Ovation Algorithms Reference Manual

OW360_R1100

For use with Ovation 3.6.0 and Feature Pack 3

August 2017
Version 4
Copyright Notice

Since the equipment explained in this document has a variety of uses, the user and those
responsible for applying this equipment must satisfy themselves as to the acceptability of each
application and use of the equipment. Under no circumstances will Emerson Process
Management Power & Water Solutions, Inc. (Emerson) be responsible or liable for any damage,
including indirect or consequential losses resulting from the use, misuse, or application of this
equipment.

The text, illustrations, charts, and examples included in this manual are intended solely to explain
the use and application of the OvationTM Unit. Due to the many variables associated with specific
uses or applications, Emerson cannot assume responsibility or liability for actual use based upon
the data provided in this manual.

No patent liability is assumed by Emerson with respect to the use of circuits, information,
equipment, or software described in this manual.

No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any
form or by any means, including electronic, mechanical, photocopying, recording or otherwise
without the prior express written permission of Emerson.

The document is the property of and contains Proprietary Information owned by Emerson and/or
its subcontractors and suppliers. It is transmitted in confidence and trust, and the user agrees to
treat this document in strict accordance with the terms and conditions of the agreement under
which it was provided.

This manual is printed in the USA and is subject to change without notice.

Ovation is the mark of Emerson. Other marks are the property of their respective holders.

Copyright © Emerson Process Management Power & Water Solutions, Inc. All rights reserved.

Emerson Process Management Power & Water Solutions

200 Beta Drive
Pittsburgh, PA 15238
USA

E-Mail: [email protected]
Web site: https://www.ovationusers.com
Summary of Changes
Ovation Algorithms Reference Manual (for use with Ovation 3.6.0 and Feature Pack 3)
OW360_R1100
August 2017
Version 4

This version of the Ovation Algorithms Reference Manual includes the following new information:
 Updated the information regarding the Algorithm classifications (see page 21).
 Added information regarding the Boolean Algorithms with Quality Propagation algorithms
(see page 109).
 Added the information regarding the COMPARATOR algorithm (see page 144).
 Added the EACK and ACKT parameters to the DEVICEX algorithm (see page 174).
 Updated the information regarding the parameters of the DIGCOUNT algorithm
(see page 193).
 Updated the information regarding the TOUT, TRIN1, and OUT2 parameters of the
DISTRIBUTOR algorithm (see page 233).
 Added information regarding the Persistent Accumulator Observer (PERSISVAL) algorithm
(see page 418).
 Added information regarding the Safety Shell Status (SS_STATUS) algorithm (see page 525).
 Contents

1 Introduction to the Ovation standard algorithms 1

1.1 What are algorithms? .......................................................................................................... 1

2 General algorithm user information 3

2.1 What is hardware addressing for algorithms?..................................................................... 3
2.1.1 To determine an algorithm hardware address ....................................................... 3
2.2 What is propagated point quality? ....................................................................................... 4
2.3 Algorithm status and mode settings .................................................................................... 4
2.4 What is invalid number checking and quality checking for algorithms? .............................. 5
2.5 What are single precision floating point numbers? ............................................................. 6
2.6 What is the error information generated by algorithms? ..................................................... 6
2.7 Binary to hexadecimal conversion for algorithms ............................................................... 6
2.8 Understanding algorithm descriptions ................................................................................. 7
2.8.1 Algorithm functional symbols ................................................................................. 9

3 Understanding tracking 11
3.1 What is tracking? ............................................................................................................... 11
3.2 What is the purpose of tracking?....................................................................................... 12
3.3 What is the tracking process? ........................................................................................... 13
3.4 What are the best practices for using tracking? ................................................................ 13
3.5 What algorithms support tracking?.................................................................................... 14
3.6 Tracking examples ............................................................................................................ 16
3.7 Setting tracking signals for algorithms .............................................................................. 17

4 Algorithm classifications 21
4.1 What are algorithm classification groups? ........................................................................ 22
4.2 Alarm Manipulation algorithms .......................................................................................... 23
4.3 Artificial I/O algorithms (signal generators) ....................................................................... 23
4.4 Boolean Logic algorithms .................................................................................................. 24
4.5 Boolean Logic Memory algorithms .................................................................................... 25
4.6 Custom Calculation algorithms ......................................................................................... 25
4.7 Device Control algorithms ................................................................................................. 26
4.8 Fieldbus algorithms ........................................................................................................... 27
4.9 Filtering algorithms ............................................................................................................ 28
4.10 Hardware Interface algorithms .......................................................................................... 29
4.11 Link Controller Module Interface algorithms ..................................................................... 30
4.12 Loop Interface Module algorithms ..................................................................................... 31

OW360_R1100 i
Table of Contents

4.13 Mathematical and Statistical algorithms ............................................................................ 32

4.14 Migrated special function algorithms ................................................................................. 33
4.15 Modulating Control algorithms .......................................................................................... 34
4.16 Monitor Function algorithms .............................................................................................. 35
4.17 Operator Interface algorithms ........................................................................................... 36
4.18 Point Format Conversion algorithms ................................................................................. 37
4.19 Pulse Accumulator Module Interface algorithms............................................................... 38
4.20 Redundant Signal Processing algorithms ......................................................................... 38
4.21 Q-Line Interface algorithms ............................................................................................... 39
4.22 Safety Instrumented System (SIS) algorithms .................................................................. 40
4.23 Sequential Logic algorithms .............................................................................................. 42
4.24 Signal Compensation algorithms ...................................................................................... 43
4.25 System Diagnostic algorithms ........................................................................................... 44
4.26 System Time Function algorithms ..................................................................................... 44
4.27 Time/Counter Function algorithms .................................................................................... 45
4.28 Tracking algorithms ........................................................................................................... 46
4.29 Turbine Interface algorithms ............................................................................................. 47

5 Standard algorithm reference pages 49

5.1 Understanding algorithm descriptions ............................................................................... 52
5.1.1 Algorithm functional symbols ............................................................................... 53
5.2 AAFLIPFLOP..................................................................................................................... 54
5.3 ABSVALUE ....................................................................................................................... 56
5.4 ALARMLIMIT ..................................................................................................................... 57
5.5 ALARMMON...................................................................................................................... 62
5.6 ALGFIELD ......................................................................................................................... 64
5.6.1 ALGFIELD functions ............................................................................................ 66
5.6.2 Output points quality ............................................................................................ 66
5.6.3 Error conditions .................................................................................................... 67
5.6.4 Algorithm definitions ............................................................................................. 67
5.6.5 Example - Reading the PID algorithm parameter ................................................ 68
5.6.6 Example - Reading the ID number of the currently executed
ScStep algorithm .................................................................................................. 71
5.6.7 Example - Reading the STABLE97 AUX LC Record Field from the
ALGFIELD algorithm ............................................................................................ 74
5.7 ANALOG DEVICE (ADEVICE).......................................................................................... 77
5.8 ANALOGDRUM................................................................................................................. 80
5.9 AND ................................................................................................................................... 84
5.10 ANNUNCIATOR ................................................................................................................ 85
5.11 ANTILOG........................................................................................................................... 88
5.12 ARCCOSINE ..................................................................................................................... 90
5.13 ARCSINE .......................................................................................................................... 91
5.14 ARCTANGENT.................................................................................................................. 92
5.15 ASSIGN ............................................................................................................................. 93
5.16 ATREND............................................................................................................................ 94
5.17 AVALGEN ......................................................................................................................... 96

ii OW360_R1100
 Table of Contents

5.18 BALANCER ....................................................................................................................... 97

5.19 BCDNIN ........................................................................................................................... 103
5.20 BCDNOUT ....................................................................................................................... 105
5.21 BILLFLOW ....................................................................................................................... 107
5.22 Boolean Algorithms with Quality Propagation ................................................................. 109
5.22.1 QAND ................................................................................................................. 109
5.22.2 QOR ................................................................................................................... 111
5.22.3 QNOT ................................................................................................................. 113
5.22.4 QXOR ................................................................................................................. 114
5.23 BUFFER .......................................................................................................................... 116
5.24 CALCBLOCK................................................................................................................... 129
5.25 CALCBLOCKD ................................................................................................................ 138
5.26 COMPARATOR............................................................................................................... 144
5.27 COMPARE ...................................................................................................................... 146
5.28 COSINE........................................................................................................................... 147
5.29 COUNTER....................................................................................................................... 148
5.30 DBEQUALS ..................................................................................................................... 150
5.31 DEVICE ........................................................................................................................... 152
5.32 DEVICESEQ ................................................................................................................... 170
5.33 DEVICEX ......................................................................................................................... 174
5.34 DFIELD ............................................................................................................................ 192
5.35 DIGCOUNT ..................................................................................................................... 193
5.36 DIGDRUM ....................................................................................................................... 195
5.37 DIGITAL DEVICE ............................................................................................................ 201
5.37.1 SAMPLER (Controlled Sampler) ........................................................................ 202
5.37.2 VALVE NC (Non-Controlled Valve) .................................................................... 203
5.37.3 MOTOR NC (Non-Controlled Motor) .................................................................. 204
5.37.4 MOTOR (Simple Controlled Motor) .................................................................... 206
5.37.5 MOTOR 2-SPD (Two Speed or Bi-Directional Controlled Motor) ...................... 209
5.37.6 MOTOR 4-SPD (Two Speed and Bi-Directional Controlled Motor) ................... 212
5.37.7 VALVE (Controlled Valve) .................................................................................. 217
5.38 DISTRIBUTOR ................................................................................................................ 220
5.38.1 Input, FNUM parameter, and Output pins (IN, FNUM, and OUT[1-8]) .............. 221
5.38.2 Exclusion (EXCL) ............................................................................................... 222
5.38.3 Tracking Inputs (TKIN[1-8]) ................................................................................ 223
5.38.4 Correction Gain .................................................................................................. 224
5.38.5 Priority Deadband (PDB).................................................................................... 225
5.38.6 Base Gain........................................................................................................... 226
5.38.7 Tracking Out (TOUT) ......................................................................................... 227
5.38.8 Internal and External Control ............................................................................. 228
5.38.9 Switching Between Internal and External Inputs................................................ 229
5.38.10 First Pass Startup Options ................................................................................. 231
5.38.11 Point Quality ....................................................................................................... 231
5.38.12 SID Storage ........................................................................................................ 231
5.38.13 Distributor replaces Balancer ............................................................................. 232
5.38.14 Distributor Algorithm Definitions ......................................................................... 233

OW360_R1100 iii
Table of Contents

5.39 DIVIDE ............................................................................................................................ 243

5.40 DRPI1A ........................................................................................................................... 247
5.41 DVALGEN ....................................................................................................................... 249
5.42 DXCSTATUS................................................................................................................... 250
5.42.1 DXCSTATUS tuning parameters and site ratings .............................................. 267
5.42.2 DXCSTATUS functions ...................................................................................... 268
5.42.3 DXCSTATUS state ............................................................................................. 270
5.43 DROPSTATUS ................................................................................................................ 272
5.44 ELCCONTROL ................................................................................................................ 275
5.45 FACEPLATE ................................................................................................................... 278
5.45.1 FACEPLATE -- DIGITAL DEVICE template ...................................................... 282
5.45.2 FACEPLATE -- MASTATION template .............................................................. 285
5.46 FIELD .............................................................................................................................. 287
5.47 FIFO ................................................................................................................................ 289
5.48 FIRSTOUT ...................................................................................................................... 291
5.49 FLIPFLOP ....................................................................................................................... 296
5.50 FUNCTION ...................................................................................................................... 298
5.51 GAINBIAS ....................................................................................................................... 302
5.52 GASFLOW ...................................................................................................................... 306
5.53 HEARTBEAT ................................................................................................................... 313
5.54 HIGHLOWMON ............................................................................................................... 316
5.55 HIGHMON ....................................................................................................................... 317
5.56 HISELECT ....................................................................................................................... 319
5.57 HSCLTP .......................................................................................................................... 324
5.58 HSLT ............................................................................................................................... 325
5.59 HSTVSVP........................................................................................................................ 326
5.60 HSVSSTP........................................................................................................................ 327
5.61 INTERP ........................................................................................................................... 328
5.62 KEYBOARD .................................................................................................................... 332
5.63 LATCHQUAL ................................................................................................................... 335
5.64 LEADLAG ........................................................................................................................ 337
5.65 LEVELCOMP .................................................................................................................. 341
5.66 LOG ................................................................................................................................. 345
5.67 LONGACC ....................................................................................................................... 346
5.67.1 Operations .......................................................................................................... 349
5.67.2 Behavior on the limits ......................................................................................... 350
5.67.3 Status of LONGACC algorithm during an error.................................................. 351
5.67.4 Point Quality ....................................................................................................... 352
5.67.5 SID storage ........................................................................................................ 353
5.67.6 Algorithm definitions ........................................................................................... 353
5.68 LOSELECT ...................................................................................................................... 357
5.69 LOWMON ........................................................................................................................ 362
5.70 MAMODE ........................................................................................................................ 363
5.71 MASTATION ................................................................................................................... 366
5.72 MASTERSEQ .................................................................................................................. 376
5.73 MEDIANSEL.................................................................................................................... 389
5.74 MULTIPLY ....................................................................................................................... 397

iv OW360_R1100
 Table of Contents

5.75 MULTISWITCH ............................................................................................................... 400

5.75.1 Functions ............................................................................................................ 402
5.75.2 Algorithm definitions ........................................................................................... 403
5.76 NLOG .............................................................................................................................. 405
5.77 NOT ................................................................................................................................. 406
5.78 OFFDELAY ..................................................................................................................... 407
5.79 ONDELAY ....................................................................................................................... 409
5.80 ONESHOT ....................................................................................................................... 411
5.81 OR ................................................................................................................................... 415
5.82 PACK16........................................................................................................................... 416
5.83 PERSISVAL .................................................................................................................... 418
5.84 PID .................................................................................................................................. 420
5.85 PIDFF .............................................................................................................................. 435
5.86 PNTSTATUS ................................................................................................................... 446
5.87 POLYNOMIAL ................................................................................................................. 448
5.88 PREDICTOR ................................................................................................................... 450
5.89 PRIORITY Algorithm Package ........................................................................................ 454
5.89.1 PRIORITY .......................................................................................................... 454
5.89.2 PRIORITY-EXT .................................................................................................. 470
5.89.3 PRIORITY-REJ .................................................................................................. 475
5.90 PSLT ............................................................................................................................... 478
5.91 PSVS ............................................................................................................................... 479
5.92 PULSECNT ..................................................................................................................... 480
5.93 QAVERAGE .................................................................................................................... 481
5.94 QUALITYMON................................................................................................................. 482
5.95 RAMPGEN ...................................................................................................................... 483
5.96 RATECHANGE ............................................................................................................... 487
5.97 RATELIMIT...................................................................................................................... 489
5.98 RATEMON ...................................................................................................................... 493
5.99 RESETSUM .................................................................................................................... 495
5.100 RLICONFIG ..................................................................................................................... 498
5.101 RPACNT .......................................................................................................................... 502
5.102 RPAWIDTH ..................................................................................................................... 503
5.103 RSRSTATUS................................................................................................................... 504
5.104 RUNAVERAGE ............................................................................................................... 514
5.105 RUNTIME ........................................................................................................................ 516
5.106 RVPSTATUS ................................................................................................................... 522
5.107 SS_STATUS ................................................................................................................... 525
5.107.1 Controller faults for Safety Shell ........................................................................ 527
5.108 SATOSP .......................................................................................................................... 528
5.109 SELECTOR ..................................................................................................................... 529
5.110 SETPOINT ...................................................................................................................... 531
5.111 SIMTIME ......................................................................................................................... 535
5.112 SINE ................................................................................................................................ 535
5.113 SLCAIN ........................................................................................................................... 536
5.114 SLCAOUT ....................................................................................................................... 539

OW360_R1100 v
Table of Contents

5.115 SLCDIN ........................................................................................................................... 542

5.116 SLCDOUT ....................................................................................................................... 545
5.117 SLCPIN ........................................................................................................................... 548
5.118 SLCPOUT ....................................................................................................................... 551
5.119 SLCSTATUS ................................................................................................................... 554
5.120 SMOOTH......................................................................................................................... 558
5.121 SOFTSOE ....................................................................................................................... 560
5.122 SPTOSA .......................................................................................................................... 570
5.123 SQUAREROOT ............................................................................................................... 571
5.124 SSLT ............................................................................................................................... 574
5.125 STATISTICS.................................................................................................................... 575
5.126 STEAMFLOW.................................................................................................................. 592
5.127 STEAMTABLE................................................................................................................. 594
5.128 STEPTIME ...................................................................................................................... 597
5.129 SUM ................................................................................................................................ 603
5.130 SYSTEMTIME ................................................................................................................. 607
5.131 TANGENT ....................................................................................................................... 608
5.132 TIMECHANGE ................................................................................................................ 609
5.133 TIMEDETECT ................................................................................................................. 610
5.134 TIMEMON ....................................................................................................................... 611
5.135 TRANSFER ..................................................................................................................... 614
5.136 TRANSLATOR ................................................................................................................ 622
5.137 TRANSPORT .................................................................................................................. 627
5.138 TRNSFINDX .................................................................................................................... 629
5.139 TRUTHTBL...................................................................................................................... 630
5.140 TRVP ............................................................................................................................... 633
5.140.1 TRVP configuration ............................................................................................ 634
5.140.2 Monitoring the health of each Valve Positioner module ..................................... 635
5.140.3 Detecting feedback position deviation ............................................................... 635
5.140.4 Determining and displaying the state of each module ....................................... 636
5.140.5 Computing the integral component of the PI algorithm ...................................... 637
5.140.6 Scaling output voltage for bumpless control ...................................................... 638
5.140.7 Status Register 1 points (inputs) ........................................................................ 639
5.140.8 Command Register 10 points (outputs) ............................................................. 639
5.140.9 Synchronized calibration .................................................................................... 640
5.140.10 Reset Failure flags ....................................................................................... 642
5.140.11 Module Reboot ............................................................................................. 642
5.140.12 Signal quality ................................................................................................ 642
5.140.13 TRVP Algorithm Definitions .......................................................................... 643
5.141 TRVPTUNE ..................................................................................................................... 646
5.142 TSLH ............................................................................................................................... 653
5.143 TSLP ............................................................................................................................... 654
5.144 UNPACK16 ..................................................................................................................... 655

vi OW360_R1100
 Table of Contents

5.145 VCLTP ............................................................................................................................. 657

5.146 VSLT ............................................................................................................................... 658
5.147 XOR................................................................................................................................. 659
5.148 X3STEP........................................................................................................................... 660
5.149 2XSELECT ...................................................................................................................... 669

Index 677

OW360_R1100 vii
 S E C T I O N 1

1 Introduction to the Ovation standard algorithms

IN THIS SECTION

What are algorithms? .......................................................................................................... 1

1.1 What are algorithms?

Algorithms are mathematical formulas that define a specific control strategy. An algorithm may be
thought of as a collection of system points that are controlled by the algorithm. The algorithm
reads values (inputs) and writes values (outputs) into points to accomplish certain desired actions
in the system. (See Ovation Record Types Reference Manual for information about point record
types.)

The Ovation Control Builder places these algorithms on control sheets to tell the Ovation control
system what algorithms to use, what points to associate with the algorithms, and in what order the
algorithms should execute. The Control Builder combines multiple algorithms and even multiple
control sheets to create an entire control strategy for a system process.

The Ovation algorithms are typically provided with the Ovation Controller, and are used to
implement a wide range of functionality for a Controller. Each algorithm is represented in the
Control Builder by a unique symbol.

For information on adding algorithms to sheets in the Control Builder, refer to Ovation Control
Builder User Guide.

Standard Ovation algorithms are described in Ovation Algorithms Reference Manual.

Q-line, Fieldbus, SIS, and migrated special function algorithms are described in Ovation Q-line
and Specialty Algorithms Reference Manual.

OW360_R1100 1
 S E C T I O N 2

2 General algorithm user information

IN THIS SECTION

What is hardware addressing for algorithms? ..................................................................... 3

What is propagated point quality? ....................................................................................... 4
Algorithm status and mode settings .................................................................................... 4
What is invalid number checking and quality checking for algorithms? .............................. 5
What are single precision floating point numbers? ............................................................. 6
What is the error information generated by algorithms? ..................................................... 6
Binary to hexadecimal conversion for algorithms ............................................................... 6
Understanding algorithm descriptions ................................................................................. 7

2.1 What is hardw are addressing for algorithms?

Some algorithms (for example, an MASTATION algorithm) require the hardware address of the
associated I/O module in order to perform their functions. You must enter the hardware address
for the algorithm into the hardware address field.

For a point that is read from or written to an I/O card, the hardware address parameter indicates
the offset from where the pertinent I/O register resides.

Addressing that is initialized in the algorithm is either for Ovation cards or Q-line cards.
 For Ovation, the address is determined by the module position in the I/O cabinet.
 For Q-line, the hardware address is equal to the address directly jumpered on the card plus
the offset into the proper channel number (no doubling required).

2.1.1 To determine an algorithm hardware address

Perform the following steps to determine an algorithm hardware address:

1. Access the Point Information window to view the module record. Refer to Ovation Operator
Station User Guide.
2. Select the Hardware tab.
3. Note the hex representation of the hardware address for the module in the “HD” field.
4. The algorithm requires the base address, so take the “D” in the base address and convert it to
a zero.
5. Enter that value into the algorithm's hardware address field.
For example, if a Loop Interface module record's HD field is “0x9D” then “0x90” is entered in
the MASTATION'S hardware address field.

OW360_R1100 3
2.2 What is propagated point quality?

2.2 What is propagated point quality?

Many algorithms generate a quality setting for the output. In most cases, the quality of the output
equals the quality of the input. This is commonly called propagated quality. However, this simple
propagation is not true for all algorithms.

In general, the worst quality of the algorithm's input points is passed on to the output point for
each standard algorithm. For example, an input sensor failure causes BAD quality to propagate
through all standard algorithms that directly or indirectly use the input point. This BAD quality may
be used to reject certain algorithms to Manual mode. (Refer to the individual algorithm reference
pages for complete information.)

Process points may have one of the following quality values, assigned by the user or the system:
 GOOD = Point is functioning properly.
 FAIR = Typically an entered value.
 POOR = Generated from certain algorithms if some inputs were BAD and some were GOOD.
 BAD = Point is not functioning properly, typically caused by sensor failure.

Note: Algorithms propagate GOOD quality when in Manual mode.

2.3 Algorithm status and mode settings

The mode and status digital signals are set as follows:

Signal status

SIGNAL ACTION

Auto Mode MASTATION sets the output Auto Mode signal TRUE when the
algorithm is in Auto mode.

High Limit Reached All algorithms set the High Limit Reached output signal TRUE when
the output is at the high limit specified and the High Limit Reached
output signal is not scan removed.

Local Manual Mode MASTATION sets the Local Manual Mode output signal TRUE when
the algorithm is in Local Manual mode.

Low Limit Reached All algorithms set the Low Limit Reached output signal TRUE when
the output is at the low limit specified and the Low Limit Reached
output signal is not scan removed.

Manual Mode MASTATION sets the output Manual mode signal TRUE when the
algorithm is in Manual mode.

4 OW360_R1100
 2.4 What is invalid number checking and quality checking for algorithms?

2.4 What is invalid number checking and quality checking for

algorithms?

Most algorithms perform invalid number checking on analog input points. These points include
tracking inputs. If an invalid number is detected, the drop goes into alarm and the problem is
identified by Fault Code 66, Fault ID 3.

For algorithms, Fault Parameter 3 contains the number of the algorithm sheet detecting an invalid
number. These numbers are reported as hexadecimal values. The Ovation System Viewer
application provides access to fault code information and suggests possible user actions to
correct the fault.

An invalid number is generated under exceptional conditions. An example of such conditions is

taking the square root of a negative number. The Function section in the individual algorithm
reference sheets identifies those algorithms, which provide additional checking to avoid specific
exceptional conditions.

When an invalid number is input to an algorithm, generally the output of the algorithm is also
invalid and is marked with BAD quality. In the following algorithm reference sheets, each
algorithm that performs invalid number checking discusses how the invalid number is treated and
the results that occur from the invalid number.

There are three types of invalid numbers: indefinite, NAN, and denormal.
 An indefinite invalid number is generated from a mathematical operation for which there is no
reasonable result.
 A NAN (not-a-number) invalid number is an unrecognizable real number format and should
never occur.
 A denormal invalid number is generated when the result of a mathematical operation is too
small to be represented in the 32-bit real number format used in the system. If an analog input
is a denormal invalid number, the drop is placed into alarm identified by Fault Code 66, Fault
ID 3.
However, certain algorithms store the denormal value into a temporary variable, convert it to zero,
and use that value (0) in the algorithm calculation. Consequently, these algorithms calculate a
valid output value with GOOD quality and the drop goes into alarm.

If the output of the algorithm is a denormal invalid number, then the value of the output is set to
zero and the drop is not placed into alarm. These denormal invalid numbers are displayed
throughout the system as zero.

If an invalid number is generated, the cause of the problem generate should be immediately
investigated and corrected since it could cause a control problem in the system.

In addition to invalid number checking, many algorithms generate a quality setting on the output.

OW360_R1100 5
2.5 What are single precision floating point numbers?

2.5 What are single precision floating point numbers?

Single precision floating point numbers are represented within 32 binary bits. One-bit is the sign of
the characteristic, 23-bits show the binary value of the characteristic, one-bit for the sign of the
mantissa, and 7-bits for the value of the binary mantissa.

The Ovation system is limited to single precision floating point numbers, which can affect
algorithm precision. In certain cases, this may prevent an algorithm from writing a value beyond a
certain number if a single precision floating point limitation is reached. Although the internal
algorithm calculation can handle double precision floating point numbers, Ovation points are
limited to single precision values. More information is available by researching the IEEE754
floating point standard.

2.6 What is the error information generated by algorithms?

The second status word in an analog or digital process point may contain error information
generated by an algorithm that processed the value of that point.

For analog and digital points, the 2W record field contains the second status word.
 If a bit is TRUE, then the error indicated by that bit has been detected.
 If a bit is FALSE, then the error has not been detected.

2.7 Binary to hexadecimal conversion for algorithms

The following binary to hexadecimal conversion table is included to assist you in using algorithms
that require binary to hexadecimal conversion.

Binary to Hexadecimal Conversion

BINARY TO HEXADECIMAL CONVERSION TABLE

BINARY HEXADECIMAL DECIMAL

0000 0 0

0001 1 1

0010 2 2

0011 3 3

0100 4 4

0101 5 5

0110 6 6

0111 7 7

1000 8 8

1001 9 9

1010 A 10

1011 B 11

6 OW360_R1100
 2.8 Understanding algorithm descriptions

BINARY TO HEXADECIMAL CONVERSION TABLE

BINARY HEXADECIMAL DECIMAL

1100 C 12

1101 D 13

1110 E 14

1111 F 15

For example, in DIGDRUM, the following binary number represents the states of the 16 outputs in
a given step. The right-most bit represents Output 001, and the left-most bit represents Output
016. For example, if you want Step 5 to have the outputs in these states, I05 would be initialized
to 0x53C6.

Byte = 8 bits, Integer = 16 bits

Binary: 0101 0011 1100 0110 0101001111000110B

Hexadecimal: 5 3 C 6 0x53C6

2.8 Understanding algorithm descri ptions

Most of the algorithm reference pages contain the following information (where applicable):
 Description - Describes the algorithm's operation.
 Invalid Real Numbers and Quality - Describes how quality is set.
 Functional Symbol - Illustrates (in pictorial form) the algorithm's operation. See Algorithm
functional symbols (see page 9).
 Control Builder Symbols -- Shows how the algorithm will appear in the Control Builder and
Signal Diagram programs.
 Algorithm Record Type (if required) - Defines the type and size of the record generated for
storing parameters and other information necessary to the algorithm. (See Ovation Record
Types Reference Manual.)

OW360_R1100 7
2.8 Understanding algorithm descriptions

 Algorithm Definitions - Provides the following information on the algorithm:

 Names of the parameters used.
 Algorithm record field used by each tuning constant or data initialization parameter; also,
the type of entry required in this field (integer, byte, or real).
 Parameter types such as those described below:
 Variable = Input or output signal to the algorithm (that is, analog or digital).
 Tuning Constant = Fixed parameter that remains constant unless it is changed by the
user at the Operator's Station or Control Builder.
 Data Initialization Parameter = Fixed constant that cannot be changed by the user at
the Operator's Station but can be changed by the Control Builder.
 Selectable = Can be either a Tuning constant in an algorithm record field or a point
record.
 Reconcilable Constant = Parameter can be tuned and reconciled through a special,
project-specific diagram.
 Algorithm Initialization = Internal parameter that is exposed by the algorithm.
 Definition of whether the parameter is required or optional.
If the parameter is optional and not initialized by the user, it defaults to zero.
If there are input points to the algorithm that are optional and not initialized by the user,
they have a value of zero for analog points and FALSE for digital inputs.
 Default value (if applicable).
 Brief description of the parameter.
 Minimum point record required by each variable.
Each algorithm defines the minimum size point record that can be used for each
algorithm input or output.
The quality (see page 4) of the points is set BAD when a detectable hardware failure is
encountered. This information can be used in control strategies or for alarming purposes
by detecting BAD quality using the QUALITYMON series of algorithms.
 Function - Explains the algorithm's operation in terms of a mathematical equation.
 Application Example - Provides an example to demonstrate the use of the algorithm.
 Miscellaneous Sections - Applicable to a specific algorithm only.

8 OW360_R1100
 2.8 Understanding algorithm descriptions

2.8.1 Algorithm functional symbols

The following table lists the items used in the algorithm functional symbols:

Functional symbols items description

FUNCTIONAL DESCRIPTION
SYM BOL

Required Analog (LA record type) input or output (solid line and solid
arrowhead).
Required Digital or Packed Digital (LD or LP record type) input or output
(solid line and hollow arrowhead).
Required Algorithm (LC record type) input or output (solid line and line
arrowhead).
Required Drop (DU) input or output (solid line and no arrowhead).

Optional or Selectable Analog (LA record type) input or output (dashed line
and solid arrowhead).
Optional or Selectable Digital or Packed Digital (LD, LP record type) input or
output (dashed line and hollow arrowhead).
Optional or Selectable Algorithm (LC record type) input or output (dashed line
and line arrowhead.
Optional or Selectable Drop (DU record type) input or output (dashed line
and no arrowhead)

Note: Symbols portrayed in this manual only serve as an example and can be configured
differently depending on the number and type of pins that are used. The Control Builder
application may show various symbol configurations of the same algorithm and may not directly
match what is shown in this document.

OW360_R1100 9
 S E C T I O N 3

3 Understanding tracking

IN THIS SECTION

What is tracking? ............................................................................................................... 11

What is the purpose of tracking? ....................................................................................... 12
What is the tracking process? ........................................................................................... 13
What are the best practices for using tracking? ................................................................ 13
What algorithms support tracking? .................................................................................... 14
Tracking examples ............................................................................................................ 16
Setting tracking signals for algorithms .............................................................................. 17

3.1 What is tracking?

The tracking function is a sophisticated control feature that is implemented through the signals
that connect the algorithms. Tracking may be defined as aligning a portion of a control system
that is not in control to the portion of the control system that is in control.

To implement tracking in the Ovation system, tracking signals are sent between algorithms.
These signals tell the upstream algorithm whether or not to be in the tracking mode and what
value is required by the downstream algorithm to achieve the present output.

Typically, multiple control strategies (or “modes”) are defined to control a process. For example,
both manual and automatic control modes may be available. Multiple types of automatic control
may be available, such as flow control, level control, element control, and cascade control modes.
During the transition from one control mode to another, tracking is needed.

When transferring between control strategies (for instance, from manual to automatic control
modes), information is required by the newly selected control strategy to ensure a smooth
transition. These required values are obtained from the active control strategy and are provided to
the other available strategies. This exchange of information between control strategies is referred
to as tracking.

Tracking signals are automatically generated by the Control Builder. The Control Builder assigns
points to carry the tracking mode and value information. The insertion of tracking logic is
transparent to the user (requires no user input to implement). You have the option of turning
tracking off.

OW360_R1100 11
3.2 What is the purpose of tracking?

Tracking should be turned off for the following situations:

 Tracking from a mathematical calculation.
 When using PID to a setpoint to keep from winding up a PID, priority lower/raise. Typically, do
not allow tracking to change a setpoint.
Tracking can be blocked in the following ways:
 Place the algorithms on a separate sheet. Since automatic tracking only occurs within a
sheet, tracking is effectively blocked.
 Use Control Builder to remove tracking points from the TRIN entry fields.

3.2 What is the purpose of tracking?

There are two purposes for tracking:

 Prevent bumps.
Changes in the mode of a process have the potential to disrupt the process. For example,
consider a situation where a control element is manually set to a low level, even though the
automatic control scheme is calculating a high level. If the control mode is changed to
automatic, a “bump” occurs as this control element’s setting goes from low to high. If the
change is extreme, equipment damage could result. Methods used to avoid this type of rapid
adjustment are referred to as “bumpless transfer.”
 Reduce process upsets.
A process upset may be defined as a condition in which the control system causes the
process to temporarily move to an operating point that differs from the desired point. Often the
process upset is caused by failing to hold the integral action of a PID Controller in check; this
condition is called reset windup.
For example, a PID control scheme sums a Proportional component and an Integral
component. In certain situations, the value of the output may reach its limit (100%) while one
of the components is still increasing. Although the output cannot be driven past 100%, it takes
time for the component value to return to the appropriate range. During this time, if it is
necessary to lower the output, the artificially high component value can cause a delay. In
order to keep the control scheme components within the appropriate range, an approach
called Anti-reset windup limiting is used.
To ensure bumpless transfer (during the transition from one control mode to another) and to
avoid reset windup, tracking is needed.

12 OW360_R1100
 3.3 What is the tracking process?

3.3 What is the tracking process?

Tracking works by reverse calculation of the normal control functions. Control may be thought of
as proceeding from “top to bottom,” with inputs on the top, computations in the middle, and
outputs on the bottom. On the other hand, tracking may be thought of as proceeding from “bottom
to top,” with the output values on the bottom being used to calculate values for the computational
elements in the middle. Effectively, tracking calculates a value for an upstream control function,
so that the upstream objectives are satisfied.

One output point that is used for tracking is created for each algorithm that has an IN1 input. The
output is listed in the algorithm definitions as TOUT. TOUT contains the track output value, mode
and status output signals for the cascade IN1 variable.

Some algorithms have two to four additional tracking outputs for the Input 2, Input 3, and Input 4
as well. These are TRK2, TRK3, and TRK4.

The tracking output is input by the upstream algorithm as TRIN (Tracking Input Point) according
to the tracking rules outlined in the following sections. TRIN contains the tracking analog input
value and the tracking and limiting mode input signals.

Tracking values are generated by a reverse calculation of the normal algorithm function. That is,
when the algorithm is actively controlling the process, it uses one or more inputs to calculate an
output. When in the tracking mode, the algorithm is provided with the output value, and must
calculate the input value required to obtain that output. This value is sent to the upstream
algorithm that is generating the algorithm’s input. When there is more than one input, the value is
sent to the IN1 input.

Not all algorithms initiate tracking. All algorithms do not process the signals the same way. Refer
to the individual algorithm descriptions to determine how the signals are processed for a particular
algorithm.

3.4 What are the best practices for using tracking?

Refer to the following guidelines when using tracking:

 Tracking is typically done upstream.
 Do not unnecessarily use the GAINBIAS algorithm.
 Use MAMODE priority raise/lower instead of external transfers below MASTATION
algorithms.
 Tracking signals are always visible (except for BALANCER signals) and are typically shown in
green.
 If downstream tracking can come from more than one source, then the initial building order
determines the source unless manually changed. The exception to this is the BALANCER
algorithm, which can accept tracking from up to 16 downstream algorithms.
 Tracking may be broken after the signal wires are drawn. On the Windows platform, this may
be done with the Clear Tracking icon.
 If non-tracking algorithms are inserted between tracking algorithms, then the designer is
responsible for tracking across the “gaps.” Typically, the TRANSFER algorithm is used above
the gap to insert the user-computed tracking.

OW360_R1100 13
3.5 What algorithms support tracking?

 Reset Windup limiting is performed by tracking algorithms if:

 They are properly configured for tracking.
 The scale limits (TPSC and BTSC) are set to reflect the accepted signal range.
 In addition, the PID and PIDFF algorithms provide for enhanced windup limiting in the
cascade configuration.
 Cross sheet tracking is implemented by passing a tracking point “upstream” through the same
page connectors that pass control signals downstream. On the Windows platform, this is done
by using the Set Tracking icon with the signal wires.
 Tracking points are fully managed by OCB except when tracking crosses between sheets,
and when tracking from a downstream algorithm into a BALANCER algorithm.
Since the BALANCER algorithm tracks from many downstream algorithms, tracking
connections between a BALANCER algorithm and any downstream algorithms are not
graphically visible.
 Typically, there is only one tracking input (IN1) to an algorithm, except for TRANSFER and
SELECTOR algorithms.
 Before you implement tracking, consider the following:
 What are scaling factors, voltage, percentage, temperature?
 Where is the I/O located?
 What is the frequency of the point?
 The Track Ramp Rate (TRAT) referred to in the algorithm descriptions is used by the
algorithm when tracking action is terminated and normal control begins. It is the time in units
per second for the output to decay or ramp to the value dictated by the inputs under normal
(non-tracking) operation. The default Track Ramp Rate value is 2.5 units

3.5 What algori thms support tracking?

The algorithms in the following table support tracking through dual-purpose analog inputs and
outputs (that is, track value in AV field, mode status bits in 3W field). See Ovation Record Types
Reference Manual for information on record fields and status bits.

Note: The following algorithms are described in the Ovation Q-Line and Specialty Algorithms
Reference Manual: FFAI, FFAO, FFDI, FFDO, FFMAI, FFPID, QSRM, XMA2, and XML2.

Tracking algorithm summary

ALGORITHM T R AT TOUT TRK1 TRK2 TRK3 TRK4 ACCEPT CAS CADE

RAMP TO TO TO TO TO TRIN TRACK
IN1 IN1 IN2 IN3 IN4 OPTIMIZE

ANALOG x x
DEVICE

BALANCER x x TRK01-
TRK16
DIVIDE x x x

FIELD x

FFAI x

14 OW360_R1100
 3.5 What algorithms support tracking?

ALGORITHM T R AT TOUT TRK1 TRK2 TRK3 TRK4 ACCEPT CAS CADE

RAMP TO TO TO TO TO TRIN TRACK
IN1 IN1 IN2 IN3 IN4 OPTIMIZE

FFAO x

FFDI x

FFDO x

FFMAI x

FFPID x1 x

FUNCTION x x x

GAINBIAS x x x

GASFLOW x x

HISELECT x x x x x x

LEADLAG x x x

LOSELECT x x x x x x

MASTATION x x x

MULTIPLY x x x

PID x x1 x x

PIDFF x x1 x x

QSRMA x x x

RATELIMIT x x

SETPOINT x2 x

SETSTATES x

SQUARE- x x x
ROOT

SUM x x x

TRANSFER3 x4 x x x

XMA2 x x x

XML2 x2 x

X3STEP x x
1 Through S (setpoint) pin

2 Information Only

3 Supports switchable slewing and switchable tracking

4 Ramps supported on both TRR1 and TRR2 pins

OW360_R1100 15
3.6 Tracking examples

3.6 Tracking examples

Tracking: Mode Transition

One of the most common uses of tracking is during the transition between manual mode and auto
mode. In this case, the control algorithm upstream of the MASTATION algorithm must be tracked
to the current output of the MASTATION algorithm. The input to the MASTATION station is the
same as the output from the MASTATION station at the moment of the mode change, and
bumping is prevented.

Tracking: SUM Algorithm

Another common use of tracking is for one input into a SUM algorithm. A two-input SUM algorithm
normally adds two inputs, A and B, to produce an output, C. That is, A + B = C. When the
algorithm is in tracking mode, C is dictated by downstream tracking requirements and one of the
inputs, which may be continually varying as process conditions change. Therefore, a value for the
other input must be calculated by the algorithm such that the sum of the inputs is equal to the
required output. Simple algebraic manipulation of the SUM equation reveals that the dependent
input must be tracked to the difference between required C and independent B. That is, A = C - B.

Tracking: PID Algorithm

Still another common tracking use involves one of the inputs to a PID algorithm’s error calculation.
As in the SUM example, the output of the PID is dictated by downstream tracking requirements
and the process variable acts as an independent variable. However, because integral action is
involved in this control algorithm, the concept for tracking changes. Here, the appropriate
technique is to cause a zero error to be presented to the PID during tracking periods to provide no
error-related movement of the PID output when tracking is initially released.

Therefore, the dependent input to the PID error function, the set point, should be tracked to the
value of the process variable input so that a zero-error condition is produced. Also, the PID output
must be tracked when the associated portion of the system is not in control so that integral action
does not cause process upsets by following set point errors. As described previously, this
condition is called reset windup.

Typically, an MASTATION algorithm is placed below the PID algorithm on a control sheet.

In summary, there might be a change in your plant's process values (for example, the
temperature rose in a feedwater system). The applicable process control sheet contains the logic
that defines the desired value for the process. The algorithm PID looks at the difference between
the actual process value and the desired process value and reacts based on this difference. It
performs the necessary action (for example, add cold water to lower the water temperature) to
bring the process back to the desired value.

Tracking: Reset Windup

The concept of reset windup applies to normal control modes as well as to tracking modes. It is
undesirable to allow the integral action in a control algorithm to move any further in a direction
that tends to drive a control element past its limits of travel. Once the integrator winds past where
it should be, it takes time to wind back to the control region when the time comes. Control delays
result and process upsets may occur. The solution is to compute an integrator output that keeps
the downstream demand to the control element at the limit until it becomes time to drive the
control element into the control range. This approach is called anti-reset windup limiting.

16 OW360_R1100
 3.7 Setting tracking signals for algorithms

Tracking: Anti-Reset Windup

The Ovation tracking functions performs the anti-reset windup limiting function if the following two
conditions are met:
 The sheets must be configured using the Ovation sheet tracking rules.
 The Scale Top and Scale Bottom parameters of the algorithms must be set to reflect the
actual control element ranges, usable controller ranges, and so forth.
The fact that an algorithm is at its top or bottom of scale is used to produce signals that inhibit the
upstream algorithm from moving too far in the wrong direction. If algorithms are properly
configured, reset windup is prevented. Reset windup is technically more of a concern in control
mode than in tracking mode.

3.7 Setting tracking signals for algorithms

The digital tracking signals are set and used as described in the following table.

Digital tracking signals status

SIGNAL ACTION OF THE ALGORITHM IMPLEMENTATION BY THE

INITIATING THE TRACKING ALGORITHM BEING TOLD TO
TRACK

Track PID and PIDFF set the Track output The output value is set equal to the
signal TRUE. Track input value. An internal track
buffer is set up to provide a
TRANSFER sets the Track output signal bumpless transfer when the Track
TRUE for the value that is not selected. input signal is removed.
MASTATION set the Track output signal
TRUE for one loop after it reads the
hardware value on the first pass.
MASTATION sets the Track output
signal TRUE when the algorithm is not in
Auto mode.
All algorithms set the Track output signal
TRUE when the Track input signal is
TRUE.

OW360_R1100 17
3.7 Setting tracking signals for algorithms

SIGNAL ACTION OF THE ALGORITHM IMPLEMENTATION BY THE

INITIATING THE TRACKING ALGORITHM BEING TOLD TO
TRACK

Track-if-Lower HISELECT sets the Track-if-Lower If the output value of the PID or
output signal TRUE for the value that is PIDFF is less than the Track input
not selected only when there are no value, then a negative error causes
Track, Track-if_Higher, or Track-if-Lower the Controller to take action from
input signals and the gain on the input the previous output value, and a
value is positive. positive error causes the Controller
to take action from the Track input
LOSELECT sets the Track-if-Lower value.
output signal TRUE for the value that is
not selected only when there are not
Track, Track-if-Higher, or Track-if-Lower
input signals and the gain on the input
value is negative.
All algorithms set the Tack-if-Lower
output signal TRUE when there is no
Track input signal and either:
 The Track-if-Lower signal is TRUE and
the gain on the input value is positive,
or
 The Track-if-Higher input signal is
TRUE and the gain on the input value
is negative.
Track-if-Higher LOSELECT sets the Track-if-Higher If the output value of PID or PIDFF
output signal TRUE for the value that is is greater than the Track input
not selected only when there are no value, then a positive error causes
Track, Track-if-Higher, or Track-if-Lower the Controller to take action from
input signals and the gain on the input the previous output value, and a
value is positive. negative error causes the Controller
to take action from the Track input
HISELECT sets the Track-if-Higher value.
output signal TRUE for the value that is
not selected only when there are no
Track, Track-if-Higher, or Track-if-Lower
input signals and the gain on the input
value is negative.
All algorithms set the Track-if-Higher
output signal TRUE when there is no
Track input signal and :
 The Track-if-Higher input signal is
TRUE and the gain on the input value
is positive, or
 The Track-if-Lower input signal is
TRUE and the gain on the input value
is negative.

18 OW360_R1100
 3.7 Setting tracking signals for algorithms

SIGNAL ACTION OF THE ALGORITHM IMPLEMENTATION BY THE

INITIATING THE TRACKING ALGORITHM BEING TOLD TO
TRACK

Lower Inhibit PID and PIDFF set the Lower Inhibit The output is prevented from
output signal TRUE when the algorithm decreasing its value, but it is
is in Cascade mode, no Track input permitted to increase.
signal exists, and:
 The Track-if-Lower input signal is
TRUE and either the gain on the
setpoint is positive with INDIRECT
action on the error or the gain on the
setpoint is negative with DIRECT
action on the error, or
 The Track-if-Higher input signal is
TRUE and either the gain on the
setpoint is negative with INDIRECT
action on the error, or the gain on the
setpoint is positive with DIRECT action
on the error.
All algorithms set the Lower Inhibit
output signal TRUE when there is no
Track input signal and:
 The output value is at the low limit
specified and the gain on the output
value is positive, or
 The output value is at the high limit
specified and the gain on the input
value is negative, or
 The Lower Inhibit input signal is TRUE
and the gain on the input value is
positive, or
 The Raise Inhibit input signal is TRUE
and the gain on the input value is
negative.

OW360_R1100 19
3.7 Setting tracking signals for algorithms

SIGNAL ACTION OF THE ALGORITHM IMPLEMENTATION BY THE

INITIATING THE TRACKING ALGORITHM BEING TOLD TO
TRACK

Raise Inhibit PID and PIDFF set the Raise Inhibit The output is prevented from
output signal TRUE when the algorithm increasing its value, but it is
is in Cascade mode, no Track input permitted to decrease.
signal exists, and:
 The Track-if-Higher input signal is
TRUE and either the gain on the
setpoint is positive with INDIRECT
action on the error, or the gain on the
setpoint is negative with DIRECT
action on the error, or
 The Track-if-Lower input signal is
TRUE and either the gain on the
setpoint is negative with INDIRECT
action on the error, or the gain on the
setpoint is positive with DIRECT action
on the error.
All algorithms set the Raise Inhibit output
signal TRUE when there is no Track
input signal, and:
 The output value is at the high limit
specified and the gain on the input
value is positive, or
 The output value is at the low limit
specified and the gain on the input
value is negative, or
 The Raise Inhibit input signal is TRUE
and the gain on the input value is
positive, or
 The Lower Inhibit input signal is TRUE
and the gain on the input value is
negative.

20 OW360_R1100
 S E C T I O N 4

4 Algorithm classifications

IN THIS SECTION

What are algorithm classification groups? ........................................................................ 22

Alarm Manipulation algorithms .......................................................................................... 23
Artificial I/O algorithms (signal generators) ....................................................................... 23
Boolean Logic algorithms .................................................................................................. 24
Boolean Logic Memory algorithms .................................................................................... 25
Custom Calculation algorithms ......................................................................................... 25
Device Control algorithms ................................................................................................. 26
Fieldbus algorithms ........................................................................................................... 27
Filtering algorithms ............................................................................................................ 28
Hardware Interface algorithms .......................................................................................... 29
Link Controller Module Interface algorithms ..................................................................... 30
Loop Interface Module algorithms ..................................................................................... 31
Mathematical and Statistical algorithms ............................................................................ 32
Migrated special function algorithms ................................................................................. 33
Modulating Control algorithms .......................................................................................... 34
Monitor Function algorithms .............................................................................................. 35
Operator Interface algorithms ........................................................................................... 36
Point Format Conversion algorithms ................................................................................. 37
Pulse Accumulator Module Interface algorithms ............................................................... 38
Redundant Signal Processing algorithms ......................................................................... 38
Q-Line Interface algorithms ............................................................................................... 39
Safety Instrumented System (SIS) algorithms .................................................................. 40
Sequential Logic algorithms .............................................................................................. 42
Signal Compensation algorithms ...................................................................................... 43
System Diagnostic algorithms ........................................................................................... 44
System Time Function algorithms ..................................................................................... 44
Time/Counter Function algorithms .................................................................................... 45
Tracking algorithms ........................................................................................................... 46
Turbine Interface algorithms ............................................................................................. 47

OW360_R1100 21
4.1 What are algorithm classification groups?

4.1 What are algorithm classification groups?

Algorithms can be classified according to their function. Many algorithms can be placed in more
than one category because they can have multiple applications.

All of the standard Ovation algorithms can be found in at least one of the following algorithm
classification groups:

Note: Reference pages for standard Ovation algorithms are found in the Ovation Algorithms
Reference Manual. Reference pages for Q-Line, Fieldbus, SIS, and migrated algorithms are
found in Ovation Q-line and Specialty Algorithms Reference Manual.

 Alarm manipulation algorithms (see page 23).

 Artificial I/O algorithms (Signal Generators) (see page 23).
 Boolean logic algorithms (see page 24).
 Boolean logic memory algorithms (see page 25).
 Custom calculation algorithms (see page 25).
 Device control algorithms (see page 26).
 Fieldbus algorithms (see page 27).
 Filtering algorithms (see page 28).
 Hardware interface algorithms (see page 29).
 Link Controller module interface algorithms (see page 30).
 Loop interface module algorithms (see page 31).
 Mathematical and statistical algorithms (see page 32).
 Migrated special function algorithms. (see page 33)
 Modulating control algorithms (see page 34).
 Monitor function algorithms (see page 35).
 Operator interface algorithms (see page 36).
 Point format conversion algorithms (see page 37).
 Pulse accumulator module interface algorithms (see page 38).
 Q-Line Interface algorithms (see page 39).
 Redundant signal processing algorithms (see page 38).
 Safety Instrumented System (SIS) algorithms (see page 40).
 Sequential logic algorithms (see page 42).
 Signal compensation algorithms (see page 43).
 System diagnostic algorithms (see page 44).
 System time function algorithms (see page 44).
 Time/counter function algorithms (see page 45).
 Tracking algorithms (see page 46).
 Turbine interface algorithms (see page 47).

22 OW360_R1100
 4.2 Alarm Manipulation algorithms

4.2 Alarm Manipulation algorithms

Description

Alarm manipulation algorithms provide a means of interfacing alarm information into the control
scheme.

Common uses

Alarm manipulation algorithms have the following uses:

 Drive alarm panels.
 Determine alarm states to trigger control functions.

Commonly used algorithms of this type

 ALARMLIMIT (see page 57) -- Allows logic to be driven using alarm limits and values
produced by analog points.
 ALARMMON (see page 62) -- Monitors up to 16 analog or digital points for alarm states.
 ANNUNCIATOR (see page 85) -- Calculates alarm state.
 SOFTSOE (see page 560) - Allows a Sequence of Events (SOE) to be generated by software
in control sheets.

4.3 Artificial I/O algorithms (signal generators)

Description

Artificial I/O algorithms generate a value and serve as place holders to input values into the
system.

Common uses

Artificial I/O algorithms have the following uses:

 Provide an interface for operator value entry.
 Input fixed constants into the control scheme.
 Change the point name of a signal.

Commonly used algorithms of this type

 ASSIGN (see page 93) -- Transfers the value and quality of one process point to another
process point of the same type.
 AVALGEN (see page 96) -- Analog value generator.
 DVALGEN (see page 249) -- Digital value generator.

OW360_R1100 23
4.4 Boolean Logic algorithms

4.4 Boolean Logic algorithms

Description

Boolean logic algorithms represent logical gates for binary logic (1 or 0).
 AND - All inputs must be true to get true output. Implement as normally open contacts in a
series.
 OR - One or more inputs must be true to get true output. Implement as normally open
contacts in parallel.
 NOT - Inverts the input. Implement with normally closed contacts.
 XOR - Inputs must be different from each other to get true output. For example, out = (A AND
(NOT B)) OR ((NOT A) AND B).

Common uses

Boolean logic algorithms have the following use:

 Implement functions in binary logic.

Commonly used algorithms of this type

 AND (see page 84) - Logical AND gate up to eight inputs.
 NOT (see page 406) - Logical NOT gate.
 OR (see page 415) - Logical OR gate up to eight inputs.
 TRUTHTBL (see page 630) - Condenses discrete logic elements (for example, AND, OR,
NOT, XOR, NAND, or NOR) into one algorithm call.
 XOR (see page 659) - Exclusive OR of two inputs.
 QAND (see page 109) - Implements a logical AND of up to eight inputs.
 QOR (see page 111) - Implements a logical OR of up to eight inputs.
 QNOT (see page 113) - Implements a logical NOT of one input.
 QXOR (see page 114) - Implements an exclusive OR.

24 OW360_R1100
 4.5 Boolean Logic Memory algorithms

4.5 Boolean Logic Memory algorithms

Description

Boolean logic memory algorithms remember the state of the input change.

Common uses

Boolean logic memory algorithms have the following uses:

 Implement on/off switches to initiate start/stop functions.
 Latch binary outputs.
 Implement toggle switches.

Commonly used algorithms of this type

 AAFLIPFLOP (including alternate implementations) (see page 54) - Alternate action flip-flop
with reset.
 FLIPFLOP (see page 296) - S-R type flip-flop memory with set or reset override.

4.6 Custom Calcula tion algorithms

Description

Custom calculation algorithms support complex mathematical equations within a single algorithm.
These algorithms can be used to simplify mathematical processes instead of using separate
mathematical function algorithms.

Common uses

Custom calculation algorithms have the following uses:

 Enter mathematical functions and utilize the result in the control scheme.
 Convert gray codes to actual rod positions.

Commonly used algorithms of this type

 CALCBLOCK (see page 129) - Allows you to define a mathematical calculation using a list of
operators.
 CALCBLOCKD (see page 138) - Operates like CALCBLOCK, but is used for logical functions
only (digital version).
 DRPI1A - Digital rod position indicator.
 LONGACC (see page 346) - Calculates integral counters with high precision.
 MULTISWITCH (see page 400) - Safety calculation of series transfers logic structure.

OW360_R1100 25
4.7 Device Control algorithms

4.7 Device Control algorithms

Description

Device control algorithms are predefined control schemes used to quickly implement start/stop,
open/close logic.

Common uses

Device control algorithms have the following uses:

 Start/stop motors.
 Open/close valves, dampers, etc.
 Calculate running time.

Commonly used algorithms of this type

 ANALOG DEVICE (ADEVICE) (see page 77) - Interfaces to Motor Control Centers (MCCs).
 DEVICE (see page 152) - Combines the commands to open/close/stop or start/stop a piece of
equipment with feedback signals indicating the command was accomplished.
 DEVICEX (see page 174) - Combines the commands to open/close or start/stop a piece of
equipment with feedback signals indicating the command was accomplished.
 DIGITAL DEVICE (see page 201) - Provides logic to control the following seven types of
devices:
 MOTOR (see page 206) - Simple controlled motor.
 MOTOR NC (see page 204) - Non-controlled motor.
 MOTOR 2-SPD (see page 209) - Two-speed or bi-directional controlled motor.
 MOTOR 4-SPD (see page 212) - Two-speed and bi-directional controlled motor.
 SAMPLER (see page 202) - Controlled sampler (calculates running time).
 VALVE (see page 217) - Controlled valve.
 VALVE NC (see page 203) - Non-controlled valve.
 ELCCONTROL (see page 275) - Allows control logic to select which ELC module, of a
redundant pair, is in control.
 PERSISVAL (see page 418) - Allows reconciling the analog points from the Ovation controller
to Ovation database.

26 OW360_R1100
 4.8 Fieldbus algorithms

4.8 Fieldbus algorithms

Description

Fieldbus algorithms interface to Fieldbus function blocks. Function blocks are self-contained
software modules that reside in Fieldbus devices. Therefore, Fieldbus devices can be controlled
by Ovation Fieldbus algorithms and integrated as part of an Ovation control scheme.

Note: Information on Fieldbus algorithms can be found in Ovation Q-Line and Specialty
Algorithm Reference Manual.

Common uses

Fieldbus algorithms have the following use:

 Implement Foundation Fieldbus logic at the transmitter level.

Commonly used algorithms of this type

 FFAI - Foundation Fieldbus analog input.
 FFAO - Foundation Fieldbus analog output.
 FFARTHM - Foundation Fieldbus arithmetic.
 FFDI - Foundation Fieldbus digital input.
 FFDO - Foundation Fieldbus digital output.
 FFINT - Foundation Fieldbus integrator.
 FFISEL/FFISELX - Foundation Fieldbus input selector.
 FFMAI - Foundation Fieldbus multiple analog input.
 FFMAO - Foundation Fieldbus multiple analog output.
 FFMDI - Foundation Fieldbus multiple digital input.
 FFMDO - Foundation Fieldbus multiple digital output.
 FFPID - Foundation Fieldbus PID.
 FFSGCR - Foundation Fieldbus signal characterizer.

OW360_R1100 27
4.9 Filtering algorithms

4.9 Filtering algorithms

Description

Filtering algorithms stabilize I/O readings. In most cases, they are used to filter out noise or
compensate for a true delay.

Common uses

Filtering algorithms have the following uses:

 Smooth noisy signals.
 Compute averages.
 Compensate for transport delays.
 Implement derivative functions in the control scheme.

Commonly used algorithms of this type

 LEADLAG (see page 337) - Lead/lag compensator.
 QAVERAGE (see page 481) - Average N analog points; exclude points with Bad quality;
N < 9.
 RATELIMIT (see page 489) - Rate limiter with fixed rate limit and flag when rate limit is
exceeded.
 RUNAVERAGE (see page 514) - Running average transform.
 SMOOTH (see page 558) - Smoothed value transform.
 TRANSPORT (see page 627) - Transport time delay.

28 OW360_R1100
 4.10 Hardware Interface algorithms

4.10 Hardw are Interface algorithms

Description

Hardware interface algorithms read and/or write data to/from I/O modules or field devices.

Common uses

Hardware interface algorithms have the following uses:

 Interface to a specific type of hardware.
 Allow monitoring and diagnosing of output signal status.
 Perform digital positioning of control devices.

Commonly used algorithms of this type

 ANALOG DEVICE (ADEVICE) (see page 77) - Interfaces to local analog loop Controllers.
 ATREND (see page 94) - Trend an analog or digital point.
 ELCCONTROL (see page 275) - Allows control logic to select which ELC module, of a
redundant pair, is in control.
 FIELD (see page 287) - Write value to a hardware output point.
 DFIELD (see page 192) - Used only with hardware digital output variable points.
 DXCSTATUS (see page 250) - interfaces with the digital excitation controller for the purpose
of reconciling the module’s tuning parameters with the Ovation database server.
 RPACNT (see page 502) - Count pulses from the Pulse Accumulator card.
 RPAWIDTH (see page 503) - Pulse width from the Pulse Accumulator card.
 RSRSTATUS (see page 504) - Interface to the RSR card.
 RVPSTATUS (see page 522) - Reads the Value Positioner card status and information.
 TRVP (see page 633) - Implements the triple module redundancy for the Ovation Valve
Positioner module.
 TRVPTUNE (see page 646) - Provides upload and download functionality for the G05 Valve
Positioner module.
 X3STEP (see page 660) - Acts as a positioner control for field devices.
 DXCSTATUS (see page 250) - Reconciles the module’s tuning parameters.
 ALGFIELD (see page 64) - Reads the value from the LC record register (field), depending on
the register name you set.
See Link Controller module interface algorithms (see page 30).

OW360_R1100 29
4.11 Link Controller Module Interface algorithms

4.11 Link Controller Module Interface algorithms

Description

Link Controller module interface algorithms manipulate inputs, outputs, and statuses to the
Ovation Link Controller module providing serial communications via standard protocols to external
devices (such as Modbus, Allen-Bradley, and so forth).

Common uses

Link Controller algorithms have the following uses:

 Read/write registers to/from QLC or LC cards.
 Provide status for link diagnostics.

Commonly used algorithms of this type

 SLCAIN (see page 536) - Reads analog input(s) from QLC/LC.
 SLCAOUT (see page 539) - Writes analog output(s) to QLC/LC.
 SLCDIN (see page 542) - Reads digital input(s) from QLC/LC.
 SLCDOUT (see page 545) - Writes digital output(s) to QLC/LC.
 SLCPIN (see page 548) - Reads packed digital input(s) from QLC/LC.
 SLCPOUT (see page 551) - Writes packed digital ouput(s) to QLC/LC
 SLCSTATUS (see page 554) - Status value of QLC/LC.

30 OW360_R1100
 4.12 Loop Interface Module algorithms

4.12 Loop Interface Module algorithms

Description

Loop interface module algorithms enable the interface to the local loop controllers or electric
drives. For more information, refer Ovation I/O Reference Manual.

Common uses

Loop interface module algorithms have the following uses:

 Interface to electric drives.
 Interface to remote auto/manual stations.

Commonly used algorithms of this type

 MASTATION (see page 366) - Interfaces between a soft manual/auto station and the
functional processor.
 RLICONFIG (see page 498) - Configures the loop interface card.
 SETPOINT (see page 531) - Soft and/or hard manual loader station with an interface to the
RLI card setpoint.
 XMA2 - Interface between a soft manual/auto station and a QAM, QAA, or QLI card and the
functional processor.
 XML2 - Soft and/or hard manual loader station with an interface to the QAM or QLI card
setpoint.

Note: Refer to Ovation Q-Line and Specialty Algorithms Reference Manual for information on
the XMA2 and XML2 algorithms.

OW360_R1100 31
4.13 Mathematical and Statistical algorithms

4.13 Mathematical and Statistical algorithms

Description

Mathematical and statistical algorithms perform calculations using standard math formulas and
properties.

Common uses

Mathematical and statistical algorithms have the following uses:

 Implement trigonometric functions.
 Perform custom calculations by entering a mathematical formula.
 Perform basic math functions like adding, multiplying, dividing, and so forth.
 Perform linear curve interpolation between segments.
 Calculate statistical values like average, mean, and standard deviation.

Commonly used algorithms of this type

 ABSVALUE (see page 56) - Absolute value of an input.
 ANTILOG (see page 88) - Antilog of scaled input, base 10 or natural base.
 ARCCOSINE (see page 90) - Arccosine on an input (in radians).
 ARCSINE (see page 91) - Arcsine of an input (in radians).
 ARCTANGENT (see page 92) - Arctangent of an input (in radians).
 CALCBLOCK (see page 129) - Defines a mathematical calculation using a list of operators.
 CALCBLOCKD (see page 138) - Defines a mathematical calculation using a list of operators
(performs logical functions only).
 COSINE (see page 147) - Cosine of an input (in radians).
 DIVIDE (see page 243) - Divides two gained and biased inputs.
 FUNCTION (see page 298) - Twelve breakpoint function generator.
 GAINBIAS (see page 302) - Limits a gained and biased input.
 INTERP (see page 328) - Provides a linear table lookup and interpolation function.
 LOG (see page 345) - Base10 logarithm and bias.
 MULTIPLY (see page 397) - Multiplies two gained and biased inputs.
 NLOG (see page 405) - Natural logarithm with bias.
 POLYNOMIAL (see page 448) - Fifth order polynomial equation.
 SINE (see page 535) - Sine of an input (in radians).
 SQUAREROOT (see page 571) - Square root of a gained and biased input.
 STATISTICS (see page 575) - Calculates variance and standard deviation of input samples,
based on values from TW (time window).
 SUM (see page 603) - Adds four gained and biased inputs.
 TANGENT (see page 608) - Tangent of an input (in radians).
 LONGACC (see page 346) - Calculates integral counters with high precision.

32 OW360_R1100
 4.14 Migrated special function algorithms

4.14 Migrated special function algorithms

Description

Migrated special function algorithms are used in the process of upgrading a system from WDPF
to Ovation, while still using the original Q-Line wiring and/or Q-Line I/O cards.

Typically, ladders are used only by Migration projects. After a system has been migrated, any
ladder logic that was used in the original system is preserved in the new Ovation system, and
may need to be edited.

Note: Information on Migrated special function algorithms can be found in Ovation Q-Line and
Specialty Algorithm Reference Manual.

Common uses

Migrated special function algorithms have the following uses:

 Upgrade a system from WDPF to Ovation.

Commonly used algorithms of this type

 MODETRANS - Transfers the Ovation tracking point status bit information (bits 16 - 32
stored in the 3W field) to an Ovation packed point.
 SETSTATES - Sets tracking bits in the Ovation tracking point based on the inputs that are
connected.

OW360_R1100 33
4.15 Modulating Control algorithms

4.15 Modulating Control algorithms

Description

Modulating control algorithms implement modulating control strategies, such as level control,
feedwater control, flow/temperature controls, and so forth.

Common uses

Modulating control algorithms have the following uses:

 Implement modulating control scheme with balancing functions, selection functions, override
functions, proportional, integral and derivative functions, and operator interface functions.

Commonly used algorithms of this type

 BALANCER (see page 97) - Controls up to 16 downstream algorithms.
 DISTRIBUTOR (see page 220) - Distributes an input signal (IN) into two or more (up to eight)
analog outputs (OUTx).
 FUNCTION (see page 298) - Twelve breakpoint function generator.
 HISELECT (see page 319) - Selects the greater of two gained and biased inputs.
 LOSELECT (see page 357) - Selects the smaller of four gained and biased inputs.
 MAMODE (see page 363) - Logic interface to MASTATION.
 MASTATION (see page 366) - Interface between a soft manual/auto station and the
functional processor.
 PID (see page 420) - Proportional plus integral plus derivative controller
 PIDFF (see page 435) - Proportional plus integral plus derivative controller with feed forward.
 PREDICTOR (see page 450) - Compensate for pure time-delay.
 RAMPGEN (see page 483) - Ramps its output to follow a setpoint target when in automatic
mode, or it ramps the output up or down at a fixed rate in manual mode.
 SETPOINT (see page 531) - Soft and/or hard manual loader station.
 TRANSFER - Selects a gained and biased input based on a flag.
See also Tracking algorithms (see page 46).

34 OW360_R1100
 4.16 Monitor Function algorithms

4.16 Monitor Function algorithms

Description

Monitor function algorithms monitor point status with certain criteria such as limits, quality, and
transitions. These algorithms create discrete logic that can be used for program flow control.

Common uses

Monitor function algorithms have the following uses:

 Generate flags based on process conditions.
 Trigger control actions.
 Monitor signal status.

Commonly used algorithms of this type

 COMPARE (see page 146) - Floating point compare.
 COMPARATOR (see page 144) - Floating point compare.
 DBEQUALS (see page 150) - Deviation monitor between two variable inputs.
 DIGCOUNT - Digital counter with flag.
 HIGHLOWMON (see page 316) - High and low signal monitor with reset deadband and
fixed/variable limit.
 HIGHMON (see page 317) - High signal monitor with reset deadband and a fixed/variable
limit.
 LOWMON (see page 362) - Low signal monitor with reset deadband and a fixed/variable limit.
 PULSECNT (see page 480) - Pulse count.
 QUALITYMON (see page 482) - Quality check one input.
 RATECHANGE (see page 487) - Rate of change transform.
 RATELIMIT (see page 489) - Rate limiter with fixed rate limit and flag when rate limit is
exceeded.
 RATEMON (see page 493) - Rate of change monitor with reset deadband and fixed/variable
rate limit.
 SOFTSOE (see page 560) - Allows a Sequence of Events (SOE) to be generated by software
in control sheets.

OW360_R1100 35
4.17 Operator Interface algorithms

4.17 Operator Interface algorithms

Description

Operator interface algorithms are control function algorithms that provide a means for the
operator to interact with the control system.

Common uses

Operator interface algorithms have the following uses:

 Provide a mechanism to actuate functions in the control scheme.
 Generate control commands.
 Dynamically move process set points.
 Interface to external loop controllers and drives.
 Auctioneer between multiple control signals.

Commonly used algorithms of this type

 BUFFER (see page 116) - Gathers the value and status of a point and associates a
timestamp with this information.
 FACEPLATE (see page 278) - Generic algorithm used to collect all inputs necessary for a
graphic faceplate.
 KEYBOARD (see page 332) - Programmable/function key interface - P1 through P10 to
control key interface.
 MASTATION (see page 366) - Interface between a soft manual/auto station and the
functional processor.
 MEDIANSEL (see page 389) - Monitors analog transmitter inputs for quality and deviation
from each other.
 SETPOINT (see page 531) - Soft and/or hard manual loader station with an interface to the
RLI card setpoint.
 XMA2 - Interface between a soft manual/auto station and a QAM, QAA, or QLI card and the
functional processor.
 XML2 - Soft and/or hard manual loader station with an interface to the QAM or QLI card
setpoint.
 2XSELECT (see page 669) - Selects and monitors two transmitter signals.
Also see Device control algorithms (see page 26).

Note: Refer to Ovation Q-Line and Specialty Algorithms Reference Manual for information on
the XMA2 and XML2 algorithms.

36 OW360_R1100
 4.18 Point Format Conversion algorithms

4.18 Point Format Conversion algorithms

Description

Point format conversion algorithms provide the means to translate point values from one data
structure to another.

Common uses

Point format conversion algorithms have the following uses:

 Change a point name.
 Transfer to/from a binary-coded decimal (BCD).
 Manipulate packed signals.

Commonly used algorithms of this type

 BCDNIN (see page 103) - Inputs n BCD digits to the functional processor from the DIOB.
 BCDNOUT (see page 105) - Outputs n BCD digits from the functional processor to the I/O
bus.
 PACK16 (see page 416) - Packs up to 16 digital point values into a packed digital record.
 SATOSP (see page 528) - Transfers analog values to a packed digital record.
 SPTOSA (see page 570) - Transfers packed digital values to an analog record.
 TRANSLATOR (see page 622) - Translates the output based on the input of a predefined
table.
 UNPACK16 (see page 655) - Unpacks up to 16 digital point values from a packed digital
record.

OW360_R1100 37
4.19 Pulse Accumulator Module Interface algorithms

4.19 Pulse Accumulator Module Interface algorithms

Description

Pulse accumulator module interface algorithms read and reset accumulator pulses in the Ovation
Pulse Accumulator card.

Common uses

Pulse accumulator module interface algorithms have the following uses:

 Read the status for the pulse accumulator module.
 Write commands to the pulse accumulator module.

Commonly used algorithms of this type

 QPACMD - Writes a command byte to a QPA card.
 QPACMPAR - Writes a comparator value to a QPA card.
 QPASTAT - Outputs the digital status from a QPA card.
 RPACNT (see page 502) - Counts pulses from the Pulse Accumulator (PA) card.
 RPAWIDTH (see page 503) - Pulse width from the Pulse Accumulator (PA) card.

Note: Refer to Ovation Q-Line and Specialty Algorithms Reference Manual for information on
the QPACMD, QPACMPAR, and QPASTAT algorithms.

4.20 Redundant Signal Processing algorithms

Description

Redundant signal process algorithms select which signal or which statistic (median, average,
maximum, minimum, and so forth) to use for control in a redundant configuration.

Common uses

Redundant signal processing algorithms have the following uses:

 Auctioneer between multiple control signals.
 Allow manual or automatic selection of the signal to be used for control purposes.

Commonly used algorithms of this type

 MEDIANSEL (see page 389) - Monitors analog transmitter inputs for quality and deviation
from each other.
 SELECTOR (see page 529) - Transfer between n analog inputs, where n < 8.
 TRANSFER - Selects a gained and biased input based on a flag.
 2XSELECT (see page 669) - Selects and monitors two transmitter signals.

38 OW360_R1100
 4.21 Q-Line Interface algorithms

4.21 Q-Line Interface algorithms

Description

Q-Line interface algorithms are used specifically with Q-Line I/O hardware in an Ovation system.
These algorithms are the only Q-Line algorithms supported in Ovation.

Note: Information on Q-Line algorithms can be found in Ovation Q-Line and Specialty Algorithm
Reference Manual.

Common uses

Q-line algorithms have the following use:

 Used in Ovation for compatibility with Q-Line I/O.

Commonly used algorithms of this type

 PVSPSLI - Writes the functional processor-defined process variable (PVAR) and/or set point
(STPT) values to the Q-Line Loop Interface (QLI) for display at the Loop Interface Module
(LIM).
 PWDIN - Converts a digital pulse to an analog value proportional to the width of the pulse.
 QLIPASS - Changes the default station (or loop) number and password number for up to 12
QLI cards
 QPACMD - Writes a command byte to a QPA card.
 QPACMPAR - Writes a comparator value to a QPA card.
 QPASTAT - Outputs the digital status from a QPA card.
 QSDDEMAND - Writes demand and mode to a QSD card.
 QSDMODE - Indicates QSD mode.
 QSRMA - Interface manual/auto station to a QSR card.
 QVP - Interface to a QVP card.
 XFLOW - Calculates a pressure-and-temperature-compensated mass or volumetric flow for
ideal gases.
 XMA2 - Interface between a soft manual/auto station and a QAM, QAA, or QLI card and the
functional processor.
 XML2 - Soft and/or hard manual loader station with an interface to the QAM or QLI card
setpoint.
 XPIDSLI - PID controller with supervisory set point and QLI or QLJ card interface.

OW360_R1100 39
4.22 Safety Instrumented System (SIS) algorithms

4.22 Safety Instrumented System (SIS) algorithms

Description

Safety Instrumented System (SIS) algorithms are used in Safety Instrumented systems. A Safety
Instrumented System (SIS) is a form of process control typically used in industrial processes,
such as those of Power Generation and Waste Water. The SIS performs specified functions in
order to maintain a safe state of a control process when any unacceptable process conditions are
detected.

A safe state is a state of the process operation where the hazardous event cannot occur. The
safe state should be achieved within one-half of the process safety time.

Note: Information on SIS algorithms can be found in Ovation Q-Line and Specialty Algorithm
Reference Manual.

Common uses

SIS algorithms have the following use:

 Used in Ovation SIS Logic Solvers and CHARMs Smart Logic Solvers.

Note: The term "Logic Solver" refers to both the 1508 Logic Solver and the CSLS.

Commonly used algorithms of this type

 LSAI - Accepts a single analog input signal from an input channel and makes it available to
other algorithms
 LSALM - Detects alarm conditions on an analog input you specify.
 LSAND - Generates a digital output value based on the logical AND of 2 to 16 digital inputs.
 LSAVTR - Provides an analog voter function for safety instrumented functions.
 LSBDE - Generates a True (1) digital output when the digital input makes a positive
(False-to-True) or a negative (True-to-False) transition since the last execution of the
algorithm.
 LSBFI - Generates a digital output based on the weighted binary sum, binary coded decimal
(BCD) representation, transition state, or logical OR of one to 16 digital inputs.
 LSBFO - Decodes a binary weighted input to individual bits and generates a digital output
value for each bit.
 LSCALC - Evaluates an expression you define to determine the algorithm's outputs.
 LSCEM - Defines interlock and permissive logic that associates as many as 16 inputs (CSx
Input Cause parameters) and 16 outputs (EFFx Output Effect parameters).
 LSCMP - Compares two values (DSCV and CMPV1 - Input and First Comparative Value
respectively) and sets a Boolean output for each of the following comparisons: LT (Less
Than), GT (Greater Than), EQ (Equal To), NEQ (Not Equal).
 LSDI - Accesses a single digital input from a two-state field device and makes the processed
physical input available to other algorithms.
 LSDO - Drives a Logic Solver output channel (for example, a Digital Output channel) to
manipulate a solenoid or other final element.
 LSDVC - Provides an interface to the Fisher Controls DVC6000ESD digital valve controller for
safety shutdown applications

40 OW360_R1100
 4.22 Safety Instrumented System (SIS) algorithms

 LSDVTR - Provides a digital voter function for safety instrumented functions.

 LSLIM - Limits an input value between two reference values.
 LSMID - Selects the mid-valued input from multiple analog signals.
 LSNAND - Generates a digital output value based on inverting the logical AND of two to 16
digital inputs.
 LSNDE - Generates a True (1) digital output when the digital input makes a negative
(True-to-False) transition since the last execution of the algorithm
 LSNOR - Generates a digital output value based on inverting the logical OR of two to 16
digital inputs.
 LSNOT - Logically inverts a digital input signal and generates a digital output value.
 LSOFFD - Delays the transfer of a False (0) digital input value to the output by a specified
time period.
 LSOND - Delays the transfer of a True (1) digital input value to the output by a specified time
period.
 LSOR - Generates a digital output value based on the logical OR of two to 16 digital inputs.
 LSPDE - Generates a True (1) digital output when the digital input makes a positive
(False-to-True) transition since the last execution of the algorithm.
 LSRET - Generates a True (1) digital output after the input has been True for a specified time
period.
 LSRS - Generates a digital output value based on NOR logic of reset and set inputs.
 LSSEQ - Associates system states with actions.
 LSSR - Generates a digital output value based on NAND logic of set and reset inputs.
 LSSTD - Implements a user-defined state machine in the Logic Solver.
 LSTP - Generates a True (1) digital output for a specified time duration when the input makes
a positive (False-to-True) transition.
 LSXNOR - Performs an exclusive OR of two inputs, then performs a NOT on that result to
produce an output.
 LSXOR - Performs an exclusive OR of two inputs to produce an output that is True if one, and
only one, of the inputs is true.
 GSECPARAMREF - Is used as a connector and accepts points into a sheet from another
sheet that belongs to a different SIS Data Server and accepts data from a SECPARAM
algorithm via fiber-optic repeaters.
 NONSECPARAM - Is used as a connector and accepts points into a sheet from outside the
SIS network.
 SECPARAM - Is used as a connector and accepts points into a sheet from inside a SIS Data
Server and transfers data to a SECPARAMREF algorithm
 SECPARAMREF - Is used as a connector, and works in conjunction with the SECPARAM
algorithm.

OW360_R1100 41
4.23 Sequential Logic algorithms

4.23 Sequential Logic algorithms

Description

Sequential logic algorithms help you control processes that are sequential in nature and follow a
predetermined set of steps.

Common uses

Sequential logic algorithms have the following uses:

 Implement sequential logic.
 Selection of a specified output based on different input steps.
 Implement the step control functions.

Commonly used algorithms of this type

 ANALOGDRUM (see page 80) - Drum controller with two analog outputs or with one analog
output.
 DEVICESEQ (see page 170) - Sequencer using MASTER/DEVICE arrangement.
 DIGDRUM (see page 195) - Drum controller with 16 digital outputs.
 FIFO (see page 289) - Transaction queue; first in - first out.
 FIRSTOUT (see page 291) - Monitors up to 16 digital inputs and provides an indication of the
first digital input to transition from zero to one.
 MASTERSEQ (see page 376) - Sequencer using MASTER/DEVICE arrangement.
 PRIORITY (see page 454) - Consolidates complex logic to perform priority-based sequencing
when turning devices ON and OFF.
 PRIORITY-EXT (see page 470) - Dynamically calculates external priorities and is designed
for use with the Priority algorithm.
 PRIORITY-REJ (see page 475) - Provides a method to manage load rejection up to a
predefined number of devices and is designed for use with the Priority algorithm.
 STEPTIME (see page 597) - Automatic step timer.
 TRANSLATOR (see page 622) - Translator.
 TRNSFNDX (see page 629) - Selects output analog value from up to 64 outputs which hold
the input.

42 OW360_R1100
 4.24 Signal Compensation algorithms

4.24 Signal Compensation algorithms

Description

Signal compensation algorithms adjust the input signal based on density, volume, enthalpy, and
so forth in order to provide a true indication of the process value.

Common uses

Signal compensation algorithms have the following uses:

 Condition input signals to provide a true reading of the variable.
 Provide easy access to the steam tables to use for thermal dynamic conversions.
 Determine level and flow compensations based on density.

Commonly used algorithms of this type

 BILLFLOW (see page 107) - Calculates gas flow.
 GASFLOW (see page 306) - Calculates a pressure and temperature compensated mass or
volumetric flow.
 LEVELCOMP (see page 341) - Calculates the density compensated water level in a
pressurized steam drum.
 STEAMFLOW (see page 592) - Flow compensation.
 STEAMTABLE (see page 594) - Calculates thermodynamic properties of water and steam.
 HSCLTP (see page 324) - Calculates Enthalpy (H) and Entropy (S) of Compressed Liquid
given its Temperature and Pressure.
 HSLT (see page 325)- Calculates Enthalpy (H) of Saturated Liquid given its Temperature.
 HSTVSVP (see page 326) - Calculates Enthalpy (H), Entropy (S), Temperature, and
Specific Volume of Saturated Vapor given its Pressure.
 HSVSSTP (see page 327) - Calculates Enthalpy (H), Entropy (S), and Specific Volume of
Superheated Steam given its Temperature and Pressure.
 PSLT (see page 478) - Calculates Pressure of Saturated Liquid given its Temperature.
 PSVS (see page 479) - Calculates Pressure of Saturated Vapor given its Entropy (S).
 SSLT (see page 574) - Calculates Entropy (S) of Saturated Liquid given its Temperature.
 TSLH (see page 653) - Calculates Temperature for Saturated Liquid given its Enthalpy
(H).
 TSLP (see page 654) - Calculates Saturation Temperature of Saturated Liquid given its
Pressure.
 VCLTP (see page 657) - Calculates Specific Volume of Compressed Liquid given its
Temperature and Pressure.
 VSLT (see page 658) - Calculates Specific Volume of Saturated Liquid given its
Temperature.

OW360_R1100 43
4.25 System Diagnostic algorithms

4.25 System Diagnostic algorithms

Description

System diagnostic algorithms directly interface and set system statuses in order to assist in
troubleshooting and monitoring Ovation points.

Common uses

System diagnostic algorithms have the following use:

 Provide a mechanism to monitor system status and initiate actions in the control system.

Commonly used algorithms of this type

 DROPSTATUS (see page 272) - Drop status record monitor.
 HEARTBEAT (see page 313) - Generates heartbeat signals that can be received by other
drops.
 LATCHQUAL (see page 335) - Latches and unlatches the quality of an input analog or digital
point.
 PNTSTATUS (see page 446) - Point status.
 DXCSTATUS (see page 250) - Reconciles the module’s tuning parameters.
For more information, refer to the Ovation Standard Algorithms Reference Manual.

4.26 System Time Function algorithms

Description

System time function algorithms read the UTC system clock and allow you to perform functions
based on time.

Common uses

System time function algorithms have the following use:

 Provide access to the system clock to implement time-related functions.

Commonly used algorithms of this type

 SYSTEMTIME (see page 607) - Stores system date and time in analog points.
 TIMECHANGE (see page 609) - Time change.
 TIMEDETECT (see page 610) - Time detector.
 TIMEMON (see page 611) - Pulse digital points based on the system time.

44 OW360_R1100
 4.27 Time/Counter Function algorithms

4.27 Time/Counter Function algorithms

Description

Timer/Counter function algorithms execute actions based on user-specified time input. These
algorithms manipulate an output based on time.

Common uses

Time/counter function algorithms have the following uses:

 Implement timing functions in the control scheme (such as delays and pulses).
 Monitor loop count to determine functions such as equipment running time.

Commonly used algorithms of this type

 COUNTER (see page 148) - Interface up/down counter.
 OFFDELAY (see page 407) - Pulse stretcher.
 ONDELAY (see page 409) - Pulse timer.
 ONESHOT (see page 411) - Digital one-shot pulse.
 RESETSUM (see page 495) - Accumulates until told to reset.
 RUNTIME (see page 516) - Counts long lasting service times of devices.
 TIMEMON (see page 611) - Pulse digital points based on the system time.
 Safety Shell Status (SS_STATUS) - Displays the Safety Shell fault counts related to a
specified originating drop.

OW360_R1100 45
4.28 Tracking algorithms

4.28 Tracking algorithms

Description

The tracking algorithms support tracking. Tracking may be defined as aligning a portion of a
control system that is not in control to the portion of the control system that is in control. Tracking
is used to prevent bumps and to reduce process upsets. Tracking algorithms support tracking
through dual-purpose inputs and outputs (that is, the track value in the AV field).

Common uses

Tracking algorithms have the following uses:

 Keep the system aligned while manual changes are performed in order to prevent bumps.
 Balance several large pieces of equipment in a plant.
 Maintain major plant loops inside their designed range of operation.

Commonly used algorithms of this type

 ANALOG DEVICE (ADEVICE) (see page 77) - Interfaces to local analog loop controllers.
 BALANCER (see page 97) - Controls up to 16 downstream algorithms.
 DIVIDE (see page 243) - Divides two gained and biased inputs.
 FFAI - Foundation Fieldbus analog input.
 FFAO - Foundation Fieldbus analog output.
 FFDI - Foundation Fieldbus digital input.
 FFDO - Foundation Fieldbus digital output.
 FFMAI - Foundation Fieldbus multiple analog input.
 FFPID - Foundation Fieldbus PID.
 FIELD (see page 287) - Writes value to I/O point.
 FUNCTION (see page 298) - Two-segment function generator.
 GAINBIAS (see page 302) - Limits a gained and biased input.
 GASFLOW (see page 306) - Calculates a pressure and temperature compensated mass or
volumetric flow.
 HISELECT (see page 319) - Selects the greater of two gained and biased inputs.
 LEADLAG (see page 337) - Lead/lag compensator.
 LOSELECT (see page 357) - Selects the smaller of four gained and biased inputs.
 MASTATION (see page 366) - Interface between a soft manual/auto station and the
functional processor.
 MULTIPLY (see page 397) - Multiplies two gained and biased inputs.
 PID (see page 420) - Proportional plus integral plus derivative controller.
 PIDFF (see page 435) - Proportional plus integral plus derivative controller with feed forward.
 QSRMA - Interface manual/auto station to a QSR card.
 RATELIMIT (see page 489) - Rate limiter with fixed rate limit and flag when rate limit is
exceeded.
 SETPOINT (see page 531) - Soft and/or hard manual loader station with an interface to the
RLI card setpoint.

46 OW360_R1100
 4.29 Turbine Interface algorithms

 SETSTATES - Sets tracking bits in the Ovation tracking point based on the inputs that are
connected.
 SQUAREROOT (see page 571) - Square root of a gained and biased input.
 SUM (see page 603) - Adds four gained and biased inputs.
 TRANSFER - Selects a gained and biased input based on a flag.
 XMA2 - Interface between a soft manual/auto station and a QAM, QAA, or QLI card and the
functional processor.
 XML2 - Soft and/or hard manual loader station with an interface to the QAM or QLI card
setpoint.
 X3STEP (see page 660) - Controls devices which must be kept within a certain tolerance.
 PERSISVAL (see page 418) - Tracks the number of times a pump or a motor starts.

Note: Refer to Ovation Q-Line and Specialty Algorithms Reference Manual for information on
the Foundation Fieldbus, QSRMA, XMA2, and XML2 algorithms.

4.29 Turbine Interface algorithms

Description

Turbine interface algorithms allow communication to the Ovation I/O interfaces and to hydraulic
servos dedicated to position control of process control valves.

Common uses

Turbine interface algorithms have the following uses:

 Read and write valve and status information to/from the Ovation RVP card.
 Read and write valve and status information to/from the Ovation QVP card.
 Read and write status information to/from the Ovation Servo Driver card.

Commonly used algorithms of this type

 MASTATION (see page 366) - Interfaces between a soft manual/auto station and the
functional processor. This has been used to interface to the RVP I/O module in early Ovation
releases.
 QVP - Interfaces to a QVP card.
 QSRMA - Interfaces to the QSR card.
 RSRSTATUS (see page 504) - Reads the RSR card status and information.
 RVPSTATUS (see page 522) - Reads the RVP card status and information.
 XMA2 - Interfaces between a soft manual/auto station and a QAM, QAA, QLI, or QVP card
and the functional processor.

Note: Refer to Ovation Q-Line and Specialty Algorithms Reference Manual for information on
the QVP and QSRMA algorithms.

OW360_R1100 47
 S E C T I O N 5

5 Standard algorithm reference pages

..

IN THIS SECTION

Understanding algorithm descriptions ............................................................................... 52

AAFLIPFLOP..................................................................................................................... 54
ABSVALUE ....................................................................................................................... 56
ALARMLIMIT ..................................................................................................................... 57
ALARMMON...................................................................................................................... 62
ALGFIELD ......................................................................................................................... 64
ANALOG DEVICE (ADEVICE) .......................................................................................... 77
ANALOGDRUM................................................................................................................. 80
AND ................................................................................................................................... 84
ANNUNCIATOR ................................................................................................................ 85
ANTILOG ........................................................................................................................... 88
ARCCOSINE ..................................................................................................................... 90
ARCSINE .......................................................................................................................... 91
ARCTANGENT .................................................................................................................. 92
ASSIGN ............................................................................................................................. 93
ATREND ............................................................................................................................ 94
AVALGEN ......................................................................................................................... 96
BALANCER ....................................................................................................................... 97
BCDNIN ........................................................................................................................... 103
BCDNOUT ....................................................................................................................... 105
BILLFLOW ....................................................................................................................... 107
Boolean Algorithms with Quality Propagation ................................................................. 109
BUFFER .......................................................................................................................... 116
CALCBLOCK................................................................................................................... 129
CALCBLOCKD ................................................................................................................ 138
COMPARATOR............................................................................................................... 144
COMPARE ...................................................................................................................... 146
COSINE ........................................................................................................................... 147
COUNTER ....................................................................................................................... 148
DBEQUALS ..................................................................................................................... 150
DEVICE ........................................................................................................................... 152
DEVICESEQ ................................................................................................................... 170
DEVICEX ......................................................................................................................... 174
DFIELD ............................................................................................................................ 192
DIGCOUNT ..................................................................................................................... 193
DIGDRUM ....................................................................................................................... 195
DIGITAL DEVICE ............................................................................................................ 201
DISTRIBUTOR ................................................................................................................ 220
DIVIDE ............................................................................................................................ 243
DRPI1A ........................................................................................................................... 247
DVALGEN ....................................................................................................................... 249

OW360_R1100 49
4.29 Turbine Interface algorithms

DXCSTATUS................................................................................................................... 250
DROPSTATUS ................................................................................................................ 272
ELCCONTROL ................................................................................................................ 275
FACEPLATE ................................................................................................................... 278
FIELD .............................................................................................................................. 287
FIFO ................................................................................................................................ 289
FIRSTOUT ...................................................................................................................... 291
FLIPFLOP ....................................................................................................................... 296
FUNCTION ...................................................................................................................... 298
GAINBIAS ....................................................................................................................... 302
GASFLOW ...................................................................................................................... 306
HEARTBEAT ................................................................................................................... 313
HIGHLOWMON ............................................................................................................... 316
HIGHMON ....................................................................................................................... 317
HISELECT ....................................................................................................................... 319
HSCLTP .......................................................................................................................... 324
HSLT ............................................................................................................................... 325
HSTVSVP ........................................................................................................................ 326
HSVSSTP ........................................................................................................................ 327
INTERP ........................................................................................................................... 328
KEYBOARD .................................................................................................................... 332
LATCHQUAL ................................................................................................................... 335
LEADLAG ........................................................................................................................ 337
LEVELCOMP .................................................................................................................. 341
LOG ................................................................................................................................. 345
LONGACC ....................................................................................................................... 346
LOSELECT ...................................................................................................................... 357
LOWMON ........................................................................................................................ 362
MAMODE ........................................................................................................................ 363
MASTATION ................................................................................................................... 366
MASTERSEQ .................................................................................................................. 376
MEDIANSEL.................................................................................................................... 389
MULTIPLY ....................................................................................................................... 397
MULTISWITCH ............................................................................................................... 400
NLOG .............................................................................................................................. 405
NOT ................................................................................................................................. 406
OFFDELAY ..................................................................................................................... 407
ONDELAY ....................................................................................................................... 409
ONESHOT ....................................................................................................................... 411
OR ................................................................................................................................... 415
PACK16 ........................................................................................................................... 416
PERSISVAL .................................................................................................................... 418
PID .................................................................................................................................. 420
PIDFF .............................................................................................................................. 435
PNTSTATUS ................................................................................................................... 446
POLYNOMIAL ................................................................................................................. 448
PREDICTOR ................................................................................................................... 450
PRIORITY Algorithm Package ........................................................................................ 454
PSLT ............................................................................................................................... 478
PSVS ............................................................................................................................... 479
PULSECNT ..................................................................................................................... 480
QAVERAGE .................................................................................................................... 481
QUALITYMON................................................................................................................. 482
RAMPGEN ...................................................................................................................... 483
RATECHANGE ............................................................................................................... 487
RATELIMIT ...................................................................................................................... 489

50 OW360_R1100
 4.29 Turbine Interface algorithms

RATEMON ...................................................................................................................... 493

RESETSUM .................................................................................................................... 495
RLICONFIG ..................................................................................................................... 498
RPACNT .......................................................................................................................... 502
RPAWIDTH ..................................................................................................................... 503
RSRSTATUS................................................................................................................... 504
RUNAVERAGE ............................................................................................................... 514
RUNTIME ........................................................................................................................ 516
RVPSTATUS ................................................................................................................... 522
SS_STATUS ................................................................................................................... 525
SATOSP .......................................................................................................................... 528
SELECTOR ..................................................................................................................... 529
SETPOINT ...................................................................................................................... 531
SIMTIME ......................................................................................................................... 535
SINE ................................................................................................................................ 535
SLCAIN ........................................................................................................................... 536
SLCAOUT ....................................................................................................................... 539
SLCDIN ........................................................................................................................... 542
SLCDOUT ....................................................................................................................... 545
SLCPIN ........................................................................................................................... 548
SLCPOUT ....................................................................................................................... 551
SLCSTATUS ................................................................................................................... 554
SMOOTH ......................................................................................................................... 558
SOFTSOE ....................................................................................................................... 560
SPTOSA .......................................................................................................................... 570
SQUAREROOT ............................................................................................................... 571
SSLT ............................................................................................................................... 574
STATISTICS.................................................................................................................... 575
STEAMFLOW .................................................................................................................. 592
STEAMTABLE................................................................................................................. 594
STEPTIME ...................................................................................................................... 597
SUM ................................................................................................................................ 603
SYSTEMTIME ................................................................................................................. 607
TANGENT ....................................................................................................................... 608
TIMECHANGE ................................................................................................................ 609
TIMEDETECT ................................................................................................................. 610
TIMEMON ....................................................................................................................... 611
TRANSFER ..................................................................................................................... 614
TRANSLATOR ................................................................................................................ 622
TRANSPORT .................................................................................................................. 627
TRNSFINDX .................................................................................................................... 629
TRUTHTBL ...................................................................................................................... 630
TRVP ............................................................................................................................... 633
TRVPTUNE ..................................................................................................................... 646
TSLH ............................................................................................................................... 653
TSLP ............................................................................................................................... 654
UNPACK16 ..................................................................................................................... 655
VCLTP ............................................................................................................................. 657
VSLT ............................................................................................................................... 658
XOR ................................................................................................................................. 659
X3STEP ........................................................................................................................... 660
2XSELECT ...................................................................................................................... 669

OW360_R1100 51
5.1 Understanding algorithm descriptions

5.1 Understanding algorithm descriptions

Most of the algorithm reference pages contain the following information (where applicable):
 Description - Describes the algorithm's operation.
 Invalid Real Numbers and Quality - Describes how quality is set.
 Functional Symbol - Illustrates (in pictorial form) the algorithm's operation. See Algorithm
functional symbols (see page 9).
 Control Builder Symbols -- Shows how the algorithm will appear in the Control Builder and
Signal Diagram programs.
 Algorithm Record Type (if required) - Defines the type and size of the record generated for
storing parameters and other information necessary to the algorithm. (See Ovation Record
Types Reference Manual.)
 Algorithm Definitions - Provides the following information on the algorithm:
 Names of the parameters used.
 Algorithm record field used by each tuning constant or data initialization parameter; also,
the type of entry required in this field (integer, byte, or real).
 Parameter types such as those described below:
 Variable = Input or output signal to the algorithm (that is, analog or digital).
 Tuning Constant = Fixed parameter that remains constant unless it is changed by the
user at the Operator's Station or Control Builder.
 Data Initialization Parameter = Fixed constant that cannot be changed by the user at
the Operator's Station but can be changed by the Control Builder.
 Selectable = Can be either a Tuning constant in an algorithm record field or a point
record.
 Reconcilable Constant = Parameter can be tuned and reconciled through a special,
project-specific diagram.
 Algorithm Initialization = Internal parameter that is exposed by the algorithm.
 Definition of whether the parameter is required or optional.
If the parameter is optional and not initialized by the user, it defaults to zero.
If there are input points to the algorithm that are optional and not initialized by the user,
they have a value of zero for analog points and FALSE for digital inputs.
 Default value (if applicable).
 Brief description of the parameter.
 Minimum point record required by each variable.
Each algorithm defines the minimum size point record that can be used for each
algorithm input or output.
The quality (see page 4) of the points is set BAD when a detectable hardware failure is
encountered. This information can be used in control strategies or for alarming purposes
by detecting BAD quality using the QUALITYMON series of algorithms.
 Function - Explains the algorithm's operation in terms of a mathematical equation.
 Application Example - Provides an example to demonstrate the use of the algorithm.
 Miscellaneous Sections - Applicable to a specific algorithm only.

52 OW360_R1100
 5.1 Understanding algorithm descriptions

5.1.1 Algorithm functional symbols

The following table lists the items used in the algorithm functional symbols:

Functional symbols items description

FUNCTIONAL DESCRIPTION
SYM BOL

Required Analog (LA record type) input or output (solid line and solid
arrowhead).
Required Digital or Packed Digital (LD or LP record type) input or output (solid
line and hollow arrowhead).
Required Algorithm (LC record type) input or output (solid line and line
arrowhead).
Required Drop (DU) input or output (solid line and no arrowhead).

Optional or Selectable Analog (LA record type) input or output (dashed line and
solid arrowhead).
Optional or Selectable Digital or Packed Digital (LD, LP record type) input or
output (dashed line and hollow arrowhead).
Optional or Selectable Algorithm (LC record type) input or output (dashed line
and line arrowhead.
Optional or Selectable Drop (DU record type) input or output (dashed line and
no arrowhead)

Note: Symbols portrayed in this manual only serve as an example and can be configured
differently depending on the number and type of pins that are used. The Control Builder
application may show various symbol configurations of the same algorithm and may not directly
match what is shown in this document.

OW360_R1100 53
5.2 AAFLIPFLOP

5.2 AAFLIPFLOP
Description

The AAFLIPFLOP algorithm simulates a memory device whose output state is inverted by each
momentary TRUE signal on SRST (that is, the output state OUT is inverted when there is a
transition in the input SRST from a FALSE to a TRUE signal). OUT is set to FALSE anytime the
reset digital input signal RSET is TRUE.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

INIT - Variable Optional - Initial Value LD, LP

SRST - Variable Required - Input (digital) LD, LP

RSET - Variable Required - Reset Input LD, LP

(digital)
OUT - Variable Required - Output (digital) LD, LP

54 OW360_R1100
 5.2 AAFLIPFLOP

Function

RSET OLD SRST SRST OUT

0 0 0 S

0 0 1 T

0 1 0 S

0 1 1 S

1 X X 0

where:

X = Value can be 0 or 1.
S = Output remains in the same or previous state.
T = Output toggles from the previous state.
OLD SRST = Value of the SRST input on the previous loop executed by the functional
processor.
On the first pass, OUT is set to FALSE if RSET is TRUE. Otherwise, OUT is set as follows:
 If the optional INIT input is initialized by the user, OUT is set to the value of INIT.
 If INIT is not initialized or has BAD quality on the first pass, OUT remains in the same
state. OUT is set to FALSE on power up/reset unless it is initialized to TRUE by the user
in the program.

OW360_R1100 55
5.3 ABSVALUE

5.3 ABSV ALUE

Description

The output for the ABSVALUE algorithm is the absolute value of input IN1.

The value of IN1 is checked for invalid real numbers. If IN1 is valid, the quality of IN1 is
propagated to the quality of OUT and the real number value of OUT is written to the point record.

Invalid Numbers and Quality

If the value of IN1 is invalid or if the calculated value of OUT written to the point record is invalid,
the quality and the reason are set to BAD.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

Function

OUT = ABS(IN1)

56 OW360_R1100
 5.4 ALARMLIMIT

5.4 AL ARMLIMIT
Description

The ALARMLIMIT algorithm allows logic to be driven using alarm limits and values produced by
analog points.

Functional symbol

Alarm Limit Value (ALVAL)

The alarm limit value (ALVAL) parameter can be configured to output the current selected Limit
Type (LTYPE). This value is also stored in the Alarm Limit (ALIM) field. The ALIM field allows you
to reconcile the alarm limit to the control sheet for documentation purposes.

If the selected limit is not defined in the input point (as determined by the LB record field), the
algorithm will set ALVAL to 0 and BAD quality.

Note: Alarm Limits can be defined as values or points. In the case of a point, the algorithm will
use the value of the point during the executed control cycle.

Alarm Active (ACT)

The alarm active (ACT) output is set depending on the following three parameters: ATYPE,
LTYPE, and QUAL.

Alarm Type (ATYPE)

The chosen alarm type (ATYPE) determines how alarm limits and alarm cutouts should be
monitored.

Alarm types

ATYPE DESCRIPTION

LQ Monitor Limit and Quality defined by LTYPE and QUAL.

LQC Monitor Limit and Quality defined by LTYPE and QUAL. Cutout bit is also
monitored. If a point is cutout, the algorithm will not set ACT output.
ALMQC Monitor Limit (including lower alarm limits) and Quality defined by QUAL. The
cutout bit is also monitored. If a point is cutout, the algorithm will not set the
ACT output.

Note: If you choose ALMQC, the algorithm monitors the selected limit in LTYPE, and any lower
defined limits. For instance, if you choose LOW2, the algorithm monitors LOW2, LOW3, and
LOW4. The user-defined high and low limits are exempt from this and will only be monitored if
specifically selected.

OW360_R1100 57
5.4 ALARMLIMIT

Limit Type (LTYPE)

The chosen limit type (LTYPE) determines what limit the algorithm will use to determine if the
input point is in alarm. Deadbands are taken into account as well, using the same definition as the
DB and DJ record fields. Refer Ovation Record Types Reference Manual for more information.

Limit types

LTYPE LIMIT FIELD DESCRIPTION

HIGH_UD UH User-defined high limit.

HIGH1 HL High limit 1.
HIGH2 ZH High limit 2.
HIGH3 3Y High limit 3.
HIGH4 4Y High limit 4.
LOW_UD UL User-defined low limit.
LOW1 LL Low limit 1.
LOW2 ZL Low limit 2.
LOW3 3Z Low limit 3.
LOW4 4Z Low limit 4.

Configured Quality (QUAL)

The configured quality parameter (QUAL) determines how quality is used in the calculation of the
ACT output. The QUAL table in the template describes the QUAL parameter options. For
instance, if "Value and GOOD quality" are selected, the output will be set to true if the LTYPE is
satisfied and the point quality is GOOD. If "Value or BAD quality" is selected, the output will be set
to true if the LTYPE is satisfied or the quality is BAD.

Quality parameter

QUAL DESCRIPTION

LTYPE Alarm using LTYPE only; quality ignored.

LTYPE or BAD Alarm using LTYPE or BAD quality.
LTYPE or BAD, POOR Alarm using LTYPE or BAD or POOR quality.
LTYPE or BAD, POOR, FAIR Alarm using LTYPE or BAD or POOR, FAIR quality.
LTYPE and GOOD Alarm using LTYPE and GOOD quality.
LTYPE and GOOD, FAIR Alarm using LTYPE and GOOD or FAIR quality.
LTYPE and GOOD, FAIR, POOR Alarm using LTYPE and GOOD, FAIR, or POOR quality.

58 OW360_R1100
 5.4 ALARMLIMIT

Output Quality

Point quality is not propagated. If the selected LTYPE is currently not defined in the attached
analog input point (LB field), then the ALVAL output will go to zero (0), and the ACT output will
reset. Both outputs will also go to BAD quality.

SID Storage

In order to assist with graphics programming, all input and output point SIDs are stored in fields in
the algorithm. This allows the graphic to access multiple SIDs by accessing a single SID (the
algorithm LC record).

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

Inputs:

IN C0 - SID Variable Required -- Analog input point. LA

Outputs:

ALVAL R1 - Value Variable Optional -- Alarm limit value. LA

C1 - SID
ACT G0 - Value Variable Optional -- Alarm active. LD, LP
C2 - SID
Params:

ATYPE B0 - Enum Data Init. Required 0 Alarm Type Parameter: --

 LQ - LTYPE and
QUAL - Value is 0.
 LQC - LTYPE, QUAL,
and cutout. Value is 1.
 ALMQC - LTYPE
including lower limits,
QUAL, and cutout.
Value is 2.

OW360_R1100 59
5.4 ALARMLIMIT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

LTYPE B1 - Enum Data Init. Required 0 Limit Type Parameter: --

 HIGH_UD - UH.
Output is val(UH).
Value is 0.
 HIGH1 - HL. Output is
val(HL). Value is 1.
 HIGH2 - ZH. Output is
val(ZH). Value is 2.
 HIGH3 - 3Y. Output is
val(3Y). Value is 3.
 HIGH4 - 4Y. Output
value is val(4Y). Value
is 4.
 LOW_UD - UL.
Output is val(UL).
Value is 5.
 LOW1 - LL. Output is
val(LL). Value is 6.
 LOW2 - ZL. Output is
val(ZL). Value is 7.
 LOW3 - 3Z. Output is
val(3Z). Value is 8.
 LOW4 - 4Z. Output is
val(4Z). Value is 9.
QUAL B2 - Enum Data Init. Required 0 Configured Quality --
Parameter:
 LTYPE - Value is 0.
 LTYPE or BAD -
Value is 1.
 LTYPE or BAD,
POOR - Value is 2.
 LTYPE or BAD,
POOR, FAIR - Value
is 3.
 LTYPE and GOOD -
Value is 4.
 LTYPE and GOOD,
FAIR - Value is 5.
 LTYPE and GOOD,
FAIR, POOR - Value
is 6.
* ALIM R2 Alg. Init. Variable 0 Alarm limit, same value --
as ALVAL. Used to
reconcile alarm limit to
database.
HDB R3 Alg. Init. Variable 0 High deadband value. --
Used to reconcile alarm
limit for control sheet
display.

60 OW360_R1100
 5.4 ALARMLIMIT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

LDB R4 Alg. Init Variable 0 Low deadband value. --

Used to reconcile alarm
limit for control sheet
display.
* HIAL R5 Alg. Init. Variable 0 High incremental alarm --
limit value. Used to
reconcile alarm limit for
control sheet display.
* LIAL R6 Alg. Init. Variable 0 Low incremental alarm --
limit value. used to
reconcile alarm limit for
control sheet display.
* Even though these parameters are listed as "Alg. Init.," they are reconciled to the control sheet for display
purposes.

OW360_R1100 61
5.5 ALARMMON

5.5 AL ARMMON
Description

The ALARMMON algorithm sets OUT equal to TRUE if any of the inputs are in alarm (alarm
status is TRUE). OUT is set to TRUE if unacknowledged and alarm bits are set in the first status
word of the point or alarm bit is TRUE and unacknowledged is FALSE.

The inputs are optional, numbering from 1 through 16, and may be analog or digital types. The
ALRM flag determines the type of alarm check that the algorithm performs.
 If the ALRM flag is 0 (X1=0), the optional output (FOUT) is set FALSE if no inputs went into
alarm since the last loop. FOUT is set TRUE for one loop when inputs go into alarm.
 If the ALRM flag is 1 (X1=1), the digital output (FOUT) is set TRUE if one or more inputs have
their unacknowledged alarm bit set to TRUE.
 If the ALRM flag is 2 (X1=2), the OUT point is set to a 1 when any of the Inputs are in alarm.
The FOUT point is set to a 1 (for 1 loop) if any of the inputs go into alarm and they were not in
Alarm in the previous loop.
 If the ALRM flag is 3 (X1=3), the OUT point is set to TRUE when any of the input points are in
ALARM. The FOUT point is set to a TRUE whenever any of the input points have both their
'ALARM' and 'unacknowledged' bits set TRUE.

Functional symbol

62 OW360_R1100
 5.5 ALARMMON

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

DIAG LU-Integer Data Init. Required 16 Tuning Diagram -

Number
ALRM X1-Byte Data Init. Optional 0 Type of alarm check: -
0 = New Alarm
1 = Unacknowledged
alarm
2 = New alarm/Any
alarm
3 = Unacknowledged
alarm/Any alarm
IN1 - Variable Optional - Input (analog or LA,
digital) LD
•
•
•
IN16
OUT - Variable Required - Output (digital) LD,
LP
FOUT - Variable Optional - Alarm Check LD,
Output (digital) LP

State change digital points should not be used since the alarm status is set TRUE for each state change.
This is an improper use of this algorithm.

OW360_R1100 63
5.6 ALGFIELD

5.6 ALGFIELD

Description

The ALGFIELD algorithm is designed as a standard OVATION algorithm to read the value of
register from the LC record connected by the ALGLC input pin or LC record SID. It converts the
value to LA, LD, LP or SID type and is presented as an algorithm output.

The ALGFIELD algorithm is implemented as an embedded standard Ovation algorithm. You can
integrate the ALGFIELD algorithm with Operator graphics and other Ovation system applications.

Note: Emerson recommends not to use the ALGFIELD algorithm in the Control Sheet.

The ALGFIELD algorithm has four outputs: LA, LD, LP, and PD. The additional ERR output is
designed to inform about the algorithm status error.

Functional symbol

The following table describes the input and output pins of the ALGFIELD algorithm.

Input and output pins

PIN INPUT OR POINT REQUIRED OR DESCRIPTION

OUTPUT TYPE OPTIONAL

ALGLC Input LC Required Algorithm LC record of

connected algorithm
ISID Input PD Optional Algorithm SID of connected
algorithm
OLA Output LA Optional Analog output value
OLD Output LD Optional Digital output value
OLP Output LP Optional Packed output value
OSID Output PD Optional SID output value
ERR Output LD Optional Error output

64 OW360_R1100
 5.6 ALGFIELD

The following table describes the ALGFIELD algorithm input and output parameters.

Input and output parameters

PARAME TE R VALUE (DEFAULT IN BOLD) DESCRIPTION

BYTE 0: NOT USED Required field in BYTE group

1: X0 9: X8
2: X1 10: X9
3: X2 11: Y0
4: X3 12: Y1
5: X4 13: Y2
6: X5 14: Y3
7: X6 15: Y4
8: X7 16: Y5
INT - Required field in INT group
REAL 0: NOT USED Required field in REAL group
1: R1 17: S8 33: V3
2: R2 18: S9 34: V4
3: R3 19: T1 35: V5
4: R4 20: T2 36: V6
5: R5 21: T3
6: R6 22: T4
7: R7 23: T5
8: R8 24: T6
9: R9 25: T7
10: S1 26: T8
11: S2 27: T9
12: S3 28: U1
13: S4 29: U2
14: S5 30: U3
15: S6 31: V1
16: S7 32: V2

Note: All the parameters are tunable.

Notes: Key notable points about the ALGFIELD algorithm:

 Does not support tracking.

 Outputs are not limited by High limit and Low limit.
 Does not implement any additional actions during first pass.

OW360_R1100 65
5.6 ALGFIELD

5.6.1 ALGFIELD functions

The ALGFIELD algorithm takes access to the LC record of the connected algorithm by the
ALGLC input pin or LC record SID by ISID input pin. The ALGFIELD algorithm reads the value
from the LC record register (field), depending on the register name you set.

There are three groups of records: BYTE, INT and REAL. You can select only one register from
one group. For example, if you select field B0 from INT, the fields from the other group are
configured as NOT_USED.

The following table describes the selected B0 field from INT group.

Selected B0 field from INT group

PARAME TE R VALUE

BYTE NOT_USED
INT B0
REAL NOT_USED

Note: If you select more than one register, then the algorithm takes the register from the last
group.

The following table describes the settings.

All groups used

PARAME TE R VALUE

BYTE X1
INT B0
REAL S2

Note: The ALGFILED algorithm reads the S2 register because the REAL field group is the last
one.

The following are the values from the selected register.

 Analog value on OLA pin.
 Digital value on OLD pin.
 Package value on OLP pin.

Note: The OSID pin presents only the INT registers.

5.6.2 Output points quality

 The quality of the output is set to GOOD.
 The quality of OLA is set to BAD, when the value is invalid (NaN or INF).

66 OW360_R1100
 5.6 ALGFIELD

5.6.3 Error conditions

The following are the conditions when ERR output is set to TRUE.
 ALGLC or ISID pins are not connected,
 When the SID given by the ISID is incorrect, that is, the SID does not exist or it is not part of
the LC record SID, then the ALGFIELD algorithm cannot get access to the connected LC
record.

5.6.4 Algorithm definitions

The following table describes the algorithm definitions.

Algorithm Record Type = LC

Algorithm definitions

LC ALG. MIN.
RECORD REQUIRED/ DEFAULT DESCRIPTION POINT
NAME FIELD TYPE OPTIONAL VALUE REC.

DIAG LU-Integer Data Init Required 120 Displays the -

tuning Diagram
Number.
BYTE X1 - BYTE Tuning Required 0 Displays the -
Constant BYTE field:
0 "NOT_USED"
1 "X0"
…
16 "Y5"
INT X2 - BYTE Tuning Required 0 Displays the INT -
Constant field:
0 "NOT_USED"
1 "G0"
…
60 "XR"
REAL X3 - BYTE Tuning Required 0 Displays the -
Constant REAL field:
0 "NOT_USED"
1 "R1"
…
36 "V6"
ALGLC - Variable Optional - Specifies the LC
Algorithm LC
record
ISID - Variable Optional - Specifies the LC PD
record input SID

OW360_R1100 67
5.6 ALGFIELD

LC ALG. MIN.
RECORD REQUIRED/ DEFAULT DESCRIPTION POINT
NAME FIELD TYPE OPTIONAL VALUE REC.

OLA - Variable Optional - Displays the LA

analog output
OLD - Variable Optional - Displays the LD
Digital output
OLP - Variable Optional - Specifies the LP
packed output
OSID - Variable Optional - Specifies the LC PD
record output SID
ERR - Variable Optional - Displays the error LD
status

5.6.5 Example - Reading the PID algorithm parameter

The example describes how you can read information about the PID (see page 420) parameter
and how to read and propagate the value of the INTG parameter.

Before starting with the procedure, do the following:

 Access the Control Builder online help and navigate to the PID algorithm.
 From the Algorithm definitions table, navigate to the INTG parameter with LC Record Field
R9-Real, and note the Default Value, which is 10.

Figure 1: PID- online help

68 OW360_R1100
 5.6 ALGFIELD

Perform the following steps to read and propagate the value of the INTG parameter.

1. Open the Control sheet and design the following logic, where the PID algorithm is connected
to the ALGFIELD algorithm through the ALGLC (Algorithm Control Record) pin.

Figure 2: Control sheet with connection between PID and ALGFIELD algorithms

2. In the ALGFIELD algorithm Properties Summary dialog box, select the Tuned Value as R9 for
the REAL parameter form the drop-down list.

Figure 3: Properties Summary dialog box for ALGFIELD algorithm

OW360_R1100 69
5.6 ALGFIELD

3. Load the logic and execute the operation. On the Signal Diagram, the ALGFIELD algorithm
displays the INTG value on its output pin OLA.

Figure 4: OLA output pin value

70 OW360_R1100
 5.6 ALGFIELD

5.6.6 Example - Reading the ID number of the currently executed ScStep

algorithm

The example describes how you can read the ID number of the currently executed ScStep
algorithm.

Before starting this procedure, do the following:

 Access the Control Builder online help and navigate to the ScStep algorithm.
 From the Algorithm definitions table, navigate to the STEP parameter with LC Record Field
S1, and note the Default Value, which is 0.

Figure 5: ScStep- online help

OW360_R1100 71
5.6 ALGFIELD

Perform the following steps to read and propagate the value of the INTG parameter.

1. Open the Control sheet and design the following logic, where there is a connection between
three serially connected ScStep algorithm to the single ScTask algorithm and ALGFIELD
algorithm.

Notes:

 Each of the ScStep algorithms must have different values of the STEP parameter.
 Additional settings of ScAction, ScStep and ScTask are not described in this example. The
initial setting for this structure ensures ScStep algorithm execution.

Figure 6: Control sheet with connection between three serially connected ScStep
algorithm to the single ScTask algorithm, and ALGFIELD algorithm

72 OW360_R1100
 5.6 ALGFIELD

2. In the ALGFIELD algorithm Properties Summary dialog box, select the Tuned Value as S1 for
the REAL parameter form the drop-down list.

Figure 7: Properties Summary dialog box for ALGFIELD algorithm

3. Load the logic and execute the operation. On the Signal Diagram, the ALGFIELD algorithm
displays the STEP value on its output pin OLP.

Figure 8: ALGFIELD output pin value

OW360_R1100 73
5.6 ALGFIELD

5.6.7 Example - Reading the STABLE97 AUX LC Record Field from the ALGFIELD
algorithm

The example describes how you can read information from the ALGFIELD algorithm auxiliary
record. This example is based on the STABLE 97 algorithm.

Notes:

 Two ALGFIELD algorithms are used. The first is responsible for reading the SID of the first
AUX record. The second ALGFIELD algorithm reads the field(s): BYTE, INT, or REAL from
the AUX SID record.
 The SID of the first AUX LC record for the STABLE97 algorithm is stored in the ALGFIELD
algorithm's LC record in the field G0.

Perform the following steps to read information about the STABLE 97 AUX LC Record Field from
the ALGFIELD algorithm. In this procedure, you will read the R6 record field from the first AUX LC
record, which is used in STABLE97 algorithm for storing the internal temperature in Standard
International (SI) unit.

1. Open the Control Sheet and design the following logic, where the two ALGFIELD algorithms
are connected to the STABLE97 algorithm.

Figure 9: Control sheet with connection between two ALGFIELD and STABLE97 algorithms

74 OW360_R1100
 5.6 ALGFIELD

2. In the first ALGFIELD algorithm Properties Summary dialog box, select the Tuned Value as
G0 for the REAL parameter form the drop-down list and select the Tuned Value as R6 for the
REAL parameter form the drop-down list.

Figure 10: Properties Summary dialog box for the first ALGFIELD algorithm- G0 field

Figure 11: Properties Summary dialog box for the second ALGFIELD algorithm- R6 field

OW360_R1100 75
5.6 ALGFIELD

3. Load the logic and execute the operation. On the Signal Diagram, the first ALGFIELD
algorithm feeds the SID (G0 field value) of the STABLE97 AUX LC Record field to the second
ALGFIELD algorithm through the ISID pin and the second ALGFIELD algorithm displays the
R6 value on its output pin OLA.

Figure 12: ALGFIELD output pin value

76 OW360_R1100
 5.7 ANALOG DEVICE (ADEVICE)

5.7 AN ALOG DEVICE (ADEVICE)

Description

The Analog Output Device algorithm is used to interface to Motor Control Centers (MCCs). Under
normal operation, the analog device algorithm attempts to control the device.

When the Analog Device algorithm is in AUTO, the error is calculated by taking the feedback
minus the demand times a sensitivity factor. The default sensitivity factor is one. If the error is less
than the inner deadband, the analog output is set to zero. If the error is greater than the outer
deadband, the analog output is set equal to this error. If the error is between the two deadbands,
the error is scaled between zero and one. The closer the error is to the outer deadband, the
closer the scale factor to one. The closer the error is to the inner deadband, the closer the scale
factor is to zero. The output is simply the error multiplied by the scale factor. The output is
clamped to the clamping limits (MAX). The quality of OUT is set to the worst quality of the two
inputs when not in tracking mode.

The shed relay is a copy of the tracking flag (IN3). If the tracking flag (IN3) is reset or the tracking
input indicates that there is tracking, the tracking output is equal to the tracking input. When
tracking, quality is set to the quality of the track input variable.

Tracking Signals

Tracking is performed through signals passed in the upper 16 bits of the third status word of the
analog tracking point. This algorithm takes the following action in response to the information
found in the digital input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed Through

17 Track if Lower No Action Not Used

18 Track if Higher No Action Not Used

19 Lower Inhibit No Action Not Used

20 Raise Inhibit No Action Not Used

21 Conditional Track Implemented Passed Through

22 Not Used No Action Not Used

23 Deviation Alarm No Action Not Used

24 Local Manual Mode No Action Not Used

25 Manual Mode No Action Not Used

26 Auto Mode No Action Not Used

27 Not Used No Action Not Used

28 Not Used No Action Not Used

29 Not Used No Action Not Used

OW360_R1100 77
5.7 ANALOG DEVICE (ADEVICE)

BIT DESCRIPTION ACTION TOUT SIGNAL

30 Low Limit Reached Implemented Passed Through

31 High Limit Reached Implemented Passed Through

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Optional 118 Tuning Diagram -

Number
IN1G R6 Tuning Required 1.0 Demand Gain -
Constant

IN1B R7 Tuning Required 0.0 Demand Bias -

Constant

IN2G R8 Tuning Required 1.0 Feedback Gain -

Constant

IN2B R9 Tuning Required 0.0 Feedback Bias -

Constant

TPSC S1 Tuning Required 100.00 Output Top of -

Constant Scale

BTSC S2 Tuning Required 0.0 Output Bottom -

Constant of Scale

DLAY G0 Tuning Required 0.0 Deviation Time -

Constant Delay

ODBN R1 Tuning Required 0.0 Outer -

Constant Deadband

IDBN R2 Tuning Required 0.0 Inner Deadband -

Constant

MAX R3 Tuning Required 0.0 Maximum -

Constant Output

78 OW360_R1100
 5.7 ANALOG DEVICE (ADEVICE)

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

SENS R4 Tuning Required 1.0 Sensitivity -

Constant

DEVA R5 Tuning Optional 0.0 Deviation -

Constant Deadband

IN1 - Variable Required - Demand LA

TOUT - Variable Required - Tracking Output LA

IN2 - Variable Required - Feedback LA

IN3 - Variable Required - Tracking Flag LD

OUT - Variable Required - Analog Output LA

TRIN - Variable Required - Track Input LA

OUT2/ - Variable Optional - Shed Relay LD

SHED
OUT3/ - Variable Optional - Up Analog LA
OUTU
OUT4/ - Variable Optional - Down Analog LA
OUTD
OUT5 - Variable Optional - Deviation Alarm LD

OW360_R1100 79
5.8 ANALOGDRUM

5.8 AN ALOGDRUM
Description

The ANALOGDRUM algorithm is a software drum controller with one analog output value and up
to 30 steps OR a software drum controller with two analog output values and up to 15 steps. The
output selected is based on the current step number and a list of up to 30 /15 initialized real
values. The current step number may be tracked to a selected step (TRIN) when in tracking mode
(TMOD = TRUE), increased (INC), or decreased (DEC). The current step number is only
increased or decreased on a FALSE to TRUE transition of INC and DEC. The maximum number
of steps must be initialized. When the step number becomes greater than the maximum number
of steps, the current step number is reset to one.

The track input value (TRIN) and output value (OUT) are checked for invalid real numbers. If a
tracking request is received and TRIN is an invalid number, then the tracking request is ignored.
However, the current step can be increased (using INC) or decreased (using DEC) even when
TRIN is an invalid number. If the algorithm calculates an invalid real number output, the value is
invalid and the quality is set to BAD.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init Required 101 Tuning Diagram -

number
INC - Variable Required - Input (digital signal LD, LP
to increase the step
number)
DEC - Variable Required - Input (digital signal LD, LP
to decrease the step
number)
TMOD - Variable Required - Input (digital signal); LD, LP
tracking request

TRIN - Variable Required - Input (analog); tracks LA

the step number to
this value
NMIN X1-Byte Tuning Required 1 Maximum number of -
Constant steps

R01 R1-Real Tuning Optional 0 Output value for -

Constant Step 1
(+ or -)

80 OW360_R1100
 5.8 ANALOGDRUM

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

R02 R2-Real Tuning Optional 0.0 Output value for -

Constant Step 2
(+ or -)
R03 R3-Real Tuning Optional 0.0 Output value for -
Constant Step 3
(+ or -)
R04 R4-Real Tuning Optional 0.0 Output value for -
Constant Step 4
(+ or -)
R05 R5-Real Tuning Optional 0.0 Output value for -
Constant Step 5
(+ or -)
R06 R6-Real Tuning Optional 0.0 Output value for -
Constant Step 6
(+ or -)
R07 R7-Real Tuning Optional 0.0 Output value for -
Constant Step 7
(+ or -)
R08 R8-Real Tuning Optional 0.0 Output value for -
Constant Step 8
(+ or -)
R09 R9-Real Tuning Optional 0.0 Output value for -
Constant Step 9
(+ or -)
R10 S1-Real Tuning Optional 0.0 Output value for -
Constant Step 10
(+ or -)
R11 S2-Real Tuning Optional 0.0 Output value for -
Constant Step 11
(+ or -)
R12 S3-Real Tuning Optional 0.0 Output value for -
Constant Step 12
(+ or -)
R13 S4-Real Tuning Optional 0.0 Output value for -
Constant Step 13
(+ or -)
R14 S5-Real Tuning Optional 0.0 Output value for -
Constant Step 14
(+ or -)
R15 S6-Real Tuning Optional 0.0 Output value for -
Constant Step 15
(+ or -)
R16 S7-Real Tuning Optional 0.0 Output value for -
Constant Step 16 (+ or -) or
Output value 2 for
Step 1

OW360_R1100 81
5.8 ANALOGDRUM

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

R17 S8-Real Tuning Optional 0.0 Output value for -

Constant Step 17 (+ or -) or
Output value 2 for
Step 2
R18 S9-Real Tuning Optional 0.0 Output value for -
Constant Step 18 (+ or -) or
Output value 2 for
Step 3
R19 T1-Real Tuning Optional 0.0 Output value for -
Constant Step 19 (+ or -) or
Output value 2 for
Step 4
R20 T2-Real Tuning Optional 0.0 Output value for -
Constant Step 20 (+ or -) or
Output value 2 for
Step 5
R21 T3-Real Tuning Optional 0.0 Output value for -
Constant Step 21 (+ or -) or
Output value 2 for
Step 6
R22 T4-Real Tuning Optional 0.0 Output value for -
Constant Step 22 (+ or -) or
Output value 2 for
Step 7
R23 T5-Real Tuning Optional 0.0 Output value for -
Constant Step 23 (+ or -) or
Output value 2 for
Step 8
R24 T6-Real Tuning Optional 0.0 Output value for -
Constant Step 24 (+ or -) or
Output value 2 for
Step 9
R25 T7-Real Tuning Optional 0.0 Output value for -
Constant Step 25 (+ or -) or
Output value 2 for
Step 10
R26 T8-Real Tuning Optional 0.0 Output value for -
Constant Step 26 (+ or -) or
Output value 2 for
Step 11
R27 T9-Real Tuning Optional 0.0 Output value for -
Constant Step 27 (+ or -) or
Output value 2 for
Step 12
R28 U1-Real Tuning Optional 0.0 Output value for -
Constant Step 28 (+ or -) or
Output value 2 for
Step 13

82 OW360_R1100
 5.8 ANALOGDRUM

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

R29 U2-Real Tuning Optional 0.0 Output value for -

Constant Step 29 (+ or -) or
Output value 2 for
Step 14
R30 U3-Real Tuning Optional 0.0 Output value for -
Constant Step 30 (+ or -) or
Output value 2 for
Step 15
STEP - Variable Required - Output (analog); first LA
selected by the
current step number

OUT - Variable Required - Output (analog); LA

selected by the
current step number
OUT2 - Variable Optional - Output (analog); LA
selected by the
current step number

OW360_R1100 83
5.9 AND

5.9 AND
Description

The AND algorithm is a logical AND gate that can implement up to eight inputs. For the AND
algorithm, the output equals the logical AND of two to eight inputs (that is, all inputs must be
TRUE for the output to be TRUE). AND requires at least two inputs and up to eight digital inputs.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (digital) LD, LP

IN2 - Variable Required - Input (digital) LD, LP

IN3 - Variable Optional - Input (digital) LD, LP

IN4 - Variable Optional - Input (digital) LD, LP

IN5 - Variable Optional - Input (digital) LD, LP

IN6 - Variable Optional - Input (digital) LD, LP

IN7 - Variable Optional - Input (digital) LD, LP

IN8 - Variable Optional - Input (digital) LD, LP

OUT - Variable Req'd./Opt. - Output (digital) LD, LP

Note: Output is required if connected to anything other than another OR or AND.

Function

OUT = IN1 AND IN2 AND IN3 AND IN4 AND IN5 AND IN6 AND IN7 AND IN8

84 OW360_R1100
 5.10 ANNUNCIATOR

5.10 ANNUNCI ATOR

Description

The ANNUNCIATOR algorithm calculates one alarm window state of a lamp box, based on the
result of annunciator logic (IN1), the previous window state (OUT), and the inputs from the
operator push-button interface (ACK, RSET, TEST). The algorithm also determines the state of
the horn (HORN) and the chime (CHIM) based on IN1, OUT, and the inputs PRHN and PCHM.

Annunciator Input (IN1)

IN1 can be an analog, digital, or packed point. If IN1 is a packed point, the algorithm will count
each bit. If all 16 bits are set, then the algorithm assigns a value of 16 to IN1. If 15 bits are set,
regardless of which bits, then the algorithm assigns a value of 15 to IN1, and so on. Once the
value is determined, the algorithm will compare the value with the value of the last alarm state
(OUT).

Last Alarm State (OUT)

If IN1<=OUT and the OUT 1W unacknowledged bit is set and the user sets the ACK input true,
the algorithm will attempt to reset the OUT 1W unacknowledged bit.

Once the IN1 value is processed, the algorithm will set OUT equal to IN1

Fast Light Output (FAST)

The FAST output will be set true in the following instances:

1. If IN1 > OUT

2. If IN1 <= OUT and the OUT 1W unacknowledged bit is set and the ACK input is false and
either OUT 1W better alarm bit is not set or IN1 >= 0.

Slow Light Output (SLOW)

The SLOW output will be set true in the following instances:

1. If IN1 = 0 and the OUT 1W unacknowledged bit is set and the ACK input is true.
2. If IN1 = 0 and the OUT 1W unacknowledged bit is not set and the OUT 1W reset bit is set and
the RSET input is false.

Modify Light Output (MDFY)

The MDFY output will be set true in the following instance:

1. If 0 < IN1 <= OUT and the OUT 1W unacknowledged bit is set and the ACK input is false and
the OUT 1W better alarm bit is set.

OW360_R1100 85
5.10 ANNUNCIATOR

Light Output (STAT)

The STAT output will be set true in the following instances:

1. If TEST input is true.

2. If FAST is true.
3. If SLOW is true.
4. If MDFY is true.
5. If 0 < IN1 <= OUT and the OUT 1W unacknowledged bit is set and the ACK input is true.
6. If IN1 <= OUT and the OUT 1W unacknowledged bit is not set.

Note: All lights will be turned off if IN1 = 0 and the OUT 1W unacknowledged bit and reset bits
are not set.

Chime Output (CHIM)

The CHIM output will be set true in the following instances:

1. IN1 < OUT

2. If IN1 = 0 and the OUT 1W unacknowledged bit is set and the ACK input is true.
3. If Previous Chime Input (PCHM) is set.

Horn Output (HORN)

The HORN output will be set true in the following instances:

1. IN1 > OUT

2. If Previous Horn Input (PRHN) is set.

Invalid Numbers and Quality

If the value of IN1 is invalid or if the calculated value of OUT (written to the point record) is invalid,
the quality and reason of OUT is set to BAD.

Functional Symbol

86 OW360_R1100
 5.10 ANNUNCIATOR

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input LA, LD,

LP

ACK - Variable Required - Acknowledge Input LD, LP

(digital)

RSET - Variable Required - Reset Input (digital) LD, LP

TEST - Variable Required - Test Input (digital) LD, LP

PRHN - Variable Required - Previous Horn Input LD, LP

(digital)

PCHM - Variable Required - Previous Chime Input LD, LP

(digital)

OUT - Variable Required - Output (analog) LA

FAST - Variable Required - Fast Flash Output LD, LP

(digital)
SLOW - Variable Required - Slow Flash Output LD, LP
(digital)
MDFY - Variable Required - Modified Flash Output LD, LP
(digital)

STAT - Variable Required - Window State (on/off) LD, LP

Output (digital)

HORN - Variable Required - Current Horn Output LD, LP

(digital)

CHIM - Variable Required - Current Chime Output LD, LP

(digital)

OW360_R1100 87
5.11 ANTILOG

5.11 ANTILOG
Description

The ANTILOG algorithm scales an input value and outputs the antilog of the scaled value.

If the scaled input is outside the range for which the antilog can be stored as a real number, an
optional “out-of-range” digital is set, and the output value is set to the corresponding limiting
value.

Two algorithm tuning parameters are used: one for the scaling factor, and one to select the base
to be used for the calculation (base 10 or the natural base e, where the natural base e is the
default).

Invalid Numbers and Quality

The value of IN1 is checked for invalid real numbers. If IN1 is invalid, the value of OUT equals the
invalid value of IN1, and OUT's quality is set to BAD and conditional calculated reason is set. The
quality of flag FOUT also is set to BAD. If IN1 is valid, the quality and reasons of IN1 are
propagated to OUT.

Note: Other logarithmic algorithms are LOG and NLOG.

Functional symbol

88 OW360_R1100
 5.11 ANTILOG

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 64 Tuning Diagram -

Number
BASE X1-Byte Data Init. Optional 0 Base selection: -
0 = Natural base e
1 = Base 10

Note: Any positive

integer selects Base
10 operation.

SCAL R1-Real Tuning Optional 0.0 Scaling factor -

Constant

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog); LA

antilog of the input
value
FOUT - Variable Optional - Output (digital); LD, LP
out-of-range alarm

Function

OUT = e (IN1 x SCAL) if BASE = 0

OR

OUT = 10(IN1 x SCAL) if BASE = 1

Note: For range-checking purposes, the upper and lower limits of x such that e x can be
represented as a real number are:

 HIGH = 88.72 (HIGH is less than

IN * (3.4E + 38) = 88.722)
 LOW = -87.31 (LOW is greater than
IN * (4.4E - 38) = -87.316)

OW360_R1100 89
5.12 ARCCOSINE

5.12 ARCCOSINE
Description

The ARCCOSINE algorithm performs the mathematical arc cosine function. ARCCOSINE has
one input and one output analog point. Each time the algorithm is executed, if the output is on
scan, it is set to the ARCCOSINE of the input. The output of this algorithm is in radians. If an
output in degrees is desired, multiply it by 57.29579 to convert to degrees. If the input to this
algorithm is outside the range of -1.0 to +1.0, the output is an invalid number and the drop is
placed into alarm.

Invalid Real Numbers and Quality

Analog input values are checked for invalid real numbers. If the input value is invalid, the value of
the output is invalid and its quality is set to BAD. If the input is valid, the quality of the input is
propagated to the output.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

Function

OUT = ARCCOSINE (IN1)

90 OW360_R1100
 5.13 ARCSINE

5.13 ARCSINE
Description

The ARCSINE algorithm performs the mathematical arc sine function. ARCSINE has one input
and one output analog point. Each time the algorithm is executed, if the output is on scan, it is set
to the ARCSINE of the input. The output of this algorithm is in radians. If an output in degrees is
desired, multiply it by 57.29579 to convert to degrees. If the input to this algorithm is outside the
range of -1.0 to +1.0, the output is an invalid number and the drop is placed into alarm.

Invalid Real Numbers and Quality

Analog input values are checked for invalid real numbers. If the input value is invalid, the value of
the output is invalid and its quality is set to BAD. If the input is valid, the quality of the input is
propagated to the output.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

Function

OUT = ARCSINE (IN1)

OW360_R1100 91
5.14 ARCTANGENT

5.14 ARCTANGENT
Description

The ARCTANGENT algorithm performs the mathematical arc tangent function. ARCTANGENT
has one input and one output analog point. Each time the algorithm is executed, if the output is on
scan, it is set to the ARCTANGENT of the input. The output of this algorithm is in radians. If an
output in degrees is desired, multiply it by 57.29579 to convert to degrees.

Invalid Real Numbers and Quality

Analog input values are checked for invalid real numbers. If the input value is invalid, the value of
the output is invalid and its quality is set to BAD. If the input is valid, the quality of the input is
propagated to the output.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

Function

OUT = ARCTANGENT(IN1)

92 OW360_R1100
 5.15 ASSIGN

5.15 ASSIGN
Description

The ASSIGN algorithm transfers point value and the quality of one point to another point of the
same record type. The algorithm allows value and quality to be passed from one analog to
another analog point, or from a digital to another digital point or from one packed to another
packed point. For deluxe point types, the ASSIGN algorithm transfer the U8 and U9 timestamps
from the input point to the output point. In this way, it is possible to determine the time at which
the control logic had the value from the I/O available for computation inside the control task. You
must specify an output point name - default points may not be used.

Invalid Real Numbers and Quality

If the input point is an analog point, the value is checked for an invalid real number. If the input
value is invalid, the value of the output is invalid and its quality is set to BAD.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input LA, DA,

LD, DD,
LP, DP
OUT - Variable Required - Output LA, DA,
LD, DD,
LP, DP

OW360_R1100 93
5.16 ATREND

5.16 ATREND
Description

The ATREND algorithm outputs a user-specified point to a strip chart recorder for trending. By
tuning the algorithm, the operator may change the point being trended to any point in the system
that is on the Ovation network. Any point with a system identification (that is, LA/LD record size or
larger) can be trended, regardless of the Controller in which the point is located or used. The
output to the recorder is set to zero percent for five seconds and then to 100 percent for 10
seconds to indicate that the point being trended or its scaling has been changed. A Tuning
diagram allows the point name to be entered to change the point being trended.

To enter a point to trend, open the Signal Diagram that contains the ATREND algorithm.
Right-click on the ATREND algorithm, and select the Advanced Tuning option. Enter the point
name to be trended on the advanced tuning window. For more information on Signal Diagrams,
refer to Ovation Control Builder User Guide.

Top of scale and bottom of scale values may also be specified online and are used to convert an
analog point's current value to a percentage of full scale. A digital point's current value is output
as either 25 percent (FALSE) or 75 percent (TRUE). This converted value is then normalized to
be output to a specified analog output point card. To time tag each hour during a trend, the output
to the recorder may be set to zero percent for five seconds at the start of each hour when this is
initialized in the X3 field of algorithm record. If you are not trending a point, a value of zero is
output to the I/O card. The output (TRND) is set TRUE when a point is being trended. If no point
is being trended, TRND is set FALSE.

Note: ATREND can only trend points on a local network, not on a remote network.

Functional symbol

94 OW360_R1100
 5.16 ATREND

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init. Required 18 Tuning Diagram -

Number

TYPE X3-Byte Data Init. Optional 0 Recorder card type: -

0 = 1 to 5 V or 4 to 20
mA
Q-Line
1 = 0 to 10 V Q-Line
2 = 1 to 5 V or
4 to 20 mA
Q-Line with hourly
marks
3 = 0 to 10 V Q-Line
with
hourly marks
TRND - Variable Required - Output (digital) LD, LP

CARD - Variable Required - Point with Recorder LA

hardware address
(analog).

Note: The following fields in the algorithm record are used to trend a particular point. The Tuning
diagram associated with the tuning of this algorithm enables you to initialize and tune these fields.

LC Alg. Rec. Field Type Description

R2-Real Tuning Constant Top of scale value (default value = 100)
R3-Real Tuning Constant Bottom of scale value (default value = -100)
G0-Integer Tuning Constant System identification of the point being
trended. The point name entered on the tuning
diagram is automatically converted to the
system identification to be stored in this field.

OW360_R1100 95
5.17 AVALGEN

5.17 AV ALGEN
Description

The AVALGEN algorithm initializes an analog point. For the AVALGEN algorithm, the output is
the analog value stored in the tuning constant (VALUE). This value is a set point or bias to other
algorithms. If VALUE is entered incorrectly or if the data is corrupted, then the algorithm
generates an invalid number, the value of OUT is invalid, and its quality is set to BAD.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init. Required 65 Tuning Diagram -

Number
VALU R1-Real Tuning Required 0 Analog value (+ or -) -
Constant of output

OUT - Variable Required - Output (analog) LA

Function

OUT = VALU

96 OW360_R1100
 5.18 BALANCER

5.18 BALANCER
Description

The BALANCER algorithm monitors the modes of up to 16 downstream algorithms and performs
a user-defined type of tracking when all of the downstream algorithms are requesting the
upstream algorithm to track. A special configuration of the BALANCER algorithm enables it to be
used to balance the outputs of several downstream Manual/Auto (M/A) station algorithms.

The actual number of downstream algorithms is initialized by the user. You connect the output of
this algorithm to the IN1 input of any downstream algorithm or to the IN2 input of a downstream
selector type algorithm. When configuring the BALANCER algorithm, you specify which
algorithms (in other sheets and/or drops) use the output signal of the BALANCER algorithm. The
BALANCER algorithm checks the feedback signals to see how many of the downstream
algorithms are requesting the upstream algorithm to track (how many are in Manual mode). It then
uses this information, along with the type of control initialized, to calculate the analog output value
which is being sent to the inputs of these downstream algorithms.

Note: The first time BALANCER is executed, or in a RESET/POWER UP occurrence, the

algorithm does not use the track input values passed back by the downstream algorithms until
the track inputs have been calculated by the downstream algorithms.

Also, when connecting tracking points, you must connect them sequentially. For example, the
BALANCER algorithm assumes that if the number of tracking points is three, then they must be
TRK1, TRK2, TRK3. They cannot be TRK1, TRK2, TRK4.

Functional symbol

Note: If the TRK inputs are all raise inhibit or lower inhibit or a combination of raise inhibit and
manual or lower inhibit and manual, the BALANCER output value will stay at the value prior to
the inhibit.

In a raise inhibit condition, the value cannot be raised; however it can be lowered. Conversely,
in a lower inhibit condition, the value cannot be lowered; however it can be raised.

OW360_R1100 97
5.18 BALANCER

Control Modes

There are two types of control: NORMAL and MA BALANCER. You must select a type of tracking
(highest, lowest or average) to be used for both types of control.

NORMAL

If all of the downstream algorithms are requesting the upstream algorithm to track, then the output
of the BALANCER algorithm is either the highest, the lowest or the average of the analog track
signals passed back from the downstream algorithms. The quality of the output is then the worst
quality of the analog track signals passed back.

The gains and biases of the downstream algorithms that are between the BALANCER and the
MASTATION algorithms must be equal to 1.0 and 0.0, respectively, for this type of control to be
implemented properly.

If any of the downstream algorithms are not requesting the upstream algorithm to track, then the
output of the BALANCER algorithm is the gained and biased analog input value. The quality of
the output is the quality of the input value.

The downstream algorithms may be any of the standard algorithms. Internal tracking within the
BALANCER algorithm is implemented when switching from the highest, lowest, or average of the
analog track signals to the gained and biased analog input value.

MA BALANCER

Note: When the algorithm is tracking in "Balancer" mode, the TOUT value is the average of all
the TRK inputs.

If all of the downstream MA algorithms are requesting the upstream algorithm to track, then the
output of the BALANCER algorithm is either the highest, the lowest or the average of the analog
track signals passed back from the downstream algorithms.

If any of the downstream algorithms are not requesting the upstream algorithm to track, then the
output of the BALANCER algorithm is a value which causes the average of all the downstream
algorithm outputs to be equal to the gained and biased input value.

The quality of the output is the worst quality of the analog track signals passed back.

The downstream algorithms must be MASTATION and the gains and biases of these algorithms
must all be equal to 1.0 and 0.0, respectively, for this type of control to be implemented properly.
Internal tracking within the BALANCER algorithm is implemented when switching from the
highest, lowest, or average of the analog track signals to the value which balances the
downstream algorithm outputs.

The analog track signals are used regardless of their quality.

Invalid Real Numbers and Quality

If the algorithm generates an invalid output value, the last valid value is used for the output, and
the quality of OUTPUT point is set to BAD. In addition, if the algorithm receives an invalid value
as an input, or calculates an invalid value as the output, the drop is placed into alarm.

98 OW360_R1100
 5.18 BALANCER

Initializing the Algorithm

CAUTION! The feedback tracking signals from the downstream algorithms must be initialized
before downloading the BALANCER algorithm. If the feedback tracking signal information is
missing, errors result.

The Control Builder allows you to type in or connect signal lines for TOUT point from the
downstream algorithms. The tracking point is fed back as an analog track input to the BALANCER
algorithm to be used to calculate the correct analog output value.

Tracking Signals

This algorithm takes the following action in response to the information found in the analog track
signals (in the third status field), which are passed back from the downstream algorithms:

Bits and signals

BIT DESCRIPTION ACTION TRK SIGNAL

16 Track Implemented Passed through*

17 Track if lower No action Passed through**

18 Track if higher No action Passed through**

19 Lower inhibit No action Passed through***

20 Raise inhibit No action Passed through***

21 Conditional Track No action Not used.

22 Not used No action Not used.

23 Deviation Alarm No action Not used.

24 Local Manual mode No action Not used.

25 Manual mode No action Not used.

26 Auto mode No action Not used.

27 Not Used No action Not used.

28 Not Used No action Not used.

29 Not Used No action Not used.

30 Low limit reached No action Low limit reached.

31 High limit reached No action High limit reached.

* Only when all of the track signals from the downstream algorithms are requesting the upstream
algorithm to track.
** Only when none of the track signals from the downstream algorithm are requesting the
upstream algorithm to track and when all of the downstream signals are requesting this signal.
*** Only when none of the track signals from the downstream algorithms are requesting the
upstream algorithm to track and when all of the downstream signals are requesting this signal.
The signals are set according to the definitions given in setting tracking signals (see page 17).

OW360_R1100 99
5.18 BALANCER

The output is limited by high and low limits specified by the user. The high and low limit flags and
the tracking signal from the algorithm are output in the third status field of the TOUT, to be used
for display and by an upstream algorithm.

Note: If the algorithm generates an invalid track output value, the IN1 input is used as the track
output value, unless it is invalid. The track output value is not updated if both the calculated
track output and IN1 input values are invalid. See guidelines in MASTATION algorithm
description for setting MASTATION CNFG parameter.

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 79 Tuning Diagram -

Number.
NMIN X1-Byte Data Init. Required 1 Number of -
downstream
algorithms (up
to 16).
CNTL G3-Integer Data Init. Required NORMAL Type of control -
Bit 0 to be
implemented:
NORMAL =
Normal control
mode.
BALANCER =
MA Balancer
control mode.
TRK G3-Integer Data Init. Required HIGHEST Type of -
Bits 1 and 2 tracking to be
implemented:
HIGHEST:
Highest value.
LOWEST:
Lowest value.
AVERAGE:
Average value.
If CNTL is set to
BALANCER,
TRK will be
treated as
average.

100 OW360_R1100
 5.18 BALANCER

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

GAIN R1-Real Tuning Required 1.0 Gain on input -

Constant variable. The
gain on the
input should
never be
initialized to
zero; if it is, the
drop is placed
into alarm.
BIAS R2-Real Tuning Optional 0.0 Bias on input -
Constant variable.

TPSC R3-Real Tuning Required 100.0 Maximum value -

Constant of the output
point.
BTSC R4-Real Tuning Required -100 Minimum value -
Constant of the output
point.
TRAT R5-Real Tuning Required 2.5 Track ramp rate -
Constant (units per
second).
IN1 - Variable Required - Analog input LA
variable
TOUT - Variable Required - Upstream input LA
track value,
mode and
status of the
algorithm
OUT - Variable Required - Analog output LA
variable.
TRK01 - Variable Required - One feedback LA
tracking signal
from a
downstream
algorithm which
consists of
tracking value
and tracking
signals (in the
third status field
of analog track
point).

OW360_R1100 101
5.18 BALANCER

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TRK02 - Variable Required - One feedback LA

tracking signal
from a
downstream
algorithm which
consists of
tracking value
and tracking
signals (in the
third status field
of analog track
point).
TRK03 - Variable Optional - One feedback LA
tracking signals
• from a
• downstream
algorithm which
• consists of
TRK16 tracking value
and tracking
signals (in the
third status field
of analog track
point).

102 OW360_R1100
 5.19 BCDNIN

5.19 BCDNIN
Description

The BCDNIN algorithm reads a packed point (IN) in Binary Coded Decimal (BCD), converts it to a
real number, and stores it in the AV field of the output record (OUT). You must indicate the type of
action to be taken on the input value. Direct action causes the input value to be read directly.
Inverse action causes the input value to be read and inverted (one's complement) before it is
used. You must specify the number of BCD digits to read and the bit position where the reading is
to begin.

Functional Symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 94 Tuning Diagram -

Number

BITP X2-Byte Tuning Required - Bit position of the first -

Constant digit

NDIG X1-Byte Data Init. Required 1 Number of digits to -

read: 1, 2, 3, or 4

CNTL X3-Byte Tuning Optional Direct Control Action -

Constant Indicator:
0 = Direct Action -
Card value is read
from the I/O Bus and
used. This is for a
BCD display where
low is TRUE.
1 = Inverse Action -
Card value is read
from the I/O Bus,
inverted and then
used. This is for a
BCD display where
high is TRUE.

OW360_R1100 103
5.19 BCDNIN

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN - Variable Required - Input (packed) LP

OUT - Variable Required - Output (analog) LA

Example 1

To read four BCD digits starting at Bit Position 0:

BITP = 0
NDIG = 4

Then, the current value of OUT is 6281.0.

Example 2

To read two BCD digits starting at Bit Position 4:

BITP = 4
NDIG = 2

Then, the current value of OUT is 28.

104 OW360_R1100
 5.20 BCDNOUT

5.20 BCDNOUT
Description

The BCDNOUT algorithm reads a real value from input IN, converts it to binary-coded-decimal
(BCD), and outputs a number of digits to a packed output point. You must indicate the type of
action to take on the output value. Direct action causes the output value to be written directly.
Inverse action causes the value to be inverted (one's complement) before it is written to the output
point. You must specify the number of BCD digits to write, and the bit position where the writing is
to begin.

Invalid Numbers

The analog input (IN) is checked for invalid real numbers. If an invalid real number is entered as
IN, it is not written to the output point.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 95 Tuning Diagram -

Number
BITP X2-Byte Tuning Required 0 Bit position of the -
Constant first digit

NDIG X1-Byte Data Init. Required 1 Number of digits to -

read: 1, 2, 3, or 4

OW360_R1100 105
5.20 BCDNOUT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

CNTL X3-Byte Tuning Optional Direct Control Action -

Constant Indicator:
0 = Direct Action -
Card value is read
from the hardware
and used. This is for
a BCD display
where 0 is TRUE.
1 = Inverse Action -
Card value is read
from the hardware,
inverted and then
used. This is for a
BCD display where
1 is TRUE.
IN - Variable Required - Input (analog) LA

OUT - Variable Required - Output (packed) LP

Example 1

To write four BCD digits, starting at Bit Position 0, where the current value of IN is 6281.0:

BITP = 0
NDIG = 4.

Example 2

To write two BCD digits, starting at Bit Position 4, where the current value of IN is 28.0:

BITP = 4
NDIG = 2

106 OW360_R1100
 5.21 BILLFLOW

5.21 BILLFLOW
Description

The BILLFLOW algorithm generates an AGA3 gas flow calculation for orifices. It is applicable for
downstream and upstream static pressure measurements. It can be used for both tap and flange
orifices.

The super compressibility factor can be calculated one of two ways. The value can be passed in
the compressibility (SC) point, or the algorithm can calculate the compressibility factor with
additional information from the N2 and C02 tuning fields.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init. Required 115 Tuning Diagram -

Number
FLOW X2-Byte Data Init. Required Down- Flow Element Type -
stream (Downstream or
Upstream)
XDO R1-Real Tuning Required 0.0 Orifice ID -
Constant

DI R2-Real Tuning Required 0.0 Pipe ID -

Constant

PB R3-Real Tuning Required 14.73 Pressure Base -

Constant

TB R4-Real Tuning Required 60.0 Temperature Base -

Constant

TAP X1-Byte Data Init. Required Pipe Tap Location -

(Flange or Pipe)

CU R6-Real Tuning Required 0.001 Cutoff -

Constant

C02 R7-Real Tuning Required 0.75 Mole % C02 -

Constant

OW360_R1100 107
5.21 BILLFLOW

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

N2 R8-Real Tuning Required 0.48 Mole % N2 -

Constant

SP - Variable Required - Static Flowing LA

Pressure (PSIG)

DP - Variable Required - Orifice Differential LA

Pressure (IN WC)

TEMP - Variable Required - Temperature of Gas LA

(Deg. F)
GRAV - Variable Required - Specific Gravity LA

SC - Variable Optional - Super LA

compressibility
BP - Variable Required - Barometric Pressure LA
(PSIA)
OUT - Variable Required - Gas Flow Output LA
(CF/HR)

108 OW360_R1100
 5.22 Boolean Algorithms with Quality Propagation

5.22 Boolean Algorithms w ith Quality Propagation

The following algorithms are part of the Boolean Quality Propagation algorithm package:
 QAND (see page 109)
 QOR (see page 111)
 QNOT (see page 113)
 QXOR (see page 114)

5.22.1 QAND

Description

This QAND algorithm implements a logical AND of up to eight inputs. Quality propagation is
always enabled on this algorithm, and all inputs, as well as the output, must be defined as points.

Note: The QAND algorithm has the same functionality as the AND algorithm; however, it
should only be used in place of AND when quality propagation is needed.

 An optional Quality Propagation Action parameter (QTYP) is available that decides the type of
quality propagation. This parameter is NORMAL by default and has an option - WORST
QUALITY.
 If the parameter QTYP is set to NORMAL, the output quality is as follows:
 If the output is TRUE, the output quality is the worst input quality.
 If the output is FALSE, the output quality is the best false input quality.
 If the parameter QTYP is set to WORST QUALITY, the output quality is the worst input
quality.
 There are two functional symbols: one with three inputs and one with eight inputs.

Functional symbols
 With 3 inputs

OW360_R1100 109
5.22 Boolean Algorithms with Quality Propagation

 With 8 inputs

Algorithm definitions

NAME LC ALG. TYPE REQUIRED / DEFAULT DESCRIPTION MIN. POINT

REC. OPTIONAL VALUE REC.
FIELD

QTYP X1-Byte Data Init. Optional NORMAL – Types of -

Bit 0 RULE BASED Quality
Propagation:
NORMAL
QUALITY
 The output
quality is the
worst input
quality if the
output is true.
 The output
quality is the
best false
input quality
if the output
is false.
WORST
QUALITY
 The output
quality is the
worst input
quality.
IN1 - Variable Required - Input (digital). LD, LP
IN2 - Variable Required - Input (digital). LD, LP
IN3 - Variable Optional - Input (digital). LD, LP
IN4 - Variable Optional - Input (digital). LD, LP
IN5 - Variable Optional - Input (digital). LD, LP
IN6 - Variable Optional - Input (digital). LD, LP

110 OW360_R1100
 5.22 Boolean Algorithms with Quality Propagation

NAME LC ALG. TYPE REQUIRED / DEFAULT DESCRIPTION MIN. POINT

REC. OPTIONAL VALUE REC.
FIELD

IN7 - Variable Optional - Input (digital). LD, LP

IN8 - Variable Optional - Input (digital). LD, LP
OUT - Variable Required / - Output (digital). LD, LP
Optional

5.22.2 QOR

Description

The QOR algorithm implements a logical OR of up to eight inputs. Quality propagation is always
enabled on this algorithm, and all inputs, as well as the output, must be defined as points.

Note: The QOR algorithm has the same functionality as the OR algorithm; however, it should
only be used in place of OR when quality propagation is needed.

 A Quality Propagation Action parameter (QTYP) is available that decides the type of quality
propagation. This parameter is NORMAL by default and has an option - WORST QUALITY.
 If the parameter QTYP is set to NORMAL, the quality propagation is as follows:
 If the output is TRUE, the output quality is the best true input quality.
 If the output is FALSE, output quality is the worst false input quality.
 If the parameter QTYP is set to WORST QUALITY, the output quality is the worst input
quality.
 There are two functional symbols: one with three inputs and one with eight inputs.

Functional symbols
 With 3 inputs

OW360_R1100 111
5.22 Boolean Algorithms with Quality Propagation

 With 8 inputs

Algorithm definitions

NAME LC ALG. TYPE REQUIRED / DEFAULT DESCRIPTION MIN.

REC. OPTIONAL VALUE PT.
FIELD REC.

QTYP X1-Byte Data Init. Optional NORMAL – Types of Quality -

Bit 0 RULE BASED Propagation:
NORMAL QUALITY
 The output quality is
the best input
quality if the output
is true.
 The output quality is
the worst false input
quality if the output
is false.
WORST QUALITY
 The output quality is
the worst input
quality.
IN1 - Variable Required - Input (digital). LD, LP
IN2 - Variable Required - Input (digital). LD, LP
IN3 - Variable Optional - Input (digital). LD, LP
IN4 - Variable Optional - Input (digital). LD, LP
IN5 - Variable Optional - Input (digital). LD, LP
IN6 - Variable Optional - Input (digital). LD, LP
IN7 - Variable Optional - Input (digital). LD, LP
IN8 - Variable Optional - Input (digital). LD, LP
OUT - Variable Required / - Output (digital). LD, LP
Optional

112 OW360_R1100
 5.22 Boolean Algorithms with Quality Propagation

5.22.3 QNOT

Description

The QNOT algorithm implements a logical NOT of one input. Quality propagation is always
enabled on this algorithm, and the input and output, must be defined as points.

Note: The QNOT algorithm has the same functionality as the NOT algorithm; however, it
should only be used in place of NOT when quality propagation is needed.

 The output quality of the QNOT is the same as the input quality.
 There are four functional symbols with different orientations.

Functional symbols
 Orientation 1

 Orientation 2

 Orientation 3

 Orientation 4

OW360_R1100 113
5.22 Boolean Algorithms with Quality Propagation

Algorithm definitions

NAME LC ALG. TYPE REQUIRED / DEFAULT DESCRIPTION MIN.

REC. OPTIONAL VALUE POINT
FIELD REC.

IN1 - Variable Required - Input (digital). LD, LP

OUT - Variable Required / - Output (digital). LD, LP
Optional

5.22.4 QXOR

Description

The QXOR algorithm implements an exclusive OR. Quality propagation is always enabled on this
algorithm, and all inputs as well as the output ,must be defined as points.

Note: The QXOR algorithm has the same functionality as the XOR algorithm; however, it
should only be used in place of XOR when quality propagation is needed.

 An optional Quality Propagation Action parameter (QTYP) is available that decides the type of
quality propagation. This parameter is NORMAL by default and has an option - WORST
QUALITY.
 If the parameter QTYP is set to NORMAL, the quality propagation is as follows:
 If the output is TRUE, the output quality is the quality of the true input.
 If the output is FALSE, the output quality is the worst false input quality.
 If the parameter QTYP is set to WORST QUALITY, the output quality is the worst input
quality.
 There is one functional symbol.

Functional symbol

114 OW360_R1100
 5.22 Boolean Algorithms with Quality Propagation

Algorithm definitions

NAME LC ALG. REC. TYPE REQUIRED / DEFAULT DESCRIPTION MIN.

FIELD OPTIONAL VALUE PT.
REC.

QTYP X1-Byte Bit 0 Data Optional NORMAL – Types of -

Init. RULE BASED Quality
Propagation:
NORMAL
QUALITY
 The output
quality is the
quality of the
true input if
the output is
true.
 The output
quality is the
worst false
input quality
if the output
is false.
WORST
QUALITY
 The output
quality is the
worst input
quality.
IN1 - Variable Required - Input (digital). LD,
LP
IN2 - Variable Required - Input (digital). LD,
LP
OUT - Variable Required / - Output (digital). LD,
Optional LP

OW360_R1100 115
5.23 BUFFER

5.23 BUFFER
Description

The BUFFER algorithm gathers the value and status of a point and associates a timestamp with
this information. The data is stored in a queue and is accessible via the High Speed Data
Acquisition (HSDA) Application Programming Interface (API). An API is an interface implemented
by a software program to enable interaction with other software, much in the same way that a
user interface facilitates interaction between humans and computers.

Functional symbol

Requirements

A limited number of BUFFER algorithms may be used in any given Controller and control task
depending on the Controller processor and memory usage. It is up to the user to test the
algorithm/API performance to ensure data is being adequately collected.

Note: The API allows for up to 1,000 BUFFER algorithms per Controller; however, depending
on Controller processing time and memory usage, the Controller may not be able to support
1,000 BUFFER algorithms. Emerson recommends that all BUFFER algorithms be tested in a
worst case scenario on actual Controllers in order to prevent data loss.

The HSDA task in each Controller supports up to five individual connections.

HSDA API in each MMI supports up to 10 sessions.

Enable (ENBL)

The enable input (ENBL) parameter allows you to enable or disable the BUFFER algorithm. When
disabled, the BUFFER algorithm will not store any data and will not send any data to the queue
for retrieval. It will also zero out its internal buffer.

When enabled, the algorithm will immediately send data to the queue and will store up to 10 data
values in its own internal buffer. If no point is connected to the enable pin, the algorithm will
always be enabled.

On initial startup or if the algorithm is disabled, the STAT queue overflow bit, ACNT, TCNT, CEW,
and CER fields will be reset to zero.

Buffer Input Point (IN)

The buffer input point (IN) allows you to connect any analog (LA), digital (LD), or packed (LP)
point to the algorithm. When the algorithm is enabled, the algorithm will collect the value,
timestamp, and 1W field - First Status Word for LA and LD points, and the A3 field - Invalidity bits
for LP points. Collection occurs by exception or is based on deadband.

116 OW360_R1100
 5.23 BUFFER

Timestamp

The timestamp is accurate to 1 millisecond resolution. The Controller provides the time based on
UTC (Coordinated Universal Time) time in the Controller. This information is stored in two
variables called timestampSeconds and timestampNanoseconds. The timestampSeconds
variable contains the amount of seconds since 12:00 AM January 1, 1970. The
timestampNanoseconds variable contains the amount of nanoseconds since the last full second.

Note: The time stored in timestampSeconds is provided in UTC. The user's application converts
this time to local time and adjusts a nanoseconds part from timestampNanoseconds.

After initial startup, the Controller uses the NTP server to set its calendar time. During this time,
the algorithm timestamp values may be invalid.

Timestamp Mode (TMODE)

The BUFFER algorithm allows you to configure how the algorithm retrieves the timestamp. If an
individual algorithm is selected, each BUFFER algorithm will retrieve a timestamp based on when
the algorithm was executed. If a control task is selected, then the control task will retrieve the
timestamp based on when it was executed and all BUFFER algorithms within the same control
task will use the same timestamp for that control cycle.

Deadbands

Analog Deadband (ADB)

If the connected point is an analog point, an analog deadband may be associated. The algorithm
uses the deadband to determine whether or not to collect the point's information and send it to the
queue. It uses the deadband as follows: the algorithm compares the previously collected value
with the currently scanned value for changes beyond the specified deadband value. For instance,
if the deadband is set to 5, and the point's current value is 9, but during the next control cycle, the
value is 12, the point will not be collected. However, if the point's value increases from 9 to 15 in
the next control cycle, the point information will then be collected and sent to the queue.

Digital Deadband (DDB)

If the connected point is a digital or packed point, a digital deadband may be associated. The
algorithm determines whether to collect the point information depending on which option is
selected:
 0 to 1 Transition -- Information is collected when the point value or any bit in the point
transitions from a 0 to a 1.
 1 to 0 Transition -- Information will be collected when the point value or any bit in the point
transitions from a 1 to a 0.
 State Change -- Information will be collected when the point value or any bit in the point
changes.

Note: If a zero analog deadband is assigned, the algorithm will collect the point value by
exception. Also, if the 1W field - status word or the A3 field - invalidity bits change for the IN
point, then the point will be collected and placed into the queue regardless of deadbands.

OW360_R1100 117
5.23 BUFFER

High Speed Data Acquisition

When the BUFFER algorithm is enabled, the value, status, and timestamp of the input (IN) will be
written to element 1 of the fields defined in the template. For each subsequent loop time, if the
BUFFER algorithm determines the value/status is to be collected, it will continue to write to each
element, increasing the element by 1 each time. For instance, the algorithm writes to element 1,
then element 2, then element 3, and so forth. After the algorithm writes to the 10th element, it
starts with element 1 again. If the algorithm is disabled, it resets all elements and starts from
element 1 when enabled again.

HSDA task

The information stored in each element is read by the High Speed Data Acquisition task (HSDA)
and sent to the appropriate MMI that is requesting the information. If the HSDA task is unable to
read the values from the element fields prior to the algorithm rewriting to that element, the
algorithm will set the queue overflow bit in the status output (STAT). The algorithm continues
writing over each subsequent element. When the HSDA task is able to read the current element,
the queue overflow bit resets.

Note: The HSDA task runs at a higher priority than the control tasks in order to avoid
pre-emption by the control task.

Busy

The algorithm sets the busy bit to true when it is executing. The busy bit prevents the high-speed
data acquisition task from reading values in the middle of a data write. When the algorithm
finishes executing during a control task cycle, it resets the busy bit.

Queue Overflows

In order to determine a queue overflow, the algorithm and the HSDA task store a count of how
many times it has accessed the first element. For instance, the first time that the algorithm
completes writing to the first 10 elements, it stores a zero to the ACNT field; the next time the
algorithm writes to the first 10 elements, it stores a 1 to the ACNT field, and so on. After the
HSDA task reads the first 10 elements, it stores a zero to the TCNT field; the next time the HSDA
task reads the first 10 elements, it stores a 1 to the TCNT field, and so on.

In addition, the algorithm stores the current element written to the current element written (CEW)
field, and the HSDA task stores the current element read to the current element read (CER) field.

The BUFFER algorithm uses the information to determine if it has overwritten a field that has not
been read from yet. When this occurs, the queue overflow bit in the STAT output is set, and the
buffer continues to write values to each element. Any data not read by the HSDA task during this
time is lost. When the HSDA task is able to read the current element, the queue overflow bit
resets.

Note: To avoid overruns, the algorithm subtracts 10,000 from ACNT and TCNT once TCNT
reaches 10,000.

118 OW360_R1100
 5.23 BUFFER

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

Inputs:

ENBL C0 - SID Variable Optional -- Enable buffering. LD/LP

IN C1 - SID Variable Required -- Point value to be LA/LD/LP
collected.
Outputs:

STAT C2 - SID Variable Optional -- Status and related bit LP

number
 Enable = 0
 Queue Overflow = 1
Params:

ADB R1 Tuning Required 0 Analog Deadband. --

Constant
DDB G1 Tuning Required 0 Digital Deadband: --
Constant  0 = 0 to 1 Transition
(Enum)
 1 = 1 to 0 Transition
 2 = State Change
TMODE X2 Data Init Required 0 Timestamp Mode: --
 0 = Individual
algorithm
 1 = Control task
BUSY X1 Alg. Init. -- -- Algorithm is writing --
values.
ACNT G2 Alg. Init. -- -- Algorithm Element --
Count.
TCNT G3 Alg. Init. -- -- HSDA Task Element --
Count.
CEW G4 Alg. Init. -- -- Current Element --
Written.
CER G5 Alg. Init. -- -- Current Element Read. --

ST1 B0 Alg. Init. -- -- Status for Element 1. --

ST2 B1 Alg. Init. -- -- Status for Element 2. --

ST3 B2 Alg. Init. -- -- Status for Element 3. --

ST4 YU Alg. Init. -- -- Status for Element 4. --

ST5 B4 Alg. Init. -- -- Status for Element 5. --

ST6 B5 Alg. Init. -- -- Status for Element 6. --

ST7 B6 Alg. Init. -- -- Status for Element 7. --

OW360_R1100 119
5.23 BUFFER

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

ST8 B7 Alg. Init. -- -- Status for Element 8. --

ST9 B8 Alg. Init. -- -- Status for Element 9. --

ST10 B9 Alg. Init. -- -- Status for Element 10. --

TS1 D0 Alg. Init. -- -- Timestamp in seconds --

for Element 1.
TS2 YQ Alg. Init. -- -- Timestamp in seconds --
for Element 2.
TS3 D2 Alg. Init. -- -- Timestamp in seconds --
for Element 3.
TS4 YP Alg. Init. -- -- Timestamp in seconds --
for Element 4.
TS5 D4 Alg. Init. -- -- Timestamp in seconds --
for Element 5
TS6 D5 Alg. Init. -- -- Timestamp in seconds --
for Element 6.
TS7 D6 Alg. Init. -- -- Timestamp in seconds --
for Element 7.
TS8 YN Alg. Init. -- -- Timestamp in seconds --
for Element 8.
TS9 D8 Alg. Init. -- -- Timestamp in seconds --
for Element 9.
TS10 D9 Alg. Init. -- -- Timestamp in seconds --
for Element 10.
TNS1 YM Alg. Init. -- -- Timestamp in --
nanoseconds for
Element 1.
TNS2 YL Alg. Init. -- -- Timestamp in --
nanoseconds for
Element 2.
TNS3 E2 Alg. Init. -- -- Timestamp in --
nanoseconds for
Element 3.
TNS4 E3 Alg. Init. -- -- Timestamp in --
nanoseconds for
Element 4.
TNS5 E4 Alg. Init. -- -- Timestamp in --
nanoseconds for
Element 5.
TNS6 YC Alg. Init. -- -- Timestamp in --
nanoseconds for
Element 6.
TNS7 Y9 Alg. Init. -- -- Timestamp in --
nanoseconds for
Element 7.

120 OW360_R1100
 5.23 BUFFER

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

TNS8 E7 Alg. Init. -- -- Timestamp in --

nanoseconds for
Element 8.
TNS9 E8 Alg. Init. -- -- Timestamp in --
nanoseconds for
Element 9.
TNS10 Y8 Alg. Init. -- -- Timestamp in --
nanoseconds for
Element 10.
VAL1 S1 Alg. Init. -- -- Value for Element 1. --
VAL2 S2 Alg. Init. -- -- Value for Element 2. --
VAL3 S3 Alg. Init. -- -- Value for Element 3. --

VAL4 S4 Alg. Init. -- -- Value for Element 4. --

VAL5 S5 Alg. Init. -- -- Value for Element 5. --
VAL6 S6 Alg. Init. -- -- Value for Element 6. --
VAL7 S7 Alg. Init. -- -- Value for Element 7. --
VAL8 S8 Alg. Init. -- -- Value for Element 8. --
VAL9 S9 Alg. Init. -- -- Value for Element 9. --
VAL10 T1 Alg. Init. -- -- Value for Element 10. --

HSDA API Description and Usage

The HSDA User API for Windows applications consists of the following files on each MMI:
 hsda.dll
 hsda.lib
 hsda_defines.h
 hsda.h
You must use these files to create your own application to communicate with selected Controllers
in order to collect data from each BUFFER algorithm.

Supplied Functions:
 HsdaStatusType HsdaStartup()

 HsdaStatusType HsdaSIDs(HsdaDropIdType originatingDrop,

HsdaSidType* pSidList, HsdaSidType* pInputSidList,
HsdaPointDataType *pDataTypes, UINT32* pCount)

 HsdaStatusType HsdaSIDtoName(HsdaSidType sid, char* buffer,

UINT32* pCount)

OW360_R1100 121
5.23 BUFFER

 HsdaStatusType HsdaStartLogging(HsdaSidType * pSidList, UINT32 *

pCount, HsdaSessionIdType * ID)

 HsdaStatusType HsdaData(HsdaSessionIdType ID, HsdaEventType *

pEventList, UINT32 * pCount, BOOLEAN * pMore)

 HsdaStatusType HsdaDiagDrops(HsdaSessionIdType ID,

HsdaDropDiagType * pDropDiagList, UINT32 * pCount)

 HsdaStatusType HsdaDiagSids(HsdaSessionIdType ID,

HsdaSidDiagType * pSidDiagList, UINT32 * pCount)

 HsdaStatusType HsdaResetStatisticalAttribute(HsdaSessionIdType
ID, HsdaStatisticalAttributeIdType attributeId);

 HsdaStatusType HsdaStopLogging(HsdaSessionIdType ID)

 HsdaStatusType HsdaShutdown()
Definitions:

#define HSDA_MAX_SIDS_ON_DROP 1000

#define HSDA_CONNECTIONS_MAX 10

typedef UINT32 HsdaSessionIdType;

typedef UINT16 HsdaDropIdType;

typedef UINT32 HsdaSidType;

// Represents the status of an HSDA operation

typedef union {
UINT16 wholeWord;
struct
{

// Invalid session Id was provided as an argument

to a HSDA function call
UINT16 invalid_id:1;
// Invalid SID was provided by user or drop returned
data corresponding to an unregistered SID
UINT16 invalid_sid:1;
// The drop rejected the connection because the
limit of the clients it can service simultaneously
was exceeded
UINT16 max_connections_exceeded:1;
// Drop not communicating
UINT16 drop_unavailable:1;
// One of the points for the session was not found on the
Controller or it is occupied by another session.
UINT16 point_unavailable:1;
// The buffer which the user provided as an argument for a

122 OW360_R1100
 5.23 BUFFER

HSDA
function call was too short
UINT16 buffer_too_short:1;
// Operating system error
UINT16 os_error:1;
// Buffer overflow on workstation side
UINT16 overflow:1;
// Problem with input sid for at least one algorithm
UINT16 input_sid_problem:1;
} bits;
} HsdaStatusType;

// The value for a status where no errors occurred

#define HSDA_OK 0

typedef union {
REAL32 analog;
INT32 digital;
UINT32 packed;
} HsdaValueType;

typedef struct {
HsdaValueType pointValue;
INT32 timestampSeconds;
INT32 timestampNanoseconds;
INT32 firstStatus;
} HsdaBufferDataType;

typedef union {
HsdaBufferDataType bufferData;
} HsdaDataType;

typedef struct {
Sid_type sid;
HsdaDataType data;
} HsdaEventType;

typedef enum {
HSDA_SID_OK,
HSDA_SID_USED,
HSDA_SID_NOT_FOUND,
HSDA_SID_DROP_UNREACHABLE
} HsdaSidStatusType;

typedef struct {
Sid_type sid;
HsdaSidStatusType sidStatus;
} HsdaSidDiagType;

OW360_R1100 123
5.23 BUFFER

typedef enum {
HSDA_CONN_CONNECTED,
HSDA_CONN_DROP_UNAVAILABLE,
HSDA_CONN_MAX_CLIENTS_EXCEEDED,
HSDA_CONN_BACKUP_NOT_READY,
HSDA_CONN_CONNECTING,
HSDA_CONN_UNSUPPORTED_PROTO_VERSION,
HSDA_CONN_UNKNOWN
} HsdaConnStatusType;

typedef enum
{
HSDA_ANALOG_TYPE,
HSDA_DIGITAL_TYPE,
HSDA_PACKED_TYPE,
HSDA_UNKNOWN_TYPE
} HsdaPointDataType;

// Defines a type for drop diagnostics

typedef struct {
// Ovation Network Drop Number of this drop
HsdaDropIdType dropNumber;
// TRUE if this drop reports as the active unit,
FALSE otherwise
BOOLEAN isActive;
// The status of the connection between the workstation
and this drop
HsdaConnStatusType connectionStatus;
// Ovation Highway Drop Number of this drop's partner
HsdaDropIdType partnerNumber;
// The status of the connection between the workstation
and this drop's partner
HsdaConnStatusType partnerConnectionStatus;
// The number of events which were transferred to the
application from this drop
UINT32 eventCount;
// The number of lost data packets
UINT32 lostPacketCount;
// TRUE if an overflow occurred in the local HSDA
event buffer (indicates too slow collection by client
application), FALSE otherwise
BOOLEAN bufferOverflow;
// Total number of processed data frames
UINT32 totalFramesCount;
} HsdaDropDiagType;

124 OW360_R1100
 5.23 BUFFER

// Represents the possible statistical attribute identifiers

typedef enum
{
// Identifier of unknown statistical attribute
HSDA_UNKNOWN_ATTRIBUTE,
// Identifier of statistical attribute indicating
the number of events which were transferred to the
application from this drop
HSDA_DROP_EVENT_COUNT,
// Identifier of statistical attribute indicating the
number of lost data packets
HSDA_DROP_LOST_PACKET_COUNT,
// Identifier of statistical attribute indicating
whether an overflow occurred in the local HSDA event
buffer
HSDA_DROP_BUFFER_OVERFLOW,
// Identifier of statistical attribute indicating
the total number of data frames processed
HSDA_DROP_TOTAL_FRAMES_COUNT,
} HsdaStatisticalAttributeIdType;

API Usage

Note: In the following procedure, steps that contain the word "must" are required by the user
application. Steps that contain the word "may" are optional.

Perform the following steps to collect the data:

1. You must call HsdaStartup () to initialize the HSDA mechanism.

2. You may call HsdaSIDs () to get a list of BUFFER algorithm SIDs defined within a given
Controller and the respective input point SIDs.
3. You may call HsdaSIDtoName () to get the point name of a specific SID.
4. You must call HsdaStartLogging () with a list of points to collect. This runs connections with
all originating drops and their partners. The connection to the backup Controller in a
redundant pair may be established only after the connection to the active (in control)
Controller has been established.
5. You must periodically call HsdaData () to get a list of value change events. The period must
be fast enough to prevent queue overflow.
6. If any problems with connections were detected during the HsdaData () call, then you may
call HsdaDiagDrops () to determine drop statuses.
7. If any problems with points were detected during the HsdaData () call, then you may call
HsdaDiagSids () to determine point SID statuses.
8. If you want to reset a statistical value, then you may call HsdaResetStatisticalAttribute()
with the value of the attribute identified by attributeId.
9. If you want to stop collecting data, call HsdaStopLogging (), to close connections for a
certain session.

OW360_R1100 125
5.23 BUFFER

10. When the application is finished, you must call HsdaShutdown () to terminate all HSDA
activity

Note: The Hsda API does not handle applications that share one session across multiple
threads. The behavior of such applications may be unpredictable.

HsdaStatusType HsdaStartup() – Initializes Hsda API internals

HsdaStatusType HsdaSIDs(HsdaDropIdType originatingDrop, HsdaSidType* pSidList,

HsdaSidType* pInputSidList, HsdaPointDataType *pDataTypes, UINT32* pCount) – Gets the
list of SIDs which belong to collection algorithms on the drop whose ID/number is equal to
originatingDrop. The list is returned in pSidList and the number of written entries is stored in
pCount. To prevent overflow, the caller places the maximum number of entries that can be
returned into pCount (as well as pInputSidList and pDataTypes). If more buffer algorithm SIDs
exist on the originatingDrop, the buffer_too_short bit is set in the returned status. Additionally,
for every buffer SID found, the function attempts to resolve the SID of the input point connected to
the buffer, and its corresponding data type (one of Analog/Digital/Packed). They are stored
respectively in the pInputSidList and pDataTypes arrays, at the index which corresponds to the
buffer algorithm sid entry in pSidList. If there were problems resolving any input point SID or its
data type, the input_sid_problem bit is set in the returned status.

HsdaStatusType HsdaSIDtoName(HsdaSidType sid, char* buffer, UINT32* pCount) - Gets

the name field of a point based on the supplied sid and copies it to the buffer pointed to by buffer.
The number of bytes copied into buffer is returned in the variable pCount. No null terminating
character is appended. If there is an error while trying to resolve the name, the function returns a
status code of invalid_sid. If the name was retrieved, but the buffer supplied by the caller is too
short, a status of buffer_too_short is returned. Otherwise, if the name was successfully resolved
and the buffer length is sufficient, a status of HSDA_OK is returned and the name is copied into
the user-supplied buffer.

HsdaStatusType HsdaStartLogging(HsdaSidType * pSidList, UINT32 * pCount,

HsdaSessionIdType * ID) – Identifies a list of algorithms, by SID to collect data from. pSidList
points to the list of SIDs and pCount indicates the number of items in the list. Connection threads
are started on originating drop pairs. One application may have at most 10 connection sets to
drops originating SIDs. Returns HSDA_OK and sets session ID (a positive integer number) if
successful. If any of the SIDs is an invalid collection point (point that is not a valid BUFFER
algorithm LC record), pSidList will contain the list of invalid points, pCount will indicate how many
are in the list and the invalid_sid bit is set in the returned status – in this case the communication
is not started. If the function is being called more than 10 times in one application, without closing
connections, then the function returns a status code with the max_connections bit set and the
communication is not started.

HsdaStatusType HsdaData(HsdaSessionIdType ID, HsdaEventType * pEventList, UINT32 *

pCount, BOOLEAN * pMore) – Puts any received events, for a given session ID, into pEventList
and puts the number of written entries into pCount. To prevent overflow, the caller places the
maximum number of events that can be returned into pCount. Returns HSDA_OK if no problems
occurred. Returns a status with the invalid_id bit set if session with a given ID was not found. If
there were problems with the connection to any drop, then the drop_unavailable bit is set (for
example, a maximum number of connections to certain drops have been exceeded or there is a
connection problem). If there were problems with getting events for any point (for example, the
BUFFER algorithm point is missing) then the point_unavailable bit is set. If more events exist,
pMore is set to TRUE. The function tries to get as much data as possible, even if there were
problems with the connection to any drop or any point defined for the session was unavailable.

126 OW360_R1100
 5.23 BUFFER

HsdaStatusType HsdaDiagDrops(HsdaSessionIdType ID, HsdaDropDiagType *

pDropDiagList, UINT32 * pCount) – Puts drop connection diagnostics (for given session ID) for
all drops into pDropDiagList and puts the number of entries into pCount. To prevent overflow, the
caller places the maximum number of drop connection diagnostics that can be returned into
pCount. Returns a status with the invalid_id bit set if the session with the given ID was not found.
If more drops are defined than what are defined in pCount, then the buffer_too_short bit is set in
the return status. Returns HSDA_OK if no problems occurred. Possible types of drop connection
statuses are:

1. HSDA_CONN_CONNECTED – connection to drop is active.

2. HSDA_CONN_DROP_UNAVAILABLE – communication to drop could not be established (it
will be recreated as soon as possible).
3. HSDA_CONN_MAX_CLIENTS_EXCEEDED – drop reported that it has the maximum
connections opened (the connection will be recreated as soon as possible).
4. HSDA_CONN_BACKUP_NOT_READY – drop is in backup and did not receive a list of SIDs
for the connection from its partner.
5. HSDA_CONN_CONNECTING – reconnecting to the drop.
6. HSDA_UNSUPPORTED_PROTOCOL_VERSION – protocol version mismatch between drop
and station or drop responded in unexpected way.
7. HSDA_CONN_UNKNOWN – initial state of connection to certain drop – no connection to the
drop has been attempted.

Additionally, the drop diagnostic information includes the number of processed data frames, lost
network frames, a flag indicating whether the drop is active or in standby, and a flag indicating
whether an overflow occurred in the local Windows-side event buffers.

HsdaStatusType HsdaDiagSids(HsdaSessionIdType ID, HsdaSidDiagType * pSidDiagList,

UINT32 * pCount) – Puts SID diagnostics (for given session ID) of all defined SIDs for the
session into pSidDiagList and puts the number of entries into pCount. To prevent overflow, the
caller places the maximum number of SID diagnostics that can be returned into pCount. Returns
with the invalid_id bit set if the session with a given ID was not found. If more SIDs are defined
than are in pCount, then the maximum possible amount of data is received and the
buffer_too_short bit is set in the returned status. Returns HSDA_OK if no problems occurred.
Possible point error types are:

1. HSDA_SID_OK – There is no problem with receiving data for the point.

2. HSDA_SID_USED – There is already another connection on the originating drop that uses
the point (this is for avoiding the problem that some events for the point are received by one
application and some by another one). The SID is still added to the list of SIDs on the drop,
but is always recognized as already used, even if the situation changes and it is not used by
any other application connected to the drop.
3. HSDA_SID_NOT_FOUND – The given SID was not found on the active Controller.
4. HSDA_SID_DROP_UNREACHABLE – No connection to originating drop.

HsdaStatusType HsdaResetStatisticalAttribute(HsdaSessionIdType ID,

HsdaStatisticalAttributeIdType attributeId) - Resets the value of the attribute identified by
attributeId for all drops in the session whose identifier is equal to ID. The statistical attributes that
can be reset include the buffer event overflow flag, number of processed data frames, and
number of lost data frames.

OW360_R1100 127
5.23 BUFFER

HsdaStatusType HsdaStopLogging(HsdaSessionIdType ID) – Ends logging of the algorithms

associated with a given session ID and closes all of the associated connections. ID is no longer
valid at this point.

HsdaStatusType HsdaShutdown() – Cleans up HsdaAPI internals.

API Responsibilities

The HSDA Windows API is responsible for maintaining a connection to the HSDA servers,
automatic retrieval of HSDA event data from the network, detecting communication
failures/delays, and re-establishing the connection. For the purpose of keeping track of the
connection state, the API periodically checks for incoming messages (data, diagnostic, or
heartbeat) from each server. If no data is received over an extended period of time, a Start
Logging request is resent to the server. Once the server has successfully processed the Start
Logging request, it starts to periodically send HSDA event data over the network. No explicit 'Get
Data' request is sent from the client to the server, which reduces network traffic. The events
obtained from the network are stored in internal data buffers on the workstation side, for later
retrieval by the client using the HsdaData call.

Connections to drops are not shared between HSDA sessions. Each HSDA session has its own
connection to each drop from which it receives data.

Ovation Station and Controller communication

All communication between the Ovation Station and the Ovation Controller is performed using the
UDP protocol. If the Windows firewall is turned on, you must create an exception for the end
application. On the Ovation Controller, the HSDA task listens on port 4599 for connections from
the Ovation Station. The active (in control) Controller initiates a connection to the backup
Controller. The backup Controller listens on port 4678 for HSDA connections from the active
Controller. The active Controller tries to establish the connection to its partner once a second. The
active Controller also checks if the number of connections is less than the maximum number of
connections when a new connection attempt is made.

UDP Protocol Retransmission Mechanism

 The UDP version of HSDA makes use of two mechanisms to provide limited retransmission
capability.
 The first mechanism assigns sequence numbers to UDP frames containing HSDA event
data. This enables the workstation API to determine whether a given received packet is a
duplicate or not.
 The second mechanism buffers the data frames on the Controller side in a dedicated
queue. After a data frame is sent from the Controller, it is appended to the queue. If the
workstation does not acknowledge reception of this frame within a fixed time (currently
500 ms), the frame is retransmitted. There is a fixed amount of frame buffers available
(currently 200). If there are no free buffers and a frame needs to be sent out, the oldest
frame buffer (the one which was added to the queue the earliest) is used.

128 OW360_R1100
 5.24 CALCBLOCK

5.24 CALCBLOCK
Description

The CALCBLOCK algorithm is designed to allow you to solve complex mathematical equations
within a control sheet. The CALCBLOCK algorithm supports any operation from the following list.
For more complex equations, CALCBLOCK algorithms can be cascaded together. Logical
operations are supported by the CALCBLOCKD algorithm (see page 138).

Each CALCBLOCK algorithm can support up to 18 inputs and 10 floating point constants.

Each CALCBLOCK algorithm can support up to 15 operations (in any combination). Each
operator has two arguments.

The intermediate result of each operation is stored in the Real Fields (1-15) of the algorithm
record. These intermediate results display in the tuning window of the monitor graphic and can be
used by the user to debug a calculation.

The result of the defined calculation is stored in the OUT point. If an invalid number (for example,
divide by zero, 1n (negative number), infinity, and so forth), occurs, the VALID output is set to
logical FALSE. If the calculation does not result in an invalid number, the VALID output is set to
logical TRUE.

The real constant fields are the only tunable fields in the algorithm. All editing must be performed
via the Control Builder.

The optional ENBL input allows the algorithm to be conditionally executed. If the input is
connected, the calculation is carried out only if the ENBL input is TRUE. If the ENBL input is
FALSE, the calculation is not performed, and the output is set to the previous value.

If the ENBL input is not connected, then there is no conditional execution, and the calculation is
performed each execution loop.

Note: The round function rounds to the nearest integer value. If the number falls midway, it is
rounded to the nearest value above (for positive numbers) or below (for negative numbers). For
example, round (1.5) = 2 and round (-1.5) = -2.

CALCBLOCK operations

MATHEMATICAL STANDARD SCIENTIFIC

Add (a + b) *Square Root (sqrt(a)) *Cosine (Cos (a))

Subtract (a - b) *Reciprocal (recip(a)) *Sine (Sin (a))

Multiply (a * b) Max (max (a,b)) *Tangent (Tan (a))

Divide (a / b) Min (min (a,b)) *Arccos (arccos (a))

Power (a^b) *Negate (neg (a)) *Arcsin (arcsin (a))

*Square (square(a)) Remain (remain (a,b)) *Arctan (arctan (a))

OW360_R1100 129
5.24 CALCBLOCK

MATHEMATICAL STANDARD SCIENTIFIC

*Cube *Round (round a) *Natural Log (Ln (a))

(cube(a)) *Truncate (trunc a) *Log base 10 (log10(a))

*Absolute value (abs a) *Antilog (antilog (a))

*Exp (exp(a))

(*) = Unary Operator (Takes only one argument.)

Functional symbol

130 OW360_R1100
 5.24 CALCBLOCK

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Byte Data Init. Optional 46 Tuning Diagram Number -

QBAD Y5-Byte Data Init Optional YES Bad Quality on Invalid -

Number
YES = Set output to bad
quality
NO = Do not set output to
bad quality
OPR1 X0-Byte Variable Required - Operand #1 -

OPR2 X1-Byte Variable Optional - Operand #2 -

OPR3 X2-Byte Variable Optional - Operand #3 -

OPR4 X3-Byte Variable Optional - Operand #4 -

OPR5 X4-Byte Variable Optional - Operand #5 -

OPR6 X5-Byte Variable Optional - Operand #6 -

OPR7 X6-Byte Variable Optional - Operand #7 -

OPR8 X7-Byte Variable Optional - Operand #8 -

OPR9 X8-Byte Variable Optional - Operand #9 -

OP10 X9-Byte Variable Optional - Operand #10 -

OP11 Y0-Byte Variable Optional - Operand #11 -

OP12 Y1-Byte Variable Optional - Operand #12 -

OP13 Y2-Byte Variable Optional - Operand #13 -

OP14 Y3-Byte Variable Optional - Operand #14 -

OP15 Y4-Byte Variable Optional - Operand #15 -

ARG1 G0-Integer Variable Required - Argument #1 -

ARG2 G1-Integer Variable Optional - Argument #2 -

ARG3 G2-Integer Variable Optional - Argument #3 -

ARG4 G3-Integer Variable Optional - Argument #4 -

ARG5 G4-Integer Variable Optional - Argument #5 -

ARG6 G5-Integer Variable Optional - Argument #6 -

ARG7 G6-Integer Variable Optional - Argument #7 -

ARG8 G7-Integer Variable Optional - Argument #8 -

ARG9 G8-Integer Variable Optional - Argument #9 -

OW360_R1100 131
5.24 CALCBLOCK

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

AR10 G9-Integer Variable Optional - Argument #10 -

AR11 B0-Integer Variable Optional - Argument #11 -

AR12 B1-Integer Variable Optional - Argument #12 -

AR13 B2-Integer Variable Optional - Argument #13 -

AR14 YU-Integer Variable Optional - Argument #14 -

AR15 B4-Integer Variable Optional - Argument #15 -

AR16 B5-Integer Variable Optional - Argument #16 -

AR17 B6-Integer Variable Optional - Argument #17 -

AR18 B7-Integer Variable Optional - Argument #18 -

AR19 B8-Integer Variable Optional - Argument #19 -

AR20 B9-Integer Variable Optional - Argument #20 -

AR21 C0-Integer Variable Optional - Argument #21 -

AR22 C1-Integer Variable Optional - Argument #22 -

AR23 C2-Integer Variable Optional - Argument #23 -

AR24 C3-Integer Variable Optional - Argument #24 -

AR25 C4-Integer Variable Optional - Argument #25 -

AR26 C5-Integer Variable Optional - Argument #26 -

AR27 C6-Integer Variable Optional - Argument #27 -

AR28 C7-Integer Variable Optional - Argument #28 -

AR29 C8-Integer Variable Optional - Argument #29 -

AR30 YT-Integer Variable Optional - Argument #30 -

RES1 R1-Real Variable - - Result of operation #1 -

RES2 R2-Real Variable - - Result of operation #2 -

RES3 R3-Real Variable - - Result of operation #3 -

RES4 R4-Real Variable - - Result of operation #4 -

RES5 R5-Real Variable - - Result of operation #5 -

RES6 R6-Real Variable - - Result of operation #6 -

RES7 R7-Real Variable - - Result of operation #7 -

RES8 R8-Real Variable - - Result of operation #8 -

RES9 R9-Real Variable - - Result of operation #9 -

RE10 S1-Real Variable - - Result of operation #10 -

RE11 S2-Real Variable - - Result of operation #11 -

132 OW360_R1100
 5.24 CALCBLOCK

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

RE12 S3-Real Variable - - Result of operation #12 -

RE13 S4-Real Variable - - Result of operation #13 -

RE14 S5-Real Variable - - Result of operation #14 -

RE15 S6-Real Variable - - Result of operation #15 -

CON1 S7-Real Tuning Optional - Constant 1 -

Constant

CON2 S8-Real Tuning Optional - Constant 2 -

Constant

CON3 S9-Real Tuning Optional - Constant 3 -

Constant

CON4 T1-Real Tuning Optional - Constant 4 -

Constant

CON5 T2-Real Tuning Optional - Constant 5 -

Constant

CON6 T3-Real Tuning Optional - Constant 6 -

Constant

CON7 T4-Real Tuning Optional - Constant 7 -

Constant

CON8 T5-Real Tuning Optional - Constant 8 -

Constant

CON9 T6-Real Tuning Optional - Constant 9 -

Constant

CO10 T7-Real Tuning Optional - Constant 10 -

Constant

ENBL - Variable Optional - Enable Calculations LD

IN1 - Variable Required - Input 1 LA

IN2 - Variable Optional - Input 2 LA

IN3 - Variable Optional - Input 3 LA

IN4 - Variable Optional - Input 4 LA

IN5 - Variable Optional - Input 5 LA

IN6 - Variable Optional - Input 6 LA

IN7 - Variable Optional - Input 7 LA

IN8 - Variable Optional - Input 8 LA

IN9 - Variable Optional - Input 9 LA

IN10 - Variable Optional - Input 10 LA

IN11 - Variable Optional - Input 11 LA

OW360_R1100 133
5.24 CALCBLOCK

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

IN12 - Variable Optional - Input 12 LA

IN13 - Variable Optional - Input 13 LA

IN14 - Variable Optional - Input 14 LA

IN15 - Variable Optional - Input 15 LA

IN16 - Variable Optional - Input 16 LA

IN17 - Variable Optional - Input 17 LA

IN18 - Variable Optional - Input 18 LA

OUT - Variable Required - Calculation result value LA

VALI - Variable Optional - Valid output flag LD

Example 1

The following example illustrates a single calculation.

Figure 13: Single calculation

Algorithm parameter

ALGORITHM VALUE STEP SOLUTION

PARAME TE R

IN1 T Not applicable

ENBL SIG1 Not applicable

CON1 459.67 Not applicable

CON2 1164.83 Not applicable

134 OW360_R1100
 5.24 CALCBLOCK

ALGORITHM VALUE STEP SOLUTION

PARAME TE R

OPR1 + RES1 = IN1 + CON1

OPR2 / RES2 = RES1 / CON2

OUT Y Y = RES2

VALI SIG2 Not applicable

Example 2

The following example illustrates a multiple calculation.

This calculation is divided into two parts using two CALCBLOCK algorithms as follows:

CALCBLOCK #1 solves equation:

(-2.0296177 + 0.33158207Y + 1.7158422Y2 + 6.2354116Y3 - 14.042987Y4 + 7.3749399Y5)

OW360_R1100 135
5.24 CALCBLOCK

Algorithm parameter

ALGORITHM VALUE INTERMEDIATE STEP STEP SOLUTION

PARAME TE R

IN1 Y Not applicable Not applicable

ENBL SIG1 Not applicable Not applicable

CON1 2.0296177 Not applicable Not applicable

CON2 0.33158207 Not applicable Not applicable

CON3 1.7158422 Not applicable Not applicable

CON4 6.2354116 Not applicable Not applicable

CON5 14.042987 Not applicable Not applicable

CON6 7.3749377 Not applicable Not applicable

CON7 4 Not applicable Not applicable

CON8 5 Not applicable Not applicable

OPR1 power RES1 = power (IN1, CON8) Y5

OPR2 power RES2 = power (IN1, CON7) Y4
OPR3 cube RES3 = cube (IN1) Y3
OPR4 square RES4 = square (IN1) Y2
OPR5 * RES5 = CON6 * RES1 7.374 * (Y5)
OPR6 * RES6 = CON5 * RES2 14.042 * (Y4)
OPR7 * RES7 = CON4 * RES3 6.235 * (Y3)
OPR8 * RES8 = CON3 * RES4 1.715 * (Y2)
OPR9 * RES9 = CON9 * IN1 0.331 * Y

OP10 negative RE10 = neg (CON1) -2.029

OP11 + RE11 = RE10 + RES9 (-2.029 + (0.331 * Y))

OP12 + RE12 = RE11 + RES8 ((-2.029 + (0.331 * Y)) + (1.715 *

(Y2)))
OP13 + RE13 = RE12 + RES7 ((-2.029 + (0.331 * Y)) + (1.715 *
(Y2)) + (6.235 * (Y3)))

136 OW360_R1100
 5.24 CALCBLOCK

ALGORITHM VALUE INTERMEDIATE STEP STEP SOLUTION

PARAME TE R

OP14 - RE14 = RE13 - RES6 (((-2.029 + (0.331 * Y)) + (1.715 *

(Y2)) + (6.235 * (Y3)) - (14.042 *
(Y4)))
OP15 + RE15 = RE14 + RES5 ((((-2.029 + (0.331 * Y)) + (1.715
* (Y2)) + (6.235 * (Y3)) - (14.042
* (Y4))) + (7.374 * (Y5)))
OUT OUT OUT = RE15 Not applicable

VALI VALI Not applicable Not applicable

CALCBLOCK #2 solves equation:

(2.62068 x 10-5 / 0.000672) exp(OUT1)

Algorithm parameter

ALGORITHM VALUE INTERMEDIATE STEP STEP SOLUTION

PARAME TE R

IN1 OUT Not applicable Not applicable

ENBL VALI Not applicable VALI signal from CALCBLOCK #1

CON1 0.0389982143 Not applicable (2.62068 x 10-5 / 0.000672)

OPR1 exp RES1 = exp (IN1) (exp IN1)

OPR2 * RES2 = CON1 * RES1 (0.0389982143 * (exp IN1))

OUT OUT OUT = RES2 Not applicable

VALI VALI Not applicable Not applicable

OW360_R1100 137
5.25 CALCBLOCKD

5.25 CALCBLOCKD
Description

The CALCBLOCKD algorithm is the digital version of the CALCBLOCK algorithm (see page 129).
CALCBLOCKD can only perform logical functions. The list of functions is outlined in the
following table. For more complex calculations, CALCBLOCKD algorithms can be cascaded
together.

Logic

LOGICAL

And (a && b)

Nand (a ^& b)

Or (a || b)

Nor (a ^| b)

Xor (a xor b)

Not (not a)

Each CALCBLOCKD algorithm can support up to 18 inputs and 10 floating point constants. Each
CALCBLOCKD algorithm can support up to 15 of the above operations (in any combination).
Each operator has two arguments.

The intermediate result of each operation is stored in the Real Fields (1-15) of the algorithm
record. These intermediate results display in the tuning window of the monitor graphic and can be
used by the user to debug a calculation. The result of the defined calculation is stored in the OUT
point. If an invalid calculation occurs, the VALID output is set to logical FALSE. If the calculation
does not result in an invalid number, the VALID output is set to logical TRUE.

The real constant fields are the only tunable fields in the algorithm. All editing must be performed
via the Control Builder.

The optional ENBL input allows the algorithm to be conditionally executed. If the input is
connected, the calculation is carried out only if the ENBL input is TRUE. If the ENBL input is
FALSE, the calculation is not performed, and the output is set to the previous value. If the ENBL
input is not connected, then there is no conditional execution, and the calculation is performed
each execution loop.

138 OW360_R1100
 5.25 CALCBLOCKD

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Byte Data Init. Optional 46 Tuning Diagram -

Number

OPR1 X0-Byte Variable Required - Operand #1 -

OPR2 X1-Byte Variable Optional - Operand #2 -

OPR3 X2-Byte Variable Optional - Operand #3 -

OPR4 X3-Byte Variable Optional - Operand #4 -

OPR5 X4-Byte Variable Optional - Operand #5 -

OPR6 X5-Byte Variable Optional - Operand #6 -

OPR7 X6-Byte Variable Optional - Operand #7 -

OPR8 X7-Byte Variable Optional - Operand #8 -

OPR9 X8-Byte Variable Optional - Operand #9 -

OP10 X9-Byte Variable Optional - Operand #10 -

OW360_R1100 139
5.25 CALCBLOCKD

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

OP11 Y0-Byte Variable Optional - Operand #11 -

OP12 Y1-Byte Variable Optional - Operand #12 -

OP13 Y2-Byte Variable Optional - Operand #13 -

OP14 Y3-Byte Variable Optional - Operand #14 -

OP15 Y4-Byte Variable Optional - Operand #15 -

ARG1 G0-Integer Variable Required - Argument #1 -

ARG2 G1-Integer Variable Optional - Argument #2 -

ARG3 G2-Integer Variable Optional - Argument #3 -

ARG4 G3-Integer Variable Optional - Argument #4 -

ARG5 G4-Integer Variable Optional - Argument #5 -

ARG6 G5-Integer Variable Optional - Argument #6 -

ARG7 G6-Integer Variable Optional - Argument #7 -

ARG8 G7-Integer Variable Optional - Argument #8 -

ARG9 G8-Integer Variable Optional - Argument #9 -

AR10 G9-Integer Variable Optional - Argument #10 -

AR11 B0-Integer Variable Optional - Argument #11 -

AR12 B1-Integer Variable Optional - Argument #12 -

AR13 B2-Integer Variable Optional - Argument #13 -

AR14 YU-Integer Variable Optional - Argument #14 -

AR15 B4-Integer Variable Optional - Argument #15 -

AR16 B5-Integer Variable Optional - Argument #16 -

AR17 B6-Integer Variable Optional - Argument #17 -

AR18 B7-Integer Variable Optional - Argument #18 -

AR19 B8-Integer Variable Optional - Argument #19 -

AR20 B9-Integer Variable Optional - Argument #20 -

AR21 C0-Integer Variable Optional - Argument #21 -

AR22 C1-Integer Variable Optional - Argument #22 -

AR23 C2-Integer Variable Optional - Argument #23 -

AR24 C3-Integer Variable Optional - Argument #24 -

AR25 C4-Integer Variable Optional - Argument #25 -

AR26 C5-Integer Variable Optional - Argument #26 -

AR27 C6-Integer Variable Optional - Argument #27 -

140 OW360_R1100
 5.25 CALCBLOCKD

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

AR28 C7-Integer Variable Optional - Argument #28 -

AR29 C8-Integer Variable Optional - Argument #29 -

AR30 YT-Integer Variable Optional - Argument #30 -

RES1 R1-Real Variable - - Result of operation -

#1
RES2 R2-Real Variable - - Result of operation -
#2
RES3 R3-Real Variable - - Result of operation -
#3
RES4 R4-Real Variable - - Result of operation -
#4
RES5 R5-Real Variable - - Result of operation -
#5
RES6 R6-Real Variable - - Result of operation -
#6
RES7 R7-Real Variable - - Result of operation -
#7
RES8 R8-Real Variable - - Result of operation -
#8
RES9 R9-Real Variable - - Result of operation -
#9
RE10 S1-Real Variable - - Result of operation -
#10
RE11 S2-Real Variable - - Result of operation -
#11
RE12 S3-Real Variable - - Result of operation -
#12
RE13 S4-Real Variable - - Result of operation -
#13
RE14 S5-Real Variable - - Result of operation -
#14
RE15 S6-Real Variable - - Result of operation -
#15
CON1 S7-Real Tuning Optional - Constant 1 -
Constant

CON2 S8-Real Tuning Optional - Constant 2 -

Constant

CON3 S9-Real Tuning Optional - Constant 3 -

Constant

CON4 T1-Real Tuning Optional - Constant 4 -

Constant

OW360_R1100 141
5.25 CALCBLOCKD

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

CON5 T2-Real Tuning Optional - Constant 5 -

Constant

CON6 T3-Real Tuning Optional - Constant 6 -

Constant

CON7 T4-Real Tuning Optional - Constant 7 -

Constant

CON8 T5-Real Tuning Optional - Constant 8 -

Constant

CON9 T6-Real Tuning Optional - Constant 9 -

Constant

CO10 T7-Real Tuning Optional - Constant 10 -

Constant

ENBL - Variable Optional - Enable Calculations LD

IN1 - Variable Required - Input 1 LP

IN2 - Variable Optional - Input 2 LP

IN3 - Variable Optional - Input 3 LP

IN4 - Variable Optional - Input 4 LP

IN5 - Variable Optional - Input 5 LP

IN6 - Variable Optional - Input 6 LP

IN7 - Variable Optional - Input 7 LP

IN8 - Variable Optional - Input 8 LP

IN9 - Variable Optional - Input 9 LP

IN10 - Variable Optional - Input 10 LP

IN11 - Variable Optional - Input 11 LP

IN12 - Variable Optional - Input 12 LP

IN13 - Variable Optional - Input 13 LP

IN14 - Variable Optional - Input 14 LP

IN15 - Variable Optional - Input 15 LP

IN16 - Variable Optional - Input 16 LP

IN17 - Variable Optional - Input 17 LP

IN18 - Variable Optional - Input 18 LP

OUT - Variable Required - Calculation result LP

value
VALI - Variable Optional - Valid output flag LD

142 OW360_R1100
 5.25 CALCBLOCKD

Example

The following example illustrates a single calculation:

A = NOT(IN1) && (IN2 XOR IN3)

Figure 14: Single calculation

Algorithm parameter

ALGORITHM PARAM E TER VALUE STEP SOLUTION

IN1 I1 Not applicable

IN2 I2 Not applicable

IN3 I3 Not applicable

ENBL SIG1 Not applicable

OPR1 NOT RES1 = not(IN1)

OPR2 XOR RES2 = xor(IN2, IN3)

OPR3 AND RES3 = and(RES1, RES2)

OUT A A = RES3

VALI SIG2 Not applicable

OW360_R1100 143
5.26 COMPARATOR

5.26 COMP AR ATOR

Description

The COMPARATOR algorithm compares the value of IN1 with the value of IN2, and the
appropriate output is set to TRUE. The COMPARATOR algorithm has an option for enabling or
disabling quality propagation with the following requirements:
 The added parameter is an enumerated Data Init. type named PROQ, and it has the options 0
– OFF and 1 – ON. This input is in the OFF state by default.
 The output quality is the lowest of the two input qualities when the quality propagation is
enabled. The False outputs are set to GOOD quality when the quality propagation is enabled.
All output qualities are set to GOOD if the quality propagation is disabled.
 The output quality is set to BAD if either of the inputs are invalid real numbers.
 If the PROQ parameter transitions from ON to OFF, all the output qualities are set to GOOD.
 The COMPARATOR algorithm has the same functionality as the COMPARE algorithm.

Invalid Real Numbers

Analog input values are checked for invalid real numbers. If the input value is invalid, the output
points are set to FALSE.

Functional symbol

Figure 15: COMPARATOR algorithm functional symbol

144 OW360_R1100
 5.26 COMPARATOR

Algorithm definitions

NAME LC ALG. TYPE REQUIRED / DEFAULT DESCRIPTION MIN.

REC. OPTIONAL VALUE POINT
FIELD REC.

PROQ X1-Byte Data Init. Required OFF Quality -

Bit 0 Propagation
Option:
ON
 Output quality
is the worst of
the two input
qualities. False
outputs are set
to GOOD
quality.
 If either of the
inputs are
invalid, output
quality is BAD.
OFF
 Output quality
is GOOD.
IN1 - Variable Required - Input 1 (analog). LA
IN2 - Variable Required - Input 2 (analog). LA
OUT - Variable Required - IN1 equals IN2 LD
(digital).
OUTG - Variable Required - IN1 Greater than LD
IN2 (digital).
OUTL - Variable Required - IN1 Less than LD
IN2 (digital).
ENBL - Input Optional - When this input is LD
true, IN1 is
compared to IN2,
and the
appropriate
output is set
TRUE.

OW360_R1100 145
5.27 COMPARE

5.27 COMP ARE

Description

The COMPARE algorithm compares the value of IN1 with the value of IN2, and the appropriate
output is set TRUE.

Invalid Real Numbers

Analog input values are checked for invalid real numbers. If the input value is invalid, the output
points are set to FALSE.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

IN1 - Variable Required - Input 1 (analog) LA

IN2 - Variable Required - Input 2 (analog) LA

OUT - Variable Required - IN1 equals IN2 LD

(digital)
OUTG - Variable Required - IN1 Greater than IN2 LD
(digital)

OUTL - Variable Required - IN1 Less than IN2 LD

(digital)
ENBL - Input Optional - When this input is LD
true, IN1 is compared
to IN2, and the
appropriate output is
set TRUE.

146 OW360_R1100
 5.28 COSINE

5.28 COSINE
Description

The COSINE algorithm performs the mathematical cosine function. COSINE has one input and
one output analog point. Each time the algorithm is executed, if the output is on scan, it is set to
the COSINE of the input. The input to this algorithm is in radians. If an input is only available in
degrees, multiply it by 0.01745329 to convert to radians.

Invalid Real Numbers and Quality

Analog input values are checked for invalid real numbers. If the input value is invalid, the value of
the output is invalid and its quality is set to BAD. If the input is valid, the quality of the input is
propagated to the output.

If the absolute value of the input is greater than 1018, then the output of the COSINE algorithm is
invalid and its quality is set to BAD.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

Function

OUT=COSINE(IN1)

OW360_R1100 147
5.29 COUNTER

5.29 COUNTER
Description

The COUNTER algorithm counts up or down based on the input DIRECTION for the direction to
count. If DIRECTION (DRCT) is INC (one), the counter increments, otherwise it decrements.
While the ENABLE (ENBL) is TRUE, the count increments or decrements by one for each scan
that the IN1 input is TRUE.

If the COUNTER increments, the ACTUAL (ACT) continues to increment even if it is greater than
the TARGET (TARG). If the value stored in ACT reaches the maximum value (16,777,216), it
remains unchanged. The OUT is set TRUE when ACT is equal to or greater than TARG.

If the COUNTER decrements, it starts decrementing from the TARGET value. If the value stored
in ACT reaches the minimum value (-16,777,216), it disregards the IN1 input and remains at the
minimum value. The OUT is set TRUE when ACT is less than or equal to zero.

If either TARG or ACT is invalid, no operation occurs and OUT is set to FALSE. If ENBL is
FALSE, then ACT is set to zero when the COUNTER algorithm is configured to count up or set to
preset.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Required 1 Tuning Diagram -

Number
Init
IN1 - Variable Required - Start Input Digital LD, LP

ENBL - Variable Required - Enable Input LD, LP

Digital
DRCT X1-Byte Data Init Required 0 Count Direction: -
DEC =
Decrement
INC = Increment
*TARG R1-Real Selectable Required 0.0 Count Target LA
Number
*ACT R2-Real Selectable Required 0.0 Actual Count LA
Output

148 OW360_R1100
 5.29 COUNTER

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

OUT - Variable Required - Count Complete LD, LP

Output
* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

Example

Function

OW360_R1100 149
5.30 DBEQUALS

5.30 DBEQUALS
Description

The DBEQUALS high/low comparator algorithm monitors two analog input values. If the absolute
value of the difference between the signals exceeds the deadband value, the digital output is set
TRUE. If the absolute value of the difference between the signals is less than the absolute value
of the difference between DBND and RTRN, then the output is set FALSE.

Invalid Real Numbers and Quality

Both analog input values are checked for invalid real numbers. If one of the input values is invalid,
the value of the output is invalid and its quality is set to BAD. If all the inputs are valid, the worse
quality among the inputs is propagated to the output.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 23 Tuning Diagram -

Number
DBND R1-Real Tuning Required 0 Deadband -
Constant

RTRN R2-Real Tuning Optional 0 Deadband return -

Constant delta parameter

IN1 - Variable Required - Input (analog) LA

IN2 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (digital) LD, LP

150 OW360_R1100
 5.30 DBEQUALS

Function
TEMP = IN1 - IN2
IF ABS(TEMP) DBND
THEN OUT = TRUE

IF OUT = TRUE
THEN IF ABS(TEMP) <ABS(DBND - RTRN)
THEN OUT = FALSE

where:

TEMP = local, temporary, real variable

OW360_R1100 151
5.31 DEVICE

5.31 DEVICE

Description

The DEVICE algorithm combines the commands to open/close/stop or start/stop a piece of

equipment with feedback signals indicating the command was accomplished. Devices allow
controlled access of the equipment they own and simplify the operation of the equipment. For
example, when an operator wants to close a large motor-driven valve, he could watch the
open/close verify contact signals and manually toggle the close contact output until the
closed-confirm is received or an excessive amount of time has passed. Conversely, if the
Controller takes over for the operator, the command is simpler (that is, the Controller closes the
valve). This algorithm provides digital outputs that reflect how the I/O outputs of the device are
being maintained and the different status/mode conditions of the device.

The DEVICE algorithm responds to the following signal combinations:

 One digital output and no feedback.
 One digital output and one digital feedback.
 Two digital outputs and two digital feedbacks.
 Two digital outputs and one feedback.
 Three digital outputs and two feedbacks.

One Digital Output and No Feedback

With one output and no feedback, the DEVICE algorithm sets the device to a defined state (on,
off, start, stop, open, close) when commanded.

152 OW360_R1100
 5.31 DEVICE

One Digital Output and One Digital Feedback

With one output and one feedback, the DEVICE algorithm can set the output to a defined state,
set the “In Transition” bit (A2 field of bit 1 of the device record), and then monitor the input. If the
input's state does not match the output state within a user- specified amount of time, the device
indicates a failed operation has occurred. If the feedback indicates the desired state is reached
within the user-specified time, the device sets its current state field to the appropriate value. In
either case, the In Transition bit resets at the end of the operation.

Two Digital Outputs and Two Digital Feedbacks

With two digital outputs and two digital feedbacks, the DEVICE algorithm can set the appropriate
output to “1” or ON and wait for the appropriate feedback to be true. When the appropriate
feedback indicates true, the device sets its current state field to the appropriate state. If the
feedback does not indicate the appropriate state is reached within the user-specified time, the
device status display indicates a failed operation.

OW360_R1100 153
5.31 DEVICE

Two Digital Outputs and One Digital Feedback

With two digital outputs and one feedback, the DEVICE algorithm can set the appropriate output
to “1” or ON and wait for the feedback to go to the desired state. When the feedback indicates the
new state, the device sets its current state field to the appropriate state. If the feedback does not
indicate the appropriate state was reached within the user-specified time, the device indicates a
failed operation.

Three Digital Outputs and Two Digital Feedbacks

With three outputs and two feedbacks, the algorithm can set the appropriate output to “1”
according to the OPEN/CLOSE, START/STOP, or STOP TRAVEL command requested. If the
request is an Open or Close command, the feedbacks are monitored to see if the new state is
reached. When the feedbacks indicate the new state, the device's current state bit is updated to
the appropriate state. If the feedbacks do not indicate the appropriate state within the
user-specified time, the device indicates a failed operation. If the command is a Stop Operation
request, the algorithm writes a “1” to the Stop Travel output and indicates that the device is
stopped.

154 OW360_R1100
 5.31 DEVICE

Control Operation

If the state of the I/O is indeterminate (that is, when both input status bits are equal to 1, or both
are equal to zero and the device is not being commanded to another state), the Sensor Failure bit
(bits 2 and 3 of the 1W field in the DVCE point) is set. Note, that once a device is commanded to
another state, the “In Transition” status is set true as soon as the algorithm starts driving the
device to the commanded state. The “In Transition” status is reset when the device feedback
indicates the new state, and the operation is successful. If the operation fails, and the device
indicates it is neither open nor closed (both bits of the feedbacks are zero or one), the “In
Transition” status remains set and the Input Sensor Failure bit is not set. However, the Operation
Failed bit (bit 2 of the A2 field of the DVCE point) is set.

The device with two feedbacks may also be configured to display a “Failure to Respond” status. If
you configure the device to have a response time, the failure occurs if both feedbacks are not at a
zero (clear) state within the defined response time. If a “Failure to Respond” occurs, there is no
“Operation Failure” since the algorithm waits for a new command to process following the
response failure.

In the event of “Failure to Respond”, OUTPUT1, OUTPUT2, and OUTPUT3 all equal zero. In this
case, OUTPUT1 represents OPEN/START/ON bit, OUTPUT2 represents CLOSE/STOP/OFF bit,
and OUTPUT3 represents STOP (TRAVEL) bit.

In the event of “Failure to Operate,” OUTPUT1, OUTPUT2, and OUTPUT3 equal zero, as if
“Failure to Respond.” After any “Failure to Operate” or “Failure to Respond,” the OUTPUTs are
always zero.

The digital inputs and outputs used by the DEVICE algorithm can either be signals read from or
written to I/O cards, other digital process points contained in the system, or a combination of the
two.

Whenever a device experiences a failed operation (or response failure), it may ignore additional
requests for state changes or it may continue servicing such requests, depending on how the
device is configured (bit 4 of MODE parameter). You may want a DEVICE algorithm to ignore
further requests after a piece of equipment has failed in order to prevent further damage to the
equipment. Regardless of how a device is configured, it services at least one request subsequent
to each change of operating mode (for example, Auto Mode to Manual Mode). If the device is
configured to ignore requests after a failure, it displays the status “LOCKOUT” when a failed
operation (or response failure) occurs.

Control Modes

A device is put into one of three modes by the operator by pressing the appropriate control key
(located on the Control Panel or Ovation Keyboard) or specified function key (located on a
standard keyboard). Note that the device must be configured to operate in that mode. Therefore,
the DEVICE has three modes of operation that can be adjusted during monitoring. These modes
are as follows:
 AUTO
 MANUAL
 LOCAL

OW360_R1100 155
5.31 DEVICE

Auto Mode

Auto Mode allows the Controller application program to control the device through
user-programmed logic. The device cannot go into Auto mode unless one or both of the following
conditions are true:
 The “Auto Permissive” bit is true.
 The device is configured so that its default mode (bit 7 in MODE parameter) is Auto.
Once either of the above conditions is satisfied, and the device is not in Local mode, the device
can enter Auto mode if:
 The operator presses the Auto mode request key.
 An Emergency Override occurs and the device's default mode is Auto.
 The Local Mode input goes false after being true, and the device's default mode is Auto.
 The default mode is Auto, and the DEVICE algorithm is in its first pass.
The device exits Auto mode whenever one of the following happens:
 The operator presses the Manual Mode Request key.
 The operator Tags Out the device.
 The “Auto Permissive” bit (bit 5 of the C5 field of the command word) goes False and the
default mode is not Auto mode (the device goes to Manual mode).
 Local Mode is commanded through the optional LRE input.
 Emergency Override occurs and the device's default mode is Manual (occurrence of an
override forces the mode to Manual).
The device may be configured (Bit 6 of MODE parameter) to go to Manual mode when a change
of state command is entered. If this is the case, pressing the following control keys causes the
device to go to Manual mode:
 Start/Open/Trip.
 Stop/Close/Reset.
 Stop Travel (discontinue operation in progress).
When in Auto Mode, the DEVICE algorithm accepts commands from the digital process points
that are linked to the device through the DEVICE algorithm. Possible commands are:
 Stop/Close/Reset.
 Start/Open/Trip.
 Stop Travel (discontinue operation in progress).
 Emergency OPEN/START Override.
 Emergency CLOSE/STOP Override.

156 OW360_R1100
 5.31 DEVICE

Manual Mode

Manual Mode of operation allows the operator to control the device with the control keys. The
device goes into this mode when one of the following occurs:
 The operator requests Manual mode by pressing the Manual Mode request key.
 In Auto mode, the “Auto Permissive” bit (bit 5 of the C5 field of the command word) goes false
and the device default mode is not Auto.
 Upon startup of the Controller, if the default mode of the device is Manual.
 Occurrence of an Emergency Override and the default mode of the device is Manual, or in
Local mode, the hardware field input goes false and the default mode of the device is Manual.
The device may be configured to go to Manual mode when an Engineer Station or Operator
Station change of state command is entered. If this is the case, pressing the following control
keys causes the device to go to Manual mode:
 Start/Open/Trip.
 Stop/Close/Reset.
 Stop Travel (discontinue operation in progress).
The device exits Manual mode whenever one of the following happens:
 Local Mode is commanded through the optional LRE (reject to local) input.
 The operator requests Auto Mode (and the “Auto Permissive” bit is set or Auto is the device's
default mode), or the operator requests the device to be Tagged-Out with the appropriate
control key.
When in Manual Mode, the DEVICE algorithm executes the Emergency Override to the device
only if the device is configured (see bit 0 in MODE parameter) so that the overrides have
precedence over the operator's commands.

Local Mode

Local Mode is the lowest level mode of operation for the device. A device can enter this mode
only if the following two conditions are met:
 The device is configured to monitor the LRE input that indicates a local mode is active.
 The LRE point is in the set (true) state.
When this point goes true, the device immediately goes into Local Mode and stays in this mode
until the following occurs:
 The LRE point is reset (goes false).
As long as the LRE point is true, the device does not accept any commands from the Auto and
Manual modes. It does however, report the current state of the device. Device Trips, Sensor
Failures, and Failed Operations cannot be determined when in Local Mode; therefore, these
conditions are not checked for or reported when in Local Mode.

When the device goes into Local Mode, inputs are read and outputs are not energized; they are
left as they were when device went into Local Mode. When the device leaves the Local Mode, the
device goes to its default mode AUTO or MANUAL as defined by bit 7 in MODE parameter. If
input sensors cannot be determined (both = 0, or both = 1) and the device has not been
commanded to change state, all three outputs equal zero.

OW360_R1100 157
5.31 DEVICE

Mode Independent Commands

There are several commands that are requested with keys and are executed if the device is in
Auto or Manual mode. These commands are:
 Set “Override Failure” flag (Disable Lockouts).
 Clear “Override Failure” flag (Enable Lockouts).
 Tag Out the Device.
 Acknowledge Trip.
 Auto mode request.
 Manual mode request.
These commands are not accepted, however, if the device is in Local mode or is tagged-out.

Maintenance Modes

Tag Out

When in Tag Out Mode, the device ignores all commands except “Remove Tag Out.” The device
goes to its default mode when the Tag Out is removed.

Lock Out

A subset of the Tag Out Mode is the device “LOCK OUT” mode. Lock out occurs if the device is
configured (see bit 4 MODE parameter) to ignore subsequent commands to change state after an
operation fails. In other words, the device has only one opportunity to change state in a particular
mode. If the operation fails, the DEVICE algorithm does not accept another Open/Start or
Close/Stop command while locked out.

A device may be removed from Lock Out by any of the following actions:
 Pressing the Auto or Manual mode request keys.
 Setting the failure override flag (disabling lockouts) via the appropriate key.
 Tagging out the device.
 Control being transferred to Local mode (the LRE point goes true).
When returning from Lock Out, variables OUT1, OUT2, and OUT3 equal zero.

Change of State

In general, a change of state command in progress is continued until the device reaches the new
state or until a time out occurs. The following conditions cause an operation in progress to be
discontinued:
 The device is Tagged Out, resulting in inputs being read and outputs not energized, left as
they were at the time of Lock Out.
 The device goes to Local mode, resulting in inputs being read and outputs not being
energized, left as they were when device went to Local Mode.
 A Stop (discontinue operation) command is requested by the current control mode and an
Emergency Override is not in progress. If the device is in Manual mode, however, and it is
configured so the Emergency Overrides do not have priority over Manual commands, a
Manual Stop request overrides the Emergency command.

158 OW360_R1100
 5.31 DEVICE

In order for a change of state command to be executed, its proper permissive must be true. For
example, a Manual Close/Stop command only executes if the Close/Stop permissive of the device
is true. The Emergency Override and Stop (discontinue operation) commands do not require any
permissive to be true in order to be executed.

The permissives of a device are set true on start-up and remain true unless the DEVICE algorithm
is used to update them.

You can set the amount of time that a device allows for the equipment to change state following a
command. You must specify the units of time (0.1 seconds, seconds, or minutes) to measure
transition time, and the maximum number of time units to get to the set and reset states. You can
also specify a time period (in loops) for the equipment to respond to a command.

For devices with feedback, you can also configure the amount of time that the DEVICE algorithm
sets the appropriate output “ON”. The following modes are supported:
 Set output “ON” for a user-configured time period (less than the transition time), or until the
new state is reached, whichever occurs first. (Setting bit 1 of MODE parameter indicates this
mode.)
 Set output “ON” for a user-configured time period (equal to the transition time) or until the new
state is reached, whichever occurs first. (Indicate this mode by setting bit 2 of the MODE
parameter.)
 Maintain output “ON” continuously, until a new command is given. This mode also has a
time-out associated with it, but the pulsing continues after the time-out occurs. If the operation
fails (device does not reach the commanded state) the operation is flagged as a failure, and
the pulsing is discontinued until a new command is given. (This mode is indicated by bit 3 of
the MODE parameter.)
For the case where the device has only one output (no feedbacks), the output is set to “ON” (or
“OFF”) continuously depending on whichever command is requested. There are no time-outs for
this case.

A device always writes to its output(s) when a new change of state command occurs regardless
of the state of its input(s). If the device command is from other application logic, care should be
taken to ensure that the command is maintained or pulsed as needed.

The device continuously checks for change of state commands when it is not in the process of
executing one. The device executes a change of state command when it is first set “ON.” If the
command stays “ON,” the device treats it as a new command when it finishes executing the last
command. Since the device writes to its output(s) when a new command occurs, its output(s)
cycle continuously “ON” and “OFF” if the following are true:
 A change of state command is “ON” and it matches the state of the device's input(s).
 The device is configured to set its output(s) “ON” for a certain amount of time, then “OFF.”

Emergency Overrides

In addition to the change of state commands, in each of the operating modes there are two other
commands: Emergency Start/Open/Trip and Emergency Stop/Close/Reset.

These two commands are generated by external logic in the Controller and can act as emergency
overrides over all other commands, including Stop Travel.

OW360_R1100 159
5.31 DEVICE

Whenever either the Emergency Open, or Emergency Close input becomes true, the DEVICE
algorithm forces the device to its default state and attempts to get the device to the commanded
state. (If the DEVICE algorithm is not configured to ignore failures, the emergency command
executes only once.) If both emergency overrides are set at the same time, the device remains on
its present course of action. Any occurrence of an override forces the device to its default mode.

As long as either Emergency input is set, the DEVICE algorithm ignores all Auto commands to
drive the device. The device may also be configured to have the Emergency inputs override the
Manual commands or the Manual commands override the Emergency inputs. Upon removal of
the emergency override, the device returns to servicing commands of its default mode.

Note: Emergency overrides, like all other commands, are ignored when the device is tagged out
or in Local Mode.

Alarming

The DEVICE algorithm supports seven types of alarms. All of these alarms, except Trips, require
operator acknowledgment. The device conditions which can produce alarms are:
 Failed Operations.
 Failures to Respond.
 Trips.
 Alarm State.
 Sensor Failures.
 Emergency Overrides.
 Attention (Trouble).

Failed Operations

If the Failed Operations alarm is configured, the DEVICE algorithm puts the device in alarm
whenever the equipment does not complete a change-of-state command (for example, if a valve
is commanded to open and it does not do so within the user-specified time). A Failed Operation
Alarm clears upon the next Open, Close, or Stop command to the device.

Failure to Respond

If the Failure to Respond alarm is configured, the DEVICE algorithm puts the device into alarm if
the feedbacks do not reflect an “In Transition” state within a user-specified number of loops. The
“In Transition” state must be that both feedbacks have a value of 0.

Trips

If Trip alarms are configured, the DEVICE algorithm puts the device into alarm whenever the
equipment unexpectedly changes state (for example, when a breaker trips open). A Trip Alarm
clears when you acknowledge the Trip by commanding the device to the Tripped state. Trip Alarm
returns do not require acknowledgment by the user.

Alarm State

The device can be configured to go into alarm based on a user-defined state. The alarm clears
only when the device returns to the non-alarmed state. These alarms must be acknowledged by
the user.

160 OW360_R1100
 5.31 DEVICE

Sensor Failures

A Sensor Failure alarm is caused by either or both of the following conditions:

 The device feedbacks are indeterminate (that is, both show a 00 or 11 status) and the device
is not in transition. This is an input sensor alarm.
 The outputs do not reflect the value written to them (output sensor alarm).

Emergency Override

The Emergency Override alarm is generated any time an override occurs and the device is not at
the override state. For example, the occurrence of an Emergency Open would generate an alarm
if the device is Closed. If both override inputs happen to become true at the same time, an alarm
is generated regardless of the state of the device.

Attention

The Attention (Trouble) alarm is caused by different conditions depending on how the device is
configured. Currently, the standard DEVICE algorithm does not generate an ATTENTION alarm.

If the device is configured to alarm a combination of conditions, the points are put into alarm when
either one or more of the alarm conditions exist.

The following alarming options are available:

 No Alarming.
 Failed Operations, Sensor Failures, Trips, Response Failures, Attention conditions, and
Emergency Overrides.
 Failed Operations, Sensor Failures, Trips, Response Failures, Attention conditions,
Emergency Overrides, and Alarm State.

Clearing Alarms

Upon Tagging Out, Scan Removing, or putting a device into Local mode, the following alarms are
cleared:
 Failed Operation.
 Failure to Respond.
 Sensor Failures.
 Trips.
 Attention.
A State Alarm, however, is not cleared by any of the conditions mentioned above. It must be
cleared by commanding the device.

Tagging out or going to Local mode clears any Emergency Override present.

OW360_R1100 161
5.31 DEVICE

Device Status Reporting

The device record maintains information corresponding to the current status of a device.
Depending on the state of a device, its displayed status includes a combination of the following
conditions:
 Current State.
 In Transition.
 Operation Failed.
 Failure to Respond.
 Tripped.
 Stopped.
 Emergency Close.
 Emergency Open.
 Current Mode.
 Override Failure.
 Scan Removed.
 Alarm Checking Off.
 Tagged Out.
 Locked Out.
 Quality.
The status information mentioned above comes from various flags (bits) in certain fields in the
packed point and algorithm record.

The A2 field of the Packed point (DVCE) has the following information:

A2 Field Bit Information

BIT DESCRIPTION

Bit 0 Current State. This bit indicates the current state of the feedback signals. In case
feedback signals give conflicting data, the last known state is reported. When scan
removed, the last command state is reported.

Bit 1 In Transition. This bit indicates the device algorithm is currently in the process of
trying to change the state of its equipment. The bit is set true when the device
starts to execute a command. It is reset when the feedback signals indicate the
operation is complete or the operation has failed.

Bit 2 Operation Failed. This bit is set following any unsuccessful attempt to change the
state of the equipment. It remains set until the next attempt is made to change the
state of the equipment. Failed operation is not indicated if the device is scanned
off.
Bit 3 Tripped. This bit is set any time the equipment changes state on its own, not by
the algorithm. It remains set until the Trip Acknowledge command is received. If it
is not acknowledged, no other change of state operations, in any mode, is
processed. The tripped bit is not set when the device is Tagged Out or Scanned
Removed.
Bit 4 Stopped. This bit is set whenever the device is commanded to stop. The bit
remains set until the next attempt is made by the device to change the state of the
equipment.

162 OW360_R1100
 5.31 DEVICE

BIT DESCRIPTION

Bit 5 Emergency Close. This bit reflects the status of the override inputs to the device.

Bit 6 Emergency Open. This bit reflects the status of the override inputs to the device.

Bit 7 Last Commanded State. This bit reflects the last known state of the device.

Bit 8 Local Mode. This bit indicates that the device is in local mode.

Bit 9 Manual Mode. This bit indicates that the device is in manual mode.

Bit 10 Auto Mode. This bit indicates that the device is in auto mode.

Bit 11 Reserved.

Bit 12 Attention. This bit indicates certain error conditions are present.

Bit 13 Failed to Respond. This bit indicates that the device did not respond to a
command.
Bit 14 Locked Out. This bit indicates that the state of the device is locked out.

Bit 15 Tagged Out. This bit indicates that the state of the device is tagged out.

The C5 field in the device algorithm holds the command word. This command word is the
interface between a Controller and a device. The bits in the C5 field are defined in the following
table:

C5 Field Bit Information

BIT DESCRIPTION

Bit 0 Emergency Close/Stop.

Bit 1 Emergency Open/Start.

Bit 2 Auto Close/Stop/Reset.

Bit 3 Auto Open/Start/Set.

Bit 4 Stop.

Bit 5 Auto Permissive.

Bit 6 Current State of Input 1 (Open/Start).

Bit 7 Current State of Input 2 (Close/Stop).

Bit 8 Current State of Input 3 (Stop).

Bit 9 Value currently being written to Output 1 (Open/Start).

Bit 10 Value currently being written to Output 2 (Close/Stop).

Bit 11 Value currently being written to Output 3 (Stop).

Bit 12 Close/Stop permissive.

OW360_R1100 163
5.31 DEVICE

BIT DESCRIPTION

Bit 13 Open/Start permissive.

Bit 14 Local Reject.

Setting Device Parameters

Alarming

The following fields in the Packed point (DVCE) must be set for alarming:

Alarming Parameters

TYPE OF ALARMING FIELDS TO BE SET

No Alarming Set E0 and E1 to zero.

Operate, Sensor, Trips, Overrides and Attention Set E0 and E1 to 0x386c.

Operate, Sensor, Trips, Overrides and Attention, Set E0 and E1 to 0x386d.

State Set(1)

Operate, Sensor, Trips, Overrides and Attention, Set E0 to 0x386d and E1 to 0x386c.
State Set(0)

The C4 field in the algorithm record defines the mode configuration. The bits in the C4 field are
defined in the following table:

C4 Field Bit Information

BIT MODE DESCRIPTION

Bit 0 Off The emergency Open/Start and Close/Stop commands override Auto
commands.

On The Emergency Open/Start and Close/Stop commands override all other

commands.

Bit 1 * On Set output 'ON' for a configured time period (less than the time-out). If this
bit is set, the algorithm maintains the appropriate output for the number of
loops in the Pulse Time or until the operation is successful, whichever
occurs first.
Bit 2 * On Set output 'ON' until a user-configured time-out (or the operation is
successful). The transition times for setting and resetting the device are
entered in the Set Time-out and Reset Time-out fields.
Bit 3 * On Set output 'On' continuously until a new command is entered.

Bit 4 On Disable lock-outs. If this bit is set, the device does not go into Lock Out
mode when a failed operation occurs.

Bit 5 On Do not execute the STOP TRAVEL command.

164 OW360_R1100
 5.31 DEVICE

BIT MODE DESCRIPTION

Bit 6 Off Manual Open/Close/Stop commands force the device to Manual mode.

On Manual Open/Close/Stop commands are processed only it the device is in

Manual mode.

Bit 7 Off Device default mode is Manual.

On Device default mode is Auto.

* Bits 1, 2, and 3 are not meant to be used together. Only one of these bits should be used at a
time. Also, these options apply to START/OPEN and STOP/CLOSE commands only. The STOP
TRAVEL command uses Bit 3 regardless of what is selected.

The C7 field in the algorithm record defines the emergency Open/Close configuration. The bits in
the C7 field are defined in the following table:

C7 Field Bit Information

BIT MODE DESCRIPTION

Bit 0 Not Used Not used.

Bit 1 Off Place the DEVICE algorithm in Local mode when:
The LRE point is TRUE.
Bit 2 of the C7 field is 1 and the LRE is TRUE.
On Place the DEVICE algorithm in Local mode when:
The LRE point is FALSE.
Bit 2 of the C7 field is 1 and the LRE is FALSE.
Bit 2 Off The LOC point is used to indicate the device is in Local mode.
On The LRE point is used as a “local mode request.”

Bit 3 Off The EMOP (Emergency Open) input is NOT inverted.

On The EMOP (Emergency Open) input is inverted.

Bit 4 Off The EMCL (Emergency Close) input is NOT inverted.

On The EMCL (Emergency Close) input is inverted.

Bit 5 Off The Trip Acknowledge action causes a command to the output(s)
based on the current feedback state.

On The Trip Acknowledge action does NOT cause a command to

the output(s).

Bit 6 Off The OPRM (Open Permissive) does NOT apply to the EMOP
(Emergency Open) input.

OW360_R1100 165
5.31 DEVICE

BIT MODE DESCRIPTION

On The OPRM (Open Permissive) does apply to the EMOP

(Emergency Open) input.

Bit 7 Off The CPRM (Close Permissive) does NOT apply to the EMCL
(Emergency Close) input.

On The CPRM (Close Permissive) does apply to the EMCL

(Emergency Close) input.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU - Data Init Required 121 Tuning diagram -

number.
Integer
SET D2 - Data Init. Required 20 Set time out -
(maximum of 255 if
Integer units are tenth of a
second or seconds.
Maximum of 100
minutes if units are
minutes).
RSET YT - Data Init. Required 20 Reset time out -
(maximum of 255 if
Integer units are tenth of a
second or seconds.
Maximum of 100
minutes if units are
minutes).

166 OW360_R1100
 5.31 DEVICE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

MODE C4 - Data Init. Required 9 Mode information. -

Integer
EMRG C7 - Data Init. Required - Emergency -
open/close.
Integer
PT D4 - Data Init. Required - Pulse time. -
Integer
TR YP - Data Init. Required 0 Time response. -
Integer
TU DO - Data Init. Required 1 Units time out. Value -
time units:
Integer
0 = tenth of a second
1 = seconds
2 = minutes
TYPE C8 - Data Init. Required Open/ Device type. The -
Close choices are:
Integer
- Open/Close
- Start/Stop
OPRM - Variable Optional - Input (digital); OPEN LD, LP
PERMISSIVE, allows
OPEN/START
commands to be
honored.
CPRM - Variable Optional - Input (digital); CLOSE LD, LP
PERMISSIVE; allows
CLOSE/STOP
commands to be
honored.
IN1 - Variable Optional - Input (digital); LD, LP
feedback. If the value
is TRUE, the device is
OPEN/ON.
IN2 - Variable Optional - Input (digital); LD, LP
feedback. If the value
is TRUE, the device is
CLOSED/OFF.
IN3 - Variable Optional - Input (digital): LD, LP
Auto mode request
DVCE point goes to
Auto mode when IN3
is TRUE, AUTP IS
TRUE.

OW360_R1100 167
5.31 DEVICE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

LRE - Variable Optional - Input (digital); Local LD, LP

reject
When EMRG Bit 2 =
1, point is used as the
“local mode request.”
AUTP - Variable Optional - Input (digital); AUTO LD, LP
PERMISSIVE; allows
the device to operate
in AUTO mode.
STOP - Variable Optional - Input (digital); AUTO LD, LP
STOP TRAVEL
command.
OPEN - Variable Optional - Input (digital); AUTO LD, LP
OPEN/START
command.
CLOS - Variable Optional - Input (digital); AUTO LD, LP
CLOSE/STOP
command.
EMOP - Variable Optional - Input (digital); LD, LP
emergency
OPEN/START
command.
EMCL - Variable Optional - Input (digital); LD, LP
emergency
CLOSE/STOP
command.
DVCE - Variable Required - Output device. LP

OUT1 - Variable Optional - Output (digital); TRUE LD, LP

when the device is
going to or being kept
at the OPEN/START
state.
OUT2 - Variable Optional - Output (digital); TRUE LD, LP
when the device is
going to or being kept
at the CLOSED/STOP
state.
OUT3 - Variable Optional - Output (digital); TRUE LD, LP
when a device
operation has been
stopped.
LOC - Variable Optional - Output (digital); LD, LP
When EMRG Bit 2 =
0, LOC is set TRUE
when the device is
operating in Local
mode.

168 OW360_R1100
 5.31 DEVICE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

MAN - Variable Optional - Output (digital); TRUE LD, LP

if the device is
operating in Manual
mode.
AUTO - Variable Optional - Output (digital); TRUE LD, LP
if the device is
operating in Auto
mode.
OPFL - Variable Optional - Output (digital); TRUE LD, LP
if a device operation
failed or if a failure to
respond occurred.
TRIP - Variable Optional - Output (digital); TRUE LD, LP
if the device tripped
(that is, changed state
without a change
state command).
STAT - Variable Optional - Output (digital); LD, LP
current state of the
device.
1 = OPEN/ON
0 = CLOSED/OFF

OW360_R1100 169
5.32 DEVICESEQ

5.32 DEVICESEQ
Description

The DEVICESEQ algorithm provides an interface between a control logic function and a
MASTERSEQ algorithm. In the most common application configuration, the logic control is utilized
to control a particular device. In this configuration, the MASERSEQ algorithm typically provides a
supervisory control function of multiple devices. Refer to the MASTERSEQ reference pages
(see page 376) for details on the operation of the MASTERSEQ algorithm.

The DEVICESEQ algorithm communicates with the associated MASTERSEQ algorithm via a
packed group point status point. The DEVICESEQ algorithm interfaces to the control logic via
individual inputs and outputs. Refer to the template definition table for details on the algorithm
inputs, outputs, and configuration parameters.

Functional symbol

Details of Operation

The DEVICESEQ algorithm provides the MASTERSEQ with the status information of the
associated device. This status information is outlined in the following status information section.
The DEVICESEQ algorithm also transfers the value of the GO bit in the status point to the STRT
output. As long as the GO bit in the status point is TRUE, the associated device is considered to
be running.

The algorithm can also be configured to utilize an internal failure timer. This timer monitors the
amount of time that elapses while the device is running. The timer stops accumulating time when
either the PASS or FAIL input becomes TRUE. The elapsed time is compared to the value of the
TARG parameter each execution cycle of the algorithm. The internal timer expires when the
accumulated time becomes greater than or equal to the value of TARG parameter and is greater
than zero. Setting the value of the TARG parameter greater than zero enables the failure timer. If
the failure timer is enabled, the accumulated time is always stored in the R3 field of the algorithm.
In addition, the accumulated time is also stored in the optional ACT output point.

The algorithm also incorporates an additional internal timer that stores the time that has elapsed
while the device was running. This timer value is stored in both the optional TIME output and the
R4 field of the algorithm record. This value is independent of the internal failure timer and is
always updated whether the internal failure timer is utilized or not. The accumulated time in both
timers is calculated based on loop time.

During the first pass mode of the controller and when the RESET bit in the status point (MSTR) is
TRUE, the DEVICESEQ algorithm sets the elapsed time for both the step timer and the internal
failure timer to zero.

170 OW360_R1100
 5.32 DEVICESEQ

Status Information

The DEVICESEQ algorithm provides the attached MASTERSEQ algorithm with the following
status information:
 It provides an indication that the associated device is ready for a remote start. The device is
ready for remote start when the RDY input is TRUE. The value of the RDY input is then
transferred to the READY bit of the status point during each execution cycle of the algorithm.
 It provides an indication that the associated device has failed. The device is failed when the
FAIL input is TRUE. The value of the FAIL input is transferred to the FAILED bit in the status
point during each execution cycle of the algorithm.
 It provides an indication that the associated device has completed operation when the PASS
input is TRUE. The value of the PASS input is transferred to the SUCCESS bit during each
execution cycle of the algorithm.

Freeze Mode

The purpose of the freeze mode is to preserve the operating state of the algorithm after the
device has completed operation. The algorithm can be configured to freeze the value of the bits in
the status point after the algorithm has been selected by the attached MASTERSEQ. As a result,
this enables you to determine and evaluate the performance of the device at a later point in time.
A DEVICESEQ algorithm is selected when the INSTEP bit in the status point is TRUE. If the FRZ
field in the algorithm is initialized to “FREEZE”, the algorithm does not update the status point
after the INSTEP bit transitions from TRUE to FALSE. Thus, the status bits that originate with the
DEVICESEQ retain their previous values. This state is referred to as freeze mode.

In freeze mode, the algorithm sets the FROZEN bit to logic 1 in the status point. In order to clear
the freeze mode condition, the attached MASTERSEQ algorithm must be reset. This causes the
RESET bit in the status point to become TRUE and the DEVICESEQ resets according to the rules
outlined in the initial state and reset section.

Note: Emerson does not recommend using freeze mode with an associated MASTERSEQ
algorithm which is operating in priority mode. See the MASTERSEQ reference pages (see page
376) for more details on priority mode operation.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU -Integer Data Required 5 Tuning Diagram -

Init Number

MSTR - Variable Required - Status point for LP

communication with
MASTERSEQ

FAIL - Variable Required - Input from device LD, LP

Logic functions
indicating that a
failure has occurred.

OW360_R1100 171
5.32 DEVICESEQ

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

PASS - Variable Required - Input from device LD, LP

Logic functions
indicating that the
execution of the
device has completed
successfully.
RDY - Variable Required - Input from device LD, LP
Logic functions
indicating that the
associated device is
ready for a start
command.
BASE R1-Real Tuning Required 1.0 Time Base in -
Constant Seconds.
Defines the units that
the internal failure
time and accumulated
time are displayed in.
(Typical values are
1.0 or 0.1 sec.)
* TARG R2-Real Selectable Required 0.0 Delay Time. LA
Defines the amount of
time that can elapse,
while the device is
running, before the
DEVICESEQ
algorithm sets the
failure bit in the status
point to Logic Delay
Time 1. If the value of
the parameters is 0.0,
the internal failure
timer is disabled.
FRZ X1-Byte Data Init Optional NO Options are: -
FREEZE
NO FREEZE
FREEZE
Update Freeze Flag.
Enables and disables
freeze mode.
STRT - Variable Required - Start Device LD, LP

172 OW360_R1100
 5.32 DEVICESEQ

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

ACT - Variable Optional - Output value of LA

internal failure timer.

TIME - Variable Optional - Output value of step LA

timer. Represents the
amount of time the
device has been
running
* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be executed
properly, you must enter a value for the parameter.

Status Bit Definitions

BIT NUMBER ORIGINATOR SIGNAL NAME DESCRIPTION

0 MASTERSEQ GO Signal to Device to Begin Step.

1 DEVICESEQ FAILED Signal to MASTERSEQ that Current Step

Encountered a Failure.
2 DEVICESEQ READY Signal to MASTERSEQ that Current Step
Completed Successfully.
3 DEVICESEQ SUCCESS Signal to MASTERSEQ that the low-level
Logic is Ready to Receive a Remote Start
Command.
4 MASTERSEQ INSTEP Signal from MASTERSEQ that the Step is
Currently Being Executed.

5 MASTERSEQ OVERRIDE When TRUE indicates that the OVRD input

was used to Increment the step.
6 MASTERSEQ RESET MASTERSEQ sets this bit logic 1 when
reset input is TRUE.
7 DEVICESEQ FROZEN This bit is TRUE when DEVICESEQ has
Frozen updates to the status point.
8 - 15 Reserved for - -
future use

OW360_R1100 173
5.33 DEVICEX

5.33 DEVICEX
Description

The DEVICEX algorithm combines the commands to open and close or start and stop a piece of
equipment with feedback signals indicating the command was accomplished. Devices allow
controlled access of the equipment they own and simplify the operation of the equipment. This
algorithm provides digital outputs that reflect how the I/O outputs of the device are being
maintained and the different status/mode conditions of the device.

The DEVICEX algorithm responds to the following signal combinations:

 One digital output and no feedback.
 One digital output and one digital feedback.
 Two digital outputs and two digital feedback signals.
 Two digital outputs and one feedback.
 Three digital outputs and two feedbacks.

Signal Combinations

One Digital Output and No Feedback

With one output and no feedback, the DEVICEX algorithm sets the device to a defined state (on,
off, start, stop, open, close) when commanded.

174 OW360_R1100
 5.33 DEVICEX

One Digital Output and One Digital Feedback

With one output and one feedback, the DEVICEX algorithm can set the output to a defined state,
set the “In Transition” bit (A2 field of bit 1 of the device record), and then monitor the input. If the
input's state does not match the output state within a user- specified amount of time, the device
indicates a failed operation has occurred. If the feedback indicates the desired state is reached
within the user-specified time, the device sets its current state field to the appropriate value. In
either case, the In Transition bit resets at the end of the operation.

Two Digital Outputs and Two Digital Feedbacks

With two digital outputs and two digital feedbacks, the DEVICEX algorithm can set the appropriate
output to “1” or ON and wait for the appropriate feedback to be true. When the appropriate
feedback indicates true, the device sets its current state field to the appropriate state. If the
feedback does not indicate the appropriate state is reached within the user-specified time, the
device status display indicates a failed operation.

OW360_R1100 175
5.33 DEVICEX

Two Digital Outputs and One Digital Feedback

With two digital outputs and one feedback, the DEVICEX algorithm can set the appropriate output
to “1” or ON and wait for the feedback to go to the desired state. When the feedback indicates the
new state, the device sets its current state field to the appropriate state. If the feedback does not
indicate the appropriate state was reached within the user-specified time, the device indicates a
failed operation.

Three Digital Outputs and Two Digital Feedbacks

With three outputs and two feedbacks, the algorithm can set the appropriate output to “1”
according to the OPEN/CLOSE, START/STOP, or STOP TRAVEL command requested. If the
request is an Open or Close command, the feedbacks are monitored to see if the new state is
reached. When the feedbacks indicate the new state, the device's current state bit is updated to
the appropriate state. If the feedbacks do not indicate the appropriate state within the
user-specified time, the device indicates a failed operation. If the command is a Stop Operation
request, the algorithm writes a “1” to the Stop Travel output and indicates that the device is
stopped.

176 OW360_R1100
 5.33 DEVICEX

Control Operation

If the state of the I/O is indeterminate (that is, when both input status bits are equal to 1, or both
are equal to zero and the device is not being commanded to another state), the Sensor Failure bit
(bit 2 and 3 of the 1W field of the DVCE point) in the device record is set and the quality is set to
bad. Note, that once a device is commanded to another state, the “In Transition” status is set to
true as soon as the algorithm starts driving the device to the commanded state. The “In
Transition” status is reset when the device feedback indicates the new state, and the operation is
successful. If the operation fails, and the device indicates it is neither open nor closed (both bits of
the feedbacks are zero or one), the “In Transition” status remains set and the Input Sensor Failure
bit is not set. However, the Operation Failed bit (bit 2 of the A2 field of the DVCE point) is set.

The device with two feedbacks may also be configured to display a “Failure to Respond” status. If
you configure the device to have a response time, the failure occurs if both feedbacks are not at a
zero (clear) state within the defined response time. If a “Failure to Respond” occurs, there is no
“Operation Failure” since the algorithm waits for a new command to process following the
response failure. However, if the device is Stopped and the feedbacks indicate a zero condition,
the Sensor Failure bit is not set.

The digital inputs and outputs used by the DEVICEX algorithm can either be signals read from or
written to I/O cards, other digital process points contained in the system, or a combination of the
two.

Whenever a device experiences a failed operation (or response failure), it may ignore additional
requests for state changes or it may continue servicing such requests. This depends on how the
device is configured (bit 4 of the C4 field of the algorithm record). You may want a DEVICEX
algorithm to ignore further requests after a piece of equipment has failed in order to prevent
further damage to the equipment. Regardless of how a device is configured, it services at least
one request subsequent to each change of operating mode (for example, Auto Mode to Manual
Mode). If the device is configured to ignore requests after a failure, it displays the status
“LOCKOUT” when a failed operation (or response failure) occurs.

Control Modes

A device is put into one of three modes by the operator by pressing the appropriate control key
(located on the Control Panel or Ovation Keyboard) or specified function key (located on a
standard keyboard). Note that the device must be configured to operate in that mode. Therefore,
the DEVICEX has three modes of operation that can be adjusted during monitoring. These modes
are as follows:
 AUTO
 MANUAL
 LOCAL

OW360_R1100 177
5.33 DEVICEX

Auto Mode

Auto Mode allows the Controller application program to control the device through user-
programmed logic. The device cannot go into Auto mode unless it is configured to operate in that
mode.

Once it is configured for Auto mode, the device can enter Auto mode if one of the following
occurs:
 The operator presses the Auto mode control key.
 The status of the device is a return from Tag Out and its default mode is Auto.
 The Reject to Auto (ARE) input becomes true and both Manual (MRE) and Local (LRE)
rejects are false.
 The default mode of the device is Auto, and the DEVICEX algorithm is in its first pass.
 Upon a failed operation if the device is configured.
The device exits Auto mode whenever one of the following happens:
 The operator presses the Manual Mode control key.
 The operator presses the Local Mode control key.
 The operator Tags Out the device.
 The Reject to Local (LRE) input goes true.
 The Reject to Manual (MRE) input goes true.
 A Failed Operation occurs and the device is configured to go to Manual mode when the
operation fails.
The device may be configured (bit 6 of the C4 field) to go to Manual mode when a change of state
command is entered. If this is the case, pressing the following control keys causes the device to
go to Manual mode:
 Start/Open
 Stop/Close
 Stop Travel (discontinue operation in progress)
When in Auto Mode, the DEVICEX algorithm accepts commands from the digital process points
that are linked to the device through the DEVICEX algorithm. Possible commands are:
 Stop/Close
 Start/Open
 Stop Travel (discontinue operation in progress)
 Emergency OPEN/START Override
 Emergency CLOSE/STOP Override
The device does not process any Manual or Local commands while in Auto mode.

178 OW360_R1100
 5.33 DEVICEX

Manual Mode

Manual Mode allows the operator to control the device with the control keys. The device cannot
go into Manual Mode unless it is configured for that mode. Once the device is configured, it can
enter Manual Mode when one of the following occurs:
 The operator requests Manual mode by pressing the Manual Mode request key.
 The status of the device is a return from Tag Out and its default mode is Manual.
 The Reject to Manual (MRE) input goes true.
 Upon startup of the Controller, the default mode of the device is Manual.
 There is an occurrence of an Emergency Override and the default mode of the device is
Manual.
 Upon a failed operation, if the device is configured.
The device may be configured to go to Manual mode when a change of state command is
entered. If this is the case, pressing the following control keys causes the device to go to Manual
mode:
 Start/Open
 Stop/Close
 Stop Travel (discontinue operation in progress)
The device exits Manual Mode whenever one of the following happens:
 The operator requests Local mode with a control key.
 The operator requests Auto mode with a control key.
 The Reject to Local (LRE) or Reject to Auto (ARE) input becomes true and Manual Reject
(MRE) is false.
 The operator requests the device to be Tagged-Out with the appropriate control key.
When in Manual Mode, the DEVICEX algorithm accepts commands from the following possible
commands:
 Start/Open
 Stop/Close
 Stop
When in Manual Mode, the DEVICEX algorithm allows the Emergency Override to the device only
if the device is configured (see bit 0 in C4 field) such that the overrides have precedence over the
operator's commands.

In addition, when in Manual Mode, the DEVICEX algorithm does not process any Auto and Local
commands to Close, Open, or Stop the devices.

OW360_R1100 179
5.33 DEVICEX

Local Mode

Local Mode is the lowest level mode of operation for the device. A device can enter this mode
only if the following two conditions are met:
 The Reject to Local (LRE) input goes true.
 The operator requests Local mode with a control key.
The device exits Local mode whenever one of the following happens:
 The operator Tags Out the device.
 The Reject to Manual (MRE) input goes true.
 A Failed Operation occurs and the device is configured to go to Manual mode when operation
fails.
When in Local Mode, the DEVICEX algorithm accepts commands. Commands are digital process
points that are linked to the device through the DEVICEX algorithm. Possible commands are:
 Stop/Close
 Start/Open
 Stop Travel (discontinue operation in progress)
 Emergency OPEN/START Override
 Emergency CLOSE/STOP Override
As long as the device is in the Local mode, the DEVICEX algorithm does not execute any
commands from the Auto and Manual modes. However, the Emergency Overrides is honored
when the device is in Local mode.

Mode Independent Commands

There are several commands that are requested with keys and are executed if the device is in
Auto, Manual or Local mode. These commands are:
 Tag Out the Device
 Acknowledge Trip
 Auto mode request
 Manual mode request
 Local mode request
These commands are not accepted, however, if the device is tagged-out.

Tag Out

When in Tag Out Mode, the device ignores all commands except “Remove Tag Out”. The device
goes to its default mode when the Tag Out is removed.

Lock Out

A subset of the Tag Out mode is the device “LOCK OUT” mode. Lock out occurs if the device is
configured (see bit 4 C4 field) to ignore subsequent commands to change state after an operation
fails. In other words, the device has only one opportunity to change state in a particular mode. If
the operation fails, the DEVICEX algorithm does not accept another Open/Start or Close/Stop
command while locked out.

180 OW360_R1100
 5.33 DEVICEX

A device may be removed from a Lock Out condition by any of the following actions:
 Pressing the Auto, Manual or Local mode control keys.
 Tagging out the device.

Emergency Overrides

In addition to the change of state commands, in each of the operating modes there are two other
commands: Emergency Start/Open/Trip and Emergency Stop/Close/Reset.

These two commands are generated by external logic in the Controller and can act as emergency
overrides over all other commands, including Stop Travel.

Whenever either the Emergency Open, or Emergency Close input becomes true, the DEVICEX
algorithm forces the device to its default state and attempts to get the device to the commanded
state. (If the DEVICEX algorithm is not configured to ignore failures, the emergency command
executes only once.) If both emergency overrides are set at the same time, the device remains on
its present course of action.

As long as either Emergency input is set, the DEVICEX algorithm ignores all Auto and Local
commands to drive the device. The device may also be configured to have the Emergency inputs
override the Manual commands or the Manual commands to override the Emergency inputs.
Upon removal of the emergency override, the device returns to its default mode.

Note: Emergency overrides, like all other commands, are ignored when the device is tagged out
or in Local Mode.

Change of State

In general, when a change of state command is in progress, it is continued until the device
reaches the new state or until a time out occurs. The following conditions cause an operation in
progress to be discontinued:
 The device is Tagged Out, resulting in inputs being read and outputs not set to true. They are
left as they were at the time of Lock Out.
 A Stop (discontinue operation) command is requested by the current control mode and an
Emergency Override is not in progress. However, if the device is in Manual mode, and it is
configured such that the Emergency Overrides do not have priority over Manual commands, a
Manual Stop request overrides the Emergency command.
In order for a change of state command to be executed, its proper permissive bit must be true.
For example a Manual Close/Stop command is only executed if the Close/Stop permissive bit of
the device is true. The Emergency Override and Stop (discontinue operation) commands do not
require any permissives to be true in order to be executed.

The permissives of a device are set to true on start-up and remain true unless the DEVICEX
algorithm is used to update them.

The amount of time that a device allows for the equipment to change state following a command
can be set by the user. You must specify the units of time for transition (tenths of a second,
seconds, or minutes), and the maximum number of time units to get to the set and reset states.
You can also specify a time period (in loops) for the equipment to respond to a command.

OW360_R1100 181
5.33 DEVICEX

For devices with feedback, the amount of time that the DEVICEX algorithm sets the appropriate
output to “ON” can also be configured by the user. The following modes are supported:
 Set output “ON” for a user-configured time period (less than the transition time), or until the
new state is reached, whichever occurs first. (Indicate this mode by setting bit 1 of C4 field.)
 Set output “ON” for a user-configured time period (equal to the transition time) or until the new
state is reached, whichever occurs first. (Indicate this mode by setting bit 2 of the C4 field.)
 Maintain output “ON” continuously, until a new command is given. This mode also has a
time-out associated with it, but the pulsing continues after the time-out occurs. If the operation
should fail (device does not reach the commanded state) the operation is flagged as a failure,
and the pulsing discontinues until a new command is given. (Indicate this mode by setting bit
3 of the C4 field.)
For the case where the device has only one output (no feedbacks), the output is set to “ON” (or
“OFF”) continuously depending on whichever command is requested. There are no time-outs for
this case.

A device always writes to its output(s) when a new change of state command occurs regardless
of the state of its input(s). If the device command is from other application logic, care should be
taken to ensure that the command is maintained or pulsed as needed.

The device continuously checks for change of state commands when it is not in the process of
executing one. The device executes a change of state command when it is first set to “ON.” If the
command stays “ON,” the device treats it as a new command when it finishes executing the last
command. Since the device writes to its output(s) when a new command occurs, its output(s)
cycles continuously “ON” and “OFF” if the following are true:
 A change of state command is “ON” and it matches the state of the device's input(s).
 The device is configured to set its output(s) “ON” for a certain amount of time, then “OFF”.

Alarming

The DEVICE algorithm supports seven types of alarms. All of these alarms, except Trips, require
operator acknowledgment. The device conditions which can produce alarms are:
 Failed Operations
 Failures to Respond
 Trips
 Alarm State
 Sensor Failures
 Emergency Overrides
 Attention (Trouble)

Failed Operations

If the Failed Operations alarm is configured, the DEVICEX algorithm puts the device in alarm
whenever the equipment does not complete a change-of-state command (for example, if a valve
is commanded to open and it does not do so within the user-specified time). A Failed Operation
Alarm clears upon the next Open, Close, or Stop command to the device.

182 OW360_R1100
 5.33 DEVICEX

Failure to Respond

If the Failure to Respond alarm is configured, the DEVICEX algorithm puts the device into alarm if
the feedbacks do not reflect an “In Transition” state within a user-specified number of loops. The
“In Transition” state must be that both feedbacks have a value of 0.

Trips

If Trip alarms are configured, the DEVICEX algorithm puts the device into alarm whenever the
equipment unexpectedly changes state (for example, when a breaker trips open). A Trip Alarm
clears when you acknowledge the Trip by commanding the device to the Tripped state. Trips can
be acknowledge through the operator graphic or by control logic through the ACKT pin if the
EACK option is ON. Trip Alarm returns do not require acknowledgment by the user via the Alarm
window since they are cleared by commanding the device.

Alarm State

The device can be configured to go into alarm based on a user-defined state. The alarm clears
only when the device returns to the non-alarmed state. These alarms must be acknowledged by
the user.

Sensor Failures

Either one or both of the following conditions cause a Sensor Failure alarm:
 The device feedbacks are indeterminate (that is, both show a 00 or 11 status) and the device
is not in transition. This is an input sensor alarm.
 The outputs do not reflect the value written to them (output sensor alarm).

Emergency Override

The Emergency Override alarm is generated any time an override occurs and the device is not at
the override state. For example, the occurrence of an Emergency Open generates an alarm if the
device is Closed. If both override inputs happen to become true at the same time, an alarm is
generated regardless of the state of the device.

Attention (Trouble)

The Attention (Trouble) alarm is caused by the following conditions:

 The device is in Auto mode and an Auto Open/Start command is present while the device
Open/Start permissive is OFF or and Emergency Close/Stop override is ON.
 The device is in Auto mode and an Auto Close/Stop command is present while the device
Close/Stop permissive if OFF or and Emergency Open/Start override is ON.
 The device is not in Auto mode and an Auto Open/Start command is present while the device
is not Open or Running.
 The device is not in Auto mode and an Auto Close/Stop command is present while the device
is not Closed or OFF.
If the device is configured to go into alarm based on a combination of conditions, the point is put
into alarm when either one or more of the alarm conditions exist.

OW360_R1100 183
5.33 DEVICEX

The following alarming options are available:

 No Alarming
 Failed Operations, Sensor Failures, Trips, Response Failures, Attention conditions, and
Emergency Overrides
 Failed Operations, Sensor Failures, Trips, Response Failures, Attention conditions,
Emergency Overrides, and Alarm State

Clearing Alarms

Upon Tagging Out, Scan Removing, or putting a device into Local mode, the following alarms are
cleared:
 Failed Operation
 Failure to Respond
 Sensor Failures
 Trips
 Attention
A State Alarm, however is not cleared by any of the conditions mentioned above. It must be
cleared by commanding the device.

Tagging out or going to Local mode clears any Emergency Override present.

Device Status Reporting

The device record maintains information corresponding to the current status of a device.
Depending on the state of a device, its displayed status includes a combination of the following
conditions:
 Current State
 In Transition
 Operation Failed
 Tripped
 Stopped
 Emergency Close
 Emergency Open
 Current Mode
 Override Failure
 Scan Removed
 Alarm Checking Off
 Tagged Out
 Locked Out
 Quality
 Permissives
 Rejects
The status information mentioned above comes from various flags (bits) in certain fields in the
packed point and algorithm record.

184 OW360_R1100
 5.33 DEVICEX

The A2 field of the Packed point (DVCE) has the following information: The bits in the A2 field are
defined in the following table:

A2 Field Bit Information

BIT DESCRIPTION

Bit 0 Current State. This bit indicates the current state of the feedback signals. In case feedback
signals give conflicting data, the last known state is reported. When scanned removed the
last command state is reported.

Bit 1 In Transition. This bit indicates the device algorithm is currently in the process of trying to
change the state of its equipment. The bit is set true when the device starts to execute a
command. It is reset when the feedback signals indicate the operation is complete or the
operation has failed.
Bit 2 Operation Failed. This bit is set following any unsuccessful attempt to change the state of
the equipment. It remains set until the next attempt is made to change the state of the
equipment. Failed operation are not indicated if the device is scanned off.

Bit 3 Tripped. This bit is set any time the equipment changes stage on its own, not by the
algorithm. It remains set until the Trip Acknowledge command. If it is not acknowledged, no
other change of state operations, in any mode are processed. The tripped bit is not set
when the device is Tagged Out or Scanned Removed.

Bit 4 Stopped. This bit is set whenever the device is commanded to stopped. The bit remains
set until the next attempt is made by the device to change the state of the equipment.
Bit 5 Emergency Close. This bit reflects the status of the override inputs to the device.
Bit 6 Emergency Open. This bit reflects the status of the override inputs to the device.
Bit 7 Last Commanded State. This bit reflects the last known state of the device.

Bit 8 Local Mode. This bit indicates that the device is in local mode.

Bit 9 Manual Mode. This bit indicates that the device is in manual mode.

Bit 10 Auto Mode. This bit indicates that the device is in auto mode.

Bit 11 Reserved.

Bit 12 Attention. This bit indicates certain error conditions are present.

Bit 13 Failed to Respond. This bit indicates that the device did not respond to a command.
Bit 14 Locked Out. This bit indicates that the state of the device is locked out.

Bit 15 Tagged Out. This bit indicates that the state of the device is tagged out.

OW360_R1100 185
5.33 DEVICEX

The C5 field in the DEVICEX algorithm holds the command word. This command word is the
interface between a Controller and the algorithm. The bits in the C5 field are defined in the
following table:

C5 Field Bit Information

BIT DESCRIPTION

Bit 0 Emergency Close/Stop

Bit 1 Emergency Open/Start

Bit 6 Current State of Input 1 (Open/Start)

Bit 7 Current State of Input 2 (Close/Stop)

Bit 8 Current State of Input 3 (Stop)

Bit 9 Value currently being written to Output 1 (Open/Start)

Bit 10 Value currently being written to Output 2 (Close/Stop)

Bit 11 Value currently being written to Output 3 (Stop)

Bit 12 Close/Stop permissive

Bit 13 Open/Start permissive

Setting Device Parameters

Alarming

The following fields in the Packed point (DVCE) must be set for alarming:

Alarming Parameters

TYPE OF ALARMING FIELDS TO BE SET

No Alarming Set E0 and E1 to zero.

Operate, Sensor, Trips, Overrides and Attention Set E0 and E1 to 0x386c

Operate, Sensor, Trips, Overrides and Attention, Set E0 and E1 to 0x386d

State Set(1)

Operate, Sensor, Trips, Overrides and Attention, Set E0 to 0x386d and E1 to 0x386c
State Set(0)

186 OW360_R1100
 5.33 DEVICEX

Pulse and Transition Timing

The amount of time a device allows for the equipment to change state following a command is
user-configurable. You must specify the units of the time (tenths of a second, seconds, or
minutes) to measure the transition time in, and the maximum number of time units to get to the
set and reset states. You may also specify a time period (in loops) for the equipment to respond
to a command.
 Time Units field (D0 field in the algorithm record) - holds the user-entered time units for
the set and reset time-outs. Valid values are 0 for tenth of seconds, 1 for seconds, and 2 for
minutes.
 Set Time-out field (D2 field in the algorithm record) - holds the user-entered value. The
maximum number for tenth of a second and second is 255. The maximum number for
minutes is 100.
 Reset Time-out field (YT field in the algorithm record) - holds the user-entered value. The
maximum number for tenth of a second and second is 255. The maximum number for
minutes is 100.
 Time to Respond field (YP field in the algorithm record) - applies only to devices with two
feedbacks. If this value is non-zero, the device feedbacks must respond to a command within
the response time or the operation is discontinued and a 'Failure to Respond' alarm is
generated.
The C4 field in the algorithm record defines the mode configuration. The bits in the C4 field are
defined in the following table:

C4 Field Bit Information

BIT MODE DESCRIPTION

Bit 0 Off The emergency Open/Start and Close/Stop commands

override Auto and Local Mode commands.
On The Emergency Open/Start and Close/Stop commands
override all other commands.

Bit 1 On Set output 'ON' for a configured time period (less than
the time-out). If this bit is set, the algorithm maintains
the appropriate output for the number of loops in the
Pulse Time or until the operation is successful,
whichever occurs first.

Bit 2 On Set output 'ON' until a user-configured time-out (or the

operation is successful). The transition times for setting
and resetting the device are entered in the Set Time-out
and Reset Time-out fields.

Bit 3 On Set output 'On' continuously until a new command is

entered.

Bit 4 On Set Override Failure bit in the A2 field of the DVCE

point.
Bit 5 On Do not execute the STOP command

Bit 6 Off Manual Open/Close/Stop commands force the device to

Manual mode.

OW360_R1100 187
5.33 DEVICEX

BIT MODE DESCRIPTION

On Manual Open/Close/Stop commands are processed

only it the device is in Manual mode.

Bit 7 Off Device default mode is Manual.

On Device default mode is Auto

Note: If bits 1, 2, and 3 are all zero, then the information in bits 3, 4, and 5 in the Custom
Configuration word is used to maintain/pulse the outputs.

The custom configuration (C7 field in the algorithm record) bits are defined below. You may also
define the mode(s) a device may operate in, the position the device may be tagged out in, and so
forth as defined in the following table:

C7 Field Bit Information

BIT MODE DESCRIPTION

Bit 0 On The device is allowed to operate in Auto mode.

Bit 1 On The device is allowed to operate in Local mode.

Bit 2 On The device is allowed to operate in Manual mode.

Bit 3 On The Open (Start) output is maintained continuously.

Off The Open (Start) output is pulsed once on an Open/Start

command.

Bit 4 On The Close (Stop) output is maintained continuously.

Off The Close (Stop) output is pulsed once on a Close/Stop.

Bit 5 On Only applicable to Open/Close/Stop type devices. The

Stop output is maintained continuously.

Off The Stop output is pulsed once on a Stop command.

Bit 6 On The Auto Stop is maintained input (always on until the

algorithm turns it off).
Off The Auto Stop is pulsed input.

Bit 7 On The Auto Start is maintained input (always on until the

algorithm turns it off).
Off The Auto Start is pulsed input.

Bit 8 On The Local Stop is maintained input (always on until the

algorithm turns it off).
Off The Local Stop is pulsed input.

Bit 9 On The Local Start is maintained input (always on until the

algorithm turns it off).
Off The Local Start is pulsed input.

Bit 10 On The Close/Stop permissive is internally generated.

188 OW360_R1100
 5.33 DEVICEX

BIT MODE DESCRIPTION

Bit 11 On The Open/Start permissive is internally generated.

Bit 12 On The Travel (Transition) Timer Enabled is internally

generated.

Bit 13 On The equipment may be Tagged-out in the open position.

Bit 14 On If Bit 14 is set, equipment may be Tagged-out in the closed

position.
For Start/Stop devices only, equipment may be tagged out
in the Off/Stop position.
Bit 15 On The device is forced to Manual mode when a failed
operation occurs.

Functional symbol

OW360_R1100 189
5.33 DEVICEX

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU - Byte Data Required 47 Tuning Diagram -

Init. Number.
SET D2 - Integer Data Required 20 Set time-out (Max of -
Init. 255 if units are 1/10
seconds or seconds.
Max. of 100 if units
are minutes.)
RSET YT - Integer Data Required 20 Reset time-out (Max -
Init. of 255 if units are
1/10 seconds or
seconds. Max. of
100 if units are
minutes.)
EM C4 - Integer Data Required 9 Emergency override -
Init. commands

PT D4 - Integer Data Required 0 Pulse Time -

Init.

TR YP - Integer Data Required 0 Number of Loops to -

Init. Respond

CZ C7 - Integer Data Required 0 Configuration -

Init.

TU D0 - Integer Data Required 1 Units time-out -

Init.
Value Time Units
0 - Tenths of
Seconds
1 - Seconds
2 - Minutes
TYPE C8 - Integer Data Required Open Device Type: -
Init. Open/close or
Start/Stop
DTIM D5 - Integer Data Required 0 Delay Time in -
Init. Seconds

IN1 - Variable Optional - Device Input 1 - LD, LP

Feedback
IN2 - Variable Optional - Device Input 2 - LD, LP
Feedback
IN3 - Variable Optional - Device Input 3 - LD, LP
Feedback
CPRM - Variable Optional - Close Permissive LD, LP

OPRM - Variable Optional - Open Permissive LD, LP

190 OW360_R1100
 5.33 DEVICEX

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

ARE - Variable Optional - Auto Reject LD, LP

LRE - Variable Optional - Local Reject LD, LP

MRE - Variable Optional - Manual Reject LD, LP

LOPL - Variable Optional - Local Open Logic LD, LP

LCLL - Variable Optional - Local Close Logic LD, LP

LSTL - Variable Optional - Local Stop Logic LD, LP

AOPL - Variable Optional - Auto Open Logic LD, LP

ACLL - Variable Optional - Auto Close Logic LD, LP

ASTL - Variable Optional - Auto Stop Logic LD, LP

TMEN - Variable Optional - Transition Timer LD, LP

Enable
EMCL - Variable Optional - Emergency LD, LP
Close/Stop
EMOP - Variable Optional - Emergency LD, LP
Open/Start
DVCE - Variable Required - Device record LP

OUT1 - Variable Optional - Output 1 LD, LP

OUT2 - Variable Optional - Output 2 LD, LP

OUT3 - Variable Optional - Output 3 LD, LP

OUT4 - Variable Optional - Output 4 LD, LP

LOC - Variable Optional - Local Mode LD, LP

MAN - Variable Optional - Manual Mode LD, LP

AUTO - Variable Optional - Auto Mode LD, LP

OPFL - Variable Optional - Failure-to-Respond LD, LP

TRIP - Variable Optional - Report Trip LD, LP

STAT - Variable Optional - State of the device LD, LP

DEST - Variable Optional - Delay Output LD, LP

EACK X2 Data Required OFF Enable acknowledge -

Init. trip pin
ACKT - Variable Optional - Acknowledge trip LD, LP

OW360_R1100 191
5.34 DFIELD

5.34 DFIELD

Description

The DFIELD algorithm is used only with the hardware digital output variable points. It should be
used instead of “output digital hardware” I/O connectors in applications involving interfaces to
control elements (for example, valves and dampers).

The output digital point (FAIL) is TRUE when the algorithm detects a hardware error on the I/O
card.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU Data Init. Required 0 Tuning Diagram -

Number
IN1 - Variable Required - Input (digital) LL

HWPT1 - Variable Required - Hardware Output LL

(digital)
FAIL - Variable Optional - Hardware Error LL
Point (digital)
1 You cannot scan remove the HWPT point.

192 OW360_R1100
 5.35 DIGCOUNT

5.35 DIGCOUNT

Description

The DIGCOUNT algorithm sets the output digital FLAG TRUE if M inputs or more of the N digital
inputs are TRUE (where N < 12, and M and N are constants). The output analog record is set
equal to the number of TRUE digital inputs.

The DIGCOUNT algorithm has an option for enabling or disabling quality propagation with the
following requirements:
 The added parameter is an enumerated Data Init. type named PROQ, and it has the options
0 – OFF and 1 – ON. This input is in the OFF state by default.
 If the PROQ parameter transitions from ON to OFF, all the output qualities are set to GOOD.
The following rule applies to propagating quality in the DIGCOUNT algorithm:
 The output quality is the worst quality of the best quality inputs, if the output is true. This is
necessary to fulfill the coincidence.
 The output quality is the worst false input quality if the output is false.

Functional symbol

OW360_R1100 193
5.35 DIGCOUNT

DIGICOUNT algorithm definitions

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 85 Tuning Diagram -

number
NMIN G4-Integer Data Init. Required 0 Total digital -
inputs (N)
* MTRU X1-Byte Selectable Required 0 Maximum TRUE LA
digital inputs (M)

IN1 - Variable Required - Input (digital) LD, LP

IN2 - Variable Optional - Input (digital) LD, LP

•
•
IN12

OUT - Variable Required - Output (analog) LA

FOUT - Variable Required - Output (digital LD, LP

flag)
PROQ X2-Byte Data Init. Required OFF Quality -
Bit 0 Propagation
Option:
ON
 The output
quality is the
worst quality
of the best
quality inputs
necessary to
fulfill the
coincidence if
the output is
true.
 The output
quality is the
worst false
input quality if
the output is
false.
OFF
 Output quality
is GOOD.
* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

194 OW360_R1100
 5.36 DIGDRUM

5.36 DIGDRUM
Description

The DIGDRUM algorithm is a software drum controller with up to 32 digital output values and up
to 50 steps. The outputs selected to be TRUE are based on the current step number and a list of
up to 50 initialized integer values. These integers contain 32 bits of data, which are then mapped
onto the 32 digital outputs. Thus, for each step, you can initialize any combination of TRUE and
FALSE states for any or all of the 32 outputs by converting a string of up to 32 bits into a
hexadecimal number.

Functional symbol

The following 50 integers should be input as hexadecimal numbers (for example, 0x1234). See
the Binary to Hexadecimal Conversion Table (see page 6) for information on how to create a
hexadecimal number from 16 bits.
G0 B0 C0 D0 YM
G1 B1 C1 YQ YL
G2 B2 C2 D2 E2
G3 YU C3 YP E3
G4 B4 C4 D4 E4
G5 B5 C5 D5 YC
G6 B6 C6 D6 Y9
G7 B7 C7 YN E7
G8 B8 C8 D8 E8
G9 B9 YT D9 Y8

OW360_R1100 195
5.36 DIGDRUM

The current step number may be tracked to a selected step (TRIN) when in tracking mode
(TMOD = TRUE), increased (INC), or decreased (DEC). The current step number is only
increased or decreased on a FALSE to TRUE transition of INC and DEC. The maximum number
of steps must be initialized. When the current step number becomes greater than the number of
steps, the current step number is reset to one. If TRIN is a non-integer value, the algorithm
rounds the value to the nearest integer. Any value for TRIN not in the range of one to NMIN is
converted to a one by the algorithm.

The track input value (TRIN) and output value (OUT) are checked for invalid real numbers. If a
tracking request is received and TRIN is an invalid number, then the tracking request is ignored.
However, the current step can be increased (using INC) or decreased (using DEC) even when
TRIN is an invalid number.

If the algorithm calculates an invalid real number output, the value is invalid and the quality is set
to BAD.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 102 Tuning Diagram -

Number
INC - Variable Required 0 Input (digital LD, LP
signal to
increase the
step number)
DEC - Variable Required 0 Input (digital LD, LP
signal to
decrease the
step number)
TMOD - Variable Required 0 Input (digital LD, LP
signal); tracking
request
TRIN - Variable Required 0 Input (analog); LA
tracks the step
number to this
value
NMIN X1-Byte Tuning Required 0 Maximum -
Constant number of steps

196 OW360_R1100
 5.36 DIGDRUM

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TYPE X2-Byte Data Init Optional Long Steps are Long -

or Short.
Long = Step 1
to Step 50
defines up to 32
outputs.
Short = Double
number of steps
to 100 since
parameter “I/01”
contains Step 1
value in the
lower 16 bits,
and Step 2
value in the
higher 16 bits.
Therefore, only
up to 16 outputs
are used.
I01 G0-Integer Tuning Optional 0 Output values -
Constant for Step 1

I02 G1-Integer Tuning Optional 0 Output values -

Constant for Step 2

I03 G2-Integer Tuning Optional 0 Output values -

Constant for Step 3

I04 G3-Integer Tuning Optional 0 Output values -

Constant for Step 4

I05 G4-Integer Tuning Optional 0 Output values -

Constant for Step 5

I06 G5-Integer Tuning Optional 0 Output values -

Constant for Step 6

I07 G6-Integer Tuning Optional 0 Output values -

Constant for Step 7

I08 G7-Integer Tuning Optional 0 Output values -

Constant for Step 8

I09 G8-Integer Tuning Optional 0 Output values -

Constant for Step 9

I10 G9-Integer Tuning Optional 0 Output values -

Constant for Step 10

I11 B0-Integer Tuning Optional 0 Output values -

Constant for Step 11

I12 B1-Integer Tuning Optional 0 Output values -

Constant for Step 12

I13 B2-Integer Tuning Optional 0 Output values -

Constant for Step 13

OW360_R1100 197
5.36 DIGDRUM

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

I14 YU-Integer Tuning Optional 0 Output values -

Constant for Step 14

I15 B4-Integer Tuning Optional 0 Output values -

Constant for Step 15

I16 B5-Integer Tuning Optional 0 Output values -

Constant for Step 16

I17 B6-Integer Tuning Optional 0 Output values -

Constant for Step 17

I18 B7-Integer Tuning Optional 0 Output values -

Constant for Step 18

I19 B8-Integer Tuning Optional 0 Output values -

Constant for Step 19

I20 B9-Integer Tuning Optional 0 Output values -

Constant for Step 20

I21 C0-Integer Tuning Optional 0 Output values -

Constant for Step 21

I22 C1-Integer Tuning Optional 0 Output values -

Constant for Step 22

I23 C2-Integer Tuning Optional 0 Output values -

Constant for Step 23

I24 C3-Integer Tuning Optional 0 Output values -

Constant for Step 24

I25 C4-Integer Tuning Optional 0 Output values -

Constant for Step 25

I26 C5-Integer Tuning Optional 0 Output values -

Constant for Step 26

I27 C6-Integer Tuning Optional 0 Output values -

Constant for Step 27

I28 C7-Integer Tuning Optional 0 Output values -

Constant for Step 28

I29 C8-Integer Tuning Optional 0 Output values -

Constant for Step 29

I30 YT-Integer Tuning Optional 0 Output values -

Constant for Step 30

I31 D0-Integer Tuning Optional 0 Output values -

Constant for Step 31

I32 YQ-Integer Tuning Optional 0 Output values -

Constant for Step 32

I33 D2-Integer Tuning Optional 0 Output values -

Constant for Step 33

198 OW360_R1100
 5.36 DIGDRUM

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

I34 YP-Integer Tuning Optional 0 Output values -

Constant for Step 34

I35 D4-Integer Tuning Optional 0 Output values -

Constant for Step 35

I36 D5-Integer Tuning Optional 0 Output values -

Constant for Step 36

I37 D6-Integer Tuning Optional 0 Output values -

Constant for Step 37

I38 YN-Integer Tuning Optional 0 Output values -

Constant for Step 38

I39 D8-Integer Tuning Optional 0 Output values -

Constant for Step 39

I40 D9-Integer Tuning Optional 0 Output values -

Constant for Step 40

I41 YM-Integer Tuning Optional 0 Output values -

Constant for Step 41

I42 YL-Integer Tuning Optional 0 Output values -

Constant for Step 42

I43 E2-Integer Tuning Optional 0 Output values -

Constant for Step 43

I44 E3-Integer Tuning Optional 0 Output values -

Constant for Step 44

I45 E4-Integer Tuning Optional 0 Output values -

Constant for Step 45

I46 YC-Integer Tuning Optional 0 Output values -

Constant for Step 46

I47 Y9-Integer Tuning Optional 0 Output values -

Constant for Step 47

I48 E7-Integer Tuning Optional 0 Output values -

Constant for Step 48

I49 E8-Integer Tuning Optional 0 Output values -

Constant for Step 49

I50 Y8-Integer Tuning Optional 0 Output values -

Constant for Step 50

STEP - Variable Required - Output (analog); LA

current step
number

OW360_R1100 199
5.36 DIGDRUM

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

O01 - Variable Optional - Output (digital LD, LP

signal);
least-significant
bit; set or reset
according to the
bits in the
integer selected
by the current
step number
O02 - Variable Optional - Output (digital LD, LP
signal); set or
. reset according
. to the bits in the
integer selected
. by the current
O31 step number

O32 - Variable Optional - Output (digital LD, LP

signal); most
significant bit set
or reset
according to the
bits in the
integer selected
by the current
step number

200 OW360_R1100
 5.37 DIGITAL DEVICE

5.37 DIGITAL DEVICE

Description

The Digital Device algorithm provides logic to control the following seven types of devices:
 SAMPLER (Controlled Sampler) (see page 202).
 VALVE NC (Non-Controlled Valve) (see page 203).
 MOTOR NC (Non-Controlled Motor) (see page 204).
 MOTOR (Simple Controlled Motor) (see page 206).
 MOTOR 2-SPD (Two-Speed or Bi-directional Controlled Motor) (see page 209).
 MOTOR 4-SPD (Two-Speed and Bi-directional Controlled Motor) (see page 212).
 VALVE (Controlled Valve) (see page 217).
The Digital Device algorithm provides a digital alarm bit to be set for applicable devices. The
algorithm provides time delays for each device as needed, which keeps the device from failing
while the device is processing a command. The time delay for each device can be independently
tuned in the Control Builder. A run counter is maintained for the motor and the sampler devices
and can be reset by the Operator Keyboard. The algorithm keeps the count in local memory as
either hours, minutes, or seconds, and then saves it as an analog output.

Where applicable, there are three modes: AUTO, MANUAL, and OFF. When the device is in OFF
mode, the algorithm only tracks the inputs and does not respond to any control logic or operator
commands. When in AUTO mode, the device only responds to control logic, and in MANUAL
mode, the device only responds to the Program Keys on the Operator Keyboard (described in the
following table).

Interface Keys on the Operator Keyboard

PROGRAM KE Y DESCRIPTION

P1 Close/Stop
P2 Open/Start/Fast Forward Start/Forward Start/Fast Start
P3 Slow Forward Start/Reverse Start/Slow Start
P4 Fast Reverse Start
P5 Slow Reverse Start
P6 Reset Total Run Time
P7 Reset Device Algorithm

In order for a device to respond to a command, the device must be available - not failed - and in
either MANUAL or AUTO mode. Where applicable, the algorithm can be reset either by a remote
reset device point, or by the Operator Keyboard. When the device is reset, the alarm output point
is always reset, along with the packed status alarm bits. When a device is in either the Failed or
the Unavailable condition, the device remains in the OFF mode until the problem is resolved and
the device is reset. The device is always put in the MANUAL mode when the reset is set and the
device is READY. The algorithm responds for both the Remote Reset and the Operator Reset in
any mode.

OW360_R1100 201
5.37 DIGITAL DEVICE

5.37.1 SAMPLER (Controlled Sampler)

Description

The Controlled Sampler device has the option of having the Operator Keyboard on or off. The
priority is set in the Control Builder and can only be changed in the Control Builder. The list of
inputs and outputs are found in the Algorithm Definitions table.

If the Operator Keyboard is off, the keyboard keys are disabled, and the output (OUT1) of the
device follows the input (IN1). When the Operator Keyboard is on, the output follows the input
until the output is changed manually by the operator with either the STOP or START keys. The
output follows the input again once there is a change in the input.

The runtime counts when the output is set. The total runtime will not update when Sample Reset
Priority (SPRI) is set to "Operator Keyboard OFF." The operator has the ability to reset the
runtime when either priority is set. There are no modes, time delays, or alarms associated with
the Controlled Sampler. The runtime can be tuned by changing the RUNT parameter in the
Control Builder.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 30 Tuning Diagram -

Number
SPRI X2-Byte Data Init. Required Keyboard Sampler Reset -
Priority
Keyboard = Operator
Keyboard ON
Input = Operator
Keyboard OFF
BASE C6-Integer Tuning Optional Hours Time base for total -
Constant run
Hours
Minutes
Seconds
RUNT R1 - Real Data Init Required 0 Tune the total runtime -
value.

IN1 - Variable Optional - Remote Run (digital) LD

202 OW360_R1100
 5.37 DIGITAL DEVICE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

OUT1 - Variable Required - Running Output LD

(digital)
RUN - Variable Optional - Total Run Time LA
(analog)

Note: The RUN output (total run time) of the algorithm will not update if SPRI (sampler reset
priority) is selected as "Input" (that is, Operator Keyboard is OFF) in the Control Builder, even
though the device is running.

5.37.2 VALVE NC (Non-Controlled Valve)

Description

The Non-Controlled Valve does not accept control information from either the control logic or the
operator (see the Algorithm Definitions table for a list of inputs and outputs). The algorithm
activates the digital alarm bit when in the failed state (see the Truth table for states of the valve).
There are no modes, time delay, or run time associated with this device.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 30 Tuning Diagram -

Number
IN1 - Variable Required - Open Contact LD
(digital)
IN2 - Variable Required - Close Contact LD
(digital)
IN3 - Variable Optional - Remote Reset LD
(digital)
ALRM - Variable Optional - Device Alarm LD
(digital)

OW360_R1100 203
5.37 DIGITAL DEVICE

Truth table

OPEN STATUS CLOSED STATUS VALVE STATE

Set Set Moving

Set Reset Open

Reset Set Closed

Reset Reset Failed

5.37.3 MOTOR NC (Non-Controlled Motor)

Description

The Non-Controlled Motor does not accept control information from either the control logic or the
operator (refer to the Algorithm Definitions table for the list of inputs and outputs). The digital
alarm bit is set when the motor is either in the failed state or Unavailable state (refer to the Truth
table for the states of the motor). The Non-Controlled Motor has an analog run time output that
may be reset by the operator. The runtime value can be tuned in the Control Builder. There are no
modes or time delays associated with this device.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 30 Tuning Diagram -

Number
BASE C6-Integer Tuning Optional 0 Time base for -
Constant total run.
0 = Hours
1 = Minutes
2 = Seconds
RUNT R1 - Real Data Init Required 0 Tune the -
runtime value.

IN1 - Variable Required - Ready Contact LD

(digital)
IN2 - Variable Required - Running LD
Contact (digital)
IN3 - Variable Optional - Remote Device LD
Reset (digital)

204 OW360_R1100
 5.37 DIGITAL DEVICE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

ALRM - Variable Optional - Device Alarm LD

(digital)
RUN - Variable Optional - Total Run Time LA
(analog)

Truth table

READY STATUS RUNNING STATUS MOTOR STATE

Set Set Running

Set Reset Ready

Reset Set Failed

Reset Reset Unavailable

OW360_R1100 205
5.37 DIGITAL DEVICE

5.37.4 MOTOR (Simple Controlled Motor)

Description

The Simple Controlled Motor runs at one speed and in one direction when in operation. This
motor has the option of accepting start or stop commands from either the control logic or the
operator.

When the device is in AUTO mode, the algorithm accepts control commands from the Remote
Start (IN3) and Remote Stop (IN4) inputs. When the device is in MANUAL mode, the algorithm
accepts the control commands Stop and Start from the Operator Keyboard. Whenever a
command is processed in either AUTO or MANUAL mode, the outputs (OUT1 and OUT2) are set
accordingly for the duration of the time delay previously set in the Control Builder.

The Stop Permissive (IN8) must be set to allow the motor to be stopped. The Stop Permissive is
automatically set when no input is connect to IN8. Refer to the Algorithm Definitions table for the
list of inputs and outputs.

The digital alarm bit is set when:

 The device is in the Failed state.
 The device is in the Unavailable state.
 The device changes running states without being commanded to do so.
 The device fails to start or stop.
When the device fails to start or stop, the alarm triggers, but the device stays in the current mode
and continues looking for the proper combination of Running and Ready. When this combination
is detected, the alarm is reset and the device continues operating in a normal condition. All other
alarms put the device in OFF mode. Refer to the Truth table for the states of the motor.

The Simple Controlled Motor also has a status packed point that displays which alarm has been
set, the last command, and which mode it is currently in. Refer to the Output Status Bits table for
the list of the status bits.

Functional symbol

206 OW360_R1100
 5.37 DIGITAL DEVICE

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 30 Tuning Diagram -

Number
DLY1 C0-Integer Tuning Required 0 Time for Ready after -
Constant Stop

DLY2 C1-Integer Tuning Required 1 Time for Stop -

Constant

DLY3 C2-Integer Tuning Required 1 Time for Start -

Constant

BASE C6-Integer Tuning Optional 0 Time base for total -

Constant run.
0 = Hours
1 = Minutes
2 = Seconds
IN1 - Variable Required - Ready Contact LD
(digital)
IN2 - Variable Required - Running Contact LD
(digital)
IN3 - Variable Optional - Remote Start (digital) LD

IN4 - Variable Optional - Remote Stop (digital) LD

IN5 - Variable Optional - Remote Auto (digital) LD

IN6 - Variable Optional - Remote Manual LD

(digital)
IN7 - Variable Optional - Remote Device Reset LD
(digital)

IN8 - Variable Optional - Stop Permissive LD

(digital)
OUT1 - Variable Required - Start Output (digital) LD

OUT2 - Variable Required - Stop Output (digital) LD

ALRM - Variable Optional - Device Alarm (digital) LD

STAT - Variable Optional - Alarm and Mode LP

Status (packed)

RUN - Variable Optional - Total Run Time LA

(analog)
RUNT R1-Real Data Init Required 0 Tune the total runtime -
value

OW360_R1100 207
5.37 DIGITAL DEVICE

Truth table

READY STATUS RUNNING STATUS MOTOR STATE

Set Set Running

Set Reset Ready
Reset Set Failed
Reset Reset Unavailable

Output status bits

BIT DESCRIPTION

0 Failed to Stop

1 Failed to Start

2 Not Applicable

3 Not Applicable

4 Not Applicable

5 Device Unavailable

6 Device Deviation

7 Device Failed

8 Last Command Stop

9 Last Command Start

10 Not Applicable

11 Not Applicable

12 Not Applicable

13 Device Off

14 Device in Manual

15 Device in Auto

208 OW360_R1100
 5.37 DIGITAL DEVICE

5.37.5 MOTOR 2-SPD (Two Speed or Bi-Directional Controlled Motor)

Description

The Two-Speed or Bi-Directional Controlled Motor has the option of either running fast or slow, or
running forward or backward when in operation. This motor has the option of accepting start or
stop commands from either the control logic or the operator.

When the device is in AUTO mode, the algorithm accepts control commands from the Remote
Fast/Forward Start (IN4), Remote Slow/Reverse Start (IN5), and Remote Stop (IN6) inputs. When
the device is in MANUAL mode, the algorithm accepts the control commands Stop, Fast/Forward
Start, and Slow/Reverse Start from the Operator Keyboard. Whenever a command is processed
in either AUTO or MANUAL mode, the outputs (OUT1, OUT2, and OUT3) are set accordingly for
the duration of the time delay previously set in the Control Builder.

The Stop Permissive (IN10) must be set to allow the motor to be stopped. The Stop Permissive is
automatically set when no input is connected to IN10. This motor may be commanded to change
direction or speed without first being stopped. Refer to the Algorithm Definitions table for the list of
inputs and outputs.

The digital alarm bit is set when one of the following occurs:
 The device is in the Failed state.
 The device is in the Unavailable state.
 The device changes running states without being commanded to do so.
 The device fails to start or stop.
When the device fails to start or stop, the alarm triggers, but the device stays in the current mode
and continues looking for the combination of Running and Ready. When this combination has
been detected, the alarm is reset and the device continues operating in a normal condition. All
other alarms put the device in OFF mode. See the Truth table for the states of the motor.

The Two Speed or Bi-Directional Controlled Motor also has a status packed point that displays
which alarm has been set, the last command, and which mode it is currently in. See Output Status
Bits for the list of status bits.

Functional symbol

OW360_R1100 209
5.37 DIGITAL DEVICE

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

DIAG LU-Integer Data Init. Required 30 Tuning Diagram -

Number
DLY1 C0-Integer Tuning Required 0 Time for Ready after -
Constant Stop

DLY2 C1-Integer Tuning Required 1 Time for Stop -

Constant
DLY3 C2-Integer Tuning Required 1 Time for Start -
Constant Fast/Forward
DLY4 C3-Integer Tuning Required 1 Time for Start -
Constant Slow/Reverse

BASE C6-Integer Tuning Optional 0 Time base for total run: -

Constant 0 = Hours
1 = Minutes
2 = Seconds
IN1 - Variable Required - Ready Contact (digital) LD

IN2 - Variable Required - Fast/Forward Running LD

Contact (digital)

IN3 - Variable Required - Slow/Reverse Running LD

Contact (digital)

IN4 - Variable Optional - Remote Fast/Forward LD

Start (digital)
IN5 - Variable Optional - Remote Slow/Reverse LD
Start (digital)

IN6 - Variable Optional - Remote Stop (digital) LD

IN7 - Variable Optional - Remote Auto (digital) LD

IN8 - Variable Optional - Remote Manual LD

(digital)
IN9 - Variable Optional - Remote Device Reset LD
(digital)

IN10 - Variable Optional - Stop Permissive LD

(digital)
OUT1 - Variable Required - Fast/Forward Start LD
Output (digital)

OUT2 - Variable Required - Slow/Reverse Start LD

Output (digital)

OUT3 - Variable Required - Stop Output (digital) LD

ALRM - Variable Optional - Device Alarm (digital) LD

210 OW360_R1100
 5.37 DIGITAL DEVICE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

STAT - Variable Optional - Alarm and Mode Status LP

(packed)
RUN Variable Optional Total Run Time LA
(analog)
RUNT R1 - Real Data Init Required 0 Tune the total runtime -
value.

Truth table

READY STATUS FAS T/FORWARD SLOW/REVERSE MOTOR STATE

RUNNING STATUS RUNNING STATUS

Set Set Set Not Applicable

Set Set Reset Running Fast or Forward

Set Reset Set Running Slow or Reverse
Set Reset Reset Ready

Reset Set Set Failed

Reset Set Reset Failed

Reset Reset Set Failed

Reset Reset Reset Unavailable

Output status bits

BIT DESCRIPTION

0 Failed to Stop

1 Failed to Start Fast/Forward

2 Failed to Start Slow/Reverse

3 Not Applicable

4 Not Applicable

5 Device Unavailable

6 Device Deviation

7 Device Failed

8 Last Command Stop

9 Last Command Start Fast/Forward

10 Last Command Start Slow/Reverse

11 Not Applicable

OW360_R1100 211
5.37 DIGITAL DEVICE

BIT DESCRIPTION

12 Not Applicable

13 Device Off

14 Device in Manual

15 Device in Auto

5.37.6 MOTOR 4-SPD (Two Speed and Bi-Directional Controlled Motor)

Description

The Two-Speed and Bi-Directional Controlled Motor has the option of accepting start or stop
commands from either the control logic or the operator. This motor has the option of running in
any one of the following four states:
 Fast and forward
 Fast and reverse
 Slow and forward
 Slow and reverse
When the device is in AUTO mode, the algorithm accepts control commands from the Remote
Fast Forward Start (IN6), Remote Slow Forward Start (IN7), Remote Fast Reverse Start (IN8),
Remote Slow Reverse Start (IN9), and Remote Stop (IN10) inputs.

When the device is in MANUAL mode, the algorithm accepts the control commands Stop, Fast
Forward Start, Slow Forward Start, Fast Reverse Start, and Slow Reverse Start from the Operator
Keyboard. Whenever a command is processed in either AUTO or MANUAL mode, the outputs
(OUT1, OUT2, OUT3, OUT4, and OUT5) are set accordingly for the duration of the time delay
previously set in the Control Builder.

The Stop Permissive (IN14) must be set to allow the motor to be stopped. The Stop Permissive is
automatically set when no input is connected to IN14. This motor may be commanded to change
direction or speed without first being stopped. See the Algorithm Definitions table for the list of
inputs and outputs.

The digital alarm bit is set when one of the following occurs:
 The device is in the Failed state.
 The device is in the Unavailable state.
 The device changes running states without being commanded to do so.
 The device fails to start or stop.
When the device fails to start or stop, the alarm triggers, but the device stays in the current mode
and continues looking for the proper combination of Running and Ready. When this combination
is found, the alarm is reset and the device continues operating in a normal condition. All other
alarms put the device in OFF mode. See the Truth table for the states of the motor.

The Two-Speed and Bi-Directional Controlled Motor also has a status packed point that displays
which alarm has been set, the last command, and which mode it is currently in. See the Output
Status Bits table for the list of status bits.

212 OW360_R1100
 5.37 DIGITAL DEVICE

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 30 Tuning Diagram -

Number
DLY1 C0-Integer Tuning Required 0 Time for Ready -
Constant after Stop

DLY2 C1-Integer Tuning Required 1 Time for Stop -

Constant

DLY3 C2-Integer Tuning Required 1 Time for Fast -

Constant Forward Start

DLY4 C3-Integer Tuning Required 1 Time for Slow -

Constant Forward Start

DLY5 C4-Integer Tuning Required 1 Time for Fast -

Constant Reverse Start

DLY6 C5-Integer Tuning Required 1 Time for Slow -

Constant Reverse Start

BASE C6-Integer Tuning Optional 0 Time base for total -

Constant run.
0 = Hours
1 = Minutes
2 = Seconds
RUNT R1 - Real Data Init Required 0 Tune the total -
runtime value.

OW360_R1100 213
5.37 DIGITAL DEVICE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Ready Contact LD

(digital)
IN2 - Variable Required - Fast Forward LD
Running Contact
(digital)
IN3 - Variable Required - Slow Forward LD
Running Contact
(digital)
IN4 - Variable Required - Fast Reverse LD
Running Contact
(digital)
IN5 - Variable Required - Slow Reverse LD
Running Contact
(digital)
IN6 - Variable Optional - Remote Fast LD
Forward Start
(digital)
IN7 - Variable Optional - Remote Slow LD
Forward Start
(digital)
IN8 - Variable Optional - Remote Fast LD
Reverse Start
(digital)
IN9 - Variable Optional - Remote Slow LD
Reverse (digital)

IN10 - Variable Optional - Remote Stop LD

(digital)
IN11 - Variable Optional - Remote Auto LD
(digital)
IN12 - Variable Optional - Remote Manual LD
(digital)
IN13 - Variable Optional - Remote Device LD
Reset (digital)

IN14 - Variable Optional - Stop Permissive LD

(digital)
OUT1 - Variable Required - Fast Forward Start LD
Output (digital)

OUT2 - Variable Required - Slow Forward Start LD

Output (digital)

OUT3 - Variable Required - Fast Reverse Start LD

Output (digital)

OUT4 - Variable Required - Slow Reverse Start LD

Output (digital)

OUT5 - Variable Required - Stop Output LD

(digital)

214 OW360_R1100
 5.37 DIGITAL DEVICE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

ALRM - Variable Optional - Device Alarm LD

(digital)
STAT - Variable Optional - Alarm and Mode LP
Status (packed)

RUN - Variable Optional - Total Run Time LA

(analog)

Truth table

READY FAS T SLOW F AS T SLOW MOTOR STATE

STATUS FORWARD FORWARD REVERSE REVERSE
RUNNING RUNNING RUNNING RUNNING
STATUS STATUS STATUS STATUS

Set Set Set Set Set Not Applicable

Set Set Set Set Reset Not Applicable

Set Set Set Reset Set Not Applicable

Set Set Set Reset Reset Not Applicable

Set Set Reset Set Set Not Applicable

Set Set Reset Set Reset Not Applicable

Set Set Reset Reset Set Not Applicable

Set Set Reset Reset Reset Running Fast

Forward

Set Reset Set Set Set Not Applicable

Set Reset Set Set Reset Not Applicable

Set Reset Set Reset Set Not Applicable

Set Reset Set Reset Reset Running Slow

Forward

Set Reset Reset Set Set Not Applicable

Set Reset Reset Set Reset Running Fast

Reverse

Set Reset Reset Reset Set Running Slow

Reverse

OW360_R1100 215
5.37 DIGITAL DEVICE

READY FAS T SLOW F AS T SLOW MOTOR STATE

STATUS FORWARD FORWARD REVERSE REVERSE
RUNNING RUNNING RUNNING RUNNING
STATUS STATUS STATUS STATUS

Set Reset Reset Reset Reset Ready

Reset Set Set/Reset Set/Reset Set/Reset Failed

Reset Set/Reset Set Set/Reset Set/Reset Failed

Reset Set/Reset Set/Reset Set Set/Reset Failed

Reset Set/Reset Set/Reset Set/Reset Set Failed

Reset Reset Reset Reset Reset Unavailable

Output status bits

BIT DESCRIPTION

0 Failed to Stop

1 Failed to Start Fast Forward

2 Failed to Start Slow Forward

3 Failed to Start Fast Reverse

4 Failed to Start Slow Reverse

5 Device Unavailable

6 Device Deviation

7 Device Failed

8 Last Command Stop

9 Last Command Start Fast Forward

10 Last Command Start Slow Forward

11 Last Command Start Fast Reverse

12 Last Command Start Slow Reverse

13 Device Off

14 Device in Manual

15 Device in Auto

216 OW360_R1100
 5.37 DIGITAL DEVICE

5.37.7 VALVE (Controlled Valve)

Description

The Controlled Valve has the option of accepting commands from either the control logic or the
operator.

When the device is in AUTO mode, the algorithm accepts control commands from the Remote
Open (IN3) and Remote Close (IN4) inputs. When the device is in MANUAL mode, the algorithm
accepts the control commands Close and Open from the Operator Keyboard. Whenever a
command is processed in either AUTO or MANUAL mode, the outputs (OUT1 and OUT2) are set
accordingly for the duration of the time delay previously set in the Control Builder.

The Open and Close Permissives (IN8 and IN9) must be set to allow the valve to be opened or
closed. The Open and Close Permissives are automatically set when no input is connected to IN8
or IN9. See the Algorithm Definitions table for the list of inputs and outputs.

The digital alarm bit is set when one of the following occurs:
 The device is in the Failed state.
 The device opens or closes without being commanded to do so.
 The device fails to open or close.
When the device fails to open or close, the alarm triggers, but the device stays in the current
mode and continues looking for the proper Open and Close input combination. When this
combination is found, the alarm is reset, and the device continues operating in a normal condition.
All other alarms put the device in OFF mode. See the Truth table for the states of the valve.

The Controlled Valve also has a status packed point that displays which alarm has been set, the
last command, and which mode it is currently in. See the Output Status Bits table for the list of the
status bits.

Functional symbol

OW360_R1100 217
5.37 DIGITAL DEVICE

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 30 Tuning -

Diagram
Number
DLY1 C0-Integer Tuning Required 1 Time for Close -
Constant
(should be
greater than
loop time)
DLY2 C1-Integer Tuning Required 1 Time for Open -
Constant
(should be
greater than
loop time)
IN1 - Variable Required - Open Contact LD
(digital)
IN2 - Variable Required - Close Contact LD
(digital)
IN3 - Variable Optional - Remote Open LD
(digital)
IN4 - Variable Optional - Remote Close LD
(digital)
IN5 - Variable Optional - Remote Auto LD
(digital)
IN6 - Variable Optional - Remote LD
Manual (digital)
IN7 - Variable Optional - Remote Device LD
Reset (digital)

IN8 - Variable Optional - Open LD

Permissive
(digital)
IN9 - Variable Optional - Close LD
Permissive
(digital)
OUT1 - Variable Required - Open Output LD
(digital)
OUT2 - Variable Required - Close Output LD
(digital)
ALRM - Variable Optional - Device Alarm LD
(digital)
STAT - Variable Optional - Alarm and LP
Mode Status
(packed)

218 OW360_R1100
 5.37 DIGITAL DEVICE

Truth table

OPEN STATUS CLOSED STATUS VALVE STATE

Set Set Moving

Set Reset Open

Reset Set Closed

Reset Reset Failed

Output status bits

BIT DESCRIPTION

0 Failed to Close

1 Failed to Open

2 Not Applicable

3 Not Applicable

4 Not Applicable

5 Not Applicable

6 Device Deviation

7 Device Failed

8 Last Command Close

9 Last Command Open

10 Not Applicable

11 Not Applicable

12 Not Applicable

13 Device Off

14 Device in Manual

15 Device in Auto

OW360_R1100 219
5.38 DISTRIBUTOR

5.38 DISTRIBUTOR
Description

The DISTRIBUTOR algorithm distributes an input signal (IN) into two or more (up to eight) analog
outputs (OUTx). The final value of the outputs will be the balance of the IN value, the number of
devices needed to satisfy the demands of the system, and other configuration options.

The DISTRIBUTOR algorithm is available in the Ovation 3.5 release and later.

Functional symbol

Note: Tracking signals are not shown.

220 OW360_R1100
 5.38 DISTRIBUTOR

5.38.1 Input, FNUM parameter, and Output pins (IN, FNUM, and OUT[1 -8])

All algorithms connected to the IN and OUTx pins are required to be on a scale of 0 to 100. If an
IN pin is out of this range, the algorithm will substitute the closest boundary as the input value. If
the calculated OUTx value is out of range, the algorithm defaults to the nearest limit.

The FNUM parameter is defined as the number of devices required to cover a full load. It has a
range from 1 to the maximum number of algorithms connected to the OUTx pins. FNUM's default
value is 0, which the algorithm interprets and sets the FNUM parameter to the number of OUTx
pins currently connected to downstream algorithms. For example, if FNUM is set to zero and
three OUTx pins are connected, then the algorithm will use 3 as FNUM's value. In the default
configuration, each of the OUTx pins will be equal to the IN value, because FNUM would be equal
to the number of OUTx pins connected. See the following default Advanced Distributor equation.

In the default Distributor equation shown above, IN = the input value, FNUM = the number of
devices needed to satisfy the system demand, and Nc = the number of connected OUT pins.

In most cases, the sum of all the OUTx values will equal the product of the IN value and FNUM.

Note: For simplicity, equations are presented with default parameters when Base Gains (BG)
are equal to 100% and Corrections Gains are equal to 1.0.

All OUTx pins that are connected to another algorithm must be connected consecutively with no
skipped OUTx pins.

You can specify a lower number FNUM than the number of points connected to the OUTx pins.
For example, a Distributor algorithm is controlling three valves equally (such as an MASTATION
opening/closing physical valves), but the demand for this application is, at most. only what two
valves can provide. If all three valves were open 100%, the system would be overloaded. When
you lower FNUM from the number of OUTx pins to a lesser number (in this case, two), it is
equivalent to lowering the total output of three devices to a maximum output of what two devices
can provide.

You can set FNUM to exceed the number of OUTx pins connected, but this will have no effect on
the algorithm. The Distributor algorithm will reset FNUM internally back to the default (that is, to
the maximum OUTx pins connected).

Some configurations or tracking signals may change the Default Equation for the OUTx pins, but
the algorithm will achieve the Steady State, if possible.

OW360_R1100 221
5.38 DISTRIBUTOR

5.38.2 Exclusion (EXCL)

The Exclusion (EXCL) feature allows you to ignore OUTx pins already connected to the algorithm
(this includes the tracking TRINx signals) by selecting the unwanted pins (see Internal and
External Control (see page 228) for how OUTx can be selected). The Distributor algorithm
subtracts these pins from the number of connected pins in the default equation. In addition, the
excluded OUTx pins are excluded from the Steady State equation.

When the OUTx pin is excluded, the values of the outputs will not change. This is achieved by
setting the Track Out (TOUT) TRACKing bit for one loop cycle. The value of Track Out is
calculated as follows:

In exclusion mode, the value of the OUTx pin is calculated as follows:

Note: For simplicity, equations are presented with default parameters when Base Gains are
equal to 100% and Corrections Gains are equal to 1.0.

Example

If the default settings are used, IN's value is set 50 and there are three OUTx pins connected,
each will equal 50. If one pin is excluded, TOUT will change from 50 to 33.3 and the TOUT
TRACKing bit will be set. Depending on what is driving the Distributor input, the IN value may
drop from 50 to 33.3. The remaining OUTx points would remain at 50 through the transition. Once
the excluded OUTx pins are included again, the algorithm recalculates the OUTx values and will
move to the new values incrementally using the TRAT. When the newly included pin is
re-considered in the equation, TOUT's value may change drastically.

Based on the information above, the two OUTx pins that are not excluded are set to 75 and the
OUTx pin that was just included is 50. TOUT in this instance will jump to the average of the three
OUTx pins. TOUT will also pulse its TRACKing bit. In an MAStation, this will change the OUT pin
(and the Distributor's input) to equal the value of TOUT. All of the OUTx pins that were excluded
are then re-apportioned incrementally based on the moving values of the recently included pin.
The included OUTx pin is moving to the new OUTx value using the TRAT parameter (multiplied
by BGx).

222 OW360_R1100
 5.38 DISTRIBUTOR

5.38.3 Tracking Inputs (TKIN[1-8])

Tracking is applied to the input pin and all eight output pins (TRINx). When a downstream
algorithm sends one of the following tracking signals, the OUTx value will be controlled by the
downstream algorithm connected to it:
 High/low limit.
 TRACK bit (for example, an MAStation in manual mode).
 Lower/raise inhibit

Note: TRACK if higher and TRACK if lower are not implemented.

When the TRACK bit is set in TRINx, the Distributor relinquishes control of the OUTx value and
assigns the TRINx value directly to OUTx. The other OUTx values controlled by the Distributor
are redistributed depending on the TRINx values, as well as other changes in the algorithm.

Sum value of all the pins that are tracking:

Value of an OUT pin that is NOT tracking:

Where:

Tsum = Sum of track OUT pins

BG = Base Gain parameter
Nt = Number of track OUT pins

Note: For simplicity, the figure above does not consider Base Gain (BG) and Correction Gains.

If high limit or raise inhibit tracking bits are set and the IN value is going up, the Distributor
algorithm will freeze the OUTx value on the last OUTx value, all other OUTx values will shift to
achieve SteadyState. This also applies when the low limit or lower inhibit bit is set and the IN
value is going down. When both a high and a low signal are set on the same TRINx, the OUTx pin
will equal TRINx until one (or both) of the downstream signals are released.

When the OUTx pin(s) are released from their downstream tracking signals, the Distributor will
rebalance the OUTx pins. The TRAT is applied to the released pins until all the OUTx values are
balanced.

OW360_R1100 223
5.38 DISTRIBUTOR

5.38.4 Correction Gain

The Correction Gain (CGAIN) parameter is used to make minor corrections to each of the OUTx
equations dynamically through input pins or through a user diagram (see Internal and External
Control (see page 228)). The default value is 1.0. By default, each of the eight CGAIN (GAINx
pins and IGx parameters) must be between the values of 0.5 and 1.5. You can also define an
even smaller range by changing the CMIN and CMAX in the Control Builder (refer to Ovation
Control Builder User Guide for more information). The valid range for the CMIN parameter is 0.5
through 1.0 and the valid range for CMAX is 1.0 through 1.5. Inputs that exceed the range are
forced to the closest limit.

For the algorithm to reach Steady State, the sum of all the CGAIN inputs must equal the number
of all the attached OUTx pins. Since the correction gain can change, the current values may not
equal the number of OUTx pins all the time. To ensure equalization, each CGAIN is divided by the
"CGAIN Average." The new CGAIN values are then multiplied by the OUTx fields.

Average CGain value:

Value of OUT[x] after CGain is applied:

The CGAIN values will be applied in proportion to one another but will not unbalance the
algorithm's Steady State. For example, if all of the CGAIN values were equal to the maximum
value (1.5 or CMAX) and applied directly to the OUTx values, the Steady State equation would
not work. However, if CGAIN_Avg divides into each CGAINx value, it will work within the Steady
State equation.

Example 1: CGAIN = (1.5, 1.5, 1.5) and Steady State = 3

OUT1 = 1 OUT2 = 1 OUT3 = 1 Steady State

Org. Value of CGAINx 1 * 1.5 1 * 1.5 1 * 1.5 4.5 != 3
Value after CGAIN_Avg 1*1 1*1 1*1 3 == 3

Using CGAIN_Avg changes the value of the CGAINx, but the OUTx values will still be the same
proportional difference from each other. If the CGAINx values are 1.5, 1.5, and 0.7 for the first
three OUTx pins, OUT1 and OUT2 should be equal to one another, and OUT3 should be
proportionally less than the other OUTx values.

224 OW360_R1100
 5.38 DISTRIBUTOR

Example 2: CGAIN = (1.5, 1.5, 0.7) and Steady State = 3

OUT1 = 1 OUT2 = 1 OUT3 = 1 Steady State

Org. Value of CGAINx 1 * 1.5 1 * 1.5 1 * 0.7 3.7 != 3
Value after CGAIN_Avg 1 * 1.216 1 * 1.216 1 * 0.567 3 == 3

Note: Values are rounded.

The GAINx inputs have tracking signals attached to them (TRKGx). The TRKGx value is equal to
the internal input value IGx (Internal and External Control (see page 228)). This is provided for
external applications that change the OUTx values. If external inputs are switched to user control,
the external applications will have the information needed to make a smooth transition before
handing over control to a user diagram.

5.38.5 Priority Deadband (PDB)

The Priority Deadband (PDB) function is defined as the priority of outputs that will be used to
compensate for small changes in the IN value. This mechanism is designed to protect devices
against excessive wear. For example, when a change in the IN value is small, only one or a few
selected outputs should be used; the rest of the signals should not change in value.

The Priority Deadband mechanism requires you to define which outputs are set in priority mode
and what is the value of the deadband parameter. The Deadband parameter defines the maximal
difference between the priority output and other non-priority outputs. If the difference in the
current step would exceed the deadband value. then all output signals (priority and non-priority)
are used in the calculations for this step. The following formula defines how the output value in
Priority mode is calculated.

Where:

NPsum = Sum of non-priority OUT pins

Nnp = Number of non-priority OUT pins

OW360_R1100 225
5.38 DISTRIBUTOR

Consider the following:

 Priority mode is held temporarily if the distance between the high limit and the current output
is smaller than the deadband.
 Priority mode is turned off permanently if the output is tracked (TRACK, raise/lower inhibit,
TRACK if higher/lower).
 If an excluded OUTx is selected as a PDB, it is only counted as an excluded output.
 Priority mode can only be applied to outputs when BG is 100.
For a general example for how PDB is applied, refer to the following table:

Time and current in value

CURRENT VALUE TO OUT1 OUT2 OUT3 OUT4

TIME IN VALUE DISTRIBUTION (PRIORITY) (PRIORITY)

0 50 200 50 50 50 50
1 49 196 48 48 50 50
2 48 192 46 46 50 50
3 47 188 47 47 47 47
4 46 184 45 45 47 47
5 45 180 43 43 47 47
6 44 176 44 44 44 44

Time 3, 6 At this time, the values are distributed normally because the differences between
priority and non-priority points would be bigger than the priority deadband
(PDB=5).

5.38.6 Base Gain

The Base Gain (BGx) parameter gives the ability to re-apportion the final OUTx signals. The
range of BGx is from 100 (the default) to five (5) and anything outside that range will be
considered equal to 100.

BGx is applied to the OUTx equation only after everything else has been calculated.

When none of the OUTx pins have reached a high limit (for example: OUTx >= 100), BGx will
simply be the equation shown above. However, if the BGx causes an OUTx value to exceed its
high limits, then the Distributor algorithm will set those OUTx parameters to their limits (for
example: OUTx = 100) and the downstream algorithms will set the High Limit flags in the returned
TRINx fields. These pins are considered at a High Limit and need to be treated as if the High Limit
Flag was already set. To solve the other OUTx values and keep the Steady State, the algorithm
must solve all the other OUTx values with the Tracking Equation.

226 OW360_R1100
 5.38 DISTRIBUTOR

5.38.7 Tracking Out (TOUT)

The Distributor algorithm takes the following action in response to the information found in the
analog track signals (in the third status field), which are passed back from the downstream
algorithm:

Signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 TRACK Implemented Refer to Internal and External Control

(see page 228).
17 Track if Lower -- Passed through
18 Track if Higher -- Passed through
19 Lower Inhibit Implemented Passed through
20 Raise Inhibit Implemented Passed through
21 Conditional Track -- --
22 Not Used -- --
23 Deviation Alarm -- --
24 Local Manual Mode -- --
25 Manual Mode -- --
26 Auto Mode -- --
27 Not Used -- --
28 Not Used -- --
29 Not Used -- --
30 Low Limit Reached Implemented Passed Through
31 High Limit Reached Implemented Passed Through

The Tracking Out (TOUT) value is calculated as follows:

The TRACK bit is set for TOUT on the following occasions:

1. The tracking bit is Pulsed ON if the selected EXCL outputs have changed from the previous
Task Cycle.
2. The tracking bit is set ON continually if all OUTx pins are excluded and/or all TRINx TRACK
bits are set.

OW360_R1100 227
5.38 DISTRIBUTOR

The Lower Inhibits bit is set if all outputs are limited from down (TRACK, low limit, lower inhibit)
and Steady State equation is not met.

The Raise Inhibits bit is set if all outputs are limited from top (TRACK, high limit, raise inhibit) and
the Steady State equation is not met.

The Low Limit bit is set if all outputs (excluded pins are not counted) are on low limit (0.0). In this
case, the Lower Inhibit bit is set as well.

The High Limit bit is set if all outputs (excluded pins are not counted) are on high limit (100.0). In
this case, the Raise Inhibit bit is set as well.

The other bits are “passed though” from the TRINx pins to the TOUT pin only if all the TRINx pins
have the same signal(s) set. This does not count pins that are excluded.

5.38.8 Internal and External Control

The Distributor has several parameters that can accept inputs from pin(s), as well as fields from
inside the algorithm record, but never both at the same time. These are called "selectable inputs,"
and they apply to the optional features EXCL mode, PDB Mode, and GAINx inputs.

External:
1. Two packed 16-bit input pins control the EXCL and PDB features. The packed points are
used to select the OUTx pins that are connected. Bit 0 is equal to OUT1 and Bit 7 is equal to
OUT8. (Bits 8 through 15 are not used.) To select the OUTx pin(s), set and hold a "1" in the
correct bit. To deselect an OUTx pin(s), set the required bit to "0."
2. The Correction Gain uses eight analog input pins (GAINx). Each pin corresponds to an
attached OUTx pin.

Internal (Record Fields):

1. The EXCL and PDB each use a set of parameters for internal control (EXON\EXOFF and
PDON\PDOFF). One field is used to select OUTx pins, while the other field is used to deselect
OUTx pins. This parameter uses bit maps to choose the selected OUTx pins. For example, if
EXON = 0x5 then OUT1 and OUT3 will be selected. If EXOFF = 0x1, OUT1 is deselected, but
OUT3 remains unchanged. The fields reset to zero after they are applied to the algorithm.
2. The CGAIN uses eight LC record parameters to control the gain internally (IGx parameters).

External vs. Internal

FEATURES EXTERNAL INTERNAL

Exclusion XSEL EXON\EXOFF

Priority Deadband PSEL PDON\PDOFF
Correction Gain GAINx IGx

Note: The use of the selectable pins are optional. If the pins are not used, the operator must
use the internal fields in order to utilize this feature.

228 OW360_R1100
 5.38 DISTRIBUTOR

5.38.9 Switching Between Internal and External Inputs

You can switch between internal algorithm fields or external algorithm pins for EXCL mode, PDB
mode, and CGAIN. This can be done as follows:

1. The command signal pin (CMD) - a 16-bit packed point input pin:
a) To turn the input pin(s) ON for a specific function (and accept input from an external
application), the appropriate bit (1, 3, 5) must be set to "1."
b) To turn the input pin(s) OFF for a specific function (and accept input from the internal
algorithm field), the appropriate bit (0, 2, 4) must be set to "1."
c) If both appropriate bits (0, 1) or (2, 3) or (4, 5) are set to "1," the input pin(s) will be turned
OFF.
d) If both the appropriate bits (0, 1) or (2, 3) or (4, 5) are set to "0," the state will depend on
internal algorithm fields (see #2 below).

Note: The signals can be pulsed or held. If these signals are held at 1, you will not be able to
change its state from the internal algorithm fields.

2. The internal algorithm fields Y[0 - 5]:

a) To turn the input pin(s) ON for a specific function (and accept input from an external
application), the appropriate field (Y0, Y2, Y4) must be set to "1."
b) To turn the input pin(s) OFF for a specific function (and accept input from an internal
algorithm field), the appropriate field must be set to "1" (Y1, Y3, Y5).
c) If both fields are set to "1" for a specific function, the input pin(s) will be turned OFF.
d) If both fields are set to "0" for a specific function, the input pin(s) will not be changed.
e) The field is reset to "0" after the command(s) are read..
3. Special Case situations:
a) The Y0 field is set and the CMD:Bit 1 field is set at the same time (opposite commands
for the same function). If there is a conflict between CMD and the Y fields, the CMD pin
takes priority.

Bits and fields

16-Bit Packed Point - CMD

Bits 0 and 1 Turn Correction Gain Control Pins ON/OFF

Bits 2 and 3 Turn the Exclusion Control Pin ON/OFF

Bits 4 and 5 Turn the Priority Control Pin ON/OFF

Bits 6 through 15 Not Implemented.

Algorithm Record Fields

Y0 and Y1 Turn Correction Gain Control Pins ON/OFF (GAIN[1 - 8] pins)

Y2 and Y3 Turn the Exclusion Control Pin ON/OFF (EXCL packed point)

Y4 and Y5 Turn the Priority Control Pin ON/OFF (PSEL packed point)

OW360_R1100 229
5.38 DISTRIBUTOR

Results

CONTROL ALGORITHM 16-BIT PACKED

TYPE REFERENCE POINT "CMD" RESULTS

STATE ON OFF ON OFF

EX AMP LE Y0 Y1 BIT 1 BIT 0

0 FALSE FALSE FALSE FALSE State does not change.

1 FALSE FALSE FALSE TRUE CMD changes the state to OFF.

2 FALSE FALSE TRUE FALSE CMD changes the state to ON.

3 FALSE FALSE TRUE TRUE CMD changes the state to OFF.

4 FALSE TRUE FALSE FALSE Algorithm field changes the state to

OFF.
5 FALSE TRUE FALSE TRUE CMD changes the state to OFF.
6 FALSE TRUE TRUE FALSE CMD changes the state to ON.

7 FALSE TRUE TRUE TRUE CMD changes the state to OFF.

8 TRUE FALSE FALSE FALSE Algorithm field changes the state to
ON.
9 TRUE FALSE FALSE TRUE CMD changes the state to OFF.
10 TRUE FALSE TRUE FALSE CMD changes the state to ON.

11 TRUE FALSE TRUE TRUE CMD changes the state to OFF.

12 TRUE TRUE FALSE FALSE Algorithm field changes the state to

OFF.
13 TRUE TRUE FALSE TRUE CMD changes the state to OFF.

14 TRUE TRUE TRUE FALSE CMD changes the state to ON.

15 TRUE TRUE TRUE TRUE CMD changes the state to OFF.

230 OW360_R1100
 5.38 DISTRIBUTOR

5.38.10 First Pass Startup Options

There is a data init parameter for each of the selectable inputs to determine whether the input
pins are ON or OFF after first pass startup. If the pins XSEL and/or PSEL are OFF for the first
pass, an engineer can set the internal value of the EXCL and PBD selection bitmaps with the
FPEX and FPPR parameters. For example, an engineer can set FPEA to OFF , which will turn off
the XSEL pin for the first time the algorithm runs. Then they can exclude OUT1 and OUT3 for the
first pass by setting FPEX to 0x05.

First Pass Startup Options

FEATURES FIRST PASS STATE FIELDS INIT VALUES (ONLY IF THE PIN
IS OFF)

Exclusion FPEA (XSEL is ON/OFF after FPEX (if FPEA is OFF)

First pass)
Priority Deadband FPPA (PSEL is ON/OFF after FPPR (if FPPA is OFF)
First pass)
Correction Gain FPGA (GAINx is ON/OFF after IG[1-8] (if FPGA is OFF)
First pass)

STAT1 Pins

BITS DESCRIPTION

0-7 A bitmap of OUTx pins that the Distributor has control over.
8 GAIN input pins that are active.
9 PDB input pins that are active.
10 EXCL input pins that are active.
11 Track if Lower and Track if Higher conditions are active.

STAT2 Pins

BITS DESCRIPTION

0-7 Bitmap of EXCL selected OUTx

8 - 15 Bitmap of PDB selected OUTx

5.38.11 Point Quality

Quality is propagated from the IN pin to all OUTx pins that are excluded. If a point is excluded, the
value and quality is taken from the TRIN point.

5.38.12 SID Storage

In order to assist with graphics programming, all output point SIDs are stored in fields in the
algorithm. This allows the graphic to access multiple SIDs by accessing a single SID (the
algorithm LC record).

OW360_R1100 231
5.38 DISTRIBUTOR

5.38.13 Distributor replaces Balancer

The DISTRIBUTOR algorithm provides all of the functionality of the BALANCER, and offers
additional features as well. Some of the new features are Exclusion, Priority, Correction Gain, and
Bias Gain.

The DISTRIBUTOR algorithm has advanced design and algorithm behavior that tracks the current
value when the device first switched from a manual mode to AUTO mode. This algorithm is
unified with OVATION tracking philosophy; therefore, it can be placed between any other
algorithms on a control sheet. These changes impact the algorithm's behavior only when the
downstream algorithm is limited by TPSC or BTSC as shown in the following figure (in this case,
the downstream algorithm is a MASTATION):

Figure 16: MASTATION algorithm limited by TPSC or BTSC

232 OW360_R1100
 5.38 DISTRIBUTOR

The BALANCER algorithm balances signals that treat the HIGH LIMIT REACHED signals like a
TRACK signal. However, the DISTRIBUTOR algorithm only tracks TRACK signals. By adding an
external logic, the DISTRIBUTOR algorithm is no longer limited. For example, in the following
figure the TPSC value is 40 that is smaller than DISTRIBUTOR algorithm output, which is 44. The
TRANSFER algorithm selects TPSC value and sends TRACK bits to the DISTRIBUTOR
algorithm. The DISTRIBUTOR algorithm considers TRACK bits and balances the other output
values.

5.38.14 Distributor Algorithm Definitions

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

Inputs (with attached Tracking signals)

IN D0 - SID Variable Required - Input (analog) LA

T1 - Value
TOUT Variable Optional - Track output LA
value mode and
status signals for
input variable
GAIN1 S1 - Value Variable Optional - External LA
Correction
Gain 1
TRKG1 Variable Optional - Tracking LA
Correction
Gain 1. This
outputs the
value of IG1
(R1 field).

OW360_R1100 233
5.38 DISTRIBUTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

GAIN2 S2 - Value Variable Optional - External LA

Correction
Gain 2
TRKG2 Variable Optional - Tracking LA
Correction Gain
2. This outputs
the value of IG2
(R2 field).
GAIN3 S3 - Value Variable Optional - External LA
Correction
Gain 3
TRKG3 Variable Optional - Tracking LA
Correction Gain
3. This outputs
the value of IG3
(R3 field).
GAIN4 S4 - Value Variable Optional - External LA
Correction
Gain 4
TRKG4 Variable Optional - Tracking LA
Correction Gain
4. This outputs
the value of IG4
(R4 field).
GAIN5 S5 - Value Variable Optional - External LA
Correction
Gain 5
TRKG5 Variable Optional - Tracking LA
Correction Gain
5. This outputs
the value of IG5
(R5 field).
GAIN6 S6 - Value Variable Optional - External LA
Correction
Gain 6
TRKG6 Variable Optional - Tracking LA
Correction Gain
6. This outputs
the value of IG6
(R6 field).
GAIN7 S7 - Value Variable Optional - External LA
Correction
Gain 7
TRKG7 Variable Optional - Tracking LA
Correction Gain
7. This outputs
the value of IG7
(R7 field).

234 OW360_R1100
 5.38 DISTRIBUTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

GAIN8 S8 - Value Variable Optional - External LA

Correction
Gain 8
TRKG8 Variable Optional - Tracking LA
Correction Gain
8. This outputs
the value of IG8
(R8 field).
CMD G7 - Value Variable Optional - External LP
Command
(16-bit Pack):
 Bits 0 and 1:
GAIN# pins
(ON/OFF)
 Bits 2 and 3:
XSEL pin
(ON/OFF)
 Bits 4 and 5:
PSEL pin
(ON/OFF)
PSEL G8 - Value Variable Optional - Select OUTx to LP
apply the Priority
deadband.
 Bits 0 - 7 used
to select OUTx
pins. (Hold bits
TRUE to
Select
Outputs)
XSEL G9 - Value Variable Optional - Select OUTx to LP
Excluded.
 Bits 0 - 7 used
to select OUTx
pins. (Hold bits
TRUE to
Select
Outputs)
Outputs (with attached Tracking signals):

OUT1 YQ - SID Variable Required - Analog Output 1 LA

T2 - Value
TRIN1 Variable Optional - Tracking Input LA
for OUT1
OUT2 D2 - SID Variable Required - Analog Output 2 LA
T3 - Value
TRIN2 Variable Optional - Tracking Input LA
for OUT2
OUT3 YP - SID Variable Optional - Analog Output 3 LA
T4 - Value

OW360_R1100 235
5.38 DISTRIBUTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TRIN3 Variable Optional - Tracking Input LA

for OUT3
OUT4 D4 - SID Variable Optional - Analog Output 4 LA
T5 - Value
TRIN4 Variable Optional - Tracking Input LA
for OUT4
OUT5 D5 - SID Variable Optional - Analog Output 5 LA
T6 - Value
TRIN5 Variable Optional - Tracking Input LA
for OUT5
OUT6 D6 - SID Variable Optional - Analog Output 6 LA
T7 - Value
TRIN6 Variable Optional - Tracking Input LA
for OUT6
OUT7 YN - SID Variable Optional - Analog Output 7 LA
T8 - Value
TRIN7 Variable Optional - Tracking input LA
for OUT7
OUT8 D8 SID Variable Optional - Analog Output 8 LA
T9 Value
TRIN8 Variable Optional - Tracking Input LA
for OUT8
STAT2 Variable Optional - Status (See LP
"Stat2" table)
STAT1 Variable Optional - Status 1 (See LP
"Stat1" table)
Params:

BG1 X1 Data Init Required 100 Base Gain 1 -

BG2 X2 Data Init Required 100 Base Gain 2 -

BG3 X3 Data Init Required 100 Base Gain 3 -

BG4 X4 Data Init Required 100 Base Gain 4 -

BG5 X5 Data Init Required 100 Base Gain 5 -

BG6 X6 Data Init Required 100 Base Gain 6 -

BG7 X7 Data Init Required 100 Base Gain 7 -

BG8 X8 Data Init Required 100 Base Gain 8 -

FPEA X9 Bit 2 Data Init Required OFF XSEL pin -

ON/OFF for the
algorithm's
startup.

236 OW360_R1100
 5.38 DISTRIBUTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

FPPA X9 Bit 4 Data Init Required OFF PSEL pin -

ON/OFF for the
algorithm's
startup.
FPGA X9 Bit 0 Data Init Required OFF GAINx pins -
ON/OFF for the
initial algorithm's
startup.
CGON *Y0 Variable Required 0 Internal -
command to turn
GAINx pins
"ON."
CGOFF *Y1 Variable Required 0 Internal -
command to turn
GAINx pin
"OFF."
CEON *Y2 Variable Required 0 Internal -
command to turn
the XSEL pin
"ON."
CEOFF *Y3 Variable Required 0 Internal -
command to turn
the XSEL pin
"OFF."
CPON *Y4 Variable Required 0 Internal -
command to turn
the PSEL pin
"ON."
CPOFF *Y5 Variable Required 0 Internal -
command to turn
the PSEL pin
"OFF."
FPEX G1 Data Init Required 0 If the FPEA is -
"OFF," then this
is the internal bit
map of Excluded
OUTx pins for
initial algorithm
startup.
EXON *G2 Variable Required 0 Internal -
Command to
Select OUTx
pins to Exclude.
Reset to zero
after selection is
accepted. Only
valid if XSEL is
turned "OFF."
(Range: 0x00 to
0xFF)

OW360_R1100 237
5.38 DISTRIBUTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

EXOFF *G3 Variable Required 0 Internal -

Command to
deselect OUTx
pins to Exclude.
Reset to zero
after selection is
accepted. Only
valid if XSEL is
turned "OFF."
(Range: 0x00 to
0xFF)
FPPR G4 Data Init Required 0 If the FPPA is -
"OFF," then this
is the internal bit
map of Excluded
OUTx pins for
initial algorithm
startup.
PDON *G5 Variable Required 0 Internal -
Command to
Select OUTx
pins to apply
Priority
deadband.
Reset to zero
after selection is
accepted. Only
valid if PSEL is
turned "OFF."
(Range: 0x00 to
0xFF)
PDOFF *G6 Variable Required 0 Internal -
Command to
Select OUTx
pins to apply
Priority
deadband.
Reset to zero
after selection is
accepted. Only
valid if PSEL is
turned "OFF."
(Range: 0x00 to
0xFF)
CMDVL G7 Variable Required 0 Information -
about CMD pin
map.
PSELV G8 Variable Required 0 Information -
about PSEL pin
map.
XSELV G9 Variable Required 0 Information -
about XSEL pin
map.

238 OW360_R1100
 5.38 DISTRIBUTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

CMIN U2 Data Init Required 0.5 Correction -

Gain's lowest
value. Valid
range: 0.5 to 1.0
CMAX U3 Data Init Required 1.5 Correction -
Gain's highest
value. Valid
range: 1.0 to 1.5
TRAT R9 Tuning Required 2.5 Track Ramp -
Constant Rate.
This is only
applied to
situations that an
OUTx pin is
released from
tracking or
Exclusion. TRAT
is always
multiplied by the
OUTx pin's Base
Gain
TRAT = (TRAT
* 100/BG[x])
PRDB S9 Tuning Required 5 Priority -
Constant Deadband value
TRDB V1 Tuning Required 1.0 Deadband for -
Constant Track conditions

OW360_R1100 239
5.38 DISTRIBUTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

FNUM C0 Data Init Required 0 Number of -

devices needed
to satisfy the
system demand.
This can never
be more than the
devices
connected.
 0: Count of all
devices
connected to
the OUTx pins.
 1: One device
is needed.
 2: Two devices
are needed.
 3: Three
devices are
needed.
 4: Four
devices are
needed.
 5: Five devices
are needed.
 6: Six devices
are needed.
 7: Seven
devices are
needed.
 8: Eight
devices are
needed.
IG1 R1 Tuning Required 1 Internal -
Constant Correction
Gain 1
IG2 R2 Tuning Required 1 Internal -
Constant Correction
Gain 2
IG3 R3 Tuning Required 1 Internal -
Constant Correction
Gain 3
IG4 R4 Tuning Required 1 Internal -
Constant Correction
Gain 4
IG5 R5 Tuning Required 1 Internal -
Constant Correction
Gain 5
IG6 R6 Tuning Required 1 Internal -
Constant Correction
Gain 6

240 OW360_R1100
 5.38 DISTRIBUTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IG7 R7 Tuning Required 1 Internal -

Constant Correction
Gain 7
IG8 R8 Tuning Required 1 Internal -
Constant Correction
Gain 8
VER U1 Alg Init Variable 0 Version of the -
Distributor
COMAP B0 Alg Init Variable 0 Bitmap of -
Connected
OUTx
ACMAP B1 Alg Init Variable 0 Bitmap of active -
OUTx pins.
(These are
OUTx pins that
are not
excluded,
tracking,
ramping)
PAMAP B2 Alg Init Variable 0 Bitmap of -
passive OUTx
pins. (These are
OUTx pins that
are excluded or
tracking.)
REMAP YU Alg Init Variable 0 Bitmap of -
released OUTx
pins. (These are
OUTx pins that
are ramping.)
SPMAP B4 Alg Init Variable 0 Bitmap of -
tracking OUTx
pins
EXCL B5 Alg Init Variable 0 Selected OUTx -
pins that are
Excluded
(Bitmap)
PDB B6 Alg Init Variable 0 Selected OUTx -
pins that are
PDB (Bitmap)
TRMAP C1 Alg Init Variable 0 Bitmap of OUTx -
pins that have
"_3W_Track_
Bit_" set.
LOWTR C2 Alg Init Variable 0 Bitmap of OUTx -
pins that have
_3W_LOW_
TRACK_set

OW360_R1100 241
5.38 DISTRIBUTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

HITRK C3 Alg Init Variable 0 Bitmap of OUTx -

pins that have
_3W_HIGH_
TRACK_set
LOLIM C4 Alg Init Variable 0 Bitmap of OUTx -
pins that have
_3W_LOW_
LIMIT_set
HILIM C5 Alg Init Variable 0 Bitmap of OUTx -
pins that have
_3W_HIGH_
LIMIT_set
INLMP C6 Alg Init Variable 0 Bitmap of OUTx -
pins that have
_3W_LOWER_
INHIBIT_set

INHMP C7 Alg Init Variable 0 Bitmap of OUTx -

pins that have
_3W_HIGH_
INHIBIT_set
* The asterisk indicates that this is a command field, not a feedback field. A command field can be
used as a user-interface to the algorithm. It drives the algorithm to perform a function.

242 OW360_R1100
 5.39 DIVIDE

5.39 DIVIDE
Description

The DIVIDE algorithm divides two gained and biased inputs. The output of the DIVIDE algorithm
is the result of the gained and biased IN1 divided by the gained and biased IN2. If the gained and
biased IN2 is zero, or an invalid real number, then the output is either the high or low limit
according to the sign of the IN1.

Note: If the algorithm receives an invalid value as the input, or if it calculates an invalid value as
the output, the drop is placed into alarm.

Functional symbol

Tracking Signals

Tracking and limiting are done through signals passed in the third status field of an analog point to
the algorithm. This algorithm takes the following action in response to the information found in the
input signal TRIN:

Bits description

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit No action Passed through**

20 Raise inhibit No action Passed through**

21 Conditional Track Implemented Passed through***

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Not Used No action Not used

OW360_R1100 243
5.39 DIVIDE

BIT DESCRIPTION ACTION TOUT SIGNAL

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the
definitions given in Setting Tracking Signals (see page 17).

*** If the algorithm is being told to track, then the Conditional track bit is ignored.
Otherwise, the value of the conditional track bit is transferred to all output track points.
If the Conditional Track bit is set in the track input point, the analog value of all output
track points is calculated based on the analog value of the track input point.

The high and low limit flags and the tracking signals from the algorithms are outputs to TOUT, to
be used for display and by an upstream algorithm. If the output value is invalid, the quality of OUT
is set BAD otherwise, the quality of OUT is set to the worst quality of the two inputs when not in
tracking mode. When tracking, the quality is set to the quality of the track input variable.

Note: If the algorithm generates an inverted track output, the IN1 value is used as the track
output, unless it is invalid, The track output value is not updated if both the calculated track
output and INI input values are inverted.

In addition, you may turn off the tracking output calculations. This may be done to support control
logic designs that require fast execution times (such as 20 msec). The TBLK parameter can be
set to OFF, which will disable the tracking calculations and local memory operations. The default
value for TBLK is ON, which means the algorithm performs the tracking calculations.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 81 Tuning -

Diagram
Number
IN1G R1-Real Tuning Required 1.0 Gain (+ or -) on -
(NUMG) Constant input 1

IN1B R2-Real Tuning Required 0.0 Bias (+ or -) on -

(NUMB) Constant input 2

IN2G R3-Real Tuning Required 1.0 Gain on input 2 -

(DENG) Constant

IN2B R4-Real Tuning Required 0.0 Bias on input 2 -

(DENB) Constant

244 OW360_R1100
 5.39 DIVIDE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TPSC R5-Real Tuning Required 1E+09 Maximum -

Constant value of the
(999999999) output point
BTSC R6-Real Tuning Required -1E+09 Minimum value -
Constant of the output
(-999999999) point
TRAT R7-Real Tuning Required 2.5 Track ramp -
Constant rate (units per
second)
TBLK X3 - Byte Data Init. Required ON Enable tracking -
Bit 0 calculations
and local
memory
operations. The
choices are:
ON
OFF
NUM - Variable Required - Input (analog) LA
(IN1)

TOUT - Variable Required - Track output LA

value, mode &
status for input
variable
DEN - Variable Required - Input (analog) LA
(IN2)

OUT - Variable Required - Output (analog) LA

TRIN - Variable Optional - Tracking LA

analog value,
tracking and
limiting mode
signals input
variance

OW360_R1100 245
5.39 DIVIDE

Function

246 OW360_R1100
 5.40 DRPI1A

5.40 DRPI1 A

Description

The DRPI1A algorithm converts the gray codes (IN1) to actual rod positions. On the first pass, the
rod position is always a zero value with BAD quality. For control rods, the calculation for
converting gray codes into steps is converting the gray code to a decimal number and adding the
two gray codes together and multiplying the sum by STEP. If there is an error reading either gray
code, or if the gray code is above the maximum range, only the good code is used in the
calculation and the resultant quality is set to FAIR. If gray code A is BAD, then the rod position is
equal to: ((converted gray code B times 2 times STEP) + (1/2 times STEP)). If the gray code B is
BAD, then the rod position is equal to: ((converted gray code A times 2 times STEP) - (1/2 times
STEP)). If both gray codes are BAD or above the limits, then the rod position is set to zero with
BAD quality.

If the rod is a shutdown rod and the converted gray codes added together equal BOTS, then the
rod position is equal to GAP and POOR quality. If the converted gray codes added together is
greater than BOTS, then the rod position is equal to TOPG plus the calculated position.

If bit 12 of IN1 is set, then the algorithm sets a two-second timer. When the timer expires, the
algorithm saves the current rod being scanned. During the first scan of any rod after the two
second timer has expired, a rod value of zero is allowed. At all other times a zero is not valid. If a
zero is not allowed, then any zero reading is ignored by setting the rod number (RODZ) to zero.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 93 Tuning Diagram -

Number
MNIN R1-Real Tuning Required 0.0 Maximum number -
Constant of steps per rod

GAP R2-Real Tuning Required 0.0 Shutdown Rod Gap -

Constant

TOPG R3-Real Tuning Required 0.0 Shutdown Top Gap -

Constant

FUEL R4-Real Tuning Required 0.0 Maximum Steps for -

Constant Rapid Refuel

OW360_R1100 247
5.40 DRPI1A

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

BOTS G0-Integer Tuning Required 4 Number of Bottom -

Constant Coils for Shutdown
Rod
MAXS G1-Integer Tuning Required 6 Maximum Coils in -
Constant Shutdown Rod

STEP G2-Integer Tuning Required 6 Number of Steps -

Constant Between Coils

IN1 - Variable Required 0 Input (packed): LP

Bits 0 - 4 = Gray
Bit 5 = Gray Code
A Error Bit
Bits 6 - 10 = Gray
Code B
Bit 11 = Gray Code
B Error Bit
Bit 12 = CD24
Monitor.
Indicator that zero
value can be
accepted.
Bit 13 = Rapid
Refuel in
progress
ROD - Variable Required - Rod Number Input LA
(analog)

SHUT - Variable Required - Shutdown Control LD, LP

Rod
Input (digital)
TRIP - Variable Optional - Unit Trip Input LD, LP
(digital)
OUT - Variable Required - Rod Position LA
Output (analog)

RODZ - Variable Required - Rod Number or LA

zero
Output (analog)

248 OW360_R1100
 5.41 DVALGEN

5.41 DV ALGEN

Description

The DVALGEN algorithm initializes a digital point. For the DVALGEN algorithm, the output is the
digital value stored in the tuning constant (VALU). This value can be used to force any digital
input to any algorithm to either a TRUE or FALSE statement that remains fixed unless changed
by a tuning function.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU- Data Init. Required 69 Tuning Diagram -

Integer Number
VALU R1-Real Tuning Required 1.0 Real value -
Constant (0.0 = FALSE;
1.0 or any other
non-zero,
real number = TRUE)
OUT - Variable Required - Output (digital) LD, LP

Function

OUT = VALUE

OW360_R1100 249
5.42 DXCSTATUS

5.42 DXCSTATUS
Description

The Digital eXcitation Controller algorithm (DXCSTATUS) interfaces with the Digital Excitation
Controller (DEC) module for the purpose of reconciling the module’s tuning parameters with the
Ovation Database Server.

Note: For more information on the DEC module, refer to the Digital eXcitation Controller User
Guide and the Ovation Bus and Specialty I/O Reference Manual.

The DXCSTATUS algorithm interacts with the DEC module to:

 Exchange tuning parameters and site rating parameters with the module. Parameters can be
uploaded from and downloaded to the module using a custom graphic.
 Reconcile tuning parameters and site rating parameters with the Ovation Database Server.
 Perform on-demand calibration of excitation module inputs.
 Swap control between modules in a redundant system.
The DXCSTATUS algorithm operates in conjunction with a single excitation module or a
redundant pair of modules.

Functional symbol

The following table describes the DXCSTATUS algorithm inputs.

DXCSTATUS algorithm inputs

NAM E DESCRIPTION

ACMD Algorithm command word input from control logic.

RDNT Indicates redundant configuration.
ENBL Enables the DXCSTATUS algorithm.

250 OW360_R1100
 5.42 DXCSTATUS

The following table describes the DXCSTATUS algorithm output.

DXCSTATUS algorithm output

NAME DESCRIPTION

ASTA1 Algorithm status word output to control logic for primary module.
ASTA2 Algorithm status word output to control logic for partner module.
STATE Algorithm internal state (see state diagram).

Algorithm Parameters

The following table describes the DXCSTATUS algorithm parameters.

 DSTA, DST2 -- Status returned by the driver after a processing command requests from the
algorithm. DSTA is the status returned from the module. DST2 is the status returned from the
redundant module.
 DIAG -- Tuning diagram number.
 DVNM -- Device number for Ethernet I/O.
 HWA1, HWA2 -- Hardware address of module and redundant module, respectively.
 Module tuning parameters.
 Module site rating parameters.

Note: Custom graphics are typically used to modify the site ratings parameters.

Most of the algorithm parameters consist of DEC module tuning parameters and site rating
parameters. A complete list of algorithm parameters appears in the Algorithm parameters table.
Initial values for module tuning parameters are specified as the default values for the parameters
in the DXCSTATUS algorithm.

Note: In the following table, all parameters are required.

Algorithm parameters

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

DVNM G1 Integer No N/A 0 Device number.

HWA1 G6 Int No N/A 0.0 Card hardware address.
HWA2 G7 Int No N/A 0.0 Redundant card
hardware address.
DSTA G4 LP No N/A 0 Driver status.
DST2 G5 LP No N/A 0 Driver status second
module.
ERR1 G8 Int No N/A 0 Error code primary
module.

OW360_R1100 251
5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

ERR2 G9 Int No N/A 0 Error code partner

module.
DEC Tuning Information
DCKI R1 Real Yes Tuning 10 Inner loop integral gain
Constant for AC control, in volts
DC / (per unit * sec).
DCKP R2 Real Yes Tuning 10 Inner loop proportional
Constant gain for AC control, in
volts DC / per unit.
ACKD R3 Real Yes Tuning 0 Derivative gain for the
Constant AC controller, in volts DC
* sec / in fractional
percent.
ACKI R4 Real Yes Tuning 20 AC controller integral
Constant gain for voltage control,
in 1 / sec.
ACKP R5 Real Yes Tuning 20 AC controller
Constant proportional gain for
voltage control, in per
unit.
KS1H R6 Real Yes Tuning 1.0 PSS variable, high range
Constant (normal) gain of PSS, in
per unit/pu.
KS1L R7 Real Yes Tuning 1.0 PSS variable, low range
Constant (attenuated) gain of PSS,
in per unit/pu.
KS1M R8 Real Yes Tuning 0.5 PSS variable, high range
Constant load to use KS1H for
PSS, in per unit.
KS1N R9 Real Yes Tuning 0.45 PSS variable, low range
Constant load to use KS1L for
PSS, in per unit/pu.
KS2 S1 Real Yes Tuning 0.78 PSS variable, integrator
Constant gain - normally = T7/2H,
in per unit/pu.
KS3 S2 Real Yes Tuning 1.0 PSS variable, summation
Constant gain - normally 1, in per
unit/pu.
KSG S3 Real Yes Tuning 0.707 PSS variable, internal
Constant signal generator gain -
amplitude control,
unitless.
KTI S4 Real Yes Tuning 0.01 PSS variable, test signal
Constant gain, in per unit / volts
DC.

252 OW360_R1100
 5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

LL1E X0 Byte Yes Tuning 1 PSS variable, enables

Constant the first lead/lag filter:
 0 = disable
 1 = enable
LL2E X1 Byte Yes Tuning 1 PSS variable, enables
Constant the second lead/lag filter:
 0 = disable
 1 = enable
LL3E X2 Byte Yes Tuning 1 PSS variable, enables
Constant the third lead/lag filter:
 0 = disable
 1 = enable
UEKI S5 Real Yes Tuning 4 Integral gain of MEL, in
Constant fractional percent
terminal voltage
(.% MVA * sec).
UEKP S6 Real Yes Tuning 2 MEL proportional gain, in
Constant fractional percent
terminal voltage /
(.% MVA).
OEKI S7 Real Yes Tuning 15 MXL integrator gain, in
Constant fractional percent
terminal voltage /
(.% current * sec).
OEKP S8 Real Yes Tuning 10 MXL proportional gain, in
Constant fractional percent
terminal voltage / .% Ifld.
NCHE X3 Byte Yes Tuning 0 PSS variable, enables
Constant the notch filter:
 0 = disable
 1 = enable
NCHF S9 Real Yes Tuning 9.0 PSS variable, center
Constant frequency for the notch
filter, in Hz.
NCHQ T1 Real Yes Tuning 10.0 PSS variable, quality
Constant factor for notch filter,
unitless.
PSSF T2 Real Yes Tuning 1.0 Scale factor to permit
Constant derating the AC
controller PID gains if the
PSS is not operational,
unitless.
PSMW T3 Real Yes Tuning 0.1 PSS variable, sets the
Constant maximum value of MW at
which the PSS will turn
off, in per unit.

OW360_R1100 253
5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

PSOF T4 Real Yes Tuning 0.15 PSS variable, sets the

Constant minimum value of MW at
which the PSS will turn
on, in per unit.
RTFE X4 Byte Yes Tuning 1 PSS variable, used to
Constant enable the ramp tracking
filter:
 0 = disable
 1 = enable
RTFM G2 Int Yes Tuning 5 PSS variable,
Constant ramp-tracking filter
exponent of
denominator, unitless.
RTFN G3 Int Yes Tuning 1 PSS variable,
Constant ramp-tracking filter
exponent, unitless.
PST1 T5 Real Yes Tuning 0.1 PSS lead time constant
Constant in seconds.
PST2 T6 Real Yes Tuning 0.03 PSS lag time constant in
Constant seconds.
PST3 T7 Real Yes Tuning 0.09 PSS lead time constant
Constant in seconds.
PST4 T8 Real Yes Tuning 0.03 PSS lag time constant in
Constant seconds.
PST7 T9 Real Yes Tuning 5 PSS integrator time
Constant constant in seconds.
PEW1 X5 Byte Yes Tuning 1 PSS variable, washout
Constant filter 1 enable:
 0 = disable
 1 = enable
PEW2 X6 Byte Yes Tuning 1 PSS variable, washout
Constant filter 2 enable:
 0 = disable
 1 = enable
PEW3 X7 Byte Yes Tuning 1 PSS variable, washout
Constant filter 3 enable:
 0 = disable
 1 = enable
PEW4 X8 Byte Yes Tuning 0 PSS variable, washout
Constant filter 4 enable:
 0 = disable
 1 = enable
PSOE X9 Byte Yes Tuning 1 PSS variable, enables
Constant the stabilizer output:
 0 = disable
 1 = enable

254 OW360_R1100
 5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

AUX1 LC N/A No - - DXCSTATUS -

Auxiliary 1
AUX2 LC N/A No - - DXCSTATUS -
Auxiliary 2
AUX3 LC N/A No - - DXCSTATUS -
Auxiliary 3
AUX1: AN Char No - - -
AN
AUX2: AN Char No - - -
AN
AUX3: AN Char No - - -
AN
AUX1: R1 Real Yes Tuning 15 VHL integrator gain, in
VHLI Constant fractional percent of
terminal voltage / PT
VAC.
AUX1: R2 Real Yes Tuning 10 VHL controller
VHLP Constant proportional gain, in
fractional percent of
terminal voltage / (PT
VAC * sec).
AUX1: R3 Real Yes Tuning 0.05 PSS variable, stabilizer
PSVT Constant output maximum limit, in
per unit.
AUX1: R4 Real Yes Tuning -0.05 PSS variable, stabilizer
PSVB Constant output minimum limit, in
per unit*/.
AUX1: R5 Real Yes Tuning 0.45 Compensation reactance
PSXQ Constant for internal voltage
calculation, in per unit.
AUX1: R6 Real Yes Tuning 0.004 Maximum rate of change
SCLR Constant of the SCL output, in per
unit / sec.
AUX1: R7 Real Yes Tuning 1.0 Inner loop feedback gain,
KF2 Constant in per unit.
AUX1: R8 Real Yes Tuning 0.15 Difference limit alarm set
CTDL Constant point for a dual-CT
system, units of fractional
percentage.
AUX1: R9 Real Yes Config 1000 Machine current
CTR transformer ratio, in
AAC/AAC.

OW360_R1100 255
5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

AUX1: X0 Enum Yes Config 0 Selects the exciter type,

EXCT which selects the
appropriate control
algorithm:
 0 = BRUSHLESS
 1 = STATIC
AUX1: S1 Real Yes Config 0.052 PT loss-of-sensing
FAIT timeout before a failure
condition is declared, in
seconds.
AUX1: S2 Real Yes Config 0.1 PT loss-of-sensing
FAUT timeout before a fault
condition (for example,
three-phase short to
ground) is declared, in
seconds.
AUX1: S3 Real Yes Config 2 Field current transducer
FIXR ratio, converts the
transducer output to field
scaling, in ADC/VDC.
AUX1: S4 Real Yes Config 0.05 Field current difference
FIDF limit for disagreement
between transducers, in
fractional percent.
AUX1: S5 Real Yes Config 1.5 Maximum instantaneous
FIMX value of field current, in
fractional percent.
AUX1: S6 Real Yes Config 0 Minimum reasonable
FIMN field current for operating
generator, in ADC.
AUX1: S7 Real Yes Config 0.5 The amount of field
FION current required to be
online for detecting a
failed CT in one CT
system, in fractional
percent.
AUX1: S8 Real Yes Rating 1 Scale factor to convert
FIPU field current into per unit.
AUX1: S9 Real Yes Rating 7.1 Field current rating, in
FIRT ADC.
AUX1: T1 Real Yes Rating 85 Field voltage rating, in
FVRT volts DC.
AUX1: T2 Real Yes Config 40 Field voltage transducer
FVR ratio, converts the
transducer output to the
field scaling, in
VDC/VDC.

256 OW360_R1100
 5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

AUX1: X1 Byte Yes Config 0 Forcing + under-voltage

FUVE is an indicator of a blown
exciter diode - enable for
unit trip:
 0 = disabled
 1 = enabled
AUX1: T3 Real Yes Config 0.00298 Forcing derating scale
FITS factor from the C50.13
rotor current inverse time
curve, unitless.
AUX1: T4 Real Yes Config 1.03 Field forcing alarm set
FLIM point, in fraction percent
of field current.
AUX1: T5 Real Yes Config 1 Length of time forcing
FTMO before checking for an
under-voltage condition,
in seconds.
AUX1: T6 Real Yes Config 0.95 Under-voltage set point
FUV associated with forcing to
indicate an exciter
rectifier failure, in per unit
of terminal voltage.
AUX1: T7 Real Yes Rating 60 Rated frequency of
GFRT generator, in Hertz.
AUX1: T8 Real Yes Config 60 Specifies the exciter
EXSF frequency, used to select
field voltage filter
settings, in Hz.
AUX1: T9 Real Yes Rating 769.8 Generator stator current
GIRT rating, in AAC.
AUX1: U1 Real yes Rating 18.4 Generator apparent
GMVR power rating, in MVA.
AUX1: U2 Real Yes Config 0.7 Generator voltage must
GVIL go below this value to be
invalid - set lower than
GVVL, in per unit.
AUX1: U3 Real Yes Rating 13800 Generator terminal
GVRT voltage rating (line-line),
in VAC-RMS.
AUX1: V1 Real Yes Config 0.8 Generator voltage must
GVVL go above this value to be
valid - set higher than
GVIL, in per unit.
AUX1: V2 Real Yes Config 0 Set point for reactive
XCSP load compensation, in
per unit.

OW360_R1100 257
5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

AUX1: V3 Real Yes Config 0 Instantaneous limiting

UELI amount, in fractional
percent of terminal
voltage.
AUX1: X2 Byte Yes Config 1 Enables the MEL:
UELE  0 = uninstalled
 1 = installed
AUX1: V4 Real Yes Config 0.1 Size of hysteresis above
UELH MEL limit, in fractional
percent.
AUX1: V5 Real Yes Config 26.58 MEL curve circle radius
UELR for type 1 MEL algorithm,
in MVA.
AUX1: X3 Enum Yes Config 0 Selects type of MEL
UELT specification:
 0 = 5-point discrete
 1 = circular
AUX1: V6 Real Yes Config 0.9 How much the warning
UELW alarm is derated from the
limiting alarm, in
fractional percent.
AUX2: R1 Real Yes Config 0 MEL type 1 MW (X)
UELX offset for circle origin, in
MW.
AUX2: R2 Real Yes Config 26.58 MEL type 1 MVAR (Y)
UELY offset for circle origin, in
MVAR.
AUX2: X0 Byte Yes Config 0 Enables minimum
UEPE excitation protection:
 0 = uninstalled
 1 = installed
AUX2: R3 Real Yes Config 10 Minimum excitation
UEPO protection offset below
MEL curve, in VA.
AUX2: R4 Real Yes Config 2 Timeout before MEP to
UEPT trip the unit, in seconds.
AUX2: R5 Real Yes Config 8 Minimum excitation
UEPW protection warning offset
from MEP set point, in
MVAR.
AUX2: R6 Real Yes Config 0 The first point of the
MW1 linearized x-axis of the
discrete version of the
capability curve, in MW.
AUX2: R7 Real Yes Config 7.4 The second point of the
MW2 linearized x-axis of the
discrete version of the
capability curve, in MW.

258 OW360_R1100
 5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

AUX2: R8 Real Yes Config 11 The third point of the

MW3 linearized x-axis of the
discrete version of the
capability curve, in MW.
AUX2: R9 Real Yes Config 12.9 The fourth point of the
MW4 linearized x-axis of the
discrete version of the
capability curve, in MW.
AUX2: S1 Real Yes Config 18.4 The fifth point of the
MW5 linearized x-axis of the
discrete version of the
capability curve, in MW.
AUX2: S2 Real Yes Config 0.925 MXL total heat set point
OELC fraction to allow
ramp-down of field
current to limit, in
fractional percent.
AUX2: S3 Real Yes Config 0.99 MXL hysteresis set point,
OELH in fractional percent.
AUX2: S4 Real Yes Config 0.39 MXL current limit for
OELO offline operation, in
fractional percent of
rated current.
AUX2: S5 Real Yes Config 1.05 Maximum excitation
OELS limiter set point, in
fractional percent of
rated current.
AUX2: S6 Real Yes Config 0 Instantaneous limiting
OELI amount, in fractional
percent of terminal
voltage.
AUX2: X1 Byte Yes Config 1 Enables the maximum
OELE excitation limiter:
 0 = uninstalled
 1 = installed
AUX2: S7 Real Yes Config 0.7 MXL derating scale
OELF factor from the C50.13
rotor current inverse time
curve, unitless.
AUX2: S8 Real Yes Config 0.42 OXP current limit for
OEPO offline operation, in
fractional percent.
AUX2: S9 Real Yes Config 1.1 OXP field current set
OEPS point for online operation,
in fractional percent.
AUX2: X3 Byte Yes Config 1 Enables OXP:
OEPE  0 = disabled
 1 = enabled

OW360_R1100 259
5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

AUX2: T1 Real Yes Config 0.8 OXP derating scale

OEPF factor from the C50.13
rotor current inverse time
curve, unitless.
AUX2: T2 Real Yes Config 5 OXP regulator timeout, in
OEPT seconds.
AUX2: X4 Byte Yes Config 0 PSS variable, PSS
PSSE installation enable:
 0 = uninstalled
 1 = installed
AUX2: T3 Real Yes Config 0.08 PSS voltage limit OFF
PSVO set point - creates
hysteresis - symmetrical
around rated voltage, per
unit.
AUX2: T4 Real Yes Config 0.1 PSS voltage limit ON set
PSVN point - symmetrical
around rated voltage, per
unit.
AUX2: T5 Real Yes Config 0.025 The amount of
PTCL disagreement between
PT's to not be considered
uncalibrated, in fractional
percent.
AUX2: T6 Real Yes Config 5 Sets the timeout period
PTCT for being out of
calibration, in seconds.
AUX2: T7 Real Yes Config 0.035 The amount of
PTEL disagreement between
PT's to not be in error, in
fractional percent.
AUX2: T8 Real Yes Config 1 Sets the timeout period
PTET for being in error, in
seconds.
AUX2: T9 Real Yes Config 120 Ratio of potential
PTR transformers for the
phase voltages,
VAC/VAC.
AUX2: U1 Real Yes Config 600 Generator rotor current
RIXR transducer ratio, in
ADC/VDC.
AUX2: U2 Real Yes Rating 4396 Rated value of generator
RIRT rotor field current, in
ADC.
AUX2: U3 Real Yes Config 0.002 SCL error deadband, in
SCLD per unit of stator current.
AUX2: V1 Real Yes Config 0.99 SCL hysteresis set point,
SCLH in fractional percent.

260 OW360_R1100
 5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

AUX2: V2 Real Yes Config 1.5 Maximum instantaneous

SCLM value of stator current, in
fractional percent.
AUX2: V3 Real Yes Config 1 Stator current limiter set
SCLS point, in fractional
percent of rated stator
current.
AUX2: X5 Byte Yes Config 0 Stator current limiter
SCLE installed flag:
 0 = uninstalled,
 1 = installed
AUX2: V4 Real Yes Config 0.8 SCL derating scale factor
SCLF from the C50.13 stator
current inverse time
curve, unitless.
AUX2: V5 Real Yes Config -7.4 The first point of the
VAR1 linearized y-axis of the
discrete version of the
capability curve, in
MVAR.
AUX2: V6 Real Yes Config -4.4 The second point of the
VAR2 linearized y-axis of the
discrete version of the
capability curve, in
MVAR.
AUX3: R1 Real Yes Config -2.9 The third point of the
VAR3 linearized y-axis of the
discrete version of the
capability curve, in
MVAR.
AUX3: R2 Real Yes Config -2.4 The fourth point of the
VAR4 linearized y-axis of the
discrete version of the
capability curve, in
MVAR.
AUX3: R3 Real Yes Config 0 The fifth point of the
VAR5 linearized y-axis of the
discrete version of the
capability curve, in
MVAR.
AUX3: R4 Real Yes Config 1.05 VHL set point for the
VHLG generator, in fractional
percent.
AUX3: X0 Byte Yes Config 1 Enables the volts per
VHLE hertz limiter:
 0 = disable
 1 = enable

OW360_R1100 261
5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

AUX3: R5 Real Yes Config 0.99 VHL limit set point

VHLL hysteresis, in fractional
percent.
AUX3: R6 Real Yes Config 0.9933 VHL warning set point, in
VHLW fractional percent.
AUX3: R7 Real Yes Config 1.05 VHL set point for the
VHLX transformer, in fractional
percent.
AUX3: R8 Real Yes Config 1.1 VHP generator low limit
VPG1 set point (less
restrictive), in fractional
percent.
AUX3: R9 Real Yes Config 1.18 VHP generator high limit
VPG2 set point (more
restrictive), in fractional
percent.
AUX3: S1 Real Yes Config 0.995 Hysteresis point for VHP,
VPH in fractional percent.
AUX3: X1 Byte Yes Config 1 Enables volts per Hz
VPE protection:
 0 = disable
 1 = enable
AUX3: S2 Real Yes Config 3 Timeout between VHP
VPRT regulator trip and unit trip
outputs, in seconds.
AUX3: S3 Real Yes Config 45 VHP timing limit
VPT1 associated with the low
VHP set point (more
restrictive of VPG1 and
VPX1), in seconds.
AUX3: S4 Real Yes Config 6 VHP timing limit
VPT2 associated with the high
VHP set point (more
restrictive of VPG2 and
VPX2), in seconds.
AUX3: S5 Real Yes Config 1.1 VHP transformer low limit
VPX1 set point (less
restrictive), in fractional
percent.
AUX3: S6 Real Yes Config 1.18 VHP transformer high
VPX2 limit set point (more
restrictive), in fractional
percent.
AUX3: S7 Real Yes Rating 13800 Transformer voltage
XVRT rating, in VAC-RMS.
AUX3: U1 Real Yes Tuning 0.5 PSS variable, low-pass
PST8 Constant filter time constant, in
seconds.

262 OW360_R1100
 5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

AUX3: U2 Real Yes Tuning 0.1 PSS variable, low-pass

PST9 Constant filter time constant, in
seconds.
AUX3: U3 Real Yes Tuning 0.09 PSS variable, lead time
PSTA Constant constant, in seconds
AUX3: V1 Real Yes Tuning 0.03 PSS variable, lag time
PSTB Constant constant, in seconds.
AUX3: V2 Real Yes Tuning 0.05 Derivative time constant
TDR Constant for the AC controller, in
seconds.
AUX3: V3 Real Yes Tuning 5.0 PSS variable, washout
PTW1 Constant time constant 1, in
seconds.
AUX3: V4 Real Yes Tuning 5.0 PSS variable, washout
PTW2 Constant time constant 2, in
seconds.
AUX3: V5 Real Yes Tuning 5.0 PSS variable, washout
PTW3 Constant time constant 3, in
seconds.
AUX3: V6 Real Yes Tuning 5.0 PSS variable, washout
PTW4 Constant time constant 4, in
seconds.

Dual Input Parameters

The following table describes the DXCSTATUS algorithm’s dual input parameters.

Dual input parameters

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

P1AV V1 LA / Real No N/A 0.0 PTA calibration

voltage.
P1BV V2 LA / real No N/A 0.0 PTB calibration
voltage.
P1CV V3 LA / Real No N/A 0.0 PTC calibration
voltage.
P2AV U1 LA / Real No N/A 0.0 PT2 A calibration
voltage.
P2BV U2 LA / Real No N/A 0.0 PT2 B calibration
voltage.
P2CV U3 LA / Real No N/A 0.0 PT2 C calibration
voltage
CTAI U4 LA / Real No N/A 0.0 CTA calibration
current.

OW360_R1100 263
5.42 DXCSTATUS

NAME RECORD TYPE RECONCILE TUNING DEFAULT DESCRIPTION

FIELD RATING
CONFIG.

P1AV V1 LA / Real No N/A 0.0 PTA calibration

voltage.
CTBI U5 LA / Real No N/A 0.0 CTB calibration
current.
CTCI U6 LA / Real No N/A 0.0 CTC calibration
current.
READ Y0 LL / Byte No N/A 0 Instruct algorithm to
read and execute
ACMD. Set by
graphics, reset by
algorithm.

The following table describes the DXCSTATUS algorithm’s input parameters.

Inputs

NAME TYPE DESCRIPTION COMMENT

ACMD LP Algorithm command. Specifies command input to algorithm.

RDNT LL Redundant flag. Indicates whether redundant modules are present.
ENBL LL Enable Flag. Conditional to run algorithm or not

ACMD

The ACMD input bits are defined in the following table.

15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

Module Reserved PT2 PT1 CTs CMD

The module bits indicate which module (primary or backup) should receive the decoded
command. Since it is possible to send a message to both modules with the same command, the
encoding of bits 14 and 15 are as follows

ACMD Bits 14 and 15

FRC DESCRIPTION

00 This pattern is reserved.

01 The command should be sent to module1.
10 The command should be sent to module 2.
11 The command should be sent to modules 1 and 2.

264 OW360_R1100
 5.42 DXCSTATUS

If the command encoded in the CMD field is to force a particular module into control, bit pattern
11 for the module bits becomes an invalid pattern. If a command is being sent to module 2 and
the redundant flag for the algorithm is not set, the command is ignored.

RESERVED bits are reserved for future use. RESERVED bits must be set to zero or undefined
behavior may result.

Bits 4-6 identify which devices are being calibrated when a calibrate command is issued.

Bits 4-6 commands and descriptions

CMD DESCRIPTION

Bit 4 CTs
Bit 5 PT1
Bit 6 PT2

CMD provides commands which may affect the module or both modules in a redundant pair.

CMD commands and descriptions

CMD DESCRIPTION

0000 Null; no command.

0001 Upload tuning parameters (from controlling module).
0010 Download tuning parameters (to both modules in redundant pair).
0011 Trigger oscillography on controlling module.
0100 Read low calibration.
0101 Read high calibration.
0110 Calculate calibration coefficients.
0111 Cancel calibration.
1000 Transfer control of module as specified by module bits of ACMD.
1001 Commit calibration coefficients.

Outputs

The following table describes the DXCSTATUS algorithm output pin.

Output pins

NAME TYPE DESCRIPTION

ASTA1 LP Algorithm status for module 1.

ASTA2 LP Algorithm status for module 2.
STATE LA Algorithm internal state. See state
diagram.

OW360_R1100 265
5.42 DXCSTATUS

ASTA1, ASTA2
The following values are defined for the ASTA1 and ASTA2 outputs. ASTA1 refers to the primary
module, and ASTA2 refers to the partner module.

ASTA output bits

ASTA BIT MEANING

0x0 Null (ready for command).

0x1 Driver message sent.
0x2 Driver in progress.
0x3 Cannot connect to the driver.
0x4 Command timeout (no response from the driver).
0x5 Invalid command.
0x6 Invalid flags in Calibration command.
0x7 Invalid flags in Transfer Control command.
0x8 Invalid flags in Upload command.
0x9 Invalid flags in Download command.
0xA Invalid flags in Start Oscillography command.
0xB Command timeout (no response from module).
0xC Error reported from module (error code in field G8 or G9).
0xD Invalid address for module.
0xE Command completed successfully.
0xF Command cancelled.
0x10 Unknown status from driver.

266 OW360_R1100
 5.42 DXCSTATUS

5.42.1 DXCSTATUS tuning parameters and site ratings

Tuning parameters are module-shared memory variables that contain the gains, time constants,
and other tuning values, which configure the control loops on the module. Tuning parameters
consist of the following items:
 Control loop PID gains.
 Limiter PI gains.
 PSS time constants and gains.
Site ratings are module-shared memory variables that contain rated values, ratios, and functional
enable parameters that govern operation of the system and scaling of process parameters. Site
ratings consist of the following items:
 PT and CT ratios.
 Rated field current.
 Rated terminal voltage.
 Individual limiter and protective enable parameters.
The Ovation system maintains the module tuning parameters and site ratings in the LC records of
the DXCSTATUS algorithm. The Operator Station contains custom graphics that interact with the
DXCSTATUS algorithm to allow the tuning parameters to be transferred back and forth between
the LC record and the module. The tuning parameters are transferred on operator command from
the graphic; they do not update automatically when the values change on the graphic or module.

Note: Refer to Ovation Record Types Reference Manual for more information on LC record
fields.

Figure 17: DXCSTATUS Tuning Parameter processing

OW360_R1100 267
5.42 DXCSTATUS

Site ratings are typically entered using custom graphics during system configuration and may be
modified during testing. The site ratings must be downloaded to the module using the
DXCSTATUS algorithm after entry or modification. The site ratings should be reconciled with the
Ovation Database once they have been specified or modified.

Tuning parameters are typically modified by Emerson personnel during service or unit startup.
After the module has been properly tuned, the tuning parameters are uploaded from the module.
The updated tuning parameters are then reconciled with the Ovation Database.

The module tuning parameters and site ratings are stored locally in the module in the
installation.conf configuration file. This file is written upon downloading parameters to the
module from the DXCSTATUS algorithm. After uploading new tuning parameters, they must then
be downloaded back to the module(s) to force them to be written to the configuration file.

5.42.2 DXCSTATUS functions

The DXCStatus algorithm provides an interface to a standalone or redundant pair of modules

allowing functions on the module(s) to be accessed. The following functions are available:
 Module parameter upload/download.
 Reconcile algorithm parameters.

Note: Reconciling the algorithm parameters is an Ovation function and not truly a function of the
DXCSTATUS algorithm or the module.

 I/O calibration.
 Swap control between modules in a redundant pair.

Upload/Download function

The Upload/Download function retrieves tuning and site rating parameters from the module to the
algorithm (upload) and sends tuning and site rating parameters from the algorithm to the module
(download).

The Upload from Module function is invoked by setting the CMD field in the algorithm’s ACMD
input. The algorithm sends a request to the module communications driver, instructing the driver
to read the controlling module’s parameters. When the module responds, the driver updates the
algorithm LC record with the parameters and then sets the completion status parameter in the LC
record indicating that the upload is complete.

The Download to Module function is invoked by setting the CMD field in the algorithm’s ACMD
input. The algorithm sends a request to the module communications driver, instructing the driver
to send the parameters contained in the algorithm’s LC record to the module. The driver locates
the algorithm LC record using the SID that was passed in with the request. When the transfer
completes, the driver updates the status parameter in the LC record indicating that the download
is complete.

Note: Refer to Ovation Record Types Reference Manual for more information on LC record
fields.

268 OW360_R1100
 5.42 DXCSTATUS

I/O Calibration function

All module I/O is calibrated during factory testing, but because CT and PT panels are not
assigned to a module until that module is used in a system, field calibration may be necessary.

The DXCSTATUS algorithm coordinates field calibration of the module PT and CT inputs. Other
I/O cannot be calibrated in the field.

All CTs are calibrated as a group. Each set of PTs is calibrated independently; the PTs within a
set are calibrated as a group. The devices being calibrated are identified by bits 4 - 6 in the
algorithm command word. If a bit is non-zero, then that set of devices (CTs, PT1, PT2) is
affected by the calibration command.

Five commands support calibration:

 Read Low Cal -- transfers the calibration values (algorithm dual input parameters) to the
module and instructs the module to read the low calibration input(s).
 Read High Cal -- transfers the calibration values (algorithm dual input parameters) to the
module and instructs the module to read the high calibration input(s).
 Calculate Calibration Coefficients -- tells the module to calculate the new calibration
settings.
 Commit Calibration Coefficients -- tells the module to save the new calibration coefficients
to a file.
 Cancel calibration -- instructs the module to revert all calibrations to their previous values as
long as they have not been committed.
It is possible to calibrate all inputs simultaneously by applying appropriate signals to each input
and selecting all calibration devices with bits 4 - 6. Once new coefficients have been calculated,
they take immediate effect. Subsequent measurements will demonstrate the efficacy of the new
calibration. To make the new coefficients permanent, they must be committed to a file. If the new
calibration is unsatisfactory, the Cancel Calibration command will undo the change as long as it
has not been committed.

Transfer Control function

The Transfer Control function transfers control from the controlling module to the non-controlling
module. This supports the ability to force a particular module to control in order to perform
maintenance on the other module.

Note: The Transfer Control function is designed for maintenance purposes only and should
never be used during normal operation of the system.

OW360_R1100 269
5.42 DXCSTATUS

5.42.3 DXCSTATUS state

The following figure shows the DXCSTATUS algorithm state diagram. The state diagram
indicates the control flow between states and the values for each state.

270 OW360_R1100
 5.42 DXCSTATUS

State value and name

STATE VALUE STATE NAM E

0 RESET
1 READY
2 STARTING COMMAND (UPLOAD)
3 WAITING FOR COMMAND (UPLOAD)
4 FINISHING COMMAND (UPLOAD)
5 STARTING COMMAND (DOWNLOAD)
6 WAITING FOR COMMAND (DOWNLOAD)
7 FINISHING COMMAND (DOWNLOAD)
8 STARTING COMMAND (OSCILLOGRAPHY)
9 WAITING FOR COMMAND (OSCILLOGRAPHY)
10 FINISHING COMMAND (OSCILLOGRAPHY)
11 STARTING COMMAND (READ LOW CAL)
12 WAITING FOR COMMAND (READ LOW CAL)
13 FINISHING COMMAND (READ LOW CAL)
14 STARTING COMMAND (READ HIGH CAL)
15 WAITING FOR COMMAND (READ HIGH CAL)
16 FINISHING COMMAND (READ HIGH CAL)
17 STARTING COMMAND (CALC CAL)
18 WAITING FOR COMMAND (CALC CAL)
19 FINISHING COMMAND (CALC CAL)
20 STARTING COMMAND (CANCEL CAL)
21 WAITING FOR COMMAND (CANCEL CAL)
22 FINISHING COMMAND (CANCEL CAL)
23 STARTING COMMAND (TRANSFER CONTROL)
24 WAITING FOR COMMAND (TRANSFER CONTROL)
25 FINISHING COMMAND (TRANSFER CONTROL)
26 STARTING COMMAND (COMMIT CAL)
27 WAITING FOR COMMAND (COMMIT CAL)
28 FINISHING COMMAND (COMMIT CAL)
29 START ERROR
30 DELAY ERROR
31 DONE ERROR

OW360_R1100 271
5.43 DROPSTATUS

5.43 DROPSTATUS
Description

The DROPSTATUS algorithm accesses and outputs the contents of any record field in the Drop
Status Record (DU) for a particular Controller. To access the contents of a record field, the field
number must be specified. If an invalid field number is entered, zero is written to the AOUT and
POUT output points.

The data in the DU record field is output as a packed point. If specified, the contents of the record
field can also be output as an analog value. (Refer to the Ovation Record Types Reference
Manual.)

Note: For Ovation 3.2 systems and later, the DROPSTATUS algorithm will allow any DU record
to be used as an input into the drop status.

Functional symbol

Field numbers and names

FIELD NUMBER FIELD NAME

1 FA

2 FB

3 FC

4 FK

5 FS

6 FO

7 HC

8 TA

9 CT

10 RT

11 LN

12 E5

13 E6

14 GD

15 GL

16 GI

272 OW360_R1100
 5.43 DROPSTATUS

FIELD NUMBER FIELD NAME

17 GG

18 GH

19 NC

20 FF

21 JU

22 U4

23 U5

24 U6

25 U7

26 KM

27 VE

28 K0

29 K1

30 TR

31 NE

32 IS

33 IE

34 OP

35 OE

36 FG

37 FH

38 FI

39 ES

40 ET

41 NG

42 CK

OW360_R1100 273
5.43 DROPSTATUS

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

RECD G0 - Data Init. Required 0 The field number -

Integer in the drop
record.
AOUT - Variable Optional - Output (analog); LA
contents of the
DU record field.
POUT - Variable Required - Output (packed); LP
contents of the
DU record field.
DUID - Variable Optional - Input DU record DU

274 OW360_R1100
 5.44 ELCCONTROL

5.44 ELCCONTROL

Description

The ELCCONTROL algorithm allows control logic to select which ELC module, of a redundant
pair, is in control. The algorithm will have the setting of the module address in the LC record, and
this address will not be tunable.

Note: It is the engineer's responsibility to make sure that the initial state of the ELC module is
the same as what is on the control sheets (logic).

Functional symbol

Input Select parameters

The Select parameter is a digital input that can be used to switch which ELC is in control.

Note: The 0 or 1 Select parameter value does not indicate which ELC is in control. The
ELCCONTROL algorithm performs only when the value changes.

Value

VALUE DESCRIPTION

0 A transition from 0 to 1 puts the Secondary ELC into control.

1 A transition from 1 to 0 puts the Primary ELC into control.

If the quality of the Select input is BAD, no change is made to the ELC module.

OW360_R1100 275
5.44 ELCCONTROL

Setting the ELC module address in the LC record

The address identifies the ELC that is being controlled. It consists of four parts kept in the LC
record.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

SUBSYSTEM R1-Real Data Init. Optional - Not used. -

Subsystem
address.
NODE R2-Real Data Init. Required 1-8 Node address. -
Accepts integer
from range 1-8.
BRANCH R3-Real Data Init. Required 1-8 Branch -
address.
Accepts integer
from range 1-8.
SLOT R4-Real Data Init. Required 1-8 Slot address. -
Accepts integer
from range 1-8.

SELECT - Variable Required 0 Input boolean LD

pin. The default
value is 0.

STATUS - Variable Optional - Output boolean LD

pin.

Note: The algorithm record fields R1-R4 are not tunable.

276 OW360_R1100
 5.44 ELCCONTROL

LC record, First pass startup options

On a first pass, the ELCCONTROL algorithm will not perform a switchover, but the algorithm will
remember the state of the active device. The state of the first pass and of the ELC module
currently in control will be stored in the LC record.

X1 - Bit LC record. Two bits are used:

Bits

BIT DEFINITION

0  0 - First module is active

 1 - Second module is active.
1  0 - First pass was not done.
 1 - First pass was done.

Output Status parameter

The Status parameter is a digital type parameter and gives the algorithm execution feedback.

STATUS - This parameter helps troubleshoot algorithm issues.

Status

STATUS DESCRIPTION

1 GOOD Normal operation.

1 BAD Digital input Select has BAD quality.

0 GOOD One of the address records is incorrect or the output scan is OFF.

0 BAD Module is not responding.

OW360_R1100 277
5.45 FACEPLATE

5.45 FACEPLATE
Description

The FACEPLATE algorithm is a generic algorithm used to collect all inputs necessary for a
graphic faceplate. Its purpose is to reduce the amount of data needed by the graphic designer
when adding faceplates to a process diagram or window.

You need to pass only the name of the FACEPLATE algorithm to a graphic macro. The graphic
macro then retrieves all relevant input signals from the FACEPLATE algorithm and displays the
data accordingly.

The FACEPLATE algorithm sequences through all arguments and checks for a connection. It
then stores the system IDs for those connected points in the appropriate record fields of the
FACEPLATE algorithm.

The algorithm can have a maximum of two control algorithm points and up to 30 input points,
which can be analog, digital, or packed.

In addition to the generic template, two other templates exist for this algorithm.
 DIGITAL DEVICE template (see page 282).
 MASTATION template (see page 285).

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TYPE X1 - Byte Data Init Required 0 Faceplate type --

WIN XU - Data Init Required 0 Default window --

Integer number
MAC XR - Data Init Required 0 Default macro --
Integer number
TTL1 TT - ASCII Data Init Optional TITLE Title --

ALG1 G0 Variable Required -- Control LC

algorithm #1

278 OW360_R1100
 5.45 FACEPLATE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

ALG2 G1 Variable Optional -- Control LC

algorithm #2
PM1 B0 Variable Optional -- Input #1. Could LA, LD, LP
be analog,
digital, or
packed.
PM2 B1 Variable Optional -- Input #2. Could LA, LD, LP
be analog,
digital, or
packed.
PM3 B2 Variable Optional -- Input #3. Could LA, LD, LP
be analog,
digital, or
packed.
PM4 YU Variable Optional -- Input #4. Could LA, LD, LP
be analog,
digital, or
packed.
PM5 B4 Variable Optional -- Input #5. Could LA, LD, LP
be analog,
digital, or
packed.
PM6 B5 Variable Optional -- Input #6. Could LA, LD, LP
be analog,
digital, or
packed.
PM7 B6 Variable Optional -- Input #7. Could LA, LD, LP
be analog,
digital, or
packed.
PM8 B7 Variable Optional -- Input #8. Could LA, LD, LP
be analog,
digital, or
packed.
PM9 B8 Variable Optional -- Input #9. Could LA, LD, LP
be analog,
digital, or
packed.
PM10 B9 Variable Optional -- Input #10. LA, LD, LP
Could be
analog, digital,
or packed.
PM11 C0 Variable Optional -- Input #11. LA, LD, LP
Could be
analog, digital,
or packed.
PM12 C1 Variable Optional -- Input #12. LA, LD, LP
Could be
analog, digital,
or packed.

OW360_R1100 279
5.45 FACEPLATE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

PM13 C2 Variable Optional -- Input #13. LA, LD, LP

Could be
analog, digital,
or packed.
PM14 C3 Variable Optional -- Input #14. LA, LD, LP
Could be
analog, digital,
or packed.
PM15 C4 Variable Optional -- Input #15. LA, LD, LP
Could be
analog, digital,
or packed.
PM16 C5 Variable Optional -- Input #16. LA, LD, LP
Could be
analog, digital,
or packed.
PM17 C6 Variable Optional -- Input #17. LA, LD, LP
Could be
analog, digital,
or packed.
PM18 C7 Variable Optional -- Input #18. LA, LD, LP
Could be
analog, digital,
or packed.
PM19 C8 Variable Optional -- Input #19. LA, LD, LP
Could be
analog, digital,
or packed.
PM20 YT Variable Optional -- Input #20. LA, LD, LP
Could be
analog, digital,
or packed.
PM21 D0 Variable Optional -- Input #21. LA, LD, LP
Could be
analog, digital,
or packed.
PM22 YQ Variable Optional -- Input #22. LA, LD, LP
Could be
analog, digital,
or packed.
PM23 D2 Variable Optional -- Input #23. LA, LD, LP
Could be
analog, digital,
or packed.
PM24 YP Variable Optional -- Input #24. LA, LD, LP
Could be
analog, digital,
or packed.

280 OW360_R1100
 5.45 FACEPLATE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

PM25 D4 Variable Optional -- Input #25. LA, LD, LP

Could be
analog, digital,
or packed.
PM26 D5 Variable Optional -- Input #26. LA, LD, LP
Could be
analog, digital,
or packed.
PM27 D6 Variable Optional -- Input #27. LA, LD, LP
Could be
analog, digital,
or packed.
PM28 YN Variable Optional -- Input #28. LA, LD, LP
Could be
analog, digital,
or packed.
PM29 D8 Variable Optional -- Input #29. LA, LD, LP
Could be
analog, digital,
or packed.
PM30 D9 Variable Optional -- Input #30. LA, LD, LP
Could be
analog, digital,
or packed.

OW360_R1100 281
5.45 FACEPLATE

5.45.1 FACEPLATE -- DIGITAL DEVICE template

Description

This template should be used with the DIGITAL DEVICE algorithm. The following symbols show
an example of how this template could be used.

Note: Default symbols are not available for this template. Users are responsible for generating
their own symbols since the interface is defined within the individual graphics macros.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TYPE X1 - Byte Data Init Required 2 Faceplate type --

WIN XU - Data Init Required 9100 Default window --

Integer number
MAC XR - Data Init Required 9100 Default macro --
Integer number
CNTL X2 - Byte Data Init Required 0 Type of control to --
be implemented:
 Start/Stop
Normally Open
Contact
 Start/Stop
Normally Closed
Contact
 Open/Closed
Normally Open
Contact
 Open/Closed
Normally Closed
Contact

282 OW360_R1100
 5.45 FACEPLATE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

FBI X3 - Byte Data Init Required 1 Analog feedback for --

travel:
YES: Use feedback
NO: Do not use
feedback
TTL1 TT - ASCII Data Init Optional TITLE Title --

ALG1 G0 Variable Required -- Control algorithm LC

#1
ALG2 G1 Variable Optional -- Control algorithm LC
#2
TVST B0 Variable Optional -- Analog travel LA
feedback status.
PK12 B1 Variable Optional -- Feedback for P-key LA
1 and 2 -- 1-3
Element
PK3 B2 Variable Optional -- Feedback for P-key LA
3 - Auto
IND C0 Variable Optional -- 1-3 Element LD
indication
DEV1 D0 Variable Optional -- Device LP point LP
name for feedback

Example Using the Digital Device template

For the digital faceplate values to be displayed in a graphic using the FACEPLATE algorithm, use
the following example to place code in the main screen diagram.

In the DIAGRAM section (OCB010F001 will be replaced by the name of your faceplate):

******** Start Process Point Mapping of Digital Faceplate Algorithm

*********

*** Digital Faceplate Algorithm Name = OCB010F001

* Analog feedback for Travel Status

DEF_VARIABLE LOCAL TVST SYSID

SET_VARIABLE l:TVST OCB010F001 B0

* Feedback for P-KEY 1&2 - 1-3 Element

DEF_VARIABLE LOCAL PK12 SYSID

SET_VARIABLE l:PK12 OCB010F001 B1

OW360_R1100 283
5.45 FACEPLATE

* Feedback for P-KEY 3 - AUTO

DEF_VARIABLE LOCAL PK3 SYSID

SET_VARIABLE l:PK3 OCB010F001 B2

* 1-3 Element Indication

DEF_VARIABLE LOCAL IND SYSID

SET_VARIABLE l:IND OCB010F001 C0

* Device LP Point Name for Feedback

DEF_VARIABLE LOCAL DEV1 SYSID

SET_VARIABLE l:DEV1 OCB010F001 D0

In the BACKGROUND section (Optional):

TEXT 7346 1996 "TVST B0" HORZ VECTOR_OVER 108 351 1

TEXT 7345 2525 "PK12 B1" HORZ VECTOR_OVER 108 351 1

TEXT 7330 3031 "PK3 B2" HORZ VECTOR_OVER 108 351 1

TEXT 7329 3647 "IND C0" HORZ VECTOR_OVER 108 351 1

TEXT 7342 4198 "DEV1 D0" HORZ VECTOR_OVER 108 351 1

In the FOREGROUND section (to display specific values of the record field of the Faceplate
algorithm):

PROCESS_PT 5506 2017 15 -1 RIGHT OFF HORZ VECTOR_OVER 108

351 1 L:TVST AV

PROCESS_PT 5520 2543 15 -1 RIGHT OFF HORZ VECTOR_OVER 108

351 1 L:PK12 AV

PROCESS_PT 5521 3069 15 -1 RIGHT OFF HORZ VECTOR_OVER 108

351 1 L:PK3 AV

PROCESS_PT 5521 3661 15 -1 RIGHT OFF HORZ VECTOR_OVER 108

351 1 L:IND DS

PROCESS_PT 5535 4231 15 -1 HEX OFF HORZ VECTOR_OVER 108 351 1

L:DEV1 A2

284 OW360_R1100
 5.45 FACEPLATE

To call the faceplate Macro (49100 in this case) using the one $D1 point - the LC faceplate
algorithm name.

Macro 49100 55 8201 0.318631 0.489620 1 0 3 1 3 0

\OCB010F001.UNIT0@FE222\

"Digital Faceplate Alg." "FE222-Drop 14 - Using Macro 49100"

"OCB010F001"

28 28 2 3 0 0

Refer to Ovation Graphics Language Reference Manual for more information on graphic
commands.

5.45.2 FACEPLATE -- MASTATION template

Description

This template should be used with the MASTATION algorithm. The following symbols show an
example of how this template could be used.

Note: Default symbols are not available for this template. Users are responsible for generating
their own symbols since the interface is defined within the individual graphics macros.

OW360_R1100 285
5.45 FACEPLATE

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TYPE X1 - Byte Data Init Required 1 Faceplate type --

WIN XU - Integer Data Init Required 9000 Default window --

number
MAC XR - Integer Data Init Required 9000 Default macro --
number
TTL1 TT - ASCII Data Init Optional TITLE Title --
ALG1 G0 Variable Required -- Control algorithm LC
#1
ALG2 G1 Variable Optional -- Control algorithm LC
#2
PV B0 Variable Optional -- Process variable LA

DEMD B1 Variable Optional -- Demand LA

BIAS B2 Variable Optional -- Bias LA

STPT YU Variable Optional -- Setpoint LA

OUT B4 Variable Optional -- Output LA

SMOD B5 Variable Optional -- Mode word for LA

setpoint
IND C0 Variable Optional -- 1 - 3 element LD
indication
MODE D0 Variable Optional -- Input mode point LP

286 OW360_R1100
 5.46 FIELD

5.46 FIELD
Description

The FIELD algorithm is used only with the hardware analog output variable points. This algorithm
checks the value against the IO card limits and sets the appropriate bits in the track output point.
It should be used instead of “output analog hardware” I/O connectors in applications involving
interfaces to control elements (for example, valves and dampers).

The output digital point (FAIL) is TRUE when the algorithm detects a hardware error on the I/O
card. This algorithm is designed to read the value from the point record and output value TOUT
on the first pass.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU Data Required - Tuning -

Init. Diagram
Number
IN1 - Variable Required - Input (analog) LA

TOUT - Variable Required - Track Output LA

Value Mode
and Status For
Input Variable
(analog)

HWPT1 - Variable Optional - Hardware LA

Output (analog)
FAIL - Variable Optional - Hardware Error LD, LP
Point (digital)
1 You cannot scan remove the HWPT point.

OW360_R1100 287
5.46 FIELD

Tracking Signals

The high and low limits flags and tracking signals from the algorithm are output to TOUT, to be
used for display and by an upstream algorithm.

The following information is output by this algorithm in the TOUT signal.

Bits description

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented TRUE when output value is at low

limit of the card

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit Implemented TRUE when output value is at the

low limit of the card**

20 Raise inhibit Implemented TRUE when output value is at high

limit of the card**

21 Conditional Track No action Not used

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Supervisory mode No action Not used

28 Cascade mode No action Not used

29 DDC mode No action Not used

30 Low limit reached Implemented Low limit reached

31 High limit reached Implemented High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the
definitions given in Setting Tracking Signals (see page 17).

288 OW360_R1100
 5.47 FIFO

5.47 FIFO
Description

The FIFO algorithm provides a basic First In - First Out operation. The order in which any of the
16 digital inputs transition from FALSE to TRUE is preserved. The order is stored using the input
number of the associated input (that is, 1 for IN1, 2 for IN2, 3 for IN3, and so forth).

Initially, the value of the output is zero. If the FIFO is empty, the output is also zero. For each
successive FALSE to TRUE Transition of the rotate (RTAT) input, the oldest input number stored
in the FIFO is removed from internal storage and that numerical value is written to the output
(OUT). Note that the output is considered separate from the actual FIFO.

The point retains the value until either the rotate (RTAT) or the clear (CLR) input transitions from
FALSE to TRUE. A FALSE to TRUE transition on the (RTAT) input causes the oldest entry in the
FIFO to be removed from the FIFO and placed in the output (OUT). At this point, the value in the
(OUT) variable is no longer included in the queue.

If multiple inputs transition from FALSE to TRUE on the same execution cycle of the Controller,
then they are ordered according to their numerical number. For example, IN1 is placed in the
FIFO first and thus is rotated out first.

A FALSE to TRUE transition on the clear (CLR) input causes the output and all the internal FIFO
entries to be set to zero. As long as the clear (CLR) input remains TRUE, the algorithm ignores all
the inputs and thus does not operate.

The FIFO is considered full when all 16 inputs have made a transition from FALSE to TRUE
without any subsequent FALSE to TRUE transition on the rotate (RTAT) input. When this full
condition exists, any further FALSE to TRUE transitions of any of the inputs are ignored until at
least one of the stored values is rotated out of the FIFO.

The FLAG output is set TRUE when the FIFO is NOT empty.

Note: The FIFO values are stored in the algorithm record fields G0-G9, B0-B5.

Functional symbol

OW360_R1100 289
5.47 FIFO

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Digital Input LD

IN2 - Variable Optional - Digital Input LD

IN3 - Variable Optional - Digital Input LD

IN4 - Variable Optional - Digital Input LD

IN5 - Variable Optional - Digital Input LD

IN6 - Variable Optional - Digital Input LD

IN7 - Variable Optional - Digital Input LD

IN8 - Variable Optional - Digital Input LD

IN9 - Variable Optional - Digital Input LD

IN10 - Variable Optional - Digital Input LD

IN11 - Variable Optional - Digital Input LD

IN12 - Variable Optional - Digital Input LD

IN13 - Variable Optional - Digital Input LD

IN14 - Variable Optional - Digital Input LD

IN15 - Variable Optional - Digital Input LD

IN16 - Variable Optional - Digital Input LD

RTAT - Variable Required - Digital Rotate LD

FIFO Input
CLR - Variable Required - Digital Clear LD
FIFO Input
OUT - Variable Required - Analog output LA
variable
FLAG - Variable Optional - Digital output LD
variable

290 OW360_R1100
 5.48 FIRSTOUT

5.48 FIRSTOUT
Description

The FIRSTOUT algorithm monitors up to 16 digital inputs and provides an indication of the first
digital input to transition from zero to one. The algorithm output is a packed group point whose 16
bits correspond to each of the 16 digital inputs. If more than 16 inputs need to be monitored,
multiple algorithms can be cascaded together. The resolution of the algorithm is equal to the
period of the control task in which it executes.

Note: The quality values of the digital inputs are not propagated to the digital outputs.

Functional symbol

Algorithm States

The FIRSTOUT algorithm operates in three states: armed, tripped and disabled.

In the disabled state, the algorithm does not operate. In the armed state, the algorithm monitors
the digital value of all connected inputs (IN1-IN16). If any of the inputs transition from a zero to a
one, the algorithm enters the tripped state.

When RST input is set to zero, the algorithm is in the disabled state. A zero to one transition on
the RST input sets the algorithm to the armed state. When this transition occurs, any inputs
(IN1-IN16) that are a one are ignored. Thus, it is not necessary to ensure that all inputs are a zero
when the algorithm is armed.

OW360_R1100 291
5.48 FIRSTOUT

The current state of the algorithm is indicated in two ways: the X1 field of the algorithm LC record
and the STATE output. The following table shows the states and the indications.

States

STATE X1 FIELD S T AT E O U T P U T

Armed or Disabled 0 0

Tripped 1 1

Once the algorithm enters the tripped state it remains in that state. The RST input must be set to
zero to enter the disabled state, and then set to a one in order to enter the armed state again.

Controlled Algorithm Execution

The FIRSTOUT algorithm can be selectively executed by using the reset (RST) input. The RST
input must be set to a one for the algorithm to operate. If the RST input is set to a zero, the
algorithm is disabled and the algorithm is not executed in each loop that the RST is set to zero.

Trip Reporting

Each of the 16 bits in the monitor (MNTR) output corresponds to the IN1 - IN16 inputs. Bit zero
corresponds to IN1, bit one corresponds to IN2, and so forth. When the algorithm is operating in
the armed state, all bits in the MNTR points are set to zero. If any of the inputs (IN1 - IN16)
transition to a one, the corresponding bit in the MNTR packed point output is set to one.

If multiple inputs transition to one on the same execution cycle, the algorithm can be configured to
report which input(s) caused the change. This can be done in one of two ways. First, the default is
for all inputs that transitioned to be reported in the MNTR output. Optionally, only the input with
the lowest input number can be reported in the MNTR output. Note that the MULT output point is
set to one when either of these conditions occur. The desired configuration is specified using the
MCFG (X2) field in the algorithm LC record.

The number of inputs that transitioned from zero to one is reported in the optional analog output
NTRP. During operation in armed mode, the NTRP output is set to zero.

Dependencies among RST, IN1-IN16 inputs, and TRPD output are shown on the following timing
diagram.

1
RST 0

IN1 1
0

IN2 1
0

TRPD 1
0

292 OW360_R1100
 5.48 FIRSTOUT

Cascading Multiple Algorithms

If it is necessary to monitor more than 16 digital inputs, multiple FIRSTOUT algorithms can be
cascaded together. The TRPD output of each algorithm is connected to one of the inputs (IN1 -
IN6) of the subsequent algorithm.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU -Integer Data Init Optional - Tuning diagram -

number

MCFG X2 - Byte Data Init Required 0 This field controls -

how the algorithm
reports multiple
inputs transitioning
in the same loop
time. The values
are:
 0 = Report all
inputs that
transitioned
 1 = Report only
the input with the
lowest input pin
number
IN1 Input Variable Optional - Input 1 LD, LP

IN2 Input Variable Optional - Input 2 LD, LP

IN3 Input Variable Optional - Input 3 LD, LP

IN4 Input Variable Optional - Input 4 LD, LP

IN5 Input Variable Optional - Input 5 LD, LP

IN6 Input Variable Optional - Input 6 LD, LP

IN7 Input Variable Optional - Input 7 LD, LP

IN8 Input Variable Optional - Input 8 LD, LP

IN9 Input Variable Optional - Input 9 LD, LP

IN10 Input Variable Optional - Input 10 LD, LP

IN11 Input Variable Optional - Input 11 LD, LP

IN12 Input Variable Optional - Input 12 LD, LP

IN13 Input Variable Optional - Input 13 LD, LP

IN14 Input Variable Optional - Input 14 LD, LP

IN15 Input Variable Optional - Input 15 LD, LP

OW360_R1100 293
5.48 FIRSTOUT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

IN16 Input Variable Optional - Input 16 LD, LP

RST Input Variable Required - Reset input. A zero LD, LP

on this input
causes the
algorithm to enter
disabled mode. A
value of one
causes the
algorithm to enter
armed mode.
MNTR Output Variable Required - Each bit 1 - 16 of LP
this point
corresponds to IN1
- IN16 respectively.
When in the armed
state, all 16 bits
are set to zero.
When in the
tripped state, the
bit that
corresponds to the
first input to
transition to a one
is set.
MULT Output Variable Optional - This output is LD, LP
always set to zero
when the algorithm
is operating in the
armed mode. If
more than one of
the inputs
transition to one,
this output is set to
one. Note that
when this condition
occurs, the bit that
corresponds to the
lowest numbered
input that triggered
the trip condition is
set in the MNTR
point.
TRPD Output Variable Required - This output is set LD, LP
to one when the
algorithm is
operating in the
tripped state. It is
set to zero if the
algorithm is
operating in the
armed state.

294 OW360_R1100
 5.48 FIRSTOUT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

NTRP Output Variable Required - In the tripped state, LA

this output is equal
to the number of
inputs that
transitioned from
zero to one in the
execution cycle in
which the
algorithm
transitioned to the
tripped state. This
output is always
set to zero when
the algorithm is
operating in the
armed state.

OW360_R1100 295
5.49 FLIPFLOP

5.49 FLIPFLOP
Description

The FLIPFLOP algorithm is a memory device. Its output states are defined in the Function for
Reset Override and Function for Set Override Truth tables.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN. POINT

RECORD OPTIONAL VALUE RECORD
FIELD

TYPE X1-Byte Data Init. Required 0 Type of flip-flop: -

 1 = Flip-flop with
set override
 0 = Flip-flop with
reset override
SET - Variable Required - Input (digital); set LD, LP

RSET - Variable Required - Input (digital); LD, LP

reset
OUT - Variable Required - Output (digital) LD, LP

Function for Reset Override

Functions

SET RESET OUT

0 0 S

0 1 0

1 0 1

1 1 0

where:

S = Output remains in the same or previous state.

296 OW360_R1100
 5.49 FLIPFLOP

On power up/reset of the Controller, OUT is set according to the truth table, unless SET and
RSET are both FALSE.

Function for Set Override

Functions

SET RESET OUT

0 0 S

0 1 0

1 0 1

1 1 1

where:

S = Output remains in the same or previous state.

On power up/reset of the Controller, OUT is set according to the truth table, unless SET is set
FALSE.

OW360_R1100 297
5.50 FUNCTION

5.50 FUNCTION
Description

The FUNCTION algorithm generates a piecewise-linear function that is determined by elements

of a 12-element X-Y breakpoint array. Each Y-array element (dependent variable) has a
respective X-array element (independent variable), thereby portraying the desired function. The
number of breakpoints specifies the size of the array.

If the input value is invalid or less than the smallest element in the X-array, the output assumes
the value of the corresponding Y-array element. Also, if the input value is greater than the largest
X-array element, the output assumes the value of the corresponding Y-array element. If there is
more than one output value (Y-array) for a particular input value (X-array), the output is the first
element of the Y-array encountered.

The TPSC and BTSC algorithm definitions must match the highest and lowest Y-array values of
the function defined in order for tracking to be properly implemented. If the limits are different, the
algorithm tracks to the value. But upon releasing, it bumps back to the calculated output value.

Functional symbol

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog point. This algorithm takes the following action in response to the information found
in the input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit No action Passed through**

20 Raise inhibit No action Passed through**

21 Conditional Track Implemented Passed through***

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

298 OW360_R1100
 5.50 FUNCTION

BIT DESCRIPTION ACTION TOUT SIGNAL

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set
according to the
definitions given in Setting Tracking Signals (see page 17).
*** If the algorithm is being told to track, then the Conditional track bit is
ignored.
Otherwise, the value of the conditional track bit is transferred to all output
track points.
If the Conditional Track bit is set in the track input point, the analog value
of all output
track points is calculated based on the analog value of the track input
point.

The high and low limit flags and the tracking signals from the algorithm are output to TOUT, to be
used for display and by an upstream algorithm. If the output value is invalid, the quality of OUT is
set to BAD. Otherwise, the quality of OUT is set to the quality of the input when not in tracking
mode. When tracking, the quality is set to the quality of the track input variable.

When the FUNCTION algorithm is tracking, it forces the upstream algorithm to track to the
X-array value associated with the Y-array value to which the FUNCTION is told to track. However,
if there is more than one X-array value associated with the specified Y-array value, the
FUNCTION algorithm forces the upstream algorithm to track to the first X-array value
encountered.

Note: If the algorithm generates an invalid track output value, the input value is used as the
track output, unless it is invalid. The track output value is not updated if both the calculated track
output and input values are invalid.

OW360_R1100 299
5.50 FUNCTION

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init Required 105 Tuning Diagram -

Number
GAIN T7-Real Tuning Constant Required 1.0 Gain on the -
input. The gain
on the input
should never be
initialized to
zero; if it is, the
drop is placed
into alarm.
BIAS T8-Real Tuning Constant Required 0.0 Bias on the -
input

TPSC T9-Real Tuning Constant Required 100.0 Maximum value -

of the output
point
BTSC U1-Real Tuning Constant Required 0.0 Minimum value -
of the output
point
TRAT U2-Real Tuning Constant Required 2.5 Track ramp rate -
(units per
second).
BPTS X1-Byte Tuning Constant Required 2.0 Number of -
break points
(number of (x, y)
coordinate
pairs)
X- 1 R1-Real Tuning Constant Required - 100.0 X-coordinate 1 -
Y- 1 S4-Real Tuning Constant Required - 100.0 Y-coordinate 1 -
X- 2 R2-Real Tuning Constant Required 100.0 X-coordinate 2 -
Y- 2 S5-Real Tuning Constant Required 100.0 Y-coordinate 2 -
X- 3 R3-Real Tuning Constant Optional 0.0 X-coordinate 3 -
Y- 3 S6-Real Tuning Constant Optional 0.0 Y-coordinate 3 -
X- 4 R4-Real Tuning Constant Optional 0.0 X-coordinate 4 -
Y- 4 S7-Real Tuning Constant Optional 0.0 Y-coordinate 4 -
X- 5 R5-Real Tuning Constant Optional 0.0 X-coordinate 5 -
Y- 5 S8-Real Tuning Constant Optional 0.0 Y-coordinate 5 -
X- 6 R6-Real Tuning Constant Optional 0.0 X-coordinate 6 -

Y- 6 S9-Real Tuning Constant Optional 0.0 Y-coordinate 6 -

X- 7 R7-Real Tuning Constant Optional 0.0 X-coordinate 7 -
Y- 7 T1-Real Tuning Constant Optional 0.0 Y-coordinate 7 -

300 OW360_R1100
 5.50 FUNCTION

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

X- 8 R8-Real Tuning Constant Optional 0.0 X-coordinate 8 -

Y- 9 T2-Real Tuning Constant Optional 0.0 Y-coordinate 8 -
X- 9 R9-Real Tuning Constant Optional 0.0 X-coordinate 9 -
Y- 9 T3-Real Tuning Constant Optional 0.0 Y-coordinate 9 -
X -10 S1-Real Tuning Constant Optional 0.0 X-coordinate 10 -
Y -10 T4-Real Tuning Constant Optional 0.0 Y-coordinate 10 -
X -11 S2-Real Tuning Constant Optional 0.0 X-coordinate 11 -
Y -11 T5-Real Tuning Constant Optional 0.0 Y-coordinate 11 -
X -12 S3-Real Tuning Constant Optional 0.0 X-coordinate 12 -
Y -12 T6-Real Tuning Constant Optional 0.0 Y-coordinate 12 -
IN1 - Variable Required - IN1 variable LA
analog input
TOUT - Variable Required - Track output LA
value, mode and
status signals
for input variable
OUT - Variable Required - Analog output LA
variable
TRIN - Variable Optional - Tracking analog LA
value, tracking
and limiting
mode signals
input variance

OW360_R1100 301
5.51 GAINBIAS

5.51 G AINBI AS
Description

The GAINBIAS algorithm multiplies the analog input with an internal gain, adds a bias and then
limits the output value.

To scale the output proportionally to the input, calculate the required Gain and Bias as follows:

Note: If the algorithm receives an invalid value as an input, or calculates an invalid value as the
output, the drop is placed into alarm.

Functional symbol

302 OW360_R1100
 5.51 GAINBIAS

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status of
the analog point. This algorithm takes the following action in response to the information found in
the input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit No action Passed through**

20 Raise inhibit No action Passed through**

21 Conditional Track Implemented Passed through***

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the
definitions given in Setting Tracking Signals (see page 17).

*** If the algorithm is being told to track, then the Conditional track bit is ignored.
Otherwise, the value of the conditional track bit is transferred to all output track
points. If the Conditional Track bit is set in the track input point, the analog value of
all output track points is calculated based on the analog value of the track input
point.

OW360_R1100 303
5.51 GAINBIAS

The high and low limit flags and the tracking signals from the algorithm are output to TOUT, to be
used for display and by an upstream algorithm. If the OUT value is invalid, the quality of OUT is
set to BAD. Otherwise, if the quality propagation (PROQ) option is ON, the quality of OUT is set to
the quality of the input when not in tracking mode. When tracking, the quality is set to the quality
of the track input variable. If the PROQ option is OFF, the quality of OUT is set to GOOD.

Note: If the algorithm generates an invalid track output value, the input value is used as the
track output, unless it is invalid. The track output value is not updated if both the calculated track
output and input values are invalid.

In addition, you may turn off the tracking output calculations. This may be done to support control
logic designs that require fast execution times (such as 20 msec). The TBLK parameter can be
set to OFF, which will disab le the tracking calculations and local memory operations. The default
value for TBLK is ON, which means the algorithm performs the tracking calculations.

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 76 Tuning Diagram -

Number
GAIN R1-Real Tuning Required 1.0 Gain on input. The -
Constant gain on the input
should never be
initialized to zero; if
it is, the drop is
placed into alarm.
BIAS R2-Real Tuning Required 0 Bias on input -
Constant

TPSC R5-Real Tuning Required 1E+09 Maximum value of -

Constant the output point
(999999999)
BTSC R6-Real Tuning Required -1E+09 Minimum value of -
Constant the output point
(-999999999)
TRAT R5-Real Tuning Required 2.5 Track ramp rate -
Constant (units per second)

TBLK X3 - Byte Data Init. Required ON Enable tracking -

Bit 0 calculations and
local memory
operations. The
choices are:
 ON
 OFF

304 OW360_R1100
 5.51 GAINBIAS

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

PROQ X1-Byte Data Init. Required ON Quality Propagation -

Bit 1 option:
ON = Normal
quality selection.
OFF = Quality of
the output is always
GOOD, except
when OUTPUT is
not a valid real
number.
IN1 - Variable Required - Input analog LA

TOUT - Variable Required - Track output value, LA

mode and status
signals for input
variable
OUT - Variable Required - Analog output LA
variable
TRIN - Variable Optional - Tracking analog LA
value, tracking and
limiting mode
signals input
variable

Function

OUT = (IN1 x GAIN) + BIAS

IF OUT >= TPSC THEN
OUT = TPSC
ELSE
IF OUT <= BTSC THEN
OUT = BTSC

OW360_R1100 305
5.52 GASFLOW

5.52 G ASFLOW
Description

The GASFLOW algorithm calculates a pressure-and-temperature-compensated mass or

volumetric flow for ideal gases.

The mass flow is calculated as shown below:

The volumetric flow is calculated as shown below:

It is possible to disable pressure compensation or temperature compensation. For no pressure

compensation, you must specify a negative pressure reference (PRES) value. For no temperature
compensation, you must specify a negative temperature reference (TEMP) value.

The TPSC and BTSC parameters are used to limit the output value of the algorithm.

Functional symbol

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the analog tracking
point's third status word. This algorithm takes the following action in response to the information
found in the input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Ignored Not used

17 Track if lower Ignored Not used

18 Track if higher Ignored Not used

306 OW360_R1100
 5.52 GASFLOW

BIT DESCRIPTION ACTION TOUT SIGNAL

19 Lower inhibit Ignored Not used

20 Raise inhibit Ignored Not used

21 Conditional Track No action Not used

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

The high and low limit flags are output to TOUT to be used for display.

The output has the worst quality of the analog inputs specified assigned to the quality of the
output.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init. Required 78 Tuning Diagram -

Number
CALC G3-Integer Data Init. Required MASS- Type of flow -
Bit 5 FLOW calculation
performed:
MASSFLOW =
mass flow
VOLFLOW =
volume flow
GAIN R3-Real Tuning Required 1.0 Calculated flow -
Constant coefficient at base
operating
conditions.

OW360_R1100 307
5.52 GASFLOW

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

PRES R4-Real Tuning Required 2400.0 Reference pressure; -

Constant base operating
pressure used in the
calculation of the
flow coefficient,
GAIN
TEMP R5-Real Tuning Required 1000.0 Reference -
Constant temperature; base
operating
temperature used in
the calculation of
the flow coefficient,
GAIN.
PABS G3-Integer Data Init. Required YES Convert pressure -
Bit 2 values to absolute
pressure option:
YES = Input and
reference pressure
values are
converted to
absolute pressure.
NO = Input and
reference pressure
values are not
converted to
absolute pressure.
PUNT G3-Integer Data Init. Required PSI Pressure -
Bits 0 and 1 conversion type :
 Absolute
 Pressure
Pressure
 Conversion
Type Value
PSI 14.696
INH20 406.800
KGCM 21.033
KPA 101.325

308 OW360_R1100
 5.52 GASFLOW

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

TABS G3-Integer Data Init. Required YES Convert -

Bit 4 temperature values
to absolute
temperature option.
YES = Input and
reference
temperature values
are converted to
absolute
temperature.
NO = Input and
reference
temperature values
are not converted to
absolute
temperature.
TUNT G3-Integer Data Init. Required FAHR Temperature -
Bit 3 conversion type:
 Absolute
 Temperature
 Conversion
Type Value
FAHR 459.67
CENT 273.15
TPSC R1-Real Tuning Required 100.0 Maximum value of -
Constant the output

BTSC R2-Real Tuning Required 0.0 Minimum value of -

Constant the output

OW360_R1100 309
5.52 GASFLOW

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

PNEG G3-Integer Data Init. Required NO-CHECK Check for use of -

Bit 6 negative pressure
and temperature
reference values
NOCHECK = No
check is performed
to see if the
PACT(C) and
TACT(C) inputs
were specified. A
negative PRES REF
or TEMP REF value
causes the
associated term to
be omitted from the
equation.
CHECK = Check
whether the
PACT(C) and
TACT(C) inputs
were specified. If an
input is not
specified, the
associated term is
omitted from the
equation. When the
inputs are specified,
the PRES REF and
TEMP REF values
are used regardless
of their sign.
PSEL G3-Integer Data Init. Required STANDARD Select pressure -
Bit 7 conversion type:
STANDARD - Use
the pressure
conversion value
defined by PRES
UNIT.
USER - Use the
pressure conversion
value defined by
USER PRES.
PUSR R6-Real Tuning Required 0.0000 Value for -
Constant user-specified
pressure conversion

310 OW360_R1100
 5.52 GASFLOW

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

TYPE X1-Byte Data Init. Required DEL-TAP Flow Differential or -

DELTAP
Default: DELTAP
IN1 - Variable Required - Differential pressure LA
or flow.
Input (analog)
TOUT - Variable Required - Track output value LA
and status output
signals
PACT - Variable Optional - Actual pressure. LA
Input (analog)
TACT - Variable Optional - Actual temperature. LA
Input (analog)
OUT - Variable Required - Analog output LA
variable
TRIN - Variable Optional - Track value, LA
tracking and limit
modes.
Input (analog)

OW360_R1100 311
5.52 GASFLOW

Function
IF ((PNEG = NOCHECK) AND (PRES REF < 0)) OR
((PNEG = CHECK) AND (PACT = UNDEFINED))
THEN
P1 = P2 = 1
ELSE
P1 = PACT + ABSPRES
P2 = PRES REF + ABSPRES

IF ((TNEG= NOCHECK) AND (TEMP REF < 0)) OR

((TNEG= CHECK) AND (TACT = UNDEFINED))
THEN
T1 = T2 = 1
ELSE
T2 = TACT + ABSTEMP
T1 = TEMP REF + ABSTEMP

IF MASSFLOW THEN
IF (P2 = 0) OR (T1 = 0) THEN
OUTVAL = 0
ELSE
IF DELTAP
OUTVAL = IN1 * (P1/P2) * (T1/T2)
ELSE
OUTVAL = (P1/P2) * (T1/T2)
ELSE
IF (P1 = 0) OR (T2 = 0) THEN
OUTVAL = 0
ELSE
IF DELTAP
OUTVAL = IN1 * (P2/P1) * (T2/T1)
ELSE
OUTVAL = (P2/P1) x (T2/T1)

IF OUTVAL < 0 THEN

OUT = 0
ELSE
IF DELTAP
OUT = GAIN * SQUARE ROOT OF OUTVAL
ELSE
OUT = (GAIN * IN1) * SQUARE ROOT OF OUTVAL

where:
P1,P2,T1,T2,OUTVAL = local, temporary, real variables

ABSPRES, ABSTEMP = constants from the pressure and temperature conversion tables
built into the algorithm

312 OW360_R1100
 5.53 HEARTBEAT

5.53 HE ARTBE AT
Description

The HEARTBEAT algorithm is designed to generate heartbeat signals that can be received by
other drops for use in safety critical applications. The algorithm can also be utilized to monitor up
to five heartbeat signals generated from heartbeat algorithms in other Controllers. If the algorithm
detects that a heartbeat signal being monitored has ceased, it sets the corresponding output to
one. It has a value of zero when it is communicating.

A heartbeat signal is a continuously changing signal that is generated and broadcast from an
Ovation Controller. A heartbeat signal that is continuously changing is an explicit indication that
the Controller generating the heartbeat signal is functioning properly.

Typically, the heartbeat signal allows a control strategy to monitor other heartbeat signals (ones
that are broadcast from other Controller drops) and take appropriate actions if the heartbeat
signals cease. It is common in power generation applications to have the loss of a heartbeat
signal from one or more Controllers generate a Master Fuel Trip (MFT) in the Controller that is
monitoring the heartbeat signals.

Functional symbol

Overview

The value of a heartbeat signal output (HTBT) is a continuously changing analog value. The
HTBT output is updated each loop time to a new number. The actual value of the heartbeat signal
is not important - it is important that the heartbeat signal updates each loop time by the originating
Controller and that the receiving Controller records a different value each loop time.

If any input heartbeat signals are connected to the HEARTBEAT algorithm, they are monitored to
ensure that the value changes on each successive loop. During each execution loop, the value of
each connected input is read and compared to that point's value that was read on the previous
loop. Under normal conditions, these two successive values should be different - that is, the
changing signal is being received from the originating drop(s) successfully. If the value of any of
the input points is unchanging for the user-entered timeout period (TIME1 - 5), the corresponding
trip output OUT1 - 5 is set to true.

OW360_R1100 313
5.53 HEARTBEAT

Note that if the user-entered timeout period is not an exact multiple of the control task period in
which the algorithm is executing, then the algorithm rounds the user-entered value to the next
higher integer multiple of the task period. When this occurs, the resulting actual timeout is the
user-entered timeout plus the control task period. This action ensures that the tuning fields of the
algorithm always reflect the exact timeout period.

Emerson recommends that when the algorithm is used to generate a heartbeat signal, it should
be executed in a 0.1 second control task. When the algorithm is used to monitor other heartbeat
signals, Emerson recommends that it should be executed in a 0.1 second control task.

Also, note that the algorithm ensures that the user-entered timeout cannot be set to a value less
than the time that it takes the Ovation Network to detect a loss of communication on a primary
Controller and to initiate a failover. This time is typically five seconds.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU - Integer Data Init Optional - Tuning diagram -

number

TIME1 R1 - Real Tuning Required - Timeout value for -

Constant heartbeat input 1*

TIME2 R2 - Real Tuning Required - Timeout value for -

Constant heartbeat input 2*

TIME3 R3 - Real Tuning Required - Timeout value for -

Constant heartbeat input 3*

TIME4 R4 - Real Tuning Required - Timeout value for -

Constant heartbeat input 4*

TIME5 R5 - Real Tuning Required - Timeout value for -

Constant heartbeat input 5*

IN1 Input Variable Optional - Input Heartbeat LA

signal 1
IN2 Input Variable Optional - Input Heartbeat LA
signal 2
IN3 Input Variable Optional - Input Heartbeat LA
signal 3
IN4 Input Variable Optional - Input Heartbeat LA
signal 4
IN5 Input Variable Optional - Input Heartbeat LA
signal 5

314 OW360_R1100
 5.53 HEARTBEAT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

HTBT Output Variable Required - Heartbeat Output LA

Note: Emerson
recommends that
the Heartbeat
output (HTBT)
points be built
with a broadcast
frequency of
100msec instead
of 1 second.

OUT1 - Variable Optional - Fail Output for LD, LP

Heartbeat input
signal 1
OUT2 - Variable Optional - Fail Output for LD, LP
Heartbeat input
signal 2
OUT3 - Variable Optional - Fail Output for LD, LP
Heartbeat input
signal 3
OUT4 - Variable Optional - Fail Output for LD, LP
Heartbeat input
signal 4
OUT5 - Variable Optional - Fail Output for LD, LP
Heartbeat input
signal 5

Note: The algorithm sets the parameter to a minimum value required for the Ovation network
subsystem to detect a timeout. You only have the option to extend the timeout value. Also, if the
user-entered timeout is not an integer multiple of the control task period, the algorithm rounds up to
the user-entered value to the next highest integer multiple of the control task period.

OW360_R1100 315
5.54 HIGHLOWMON

5.54 HIGHLOWMON
Description

The HIGHLOWMON algorithm is a high and low signal monitor with reset deadband and
fixed/variable limits. For the HIGHLOWMON algorithm, if the input value (IN1) is greater than the
high set point or less than the low set point, the digital output flag is set TRUE. To reset the flag,
the input must be less than the high set point minus the deadband on the high set point, and
greater than the low set point plus the deadband on the low set point.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 74 Tuning Diagram -

Number
* HISP R1-Real Selectable Required 0.0 High set point LA

HIDB R2-Real Tuning Optional 0.0 Deadband on -

Constant high set point

* LOSP R3-Real Selectable Required 0.0 Low set point LA

LODB R4-Real Tuning Optional 0.0 Deadband on low -

Constant set point

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required 0.0 Output (digital) LD

* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

Function

IF IN1 > HISP OR IN1 < LOSP

THEN OUT = TRUE
ELSE
IF IN1 < (HISP - HIDB) AND IN1 > (LOSP + LODB)
THEN OUT = FALSE

316 OW360_R1100
 5.55 HIGHMON

5.55 HIGHMON
Description

The HIGHMON algorithm is a high signal monitor with reset deadband and a fixed/variable limit.
With the HIGHMON algorithm, if the input value (IN1) exceeds the fixed set point value, the digital
flag is set TRUE. To clear the flag, IN1 must be less than the set point value minus the deadband.
The value of IN1 is checked for invalid real numbers. If IN1 is invalid, OUT retains its last valid
value, and the quality of OUT is set to BAD. The quality of IN1 is not propagated.

Functional Symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 63 Tuning Diagram -

Number
* HISP R1-Real Selectable Required 0.0 Set point for the LA
high signal
monitor trip point
HIDB R2-Real Tuning Required 0.0 Deadband -
Constant

OUT - Variable Required - Output (digital) LD, LP

IN1 - Variable Required - Input (analog) LA

* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder
may default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

OW360_R1100 317
5.55 HIGHMON

Function

IF IN1 > HISP

THEN OUT = TRUE
ELSE
IF IN1 < (HISP - HIDB)
THEN OUT = FALSE

Note the following:

In the Function above, if neither condition is satisfied, the value of the output is maintained from
the previous value. See below:

For the first loop, if IN1 = 51, HISP = 50, HIDB = 5, then the function would look like this:

IF 51 > 50
THEN OUT = TRUE
ELSE
IF 51 < (50 - 5)
THEN OUT = FALSE
For the first loop, OUT = TRUE

For the second loop, if IN1 = 48, HISP = 50, HIDB = 5, then the function would look like this:

IF 48 > 50
THEN OUT = TRUE
ELSE
IF 48 < (50 - 5)
THEN OUT = FALSE
For the second loop, neither condition is met. Therefore, the value of the output is maintained
from the previous value so OUT = TRUE.

For the third loop, if IN1 = 42, HISP = 50, HIDB = 5, then the function would look like this:

IF 42 > 50
THEN OUT = TRUE
ELSE
IF 42 < (50 - 5)
THEN OUT = FALSE
For the third loop, OUT = FALSE

318 OW360_R1100
 5.56 HISELECT

5.56 HISELECT
Description

The HISELECT algorithm performs a gain and bias on four inputs. The output is equal to the
greater of the four values, according to the quality (QUAL) parameter.

The quality (QUAL) parameter contains three options that enable you to select the value and type
of quality that the output point receives.

The WORSE option selects the greater value for an output point, independent of the qualities of
the input points. The output point is assigned the worst quality of the input points.

The SELECTED option also selects the greater value, independent of the qualities of the input
points. The output point is assigned the value and quality of the selected input point. However, if
any of the gained and biased values are equal, the better quality is assigned to the output point.

The NOTBAD option selects the greater gained and biased input value, providing the qualities of
both inputs are not BAD. The quality of the output is set equal to the quality of the input selected
or to the better quality of the two inputs if the gained and biased input values are equal. If one
input has BAD quality, the gained and bias input value and the quality of the input with the not
BAD quality are assigned to the output. The output is equal to the greater gained and biased input
value and contains BAD quality if both input qualities are BAD.

Note: If the algorithm calculates an invalid output value by using one of the gained and biased
inputs, the value of the other three points is used for the output. In addition, for the NOTBAD
option, if the quality of four input points is BAD, and only one of the inputs is a valid value, the
algorithm selects the valid gained and biased input for the output, and sets the quality of the
output point to BAD.

If the calculated track output is invalid, then the IN2 output is equal to the IN1 input, and the
cascade track output is equal to the IN1 input, if the inputs are valid. If the calculated track
output and the input values are invalid, then the IN1 and IN1 track outputs are not updated.

If the algorithm receives an invalid value as an input, or if it calculates an invalid value as an

output, the drop is placed into alarm.

Functional symbol

OW360_R1100 319
5.56 HISELECT

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog tracking point. This algorithm takes the following action in response to the
information found in the analog input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TRK1 SIGNAL

16 Track Implemented and passed Implemented and passed

through. Passed through or through. Passed through or set
17 Track if lower set TRUE when IN1 input is TRUE when IN2 input is not
not selected and selected and IN2 gain is >0*
IN1 gain is >0*
18 Track if higher Passed through or set TRUE Passed through or set TRUE
when IN1 input is not selected when IN2 input < is not
and IN1 gain is >0* selected and IN2 gain is >0*

19 Lower inhibit Passed through** Passed through**

20 Raise inhibit Passed through** Passed through**

21 Conditional Track Implemented Passed through***

22 Not used Not used Not used

23 Deviation Alarm Not used Not used

24 Local Manual mode Not used Not used

25 Manual mode Not used Not used

26 Auto mode Not used Not used

27 Not Used Not used Not used

28 Not Used Not used Not used

29 Not Used Not used Not used

30 Low limit reached Low limit reached Not used

31 High limit reached High limit reached Not used

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the definitions given
in Setting Tracking Signals (see page 17).

*** If the algorithm is being told to track, then the Conditional track bit is ignored. Otherwise, the
value of the conditional track bit is transferred to all output track points. If the Conditional Track bit
is set in the track input point, the analog value of all output track points is calculated based on the
analog value of the track input point.

320 OW360_R1100
 5.56 HISELECT

The high and low limit flags, and the tracking signals from the algorithm are output to TRK3 and
TRK4, to be used for display and by upstream algorithms. If the output value is invalid, the quality
of OUT is set to BAD. Otherwise, the quality of OUT is set according to the quality (QUAL)
parameter. When tracking, the quality is set to the quality of the track input variable.

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

DIAG LU-Integer Data Init Required 83 Tuning Diagram -

Number
IN1G R1-Real Tuning Required 1.0 Gain on input 1. The -
Constant gain on the input1
should never be
initialized to zero; if it
is, the drop is placed
into alarm.
IN1B R2-Real Tuning Optional 0.0 Bias on input 1 -
Constant

IN2G R3-Real Tuning Required 1.0 Gain on input 2. The -

Constant gain on the input 2
should never be
initialized to zero; if it
is, the drop is placed
into alarm.
IN2B R4-Real Tuning Optional 0.0 Bias on input 2 -
Constant

IN3G R8-Real Tuning Optional 1.0 Gain on input 3. The -

Constant gain on the input 3
should never be
initialized to zero; if it
is, the drop is placed
into alarm
IN3B R9-Real Tuning Optional 0.0 Bias on input 3 -
Constant

IN4G S1-Real Tuning Optional 1.0 Gain on input 4, the -

Constant gain on the input 4
should never be
initialized to zero; if it is
the drop is placed into
alarm
IN4B S2-Real Tuning Optional 0.0 Bias on input 4 -
Constant

TPSC R5-Real Tuning Required 1E+09 Maximum value of the -

Constant output point
(999999999)
BTSC R6-Real Tuning Required -1E+09 Minimum value of the -
Constant output point
(-999999999)

OW360_R1100 321
5.56 HISELECT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

TRAT R7-Real Tuning Required 2.5 Track ramp rate (units -

Constant per second)

QUAL X1-Byte Data Init. Required WORSE Output quality type: -

Bits 0 and 1  WORSE = Worst
quality of the four
inputs is selected.
 SELECTED = Output
point is assigned the
quality of the
selected input point.
If the values of the
input points are
equal, the best
quality is selected.
 NOTBAD = The
output point is
assigned the quality
of the selected input
point, providing the
qualities of the two
inputs are not BAD. If
one input point
quality is BAD, the
output is assigned
the quality of the not
BAD input. The
better quality of the
two inputs is selected
if the input values are
equal.
IN1 - Variable Required - Analog input 1 LA

TRK1 - Variable Required - Track output value LA

mode and status
signals for Input 1
variable
IN2 - Variable Required - Analog input 2 LA

TRK2 - Variable Required - Track output value LA

mode status signals for
Input 2 variable

IN3 - Variable Optional - Analog input 3 LA

TRK3 - Variable Optional - Track output value LA

mode signal for Input 3

IN4 - Variable Optional - Analog input 4 LA

TRK4 - Variable Optional - Track output value LA

mode signal for Input 4

OUT - Variable Required - Analog output variable LA

TRIN - Variable Optional - Tracking and signals LA

analog input variable

322 OW360_R1100
 5.56 HISELECT

Function

IN1GB = (IN1 x IN1G) + IN1B

IN2GB = (IN2 x IN2G) + IN2B
IN3GB = (IN3 x IN3G) + IN3B
IN4GB = (IN4 x IN4G) + IN4B
IF IN2GB >= IN1GB THEN
OUT = IN2GB
ELSE
OUT = IN1GB
If IN3G >= OUT
OUT = IN3G
If IN4G >= OUT
OUT = IN4G
IF OUT >= TPSC THEN
OUT = TPSC
ELSE
IF OUT <= BTSC THEN
OUT = BTSC

IF OUT >= TPSC

OUT = TPSC
ELSE
IF OUT <= BTSC
OUT = BTSC

OW360_R1100 323
5.57 HSCLTP

5.57 HSCLTP
Description

HSCLTP calculates Enthalpy (H) and Entropy (S) of Compressed Liquid given its Temperature
and Pressure. It is one of the functions of the STEAMTABLE algorithm (see page 594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

HSCLTP input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) TEMP 32.0 705.47

(INPUT 2) PRES 0.0885891400 16000.00
(INPUT 3) PRAT * Pressures are added together.
(OUT 1) ENTH -0.017864220 906.01
(OUT 2) ENTR -0.000036890 1.0612

Note: PRAT is set from 12 to 16 psi.

324 OW360_R1100
 5.58 HSLT

5.58 HSLT
Description

HSLT calculates Enthalpy (H) of Saturated Liquid given its Temperature. It is one of the functions
of the STEAMTABLE algorithm (see page 594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

HSLT input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) TEMP 32.0 705.47

(OUT 1) ENTH -0.017864220 906.01

OW360_R1100 325
5.59 HSTVSVP

5.59 HSTVSVP
Description

HSTVSVP calculates Enthalpy (H), Entropy (S), Temperature, and Specific Volume of Saturated
Vapor given its Pressure. It is one of the functions of the STEAMTABLE algorithm (see page
594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

HSTVSVP input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) PRES 0.08858914 32080.234

(INPUT 2) PRAT * Pressures are added together.
(OUT 1) ENTH 906.01 1204.8
(OUT 2) TEMP 32.0 705.47
(OUT 3) ENTR 1.0612 2.1873
(OUT 4) VOL 0.05078 3304.7

Note: PRAT is set from 12 to 16 psi.

326 OW360_R1100
 5.60 HSVSSTP

5.60 HSVSSTP
Description

HSVSSTP calculates Enthalpy (H), Entropy (S), and Specific Volume of Superheated Steam
given its Temperature and Pressure. It is one of the functions of the STEAMTABLE algorithm (see
page 594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

HSVSSTP input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) TEMP 32.0 1600.0

(INPUT 2) PRES 0.01 16000.0
(INPUT 3) PRAT * Pressures are added together.
(OUT 1) ENTH 715.570 1859.85
(OUT 2) ENTR 0.84797280 3.1233000
(OUT 3) VOL 0.0200 122690.0

Note: PRAT is set from 12 to 16 psi.

OW360_R1100 327
5.61 INTERP

5.61 INTERP
Description

The INTERP algorithm provides a linear table-lookup and interpolation function. The algorithm
provides a lookup table for the value of a dependent variable (Y) based on the value of an
independent variable (X). The actual value X (XIN) is input to the algorithm along with up to ten
reference Y values (Y1...Y10) and their corresponding X values (X1...X10).

If the value of the XIN is not identically equal to any of the X1...X10 inputs, then resulting value of
YOUT is calculated by linear interpolation between the closest two values that the input XIN falls
between (that is, Xn + Xn+1). The formula to calculate YOUT is given as follows:

YOUT = Yn + ( (Yn+1 - Yn) * ( (XIN - Xn) / (Xn+1 - Xn) )

The value of YOUT is limited by the user-defined high and low limit values. Refer to the
accompanying figure that illustrates the interpolation procedure.

Functional symbol

Quality

The algorithm propagates the worst quality between the XIN input and the associated Y inputs
used to determine the value of YOUT. If the output is an exact Y input, then the YOUT quality is
the worst quality of the XIN input and that particular Y input.

User Configuration

The values of X1...X10 MUST be monotonically increasing (that is, Xn+1 > Xn). If the value of the
XIN is found to fall between X1...X10, then the VALID output is set to logic one. If the
monotonicity of the X1 - X10 is not monotonically increasing, then the algorithm may yield
unpredictable results. If the algorithm can determine that the table is not monotonically increasing,
then YOUT is set equal to Y10 and the VALID output is set to logic 0.

If the value of XIN > X10, then YOUT is set equal to Y10. If XIN < X1, then YOUT is set equal to
Y1. In both of these cases, the VALID output is set to logic zero. If the algorithm calculates an
invalid number, then YOUT is set to the last GOOD value and the quality is set to BAD.

If the YOUT is calculated by interpolating between Yn and Yn+1, then the quality of YOUT is the
worst quality of the XIN, Yn and Yn+1 inputs.

328 OW360_R1100
 5.61 INTERP

Interpolation Illustration

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 113 Tuning -

Diagram
Number
TYPE X2-Byte Data Init Required Linear Interpolation -
Type. Currently
only linear is
supported.
NUMR X1-Byte Data Init Required 0 Number of X -
values.

OW360_R1100 329
5.61 INTERP

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

X1 R1-Real Tuning Required 0.0 X value -

Constant corresponding
to Y1.
X2 R2-Real Tuning Required 0.0 X value -
Constant corresponding
to Y2.
X3 R3-Real Tuning Required 0.0 X value -
Constant corresponding
to Y3.
X4 R4-Real Tuning Required 0.0 X value -
Constant corresponding
to Y4.
X5 R5-Real Tuning Required 0.0 X value -
Constant corresponding
to Y5.
X6 R6-Real Tuning Required 0.0 X value -
Constant corresponding
to Y6.
X7 R7-Real Tuning Required 0.0 X value -
Constant corresponding
to Y7.
X8 R8-Real Tuning Required 0.0 X value -
Constant corresponding
to Y8.
X9 R9-Real Tuning Required 0.0 X value -
Constant corresponding
to Y9.
X10 S1-Real Tuning Required 0.0 X value -
Constant corresponding
to Y10.
TPSC S2-Real Tuning Required 100.0 Output top of -
Constant scale.

BTSC S3-Real Tuning Required 0.0 Output bottom -

Constant of scale.

XIN - Variable Required - Actual value of LA

X variable
(analog)
Y1 - Variable Optional - Output Value LA
1(analog)
Y2 - Variable Optional - Output Value 2 LA
(analog)
Y3 - Variable Optional - Output Value 3 LA
(analog)
Y4 - Variable Optional - Output Value 4 LA
(analog)

330 OW360_R1100
 5.61 INTERP

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

Y5 - Variable Optional - Output Value 5 LA

(analog)
Y6 - Variable Optional - Output Value 6 LA
(analog)
Y7 - Variable Optional - Output Value 7 LA
(analog)
Y8 - Variable Optional - Output Value 8 LA
(analog)
Y9 - Variable Optional - Output Value 9 LA
(analog)
Y10 - Variable Optional - Output Value LA
10 (analog)
YOUT - Variable Required - Output Y value LA
(analog)
VALID - Variable Optional - Equals Logic 1 LD
when the XIN
value is found
to fall between
two X values in
the table
(digital).

OW360_R1100 331
5.62 KEYBOARD

5.62 KEYBO ARD

Description

The KEYBOARD (Key Interface) algorithm interfaces the following control keys (P1 - P8,
Start/Open, Stop/Close, AUTO, MAN, SPUP, SPDN, INC, and DEC) to the Controller in the most
basic form. The output of each key is available for use once the algorithm is activated via a
control select command.

The KEYBOARD algorithm interfaces the Operator Station programmable keys (P1 through P10)
to the Controller in the most basic form. The output of each programmable key is available for use
once the algorithm is activated via a control select key. When using this algorithm, none of the ten
Control keys may be used for the activated control select number.

For the INC, DEC, SPDN, and SPUP keys, the output maintains a TRUE signal for as long as the
key is pressed. For all other keys, the output of this algorithm is a pulse (TRUE signal) of variable
length. The pulse length is determined by the LENGTH (LENG) parameter, which specifies the
pulse length in loops. If LENGTH is equal to 0 or 1, the pulse is 1 loop long. The LENGTH
parameter may specify a pulse length up to 255 loops.

Note: P9 and P10 keys are the same as Open and Close keys.

Functional symbol

332 OW360_R1100
 5.62 KEYBOARD

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU- Data Init. Required 128 Tuning Diagram -

Integer Number
LENG X2-Byte Data Init. Optional 1 Length of output -
pulse in loops.

PK1 - Variable Optional - Output (digital); LD, LP

passed on from
Function Key F1
or
Programmable
Key P1.
PK2 - Variable Optional - Output (digital); LD, LP
passed on from
Function Key F2
or
Programmable
Key P2.
PK3 - Variable Optional - Output (digital); LD, LP
passed on from
Function Key F3
or
Programmable
Key P3.
PK4 - Variable Optional - Output (digital); LD, LP
passed on from
Function Key F4
or
Programmable
Key P4.
PK5 - Variable Optional - Output (digital); LD, LP
passed on from
Function Key F5
or
Programmable
Key P5.
PK6 - Variable Optional - Output (digital); LD, LP
passed on from
Function Key F6
or
Programmable
Key P6.
PK7 - Variable Optional - Output (digital); LD, LP
passed on from
Function Key F7
or
Programmable
Key P7.

OW360_R1100 333
5.62 KEYBOARD

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

PK8 - Variable Optional - Output (digital); LD, LP

passed on from
Function Key F8
or
Programmable
Key P8.
OPEN - Variable Optional - Output (digital); LD, LP
Passed on from
KEYBOARD
START/OPEN
CLOS - Variable Optional - Output (digital): LD, LP
Passed on from
KEYBOARD
STOP/CLOSE
SPUP - Variable Optional - Output (digital): LD, LP
Passed on from
KEYBOARD set
point
INCREASE (up
arrow).
SPDN - Variable Optional - Output (digital); LD, LP
Passed on from
KEYBOARD set
point Decrease
(down arrow).
AUTO - Variable Optional - Output (digital); LD, LP
Passed on from
KEYBOARD
AUTO
MAN - Variable Optional - Output (digital); LD, LP
Passed on from
KEYBOARD
MANUAL
INC - Variable Optional - Output (digital); LD, LP
Passed on from
KEYBOARD
Output Increase
(up triangle)
DEC - Variable Optional - Output (digital); LD, LP
Passed on from
KEYBOARD
Output
Decrease (down
triangle).

334 OW360_R1100
 5.63 LATCHQUAL

5.63 LATCHQUAL
Description

The LATCHQUAL algorithm latches and unlatches the quality of an input analog or digital point.
The algorithm sets or clears the “Latched Quality” bit of the IN1 point, depending on SET and
RSET points. Bit 14 of the 2W (second status word) of the analog point or bit 11 of the 2W
(second status word) of the digital point is the “Latched Quality” bit for the point.

Functional symbol

If RSET is TRUE and the latched quality bit of IN1 is set, the Latched Quality bit is cleared.

If RSET is FALSE and SET is TRUE, then depending on the value of QUAL, the IN1 point sets its
Latched Quality bit and quality as follows:
 If QUAL = 0 and Latched Quality of IN1 is not set, then Latched quality bit is set at its current
state.
 If QUAL = 1 and Latched Quality of IN1 is not set or the Quality of IN1 is not GOOD, then the
Quality is set (latched) to GOOD.
 If QUAL = 2 and Latched Quality of IN1 is not set or the Quality of IN1 is not FAIR, then the
Quality is set (latched) to FAIR.
 If QUAL = 3 and Latched Quality of IN1 is not set or the Quality of IN1 is not POOR, then the
Quality is set (latched) to POOR.
 If QUAL is greater than or equal to 4 and Latched Quality of IN1 is not set or the Quality of
IN1 is not BAD, then the Quality is set (latched) to BAD.
RSET overrides SET. If both are TRUE, then the Latched Quality bit of IN1 is cleared.

Note: IN1 can be a digital or analog point, with the minimum point record being LD or LA. If a
smaller point record is used, then no action is taken.

OW360_R1100 335
5.63 LATCHQUAL

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN. POINT

RECORD OPTIONAL VALUE RECORD
FIELD

SET - Variable Required - Digital input. Set LD, LP

Latched Quality bit
flag.
IN1 - Variable Required - Analog/Digital input LD, LA

QUAL - Variable Required - Packed input. LP

Indicates the quality
to which IN1 is to
be set.
RSET - Variable Required - Digital input. Clear LD, LP
Latched Quality bit
flag.

336 OW360_R1100
 5.64 LEADLAG

5.64 LE ADLAG
Description

LEADLAG is a nonlinear lead/lag function. The output value is a function of the old output, old
input, new input, gain, lead and lag time constants. In steady state, OUT = IN1 x GAIN (except
when limited). The output achieves 98 percent of the expected steady-state output value in five
time constants.

The algorithm can be configured to be a pure lead function. The output value is a function of the
old output, old input, new input, gain and lead time constants. The output achieves 98% of the
expected steady-state output value in five time constants.

Note: If the algorithm receives an invalid value as an input, or calculates an invalid value as the
output, the drop is placed into alarm.

Functional symbol

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog track point. This algorithm takes the following action in response to the information
found in the analog input signal TRIN:

Tracking signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit Implemented Passed through**

20 Raise inhibit Implemented Passed through**

21 Conditional Track No action Not used

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

25 Manual mode No action Not used

OW360_R1100 337
5.64 LEADLAG

BIT DESCRIPTION ACTION TOUT SIGNAL

26 Auto mode No action Not used

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the definition given
in Setting Tracking Signals (see page 17).

The high and low limit flags and the tracking signals from the algorithm are output to TOUT, to be
used for display and by an upstream algorithm. If the output value is invalid, the quality of OUT is
set to BAD. Otherwise, the quality of OUT is set to the quality of the input when it is not in tracking
mode. When tracking, the quality is set to the quality of the track input variable.

Note: If the algorithm generates an invalid track output value, the IN1 input value is used as the
track output, unless it is invalid. The track output value is not updated if both the calculated track
output and IN1 input values are invalid.

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

DIAG LU-Integer Data Init Required 33 Tuning Diagram -

Number
GAIN R3-Real Tuning Required 1.0 Gain on input. The -
Constant gain on the input
should never be
initialized to zero; if
it is, the drop is
placed into alarm
TPSC R5-Real Tuning Required 1E+09 Maximum value of -
Constant the output point
(999999999)
BTSC R6-Real Tuning Required -1E+09 Minimum value of -
Constant the output point
(-999999999)
* LEAD R4-Real Selectable Required 0.0 Lead time constant LA
(second)

338 OW360_R1100
 5.64 LEADLAG

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

* LAG R5-Real Selectable Required 30.0 Lag time constant LA

(second)

Note: This is
approximately 1/5
of the total time to
settle. For
example, for a 1
minute total, set
LAG to 12
seconds.

TYPE X2-Byte Tuning Required LEADLAG Type of Function. -

Constant The choices are:
 LEADLAG (0)
 LEAD_ONLY (1)
Default =
LEADLAG
TRAT R6-Real Tuning Required 2.5 Track ramp rate -
Constant (units per second).

IN1 - Variable Required - Analog input LA

variable
TOUT - Variable Required - Track output value, LA
for mode and status
signals for Input 1
variable
OUT - Variable Required - Analog output LA
variable
TRIN - Variable Optional - Tracking and LA
Limiting mode
signals and tracking
value; analog input
variable
* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be executed
properly, you must enter a value for the parameter.

OW360_R1100 339
5.64 LEADLAG

Function
LEADLAG:

OUT = (K1 X IN1) + (K2 X OLDIN1) + (K3 X OLDOUT)

where:

OLDOUT = Previous output

IN1 = Current input

OLDIN1 = Previous input

K1 = GAIN x (H + 2x LEAD) / (H + 2x LAG)

K2 = GAIN x (H - 2x LEAD) / (H + 2x LAG)

K3 = (2x LAG - H) / (2x LAG + H)

H = Sampling time (loop time)

LEAD-ONLY

OUT = [(Gain * (Input - Previous Input)) + k1 * Old Output]/K1 + 1

where:

GAIN = User Gain * (1 + K1)

K1 = Lead Constant/Sampling time (loop time)

340 OW360_R1100
 5.65 LEVELCOMP

5.65 LEVELCOMP
Description

The LEVELCOMP algorithm calculates the density compensated water level in a pressurized
steam drum. This compensation assumes a differential pressure transmitter is inputting the raw
level signal. One leg of the transmitter is connected to a condensate reservoir which establishes
the transmitter's maximum water level. The other side of the transmitter is connected to the point
which defines the minimum transmitter water level. The distance between these taps is the
transmitter range “D”. See the following figure for details of the assumed piping configuration.

Figure 18: Piping configuration

OW360_R1100 341
5.65 LEVELCOMP

The steam and water inside the drum are at saturation conditions. The water in the condensated
reservoir is pressurized water. The LEVELCOMP algorithm uses the specific volume of the steam
in the drum (µs), the specific volume of the water in the drum (µw) and the specific volume of the
water in the reference leg(µr), and the specific volume of the water at calibration conditions (µcal)
to compute the compensated level. The LEVELCOMP algorithm does the steamtable calculations
to obtain values for µs, µw, and µr based on input points pressure and temperature. The
derivation of µr requires an estimation of the average temperature in the condensate reference
column. The temperature can be a variable point or entered as a tuning constant. The calibration
fluid specific volume (µcal) is an estimated value entered as a tuning constant.

Figure 19: Calculations

The raw drum level input normally varies from a negative value for minimum level to a positive
value at a maximum to +20 inwc at a maximum with 0 inwc being normal water level. The
minimum (MIN) and maximum (MAX) values are not used in the compensation calculation. The
algorithm output has the same range as the input.

342 OW360_R1100
 5.65 LEVELCOMP

Invalid Real Numbers and Quality

If the output value is invalid, the quality of the OUT is set to BAD. If the pressure (PRES) or
temperature (TEMP) value is out of range for the compressed liquid, saturated liquid or saturated
vapor regions, the quality of OUT is set to BAD. Otherwise, the quality of OUT is set to the worst
quality of the inputs.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 112 Tuning diagram -

number
VCAL R1-Real Tuning Required 0.016049 Specific -
Constant Volume of
Calibration fluid
(lbs per ft3)
MAX R2-Real Tuning Required 1.0 Maximum Level -
Constant Range

MIN R3-Real Tuning Required 0.0 Minimum Level -

Constant Range

* TEMP R4-Real Selectable Required - Temperature of LA

water in
reference leg
(F)
PRES - Variable Required - Drum Pressure LA
(analog) (PSI)

OW360_R1100 343
5.65 LEVELCOMP

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Drum Level LA

Transmitter
(analog)
OUT - Variable Required - Output variable LA
(analog)
* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

Function

Where as D = maximum range level - minimum range level

LIN = IN1 - Min

344 OW360_R1100
 5.66 LOG

5.66 LOG
Description

The LOG algorithm performs the mathematical logarithmic function. For the LOG algorithm, the
output equals the base 10 logarithm of the input value plus a bias. If the input value is less than or
equal to zero, the output is set to a large negative number (-3.4 x 1038). The value of IN1 is
checked for invalid real numbers. If IN1 is valid, the quality of IN1 is propagated to the quality of
OUT and the real number value of OUT is written to the point record. If the value of IN1 is invalid
or if the calculated value of OUT written to the point record is invalid, the quality of OUT is set to
BAD.

Note: Other logarithmic algorithms are ANTILOG and NLOG.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 68 Tuning Diagram -

Number
BIAS R1-Real Tuning Optional 0.0 Bias Factor (+ or -) -
Constant

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

Function

OUT = LOG10 (IN1) + BIAS

OW360_R1100 345
5.67 LONGACC

5.67 LONG ACC

Description

The LONGACC algorithm integrates the input data in internal double precision floating point
format from the IN pin and sends the current value to the ACC output pin. The internal integration
is performed in double precision accumulator, but the results are shown through the standard (LA)
analog point (float number), so that the required horizon float number does not reach the
maximum allowed value (in OVATION that limit is set to +/- 1e+37). This value cannot be
changed. You can enable or disable the accumulation of the integrated input data in respective
directions by using EUPC and EDNC inputs, respectively.
 The ACC output is set to the Set Value (SV) when the Set Command (SC) is TRUE.
 The ACC output is set to the Increment Value (IV) when the Increment Command (IC) is
TRUE.
The error status of the LONGACC algorithm is calculated online. Pins IN and ACC are required
for generating the online error status, the rest of the pins are optional.

Functional symbol

The following table describes the input and output pins.

Input and output pins

REQUIRED /
INPUT / OUTPUT NAME POINT TYPE DESCRIPTION
OPTIONAL

Input IN LA Required Integrated value

Input Enable accumulation up
EUPC LD Optional
(Selectable) command

Input Enable accumulation down

ENDC LD Optional
(Selectable) command

Input
SV LA Optional Set value
(Selectable)

346 OW360_R1100
 5.67 LONGACC

REQUIRED /
INPUT / OUTPUT NAME POINT TYPE DESCRIPTION
OPTIONAL

Input
SC LD Optional Set command
(Selectable)
Input
IV LA Optional Increment value
(Selectable)
Input
IC LD Optional Increment command
(Selectable)
Output ACC LA Required Accumulated value
Output STAT LP Optional Algorithm status value

The following table describes the LONGACC input and output parameters.

Input and output parameters

PARAME TE RS DESCRIPTION VALUE

(DEFAULT
IS BOLD)

GAIN Input gain value. 1

Time correction factor. When TCORR is OFF, then the LONGACC
algorithm does not consider task area time and counts events gained by
R1.

ACCt  ACCt 1  IN  R1
When the TCORR is ON, then the LONGACC algorithm measures the
control task area time and the calculated outputs due to the following OFF
TCORR equation:
ON

MeasuredCntrlAreaTIME[in _ ms]
ACCt  ACCt 1  IN  R1
1000[in _ ms]
This mode allows you to sum the physical values, for example, liquid
flow (in that case, represents the flow in lb/s). If you set IN and
R1 to 1, then the LONGACC algorithm sums time in seconds.
Enables the accumulation up option. The LONGACC algorithm checks
this option when IN*R1>0 and EUPC are not connected. It is applied only OFF
EUP
to the IN input. This option does not impact, on set and increment ON
operation.
Enables the accumulation down option. The LONGACC algorithm
checks this option when IN*R1<0 and ENDC are not connected. It is OFF
EDN
applied only to the IN input. This option does not impact, on set and ON
increment operation.
Reconcile option allows you to reconcile the current value of ACC to
control sheet and database. This functionality is used before shutting OFF
RECOP
down both controllers. After the controllers' restart, the last reconciled ON
value is used as the initial value.

OW360_R1100 347
5.67 LONGACC

PARAME TE RS DESCRIPTION VALUE

(DEFAULT
IS BOLD)

Initiates the mechanism to initialize the accumulator value from the

Saved Point value from the flash memory. This functionality is useful OFF
INITP
during power failure. After the controllers' restart, the last saved value is ON
used as the initial value.
GOOD FAIR
Allows you to decide about the ACC pin quality after the controllers
QRECOP POOR
restart with the RECOP parameter ON.
BAD
Accuracy of summation. ASUM parameter allows you to define the
accuracy of summation. In each loop, the LONGACC algorithm checks
the accuracy in the following way:

tempValue = output;
output = output + incrementValue;
ASUM 1E-06
diff = output – tempValue;
IF (abs(diff) >= incrementValue) THEN error

If the LONGACC algorithm detects ERROR, then the output quality is set
to BAD quality. The quality (see page 352) stays in BAD state until reset.
Accuracy of summation is used for increment or decrement operation.

Note: All parameters except RECOP, QRECOP, and INITP are tunable. You can set their value in the
Control Builder and Signal Diagram after loading the controller.

Initialization RECOP and INITP options

The LONGACC algorithm is designed for redundant operations, therefore it maintains the
previous ACC value during failover of controllers.

However, when the last control is cleared or fails and the backup controller is not operational,
then the LONGACC algorithm cannot calculate the previous ACC value. For such cases, the
LONGACC algorithm automatically resets the ACC to 0 and assigns Poor Quality to the ACC
output. After that the LONGACC algorithm starts accumulation from 0. The quality stays in POOR
state until reset (see page 352).

The LONGACC algorithm implements the mechanism that allows to initialize the accumulator
value from the flash memory RECOP or from the database INITP (after power failure).

Note: This mechanism is implemented as an option, similar to the RUNTIME (see page 516)
algorithm.

348 OW360_R1100
 5.67 LONGACC

Mechanisms:
 When the LONGACC algorithm accumulator value is initialized through the flash memory,
then the quality of the ACC pin is set to the quality of the point saved in the memory (INITP).
 When the LONGACC algorithm accumulator value is initialized through the database then,
the quality of the ACC pin is set to the quality defined by the QRECOP parameter.
Functionalities of INITP and RECOP parameters:
 For the INITP parameter you need to create an analog point (Frequency A) with an option to
have a periodic save and use this point as the LONGACC output.
 For the RECOP parameter you need to reconcile before rebooting both the controllers.
 When both the parameters are ON, the LONGACC algorithm executes firstly the RECOP
parameter and then the INITP parameter. Therefore, if you want to to use the RECOP
parameter, then you need to turn off the INITP parameter.

5.67.1 Operations

Setup operation

Sets (initiates) the ACC to the user value. To execute this option, perform one of the following two
methods:
 Process (by input pins)
The SV (analog value) and the SC (digital value) setup commands are used. Both the setup
commands are optional.

 When SC is equal to 1, ACC is equal to SV.

 When SC is connected but SV is not connected, then the default value 0 is used for SV.
 Process initiated setup is deactivated if SC is not connected.
Process initiated setup has higher priority than any operator initiated action.

Notes:

 When SV is at BAD quality and is required to avoid the process initiated setup, the BAD
quality logic must be designed to deactivate the SC pin signal.
 The output ACC quality is set to BAD when, the SV value is NaN or INF or when the value is
close to the top and bottom limits.

 Operator initiated (by LC registers)

The operator initiated operation uses the setup value (SV) stored in R2 as the analog value.

 Value 1 is written to the G2 register, to initiate the output (ACC) to the value stored in R2.
 The value in G2 is automatically set to 0, by the LONGACC algorithm during initialization.
 The value in R2 remains unchanged after operation is completed. The default value for
R2 is 0.

Note: The output ACC quality is set to BAD when, the SV value is NaN or INF or when the
value is close to the top and bottom limits.

OW360_R1100 349
5.67 LONGACC

Increment operation

Increments the ACC by the user value. To execute this option use one of the following two
methods:
 Increment by pins
The IV (analog value) and IC (digital value) increment commands are used. Both the increment
commands are optional.

 When IC is equal to 1, ACC is incremented by IV.

 When IC is connected but IV is not connected, then the default value 0 is used for IV. In
this scenario, effective increment operation is not performed.
 Process initiated increment is deactivated if SC is not connected.
A process initiated increment has higher priority than any operator initiated action, but has
lower priority than the setup operation.

Notes:

 To avoid using the process initiated setup when IV is at BAD quality, design the BAD quality
logic to deactivate the IC pin signal.
 The output ACC increment quality is set to BAD when, the IV value is NaN or INF.
 When decrementing the algorithm provides negative value on the IV input.

 Increment by LC registers
The operator initiated increment operation uses the value stored in R3 as the analog value.

Value 1 is written to G3 register, to increment ACC by the value stored in R3.

Value in G3 is automatically set to 0, by the LONGACC algorithm during initialization.

The value in R3 remains unchanged after operation is completed. The default value for R3 is 0.

Notes:

 The output ACC increment quality is set to BAD when, the IV value is NaN or INF.
 When decrementing the algorithm provides negative value on the IV input or store the
negative value in R3.

5.67.2 Behavior on the limits

The LONGACC algorithm compares the ACC output to the internal algorithm limits that are set to
1e+37 and -1e+37, respectively.

When the ACC output reaches the 1e+37 or -1e+37 limit, then the LONGACC algorithm maintains
the ACC output on the limit and sets the ACC output quality to BAD. The quality stays in a BAD
state until reset (see page 352). Field B2 is used to inform the user about the internal status of the
LONGACC algorithm's STAT pin.

350 OW360_R1100
 5.67 LONGACC

5.67.3 Status of LONGACC algorithm during an error

The STAT output pin reports the internal information (errors) about the LONGACC algorithm.
When any of the bits are active then the quality of the output is set to BAD.

The following table describes the status bits utilized in the algorithm:

STAT output bits and description

BIT B2 FIELD DESCRIPTION

0 1 ACC value on the top limit.

1 2 ACC value on the bottom limit.
2 4 ACC value is NaN or Inf.
3 8 IN value is NaN or Inf.
4 16 IV value is NaN or Inf.
5 32 SV value is NaN or Inf.
6 64 Gain parameter value is NaN or Inf.
7 128 Accuracy of summation for IN pin is out of range.
8 256 Accuracy of summation for IV pin is out of range.
9-15 - Not used.

Notes:

 The STAT pin keeps the information until you reset the quality (see page 352).
 The STAT pin loses information when both the controllers are rebooted at the same time.

OW360_R1100 351
5.67 LONGACC

5.67.4 Point Quality

Output Point Quality

Note: The LONGACC algorithm does not evaluate the quality of IN, SV, and the IV inputs and
continues the calculations even if the inputs are BAD. There is only one exception, the input
value is ignored when the IN*GAIN value equals NaN or INF.

 The LONGACC algorithm input value is not calculated, when the input value equals NaN or
INF.
 When the SV value equals NaN or INF and SC is active, then the output value is set to the
last value having the BAD quality.
 When the IN*Gain value equals NaN or INF, then the output value is set to the last value
having the BAD quality.
 When the IV value equals NaN or INF and IC is active, then the increment operation (see
page 349) is executed and the LONGACC algorithm continues the IN value summation (only
when, IN is valid).
When the input returns to the correct value, then the LONGACC algorithm starts summation, but
the output quality stays in BAD state, until reset.

Reset Point Quality

The LONGACC algorithm sets the output to BAD quality during the following scenarios:
 Output was BAD and quality was not reset.
 SV value is NaN or INF and SC is active.
 IN value is NaN or INF.
 Gain value is NaN or INF.
 IV value is NaN or INF and IC is active.
 Output is limited to +/- 1e37 in any operation modes (see page 349).
 The LONGACC algorithm detects the error due to ASUM parameter for normal summing (IN
value),
 The LONGACC algorithm detects the error due to ASUM parameter for increment operation
(IV value),
 Output is invalid.
The BAD quality stays unit you reset the LONGACC algorithm. You can reset the quality in one of
the following three ways:
 Initiate ACC to the initial value (either through process or operator initialization).
 Increment the ACC as per the last recorded value (for example, the last good recorded value
in the Historian). This is done by the operator through the graphic. IV and IC input pins do not
record values.
 Manually reset the ACC quality pin by writing 1 to G0. The value in G0 is automatically set to
0 by the LONGACC algorithm, when the output quality updates to GOOD.

Note: The ACC output value does not change after being manually reset.

The LONGACC algorithm output quality is set to GOOD, when one of the above three methods
are followed.

352 OW360_R1100
 5.67 LONGACC

5.67.5 SID storage

The value of ACC is stored in R4, the SID of the STAT value is stored in C8, the SID of the ACC
value is stored in C7.

The SIDs of IN, EUP, EDN, SV, SC, IV, and IC inputs are stored in C0, C1, C2, C3, C4, C5, and
C6, respectively.
 These SIDs are read as the LONGACC algorithm record to the graphic variables of the
SYSID type.
 These SIDs are used as points in the graphical interface, instead of specifying the explicit
point names.

5.67.6 Algorithm definitions

Algorithm Record Type = LC

The following table describes the LONGACC algorithm definitions.

Algorithm definitions

LC MIN.
ALGORITHM REQUIRED/ DEFAULT PT.
NAME RECORD TYPE OPTIONAL VALUE DESCRIPTION REC.
FIELD

DIAG LU-Integer Data Init Required 120 Displays the tuning -

diagram number
GAIN R1 Tuning Required 1.0 Displays the gain -
Constant on input
TCORR X2 Tuning Required 0 Specifies the time -
Constant correction:
Bit 0
 0: OFF
 1: ON
EUP X3 Tuning Required 1 Enables -
Constant accumulation up:
Bit 0
 0: OFF
 1: ON

EDN X4 Tuning Required 1 Enables -

Constant accumulation down:
Bit 0
 0: OFF
 1: ON
RECOP X5 Data Init. Required 0 Specifies the -
reconcile options:
 0: OFF
 1: ON
INITP X6 Data Init. Required 0 Initializes ACC
value from Saved
Point:
 0: OFF
 1: ON

OW360_R1100 353
5.67 LONGACC

LC MIN.
ALGORITHM REQUIRED/ DEFAULT PT.
NAME RECORD TYPE OPTIONAL VALUE DESCRIPTION REC.
FIELD

QRECOP X7 Data Init. Required 2 Specifies the quality -

after reboot both
controllers when
RECOP is active:
 0: GOOD
 1: FAIR
 2: POOR
 3: BAD
ACCV R4 Tuning Required 0 Displays the total -
Constant accumulator value
(Reconcile)
ASUM S1 Tuning Required 1e-06 Specifies the -
Constant accuracy of
summation
IN - Variable Required - Displays the input LA
value
EUPC - Variable Optional - Enables LD
accumulation up
command (see
EUP parameter)
EDNC - Variable Optional - Enables LD
accumulation up
command (see
EDN parameter)
SV - Variable Optional - Displays the setup LA
value
SC - Variable Optional - Specifies the setup LD
command
IV - Variable Optional - Specifies the LA
increment value
IC - Variable Optional - Specifies the LD
increment
command
STAT - Variable Optional - Specifies the LP
algorithm status
value
ACC - Variable Required - Specifies the LA
accumulated output
value

354 OW360_R1100
 5.67 LONGACC

LC MIN.
ALGORITHM REQUIRED/ DEFAULT PT.
NAME RECORD TYPE OPTIONAL VALUE DESCRIPTION REC.
FIELD

Note: Internal algorithm registers do not exist in the template and are not reconciled.

Registers set by the LONGACC algorithm

- C0 - - - Displays the IN -
input SID
- C1 - - - Displays the EUP -
input SID
- C2 - - - Displays the EDN -
input SID
- C3 - - - Displays the SV -
input SID
- C4 - - - Displays the SC -
input SID
- C5 - - - Displays the IV -
input SID
- C6 - - - Displays the IC -
input SID
- C7 - - - Displays the ACC -
output SID
- C8 - -- - Displays the STAT -
output SID
- B2 - - - Displays the STAT
value in decimal
format
(see page 351).
- R4 - - - Displays the output -
value
- R5 - - - Specifies the time
speed correction

OW360_R1100 355
5.67 LONGACC

LC MIN.
ALGORITHM REQUIRED/ DEFAULT PT.
NAME RECORD TYPE OPTIONAL VALUE DESCRIPTION REC.
FIELD

Registers set by you from the graphic

- G0 - - - Resets BAD quality -
on output. Value is
not changed
- R2 - - - Displays the initial -
set up value,
default 0
- G2 - - - Specifies the setup
command:
 0: not active
 1: active
Default is 0
- R3 - - - Displays the initial -
incremental value,
default 0
- G3 - - - Displays the
incremental
command:
 0: not active
 1: active
Default is 0

356 OW360_R1100
 5.68 LOSELECT

5.68 LOSELECT
Description

The LOSELECT algorithm performs a gain and bias on the four inputs. The output is equal to the
smallest of the four values, according to the quality (QUAL) parameter.

The quality (QUAL) parameter contains three options that enable you to select the value and type
of quality that the output point receives.

The WORSE option selects the lower value for an output point, independent of the qualities of
the input points. The output point is assigned the worst quality of the input points.

The SELECTED option also selects the lowest value, independent of the qualities of the input
points. The output point is assigned the value and quality of the selected input point. However, if
any of the gained and biased values are equal, the best quality is assigned to the output point.

The NOTBAD option selects the lowest gained and biased input value, providing the qualities of
both inputs are not BAD. The quality of the output is set equal to the quality of the input selected
or to the better quality of the two inputs if the gained and biased input values are equal. If one
input has BAD quality, the gained and bias input value and the quality of the input with the not
BAD quality are assigned to the output. The output is equal to the lowest gained and biased input
value and contains BAD quality if both input qualities are BAD.

Note: If the algorithm calculates an invalid output value by using one of the gained and biased
inputs, the value of the other point is used for the output.

If the calculated track output is invalid, then the IN2 track output is equal to the IN2 input, and
the IN1 track output is equal to the IN1 input, if the inputs are valid. If the calculated track
outputs and the input values are invalid, then the IN2 and IN1 track outputs are not updated.

If the algorithm receives an invalid value as an input, or if it calculates an invalid value as an

output, the drop is placed into alarm.

Functional symbol

OW360_R1100 357
5.68 LOSELECT

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status of
the analog tracking point. This algorithm takes the following action in response to the information
found in the analog input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TRK1 SIGNAL

16 Track Implemented and passed Implemented and passed

through. Passed through or set through. Passed through or set
17 Track if lower TRUE when IN1 input is not TRUE when IN2 input is not
selected and IN1 gain is >0*. selected and IN2 gain is >0*.

18 Track if higher Passed through or set TRUE Passed through or set TRUE
when IN1 input is not selected when IN2 input is not selected
and IN1 gain is >0*. and IN2 gain is >0*.

19 Lower inhibit Passed through** Passed through**

20 Raise inhibit Passed through** Passed through**

21 Conditional Track Implemented Passed through***

22 Not used Not used Not used

23 Deviation Alarm Not used Not used

24 Local Manual mode Not used Not used

25 Manual mode Not used Not used

26 Auto mode Not used Not used

27 Not Used Not used Not used

28 Not Used Not used Not used

29 Not Used Not used Not used

30 Low limit reached Low limit reached Not used

31 High limit reached High limit reached Not used

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the definitions
given in Setting Tracking Signals (see page 17).

*** If the algorithm is being told to track, then the Conditional track bit is ignored. Otherwise,
the value of the conditional track bit is transferred to all output track points. If the Conditional Track bit
is set in the track input point, the analog value of all output track points is calculated based on the
analog value of the track input point.

358 OW360_R1100
 5.68 LOSELECT

The high and low limit flags, and the tracking signals from the algorithm are output to TRK2,
TRK3, and TRK4, to be used for display and by upstream algorithms. If the output value is invalid,
the quality of OUT is set to BAD. Otherwise, the quality of OUT is set according to the QUALITY
(QUAL) parameter. When tracking, the quality is set to the quality of the track input variable.

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 80 Tuning Diagram -

Number
IN1G R1-Real Tuning Required 1.0 Gain on Input 1. -
Constant The gain on the
input should
never be
initialized to zero;
if it is, the drop is
placed into alarm.
IN1B R2-Real Tuning Optional 0.0 Bias on Input 1. -
Constant

IN2G R3-Real Tuning Required 1.0 Gain on input 2. -

Constant The gain on the
input should
never be
initialized to zero;
if it is, the drop is
placed into alarm.
IN2B R4-Real Tuning Optional 0.0 Bias on input 2. -
Constant

IN3G R8-Real Tuning Optional 1.0 Gain on Input 3. -

Constant The gain on the
input should
never be
initialized to zero.
IN3B R9-Real Tuning Optional 0.0 Bias on Input 3. -
Constant

IN4G S1-Real Tuning Optional 1.0 Gain on Input 4. -

Constant The gain on the
input should
never be
initialized to zero.
IN4B S2-Real Tuning Optional 0.0 Bias on Input 4. -
Constant

TPSC R5-Real Tuning Required 1E+09 Maximum value -

Constant of the output
(999999999) point
BTSC R6-Real Tuning Required -1E+09 Minimum value of -
Constant the output point
(-999999999)

OW360_R1100 359
5.68 LOSELECT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TRAT R7-Real Tuning Required 2.5 Track ramp rate -

Constant (units per
second).
QUAL X1-Byte Data Init. Required WORSE Output quality -
Bits 0 type.
 WORSE =
Worst quality of
the four inputs
is selected.
 SELECTED =
Output point is
assigned the
quality of the
selected input
point. If the
values of the
input points are
equal, the best
quality is
selected.
 NOTBAD = The
output point is
assigned the
quality of the
selected input
point, providing
the qualities of
the two inputs
are not BAD. If
one input point
quality is BAD,
the output is
assigned the
quality of the
not BAD input.
The better
quality of the
two inputs is
selected if the
input values are
equal.
IN1 - Variable Required - Input 1 (analog) LA

TRK1 - Variable Required - Track output LA

value mode and
status signals for
Input 1
IN2 - Variable Required - Input 2 (analog) LA

TRK2 - Variable Required - Track output LA

value mode and
status signals for
input 2 variable
IN3 - Variable Optional - Input 3 (analog) LA

360 OW360_R1100
 5.68 LOSELECT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TRK 3 - Variable Optional - Track output LA

value mode and
status signals for
input 3.
IN4 - Variable Optional - Input 4 (analog) LA

TRK 4 - Variable Optional - Track output LA

value mode and
status signals for
input 4.
OUT - Variable Required - Analog output LA
variable
TRIN - Variable Optional - Tracking and LA
Limiting mode
signals and
tracking value
analog input
variable

Function
IN1GB = (IN1 x IN1 GAIN) + IN1BIAS
IN2GB = (IN2 x IN2 GAIN) + IN2 BIAS
IN3GB = (IN3 x IN3 GAIN) + IN3BAS
IN4GB = (IN4 x IN4 GAIN) + IN4BAS
IF IN2GB <= IN1GB THEN
OUT = IN2GB
ELSE
OUT = IN1GB
If IN3G <= OUTPUT
OUT = IN3G
If IN4G <= OUTPUT
OUT = IN4G
IF OUT >= TPSC THEN
OUT = TPSC
ELSE
IF OUT <= BTSC THEN
OUT = BTSC

OW360_R1100 361
5.69 LOWMON

5.69 LOWMON
Description

The LOWMON algorithm is a low signal monitor with reset deadband and a fixed variable limit.
For the LOWMON (Low signal monitor, reset deadband) algorithm, if the input value (IN1) goes
below the fixed set point value (LOSP), the digital output is set TRUE. To clear the output, IN1
must be greater than the set point value plus the deadband. The value of IN1 is checked for
invalid real numbers. If IN1 is invalid, OUT retains its last valid value, and the quality of OUT is set
to BAD. The quality of IN1 is not propagated.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 60 Tuning -

Diagram
Number
IN1 - Variable Required - Input (analog) LA

* LOSP R1-Real Selectable Required 0.0 Set point for the LA

low signal
monitor trip
point
LODB R2-Real Tuning Required 0.0 Deadband -
Constant

OUT - Variable Required - Output (digital) LD, LP

* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder
may default the parameter to a value and mark it as "Optional." However, for the control function to
be executed properly, you must enter a value for the parameter.

Function

IF IN1 < LOSP

THEN OUT = TRUE
ELSE
IF IN1 > (LOSP + LODB)
THEN OUT = FALSE

362 OW360_R1100
 5.70 MAMODE

5.70 MAMODE
Description

MAMODE is used in conjunction with a MASTATION algorithm. This algorithm is used to send the
priorities (raise/lower), inhibits (raise/lower), reject (manual/auto), track bit and Slew Bias
commands to the MASTATION. If Bias is TRUE, then MASTATION can raise/lower the Bias
value. If Bias is FALSE, the Bias value is slewed to zero and the Bias value is not allowed to be
raised or lowered.

The output TRK, AUTO, MAN and LOC points are set TRUE based on the MASTATION's track
point connected to the algorithm.

Raise/Lower Inhibit and Priorities work as follows:

 When Raise Inhibit and Lower Inhibit occur at the same time, the MASTATION will be locked.
 When Priority Lower and Priority Raise occur at the same time, the MASTATION will ignore
the commands.
 When Raise Inhibit and Priority Raise occur at the same time, the output of the MASTATION
will be locked.
 When Lower Inhibit and Priority Lower occur at the same time, the output of the MASTATION
will be locked.

Functional symbol

Bits In Mode:

Bits description

BIT DESCRIPTION

Bit 0 Priority Lower

Bit 1 Priority Raise

Bit 2 Low Inhibit

Bit 3 High Inhibit

Bit 4 Manual Reject

Bit 5 Auto Reject

Bit 6 Bias Active

OW360_R1100 363
5.70 MAMODE

BIT DESCRIPTION

Bit 7 Set Tracking Bit

Bit 8 Indicate Low Inhibit

Bit 9 Indicate High Inhibit

Bit 10 Local Mode

Bit 11 MASTATION is in manual mode

Bit 12 MASTATON is in auto

Bit 13 MASTATON is told to track

Bit 14 RLI priority lower

Bit 15 RLI priority raise

Note: If a mode word is provided, its contents are decoded and shown in the Control Builder in
the bottom status bar along with the track words. Refer Ovation Control Builder User Guide for
more information.

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

PLW - Variable Optional - Priority Lower LD, LP

input
PRA - Variable Optional - Priority Raise LD, LP
input
LWI - Variable Optional - Lower Inhibit LD, LP
input
RAI - Variable Optional - Raise Inhibit LD, LP
input
MRE - Variable Optional - Manual Reject LD, LP
input
ARE - Variable Optional - Auto Reject LD, LP
input
BACT - Variable Optional - Bias Active input LD, LP

364 OW360_R1100
 5.70 MAMODE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

STRK - Variable Optional - Set LD, LP

MASTATION
track bit
TRK - Variable Optional - MASTATION is LD, LP
based on TRIN
point
AUTO - Variable Optional - Auto Mode LD, LP
output
MAN - Variable Optional - Manual Mode LD, LP
output
LOC - Variable Optional - Local Mode LD, LP
output
MODE - Variable Optional - Output to LP
MASTATION

OW360_R1100 365
5.71 MASTATION

5.71 MASTATION
Description

MASTATION algorithm interfaces a CRT-based soft manual/auto station and an optional Ovation
Loop Interface module card with the functional processor.

The following modes are available: Auto, Manual, and Local.

You select one of the following interfaces with the TYPE Algorithm Field:
 SOFT - Soft manual/auto station only
 RLI - Ovation Loop Interface module
 RVP - Ovation Valve Position module

Functional symbol

If an Ovation Loop Interface Module is set in TYPE and the Controller is reset, powered-up or
fails, the output is read from the Ovation Loop Interface module card and used initially in the OUT
field of the algorithm. This reports the status of the field device before any action is taken by either
the algorithm or the operator.

Note: The TPSC and BTSC parameters are used to limit the output value of the algorithm.
These values must always be 100% and 0%, respectively when a SLIM interfaces to an
Ovation Loop Interface module card.

Auto Mode

The output equals the gained and biased input plus the bias bar value
(OUT = (IN1 x IN1 GAIN) + IN1 BIAS + BIAS BAR) except:
 When the algorithm is told to track, the output equals the track input when the tracking signal
is present. The output ramps from the track input back to the gained and biased input when
the tracking signal is removed.
 When a raise inhibit or lower inhibit signal is present, it may prevent the output from following
the input.

366 OW360_R1100
 5.71 MASTATION

The bias bar value is output as an analog value and may be raised or lowered by the
Increase/Decrease set point keys (arrow up/arrow down) on the Operator's Keyboard. This value
is only added to the output value in Auto mode; it has no effect on the output (but still may be
raised or lowered) in Manual or Local mode.

If an Ovation Loop Interface module is selected, the output value is written to the card.

The Increase/Decrease Output keys on the Operator's Keyboard have no effect in this mode.

Manual Mode

The output is raised or lowered by using the Increase/Decrease Output requests. The raise inhibit
and lower inhibit signals override the Operator's Keyboard Increase/Decrease Output requests.
The tracking signal causes the output to equal the track input, regardless of the raise/lower inhibit
signals and the Increase/Decrease Output key requests. The bias bar value has no effect on the
output, but still may be raised and lowered.

If an LI interface is selected, the output value is written to the card. The output value may also be
raised or lowered from the Loop Interface Module (SLIM) in this mode.

Local Mode

This mode is only available if an LI Module, type interface has been selected. The
Increase/Decrease commands from the SLIM directly control the LI card, which is in Local mode.
The algorithm either reads the demand counter on the LI, and causes its output to track the card's
value. In this tracking mode, all directional commands inside the functional processor (for
example, Variable Input, Raise Inhibit and Lower Inhibit) and directional commands from the
Operator's/Alarm Console (for example, Increase, Decrease) have no effect on the algorithm.

Mode Transfers

The algorithm transfers between the Auto, Manual, and Local modes as follows:
 The digital reject signal from the MAMODE Algorithm rejects the algorithm from Auto to
Manual mode.
 The Auto Request and Manual Request signals from the AUTO and MAN mode request keys
on the Operator's Keyboard switch the algorithm to the desired mode if it is not in Local mode.
 If the LI is selected, the SLIM can switch the algorithm between Auto, Manual, and Local
modes.
 If the LI is selected, and if there are hardware errors, the algorithm rejects to Local mode. If
the card determines that there is a SLIM communications error while it is in Local mode, it
rejects the card to Manual mode. The algorithm also goes to Manual mode.
 If the Quality Reject (REJQ) feature is OFF, then the quality check is not performed on the
input when in Auto mode. If the algorithm is in Auto mode and the quality of the input goes
BAD or not GOOD depending on the Quality Reject flag, then the algorithm rejects the card to
Manual mode.
 Regardless of the REJQ parameter, the input value (IN1) is checked for an invalid value when
the algorithm is in Auto mode. If the algorithm is in Auto mode and the value of the input
becomes invalid, the algorithm rejects the card to Manual mode. If the algorithm is not in Auto
mode and the operator tries to select Auto mode when the input value is invalid, the algorithm
remains in the same mode and does not reject the card to Manual mode.

OW360_R1100 367
5.71 MASTATION

 The track input value is also be checked for invalid real numbers when the algorithm is being
told to track. While in Auto mode, if the algorithm is told to track and the track input value is
invalid, the algorithm rejects the card to Manual mode. In all modes, the track request is
ignored when the track input value is invalid.
 On reset/power-up, the algorithm is in Local mode if a LI interface is selected. If a soft
interface is selected, then the algorithm goes to the mode initialized by the First pass mode
(FP) parameter.
 On reset/power-up of the LI card, if LI interface is selected and RLI priority (PRLI) is YES,
then the algorithm is set to local mode and the output value is zero. If the LI interface is
selected and RLI priority (PRLI) is NO, then the algorithm changes the RLI card mode from
local to the last mode before the card is powered down. The LI analog output value is
initialized to the last output value before the card was powered off.
The interface keys of the Operator's Keyboard are:

Keys

KEY USE

AUTO Function Key Auto mode request

MAN Function Key Manual mode request

Set Point Increase Function Key Raise the bias bar (up arrow)

Set Point Decrease Function Key Lower the bias bar (down arrow)

Output Increase Function Key Raise the output (up triangle)

Output Decrease Function Key Lower the output (down triangle)

Manual Reject Output Point

The MRE point becomes true for the amount of time specified in the MRET parameter. The
algorithm sets the point true anytime the algorithm goes to manual (unless specified by operator
request).

368 OW360_R1100
 5.71 MASTATION

Priority Raise/Lower

The Priority Raise/Lower functionality (PRAR, PRAT, PLWR, PLWT parameters) is available
when the MODE input pin is connected to output of MAMODE algorithm.

If bit 0 (Priority Lower) in MODE pin is active, the MASTATON output is decreased with the rate
defined by the PLWR (Priority Lower Rate) parameter. In that case, the output is going to the
value defined by the PLWT (Priority Lower Target) parameter. If the PLWT value is lower than the
BTSC limit, the MASTATION output stops on the BTSC limit.

If bit 1 (Priority Raise) in MODE pin is active, the MASTATON output is increased with the rate
defined by the PRAR (Priority Raise Rate) parameter. In that case, the output is going to the
value defined by the PRAT (Priority Raise Target) parameter. If the PRAT value is lower than the
TPSC limit, the MASTATION output stops on the TPSC limit.

If both bits (Priority Lower and Priority Raise) are active at the same time, the MASTATION will
ignore these commands.

Operational symbol

The following symbol illustrates the operation of MASTATION via a SAMA representation.

OW360_R1100 369
5.71 MASTATION

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog track point. This algorithm takes the action shown in the following table in response
to the information found in the analog input signal TRIN.

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through, set TRUE on first pass

to read the hardware, or set TRUE
when not in Auto mode.

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit Implemented* Passed through*

20 Raise inhibit Implemented Passed through***

21 Conditional Track Implemented Passed through***

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Local mode

25 Manual mode No action Manual mode

26 Auto mode No action Auto mode

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the definitions given
in Setting Tracking Signals (see page 17).

*** If the algorithm is being told to track, then the Conditional track bit is ignored. Otherwise, the
value of the conditional track bit is transferred to all output track points. If the Conditional Track
bit is set in the track input point, the analog value of all output track points is calculated based on
the analog value of the track input point.

Note: If a mode word is provided, its contents are decoded and shown in the Control Builder in
the bottom status bar along with the track words. See Ovation Control Builder User Guide for
more information.

370 OW360_R1100
 5.71 MASTATION

The high and low limit flags, the mode and the tracking signals from the algorithm are output to
TOUT, to be used for display and by an upstream algorithm. The configuration of the use of this
algorithm must be specified by the user for correct implementation of the tracking features. If the
upstream algorithm is BALANCER, then the configuration must indicate that this algorithm is
being used with the BALANCER algorithm. Otherwise, the configuration is specified as NORMAL.

If a BAD hardware status error caused the algorithm to reject to Local, the quality remains BAD
on the output and the algorithm remains in Local mode until the error is cleared. If a write error
caused the algorithm to reject to Local, the quality becomes GOOD on the output and the
algorithm remains in Local mode until Local mode is exited via the SLIM.

If there are no hardware errors, the quality of OUT is set to the quality of the track input variable
when tracking. Otherwise, the quality of OUT is GOOD when in Manual mode or set to the quality
of the input when in Auto mode.

If the algorithm calculates an invalid real number for the output in Auto mode, the quality of OUT
is set to BAD and the drop is placed into alarm.

Note: If the algorithm generates an invalid track output value, the IN1 input value is used as the
track output, unless it is invalid. The track output value is not updated if both the calculated track
output and IN1 input values are invalid.

The TPSC and BTSC parameters are used to limit the output value of the algorithm. These values
must always be 100% and 0%, respectively, when interfacing to an LI card which is connected to
a SLIM.

Any output raise or lower request, from the Operator Station is sent directly to the LI configured as
an electric drive card type when it is in Failed Local mode. The LI outputs any SLIM raise or lower
requests for the output, then outputs any controller raise or lower requests for the output to the
digital raise or lower outputs.

When the position feedback signal of an LI configured as an electric drive card type fails, the LI
goes to Failed Local mode and the value of output point is the feedback signal from the drive. The
output bar SLIM display flashes between 0 and 100% to indicate the Failed Local mode.

The options to have runbacks and/or interface to an electric drive on the LI card must be
configured through the I/O Builder.

CAUTION! When using the MASTATION algorithm with a BALANCER algorithm, follow these
guidelines:

1. If MASTATION precedes BALANCER, set the MASTATION CNFG parameter to NORMAL.

2. For all MASTATIONS that immediately follow BALANCER, set MASTATIONS CNFG
parameter to BALANCER.

3. For MASTATIONS that follow MASTATIONS in Guideline 2, set CNFG parameter to

NORMAL.

OW360_R1100 371
5.71 MASTATION

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 10 Tuning Diagram -

Number
IN1G R5-Real Tuning Required 1.0 Gain on input. -
Constant The cascade gain
should never be
initialized to zero;
if it is, the drop is
placed into alarm.
IN1B R6-Real Tuning Optional 0.0 Bias on input -
Constant

* TPSC R7-Real Selectable Required 100.0 Maximum value LA

of the output point

* BTSC R8-Real Selectable Required 0.0 Minimum value of LA

the output point

TPBS R2-Real Tuning Required 0.0 Maximum value -

Constant of the bias bar

BTBS R3-Real Tuning Required 0.0 Minimum value of -

Constant the bias bar

PCNT X1-Byte Tuning Required 4 Percent change in -

Constant first four seconds

TIME X2-Byte Tuning Required 25 Number of -

Constant seconds
remaining for
ramp to full scale
FP G0-Integer Data Init. Required MANUAL First pass mode. -
Bit 8 Algorithm goes to
this mode on
reset/power-up:
MANUAL: Manual
mode
AUTO: Auto
mode
TYPE G0-Integer Data Init. Optional SOFT Interface Card -
Bits 0 type:
and 1
SOFT: Soft M/A
only
RLI: LI card
RVP: VP Card
DRVE G0-Integer Data Init Optional NO Electric Drive: -
Bit 9
NO
YES

372 OW360_R1100
 5.71 MASTATION

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

CARD X5-Byte Data Init Optional 1 PCI Card Number -

(1, 2)
For OCR400 - 1
only
For OCR1100 - 1
only
HWAD B2-Integer Data Init. Optional 0 Card address -
(see page 3) for
any hardware
interface (in
decimal bytes).
RDNT X3-Byte Data Init Required NO Redundant RVP -
Bit 0 cards:
NO
YES
HWA2 YU-Integer Data Init Required 0 Redundant RVP -
hardware address

PRLI G0-Integer Data Init Required YES RLI Priority: -

Bit 2
YES
NO
PRAR S1-Real Tuning Optional 2.5 Priority Raise -
Constant Rate

PRAT S2-Real Tuning Optional 100.0 Priority Raise -

Constant Target

PLWR S3-Real Tuning Optional 2.5 Priority Lower -

Constant Rate

PLWT S4-Real Tuning Optional 0.0 Priority Lower -

Constant Target

OW360_R1100 373
5.71 MASTATION

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

REJQ G0-Integer Data Init. Required BAD Quality reject type -

Bits 6 and 7 (only has
meaning if
Manual Inhibit is
OFF):
 BAD: Algorithm
rejects to
Manual mode
when the quality
of the IN1 input
goes BAD and
the algorithm is
in Auto mode.
 NOTGOOD:
Algorithm
rejects to
Manual mode
when the quality
of the IN1 input
is NOT GOOD
and the
algorithm is in
Auto mode.
 OFF: The
quality of the
IN1 input is not
checked or
used to reject
the algorithm to
Manual mode
when the
algorithm is in
Auto mode.
CNFG G0-Integer Data Init. Required NORMAL Configuration -
Bit 5 type:
 NORMAL: -
Upstream
algorithm is not
BALANCER
 BALANCER: -
Upstream
algorithm is
BALANCER
TRAT R1-Real Tuning Required 2.5 Track ramp rate -
Constant
MRET G1 Tuning Optional 5 Manual reject -
Constant time in seconds.

MRE - Variable Optional - Manual reject LD

point
IN1 - Variable Required - Input 1 variable LA
analog input

374 OW360_R1100
 5.71 MASTATION

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TOUT - Variable Required - Track output LA

value mode and
status signals for
Input 1 variable
MODE - Variable Optional - Output point from LP
the MAMODE
algorithm
OUT - Variable Required - Analog output LA
variable
TRIN - Variable Optional - Tracking and LA
Limiting mode
signals and
tracking value;
analog Input
variable
BIAS - Variable Optional - Analog bias bar LA
variable output

* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

OW360_R1100 375
5.72 MASTERSEQ

5.72 MASTERSEQ
Description

The MASTERSEQ (SEQUENCER, MASTER) algorithm provides a supervisory algorithm to

control sequential execution of control functions. The algorithm utilizes individual DEVICESEQ
algorithms to provide an interface to the logic functions being executed in each step of the
sequence. Each MASTERSEQ algorithm can have a maximum of 30 DEVICESEQ algorithms
attached. Each of the individual DEVICESEQ algorithms is referred to as a device. If more than
30 devices are required, then multiple MASTERSEQ algorithms can be cascaded together.

The algorithm monitors the device that corresponds to each step via a packed group point. This
packed group point is termed the status point. There is a unique status point for each device. The
status point serves as both input and output for the MASTERSEQ and DEVICESEQ algorithms
according to the bit definitions in the accompanying table. A device is considered “on” or “running”
when bit zero, in its associated packed group status point, is equal to logic 1. Likewise, a device is
considered “off” or “stopped” when bit zero is equal to logic zero.

Functional symbol

376 OW360_R1100
 5.72 MASTERSEQ

User Configuration

The attached devices are numbered sequentially from 1-30 and the associated default status
points are named DV01-DV30 respectively. These 30 devices can be sequenced in any
user-defined order. The 30 integer fields in the algorithm template (ST01-ST30) correspond to the
30 possible steps. The steps are numbered sequentially. In order to associate a particular device
with a step number, the device number is included in the integer field that corresponds to that
step number. A particular device can be included in multiple steps in the sequence. The current
step number being considered by the MASTERSEQ is stored in the STEP output.

In the following sections, a step is considered complete when the DEVICESEQ algorithm
assigned to that step indicates a success or failure or the user overrides the step via the OVRD
input. If a step references a device that does not exist or a zero is specified as the device number
for a particular step, then, that step is skipped and the algorithm increments the step.

The MASTERSEQ algorithm can operate in two modes. These are normal mode and priority
mode. In normal mode, the step numbers increase sequentially and the corresponding devices
are executed accordingly. In priority mode, the step number that corresponds to the device to be
executed is input to the algorithm via the TKIN input. That step is executed when the TMOD input
is TRUE. The order of the steps does not need to be sequential. This allows the sequence to be
dynamically adaptive based on the requirements of a particular application.

The algorithm is reset to the initial state when the RSET input is TRUE regardless of the mode of
operation. Any time the RSET input is TRUE, it causes the algorithm to clear all bits in the status
point, stop any device that is currently running, and set the current step to zero. Refer to the reset
flow chart for a visual depiction of the actions performed when the RSET input is TRUE.

Initial State

The initial step of the algorithm, on power-up, is zero. At step zero, no devices are active. In
normal mode, if the ENBL input is equal to logic one, the algorithm sequences to the first
available step. If the ENBL input is equal to logic 0, then all devices are ignored and remain in
their previous state and the algorithm is inactive. A step is considered to be available if its
associated device number corresponds to a DEVICESEQ algorithm that is connected to the
MASTERSEQ algorithm. If the device number is valid, the device is considered for execution
according to the rules outlined in the following sections. If the ENBL input is FALSE the algorithm
is inactive regardless of the mode of operation.

Normal Mode Step Execution and Control

In the normal mode of operation, the sequential execution of the connected devices is controlled
via the PRCD and OVRD inputs on the algorithm. The PRCD input acts as a “start” button. If the
PRCD input is TRUE, the algorithm reads the value of the READY and FAILED bits from the
associated status point. Refer to the description of the DEVICESEQ algorithm for details on how
the READY and FAILED bits in the status point are initialized. If the associated device is READY
and not FAILED, the algorithm sets bit one, in the status point that corresponds to that device, to
logic 1.

If the READY bit in the status point is FALSE, the algorithm sets the HOLD output to logic 1. If the
FAILED bit is TRUE, the algorithm sets HOLD output to logic 1. In both of these conditions, the
algorithm remains at the current step.

OW360_R1100 377
5.72 MASTERSEQ

If while a device is running, the SUCCESS bit becomes TRUE in the corresponding status point,
the algorithm sets bit zero in the status point to logic 1 (thus stopping the device) and the step is
incremented to the next step sequential number. The next device is not started unless the PRCD
input is TRUE.

If while a device is running, the FAILED bit becomes TRUE in the status point, the step number is
not be incremented and both the HOLD and FAIL outputs are set to logic 1. Once this condition is
reached, one of the following actions must occur in order for the step to increment:

A. The FAIL condition must be cleared which causes the FAIL output to be set to logic zero and
the step is incremented to the next sequential number.

B. The OVRD input must be set to logic 1, which causes the step to increment to the next
sequential number.

If at any time during execution, the OVRD input becomes equal to logic 1, the algorithm
increments the current step. If the OVRD input is equal to logic 1 while a particular step is being
executed, the algorithm turns the corresponding device off and the step number is incremented to
the next available step. Any tine the step is incremented as a result of the OVRD input, the
OVERRIDE bit is set to 1 at the status point. This provides a history feature for each step to
indicate how the step number was advanced. If the PRCD and OVRD inputs are equal to logic 1
simultaneously, the OVRD takes precedence.

When the last step in the sequence has completed, the algorithm sets the DONE output logic to 1.
At this point, the algorithm must be reset to begin operation again.

Refer to the normal mode flow chart for a visual depiction of the operation of the algorithm when
operating in normal mode.

Priority Mode Step Execution and Control

In priority mode, the step number to be executed is determined by the analog value of the TKIN
input. Any fractional value to the right of the decimal point, in the TKIN input value, is truncated.
This gives you the ability to dynamically steer the algorithm to any desired step in the sequence.
The value of the TKIN input is used as the step number only if the TMOD input is TRUE. Thus the
algorithm is considered to be in priority mode when the step number is determined from the TKIN
input. As in normal mode, the PRCD input must be TRUE in order for the execution of the step to
begin.

If the value of TKIN is equal to a step that corresponds to a valid device, the TMOD input is TRUE
and PRCD input is FALSE, the algorithm sets the current step to the TKIN value. However, the
step is not executed until the PRCD input becomes TRUE. When operating in Priority Mode, the
algorithm ignores the OVRD input. If the value of the TKIN refers to a device that does not exist,
the algorithm remains at the previous step. If a device is running, the TKIN and TMOD inputs are
ignored until the step completes.

If the MODE parameter is advisory, TKIN must be less than the maximum number of steps
(NMIN). If the MODE parameter is priority, then TKIN must be less than 30 (the total number of
allowed steps). This applies only in priority mode. All other checks for valid device apply no matter
what the priority MODE parameter is set to.

If the READY bit, in the status point, is TRUE and the FAILED bit is FALSE, the algorithm issues
a start to the associated device. This is accomplished by setting bit zero in the status point to
logic 1.

378 OW360_R1100
 5.72 MASTERSEQ

If the READY bit in the status point is FALSE, the algorithm sets the HOLD output logic to 1. If the
FAILED bit is TRUE, the algorithm sets both the HOLD and FAIL output to logic 1. In both of
these conditions, the algorithm remains at the current step.

If while a device is running, the SUCCESS bit becomes TRUE in the corresponding status point,
the algorithm sets bit zero in the status point logic 0 (thus stopping the device). The step is set to
the value of the TKIN input if it is a valid step. The next device is not started unless the PRCD
input is TRUE.

If while a device is running, the FAILED bit becomes TRUE in the status point, both the HOLD
and FAIL outputs are set to logic 1. When this condition is reached, the current step can be
changed via the TKIN and TMOD inputs.

Refer to the priority mode flow chart for a visual depiction of the operation of the algorithm when
operating in priority mode.

If any time during the priority mode operation the TMOD input becomes FALSE, the algorithm
reverts to normal mode operation. The hybrid mode section outlines the operation of the algorithm
using a combination of normal mode and priority mode.

Hybrid Mode Operation

It is possible to operate the algorithm in a hybrid mode where some steps are performed in
normal mode and others in Priority Mode. The mode switch is controlled by the digital value of the
TMOD input and thus can be done dynamically. When operating in normal mode, the normal
mode rules outlined above apply and when operating in priority mode, the priority mode rules
above apply.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 3 Tuning -

Diagram
Number
MODE X2-Byte Data Init Required Advisory Mode of -
operation:
 Advisory
 Priority
NMIN X1-Byte Tuning Required 0 Number of -
Constant Steps

ST01 G0- Integer Tuning Required 0 Device Number -

Constant for Step 1

ST02 G1- Integer Tuning Required 0 Device Number -

Constant for Step 2

ST03 G2- Integer Tuning Required 0 Device Number -

Constant for Step 3

OW360_R1100 379
5.72 MASTERSEQ

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

ST04 G3- Integer Tuning Required 0 Device Number -

Constant for Step 4

ST05 G4- Integer Tuning Required 0 Device Number -

Constant for Step 5

ST06 G5- Integer Tuning Required 0 Device Number -

Constant for Step 6

ST07 G6- Integer Tuning Required 0 Device Number -

Constant for Step 7

ST08 G7- Integer Tuning Required 0 Device Number -

Constant for Step 8

ST09 G8- Integer Tuning Required 0 Device Number -

Constant for Step 9

ST10 G9- Integer Tuning Required 0 Device Number -

Constant for Step 10

ST11 B0- Integer Tuning Required 0 Device Number -

Constant for Step 11

ST12 B1- Integer Tuning Required 0 Device Number -

Constant for Step 12

ST13 B2- Integer Tuning Required 0 Device Number -

Constant for Step 13

ST14 YU- Integer Tuning Required 0 Device Number -

Constant for Step 14

ST15 B4- Integer Tuning Required 0 Device Number -

Constant for Step 15

ST16 B5- Integer Tuning Required 0 Device Number -

Constant for Step 16

ST17 B6- Integer Tuning Required 0 Device Number -

Constant for Step 17

ST18 B7- Integer Tuning Required 0 Device Number -

Constant for Step 18

ST19 B8- Integer Tuning Required 0 Device Number -

Constant for Step 19

ST20 B9- Integer Tuning Required 0 Device Number -

Constant for Step 20

ST21 C0- Integer Tuning Required 0 Device Number -

Constant for Step 21

ST22 C1- Integer Tuning Required 0 Device Number -

Constant for Step 22

ST23 C2- Integer Tuning Required 0 Device Number -

Constant for Step 23

380 OW360_R1100
 5.72 MASTERSEQ

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

ST24 C3- Integer Tuning Required 0 Device Number -

Constant for Step 24

ST25 C4- Integer Tuning Required 0 Device Number -

Constant for Step 25

ST26 C5- Integer Tuning Required 0 Device Number -

Constant for Step 26

ST27 C6- Integer Tuning Required 0 Device Number -

Constant for Step 27

ST28 C7- Integer Tuning Required 0 Device Number -

Constant for Step 28

ST29 C8- Integer Tuning Required 0 Device Number -

Constant for Step 29

ST30 YT- Integer Tuning Required 0 Device Number -

Constant for Step 30

ENBL - Variable Required - MASTERSEQ LD, LP

is inoperative
anytime this
signal is
FALSE.
OVRD - Variable Required - Proceed to LD, LP
next step
ignoring any
status of the
current step.
PRCD - Variable Required - Execute the LD, LP
current step.
RSET - Variable Required - Re-Initializes LD, LP
algorithm to
step zero.
TKIN - Variable Optional - Dynamic step LA
value.
TMOD - Variable Optional - Activate Priority LD, LP
mode.
FAIL - Variable Required - TRUE When a LD, LP
DEVICESEQ
algorithm
reports a
failure.
HOLD - Variable Required - TRUE when LD, LP
algorithm is
waiting to
execute current
step.

OW360_R1100 381
5.72 MASTERSEQ

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DONE - Variable Required - TRUE When LD, LP

Master
completes last
defined step.
(Can be used
to daisy chain
multiple
MASTERSEQ).
STEP - Variable Required - Number of LA
current step
(1-30)
DV01 - Variable Required - Communication LP
with Device
Algorithm 1
(See Bit
Definitions)
DV02 - Variable Optional - Communication LP
with Device
Algorithm 2
(See Bit
Definitions).
DV03 - Variable Optional - Communication LP
with Device
Algorithm 3
(See Bit
Definitions).
DV04 - Variable Optional - Communication LP
with Device
Algorithm 4
(See Bit
Definitions).
DV05 - Variable Optional - Communication LP
with Device
Algorithm 5
(See Bit
Definitions).
DV06 - Variable Optional - Communication LP
with Device
Algorithm 6
(See Bit
Definitions).
DV07 - Variable Optional - Communication LP
with Device
Algorithm 7
(See Bit
Definitions).

382 OW360_R1100
 5.72 MASTERSEQ

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DV08 - Variable Optional - Communication LP

with Device
Algorithm 8
(See Bit
Definitions).
DV09 - Variable Optional - Communication LP
with Device
Algorithm 9
(See Bit
Definitions).
DV10 - Variable Optional - Communication LP
with Device
Algorithm 10
(See Bit
Definitions).
DV11 - Variable Optional - Communication LP
with Device
Algorithm 11
(See Bit
Definitions).
DV12 - Variable Optional - Communication LP
with Device
Algorithm 12
(See Bit
Definitions).
DV13 - Variable Optional - Communication LP
with Device
Algorithm 13
(See Bit
Definitions).
DV14 - Variable Optional - Communication LP
with Device
Algorithm 14
(See Bit
Definitions).
DV15 - Variable Optional - Communication LP
with Device
Algorithm 15
(See Bit
Definitions).
DV16 - Variable Optional - Communication LP
with Device
Algorithm 16
(See Bit
Definitions).

OW360_R1100 383
5.72 MASTERSEQ

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DV17 - Variable Optional - Communication LP

with Device
Algorithm 17
(See Bit
Definitions).
DV18 - Variable Optional - Communication LP
with Device
Algorithm 18
(See Bit
Definitions).
DV19 - Variable Optional - Communication LP
with Device
Algorithm 19
(See Bit
Definitions).
DV20 - Variable Optional - Communication LP
with Device
Algorithm 20
(See Bit
Definitions).
DV21 - Variable Optional - Communication LP
with Device
Algorithm 21
(See Bit
Definitions).
DV22 - Variable Optional - Communication LP
with Device
Algorithm 22
(See Bit
Definitions).
DV23 - Variable Optional - Communication LP
with Device
Algorithm 23
(See Bit
Definitions).
DV24 - Variable Optional - Communication LP
with Device
Algorithm 24
(See Bit
Definitions).
DV25 - Variable Optional - Communication LP
with Device
Algorithm 25
(See Bit
Definitions).

384 OW360_R1100
 5.72 MASTERSEQ

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DV26 - Variable Optional - Communication LP

with Device
Algorithm 26
(See Bit
Definitions).
DV27 - Variable Optional - Communication LP
with Device
Algorithm 27
(See Bit
Definitions).
DV28 - Variable Optional - Communication LP
with Device
Algorithm 28
(See Bit
Definitions).
DV29 - Variable Optional - Communication LP
with Device
Algorithm 29
(See Bit
Definitions).
DV30 - Variable Optional - Communication LP
with Device
Algorithm 30
(See Bit
Definitions).

OW360_R1100 385
5.72 MASTERSEQ

Status Bit definitions

BIT ORIGINATOR SIGNAL NAME DESCRIPTION

NUMBER

0 MASTERSEQ GO Signal to Device to Begin Step.

1 DEVICESEQ FAILED Signal to MASTERSEQ that Current Step

Encountered a Failure.

2 DEVICESEQ READY Signal to MASTERSEQ that the low-level

Logic is Ready to Receive a Remote Start
Command.

3 DEVICESEQ SUCCESS Signal to MASTERSEQ that current Step

Completed Successfully.

4 MASTERSEQ INSTEP Signal from Master that the step is currently

being Executed.

5 MASTERSEQ OVERRIDE When TRUE indicates that the OVRD input

was used to Increment the step.

6 MASTERSEQ RESET MASTERSEQ sets this bit logic 1 when

reset input is TRUE.

7 DEVICESEQ FROZEN This bit is TRUE when DEVICESEQ has

Frozen updates to the status point (see
DEVICESEQ section for data)

8 - 15 Reserved for - -
future use.

386 OW360_R1100
 5.72 MASTERSEQ

Figure 20: Normal mode

OW360_R1100 387
5.72 MASTERSEQ

Figure 21: Priority mode

388 OW360_R1100
 5.73 MEDIANSEL

5.73 MEDI ANSEL

Description

The MEDIANSEL (Median value selector, quality and deviation checks) algorithm monitors analog
transmitter inputs for quality and deviation from each other. The output (OUT) of the algorithm is
the median of the three analog inputs as long as there are no Quality or Deviation Alarms.
Otherwise, the algorithm determines the best or most probably correct input or average of inputs
for the output value. In addition to the output signal (OUT), there is a High Alarm analog output
(HI), a Low Alarm analog output (LO) and 12 digital signals, indicating the states of the inputs,
which may be output as individual digital points or as a packed digital record.

Functional symbol

The type of quality on the input that sets the Quality Alarm for that point is initialized in the Control
Indicator Word. The Control Deviation Alarm digital output signal between two points is set TRUE
when the difference of the two points is greater than the user-initialized Control Deviation
Deadband (CNDB) and the two points are not in Quality Alarm. Also, the Alarm Deviation Alarm
digital output signal between two points is set TRUE when the difference of the two points is
greater than the user-initialized Alarm Deviation Deadband (ALDB) and the two points are not in
Quality Alarm. The Alarm Deviation Deadband should be less than the Control Deviation
Deadband for the algorithm to function properly.

If all three transmitters are in Quality Alarm, the output value remains the last GOOD value. In
addition, if all three transmitters are in quality alarm or if the output (OUT) value is invalid, the
quality of the output is set to BAD.

If two transmitters are in Quality Alarm, the output value is the value of the transmitter that is
not in Quality Alarm.

If one transmitter is in Quality Alarm and there is no Control Deviation Alarm between the
two transmitters not in Quality Alarm, the output value is the average of the two transmitters
not in Quality Alarm.

OW360_R1100 389
5.73 MEDIANSEL

If one transmitter is in Quality Alarm and there is a Control Deviation alarm between the
two transmitters not in Quality Alarm, the output value is:

1. The higher value of the two transmitters not in Quality Alarm if the higher value is greater than
the High Alarm Monitor value (HMTR) and the lower value is not less than the Low Alarm
Monitor value (LMTR).
OR
2. The lower value of the two transmitters not in Quality Alarm if the lower value is less than the
Low Alarm Monitor value and the higher value is not greater than the High Alarm Monitor
value.
OR
3. Either the higher or lower value of the two transmitters not in Quality Alarm, depending on the
High/Low Output parameter initialized in the Control Indicator Word.

If none of the transmitters are in Quality Alarm but all three transmitters are in Control
Deviation with each other, the output value is:

1. The highest value of the transmitters if the higher value is greater than the High Alarm Monitor
value (HMTR) and the lowest value is not less than the Low Alarm Monitor value (LMTR).
OR
2. The lowest value of the transmitters if the lowest value is less than the Low Alarm Monitor
value and the highest value is not greater than the High Alarm Monitor value.
OR
3. Either the highest or lowest value of the transmitters, depending on the High/Low Output
parameter initialized in the Control Indicator Word.

If none of the transmitters are in Quality Alarm but one transmitter is in Control Deviation
with both of the other two transmitters and there is no Control Deviation alarm between the
other two transmitters, the output value is the average of the two transmitters not in Control
Deviation Alarm with each other. If none of the transmitters are in Quality Alarm and two
transmitters are in Control Deviation Alarm with each other but not with the third transmitter, the
output value is the value of the third (median) transmitter.

If none of the transmitters are in Quality or Control Deviation Alarm and either all or none
of the three transmitters are in Alarm Deviation with each other, the output is the median
value of the transmitters.

If none of the transmitters are in Quality or Control Deviation Alarm but one transmitter is
in Alarm Deviation with both of the other two transmitters and there is no Alarm Deviation
between the other two transmitters, the output value is the average of the two transmitters not
in Alarm Deviation with each other.

If none of the transmitters are in Quality or Control Deviation Alarm and two transmitters
are in Alarm Deviation with each other but not with the third transmitter, the output value is
the value of the third (median) transmitter.

If none of the transmitters are in Control Deviation Alarm with each other, the high alarm
output and low alarm output values are set equal to the output value. Otherwise, the high alarm
output value is set equal to the highest transmitter value not in Quality Alarm, and the low alarm
output value is set equal to the lowest transmitter value not in Quality Alarm.

390 OW360_R1100
 5.73 MEDIANSEL

The Transmitter Quality Alarm digital output (XBQ) is set TRUE when all three transmitters are in
Quality Alarm. The Transmitter A Quality Alarm digital output (XABQ) is set TRUE when
Transmitter A is in Quality Alarm. The Transmitter B Quality Alarm digital output (XBBQ) is set
TRUE when Transmitter B is in Quality Alarm. The Transmitter C Quality Alarm digital output
(XCBQ) is set TRUE when Transmitter C is in Quality Alarm.

The Transmitter A - Transmitter B Control Deviation Alarm digital output (ABDC) is set TRUE
when the deviation between Transmitter A and Transmitter B is greater than the Control Deviation
Deadband. The Transmitter A - Transmitter C Control Deviation Alarm digital output (ACDC) is set
TRUE when the deviation between Transmitter A and Transmitter C is greater than the Control
Deviation Deadband. The Transmitter B - Transmitter C Control Deviation Alarm digital output
(BCDC) is set TRUE when the deviation between Transmitter B and Transmitter C is greater than
the Control Deviation Deadband.

The Transmitter A - Transmitter B Alarm Deviation Alarm digital output (ABDA) is set TRUE when
the deviation between Transmitter A and Transmitter B is greater than the Alarm Deviation
Deadband. The Transmitter A - Transmitter C Alarm Deviation Alarm digital output (ACDA) is set
TRUE when the deviation between Transmitter A and Transmitter C is greater than the Alarm
Deviation deadband. The Transmitter B - Transmitter C Alarm Deviation Alarm digital output
(BCDA) is set TRUE when the deviation between Transmitter B and Transmitter C is greater than
the Alarm Deviation Deadband.

The Transmitter Malfunction Alarm digital output (XALM) is set TRUE when there is a Quality
Alarm on any of the three signals or when the deviation between any two transmitter values is
greater than either the Control Deviation Deadband or the Alarm Deviation Deadband.

The Manual Reject digital output (MRE) is set TRUE:

1. When all three transmitters are in Quality Alarm.

OR
2. When there is one point in Quality Alarm and there is a Control Deviation Alarm between the
two points not in Quality Alarm.
OR
3. When all three transmitters are in Control Deviation with each other.

The Manual Reject digital output is either a one-shot signal or a maintained output, depending on
the MRE output type that is initialized in the Control Indicator Word (CNTL).

The Packed output signal (PBPT) contains the Manual Reject output, the Transmitter Malfunction
Alarm, the Quality Alarms, the Control Deviation Alarms, and the Alarm Deviation Alarms for all
three transmitters.

The HOLD parameter holds the output value and quality for a desired number of loops when a
manual reject occurs.

OW360_R1100 391
5.73 MEDIANSEL

The Interface keys on the Operators Keyboard are:

Function keys

FUNCTION KEY USE

P1 Median Mode Requested

P2 Transmitter A Mode requested

P3 Transmitter B Mode requested

P4 Transmitter C Mode requested

P5 Toggle the inhibiting of the control deviation alarm check on the manual
reject (MRE) output

Note: If the transmitter selected goes to BAD quality, then the algorithm changes mode to
median.

Invalid Numbers and Quality

The transmitter's input values to the algorithms are checked for invalid real numbers. If an input
value contains an invalid real number, it is not used in generating the output of the algorithm.
However, the Transmitter Quality Alarm digital output for the point is set to TRUE if the input value
is invalid.

If the algorithm calculates an invalid real number for the output, the quality of the output is set to
BAD and the output value is invalid.

INSEL parameter

The INSEL parameter determines which inputs of the MEDIANSEL algorithm are being used to
calculate the output. The Signal Diagram application displays green circles around the active pins.
If none of the pins are selected, then nothing will display. You can also view this information via
the Process Diagram System graphics as well. Refer to Ovation Operator Station User Guide for
more information on the Signal Diagrams application and the Process Diagram System graphics.

The MEDIANSEL algorithm activates individual bits in the Y0 field depending on the conditions in
the description field. If a signal is active, that signal is being used in the output calculation.

392 OW360_R1100
 5.73 MEDIANSEL

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init. Required 62 Tuning Diagram -

Number.
CNTL X1-Byte Data Init. Optional 0 Control Indicator Word: -
 Bit 0 = MRE Output
Type (0 = One-shot
signal
1 = Maintained
signal)
 Bit 1 = High/Low
Output (0 = Selected
high GOOD quality
output
1 = Select low
GOOD quality
output)
 Bit 2 = Quality Alarm
Type (0 = BAD
Quality Alarm
1 = Not GOOD
Quality Alarm)
ALDB R1-Real Tuning Required 0.0 Alarm Deviation -
Constant Deadband.

CNDB R2-Real Tuning Required 0.0 Control Deviation -

Constant Deadband.

HMTR R3-Real Tuning Required 0.0 High Alarm monitor -

Constant value.

LMTR R4-Real Tuning Required 0.0 Low Alarm monitor -

Constant value.

HOLD X7-Byte Data Init Required 0 Hold output during -

manual reject (number
based on loop time).

XA - Variable Required - Input (analog); LA

Transmitter A.
XB - Variable Required - Input (analog); LA
Transmitter B.
XC - Variable Required - Input (analog); LA
Transmitter C.
OUT - Variable Required - Output (analog); LA
median value.

HI - Variable Optional - Output (analog); High LA

Alarm monitoring
value.

OW360_R1100 393
5.73 MEDIANSEL

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

LO - Variable Optional - Output (analog); Low LA

Alarm monitoring
value.
XBQ - Variable Optional - Output (digital); all LD, LP
transmitters in Quality
Alarm.
XABQ - Variable Optional - Output (digital); Quality LD, LP
Alarm for
Transmitter A.
XBBQ - Variable Optional - Output (digital); Quality LD, LP
Alarm for
Transmitter B.
XCBQ - Variable Optional - Output (digital); Quality LD, LP
Alarm for
Transmitter C.
ABDC - Variable Optional - Output (digital); LD, LP
Control Deviation
Alarm between
Transmitters A and B.
ABDA - Variable Optional - Output (digital); Alarm LD, LP
Deviation Alarm
between Transmitters
A and B.
ACDC - Variable Optional - Output (digital); LD, LP
Control Deviation
Alarm between
Transmitter A and C.
ACDA - Variable Optional - Output (digital); Alarm LD, LP
Deviation Alarm
between Transmitters
A and C.
BCDC - Variable Optional - Output (digital); LD, LP
Control Deviation
Alarm Transmitters B
and C
BCDA - Variable Optional - Output (digital); Alarm LD, LP
Deviation Alarm
between Transmitters
B and C.
XALM - Variable Optional - Output (digital); LD, LP
Transmitter
Malfunction Alarm.
MRE - Variable Optional - Output (digital); LD, LP
manual reject.

394 OW360_R1100
 5.73 MEDIANSEL

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

PBPT - Variable Optional - Output (packed digital) LP

(bit and description
shown):
 0 = Manual reject
 1 = Transmitter
malfunction
 2 = All transmitters in
Quality Alarm
 3 = Quality Alarm for
Transmitter A
 4 = Quality Alarm for
Transmitter B
 5 = Quality Alarm for
Transmitter C
 6 = Alarm deviation
between
Transmitters A and B
 7 = Alarm deviation
between
Transmitters A and C
 8 = Alarm deviation
between
Transmitters B and C
 9 = Control deviation
between
Transmitters A and B
 10 = Control
deviation between
Transmitters A and C
 11 = Control
deviation between
Transmitters B and C
 12 = Inhibit Control
Deviation Check for
MRE Output
 13 = Transmitter A
mode
 14 = Transmitter B
mode
 15 = Transmitter C
mode

OW360_R1100 395
5.73 MEDIANSEL

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

INSEL* Y0 Alg. Init Required 0 Input Selected: --

 Bit 1 - Signal A
0 = Not Active
1 = Active
 Bit 2 - Signal B
0 = Not Active
1 = Active
 Bit 3 - Signal C
0 = Not active
1 = Active
* If no inputs are selected, it indicates one of the following:
 the inputs are all BAD quality.
 the output is scan removed.
 Manual Reject is activated with HOLD.
 the calculated output is invalid.

396 OW360_R1100
 5.74 MULTIPLY

5.74 MULTIPLY
Description

The MULTIPLY algorithm multiplies two gained and biased inputs. The output of the MULTIPLY
algorithm is the product of the two individually gained and biased inputs.

Functional symbol

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog point. This algorithm takes the following action in response to the information found
in the analog input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit No action Passed through**

20 Raise inhibit No action Passed through**

21 Conditional Track Implemented Passed through***

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Not used No action Not used

28 Not used No action Not used

29 Not used No action Not used

30 Low limit reached No action Low limit reached

OW360_R1100 397
5.74 MULTIPLY

BIT DESCRIPTION ACTION TOUT SIGNAL

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the definitions given
in Setting Tracking Signals (see page 16).

*** If the algorithm is being told to track, then the Conditional track bit is ignored. Otherwise, the
value of the conditional track bit is transferred to all output track points. If the Conditional Track bit
is set in the track input point, the analog value of all output track points is calculated based on the
analog value of the track input point.

The high and low limit flags and the tracking signals from the algorithm are output to TOUT, to be
used for display and by an upstream algorithm. If the output value is invalid, the quality of OUT is
set to BAD. Otherwise, the quality of OUT is set to the worst quality of the two inputs when not in
tracking mode. When tracking, the quality is set to the quality of the track input variable.

Note: If the algorithm generates an invalid track output value, the IN1 input value is used as the
track output, unless it is invalid. The track output value is not updated if both the calculated track
output and IN1input values are invalid.

In addition, you may turn off the tracking output calculations. This may be done to support control
logic designs that require fast execution times (such as 20 msec). The TBLK parameter can be
set to OFF, which will disable the tracking calculations and local memory operations. The default
value for TBLK is ON, which means the algorithm performs the tracking calculations.

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 82 Tuning -

Diagram
Number
IN1G R1-Real Tuning Required 1.0 Gain on input 1. -
Constant The gain on
input 1 should
never be
initialized to
zero; if it is, the
drop is placed
into alarm.
IN1B R2-Real Tuning Required 0.0 Bias on input 1 -
Constant

IN2G R3-Real Tuning Required 1.0 Gain on input 2 -

Constant

IN2B R4-Real Tuning Required 0.0 Bias on input 2 -

Constant

398 OW360_R1100
 5.74 MULTIPLY

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TPSC R5-Real Tuning Required 1E+09 Maximum value -

Constant of the output
(999999999) point
BTSC R6-Real Tuning Required -1E+09 Minimum value -
Constant of the output
(-999999999) point
TRAT R7-Real Tuning Required 2.5 Track ramp rate -
Constant (units per
second)
TBLK X3 - Byte Data Init. Required ON Enable tracking -
Bit 0 calculations
and local
memory
operations. The
choices are:
 ON
 OFF
IN1 - Variable Required - Analog input 1 LA

TOUT - Variable Required - Track output LA

value mode
and status
signals for input
1 variable
IN2 - Variable Required - Analog input 2 LA

OUT - Variable Required - Analog output LA

variable
TRIN - Variable Optional - Tracking and LA
limiting mode
signals and
tracking value;
analog input
variable

Function

IN1GB= (IN1 x IN1G) + IN1B

IN2GB = (IN2 x IN2G) + IN2B
OUT = IN2GB x IN1GB
IF OUT >= TPSC THEN
OUT = TPSC
ELSE
IF OUT <= BTSC THEN
OUT = BTSC

OW360_R1100 399
5.75 MULTISWITCH

5.75 MULTISWITCH

Description

The MULTISWITCH algorithm is designed to operate with very high performance. Due to the
functionality, the MULTISWITCH algorithm is limited to calculate the series transfer logic
structure.

Functional symbol

MULTISWITCH algorithm input and output pins

 In the MULTISWITCH algorithm all the input pins are optional.
 In the MULTISWITCH algorithm the output pin can be connected, but the output value is
always calculated.
 If the input selector flag (S2, ...., S5) is not connected, then its value is assumed to be FALSE.
 Each of the analog input is equipped with the GAIN and BIAS parameters.
The following table describes the MULTISWITCH algorithm input and output pins.

Input and output pins

INPUT/ MIN. POINT REQUIRED/

NAME DESCRIPTION
OUTPUT REC. OPTIONAL

Input IN1 LA Optional Input 1 value

Input IN2 LA Optional Input 2 value

Input IN3 LA Optional Input 3 value
Input IN4 LA Optional Input 4 value
Input IN5 LA Optional Input 5 value
Input S2 LD Optional Input 2 selector

400 OW360_R1100
 5.75 MULTISWITCH

INPUT/ MIN. POINT REQUIRED/

NAME DESCRIPTION
OUTPUT REC. OPTIONAL

Input S3 LD Optional Input 3 selector

Input S4 LD Optional Input 4 selector
Input S5 LD Optional Input 5 selector
Output OUT LA Optional Output value

Input Points Quality

The MULTISWITCH algorithm does not evaluate the quality of the INx (IN1, ...., IN5) input pins.
When the input pin value is equal to NaN or INF, then the value is propagated and the quality of
the OUT pin is set to BAD.

Note: The quality on the other input pins are not evaluated.

 The value and the quality of the selected input is transferred directly to the output.
 The quality of the remaining connected input pins, but not selected input pins are not
propagated and is not used by the MULTISWITCH algorithm.

MULTISWITCH algorithm parameters

All the MULTISWITCH algorithm parameters are tunable. You can set the values of the
parameters in the Control Builder and the Signal diagram after loading the Controller.

Parameters

PARAME TE R DESCRIPTION VALUE

G1 Gain on input 1 1

B1 Bias on input 1 0

G2 Gain on input 2 1

B2 Bias on input 2 0

G3 Gain on input 3 1

B3 Bias on input 3 0

G4 Gain on input 4 1

B4 Bias on input 4 0
G5 Gain on input 5 1
B5 Bias on input 5 0

OW360_R1100 401
5.75 MULTISWITCH

Tracking

To make fast calculations, the MULTISWITCH algorithm does not support the tracking
functionality.

Limits

The output of the MULTISWITCH algorithm is not limited to HIGH limit and LOW limit. The input
of the INx (IN1, ...., IN5) pins are limited to 1e37 and -1e37, respectively.

5.75.1 Functions

The following are the functionalities of the MULTISWITCH algorithm.

 To indicate which input pins are selected, by checking the S2, ..., S5 pin connections and
their pin values.
 To indicate the input pin connections and their values for the input pin that is selected from
the pins INx (IN1, ....., IN5).
 To calculate the output value using the following equation:

OUT  GAINx  INx  BIASx

where, x is the selected input number.

When the input selector pins are not connected and their values are not set to TRUE, then by
default, the MULTISWITCH algorithm uses the IN1 input value with the G1 and the B1 parameter
values. When the same input selector pins are connected, then the MULTISWITCH algorithm
uses the input pin having the highest priority.

The following table describes the input selector pins priority.

Selector pins priority

CONNECTED SELECTED
PRIORITY
SELECTOR INPUT

ANY IN1 4 (the lowest)

S2 IN2 3
S3 IN3 2
S4 IN4 1
S5 IN5 0 (the highest)

When one of the input pins INx (In1, ...., IN5) is not connected, then the following equation is used
to calculate the INx output value.

OUT  GAINx  0x  BIASx

402 OW360_R1100
 5.75 MULTISWITCH

5.75.2 Algorithm definitions

Algorithm Record Type = LC

The following table describes the MULTISWITCH algorithm definitions.

Algorithm definitions

LC ALG. MIN.
RECORD REQUIRED/ DEFAULT POINT
NAME FIELD TYPE OPTIONAL VALUE DESCRIPTION REC.

DIAG LU-Integer Data Init Required 120 Specifies the -

tuning diagram
number.
G1 R1 Tuning Required 1.0 Displays the gain -
Constant on input 1
B1 S1 Tuning Required 0 Displays the bias -
Constant on input 1
G2 R2 Tuning Required 1.0 Displays the gain -
Constant on input 2
B2 S2 Tuning Required 0 Displays the bias -
Constant on input 2
G3 R3 Tuning Required 1.0 Displays the gain -
Constant on input 3
B3 S3 Tuning Required 0 Displays the bias -
Constant on input 3
G4 R4 Tuning Required 1.0 Displays the gain -
Constant on input 4
B4 S4 Tuning Required 0 Displays the bias -
Constant on input 4
G5 R5 Tuning Required 1.0 Displays the gain -
Constant on input 5
B5 S5 Tuning Optional 0 Displays the bias -
Constant on input 5
IN1 - Variable Optional - Specifies the LA
input 1
IN2 - Variable Optional - Specifies the LA
input 2
IN3 - Variable Optional - Specifies the LA
input 3
IN4 - Variable Optional - Specifies the LA
input 4
IN5 - Variable Optional - Specifies the LA
input 5

OW360_R1100 403
5.75 MULTISWITCH

LC ALG. MIN.
RECORD REQUIRED/ DEFAULT POINT
NAME FIELD TYPE OPTIONAL VALUE DESCRIPTION REC.

S2 - Variable Optional - Specifies the LL

selector for Input 2
S3 - Variable Optional - Specifies the LL
selector for Input 3
S4 - Variable Optional - Specifies the LL
selector for Input 4
S5 - Variable Optional - Specifies the LL
selector for Input 5

404 OW360_R1100
 5.76 NLOG

5.76 NLOG
Description

The NLOG algorithm performs the mathematical natural logarithmic function. For the NLOG
algorithm, the output equals the natural logarithm of the input value plus a bias. If the input value
is less than or equal to zero, the output is set to a large negative number (-3.4 x 1038).

Note: Other logarithmic algorithms are ANTILOG (see page 88) and LOG (see page 345).

Invalid Numbers and Quality

The quality of the input is propagated to the output. However, if the algorithm calculates an invalid
value for the output, the quality of the output is set to BAD, and the output value is invalid.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 70 Tuning Diagram -

Number
BIAS R1-Real Tuning Optional 0.0 Bias -
Constant

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

Function

OUT = NATURAL LOG OF IN1 + BIAS

OW360_R1100 405
5.77 NOT

5.77 NOT
Description

The NOT algorithm is a logical NOT gate. For the NOT algorithm, the output is the logical NOT of
the input.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (digital) LD, LP

OUT - Variable Required/ - Output (digital) LD, LP

Optional

Note: Output is required if connecting to anything other than OR or AND.

Function

IF IN1 = TRUE
THEN OUT = FALSE
ELSE
OUT = TRUE

406 OW360_R1100
 5.78 OFFDELAY

5.78 OFFDELAY
Description

The OFFDELAY algorithm extends the time that the output is TRUE. On a FALSE-to-TRUE state
level change of the IN1 (Pulse Stretcher), the Timer ACTUAL (ACT) is set to zero and the OUT
output is TRUE.

On a subsequent TRUE-to-FALSE state level change of the IN1, the ACTUAL (ACT) begins
accumulating time. When ACTUAL (ACT) is equal to the TARGET (TARG), accumulation stops,
the OUT output is set to FALSE, and ACTUAL (ACT) retains data until it is reset by another
FALSE-to-TRUE state level change of the IN1 input.

If the TARGET (TARG) value specifies a time which is less than or equal to the sheet scan time, it
is permissible for the OUT output to be set FALSE on the same scan that the IN1 input changed
from TRUE to FALSE.

The timers are re-triggerable (that is, the ACTUAL (ACT) can be reset before it reaches the
TARGET (TARG) value).

The OUT output is de-energized if (ACT >= TARG).

If the TARGET (TARG) or ACTUAL (ACT) operands contain a negative or invalid number, OUT is
set to FALSE but no other operation takes place.

When a Controller resets, if IN1 is FALSE, ACTUAL (ACT) remains unchanged and the OUT
output is TRUE according to the comparison between the ACTUAL (ACT) and the TARGET
(TARG). However, if the ACTUAL (ACT) has an initial value, then the ACTUAL'S (ACT's) initial
value is compared to TARG. If IN1 is TRUE, ACTUAL (ACT) is set to zero and OUT is TRUE.

In redundant Controllers, during Fail over, if IN1 is FALSE, ACTUAL (ACT) remains unchanged
and both outputs are TRUE according to the comparison between the ACTUAL (ACT) and
TARGET (TARG). If IN1 is TRUE, ACT is set to zero and OUT is TRUE.

An optional time base (minimum of 0.1 second) can be entered in the R1 field of the algorithm
record. The default time base is 1 second.

Functional symbol

OW360_R1100 407
5.78 OFFDELAY

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 97 Tuning -

Diagram
number
BASE R1-Real Tuning Required 1.0 Time Base in -
Constant seconds
(minimum 0.1
second, default
1.0 seconds)
IN1 - Variable Required - Input (digital) LD, LP

* TARG R2-Real Selectable Required 0.0 Delay Time LA

number
(analog)
* ACT R3-Real Selectable Required 0.0 Output LA
(analog)
OUT - Variable Required - Output (digital) LD, LP

* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

Function (Timing Diagram)

(IN1)

TARGET TARGET

408 OW360_R1100
 5.79 ONDELAY

5.79 ONDELAY
Description

The ONDELAY algorithm delays the time that the output is set to TRUE. When the ONDELAY
algorithm is enabled with the IN1 input TRUE, the Timer ACTUAL (ACT) accumulates time per
the specified Time BASE (BASE) until it equals the Timer TARGET (TARG). At this point, it stops
accumulating and remains at the TARGET (TARG) value and OUT goes to TRUE.

If the IN1 input changes from TRUE to FALSE while the Timer is enabled (ENBL), the ACTUAL
(ACT) retains the current value. When the IN1 input changes back to the TRUE state, the
ACTUAL (ACT) resumes accumulating time.

You can reset ACTUAL (ACT) to zero at any time by making the ENBL input FALSE. This causes
OUT to go FALSE. Typically; however, the IN1 and ENBL inputs are tied together so that
ONDELAY acts as a “classical” timer.

Note: If ENBL is not connected, the algorithm works as a “classical” timer. The same
functionality can be achieved when the IN1 and ENBL inputs are tied together.

If the ACTUAL (ACT) value is equal to or greater than the TARGET (TARG) value, transitions of
the IN1 input have no effect.

Of special consideration is the case when the Timer TARGET (TARG) equals zero. In this
instance, the OUT output follows the IN1 input as long as the Timer is enabled.

If the TARGET (TARG) specifies a time which is less than or equal to the sheet scan time, it is
permissible for the OUT output to be TRUE on the first scan that the IN1 and ENBL inputs are
TRUE.

If the TARGET (TARG) or ACTUAL (ACT) operands contain a negative or invalid number, OUT is
set to FALSE but no other operation takes place.

When a Controller resets, if ENBL is TRUE, ACTUAL (ACT) remains unchanged and the OUT
output is energized according to the comparison between ACTUAL (ACT) and TARGET (TARG).
However, if ACTUAL (ACT) has an initial value, then ACT's initial value is compared to TARGET
(TARG). If ENBL is FALSE, ACTUAL (ACT) is set to zero and OUT is FALSE.

In redundant Controllers, during Failover, if ENBL is energized, ACTUAL (ACT) remains

unchanged and both outputs are energized according to the comparison between ACTUAL (ACT)
and TARGET (TARG). If ENBL is FALSE, ACTUAL (ACT) is set to zero and OUT is FALSE.

An optional time base (minimum of 0.1 second) can be entered in the R1 field of the algorithm
record. The default time base is 1 second.

OW360_R1100 409
5.79 ONDELAY

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 96 Tuning -

Diagram
number
BASE R1-Real Tuning Required 1.0 Time Base -
Constant seconds
(minimum 0.1
second, default
1.0 seconds)
IN1 - Variable Required - Input (digital) LD, LP

ENBL - Variable Optional - Input (digital) LD, LP

* TARG R2-Real Selectable Required 0.0 Delay Time LA

number
(analog)
* ACT R3-Real Selectable Required 0.0 Output (analog) LA

OUT - Variable Required - Output (digital) LD, LP

* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder
may default the parameter to a value and mark it as "Optional." However, for the control function to
be executed properly, you must enter a value for the parameter.

Function (Tuning Diagram)

(IN1)

TARGET TARGET TARGET

410 OW360_R1100
 5.80 ONESHOT

5.80 ONESHOT
Description

The ONESHOT algorithm sets the output to TRUE on a transition for a specified period of time.
The period of time is defined in units of time by the BASE parameter and the TARGET (TARG)
parameter or by the loops number by the Pulse in Loops (LPS) parameter.

By default, the LPS parameter is set to 0 and the period of time is defined by the BASE and the
TARG parameters. When the LPS parameter is set to any positive value, then the period of time
is automatically defined by the LPS parameter. And, the BASE and the TARG parameters are
ignored.

Period of Time defined by the BASE and the TARG parameters (LPS parameter = 0)

On a FALSE-to-TRUE transition of the IN1 input, the OUT output energizes. The ACTUAL (ACT)
is reset to zero and immediately begins accumulating time, and continues to accumulate until it
equals the TARGET (TARG) or until another FALSE-to-TRUE transition of the IN1 input has
occurred.

When ACTUAL (ACT) equals TARGET (TARG), the OUT output de-energizes and the ACTUAL
(ACT) retains its value until a FALSE-to-TRUE transition of the IN1 input has occurred.

The function is retriggerable (that is, if the ACTUAL (ACT) is accumulating time and the IN1 input
makes a FALSE-to-TRUE transition before it reaches the TARGET (TARG) value, the function is
reset and begins accumulating from time zero).

If the ACTUAL (ACT) is greater than the TARGET (TARG), it is inhibited from accumulating time
and the OUT output is de-energized.

If TARGET (TARG) equals zero, the OUT output never energizes.

If the TARGET (TARG) or ACTUAL (ACT) operands contain a negative or invalid number, OUT is
de-energized but no other operation takes place.

When a Controller resets, if the IN1 state is true, ACTUAL (ACT) accumulates from its initial value
if it is defined as a point and from its previous value if it is defined as a saved point. The OUT
output is energized according to the comparison between ACTUAL (ACT) and TARGET (TARG).
If ACT is not defined as a point and the IN1 state is true upon a Controller reset, ACT
accumulates from zero and OUT energizes when ACT is greater than TARGET. If ACTUAL (ACT)
has an initial value greater than the target, the output does not energize.

In redundant Controllers, during Failover, regardless of the IN1 state, ACTUAL (ACT) continues to
accumulate and the OUT output is energized according to the comparison between ACTUAL
(ACT) and TARGET (TARG).

When a control sheet is modified and then loaded, the algorithm behavior depends on the
algorithm state and the changes made on the sheet.
 If the ONESHOT is in a triggered state (IN1 = TRUE) and any changes were made to any of
the ONESHOT’s parameters, the OUT resets to zero and the ACTUAL (ACT) is also reset to
zero upon a sheet load.
 In other cases, when the ONESHOT is not in a triggered state or no changes are made to any
of the ONESHOT’s parameters, the OUT keeps the current value and ACTUAL (ACT)
continues to count (if the target value has not been reached).

OW360_R1100 411
5.80 ONESHOT

If a tuning change is made to the TARGET (TARG) from the signal diagram, it is ignored if the
ONESHOT is in its triggered state (IN1 = TRUE). For example, if the TARGET (TARG) is 10 and
the ONESHOT is triggered, changing the target to 20 will not change the time when the OUT
transitions to zero (it will still be a 10 second pulse).

If a tuning change is made (via the signal diagram) to the BASE, the ONESHOT will recalculate
its ACTUAL (ACT) time and if the recalculated time has not reached its TARGET (TARG), the
OUT will remain at a one state until the target is reached. For example, assume the ONESHOT
with a BASE of 1 and a TARGET of 20 is triggered. At count 10, the base is then changed to 2.
The ACTUAL (ACT) will immediately change to 5 and the OUT will stay at a one state until the
count reaches 20 which will actually be 40 seconds from the time it was triggered.

In the Ovation Developer Studio, the TARGET is actually labeled "Pulse Time Number."

If the TARGET input is connected to another algorithm output, the ONESHOT behaves differently
than the manner described above. Tuning changes (via the signal diagram) will not be ignored but
will function as follows: Assume a TARGET of 30 and the ONESHOT is triggered. The ACTUAL
(ACT) time will increment normally. If the TARGET input is changed to a greater value before the
30 seconds has timed out, the pulse will obey the new value. Therefore, if the value was changed
to 60, the pulse length will now be 60 seconds instead of 30 (but only if the TARGET input value
changed before the original 30 seconds had timed out).

Conversely, if the TARGET input time is shortened before the original target is reached, the
ONESHOT will obey the new TARGET. Assume an initial TARGET of 30 and the ONESHOT is
triggered. A change is made to the TARGET input to 20 so now the pulse length will be shortened
to 20. If the ACTUAL (ACT) value is greater than 20 when the change is made, the OUT will
immediately transition to zero. Tying the TARGET to an AVALGEN algorithm offers additional
flexibility especially in cases where it is not known exactly how long the ONESHOT should be and
online tuning changes are desired.

Connecting the TARGET to other algorithms can be done to create additional functions such as a
variable ONESHOT pulse output.

An optional time base (minimum of 0.1 second) can be entered in the R1 field of the algorithm
record. If a value is not entered or a zero is entered into BASE (R1), the default time base is
assumed to be 1 second.

Period of Time defined by the LPS parameter (LPS parameter > 0)

On a FALSE-to-TRUE transition of the IN1 input, the OUT output energizes. The ACTUAL (ACT)
is reset to zero and immediately begins accumulating time, and continues to accumulate until it
equals the LPS or until another FALSE-to-TRUE transition of the IN1 input has occurred.

When ACTUAL (ACT) equals LPS, the OUT output de energizes and the ACTUAL (ACT) retains
its value until a FALSE-to-TRUE transition of the IN1 input has occurred.

The function is retriggerable (that is, if the ACTUAL (ACT) is accumulating time and the IN1 input
makes a FALSE-to-TRUE transition before it reaches the LPS value, the function is reset and
begins accumulating from time zero).

If the ACTUAL (ACT) is greater than the LPS, it is inhibited from accumulating time and the OUT
output is de energized.

If LPS equals zero, then period of time is defined by TARGET and BASE parameters. If TARGET
equals 0 and LPS equals 0, the OUT output never energizes.

412 OW360_R1100
 5.80 ONESHOT

When a Controller resets, if the IN1 state is true, ACTUAL (ACT) accumulates from its initial value
if it is defined as a point and from its previous value if it is defined as a saved point. The OUT
output is energized according to the comparison between ACTUAL (ACT) and LPS. If ACT is not
defined as a point and the IN1 state is true upon a Controller reset, ACT accumulates from zero
and OUT energizes when ACT is greater than LPS. If ACTUAL (ACT) has an initial value greater
than the LPS, the output does not energize.

In redundant Controllers, during Failover, regardless of the IN1 state, ACTUAL (ACT) continues to
accumulate and the OUT output is energized according to the comparison between ACTUAL
(ACT) and LPS.

When a control sheet is modified to the LPS parameter and then loaded, or when a tuning change
is made (through the signal diagram) to the LPS parameter, the ONESHOT algorithm continues
counting its ACTUAL (ACT) time, until the time does not reach its target (LPS). The OUT
parameter remains at one state until the target is reached.

For example, when the ONESHOT algorithm with a LPS parameter equal to 10 is triggered, at the
count 5, the LPS changes to 20. The ACTUAL (ACT) continues counting and the OUT parameter
stays at one state until the count reaches 20, which is the LPS value.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 98 Displays the -

tuning Diagram
number
BASE R1-Real Tuning Optional 1.0 Specifies the -
Constant Time Base in
seconds
(minimum 0.1
second, default
1.0 seconds);
(0 implies 1.0
second)
IN1 - Variable Required - Specifies the LD, LP
input (digital
signal)

OW360_R1100 413
5.80 ONESHOT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

* TARG R2-Real Selectable Required 1.0 Specifies the LA

Pulse Time
number (analog
signal)
* ACT R3-Real Selectable Required 0.0 Specifies the LA
output (analog
signal)
OUT - Variable Required - Specifies the LD, LP
output (digital
signal)
LPS B0-Integer Data Init Required 0.0 Specifies the -
Pulse length in
loops (LPS).
Scenarios:
 LPS is 0 -
ONESHOT
algorithm
ignores the LPS
parameter and
the period of
time is defined
by the BASE
and the TARG
parameters.
 LPS has a
positive value -
ONESHOT
algorithm
ignores the
BASE and the
TARG
parameters and
the period of
time is defined
by the LPS
parameter.
* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder
may default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

Function (Timing Diagram)

(IN1)

TARGET TARGET TARGET

414 OW360_R1100
 5.81 OR

5.81 OR
Description

The OR (Logical OR gate up to 8 inputs) algorithm changes the Boolean of the output based on
the input. The output equals the logical OR of two to eight inputs (that is, at least one input must
be TRUE for the output to be TRUE).

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (digital) LD, LP

IN2 - Variable Optional - Input (digital) LD, LP

IN3 - Variable Optional - Input (digital) LD, LP

IN4 - Variable Optional - Input (digital) LD, LP

IN5 - Variable Optional - Input (digital) LD, LP

IN6 - Variable Optional - Input (digital) LD, LP

IN7 - Variable Optional - Input (digital) LD, LP

IN8 - Variable Optional - Input (digital) LD, LP

OUT - Variable Required/ - Output (digital) LD, LP

Optional

Note: Output is required if connecting to anything other than OR or AND.

Function

OUT = IN1 OR IN2 OR IN3 OR IN4 OR IN5 OR IN6 OR IN7 OR IN8

OW360_R1100 415
5.82 PACK16

5.82 P ACK16
Description

The PACK16 algorithm specifies up to 16 optional digital values as inputs, which are placed into
their corresponding positions in the A2 record field of an LP or larger point record. Inputs may be
of any size (that is, LD, or DD). Variable PBPT functions as an output LP point record, which is
broadcast on the Data Highway for use by other drops. PBPT also functions as an input, when
desired, to pack the LP record from multiple algorithms. These other algorithms can be additional
PACK16 algorithms or other types. For example, you could pack Bits 0 through 10 from Algorithm
X, Bits 11 through 15 from algorithm Y. Bit locations can be left unpacked as spares, if desired.

Note: If digital inputs have bad quality, then the packed point (PBPT) bit remains unchanged.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

ALG. OPTIONAL VALUE POINT
RECORD RECORD
FIELD

D0 - Variable Optional - Input (digital) for Bit 0 LD

D1 - Variable Optional - Input (digital) for Bit 1 LD

D2 - Variable Optional - Input (digital) for Bit 2 LD

D3 - Variable Optional - Input (digital) for Bit 3 LD

D4 - Variable Optional - Input (digital) for Bit 4 LD

416 OW360_R1100
 5.82 PACK16

NAME LC TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

ALG. OPTIONAL VALUE POINT
RECORD RECORD
FIELD

D5 - Variable Optional - Input (digital) for Bit 5 LD

D6 - Variable Optional - Input (digital) for Bit 6 LD

D7 - Variable Optional - Input (digital) for Bit 7 LD

D8 - Variable Optional - Input (digital) for Bit 8 LD

D9 - Variable Optional - Input (digital) for Bit 9 LD

D10 - Variable Optional - Input.(digital) for Bit 10 LD

D11 - Variable Optional - Input (digital) for Bit 11 LD

D12 - Variable Optional - Input (digital) for Bit 12 LD

D13 - Variable Optional - Input (digital) for Bit 13 LD

D14 - Variable Optional - Input (digital) for Bit 14 LD

D15 - Variable Optional - Input (digital) for Bit 15 LD

PBPT - Variable Required - Output (packed point) LP

(POUT)

OW360_R1100 417
5.83 PERSISVAL

5.83 PERSISV AL

Description

The Persistent Accumulator Observer (PERSISVAL) algorithm allows you to maintain the specific
values of a piece of equipment over its lifetime regardless of Controller shutdown or failover. For
example, if you are monitoring the number of times a pump or motor was started, you could lose
the initial values if the Controller shuts down. To maintain the analog point values, you can
implement the PERSISVAL algorithm on the control sheet.

It is a control algorithm that periodically saves an analog point value into an algorithm record field.
The periodicity of the same is one per hour.

Functionality

The PERSISVAL algorithm collects and saves analog point values from the Ovation Controller
into an Ovation database algorithm record field hour.The task of collecting and storing the analog
point values from the PERSISVAl algorithm is performed with the help of a service in the
Database Server. To install and start the service, use the following commands in a Database
Server command window:

set
INSTALL_EXE="C:\Windows\Microsoft.NET\Framework\v4.0.30319\instal
lUtil.exe"

%INSTALL_EXE% C:\Ovation\OvationBase\OvationPersistentValues.exe

NET START "Ovation Persistent Values Service"

Once you start the service, the defined analog values are retained in the event of an Ovation
system upgrade or when a redundant Controller pair is cleared or loaded.

Functional symbol

Tracking

The PERSISVAL algorithm tracks the specific parameters of the algorithms connected to it. These
parameters record equipment states such as hours running or number of starts.
 For the RESETSUM algorithm (see page 495), connect the OUT pin to the PERSISVAL
algorithm IN pin.
 For the RUNTIME algorithm (see page 516), connect the RTIME (time running) pin to the
PERSISVAL algorithm IN pin.
 For the RUNTIME algorithm (see page 516), connect the NUMST (number of starts) pin to the
PERSISVAL algorithm IN pin.

Note: You should configure the restore points of the RUNTIME algorithm only when there is a
dual Controller power loss. For more information on configuring the restore points (INITP option
must be ON), see the RUNTIME algorithm (see page 516).

418 OW360_R1100
 5.83 PERSISVAL

 For the COUNTER algorithm (see page 148), connect the ACC pin to the PERSISVAL
algorithm IN pin.

Algorithm definition

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN - Variable Required - Specifies the input LA

point to be
observed.

Example

Connect the analog output point from any one of the supported algorithms (RESETSUM,
RUNTIME, and COUNTER), to the PERSISVAL algorithm's input (IN) point.

The following figure depicts the connection between the PERSISVAL algorithm and the
RESETSUM (see page 495) and RUNTIME algorithms (see page 516).

Figure 22: Example - Use of PERSISVAL algorithm with the RESETSUM and RUNTIME
algorithms

OW360_R1100 419
5.84 PID

5.84 PID
Description

The PID algorithm provides a proportional, integral, derivative controller function. The algorithm is
a parallel PID implementation that utilizes integral tracking signals for bumpless transfer. The
output value is limited via user-defined limits and anti-reset windup is handled internally.

Functional symbol

Guidelines

Notes:

 PV = Process Variable
 STPT = Set Point

1. PV GAIN and PV BIAS must be used to normalize the process variable inputs to a 0 to 100
percent value.
(PV x PV GAIN) + PV BIAS = PV percent. Thus:

2. STPT GAIN and STPT BIAS must be used to normalize the set point to a 0 to 100 percent
value. If setpoint input units are not 0 to 100 percent, then:

(STPT x STPT GAIN) + STPT BIAS = set point percent. Thus:

3. Determine set point high and low limits with these equations:
set point high limit = (100 - STPT BIAS)/STPT GAIN
set point low limit = (0 - STPT BIAS)/STPT GAIN

420 OW360_R1100
 5.84 PID

Auto-scaling options

The Auto-scaling option consists of a configuration parameter (AUSC) and Engineering Units
limits parameters (high and low limits) for PV and STPT inputs of the PID algorithm.

Possible settings for the AUSC parameter are:

 NONE
Auto-scaling is disabled. The PID uses the gain and bias values that are configured by the user
for each input (R1, R2 for PV and R3, R4 for SP).
 PV_ONLY
Auto-scaling is enabled for the process variable only. The STPT input (setpoint) uses the gain and
bias values configured by the user. For the PV gain and bias values, the top and bottom
engineering units range are read depending on the Auto-Scaling parameter option. The
appropriate gain and bias values are calculated so that the PV auto-scale high and low limits are
scaled to 0%-100%, according to the formulas:

The calculated gain and bias values are then written to the R1 and R2 LC record fields by the
algorithm. These changes will be reconcilable from the database in the same manner as if it were
tuned
 SP_ONLY
Auto-scaling is enabled for the Set Point only. The PV (Process Variable) input uses the gain and
bias values configured by the user. For the SP gain and bias values, the top and bottom
engineering units range are read depending on the Auto-Scaling parameter option. The
appropriate gain and bias values are calculated so that the SP auto-scale high and low limits are
scaled to 0%-100%, according to the formulas:

The calculated gain and bias values are then written to the R3 and R4 LC record fields by the
algorithm. These changes will be reconcilable from the database in the same manner as if it were
tuned.

OW360_R1100 421
5.84 PID

 BOTH
Auto-scaling is enabled for both the PV and SP. The PV auto-ranging is handled as outlined in
PV_ONLY and the SP auto-scaling is handled as outlined in SP_ONLY.

Auto-scaling parameter options

The Auto-scaling parameter option consists of the configuration parameter (AUSCP). This
parameter allows the user to configure what scaling parameters to use.

Possible settings for the AUSCP parameter are:

 INT – INTERNAL. If auto-scaling is enabled, use internal user-defined scaling (V1 – V4).
 EXT – EXTERNAL. If auto-scaling is enabled, use PV input TW (top scale) and BW (bottom
scale) to calculate gain and bias. This is dependent on the AUSC option.

Error conditions: Auto-scale range values are invalid

This case applies to any configuration of auto-scaling. The auto-scaling range values are
considered invalid if any one of the following occurs:
 Bottom and Top Scale values are equal.
 Bottom Scale value > Top Scale value.
In the case where the range values are invalid for a particular input, the output will not change
and will be marked as BAD quality. Also, the PID will post an Invalid Calculated Number message
in the Error Log and will place the drop in alarm.

Output Calculation

The output (which is in either engineering units or percent and limited by the high and low limits
specified) equals the result of the PID equation except:
 When the algorithm is told to track, the output equals the track input when the tracking signal
is present. The output ramps at the user-specified track rate, from the track input back to the
controlled value when the tracking signal is removed.
 When a raise inhibits or lower inhibit signal is present, it may prevent the PID controller from
controlling.
 If the algorithm calculates an invalid real number for the output, the quality of the output is set
to BAD. Consequently, if an invalid value is entered as an input to the algorithm, or if the
algorithm generates an invalid value for the output, the drop is placed into alarm. In all cases,
the output is set to the last GOOD value.
 If the algorithm generates an invalid track output value, the set point input value is used as
the track output, unless it is invalid. The track output value is not updated if both the
calculated track output and the set point input values are invalid.

Error Deadband and Deadband Gain

The algorithm can be configured to utilize a Deadband region in the Controller error signal. This
Deadband region is used to modify the error signal that is presented to the PID equation.

The Controller error signal is calculated as the difference between the normalized process
variable and normalized set point and is passed as the input to the PID equation. If the algorithm
is configured to utilize an error Deadband and the error is within the deadband limits, the error
that is presented to the PID equation is Error = Error X Error Deadband Gain.

422 OW360_R1100
 5.84 PID

When the algorithm is configured to use deadband, transitions into and out of the deadband
region are smoothed internally by utilizing a hold and track operation. During this transition cycle,
the Controller output is set to its previous value and the integral term is re-calculated to account
for the apparent proportional gain change in the new region. This effectively eliminates the abrupt
change in the proportional term due to the deadband transition. Derivative action is disabled when
the algorithm is operating within the deadband region.

If no deadband action is desired, the inner deadband limit (DBND) should be set to zero.

Single Deadband

The Single Deadband mode is configured by initializing the inner deadband limit (DBND field) to a
non-zero value and setting the deadbands option (DOPT) parameter to SINGLE. This value
represents the normalized Controller error signal to be used as the Deadband region limits.
Deadband is symmetrical with respect to zero. For example, if the DBND field equals 5, then the
deadband region is between -5% and +5%. If the Controller error signal is within the deadband,
then the actual error that is presented to the PID equation is the product of the error signal and
the error deadband gain. The ERRD field contains the value of the error deadband gain. The valid
values for this field are any real numbers between zero and one [0 - 1].

As an example, consider the following: DBND is 5 and ERRD is 0.5. For a normalized Controller
error signal of 2%, the actual error signal that is applied to the PID equation is 2% x 0.5 = 1%. In
general, for these example values of DBND and ERRD, any normalized error signal between -5%
and +5% is reduced by 50% before being applied to the PID equation. Derivative action is
disabled when the algorithm is operating within the deadband region.

Double Deadband

The Double Deadband configuration utilizes two deadband limits. These are the inner (DBND)
and the outer deadband limit (ODBND). Once the absolute value of the error signal is less than or
equal to the inner deadband, then the deadband gain is applied. The deadband gain is applied
until the absolute value of the error signal is greater than the outer deadband.

The Double Deadband mode is configured by initializing the Outer Deadband (ODBND) field to a
value greater than the inner deadband limit (DBND) and setting the deadbands option (DOPT)
parameter to DOUBLE. The Double Deadband mode is designed to be used when a noisy
process variable is present. When noise is present in the Process Variable signal, it causes
fluctuations in the magnitude of the error signal. When a Single Deadband is used, the Controller
error signal can fluctuate in and out of the deadband region (DBND) on successive execution
loops. In severe cases, this can lead to reduced performance of the PID algorithm. An example of
this situation is shown graphically in the following figure.

In this figure, at time t1, the signal has entered the inner deadband region. At time t2, the noise
has caused the signal to exit the inner deadband region, and at t3, it enters it again. The same
problem is seen again as the signal leaves the inner deadband region, as seen at t4, t5 and t6.

At each transition into and out of the deadband, the algorithm performs a track and hold
operation. This prevents the output from spiking due to the abrupt change in the proportional
term.

OW360_R1100 423
5.84 PID

In Singe Deadband mode, subsequent transitions into and out of the deadband region can lead to
reduced performance of the PID algorithm.

Figure 23: Signal Entering and Exiting Inner Deadband Region

To prevent this situation, a second outer deadband region (ODBND) can be defined by the user.
This should be larger than the inner deadband region (DBND) as shown in the following figure.
More specifically, the outer deadband (ODBND) should be defined as equal to, or larger than, the
noise seen in the signal PLUS the inner deadband region (DBND).

For example, if the DBND field is equal to 5, then that deadband region is between -5% and +5%.
Once the Controller error signal reaches this inner deadband region of + or -5%, a noise in the
signal with a peak of + or -3% could push the Controller error signal back out of the inner
deadband region up to + or -8% on the next scan. Therefore, the outer deadband (ODBND)
should be set larger than + or -8% to compensate for noise. In the following figure, we set the
ODBND to +/- 10. If the outer deadband (ODBND) region is less than the defined inner deadband
(DBND) region, then the outer deadband region is set equal to the inner deadband value.

Figure 24: Signal Entering and Exiting Inner and Outer Deadband Regions

424 OW360_R1100
 5.84 PID

Hard Inhibit Parameter

If the Hard Inhibit parameter (INHB) of PID is set to ENABLED, and PID receives an inhibit signal
from downstream, PID stops updating the PID output and holds the last calculated value prior to
the receipt of the inhibit signal. As long as the inhibit condition remains, normal control action will
resume only after the PID error changes sign.

If the Hard Inhibit parameter (INHB) is set to DISABLED, and PID receives the inhibit signal from
downstream, PID continues calculating a new output value each loop time. PID compares the
new value to the previous output value and if updating the output point with the new value would
violate the inhibit condition, then the previous output value is maintained. If the new value would
not violate the inhibit condition, then the output point is updated with the new output value.

Example

If INHB is set to ENABLED when PID receives a lower inhibit signal (LWI) via track input from a
downstream algorithm, PID output cannot decrease. The output value remains constant until
either the LWI signal is removed, or the process error changes to where PID output increases and
resumes normal control action.

If INHB is set to DISABLED when PID receives a lower inhibit signal (LWI) via track input from a
downstream algorithm, PID continues to calculate a PID output each loop time. The calculated
value is stored in the algorithm and compared to the output calculated during the previous loop
time. If a lower inhibit occurs, the actual PID output will be the greater of the two calculated
values. If a raise inhibit occurs, the actual PID output will be the lesser of the two calculated
values.

Note: In either case, PID uses internal mechanisms to ensure that an integral windup condition
does not occur during an inhibited situation.

Tracking Signals

External tracking and limiting are done through signals passed in the upper 16 bits of the third
status word of the analog track points. This algorithm takes the following action in response to
information found in the third status word of the analog input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through or set TRUE when

not in Cascade mode.
17 Track if lower Implemented Not used

18 Track if higher Implemented Not used

19 Lower inhibit Implemented* Passed through**

20 Raise inhibit Implemented* Passed through**

21 Conditional Track See description of Passed through if in the cascaded

cascaded mode. mode.

22 Not used No action Not used

23 Deviation Alarm No action Not used

OW360_R1100 425
5.84 PID

BIT DESCRIPTION ACTION TOUT SIGNAL

24 Local Manual mode No action Not used

25 Manual mode No action Manual mode

26 Auto mode No action Auto mode

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the definitions given in
Setting Tracking Signals (see page 17).

The High and Low limit flags, the mode, and the tracking signals from the algorithm are output to
TOUT to be used for display and by upstream algorithms.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

DIAG LU-Integer Data Init Required 38 Specifies the tuning -

diagram number
SPTG R3-Real Tuning Required 1.0 Specifies the gain on -
Constant set point. The gain on
the set point should
never be initialized to
zero.
SPTB R4-Real Tuning Optional 0.0 Specifies the bias on set -
Constant point

PVG R1-Real Tuning Required 1.0 Specifies the gain on -

Constant process variable input.
The gain on the set
point should never be
initialized to zero.
PVB R2-Real Tuning Optional 0.0 Specifies the bias on -
Constant process variable input

TPSC R5-Real Tuning Required 100.0 Specifies the Maximum -

Constant value of the output point

BTSC R6-Real Tuning Required 0.0 Specifies the minimum -

Constant value of the output point

426 OW360_R1100
 5.84 PID

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

PVTS V1-Real Tuning Required 100.0 Specifies the top scale -

Constant for PV input point --
used only when AUSC
is set to PV_ONLY or
BOTH.
PVBS V2-Real Tuning Required 0.0 Specifies the bottom -
Constant scale for PV input point
-- used only when
AUSC is set to
PV_ONLY or BOTH.
SPTS V3-Real Tuning Required 100.0 Specifies the top scale -
Constant for STPT input point --
used only when AUSC
is set to SP_ONLY or
BOTH.
SPBS V4-Real Tuning Required 0.0 Specifies the bottom -
Constant scale for STPT input
point -- used only when
AUSC is set to
SP_ONLY or BOTH.
AUSC X7-Byte Data Init. Required NONE Specifies the Auto -
Bits 0 and 1 scaling options:
 NONE - No
auto-scaling enabled.
GAINs and BIASes
defined in R1-R4
fields will be used.
 PV_ONLY - Only
GAIN and BIAS for PV
(R1 and RS) are
automatically
calculated, using TOP
(V1) and BOTTOM
(V2) scale parameters
for PV.
 SP_ONLY - GAIN and
BIAS for SP only (R3
and R4) are
automatically
calculated, using TOP
(V1) and BOTTOM
(V2) scale parameters
for PV.
 BOTH - GAIN and
BIAS for both PV and
SP inputs are
automatically
recalculated, using
appropriate TOP and
BOTTOM scale
parameters for PV (V1
and V2) and for SP
(V3 and V4).

OW360_R1100 427
5.84 PID

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

AUSCP X8-Byte Data Init. Required INT Specifies the Auto -

Bit 0 scaling parameters
options:
 INT - If auto-scaling is
enabled, use
user-defined internal
scaling (V1 - V4)
 EXT - If auto-scaling
is enabled, use PV
input TW (top scale)
and BW (bottom
scale) to calculate
gain and bias.
TYPE X5-Byte Data Init. Required NORMAL Specifies the types of -
Bits 1 and 0 PID controllers:
 NORMAL = Regular
PID control
 ESG = PID control
with error squared on
the proportional gain
term
 ESI = PID control with
error squared on the
integral term
ACTN X5-Byte Data Init. Required INDIRECT Specifies the direction -
flags:
Bit 2
 INDIRECT = Error =
Set point - process
variable
 DIRECT: Error =
Process variable - set
point
INHB X6-Byte Data Init. Required ENABLED Defines algorithm -
behavior when a raise
Bit 0 or lower inhibit signal is
received from a
downstream algorithm.
 ENABLED = Normal
PID action. Output is
not updated and last
value is held until PID
error changes sign.
 DISABLED = See
description of Hard
Inhibit Parameter.

428 OW360_R1100
 5.84 PID

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

CASC X5-Byte Data Init Required NORMAL Specifies that the -

Bit 3 Controller is
downstream in a
cascaded configuration.
 NORMAL = Normal
PID action.
 CASCADED = See
description of
Cascaded Mode and
Conditional Tracking.

PACT X6-Byte Selectable Required NORMAL Specifies the types of -

Bit 1 proportional actions:
 NORMAL = Error.
 PROCESS = Process
variable.
DACT X5-Byte Data Init Required NORMAL Specifies the type of -
Bit 4 derivative actions:
 NORMAL = Derivative
applied to change in
error.
 SET POINT =
Derivative applied to
change in set point.
 PROCESS =
Derivative applied to
change in process
variable.
IACT X6-Byte Selectable Required NORMAL Specifies the types of -
integral actions:
Bit 2
 NORMAL = Reset
time cannot be less
than the task loop
time.
 ALLOW < LOOP
TIME = Reset time
can be less than the
task loop time.
DBND S3-Real Tuning Required 0.0 Specifies the PID error -
Constant deadband*

DOPT X5-Byte Bit Data Init. Required SINGLE  SINGLE - Single -

6 and 7 deadband mode
 DOUBLE - Double
deadband mode
ODBND S7-Real Tuning Required 0.0 Specifies the PID outer LA
Constant error deadband**

ERRD S4-Real Tuning Required 0.0 Specifies the PID error -

Constant deadband gain

OW360_R1100 429
5.84 PID

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

*** PGAIN R8-Real Selectable Required 1.0 Specifies the PID LA

proportional gain. If the
proportional gain equals
zero, the proportional
part is not included in
the output.
*** INTG R9-Real Selectable Required 10.0 Specifies the PID LA
integral time in seconds
per repeat. If the
integral time equals
zero, the integral part is
not included in the
output.
*** DGAIN S1-Real Selectable Required 0.0 Specifies the PID LA
derivative gain. If the
derivative gain equals
zero, the derivative part
is not included in the
output.
*** DRAT S2-Real Selectable Required 0.0 Specifies the PID LA
derivative rate decay
constant in seconds.
 When the DRAT
parameter is set to
equal to half of the
task loop time, then
the time derivative is
0.
 When the DRAT
parameter is less than
half of the task loop
time, then it is set to
half of the task loop
time internally and the
derivative term is 0.
TRAT R7-Real Tuning Required 2.5 Specifies the Tract ramp -
Constant rate (units per second)

PV - Variable Required - Specifies the process LA

variable analog input.

STPT - Variable Required - Specifies the set point LA

analog input
TOUT - Variable Required - Specifies the track LA
output value.
OUT - Variable Required - Specifies the analog LA
output variable.
TRIN - Variable Optional - Specifies the tracking LA
analog input variable.

DVAL - Variable Optional - Specifies the derivative LA

term output.

430 OW360_R1100
 5.84 PID

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

DEVA - Variable Optional - Specifies the error LA

between process
variable and set point
for PID. This is
calculated using the
normalized set point
PVAR.
* A value of 0.0 for this field disables all deadband action.

** Anytime that the value of this field is greater than the inner deadband (DBND), the double deadband
action results. This value should be set to zero if single deadband action is desired.

*** When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be executed
properly, you must enter a value for the parameter.
For selectable parameters, the record field associated with the parameter will reflect the value of what is
currently selected.

Process proportional mode

When the proportional mode is set to process (PACT = Process), the PID control action is shown
as:

d d 
u t   K  PV t    et d  K dt 
~ 1 t
in
i
d d
t0

Where:
~
K p  K p
 The mathematical equation represents an indirect mode regulator.
~
Kp  Kp
 The mathematical equation represents a direct mode regulator.
 PV(t) is the process variable.
In this mode, when the controller experiences a startup or a failover, the integral term is initialized
in the following way to prevent a drift in the process variable.


uint  uold  K p  PV t 
~

The integrator initialization during operation is done after the changes to the PACT. During the
integrator initialization, the control output is kept to the previous value for one cycle.

During this condition, any change to the PACT initializes the integrator, even if the reset time is 0.
This is done in order to prevent a bump. If the reset time is 0, the integrator ramps down to 0 in
increments of TRAT x Loop Time.

OW360_R1100 431
5.84 PID

While configuring the PD controller, if the PACT is set to the Process mode and the DACT is not
set to the Normal mode, the process variable does not follow the set-point and the regulator
becomes limited.

Figure 25: Functional operation of PID

432 OW360_R1100
 5.84 PID

Cascaded Mode and Conditional Tracking:

Figure 26: Tracking calculations

Conditional tracking is a scheme which allows tighter control of the process variable when the
control strategy is implemented using cascaded Controllers. Essentially, the conditional tracking
scheme allows the upstream Controller to have immediate influence on the final output when the
error between the process variable and the set point changes direction while the downstream
Controller is in a saturation condition. Conditional tracking is incorporated when the downstream
Controller (Controller “B” in figure) operates in cascaded mode.

The purpose of cascaded mode is to allow two PID algorithms to be used in a cascaded
configuration where the output of one PID is the set point for another. When you desire to arrange
two PID Controllers in this configuration, the type parameter should be set to cascaded in the
downstream Controller only. It is not necessary to configure the upstream Controller in the
cascaded configuration.

When the downstream Controller is configured in the cascaded mode, the Controller operates as
a conventional PID controller so long as the Controller is not in a saturation condition. However, if
the Controller output is saturated at the HI or LO limit or if the Controller receives an inhibit signal
from a downstream algorithm the behavior of the cascaded pair is as follows:
 The downstream Controller (Controller “B” in figure) asserts the conditional track signal in its
output tracking point along the applicable limit or inhibit bit. The downstream Controller also
calculates a track output value that if applied as a set point input, yields a Controller error of
zero (see Equation 1 in the previous figure).
 When the upstream Controller sees the conditional track bit set, it adjusts its output as
follows: If the error signal causes the Controller output to move against the inhibit signal (for
example, output attempts to increase when the algorithm is receiving a raise inhibit), then the
algorithm sets its output equal to the track input received from downstream.
 If the error signal causes the output to move away from the inhibit signal, the algorithm sets
its output equal to the track input and begin controlling.
 Without this mode, the upstream Controller would first have to move enough to zero the error
on the downstream Controller before having any effect on the process. This would introduce
additional dead-time in the Controller response and in the case of processes with slow
dynamics (for example, temperature control), this additional dead-time may be significant.
 Only the PID algorithm configured to be in cascaded mode asserts the conditional track bit.
The upstream Controller (Controller “A” in the previous figure) does not pass the conditional
track bit in its track output.

OW360_R1100 433
5.84 PID

Hard Inhibit Parameter

If the Hard Inhibit parameter (INHB) of the PID algorithm is set to ENABLED, and PID receives an
inhibit signal from downstream, the PID algorithm stops updating the PID output and holds the
last calculated value prior to the receipt of the inhibit signal. As long as the inhibit condition
remains, normal control action will resume only after the PID error changes sign.

If the Hard Inhibit parameter (INHB) is set to DISABLED, and the PID algorithm receives the
inhibit signal from downstream, PID continues calculating a new output value each loop time. PID
compares the new value to the previous output value and if updating the output point with the new
value would violate the inhibit condition, then the previous output value is maintained. If the new
value would not violate the inhibit condition, then the output point is updated with the new output
value.

Example

If INHB is set to ENABLED when PID receives a lower inhibit signal (LWI) via track input from a
downstream algorithm, the PID algorithm output cannot decrease. The output value remains
constant until either the LWI signal is removed, or the process error changes to where PID output
increases and resumes normal control action.

If INHB is set to DISABLED when PID receives a lower inhibit signal (LWI) via track input from a
downstream algorithm, the PID algorithm continues to calculate a PID output each loop time. The
calculated value is stored in the algorithm and compared to the output calculated during the
previous loop time. If a lower inhibit occurs, the actual PID output will be the greater of the two
calculated values. If a raise inhibit occurs, the actual PID output will be the lesser of the two
calculated values.

Note: In either case, PID uses internal mechanisms to ensure that an integral windup condition
does not occur during an inhibited situation.

434 OW360_R1100
 5.85 PIDFF

5.85 PIDFF
Description

The PIDFF algorithm is designed to accept an externally generated analog signal that is used as
a feed-forward bias. This analog signal is summed with the actual PID output (sum of the
proportional, integral and derivative terms) to become the final control output. The advantage to
having the feed-forward input incorporated in the PID algorithm is that saturation conditions,
caused by either the final control output exceeding the algorithms limits or raise/lower inhibit
signals generated by the downstream algorithms, are handled internally to the algorithm. This can
greatly improve Controller response times to sudden changes in the direction (algebraic sign) of
the Controller error signal when the Controller is in a saturation condition.

The PID portion of the algorithm provides a proportional, integral, derivative Controller function.
The algorithm is a parallel PID implementation that utilizes integral tracking signals for bumpless
transfer. The output value is limited via user-defined limits and anti-reset windup is handled
internally.

Functional symbol

Guidelines

Note: PV = Process Variable

STPT = Set Point
FF = FF Input

1. PV GAIN and PV BIAS must be used to normalize the process variable inputs to a 0 to 100
percent value. Use this equation:
(PV x PV GAIN) + PV BIAS = PV percent. Thus,

OW360_R1100 435
5.85 PIDFF

2. STPT GAIN and STPT BIAS must be used to normalize the set point to a 0 to 100 percent
value. If setpoint input units are not 0 to 100 percent, then:

(STPT x STPT GAIN) + STPT BIAS = set point percent. Thus:

3. The external feed-forward input should be normalized to 0-100%

(FF x FF GAIN) + FF BIAS = FF percent

Error Deadband and Deadband Gain

The algorithm can be configured to utilize a Deadband region in the Controller error signal. This
Deadband region is used to modify the error signal that is presented to the PID equation.

The Controller error signal is calculated as the difference between the normalized process
variable and normalized set point and is passed as the input to the PID equation. If the algorithm
is configured to utilize an error Deadband and the error is within the deadband limits, the error
that is presented to the PID equation is Error = Error X Error Deadband Gain.

When the algorithm is configured to use deadband, transitions into and out of the deadband
region are smoothed internally by utilizing a hold and track operation. During this transition cycle,
the Controller output is set to its previous value and the integral term is re-calculated to account
for the apparent proportional gain change in the new region. This effectively eliminates the abrupt
change in the proportional term due to the deadband transition. Derivative action is disabled when
the algorithm is operating within the deadband region.

If no deadband action is desired, the inner deadband limit (DBND) should be set to zero.

Single Deadband

The Single Deadband mode is configured by initializing the inner deadband limit (DBND field) to a
non-zero value and setting the deadbands option (DOPT) parameter to SINGLE. This value
represents the normalized Controller error signal to be used as the Deadband region limits.
Deadband is symmetrical with respect to zero. For example, if the DBND field equals 5, then the
deadband region is between -5% and +5%. If the Controller error signal is within the deadband,
then the actual error that is presented to the PID equation is the product of the error signal and
the error deadband gain. The ERRD field contains the value of the error deadband gain. The valid
values for this field are any real numbers between zero and one [0 - 1].

As an example, consider the following: DBND is 5 and ERRD is 0.5. For a normalized Controller
error signal of 2%, the actual error signal that is applied to the PID equation is 2% x 0.5 = 1%. In
general, for these example values of DBND and ERRD, any normalized error signal between -5%
and +5% is reduced by 50% before being applied to the PID equation. Derivative action is
disabled when the algorithm is operating within the deadband region.

436 OW360_R1100
 5.85 PIDFF

Double Deadband

The Double Deadband configuration utilizes two deadband limits. These are the inner (DBND)
and the outer deadband limit (ODBND). Once the absolute value of the error signal is less than or
equal to the inner deadband, then the deadband gain is applied. The deadband gain is applied
until the absolute value of the error signal is greater than the outer deadband.

The Double Deadband mode is configured by initializing the Outer Deadband (ODBND) field to a
value greater than the inner deadband limit (DBND) and setting the deadbands option (DOPT)
parameter to DOUBLE. The Double Deadband mode is designed to be used when a noisy
process variable is present. When noise is present in the Process Variable signal, it causes
fluctuations in the magnitude of the error signal. When a Single Deadband is used, the Controller
error signal can fluctuate in and out of the deadband region (DBND) on successive execution
loops. In severe cases, this can lead to reduced performance of the PID algorithm. An example of
this situation is shown graphically in the following figure.

In the following figure, at time t1, the signal has entered the inner deadband region. At time t2, the
noise has caused the signal to exit the inner deadband region, and at t3, it enters it again. The
same problem is seen again as the signal leaves the inner deadband region, as seen at t4, t5 and
t6.

At each transition into and out of the deadband, the algorithm performs a track and hold
operation. This prevents the output from spiking due to the abrupt change in the proportional
term.

In Singe Deadband mode, subsequent transitions into and out of the deadband region can lead to
reduced performance of the PID algorithm.

Figure 27: Signal Entering and Exiting Inner Deadband Region

OW360_R1100 437
5.85 PIDFF

To prevent this situation, a second outer deadband region (ODBND) can be defined by the user.
This should be larger than the inner deadband region (DBND) (see the following figure). More
specifically, the outer deadband (ODBND) should be defined as equal to, or larger than, the noise
seen in the signal PLUS the inner deadband region (DBND).

For example, if the DBND field is equal to 5, then that deadband region is between -5% and +5%.
Once the Controller error signal reaches this inner deadband region of + or -5%, a noise in the
signal with a peak of + or -3% could push the Controller error signal back out of the inner
deadband region up to + or -8% on the next scan. Therefore, the outer deadband (ODBND)
should be set larger than + or -8% to compensate for noise. In the following figure, the ODBND
was set to +/- 10. If the outer deadband (ODBND) region is less than the defined inner deadband
(DBND) region, then the outer deadband region is set equal to the inner deadband value.

Figure 28: Signal Entering and Exiting Inner and Outer Deadband Regions

Output Calculation

The output (which is in either engineering units or percent and limited by the high and low limits
specified) equals the algebraic sum of the result of the PID equation and the feed-forward input
except:
 When the algorithm is told to track, the output equals the track input when the tracking signal
is present. The output ramps at the user-specified track rate, from the track input back to the
controlled value when the tracking signal is removed.
 When a raise inhibit or lower inhibit signal is present, it may prevent the PID Controller from
controlling.
 When the sum of the actual PID output and the normalized feed-forward input exceeds either
the high or low limit of the algorithm, the output in this case is clipped at the corresponding
limit.
 If the algorithm calculates an invalid real number for the output, the quality of the output is set
to BAD. Consequently, if an invalid value is entered as an input to the algorithm, or if the
algorithm generates an invalid value for the output, the drop is placed into alarm. In all cases,
the output is set to the last GOOD value.
 If the algorithm generates an invalid track output value, the set point input value is used as
the track output, unless it is invalid. The track output value is not updated if both the
calculated track output and the set point input values are invalid.

438 OW360_R1100
 5.85 PIDFF

Tracking Signals

External tracking and limiting are done through signals passed in the upper 16 bits of the third
status word of the analog track points. This algorithm takes the following action in response to
information found in the third status word of the analog input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through or set

TRUE when not in
Cascade mode.

17 Track if lower Implemented when not in Not used

Manual mode*

18 Track if higher Implemented when not in Not used

Manual mode*

19 Lower inhibit Implemented* Passed through**

20 Raise inhibit Implemented* Passed through**

21 Conditional Track See description of Passed through if in the

cascaded mode. cascaded mode.

22 Not used No action Not used

23 Deviation Alarm No action Set when the deviation of

process variable and set
point is greater than the
given Deviation Alarm
deadband.
24 Local Manual mode No action Not used

25 Manual mode No action Manual mode

26 Auto mode No action Auto mode

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the definitions given
in Setting Tracking Signals (see page 17).

OW360_R1100 439
5.85 PIDFF

The High and Low limit flags, the mode, and the tracking signals from the algorithm are output to
TOUT to be used for display and by upstream algorithms.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

DIAG LU-Integer Data Init Required 24 Tuning Diagram Number -

DOPT X5-Bit 6 Data Init Required Single Deadband options: -

 Single
 Double
CDLY B7-Real Non- Required 0 Cascade Delay Time in -
tunable Seconds
SPTG R3-Real Tuning Required 1.0 Gain on set point. The -
Constant gain on the set point
should never be
initialized to zero.
SPTB R4-Real Tuning Optional 0.0 Bias on set point -
Constant

PVG R1-Real Tuning Required 1.0 Gain on process -

Constant variable input. The gain
on the set point should
never be initialized to
zero.
PVB R2-Real Tuning Optional 0.0 Bias on process variable -
Constant input

FFG S5-Real Tuning Required 1.0 Gain on Feedforward. -

Constant The gain on feedforward
should never be
initialized to zero.

FFB S6-Real Tuning Optional 0.0 Bias on Feedforward -

Constant input

DACT X5-Byte Data Init Required Normal Type of Derivative -

Bit 4 action:

Normal - Derivative
applied to change in
error.

Set point - Derivative

applied to change in set
point.

Process - Derivative
applied to change in
process variable.
TPSC R5-Real Tuning Required 100.0 Maximum value of the -
Constant output point

440 OW360_R1100
 5.85 PIDFF

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

BTSC R6-Real Tuning Required 0.0 Minimum value of the -

Constant output point

TYPE X5-Byte Data Init. Required NORMAL Type of PID controller: -

Bits 0  NORMAL= Regular
and 1 PID control
 ESG = PID control
with error squared on
the proportional gain
term
 ESI = PID control with
error squared on the
integral term
ACTN X5-Byte Data Init. Required INDIRECT Direction Flag: -
Bit 2  INDIRECT = Error =
Set point - process
variable
 DIRECT = Error =
Process variable - set
point
CASC X5-Byte Data Init Required NORMAL Controller is -
Bit 3 downstream in a
cascaded configuration.
 NORMAL = Normal
PID action.
 CASCADED = See
description of
cascaded mode and
conditional tracking.

DBND S3-Real Tuning Required 0.0 PID error inner -

Constant deadband *
DOPT X5-Byte Data Init. Required SINGLE  SINGLE - Single -
Bit 6 and 7 deadband mode
 DOUBLE - Double
deadband mode
ODBND S7-Real Tuning Required 0.0 PID error outer LA
Constant deadband **

ERRD S4-Real Tuning Required 0.0 PID error deadband gain -

Constant

*** PGAIN R8-Real Selectable Required 1.0 PID proportional gain. If -

the proportional gain
equals zero, the
proportional part is not
included in the output.

*** INTG R9-Real Selectable Required 10.0 PID integral time in -

seconds per repeat. If
the integral time equals
zero, the integral part is
not included in the
output.

OW360_R1100 441
5.85 PIDFF

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

*** DGAIN S1-Real Selectable Required 0.0 PID derivative gain. If -

the derivative gain
equals zero, the
derivative part is not
included in the output.
*** DRAT S2-Real Selectable Required 0.5 PID derivative rate -
decay constant in
seconds
TRAT R7-Real Tuning Required 2.5 Track ramp rate (units -
Constant per second)

PV - Variable Required - Process variable analog LA

input.

FF - Variable Required - Feedforward Input LA

STPT - Variable Required - Set point. LA

TOUT - Variable Required - Track output value LA

OUT - Variable Required - Analog output variable LA

DVAL - Variable Optional - Derivative term output LA

TRIN - Variable Optional - Tracking analog input LA
variable

* A value of 0.0 for this field disables all deadband action.

** Anytime that the value of this field is greater than the inner deadband (DBND), the double
deadband action results. This value should be set to zero if single deadband action is desired.

*** When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

442 OW360_R1100
 5.85 PIDFF

OW360_R1100 443
5.85 PIDFF

Feed-Forward Control Example

Refer to the “Functional Operation of PIDFF” diagram for the following example. Consider the
case where the output limits on the PIDFF algorithm are 0-100%, the external feed-forward input
has a normalized value of 75%, the actual PID output is 50% and the error between process
variable and set point causes the PID output to increase. This condition would require that the
final output be 125%, which violates the algorithm's high limit of 100%. The final PIDFF output is
clipped at 100%. If the error between the process variable and the set point were to change
direction, the PID output would have to move 25% before it had any effect on the final control
output and thus the process variable. Depending on the tuning parameters, the time that this
takes can be significant.

By incorporating the feed-forward input into the PIDFF algorithm, this direction change in the error
between the process variable and set point has an immediate effect on the final control output.

The PIDFF begins integrating from the high limit of 100% and thus has immediate influence on
the final control output and subsequently on the process variable.

Cascaded Mode and Conditional Tracking

444 OW360_R1100
 5.85 PIDFF

Conditional tracking is a scheme which allows tighter control of the process variable when the
control strategy is implemented using cascaded Controllers. Essentially, the conditional tracking
scheme allows the upstream Controller to have immediate influence on the final output when the
error between the process variable and the setpoint changes direction while the downstream
controller is in a saturation condition. Conditional tracking is incorporated when the downstream
Controller (Controller “B” in previous figure) operates in cascaded mode.

The purpose of cascaded mode is to allow two PID algorithms to be used in a cascaded
configuration where the output of one PID is the set point for another. When you desire to arrange
two PID Controllers in this configuration, the type parameter should be set to cascaded in the
downstream Controller only. It is not necessary to configure the upstream Controller in the
cascaded configuration.

When the downstream controller is configured in the cascaded mode, the Controller operates as a
conventional PIDFF Controller so long as the Controller is not in a saturation condition. However,
if the controller output is saturated at the HI or LO limit or if the Controller receives an inhibit
signal from a downstream algorithm, the behavior of the cascaded pair is as follows:
 The downstream Controller (Controller “B” in the previous figure) asserts the conditional track
signal in its output tracking point along the applicable limit or inhibit bit. The downstream
Controller also calculates a track output value that if applied as a set point input, yields a
Controller error of zero (see the previous Equation 1).
 When the upstream Controller sees the conditional track bit set it adjusts its output as follows:
If the error signal causes the Controller output to move against the inhibit signal (for example,
output attempts to increase when the algorithm is receiving a raise inhibit), then the algorithm
sets its output equal to the track input received from downstream.
 If the error signal causes the output to move away from the inhibit signal, the algorithm sets
its output equal to the track input and begin controlling.
 Without this mode, the upstream Controller would first have to move enough to zero the error
on the downstream Controller before having any effect on the process. This would introduce
additional dead-time in the Controller response and in the case of processes with slow
dynamics (for example, temperature control) this additional deadtime may be significant.
 Only the PIDFF algorithm configured to be in cascaded mode asserts the conditional track bit.
The upstream Controller (Controller “A” in previous figure) does not pass the conditional track
bit in its track output.

OW360_R1100 445
5.86 PNTSTATUS

5.86 PNTSTATUS
Description

The PNTSTATUS algorithm outputs the states of two specified bits of the point record's status
word. When the ENBL input is TRUE, the states of BITA and BITB of the point record's status
word are output to OUTA and OUTB, respectively. For example, if the bit specified by BITA is a
one, then OUTA is TRUE. Conversely, if the bit specified by BITA is a zero, then OUTA is FALSE.
This example also holds TRUE for BITB and OUTB.

For analog and digital records, the valid range for BITA and BITB is 0 through 31.

When the ENBL input is TRUE and either the BITA or BITB operand contains an invalid bit
number, no operation occurs and the BITA and BITB outputs are FALSE.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 86 Tuning Diagram -

number
STAT X1-Byte Data Init. Required 1W Status word -
1W, 2W, 3W
BITA X2-Byte Data Init. Optional 0 Which bit in the -
point record's
status word is
output to OUTA
BITB X3-Byte Data Init. Optional 0 Which bit in the -
point record's
status word is
output to OUTB

446 OW360_R1100
 5.86 PNTSTATUS

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

ENBL - Variable Required - Enable Input Flag LD, LP

(digital)
IN1 - Variable Required - Input LA, LD

OUTA - Variable Optional - When the ENBL LD, LP

input is TRUE, this
output reflects the
state of the bit
specified by BITA.
OUTB - Variable Optional - When the ENBL LD, LP
input is TRUE, this
output reflects the
state of the bit
specified by BITB.

OW360_R1100 447
5.87 POLYNOMIAL

5.87 POLYNOMI AL
Description

The POLYNOMIAL algorithm performs a mathematical fifth order polynomial function. The output
of the POLYNOMIAL algorithm is the result of a fifth order polynomial equation of the input using
the coefficients listed in this description.

Invalid Numbers and Quality

The quality of the analog input is propagated to the output. However, if the algorithm calculates an
invalid value for the output, the quality of the output is set to BAD, and the output value is invalid.

Functional Symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 7 Tuning -

Diagram
Number
CX0 R1-Real Tuning Required 0.0 Zero coefficient -
Constant of the
polynomial
equation
CX1 R2-Real Tuning Required 0.0 First coefficient -
Constant of the
polynomial
equation
CX2 R3-Real Tuning Required 0.0 Second -
Constant coefficient of
the polynomial
equation
CX3 R4-Real Tuning Required 0.0 Third -
Constant coefficient of
the polynomial
equation

448 OW360_R1100
 5.87 POLYNOMIAL

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

CX4 R5-Real Tuning Required 0.0 Fourth -

Constant coefficient of
the polynomial
equation
CX5 R6-Real Tuning Required 0.0 Fifth coefficient -
Constant of the
polynomial
equation
IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output LA

(analog)

Function

OUT = CX0 (IN1)0 + CX1 (IN1)1 + CX2 (IN1)2 + CX3 (IN1)3 + CX4 (IN1)4 + CX5 (IN1)5

OW360_R1100 449
5.88 PREDICTOR

5.88 PREDICTOR
Description

This algorithm can be utilized to implement a standard Smith Predictor control system structure in
processes that are characterized by dynamics that include a deadtime. The advantage of using a
Smith Predictor is that the Controller (typically a PID) tuning can be performed as if no dead time
exists in the process, and hence a relatively high gain can be applied to expedite the response.

The output of the PREDICTOR is the result of the summation of the actual process variable and a
no-delay model output minus the with-delay model output. This is illustrated mathematically in the
functional diagram. The process input to the algorithm is gain and biased. The algorithm output
directly connects to the downstream PID algorithm process input. When no dead time is present
in the process (and the model), the process variable input to the PREDICTOR directly passes
through unmodified to the downstream PID process input. You have the option to configure the
algorithm to use either a first or second order model of the plant.

Since the internal memory size for each algorithm is limited, a long dead time must be realized by
an internal time delay plus a chain of cascaded external delays (implemented by TRANSPORT
algorithm).

The plant model dead time is realized by storing N samples of the process variable. The value of
N is a function of the Process dead-time and the control area loop time. The value of N is
calculated as follows:

N = (dead time (secs)) / (loop time (secs))

Due to memory limitations, the PREDICTOR algorithm can store up to eight samples. If the value
of N is greater than eight, the remainder of the samples can be realized by using Transport Delay
algorithms as shown in the configuration example of the PREDICTOR.

If the algorithm receives an invalid value as the input, or if it calculates an invalid value as the
output, the drop is placed into alarm and the output is set to the last GOOD value with quality set
to BAD. Under normal operation, the output propagates the quality of the PV input.

Functional symbol

450 OW360_R1100
 5.88 PREDICTOR

Algorithm Tuning

Algorithm Definitions listed as Tuning Constants for this algorithm are monitored and modified
with the Tuning Diagrams. Parameters for the process model (gain, first and second time
constants) can also be modified by outside algorithms through selectable pins. The guideline for
tuning is that the model gain and time constants should be set as close as possible to the
parameters reflecting the real process. Tuning for the length of dead time can be implemented by
modifying the internal time delay (in T3 field) and/or the number of samples in the TRANSPORT
algorithms.

If a first order model of the plant is desired, the FOTC field of the algorithm is initialized to the
value of the time constant (in seconds) of the 1st order model. The SOTC field should be set to a
value of zero. Here the time constant refers to the time (in seconds) that is required for the Step
response of the process to achieve 66% of its final value.

If a second order model of the plant is desired, more advanced system identification methods can
be used to determine the values of the FOTC and the SOTC.

Both the gain and the dead time can be calculated by applying a step input to the control output
(output of M/A in the configuration example) of the Control Loop. The time (in seconds) that it
takes for the process variable to begin to respond is the dead time. The gain value is calculated
by taking the ratio of the change in the process output divided by the change in input (change in
the process variable divided by the change in control output).

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU- Data Init Required 106 Tuning diagram -

Integer number
PVG R1 -Real Tuning Required 1.0 Gain on process -
Constant input. The gain on
the input should
never be initialized
to zero; if it is, the
drop is placed into
alarm.
PVB R2 -Real Tuning Required 0.0 Bias on process -
Constant variable input

TPSC R3 -Real Tuning Required 100.0 Output top of scale -

Constant

BTSC R4-Real Tuning Required 0.0 Output bottom of -

Constant scale

* TDLY T3-Real Selectable Required 0.0 Process time LA

delay

PV - Variable Required - Process variable LA

analog input

OW360_R1100 451
5.88 PREDICTOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

CTRL - Variable Required - Down stream PID LA

control output

DLIN - Variable Optional - Output of the LA

TRANSPORT
algorithm(s)
* GAIN T4 - Real Selectable Required 1.0 Gain on process LA
MODEL
* FOTC T1- Real Selectable Required 10.0 The 1st time LA
constant in the
model.
* SOTC T2 - Real Selectable Required 0.0 The 2nd time LA
constant
OUT - Variable Required - Analog output LA
variable
DOUT - Variable Optional - Input to the LA
downstream
TRANSPORT.
Analog outvariable
* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be executed
properly, you must enter a value for the parameter.

The control system structure can be illustrated by the following diagram. The dashed line box
contains the Predictor.

Figure 29: Functional Diagram

where:

y(s) = process variable

u(s) = control output

r(s) = set point

 = dead time.

452 OW360_R1100
 5.88 PREDICTOR

In the ideal case , ,

and the closed-loop transfer function is:

OW360_R1100 453
5.89 PRIORITY Algorithm Package

5.89 PRIORITY Algorithm Package

The PRIORITY algorithm package is a combination of three individual algorithms that can be
used together to perform priority-based sequencing of devices:
 PRIORITY algorithm -- consolidates complex logic to perform priority-based sequencing
when turning devices ON and OFF. The PRIORITY algorithm allows you to attach up to 16
devices and control these devices by turning them on or off based on a set of priorities
configured by the user.
 PRIORITY-EXT algorithm -- dynamically calculates external priorities and is designed for use
with the PRIORITY algorithm. The algorithm allows priorities to be assigned to input device
channels by means of operating hours or other analog parameters related to devices.
 PRIORITY-REJ algorithm -- provides a method to manage load rejection up to a predefined
number of devices and is designed for use with the PRIORITY algorithm. The algorithm
gathers information about priorities of devices and current devices in service, and then uses
this information to turn devices ON or OFF.

5.89.1 PRIORITY

Description

The purpose of this algorithm is to consolidate complex logic to perform priority-based sequencing
when turning devices ON and OFF. The PRIORITY algorithm allows the user to attach up to 16
devices and control these devices by turning them on or off based on a set of priorities configured
by the user.

Functional symbol

454 OW360_R1100
 5.89 PRIORITY Algorithm Package

Operation

The device status is determined from the feedback inputs (FBx) and the ready for control inputs
(RDYx). An FBx input is the ON/OFF status of a device (1 = ON, 0 = OFF). A RDYx input
indicates if the device is available for control (1 = ready, 0 = not ready).

The following describes the rules of operation:

 A device can be switched ON only when the device is OFF and ready
(FBx = 0 and RDYx = 1).
 A device can be switched OFF only when the device is ON and ready
(FBx = 1 and RDYx = 1).
 If not connected, the RDYx input is considered ON if the corresponding FBx input is
connected.
 If not connected, the RDYx input is considered OFF if the corresponding FBx input is also not
connected.
 If not connected, the device status FBx input is considered OFF.

Number of devices required (NUMRQ)

The algorithm automatically detects the maximum number of devices available for control. This is
calculated by counting the number of devices connected to the FBx pins. At most, 16 individual
devices can be controlled by one Priority algorithm. The number of devices currently ON
(NUMON) is determined by the active FBx inputs. The user, and/or control logic, determines the
number of devices currently required to turn on (NUMRQ). That value is reflected in the NUMRQ
output and is determined by the configured limitations and system inputs.

NUMRQ is determined by:

 Minimum/Maximum Required Devices:
The default range of NUMRQ is 0 to the maximum number of devices connected (up to 16).
Using Low Limit (LLIM), the value of NUMRQ can be forced to keep a minimum number of
devices on. Using High Limit (HLIM), the maximum number of devices allowed to be active
can be held less than the number connected, if desired. For example, if LLIM is set to 3 and
HLIM is set to 5, then the minimal number of devices active will not fall below 3 and the
maximum number of devices active will not exceed 5. If NUMON surpasses either one of
these limits, a high or low flag will be set in STAT (status section). If LLIM and HLIM are 0, the
algorithm will use its default range (0-16).
 If LLIM < 0, LLIM will default to 0.
 If LLIM > 16 or LLIM > HLIM, it will default to the value of HLIM.
 If HLIM < LLIM, it will default to the value of LLIM.
 If HLIM > 16, it will default to the maximum number of devices connected.

Note: If LLIM and HLIM are configured via signal diagrams, the fields will only allow a value
between 0 - 15 for LLIM and 1 - 16 for HLIM.

 Increment/Decrement with INCDV / DECDV

A pulse into INCDV / DECDV will cause an increase/decrease (respectively) of NUMRQ. The
algorithm ensures this number will not drop below or exceed the range of required devices.
Holding in both of these inputs will cancel out both commands and holding in either input will
Increment/Decrement by only one device.

OW360_R1100 455
5.89 PRIORITY Algorithm Package

 Change Several devices with ANUM / NUM

The requested number of devices input (NUM) can override the current number of required
devices, but only if it is in a valid range and the activate NUM input (ANUM) is set. The
INCDV/DECDV signals will be locked out while the ANUM input is set true.
 Changeover action (parameter NRTYPE)
Depending on the COMOD parameter (UP_CHNGOVER / DN_CHANGEOVER) the number
of devices increase or decrease temporarily during the changeover action. These changes
impact the NUMRQ, when the NRTYPE is set to TOTAL. When, the NRTYPE is set to BASE,
then temporary changes of devices do not reflect on the NUMRQ output pin.

Commanding Devices ON and OFF

The algorithm commands devices ON and OFF using the Command Device ON (DVON) and
Command Device OFF (DVOFF) packed output points, where each of the 16 bits represents the
corresponding device. The algorithm calculates when to turn a device ON and OFF based on
device priority and NUMRQ. In both the DVON and DVOFF outputs, bits for unconnected devices
(FBx) are always OFF.

The algorithm calculates the next device to switch ON or OFF and sets the appropriate bit for
these devices in the Next On (NON) and Next Off (NOFF) packed output points. This calculation
is based on device priority and whether the appropriate FBx and RDYx pins are set. Both outputs
provide an indication of what device would turn on/off next, if the priorities increase/decrease or
NUMRQ is changed.

A bit map of the devices the algorithm expects to be ON is displayed in the REQON output.

Note: Devices whose RDYx signal is off, but FBx is currently on, will be added to the REQON
bit map and to the NUMON value, as well.

Priority Management

Part of the calculation for turning a device ON or OFF is based on the device priority. Priorities are
set by the user using the DPRx fields or EDPRx pins. The priority for each device can be set from
1 to 16 using the DPRx fields, or 0x0 through 0xF using the EDPRx pins, with 1 or 0x0 being the
highest priority and 16 or 0xF being the lowest. More than one device can have the same priority,
in which case higher priority is given to the lower numbered device. For example, if device 1 and
device 13 have the same priority assigned, then device 1 will always be treated as the higher
priority.

The PRIORITY algorithm will try to run the highest priority device first, and work its way to the
lowest priority device, until the NUMRQ is reached (or there are no more devices ready to
activate). For example, if device 1 has a priority of 6 and device 2 has a priority of 3, then device 2
will run before device 1. However, if device 2’s RDYx pin is deactivated and device 1’s RDYx pin
is activated, then device 1 will turn on, even though it has a lower priority.

456 OW360_R1100
 5.89 PRIORITY Algorithm Package

Priorities can be set in two ways:

 In Automatic Mode:
Priorities can be changed via pins using the external device priority (EDPRx) inputs. Each
input contains packed priorities for four devices. Algorithms will only accept external priorities
if the submit device priority pin (SDPR) is set.
 In Manual Mode:
Priorities can be changed via fields using the device priority DPRx fields. The algorithm will
set the new values, if the user sets the submit device priority SDPR field.

After the algorithm accepts the new priorities, they will be displayed in the CPRx fields. If DPRx is
set to any value outside the range of 1 to 16, CPRx will be set to 16, but the algorithm will not
change the DPRx fields.

Disabled/Auto/Manual Mode

Selecting between disabled, automatic, and manual modes can be done using the
DSABL/AUTO/MAN inputs or the Disable/Auto/Manual buttons.

In disabled mode, the algorithm will only update the status and number of active devices currently
on (NUMON) and will accept user priority changes. It will not attempt to turn on devices. In
addition, if the rotation mode (RTMOD) parameter is configured as on - ignore disabled
(ON_IGN_DSABL), the algorithm will continue to rotate priorities.

In Manual mode, certain algorithm commands are controlled by fields.

In Auto mode, certain algorithm commands are controlled via input pin connections.

The following parameters are affected by AUTO/MAN mode: INCDV, DECDV, NUM, ANUM,
CODV, CMAN, CAUTO, SDPR, and EDPRx/DPRx.

In addition, you may configure the algorithm to allow both manual and auto commands at the
same time while the algorithm is in auto mode using the manual/auto control (MACTL) parameter.
This allows the operator to direct the algorithm via pushbutton, even though the algorithm is in
auto.

If more than one of the mode signals is set at the same time, the algorithm will give precedence to
Disabled mode, then Manual mode, then Auto mode. For instance, if Manual and Auto are both
set at the same time, the algorithm will reject to Manual mode.

Operation Mode

There are three different ways to turn on several different devices. Using the operating mode
(OPMOD) parameter, devices can be turned on/off in three different modes: SERIAL, PARALLEL,
or serial on, parallel off (S_ON_P_OFF). In serial mode, the devices will be activated or
deactivated one at a time, until the NUMRQ and NUMON equal each other. In parallel mode, the
algorithm will calculate the difference between NUMRQ and NUMON and attempt to turn on/off
that many devices all at once. In serial on, parallel off mode, the algorithm will turn on devices in
serial mode but will turn off devices in parallel mode.

OW360_R1100 457
5.89 PRIORITY Algorithm Package

Rotation Mode

The PRIORITY algorithm provides the capability to automatically change device priorities
internally, based on the changing states of the FBx inputs. When Rotation mode is activated,
priorities are rotated each time one of the devices is turned on or off. When a device turns off, its
priority is set to the number of connected devices (lowest priority). Devices not connected are set
to a lower priority than all connected devices. For instance, if eight devices are connected, then all
the devices not connected are set to a higher number than 8, as long as the user did not tune the
priorities manually. Turning on a device sets it to the highest priority of 1. Priorities of all other
devices are incremented or decremented respectively.

This mode can be switched off (NO_ROTATION), switched on (ROTATION), or switched on when
the algorithm is disabled (ON_IGN_DSABL) using the RTMOD parameter.

Changeover Mode

The algorithm can be configured to rotate devices based on a set of timers, rather than an
external mechanism. This functionality is called Changeover, and it is designed to even out the
wear of devices while they are running for an extended period of time.

In order to activate changeover, RTMOD must be in an active state (that is, ROTATION or
ROT_WHEN_ENBL modes). In addition, COMOD must be configured to UP_CHNGOVER or
DN_CHNGOVER modes and the three changeover timers need to be configured. The input signal
changeover enable (COEN) indicates that changeover is ready to run (when it is not connected
changeover is enabled by default).

Example:

First, a command is given to the algorithm to start a changeover via the Changeover Device
(CODV) signal. The algorithm will increase the NUMRQ from 3 to 4 (COMOD is set to
UP_CHNGOVER). The fourth Device would have the length of TAC timer (allowed time for
changeover) to turn on. If the device turns on in time, then NUMRQ will hold four devices until the
TTC (transition time) timer counts down to zero. Once TTC reaches zero, NUMRQ is set to 3
again and then the device that had the highest priority needs to turn off before TAC reaches zero.

Changeover will continue depending on whether the algorithm is in Changeover manual or

Changeover automatic. This is determined by the CMAN and CAUTO parameters. If both
parameters are set, or neither is set, then the algorithm will default to Changeover Manual. In
changeover manual mode, the user must start changeover via the CODV signal. In changeover
auto mode, the TBC (time between changeovers) timer determines the time between
changeovers. At the end of the TBC time, changeover will start again.

The following state table displays the possible states that changeover can be in. These states are
reported through the CSTAT output.

Bits description

BITS DESCRIPTION

0 Specifies the idle flag

1 Specifies the changeover
manual
2 Displays the changeover auto
3 Displays the on hold flag

458 OW360_R1100
 5.89 PRIORITY Algorithm Package

BITS DESCRIPTION

4 Displays the started flag

5 Displays the pending flag
6 Displays the finished flag
7 Displays the ready flag
8 Displays the reinitialize flag
9 Displays the timeout flag
10 Displays the external change
flag
11 Displays the manual reject flag

A description of the states is listed below:

 Idle State
 Job: To wait for algorithm to be ready.
 Reason: If there are no devices to start-up or if the algorithm is disabled or RTMOD is
equal to NO_ROTATION or COMOD is equal to NO_CHNGOVER
 Outputs “Idle” flag is set.
 Next State: “Ready”
 Ready State
 Job: Wait for changeover sequence start.
 Reason: Algorithm was idle, there are ready devices to turn ON/OFF, algorithm is
enabled and RTMOD and COMOD are set and the number of ON devices is equal to the
required number.
 Outputs: “Ready” flag is set.
 Next State: “Started”, “On hold”
 Started State
 Job: Start TAC count down. Increase/decrease required devices number.
 Reason: Algorithm was ready and TBC time elapsed or changeover command was given.
 Outputs: TAC is output to CTIME (Changeover Timer) pin. “Started” flag is set. New
REQON output is set.
 Next State: “Pending,” “On hold,” “Timeout”
 Pending State
 Job: Start TTC count down.
 Reason: Changeover was started and the number of ON devices is equal to the required
number.
 Outputs: TTC is output to CTIME pin. “Pending” flag is set.
 Next State: “Finished” or “On hold”

OW360_R1100 459
5.89 PRIORITY Algorithm Package

 Finished State
 Job: Start TAC count down. Increase/decrease required devices number.
 Reason: Changeover was in “Pending” state, devices have been in the same state for
time set in TTC counter.
 Outputs: TAC is output to CTIME pin. “Finished” Flag is set. New REQON output is set.
 Next State: “Idle,” “Timeout”
 On hold State
 Job: To wait for enable changeover signal (COEN input).
 Reason: Algorithm is ready to change state but COEN signal is not present.
 Outputs: ”On hold” flag is set.
 Next State: “Started,” “Pending,” “Finished”
 Timeout State
 Job: Abandon changeover sequence, reject to manual changeover mode, restart TBC
countdown.
 Reason: Requested change of device states did not occur during TAC countdown.
 Outputs: “Timeout” flag is set. Changeover mode is set to manual. “Manual reject” flag is
set. TBC is output to CTIME pin.
 Next State: “Idle”
 External Change State
 Job: Abandon changeover, reinitialize TBC countdown.
 Reason: External change occurred during changeover sequence.
 Outputs: “External Change” flag is set. TBC is output to CTIME pin.
 Next State: “Idle”
 Reinitialize State
 Job: Reinitialize TBC countdown.
 Reason: External change occurred when changeover was idle.
 Outputs: “Reinitialize” flag is set. TBC is output to CTIME pin.
 Next State: “Idle”

460 OW360_R1100
 5.89 PRIORITY Algorithm Package

 Manual Reject
 Job: This is the error state for automatic changeover.
 Reason(s): If there is an interruption in the sequence during Auto Changeover, then the
sequence will default to Manual Changeover.
 Interruptions include the following:
 Unexpected change in the number of required devices.
 The control mode is changed from auto, to manual or disabled.
 SDPR is activated and new device priorities are excepted.
 One of the timers (TAC, TBC, TTC) finished counting down before its task could
complete.
 TBC is initially set to zero or less.
 To clear the Manual Reject, start the sequence again. However, if the interruption was
never taken care of, or accrues again, then the sequence will again abort to this state.

Prohibited Configurations (PCx)

The algorithm allows the user to specify up to 32 prohibited configurations. This is represented as
32 individual bit maps. For example, if bits 0, 2, and 10 are set, then devices 1, 3 and 11 cannot
run at the same time. If the algorithm tries to change devices to a configuration that is forbidden,
then the algorithm will try to find another configuration that will work.

Note: Prohibited configurations only apply to exact instances of running devices. For instance, if
devices 1, 2, and 3 are prohibited from running, and devices 1, 2, 3, and 4 are requested to run,
then the prohibited configuration will not apply, and all four devices will run. However, if only
devices 1, 2, and 3 are attempting to run, then the algorithm will prevent the devices from
running.

Algorithm Status

Algorithm status and error information is stored in the STAT output. The STAT output bits are
defined as shown:

Bits description

BITS DESCRIPTION

0 Displays the disabled mode.

1 Displays the manual mode.
2 Displays the auto mode.
3 Specifies increasing.
4 Specifies decreasing.
5 Displays the priorities rotated.
6 Displays the priority rotation enabled.
7 Displays the external priorities accepted.
8 Displays the algorithm load or tuning change.
9 Specifies no more available devices to turn OFF.

OW360_R1100 461
5.89 PRIORITY Algorithm Package

BITS DESCRIPTION

10 Specifies no more available devices to turn ON.

11 Displays the maximum or minimum number of ON devices
reached.
12 Specifies reserved.
13 Displays the prohibited configuration.
14 Specifies the external Priorities are different than current
Priorities.
15 Specifies the reserved.

SID Storage

In order to assist with graphics programming, all output point SIDs are stored in fields in the
algorithm. This allows the graphic to access multiple SIDs by accessing a single SID (the
algorithm LC record).

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

Inputs:

AUX1 C7-SID Auxiliary Required -- Displays the priority LC

auxiliary record
DSABL G1 Variable Optional -- Specifies the disabled LD, LP
mode request
RDY1 Variable Optional -- Specifies that device 1 LD, LP
is ready and available
FB1 Variable Required -- Specifies that device 1 LD, LP
On/Off Feedback
RDY2 Variable Optional -- Specifies that device 2 LD, LP
is ready and available
FB2 Variable Required -- Specifies that device 2 LD, LP
On/Off Feedback
RDY3 Variable Optional -- Specifies that device 3 LD, LP
is ready and available
FB3 Variable Optional -- Specifies that device 3 LD, LP
On/Off Feedback
RDY4 Variable Optional -- Specifies that device 4 LD, LP
is ready and available

FB4 Variable Optional -- Specifies that device 4 LD, LP

On/Off Feedback

462 OW360_R1100
 5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

RDY5 Variable Optional -- Specifies that device 5 LD, LP

is ready and available

FB5 Variable Optional -- Specifies that device 5 LD, LP

On/Off Feedback

RDY6 Variable Optional -- Specifies that device 6 LD, LP

is ready and available

FB6 Variable Optional -- Specifies that device 6 LD, LP

On/Off Feedback

RDY7 Variable Optional -- Specifies that device 7 LD, LP

is ready and available

FB7 Variable Optional -- Specifies that device 7 LD, LP

On/Off Feedback

RDY8 Variable Optional -- Specifies that device 8 LD, LP

is ready and available

FB8 Variable Optional -- Specifies that device 8 LD, LP

On/Off Feedback

RDY9 Variable Optional -- Specifies that device 9 LD, LP

is ready and available

FB9 Variable Optional -- Specifies that device 9 LD, LP

On/Off Feedback

RDY10 Variable Optional -- Specifies that device LD, LP

10 is ready and
available
FB10 Variable Optional -- Specifies that device LD, LP
10 On/Off Feedback

RDY11 Variable Optional -- Specifies that device LD, LP

11 is ready and
available
FB11 Variable Optional -- Specifies that device LD, LP
11 On/Off Feedback

RDY12 Variable Optional -- Specifies that device LD, LP

12 is ready and
available
FB12 Variable Optional -- Specifies that device LD, LP
12 On/Off Feedback

RDY13 Variable Optional -- Specifies that device LD, LP

13 is ready and
available
FB13 Variable Optional -- Specifies that device LD, LP
13 On/Off Feedback

RDY14 Variable Optional -- Specifies that device LD, LP

14 is ready and
available

OW360_R1100 463
5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

FB14 Variable Optional -- Specifies that device LD, LP

14 On/Off Feedback

RDY15 Variable Optional -- Specifies that device LD, LP

15 is ready and
available
FB15 Variable Optional -- Specifies that device LD, LP
15 On/Off Feedback

RDY16 Variable Optional -- Specifies that device LD, LP

16 is ready and
available
FB16 Variable Optional -- Specifies that device LD, LP
16 On/Off Feedback

INCDV CN:9 Variable Optional -- Displays the increased LD, LP

number of required ON
devices
DECDV CN:8 Variable Optional -- Displays the decreased LD, LP
number of required ON
devices
MAN CN:12 Variable Optional -- Specifies the manual LD, LP
mode request

AUTO CN:13 Variable Optional -- Specifies the auto LD, LP

mode request

NUM G8 Variable Optional -- Specifies the required LA

number of ON devices
(used with ANUM).
ANUM G2 Variable Optional -- Specifies the activate LD, LP
"Number of Required
ON Devices"
CODV G3 Variable Optional -- Specifies the request LD, LP
device changeover

COEN -- Variable Optional -- Specifies that the LD, LP

Device changeover is
enabled
CMAN D4 Variable Optional -- Specifies the LD, LP
changeover Manual
mode
CAUTO D5 Variable Optional -- Specifies the LD, LP
changeover Auto mode

LLIM G9 Selectable Optional -- Displays the lowest LA

number of requested
devices
HLIM B0 Selectable Optional -- Displays the highest LA
number of requested
devices

464 OW360_R1100
 5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

EDPR1 Variable Optional -- Specifies the external LP

priorities for devices
1-4
EDPR2 Variable Optional -- Specifies the external LP
priorities for devices
5-8
EDPR3 Variable Optional -- Specifies the external LP
priorities for devices
9 - 12
EDPR4 Variable Optional -- Specifies the external LP
priorities for devices
13 - 16
SDPR G5 Variable Optional -- Specifies the submit LD, LP
device priority pin.

Outputs:
DVON B1 - SID Variable Required -- Specifies the devices LP
to be switched ON, but
not OFF
DVOFF B2 - SID Variable Required -- Specifies the devices LP
to be switched OFF,
but not ON
NON YU - SID Variable Optional -- Specifies the next LP
device to go ON

NOFF B4 - SID Variable Optional -- Specifies the next LP

device to go OFF

REQON B5 - SID Variable Optional -- Specify the devices LP

required to be ON

CURON B6 - SID Variable Optional -- Specify the devices LP

currently ON

RDYDV B7 - SID Variable Optional -- Specify the devices LP

ready and available

STAT B8 - SID Variable Optional -- Display the sstatus LP

NUMRQ B9 - SID Variable Optional -- Specifies the number LA

of devices required to
be ON
NUMON C0 - SID Variable Optional -- Specifies the number LA
of devices currently ON

PRI1 C1 - SID Variable Optional -- Specifies the Priopities LP

for devices 1 - 4

PRI2 C2 - SID Variable Optional -- Specifies the Priopities LP

for devices 5 - 8

PRI3 C3 - SID Variable Optional -- Specifies the Priopities LP

for devices 9 - 12

OW360_R1100 465
5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

PRI4 C4 - SID Variable Optional -- Specifies the Priopities LP

for devices 13 - 16

CSTAT C5-SID Variable Optional -- Specifies the LP

chaneover status

CTIME C6-SID Variable Optional -- Specifies the LA

changeover timer

Input Params:
MACTL D0 Tuning Required 0 Specifies the manual or
Constant auto Control mode:
 0 - Normal
 1 - Man in Auto
NRTYPE X7 Tuning Required 0 Specifies the number
Constant required type counting:
 0 - TOTAL
 1 - BASE
OPMOD YQ Tuning Required 0 Specifies the operation --
Constant mode:
 0 - SERIAL
 1 - PARALLEL
 2 - S_ON_P_OFF
Serial on parallel off
RTMOD D2 Tuning Required 0 Specifies the rotation --
Constant mode:
 0 - OFF
 1 - ON
 2 - ON_IGN_DSABL
COMOD YP Tuning Required 0 Specifies the --
Constant Chanceover modes:
 0 - NO_CHNGOVER
 1 - UP_CHNGOVER
 2 - DN_CHNGOVER
TBC D6 Tuning Required 1 Specifies the time --
Constant period between
changeovers
TAC YN Tuning Required 1 Specifies the time --
Constant allowed for changeover
(between start and
stop)
TTC D8 Tuning Required 1 Specifies the time to --
Constant remain in the "Pending
State" during
changeover

466 OW360_R1100
 5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

CTMOD D9 Alg. Init. Variable 0 Specifies the control --

Mode:
 0 - Disabled
 1 - Manual
 2 - Auto
DVFB YM Alg. Init. Variable 0 Specifies the map of --
devices feedback
connections
STATS YL Alg. Init. Variable 0 Specifies the STAT --
value (lower 16 bits)
and CSTAT value
(higher 16 bits)
CPR1 E3 Alg. Init. Variable 0 Specifies the current --
priority for device 1

CPR2 E4 Alg. Init. Variable 0 Specifies the current --

priority for device 2.

CPR3 YC Alg. Init. Variable 0 Specifies the current --

priority for device 3.

CPR4 Y9 Alg. Init. Variable 0 Specifies the current --

priority for device 4.

CPR5 E7 Alg. Init. Variable 0 Specifies the current --

priority for device 5

CPR6 E8 Alg. Init. Variable 0 Specifies the current --

priority for device 6

CPR7 Y8 Alg. Init. Variable 0 Specifies the current --

priority for device 7

CPR8 Y7 Alg. Init. Variable 0 Specifies the current --

priority for device 8

CPR9 Y6 Alg. Init. Variable 0 Specifies the current --

priority for device 9

CPR10 XY Alg. Init. Variable 0 Specifies the current --

priority for device 10

CPR11 XW Alg. Init. Variable 0 Specifies the current --

priority for device 11.

CPR12 F4 Alg. Init. Variable 0 Specifies the current --

piority for device 12.

CPR13 F5 Alg. Init. Variable 0 Specifies the current --

priority for device 13.

CPR14 F6 Alg. Init. Variable 0 Specifies the current --

priority for device 14

OW360_R1100 467
5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

CPR15 XV Alg. Init. Variable 0 Specifies the current --

priority for device 15

CPR16 XU Alg. Init. Variable 0 Specifies the current --

priority for device 16

Auxiliary algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

DPR1 G0 Tuning Required 1 Priority for Device 1 --

Constant (1 - 16)
DPR2 G1 Tuning Required 2 Priority for Device 2 --
Constant (1 - 16)
DPR3 G2 Tuning Required 3 Priority for Device 3 --
Constant (1 - 16)
DPR4 G3 Tuning Required 4 Priority for Device 4 --
Constant (1 - 16)
DPR5 G4 Tuning Required 5 Priority for Device 5 --
Constant (1 - 16)
DPR6 G5 Tuning Required 6 Priority for Device 6 --
Constant (1 - 16)
DPR7 G6 Tuning Required 7 Priority for Device 7 --
Constant (1 - 16)
DPR8 G7 Tuning Required 8 Priority for Device 8 --
Constant (1 - 16)
DPR9 G8 Tuning Required 9 Priority for Device 9 --
Constant (1 - 16)

DPR10 G9 Tuning Required 10 Priority for Device 10 --

Constant (1 - 16)
DPR11 B0 Tuning Required 11 Priority for Device 11 --
Constant (1 - 16)

DPR12 B1 Tuning Required 12 Priority for Device 12 --

Constant (1 - 16)

DPR13 B2 Tuning Required 13 Priority for Device 13 --

Constant (1 - 16)

DPR14 YU Tuning Required 14 Priority for Device 14 --

Constant (1 - 16)

DPR15 B4 Tuning Required 15 Priority for Device 15 --

Constant (1 - 16)

DPR16 B5 Tuning Required 16 Priority for Device 16 --

Constant (1 - 16)

468 OW360_R1100
 5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

PC1 C8 Tuning Required 0 Prohibited --

Constant configuration 1

PC2 YT Tuning Required 0 Prohibited --

Constant configuration 2

PC3 D0 Tuning Required 0 Prohibited --

Constant configuration 3

PC4 YQ Tuning Required 0 Prohibited --

Constant configuration 4

PC5 D2 Tuning Required 0 Prohibited --

Constant configuration 5

PC6 YP Tuning Required 0 Prohibited --

Constant configuration 6

PC7 D4 Tuning Required 0 Prohibited --

Constant configuration 7

PC8 D5 Tuning Required 0 Prohibited --

Constant configuration 8

PC9 D6 Tuning Required 0 Prohibited --

Constant configuration 9

PC10 YN Tuning Required 0 Prohibited --

Constant configuration 10

PC11 D8 Tuning Required 0 Prohibited --

Constant configuration 11

PC12 D9 Tuning Required 0 Prohibited --

Constant configuration 12

PC13 YM Tuning Required 0 Prohibited --

Constant configuration 13

PC14 YL Tuning Required 0 Prohibited --

Constant configuration 14

PC15 E2 Tuning Required 0 Prohibited --

Constant configuration 15

PC16 E3 Tuning Required 0 Prohibited --

Constant configuration 16

PC17 E4 Tuning Required 0 Prohibited --

Constant configuration 17

PC18 YC Tuning Required 0 Prohibited --

Constant configuration 18

PC19 Y9 Tuning Required 0 Prohibited --

Constant configuration 19

PC20 E7 Tuning Required 0 Prohibited --

Constant configuration 20

OW360_R1100 469
5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

PC21 E8 Tuning Required 0 Prohibited --

Constant configuration 21

PC22 Y8 Tuning Required 0 Prohibited --

Constant configuration 22

PC23 Y7 Tuning Required 0 Prohibited --

Constant configuration 23

PC24 Y6 Tuning Required 0 Prohibited --

Constant configuration 24

PC25 XY Tuning Required 0 Prohibited --

Constant configuration 25

PC26 XW Tuning Required 0 Prohibited --

Constant configuration 26

PC27 F4 Tuning Required 0 Prohibited --

Constant configuration 27

PC28 F5 Tuning Required 0 Prohibited --

Constant configuration 28

PC29 F6 Tuning Required 0 Prohibited --

Constant configuration 29

PC30 XV Tuning Required 0 Prohibited --

Constant configuration 30

PC31 XU Tuning Required 0 Prohibited --

Constant configuration 31

PC32 XR Tuning Required 0 Prohibited --

Constant configuration 32

5.89.2 PRIORITY-EXT

Description

The PRIORITY-EXT algorithm allows the user to dynamically calculate external priorities and is
designed for use with the PRIORITY algorithm. The algorithm allows priorities to be assigned to
input device channels by means of operating hours or other analog parameters related to devices.

Functional symbol

470 OW360_R1100
 5.89 PRIORITY Algorithm Package

Sorting

The PRIORITY-EXT algorithm sorts inputs using the status of each analog input based on the
status priority mode (SPMOD), and the value of the analog input (AINx) based on the sorting
mode (SOMOD).

Status Priority Mode

The algorithm sorts by Status first. The status priority mode is configured via the SPMOD
parameter:

Note: Even if SPMOD is set to NONE, inputs that are not connected will have the lowest
priorities.

 Standard
 Status Priority 0 – Quality - Good
 Status Priority 1 – Quality - Fair
 Status Priority 2 – Quality - Poor
 Status Priority 3 – Quality - Bad
 Status Priority 4 – Sensor
 Status Priority 5 – Timeout
 Status Priority 7 – Point Not Connected
 Custom – user can assign each status (SPG, SPF, SPP, SPB, SPS, SPT) a custom priority
(0-5)
 None - Priorities are not taken into account while sorting inputs

Note: It is possible for a point to have an assigned quality and also be in Sensor or Timeout
status. In this scenario, Timeout takes precedence over Sensor, and Sensor takes precedence
over all Quality statuses.

Sorting Mode

Once the algorithm sorts by status, it will then sort the inputs by value. Sorting mode (SOMOD)
determines how the algorithm will sort the inputs. If ascending, the algorithm will assign a greater
priority to the lower numbered input with the lowest value. If descending, the algorithm will assign
greater priority to the higher numbered input with the highest value.

External Device Priority (EDPR) Outputs

Each output contains packed priorities for four devices. Priorities are zero based (Highest priority -
0x0 through Lowest priority - 0xF) are output through four packed points EDPR1-EDPR4. Bits 0-3
of EDPR1 contain the priority for input/device 1; bits 4-7 in EDPR1 contain the priority for
input/device 2; bits 8-11 in EDPR1 contain the priority for input/device 3; and bits 12-15 contain
the priority for input/device 4. EDPR2 applies to inputs 5-8, EDPR3 applies to inputs 9-12, and
EDPR4 applies to inputs 13-16. The EDPRx outputs can be connected directly to the EDPRx
inputs of the PRIORITY algorithm.

OW360_R1100 471
5.89 PRIORITY Algorithm Package

Current Device Priority (CPR) Fields

The current device priority fields store the same values that are in the EDPR outputs for use with
graphics applications. The priorities in these fields are one based. For instance, if the priority
displayed in EDPRx is 0x0, the priority will display as 1 in the CPR field. If it is a 0x5 in EDPRx, it
will display as a 6 in the CPR field.

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

Inputs:

AIN1 -- Variable Required -- Analog input 1 to LA

use for sorting.
AIN2 -- Variable Required -- Analog input 2 to LA
use for sorting.
AIN3 -- Variable Optional -- Analog input 3 to LA
use for sorting.
AIN4 -- Variable Optional -- Analog input 4 to LA
use for sorting.
AIN5 -- Variable Optional -- Analog input 5 to LA
use for sorting.
AIN6 -- Variable Optional -- Analog input 6 to LA
use for sorting.
AIN7 -- Variable Optional -- Analog input 7 to LA
use for sorting.
AIN8 -- Variable Optional -- Analog input 8 to LA
use for sorting.
AIN9 -- Variable Optional -- Analog input 9 to LA
use for sorting.
AIN10 -- Variable Optional -- Analog input 10 to LA
use for sorting.
AIN11 -- Variable Optional -- Analog input 11 to LA
use for sorting.
AIN12 -- Variable Optional -- Analog input 12 to LA
use for sorting.
AIN13 -- Variable Optional -- Analog input 13 to LA
use for sorting.
AIN14 -- Variable Optional -- Analog input 14 to LA
use for sorting.
AIN15 -- Variable Optional -- Analog input 15 to LA
use for sorting.
AIN16 -- Variable Optional -- Analog input 16 to LA
use for sorting.

472 OW360_R1100
 5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

Outputs:
EDPR1 -- Variable Required -- Priorities for LP
devices
1 - 4.
EDPR2 -- Variable Optional -- Priorities for LP
devices
5 - 8.
EDPR3 -- Variable Optional -- Priorities for LP
devices
9 - 12.
EDPR4 -- Variable Optional -- Priorities for LP
devices
13 - 16.
Input Params:
SOMOD X1 Tuning Required 0 Sorting mode: --
Constant
0 - Ascending
1 - Descending
SPMOD X2 Tuning Required 0 Status Priority: --
Constant
0 - Standard
1 - Custom
2 - None
SPG X4 Tuning Required 0 Assigned Priority --
Constant for status: GOOD
quality.
SPF X5 Tuning Required 1 Assigned Priority --
Constant for status: FAIR
quality.
SPP X6 Tuning Required 2 Assigned Priority --
Constant for status: POOR
quality.
SPB X7 Tuning Required 3 Assigned Priority --
Constant for status: BAD
quality.
SPS X8 Tuning Required 4 Assigned Priority --
Constant for status:
SENSOR.
SPT X9 Tuning Required 5 Assigned Priority --
Constant for status:
TIMEOUT.
CPR1 G0 Alg. Init. Variable 0 Current Priority --
for Device 1.
CPR2 G1 Alg. Init. Variable 0 Current Priority --
for Device 2.

OW360_R1100 473
5.89 PRIORITY Algorithm Package

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

CPR3 G2 Alg. Init. Variable 0 Current Priority --

for Device 3.
CPR4 G3 Alg. Init. Variable 0 Current Priority --
for Device 4.
CPR5 G4 Alg. Init. Variable 0 Current Priority --
for Device 5.
CPR6 G5 Alg. Init. Variable 0 Current Priority --
for Device 6.
CPR7 G6 Alg. Init. Variable 0 Current Priority --
for Device 7.
CPR8 G7 Alg. Init. Variable 0 Current Priority --
for Device 8.
CPR9 G8 Alg. Init. Variable 0 Current Priority --
for Device 9.
CPR10 G9 Alg. Init. Variable 0 Current Priority --
for Device 10.
CPR11 B0 Alg. Init. Variable 0 Current Priority --
for Device 11.
CPR12 B1 Alg. Init. Variable 0 Current Priority --
for Device 12.
CPR13 B2 Alg. Init. Variable 0 Current Priority --
for Device 13.
CPR14 YU Alg. Init. Variable 0 Current Priority --
for Device 14.
CPR15 B4 Alg. Init. Variable 0 Current Priority --
for Device 15.
CPR16 B5 Alg. Init. Variable 0 Current Priority --
for Device 16.

474 OW360_R1100
 5.89 PRIORITY Algorithm Package

5.89.3 PRIORITY-REJ

Description

The PRIORITY-REJ algorithm provides a method to manage load rejection up to a predefined

number of devices and is designed for use with the PRIORITY algorithm. The algorithm gathers
information about priorities of devices and current devices in service, and then uses this
information to turn devices on or off.

Functional symbol

Current State of Devices

1. Devices Ready for Control (RDYDV)
Each bit in the packed RDYDV input represents one device. If a bit is active, then the
algorithm assumes the device is ready to be controlled and can be turned on/off as needed.
When a bit is not active, the required on (RQON) output will reflect the current state of that
device based on the CURON input.
The RDYDV input is designed to be used with the RDYDV output from the PRIORITY
algorithm. If the RDYDV input is not connected, all devices are considered “ready for control”
by this algorithm.
2. Devices Currently ON (CURON)
Each bit in the packed CURON input represents one device. If a bit is active, then the
algorithm assumes the device is currently on. The algorithm then limits the number of devices
the operator wants to remain on, based on this input and the required number of devices
(NUM) input. Only devices that are ON and ready (RDYDV) can be activated or deactivated.
The resulting algorithm calculation is reflected in the required on (RQON) output. If NUM is
greater than the number of devices currently on, then the algorithm will not attempt to turn
additional devices on.
The CURON input is designed to be used with the CURON output from the PRIORITY
algorithm. However, the CURON input can also be connected to another PRIORITY-REJ
algorithm (RQON) output if cascading algorithms are being used.
3. Required Number of Devices (NUM)
Required Number of Devices (NUM) controls the number of devices that the algorithm will
activate using RQON. For example, if seven devices are available (both CURON and
RDYDV) and NUM is set to 3, then three devices will be selected to keep on. The algorithm
will choose the devices based on the priority assigned to them via the PRIx pins. Higher
priority devices will be selected first.

OW360_R1100 475
5.89 PRIORITY Algorithm Package

4. Devices Currently OFF (DVOFF) and Reject (REJ)

Each bit in the packed DVOFF input represents one device. When the reject input (REJ) is
inactive, the required off (RQOFF) output will reflect the DVOFF input. When the REJ input is
active, the RQOFF output will attempt to turn off all devices that are not currently selected to
stay on (RQON).
The DVOFF input is designed to be used with the DVOFF output from the PRIORITY
algorithm. This input may also be connected to the ‘Devices required off’ (RQOFF) output
from another PRIORITY-REJ algorithm.

Device Priority Inputs

Each PRIx input contains the packed priorities for four devices (PRI1 though PRI4). For example,
Bits 0-3 of PRI1 contain the priority for device 1; bits 4-7 contain the priority for device 2; bits 8-11
contain the priority for device 3; and bits 12-15 contain the priority for device 4. PRI2 applies to
devices 5-8, PRI3 applies to devices 9-12, and PRI4 applies to devices 13-16.

The PRIx inputs are designed to be used with the PRIx outputs of the PRIORITY algorithm. The
priorities of each device can only be set between 0x0 (the highest priority) and 0xF (the lowest
priority). If two (or more) devices have the same priority, then the lowest numbered device will be
given higher priority.

Algorithm Status

Algorithm status and error information is stored in the STAT output. The STAT output bits are
defined as shown:

Bits description

BIT DESCRIPTION

0 OK flag -- set when it is possible to keep the required number of devices.

1 Reject flag -- set when the REJ command is given.
2 Equal flag -- set when the number of currently active devices equals the required
number of devices.
3 Inadequate Number of Devices flag -- set when the required number of devices is
greater than the number of devices that can be activated.
4 Surplus Number of Devices flag -- set when it is not possible to turn off sufficient
number of devices.
5 Tuning error flag -- set when the required number of devices is less than 0 or greater
than 16.

SID Storage

In order to assist with graphics programming, all output point SIDs are stored in fields in the
algorithm. This allows the graphic to access multiple SIDs by accessing a single SID (the
algorithm LC record). Output SIDs are mapped into the C0 - C2 fields.

476 OW360_R1100
 5.89 PRIORITY Algorithm Package

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

Inputs:

REJ -- Variable Required -- Active Reject mode LD

RDYDV -- Variable Optional -- Devices available for LP

control
CURON -- Variable Optional -- Devices currently on LP

NUM G0 Selectable Required -- Required number of LA

ON devices
DVOFF -- Variable Optional -- Devices currently off LP

PRI1 -- Variable Optional -- Packed priorities for LP

channels 1-4
PRI2 -- Variable Optional -- Packed priorities for LP
channels 5-8
PRI3 -- Variable Optional -- Packed priorities for LP
channels 9-12
PRI4 -- Variable Optional -- Packed priorities for LP
channels 13-16
Outputs:
RQOFF B0 Variable Required -- Devices required to LP
C0-SID be OFF.
RQON B1 Variable Optional -- Devices required to LP
C1-SID be ON.
STAT B2 Variable Optional -- Algorithm status. LP
C2-SID

OW360_R1100 477
5.90 PSLT

5.90 PSLT
Description

PSLT calculates Pressure of Saturated Liquid given its Temperature. It is one of the functions of
the STEAMTABLE algorithm (see page 594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

PSLT input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) TEMP 32.0 705.47

(OUT 1) PRES 0.0885891400 16000.00

478 OW360_R1100
 5.91 PSVS

5.91 PSVS
Description

PSVS calculates Pressure of Saturated Vapor given its Entropy (S). It is one of the functions of
the STEAMTABLE algorithm (see page 594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

PSVS input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) ENTR 1.0612 2.1873

(OUT 1) PRES 0.08858914 3208.234

OW360_R1100 479
5.92 PULSECNT

5.92 PULSECNT
Description

The PULSECNT algorithm counts the number of FALSE to TRUE transitions of the digital input
point. If the Reset flag is TRUE, the output count is set to zero before the digital value is checked.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

RSET - Variable Required - Input (digital); LD, LP

reset flag

IN1 - Variable Required - Input (digital LD, LP

signal)

OUT - Variable Required - Output LA

(analog); count

Function

IF RSET
THEN OUT = 0
IF IN1 = TRUE AND OLDIN = FALSE
THEN OUT = OUT + 1

where:

OLDIN = locally retained variable

480 OW360_R1100
 5.93 QAVERAGE

5.93 Q AVERAGE
Description

The QAVERAGE algorithm output is the unweighted average of the N inputs. Analog inputs
whose quality is BAD, or whose value is not being updated, are excluded from the average
calculation so that only the remaining inputs are averaged. The quality of the output equals the
worst quality of all the input values averaged. If all points have BAD quality, the old output value is
retained, and the quality of the output is set BAD.

Invalid Numbers and Quality

The values of the analog inputs to the algorithm are checked for invalid real numbers. If the value
of an input is invalid, that input is considered to have BAD quality.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Optional - Input (analog) LA

•
•
•
IN8
OUT - Variable Required - Output (analog) LA

Function

If the quality is GOOD for all points, and the points are being updated,
THEN OUT = (IN1 + ...INN)/N

Any point with BAD quality is excluded from the average. If all points have BAD quality,
THEN OUT = OLDOUT
and the quality is BAD.

OW360_R1100 481
5.94 QUALITYMON

5.94 QUALITYMON
Description

The QUALITYMON algorithm sets the digital output signal (OUT) TRUE if the input value (IN1)
has the same quality as selected in the quality type field(X1). IN1 can be either an analog or
digital variable.

Invalid Numbers and Quality

The value of the input (IN1) to the algorithm is checked for invalid real numbers. If the input value
is invalid, that input is considered to have BAD quality, and the digital output (OUT) is set TRUE.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 92 Tuning -

diagram
number
CHK X1-Byte Data Init Required BAD Quality check -
type:
BAD, FAIR,
Not GOOD,
GOOD
IN1 - Variable Required - Input (analog LA, LD
or digital)
OUT - Variable Required - Output (digital) LD, LP

Function
If the quality of IN1 is the selected quality type, or if its value is not being updated,
THEN OUT = TRUE
ELSE
OUT = FALSE

482 OW360_R1100
 5.95 RAMPGEN

5.95 RAMPGEN
Description

The RAMPGEN algorithm ramps its output to follow a setpoint target when in automatic mode, or
it ramps the output up or down at a fixed rate in manual mode.

Functional symbol

Functionality

The bits in the STIN input pin control the behavior of the RAMPGEN algorithm.

Bits description

BIT DESCRIPTION

Bit 0 Initialize OUT to INIT input. If this bit is active, OUT is set immediately to the
INIT value. If the INIT value is higher than HILM or lower than LOLM, then
OUT is cut to the limit.

Note: If Bit 0 is set to TRUE, it overrides the other bits. The algorithm initializes OUT to INIT and
ignores the other bits.

Bit 1 Ramp Auto/Manual Mode (0 - MAN, 1 - AUTO).

In AUTO mode the algorithm ramps its output signal to follow a target setpoint
(TARG) with the rate defined by LORT or HIRM (depending on the value of
bit 4).
In MAN (manual) mode, the algorithm can ramp the output down (if bit 2 is
TRUE) or up (if bit 3 is TRUE). The rate is defined by LORT or HIRT
(depending on the value of bit 4).
Bit 2 Ramp Down in manual mode.

OW360_R1100 483
5.95 RAMPGEN

BIT DESCRIPTION

Bit 3 Ramp Up in manual mode.

Bit 4 Fast Ramp Rate (0 - NORMAL, 1 - FAST).
Bit 5 Implied manual mode. When TRUE and a Ramp Up or Down (bit 2=1 or
bit 3 =1), the algorithm will ramp in manual mode without respect to the Ramp
Auto/Manual mode (bit 1).
Bit 6 Inhibit increase.
Bit 7 Inhibit decrease.
Bits 8 - 15 NOT USED.

The state of the algorithm is presented from the STOU output pin. It is a word of 16 consecutive
bits. They are:

Bits description

BIT DESCRIPTION

Bit 0 Output is at minimum.

Bit 1 Output is at maximum.
Bit 2 Initialize input status.
Bit 3 Setpoint is increasing.
Bit 4 Setpoint is decreasing.
Bit 5 Manual “Raise/Lower” is active.
Bits 6 - 15 NOT USED.

The OUT output pin keeps the current value for setpoint.

Also note:
 Fast and slow ramp has to be a positive value.
 DDBND parameter has to be greater or equal to 0.0. This parameter defines the minimum
value of output change to set Bit 3 or Bit 4 in the STOU output pin.
BIT 3 is TRUE when (OUT – LAST_OUT) > DDBND * task_area.
BIT 4 is TRUE when (OUT – LAST_OUT) < -DDBND * task_area.

484 OW360_R1100
 5.95 RAMPGEN

Tracking and Limits

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog track point. This algorithm takes the following action in response to the information
found in the analog input signal TRKIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through

17 Track if lower No action Passed through*
18 Track if higher No action Passed through*
19 Lower inhibit Implemented Passed through**
20 Raise inhibit Implemented Passed through**
21 Conditional Track No action Not used
22 Not used No action Not used
23 Deviation Alarm No action Not used
24 Local Manual mode No action Not used
25 Manual mode No action Not used
26 Auto mode No action Not used
27 Not used No action Not used
28 Not used No action Not used
29 Not used No action Not used
30 Low limit reached No action Low limit reached
31 High limit reached No action High limit reached
* Only when the Track signal is not present.
** Only when the Track signal is not present; the signals are set according to the definitions
given in Setting Tracking Signals (see page 17).

Quality
The quality of the OUT pin will be set to the same value as the lowest quality analog input pin. For
example, if the INIT pin quality is BAD, LORT quality is FAIR, and all other inputs quality are
GOOD, then the OUT quality is set to BAD. In this case, the algorithm calculates the value based
on the bits in the STIN input and updates the OUT and TOUT pins in each loop.

The quality of the STIN input is not considered in the quality calculations.

If the value of inputs used for OUT calculations is invalid (INF or NAN), then the algorithm does
not update the SETPT and TOUT pins – the outputs are set to the last correct value.

OW360_R1100 485
5.95 RAMPGEN

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required Not Tuning Diagram -

defined yet Number.
DDBND R1 Tuning Required 0.0 Deadband for -
parameter changes
INIT R2 Selectable Required 0.0 Initial value LA

LORT R3 Selectable Required 1.0 Slow ramp rate LA

per second.
HIRT R4 Selectable Required 5.0 Fast ramp rate LA
per second.
TPSC R5 Selectable Required 100.0 Output Top of LA
Scale
BTSC R6 Selectable Required 0.0 Output Bottom of LA
Scale
STIN Variable Required Input status bits LP

TARG Selectable Required 0.0 Setpoint target LA

TOUT Variable Required Track out LA

OUT Variable Required Setpoint LA

STOU Variable Optional Output status bits LP

TRKIN Variable Optional Tracking input LA

486 OW360_R1100
 5.96 RATECHANGE

5.96 RATECHANGE
Description

The RATECHANGE algorithm calculates the analog value of OUT as the smoothed rate of
change of IN1. The smoothing time constant (SMTH) can either be dynamic, using an input pin, or
a constant, by defining it within the algorithm. This calculation is performed once per loop cycle
giving OUT units of [IN1] per loop time.

Invalid Numbers and Quality

If the smoothing time constant (SMTH) is less than zero, the negative value is ignored and the
calculation is performed with a smoothing time constant of 0. The quality of OUT is then set to
BAD. The quality of OUT will also be set to BAD if an invalid real number is read from IN1. Unless
either of these situations occur, the quality of OUT will be the same as the quality of IN1.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 71 Tuning Diagram -

Number
* SMTH R1-Real Selectable Required 0.0 Smoothing time LA
constant in seconds

Note: This is
approximately 1/5
of the total time to
settle. For
example, for 1
minute total, set
SMTH to 12
seconds.

OW360_R1100 487
5.96 RATECHANGE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

Function

where:

S(N) = smoothed value of the analog variable (alpha x IN1) + (beta x old
smoothed value)

SS(N) = double smoothed value of the analog variable (alpha x S(N)) + (beta x old
double smoothed value)

alpha = 1 - E(-loop time/SMTH)

beta = E(-loop time/SMTH)

loop time = sampling time (loop time)

488 OW360_R1100
 5.97 RATELIMIT

5.97 RATELIMIT
Description

The RATELIMIT algorithm is a rate limiter with fixed rate limit and flag when rate limit is
exceeded. For the RATELIMIT algorithm, if the rate of change of the output is less than or equal
to the rate limit, the output equals the input, and the digital output flag is set FALSE. If the rate of
change of the output is greater than the rate limit, the output change is limited to the rate limit
value and the digital output flag is set to TRUE. The quality of the analog input is propagated to
the output.

Invalid Numbers and Quality

The input value (IN1) to the algorithm is checked for invalid real numbers. If the input value is
invalid, the output is invalid and the quality of the output is set to BAD. Also, if the input is invalid,
the digital output flag retains its last value and its quality is set to BAD. If the input value is valid,
the quality of the input is propagated to the output.

Functional symbol

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog track point. This algorithm takes the following action in response to the information
found in the analog input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit Implemented Passed through**

20 Raise inhibit Implemented Passed through**

21 Conditional Track No action Passed through**

22 Not used No action Not used

23 Deviation Alarm No action Not used

OW360_R1100 489
5.97 RATELIMIT

BIT DESCRIPTION ACTION TOUT SIGNAL

24 Local Manual mode No action Not used

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the definition given
in Setting Tracking Signals (see page 17).

The high and low limit flags and the tracking signals from the algorithm are output to TOUT, to be
used for display and by an upstream algorithm. If the output value is invalid, the quality of OUT is
set to BAD. Otherwise, the quality of OUT is set to the quality of the input when not in tracking
mode. When tracking, the quality is set to the quality of the track input variable.

Note: If the algorithm generates an invalid track output value, the IN1 input value is used as the
track output, unless it is invalid. The track output value is not updated if both the calculated track
output and IN1 input values are invalid.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init. Required 20 Displays the tuning -

diagram number.

TPSC R5-Real Tuning Required 1E+09 Specifies the -

Constant maximum value of
(999999999) the output point.
BTSC R6-Real Tuning Required -1E+09 Specifies the -
Constant minimum value of
(-999999999) the output point.
* RALM R1-Real Selectable Required 0.0 Specifies the rate of LA
change limit in units
per second.
IN1 - Variable Required - Specifies the input LA
(analog).

490 OW360_R1100
 5.97 RATELIMIT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

TOUT - Variable Required - Specifies the track LA

output value. For
mode and status
signals for input.
OUT - Variable Required - Specifies the output LA
(analog).
TRIN - Variable Optional - Specifies the LA
tracking and limiting
mode signals and
track value.
FOUT - Variable Required - Specifies the output LD, LP
(digital).

TROP X1-Byte Data Init. Required NORMAL Specifies the type of -

tracking:
Bit 0
 NORMAL =
Responds to Track
bit, Track if higher
bit, Track if lower
bit, and Conditional
Track bit. The
RALM parameter
is used to carry the
OUT parameter to
the TRIN value.
 STRICT =
Responds only to
the Track bit. The
OUT parameter is
instantaneously set
to the TRIN value.
* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be executed
properly, you must enter a value for the parameter.

OW360_R1100 491
5.97 RATELIMIT

Function

PLR = RALM * (TS/1000)

TEMP = (IN1 - OLDOUT)
IF ABS(TEMP) < PLR
THEN OUT = IN1
FOUT = FALSE
ELSE
IF TEMP > 0.0
THEN OUT = OLDOUT + PLR
ELSE
OUT = OLDOUT - PLR
FOUT = TRUE
IF OUT > TPSC
OUT = TPSC
ELSE
IF OUT < BTSC
OUT = BTSC

where:

PLR = rate per loop

OLDOUT = locally retained variable

TEMP = local, temporary variable

TS = sampling time (loop time) in milliseconds

492 OW360_R1100
 5.98 RATEMON

5.98 RATEMON
Description

The RATEMON algorithm is a rate of change monitor with reset deadband and fixed/variable rate
limit. For the RATEMON algorithm, if the input value (IN1) increases at a rate faster than the
user-specified rate of change limit in the positive direction, or decreases at a rate faster than the
user-specified rate of change limit in the negative direction, the digital output flag (OUT) is set
TRUE. To reset the output flag, the input value must increase at a rate slower than the rate of
change limit in the positive direction minus the deadband on the positive rate of change limit, or
decrease at a rate slower than the rate of change limit in the negative direction minus the
deadband on the negative rate of change limit.

Invalid Numbers and Quality

The input value (IN1) is checked for invalid real numbers. If IN1 is invalid, the digital flag retains
its last value and its quality is set to BAD.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 75 Tuning Diagram -

Number
* PRAT R1-Real Selectable Required 0.0 Rate of change LA
limit in the positive
direction (absolute
value)
PDB R2-Real Tuning Optional 0.0 Deadband on the -
Constant positive rate of
change limit
(absolute value)
* NRAT R3-Real Selectable Required 0.0 Rate of change LA
limit in the
negative direction
(absolute value)

OW360_R1100 493
5.98 RATEMON

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

NDB R4-Real Tuning Optional 0.0 Deadband on the -

Constant negative rate of
change limit
(absolute value)
IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (digital) LD, LP

* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

Function

RATE = (IN1 - OLDIN)/TS

IF (RATE > PRAT)
OR (RATE < (0 - NRAT))
THEN OUT = TRUE
ELSE
IF (RATE < (PRAT - PDB))
AND (RATE > (0 - (NRAT - NDB)))
THEN OUT = FALSE

where:

RATE = local, temporary, variable

OLDIN = locally retained, real variable

TS = sampling time (control task loop time)

494 OW360_R1100
 5.99 RESETSUM

5.99 RESETSUM
Description

The RESETSUM algorithm accumulates until told to reset. For the RESETSUM algorithm, if the
Run flag is TRUE, the output value (OUT) is the sum of the gained input value (IN1) and the old
output value. If the Freeze flag is TRUE, the output value is also stored in the frozen output
(FOUT). As OUT continues to totalize IN1, the value in FOUT is frozen when the Freeze flag
reverts back to FALSE.

If the Reset flag is TRUE, OUT is set to the reset count stored in the RCNT (R1) field of the
algorithm record. If the Run flag is FALSE, the algorithm does nothing. You may tune the output
value anytime by setting the TRST (R3) field of the algorithm record to a non-zero value. The
algorithm will set the TRST (R3) field back to zero after it detects a non-zero value. The TRST
(R3) value is checked first; then, the Reset flag is checked before the summation is made.

Note: The Ovation system is limited to single precision floating point numbers, which can affect
algorithm precision. This may be seen if the RESETSUM algorithm stops updating its output and
locks at what appears to be a maximum value (though no max value is defined or reached). For
more information on this, refer to: What are single precision floating point numbers?
(see page 6).

Functional symbol

The quality of the input is propagated to the output points (OUT and FOUT) under the following
conditions:
 The RUN flag is TRUE.
 The outputs are not scan-removed.
 The values of the inputs and outputs are valid real numbers.
 The RSET flag must be FALSE for the quality of the output (OUT) to be updated. However, if
the RSET flag is TRUE, the output retains its last quality value.
 The freeze flag (FFLG) must be TRUE for the quality of the frozen point (FOUT) to be
updated. However, if the freeze flag is FALSE, the frozen output (FOUT) retains its last quality
value.

OW360_R1100 495
5.99 RESETSUM

The quality of the output is not affected by requests to tune the value of the output through the
use of the R3 record field or by setting the RSET flag to TRUE.

Quality propagation is overruled by invalid real numbers. If the input (IN1) contains an invalid real
number, the quality of the output (OUT) is set to BAD, providing the point is not scan-removed
and that the RUN flag is TRUE. The quality of the frozen output point (FOUT) is also set to BAD if
the point is not scan-removed and the freeze flag (FFLG) is TRUE.

Invalid Numbers and Quality

The value of the input (IN1) is checked for invalid real numbers. If the input value is invalid, the
output (OUT) retains its last valid value. If the input value is valid, the quality of IN1 is propagated
to OUT.

If the FFLG flag is TRUE and the input is invalid, the value of the frozen output (FOUT) is equal to
the output (OUT).

If the input is invalid, any requests to digitally reset the output value (OUT) through the use of the
RSET flag are ignored.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 4 Tuning Diagram -

Number

RCNT R1-Real Tuning Required 0.0 Reset count -

Constant

GAIN R2-Real Tuning Required 1 Gain on the input -

Constant

TRST R3-Real Tuning Optional 0.0 Tuning reset count -

Constant

IN1 - Variable Required - Input (analog) LA

FFLG - Variable Required - Input (digital); LD, LP

Freeze flag
RSET - Variable Required - Input (digital); LD, LP
Reset flag
RUN - Variable Required - Input (digital); Run LD, LP
flag
OUT - Variable Required - Output (analog) LA

FOUT - Variable Required - Output (analog); LA

frozen value

496 OW360_R1100
 5.99 RESETSUM

Function
IF TRST  0

THEN OUT = TRST

IF RUN = TRUE

THEN TEMP = OUT + (GAIN x IN1)

IF FFLG = TRUE

THEN FOUT = TEMP

IF RSET = TRUE

THEN OUT = RCNT

ELSE

OUT = TEMP

where:

TEMP = local, temporary, real variable

OW360_R1100 497
5.100 RLICONFIG

5.100 RLICONFIG
Description

The RLICONFIG algorithm is used to send data constant information to the Loop Interface card. If
the data stored in the card versus the data stored in the algorithm is different, then the algorithm
sends the information in the algorithm to the card. The algorithm supports tuning either the
Control Defined Process Variable, the Setpoint or Output/Drive, Analog Input 1, or Analog Input 2
sections of the Loop Interface card.

The optional STAT output point contains the status of the Loop Interface card. The following
conditions apply:
 If bit 0 is true, then the algorithm cannot communicate with the card.
 If bit 1 is true, the algorithm is configuring the setpoint section.
 If bit 2 is true, the algorithm is configuring the process variable section.
 If bit 3 is true, the algorithm is configuring the electric drive section.
 If bit 4 is true, the algorithm is configuring the analog input 1 section.
 If bit 5 is true, the algorithm is configuring the analog input 2 section.

Functional symbol

498 OW360_R1100
 5.100 RLICONFIG

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

CARD X4 - Byte Data Init Required 1 PCI card -

number
HWAD B2 - Integer Data Init Required 0 Card hardware -
address

TYPE X1 - Byte Data Init Required Setpoint Section to -

configure. The
choices are:
 Setpoint
 CTLR_PV
 Drive
 Analog
ATYP X9 - Byte Data Init Required AI1 Analog point
section to
configure:
 AI1
 AI2
PCST X2 -Byte Data Init Required 25 Setpoint -
seconds for full
scale
TIST X3 - Byte Data Init Required 4 Setpoint -
percent change
TPST R1 - Real Data Init Required 100 Setpoint top of -
scale
BTST R2 - Real Data Init Required 0 Setpoint bottom -
of scale

EUST AJ - ASCII Data Init Required PCT Setpoint -

engineering
units
TPPV R3 - Real Data Init Required 100 Process -
variable AI1,
AI2 top of scale
BTPV R4 - Real Data Init Required 0 Process -
variable AI1,
AI2 bottom of
scale
EUPV AK - ASCII Data Init Required PCT Process -
variable AI1,
AI2 engineering
units
FINE G0 - Integer Data Init Required 1 Fine deadband -

CRSE G1 - Integer Data Init Required 5 Coarse -

deadband

OW360_R1100 499
5.100 RLICONFIG

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

FIN10 R5 – Data Init Required 0.0 Fine deadband -

Integer with tenths for
deadbands
smaller than 1.
FIN10 is used
instead of FINE
if FINE is
configured as
non-zero
CRS10 R6 – Data Init Required 0.0 Coarse -
Integer deadband with
tenths for
deadband
smaller than 1.
CRS10 is used
instead of
CRSE if CRSE
is configured as
non-zero
SLOW G2 - Integer Data Init Required 771 Slow -
raise/lower
pulse on/off
(See note
below.)
FAST G3 - Integer Data Init Required 65280 Fast raise/lower -
pulse on/off
(See note
below.)
PCNT X5 - Byte Data Init Required 4 Narrow band -
percent change
TIME X6 - Byte Data Init Required 25 Seconds for full -
scale
PRAT X7 - Byte Data Init Required 3 Priority runback -
rate
CTYP X8 - Byte Data Init Required 1 Conversion -
Type (Valid
choices are
1 - 6)
COE00 S1 -Real Data Init Required 0 Coefficient 0 -

COE01 S2 -Real Data Init Required 0 Coefficient 1 -

COE02 S3 -Real Data Init Required 0 Coefficient 2 -

COE03 S4 -Real Data Init Required 0 Coefficient 3 -

COE04 S5 -Real Data Init Required 0 Coefficient 4 -

COE05 S6 -Real Data Init Required 0 Coefficient 5 -

COE06 S7 -Real Data Init Required 0 Coefficient 6 -

COE07 S8 -Real Data Init Required 0 Coefficient 7 -

500 OW360_R1100
 5.100 RLICONFIG

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

COE08 S9 -Real Data Init Required 0 Coefficient 8 -

COE09 T1 -Real Data Init Required 0 Coefficient 9 -

COE10 T2 -Real Data Init Required 0 Coefficient 10 -

COE11 T3 -Real Data Init Required 0 Coefficient 11 -

COE12 T4 -Real Data Init Required 0 Coefficient 12 -

COE13 T5 - Real Data Init Required 0 Coefficient 13 -

ENBL - Variable Optional - Enable flag LD, LP

STAT - Variable Optional - Status of the LP

RLI card

Notes:

 The slow/fast, raise/lower pulse on/off times for electric drive signals (low byte = off time;
high byte = on time) are in units of 0.1 or 0.004 seconds.
 Two ranges of value (0.1 or 0.004 second resolution) are available for the electric drive
slow/fast action pulse on/off values.
 For 0.1 second resolution, byte values in the range of 0 to 127 (00 to 7FH) are used. For
example, 03H represents a 0.3 second pulse time (3 x 0.1).
 For 0.004 second resolution, byte values in ranges 128 to 255 (80 to FFH) are used to
represent the range 0 to 127. For example, 83H represents a 0.012 second pulse time
(3 x 0.004).

OW360_R1100 501
5.101 RPACNT

5.101 RP ACNT
Description

The RPACNT algorithm reads the pulse count from the Ovation Pulse Accumulator card. The
algorithm uses the hardware address in the OUT point to access the Ovation Pulse Accumulator
card.

When IN1 is TRUE, the algorithm reads the pulse count from the card, resets the counter to zero
and stores the pulse counts in OUT. Conversion may be done on the pulse value before the pulse
count is stored in the OUT point. A linear conversion, if chosen, is taken from the CV, 1V and 2V
of the OUT point. For example, consider the case in which the input is a count of contact closures
from a watt hour meter. The number of megawatt hours per pulse can be accounted for in the
coefficients that are calculated as part of the point record. For example, to get the megawatt
hours per hour, the rate would be:

PULSES KWH MWH MIN MWH

3 * 10 * * 60 = 1.8
MIN PULSE 1000 KWH HR HR

The FOUT point contains accumulated pulse count until the reset flag (RSET) is TRUE. If IN1 and
RSET are TRUE, then FOUT contains the pulse count read from the card.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input, read LD, LP

trigger of the
RPA card
(digital)
RSET - Variable Optional - Input to reset LD, LP
count (digital)
OUT - Variable Required - Output value LA
from RPA card
(analog)
FOUT - Variable Optional - Accumulated LA
count output
value (analog)

502 OW360_R1100
 5.102 RPAWIDTH

5.102 RP AWIDTH

Description

The RPAWIDTH algorithm reads the pulse width from the Ovation Pulse Accumulator card
(See Ovation I/O Reference Manual). The algorithm uses the hardware address in the OUT point
to access the Ovation Pulse Accumulator card. If there is a hardware error, the OUT is set to BAD
quality.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

OUT - Variable Required - Pulse Width LA

output (analog)

OW360_R1100 503
5.103 RSRSTATUS

5.103 RSRSTATUS
Description

The RSRSTATUS algorithm performs the following:

 Displays the status register and command register for the Ovation Servo Driver (RSR) card.
 Calibrates Channel 1 and Channel 2 of the RSR card using a project-specific graphic
(diagram 8799) instead of using the RSR serial port.
 Uploads and downloads configurable parameters used by the RSR card. (See Ovation I/O
Reference Manual.)
If a point is assigned to the ENBL input, and the point is TRUE, then the STAT1, STAT2, and
CMD outputs are updated. If ENBL is FALSE, then the last value of STAT1, STAT2, and CMD is
retained.

Note: Use the RSRSTATUS algorithm only with E or greater level of RSR firmware.

Functional symbol

Calibration Commands

There are three different types of calibrations that can be done to the valve:
 0% or Low Calibration command - moves the actuator until the 0% position is
re-established. The feedback gain is not re-established.
 100% or High Calibration command - moves the actuator until the 100% position is
re-established. The feedback gain is not re-established.
 Full Calibration command - moves the actuator until both the 0% and 100% positions are
re-established. It also re-establishes the feedback gain.
During the travel sequence, the actuator moves the valve at a programmable rate. While the
Valve Positioner is traveling, the graphic displays and continuously updates the current voltage
value based on the position. There is also a Clear Calibration command that may be used if the
calibration command is no longer desired.

The UTYP parameter can be configured to allow the constant value to be automatically uploaded
after any calibration command.

504 OW360_R1100
 5.103 RSRSTATUS

Upload Command

The upload command is used to retrieve the constant values currently stored in the RSR card
memory. When the upload command is executed, the X3 value is changed and the RSR card is
commanded to send the current values stored in its memory to the 32-bit real number fields of the
algorithm record. The standard graphic then displays the values in these selected algorithm
record fields for the user when the upload is finished. Note these values can only be uploaded
when the RSR card is in local or normal mode.

Note: For the Ovation 3.5 release and later, the UPLOAD operation can change the OutputMin
and OutputMax values maximally about +/-2 but only one time. For example, if you set
OutputMax=9000, this value will be changed to 8999 after download and upload operations and
will not be changed until you type a new value. This property is related to a numerical rounding
issue and the fact that the RSR card tunes parameters as a short unsigned INT.

Download Command

The download command is used to update the constant values currently stored in the RSR Card
memory. When the download command is requested, the X3 field is changed, and the values
entered into the graphic are stored in the 32-bit real number fields of the algorithm record. Then
the values in the selected fields of the algorithm record are written to the RSR memory. Note
these values can only be downloaded when the RSR card is in local or normal mode.

The DTYP parameter can be configured to automatically download the constant values when the
RSR card is replaced or reseated in the slot.

Interface Information

The calibration commands are sent to the X3 field in the algorithm record.

Command description

CALIBRATE COMMAND COMMAND DESCRIPTION

0 No Command.

1 Channel 1 Calibrate 0%.

2 Channel 1 Calibrate 100%.

3 Channel 1 Full Calibration.

7 Clear Calibration Request.

8 Upload Request.

9 Download Request.

11 Channel 2 Calibrate 0%

12 Channel 2 Calibrate 100%

13 Channel 2 Full Calibration

15 Channel 1 Normal Mode

16 Channel 1 Local Mode

OW360_R1100 505
5.103 RSRSTATUS

CALIBRATE COMMAND COMMAND DESCRIPTION

17 Channel 1 Raise 0.5%

18 Channel 1 Lower 0.5%

19 Channel 2 Normal Mode

20 Channel 2 Local Mode

21 Channel 2 Raise 0.5%

22 Channel 2 Lower 0.5%

24 Display Feedback Voltage

25 Display DAC Setting

As the commands are being executed, messages are displayed on the graphic by the status
value in the X5 field of the algorithm record.

Status description

STATUS DESCRIPTION

0 No Message.

1 Calibration in Progress.

2 Poor Calibration.

3 Calibration Time-out.

4 Upload Error.

5 Download in Progress.

6 Download Error.

7 Download Time-out.

8 Channel 1 Not Ready.

11 Command cannot be processed.

12 Channel 2 Not Ready.

506 OW360_R1100
 5.103 RSRSTATUS

RSR CALIBRATION DIAGRAMS

There is one calibration diagram linked to an RSR module:

 Diagram 8799 = Project-specific diagram.

Accessing Diagram 8799

In order to perform tuning calibrations on the RSR module, you need to use a tuning diagram
such as diagram 8799. This diagram is accessed from a custom graphic. You can use the
Ovation Graphics Builder to create code that will call the 8799 calibration diagram. Refer to the
Ovation Graphics Builder User Guide for more information on building Ovation graphics.

The following is an example of calling the 8799 diagram from diagram 1000 by using a standard
OL_BUTTON command in Ovation Graphics Builder:

OL_BUTTON 6868 6044 HORZ SQUARED TEXT_LABEL VECTOR 137 438 1 "RSR
TUNING" EXEC_POKE 7 2 6 0 5 \RSRSTAT\ ID \RSRSTAT\ ID 3 83 3 117 8799 20 0 0 0 0
15 \RSR-DMD1\ ID \RSR-POS1\ ID\RSR-INTGV1\ ID \RSR-DMD2\ ID \RSR-POS2\ ID
\RSR-INTGV2\ ID \RSR-STAT1\ ID \RSR-STAT2\ ID \RSR-CMD\ ID \MASTATION1\ ID
\MAMODE1-MODE\ ID \MASTATION2\ ID \MAMODE2-MODE\ ID \RSR-OUT1\ ID
\RSR-OUT2\ ID
* RSRSTAT - RSRSTAT LC point
* RSR-DMD1 - RSR IO point - channel 5
* RSR-POS1 - RSR IO point - channel 1
* RSR-INTGV1 - RSR IO point - channel 3
* RSR-DMD2 - RSR IO point - channel 6
* RSR-POS2 - RSR IO point - channel 2
* RSR-INTGV2 - RSR IO point - channel 4
* RSR-STAT1 - RSRSTAT STAT1 output point
* RSR-STAT2 - RSRSTAT STAT2 output point
* RSR-CMD - RSRSTAT CMD output
* MASTATION1 - MASTATION1 LC point
* MAMODE1-MODE - MAMODE1 - MODE output point
* MASTATION2 - MASTATION2 LC point
* MAMODE2-MODE - MAMODE2 - MODE output point
* RSR-OUT1 - RSRSTAT OUT1 output point
* RSR-OUT2 - RSRSTAT OUT2 output point

OW360_R1100 507
5.103 RSRSTATUS

Diagram 8799

Diagram 8799 consists of three main sections: Common, Channel 1 and Channel 2:
 Common section contains configuration pushbuttons and tuning constant entry fields common
for both channels.
 Channel 1 section contains configuration pushbuttons, tuning constant entry fields and
message lines used only for Channel 1.
 The Channel 2 section contains configuration pushbuttons, tuning constant entry fields and
message lines used only for Channel 2.

Figure 30: Servo Driver tuning diagram

Common Section of 8799 Diagram

Calibration is performed by using command pushbuttons and entering tuning constants in the
entry fields. Some of the pushbuttons are accompanied with rectangular confirmation boxes –
when the function is selected, the color changes from black to yellow.

508 OW360_R1100
 5.103 RSRSTATUS

The pushbuttons and entry fields that are used to set configuration values are described in the
following table.

Calibration Fields in Common Section of 8799 Diagram

BUTTON OR ENTRY FIELD DESCRIPTION

Upload button Read data command given to RSR module.

Download button Write data command given to RSR module.

Clear EF’s button Clear diagram entry field command.

INTEGRAL button DAC is displayed in RawVoltage and OutputValue for both channels -
the yellow rectangle confirms selection.
LVDT button Feedback voltage is displayed in RawVoltage and OutputValue for
both channels - the yellow rectangle confirms selection.
PROPOR button Proportional output option flag to 1 - the yellow rectangle confirms
selection.
REGUL button Proportional output option flag to 0 - the yellow rectangle confirms
selection.
REDUND button Redundant LVDT option flag to 1 - the yellow rectangle confirms
selection.
SINGLE button Redundant LVDT option flag to 0 - the yellow rectangle confirms
selection.
INPLACE button Fail-in-place flag to 1 - the yellow rectangle confirms selection.

TOZERO button Fail-in-place flag to 0 - the yellow rectangle confirms selection.

CASCADE button Cascade flag to 1- the yellow rectangle confirms selection.

NORMAL button Cascade flag to 0 (normal configuration) - the yellow rectangle

confirms selection.
contingencyTime entry field The time in milliseconds - if the error between target position and
actual position exceeds contingency for this amount of time, then the
condition is reported to the Controller.
posErrorRetreat entry field The output will not retreat until ABS| posFB - TargetPos|
<posErrorRetreat.
retreatRate entry field Volts per second rate of output retreat.

retreatHoldT entry field The time in milliseconds - retreat occurs after this time has expired,
and (ABS|Target-Feedback| < posErrorRetreat).

OW360_R1100 509
5.103 RSRSTATUS

Channels 1 and 2 of 8799 Diagram

Calibration is performed by using command push buttons and entering tuning constants in the
entry fields. Some of the push buttons are accompanied with rectangular confirmation boxes –
when the function is selected the box color is changed. The full, zero hot and top hot calibration
sequences can be started selecting proper push buttons. The calibration sequence can be
stopped at any time. It is not possible to start calibration sequence for both channels
simultaneously. When the calibration of any channel is in progress DOWNLOAD, UPLOAD,
CLEAR EF’s, OUTPUT, LVDT push buttons are disabled.

When the calibration is finished, the tuning of the PI position control should be performed. It can
be done in RSR local or normal mode. When local mode is selected the only way to change the
valve position demand is to press UP or DOWN push buttons. Normal mode is selected by
pressing DPU push button and the valve position demand is changed by pressing up/down arrow
push buttons, or entering demand in DEO entry field.

The following push buttons and entry fields are used to set the values of important configuration.

Calibration Fields in Channel Sections of 8799 Diagrams

BUTTON OR ENTRY FIELD DESCRIPTION

0% button Calibrate zero% - the yellow rectangle confirms selection.

100% button Calibrate 100% - the yellow rectangle confirms selection.

FULL button Full Calibration - the yellow rectangle confirms selection.

STOP button Stop Calibration - the yellow rectangle confirms selection.

UP button Raise - the yellow rectangle confirms selection.

DOWN button Lower - the yellow rectangle confirms selection.

DPU button RSR channel 1(2) to normal mode - the green rectangle confirms
selection.
LOC button RSR channel 1(2) to local mode - the yellow rectangle confirms
selection.
AUT button Mastation channel 1(2) to auto mode - the blue rectangle confirms
selection.
MAN button Mastation channel 1(2) to manual mode - the red rectangle confirms
selection.
up arrow push button Raise Mastation channel 1(2) output.

down arrow push button Lower Mastation channel 1(2) output.

DEO button Mastation channel 1(2) output digital entry.

piGain entry field PI Controller gain outside of deadband.

piResetT entry field PI Controller reset time outside of deadband.

demodGain entry field The A/D converter gain to achieve a voltage range representing 0 to
100 %.
errorDbS entry field When the absolute value of the difference between the target
position and the actual position is less than this value, the valve is
considered to be stable.

510 OW360_R1100
 5.103 RSRSTATUS

BUTTON OR ENTRY FIELD DESCRIPTION

errorDbF entry field When the absolute value of the difference between the target position
and the actual position is greater that this value, the valve is
considered to be in motion.
piGainDb entry field PI Controller gain inside deadband.

piResetTDb entry field PI Controller reset time inside deadband.

Outoffset entry field RSR output offset for the proportional mode.

iLimit entry field Integration limit - 100% no limit, 0% no integration.

calRateCh1(2) entry field Automatic calibration demand change rate – channel 1(2).
DIRECT entry field PI mode.
seatLimit entry field When target valve position is equal to or less than this value, seating
action controls the output.
backSeatLimit entry field When the target valve position is equal to or greater than this value,
backseating action controls the output.
exitSeatVal entry field When the RSR is seating the valve, then decides to retreat, this is the
output in mV to which the output goes.
exitBkSeatVal entry field When the RSR is backseating the valve, then decides to retreat, this
is the output in mV to which the output goes.
Calzero entry field The converted to decimal hexadecimal A/D converter reading for the
0% position.
Calhndrd entry field The converted to decimal hexadecimal A/D converter reading for the
100% position.
Contingency entry field The difference between Servo Driver target position and actual
Position.

The following display fields in the bottom of the 8799 diagram are used to display the status and
calibration of the RSR module.

Display Fields in Channel Sections of 8799 Diagrams

FIELD DESCRIPTION

RSR Status Options are:

 LOCAL mode
 Normal MANUAL
 Normal AUTO
Message line Options are:
 Retreat in progress
 Retreat is disabled
 Contingency

OW360_R1100 511
5.103 RSRSTATUS

FIELD DESCRIPTION

Calibration status Options are:

 Not in calibration
 CAL0 in Progress
 CAL100 in Progress
 FULL Calibration in Progress
 Calibration is Finished.
General Messages Messages that appear in the bottom of the 8799 diagram.

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 157 Tuning Diagram -

Number
PCI X4-Byte Data Init. Required 1 PCI Card Number -
(1 or 2)
HWAD B2-Integer Data Init. Required 0 Card Hardware -
Address
UTYP X6-Byte Data Init. Required YES Automatically -
upload after a
Bit 0 Calibration.
 YES (Default)
 NO
DTYP X6-Byte Data Init. Required YES Automatically -
download
Bit 1
 YES (Default)
 NO
ENBL - Variable Optional - Enable Flag LD,LP
(digital)
CC - Variable Optional - Cascade close LD, LP
command

CCF - Variable Optional - Cascade close LD, LP

freeze tracking
CCV - Variable Optional - Cascade close LA
value
IDMD1 - Variable Optional - Channel 1 LA
demand input
IDMD2 - Variable Optional - Channel 2 LA
demand input
STAT1 - Variable Required - RSR Status LP
register (packed)

512 OW360_R1100
 5.103 RSRSTATUS

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

STAT2 - Variable Required - RSR Status LP

register 2 (packed)

CMD - Variable Optional - RSR Command LP

register (packed)

ODMD1 - Variable Optional - Channel 1 LA

demand output

ODMD2 - Variable Optional - Channel 2 LA

demand output
OUT1 - Variable Optional - Channel 1 output LA
value
OUT2 - Variable Optional - Channel 2 output LA
value
X8 X8 – Byte Data Init Required 0 Allows you to -
Bit 0 specify if the
Output Min/Max
parameter should
accept real or
integer numbers:
 0 – INTEGER
 1 – REAL

OW360_R1100 513
5.104 RUNAVERAGE

5.104 RUNAVERAGE
Description

The RUNAVERAGE algorithm performs a running average calculation on a number of samples

collected at a sampling interval time. The input (IN1) is sampled periodically as specified by the
user from the Number of Units and Units of Time fields. Any decimal part in the Number of Units
field is ignored. If the time specified is less than the loop time, the input is sampled every loop.
Otherwise, the input is sampled on the first loop after the specified number of time boundaries
have elapsed.

The output, which is calculated every loop, is the average of the last N samples of the input,
where N is 8 or less. Thus, the time period for the average is the product of the sampling interval
time and the number of samples. If the quality of the input is BAD, that value of the input is not
included in the calculation. If the quality of the samples for a given period is BAD, then the output
value remains unchanged, but the quality is set BAD. During initial operation before N samples
exist, the output that is calculated is based on the available samples.

The values of all IN1 samples are checked for invalid real numbers. If an IN1 sample value is
invalid, the stored, internal quality of that IN1 is set to BAD. Only sample values with GOOD,
FAIR, and POOR quality are used to calculate the value of OUT; the quality of OUT is set
according to the rules listed in the Function section of this description.

At any given time, the output is the average of N samples, made up of the most current sample
and the previous N-1 samples. Every sampling time, the oldest sample is discarded and replaced
with a new sample.

Functional symbol

514 OW360_R1100
 5.104 RUNAVERAGE

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 61 Tuning Diagram -

Number
TIME R1-Real Tuning Optional 0.0 Number of units -
Constant

UNIT X1-Byte Data Init. Optional 0 Units of time -

0 = tenths of a
second
1 = seconds
2 = minutes
3 = hours
4 = days
NUM R2-Real Tuning Required 0 Number of samples -
Constant to be averaged
(1 through 8)
IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

Function

The quality of the output is as follows:

 On the first pass: BAD
 If all samples during the period are BAD: BAD
 If less than half the samples are GOOD: POOR
 If more than half the samples are GOOD: FAIR
 If all samples during the period are GOOD: GOOD

OW360_R1100 515
5.105 RUNTIME

5.105 RUNTIME
Description

The RUNTIME algorithm counts long-lasting service times of devices. This algorithm consists of
two counters; run time (RTIME) and number of starts (NUMST).

Functional symbol

Algorithm Activation (START)

The algorithm is activated when you set the START input. When this occurs, the algorithm begins
to increment the RTIME counter and also increments the NUMST parameter by 1. The START
input must remain set to activate the algorithm. If the START input is unset, the algorithm will stop
incrementing the RTIME counter.

Reset Counters (TRST and SRST)

You can reset the algorithm through the time reset (TRST) and number of starts reset (SRST)
inputs. Resetting the algorithm through these inputs will set both the RTIME and the NUMST
counters to 0 and qualities to GOOD.

There are several reset options available through the tuning parameters: time reset option
(TROP) and starts reset option (SROP). These options are summarized in the following table:

Tuning parameter values

TUNING P ARAME TE R V ALU E NAME RESET SELECTED

0 (default) RST_ON xRST input = 1 resets counter.

1 RST_OFF xRST input = 0 resets counter.
2 RST_CH1 xRST input change 0->1 resets counter.
3 RST_CH0 xRST input change 1->0 resets counter.
4 RST_CHG xRST any input change resets counter.

516 OW360_R1100
 5.105 RUNTIME

Run Time (RTIME)

The run time (RTIME) parameter is determined by the difference between the Controller time in
the current loop and the Controller time in the previous loop and added to an internal counter. The
internal counter is a 32-bit integer number. This allows counting up to 2^32 = 4,294,967,296
seconds which is equivalent to 136 years or 1,193,046 hours. For simplicity, the algorithm uses a
maximum of 999,999 hours at which time the counter will not increment any further. The
maximum value is equivalent to more than 100 years. The number of seconds is recalculated to
hours represented by a floating value and is reflected in the RTIME algorithm output.

Number of Starts (NUMST)

The number of starts (NUMST) parameter is determined by the amount of times the START input
transitions from 0 to 1. This counter is reflected in the number of starts (NUMST) output and is
internally stored in the algorithm. The maximum number of starts is 999,999, at which time the
counter will not increment any further.

Splitting time values

The algorithm supports splitting the time represented in RTIME into hours, minutes, and seconds.
Each part is reflected in optional outputs; run hours (RHRS), run minutes (RMIN), and run
seconds (RSEC).

Calculations are performed according to the following equations:

RHRS = int (RTIME / 3600)

RMIN = int ((RTIME mod 3600) / 60)

RSEC = RTIME mod 60

Manually updating counters

A manual update of either the RTIME counter or the NUMST counter can be achieved by
changing either the incremental tuning value for the time parameter (TTIM) or the incremental
tuning value for the number of starts parameter (TNST) respectively. Changing these parameters
will cause the algorithm to add the value entered to the current RTIME or NUMST value. The
algorithm will then zero out each field (TTIM and/or TNST) and update the current incremental
tuning value for time (CTTIM) or current incremental tuning value for number of starts (CTNST)
respectively. The CTTIM and CTNST fields store the user-entered values for future references.

If you want to start the algorithm with either the TTIM or TNST values, you must first reset each
counter to zero out the current RTIME and NUMST counters. Then the TTIM and TNST values
can be entered.

Note: Entering a number less than zero or greater than 999,999 will cause the algorithm to
ignore the value and reset the TTIM and TNST fields to zero.

OW360_R1100 517
5.105 RUNTIME

Initialize from Saved Points Option (INITP)

The INITP option, allows you to determine how the algorithm initializes its outputs after a clear
and load of both Controllers at the same time. The major difference is that in the INITP mode, the
RUNTIME algorithm reads the last saved output point value from the controller memory. In this
case the initial quality is taken from the point directly.

If the INITP option is ON, then the RUNTIME algorithm initializes its outputs from the NUMST and
the RTIME output points that are periodically saved by the Controller. This allows the RTIME and
the NUMST values to persist in cases of dual power failures to a Controller pair. The saved point
values do not persist when both the Controllers are cleared at the same time; however, you may
use the RECOP option described above. If both the INITP and the RECOP options are ON, the
RUNTIME algorithm initializes its outputs using whichever value is greater.

Notes:

 You must configure both the RTIME and NUMST points to be “Periodic save” using the
Ovation Developer Studio. The resolution of the INITP option is limited by the Controller
parameter “Save Variables @ Interval (sec)” defined by the Ovation Developer Studio. See
Ovation Developer Studio User Guide for more information on configuration.
 To allow reading from controller memory you must create aperiodic point with the Periodic
Save option enabled (this option is available in the Initial tab).

Updating counters from operator graphics

You can overwrite the counters values from the operator graphics using dedicated LC fields.
 To change time value, the CSTIM (Y0 field) command must be set. The STIM (R4 field) value
is used to overwrite the current time value. If the START parameter is in active mode, then
the time value increases in the same loop.
 To change the number of starts, the CSNST (Y1 field) command must be set. The SNST (G6
field) value is used to overwrite the current number of starts. If the START parameter is in
active mode, then for the first time, increments start in the currently executed loop.

Note: The CSTIM and CSNST commands are automatically cleared after the graphics
operation.

Resetting quality from operator graphics

Quality of the RTIME and the NUMST pins are cleared to GOOD from the operator graphics.
 To clear the RTIME quality, the QTIM (Y2 field) must be set to 1.
 To clear the NUMST pin quality, the QNST (Y3 field) must be set to 1.

Note: The QTIM and QNST commands are automatically cleared after the graphics operation.

518 OW360_R1100
 5.105 RUNTIME

Reconcile Option (RECOP)

The reconcile option allows you to determine how the algorithm initializes its outputs after a clear
and load of both Controllers at the same time.

When the reconcile option is off, the algorithm initializes its outputs to 0 and POOR quality after a
clear and load of both Controllers. When the reconcile option is on, the algorithm will initialize its
outputs using the previously reconciled values in the RTIME - R1 and NUMST - G3 fields and set
all outputs to GOOD quality. The initialized values will also be stored in the CTTIM and CTNST
fields for future reference. When the algorithm is started, it begins counting from the initialized
values.

Output Point Quality

If the RECOP option is off, any time a loaded Controller is restarted without an operable partner
drop (and with the INITP option set to OFF), the RTIME and NUMST are initialized to 0, and the
outputs will be marked with POOR quality. POOR quality indicates that the value is not
trustworthy because the output values will be initialized to 0. The qualities are changed to GOOD
after a reset by the time reset (TRST) and/or start reset (SRST) inputs. Also, updating the TTIM
field will set the RTIME quality to GOOD and updating the TNST field will set the NUMST quality
to GOOD.

The QFLAG option allows you to set BAD quality and stop counting, when the max value of the
RTIME or the NUMST is reached. This option is common for both of the pins, but the quality for
both of them is independently calculated. By default, the QFLAG is disabled and the BAD quality
at the top limit is not propagated.

Note: New functionality does not impact on actual instances of the RUNTIME algorithm,
because by default configuration the behavior of the RUNTIME algorithm remains unchanged.

SID Storage

In order to assist with graphics programming, all output point SIDs are stored in fields in the
algorithm. This allows the graphic to access multiple SIDs by accessing a single SID (the
algorithm LC record).

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

Inputs:

START -- Variable Required -- Specifies the LD, LP

algorithm activation.
TRST * X4 Variable Optional -- Displays the reset LD, LP
run timers.
SRST * X5 Variable Optional -- Resets the number LD, LP
of starts.

OW360_R1100 519
5.105 RUNTIME

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

Outputs:

RTIME R1 - Value Variable Optional -- Displays the total LA

B0 - SID run time in hours
(floating point).
RHRS G0 - Value Variable Optional -- Displays the run LA
B1 - SID time in hours
(integer).
RMIN G1 - Value Variable Optional -- Displays the run LA
B2 - SID time in minutes
(integer).
RSEC G2 - Value Variable Optional -- Displays the run LA
YU - SID time in seconds
(integer)
NUMST G3 - Value Variable Optional -- Displays the LA
B4 - SID Numbnr of device
starts.
Parameters:

TROP X1 Tuning Required 0 Specifies the Time --

Constant Reset Option:
 0 (default) -
RST_ON
 1 - RST_OFF
 2 - RST_CH1
 3 - RST_CH0
 4 - RST_CHG
SROP X2 Tuning Required 0 Specifies the Start --
Constant Reset Option:
 0 (default) -
RST_ON
 1 - RST_OFF
 2 - RST_CH1
 3 - RST_CH0
 4 - RST_CHG
RECOP X3 Data Init. Required 0 Specifies the --
Reconcile option:
 0 = Off
 1 = On
TTIM R2 Tuning Required 0 Incremental tuning --
Constant value for time (in
hours).
TNST G4 Tuning Required 0 Displays the --
Constant Incrimental tuning
value for number of
starts.

520 OW360_R1100
 5.105 RUNTIME

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

CTTIM R3 Alg. Init. Required 0 Displays the current --

incremental tuning
value for time.
CTNST G5 Alg. Init. Required 0 Displays the current --
incremental tuning
value for number of
starts.
INITP X4 Data Init. Required 0 Initializes from --
saved points option:
 0 = OFF
 1 = ON
Registers set by user from the graphic:

- Y0 - - - Displays the -
command for time.
- R4 - - - Specifies the tuning -
value for time.
- Y1 - - - Displays the -
command for
number of starts.
- G6 - - - Specifies the tuning -
value for number of
starts.
- Y2 - - - Sets good quality -
on RTIME pin.
Y3 - - - Sets good quality -
for NUMST pin.
* The asterisk indicates that this is a command field, not a feedback field. A command field can be
used as a user-interface to the algorithm. It drives the algorithm to perform a function.

OW360_R1100 521
5.106 RVPSTATUS

5.106 RVPSTATUS
Description

The RVPSTATUS algorithm performs the following:

 Displays the status register and command register for the Ovation Valve Positioner (RVP)
Card.
 Calibrates the RVP card using a standard graphic (diagram 8719) instead of using the RVP
serial port.
 Uploads and downloads configurable parameters used by the RVP card. (See Ovation I/O
Reference Manual.)
If a point assigned to the ENBL input and point is TRUE, then the STAT and CMD outputs are
updated. If ENBL is FALSE, then the last value of STAT and CMD is retained.

Functional symbol

Calibration Commands

There are four different types of calibrations that can be done to the valve:
 0% or Low Calibration command - moves the Valve Positioner until the 0% position is
re-established. The feedback gain is not re-established.
 100% or High Calibration command - moves the Valve Positioner until the 100% position is
re-established. The feedback gain is not re-established.
 Full Calibration command - moves the Valve Positioner until both the 0% and 100%
positions are re-established. It also re-establishes the feedback gain.
 Null-Point Calibration command - moves the Valve Positioner to the electrical null point of
the LVDT. The Null-Point Calibration can be requested at the same time as the Full
Calibration. If this is done, the Positioner moves through the sequences of the full calibration,
but stops at the null point when encountered.
When the calibration command is executed, the controlling MASTATION enters manual mode
and tracks the position demand feedback. During the travel sequence, the Valve Positioner
moves the valve at a programmable rate. While the Valve Positioner is traveling, the graphic
displays and continuously updates the current voltage value based on the position. There is also
a Clear Calibration command that may be used if the calibration command is no longer desired.

522 OW360_R1100
 5.106 RVPSTATUS

Upload Command

The upload command is used to retrieve the constant values currently stored in the RVP Card
memory. When the upload command is executed, the X3 value is changed and the RVP Card is
commanded to send the current values stored in its memory to the 32-bit real number fields of the
algorithm record. The standard graphic then displays the values in these selected algorithm
record fields for the user when the upload is finished. Note these values can only be uploaded
when the RVP card is in local or normal mode.

Download Command

The download command is used to update the constant values currently stored in the RVP Card
memory. When the download command is requested, X3 field is changed, and the values entered
into the graphic are stored in the 32-bit real number fields of the algorithm record. Then the values
in the selected fields of the algorithm record are written to the RVP memory. Note these values
can only be downloaded when the RVP card is in local or normal mode.

Interface Information

The calibration commands are sent to the X3 field in the algorithm record.

Calibrate command

CALIBRATE COMMAND COMMAND DESCRIPTION

0 No Command.

1 Calibrate 0%.

2 Calibrate 100%.

3 Full Calibration.

4 Go to Null Point Calibration.

7 Clear Calibration Request.

8 Upload Request.

9 Download Request.

As the commands are being executed, messages are displayed on the graphic by Status Value in
the X5 field of the algorithm record.

Status description

STATUS DESCRIPTION

0 No Message.

1 Calibration in Progress.

2 Poor Calibration.

3 Calibration Time-out.

4 Upload Error.

OW360_R1100 523
5.106 RVPSTATUS

STATUS DESCRIPTION

5 Download in Progress.

6 Download Error

7 Download Time-out

8 RVP Card Not Ready.

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU- Data Init. Required 116 Tuning Diagram -

Integer Number
PCI X4-Byte Data Init. Required 1 PCI Card Number -
(1 or 2)
HWAD B2- Data Init. Required 0 Card Hardware -
Integer Address
ENBL - Variable Optional - Enable Flag LD,LP
(digital)
STAT - Variable Required - RVP Status LP
register (packed)

CMD - Variable Optional - RVP Command LP

register (packed)

524 OW360_R1100
 5.107 SS_STATUS

5.107 SS_STATUS

Description

The Safety Sehll Status (SS_STATUS) algorithm displays the Safety Shell fault counts related to
a specified originating drop. The originating drop number is provided as a tuning parameter for
each instance of the SS_STATUS algorithm. The SS_STATUS algorithm also allows for the fault
counters to be reset and provides a mechanism to generate a controller fault if any of the fault
counters surpasses the configurable limit. One copy of the SS_STATUS algorithm is used for
each Ovation drop that originates high integrity DDBs. Each SS_STATUS algorithm reports the
count for each type of fault detected in a DDB received from a single originator.

Notes: Each Controller in a redundant pair maintains its own independent set of counters.

Functional symbol

The SS_STATUS algorithm resets the Safety Shell fault counters. This feature is facilitated by the
RSET input.

Input pin

NAME MINIMUM REQUIRED DESCRIPTION

POINT TYPE /OPTIONAL

RSET LD Optional Specifies the Reset Counters.

When the input transitions from FALSE to TRUE, the
Safety Shell fault counters related to the specified
originating drops are reset.

OW360_R1100 525
5.107 SS_STATUS

Five outputs, reflect a Safety Shell fault counter associated with the specified originating drop.

Output pin

NAME MINIMUM REQUIRED/OPTIO DESCRIPTION

POINT NAL
TYPE

BSCT LA Optional Outputs the value of the Safety Shell’s bad source
fault counter.
RSCT LA Optional Outputs the value of the Safety Shell’s repeated
sequence fault counter.
OSCT LA Optional Outputs the value of the Safety Shell’s out of
sequence fault counter.
BCCT LA Optional Outputs the value of the Safety Shell’s invalid
CRC32C fault counter.
DDCT LA Optional Outputs the value of the Safety Shell’s delayed DDB
counter.

Tuning parameters

NAME TYPE RECORD DEFAULT MAX. MIN. DESCRIPTION

FIELD VALUE

ORIG INT G1 1 254 1 Drop number of the DDB originator whose

fault counters the algorithm reports.
BSFL INT G4 0 None 0 Threshold for the bad source counter above
which a controller fault will be generated. A
value of 0 disables the limit checking.
RSFL INT G2 0 None 0 Threshold for the repeated sequence
counter above which a controller fault will
be generated. A value of 0 disables the limit
checking.
OSFL INT G3 0 None 0 Threshold for the out of sequence counter
above which a controller fault will be
generated. A value of 0 disables the limit
checking.
BCFL INT G5 0 None 0 Threshold for the bad CRC32C counter
above which a controller fault will be
generated. A value of 0 disables the limit
checking.
DDFL INT G6 0 None 0 Threshold for the delayed DDB counter
above which a controller fault will be
generated. A value of 0 disables the limit
checking.

Fault Behavior

In addition to providing the fault counter values, the SS_STATUS algorithm also faults the
Controller if any fault counter exceeds the threshold value for the respective fault (unless the
threshold value is set to zero).

526 OW360_R1100
 5.107 SS_STATUS

5.107.1 Controller faults for Safety Shell

Controller level faults alert you of the condition of the Safety Shell. Faults generated by the Safety
Shell consist of the following:
 Fault code = 66
 Fault ID = 9
 Fault parameter 1 = 0x0C
 Fault parameter 2 = 1
Every time a DDB fails one of the Safety Shell checks a fault counter is incremented. The
SS_STATUS algorithm (see page 525) checks the levels of these fault counters against the
configurable limits. If the value of a fault counter is above the limit configured in the SS_STATUS
algorithm the controller fault is generated.

Note: Several controller faults are defined, one for each type of Safety Shell checks. Each of
these faults notify you of the fault and no reboot or failover action is triggered.

The following table describes the Fault parameter 3.

Fault parameter 3 description

FAULT P ARAME TER 3 FAULT DESCRIPTION

1 Bad DDB source controller fault.

2 Repeated sequence controller fault.
3 Out of sequence controller fault.
4 Bad CRC32C controller fault.
5 Delayed DDB controller fault.
6 Error occurred while resetting the Safety Shell error counters
through the SS_STATUS algorithm (see page 525).
7 Error occurred while calculating the CRC32C.

Additional fault parameter details:

 Fault parameter 4 indicates the originating drop that generated these faults.
 When fault parameter 3 = 7, fault parameter 5 indicates the DDB ID.

OW360_R1100 527
5.108 SATOSP

5.108 S ATOSP
Description

The SATOSP algorithm transfers one analog value to a packed point record for use by
programmable controllers.

The analog point record value field is converted to an integer and stored in the packed digital
value field. Conversion is done by rounding off fractional values less than 0.50 to zero and
fractional values greater than or equal to 0.50 to the next highest integer. If the value of the
analog point record is less than the smallest integer (-32767), or greater than the largest integer
(32767), the minimum or maximum integer value is used.

The bit pattern used to store negative numbers is the sign and magnitude method.

If the quality of the analog point record is BAD, or if the value of the analog point is an invalid
number, then the packed point value remains at its last valid value. The quality of the input is not
propagated to the output.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN - Variable Required - Input (analog) LA

PACK - Variable Required - Output LP

(packed)

528 OW360_R1100
 5.109 SELECTOR

5.109 SELECTOR
Description

The SELECTOR algorithm transfers between N analog inputs. For the SELECTOR algorithm, the
output is equal to one of N analog inputs, where N is an integer less than eight. The input
selected is based on a binary address formed by three digital inputs per the table. If address 000
or an address greater than N is selected, the output signal is zero.

Digital input states

SELECTED Digital Input States

INPUT NO.
DIN1 DIN2 DIN3

None 0 0 0

1 1 0 0

2 0 1 0

3 1 1 0

4 0 0 1

5 1 0 1

6 0 1 1
7 1 1 1

Invalid Numbers and Quality

The value of the selected input is checked for invalid real numbers. If the input value is invalid, the
output value is invalid and the quality of the output is set to BAD. Otherwise, the quality of the
selected input is propagated to the output.

Functional symbol

OW360_R1100 529
5.109 SELECTOR

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 89 Tuning Diagram -

number
NMIN X1-Byte Data Init. Required 0 Number of inputs -

IN1 - Variable Optional - Input (analog) LA

•
•
•
IN7
DIN1 - Variable Required - Input (digital); Input LD, LP
Address 1

DIN2 - Variable Required - Input (digital); Input LD, LP

Address 2

DIN3 - Variable Required - Input (digital); Input LD, LP

Address 3

OUT - Variable Required - Output (analog) LA

530 OW360_R1100
 5.110 SETPOINT

5.110 SETPOINT
Description

The SETPOINT algorithm performs a manual loader function. The algorithm provides an interface
to the Control Builder or Operator Station diagram. Interface to the hard setpoint portion of the
Ovation Loop Interface (LI) card may be initialized. If the LI hardware address is initialized, the
algorithm reads the setpoint stored on the LI setpoint counter to use as its output value. If the LI
or hardware address is not initialized, the algorithm uses the last output value as its output value.

Note: The rate of change is constant in Signal Diagrams regardless of the settings for the
algorithm parameters.

Functional symbol

The output of this algorithm may be increased and/or decreased by the SLIM station or the
Operator's Soft Station diagram.

It continually checks the Set Point Increase/Decrease function keys from the Operator's Station
for increase/decrease requests for the setpoint output. If requests are received from both the hard
and soft stations at the same time, the station contacts override the Operator's Keyboard keys.
On power-up or reset of the Controller, the output is the initial value of the algorithms output
(default value = 0.0) if the LI is not initialized. Otherwise, the output is the current value stored on
the LI setpoint counter.

If the LI card is selected in the TYPE algorithm field and the Controller is reset, powered-up or
fails, the setpoint is read from the LI card and used initially in the OUT field of the algorithm. This
reports the status of the field device before any action is taken by either the algorithm or the
operator.

OW360_R1100 531
5.110 SETPOINT

The interface keys of the Operator's Keyboard are:

Keys

KEY USE

Set Point Increase Function Key (Control Raise the output

Up Arrow)

Set Point Decrease Function Key (Control Lower the output

Down Arrow)

Note: If the top and bottom scales are equal, the high limit flag is set and the output value is
equal to the top scale.

If the algorithm is told to track and the track input is invalid, the track request is ignored and the
drop is placed into alarm.

If the LI hardware address is initialized, this value is written to the setpoint counter on the
specified card. If the algorithm is operating with an LI, and the LI card is in Local mode, the output
of the algorithm cannot be changed from the Operator Station. In this case, the output of the
algorithm can be changed from the SLIM station only.

If SETPOINT is to write the setpoint value to the LI card, then changes to the setpoint value (that
is, tracking, Control Builder or Operator Station raise/lower requests, and so forth) are
implemented as described previously.

The SETPOINT algorithm monitors the LI card for any raise and lower requests from the SLIM.
Raise/lower requests from the SLIM override any other setpoint change requests received by this
algorithm (that is, tracking, Operator Station raise/lower requests, and so forth). If there are no
SLIM requests, then the setpoint value is changed as described previously. The setpoint value is
only written to the output point.

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog track point. This algorithm takes the action shown in the following table in response
to the information found in the analog input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Not used

17 Track if lower Ignored Not used

18 Track if higher Ignored Not used

19 Lower inhibit Ignored Not used

20 Raise inhibit Ignored Not used

21 Conditional Track No action Not used

532 OW360_R1100
 5.110 SETPOINT

BIT DESCRIPTION ACTION TOUT SIGNAL

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

The high and low limit flags and tracking signals from the algorithm are output to TOUT for
display. If the LI hardware address is initialized, the quality of OUT is BAD if there are any LI
hardware errors. Otherwise, the quality of OUT is GOOD when not tracking or set to the quality of
the track input variable when tracking.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init Required 9 Tuning diagram -

number.
TPSC R2-Real Tuning Required 100.0 Maximum value of the -
Constant point.

BTSC R3-Real Tuning Required 0.0 Minimum value of the -

Constant point.

PCNT X1-Byte Tuning Required 4 Percent change of -

Constant output in first four
seconds.
TIME X2-Byte Tuning Required 25 Number of seconds -
Constant remaining for ramp to
full scale.

CARD X3-Byte Data Init Required SOFT Card type: -

SOFT = No hardware
interface.
RLI = Ovation Loop
Interface card.

CNUM X5-Byte Data Init Optional 1 PCI card number -

(1,2).

OW360_R1100 533
5.110 SETPOINT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

HWAD B2-Integer Data Init Optional 0 Card Hardware -

Address (see page 3).
OUT - Variable Required - Analog output LA
variable.
TRIN - Variable Optional - Tracking & limiting LA
mode signals and
tracking value; analog
input variable.
TOUT - Variable Required - Mode and Status LA
output signals.
INIT X6-Byte Data Init Required NO Use Initial setpoint: -
Determines whether
or not the algorithm
will use the initial
value of the setpoint.
Valid values are YES
or NO.
 YES: the algorithm
uses the value that
is defined in the
IVAL (R5) field.
 NO: the algorithm
does not initialize to
a value. It maintains
the current output
level.
RECO X7-Byte Data Init Required NO Reconcile current -
setpoint: Determines
whether the algorithm
can reconcile tuning
changes to the
setpoint back to the
database and control
sheets. Valid values
are YES or NO.
 YES: allows the
algorithm to
reconcile the
tuned/actual value
of the setpoint to the
database and
control sheet.
 NO: does not permit
the initial value
(IVAL (R5) field) to
be modified after it
is set in the Control
Builder.
IVAL R5-Real Variable Required 0 Initial Value. This -
value can be set
either by the user or
by tuning/tracking.

534 OW360_R1100
 5.111 SIMTIME

5.111 SIMTIME

Description

The SIMTIME algorithm is used to set time in the Controller. It is reserved for Emerson use only.

5.112 SINE

Description

The SINE algorithm performs a mathematical sine function. The SINE algorithm has one input
and one output analog point. Each time the algorithm is executed, if the output is on scan, it is set
to the SINE of the input. The input to this algorithm is in radians. If an input is only available in
degrees, multiply it by 0.01745329 to convert to radians.

Invalid Real Numbers and Quality

Analog input values are checked for invalid real numbers. If the input value is invalid, the value of
the output is invalid and its quality is set to BAD. If the input is valid, the quality of the input is
propagated to the output.

If the absolute value of the input greater than 1018 then the output of the SINE algorithm is invalid
and its quality is set to BAD.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output LA

(analog)

Function

OUT = SINE(IN1)

OW360_R1100 535
5.113 SLCAIN

5.113 SLCAIN
Description

The SLCAIN algorithm reads up to 16 analog values from a Group 1 QLC or Ovation Link
Controller (LC) card (or redundant pair of Group 1 QLC cards).

Functional symbol

Primary and Secondary QLCs/LCs

The Hardware addresses of the primary and secondary QLC/LC cards are specified by the PHW
and SHW parameters (if no secondary QLC/LC is used, SHW is set to zero).

Digital inputs PSTA and SSTA define whether the points are to be read from the primary or
secondary QLC/LC, as shown below:
 If PSTA = TRUE, the points are read from the primary QLC/LC (status of SSTA does not
matter).
 If PSTA = FALSE and SSTA = TRUE, the points are read from the secondary QLC.
 If PSTA = FALSE and SSTA = FALSE, the point values are not updated and the points are
assigned BAD quality.
 If PSTA = FALSE and SSTA is not defined, the point values are not updated and the points
are assigned BAD quality.
 If PSTA and SSTA are not defined, the point values are not updated and the points are
assigned BAD quality.

Note: Although both PSTA and SSTA are optional parameters, at least one must be defined for
the points to be updated.

536 OW360_R1100
 5.113 SLCAIN

Point Data Formats

The FRMT parameter is used to specify the format of the analog point data to be read from the
QLC/LC registers. The four available formats are as follows:

Data formats

FRMT * FORMAT DESCRIPTION

0 Integer Integer value in the range +32767 to -32768. Each

point occupies one data register.

1 Intel Real Floating-point real number. Each point occupies two

data registers.

2 Intel Real with status Status word followed by floating-point real number.
Each point occupies three data registers.

3 Intel Real with quality Status word followed by floating-point real number.
Each point occupies three data registers.

* When the FRMT = 2, the following bits are placed into the 1W field of the analog point record:
Bit 4 - Undefined
Bits 8 and 9 - Quality
Bit 12 - Limit checking off
Bit 13 - Alarm checking off
When the FRMT = 3, only the quality bits 8 and 9 of the 1W field of the analog point record are
updated.
The remaining bits of the 1W field are used for alarm status, operator entry, and Ovation
Network status information. (See Ovation Record Types Reference Manual.)

QLC/LC Data Registers

The point data is retrieved from consecutive QLC/LC data registers, starting at the register
specified by parameter REG1. Depending on the format selected, the total area required for the
16 analog points could be 16, 32, or 48 registers.

The point parameters (OUT1 through OUT16) are associated with consecutive QLC/LC data
registers, even if some points are omitted from the argument list. For example, if REG1 = 4,
FRMT = 1, and point OUT1 is omitted, then OUT2 is read starting at data register 6 (no read is
performed from data registers 4 and 5).

The location from which a given point is read can be calculated using the following formula:

point_address = REG1 + (FRMT + 1) * (point_number - 1)

where:
point_address QLC/LC data register containing the first word of data from the point

point_number 1 for parameter A1, 2 for parameter A2, and so on.

OW360_R1100 537
5.113 SLCAIN

Any point which lies (completely or partially) beyond the end of the 2048 QLC/LC data registers is
assigned BAD quality. For example, if REG1 = 2044 and FRMT = 2, only the first point value
(parameter Al) can be obtained.

Analog Point Record Types

If alarm and/or limit checking are to be performed on points read from the QLC/LC, use point
record type Long Analog (LA).

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU- Data Init Required 11 Tuning diagram -

Integer number
FRMT B0- Data Init. Required 0 QLC/LC data -
Integer format
REG1 B1- Data Init. Required 0 First QLC/LC -
Integer data register
PHW B2- Data Init. Required 0 Primary QLC -
Integer hardware
address or LC
address (see
page 3)
SHW YU- Data Init. Required 0 Secondary QLC -
Integer hardware
address or LC
address (see
page 3)
CARD X4-Byte Data Init. Required 1 PCI Card -
Number (1,2)
TYPE X1-Byte Data Init Required QLC Interface Card -
Type:
 QLC
 RLC
OUT1 - Variable Optional - Input from LA
QLC/LC
• registers
• (analog)

•
OUT16
PSTA - Variable Optional - Primary QLC/LC LD, LP
status input
(digital)
SSTA - Variable Optional - Secondary LD, LP
QLC/LC status
input (digital)

538 OW360_R1100
 5.114 SLCAOUT

5.114 SLCAOUT

Description

The SLCAOUT algorithm writes up to 16 analog points to a Group 1 QLC or LC card

(or redundant pair of Group 1 QLC cards).

Functional symbol

Primary and Secondary QLCs/LCs

The hardware addresses of the primary and secondary QLC/LC cards are specified by the PHW
and SHW parameters (if no secondary QLC/LC is used, SHW is set to zero).

Digital inputs PSTA and SSTA define whether the points are to be written to the primary or
secondary QLC/LC, as shown below:
 If PSTA = TRUE, the points are written to the primary QLC/LC (status of SSTA does not
matter).
 If PSTA = FALSE and SSTA = TRUE, the points are written to the secondary QLC.
 If PSTA = FALSE and SSTA = FALSE, the points are not output.
 If PSTA = FALSE and SSTA is not defined, the points are not output.
 If PSTA and SSTA are not defined, the points are not output.

Note: Although both PSTA and SSTA are optional parameters, at least one must be defined for
the points to be output.

Point Data Formats

The FRMT parameter is used to specify the format of the analog point data to be written to the
QLC/LC registers. The three available formats are as follows:

Data formats

FRMT FORMAT DESCRIPTION

0 Integer Integer value in the range +32767 to -32768. Each point occupies
one data register.
1 Intel Real Floating-point real number. Each point occupies two data registers.

2 Intel Real with status Status word followed by floating-point real number. Each point
occupies three data registers.

Note: Depending on the format selected, each point value occupies between 1 and 3 data
registers.

OW360_R1100 539
5.114 SLCAOUT

QLC/LC Data Registers

The point data is written to consecutive QLC/LC data registers, starting at the register specified by
parameter REG1. Depending on the format selected, the total area required for the 16 analog
points could be 16, 32, or 48 registers.

The point parameters (A1 through A16) are associated with consecutive QLC/LC data registers,
even if some points are omitted from the argument list. For example, if REG1 = 4, FRMT = 1, and
point A1 is omitted, then A2 is written starting at data register 6 (no data is written to registers
4 and 5).

The location to which a given point is written can be calculated using the following formula:

point_address = REG1 + (FRMT + 1) * (point_number - 1)

where:
point_address QLC/LC data register containing the first word of data from the point.

point_number 1 for parameter A1, 2 for parameter A2, and so on.

No data is written to registers beyond the valid range (0 through 2047). Points which lie partially
beyond the valid range of registers are written to the extent possible; points which lie completely
beyond the valid range of registers are not written. For example, if REG1 = 2044 and FRMT = 2,
only the first point value (parameter Al) can be written.

Timed-Out Points
The TIME parameter determines what action is taken when a received point (to be written to the
QLC/LC) is timed-out. Depending on the selected TIME setting, the point is either not written to
the QLC/LC, or the last received value is written.

TIME is interpreted as a mask of bits to determine the selected setting for each point, as shown
below:

Point IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN
16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1
TIME bit 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

 For each point, a value of 0 (zero) in the corresponding bit indicates that the point should not
be written if it is timed-out.
 For each point, a value of 1(one) in the corresponding bit indicates that the last received value
should be written if the point is timed-out.

540 OW360_R1100
 5.114 SLCAOUT

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU- Data Init. Required 12 Tuning diagram -

Integer number
FRMT B0 - Data Init. Required 0 QLC/LC data format -
Integer

REG1 B1 - Data Init. Required 0 First QLC/LC data -

Integer register

PHW B2 - Data Init. Required 0 Primary QLC/LC -

Integer hardware address
(see page 3).
SHW B3 - Data Init. Required 0 Secondary QLC/LC -
Integer hardware address
(see page 3).
CARD X4-Byte Data Init. Required 1 PCI Card Number -
(1, 2)
TYPE X1-Byte Data Init Required QLC Interface Card Type: -
QLC or RLC

TIME B4 - Data Init. Required 0 Bit map for handling -

Integer of timed-out points
(1 = Use last value,
0 = Skip)
IN1 - Variable Optional 0 Output to QLC/LC LA
registers (analog)
•
•
•
IN16
PSTA - Variable Optional - Primary QLC/LC LD, LP
status input (digital)

SSTA - Variable Optional - Secondary QLC/LC LD, LP

status input (digital)

OW360_R1100 541
5.115 SLCDIN

5.115 SLCDIN
Description

The SLCDIN algorithm reads up to 16 digital values from a Group 1 QLC or Ovation Link
Controller (LC) card (or redundant pair of Group 1 QLC cards).

Functional symbol

Primary and Secondary QLCs/LCs

The Hardware addresses of the primary and secondary QLC cards are specified by the PHW and
SHW parameters (if no secondary QLC is used, SHW is set to zero).

Digital inputs PSTA and SSTA define whether the points are to be read from the primary or
secondary QLC/LC, as shown below:
 If PSTA = TRUE, the points are read from the primary QLC/LC (status of SSTA does not
matter).
 If PSTA = FALSE and SSTA = TRUE, the points are read from the secondary
QLC/LC.
 If PSTA = FALSE and SSTA = FALSE, the point values are not updated and the points are
assigned BAD quality.
 If PSTA = FALSE and SSTA is not defined, the point values are not updated and the points
are assigned BAD quality.
 If PSTA and SSTA are not defined, the point values are not updated and the points are
assigned BAD quality.

Note: Although both PSTA and SSTA are optional parameters, at least one must be defined for
the points to be updated.

542 OW360_R1100
 5.115 SLCDIN

Point Data Format

Each digital point occupies one data register (equivalent to the 1W field of the point data record).

The FRMT parameter is used to specify the format of the Digital point data to be read from the
QLC/LC register. The three available formats are as follows:

The following bits are placed into the 1W field (no other bits cleared) of the digital point record:

Data format

FRMT DESCRIPTION

0 Bit 0 - Digital value

Bits 8 and 9 - Quality
Bit 12 - Limit checking off
Bit 13 - Alarm checking off
1 Bit 0 - Digital value
Bits 8 and 9 - Quality
2 Bit 0 - Digital value

The remaining bits of the 1W field are used for alarm status, operator entry, and Data Highway
status information. (See Ovation Record Types Reference Manual.)

QLC/LC Data Registers

The point data is retrieved from consecutive QLC/LC data registers, starting at the register
specified by parameter REG1. The total area required for the 16 digital points is 16 registers.

The point parameters (OUT1 through OUT16) are associated with consecutive QLC/LC data
registers, even if some points are omitted from the argument list. For example, if REG1 and point
OUT1 is omitted, then OUT2 is read from data register 5 (no read is performed from data
register 4).

The location from which a given point is read can be calculated using the following formula:

point_address = REG1 + (point_number - 1)

where:

point_address = QLC/LC data register containing the digital point

point_number = 1 for parameter OUT1, 2 for parameter OUT2, and so on.

Any point which lies beyond the end of the 2048 QLC/LC data registers is assigned BAD quality.
For example, if REG1 =2044, only the first three point values (parameters OUT1, OUT2, and
OUT3) can be obtained.

OW360_R1100 543
5.115 SLCDIN

Digital Point Record Types

If alarm checking is to be performed on digital points read from the QLC/LC, use point record type
Long Digital.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 13 Tuning Diagram -

Number
FRMT B0 - Integer Data Init. Required - Point Format -

REG1 B1 - Integer Data Init. Required 0 First QLC/LC data -

register

PHW B2 - Integer Data Init. Required 0 Primary QLC/LC -

hardware address
(see page 3).
SHW YU - Integer Data Init. Required 0 Secondary -
QLC/LC hardware
address
(see page 3).
CARD X4-Byte Data Init. Required 1 PCI Card Number -
(1,2)
TYPE X1-Byte Data Init Required QLC Interface Card -
Type:
QLC or RLC
OUT1 - Variable Optional - Input from QLC/LC LD
registers (digital)
•
•
•
OUT16
PSTA - Variable Optional - Primary QLC/LC LD, LP
status input
(digital)
SSTA - Variable Optional - Secondary LD, LP
QLC/LC status
input (digital)

544 OW360_R1100
 5.116 SLCDOUT

5.116 SLCDOUT
Description

The SLCDOUT algorithm writes up to 16 digital points to a Group 1 QLC or Ovation Link
Controller (LC) card (or redundant pair of Group 1 QLC cards).

Functional symbol

Primary and Secondary QLCs/LCs

The hardware addresses of the primary and secondary QLC/LC cards are specified by the PHW
and SHW parameters (if no secondary QLC/LC is used, SHW is set to zero).

Digital inputs PSTA and SSTA define whether the points are to be written to the primary or
secondary QLC/LC, as shown below:
 If PSTA = TRUE, the points are written to the primary QLC/LC (status of SSTA does not
matter).
 If PSTA = FALSE and SSTA = TRUE, the points are written to the secondary QLC/LC.
 If PSTA = FALSE and SSTA = FALSE, the points are not output.
 If PSTA = FALSE and SSTA is not defined, the points are not output.
 If PSTA and SSTA are not defined, the points are not output.

Note: Although both PSTA and SSTA are optional parameters, at least one must be defined for
the points to be output.

OW360_R1100 545
5.116 SLCDOUT

Point Data Format

Each digital point occupies one data register (equivalent to the 1W field of the point data record).
(See Ovation Record Types Reference Manual.)

QLC/LC Data Registers

The point data is written to consecutive QLC/LC data registers, starting at the register specified by
parameter REG1. The total area required for the 16 digital points is 16 registers.

The point parameters (IN1 through IN16) are associated with consecutive QLC/LC data registers,
even if some points are omitted from the argument list. For example, if REG1 = 4 and point IN1 is
omitted, then IN2 is written to data register 5 (no data is written to register 4).

The location to which a given point is written can be calculated using the following formula:

point_address = REG1 + (point_number - 1)

where:
point_address = QLC/LC data register containing the digital point
point_number = 1 for parameter IN1, 2 for parameter IN2, and so on.

No data is written to registers beyond the valid range (0 through 2047). For example, if REG1 =
2044, only the first three point values (parameters IN1 through IN3) can be written.

Timed-Out Points

The TIME parameter determines what action is taken when a received point (to be written to the
QLC/LC) is timed-out. Depending on the selected TIME setting, the point is either not written to
the QLC/LC, or the last received value is written.

TIME is interpreted as a mask of bits to determine the selected setting for each point, as shown
below:

Point IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN
16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1
TIME bit 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

 For each point, a value of 0 (zero) in the corresponding bit indicates that the point should not
be written if it is timed-out.
 For each point, a value of 1 (one) in the corresponding bit indicates that the last received
value should be written if the point is timed-out.

546 OW360_R1100
 5.116 SLCDOUT

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU- Data Init. Required 14 Tuning Diagram -

Integer Number
REG1 B1 - Data Init. Required 0 First1 QLC/LC -
Integer data register

PHW B2 - Data Init. Required 0 Primary QLC/LC -

Integer hardware
address (see
page 3).
SHW YU - Data Init. Required 0 Secondary -
Integer QLC/LC
hardware
address (see
page 3).
CARD X4-Byte Data Init. Required 1 PCI Card -
Number (1,2)
TYPE X1-Byte Data Init Required QLC Interface Card -
Type:
QLC or RLC
TIME B4 - Data Init. Required 0 Bit map for -
Integer handling of
timed-out points
(1 = Use last
value, 0 = Skip)
IN1 - Variable Optional - Output to LD
QLC/LC register
• (digital)
•
•
IN16
PSTA - Variable Optional - Primary QLC/LC LD, LP
status input
(digital)
SSTA - Variable Optional - Secondary LD, LP
QLC/LC status
input (digital)

OW360_R1100 547
5.117 SLCPIN

5.117 SLCPIN
Description

The SLCPIN algorithm reads up to 16 packed points from a Group1 QLC card or LC (or
redundant pair of Group 1 QLC cards).

Functional symbol

Note: For the Windows platform, the parameters OUT10 - OUT16 are represented as
OT10 - OT16.

Primary and Secondary QLCs/LCs

The hardware addresses of the primary and secondary QLC/LC cards are specified by the PHW
and SHW parameters (if no secondary QLC/LC is used, SHW is set to zero).

Digital inputs PSTA and SSTA define whether the points are to be read from the primary or
secondary QLC/LC, as shown below:
 If PSTA = TRUE, the points are read from the primary QLC/LC (status of SSTA does not
matter).
 If PSTA = FALSE and SSTA = TRUE, the points are read from the secondary QLC/LC.
 If PSTA = FALSE and SSTA = FALSE, the point values are not updated.
 If PSTA = FALSE and SSTA is not defined, the point values are not updated.
 If PSTA and SSTA are not defined, the point values are not updated.

Note: Although both PSTA and SSTA are optional parameters, at least one must be defined for
the points to be updated.

548 OW360_R1100
 5.117 SLCPIN

Data Format

Each packed point value occupies one QLC/LC data register. For packed points, the value is
stored in the A2 field of the LP point data record. See Ovation Record Types Reference Manual.)

QLC/LC Data Registers

The point data is retrieved from consecutive QLC/LC data registers, starting at the register
specified by parameter REG1. The total area required for the 16 packed point values is 16
registers.

The point parameters (OUT1 through OUT16) are associated with consecutive QLC/LC data
registers. For example, if REG1 = 4, the value of OUT1 is read from register 4, OUT2 is read from
register 5, and so on. These point parameters are required and may not be omitted from the
argument list, regardless of the number of points which are actually used by the application.

The location from which a given point is read can be calculated using the following formula:

point_address = REG1 + (point_number - 1)

where:

point_address = QLC/LC data register containing the packed value

point_number = 1 for parameter OUT1, 2 for parameter OUT2, and so on.

Any value which lies beyond the end of the 2048 QLC data registers or 4096 LC data register is
not read. For example, if REG1 = 2044, only the first three point values (parameters OUT1,
OUT2, and OUT3) can be obtained.

OW360_R1100 549
5.117 SLCPIN

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 13 Tuning Diagram -

Number
REG1 B1 - Integer Data Init. Required 0 First QLC data -
register
PHW B2 - Integer Data Init. Required 0 Primary QLC -
DIOB address or
LC address
SHW YU - Integer Data Init. Required 0 Secondary QLC -
DIOB address or
LC address
CARD X4 - Byte Data Init. Required 1 PCI Card -
Number (1,2)
TYPE X1 - Byte Data Init. Required QLC Interface Card -
Type.
QLC or RLC
OUT1 - Variable Optional - Input from LP
QLC/LC register
• (packed)
•
•
OUT16
PSTA - Variable Optional - Primary QLC/LC LD, LP
status input
(digital)
SSTA - Variable Optional - Secondary LD, LP
QLC/LC status
input (digital)

550 OW360_R1100
 5.118 SLCPOUT

5.118 SLCPOUT
Description

The SLCPOUT algorithm writes up to 16 packed points to a Group 1 QLC card or LC (or
redundant pair of Group 1 QLC cards).

Functional symbol

Primary and Secondary QLCs/LCs

The hardware addresses of the primary and secondary QLC/LC cards are specified by the PHW
and SHW parameters (if no secondary QLC/LC is used, SHW is set to zero).

Digital inputs PSTA and SSTA define whether the points are to be written to the primary or
secondary QLC/LC, as shown below:
 If PSTA = TRUE, the points are written to the primary QLC/LC (status of SSTA does not
matter).
 If PSTA = FALSE and SSTA = TRUE, the points are written to the secondary QLC/LC.
 If PSTA = FALSE and SSTA = FALSE, the points are not output.
 If PSTA = FALSE and SSTA is not defined, the points are not output.
 If PSTA and SSTA are not defined, the points are not output.

Note: Although both PSTA and SSTA are optional parameters, at least one must be defined for
the points to be output.

OW360_R1100 551
5.118 SLCPOUT

Data Format

Each packed group point value occupies one QLC/LC data register.

For packed points, the value is obtained from the A2 field of the LP point data record. (See
Ovation Record Types Reference Manual.)

QLC/LC Data Registers

The point data is written to consecutive QLC/LC data registers, starting at the register specified by
parameter REG1. The total area required for the 16 packed point values is 16 registers.

The point parameters (IN1 through IN16) are associated with consecutive QLC/LC data registers.
For example, if REG1 = 4, the value of IN1 is written to register 4, IN2 is written to register 5, and
so on. These point parameters are required and may not be omitted from the argument list,
regardless of the number of points which are actually used by the application.

The location to which a given point is written can be calculated using the following formula:

point_address = REG1 + (point_number - 1)

where:
point_address = QLC/LC data register containing the packed group or holding register value
point_number = 1 for parameter IN1, 2 for parameter IN2, and so on.

No data is written to registers beyond the valid range (0 through 2047 for QLC and 0-4096 for
LC). For example, if REG1 = 2044, only the first three point values (parameters IN1 through IN3)
can be written.

Timed-Out Points

The TIME parameter determines what action is taken when a received point (to be written to the
QLC/LC) is timed-out. Depending on the selected TIME setting, the point is either not written to
the QLC/LC, or the last received value is written.

TIME is interpreted as a mask of bits to determine the selected setting for each point, as shown
below:

Point IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN
16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1
TIME bit 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

 For each point, a value of 0 (zero) in the corresponding bit indicates that the point should not
be written if it is timed-out.
 For each point, a value of 1 (one) in the corresponding bit indicates that the last received
value should be written if the point is timed-out.

552 OW360_R1100
 5.118 SLCPOUT

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init Required 14 Tuning diagram -

number
REG1 B1-Integer Data Init. Required 0 First QLC/LC data -
register
PHW B2-Integer Data Init. Required 0 Primary QLC/LC -
address
SHW YU- Integer Data Init. Required 0 Secondary QLC/LC -
address

CARD X4 - Byte Data Init. Required 1 PCI Card Number -

(1, 2)
TYPE X1 - Byte Data Init. Required QLC Interface Card -
Type.
 QLC
 RLC
TIME B4 - Integer Data Init. Required 0 Bit map for handling -
of timed-out points
(1 = Use last value,
0 = Skip)
IN1 - Variable Optional - Output to QLC/LC LP
register (packed)
•
•
•
IN16
PSTA - Variable Optional - Primary QLC/LC LD, LP
status input (digital)

SSTA - Variable Optional - Secondary QLC/LC LD, LP

status input (digital)

OW360_R1100 553
5.119 SLCSTATUS

5.119 SLCSTATUS
Description

The SLCSTATUS algorithm reads hardware and user application status information from a Group
1 QLC or Ovation Link Controller (LC) card (or redundant pair of Group 1 QLC cards). The status
information is placed in packed group points.

Functional symbol

Primary and Secondary QLCs/LCs

The hardware addresses of the primary and secondary QLC/LC cards are specified by the PHW
and SHW parameters.

An additional parameter is also provided to indicate whether both QLC/LC are present in the drop.
Bits 0 and 1 of the AVBL parameter are used for the primary and secondary QLC/LC,
respectively. If the bit is set to 0, then that QLC/LC card is not present. If the bit is set to 1, then
that QLC/LC card is present.

QLC/LC Data Registers

The application status information is retrieved from four consecutive QLC/LC data registers,
starting at the register specified by parameter REG1. The integer values read from these
locations are stored in the user-initialized packed (LP) points, as follows:

Register points

DATA REGISTER LP POINTS

REG1 PFID/SFID
REG1 + 1 PPR1/SPR1
REG1 + 2 PPR2/SPR2
REG1 + 3 PAUX/SAUX

The fault ID obtained from REG1 (PFID or SFID) is also used by SLCSTATUS to place the drop
into QLC/LC fault.

554 OW360_R1100
 5.119 SLCSTATUS

If the value is non-zero, a fault is reported with the following values:

Fault Code = 129

Fault ID = PFID/SFID
Fault Parameter 1 = PPR1/SPRl
Fault Parameter 2 = PPR2/SPR2

Note: Fault Code 129 is reported for either the primary or secondary QLC/LC. The Fault ID or
Fault Parameter(s) must be appropriately defined to indicate which QLC/LC is in fault.

The PAUX/SAUX parameters may be used to define additional information for use by the
application.

QLC Hardware Status Information

QLC hardware status information is placed in the PSTA and SSTA variables (for the primary and
secondary QLCs, respectively). The bits in these parameters are defined as follows:

Bits definition

BIT DEFINITION

0 Watchdog timer:
0 = Timed-out
l = Not timed-out
1 SBX module:
0 = Module is attached
1 = Module is not attached
2 DRAM parity:
0 = No parity error
1 = Parity error
3 Configuration switch 6 setting:
0 = QLC boot from external disk
1 = QLC boot from flash memory
4 Configuration switch 5 setting:
0 = 80C187 installed
1 = 80C187 not installed
5 Configuration switch 4 setting (Baud rate for communication with external personal computer)

6 Configuration switch 3 setting. (Baud rate for communication with external personal computer)
7 Configuration switch 2 setting (user defined)

8 - 15 Undefined

Note: The term 'configuration switch' refers to QLC DIP switch SW3. The switch settings are
defined as 0 = ON = closed; 1 = OFF = open.
The watchdog timer must be reset by the user application. Otherwise, bit 0 of PSTA/SSTA is
always = 0.

OW360_R1100 555
5.119 SLCSTATUS

LC Hardware Status Information

LC Hardware Status information is placed in the PSTA and STA variables (for the primary and
secondary LCs, respectively). The bits in these parameters are defined as follows:

Bits definition

BIT DEFINITION

0 Watchdog Timer:
0 - Timed-Out
1 - Not Timed-out
1-2 Personality Module Type:
0 - RS - 232 Applications Port
1 - RS - 485 Full Duplex Applications Port
3 Boot up Serial Link Controller from:
0 - External PC via Local Serial Port
1 Internal Flash Memory
5 BAUD RATE on Serial Port:
0 - Use 9600 BAUD RATE
1 - Use 19200 BAUD RATE
6-15 Undefined

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU - Integer Data Init Required 15 Tuning diagram -

number
REG1 B0 - Integer Data Init. Required 0 First QLC/LC status -
register
AVBL B1 - Integer Data Init. Required 0 Bit mask for -
available QLCs/LCs
PHW B2 - Integer Data Init. Required 0 Primary QLC/ LC -
hardware
SHW YU - Integer Data Init. Required 0 Secondary QLC/ LC -
hardware
CARD X4 - Byte Data Init. Required 1 PCI Card Number -
(1,2)
PFID - Variable Required - Primary QLC/ LC LP
fault ID (packed)

PPR1 - Variable Required - Primary QLC/ LC LP

fault parameter 1
(packed)

556 OW360_R1100
 5.119 SLCSTATUS

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

PPR2 - Variable Required - Primary QLC/ LC LP

fault parameter 2
(packed)
PAUX - Variable Required - Primary QLC/ LC LP
auxiliary fault
information (packed)
PSTA - Variable Required - Primary QLC/ LC LP
hardware status
information (packed)

SFID - Variable Required - Secondary QLC/ LC LP

fault ID (packed)

SPR1 - Variable Required - Secondary QLC/ LC LP

fault parameter
1(packed)
SPR2 - Variable Required - Secondary QLC/ LC LP
fault parameter 2
(packed)
SAUX - Variable Required - Secondary QLC/ LC LP
auxiliary fault
information (packed)

SSTA - Variable Required - Secondary QLC/ LC LP

hardware status
information (packed)

OW360_R1100 557
5.120 SMOOTH

5.120 SMOOTH
Description

This algorithm “smooths” an analog input value. Smoothing of an analog input (sometimes
referred to as digital filtering) consists of giving the most weight to the most recent sample and the
diminishing weight to all preceding readings. The relative weight given to the most recent value is
determined by the smoothing time constant specified for input filtering. The input (IN1) is sampled
each loop. If the smoothing time constant is less than or equal to zero, the output is equal to the
input value. If the smoothing time constant is less than zero, the quality of the output is set to
BAD.

The value of IN1 is checked for an invalid real number. If the calculated value of the output is
invalid, the quality of OUT is set to BAD; otherwise, the quality of IN1 is propagated to the output.

Note: Algorithm record fields that contain real number values are not updated if the new value is
an invalid real number.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 67 Tuning Diagram -

Number
* SMTH R1-Real Selectable Required 0.0 Smoothing time -
constant in
seconds
IN1 - Variable Required - Input (analog) LA

OUT - Variable Required - Output (analog) LA

* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

558 OW360_R1100
 5.120 SMOOTH

Function

OUT = (alpha x IN1) + (beta x oldout)

where:

alpha = 1 - E(- loop time/SMTH)

beta = E(- loop time/SMTH)

loop time = sampling time (loop time)
oldout = locally retained, real variable

OW360_R1100 559
5.121 SOFTSOE

5.121 SOFTSOE
Description

The SOFTSOE algorithm allows a Sequence of Events (SOE) to be generated by placing an

algorithm on a control sheet. Prior to the release of the SOFTSOE algorithm, an SOE event could
only be generated by a Sequence of Events hardware module. A sequence of events hardware
module is not required to use the SOFTSOE algorithm.

The SOE events generated by the SOFTSOE algorithm are identical to any hardware SOE events
and are stored in the same history, combined on the same reports, and so forth.

Note: Even though the resolution of events that are generated using the SOFTSOE algorithm is
to the nearest one millisecond, the accuracy is only as good as the control task period in which
the algorithm executes. SOFTSOE is designed to generate an SOE event based on the time the
algorithm samples the trigger point. This is only accurate to the period of the control task, which
could be significantly different from the time when the trigger point actually changed state. That
is, the time tag on the SOE event only reflects the time (to the nearest millisecond) when the
algorithm sampled the input.

Functional symbol

SOE Event Trigger

The state of an input digital point triggers the SOE event. The event trigger state is user
configurable. Available options are rising edge, falling edge, rising or falling edge (both), or time
change.

Note: The point connected to the TRIG input must be a digital point; it cannot be a bit of a
packed point.

The SOE Event Trigger point should not have the SOE point flag enabled in its definition. If the
SOE point flag is enabled, it uses one of the available 1,024 SOE point slots per Controller. These
slots are typically used for hardware SOE points only.

Although the system does not prevent it, you should not use the same digital point in more than
one SOFTSOE algorithm since this is a redundant configuration. It is also redundant to connect
hardware SOE points to SOFTSOE algorithms.

560 OW360_R1100
 5.121 SOFTSOE

Event Time Tagging

The time that is assigned to the SOE event can be one of the following:
 Current system time at the time the associated digital point changes to the triggering state.
 Optional external event time provided to the algorithm of which the user provides the format
(see External Time Formats).
 U8 and U9 fields of deluxe records. This is useful for third-party links.
If you cannot guarantee that the change of trigger value and related external time value are
delivered to the algorithm at the same execution loop, the tunable parameters TMDLY and VDLY
can be used to set the maximum allowed delay between the trigger change and the external time
value change.

When a trigger value changes, but the time value does not change at the same execution loop,
the algorithm waits. The VDLY parameter specifies how long to wait for a change of time value. If
the time value changes within this time, an SOE event is generated with the new time value. If the
time value does not change before this time passes or before the trigger value changes once
more, the action taken depends on the NOTME parameter.

The NOTME parameter defines the action taken when a trigger value changes, but a relevant
change of external time value is not observed. Depending on this parameter, the algorithm can do
one of the following:
 Send no SOE events.
 Send an SOE event with the current system time.
 Send an SOE event with the last received external time value.
Conversely, when the external time value changes, but the trigger value does not change at the
same execution cycle, the algorithm waits. The TMDLY parameter specifies how long to wait for a
change of triggering value. If the trigger value changes within this time, the SOE event is
immediately generated with the previously received time value. If the trigger value does not
change within this time, the algorithm waits for another change of time value before generating an
SOE event.

The TMCHG parameter tells whether the external time value changes every time the trigger value
changes or only when new SOE events are triggered. This information allows the algorithm to
associate changes of the external time value with proper changes of the trigger value.

The time change option is useful for external events (received from third-party systems) which do
not have an associated digital value, but only have the time when a particular event occurred. In
this configuration, the time used for tagging the events cannot be the current system time.

When the external time value is passed to the algorithm using two or more points, the algorithm
assumes that the entire time value changes whenever any of those points change. The algorithm
cannot detect when one of those points was already updated while the other still has the old
value. Therefore, if two or more points are used for the external time value, it should be
guaranteed that either both are delivered to the algorithm at the same time, or that both are
delivered before or at the same time as the triggering value.

OW360_R1100 561
5.121 SOFTSOE

Algorithm Internal Event Buffer

Whenever a new SOE event is generated, the SOFTSOE algorithm tries to immediately send the
event message to the SOE subsystem. If it is not possible to send the message (because the
SOE subsystem is too busy processing hardware or software SOE events, or the historian is
temporarily not available), the algorithm stores the event in its internal buffer.

The events stored in the internal buffer are sent to SOE in subsequent algorithm executions, as
soon as there is enough space for them in the software SOE queue. However, the SOFTSOE
algorithm never sends more than three buffered messages in one execution cycle.

The Number of Pending Events (G0) field in the LC record indicates the number of events that are
currently stored in the internal buffer, pending to be sent to the SOE. This number does not
include possible messages already inserted in the queue, waiting to be processed by the SOE
subsystem.

If for some reason the algorithm internal event buffer becomes full before the pending events can
be transferred to the SOE, and there is no place in it for the newly generated event, the event is
lost and the algorithm sets the optional ERR output to true for one execution cycle.

Optional ENBL Input

You can use the optional ENBL input to control the operation of the algorithm. The algorithm only
generates SOE events when the ENBL input is true. If the ENBL input is not connected, the
algorithm will always be enabled and generate events.

External Time Formats

As an option, the timestamp that is stored in the resulting SOE event can be input externally. You
select one of the available formats of the time values passed to the algorithm.

The timestamp in SOE messages is actually made of the seconds and nanoseconds fields, even
though SOE information is stored in the history with microsecond resolution.

Seconds and Microseconds Format

This format presents the timestamp information in two parts -- seconds and microseconds.

Timestamp

The timestamp is built using the following scheme:

Event timestamp = Seconds [S] + Microseconds x 1000 [nS]

Seconds

The "seconds" part is represented as the number of full seconds since January 1, 1970. You
cannot pass this value with one packed or analog point because it has a wider range than can be
precisely represented by those point types.

You can utilize either two packed (LP/DP) or analog (LA/DA) points or one packed digital (PD)
point for the "seconds" part. When using two packed points, the first contains Low Order Word
(bits 0 - 15) and the second contains High Order Word (bits 16 - 31) of the value.

562 OW360_R1100
 5.121 SOFTSOE

Two points used for seconds

Input functions

INPUT NAME FUNCTION

TSEC1 (LP/DP, LA/DA) Seconds -- bits 0 - 15

TSEC2 (LP/DP, LA/DA) Seconds -- bits 16 - 31

The algorithm calculates the seconds field as follows:

Seconds = TSEC1 + 65536 x TSEC2

One point used for seconds

INPUT NAME FUNCTION

TSEC1 (PD) Seconds

The algorithm calculates the seconds field as follows:

Seconds = TSEC1

Microseconds

The "microseconds" part specifies the number of microseconds in the specified second when the
event occurred.

As with seconds, this value can either be passed to the SOFTSOE algorithm using two packed
(LP/DP) or analog (LA/DA) points or one packed digital (PD) point.

Two points used for microseconds

INPUT NAME FUNCTION

ETIM1 (LP/DP, LA/DA) Microseconds -- bits 0 - 15

ETIM2 (LP/DP, LA/DA) Microseconds -- bits 16 - 31

The algorithm calculates the microseconds field as follows:

Microseconds = ETIM1 + 65536 x ETIM2

One point used for microseconds

INPUT NAME FUNCTION

ETIM1 (PD) Microseconds

The algorithm calculates the microseconds field as follows:

Microseconds = ETIM1

OW360_R1100 563
5.121 SOFTSOE

Seconds and Milliseconds format

This format presents the timestamp information in two parts - seconds and milliseconds.

Timestamp

The timestamp is built using the following scheme:

Event timestamp = Seconds [S] + Milliseconds x 1000000 [nS]

Seconds

The "seconds" part is represented as the number of full seconds since January 1, 1970.

You can utilize either two packed (LP/DP) or analog (LA/DA) points or one packed digital (PD)
point for the "seconds" part. When using two packed points, the first contains Low Order Word
(bits 0 - 15) and the second contains High Order Word (bits 16 - 31) of the value.

Two points used for seconds

INPUT NAME FUNCTION

TSEC1 (LP/DP, LA/DA) Seconds -- bits 0 - 15

TSEC2 (LP/DP, LA/DA) Seconds -- bits 16 - 31

The algorithm calculates the seconds field as follows:

Seconds = TSEC1 + 65536 x TSEC2

One point used for seconds

INPUT NAME FUNCTION

TSEC1 (PD) Seconds

The algorithm calculates the seconds field as follows:

Seconds = TSEC1

Milliseconds

The "milliseconds" part specifies the number of milliseconds in the specified second when the
event occurred.

One packed (LP or DP) or packed digital (PD) point is used for the "milliseconds" part.

564 OW360_R1100
 5.121 SOFTSOE

Input point functions

INPUT NAME FUNCTION

ETIM1 (LP/DP, LA/DA, PD) Milliseconds

The algorithm calculates the milliseconds field as follows:

Milliseconds = ETIM1

Milliseconds of Hour Format

This format presents the timestamp information as a single value -- the total number of
milliseconds since the last full hour. A packed digital point is required.

The time provided to the algorithm is relative and can be definitely interpreted only within a
specified period of time. This puts several constraints on the mechanism of generating and
passing the time value to the algorithm:
 It must be guaranteed that every timestamp is transferred from the third-party system to the
Ovation system and processed by the SOFTSOE algorithm in less than an hour from the
moment when it was generated. If a time value older than 59 minutes and 55 seconds is
received, it is interpreted incorrectly and an invalid timestamp is generated.
 The source of time must be synchronized with the Ovation system. If a time value more than
four seconds in the future is received, it is interpreted incorrectly and an invalid timestamp is
generated.
 This format should be avoided when an SOE event is triggered by a change of time value. If
two consecutive events are received by the algorithm with the exact one hour interval
between timestamps, the algorithm is unable to detect a change of time, and the SOE event
is not generated.

Input point functions

INPUT NAME FUNCTION

ETIM1 (PD) Milliseconds in an hour

Timestamp

The timestamp is built using the following scheme:

Timestamp = Seconds [S] + Milliseconds x 1000000 [nS]

OW360_R1100 565
5.121 SOFTSOE

Seconds

The algorithm calculates the seconds field as follows:

Calculate time of last full hour.

Full Hour Seconds = Current Seconds - (Current Seconds modulo 3600)
Add received time value (seconds).
Seconds = Full Hour Seconds + (ETIM1 div 1000)
Adjust if the event occurred in the previous full hour.
if Seconds >= Current Seconds + 5
Seconds = Seconds - 60
Adjust if the event has a timestamp in the future - in the next full hour. This can only occur
when the source of time is not accurately synchronized with Ovation.
else if Seconds < Current Seconds - 3595
Seconds = Seconds + 60

Milliseconds

The algorithm calculates the milliseconds field as follows:

Milliseconds = (ETIM1 modulo 1000)

Milliseconds of Minute Format

This format presents the timestamp information as a single value - the total number of
milliseconds since the last full minute.

This is a relative format of time value. The following constraints apply:

 It must be guaranteed that every timestamp is transferred from the third-party system to the
Ovation system and processed by the SOFTSOE algorithm in less than 55 seconds from the
moment when it was generated. If a time value older than 55 seconds is received, it is
interpreted incorrectly and an invalid timestamp is generated.
 The source of time must be synchronized with the Ovation system. If a time value more than
four seconds in the future is received, it is interpreted incorrectly and an invalid timestamp is
generated.
 You should avoid this format when an SOE event is triggered by a change of time value. If
two consecutive events are received by the algorithm with the exact one minute interval
between timestamps, the algorithm is unable to detect a change of time and the SOE event is
not generated.

Input point functions

INPUT NAME FUNCTION

ETIM1 (LP, LA, PD) Milliseconds in a minute

566 OW360_R1100
 5.121 SOFTSOE

Timestamp

The timestamp is built using the following scheme:

Timestamp = Seconds [S] + Milliseconds x 1000000 [nS]

Seconds

The algorithm calculates the seconds field as follows:

Calculate time of last full minute.

Full Minute Seconds = Current Seconds - (Current Seconds modulo 60)
Add received time value (seconds).
Seconds = Full Minute Seconds + (ETIM1 div 1000)
Adjust if the event occurred in the previous full minute.
if Seconds >= Current Seconds + 5
Seconds = Seconds - 60
Adjust if the event has a timestamp in the future - in the next full minute. This can only occur
when the source of time is not accurately synchronized with Ovation.
else if Seconds < Current Seconds - 55
Seconds = Seconds + 60

Milliseconds

The algorithm calculates the milliseconds field as follows:

Milliseconds = (ETIM1 modulo 1000)

Deluxe Records Time of Scan

This format is supported for Ovation deluxe records only. The Ovation deluxe records support the
U8 and U9 time scan fields. These fields are designed to hold seconds and nanoseconds
respectively. Third-party interfaces typically use these fields to store the time when the point was
processed.

This format also allows the U8 and U9 to be used for the SOE event timestamp.

The timestamp is built using the following scheme:

Seconds = U8
Nanoseconds = U9
Event timestamp = Seconds [S] + Nanoseconds [nS]

OW360_R1100 567
5.121 SOFTSOE

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

TRIG -- Variable Required -- SOE trigger input LD

ENBL -- Variable Optional -- Enable input LD, LP

TSEC1 -- Variable Optional -- External seconds PD

External seconds LP, LA
(bits 0 - 15)
TSEC2 -- Variable Optional -- External seconds LP, LA
(bits 16 - 32)
ETIM1 -- Variable Optional -- External PD
microseconds
LP, LA
External
microseconds
(bits 0 - 15) PD, LP,
External milliseconds LA

ETIM2 -- Variable Optional -- External LP, LA

microseconds
(bits 16 - 32)
ERR -- Variable Optional -- Buffer full error output LD

ETYPE X1 - byte Data Init Required 0 Event trigger type: --

 00 = Rising edge
 01 = Falling edge
 02 = Both
 03 = Time change
TSFMT X2 - byte Data Init Required 0 Time stamp format: --
 0 = Use current
system time
 1 = Deluxe record
U8/U9
 2 = Seconds +
Microseconds
 3 = Seconds +
Milliseconds
 4 = Milliseconds in
hour
 5 = Milliseconds in
minute
TMDLY X3 - byte Tuning Required 1 Maximum delay --
Constant between timestamp
change and value
change in loops

568 OW360_R1100
 5.121 SOFTSOE

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

VDLY X4 - byte Tuning Required 1 Maximum delay --

Constant between value
change and
timestamp change in
loops
NOTME X5 - byte Tuning Required 0 Action when value --
Constant changes without
timestamp change:
 0 = Send no event
 1 = Send event with
current system time
 2 = Send event with
last timestamp
TMCHG X6 - byte Tuning Required 0 Change of time --
Constant expected:
 0 = On every
change of value
 1 = When new
event is to be
generated
PDEVT G0 - Alg. Init N/A 0 Number of pending --
integer events

OW360_R1100 569
5.122 SPTOSA

5.122 SPTOS A
Description

The SPTOSA algorithm transfers a packed point record into an analog point record.

The packed digital value field is converted to a whole (real) number (for example, 4.0) and stored
in the analog point value field.

If Bit 15 is a zero, a positive number results. If Bit 15 is a one, a negative number results. The bit
pattern for each packed word produces a real number between -32767 and +32767. The method
for converting bit patterns into negative numbers is the sign and magnitude method.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

* PACK - Variable Required - Input (packed) LP

OUT - Variable Required - Output (analog) LA

* Parameter names may vary depending on software release.

570 OW360_R1100
 5.123 SQUAREROOT

5.123 SQUAREROOT
Description

The SQUAREROOT algorithm multiplies the analog input with an internal gain, adds a bias and
then takes the square root.

Functional symbol

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog track point. This algorithm takes the following action in response to the information
found in the analog input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit No action Passed through**

20 Raise inhibit No action Passed through**

21 Conditional Track Implemented Passed through***

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Not Used No action Not used

28 Not Used No action Not used

29 Not Used No action Not used

OW360_R1100 571
5.123 SQUAREROOT

BIT DESCRIPTION ACTION TOUT SIGNAL

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the
definitions given in Setting Tracking Signals (see page 17).

*** If the algorithm is being told to track, then the Conditional track bit is ignored. Otherwise, the
value of the conditional track bit is transferred to all output track points. If the Conditional Track
bit is set in the track input point, the analog value of all output track points is calculated based on
the analog value of the track input point.

The high and low limit flags and the tracking signals from the algorithm are output to TOUT to be
used for display and by an upstream algorithm. If the output value is invalid, the quality of OUT is
set to BAD. Otherwise, the quality of OUT is set to the quality of the input when not in tracking
mode. When tracking, the quality is set to the quality of the track input variable.

Note: If the algorithm generates an invalid track output value, the IN1 input value is used as the
track output, unless it is invalid. The track output value is not updated if both the calculated track
output and IN1 input values are invalid.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 77 Tuning -

Diagram
Number
IN1G R1-Real Tuning Required 1.0 Gain on input. -
Constant The gain on
(GAIN) the input
should never
be initialized to
zero; if it is, the
drop is placed
into alarm.
IN1B R2-Real Tuning Required 0.0 Bias on input -
Constant
(BIAS)
TPSC R5-Real Tuning Required 1E+09 Maximum -
Constant value of the
(999999999) output point
BTSC R6-Real Tuning Required 0.0 Minimum value -
Constant of the output
point

572 OW360_R1100
 5.123 SQUAREROOT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

TRAT R5-Real Tuning Required 2.5 Track ramp -

Constant rate (units per
second)
IN1 - Variable Required - Analog input LA

TOUT - Variable Required - Track output LA

value, mode
and status
signal for Input
1 variable
OUT - Variable Required - Analog output LA
variable
TRIN - Variable Optional - Tracking and LA
limiting mode
signals and
tracking value;
analog input
variable

Function

IN1GB = (IN1 x IN1 GAIN) + IN1 BIAS

IF IN1GB > 0 THEN
OUT = SQUARE ROOT OF IN1GB
ELSE
OUT = 0
IF OUT >= TPSC THEN
OUT = TPSC
ELSE
IF OUT <= BTSC THEN
OUT = BTSC

OW360_R1100 573
5.124 SSLT

5.124 SSLT
Description

SSLT calculates Entropy (S) of Saturated Liquid given its Temperature. It is one of the functions
of the STEAMTABLE algorithm (see page 594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

SSLT input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) TEMP 32.0 705.47

(OUT 1) ENTR -0.000036890 1.0612

574 OW360_R1100
 5.125 STATISTICS

5.125 STATISTICS
Description

The STATISTICS algorithm performs running calculations of weighted arithmetic mean, variance
and standard deviation of sampled input, based on values from TW (Time Window). The TW
parameter is defined by the user. This algorithm also tracks input samples to determine their
minimal and maximal value from TW last time. Additionally a user can divide the time window into
a maximum of four regions and define weights for each region. Weights can be defined by a point
or as a static, non-negative real value. Values from a given partition are taken with the same
weight.

Functional symbol

The parameters for the Functional Symbols are defined below:

 IN1 – input
 W1 – weight for 1st partition
 W2 – weight for 2nd partition
 W3 – weight for 3rd partition
 W4 – weight for 4th partition

 MEAN – weighted arithmetic mean of input values (denoted as )

 VAR – variance of input values (denoted as )

 SDEV – standard deviation of input values (denoted as )

 MIN – minimal value of input
 MAX – maximal value of input
 ROC – rate of change of MEAN
 STATE – information about state of the buffer 0/1 (not full/full)
 STATUS – information about accuracy of configuration parameters

OW360_R1100 575
5.125 STATISTICS

Algorithm Parameters and Rules

Time Window Definition

User must define:

UNIT — units of time. The user can select from one of five units:

0 = tenths of a second
1 = seconds
2 = minutes
3 = hours
4 = days

TIME — number of units

Time window (Tw) is defined as:

TW = UNIT x TIME

Below is a graphical representation of the Time window.

Figure 31: Time Window

Because the time window can encompass a large number of input samples, it is divided into NUM
(up to 60) subregions. For each subregion, a set of DISTANCE subsequent input samples is
taken. Only valid samples without BAD quality are used. Each time the algorithm takes the next
set of DISTANCE subsequent input samples into a new subregion, it stores a number of
acceptable samples, their sum and the sum of their squares for this subregion. Those values are
then used to calculate outputs.

576 OW360_R1100
 5.125 STATISTICS

The recommended length of time window is a multiple of p (control area time). The following
guidelines are recommended for best performance:
 If NUM is smaller than 60, then the algorithm uses M last input values itself to calculate
outputs. Value of NUM is set to M. DISTANCE is set to 1.
 If NUM is a multiple of 60, then the algorithm divides the time window into 60 subregions with
the same length (DISTANCE). For each sub region number of acceptable input values, the
sum and sum of squares is computed and then used to calculate outputs. The value of NUM
is set to 60, its maximal number. DISTANCE is set to M/60.
The following description illustrates how the algorithm calculates NUM parameter and
DISTANCE.

First, the algorithm calculates the number of all cycles (number of input samples) during the time
window:

where:

NUMBER_ALL_CYCLES is rounded down

Next, the algorithm calculates the distance (number of input samples taken into each subregion):

where:

DISTANCE is rounded up

Based on the number of all cycles during time window and distance, the algorithm calculates the
number of subregions, as:

OW360_R1100 577
5.125 STATISTICS

If the length of time window is not a multiple of p then bit 1 in the STAT output point is set to 1. In
this case, the length of time window is shorter than original settings.

For example, assume the follow parameters:

p = control area time = 20[sec]

UNIT = seconds

TIME = 90

The equations are solved as follows:

TW = UNIT x TIME = 90 x 1[s] = 90s

If the length of time window is a multiple of p but M is not a multiple of 60, then bit 0 in the STAT
output point is set to 1. In this case, the length of time window is not changed, but the last
subregion is smaller. Distance for the last shorter subregion is calculated as a remainder of
NUMBER_ALL_CYCLES / DISTANCE.

For further explanation, the following two examples are shown. The first example shows a
situation when the recommended conditions are followed. The second example shows a situation
when the recommended conditions are not followed.

578 OW360_R1100
 5.125 STATISTICS

Example 1

In this example, the following parameters are used:

p = control area time = 1[sec]

UNIT = seconds

TIME = 300

For these settings, the time window is equal to 300 control cycles and NUM parameter (number of
subregion) is equal to 60 (maximal value).

The following figure represents a distribution of subregions in the time window.

Figure 32: Distribution of Subregions in Time Window (recommended conditions)

OW360_R1100 579
5.125 STATISTICS

Example 2

This example represents a situation when the length of time window is not divided by 60 and the
recommended parameters are not followed. This situation can happen when a user sets
parameters that do not follow the recommendations. A second situation can happen when the
control time area changes (sheet is run in a different time area). The algorithm works correctly
with these parameters, but they are different from the recommended parameters.

For this example, assume the following parameters:

p = control area time = 1[sec]

UNIT = seconds

TIME = 303

The equations are solved as follows:

TW = UNIT x TIME = 303 x 1[s] = 303s

580 OW360_R1100
 5.125 STATISTICS

The following figure represents a distribution of sums in the time window using non-recommended
parameter conditions.

Figure 33: Distribution of Subregions in Time Window (not recommended conditions)

In this case, the number of subregions is reduced to NUM=51. This number makes a steady
distribution of subregions – number of input samples used to calculate each sum (except last) is
the same. Each sum is calculated from six input samples; however, the last sum only has three
input samples.

OW360_R1100 581
5.125 STATISTICS

Weights definition

The Time window can be divided into a maximum of four regions. The user defines ranges of
regions and weights.

PART 1 - end range of first partition defined by number of units

PART 2 - end range of second partition defined by number of units

PART 3 - end range of third partition defined by number of units

PART 4 - end range of fourth partition defined by number of units

W1- weight for first partition

W2- weight for second partition

W3- weight for third partition

W4- weight for fourth partition

Note: Ranges are defined in the same units as the time window. Weight value has to be a
non-negative real value.

Below is an example with definitions, ranges and weights (expanded Example 1).

Example 3

This example assumes the following parameters:

p = control area time = 1[sec]

UNIT = seconds

TIME = 300

R1 = 6

R2 = 150

R3 = 293

R4 = TIME = 300

For these settings, the time window is equal to 300 control cycles and the NUM parameter is
equal to 60.

582 OW360_R1100
 5.125 STATISTICS

The following figure shows a distribution of subregions in the time window.

Figure 34: Time Window with Weights

OW360_R1100 583
5.125 STATISTICS

In the case with weights, the algorithm must check membership to a region for each sum. The
algorithm calculates where the end for each region is supposed to be. Calculations are based on
the following equations:

Next, the algorithm calculates the final output as:

In Example 3, the parameters were defined as follows:

p = control area time = 1[sec]

UNIT = seconds

TIME = 300

PART1 = 6

PART2 = 150

PART3 = 293

PART4 = TIME = 300

NUM =60

584 OW360_R1100
 5.125 STATISTICS

Therefore, the equations are solved as follows:

These results are shown in the Time Window with Weights figure.

Number of sums for region 1 is equal to 1.

Number of sums for region 2 is equal to 30-1=29.

Number of sums for region 3 is equal to 58-30=28.

Number of sums for region 4 is equal to 60-58=2 .

Final output (if all samples are not BAD) is solved with the following equation:

OW360_R1100 585
5.125 STATISTICS

Quality of Input and Output Points

Qualities of MEAN, VAR, SDEV and ROC outputs are based on qualities for subregions.

Quality for each subregion is as follows:

 If all input samples taken into subregion are BAD - BAD
 If less than half of the input samples are GOOD - POOR
 If more than half of the input samples are GOOD - FAIR
 If all input samples taken into subregion are GOOD - GOOD
Qualities of MEAN, VAR, SDEV and ROC outputs are as follows:
 Until the first subregion is not filled (MEAN, VAR, SDEV) - BAD
 Until the first two subregions are not filled (ROC) - BAD
 If the quality of all subregions is BAD - BAD
 If the quality of less than half the subregions is GOOD - POOR
 If the quality of less than half of the sub regions is FAIR or POOR - FAIR
 If the quality of more than half the subregions is GOOD - FAIR
 If the quality of more than half (or all) of the sub regions is FAIR or POOR - POOR
 If the quality of all subregions is GOOD - GOOD
If the QUAL parameter is set to NO, then the following is true:
 The output quality will be set to the worst quality of the weight inputs. If the output quality is
calculated as bad, the algorithm will stop calculating the ROC, VAR, SDEV, and MEAN
outputs.
If the weight signals are set to a negative real value, then the ROC, VAR, SDEV, and MEAN
outputs will be set to BAD quality.
 If the weighted parameters are defined by the input pins, then the outputs will remain BAD
until the W1 through W4 input(s) are set to GOOD again.
 If the weighted parameters are defined in the algorithm, then the algorithm will set the
negative value to zero, and the quality will be set to GOOD.
Weight parameters are only used for calculating the MEAN.

Qualities of MIN and MAX outputs are set to qualities of input samples with minimum and
maximum value during time window Tw. In addition, those qualities are set to BAD until the first
subregion is filled.

586 OW360_R1100
 5.125 STATISTICS

Function

MEAN output

The STATISTICS algorithm calculates the weighted arithmetic mean of input samples.

If weights are equal to 1.0, then the algorithm calculates the standard mean of input samples.

VAR and SDEV Outputs

Additionally, the algorithm calculates sample variance and standard deviation, which are defined
as the following (note that “NUM” is changed to “N”):

where:

= input sample value from time k-i

n = number of all samples in time window Tw

= mean value of input sample values in time window Tw

OW360_R1100 587
5.125 STATISTICS

The algorithm cannot store all the values for the above equation. Therefore, the standard
deviation and variance are derived by the following equations:

Using the sum in each region, the equation can be written as follows:

where:

= sum of samples from subregion i

= sum of squares of samples from subregion i

= number of samples used to calculate sum

If N equals 1, then and are set to zero.

588 OW360_R1100
 5.125 STATISTICS

MIN and MAX Outputs

The STATISTICS algorithm reports the minimal and maximal input sample from N (NUM) last
subregions:

where:

= input sample with minimal value from i subregion;

where:

= input sample with maximal value from i subregion;

The outputs minimum value MIN and maximum value MAX are calculated at every loop, based on
stored min/max input values of samples from N last subregions. Qualities of these outputs are set
to qualities of samples with minimum value and maximum value.

ROC Output

The STATISTICS algorithm also calculates the rate of change of MEAN output value defined as:

where:

= Actual value of MEAN output

= Previous value of MEAN output

Additional Information

During initial operation, the algorithm calculates outputs based on the configuration of “TOPT”
parameters. TOPT is defined as:

0 (yes) Mean value is equal to current input value (until buffer is full). STDV and VAR
are equal to 0.0. When the buffer is full, the algorithm starts working according
to the explanations listed in the examples above.

1 (no) Algorithm calculates MEAN, STDV and VAR values based on the samples as
they become available in the Time window.

Each change of the TIME parameter clears all stored data. STATE value is reset to 0.

OW360_R1100 589
5.125 STATISTICS

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU - Data Init Required 149 Tuning diagram —

Integer number

TOPT X3 - Byte Data Init Optional YES Track output: —

 Yes
 No
QUAL X2 - Byte Data Init Optional No Ignore quality of —
weighted points:
 No
 Yes
UNIT X1 - Byte Data Init Optional 0 Units of time —
0 = tenths of a
second
1 = seconds
2 = minutes
3 = hours
4 = days
TIME G0 - Tuning Required 1 Number of units —
Integer Constant

PART 1 G2 - Tuning Required 0 End of range of —

Integer Constant first partition

PART 2 G3 - Tuning Required 0 End of range of —

Integer Constant second partition

PART 3 G4 - Tuning Required 0 End of range of —

Integer Constant third partition

PART 4 G5 - Tuning Required 0 End of range of —

Integer Constant fourth partition

IN1 — Variable Required — Input (analog) LA

* W1 R1 - Real Selectable Required 1.0 Weight for first LA

partition
* W2 R2 - Real Selectable Required 1.0 Weight for LA
second partition

* W3 R3 - Real Selectable Required 1.0 Weight for third LA

partition
* W4 R4 - Real Selectable Required 1.0 Weight for fourth LA
partition

MEAN — Variable Optional — Output (analog) - LA

weighted
arithmetic

590 OW360_R1100
 5.125 STATISTICS

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

VAR — Variable Optional — Output (analog) - LA

variance

SDEV — Variable Optional — Output (analog) - LA

standard
deviation
MIN — Variable Optional — Output (analog) - LA
minimal value

MAX — Variable Optional — Output (analog) - LA

maximum value

ROC — Variable Optional — Output (analog) - LA

rate of change

STATE — Variable Optional — Buffer state LD, LP

STAT — Variable Optional — Configuration LP

status
* When a parameter type is defined as "Selectable" and marked as "Required," the Control Builder may
default the parameter to a value and mark it as "Optional." However, for the control function to be
executed properly, you must enter a value for the parameter.

OW360_R1100 591
5.126 STEAMFLOW

5.126 STE AMFLOW

Description

The STEAMFLOW algorithm performs a flow compensation based on a flow measurement on an

input as a differential pressure input or a flow input (IN1). Correction is applied from specific
volume (IN2), which comes from the output of the STEAMTABLE algorithm (see page 594).

Invalid Real Numbers and Quality

If the output value is invalid, the quality of OUT is set to BAD. Otherwise, the quality of OUT is set
to the worst quality of the two inputs.

Note: You are responsible for the input’s units.

Functional symbol

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 22 Tuning Diagram —

Number
TYPE X1-Byte Data Init. Required DELTAP Input Type —
(Deltap or Flow)
SCAL R1-Real Tuning Required 1.0 Scaling factor —
Constant

BASE R2-Real Tuning Required 1.0 Base specific —

Constant volume

GAIN R3-Real Tuning Required 1.0 Gain on Specific —

Constant Volume

592 OW360_R1100
 5.126 STEAMFLOW

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

* IN1 — Variable Required — Analog Flow LA

Transmitter Delta
Pressure Input
* IN2 — Variable Required — Analog Specific LA
Volume Input

OUT — Variable Required — Analog output LA

variable
* Parameter name many vary depending on software release.

Function

DELTAP:

FLOW:

OW360_R1100 593
5.127 STEAMTABLE

5.127 STE AMTABLE

Description

The STEAMTABLE algorithm calculates thermodynamic properties of water and steam. The
STEAMTABLE algorithm supports both English and SI engineering units. The inputs are checked
to determine if they are in range. If they are not, the output point is set to BAD, the last GOOD
value is retained, and the Flag output is set to TRUE. If more than one input is required, they are
also checked to determine if the combination of input is reasonable. If they are not reasonable,
the output point is set to BAD, the last GOOD value is retained, and the Flag output is set to
TRUE. Otherwise, the quality of the OUT is set to the worst quality among the inputs.

Note: The steam tables are based on the 1967 American Society of Mechanical Engineers
(ASME) steam tables.

There are eleven individual symbols for the functions the STEAMTABLE algorithm performs. They
are as follows:

Region: Input and output

REGION CONTROL BUILDER REQUIRED INPUT OUTPUT

ALGORITHM SYM BOL

Compressed Liquid (CL) HSCLTP Temperature (IN1) Entropy (OUT)

(see page 324)
Pressure (IN2) Enthalpy (OUT1)
Atm. Pressure (IN3)
VCLTP (see page 657) Temperature (IN1) Specific Volume (OUT)
Pressure (IN2)
Atm. Pressure (IN3)
Saturated Liquid (SL) HSLT (see page 325) Temperature (IN1) Enthalpy (OUT)
SSLT (see page 574) Temperature (IN1) Entropy (OUT)
VSLT (see page 658) Temperature (IN1) Specific Volume (OUT)
PSLT (see page 478) Temperature (IN1) Pressure (OUT)

TSLP (see page 654) Pressure (IN1) Temperature (OUT)

Atm. Pressure (IN2)
TSLH (see page 653) Enthalpy (IN1) Temperature (OUT)

594 OW360_R1100
 5.127 STEAMTABLE

REGION CONTROL BUILDER REQUIRED INPUT OUTPUT

ALGORITHM SYM BOL

Saturated Vapor (SV) PSVS (see page 479) Entropy (IN1) Pressure (OUT)
HSTVSVP Pressure (IN1) Enthalpy (OUT)
(see page 326) Temperature (OUT1)
Atm. Pressure (IN2)
Entropy (OUT2)
Specific Volume
(OUT3)

Superheated Steam (SS) HSVSSTP Temperature (IN1) Entropy (OUT)

(see page 327)
Pressure (IN2) Enthalpy (OUT1)
Atm. Pressure (IN3) Specific Volume
(OUT2)

Control Builder Algorithm Symbol

The Control Builder Algorithm Symbol table provides a definition for each abbreviation used to
create the name for each STEAMTABLE function. They are as follows:

Abbreviation definitions

ABBREVIATION DEFINITION

CL Compressed Liquid

H Enthalpy

P Pressure

S Entropy

SL Saturated Liquid

SS Super Heated

SV Saturated Vapor

T Temperature

V Specific Volume

Functional symbol

OW360_R1100 595
5.127 STEAMTABLE

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

UNIT X1-Byte Data Init Required 0.0 Engineering Units —

(0 - English
(Default), 1 - SI)
See Engineering
Units Table below.
PROQ X4-Byte Data Init Required ON Quality is —
propagated:
 ON
 OFF
IN1 — Variable Required — Analog Input LA

IN2 — Variable Required/ — Analog Input LA

Optional
(depending on
algorithm)
IN3 — Variable Optional — Analog Input LA

OUT — Variable Required/ — Analog output LA

Optional variable
(depending on
algorithm)
OUT1 — Variable Optional — Analog output LA
variable
OUT2 — Variable Optional — Analog output LA
variable
OUT3 — Variable Optional — Analog output LA
variable
FLAG — Variable Optional — Digital output LD
variable

Engineering units

NAME SI ENGLISH

Temperature (T) C (Celsius) F (Farenheit)

Pressure (P) BAR psig

Specific Volume (V) M3/Kg FT3/LBM

Enthalpy (H) KJ/Kg BTU/LBM

Entropy (S) KJ/Kg x K BTU/LBM x R (Rankine)

596 OW360_R1100
 5.128 STEPTIME

5.128 STEPTIME
Description

The STEPTIME algorithm is an automatic step timer. For the STEPTIME algorithm, the output
(STEP) is an analog real value that always equals an integer from one through 50. The value
increments after a predetermined time delay, which may be different for each time interval. For
example, STEP may stay at 1 for 10 seconds, and then stay at 2 for five minutes. The time
intervals for each step are initialized integers in the algorithm record. The units of time to be used
for all the time intervals must be the same. The X1 field of the algorithm record should be
initialized to indicate which units are to be used according to the table. When all used steps are
completed, the output reverts to Step 1. Steps that have a time interval of zero are skipped.

Functional symbol

G0 B0 C0 D0 YM
G1 B1 C1 D1 YL
G2 B2 C2 D2 E2
G3 YU C3 YP E3
G4 B4 C4 D4 E4
G5 B5 C5 D5 YC
G6 B6 C6 D6 Y9
G7 B7 C7 YN E7
G8 B8 C8 D8 E8
G9 B9 YT D9 Y8

The value of STEP is tracked to the value of the track input (TRIN) when the tracking request
(TMOD) is TRUE. If the algorithm is told to track a step that has a zero time interval, the value of
STEP is the next step after this step that has a non-zero time interval. If the algorithm is not
tracking (TMOD = FALSE), the current time and the current step are held constant when the hold
request (HOLD) is TRUE. The time remaining in the timing cycle for the current step is output as
hours (RHRS), minutes (RMIN), and seconds (RSEC) with resolution down to a tenth of a second.
The hours (EHRS), minutes (EMIN), and seconds (ESEC) with resolution down to a tenth of a
second of the time elapsed in the timing cycle for the current step are also available if the optional
outputs are initialized by the user.

OW360_R1100 597
5.128 STEPTIME

Rules
1. The outputs are not scan-removable, but may be set to certain values using the TMOD and
TRIN inputs to track the algorithm to a particular step.
2. The track input and output values are checked for invalid real numbers. If a track request is
received and the track input is invalid, the tracking request is ignored.
If the algorithm calculates an invalid real number for the output, the quality of the output is set
to BAD and the output value is invalid. Otherwise, the quality of the output is set to GOOD.
3. The algorithm is also reset to the first step if a drop failover occurs and the value of the
current step number is invalid. Otherwise, the algorithm remains in the current step.
4. Controller loop time must be set to 100, 200, 500, or 1,000 milliseconds.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU - Data Init. Required 100 Tuning Diagram —

Integer Number
HOLD — Variable Required — Input (digital); LD, LP
hold request
TMOD — Variable Required — Input (digital); LD, LP
tracking request

TRIN — Variable Required — Input (analog); LA

tracks the step
to this value
UNIT X1-Byte Data Init. Optional 0 Code number —
for the units of
time to be used.
(value - units of
time)
0 - 0.1 seconds
(default)
1 - seconds
1 - minutes
3 - hours
T01 G0-Integer Tuning Optional 0 Time interval for —
Constant Step 1

T02 G1-Integer Tuning Optional 0 Time interval for —

Constant Step 2

T03 G2-Integer Tuning Optional 0 Time interval for —

Constant Step 3

T04 G3-Integer Tuning Optional 0 Time interval for —

Constant Step 4

598 OW360_R1100
 5.128 STEPTIME

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

T05 G4-Integer Tuning Optional 0 Time interval for —

Constant
Step 5
T06 G5-Integer Tuning Optional 0 Time interval for —
Constant Step 6

T07 G6-Integer Tuning Optional 0 Time interval for —

Constant Step 7

T08 G7-Integer Tuning Optional 0 Time interval for —

Constant Step 8

T09 G8-Integer Tuning Optional 0 Time interval for —

Constant Step 9

T10 G9-Integer Tuning Optional 0 Time interval for —

Constant Step 10

T11 B0-Integer Tuning Optional 0 Time interval for —

Constant Step 11

T12 B1-Integer Tuning Optional 0 Time interval for —

Constant Step 12

T13 B2-Integer Tuning Optional 0 Time interval for —

Constant Step 13

T14 YU-Integer Tuning Optional 0 Time interval for —

Constant Step 14

T15 B4-Integer Tuning Optional 0 Time interval for —

Constant Step 15

T16 B5-Integer Tuning Optional 0 Time interval for —

Constant Step 16

T17 B6-Integer Tuning Optional 0 Time interval for —

Constant Step 17

T18 B7-Integer Tuning Optional 0 Time interval for —

Constant Step 18

T19 B8-Integer Tuning Optional 0 Time interval for —

Constant Step 19

T20 B9-Integer Tuning Optional 0 Time interval for —

Constant Step 20

T21 C0-Integer Tuning Optional 0 Time interval for —

Constant Step 21

T22 C1-Integer Tuning Optional 0 Time interval for —

Constant Step 22

T23 C2-Integer Tuning Optional 0 Time interval for —

Constant Step 23

T24 C3-Integer Tuning Optional 0 Time interval for —

Constant Step 24

OW360_R1100 599
5.128 STEPTIME

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

T25 C4-Integer Tuning Optional 0 Time interval for —

Constant Step 25

T26 C5-Integer Tuning Optional 0 Time interval for —

Constant Step 26

T27 C6-Integer Tuning Optional 0 Time interval for —

Constant Step 27

T28 C7-Integer Tuning Optional 0 Time interval for —

Step 28
Constant
T29 C8-Integer Tuning Optional 0 Time interval for —
Step 29
Constant
T30 YT-Integer Tuning Optional 0 Time interval for —
Constant Step 30

T31 D0-Integer Tuning Optional 0 Time interval for —

Constant Step 31

T32 D1-Integer Tuning Optional 0 Time interval for —

Constant Step 32

T33 D2-Integer Tuning Optional 0 Time interval for —

Constant Step 33

T34 YP-Integer Tuning Optional 0 Time interval for —

Constant Step 34

T35 D4-Integer Tuning Optional 0 Time interval for —

Constant Step 35

T36 D5-Integer Tuning Optional 0 Time interval for —

Constant Step 36

T37 D6-Integer Tuning Optional 0 Time interval for —

Constant Step 37

T38 YN-Integer Tuning Optional 0 Time interval for —

Constant Step 38

T39 D8-Integer Tuning Optional 0 Time interval for —

Constant Step 39

T40 D9-Integer Tuning Optional 0 Time interval for —

Constant
Step 40
T41 YM-Integer Tuning Optional 0 Time interval for —
Constant Step 41

T42 YL-Integer Tuning Optional 0 Time interval for —

Step 42
Constant
T43 E2-Integer Tuning Optional 0 Time interval for —
Constant Step 43

600 OW360_R1100
 5.128 STEPTIME

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

T44 E3-Integer Tuning Optional 0 Time interval for —

Step 44
Constant
T45 E4-Integer Tuning Optional 0 Time interval for —
Constant Step 45
T46 YC-Integer Tuning Optional 0 Time interval for —
Constant Step 46

T47 Y9-Integer Tuning Optional 0 Time interval for —

Constant Step 47

T48 E7-Integer Tuning Optional 0 Time interval for —

Constant Step 48

T49 E8-Integer Tuning Optional 0 Time interval for —

Constant Step 49

T50 Y8-Integer Tuning Optional 0 Time interval for —

Constant Step 50

STEP — Variable Required — Output (analog); LA

the current step
number
RHRS — Variable Required — Output (analog); LA
the number of
hours for the
time remaining
in the current
timing cycle
RMIN — Variable Required — Output (analog); LA
the number of
minutes for the
time remaining
in the current
timing cycle
RSEC — Variable Required — Output (analog); LA
the number of
seconds for the
time remaining
in the current
timing cycle

OW360_R1100 601
5.128 STEPTIME

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

EHRS — Variable Optional — Output (analog); LA

the number of
hours for the
time elapsed in
the current
timing cycle
EMIN — Variable Optional — Output (analog); LA
the number of
minutes for the
time elapsed in
the current
timing cycle
ESEC — Variable Optional — Output (analog); LA
the number of
seconds for the
time elapsed in
the current
timing cycle

602 OW360_R1100
 5.129 SUM

5.129 SUM
Description

The output of the SUM algorithm is the sum of the four individually gained and biased inputs.

Functional symbol

Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog tracking point. Make sure to connect the upstream algorithm which needs tracking
to SUM’s IN1. This algorithm takes the following action in response to the information found in the
analog input signal TRIN:

Bits and signals

BIT DESCRIPTION ACTION TOUT SIGNAL

16 Track Implemented Passed through

17 Track if lower No action Passed through*

18 Track if higher No action Passed through*

19 Lower inhibit No action Passed through**

20 Raise inhibit No action Passed through**

21 Conditional Track Implemented Passed through***

22 Not used No action Not used

23 Deviation Alarm No action Not used

24 Local Manual mode No action Not used

25 Manual mode No action Not used

26 Auto mode No action Not used

27 Not Used No action Not used

28 Not Used No action Not used

OW360_R1100 603
5.129 SUM

BIT DESCRIPTION ACTION TOUT SIGNAL

29 Not Used No action Not used

30 Low limit reached No action Low limit reached

31 High limit reached No action High limit reached

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the
definitions given in Setting Tracking Signals.

*** If the algorithm is being told to track, then the Conditional track bit is ignored.
Otherwise, the value of the conditional track bit is transferred to all output track
points. If the Conditional Track bit is set in the track input point, the analog value of
all output track points is calculated based on the analog value of the track input point.

The high and low limit flags and the tracking signals from the algorithm are output to TOUT, to be
used for display and by an upstream algorithm. If the output value is invalid, the quality of OUT is
set to BAD. Otherwise, the quality of OUT is set to the worst quality of the two inputs when not in
tracking mode. When tracking, the quality is set to the quality of the track input variable.

Note: If the algorithm generates an invalid track output value, the IN1 input value is used as the
track output, unless it is invalid. The track output value is not updated if both the calculated track
output and IN1 input values are invalid.

In addition, you may turn off the tracking output calculations. This may be done to support control
logic designs that require fast execution times (such as 20 msec). The TBLK parameter can be
set to OFF, which will disab le the tracking calculations and local memory operations. The default
value for TBLK is ON, which means the algorithm performs the tracking calculations.

Algorithm Record Type =LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

DIAG LU-Integer Data Init Required 84 Tuning diagram —

number
IN1G R1-Real Tuning Required 1.0 Gain on input 1. The —
Constant gain on the input 1
should never be
initialized to zero; if it
is, the drop is placed
into alarm.
IN1B R2-Real Tuning Required 0.0 Bias on input 1. —
Constant
IN2G R3-Real Tuning Required 1.0 Gain on input 2. —
Constant
IN2B R4-Real Tuning Required 0.0 Bias on input 2. —
Constant

604 OW360_R1100
 5.129 SUM

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

IN3G R8-Real Tuning Required 1.0 Gain on Input 3. —

Constant
IN3B R9-Real Tuning Required 0.0 Bias on Input 3. —
Constant
IN4G S1-Real Tuning Required 1.0 Gain on Input 4. —
Constant
IN4B S2-Real Tuning Required 0.0 Bias on Input 4. —
Constant

TPSC R5-Real Tuning Required 1E+09 Maximum value of -

Constant the output point
(999999999)
BTSC R6-Real Tuning Required -1E+09 Minimum value of -
Constant the output point
(-999999999)
TRAT R7-Real Tuning Required 2.5 Track ramp rate —
Constant (units per second)

TBLK X2 - Byte Data Init. Required ON Enable tracking --

Bit 0 calculations and
local memory
operations. The
choices are:
 ON
 OFF
IN1 — Variable Required — Input 1 analog input LA

TRIN — Variable Optional — Tracking and LA

Limiting mode
signals and tracking
value; analog input
variable
IN2 — Variable Required — Input 2 analog input LA

IN3 — Variable Optional — Input 3 analog input LA

IN4 — Variable Optional — Input 4 analog input LA

OUT — Variable Required — Analog output LA

variable
TOUT — Variable Required — Track output value, LA
mode and status
signal for input 1
variable

OW360_R1100 605
5.129 SUM

Function

IN1GB = (IN1 x IN1 GAIN) + IN1 BIAS

IN2GB = (IN2 x IN2 GAIN) + IN2 BIAS
IN3GB = (IN3 x IN3 GAIN) + IN3 BIAS
IN4GB = (IN4 x IN4 GAIN) + IN4 BIAS
OUT = IN1GB + IN2GB + IN3GB + IN4GB
IF OUT >= TPSC THEN
OUT = TPSC
ELSE
IF OUT <= BTSC THEN
OUT = BTSC

606 OW360_R1100
 5.130 SYSTEMTIME

5.130 SYSTEMTIME
Description

While the RUN flag is set, the SYSTEMTIME algorithm accesses the time from the Contoller’s
time (expressed in Universal Time Coordinates (UTC)) and stores it in the separate, optional,
analog outputs for seconds, minutes, hours, day, month, and year.

If the month value is zero (indicating that the time is not updated), or if the RUN flag is FALSE, the
optional Time Not Updated digital output is set.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

RUN — Variable Required — Input (digital); Run LD, LP

flag
SEC — Variable Optional — Output (analog); LA
seconds
MIN — Variable Optional — Output (analog); LA
minutes
HOUR — Variable Optional — Output (analog); LA
hours
DAYM — Variable Optional — Output (analog); day LA
of month

MNTH — Variable Optional — Output (analog); LA

month
YEAR — Variable Optional — Output (analog); LA
year
TNUP — Variable Optional — Output (digital); time LD, LP
not updated

OW360_R1100 607
5.131 TANGENT

5.131 TANGENT
Description

The TANGENT algorithm performs a mathematical tangent function. TANGENT has one input
and one output analog point. Each time the algorithm is executed, if the output is on scan, it is set
to the TANGENT of the input. The input to this algorithm is in radians. If an input is only available
in degrees, multiply it by 0.01745329 to convert to radians. If the input is +/- pi/2 or any integer
multiple of pi, plus pi/2, the output is an invalid number and the drop is placed into alarm.

Invalid Real Numbers and Quality

Analog input values are checked for invalid real numbers. If the input value is invalid, the value of
the output is invalid and its quality is set to BAD. If the input is valid, the quality of the input is
propagated to the output.

If the absolute value of the input is greater than 1018 then the output of the TANGENT algorithm is
invalid and its quality is set to BAD.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 — Variable Required — Input (analog) LA

OUT — Variable Required — Output (analog) LA

Function

OUT=TANGENT(IN1)

608 OW360_R1100
 5.132 TIMECHANGE

5.132 TIMECHANGE
Description

The TIMECHANGE algorithm checks the Controller’s time (expressed in Universal Time
Coordinates (UTC)) against the old values of the time. If the hours, minutes, or seconds have
changed, the appropriate output digital flags are set; otherwise, they are reset. Each output
produces a one loop, one shot pulse when hours, minutes, or seconds change from a previous
value.

Functional Symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

OLD H R1-Real Data Init. Optional 0.0 Internal Data —

only. Not to be
initialized by user.
OLD M R2-Real Data Init. Optional 0.0 Internal Data —
only. Not to be
initialized by user.
OLD S R3-Real Data Init. Optional 0.0 Internal Data —
only. Not to be
initialized by user.
HCHG — Variable Required — Output (digital): LD, LP
Change in Hours
flag
MCHG — Variable Required — Output (digital); LD, LP
Change in
Minutes flag
SCHG — Variable Required — Output (digital); LD, LP
Change in
Seconds flag

OW360_R1100 609
5.133 TIMEDETECT

5.133 TIMEDETECT
Description

The TIMEDETECT algorithm checks the hour value from the Controller’s time (expressed in
Universal Time Coordinates (UTC)) against the old hour value for a change. If the hour has
changed, the current hour and day of the week are checked against the hour for the change of
day, the hours for the change of shift, and the day and hour for the change of week. The flags are
reset if the hour has not changed. If a change has occurred for the day, shift, or week, the digital
output for that change is TRUE for one loop.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU - Data Init. Required 87 Tuning diagram —

Integer number

SHF1 X1-Byte Tuning Required 0 First shift hour/day —

Constant hour
(0 - 23)
SHF2 X2-Byte Tuning Optional 0 Second shift hour —
Constant (0 - 23)

SHF3 X3-Byte Tuning Optional 0 Third shift hour (0 - —

Constant 23)

WEEK X4-Byte Tuning Optional 0 Day of the week —

Constant
(Day range. For
example, 1 =
Sunday)
DCHG — Variable Required — Output (digital); LD, LP
Change of Day flag

SHFT — Variable Required — Output (digital); LD, LP

Change of Shift flag

WCHG — Variable Required — Output (digital); LD, LP

Change of Week
flag

Note: SHF1 must be initialized. If SHF2 and SHF3 are not initialized or are initialized to zero, the SHFT
is not updated. If WEEK is not initialized or is initialized to zero, WCHG is not updated. DCHG is always
updated.

610 OW360_R1100
 5.134 TIMEMON

5.134 TIMEMON

Description

If the RUN flag is set, the TIMEMON algorithm provides the following functions:
 If the Controller Date/Time is between the Date 1/Time 1 and Date 2/Time 2 tuning constants,
the optional digital output flag, FLG1 is set TRUE.
 When the Date 2/Time 2 tuning constants are zero, FLG1 is pulsed when the Controller
Date/Time is equal to Date 1/Time 1.
 The MON, DAY, DWK fields of the tuning constants are ignored if zero; therefore, the tuning
constants can represent time-into-year, time-into-month, time-into-week, or time-into-day. (For
example: if HR1 is set to 15.0 and no other FLG1 tuning constants are specified, FLG1 is
pulsed every day at 3:00 p.m.)
 The optional digital output FLG2 is set when the Controller time equals the Start Time tuning
constants, and at every following incremental boundary in the day, as specified by the
Incremental Time tuning constants.
For example: if SHR = 15, SMIN = 30, IMIN = 1, and ISEC = 30, FLG2 is pulsed at 3:30 p.m.
and at each following 90-sec interval until 23:59:59.

Note: Controller time is expressed in Universal Time Coordinates (UTC). Therefore, when
entering parameters for the TIMEMON algorithm, you should convert your timezone to UTC in
order to obtain the expected performance.

Functional symbol

Note: The Incremental Time constant should be at least three times the Loop time for the FLG2
output to be seen as a pulse.

Also, the TIMEMON algorithm has a resolution of 1 second. Therefore, Emerson recommends
that you use it in control tasks >= 1 second. If it is used in a control task faster than 1 second,
the FLG1 and FLG2 parameters will generate multiple output pulses for each intended single
pulse output.

OW360_R1100 611
5.134 TIMEMON

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU - Data Init Required 88 Tuning diagram —

Integer number
RUN — Variable Required — Input (digital); LD, LP
RUN flag
MON1 B1-Integer Tuning Optional 0 Date 1 month —
Constant

DAY1 B2-Integer Tuning Optional 0 Date 1 day —

Constant

DWK1 YU-Integer Tuning Optional 0 Date 1 day of —

Constant week
Valid values are:
0 - none
1 - Monday
2 - Tuesday
3 - Wednesday
4 - Thursday
5 - Friday
6 - Saturday
7 - Sunday
HR1 B4-Integer Tuning Optional 0 Time 1 hour —
Constant

MIN1 B5-Integer Tuning Optional 0 Time 1 minute —

Constant

SEC1 B6-Integer Tuning Optional 0 Time 1 second —

Constant

MON2 B7-Integer Tuning Optional 0 Date 2 month —

Constant

DAY2 B8-Integer Tuning Optional 0 Date 2 day —

Constant

612 OW360_R1100
 5.134 TIMEMON

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DWK2 B9-Integer Tuning Optional 0 Date 2 day of —

Constant week
Valid values are:
0 - none
1 - Monday
2 - Tuesday
3 - Wednesday
4 - Thursday
5 - Friday
6 - Saturday
7 - Sunday
HR2 C1-Integer Tuning Optional 0 Time 2 hour —
Constant

MIN2 C2-Integer Tuning Optional 0 Time 2 minute —

Constant

SEC2 C3-Integer Tuning Optional 0 Time 2 second —

Constant

SHR C4-Integer Tuning Optional 0 Start time hour —

Constant

SMIN C5-Integer Tuning Optional 0 Start time —

Constant minute

SSEC C6-Integer Tuning Optional 0 Start time —

Constant second

IHR G3-Integer Tuning Optional 0 Incremental time —

Constant hour

IMIN G4-Integer Tuning Optional 0 Incremental time —

Constant minute

ISEC B0-Integer Tuning Optional 0 Incremental time —

Constant second

FLG1 — Variable Optional — Output (digital); LD, LP

FLG1 flag output

FLG2 — Variable Optional — Output (digital); LD, LP

FLG2 flag output

OW360_R1100 613
5.135 TRANSFER

5.135 TRANSFER

Description

The TRANSFER algorithm performs a transfer between two inputs. The output is equal to the IN2
input if the digital input FLAG is TRUE, and to the IN1 input if the digital input FLAG is FALSE.

If the algorithm generates an invalid output value for the selected input, the other input is
selected, and the algorithm generates a valid output value if the input for the other point is valid.

The algorithm automatically performs a bumpless transfer between the track input and the
selected input when a tracking request is removed. The algorithm ramps to the selected input
(IN1 or IN2) at the specified track ramp rate TRRx (TRR1 or TRR2).

Internal tracking may be selected to allow a bumpless transfer between IN1 and the IN2 inputs.
Individual track ramp rates may be initialized to ramp from the IN1 to the IN2 and from the IN2 to
the IN1.

The Output Direction Forcing (ODF) option forces a change in the direction of an output value in
the transition state. When the ODF option is ON, the output value changes monotonically (strictly
increasing or decreasing the function between ordered sets that preserves the given order)
towards the value of the selected input. If the ODF option is OFF, the output value changes
towards the value of the selected input; however, this may not always be monotonically.
Differences in the algorithm behavior depend on the direction of changes of the selected input.
Refer to the following two examples of ODF:

Example 1

The following example presents a scenario when the transfer algorithm behavior is same
regardless of whether ODF = ON or ODF = OFF.

Properties description

PROPERTIES DESCRIPTION

Scenario Transfer from a lower to a higher value.

During the transition, the selected value is constant in a few steps
and then the value starts increasing.
Parameters  ODF = ON
 SLEW = ON
 TRRx = 1.0 (TRR1 = 1.0 and TRR2 = 1.0)
Results when ODF = OFF Output value (green line) increases with TRRx ramp rate when the
selected signal (blue line) is constant.
When the selected value increases, the output value changes with
ramp rate equal to RAMP_OF_SELECTED_SIGNAL + TRRx.
This means that the output changes with the speed equal to the
speed of changes of the selected signal and TRR1 parameter.
Results when ODF = ON The algorithm behavior is the same as when ODF = OFF.

614 OW360_R1100
 5.135 TRANSFER

The following figure shows that the Transfer algorithm behavior is same regardless of whether
ODF = ON or ODF = OFF.

Figure 35: Transfer algorithm behavior is same for ODF = ON and ODF = OFF

Example 2

The following example presents a scenario when the Transfer algorithm behavior is different
when the ODF = ON or ODF = OFF.

Note: ODF=ON is the default setting.

Properties

PROPERTIES DESCRIPTION

Scenario Transfer from a lower to a higher value.

During the transition, the selected value is constant in a few steps and
then the value starts decreasing.

Parameters  ODF = ON
 SLEW = ON
 TRRx = 1.0 (TRR1 = 1.0 and TRR2 = 1.0)

OW360_R1100 615
5.135 TRANSFER

PROPERTIES DESCRIPTION

Results when ODF = OFF Output value (green line) decreases with TRRx ramp rate when the
selected signal (blue line) is constant.
When the selected value decreases, the output value changes with
ramp rate equal to RAMP_OF_SELECTED_SIGNAL + TRRx. This
means that the output changes with the speed equal to the speed of
change of the selected signal and TRR1 parameter.

Note: In this example, the RAMP_OF_SELECTED_SIGNAL is

negative and the output value decreases; however, it will not happen
when ODF is ON. See the following description "Results when ODF =
ON."

Results when ODF = ON Output (green line) moves towards the selected signal (blue line) with
the ramp rate is equal to TRRx in both cases: when the selected value
is constant and also when selected value decreases.
The ramp rate equals to RAMP_OF_SELECTED_SIGNAL + TRRx
only when the value of the selected signal and the value of the output
are moving in the same direction. One of the following situations is
possible:
 The output is transferring from a lower to a higher value and the
selected value is increasing.
 The output is transferring from a higher to a lower value and the
selected value is decreasing.

The following figure shows the Transfer algorithm behavior when ODF = OFF (default settings).

Figure 36: Transfer algorithm behavior when for ODF = OFF (default settings)

616 OW360_R1100
 5.135 TRANSFER

The following figure shows that the Transfer algorithm behavior when ODF = ON.

Figure 37: Transfer algorithm behavior when for ODF = ON

The rules are analogical (this means that the algorithm behavior is very similar; however, not
identical) for transfer from a higher to a lower value and from a lower to a higher value.

Summary
 When the ODF parameter is OFF (default value), the output value changes with ramp rate
equal to RAMP_OF_SELECTED_SIGNAL + TRRx.
 When the ODF parameter is ON, the output value changes with ramp rate equal to
RAMP_OF_SELECTED_SIGNAL + TRRx only, when the value of the selected signal and
value of the output are going in the same direction (Example 1). Otherwise (Example 2), the
output value is changing with ramp rate equal to TRRx.

Note: If the algorithm receives an invalid value as the selected input, or calculates an invalid
value as the output, the drop is placed into alarm.

Functional symbol

OW360_R1100 617
5.135 TRANSFER

Packed Digital Tracking Signals

Tracking and limiting are done through signals passed in the upper 16 bits of the third status word
of the analog point. This algorithm takes the following action in response to the information found
in the analog input signal TRIN:

Bits and signals

BIT DESCRIPTION TRK1 SIGNAL TRK2 SIGNAL

16 Track Implemented and passed Implemented and passed through or

through or set TRUE when set TRUE when IN2 input is not
IN1 input is not selected selected
17 Track if lower Passed through* Passed through*

18 Track if higher Passed through* Passed through*

19 Lower inhibit Passed through** Passed through**

20 Raise inhibit Passed through*** Passed through***

21 Conditional Track No Action Not used

22 Not used Not used Not used

23 Deviation Alarm Not used Not used

24 Local Manual mode Not used Not used

25 Manual mode Not used Not used

26 Auto mode Not used Not used

27 Not used Not used Not used

28 Not used Not used Not used

29 Not used Not used Not used

30 Low limit reached Low limit reached Not used

31 High limit reached High limit reached Not used

* Only when the Track signal is not present.

** Only when the Track signal is not present; the signals are set according to the definitions given in
Setting Tracking Signals (see page 17).

*** If the algorithm is being told to track, then the Conditional track bit is ignored. Otherwise, the value of
the conditional track bit is transferred to all output track points. If the Conditional Track bit is set in the
track input point, the analog value of all output track points is calculated based on the analog value of the
track input point.

618 OW360_R1100
 5.135 TRANSFER

The high and low limit flags, and the tracking signals from the algorithm are output to, TRK1 and
TRK2, to be used for display and by upstream algorithms. If the output value is invalid, the quality
of OUT is set to BAD. Otherwise, the quality of OUT is set to the quality of the selected input.
When tracking, the quality is set to the quality of the track input variable.

Note: If the calculated track output is invalid, then the IN2 output is equal to the IN2 inputs, and
the IN1 track output is equal to the IN1 variable input, if the inputs are valid. If the calculated
track outputs and the input values are invalid, then the IN2 and IN1 track outputs are not
updated.

Algorithm Record Type= LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init Required 42 Tuning diagram —

number
* IN1G R3-Real Tuning Required 1.0 Gain on input1. —
Constant The gain on the
input1 should never
be initialized to
zero; if it is, the
drop is placed into
alarm.
* IN1B R4-Real Tuning Required 0.0 Bias on input 1 —
Constant

* IN2G R1-Real Tuning Required 1.0 Gain on input2. —

Constant The gain on the
input2 should never
be initialized to
zero; if it is, the
drop is placed into
alarm.
* IN2B R2-Real Tuning Required 0.0 Bias on input2 —
Constant

TPSC R5-Real Tuning Required 1E+09 Maximum value of -

Constant the output point
(999999999)
BTSC R6-Real Tuning Required -1E+09 Minimum value of -
Constant the output point
(-999999999)
SLEW X1-Byte Data Init. Required OFF Internal tracking —
Bit 0 option:
 OFF: No tracking
during a transfer.
 ON: Tracking is
implemented
during a transfer.

OW360_R1100 619
5.135 TRANSFER

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

TRR1 R7-Real Tuning Required 2.5 Tracking ramp rate —

Constant from input1 to
input2 or from the
track input to the
input2 (units per
second)
TRR2 R9-Real Tuning Required 2.5 Tracking ramp rate —
Constant from input2 to
input1or from the
track input to the
input1 (units per
second)
OTRK X1-Byte Data Init. Required ON Output Tracking —
Bit 2 Option:
 OFF = output
value does not
track.
 ON = output
value tracks.
FLAG — Variable Required — Digital input signal LD, LP
to select output
(required); you
must enter the
name of a point.
* IN2 — Variable Required — Input2 (analog) LA

* TRK2 — Variable Required — Track output value, LA

node and status
signals for Input 2
variable
* IN1 — Variable Required — Input1 (analog) LA

* TRK1 — Variable Required — Track output value LA

mode and status
signals for input 1
variable
OUT — Variable Required — Analog output LA
variable

620 OW360_R1100
 5.135 TRANSFER

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

TRIN — Variable Optional — Tracking and LA

limiting mode
signals and
tracking value;
analog input
variable
ODF X1-Byte Data Init Required ON Output direction
Bit 4 forcing option:
 OFF = Output
value direction is
not forced in
transition state.
 ON = Output
value direction is
forced in
transition state.
* Parameter name may vary depending on software release.

Function

IF FLAG = TRUE THEN

OUT = (IN2 x IN2 GAIN) + IN2 BIAS
ELSE
OUT = (IN1 x IN1 GAIN) + IN1 BIAS
IF OUT >= TPSC THEN
OUT = TPSC
ELSE
IF OUT <= BTSC THEN
OUT = BTSC

OW360_R1100 621
5.136 TRANSLATOR

5.136 TRANSLATOR
Description

The TRANSLATOR algorithm translates the output based on the input of a predefined table. For
the TRANSLATOR algorithm, the input value (IN1) is first rounded to an integer value. This
integer is then used as an index number to access one of the 50 integers initialized in the
algorithm record. The selected integer from the algorithm record is output as a real number in the
output record (OUT). If the input value (always rounds down to an integer) is less than one or
greater than 50, no action is taken and OUT is not changed.

If the input value selects an integer between 1 and 50 that has not been initialized, then OUT
equals zero. The maximum integer number that can be initialized for I01 through I50 is + 32,767.

If the input value (when rounded to an integer) is less than 1 or greater than 50, or if the input
value is invalid, no action is taken, and OUT is not changed. However, if the input value is invalid,
the quality of OUT is set to BAD.

The quality of the input is propagated to the output.

Functional symbol

G0 B0 C0 D0 YM
G1 B1 C1 YQ YL
G2 B2 C2 D2 E2
G3 YU C3 YP E3
G4 B4 C4 D4 E4
G5 B5 C5 D5 YC
G6 B6 C6 D6 Y9
G7 B7 C7 YN E7
G8 B8 C8 D8 E8
G9 B9 YT D9 Y8

622 OW360_R1100
 5.136 TRANSLATOR

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

DIAG LU-Integer Data Init. Required 103 Tuning —

diagram
Number
I01 G0-Integer Tuning Optional 0 Possible —
Constant selected output
value
I02 G1-Integer Tuning Optional 0 Possible —
Constant selected output
value
I03 G2-Integer Tuning Optional 0 Possible —
Constant selected output
value
I04 G3-Integer Tuning Optional 0 Possible —
Constant selected output
value
I05 G4-Integer Tuning Optional 0 Possible —
Constant selected output
value
I06 G5-Integer Tuning Optional 0 Possible —
Constant selected output
value
I07 G6-Integer Tuning Optional 0 Possible —
Constant selected output
value
I08 G7-Integer Tuning Optional 0 Possible —
Constant selected output
value
I09 G8-Integer Tuning Optional 0 Possible —
Constant selected output
value
I10 G9-Integer Tuning Optional 0 Possible —
Constant selected output
value
I11 B0-Integer Tuning Optional 0 Possible —
Constant selected output
value
I12 B1-Integer Tuning Optional 0 Possible —
Constant selected output
value
I13 B1-Integer Tuning Optional 0 Possible —
Constant selected output
value

OW360_R1100 623
5.136 TRANSLATOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

I14 YU-Integer Tuning Optional 0 Possible —

Constant selected output
value
I15 B4-Integer Tuning Optional 0 Possible —
Constant selected output
value
I16 B5-Integer Tuning Optional 0 Possible —
Constant selected output
value
I17 B6-Integer Tuning Optional 0 Possible —
Constant selected output
value
I18 B7-Integer Tuning Optional 0 Possible —
Constant selected output
value
I19 B8-Integer Tuning Optional 0 Possible —
Constant selected output
value
I20 B9-Integer Tuning Optional 0 Possible —
Constant selected output
value
I21 C0-Integer Tuning Optional 0 Possible —
Constant selected output
value
I22 C1-Integer Tuning Optional 0 Possible —
Constant selected output
value
I23 C2-Integer Tuning Optional 0 Possible —
Constant selected output
value
I24 C3-Integer Tuning Optional 0 Possible —
Constant selected output
value
I25 C4-Integer Tuning Optional 0 Possible —
Constant selected output
value
I26 C5-Integer Tuning Optional 0 Possible —
Constant selected output
value
I27 C6-Integer Tuning Optional 0 Possible —
Constant selected output
value
I28 C7-Integer Tuning Optional 0 Possible —
Constant selected output
value
I29 C8-Integer Tuning Optional 0 Possible —
Constant selected output
value

624 OW360_R1100
 5.136 TRANSLATOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

I30 YT-Integer Tuning Optional 0 Possible —

Constant selected output
value
I31 D0-Integer Tuning Optional 0 Possible —
Constant selected output
value
I32 YQ-Integer Tuning Optional 0 Possible —
Constant selected output
value
I33 D2-Integer Tuning Optional 0 Possible —
Constant selected output
value
I34 YP-Integer Tuning Optional 0 Possible —
Constant selected output
value
I35 D4-Integer Tuning Optional 0 Possible —
Constant selected output
value
I36 D5-Integer Tuning Optional 0 Possible —
Constant selected output
value
I37 D6-Integer Tuning Optional 0 Possible —
Constant selected output
value
I38 YN-Integer Tuning Optional 0 Possible —
Constant selected output
value
I39 D8-Integer Tuning Optional 0 Possible —
Constant selected output
value
I40 D9-Integer Tuning Optional 0 Possible —
Constant selected output
value
I41 YM-Integer Tuning Optional 0 Possible —
Constant selected output
value
I42 YL-Integer Tuning Optional 0 Possible —
Constant selected output
value
I43 E2-Integer Tuning Optional 0 Possible —
Constant selected output
value
I44 E3-Integer Tuning Optional 0 Possible —
Constant selected output
value
I45 E4-Integer Tuning Optional 0 Possible —
Constant selected output
value

OW360_R1100 625
5.136 TRANSLATOR

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

I46 YC-Integer Tuning Optional 0 Possible —

Constant selected output
value
I47 Y9-Integer Tuning Optional 0 Possible —
Constant selected output
value
I48 E7-Integer Tuning Optional 0 Possible —
Constant selected output
value
I49 E8-Integer Tuning Optional 0 Possible —
Constant selected output
value
I50 Y8-Integer Tuning Optional 0 Possible —
Constant selected output
value
IN1 — Variable Required — Input (analog) LA

OUT — Variable Required — Output LA

(analog)

626 OW360_R1100
 5.137 TRANSPORT

5.137 TRANSPORT
Description

The TRANSPORT algorithm samples the analog input point and outputs the sample value with a
time delay. The sampling time (TSAM) and the number of samples (NSAM) control the delay
(DELAY = TSAM x NSAM). If TSAM is less than the loop time of TRANSPORT, TSAM equals the
loop time. The output is zero until the number of samples have been collected. Additional
TRANSPORT algorithms can be strung together in series to obtain longer delay times, if required.

NSAM is continually limited to a range of 1 through 25. If NSAM is negative or zero, then NSAM
goes to 1. If NSAM is greater than 25, NSAM goes to 25.

Invalid Numbers and Quality

The value of the analog input (IN1) is checked for invalid real numbers. If the input value is
invalid, the output value is invalid and the quality of the output is set to BAD. Otherwise, the
quality of the output is set to GOOD.

Functional symbol

IN1

~ OR
IN1 ~ OUT

OUT

OW360_R1100 627
5.137 TRANSPORT

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Data Init Required 90 Tuning diagram —

number
TSAM T9-Real Data Init. Required 0 Sampling time in —
seconds
NSAM G0-Integer Data Init. Required 0 Number of samples —
(1-25)

INIT X1-Byte Data Init. Optional 2 Sample initialization —

 0 or 1 = Samples are
initialized to zero
when the algorithm is
first added to the
drop; samples are
not changed at
power-up, reset, or
failover, and may
contain old values.
 2 = Samples are
initialized to the
current value of the
IN1 analog input on
power-up, reset, and
failover (as well as
when the algorithm is
first added to the
drop).
 3 = Samples are
initialized to the
current value of the
OUT analog output
on power-up, reset,
and failover (as well
as when the
algorithm is first
added to the drop).
 4 = Samples are
initialized to zero on
power-up, reset, and
failover (as well as
when the algorithm is
first added to the
drop).
IN1 — Variable Required — Input (analog) LA

OUT — Variable Required — Output (analog) LA

628 OW360_R1100
 5.138 TRNSFINDX

5.138 TRNSFINDX
Description

The TRNSFINDX algorithm selects the output analog value from up to 64 outputs which hold the
input IN1. The number of outputs is determined by NMIN which must be less than or equal to 64.
The output selected is based on the index which is the second analog input (IN2). If the index is
less than or equal to 0, or if an index greater than NMIN is selected, the input is not stored.

Functional symbol

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

NMIN X1-Byte Data Init Required 1 Select maximum —

number
IN1 — Variable Required — Analog input LA
value
IN2 — Variable Required — Analog index LA
value
O01 — Variable Required — Analog output LA
value
O02 — Variable Optional — Analog output LA
value
•
•
•
O64

OW360_R1100 629
5.139 TRUTHTBL

5.139 TRUTHTBL
Description

This digital output of TRUTHTBL is selected from one of 256 possible digital values. The 16
integer values (field B0 through C5) contain the 256 possible digital output states; each bit in an
integer represents a possible digital output (where: 0 = FALSE and 1 = TRUE). The output
selected is based on a binary address formed by eight digital inputs. The integer binary address
values may be input as hexadecimal numbers. Refer to "Converting Algorithm Binary to
Hexadecimal" (see page 6) for information on how to create a hexadecimal number from 16 bits.

The inputs are optional; therefore, any input that is not specified is assumed to have a value of
zero (FALSE). The input binary address may range from zero to 255. The letter "A" represents Bit
0 in the address and the letter "H" represents Bit 7 in the address. For example, if the input binary
address is 36 (C and F are TRUE), the digital output would be based on the value of Bit 4 (the
fifth bit) in the third integer.

Symbol

Note: The size of the algorithm symbol varies as required to enclose the logic symbols being
executed by this algorithm.

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

A - Variable Optional - Input (digital signal) LD, LP

B - Variable Optional - Input (digital signal) LD, LP

C - Variable Optional - Input (digital signal) LD, LP

D - Variable Optional - Input LD, LP

(digital signal)

630 OW360_R1100
 5.139 TRUTHTBL

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

E - Variable Optional - Input LD, LP

(digital signal)
F - Variable Optional - Input LD, LP
(digital signal)
G - Variable Optional - Input LD, LP
(digital signal)
H - Variable Optional - Input LD, LP
(digital signal)
DIAG LU - Byte Data Init. Optional 91 Tuning Diagram -
Number (default
value = 91)
I01 B0 - Integer Tuning Optional 0 Output States 0 -
Constant through 15
I02 B1 - Integer Tuning Optional 0 Output States 16 -
Constant through 31
I03 B2 - Integer Tuning Optional 0 Output States 32 -
Constant through 47
I04 B3 - Integer Tuning Optional 0 Output States 48 -
Constant through 63
I05 B4 - Integer Tuning Optional 0 Output States 64 -
Constant through 79
I06 B5 - Integer Tuning Optional 0 Output States 80 -
Constant through 95
I07 B6 - Integer Tuning Optional 0 Output States 96 -
Constant through 111
I08 B7 - Integer Tuning Optional 0 Output States 112 -
Constant through 127
I09 B8 - Integer Tuning Optional 0 Output States 128 -
Constant through 143
I10 B9 - Integer Tuning Optional 0 Output States 144 -
Constant through 159
I11 C0 - Integer Tuning Optional 0 Output States 160 -
Constant through 175
I12 C1 - Integer Tuning Optional 0 Output States 176 -
Constant through 191
I13 C2 - Integer Tuning Optional 0 Output States 192 -
Constant through 207
I14 C3 - Integer Tuning Optional 0 Output States 208 -
Constant through 223
I15 C4 - Integer Tuning Optional 0 Output States 224 -
Constant through 239

OW360_R1100 631
5.139 TRUTHTBL

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE PT.
FIELD REC.

I16 C5 - Integer Tuning Optional 0 Output States 240 -

Constant through 255
OUT - Variable Required - Output (digital signal) LD, LP

Note: Following features are of the algorithm:

1. The truth table is constructed as an ordered binary sequence from 0 to 255.

2. The output of the truth table is defined by the user via the integers B0 through C5.

3. The integer parameters in the Control Builder and Signal Diagrams must be input in decimal form. The
least significant group of 16 bits is located in the first output control state 0 through 15 (B0), and so on
until the most significant bit group.

Application Example

TRUTHTBL is a general purpose, logic algorithm. The output represents a Boolean equation of up
to eight inputs. In general, TRUTHTBL condenses discrete logic elements (for example, AND,
OR, NOT, XOR, NAND, or NOR) into one algorithm call. The logic statement of the output is
stated as a Boolean equation and then translated into the proper tuning constants. This
translation can be done manually.

The following figure illustrates how TRUTHTBL is shown on a functional drawing.

The following figure shows how the tuning contents can be manually derived.

632 OW360_R1100
 5.140 TRVP

5.140 TRVP
Description

The Triple Redundant Valve Positioner (TRVP) algorithm implements the triple module
redundancy for the Ovation Valve Positioner module. The algorithm monitors all three RVP
modules that control the process. Its main function is to provide reliable and bumpless control of
the servo valve by identifying failure scenarios and scaling the control output of the healthy RVP
modules accordingly. Additionally, the TRVP algorithm is capable of computing the integral
component of the PI algorithm and sends this information to the RVP modules as output voltage
offset.

The TRVP algorithm allows the operator to perform multiple operations such as synchronized
calibration, reboot of the RVP modules, clearing module alarms after an issue is fixed, and arming
healthy RVP modules to a control process. This algorithm is able to run a 10 milliseconds control
task.

Functional symbol

OW360_R1100 633
5.140 TRVP

5.140.1 TRVP configuration

In the triple redundancy configuration, the algorithm monitors up to three Valve Positioner
modules controlling the process. Each Valve Positioner is connected to only one coil. For servo
valves with less than three coils, only a subset of the three modules is connected to each coil.
Each of the three Valve Positioner modules determines the position feedback of the valve using a
separate LVDT sensor.

All tuning parameters are accessible from an MMI graphic. The TRVP algorithm performs the
following functions:
 Monitors the health of each Valve Positioner module (see page 635).
 Detects a deviation in the reported position feedback (see page 635).
 Determines the state of each Valve Positioner module (see page 636).
 Computes the integral component of the PI algorithm (see page 637).
 Scales the PI control output for bumpless transition when modules fail or are required to fail
for reliable control of the process (see page 638).
 Accesses Status Register 1 of each Valve Positioner module (see page 639).
 Writes to the Command Register 10 of each module (see page 639).
 Runs a synchronized calibration sequence to calibrate all the RVP modules simultaneously
(see page 640).
 Resets failure flags (see page 642).
 Reboots individual RVP modules without manually unplugging the module from the slot
(see page 642).
 Determines the signal quality of the average feedback position and the voltage bias
(see page 642).

Figure 38: TRVP algorithm

634 OW360_R1100
 5.140 TRVP

5.140.2 Monitoring the health of each Valve Positioner module

If any failure is reported onboard, the Valve Positioner is capable of performing its own
diagnostics and sending a failure command to the Controller, which will be adjusting the scaling of
the other remaining healthy Valve Positioner modules controlling the valve.

The diagnostics onboard the modules include:

 LVDT sensor reading:
 Sensor reading saturates the analog-to-digital converter (ADC).
 LVDT signal is not an AC signal (not active for DC LVDTs).
 Decoded position feedback is outside the expected range (-5% to 105%).
 Wire breaks and rod fallouts. The rate of change of feedback position is related to the
valve dynamics.
 Servo voltage readback:
 Wire breaks are detected when the voltage readback is outside the expected deadband.

If any failure condition is detected, the Valve Positioner module enters failure mode (its output
voltage is set to zero), and sends a failure command using the Status Register 1 to the TRVP
algorithm in the Controller. The algorithm will scale the output voltage of each active module to
ensure bumpless transition.

5.140.3 Detecting feedback position deviation

The feedback positions reported by all modules are received by the TRVP algorithm as inputs:
A_POSFB, B_POSFB, and C_POSFB. The algorithm computes the position difference between
every two modules and compares it to the maximum expected position deviation MAX_DEV [%].
If a position value is not consistent with the other two, then that corresponding RVP module will
be forced to fail. If the remaining two healthy modules detect an inconsistent position value (their
difference is larger than MAX_DEV), then the TRVP algorithm first checks if any of the modules
reported a failure condition. If one of the modules detected an onboard failure, then that particular
module fails, and the position reported by the only healthy module is assumed to be correct. If
neither of the modules detected a failure onboard, then both of them enter failure mode (there is a
50 percent chance that one of them is not working correctly).

Note: The feedback position deviation diagnostic is neglected during transient times (set point
change and after triggering an arming command). The tuning parameter DIA_DEL specifies how
many loop times are required to delay the diagnostic calculations after a setpoint change or an
arming command.

When a module is unplugged from the base unit, the position feedback point (A_POSFB,
B_POSFB, or C_POSFB) exhibits bad quality; the failure command is initiated inside the TRVP
algorithm to fail the module.

OW360_R1100 635
5.140 TRVP

5.140.4 Determining and displaying the state of each module

The TRVP algorithm assigns a status to each Valve Positioner module. There are three operating
states for each Valve Positioner module, which are also available as outputs: A_STATE,
B_STATE, and C_STATE.

Operating States for Valve Positioner module

NUMBER STATE DESCRIPTION

0 Failed The Valve Positioner module has reported a failure command to the Controller or
the TRVP algorithm has set the module in the failure state. The output voltage of
the module is forced to zero.
1 Ready The Valve Positioner module does not detect any failure conditions and its position
feedback is consistent with the other module(s). It is ready to be engaged and
control the process, but it is not (yet) controlling the process. The module is
assumed to be healthy, and the output voltage is zero volts.
2 Active The Valve Positioner module is healthy and participates in the control of the
process. A transition from Ready State to Active State is only possible by operator
intervention.

The Failed and the Ready states depend on the diagnostics of the module, and the transition
between these states depends on the health of the module. A transition from the Ready state to
the Active state is possible only by the arm command (rising edge for ARM_CMD) issued by the
operator given that the driving signal is TRUE.

The operator specifies which of the RVP modules are connected to a servo coil using the tuning
parameter associated with each module (A_DRIVE, B_DRIVE, or C_DRIVE). These driving
signals have the ability to accommodate the servo valves with less than three coils. In such a
case, the operator can specify which modules are controlling the process by setting A_DRIVE,
B_DRIVE, and C_DRIVE to either of the following options:
 Yes - Connected.
 No - Not Connected

636 OW360_R1100
 5.140 TRVP

5.140.5 Computing the integral component of the PI algorithm

Each Valve Positioner module implements the proportional component of the PI algorithm.
However, the integral term is computed by the TRVP algorithm and is sent to the modules as a
voltage offset. The parameter scaling for bumpless transition (see Scaling output voltage for
bumpless control (see page 638) ) will scale both the PI gain and the total integral bias by the
number of active modules. Therefore, the control of the valve is uniformly distributed between the
active modules.

The integral calculations use the setpoint value from the Controller and the average feedback
position value obtained from the healthy modules.

where

and

equals the number of healthy modules. The PI reset time is a tunable parameter (INTTIME) in
seconds.

The integral calculations are enabled only when the difference between the average feedback
position (output: AVG_POS) and the setpoint (input: STPT) is less than the value specified by the
tuning parameter INT_ENB [%]. Otherwise, the previous integral value is held. The integral value
is held constant (frozen) in the following scenarios:
 During Seating and Backseating.
 During Retreat Seating and Retreat Backseating.
 Outside the INT_ENB deadband.
 When reaching the limits INT_MAX or INT_MIN.
The integral component is reset when any of the following conditions are true:
 The input signal INT_RST is set to TRUE (it may be connected to a logic network or
manipulated by the operator).
 All modules are in failed state.
 During calibration and when in Local mode or Start mode.
Direct or indirect action can be tuned by setting INT_DIR to one or zero, respectively.

The integral component can have a lower and an upper limit specified by the tuning parameters:
INT_MIN and INT_MAX, respectively. The units are Volts.

A smoothing factor controls the slew rate of the integral component (INTSLEW) expressed in
Volts per second. A large value for this parameter allows a fast convergence of the integral
component estimation. A small value avoids the bumps in the integral calculations. The integral
component can be locked to a constant value by setting INTSLEW to zero.

The TRVP algorithm also accepts an additional voltage bias (V_BIAS) specified by the operator
as a constant. This value is added to the voltage computed by the integral calculations and sent
to the module as one voltage value. This voltage value is encoded into bits 0-12 of the TRVP
outputs: A_CTRL, B_CTRL, and C_CTRL. These outputs should be connected to the Channel 8
of the corresponding modules.

OW360_R1100 637
5.140 TRVP

5.140.6 Scaling output voltage for bumpless control

The control algorithm performed by the RVP modules to drive the valve is a proportional-integral
(PI) controller:

The proportional component (piGain * error) will be performed by each RVP module, and the
integral calculations (Integral) and any additional voltage bias (voltageBias) are determined at the
Controller level and communicated the module.

The total output voltage (servoVoltage) sent to each coil will be distributed equally between the
active RVP modules. Therefore, a failure of one of the modules implies that the remaining active
modules will divide the total output voltage between them to ensure bumpless transition during
failovers. This will be achieved by scaling the proportional term and the integral term with the
number of active modules.

A scaling factor is sent to each module to inform the module if it is actively driving the servo value.
In addition, if the module is controlling the valve, the scaling factor will specify the total number of
modules controlling the valve:

Modules

NUMBER OF MODULES DESCRIPTION

0 No module is controlling the valve, and its total output is zero volts.
1 Only one module is controlling the valve, and its output is not scaled.
2 Two modules are controlling the valve and this module is one of them. The
output is scaled by a factor of 1/2.
3 Three modules are controlling the valve and this module is one of them. The
output is scaled by a factor of 1/3.

The scaling factor is packed with the integral value into the outputs: A_CTRL, B_CTRL, C_CTRL.
These outputs should be connected to the Channel 8 of the corresponding modules. Bits 13-15
include the scaling factor.

Proportional term scaling

The proportional term, piGain * error, contributes to the output voltage during the transition period
from one setpoint value to another. The error is the difference between the setpoint and the
position feedback reported by the LVDT sensor for that particular module. After proper tuning, the
error will be minor during steady-state conditions.

The tuning parameter, piGain is scaled at the module level with the scaling factor specified by the
TRVP algorithm.

638 OW360_R1100
 5.140 TRVP

Integral term scaling

The integral term contributes to the output voltage during stable valve control (maintaining a fixed
position), and it represents the voltage required to overcome the mechanical bias of the valve.
The TRVP algorithm determines the integral term and any additional voltage bias and sends the
value to each Valve Positioner module as a single value. The TRVP algorithm specifies the
scaling factor, and the integral term is scaled accordingly at the module level.
5.140.7 Status Register 1 points (inputs)
The TRVP algorithm has access to the Status Register 1 of each module through the following
inputs: A_STATP, B_STATP, C_STATP. The corresponding Ovation point assigned to Channel 9
can be connected directly to these inputs of the TRVP algorithm. The Status Register 1 uses the
following bit assignment:
 Bits 0-3 – RVP mode
 Bits 4-5 – Not used
 Bit 6 – Hold integration (reflects Seating and Backseating status)
 Bit 7 – Alive flag
 Bit 8 – Not used
 Bit 9 – Coil diagnostic flag
 Bit 10 – Not used
 Bit 11 – Feedback A trouble
 Bit 12 – Retreat disabled flag
 Bit 13 – Feedback B trouble
 Bits 14-15 – Not used

5.140.8 Command Register 10 points (outputs)

The TRVP algorithm writes to the Command Register 10 of each module through the following
outputs: CMDREGA, CMDREG, CMDREGC. The corresponding Ovation point assigned to
Channel 11 can be connected directly to these outputs of the TRVP algorithm. The Command
Register 10 uses the following bit assignment:
 Bits 0-2 – Calibration command
 Bits 3-5 – Synchronized calibration command (see next section)
 Bit 6 – Synchronized calibration enable flag
 Bit 7 – Not used
 Bit 8 – Reset failure flags (bits 9,11,13 from Status Register 1)
 Bit 9 – Reboot command
 Bits 10-12 – Not used
 Bits 13-14 – Indicates the coil connection status:
 0 – not connected to a servo coil.
 1 – connected to a servo coil and driving the calibration.
 2 – connected to a servo coil and not driving the calibration.
 Bit 15 – Not used

OW360_R1100 639
5.140 TRVP

5.140.9 Synchronized calibration

The TRVP algorithm runs a synchronized calibration sequence to calibrate all the RVP modules
simultaneously. During calibration, only one RVP module is driving the servo valve, while the
other modules are updating their calibration parameters when requested by the TRVP algorithm.
You choose which of the RVP modules (A, B, or C) will drive the calibration using the tuning
parameter CAL_DRV.

CAL_REQ is a packed digital input signal and determines what type of calibration should be
performed. The corresponding calibration procedure will be initiated when a rising edge is
detected by the following bits of the CAL_REQ parameter:
 Bit 0 – Zero Hot Calibration
 Bit 1 – Top Hot Calibration
 Bit 2 – Full Calibration
 Bit 3 – Calibration Cancel
 Bits 4-16 – Not used
A KEYBOARD algorithm with a PACK16 algorithm can be connected to CAL_REQ to implement
the functionalities listed above.

The calibration sequence can run with three, two, or even one RVP module. If the driving module
is not inserted in the slot or it is set as not connected to a servo coil (X_DRIVE = No), then the
calibration will not start. In order to run a calibration with less than three modules, you must
manually disconnect the RVP modules from the slot (which are NOT to be calibrated) before
issuing the calibration request command (CAL_REQ). The calibration will be performed with the
RVP modules that are detected (those inserted in the slot) when the calibration command is
issued.

If an RVP module is inserted in the slot while calibration is being performed, then that module will
go to Normal mode with its output scaling set to zero until the current calibration sequence is
complete. This module will not be calibrated.

If a module is unplugged from the slot during calibration, than the other modules will enter Error
mode (bits 0-3 in the Status Register indicate the decimal value 4) after a certain timeout interval.
In this case, neither of the modules will be calibrated. In order to recover from Error mode, you
can issue a CALIBRATION CANCEL command using the CAL_REQ input pin (bit 3), or reboot all
the modules in Error mode. At this point, a new calibration command can be issued to calibrate
the remaining RVP modules.

The synchronized calibration sets the calibration parameters for all the RVP modules during the
same calibration sequence. This is orchestrated by the TRVP algorithm by writing the following
commands to Command Register 10 (bits 5-3) of each of the RVP modules:
 000 – No calibration command (default value).
 001 – Go to the Seated (0 percent) position – only the driving RVP module reacts to this
command while the other modules wait for the next command.
 010 – Read the calibration parameter for the Seated (0 percent) position.
 011 – Go to the Backseated (100 percent) position – only the driving RVP module reacts to
this command while the other modules wait for the next command.
 100 – Read the calibration parameters for the Backseated (100 percent) position.
 101 – Go to the Seated (0 percent) position – only the driving RVP module reacts to this
command while the other modules wait for the next command.

640 OW360_R1100
 5.140 TRVP

 110 – Read the calibration parameter for the Seated (0 percent) position.
 111 – Record and update the calibration parameters command.
The decimal value of these commands is also available for display using the CAL_SEQ optional
output pin. Additionally, the optional output pin CAL_CLR indicates the exit from calibration. Its
value is set to 1 when one of the two following conditions is true:
 Calibration has finished successfully and all the modules return to Normal mode.
 User aborts the calibration using the CAL_REQ input pin (bit 3).
The above calibration commands issued by the TRVP algorithm reflect the steps for a Full
Calibration sequence. The Zero Hot and Top Hot Calibration sequences use only a subset of
these commands. The RVP modules reply to the above commands using the Status Register 1
(bits 0-3):
 1011 – RVP module is driving to a requested position (Seat or Backseat) at a constant rate –
the driving RVP module will display this state.
 1001 – At Seated (0 percent) position.
 0101 – Finished reading the calibration parameters for the Seated (0 percent) position.
 1010 – At Backseated (100 percent) position.
 0110 - Finished reading the calibration parameters for the Backseated (100 percent)
position.
 0111 – Calibration (successfully) finished.
 0100 – Calibration error.
CALSTAT is a packed digital output signal used for displaying purposes:
 Bit 0 – set to TRUE if the RVP module A is available to drive the calibration. "Available"
means that A_DRIVE = YES (tuning parameter indicates that RVP A is connected to a servo
coil) and that RVP A is inserted in the slot.
 Bit 1 – set to TRUE if the RVP module B is available to drive the calibration.
 Bit 2 – set to TRUE if the RVP module C is available to drive the calibration.
 Bit 3* - set to TRUE if RVP module A is set to drive the calibration
 Bit 4* - set to TRUE if RVP module B is set to drive the calibration
 Bit 5* - set to TRUE if RVP module C is set to drive the calibration
* At any time, only one or none of the bits 3-5 is set to TRUE. All the bits are set to FALSE if the
driving RVP module (using CAL_DRV) is disconnected from the slot or if it is not to be connected
to a servo coil (X_DRIVE = No).

OW360_R1100 641
5.140 TRVP

5.140.10 Reset Failure flags

Whenever a failure is reported, the following bits are latched TRUE:

 Coil failure: bit 9 in Status Register 1, and the corresponding bit from Status Register 2 (bit 2
for coil 1 short or bit 5 for coil 1 open).
 LVDT feedback A failure: bit 11 in Status Register 1.
 LVDT feedback B Failure: bit 13 in Status Register 1.
The TRVP algorithm has the possibility to clear these bits after the problem is resolved without
having to reboot the module. The failure bits from a specific module can be reset by setting the
corresponding input signal to TRUE: A_RST_F, B_RST_F, C_RST_F. These signals write the
request to bit 8 in Command Register 10.

5.140.11 Module Reboot

You have the capability to reboot individual RVP modules without manually unplugging the
module from the slot. The corresponding RVP module will be rebooted when a rising edge is
detected by the following bits of the REBOOT packed digital input:
 Bit 0 – Reboot RVP module A.
 Bit 1 – Reboot RVP module B.
 Bit 2 – Reboot RVP module C.
 Bits 3-16 – Not used.
A KEYBOARD algorithm with a PACK16 algorithm can be connected to REBOOT to implement
the functions listed above.

5.140.12 Signal quality

The TRVP algorithm determines the signal quality of the average feedback position (AVG_POS)
and the voltage bias (OFFSET) based on the following conditions.

State description

NUMBER STATE DESCRIPTION

0 GOOD At least one Valve Positioner module is healthy, and its position feedback
value can be trusted.
3 BAD Neither of the Valve Positioner modules are healthy; either the position
feedback values from all three Valve Positioner modules deviate by more
than MAX_DEV from each other, or all of the modules reported a failure
condition.

The signal quality value is also available as an optional output pin (SIGQUAL).

642 OW360_R1100
 5.140 TRVP

5.140.13 TRVP Algorithm Definitions

Algorithm Record Type = LC

TRVP algorithm definitions

NAME LC ALG. TYPE REQUIRED / DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
TYPE RECORD

Tuning diagram
DIAG LU Tuning Required 0
number

FRSTPS X9 Tuning Required 0 First Pass

Coil Connection:
A_DRIVE G1 Tuning Required 1.0 -
1 = Yes; 0 = No

Coil Connection:
B_DRIVE G2 Tuning Required 1.0 -
1 = Yes; 0 = No

Coil Connection:
C_DRIVE G3 Tuning Required 0.0 -
1 = Yes; 0 = No

Calibration
CAL_DRV X4 Tuning Required 1 --
driver
Algorithm
T_EXEC R1 Tuning Required 0.01 Execution Time -
[sec]
Maximum
MAX_DEV R2 Tuning Required 1.0 Position -
Deviation [%]
Minimum Error
INT_ENB R3 Tuning Optional 5.0 for Integration to -
Start

Maximum Limit
INT_MAX R4 Tuning Optional 10.0 -
for Integral [V]

Minimum Limit
INT_MIN R5 Tuning Optional -10.0 -
for Integral [V]

Integral Reset
INTTIME R6 Tuning Required 10.0 -
Time [s]

Slew Rate of
INTSLEW R7 Tuning Optional 0.1 -
Integral [V/sec]

1 - Direct Action:
INT_DIR R8 Tuning Required 1.0 E = PV - STPT; -
0 - Indirect
Position
Diagnostic
DIA_DEL R9 Tuning Optional 200.0 -
Delay [loop
times]
rvpA: Position
A_POSFB - Input Required - LA
Feedback

OW360_R1100 643
5.140 TRVP

NAME LC ALG. TYPE REQUIRED / DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
TYPE RECORD

rvpB: Position
B_POSFB - Input Optional - LA
Feedback

rvpC: Position
C_POSFB - Input Optional - LA
Feedback

Engage ready
modules into
ARM_CMD - Input Required - LD
tRVP on rising
edge
rvpA: Status
A_STATP - Input Required - Register 1 LA
(Channel 9)
rvpB: Status
B_STATP - Input Optional - Register 1 LA
(Channel 9)
rvpC: Status
C_STATP - Input Optional - Register 1 LA
(Channel 9)

Set Point for PI

STPT - Input Required - LA
Algorithm

Voltage Bias
V_BIAS - Input Optional - Added to PI LA
output [V]
Integral Reset
INT_RST - Input Optional - Signal when set LD
to 1
rvpA: 1 = Reset
A_RST_F - Input Required - LD
all failure flags
rvpB: 1 = Reset
B_RST_F - Input Optional - LD
all failure flags
rvpC: 1 = Reset
C_RST_F - Input Optional - LD
all failure flags
Calibration
CAL_REQ - Input Required - request LP
command
rvpA: Connect
A_CTRL - Output Required - to Channel LA
8 point
rvpB: Connect
B_CTRL - Output Optional - to Channel LA
8 point
rvpC: Connect
C_CTRL - Output Optional - to Channel LA
8 point
rvpA: 0 - Failed;
A_STATE - Output Optional - 1 - Ready; LA
2 - Active

644 OW360_R1100
 5.140 TRVP

NAME LC ALG. TYPE REQUIRED / DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
TYPE RECORD

rvpB: 0 - Failed;
B_STATE - Output Optional - 1 - Ready; LA
2 - Active
rvpC: 0 - Failed;
C_STATE - Output Optional - 1 - Ready; LA
2 - Active
Average
feedback
AVG_POS - Output Optional - LA
position of
healthy modules
Total voltage
offset sent to the
OFFSET - Output Required - LA
RVP modules
[V]
Signal quality:
0-Good;1-Fair;
SIGQUAL - Output Optional - LA
2-Poor;
3-Bad
Calibration
CALSTAT - Output Optional - LP
status
rvpA: Command
CMDREGA - Output Required - Register 10 LA
(Channel 11)
rvpB: Command
CMDREGB - Output Optional - Register 10 LA
(Channel 11)
rvpC: Command
CMDREGC - Output Optional - Register 10 LA
(Channel 11)
Calibration
CAL_SEQ - Output Optional - sequence LA
number
Calibration clear
CAL_CLR - Output Optional - LA
command
RVPMODA - Output Optional - rvpA: Mode LA
RVPMODB - Output Optional - rvpB: Mode LA
RVPMODC - Output Optional - rvpC: Mode LA

Note: When a parameter type is defined as "Optional," the Control Builder may default the
parameter to a value. However, for the control function to be executed properly, you must enter a
value for this parameter.

OW360_R1100 645
5.141 TRVPTUNE

5.141 TRVPTUNE
Description

The Triple Redundant Valve Positioner Tune (TRVPTUNE) algorithm provides upload and
download functionality for the G05 Valve Positioner module. This algorithm handles all "offline"
(configuration) functions. The TRVPTUNE algorithm is a part of the triple redundant RVP
configuration (G05 RVP). This algorithm inherits the tuning functionalities of the RVPSTATUS
algorithm.

Functional Symbol

LC field records

The TRVPTUNE algorithm uploads and downloads configurable parameters used by the G05
Valve Positioner module. The following table lists tuning parameters and the associated LC
record fields.

646 OW360_R1100
 5.141 TRVPTUNE

Tuning parameters and associated LC Record

NUMBER NAME LC DESCRIPTION

RECORD

1 oscF R1 Oscillator frequency (not tunable):

 1: for 3 kHz (default)
 0: for 1 kHz
2 RDNDNT R2 Redundant flag: set to 1 for G05 RVP (not
tunable).
3 piGain R3 PI Controller gain outside of deadband1.
4 piResetT R4 PI Controller reset time outside of deadband1.
5 piGainDb R5 PI Controller gain inside of deadband1.
6 piResetTDb R6 PI Controller reset time inside of deadband1.
7 demodGain R7 The LVDT feedback is multiplied by this value to
achieve a voltage range representing 0 to 100%
position that is close to the input range of the A/D
converter1. This value is modified automatically
during the full calibration sequence, or it may be
entered by the user.
8 errorDbF R8 When the absolute value of the difference
between the target position and the actual
position is greater that this value (in percent), the
valve is considered to be in motion. Gain and
reset values are selected (outside the deadband)
to cause rapid control action1.
9 errorDbS R9 When the absolute value of the difference
between the target position and the actual
position is less than this value (in percent), the
valve is considered to be stable. Gain and reset
values are selected (inside the deadband) to
soften control action1.
10 seatLimit S1 When the target valve position is equal to or less
than this value (in percent), the Seating action
controls the output2.
11 backSeatLimit S2 When target valve position is equal to or greater
than this value (in percent), Backseating action
controls the output.
12 contingency S3 If the absolute value of the difference between
the target position and the feedback position is
greater than this value (in percent), then a
contingency condition may exist. The condition
must exist until a timer (contingencyTime)
expires for it to be reported.
13 contingencyTime S4 If the error between the target position and the
feedback position exceeds contingency for this
amount of time (in msec), then the condition is
reported to the Controller.

OW360_R1100 647
5.141 TRVPTUNE

NUMBER NAME LC DESCRIPTION

RECORD

14 bottomCalPos S5 This value is displayed in decimal. It is the

converted hexadecimal A/D converter reading for
the 0% position. You can enter this value
manually, if necessary; however, it is normally
determined automatically by the calibration
sequence.
15 topCalPos S6 This value is displayed in decimal. It is the
converted hexadecimal A/D converter reading for
the 100% position. You can enter this value
manually, if necessary; however, it is normally
determined automatically by the calibration
sequence.
16 seatDiagLimit S7 Maximum value (in percent) of difference
between the target position and feedback for the
output voltage to retreat to a lower value after a
timer (retreatHoldT) expired2. Retreat is disabled
if seatDiagLimit is set to 0.
17 coilDiagTime S8 Timer value (in msec) for open/shorted coil
diagnostics.
18 exitSeatVal S9 The magnitude of the output voltage is lowered to
this value (in mV) during Retreated Seating2. If
you change the DIRECT flag, then you must also
change exitSeatVal.
19 DIRECT T1 Direct action flag:
 1: Error = feedback position – setpoint
 0: Error = setpoint - feedback position
20 calRate T2 Rate (percentage change per second) at which
the target position moves during ramping to the
endpoint while in any of the calibration modes.
21 exitBkSeatVal T3 The magnitude of the output voltage is lowered to
this value (in mV) during Retreated
Backseating2. If you change the DIRECT flag,
then you must also change exitBkSeatVal.
22 min2ndry T4 If the derivative of position feedback exceeds this
value (percentage change per 10 msec), then the
valve positioner determines a failure condition.
23 coilCount T5 Specifies the number of servo coil connections to
the RVP. The default is 1 for G05 RVP.
24 Umin T6 Lower limit for the servo output voltage (in mV).
25 Umax T7 Upper limit for the servo output voltage (in mV).
26 kservo T8 The resistance of the servo coil expressed as a
ratio of the entire resistance between the
amplifier output and the ground potential. The
purpose of kServo is to predict the terminal screw
readback voltage based on voltage output. If the
readback is not in the correct proportion to the
DAC output, a wire break or short may be
indicated.

648 OW360_R1100
 5.141 TRVPTUNE

NUMBER NAME LC DESCRIPTION

RECORD

27 kservoDb T9 Deadband value used to calculate the allowable

coil voltage range when comparing predicted
voltage to actual voltage.
28 Raw_Fb_A U1 Raw reading (number of A/D converter counts)
for the secondary feedback A3.
29 Raw_Fb_B U2 Raw reading (number of A/D converter counts)
for the secondary feedback B3.
30 retreatHoldT U3 Time interval (in msec) during which the servo
voltage output is set to its maximum value (Umin
or Umax) before retreating to a lower value
(exitSeatVal or exitBkSeatVal)2.
1 Refer to Valve Positioner User Guide for Ovation for more information.

2 Seating, Retreated Seating, Backseating, and Retreated Backseating are consistent with the
RSR module. Refer to the Servo Driver User Guide for Ovation (RSR) manual for more information.
An example of Seating and Retreated Seating is illustrated in the figure following this table
assuming DIRECT = 0. The output will retreat to a lower value (exitSeatVal) if the absolute value of
the error is less than seatDiagLimit. While in Retreat, if the absolute value of the error exceeds
seatDiagLimit, the Retreat Disable flag is set (bit 12 in Status Register 1) and the output will go to
the maximum value and hold this value until it exits the Seating state (i.e. setpoint demand is larger
than seatLimit). Backseating and Retreated Backseating are similar but using backSeatLimit
instead of seatLimit, and Umax instead of Umin.
3 Raw A/D counts can be used for manually calibrating the servo valve. For example, if the valve is
at fully closed position then the A/D raw readings provide the value for bottomCalPos = Raw_Fb_B
- Raw_Fb_A. If the valve is at fully open position then the raw A/D readings provide the value for
topCalPos = Raw_Fb_B - Raw_Fb_A.

Valve Retreat

The following figure shows an example of Seating and Retreated Seating.

Figure 39: Seating, Retreated Seating, Retreat disabled

OW360_R1100 649
5.141 TRVPTUNE

Commands

The following commands are associated with the TRVPTUNE algorithm:

Command description

COMMAND DESCRIPTION

Enable Activates the TRVPTUNE algorithm. The value must be set to TRUE for the
algorithm to execute the upload and download requests.
Upload Retrieves the parameter values currently stored in the Valve Positioner
module (RVP card) memory.
Download Updates the parameter values currently stored in the Valve Positioner
module (RVP card) memory.
When the download command is requested, the values entered into the
graphic are stored in the 32-bit real number fields of the algorithm record.
Then the values in the selected fields of the algorithm record are written to
the RVP memory in the corresponding LC field.
Reset Acknowledges the finish of an upload or a download operation. If an error is
detected during the download or upload operation, the reset command will
clear the error and prepare the algorithm for the next command.

650 OW360_R1100
 5.141 TRVPTUNE

State Logic

The output status of the TRVPTUNE algorithm provides information regarding upload and
download operations. The following State chart describes the possible value outcomes of the
TRVPTUNE output signal.

Figure 40: TRVPTUNE State Logic diagram

OW360_R1100 651
5.141 TRVPTUNE

Algorithm Record Type = LC

TRVPTUNE algorithm definitions

NAME LC ALG. TYPE REQUIRED / DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
TYPE RECORD

DIAG LU- Data Required 116 Tuning diagram number -

Integer Init.
PCI X4- Data Required 1 PCI Card number (1 or 2) -
BYTE Init.
HWAD B2- Data Required 0 Card hardware address -
Integer Init.
ENBL - Variable Required - Enable flag (digital) LD
UPLD - Variable Required - Upload command (digital) LD
DNLD - Variable Required - Download command LD
(digital)
RSET - Variable Required - Reset algorithm for next LD
command (digital)
OUT1 - Variable Required - Output state (one bit is LP
set to TRUE at all times
to specify the current
state):

# DESCRIPTION

0 Alg. Not Ready

1 Alg. Ready
2 Upload Start
3 Upload Delay
4 Upload Finish
5 Upload Done
6 Download Start
7 Download Delay
8 Download Finish
9 Download Done
10 Error Start
11 Error Delay
12 Error Finish
13 Error Done

Note: When a parameter type is defined as Optional, the Control Builder may default the parameter to
a value. However, for the control function to be executed properly, you must enter a value for this
parameter.

652 OW360_R1100
 5.142 TSLH

5.142 TSLH
Description

TSLH calculates Temperature for Saturated Liquid given its Enthalpy (H). It is one of the functions
of the STEAMTABLE (see page 594) algorithm.

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

TSLH input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) ENTH -0.017864220 906.01

(OUT 1) TEMP 32.0 705.47

OW360_R1100 653
5.143 TSLP

5.143 TSLP
Description

TSLP calculates Saturation Temperature of Saturated Liquid given its Pressure. It is one of the
functions of the STEAMTABLE algorithm (see page 594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

TSLP input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) PRES 0.0885891400 3208.23

(INPUT 2) PRAT * Pressures are added together.
(OUT 1) TEMP 32.0 705.47

Note: PRAT is set from 12 to 16 psi.

654 OW360_R1100
 5.144 UNPACK16

5.144 UNP ACK16

Description

The UNPACK16 algorithm specifies up to 16 optional, packed digital values in the A2 record field
of a packed LP point record as optional outputs of this algorithm. These outputs may be initialized
as any combination of LD and DD records. The bit in the A2 record field that corresponds to the
output digital point number is moved to the output digital point record.

Note: The UNPACK16 algorithm only takes LP and DP record types as inputs.

Functional symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

PBPT — Variable Required — Input (packed point) LP, DP

(PIN)
D0 — Variable Optional — Output (digital) for Bit 0 LD

D1 — Variable Optional — Output (digital) for Bit 1 LD

D2 — Variable Optional — Output (digital) for Bit 2 LD

D3 — Variable Optional — Output (digital) for Bit 3 LD

D4 — Variable Optional — Output (digital) for Bit 4 LD

D5 — Variable Optional — Output (digital) for Bit 5 LD

D6 — Variable Optional — Output (digital) for Bit 6 LD

D7 — Variable Optional — Output (digital) for Bit 7 LD

OW360_R1100 655
5.144 UNPACK16

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

D8 — Variable Optional — Output (digital) for Bit 8 LD

D9 — Variable Optional — Output (digital) for Bit 9 LD

D10 — Variable Optional — Output (digital) for LD

Bit 10
D11 — Variable Optional — Output (digital) for LD
Bit 11
D12 — Variable Optional — Output (digital) for Bit LD
12
D13 — Variable Optional — Output (digital) for LD
Bit 13
D14 — Variable Optional — Output (digital) for LD
Bit 14
D15 — Variable Optional — Output (digital) for LD
Bit 15

656 OW360_R1100
 5.145 VCLTP

5.145 VCLTP
Description

VCLTP calculates Specific Volume of Compressed Liquid given its Temperature and Pressure. It
is one of the functions of the STEAMTABLE algorithm (see page 594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

VCLTP input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) TEMP 32.0 705.47

(INPUT 2) PRES 0.0885891400 16000.00
(INPUT 3) PRAT * Pressures are added together.
(OUT 1) VOL 0.0152 0.05078

Note: PRAT is set from 12 to 16 psi.

OW360_R1100 657
5.146 VSLT

5.146 VSLT
Description

VSLT calculates Specific Volume of Saturated Liquid given its Temperature. It is one of the
functions of the STEAMTABLE algorithm (see page 594).

Functional symbol

The following table represents the lower and upper limits of valid values for the algorithm.
However, the calculated output values may be invalid even though the input values are valid.

In the following table, all values are in English units.

VSLT input and output values

PARAME TE R PROPERTY LOW VALUE HIGH VALUE

(INPUT 1) TEMP 32.0 705.47

(OUT 1) ENTR -0.000036890 1.0612

658 OW360_R1100
 5.147 XOR

5.147 XOR
Description

The XOR algorithm performs a mathematical exclusive OR function. For the XOR algorithm, the
output is the logical, exclusive “OR” of the two inputs (that is, if one input is TRUE and the other
input is FALSE, the output is TRUE; otherwise, the output is FALSE).

Functional Symbol

Algorithm Record Type = None

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD RECORD

IN1 — Variable Required — Input (digital) LD, LP

IN2 — Variable Required — Input (digital) LD, LP

OUT — Variable Required/ — Output (digital) LD, LP

Optional

Note: Output is required if connecting to anything other than OR or AND.

Function

IF IN1 = IN2
THEN OUT = FALSE
ELSE
OUT = TRUE

OW360_R1100 659
5.148 X3STEP

5.148 X3STEP
Description

The X3STEP algorithm controls devices that must be kept within a certain tolerance and tuned by
an operator. The algorithm receives the Input demand (IN1) and the position feedback (IN2) of a
device (both are defined within a range of 0-100%). The difference (Error = IN11 - IN2), along with
other user-entered configuration parameters determine how the algorithm attempts to position the
equipment so that the error is zero.

The algorithm moves the equipment by energizing two digital outputs (DIG1 and DIG2)
associated with the device. The digital outputs may be energized in one of three ways (thus, the
algorithm's name X3STEP) to move the device to the demanded position:
 Maintained steadily ON.
 Pulsed (coarse-pulsed and fine pulsed) ON and OFF.
 Maintained steadily OFF.

Functional symbol

The action of each digital output depends on the value of the error, and the user-entered
parameters: ON1, COR1, FNE1, ON2, COR2, and FNE2.

660 OW360_R1100
 5.148 X3STEP

The parameters ON1, COR1, and FNE1, affect DIG1 when the error is above zero. The
parameters ON2, COR2, and FNE2, affect DIG2 when the error is below zero. The bar graph
below shows the relationship of the parameters with respect to the error.

% Error below zero % Error above zero

-----------------------------------------------------------
ON2 COR2 FNE2 0 FNE1 COR1 ON1

where:

FOR DIG2 FOR DIG1

ON2 = If the error is below or equal to ON2, ON1 = If the error is above or equal to ON1 the
the digital output DIG2 is maintained ON. digital output DIG1 is maintained ON.

COR2 = If the error is below or equal to COR1 = If the error is above or equal to COR1, the
COR2, the digital output DIG2 is coarse digital output DIG1 is coarse pulsed.
pulsed.
FNE2 = If the error is below or equal to FNE1= If the error is above or equal to FNE1, the
FNE2, the digital output DIG2 is fine pulsed. digital output DIG1 is fine pulsed. If the error is
If the error is below zero, but above FNE2, above zero, but below FNE1, DIG1 is maintained
DIG2 is maintained OFF. OFF.

Operation

Suppose an X3STEP algorithm had the following parameters:

ON2 COR2 FNE2 0 FNE1 COR1 ON1

-----------------------------------------------------------

-15 -12 -8 8 12 15

If the initial error is above or equal to 15, the digital output (DIG1) is set ON. DIG1 is maintained
ON until the error falls below 15. At this point, the DIG1 output begins and continues coarse
pulsing until the error is below 12. Once this occurs, the DIG1 output begins and continues fine
pulsing until the error is below 8. When this occurs, DIG1 is set OFF. Please note that the
converse of the above definitions are TRUE when the error is below 0.

In general, X3STEP turns off both its digital outputs when it detects errors in configuration or
operation. They remain OFF until the error conditions clear. Also, when errors occur on input IN2,
OUT is not updated but retains its last valid value.

OW360_R1100 661
5.148 X3STEP

The digital outputs are both set OFF (DIGI1 = 0 and DIGI2 = 0) under any of the following
conditions:
 The IN1 input has BAD quality, is an invalid real number, or is not being updated across the
Ovation network.
 The IN2 input has BAD quality, is an invalid real number, or is not being updated across the
Ovation network.
 The digital input DEVO (Operational Status of Device) is set indicating that there is a problem
with the device.
 The error is zero or below FNE1 for DIG1. The error is zero or above FNE2 for DIG2.
 An on time span of 0 or less is invalid. This invalid configuration is reported by setting the
quality of OUT to BAD and setting bit 3 of its 1W field. This error is reported at runtime.
 The algorithm has been incorrectly configured by setting ON1, COR1, FNE1, or ON2, COR2,
and FNE2 all to zero. This invalid configuration is reported by setting the quality of OUT to
BAD and bit 3 of its 1W field. This error is reported at runtime. The outputs are set to 0 for one
execution loop under any of the following conditions:
 The Controller is reset (hardware or software reset).
 A failover occurs.
 The algorithm is modified and downloaded.

Tracking Signals

This algorithm ignores the TRIN tracking signals. During first pass after a reset, or failover, and
anytime the DEVO digital is TRUE, Bit 16 of TOUT is set TRUE causing the upstream algorithm
to track OUT. Bit 16 of TOUT is set FALSE at all other times.

Bits 20 and 31 of TOUT are set ON when the IN2 value reaches 100 percent or greater. This
indicates the algorithm has reached the High Limit and requests the upstream algorithm to inhibit
raising the output.

Bits 19 and 30 of TOUT are set ON when the IN2 value reaches 0 percent or less. This indicates
that the algorithm has reached the Low Limit and requests the upstream algorithm to inhibit
lowering the output. All other bits (17-18 and 21-29) of TOUT are not used.

The TOUT value output is set equal to OUT and its quality is always set to GOOD.

Algorithm Configurations
 To maintain the digital outputs ON at all times when the error is not zero, the settings
presented in the following tables are required:

DIG1 is ON all time, coarse and fine pulsing is eliminated

DIG1 ERROR FNE1 COR1 ON1

ON >0 0 0 >0 (close to zero)

Example for DIG1 is ON all time, coarse and fine pulsing is eliminated

DIG1 ERROR FNE1 COR1 ON1

ON 0.1 0 0 0.00001

662 OW360_R1100
 5.148 X3STEP

ON all time, coarse and fine pulsing is eliminated

DIG2 ERROR FNE2 COR2 ON2

ON <0 0 0 0 (close to zero)

Example for DIG2 is ON all time, coarse and fine pulsing is eliminated

DIG1 ERROR FNE1 COR1 ON1

ON -0.1 0 0 -0.00001

 To eliminate coarse pulsing of a digital the settings presented below in the tables are
required.
If the error is initially above ON1 (or below ON2), the digital remains ON until the error falls below
ON1 (or above ON2). When this occurs and COR1 (or COR2) equals zero, coarse pulsing is
ignored and fine pulsing begins. Fine pulsing continues until the error falls below FNE1 (or above
FNE2). At this point the digital is maintained OFF.

DIG1 is ON or fine pulsing (coarse pulsing is eliminated)

DIG1 ERROR FNE1 COR1 ON1

ON >ON1 <ON1 0 >FNE1

Fine pulsing >FNE1 and <ON1 <ON1 0 >FNE1
OFF >0 and <FNE1 <ON1 0 >FNE1

Example DIG1 is ON or fine pulsing (coarse pulsing is eliminated)

DIG1 ERROR FNE1 COR1 ON1

ON 11 2 0 10
Fine pulsing 5 2 0 10
OFF 1 2 0 10

DIG2 is ON or fine pulsing (coarse pulsing is eliminated)

DIG2 ERROR FNE2 COR2 ON2

ON <ON2 >ON2 0 <FNE2

Fine pulsing >ON2 and <FNE2 >ON2 0 <FNE2
OFF <FNE2 and <0 >ON2 0 <FNE2

OW360_R1100 663
5.148 X3STEP

Example DIG2 is ON or fine pulsing (coarse pulsing is eliminated)

DIG2 ERROR FNE2 COR2 ON2

ON -11 -2 0 -10
Fine pulsing -5 -2 0 -10
OFF -1 -2 0 -10

 To eliminate fine pulsing of a digital the settings presented below in the tables are required.
If the error is initially above ON1 (or below ON2), the digital remains ON until the error falls below
ON1 (or above ON2). At this point, coarse pulsing begins and is maintained until the error falls
below COR1 (or above COR2). When this occurs and FNE1 (or FNE2) equals zero, fine pulsing is
ignored and the digital is maintained OFF.

DIG1 is ON or coarse pulsing (fine pulsing is eliminated)

DIG1 ERROR FNE1 COR1 ON1

ON >ON1 0 <ON1 >COR1

Coarse pulsing >COR1 and <ON1 0 <ON1 >COR1
OFF >0 and <COR1 0 <ON1 >COR1

Example DIG1 is ON or coarse pulsing (fine pulsing is eliminated)

DIG1 ERROR FNE1 COR1 ON1

ON 11 0 2 10
Coarse pulsing 5 0 2 10
OFF 1 0 2 10

DIG2 is ON or coarse pulsing (fine pulsing is eliminated)

DIG2 ERROR FNE2 COR2 ON2

ON <ON2 0 >ON2 <COR2

Coarse pulsing >ON2 and <COR2 0 >ON2 <COR2

OFF >COR2 and <0 0 >ON2 <COR2

Example DIG2 is ON or coarse pulsing (fine pulsing is eliminated)

DIG2 ERROR FNE2 COR2 ON2

ON -11 0 -2 -10
Coarse pulsing -5 0 -2 -10
OFF -1 0 -2 -10

664 OW360_R1100
 5.148 X3STEP

 To eliminate maintaining the digital outputs ON steady when the error is not zero, the settings
presented below in the tables are required.
Assumes a non-zero value for COR1, COR2, FNE1, or FNE2. If the error is initially above COR1
(or below COR2), the digital is pulsed coarsely until the error falls below COR1 (or above COR2).
When this occurs, fine pulsing begins and continues until the error falls below FNE1 (or above
FNE2). At this point the digital is maintained OFF.

DIG1 is coarse or fine pulsing (ON state is eliminated)

DIG1 ERROR FNE1 COR1 ON1

Coarse pulsing >COR1 <COR1 >FNE1 0

Fine pulsing >FNE1 and <COR1 >FNE1 0
<COR1
OFF >0 and <FNE1 <COR1 >FNE1 0

Example DIG1 is coarse or fine pulsing (ON state is eliminated)

DIG1 ERROR FNE1 COR1 ON1

Coarse pulsing 11 2 5 0
Fine pulsing 3 2 5 0
OFF 1 2 5 0

DIG2 is coarse or fine pulsing (ON state is eliminated)

DIG1 ERROR FNE2 COR2 ON2

Coarse pulsing <COR2 <COR2 >FNE2 0

Fine pulsing >COR2 and <COR2 >FNE2 0
<FNE2
OFF >FNE2 and <0 <COR2 >FNE2 0

Example DIG2 is coarse or fine pulsing (ON state is eliminated)

DIG2 ERROR FNE2 COR2 ON2

Coarse pulsing -11 -2 -5 0

Fine pulsing -3 -2 -5 0
OFF -1 -2 -5 0

OW360_R1100 665
5.148 X3STEP

 The ON and OFF times for the coarse and fine pulses are determined from the user-entered
off-time and on-time span tuning fields.
 OUT is assigned the value of IN2, where IN2 is the position feedback of device defined and
should be defined in range 0-100 percent.
 If IN2 is less than zero, OUT is assigned a value of zero. If IN2 is greater than 100, OUT
is assigned a value of 100. Otherwise, OUT is assigned the value of IN2.
 If IN2 has BAD quality, or is an invalid real number, OUT retains its last valid value and its
quality is set to BAD.

The quality of OUT and its 1W field report algorithm error conditions are described below:

Quality

OUT QUALITY 1W BIT SET DESCRIPTION

GOOD NONE Normal .

BAD NONE The position feedback IN2 has BAD quality.

BAD Bit 3 Invalid configuration has been entered. BAD parameter

(ON1, COR1, FNE1, ON2, COR2, FNE2) or time span
(CTM1, FTM1, CTM2, FTM2) or on-time/off-time (FDY1,
FDY2, CDY1, CDY2).

Tuning Constants
 For proper operation, ON2 < COR2 and COR1 < ON1, if any of ON2, COR2, COR1 and ON2
have non-zero values. The algorithm does not check for this invalid configuration and
algorithm results may be improper for the wrong configuration.
 For proper operation, COR2 < FNE2 and FNE1 < COR1, if any of COR2, FNE2, FNE1 and
COR1 have non-zero values. The algorithm does not check for this invalid configuration and
algorithm results may be improper for the wrong configuration.
 Set CTM1, CTM2, FTM1, FTM2 (time spans for pulsing) in multiples of the control task’s loop
time.
If CTM1, CTM2, FTM1, and FTM2 and the accompanying ON and OFF times that are less
than one loop time, the algorithm assumes those times are equal to one loop time.

Algorithm Record Type = LC

Algorithm definitions

NAME LC TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

ALGORITHM OPTIONAL VALUE PT.
RECORD REC.
FIELD

DIAG LU-Integer Data Init. Required 58 Tuning diagram. —

ON1 T9-Real Tuning Required 10 Steady ON limit (number —

Constant of error above 0 at which
DIG1 turns ON).

COR1 S1-Real Tuning Required 5 Coarse ON limit (number —

Constant of error above 0 at which
DIG1 begins coarse
pulsing).

666 OW360_R1100
 5.148 X3STEP

NAME LC TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

ALGORITHM OPTIONAL VALUE PT.
RECORD REC.
FIELD

FNE1 T1-Real Tuning Required 2 Fine ON limit (number of —

Constant error above 0 at which
DIG1 begins fine
pulsing).
ON2 U1-Real Tuning Required -10 Steady ON limit (number —
Constant of error below 0 at which
DIG2 turns ON).

COR2 S2-Real Tuning Required -5 Coarse ON limit (number —

Constant of error below 0 at which
DIG2 begins coarse
pulsing).

FNE2 T2-Real Tuning Required -2 Fine ON limit (number of —

Constant error below 0 at which
DIG2 begins fine
pulsing).
CTM1 S6-Real Tuning Required 2000 Coarse on-time span in —
Constant millisecond for DIG1.

CDY1 S7-Real Tuning Required 2000 Coarse off-time span in —

Constant millisecond for DIG1.

CTM2 S8-Real Tuning Required 2000 Coarse on-time span in —

Constant millisecond for DIG2.

CDY2 S9-Real Tuning Required 2000 Coarse off-time span in —

Constant millisecond for DIG2.

FTM1 T4-Real Tuning Required 1000 Fine on-time span in —

Constant millisecond for DIG1.

FDY1 T5-Real Tuning Required 1000 Fine off-time span in —

Constant millisecond for DIG1.

FTM2 T6-Real Tuning Required 1000 Fine on-time span in —

Constant millisecond for DIG2.

FDY2 T7-Real Tuning Required 1000 Fine off-time span in —

Constant millisecond for DIG2.

IN1 — Variable Required — Analog input – it is the LA

demand value for the
device defined in range
0-100%.
IN2 — Variable Required — Analog input – it is the LA
feedback value from the
device defined in range
0-100%.

OW360_R1100 667
5.148 X3STEP

NAME LC TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

ALGORITHM OPTIONAL VALUE PT.
RECORD REC.
FIELD

TOUT — Variable Required — Analog output - track LA

output value.
Bit 16 is set TRUE during
the first pass and when
DEVO input is TRUE.
Typically used for
initialize upstream PID
algorithm to accomplish
bumpless transfer.
Bit 19 and 30 indicate
POS is at low limit.
Bit 20 and 31 indicate
POS is at high limit.
Contains the value of the
position feedback signal.
The quality of TOUT is
always GOOD; sensor
errors are not reported.
Used to initialize
upstream PID algorithms
with bump transfer.
DEVO — Variable Optional — Packed Input - Bit 0 LP
indicates the operational
state of the device
where:
 0 = operational
 1=
non-operational
OUT — Variable Required — Analog output – it LA
contains the value of the
position feedback signal
IN2. The quality and IN
field of OUT are used to
report error conditions.
TRIN — Variable Optional — Analog input - tracking LA
and limiting mode.
Signals, tracking value,
and analog input
variable.
DIG1 — Variable Required — Digital output1. LD

DIG2 — Variable Required — Digital output2. LD

668 OW360_R1100
 5.149 2XSELECT

5.149 2XSELECT
Description

The 2XSELECT algorithm monitors two analog transmitter inputs for quality and deviation from
each other. The output is either one of the two input values; the higher value, the lower value, or
the average of the two values, depending on the mode selected. You select the mode using the
use of the TMOD and MODE tracking inputs, the Operator’s Keyboard function keys, or the
Control Builder.

Functional symbol

The Control Indicator Word is used to specify which of the Average, Lower and Higher modes are
inhibited, and the type of quality of the input that sets the Quality Alarm for that point. The
Average, Lower, and Higher modes cannot be selected if they are inhibited by the Control
Indicator Word, or when either of the transmitters is in Quality Alarm, or when the deviation
between the two transmitter values is greater than the Control Deviation Deadband tuning
constant (CNDB).
The Transmitter A mode cannot be selected when Transmitter A is in Quality Alarm and
Transmitter B is not in Quality Alarm. The algorithm goes to Transmitter A mode when both
transmitters are in Quality Alarm, or when Transmitter B is in Quality Alarm. The Transmitter B
mode cannot be selected when Transmitter B is in Quality Alarm. The algorithm goes to
Transmitter B mode when Transmitter A is in Quality Alarm and Transmitter B is not in Quality
Alarm.

OW360_R1100 669
5.149 2XSELECT

On the first pass of the algorithm, if the Tracking Input (MODE) is initialized by the user, the mode
is set according to the rounded value of the tracking input as follows:

Modes

MODE VALUE MODE SELECTED

1 Average
2 Lower
3 Higher
4 Transmitter A
5 Transmitter B

If the rounded value of the tracking input is not 1 through 5, or if the tracking input was not
initialized, the mode is set to Average mode. If the mode selected on the first pass is inhibited, or
if it is blocked by a Quality Alarm or a Deviation Alarm, as described above, the mode is set to the
next lowest priority mode (where the Average mode has the highest priority and Transmitter B
mode has the lowest priority) until a mode is selected that is not inhibited or blocked. If both
transmitters are in Quality Alarm, the output of the algorithm latches onto the last good value and
the mode is set to the Transmitter A mode.

If the Tracking Mode Request digital input (TMOD) is initialized, the mode is set according to the
rounded value of the tracking input and the above table when the Tracking Mode Request signal
is TRUE and there are no Quality Alarms. The mode remains unchanged if the rounded value of
the tracking input is not 1 through 5 when the Tracking Mode Request signal is TRUE.

You may select a different mode by using the function keys on the Operator’s Keyboard when the
Tracking Mode Request signal is FALSE. The value of the analog output (OUT) is according to
the mode of the algorithm:

Modes

MODE OUTPUT VALUE

Average Average value of the two transmitter input values.

Lower Lower value of the two transmitter input values.
Higher Higher value of the two transmitter input values.
Transmitter A Value of Transmitter A.

Transmitter B Value of Transmitter B.

The Transmitter Deviation Alarm digital output (XDEV) is set TRUE when the deviation between
the two transmitter values is greater than the Alarm Deviation Deadband tuning constant (ALDB),
or when one or both transmitters contain invalid real numbers.

The Transmitter A Quality Alarm digital output (XABQ) is set TRUE when the quality of the
Transmitter A analog input goes BAD or NOT GOOD, depending on the Quality Alarm Type flag.
The Transmitter B Quality Alarm digital output (XBBQ) is set TRUE when the quality of the
Transmitter B analog input point goes BAD or NOT GOOD, depending on the Quality Alarm Type
flag.

670 OW360_R1100
 5.149 2XSELECT

The Transmitter Malfunction Alarm digital output (XALM) is set TRUE when there is a Quality
Alarm on either of the two signals, when one or both input points contain invalid values, or when
the deviation between the two transmitter values is greater than the Control Deviation Deadband
tuning constant (CNDB).

The Manual Reject digital output (MRE) is set TRUE when both transmitters are in Quality Alarm,
or when the deviation between the two transmitter values is greater than the Control Deviation
Deadband tuning constant (CNDB). The P3 function key on the Operator’s Keyboard toggles the
inhibiting of the deviation check. For example, by pressing the P3 function key on the Operator’s
Keyboard, the Manual Reject output is only set TRUE when both transmitters are in Quality
Alarm. Then, by pressing the P3 function key again, the Manual Reject output is set TRUE when
both transmitters are in Quality Alarm or when the deviation is too large.

The packed digital output signal (PBPT) contains the Quality Alarms for both transmitters, the
Manual Reject output, the Transmitter Malfunction Alarm, the Tracking Request signal, the mode
of the algorithm, and the state of the Inhibit Control Deviation Alarm Check for the MRE digital
output feature.

The HOLD parameter holds the output value and quality for a desired number of loops when a
manual reject occurs.

Note: The information in the packed digital output signal is also stored in the B7 field of the
algorithm record.

When using the RATE or DBNB parameters, the following apply:

 2XSELECT ramps at the user-entered rate (specified in Units/Sec. via the RATE template
parameter) during mode changes. If no entry is made in the RATE parameter or a value of 0
is entered, 2XSELECT changes its output value to the new value during mode changes.
 2XSELECT returns from a deviation (XDEV) condition (that is, when the absolute difference
between the XA and XB inputs is greater than the ALDB parameter) only when absolute
difference between the XA and XB inputs return to a value which is less than or equal to
Alarm Limit Deadband (ALDB) minus DBND. If no entry is made in the DBND parameter or a
value of 0 is entered, 2XSELECT returns from an XDEV condition.
 2XSELECT returns from a CNDB condition (that is, when the absolute difference between the
XA and XB inputs is greater than the CNDB parameter) only when absolute difference
between the XA and XB inputs return to a value which is less than or equal to CNDB minus
DBND. If no entry is made in the DBND parameter or a value of 0 is entered, 2XSELECT
returns from a CNDB condition.

OW360_R1100 671
5.149 2XSELECT

The interface keys on the Operator’s Keyboard are:

Function keys

FUNCTION KEY USE

P1 Transmitter A mode request.

P2 Transmitter B mode request.
P3 Toggle the inhibiting of the Control Deviation Alarm check on
the manual reject (MRE) output.
P4 Average mode request.
P5 Lower mode request.
P6 Higher mode request.

Invalid Numbers and Quality

The transmitter input values to the algorithm are checked for invalid real numbers. If a transmitter
contains an invalid value, its Quality Alarm digital output is set TRUE.

If both transmitters are in Quality Alarm, or contain invalid values, the value of the algorithm
output (OUT) quality is set to BAD.

If the algorithm calculates an invalid real number for the output, the quality of the output is set to
BAD and the output value is invalid.

INSEL parameter

The INSEL parameter determines which inputs of the 2XSELECT algorithm are being used to
calculate the output. The Signal Diagram application displays green circles around the active pins.
If none of the pins are selected, then nothing will display. You can also view this information via
the Process Diagram System graphics as well. Refer to Ovation Operator Station User Guide for
more information on the Signal Diagrams application and the Process Diagram System graphics.

The 2XSELECT algorithm activates individual bits in the Y0 field depending on the conditions in
the description field. If a signal is active, that signal is being used in the output calculation.

672 OW360_R1100
 5.149 2XSELECT

Algorithm Record Type = LC

Algorithm definitions

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DIAG LU-Integer Tuning Required 99 Tuning diagram —

Constant number.

MODE — Selectable Optional — Input (analog); LA

tracks the algorithm
to a mode on first
pass and when
TMOD is TRUE.
This point must be
initialized if the
TMOD point is
initialized.
TMOD — Variable Optional — Input (digital); LD, LP
request to track the
mode to the value
of MODE. If this
point is initialized,
the MODE point
must also be
initialized.
CNTL G0-Integer Data Init. Optional 0 Control Indicator —
Word (bit and
description):
 0 - Average
Selection
(0 = Not allowed
1 = Allowed)
 1 - Lower
Selection
(0 = Not allowed
1 = Allowed)
 2 - Higher
Selection
(0 = Not allowed
1 = Allowed)
 3 - Quality Alarm
Type
(0 = BAD Quality
Alarm
1 = NOT GOOD
Quality Alarm)
ALDB R1-Real Tuning Required 0.0 Alarm Deviation —
Constant Deadband.

CNDB R2-Real Tuning Required 0.0 Control Deviation —

Constant Deadband.

RATE R3-Real Tuning Optional 0.0 Ramping rate —

Constant parameter.

OW360_R1100 673
5.149 2XSELECT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

DBND R4-Real Tuning Optional 0.0 Deadband delta —

Constant parameter.

HOLD X7-Byte Data Init Required 0 Hold output during —

manual reject.

XA — Variable Required — Input (analog); LA

Transmitter A.
XB — Variable Required — Input (analog); LA
Transmitter B.
XDEV — Variable Optional — Output (digital); LD, LP
Transmitter Alarm
Deviation signal.
XABQ — Variable Optional — Output (digital); LD, LP
Quality Alarm for
Transmitter A.
XBBQ — Variable Optional — Output (digital); LD, LP
Quality Alarm for
Transmitter B.
XALM — Variable Optional — Output (digital); LD, LP
Transmitter
Malfunction Alarm.
MRE — Variable Optional — Output (digital); LD, LP
Manual Reject
signal.
OUT — Variable Required — Output (analog). LA

674 OW360_R1100
 5.149 2XSELECT

NAME LC ALG. TYPE REQUIRED/ DEFAULT DESCRIPTION MIN.

RECORD OPTIONAL VALUE POINT
FIELD REC.

PBPT — Variable Optional — Output (packed LP

digital) (bit and
description):
 0 - Manual Reject
Output signal.
 1 - Transmitter
Malfunction
Alarm.
 2 - Inhibit Control
Deviation Check
for MRE output.
 3 - Quality Alarm
for
Transmitter A.
 4 - Quality Alarm
for
Transmitter B.
 5 - Mode
selection being
made by TMOD.
 6 - Transmitter
Alarm
Deviation signal.
 7 - Average
mode.
 8 - Lower mode.
 9 - Higher mode.
 10 - Transmitter A
mode.
 11 - Transmitter B
mode.
INSEL* Y0 Alg. Init. Required 0 Input Selected: --
Bit 1 - Signal A
 0 = Not Active
 1 = Active
Bit 2 - Signal B
 0 = Not Active
 1 = Active
* If no inputs are selected, it indicates one of the following:
 the inputs are all BAD quality.
 the output is scan removed.
 Manual Reject is activated with HOLD.
 the calculated output is invalid.

OW360_R1100 675
Index

Command Register 10 points (outputs) • 640

2 COMPARATOR • 144
2XSELECT • 670 COMPARE • 146
Computing the integral component of the PI
A algorithm • 638
Controller faults for Safety Shell • 528
AAFLIPFLOP • 54
Copyright Notice • 2
ABSVALUE • 56
Correction Gain • 224
Alarm Manipulation algorithms • 23
COSINE • 147
ALARMLIMIT • 57
COUNTER • 148
ALARMMON • 62
Custom Calculation algorithms • 25
ALGFIELD • 64
ALGFIELD functions • 66 D
Algorithm classification groups • 22
Algorithm classifications • 21 DBEQUALS • 150
Algorithm definitions • 67, 353, 403 Detecting feedback position deviation • 636
Algorithm functional symbols • 9, 53 Determining and displaying the state of each
Algorithm status and mode settings • 4 module • 637
Algorithms • 1 Determining hardware addressing • 3
Algorithms that support tracking • 14 DEVICE • 152
ANALOG DEVICE (ADEVICE) • 77 Device Control algorithms • 26
ANALOGDRUM • 80 DEVICESEQ • 170
AND • 84 DEVICEX • 174
ANNUNCIATOR • 85 DFIELD • 192
ANTILOG • 88 DIGCOUNT • 193
ARCCOSINE • 90 DIGDRUM • 195
ARCSINE • 91 DIGITAL DEVICE • 201
ARCTANGENT • 92 DISTRIBUTOR • 220
Artificial I/O algorithms (signal generators) • Distributor Algorithm Definitions • 233
23 Distributor replaces Balancer • 232
ASSIGN • 93 DIVIDE • 243
ATREND • 94 DROPSTATUS • 272
AVALGEN • 96 DRPI1A • 247
DVALGEN • 249
B DXCSTATUS • 250
DXCSTATUS functions • 268
BALANCER • 97
DXCSTATUS state • 270
Base Gain • 226
DXCSTATUS tuning parameters and site
BCDNIN • 103
ratings • 267
BCDNOUT • 105
Behavior on the limits • 350 E
BILLFLOW • 107
Binary to hexadecimal conversion • 6 ELCCONTROL • 275
Boolean Algorithms with Quality Propagation Error conditions • 67
• 109 Error information • 6
Boolean Logic algorithms • 24 Example - Reading the ID number of the
Boolean Logic Memory algorithms • 25 currently executed ScStep algorithm • 71
BUFFER • 116 Example - Reading the PID algorithm
parameter • 68
C Example - Reading the STABLE97 AUX LC
Record Field from the ALGFIELD
CALCBLOCK • 129
algorithm • 74
CALCBLOCKD • 138
Exclusion (EXCL) • 222

OW360_R1100 677
Index

LOSELECT • 357
F LOWMON • 362
FACEPLATE • 278
M
FACEPLATE -- DIGITAL DEVICE template •
282 MAMODE • 363
FACEPLATE -- MASTATION template • 285 MASTATION • 366
FIELD • 287 MASTERSEQ • 376
Fieldbus algorithms • 27 Mathematical and Statistical algorithms • 32
FIFO • 289 MEDIANSEL • 389
Filtering algorithms • 28 Migrated special function algorithms • 33
First Pass Startup Options • 231 Modulating Control algorithms • 34
FIRSTOUT • 291 Module Reboot • 643
FLIPFLOP • 296 Monitor Function algorithms • 35
FUNCTION • 298 Monitoring the health of each Valve
Functions • 402 Positioner module • 636
MOTOR (Simple Controlled Motor) • 206
G MOTOR 2-SPD (Two Speed or
GAINBIAS • 302 Bi-Directional Controlled Motor) • 209
GASFLOW • 306 MOTOR 4-SPD (Two Speed and
General algorithm user information • 3 Bi-Directional Controlled Motor) • 212
MOTOR NC (Non-Controlled Motor) • 204
H MULTIPLY • 397
MULTISWITCH • 400
Hardware addressing • 3
Hardware Interface algorithms • 29 N
HEARTBEAT • 313
HIGHLOWMON • 316 NLOG • 405
HIGHMON • 317 NOT • 406
HISELECT • 319
O
HSCLTP • 324
HSLT • 325 OFFDELAY • 407
HSTVSVP • 326 ONDELAY • 409
HSVSSTP • 327 ONESHOT • 411
Operations • 349
I Operator Interface algorithms • 36
Input, FNUM parameter, and Output pins OR • 415
(IN, FNUM, and OUT[1-8]) • 221 Output points quality • 66
Integral term scaling • 640
P
Internal and External Control • 228
INTERP • 328 PACK16 • 416
Introduction to the Ovation standard PERSISVAL • 418
algorithms • 1 PID • 420
Invalid number checking and quality PIDFF • 435
checking • 5 PNTSTATUS • 447
Point Format Conversion algorithms • 37
K Point Quality • 231, 352
KEYBOARD • 332 POLYNOMIAL • 449
PREDICTOR • 451
L PRIORITY • 455
PRIORITY Algorithm Package • 455
LATCHQUAL • 335
Priority Deadband (PDB) • 225
LEADLAG • 337
PRIORITY-EXT • 471
LEVELCOMP • 341
PRIORITY-REJ • 476
Link Controller Module Interface algorithms •
Propagated point quality • 4
30
Proportional term scaling • 639
LOG • 345
PSLT • 479
LONGACC • 346
PSVS • 480
Loop Interface Module algorithms • 31

678 OW360_R1100
 Index

Pulse Accumulator Module Interface SOFTSOE • 561

algorithms • 38 SPTOSA • 571
PULSECNT • 481 SQUAREROOT • 572
SS_STATUS • 526
Q SSLT • 575
QAND • 109 Standard algorithm reference pages • 49
QAVERAGE • 482 STATISTICS • 576
Q-Line Interface algorithms • 39 Status of LONGACC algorithm during an
QNOT • 113 error • 351
QOR • 111 Status Register 1 points (inputs) • 640
QUALITYMON • 483 STEAMFLOW • 593
QXOR • 114 STEAMTABLE • 595
STEPTIME • 598
R SUM • 604
Summary of Changes • 3
RAMPGEN • 484
Switching Between Internal and External
RATECHANGE • 488
Inputs • 229
RATELIMIT • 490
Synchronized calibration • 641
RATEMON • 494
System Diagnostic algorithms • 44
Redundant Signal Processing algorithms •
System Time Function algorithms • 44
38
SYSTEMTIME • 608
Reset Failure flags • 643
RESETSUM • 496 T
RLICONFIG • 499
RPACNT • 503 TANGENT • 609
RPAWIDTH • 504 Time/Counter Function algorithms • 45
RSRSTATUS • 505 TIMECHANGE • 610
RUNAVERAGE • 515 TIMEDETECT • 611
RUNTIME • 517 TIMEMON • 612
RVPSTATUS • 523 Tracking • 11
Tracking (best practices) • 13
S Tracking (purpose of) • 12
Tracking algorithms • 46
Safety Instrumented System (SIS)
Tracking examples • 16
algorithms • 40
Tracking Inputs (TKIN[1-8]) • 223
SAMPLER (Controlled Sampler) • 202
Tracking Out (TOUT) • 227
SATOSP • 529
Tracking process • 13
Scaling output voltage for bumpless control •
TRANSFER • 615
639
TRANSLATOR • 623
SELECTOR • 530
TRANSPORT • 628
Sequential Logic algorithms • 42
TRNSFINDX • 630
SETPOINT • 532
TRUTHTBL • 631
Setting tracking signals • 17
TRVP • 634
SID storage • 353
TRVP Algorithm Definitions • 644
SID Storage • 231
TRVP configuration • 635
Signal Compensation algorithms • 43
TRVPTUNE • 647
Signal quality • 643
TSLH • 654
SIMTIME • 536
TSLP • 655
SINE • 536
Turbine Interface algorithms • 47
Single precision floating point numbers • 6
SLCAIN • 537 U
SLCAOUT • 540
SLCDIN • 543 Understanding algorithm descriptions • 7, 52
SLCDOUT • 546 Understanding tracking • 11
SLCPIN • 549 UNPACK16 • 656
SLCPOUT • 552
V
SLCSTATUS • 555
SMOOTH • 559 VALVE (Controlled Valve) • 217

OW360_R1100 679
Index

VALVE NC (Non-Controlled Valve) • 203

VCLTP • 658
VSLT • 659
X
X3STEP • 661
XOR • 660

680 OW360_R1100