You are on page 1of 678

AdvaBuild®

Configurable Control Functions (CCF)


User Guide
Version 3.7

Power and productivity


for a better world TM
AdvaBuild®
Configurable Control Functions (CCF)
User Guide

Version 3.7
NOTICE
This document contains information about one or more ABB products and may include a
description of or a reference to one or more standards that may be generally relevant to
the ABB products. The presence of any such description of a standard or reference to a
standard is not a representation that all of the ABB products referenced in this document
support all of the features of the described or referenced standard. In order to determine
the specific features supported by a particular ABB product, the reader should consult the
product specifications for the particular ABB product.

ABB may have one or more patents or pending patent applications protecting the intel-
lectual property in the ABB products described in this document.

The information in this document is subject to change without notice and should not be
construed as a commitment by ABB. ABB assumes no responsibility for any errors that
may appear in this document.

In no event shall ABB be liable for direct, indirect, special, incidental or consequential
damages of any nature or kind arising from the use of this document, nor shall ABB be
liable for incidental or consequential damages arising from use of any software or hard-
ware described in this document.

This document and parts thereof must not be reproduced or copied without written per-
mission from ABB, and the contents thereof must not be imparted to a third party nor used
for any unauthorized purpose.

The software or hardware described in this document is furnished under a license and
may be used, copied, or disclosed only in accordance with the terms of such license. This
product meets the requirements specified in EMC Directive 2004/108/EEC and in Low
Voltage Directive 2006/95/EEC.

TRADEMARKS
All rights to copyrights, registered trademarks, and trademarks reside with their respec-
tive owners.

Copyright © 2001-2014 by ABB.


All rights reserved.

Release: June 2014


Document number: 3BUR002336R3701 RevA
TABLE OF CONTENTS

Section 1 - Introduction
General Information ........................................................................................................47
Scope Of This Manual.....................................................................................................48
Organization Of This Manual..........................................................................................48
Related Documentation ...................................................................................................49
Configuration Templet Displays......................................................................................50
ENABLE HI ALARMS? Field ...........................................................51
HI LIMIT Field ...................................................................................51
Descriptions Of The Templet Fields................................................................................51
Entering Floating Point Values in Exponential Format........................................52
Multibus-based Configurator ..............................................................52
AdvaBuild Template Builder (HP-UX) and AdvaBuild Templet Builder
(Windows) ....................................................................52
Templet Names.....................................................................................................53

Section 2 - CCF Software Structure


General Information ........................................................................................................55
Loop Structure .................................................................................................................57
Loop Attributes ....................................................................................................57
Function Class Modules (FCMs).....................................................................................59
FCM Attributes ....................................................................................................62
Alarm Detection By Loops..............................................................................................64
Alarm And Event Logging ..............................................................................................64
Operator Interface............................................................................................................65
Major Functions ...................................................................................................65
Area and Group Displays .....................................................................................66

3BUR002336R3701 RevA 5
Table of Contents

Other Software Packages ................................................................................................ 66

Section 3 - How to Configure Subsystems to Support CCF


General Information ........................................................................................................ 69
CCF In Advant Controllers ............................................................................................. 69
CCF In 6000-series and SC Controller Subsystems ....................................................... 69
Controller Subsystem Templet ........................................................................................ 71
TEMPLET NAME Field .................................................................... 71
PARENT NAME Field ....................................................................... 71
PHYSICAL DEVICE Field ................................................................ 71
REDUNDANCY OPTION Field........................................................ 72
Controller Templet .......................................................................................................... 73
TEMPLET NAME Field .................................................................... 73
PARENT NAME Field ....................................................................... 73
PHYSICAL DEVICE Field ................................................................ 74
SOFTWARE NAME Field ................................................................. 74
AUTO START Field ........................................................................... 76
BACKUP ON STARTUP Field .......................................................... 76
MAX DATA BASE SIZE Field.......................................................... 76
DO RATE Field .................................................................................. 77
Controller I/O Templet .................................................................................................... 78
ICI 1 through 8 STATUS Fields.......................................................... 79
DIGITALS 1 through 40 Fields .......................................................... 79
OUTPUT FAILOVER OPT Field ...................................................... 79
PO CHANNEL NUMBER, PULSE INTERVAL, and PULSE WIDTH
Fields ............................................................................ 80
Controller Digital Input and Output Channels..................................................... 82
Controller Analog Input and Output Channels .................................................... 83
Considerations for Analog Inputs ....................................................... 83
Analog Inputs for a Controller............................................................ 84
Millivolt Inputs for a Controller ......................................................... 88
Thermocouple Inputs for a Controller ................................................ 90
RTD Inputs for a Controller................................................................ 93

6 3BUR002336R3701 RevA
Table of Contents

Pulse Inputs for a Controller ...............................................................97


Backup Controller Templet .............................................................................................99
TEMPLET NAME Field.....................................................................99
TEMPLET TYPE, PARENT NAME, and DATABASE NAME Fields99
PHYSICAL DEVICE Field ..............................................................100
SOFTWARE NAME Field................................................................100
Smart I/O Templets........................................................................................................102
Smart I/O Templet..............................................................................................102
TEMPLET NAME Field...................................................................103
TEMPLET TYPE, PARENT NAME, and DATABASE NAME Fields103
PORT NAME Field...........................................................................103
Smart I/O Network Templet...............................................................................104
TEMPLET NAME Field...................................................................104
PARENT NAME Field......................................................................105
NETWORK ADDRESS Field ..........................................................105
SMART TAG, SMART ADDRESS, CHANNEL and DESCRIPTION
Fields ..........................................................................105
CCF in Turbo Nodes......................................................................................................106
Generic DPSS Templet.......................................................................................108
TEMPLET NAME Field...................................................................108
PARENT NAME Field......................................................................109
PHYSICAL DEVICE Field ..............................................................109
AUTO START Field .........................................................................109
SOFTWARE NAME Field................................................................109
DO RATE Field.................................................................................110
SECONDARY DP Field ...................................................................110
BACKUP ENABLE Field.................................................................110
BACKUP OVERRIDE Field ............................................................ 111
DEFAULT ENVIRONMENT Field.................................................. 111
NODE TYPE .................................................................................... 111
Multibus I/O Templet ......................................................................................... 111
TEMPLET NAME Field...................................................................114

3BUR002336R3701 RevA 7
Table of Contents

PARENT NAME Fields.................................................................... 115


AO CARDS Field ............................................................................. 115
PULSE INPUT CARDS Field .......................................................... 115
RTD INPUT CARDS Field .............................................................. 115
THERMOCOUPLE CARDS Field .................................................. 115
AI CARD NUMBER and MASTER/SLAVE Fields........................ 116
TTL CARD # Field........................................................................... 116
AI DEFAULT CHAN GAIN Field ................................................... 117
AI CHANNEL and AI GAIN Fields ................................................ 117
PO CHANNEL NUMBER, PULSE INTERVAL, and PULSE WIDTH
Fields .......................................................................... 117
Analog Inputs in Multibus I/O Subsystems ....................................................... 118
Analog Outputs in Multibus I/O Subsystems .................................................... 124
Digital Inputs and Outputs in Multibus I/O Subsystems ................................... 125
Thermocouples in Multibus I/O Subsystems..................................................... 126
Thermocouple Inputs with Cold Junction Compensation................. 128
Thermocouples Inputs with Hot Junction Compensation................. 134
Millivolt and Voltage Inputs via 6102D Millivolt/Thermocouple Modules...... 137
RTDs in Multibus I/O Subsystems .................................................................... 139
Pulse Inputs in Multibus I/O Subsystems .......................................................... 144
Smart I/O Templets ....................................................................................................... 145
CCF Templet ................................................................................................................. 146
TEMPLET NAME Field .................................................................. 146
PARENT NAME Field ..................................................................... 146
BASERATE Field ............................................................................. 147
ALARM DEADBAND Field ........................................................... 147
INPUT FCM DEADBAND Field..................................................... 148
INPUT LIMITER DB Field.............................................................. 148
EXTERNAL DATA RATE Field...................................................... 148
CCF INIT Field................................................................................. 148
MAX SIM AT EXP Field ................................................................. 149

Section 4 - Defining Continuous Loops

8 3BUR002336R3701 RevA
Table of Contents

General Information ......................................................................................................151


Planning a Loop .................................................................................................152
Configurable Loop Features ..........................................................................................156
Loop Processing Rate.........................................................................................158
Measured Variable..............................................................................................160
Trend Graphs for the Measured Variable ...........................................................161
Unit Assignments ...............................................................................................162
Loop State ..........................................................................................................163
FCMs Belonging to the Loop.............................................................................163
Alarm Handling: Configuration, Detection, Posting, and Cutout ......................164
Types of Alarms Configured on Loop Definition Templet ...............165
Configuring an Alarm .......................................................................165
Sequence of Events When an Alarm is Detected..............................167
Alarm Suppression ............................................................................168
Alarm Posting....................................................................................168
Alarm Cutout ....................................................................................168
COMP MODE Feature......................................................................169
Watchdog Timer Feature ...................................................................171
Setting the Watchdog Timer..............................................................172
Loop Definition Templet ...............................................................................................174
TEMPLET NAME Field...................................................................176
....................................................................................176
LOOP DESCRIPTOR Field..............................................................176
PROCESSING RATE Field ..............................................................176
PROCESSING PHASE Field ...........................................................177
NAME OF MEASURED FCM Field ...............................................178
TREND RATE Field .........................................................................179
ORDER OF PROCESSING Field ....................................................179
LO ENG. UNIT LIMIT Field............................................................179
HI ENG. UNIT LIMIT Field .............................................................180
MEASUREMENT UNITS Field ......................................................180
LOOP STATE Field ..........................................................................180

3BUR002336R3701 RevA 9
Table of Contents

EXPORT Field .................................................................................. 181


SUPPRESS ALARMS Field ............................................................ 182
ENABLE POSTING Field................................................................ 182
ENABLE CUTOUT Field ................................................................ 183
CUTOUT SOURCE Field ................................................................ 183
CUTOUT STATE Field .................................................................... 183
ENABLE HI ALARMS? Field......................................................... 184
HI LIMIT Field ................................................................................. 184
HIGH ALARM PRIORITY Field .................................................... 184
ENABLE LO ALARMS? Field........................................................ 185
LO LIMIT Field................................................................................ 185
LO ALARM PRIORITY Field ......................................................... 186
BAD MEASURE ALARMS? Field ................................................. 186
BAD ALARM PRIORITY Field ...................................................... 186
ENABLE RATE ALARMS? Field ................................................... 187
RATE LIMIT Field ........................................................................... 187
RATE ALARM PRIORITY Field .................................................... 187
ENGU ALARM DEADBAND Field ............................................... 187
ENABLE HIHI ALARMS? Field..................................................... 188
HIHI LIMIT Field............................................................................. 188
HIHI ALARM PRIORITY Field ...................................................... 189
ENABLE LOLO ALARMS? Field .................................................. 189
LOLO LIMIT Field .......................................................................... 189
LOLO ALARM PRIORITY Field.................................................... 190
UNIT ID Field .................................................................................. 190
COMP MODE RESTRICT Field ..................................................... 190
ABNORMAL STATE Field.............................................................. 191
DMND PROCESSING MODE Field............................................... 192
# LOOPS TO PRESCAN Field ........................................................ 192
FCM LIST Edit Window .................................................................. 193
LOOPS TO PROCESS Fields .......................................................... 193
Non-configurable Loop Level Parameters .................................................................... 194

10 3BUR002336R3701 RevA
Table of Contents

DQ_MEAS - Data Quality of Measured Variable.............................194


DMD_SCAN - Demand Scan ...........................................................194
ERR_FCM Output FCM which has Failed .......................................194
MEAS_ALM - Measured Value Alarm Indicator .............................195
MROC_ALM - Measured Value Rate of Change Alarm Indicator ..195
Primary History Log......................................................................................................195
Primary History Log Configuration ...................................................................196
TEMPLET NAME Field...................................................................197
PARENT NAME Field......................................................................198
LOGGED ATTRIBUTE Field ..........................................................198
PRES RANGE MIN Field ................................................................198
PRES RANGE MAX Field ...............................................................198
STORAGE INTERVAL Field ...........................................................199
TIME OFFSET Field ........................................................................199
LOAD CAPACITY Field..................................................................199
LOG ALARMS Field........................................................................200
Changing Primary History Log Parameters .......................................................200
Adding and Deleting Primary History Logs ......................................................200

Section 5 - Input FCMS


General Information ......................................................................................................201
Analog Input FCM ........................................................................................................201
RTD, TC, OR HI-LEVEL Field ........................................................202
COUNTS - LOWER BOUND Field.................................................203
COUNTS - UPPER BOUND Field...................................................203
ENGU - LOWER BOUND Field......................................................204
ENGU - UPPER BOUND Field .......................................................204
INPUT LIMITED Field ....................................................................205
VENDOR TYPE Field ......................................................................205
LAN NUMBER Field .......................................................................206
BLOCK NUMBER Field ..................................................................206
CHANNEL NUMBER Field ............................................................207
CHANNEL PATH .............................................................................207

3BUR002336R3701 RevA 11
Table of Contents

INITIAL OUTPUT MODE Field ..................................................... 208


INITIAL OUTPUT Field.................................................................. 208
Configurable Features of the Analog Input FCM .............................................. 208
Analog Input Based on Input Type .................................................................... 211
Digital Input FCM......................................................................................................... 215
NUMBER OF POINTS Field ........................................................... 216
INVERTED INPUTS Field .............................................................. 216
VENDOR TYPE Field...................................................................... 217
LAN NUMBER Field ....................................................................... 217
BLOCK NUMBER Field.................................................................. 218
CHANNEL NUMBER Field ............................................................ 218
CHANNEL PATH............................................................................. 218
INITIAL MODE Field...................................................................... 219
INITIAL OUTPUT Field.................................................................. 219
Pulsed Input FCM ......................................................................................................... 220
INPUT TYPE Field .......................................................................... 221
COUNTS - LOWER BOUND Field ................................................ 221
COUNTS - UPPER BOUND Field .................................................. 222
ENGU - LOWER BOUND Field ..................................................... 222
ENGU - UPPER BOUND Field ....................................................... 222
VENDOR TYPE Field...................................................................... 222
LAN NUMBER Field ....................................................................... 223
BLOCK NUMBER Field.................................................................. 223
CHANNEL NUMBER Field ............................................................ 224
OUTPUT 1 or 2 ON/OFF PRESET Fields....................................... 224
INITIAL MODE Field...................................................................... 224
INITIAL OUTPUT Field.................................................................. 225
INPUT LIMITED Field .................................................................... 225
Pulse Input (PI) Time Derivative FCM......................................................................... 225
INPUT SOURCE Field..................................................................... 227
CONSTANT Field ............................................................................ 227
INITIAL MODE Field...................................................................... 227

12 3BUR002336R3701 RevA
Table of Contents

INITIAL OUTPUT Field ..................................................................227


BAD INPUTS ACCEPTED? Field...................................................228

Section 6 - Auto/Manual Controller FCMs


General Information ......................................................................................................229
Configurable Features Of The Auto/Manual Controller FCM......................................230
Processing Rate ..................................................................................................230
Ratio and Bias ....................................................................................................230
Output ...........................................................................................................231
Output Alarms ....................................................................................................231
Bumpless Mode Transfers and Tracking for Auto/Manual Controllers.............234
COMP MODE Restrictions................................................................................236
Auto/Manual Controller FCM Templet.........................................................................236
Auto/Manual Controller FCM Templet, Upper Portion.....................................237
INPUT SOURCE Field .....................................................................238
PROCESSING RATE Field ..............................................................238
ACTION ON BAD INPUT Field .....................................................238
OUTPUT MODES ALLOWED Field ..............................................239
TRACK ACTIVATOR SRC Field ....................................................239
TRACK ACTIVATOR ATTR Field ..................................................239
TRACK INPUT SOURCE Field ......................................................240
TRACK INPUT ATTRIBUT Field ...................................................240
TRACK ACTIVATE STATE Field ...................................................241
BAD INPUTS ACCEPTED? Field...................................................241
INITIAL MODE Field ......................................................................241
INITIAL OUTPUT Field ..................................................................242
REMOTE RATIO SOURCE Field....................................................242
REMOTE BIAS SOURCE Field ......................................................242
OUTPUT RETURN MODE Field ....................................................242
LINK TIME-OUT Field....................................................................243
OUTPUT MODE ON FAIL Field.....................................................243
CHANGE OUTPT ON FAIL Field...................................................243
OUTPUT VALUE ON FAIL Field ...................................................244

3BUR002336R3701 RevA 13
Table of Contents

BALANCE MODE Field.................................................................. 244


BIAS MODE Field ........................................................................... 245
LOCAL BIAS Field.......................................................................... 245
BIAS MODES ALLOWED Field .................................................... 245
LIMITED BIAS MODES Field........................................................ 246
BIAS HIGH LIMIT Field ................................................................. 246
BIAS LOW LIMIT Field .................................................................. 246
RATIO MODE Field......................................................................... 247
LOCAL RATIO Field ....................................................................... 247
RATIO MODES ALLOWED Field.................................................. 247
LIMITED RATIO MODES Field ..................................................... 248
RATIO HIGH LIMIT Field .............................................................. 248
RATIO LOW LIMIT Field ............................................................... 248
Auto/Manual Controller FCM Templet, Lower Portion .................................... 249
LIMITED OUTPUT MODES Field ................................................. 249
OUTPUT HIGH LIMIT Field .......................................................... 250
OUTPUT LOW LIMIT Field ........................................................... 250
OUTPUT ALARM DB Field ........................................................... 250
OUTPUT RATE LIMIT Field .......................................................... 251
OUTPUT HIGH ALARMS? Field ................................................... 251
OUTPUT LOW ALARMS? Field .................................................... 251
OUTPUT RATE ALARM? Field ..................................................... 252
BAD OUTPUT ALARMS? Field..................................................... 252
OUTPUT HIGH PRIORITY Field ................................................... 252
OUTPUT LOW PRIORITY Field .................................................... 253
OUTPUT RATE PRIORITY Field ................................................... 253
BAD OUTPUT PRIORITY Field..................................................... 253
DESIGN OUTPUT MODE Field ..................................................... 254
Non-configurable Parameters Of The Auto/Manual Controller FCM .......................... 254
B_DQ - Bias Value Data Quality Parameter..................................... 254
FULL_OUT - Unlimited Output Value Parameter ........................... 254
OUT_COND - Output Limit Indicator Parameter ............................ 254

14 3BUR002336R3701 RevA
Table of Contents

R_DQ - Ratio Data Quality Parameter..............................................255


REM_CRTL - Remote Control Indicator Parameter ........................255
RESULT - Result of FCM Parameter ...............................................255
RET_OUMD - Output Mode on Return from Supervisory Parameter255
TRAK_DQ - Track Variable of Data Quality Parameter ..................255
TRK_FLAG - Track Flag Parameter ................................................256
TRAK_VAR - Track Variable Parameter ..........................................256
WD_COUNT - Watchdog Timer ......................................................256

Section 7 - PID Controller FCMS


General Information ......................................................................................................257
Processing Rate ..................................................................................................257
Setpoint ...........................................................................................................258
Ratio and Bias for the Setpoint ..........................................................................258
Output ...........................................................................................................259
Process Variable Alarms ....................................................................................264
Output Alarms ...................................................................................264
Setpoint Alarms.................................................................................264
Deviation Alarms ..............................................................................264
Manual Reset......................................................................................................265
Bumpless Mode Transfers and Tracking for PID Controllers............................266
COMP MODE Restrictions................................................................................268
Incremental PID Algorithm................................................................................269
The PID Controller FCM Configuration Templet Fields ..............................................271
PID Controller FCM Templet, Upper Portion....................................................271
INPUT SOURCE Field .....................................................................273
PROCESSING RATE Field ..............................................................273
BASE GAIN Field ............................................................................273
BASE RESET Field ..........................................................................274
PREACT TIME Field .......................................................................274
PREACT MODE Field .....................................................................274
PROPORTIONAL ACTION Field ...................................................274
INTEGRAL TYPE Field...................................................................275

3BUR002336R3701 RevA 15
Table of Contents

OUTPUT MODES ALLOWED Field.............................................. 275


LIMITED OUTPUT MODES Field ................................................. 276
TRACK ACTIVATOR SRC Field .................................................... 276
TRACK ACTIVATOR ATTR Field.................................................. 276
TRACK INPUT SOURCE Field ...................................................... 277
TRACK INPUT ATTRIBUT Field................................................... 277
TRACK ACTIVATE STATE Field ................................................... 278
REMOTE SETPT SOURCE Field ................................................... 278
SETPT TRACKING SRC Field ....................................................... 278
CONTROLLER ACTION Field....................................................... 279
PROCESS HIGH VALUE Field....................................................... 279
PROCESS LOW VALUE Field........................................................ 279
ADAPTIVE CONTROL Field ......................................................... 279
INITIAL MODE Field...................................................................... 280
INITIAL OUTPUT Field.................................................................. 281
INITIAL SETPOINT Field............................................................... 281
INITIAL SETPT MODE Field ......................................................... 281
LIMITED SETPT MODES Field ..................................................... 281
SETPOINT MODES ALLOWED Field........................................... 282
MANUAL RESET MODE Field...................................................... 282
MANUAL RESET VALUE Field .................................................... 283
MANUAL RESET HIGH LIMIT Field ........................................... 283
MANUAL RESET LOW LIMIT Field ............................................ 283
INCREMENTAL INC TYPE Field .................................................. 283
DESIGN OUTPUT MODE Field ..................................................... 284
DESIGN SETPT MODE Field ......................................................... 284
PID Controller FCM Templet, Middle Portion.................................................. 285
INTERACTIVE FORM Field .......................................................... 286
ERROR SQUARED OPTION Field ................................................ 286
GAIN LIMIT Field ........................................................................... 286
FEEDFORWARD TYPE Field ......................................................... 287
FF/FB MODE Field .......................................................................... 287

16 3BUR002336R3701 RevA
Table of Contents

FEEDFORWARD SOURCE Field ...................................................287


EXT FEEDBACK ENABLE Field ...................................................288
EXT FEEDBACK SOURCE Field ...................................................288
ENABLE DEAD TIME Field ...........................................................288
DEAD TIME SOURCE Field ...........................................................288
BALANCE MODE Field ..................................................................289
BIAS MODE Field............................................................................289
LOCAL BIAS Field ..........................................................................290
REMOTE BIAS SOURCE Field ......................................................290
REMOTE RATIO SOURCE Field....................................................290
BIAS MODES ALLOWED Field.....................................................290
LIMITED BIAS MODES Field ........................................................291
BAD INPUTS ACCEPTED? Field...................................................291
ACTION ON BAD INPUT Field .....................................................292
ACTION ON BAD SETPT Field .....................................................292
SETPOINT RETURN MODE Field .................................................292
SETPT VALUE ON FAIL Field .......................................................293
CHANGE SETPT ON FAIL Field....................................................293
SETPT MODE ON FAIL Field.........................................................293
OUTPUT RETURN MODE Field ....................................................294
OUTPUT MODE ON FAIL Field.....................................................294
OUTPUT VALUE ON FAIL Field ...................................................294
CHANGE OUTPUT ON FAIL Field................................................295
LINK TIME-OUT Field....................................................................295
BIAS HIGH LIMIT Field .................................................................295
BIAS LOW LIMIT Field ..................................................................296
RATIO MODE Field .........................................................................296
LOCAL RATIO Field .......................................................................296
RATIO MODES ALLOWED Field ..................................................297
LIMITED RATIO MODES Field .....................................................297
RATIO HIGH LIMIT Field...............................................................297
RATIO LOW LIMIT Field................................................................298

3BUR002336R3701 RevA 17
Table of Contents

PID Controller FCM Templet, Lower Portion................................................... 298


INC MINIMUM OUTPUT Field ..................................................... 300
INC LOWER DEADBAND Field.................................................... 300
INC UPPER DEADBAND Field ..................................................... 301
OUTPUT HIGH LIMIT Field .......................................................... 301
OUTPUT LOW LIMIT Field ........................................................... 301
OUTPUT ALARM DB Field ........................................................... 301
OUTPUT RATE LIMIT Field .......................................................... 302
OUTPUT HIGH ALARMS? Field ................................................... 302
OUTPUT LOW ALARMS? Field .................................................... 302
OUTPUT RATE ALARMS? Field ................................................... 303
BAD OUTPUT ALARMS? Field..................................................... 303
SETPOINT HIGH ALARM? Field .................................................. 303
SETPOINT LOW ALARM? Field ................................................... 304
BAD SETPOINT ALARM? Field.................................................... 304
DEVIATION HI ALARMS? Field ................................................... 304
DEVIATION LOW ALARMS? Field .............................................. 305
SETPOINT HIGH LIMIT Field ....................................................... 305
SETPOINT LOW LIMIT Field ........................................................ 305
DEVIATION HIGH LIMIT Field..................................................... 305
DEVIATION LOW LIMIT Field ..................................................... 306
DEVIATION ALARM DB Field...................................................... 306
Output, Setpoint, and Deviation Alarm PRIORITY Fields .............. 306
Adaptive Gain And Adaptive Reset ............................................................................. 306
HIGH LIMIT Field ........................................................................... 309
LOW LIMIT Field ............................................................................ 309
ENABLE ON CONTACT Field ....................................................... 309
CONTACT SOURCE Field .............................................................. 309
CONTACT STATE Field .................................................................. 310
CONTACT GAIN Field.................................................................... 310
ENABLE ON REMOTE Field ......................................................... 310
REMOTE SOURCE Field ................................................................ 310

18 3BUR002336R3701 RevA
Table of Contents

REMOTE HIGH LIMIT Field ..........................................................311


REMOTE LOW LIMIT Field ...........................................................311
REMOTE UPPER BRKPT Field......................................................311
REMOTE LOWER BRKPT Field ....................................................311
REMOTE UPPER FACTOR Field ...................................................312
REMOTE LOWER FACTOR Field .................................................312
ENABLE ON OUTPUT Field ..........................................................312
OUTPUT UPPER BRKPT Field ......................................................312
OUTPUT LOWER BRKPT Field.....................................................313
OUTPUT UPPER FACTOR Field ....................................................313
OUTPUT LOWER FACTOR Field ..................................................313
ENABLE ON PROCESS Field.........................................................313
PROCESS HIGH LIMIT Field .........................................................313
PROCESS LOW LIMIT Field ..........................................................314
PROCESS UPPER BRKPT Field.....................................................314
PROCESS LOWER BRKPT Field ...................................................314
PROCESS UPPER FACTOR Field ..................................................314
PROCESS LOWER FACTOR Field.................................................315
ENABLE ON ERROR Field.............................................................315
ERROR HIGH LIMIT Field .............................................................315
ERROR LOW LIMIT Field ..............................................................315
ERROR UPPER BRKPT Field .........................................................315
ERROR LOWER BRKPT Field .......................................................316
ERROR UPPER FACTOR Field ......................................................316
ERROR LOWER FACTOR Field.....................................................316

Section 8 - Output FCMS


General Information ......................................................................................................317
Parameters Common To All Output FCMS ..................................................................317
INPUT SOURCE Field .....................................................................317
VENDOR TYPE Field ......................................................................319
LAN NUMBER Field .......................................................................320
BLOCK NUMBER Field ..................................................................320

3BUR002336R3701 RevA 19
Table of Contents

CHANNEL NUMBER Field ............................................................ 321


INITIAL OUTPUT MODE Field or INITIAL MODE Field ........... 321
INITIAL OUTPUT Field.................................................................. 321
BAD INPUTS ACCEPTED? Field .................................................. 322
ACTION ON ERROR Field ............................................................. 322
Analog Output FCM ..................................................................................................... 322
SIGNAL INVERSION Field ............................................................ 323
ENGU OR PERCENT Field............................................................. 324
COUNTS - LOWER BOUND Field ................................................ 324
COUNTS - UPPER BOUND Field .................................................. 324
ENGU - LOWER BOUND Field ..................................................... 325
ENGU - UPPER BOUND Field ....................................................... 325
CHANNEL PATH............................................................................. 325
UNDER RANGE COUNTS Field and OVER RANGE COUNTS Field
326
Digital Output FCM ...................................................................................................... 326
NUMBER OF POINTS Field ........................................................... 327
INVERTED OUTPUTS Field .......................................................... 328
CHANNEL PATH............................................................................. 328
Pulse Duration Output FCM ......................................................................................... 328
COUNTS - UPPER BOUND Field .................................................. 330
CHANNEL PATH............................................................................. 330
Pulse Train Output FCM ............................................................................................... 331
COUNTS - UPPER BOUND Field .................................................. 332

Section 9 - Calculator FCMS


General Information ...................................................................................................... 333
Items Common To All Calculator FCMS ..................................................................... 334
Common Configurable Fields for Calculator FCMs ......................................... 334
TEMPLET NAME Field .................................................................. 335
PARENT NAME Field ..................................................................... 336
COMMENT Field............................................................................. 336
TEMPLET TYPE Field .................................................................... 336

20 3BUR002336R3701 RevA
Table of Contents

DATABASE NAME Field ................................................................336


INPUT SOURCE or INPUT SOURCE 1 Field ................................336
INITIAL MODE Field ......................................................................337
INITIAL OUTPUT Field ..................................................................337
BAD INPUTS ACCEPTED? Field...................................................337
Common Non-configurable Parameters.............................................................338
DATAQUAL Parameter ....................................................................338
DEVLPNUM Parameter ...................................................................338
FCM_MODE Parameter ...................................................................338
INIT_FLG Parameter ........................................................................339
OUT_MODE Parameter....................................................................339
RESULT Parameter...........................................................................339
Conditions for Changing the Values of Data Base Parameters ..........................339
RESULT Parameter...........................................................................340
OUT_MODE Parameter....................................................................340
Format Of The Calculator FCM Descriptions...............................................................340
Tuning and Logging Tables for Calculator FCMs .............................................342
Sum Of 4 Inputs FCM ...................................................................................................350
Purpose ...........................................................................................................350
Default Name, Algorithm Type, and Relation ...................................................350
Algorithm ...........................................................................................................350
Configurable Parameters ....................................................................................350
INPUT SOURCE 2 through 4 Fields ................................................350
CONSTANT 1 through 4 Fields........................................................351
Non-configurable Data Base Parameters ...........................................................351
Tuning and Logging ...........................................................................................351
Discussion ..........................................................................................................351
Subtraction FCM ..........................................................................................................352
Purpose ...........................................................................................................352
Default Name, Algorithm Type, and Relation ...................................................352
Algorithm ...........................................................................................................352
Configurable Parameters ....................................................................................352

3BUR002336R3701 RevA 21
Table of Contents

INPUT SOURCE 2 Field.................................................................. 353


CONSTANT 1 and 2 Fields .............................................................. 353
Non-configurable Data Base Parameters ........................................................... 353
Tuning and Logging........................................................................................... 353
Discussion .......................................................................................................... 353
Multiplication FCM ...................................................................................................... 354
Purpose .......................................................................................................... 354
Default Name, Algorithm Type, and Relation ................................................... 354
Algorithm .......................................................................................................... 354
Configurable Parameters.................................................................................... 354
CONSTANT 1 Field ......................................................................... 354
INPUT SOURCE 2 Field.................................................................. 355
Non-configurable Data Base Parameters ........................................................... 355
Tuning and Logging........................................................................................... 355
Discussion .......................................................................................................... 355
Division FCM................................................................................................................ 355
Purpose .......................................................................................................... 355
Default Name, Algorithm Type, and Relation ................................................... 356
Algorithm .......................................................................................................... 356
Configurable Parameters.................................................................................... 356
INPUT SOURCE 2 Field.................................................................. 356
CONSTANT 1 and 2 Fields .............................................................. 357
Non-configurable Data Base Parameters ........................................................... 357
Tuning and Logging........................................................................................... 357
Discussion .......................................................................................................... 357
Average FCM ................................................................................................................ 358
Purpose .......................................................................................................... 358
Default Name, Algorithm Type, and Relation ................................................... 358
Algorithm .......................................................................................................... 358
Configurable Parameters.................................................................................... 358
INPUT SOURCE 2 through 4 Fields................................................ 358
CONSTANT 1 through 4 Fields ....................................................... 359

22 3BUR002336R3701 RevA
Table of Contents

MINIMUM # INPUTS Field ............................................................359


Non-configurable Data Base Parameters ...........................................................359
INP1ENAB through INP4ENAB Parameters ...................................360
Tuning and Logging ...........................................................................................360
Discussion ..........................................................................................................360
Natural Logarithm FCM................................................................................................360
Purpose ...........................................................................................................360
Default Name, Algorithm Type, and Relation ...................................................360
Algorithm ...........................................................................................................361
Configurable Parameters ....................................................................................361
CONSTANT 1 and 2 Fields ..............................................................361
Non-configurable Data Base Parameters ...........................................................361
Tuning and Logging ...........................................................................................362
Discussion ..........................................................................................................362
Exponentiation FCM .....................................................................................................362
Purpose ...........................................................................................................362
Default Name, Algorithm Type, and Relation ...................................................362
Algorithm ...........................................................................................................362
Configurable Parameters ....................................................................................363
CONSTANT 1 and 2 Fields ..............................................................363
INPUT SOURCE 2 Field ..................................................................363
Non-configurable Data Base Parameters ...........................................................363
Tuning and Logging ...........................................................................................363
Discussion ..........................................................................................................364
Polynomial FCM ...........................................................................................................364
Purpose ...........................................................................................................364
Default Name, Algorithm Type, and Relation ...................................................364
Algorithm ...........................................................................................................364
Configurable Parameters ....................................................................................365
CONSTANT 1 through 4 Fields........................................................365
Non-configurable Data Base Parameters ...........................................................365
Tuning and Logging ...........................................................................................365

3BUR002336R3701 RevA 23
Table of Contents

Absolute Value FCM..................................................................................................... 365


Purpose .......................................................................................................... 365
Default Name, Algorithm Type, and Relation ................................................... 366
Algorithm .......................................................................................................... 366
Configurable Parameters.................................................................................... 366
Non-configurable Data Base Parameters ........................................................... 366
Tuning and Logging........................................................................................... 366
Modified Square Root FCM.......................................................................................... 367
Purpose .......................................................................................................... 367
Default Name, Algorithm Type, and Relation ................................................... 367
Algorithm .......................................................................................................... 367
Configurable Parameters.................................................................................... 370
HI ENG UNITS Field ....................................................................... 370
LO ENG UNITS Field ...................................................................... 370
Non-configurable Data Base Parameters ........................................................... 370
Tuning and Logging........................................................................................... 370
Linearization FCM ........................................................................................................ 371
Purpose .......................................................................................................... 371
Default Name, Algorithm Type, and Relation ................................................... 371
Algorithm .......................................................................................................... 371
Configurable Parameters.................................................................................... 371
BREAKPOINT SET Field................................................................ 371
INVERSE AXIS? Field .................................................................... 372
TEMPERATURE SCALE Field ....................................................... 372
COMPENSATION TYPE Field ....................................................... 372
HOT COMP BIAS Field................................................................... 373
ELEMENT TYPE Field.................................................................... 373
Non-configurable Data Base Parameters ........................................................... 374
Tuning and Logging........................................................................................... 374
Discussion .......................................................................................................... 374
Normalize FCM ............................................................................................................ 375
Purpose .......................................................................................................... 375

24 3BUR002336R3701 RevA
Table of Contents

Default Name, Algorithm Type, and Relation ...................................................375


Algorithm ...........................................................................................................375
Configurable Parameters ....................................................................................376
LOW RANGE Field..........................................................................376
HI RANGE Field...............................................................................376
SCALING FACTOR Field................................................................376
Non-configurable Data Base Parameters ...........................................................377
Tuning and Logging ...........................................................................................377
Discussion ..........................................................................................................377
Inverse Normalize FCM ................................................................................................377
Purpose ...........................................................................................................377
Default Name, Algorithm Type, and Relation ...................................................377
Algorithm ...........................................................................................................378
Configurable Parameters ....................................................................................378
LOW RANGE Field..........................................................................378
HI RANGE Field...............................................................................378
SCALING Field ................................................................................379
Non-configurable Data Base Parameters ...........................................................379
Tuning and Logging ...........................................................................................379
Discussion ..........................................................................................................379
Scale Input FCM............................................................................................................379
Purpose ...........................................................................................................379
Default Name, Algorithm Type, and Relation ...................................................380
Algorithm ...........................................................................................................380
Configurable Parameters ....................................................................................380
OLD LOW RANGE Field ................................................................380
OLD HIGH RANGE Field................................................................381
NEW LOW RANGE Field................................................................381
NEW HIGH RANGE Field...............................................................381
Non-configurable Data Base Parameters ...........................................................381
Tuning and Logging ...........................................................................................381
Discussion ..........................................................................................................382

3BUR002336R3701 RevA 25
Table of Contents

Flow Calculation FCM.................................................................................................. 382


Purpose .......................................................................................................... 382
Default Name, Algorithm Type, and Relation ................................................... 383
Algorithm .......................................................................................................... 384
Configurable Parameters.................................................................................... 385
PRIMARY INPUT SOURCE Field.................................................. 385
FLOW CALCULATION TYP Field ................................................ 386
COMPENSATION TYPE Field ....................................................... 386
TEMP INPUT SOURCE Field ......................................................... 387
PRES INPUT SOURCE Field .......................................................... 387
DENSITY INPUT SOURCE Field................................................... 387
TEMP LOC/REM Field.................................................................... 388
PRES LOC/REM Field ..................................................................... 388
DEN LOC/REM Field ...................................................................... 388
FLOW CALC TECHNIQUE Field .................................................. 389
STANDARD TEMP Field ................................................................ 389
FLOWING TEMP Field ................................................................... 389
FLOWING PRESSURE Field .......................................................... 389
FLOWING DENSITY Field............................................................. 390
DENSITY SC Field .......................................................................... 390
SPEC GRAV SC Field ...................................................................... 390
COEF THERM EXP Field ............................................................... 390
FLOW COEFFICIENT Field ........................................................... 391
Non-configurable Data Base Parameters ........................................................... 391
Tuning and Logging........................................................................................... 391
Discussion .......................................................................................................... 391
Temperature Compensation FCM ................................................................................. 394
Purpose .......................................................................................................... 394
Default Name, Algorithm Type, and Relation ................................................... 394
Algorithm .......................................................................................................... 394
Configurable Parameters.................................................................................... 395
TEMP SOURCE Field...................................................................... 395

26 3BUR002336R3701 RevA
Table of Contents

DIFF PRESR SOURCE Field...........................................................395


FLOW CONSTANT Field ................................................................396
DEN VS TEMP CONST Field .........................................................396
VOLUME OR MASS FLOW? Field ................................................396
DES TEMP CONSTANT Field ........................................................396
Non-configurable Data Base Parameters ...........................................................397
Tuning and Logging ...........................................................................................397
Discussion ..........................................................................................................397
Ratio/Bias FCM.............................................................................................................397
Purpose ...........................................................................................................397
Default Name, Algorithm Type, and Relation ...................................................397
Algorithm ...........................................................................................................398
Configurable Parameters ....................................................................................398
REM BIAS SOURCE Field ..............................................................398
REM RATIO SOURCE Field ...........................................................398
LOCAL BIAS Field ..........................................................................399
LOCAL RATIO Field .......................................................................399
BIAS MODE Field............................................................................399
RATIO MODE Field .........................................................................400
Non-configurable Data Base Parameters ...........................................................400
Tuning and Logging ...........................................................................................400
Discussion ..........................................................................................................400
Time Derivative FCM....................................................................................................400
Purpose ...........................................................................................................400
Default Name, Algorithm Type, and Relation ...................................................400
Algorithm ...........................................................................................................401
Configurable Parameters ....................................................................................401
CONSTANT Field.............................................................................401
TIME INTERVAL Field....................................................................401
Non-configurable Data Base Parameters ...........................................................402
PREV_INP Parameter .......................................................................402
TIME_CNT Parameter......................................................................402

3BUR002336R3701 RevA 27
Table of Contents

Tuning and Logging........................................................................................... 402


Time Integration FCM................................................................................................... 402
Purpose .......................................................................................................... 402
Default Name, Algorithm Type, and Relation ................................................... 403
Algorithm .......................................................................................................... 403
Configurable Parameters.................................................................................... 404
TIME INTERVAL Field ................................................................... 404
TOTALIZER OPTION Field ............................................................ 404
SCALE FACTOR Field .................................................................... 404
Non-configurable Data Base Parameters ........................................................... 405
PREV_INP Parameter....................................................................... 405
TIME_CNT Parameter ..................................................................... 405
Tuning and Logging........................................................................................... 405
First Order Filter FCM .................................................................................................. 405
Purpose .......................................................................................................... 405
Default Name, Algorithm Type, and Relation ................................................... 405
Algorithm .......................................................................................................... 406
Configurable Parameters.................................................................................... 406
LAG TIME Field .............................................................................. 406
Non-configurable Data Base Parameters ........................................................... 406
Tuning and Logging........................................................................................... 407
Totalizer FCM ............................................................................................................... 407
Purpose .......................................................................................................... 407
Default Name, Algorithm Type, and Relation ................................................... 407
Algorithm .......................................................................................................... 407
Configurable Parameters.................................................................................... 408
SCALE FACTOR Field .................................................................... 408
TRIP POINT 1 Field......................................................................... 408
TRIP POINT 2 Field......................................................................... 408
UP OR DOWN Field ........................................................................ 409
THRESHOLD VALUE Field ........................................................... 409
Non-configurable Data Base Parameters ........................................................... 409

28 3BUR002336R3701 RevA
Table of Contents

EN_DIS Parameter............................................................................409
OVERFLOW Parameter ...................................................................410
PR1_MODE Parameter .....................................................................410
PR1_STAT Parameter .......................................................................410
PR2_MODE Parameter .....................................................................411
PR2_STAT Parameter .......................................................................411
Tuning and Logging ...........................................................................................411
Discussion ..........................................................................................................411
Lead/Lag Filter FCM.....................................................................................................413
Purpose ...........................................................................................................413
Default Name, Algorithm Type, and Relation ...................................................414
Algorithm ...........................................................................................................414
Configurable Parameters ....................................................................................416
LAG TIME Field...............................................................................416
PREACT TIME Field .......................................................................416
PREACT GAIN Field .......................................................................417
Non-configurable Data Base Parameters ...........................................................417
PREV_INP Parameter .......................................................................417
Tuning and Logging ...........................................................................................417
Discussion ..........................................................................................................417
Dead Time FCM ............................................................................................................418
Purpose ...........................................................................................................418
Default Name, Algorithm Type, and Relation ...................................................418
Algorithm ...........................................................................................................418
Configurable Parameters ....................................................................................419
MAX DEAD TIME Field .................................................................419
Non-configurable Data Base Parameters ...........................................................419
Tuning and Logging ...........................................................................................419
Discussion ..........................................................................................................419
Dead Time Compensation FCM....................................................................................420
Purpose ...........................................................................................................420
Default Name, Algorithm Type, and Relation ...................................................420

3BUR002336R3701 RevA 29
Table of Contents

Algorithm .......................................................................................................... 420


Configurable Parameters.................................................................................... 421
MAX DEAD TIME Field ................................................................. 421
LAG TIME Field .............................................................................. 421
PREACT TIME Field ....................................................................... 422
PREACT GAIN Field ....................................................................... 422
Non-configurable Data Base Parameters ........................................................... 422
PREV_INP Parameter....................................................................... 422
Tuning and Logging........................................................................................... 422
Discussion .......................................................................................................... 422
Timer FCM.................................................................................................................... 423
Purpose .......................................................................................................... 423
Default Name, Algorithm Type, and Relation ................................................... 423
Algorithm .......................................................................................................... 424
Configurable Parameters.................................................................................... 424
TIMER MODE Field ........................................................................ 424
RELATIVE START TIME Field ...................................................... 425
PERIODIC TIME Field .................................................................... 426
ABSOLUTE TIME Field.................................................................. 426
REPEAT COUNT Field.................................................................... 426
Non-configurable Data Base Parameters ........................................................... 427
REP_CNT Parameter ........................................................................ 427
TIME_CNT Parameter ..................................................................... 427
OLD_MODE Parameter ................................................................... 427
Tuning and Logging........................................................................................... 427
Discussion .......................................................................................................... 427
Counter FCM ................................................................................................................ 428
Purpose .......................................................................................................... 428
Default Name, Algorithm Type, and Relation ................................................... 428
Algorithm .......................................................................................................... 428
Configurable Parameters.................................................................................... 429
RESET SOURCE Field .................................................................... 429

30 3BUR002336R3701 RevA
Table of Contents

ENABLE SOURCE Field .................................................................429


TIME UNITS (SECONDS) Field .....................................................429
LOWER TIME LIMIT Field ............................................................430
HIGHER TIME LIMIT Field............................................................430
Non-configurable Data Base Parameters ...........................................................431
TIM_EXP1 Parameter.......................................................................431
TIM_EXP2 Parameter.......................................................................431
Tuning and Logging ...........................................................................................432
Delay Timer FCM..........................................................................................................432
Purpose ...........................................................................................................432
Default Name, Algorithm Type, and Relation ...................................................432
Algorithm ...........................................................................................................432
Configurable Parameters ....................................................................................433
ON STATE Field ...............................................................................433
ON DELAY Field..............................................................................433
OFF DELAY Field ............................................................................433
Non-configurable Data Base Parameters ...........................................................434
Tuning and Logging ...........................................................................................434
Logical AND FCM........................................................................................................434
Purpose ...........................................................................................................434
Default Name, Algorithm Type, and Relation ...................................................434
Algorithm ...........................................................................................................434
Logical Mode ....................................................................................434
Bitwise Mode ....................................................................................435
Configurable Parameters ....................................................................................435
LOGICAL/BITWISE Field...............................................................435
INPUT SOURCE 2 through 4 Fields ................................................435
SHIFT COUNT 1 through 4 Fields...................................................436
SHIFT DIRECTION 1 through 4 Fields ...........................................436
Non-configurable Data Base Parameters ...........................................................436
INP1ENAB through INP4ENAB Parameters ...................................437
Tuning and Logging ...........................................................................................437

3BUR002336R3701 RevA 31
Table of Contents

Discussion .......................................................................................................... 437


Logical OR FCM........................................................................................................... 437
Purpose .......................................................................................................... 437
Default Name, Algorithm Type, and Relation ................................................... 437
Algorithm .......................................................................................................... 438
Logical Mode:................................................................................... 438
Bitwise Mode:................................................................................... 438
Configurable Parameters.................................................................................... 438
LOGICAL/BITWISE Field .............................................................. 438
INPUT SOURCE 2 through 4 Fields................................................ 439
SHIFT COUNT 1 through 4 Fields .................................................. 439
SHIFT DIRECTION 1 through 4 Fields........................................... 439
Non-configurable Data Base Parameters ........................................................... 440
INP1ENAB through INP4ENAB Parameters................................... 440
Tuning and Logging........................................................................................... 440
Discussion .......................................................................................................... 440
Logical NOT FCM ........................................................................................................ 441
Purpose .......................................................................................................... 441
Default Name, Algorithm Type, and Relation ................................................... 441
Algorithm .......................................................................................................... 441
Logical Mode:................................................................................... 441
Bitwise Mode:................................................................................... 441
Configurable Parameters.................................................................................... 441
LOGICAL/BITWISE Field .............................................................. 442
Non-configurable Data Base Parameters ........................................................... 442
Tuning and Logging........................................................................................... 442
Exclusive OR FCM ....................................................................................................... 442
Purpose .......................................................................................................... 442
Default Name, Algorithm Type, and Relation ................................................... 442
Algorithm .......................................................................................................... 443
Logical Mode:.................................................................................. 443
Bitwise Mode:................................................................................... 443

32 3BUR002336R3701 RevA
Table of Contents

Configurable Parameters ....................................................................................443


INPUT SOURCE 2 Field ..................................................................443
LOGICAL/BITWISE ? Field ............................................................444
Non-configurable Data Base Parameters ...........................................................444
Tuning and Logging ...........................................................................................444
Set/Reset Flip-flop FCM ...............................................................................................444
Purpose ...........................................................................................................444
Default Name, Algorithm Type, and Relation ...................................................444
Algorithm ...........................................................................................................445
Configurable Parameters ....................................................................................445
INPUT SOURCE 2 Field ..................................................................445
Non-configurable Data Base Parameters ...........................................................446
Tuning and Logging ...........................................................................................446
Discussion ..........................................................................................................446
Real Compare FCM.......................................................................................................446
Purpose ...........................................................................................................446
Default Name, Algorithm Type, and Relation ...................................................446
Algorithm ...........................................................................................................446
Configurable Parameters ....................................................................................447
INPUT SOURCE 2 Field ..................................................................447
COMPARISON CONSTANT Field..................................................447
COMPARE OPERATOR Field .........................................................448
NORMAL STATE Field....................................................................448
Non-configurable Data Base Parameters ...........................................................448
Tuning and Logging ...........................................................................................448
Selector FCM.................................................................................................................449
Purpose ...........................................................................................................449
Default Name, Algorithm Type, and Relation ...................................................449
Algorithm ...........................................................................................................449
Configurable Parameters ....................................................................................449
INPUT SOURCE 2 through 4 Fields ................................................449
SELECTOR MODE Field.................................................................449

3BUR002336R3701 RevA 33
Table of Contents

SELECT OP 1 through 3 Fields ....................................................... 450


MIN NUMBER OF INPUTS Field .................................................. 450
Non-configurable Data Base Parameters ........................................................... 451
INP1ENAB through INP4ENAB Parameters................................... 451
Tuning and Logging........................................................................................... 451
Discussion .......................................................................................................... 451
Put Generic Value FCM ................................................................................................ 454
Purpose .......................................................................................................... 454
Default Name, Algorithm Type, and Relation ................................................... 455
Algorithm .......................................................................................................... 455
Configurable Parameters.................................................................................... 455
OUTPUT DESTINATION Field ...................................................... 455
RELATION NAME Field ................................................................. 456
KEY NAME 1 through 5 Fields ....................................................... 456
KEY VALUE 1 through 5 Fields ...................................................... 456
ATTRIBUTE NAME Field............................................................... 457
CONSTANT TO PUT Field ............................................................. 457
Non-configurable Data Base Parameters ........................................................... 457
Tuning and Logging........................................................................................... 457
Discussion .......................................................................................................... 457
Get Generic Value FCM................................................................................................ 458
Purpose .......................................................................................................... 458
Default Name, Algorithm Type, and Relation ................................................... 458
Algorithm .......................................................................................................... 458
Configurable Parameters.................................................................................... 458
RELATION NAME Field ................................................................. 458
KEY NAME 1 through 5 Fields ....................................................... 459
KEY VALUE 1 through 5 Fields ...................................................... 459
INPUT SOURCE Field..................................................................... 459
ATTRIBUTE NAME Field............................................................... 460
DATAQUAL ATTRIBUTE Field ..................................................... 460
ALARM CONDITION Field............................................................ 460

34 3BUR002336R3701 RevA
Table of Contents

Non-configurable Data Base Parameters ...........................................................461


Tuning and Logging ...........................................................................................461
Discussion ..........................................................................................................462
Select Next FCM ...........................................................................................................462
Purpose ...........................................................................................................462
Default Name, Algorithm Type, and Relation ...................................................462
Algorithm ...........................................................................................................463
Configurable Parameters ....................................................................................463
INPUT SOURCE 2 Field ..................................................................464
COMPARISON CONSTANT Field..................................................464
COMPARE OPERATOR Field .........................................................464
ALT FCM NAME Field ....................................................................465
Non-configurable Data Base Parameters ...........................................................465
Tuning and Logging ...........................................................................................465
Discussion ..........................................................................................................465
Redundant Signal Selector FCM ...................................................................................465
Purpose ...........................................................................................................465
Default Name, Algorithm Type, and Relation ...................................................465
Algorithm ...........................................................................................................466
Configurable Parameters ....................................................................................466
INPUT SOURCE 2 Field ..................................................................466
Non-configurable Data Base Parameters ...........................................................466
Tuning and Logging ...........................................................................................467
Input Limiter FCM ........................................................................................................467
Purpose ...........................................................................................................467
Default Name, Algorithm Type, and Relation ...................................................467
Algorithm ...........................................................................................................467
Configurable Parameters ....................................................................................468
HI LIMIT Field .................................................................................468
LO LIMIT Field ................................................................................468
ENABLE HIGH LIMIT Field...........................................................468
ENABLE LOW LIMIT Field............................................................469

3BUR002336R3701 RevA 35
Table of Contents

Non-configurable Data Base Parameters ........................................................... 469


HI_FLAG Parameter......................................................................... 469
LO_FLAG Parameter ....................................................................... 469
Tuning and Logging........................................................................................... 470
Discussion .......................................................................................................... 470
User Calculations FCM................................................................................................. 470
Purpose .......................................................................................................... 470
Default Name, Algorithm Type, and Relation ................................................... 470
Algorithm .......................................................................................................... 471
Configurable Parameters.................................................................................... 471
INPUT SOURCE 1 through 4 Fields................................................ 471
INIT VALUE FOR VAR 1 through 4 Fields .................................... 471
SEQUENCE ID Field ....................................................................... 471
Non-configurable Data Base Parameters ........................................................... 472
DATA1 through DATA4 Parameters................................................. 472
DAPL_F1 through DAPL_F4 Parameters ........................................ 472
PROC_DQ Parameter ....................................................................... 472
PROC_VAL Parameter ..................................................................... 472
TIME_CNT Parameter ..................................................................... 473
Tuning and Logging........................................................................................... 473
Discussion .......................................................................................................... 473
Configuring the Loop Containing the UCAL FCM.......................... 473
Configuring the UCAL FCM............................................................ 474
Loading and Removing TCL Subroutines and Programs ................. 474
Synchronous UCAL Implementation and Processing ...................... 474
Asynchronous UCAL Implementation and Processing .................... 477
Data Entry FCM ............................................................................................................ 479
Purpose .......................................................................................................... 479
Default Name, Algorithm Type, and Relation ................................................... 479
Algorithm .......................................................................................................... 480
Configurable Parameters.................................................................................... 480
VALUE 1 through 20 Fields ............................................................. 480

36 3BUR002336R3701 RevA
Table of Contents

RESULT ENTRY Field.....................................................................483


Non-configurable Data Base Parameters ...........................................................483
Discussion ..........................................................................................................483
String FCM ....................................................................................................................484
Purpose ...........................................................................................................484
Default Name, Algorithm Type, and Relation ...................................................484
Algorithm ...........................................................................................................484
Configurable Parameters ....................................................................................484
TEXT STRING VALUE Field..........................................................484
User Math Block FCM ..................................................................................................484
Purpose ...........................................................................................................484
Default Name, Algorithm Type, and Relation ...................................................485
Algorithm ...........................................................................................................485
Configurable Parameters ....................................................................................485
User Math Block FCM Templet, Upper Portion ................................................485
INPUT SOURCE I1 Field.................................................................487
INPUT SOURCE I2 through I7 Fields .............................................487
HIGH LIMIT Field ...........................................................................487
LOW LIMIT Field ............................................................................487
CONSTANTS K1 through K7 Fields................................................488
INITIAL MODE Field ......................................................................488
BAD INPUTS ACCEPTED Field ....................................................488
INITIAL RESULT Field ...................................................................488
INITIAL RES Y1 through Y3 Fields................................................489
ENABLE HIGH LIMIT Field...........................................................489
ENABLE LOW LIMIT Field............................................................489
Y0 RESULT Field .............................................................................489
Y1 through Y3 INTERIM RES Fields..............................................490
User Math Block FCM Templet, Lower Portion................................................490
ERROR POSITION Field .................................................................491
ERROR TYPE Field .........................................................................492
EQUATION Fields............................................................................492

3BUR002336R3701 RevA 37
Table of Contents

Non-configurable Data Base Parameters ........................................................... 492


HI_FLAG .................................................................................... 492
LO_FLAG .................................................................................... 493
Discussion .......................................................................................................... 493
Equation Format ............................................................................... 493
Equation Strings................................................................................ 494
Constants .................................................................................... 496
Variables .................................................................................... 497
Expressions .................................................................................... 497
Operands and Operators.................................................................... 498
MOD30_MOD300_MAP ............................................................................................. 499

Section 10 - Extended Processing FCMS


General Information ...................................................................................................... 501
Common Parameters ..................................................................................................... 501
Common Configurable Parameters.................................................................... 502
TEMPLET NAME Field .................................................................. 502
PARENT NAME Field ..................................................................... 502
INPUT SOURCE Field..................................................................... 502
START TIME Field .......................................................................... 503
SAMPLE RATE Field ...................................................................... 503
PERIOD UNIT Field ........................................................................ 503
PERIOD SIZE Field ......................................................................... 504
INITIAL MODE Field...................................................................... 504
INITIAL OUTPUT Field.................................................................. 504
BAD INPUTS ACCEPTED? Field .................................................. 504
NUM OF INVALID SAMPLES Field.............................................. 505
Common Non-configurable Parameters ............................................................ 505
BAD_SAMP Parameter .................................................................... 505
DATAQUAL Parameter.................................................................... 505
DEVLPNUM Parameter ................................................................... 506
FCM_MODE Parameter ................................................................... 506
INIT_FLG Parameter........................................................................ 506

38 3BUR002336R3701 RevA
Table of Contents

NEXTCALC Parameter ....................................................................506


NEXTSAMP Parameter ....................................................................507
OUT_MODE Parameter....................................................................507
PREVTIME Parameter......................................................................507
RESULT Parameter...........................................................................507
Tuning and Logging Parameters for Extended Processing FCMs ....................507
Continuous Moving Average FCM ...............................................................................508
Purpose ...........................................................................................................508
Default Name, Algorithm Type, and Relation ...................................................508
Algorithm ...........................................................................................................509
Configurable Parameters ....................................................................................509
NUMBER OF SAMPLES Field .......................................................509
MAX BAD SAMPLES Field............................................................509
Non-configurable Data Base Parameters ...........................................................510
Tuning and Logging ...........................................................................................510
Standard Deviation FCM...............................................................................................510
Purpose ...........................................................................................................510
Default Name, Algorithm Type, and Relation ...................................................510
Algorithm ...........................................................................................................511
Configurable Parameters ....................................................................................511
Non-configurable Data Base Parameters ...........................................................511
Tuning and Logging ...........................................................................................511
Discussion ..........................................................................................................511
Non-rate Periodic Total FCM ........................................................................................513
Purpose ...........................................................................................................513
Default Name, Algorithm Type, and Relation ...................................................514
Algorithm ...........................................................................................................514
Configurable Parameters ....................................................................................514
Non-configurable Data Base Parameters ...........................................................514
RATE_IND Parameter ......................................................................514
Tuning and Logging ...........................................................................................515
Discussion ..........................................................................................................515

3BUR002336R3701 RevA 39
Table of Contents

Periodic Average FCM.................................................................................................. 515


Purpose .......................................................................................................... 515
Default Name, Algorithm Type, and Relation ................................................... 515
Algorithm .......................................................................................................... 516
Configurable Parameters.................................................................................... 516
Non-configurable Data Base Parameters ........................................................... 516
Tuning and Logging........................................................................................... 516
Discussion .......................................................................................................... 516
Periodic Maximum FCM .............................................................................................. 517
Purpose .......................................................................................................... 517
Default Name, Algorithm Type, and Relation ................................................... 517
Algorithm .......................................................................................................... 517
Configurable Parameters.................................................................................... 517
Non-configurable Data Base Parameters ........................................................... 517
Tuning and Logging........................................................................................... 517
Discussion .......................................................................................................... 518
Periodic Minimum FCM ............................................................................................... 518
Purpose .......................................................................................................... 518
Default Name, Algorithm Type, and Relation ................................................... 518
Algorithm .......................................................................................................... 518
Configurable Parameters.................................................................................... 518
Non-configurable Data Base Parameters ........................................................... 519
FIR_SAMP Parameter ...................................................................... 519
Tuning and Logging........................................................................................... 519
Discussion .......................................................................................................... 519
Periodic Rate Total FCM............................................................................................... 519
Purpose .......................................................................................................... 519
Default Name, Algorithm Type, and Relation ................................................... 519
Algorithm .......................................................................................................... 520
Configurable Parameters.................................................................................... 520
SAMPLE UNIT Field ....................................................................... 520
Non-configurable Data Base Parameters ........................................................... 521

40 3BUR002336R3701 RevA
Table of Contents

RATE_IND Parameter ......................................................................521


Tuning and Logging ...........................................................................................521
Discussion ..........................................................................................................521

Section 11 - Defining Device Loops


General Information ......................................................................................................523
Device Handling Mechanisms.......................................................................................523
Descriptor Sets...............................................................................................................524
Device Alarms ...............................................................................................................530
Processing Device Loops ..............................................................................................530
Interface with other Software.............................................................................533
How To Configure A Device Loop ...............................................................................533
TEMPLET NAME (TAG) Field .......................................................535
EXPORT Field ..................................................................................535
LOOP DESCRIPTOR Field..............................................................536
PROCESSING RATE Field ..............................................................536
PROCESSING PHASE Field ...........................................................537
DEVICE TYPE Field ........................................................................537
SPECIAL NAME Field.....................................................................538
INPUT SOURCE Field .....................................................................538
VENDOR TYPE Field ......................................................................539
INPUT LAN NUMBER Field ..........................................................540
INPUT BLOCK NUMBER Field .....................................................540
INPUT CHANNEL NUM Field .......................................................540
OUTPUT LAN NUMBER Field ......................................................541
OUTPUT BLOCK NUMBER Field .................................................541
OUTPUT CHANNEL NUM Field ...................................................541
MOMENTARY CHANNEL# Field..................................................542
INVERTED INPUTS Field...............................................................542
INVERTED OUTPUTS Field...........................................................543
TRANSITION OVERRIDE Field ....................................................543
LOOP STATE Field ..........................................................................544
ALARM PRIORITY Field................................................................544

3BUR002336R3701 RevA 41
Table of Contents

POSTING ENABLE Field................................................................ 545


SUPPRESS ALARMS Field ............................................................ 545
DESCRIPTOR SET Field................................................................. 546
NUMBER OF INPUTS Field ........................................................... 546
NUMBER OF OUTPUTS Field ....................................................... 546
DEVICE OVERRIDE Field ............................................................. 547
SIMULATION MODE Field ............................................................ 547
INITIAL MODE Field...................................................................... 548
INITIAL COMMAND Field ............................................................ 549
ORDER OF PROCESSING Field .................................................... 549
ABNORMAL OVERRIDE Field ..................................................... 550
ABNORMAL TIMER Field ............................................................. 551
SECONDARY TIMER Field............................................................ 551
TIMER Field .................................................................................... 551
DEV INTERLOCK ENABLE Field................................................. 553
DEV INTERLOCK SOURCE Field................................................. 553
SPECIAL COMMAND Field........................................................... 553
SAFE COMMAND Field ................................................................. 553
PERMITTED COMMAND Field .................................................... 554
REVERT ENABLE Field ................................................................. 554
REVERT COMMAND Field............................................................ 555
CUTOUT ENABLE Field ................................................................ 555
CUTOUT SOURCE Field ................................................................ 555
CUTOUT STATE Field .................................................................... 556
UNIT ID Field .................................................................................. 556
SEQUENCE ID Field ....................................................................... 556
INPUT CHANNEL PATH and OUTPUT CHANNEL PATH.......... 556
OUTPUT ERROR ACTION Field ................................................... 557
ENA ACC RESTRICTIONS Field................................................... 557
COMP MODE RESTRICT Field ..................................................... 558
ABNORMAL STATE Field.............................................................. 558
LOG STATE CHANGES Field ........................................................ 559

42 3BUR002336R3701 RevA
Table of Contents

DMND PROCESSING MODE Field, # LOOPS TO PRESCAN Field, and


LOOPS TO PROCESS Field......................................559
# LOOPS TO PRESCAN Field.........................................................560
LOOPS TO PROCESS Fields...........................................................560
Non-configurable Parameters of Device Loops .................................................560
ACT_ALM - Action Alarm ..............................................................561
DATAQUAL DATA - Quality of the Result .....................................561
DMD_SCAN - Demand Scan ...........................................................561
DEV_CMND - Device Command ....................................................561
DEV_MODE - Device Mode............................................................562
DEV_INHB - Device Inhibit ............................................................562
DEV_STAT - Device State................................................................563
DEV_TRAN - Device Transition......................................................563
FIELD_ST - Field State ....................................................................563
INP_ALM - Input Alarms.................................................................563
MAN_ENAB - Manual Enable .........................................................564
PROC_DQ - Product Data Quality ...................................................564
PROC_VAL - Process Value .............................................................564
RESULT - Result ..............................................................................564
TCL_ALM - TCL Alarm ..................................................................564
TIM1_CNT ....................................................................................564
TIM2_CNT ....................................................................................565
TIME_CNT ....................................................................................565
How to Define a Device Loop ...........................................................................565
How to Configure Special Device Algorithms..............................................................569
TEMPLET NAME Field...................................................................571
DESCRIPTOR SET Field .................................................................571
# MOMENTARY OUTPUTS Fields ................................................572
MOMENTARY DURATION # 1 through 4 Fields ..........................572
COMMAND, OUTPUT, MOMENTARY OUTPUT, INPUT MASK, and
REVERT Fields ..........................................................572
COMMAND Field ............................................................................572
OUTPUT Field..................................................................................572

3BUR002336R3701 RevA 43
Table of Contents

MOMENTARY OUTPUT Field....................................................... 573


INPUT MASK Field ......................................................................... 573
REVERT Field .................................................................................. 573
Programming User-defined Device Algorithms With TCL .......................................... 573
Processing of Device Loops that Contain User-defined Algorithms................. 574
Configuring a Device Loop that Contains a TCL Defined Algorithm .............. 575
Requirements for TCL Programs that Implement Device Algorithms.............. 576
Loading the TCL Program ................................................................................. 577

Appendix A - Advant OCS Data Base


General Information ...................................................................................................... 579
Accessing Loop And FCM Parameters......................................................................... 579
Parameters Common To All FCMs............................................................................... 581

Appendix B - Adaptive Control In The PID Controller FCM


General .......................................................................................................................... 583
Definition Of Terms ...................................................................................................... 586
Adaptive Gain Or Reset Functions ............................................................................... 589
Process, Deviation, and Remote Input Adaptive Gain or Reset ........................ 590
Break Points .................................................................................... 590
Gain Factors .................................................................................... 593
Output Adaptive Gain or Reset Functions ......................................................... 600
Base Gain or Reset and Break Points ............................................... 600
Gain Factors .................................................................................... 603
Contact Input Adaptive Gain or Reset Function................................................ 607

Appendix C - Tuning Loops Via Runtime Displays


General Information ...................................................................................................... 609
Engineer Tuning Displays For A Continuous Loop...................................................... 609
Loop FCM Display ............................................................................................ 610
Runtime Versions of the Loop Definition and FCM Templets .......................... 614
Runtime Versions of the Breakpoint Sets Templet ............................................ 616
Engineer Tuning Display For A Device Loop .............................................................. 617

44 3BUR002336R3701 RevA
Table of Contents

Appendix D - Autotune
Introduction ...................................................................................................................619
Overview .......................................................................................................................619
Considerations, Requirements, And Functions Of Autotune Methods .........................621
Closed Loop Method..........................................................................................621
Considerations and Requirements.....................................................621
Algorithm Function ...........................................................................623
Open Loop Method ............................................................................................624
Considerations and Requirements.....................................................625
Algorithm Function ...........................................................................626
Accessing The Autotune Display And Functionality ....................................................627
Softkeys ....................................................................................630
Changing Parameter Values ..............................................................633
Listing Active Experiments...............................................................633
Listing Stored Experiments...............................................................636
Autotune Execution .......................................................................................................639
Sequential Autotune Execution..........................................................................640
Interactive Autotune Execution..........................................................................644
Autotune Execution And Error Indications ...................................................................650
Autotune Notification, Error, and Warning Messages .......................................652
Aborting Autotune Execution........................................................................................660
Data Base Parameters Of Autotune Function................................................................661
Active Gain, Reset, and Pre-act (ACTIVE) ......................................662
Autotune Phase (PHASE) .................................................................662
Autotune Status (STATUS) ...............................................................663
Autotuning Method (METHD) .........................................................664
Calculated Gain, Reset, and Pre-act (CALC)....................................664
Completion Mode (CMPL MD)........................................................664
Controller Gain Limits (HI LIM and LO LIM) ................................665
Controller Pre-act Limits (HI LIM and LO LIM) .............................666
Controller Reset Limits (HI LIM and LO LIM) ...............................666
Controller Type (TYPE)....................................................................666

3BUR002336R3701 RevA 45
Table of Contents

Error Mode (ERR MD)..................................................................... 667


Estimated Process Deadtime (EST DT)............................................ 667
Estimated Process Gain (EST GN) ................................................... 668
Estimated Process Lag (EST LAG) .................................................. 668
Experiment Time (EXP TIM) ........................................................... 668
Gain Adjustment Factor (GN ADJ) .................................................. 669
Hysteresis (HYST)............................................................................ 669
Output Pulse Size (PULSE) .............................................................. 669
Output Step Size (STEP) .................................................................. 670
Pulse Factor (FACT) ......................................................................... 670
Reset Adjustment Factor (RST ADJ) ............................................... 670
Ultimate Gain Factor (PGu).............................................................. 671
Ultimate Period (PTu)....................................................................... 671

Appendix E - Detecting Setpoint/Output Limiting


What is Setpoint/Output Limiting ................................................................................. 673
How ALG_NUM Works ............................................................................................... 673
Using ALG_NUM in other Applications ...................................................................... 674

46 3BUR002336R3701 RevA
Section 1 Introduction

General Information
The Configurable Control Functions (CCF) are predefined functions for process
control and data acquisition. They execute in turbo nodes and controllers in the
Advant® OCS (Open Control System).
The Configurable Control Functions are flexible. You can adapt them to the
requirements of your process by entering data into fields on the Templet Displays in
the System Configurator.
You configure the CCF database in the Advant OCS either through the AdvaBuild®
Templet Builder software on a Windows-based Engineering Station, AdvaBuild
Template Builder and/or Function Chart Builder software on an HP-UX
Engineering Station, or Multibus-based Data Base Configurator. In the remainder of
this book, the term configurator is used to refer to both the MOD 300 Data Base
Configurator and the AdvaBuild software. Functions supported by the CCF
software include:
• Process data acquisition
• Signal linearization and conversion to engineering units
• Continuous control for analog loops
• Device handling
• Sequencing, timing, and logical operations for discrete signals
• Calculations
• Real time
• Trending
• Alarm detection
• Data processing to support the data display functions of the Operator Station
and Multibus-based Console Subsystem

3BUR002336R3701 RevA 47
Scope Of This Manual Section 1 Introduction

Scope Of This Manual


This manual describes the features of the Configurable Control Functions software
and the techniques needed to implement them and is designed to help you build your
control schemes in the Advant OCS. It is assumed that you have an understanding
of the techniques involved in process control.

Organization Of This Manual


Section 1, Introduction, describes the structure of the manual, the steps needed to
implement the software, and how to plan and list the entries for the Configurator.
Section 2, CCF Software Structure, provides an overview of CCF.
Section 3, How to Configure Subsystems to Support CCF, describes the
Configuration Templets used to specify general CCF parameters for Multibus I/O,
Data Processor, and Controller Subsystems.
Section 4, Defining Continuous Loops, describes the loop level data base
parameters for the control, indicator, and calculator loops.
Section 5, Input FCMS, describes the data base parameters for Analog, Digital and
Pulse Input FCMs.
Section 6, Auto/Manual Controller FCMs, describes the data base parameters for
Auto/Manual Controller FCM.
Section 7, PID Controller FCMS, describes the data base parameters for PID
Controller FCM.
Section 8, Output FCMS, describes the data base parameters for Analog, Digital,
Pulse Train, and Pulse Duration Output FCMs.
Section 9, Calculator FCMS, describes the data base parameters for Calculator
FCMs.
Section 10, Extended Processing FCMS, describes FCMs for calculating maximum,
minimum, total, or standard deviation values of variables over specified periods of
time.
Section 11, Defining Device Loops, describes the Device Loop and Device
Descriptor Templets for defining device loops.

48 3BUR002336R3701 RevA
Section 1 Introduction Related Documentation

Appendix A, Advant OCS Data Base, describes the parameters in the data base.
Appendix B, Adaptive Control In The PID Controller FCM, describes adaptive gain
and adaptive reset functions used with the PID Controller FCM.
Appendix C, Tuning Loops Via Runtime Displays, describes the method for
changing the loop configuration during runtime.
Appendix D, Autotune, describes the Autotune function for tuning PI, PID, and
DTC control algorithms.
Appendix E, Detecting Setpoint/Output Limiting, describes how to use the control
FCM’s ALG_NUM attribute to detect when a control algorithm is limiting its
setpoint or output.

Related Documentation
The following instruction books are relevant to Configurable Control Functions
when configuration is performed via a Windows-based Engineering Station:
• AdvaBuild Control Buider User’s Guide
• Data Base Tables
• Grafx Display Editor
• Taylor™ Control Language (TCL) User’s Guide
The following instruction books are relevant to Configurable Control Functions
when configuration is performed via a HP-UX Engineering Station:
• AdvaBuild Basic Functions User’s Guide
• Data Base Tables
• Display Builder User's Guide
• Taylor™ Control Language (TCL) User’s Guide
The following instruction books are relevant to Configurable Control Functions
when configuration is performed via a Multibus-based Configurator:
• System Configurator User's Guide
• Console Configurator User's Guide
• Data Base Planning Forms
• Data Base Tables
• Display Builder User's Guide
• Taylor™ Control Language (TCL) Manual

3BUR002336R3701 RevA 49
Configuration Templet Displays Section 1 Introduction

Configuration Templet Displays


You can tailor the CCF functions to the requirements of a specific process. This is
done by configuring CCF database parameters on interactive templet displays.
Figure 1, like all the figures of templets in this manual, shows a templet as viewed
from the AdvaBuild Templet Builder running on the Windows platform. The same
templet viewed from AdvaBuild Template Builder running on the HP-UX platform
and the Multibus-based Configurator contains essentially the same fields, but the
user interface differs. In general, each loop and type of FCM in CCF has a
corresponding templet.

Figure 1. Templet Example

50 3BUR002336R3701 RevA
Section 1 Introduction Descriptions Of The Templet Fields

Configuration is simplified by having default entries for most fields on the templets.
Default entries are typical or safe values and are used by the system unless changed
by you. Some templet fields do not have defaults. In the Multibus-based
Configurator, if a field contains three question marks (???), an entry must be made
to it. On all configuration platforms, if a field is blank, entries are possible, but not
mandatory. However, an entry must be made in the TEMPLET NAME field.

Descriptions Of The Templet Fields


The templet fields are described in detail in Section 3, How to Configure
Subsystems to Support CCF through Section 11, Defining Device Loops of this
manual. Each description is in the format shown in Figure 2. Each possible entry for
the field is listed and further information is provided about the entry as required.
The default value for the field is provided. If the field specifies the value of a
parameter in the data base, the mnemonic of that parameter is also provided.

ENABLE HI ALARMS? Field


This field specifies whether the high alarm for the measured variable is enabled.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

HI LIMIT Field
This field defines the high alarm limit for the measured variable. The alarm becomes active when the
measured variable becomes equal to or greater than the high limit and clears when the measured variable
decreases to the value of the high limit minus the alarm deadband.
Valid entry is:
a decimal number
Default is: PROCESS HI (the value entered in the HI ENG. UNIT LIMIT field)
Mnemonic: HILIMT
Label on Loop Detail Display: HIGH MV
During runtime, you can modify the high alarm limit via the HIGH MV field on the Loop Detail Display.

Figure 2. Field Description Example

3BUR002336R3701 RevA 51
Entering Floating Point Values in Exponential Format Section 1 Introduction

Entering Floating Point Values in Exponential Format


The standard format for entering floating point values is decimal format. Some
fields whose data type is floating point allow you to enter the value in exponential
format as well. The method for using exponential format is different depending on
whether you are using the Multibus-based configurator, or the AdvaBuild Template
Builder.

Multibus-based Configurator
In the Multibus-based configurator, floating point values must be entered in decimal
format initially. This is because floating point fields do not accept non-numeric
characters (e). For fields that can hold more than six characters, if you enter a value
longer than six characters, when you leave the templet and then return, the value
will be displayed in exponential format. For instance, if you enter a value of
10000000.0 in the CONSTANT K1 field of a Math block, if you leave the templet
and then return, the value will be displayed as 1.00000e7. Once the value is
displayed in exponential format, you can change the exponent value and thus enter a
value that is greater than you could have entered in floating point format (for
example: 1.00000e12).

If you save the templet to a transition file, and you have used
exponential notation to enter a value that exceeds the maximum
number of characters for the field, the leading digits will be
truncated and only the least significant digits (up to the maximum
number of characters for the field) will be transferred to the
transition file. In this case, when you restore the transition file you
must re-enter any values where truncation has occurred.

AdvaBuild Template Builder (HP-UX) and AdvaBuild Templet Builder


(Windows)
In the AdvaBuild Template Builder (HP-UX) and AdvaBuild Templet Builder
(Windows) you can enter values in either floating point or exponential format.
When you save the template the values are always displayed in decimal format,
regardless of how you entered them. The Template Builder will not allow you to
exceed the maximum character limit for the field.

52 3BUR002336R3701 RevA
Section 1 Introduction Templet Names

Templet Names
ALL templet names in the database must be unique. By definition, the database is
the total of all configurators on the same ring (or set of interconnected rings in the
case of systems with multiple DCNs).

3BUR002336R3701 RevA 53
Templet Names Section 1 Introduction

54 3BUR002336R3701 RevA
Section 2 CCF Software Structure

General Information
The Configurable Control Functions (CCF) software generates and utilizes modules
for the functions of continuous process control, discrete device handling, sequential
process control, operator interface, information display, and alarm detection. It also
defines data base parameters used by other Advant OCS applications such as Taylor
Control Language (TCL) programs, Display Builder, Report Services, and
Historical Services.
This chapter presents an overview of the CCF software. Each feature of CCF is
briefly described, and referenced to this and other manuals.
Figure 3 illustrates how CCF and its functions are distributed in the Advant OCS.
CCF uses logical data modules called loops which execute in Turbo Nodes, in the
Controller Subsystem, and in the Data Processor Subsystem. Loops get analog,
digital, and pulse inputs from the Controller, Multibus I/O in Turbo Nodes, Direct
I/O, Taylor Remote I/O (TRIO), PLC I/O, Profibus I/O, S800 I/O and MOD 30
instruments. Loops can output values to the process through the Controller,
Multibus I/O in Turbo Nodes, Direct I/O,TRIO, PLC I/O, Profibus I/O, S800 I/O
and MOD 30 instruments. Important loop parameters are displayed on the Operator
Station (HP-UX or Windows-based) or Multibus-based console for monitoring and
manipulation by the operator.

3BUR002336R3701 RevA 55
General Information Section 2 CCF Software Structure

Process loops are monitored and


controlled via Windows-based Operator
Stations, HP-UX Operator Stations, or Process loops are configured to execute in
Multibus Consoles Controller Subsystems and Multibus
Subsystems with I/O

Windows-based
Operator Station
or
HP-UX Operator Controller Multibus
Station Subsystem Subsystem
or
Multibus Console

Advant OCS Distributed DCN-to-DCN


Communications Network Interface
(DCN)

Windows-based
Engineering Station Multibus Subsystem
or with MOD 30 Instruments
HP-UX
Engineering Station
or
Multibus-based
Configurator Process loops are configured to
execute in Multibus Subsystems
with MOD 30 Instruments
Configurable Control Functions
are configured via Windows-based
Engineering Station, HP-UX
Engineering Station, or Multibus CDP

Figure 3. CCF Software in the Advant OCS

56 3BUR002336R3701 RevA
Section 2 CCF Software Structure Loop Structure

Loop Structure
Loops are categorized according to the functions they perform. The major types are
control loops, discrete (device handling) loops, indicator loops, and calculator
loops.
Control loops apply control functions to continuous variables in the process. For
example, you can configure a loop to regulate flow of a certain liquid in a process.
You assign the loop a user-defined tag, for example, FC-100, and configure it to
function as a traditional PID controller. When the system is controlling the process,
the value of the flow is measured and compared with the desired value (setpoint). If
the two values are not equal, a new output value is sent to a control valve in the field
to correct the flow rate. The significant variables of the loop, such as process
variable, setpoint, output, output mode, and setpoint mode are displayed and
manipulated at the Operator Station or Multibus-based console.
Discrete (device-handling) loops control discrete states of devices such as pumps,
motors, and valves. These loops detect the state of the device (ON, OFF, and so on)
and display the information at the Operator Station or Multibus-based console. The
operator can change the state of the device from the Operator Station or Multibus-
based console or by commands from TCL programs. You can specify special
actions for the loop to execute if the device does not go to the new state.
Indicator loops measure the values of process variables and store these values for
display on the Operator Station or Multibus-based console.
Calculator loops perform calculations on their inputs. You can use the results of the
calculations in other loops and display them on the Operator Station or Multibus-
based console.
In addition to the functions described above, loops detect alarm conditions on
variables and pass the information to the Alarm/Event Handler. These alarms can
then be brought to the attention of the operator.

Loop Attributes
Loops have many attributes in common. Most of the attributes described in this
section involve some choice on your part when you configure CCF. Additional
information about these attributes and the way they are specified is provided in
Section 4, Defining Continuous Loops.

3BUR002336R3701 RevA 57
Loop Attributes Section 2 CCF Software Structure

Loops are identified by tags and descriptors. The tag is a string of up to 12


alphanumeric characters without spaces that you choose as the loop's identifier. (See
Figure 4). No two loops in the system can have the same tag. The tag is displayed
with other loop attributes (such as measured value) on operational displays. It is also
used when parameters from the loop are referenced by the other software packages
(Historical Services, TCL, and so on).
The descriptor of up to 24 alphanumeric characters is used to further identify the
loop.

Loop

Tag TC101
Descriptor FEEDTEMP
Loop State ON
Processing Rate 4
Phase 1
List of FCMs

From Meas. To
Field Analog Linearization Value PID Analog Field
Input FCM Controller Output
FCM FCM FCM

Figure 4. Example of Loop Properties

The loops are processed repeatedly and in order according to your specifications.
Each Multibus I/O, Data Processor, and Controller Subsystem is assigned a base
rate for processing its loops. For example, if the base rate of a controller is set at 1,
its loops are processed once every second. You can give individual loops a slower
processing rate as long as the rate is a multiple of the base rate. Additionally, loops
execute automatically whenever the output mode of any of their FCMs is changed.
You can also configure Controller FCMs so they are processed at multiples of the
processing rate of the loop they belong to.
To balance processor loading, the phase feature allows you to distribute the loop
processing evenly about the processing interval.

58 3BUR002336R3701 RevA
Section 2 CCF Software Structure Function Class Modules (FCMs)

You can configure the loops in a module so they are processed in the order you
determine.
Loops have ON and OFF states to determine whether the loop is processed.
The FCMs in a loop are processed in the order they appear in the list of FCMs
under the Loop Definition Templet.
The result of one of the FCMs in a loop must be specified as the measured variable
of the loop. This value is easily accessed by the operational displays and other
software packages in the system can reference them.
Upon start-up, loops are initialized according to the initialization parameters in
their FCMs.

Function Class Modules (FCMs)


All loops, except device loops, are built from smaller algorithm blocks called
Function Class Modules (FCMs). Each FCM performs a specific function. For
example, you can make a basic PID control loop from 3 FCMs as shown in
Figure 5.
In Figure 5, the Analog Input FCM is the first FCM in the loop. It acquires the
initial input variable and scales it in engineering units. These results are passed to
the PID Controller FCM where the PID algorithm is applied. The result is passed to
the Analog Output FCM which sends the output signal to the process.

From Result Result To


Field Analog PID Analog Field
Input Controller Output
FCM FCM FCM

Figure 5. Control Loop Example

In a similar fashion, the indicator and calculator loops are made from combinations
of FCMs.

3BUR002336R3701 RevA 59
Function Class Modules (FCMs) Section 2 CCF Software Structure

CCF has many types of FCMs which fall into the following categories:
Controller FCMs provide control algorithms with associated initialization,
tracking, and mode switching parameters. Each control loop must contain a
controller FCM. The possible types are listed below. Detailed descriptions are
provided in Section 6, Auto/Manual Controller FCMs, and Section 7, PID
Controller FCMS.
A/M Controller
PID Controller
Input FCMs acquire measurement values from the process. The types of Input
FCMs are listed below. They are described in Section 5, Input FCMS.
Analog Input Pulsed Input
Digital Input Pulsed Input Time Derivative
Output FCMs output values to the process. The types of Output FCMs are listed
below. They are described in Section 8, Output FCMS.
Analog Output Pulse Duration Output
Digital Output Pulse Train Output
Extended Processing FCMs provide data averaging, maximum and minimum
value detection, and totalization. The Extended Processing FCM types are listed
below. They are described in Section 10, Extended Processing FCMS.
Continuous Moving Average Periodic Minimum
Standard Deviation Periodic Rate Total
Periodic Average Non-Rate Periodic Total
Periodic Maximum
Calculator FCMs provide a wide variety of mathematical and logical operations
for functions such as flow compensation, rate determination, input selection, event
timing, and so on. They are described in Section 9, Calculator FCMS. The
Calculator FCMs are divided into the following groups.
Logic FCMs
Logical AND Logical NOT

60 3BUR002336R3701 RevA
Section 2 CCF Software Structure Function Class Modules (FCMs)

Logical OR Set/Reset Flip/Flop


Exclusive OR Real Compare
Scale Compensation FCMs
Linearization Scale Input
Ratio/Bias Modified Square Root
Normalize Temperature Compensation
Inverse Normalize Flow Calculation
Math Related FCMs
Subtraction Absolute Value
Multiplication Average
Division Exponentiation
Sum of 4 Inputs Natural Logarithm
Polynomial
Time Related FCMs
Time Derivative Timer
Time Integration Dead Time Compensation
Totalizer Dead Time
First Order Filter Counter
Lead/Lag Filter Delay Time
Miscellaneous Calculator FCMs
Selector User Math Block
Input Limiter String
Redundant Signal Selector Data Entry
Select Next FCM Get Generic Value
MOD30_MOD300_MAP User Calculations
Put Generic Value

3BUR002336R3701 RevA 61
FCM Attributes Section 2 CCF Software Structure

FCM Attributes
FCMs have many attributes in common. Most of the attributes described in this
section involve some choice you make when you configure the system. Information
about the way these attributes are specified is provided in Section 6, Auto/Manual
Controller FCMs, through Section 11, Defining Device Loops.
Figure 6 is a representation of an FCM showing some of the FCM properties.

FCM Type PID Controller


FCM Name PID
FCM Mode ON
Output Mode AUTO
Input Setpoint State LOCAL Result

PARAMETERS (Some parameters are


Data Quality GOOD
common to all FCMs, others are unique
to certain FCMs) Output Condition
UNLIMITED

Figure 6. Example of FCM Properties

The FCM type is the predefined category for the FCM. The type is related to the
function of the FCM. The FCM types are listed in Function Class Modules (FCMs)
on page 59.
FCMs are identified by FCM names. The FCM name is a string of up to 3
alphanumeric characters you choose at configuration time as the identifier for the
FCM. A default string is created as you add the FCM to the list for the loop. No two
FCMs in a loop can have the same FCM name. The FCM name is used when
parameters from the FCM are referenced by the software packages.
The result is the value calculated by the FCM when the FCM is processed. Other
FCMs can access the result.
All measured or calculated data values have a data quality indicator associated with
their value. A GOOD data quality for a result indicates it was calculated from inputs
having GOOD data qualities. If the data quality of a result is BAD, at least one of
the inputs has a BAD data quality. The action taken when the result has a BAD data
quality is specified when the FCM is configured.

62 3BUR002336R3701 RevA
Section 2 CCF Software Structure FCM Attributes

The FCM mode determines whether the FCM is processed. The FCM modes are:
ON process the FCM
OFF do not process the FCM
The output mode determines the source of the output (result) of the FCM
according to the guidelines listed below.
For PID and Auto/Manual Controller FCMs, the output modes are:
Auto the FCM automatically determines the output value
Manual the operator at the Operator Station or Multibus-based console
determines the output value
Track the output is set equal to the value of a specified signal
For all other FCMs, the output modes are:
Auto the FCM automatically determines the output value
Manual the operator at the Operator Station or Multibus-based console
determines the output value
PID Controller FCMs have setpoint modes that determine the source of the
setpoint signal according to the following:
Local setpoint value comes from within the Controller FCM. The operator
can change this value from the Operator Station or Multibus-based
console.
Remote setpoint value is the result of another FCM
Track setpoint value tracks the value of another signal
Ramp setpoint value is changed at a specified rate to a specified endpoint
Table 1 and Table 2 summarize the modes for the FCM types.

Table 1. Modes for the PID and A/M Controller FCMs

FCM MODE OUTPUT MODE SETPOINT MODE (PID ONLY)


ON Auto, Manual, Track Local, Remote, Track, Ramp
OFF

3BUR002336R3701 RevA 63
Alarm Detection By Loops Section 2 CCF Software Structure

Table 2. Modes for Calculator, Extended Processing, Input, and Output FCMs

FCM MODE OUTPUT MODE


ON Auto, Manual
OFF

Alarm Detection By Loops


Loops can detect alarms and pass alarm information to the Alarm/Event Handler.
PID control loops detect alarms on the measured variable, setpoint, deviations, and
output. Auto/Manual control loops detect alarms on the measured variable and
output. Indicator and calculator loops detect alarms on the measured variable.
Discrete loops detect device related alarms.

Alarm And Event Logging


CCF can use the optional Alarm/Event logging features of the Advant OCS. When
parameter values are changed, messages are automatically printed on designated
logging printers. Similarly, alarm occurrence and alarm clearing messages are also
posted.
Alarm and event handling for the Windows platform is described in the Operate IT
Configuration Manual, for the HP-UX platform is described in the Advant Station
500 Series with AdvaCommand 1.x/y / AdvaBuild 2.x/y User’s Guide, and for the
Multibus-based CDP is described in the System Configurator User's Guide. It
includes instructions for configuring an Alarm/Event Logger.

64 3BUR002336R3701 RevA
Section 2 CCF Software Structure Operator Interface

Operator Interface
Figure 7 shows a typical custom operational display. The paragraphs that follow
describe the operator (runtime) user interface for CCF.

Figure 7. Typical Custom Operational Display

Major Functions
The operator interface for CCF provides the means to monitor and manipulate CCF
loops from operational displays on the Operator Station or Multibus-based console.
This section summarizes the major aspects of this operator interface. How to
configure the Windows-based operator interface is described in the Operate IT

3BUR002336R3701 RevA 65
Area and Group Displays Section 2 CCF Software Structure

Configuration Manual. See the Advant Station 500 Series with AdvaCommand 1.x/y
/ AdvaBuild 2.x/y User’s Guide for information on how to configure the HP-UX
operator interface. See the Console Configurator User's Guide for information on
how to configure the Multibus-based operator interface.
The following major functions are supported by the operator interface:
• Values of parameters from the loops are displayed in numerical and graphic
form
• Operator can change certain parameter values such as setpoints, outputs,
setpoint modes, output modes, and device commands from the Operator
Station or Multibus-based console
• Display and acknowledgment of alarm conditions
• Operator can change (tune) some aspects of the configuration while the system
is operating

Area and Group Displays


To tailor the operator interface to your specific system, you can specify which tags
are displayed on each operator display. This is done on the Windows-based platform
by assigning up to 16 loops to Groups during configuration. The operator interface
allows you to display information for all loops in a group.
On HP-UX and Multibus-based platforms, you can specify which tags are displayed
by assigning loops to Groups and Areas during configuration. Each Group contains
up to 12 control loops, or 36 indicator loops, or a combination of control and
indicator loops. Areas are larger collections consisting of up to three groups. The
operator interface allows you to simultaneously display information for all loops in
a Group or Area. For example, the Group Status Display for a Group shows the
status of every loop in the Group. Similarly, the Area Status Display shows the
status of every loop in every Group contained by the Area.

Other Software Packages


The components of the CCF data base constitute the basis for all process control and
information gathering for the system. All other applications depend upon access to
the current values in the CCF data base.

66 3BUR002336R3701 RevA
Section 2 CCF Software Structure Other Software Packages

Sequential and Supervisory Control is provided by using the Taylor Control


Language (TCL) to manipulate the CCF loops.
The Grafx Editor (Windows-based) Display Builder (HP-UX and Multibus-
based) accesses the data base for the dynamic (changing) elements of the user-
defined graphic displays.
The Report Services accesses the data base for the parameter values needed to
produce process reports.
The Alarm and Event Logger lists the alarms detected by the CCF software. It
also lists many of the parameter changes made in the loops.
The Historical Services keeps a record on disk of many of the parameters of the
CCF software.
Taylor Ladder Logic (TLL) reads values from the CCF data base.

3BUR002336R3701 RevA 67
Other Software Packages Section 2 CCF Software Structure

68 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to
Support CCF

General Information
CCF executes in Turbo Nodes, Controller Subsystems and certain Interface
Subsystems. This section describes how to configure these subsystems to support
CCF.
CCF in Interface Subsystems of the Multibus-based platform is described in
Taylor™ MOD 30™ Interface User's Guide, Taylor™ Programmable Controller
Interface User's Guide, Taylor™ AccuRay® 1180 MICRO™ Interface User's Guide,
and Smart Device Interface User's Guide.

CCF In Advant Controllers


For instructions on how to configure an Advant Controller to support CCF, refer to
the applicable Advant Controller User’s Guide.

CCF In 6000-series and SC Controller Subsystems


This section describes how to configure an SC Controller Subsystem or 6000-series
Controller Subsystem to support CCF. In this section, the terms Controller and
Controller Subsystem refer to the 6000-series and SC Controllers.
A Controller Subsystem contains up to 12 controllers, each can execute CCF. As an
option, you can designate one of the controllers as a backup controller to take over
the functions of a failed controller. A controller has 16 analog inputs, 8 analog
outputs, 8 interrupting contact inputs, and 40 digital inputs and/or outputs.

3BUR002336R3701 RevA 69
CCF In 6000-series and SC Controller Subsystems Section 3 How to Configure Subsystems to

The loops defined in a controller can either use the I/O facilities of the controller or
can get their inputs from other loops. Figure 8 shows the templet structure of a
Controller Subsystem.

Data Base

Configuration Configuration Device


Area Area Descriptor
Directory

Controller
Subsystem
Device
Descriptor
Templets
Controller

Remote I/O Controller I/O CCF Taylor Ladder Logic


(SC Controller (Not used when TCL Templets (SC Controller only) Smart I/O
only. Not used controller has
when controller TRIO)
has Direct I/O) Smart I/O
Network

Remote I/O Module More Loops


Templets. One per
module on Field Bus Loop Breakpoint
Definition Device Loops Sets

FCM
Templets

Figure 8. CCF Related Templets for Controller Subsystems

70 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Subsystem Templet

Controller Subsystem Templet


A Controller Subsystem Templet, Figure 9, identifies and specifies the DCN address
of a Controller Subsystem.

Figure 9. Controller Subsystem Templet

TEMPLET NAME Field


Use this field to specify the name all applications use to identify this Controller
Subsystem. The templet name must be unique, that is, no two templets can have the
same name.
Valid entry is:
a character string of up to 21 characters.

PARENT NAME Field


This field is automatically filled in by the system, and is for information only.

PHYSICAL DEVICE Field


This field specifies the DCN address of the Controller Subsystem.
Valid entry is:
an integer, from 2 to 255, that is the decimal equivalent of the D/F switch
setting (DCN to F Bus) in the subsystem

3BUR002336R3701 RevA 71
Controller Subsystem Templet Section 3 How to Configure Subsystems to Support CCF

An entry must be made to this field.

REDUNDANCY OPTION Field


This field specifies the number of backup controllers in the subsystem.
Valid entries are:
NO BACKUP no backup controllers
1 BACKUP one backup controller at physical address 4
3 BACKUPS three backup controllers at addresses, 4, 8, and 12. The backup
controller at physical address 4 backs up the controllers at 1, 2, and
3, and so on.
You must insure the proper number of Backup Controller Templets are configured
and the proper physical addresses are assigned to the backup controllers.

72 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Templet

Controller Templet
The Controller Templet, Figure 10, is used to specify the general parameters for a
controller. One Controller templet must be completed for each control module.

Figure 10. Controller Templet

TEMPLET NAME Field


Use this field to specify the name all applications use to identify this controller. The
specified templet name must be unique, that is, no two templets can have the same
name.
Valid entry is:
a character string of up to 21 characters

PARENT NAME Field


This field is automatically filled by the system, and is for information only.

3BUR002336R3701 RevA 73
Controller Templet Section 3 How to Configure Subsystems to Support CCF

PHYSICAL DEVICE Field


This field specifies the position (cardfile slot) of the controller in the Controller
Subsystem. An entry is mandatory in this field.
Valid entry is:
an integer from 1 to 12. In a subsystem with 11-1 redundancy, the backup
controller is usually in position 4 and the controllers are usually in positions 1
through 3 and 5 through 12. In a subsystem with 3-1 redundancy, the backup
controllers are usually in positions 4,8, and 12 and the controllers are usually in
positions 1 through 3, 5 through 7, and 9 through 11.

SOFTWARE NAME Field


This field specifies the name of the software set downloaded to the controller upon
start-up. All redundant controllers in a subsystem and the backup controller must
have the same software name. The cards must have identical software in order to
back them all up. The controller does not have to be connected to a Local Control
Panel Plus (LCP+) in order to have LCP software loaded into it.
Valid entries are:

CONTROLLER This is used for 6004B Control Modules in a subsystem with


11 to 1 redundancy. It is used in a subsystem that either has
no backup controllers or one backup controller in slot 4, and
no Manual/Auto Operator Station (M/A Station) or LCP+ is
connected to the controller.
CTLR3TO1 This is used for a 6004B Control Modules in a subsystem
with 3 to 1 redundancy (backup controllers in slots 4, 8 and
12), and no M/A Station or LCP+ is connected to the
controller.
DIGITAL This is used when the controller uses the M/A Station option
and 11 to 1 redundancy. See Operator Station for details.
DIG3TO1 This is used when the controller uses the M/A Station option
and 3 to 1 redundancy. See Operator Station for details.

74 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Templet

CONTLCP This is used when the controller uses the LCP+ option and
11 to 1 controller redundancy is employed. One Area
Control Panel must be inserted as a child of the Controller
Templet. It must specify the serial port the LCP+ is
connected to via the PORT NUMBER field, and it must
define the name for the port via the PORT NAME field. The
Area Control Panel and the LCP+ are described fully in the
Local Control Panel Plus (LCP+) instruction book.
LCP3TO1 This is used when the controller uses the LCP+ option and
3 to 1 controller redundancy is employed. This option is
described in the Local Control Panel Plus (LCP+)
instruction book.
SC_CTLR This is used when the controller is a 6204B Control Module
in a subsystem with 11 to 1 redundancy. The backup
controller must be in slot 4.
SC_CTLR3TO1 This is used when the controller is a 6204B Control Module
in a subsystem with 3 to 1 redundancy. The backup
controller can be in slots 4, 8, and 12.

Default is: CONTROLLER

The SC Controller Backup Memory Module (SC-BMC) must


always be placed in the first card file of a subsystem with 11 to 1
redundancy. Also the SC-BMC requires an Extender Module
resident in every card file on the pbus. These SC-BMC Extender
Modules must be specifically jumpered for the card file where they
reside. Failure to follow these directives result in problems with
control redundancy software.

The Smart Device Interface is supported only on SC Controllers.


Therefore, if a subsystem contains a Smart Device Interface, the
only valid entries for the SOFTWARE NAME field are SC_CTLR
and SC_CTLR3TO1.

3BUR002336R3701 RevA 75
Controller Templet Section 3 How to Configure Subsystems to Support CCF

AUTO START Field


This field determines whether the controller starts processing automatically after the
software and data base are downloaded to it.
Valid entries are:
YES start processing immediately upon download
NO do not start processing until a command is issued from the Operator
Station or Multibus-based console via the Controller Subsystem
Status Display
Default is: YES

BACKUP ON STARTUP Field


This field determines whether backup capabilities (redundancy) are enabled for this
controller. Backup capabilities are only possible if the Controller Subsystem
contains a Backup Controller and Backup Memory Module.
Valid entries are:
NO do not enable backup for the controller. This entry is used when the
Controller Subsystem does not contain a backup controller or when
a Backup Controller and Backup Memory Module are in the
Controller Subsystem but are not to provide backup capabilities for
this controller.
YES enable backup for the controller
Default is: YES

MAX DATA BASE SIZE Field


This field defines the largest amount of memory in the controller used for the data
base, TCL sequences, and remote lists. Although this field must be specified for all
controllers, it has a special meaning for controllers with backup capabilities enabled
for them. The sum of the MAX DATA BASE SIZE fields of the Controllers for
which backup capabilities are enabled (BACKUP ON START UP field contains
YES), plus 750K for code and system tables must be less than the memory capacity
of the Backup Memory Module. The capacity for the 6014B Backup Memory

76 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Templet

Module is 2 meg or 4 meg with an extender and for the 6214 SC Backup Memory
Module it is 4 meg or 8 meg with an extender. The default value for this field has
been chosen such that 11 controllers can have backup capabilities enabled. You can
adjust the maximum data base sizes of the controllers if fewer than 11 require
backup capabilities.
If the entry to this field is too small, an error message is generated upon download.
When this occurs, the entry to this field must be changed and the data base must be
recompiled and downloaded.
After the data base is downloaded, both the entry to this field and the actual size of
the data base are displayed on the Controller Subsystem Status Display.
If the entry to this field is changed for a controller, the Backup Memory Module and
the Backup Controller must be reset before redundancy is re-instated for the
controller.
Valid entry is:
an integer number of bytes. Maximum entry for the 6004B Control Module is
256,000. The maximum size for the 6204B Control Module is 1 Meg
(1,024,000 bytes). (With LCP+ configured on the controller, the maximum data
base size is reduced from 256,000 bytes to 215,040 bytes.)
Default is: 81920

DO RATE Field
The DO RATE field specifies the minimum resolution of any pulse output for the
controller. For pulse train outputs, the pulse interval and pulse width as specified
through the PO CHANNEL NUMBER, PULSE INTERVAL, and PULSE WIDTH
fields of the Controller I/O Templet must be multiples of the DO rate. For pulse
duration outputs, the duration value calculated by the Pulse Duration FCM is
rounded to the next lower multiple of the DO rate.
Valid entry is:
a number of milliseconds as either 20, 40, 100, 200, or 1000
Default is: 200

3BUR002336R3701 RevA 77
Controller I/O Templet Section 3 How to Configure Subsystems to Support CCF

Controller I/O Templet


The Controller I/O Templet, Figure 11, is used to define parameters of Controller
Direct I/O.

Figure 11. Controller I/O Templet

78 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller I/O Templet

ICI 1 through 8 STATUS Fields


These fields designate whether the interrupting contact input channels are for
interrupting digital inputs or for pulse inputs. ICI 1 Status corresponds to digital
software channel number 41, ICI 2 Status corresponds to digital software channel
number 42, and so on. See Table 3 and Controller Digital Input and Output
Channels on page 82, for a detailed description of the numbering convention for the
digital channels and information on how to use digital channels.
Valid entries are:
I interrupting digital input
P pulse input
Default is: I

DIGITALS 1 through 40 Fields


In these fields, the digital channels are individually specified as either inputs or
outputs.
The fields are grouped together in fours for display purposes only. The default for
the digital channels is I (input). The entry for the first group (DIGITALS 1-4 field)
is:
IIII
To make channels 1 through 3 inputs and channel 4 an output, the entry in the
DIGITALS 1-4 field is:
IIIO
See Table 3 and Controller Digital Input and Output Channels on page 82, for a
detailed description of the numbering convention for the digital channels and
information on how to use digital channels.

OUTPUT FAILOVER OPT Field


This field specifies how the system reacts when the system attempts to failover to
backup and the backup controller is not available. It is used when a Device Loop,
Analog Output, Digital Output, Pulse Duration Output, or Pulse Train Output
Templet for the controller has an ACTION ON ERROR field specifying GOTO

3BUR002336R3701 RevA 79
Controller I/O Templet Section 3 How to Configure Subsystems to Support CCF

BACKUP if an I/O attempt fails. When such an I/O attempt does fail and the backup
controller is not available, the system reacts as specified by this field.
Valid entries are:
LOOP OFF turn off the loop that could not perform the output
FAIL NODE fail the controller containing the loop
Default: LOOP OFF

PO CHANNEL NUMBER, PULSE INTERVAL, and PULSE WIDTH Fields


The lower portion of the Controller I/O Templet has PO CHANNEL NUMBER,
PULSE INTERVAL, and PULSE WIDTH fiels in which the parameters for the
pulse train outputs of the controller are specified. These channels are used by the
Pulse Train Output FCMs as described in Pulse Train Output FCM on page 331.
Enter the number of the digital channel being configured for pulse output in the PO
CHANNEL NUMBER column. It must be one of the digital channels configured
for output via the DIGITALS 1 through 40 fields. Enter the number of milliseconds
between consecutive leading edges of pulses into the PULSE INTERVAL column.
The default is 400. Enter the number of milliseconds between the leading and
falling edge of a pulse into the PULSE WIDTH column. The default is 200. The
PULSE INTERVAL and PULSE WIDTH entries must be multiples of the entry
made to the DO RATE field on the Controller Templet.
See Table 3 and Controller Digital Input and Output Channels on page 82, for a
detailed description of the numbering convention for the digital channels and
information on the methods of using digital channels.

Table 3. Software Channel Numbers for a Controller

Controller Digital Termination Controller Digital Termination


Assembly 1 Assembly 2
Termination Termination
Software Channel Software Channel
Board Channel Board Channel
1 1 1 21
2 2 2 22

80 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller I/O Templet

Table 3. Software Channel Numbers for a Controller (Continued)

Controller Digital Termination Controller Digital Termination


Assembly 1 Assembly 2
Termination Termination
Software Channel Software Channel
Board Channel Board Channel
3 3 3 23
4 4 4 24
5 5 5 25
6 6 6 26
7 7 7 27
8 8 8 28
9 9 9 29
10 10 10 30
11 11 11 31
12 12 12 32
13 13 13 33
14 14 14 34
15 15 15 35
16 16 16 36
17 17 17 37
18 18 18 38
19 19 19 39
20 20 20 40
21 41 21 45
22 42 22 46
23 43 23 47
24 44 24 48

3BUR002336R3701 RevA 81
Controller Digital Input and Output Channels Section 3 How to Configure Subsystems to Support

Controller Digital Input and Output Channels


A controller has 48 digital channels. Channels 1-40 are either digital input or digital
output. When you configure the Controller I/O Templet, the digital I/O channels are
referred to by software channel numbers as listed above. However, these channels
are brought into the controller via two hardware termination assemblies. Table 3
shows the relationship between the termination assembly board channels and the
software channel numbers.
Most fields on the Controller I/O Templet are used to configure the digital channels.
The DIGITALS 1 through 40 fields are used to specify each of the forty channels as
either a digital input or a digital output. The ICI 1 through 8 STATUS fields are used
to specify each interrupting contact input (ICI) field (channels 41 through 48) for
interrupting digital input or for pulse input. The PO CHANNEL NUMBER, PULSE
INTERVAL, and PULSE WIDTH fields are used to specify the pulse duration and
pulse width for pulse output channels.
When you configure digital channels for a controller, you should understand how
each digital channel is used by CCF loops. Points to consider are described in the
following paragraphs.
Digital inputs are used by certain types of continuous loops. Some of these loops get
the inputs by referencing values in other loops. However, some continuous loops
directly access the digital input channels via Digital Input FCMs. One Digital Input
FCM can read up to 16 digital channels. The channels read by one Digital Input
FCM must be consecutive channels on the controller. See Section 4, Defining
Continuous Loops, and Digital Input FCM on page 215.
Some continuous loops require pulse inputs. In a controller a pulse input is obtained
from one of the interrupting contact input channels numbered 41 to 48. The channel
used must be configured for pulse input via an ICI 1 through 8 STATUS field. For
example, if channel 43 is for a pulse input, a P must be entered in the ICI 3 STATUS
field. Loops that require a simple pulse input value use the Pulsed Input FCM. If the
loop requires an input in terms of a number of pulses per time unit (that is,
pulses/second, pulses/minutes, and so on), it uses both the Pulsed Input FCM and
the PI Time Derivative FCM. See Pulsed Input FCM on page 220, and Pulse Input
(PI) Time Derivative FCM on page 225. Controller Analog Input and Output
Channels on page 83, has information on a method of handling pulse inputs via the
analog input channels.

82 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Analog Input and Output

A continuous loop sending outputs to the field via the digital output channels of a
controller uses a Digital Output FCM. One of these FCMs can send outputs to as
many as 16 consecutive output channels. See Digital Output FCM on page 326.
A continuous loop sending a pulse output to the field does so via either a Pulse
Duration Output FCM or a Pulse Train Output FCM. See Pulse Duration Output
FCM on page 328, and Pulse Train Output FCM on page 331.
When a Pulse Duration Output FCM is executed, it produces a single pulse whose
duration is determined by the algorithm of the FCM. The pulse is sent to the field
via one of the channels configured for digital output.
When a Pulse Train Output FCM is executed, it determines the number of pulses in
a train of pulses sent to the field. If it outputs via a controller digital channel, the
channel must be configured for digital output via the corresponding DIGITALS 1
through 40 field. In addition, a pulse width and duration must be specified for the
channel via the PO CHANNEL NUMBER, PULSE INTERVAL, and PULSE
WIDTH fields on the Controller I/O Templet. The algorithm of the Pulse Train
Output FCM determines the number of pulses in the pulse train.
Device loops usually require digital inputs and send digital outputs to the field.
Since the outputs from a device loop must be sent to consecutive output channels,
care must be taken to insure the digital inputs for a device loop appear at
consecutive channels in the controller. The number of consecutive inputs and
outputs required by a device loop is determined by the device handling algorithm
for the loop. These algorithms are summarized in Table 38 of Section 11, Defining
Device Loops.

Controller Analog Input and Output Channels


Controller analog input channels are numbered 1 to 16 and are used by continuous
loops that have an Analog Input FCM. There are no configuration entries for the
analog input channels.

Considerations for Analog Inputs


Analog input channels can accept any analog input conditioned to a 1 to 5V dc
signal range. Typical input types are:
• 4 to 20mA dc from two wire and non-two wire transmitters

3BUR002336R3701 RevA 83
Controller Analog Input and Output Channels Section 3 How to Configure Subsystems to Support

• 0 to 10V dc
• millivolt inputs
• pulse rate inputs
• 1 to 5V dc from non-two wire transmitters
• thermocouples
• RTDs
The 6050N Controller Analog Termination Panel provides sixteen channels for non-
isolated analog inputs and eight channels for analog outputs. When isolated signal
conditioning for low and high level signals is needed, a 6003N Signal Conditioning
Card File with the equivalent number of I/O channels is used. This card file houses
signal conditioning modules each of which provides specific conditioning to one
field signal.
The following signal conditioning modules are available:
• 6150B Non-Isolated Analog Signal Conditioning Module
• 6152B Isolated Analog Signal Conditioning Module
• 6153B Isolated Millivolt Signal Conditioning Module
• 6154B Isolated Thermocouple Signal Conditioning Module
• 6155B Isolated RTD Signal Conditioning Module
• 6156B Isolated Pulse Signal Conditioning Module
See the Controller Signal Conditioning Modules instruction book for information
about the Signal Conditioning Card File and Modules. Section 4, Defining
Continuous Loops, Section 5, Input FCMS, and Section 9, Calculator FCMS, of this
manual describe how to handle the different types of analog inputs. The discussion
is intended for readers who have a general familiarity with continuous loops,
Analog Input FCMs, Linearization FCMs and Modified Square Root FCMs.

Analog Inputs for a Controller


High level analog inputs are brought into a controller by one of the following
methods:

84 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Analog Input and Output

• Non-isolated analog signal inputs from the field, ranging from 4 to 20mA dc or
from 1 to 5V dc, using the 6050N Controller Analog Termination Panel or the
6150B Non-isolated Analog Signal Conditioning Module.
• Isolated analog signal inputs from the field, ranging from 1 to 5V dc or from 0
to 10V dc, using the 6152 B Isolated Analog Signal Conditioning Module.
In both cases, the actual input to the controller is a 1 to 5V dc signal.
Figure 12 shows the signal flow through the hardware and software components
that transform the analog signals into values used by the CCF loops.

CONTROL AREA
Controller Subsystem

Controller CCF Software


Input Loop

Field Thermocouple Panel Signal Cond. A/D Analog Input Modified


Input or Card File Module Conversion FCM Sqr. Root
FCM
Converts field Converts Converts
signal to 1-5V 1-5V to counts to eng. Sqr. Root
counts: units or% extraction
1V = 750
5V = 3750

Figure 12. Analog Inputs for a Controller

• The signal (4 to 20mA dc, 1 to 5V dc, or 0 to 10V dc) is produced in the field.
• The signal enters the Controller Subsystem at the Controller Analog
Termination Panel or Signal Conditioning Card File.
• The signal is converted to 1 to 5V dc.
• The analog signal is converted to digital at the controller. The conversion range
is such that 1V is converted to 750 counts and 5V becomes 3750 counts.
• The input goes to a CCF loop.
• The Analog Input FCM converts the counts value to an equivalent engineering

3BUR002336R3701 RevA 85
Controller Analog Input and Output Channels Section 3 How to Configure Subsystems to Support

units or percent value.


• The Modified Square Root FCM is often the second FCM in the loop. A typical
application of this FCM is square root extraction on signals coming from
differential pressure transmitters without built-in square root extractors.
• The value in engineering units or percent is then passed on to other FCMs in
the loop if needed.
Example 1 - Differential Pressure Transmitter with Built-in Square Root
Extractor
A transmitter measures differential pressure across an orifice plate. The transmitter
has a built-in square root extractor and provides a 4 to 20mA dc signal proportional
to flow in which 4mA represents 0 flow and 20mA represents 500 GPM.
• The Loop Definition Templet must indicate the loop contains an Analog Input
FCM. Other FCMs can follow the Analog Input FCM. Since the result of the
Analog Input FCM is the flow value, it is chosen as the measured variable of
the loop.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the analog input channel,
1-16
RTD, TC, OR HI-LEVEL field HI-LEVEL
ENGU - LOWER BOUND field engineering units value equivalent to a
4mA signal from the field (0 for this
example)
ENGU - UPPER BOUND field engineering units value equivalent to a
20mA signal from the field (500 for this
example)
The COUNTS fields should be kept at their defaults. That is,
COUNTS - LOWER BOUND field 750
COUNTS - UPPER BOUND field 3750
Input limiting is specified in the normal manner via the INPUT LIMITED field of
the templet.

86 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Analog Input and Output

Example 2 - Differential Pressure Transmitter Without Built-in Square Root


Extractor
A transmitter measures differential pressure across an orifice plate. It provides a 4 to
20mA dc signal proportional to differential pressure. 4mA represents the differential
pressure at 0 flow and 20 MA represents the differential pressure at 500 GPM.
• The Loop Definition Templet must indicate the loop contains an Analog Input
FCM which sends its result to a Modified Square Root FCM. The Modified
Square Root FCM is required because the transmitter does not have a built-in
square root extractor. Other FCMs can follow the Modified Square Root FCM
for further processing. The result of the Modified Square Root FCM is the flow
value, it is chosen as the loop measured variable.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the analog input channel,
1-16
RTD, TC, OR HI-LEVEL field HI-LEVEL
ENGU - LOWER BOUND and ENGU - UPPER BOUND fields should be
chosen to scale the input into percent because the Modified Square Root FCM
requires an input in percent:
ENGU - LOWER BOUND field 0 (for 0% of range)
ENGU - UPPER BOUND field 100 (for 100% of range)
The COUNTS fields should be kept at their defaults. That is,
COUNTS - LOWER BOUND field 750
COUNTS - UPPER BOUND field 3750
Input limiting is specified in the INPUT LIMITED field.
• The Modified Square Root FCM Templet entries for the loop must include the
following:
INPUT SOURCE field PREVIOUS FCM

3BUR002336R3701 RevA 87
Controller Analog Input and Output Channels Section 3 How to Configure Subsystems to Support

HI ENG UNITS field engineering units value equivalent to a


20mA signal from the field (500 for this
example)
LO ENG UNITS field engineering units value equivalent to a
4mA signal from the field (0 for this
example)

Millivolt Inputs for a Controller


Millivolt inputs to a controller are brought in via the 6153B Isolated Millivolt Signal
Conditioning Module. Inputs from the field device range from 0 to 10 mV or 0 to
100 mV. The signal conditioning module provides 1 to 5V dc to the controller. This
module is shipped with calibration suitable to your choice of range.
Figure 13 shows the signal flow through the hardware and software components
used to convert millivolt signals to data that can be used by the CCF loops.

CONTROL AREA

Controller Subsystem Controller CCF Software


Input Loop

Millivolt Termination Panel Signal Cond. A/D Analog Input


Input Conversion FCM To other
Module FCMs
Converts field Converts Converts
signal to 1-5V 1-5V to counts to eng.
counts: units
1V = 750
5V = 3750

Figure 13. Millivolt Inputs for a Controller

• The signal is produced in the field.


• The signal enters the Controller Subsystem at the Signal Conditioning Card
File.
• The Signal Conditioning Module amplifies the signal to an extent that 1V
represents the low value of the range and 5V represents the high value.

88 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Analog Input and Output

• The analog signal is converted to digital at the controller. The conversion range
is such that 1V is converted to 750 counts and 5V becomes 3750 counts.
• The input goes to a CCF loop. The first FCM of the loop must be an Analog
Input FCM.
• The Analog Input FCM converts the counts value to an equivalent engineering
units value.
• The engineering units value is then passed on to other FCMs in the loop if
needed.
Example:
• Choose the millivolt input device range to suit the application. A calibrated
6153B Isolated Millivolt Signal Conditioning Module is shipped to you based
on your choice of range.
• The Loop Definition Templet must indicate the loop contains an Analog Input
FCM. Other FCMs can follow the Analog Input FCM.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the analog input channel,
1-16.
RTD, TC, OR HI-LEVEL field HI-LEVEL (controller sees 1-5V
signal)
ENGU - LOWER BOUND field bottom of engineering units range
ENGU - UPPER BOUND field top of engineering units range
The COUNTS fields should be kept at their defaults. That is,
COUNTS - LOWER BOUND field 750
COUNTS - UPPER BOUND field 3750
Input limiting is specified in the normal manner via the INPUT LIMITED field of
the templet.

3BUR002336R3701 RevA 89
Controller Analog Input and Output Channels Section 3 How to Configure Subsystems to Support

Thermocouple Inputs for a Controller


Thermocouple inputs to a controller are brought in via the 6154B Isolated
Thermocouple Signal Conditioning Module. This module is shipped configured to
your choice of thermocouple type and range. The linearization for a thermocouple
input is performed by the Linearization FCM. Table 4 lists the standard temperature
ranges supported by this FCM.

Table 4. Temperature Ranges Supported by the Linearization FCM

INPUT TYPE TEMPERATURE RANGE


Thermocouple RTD Degrees F (°F) Degrees C (°C)
B 986 to 3308° 530 to 1820°
E -328 to 1832° -200 to 1000°
J -346 to 1400° -210 to 760°
K -328 to 2502° -200 to 1372°
R 32 to 3214° 0 to 1768°
S 32 to 3214° 0 to 1768°
T -430 to 752° -257 to 400°
DIN(1) -328 to 1571° -200 to 855°
BURNS(2) -328 TO 1202° -200 to 650°
(1) A DIN RTD has a ratio of R100 DEGC/R0 DEGC = 1.385.
(2) A BURNS RTD has a ratio of R100 DEGC/R0 DEGC = 1.3902.

A number of hardware and software components are used to convert the voltage
signal transmitted from a thermocouple into a value in degrees used by the CCF
loops. Figure 14 shows the signal flow through these hardware and software
components.

90 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Analog Input and Output

CONTROL AREA
Controller Subsystem
Controller CCF Software
Input Loop

T/C Termination Panel Signal Cond. A/D Analog Input Linearization


Input Module Conversion FCM FCM
Cold junction
Table Lookup
Converts mv Converts Converts Linearization
signal to 1-5V 1-5V to counts to and convert
counts: microvolt equiv. to degrees
1V = 750
5V = 3750

Figure 14. Thermocouple Inputs for a Controller

• The signal is produced in the field by the thermocouple.


• The connection between the thermocouple wires and the screws in the
termination panel creates a cold junction effect. This results in a decrease in the
signal voltage.
• The Signal Conditioning Module compensates for the cold junction effect. It
also amplifies the signal to an extent that 1V represents the low value of the
thermocouple range and 5V represents the high value.
• The analog signal is converted to digital at the controller. The conversion range
is such that 1V is converted to 750 counts and 5V becomes 3750 counts.
• The input goes to a CCF loop. The first FCM of the loop must be an Analog
Input FCM. It must be immediately followed by a Linearization FCM.
• The Analog Input FCM converts the counts value to an equivalent voltage
value. (The voltage is expressed in microvolts because the Linearization FCM
must have an input expressed in microvolts.)
• The Linearization FCM uses standard tables to perform the linearization. It
then converts the microvolt value into a value in degrees.
• The value in degrees is then passed on to other FCMs in the loop if needed.

3BUR002336R3701 RevA 91
Controller Analog Input and Output Channels Section 3 How to Configure Subsystems to Support

Example:
• The thermocouple type and range should be chosen to suit the application.
Types B, E, J, K, R, S, and T thermocouples are supported by the Advant OCS.
A calibrated 6154B Isolated Thermocouple Signal Conditioning Module is
shipped configured to your choice of thermocouple type and range.
Assume, for this example, the thermocouple is type J and works on a range of
100° to 400° F.
• The Loop Definition Templet must specify the loop containing an Analog Input
FCM sending its result to a Linearization FCM. Other FCMs can follow the
Linearization FCM. Since the result of the Linearization FCM is the
temperature value, it is chosen as the measured variable of the loop.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the analog input channel,
1-16.
RTD, TC, OR HI-LEVEL field HI-LEVEL (HI-LEVEL is used instead
of TC because the controller gets a 1 to
5V signal)
Using thermocouple tables, it is found that a type J thermocouple operating on
a range of 100° to 400° F produces a voltage ranging from 1.942mV to
11.623mV. These values must be converted to microvolts because the
thermocouple tables of the Linearization FCM are designed to have its input
scaled in microvolts. Therefore:
ENGU - LOWER BOUND field = 1.942 x 1000 = 1942
ENGU - UPPER BOUND field = 11.023 x 1000 = 11023
The COUNTS fields should be kept at their defaults. That is,
COUNTS - LOWER BOUND field 750
COUNTS - UPPER BOUND field 3750
Input limiting is specified in the normal manner via the INPUT LIMITED
field.
• The Linearization FCM Templet entries for the loop must include the

92 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Analog Input and Output

following:
INPUT SOURCE field PREVIOUS FCM
TEMPERATURE SCALE field F (specifies the output of the
Linearization FCM is scaled in
degrees F.)
COMPENSATION TYPE field NONE
ELEMENT TYPE field J

RTD Inputs for a Controller


RTD inputs are brought in via the 6155B Isolated Thermocouple Signal
Conditioning Module. This module is shipped configured to your choice of RTD
type and range.
The linearization for an RTD input is performed by the Linearization FCM. This
FCM has tables for linearizing DIN RTDs on a range of -328 to 1571° F (-200 to
855° C) and BURNS RTDs on a range of -328 to 1202° F (-200 to 650° C).
A DIN RTD has a ratio of
R100 DEGC / R0 DEGC = 1.385
A BURNS RTD has a ratio of
R100 DEGC / R0 DEGC = 1.3902
A number of hardware and software components are used to convert the signal
transmitted from a RTD into a value in degrees used by the CCF loops. Figure 15
shows the signal flow through these hardware and software components.

3BUR002336R3701 RevA 93
Controller Analog Input and Output Channels Section 3 How to Configure Subsystems to Support

CONTROL AREA
Controller Subsystem
Controller CCF Software
Input Loop

RTD Termination Panel Signal Cond. A/D Analog Input Linearization


Input Module Conversion FCM FCM
Table Lookup
Converts RTD Converts Converts Linearization
signal to 1-5V 1-5V to counts to and convert
counts: ohm equiv. ohm to degrees
1V = 750
5V = 3750

Figure 15. RTD Inputs for a Controller

• The signal is produced in the field by the RTD.


• The signal enters the controller at the termination panel.
• The Signal Conditioning Module converts the signal to a voltage signal in
which 1V represents the low value of the RTD range and 5 V represents the
high value.
• The analog signal is converted to digital at the controller. The conversion range
is such that 1V is transformed to 750 counts and 5V becomes 3750 counts.
• The input goes to a CCF loop. The first FCM of the loop must be an Analog
Input FCM, followed by a Linearization FCM.
• The Analog Input FCM converts the counts value to an equivalent ohms value.
• The Linearization FCM uses standard tables to perform the linearization. It
then converts the ohms value into a value in degrees.
• The value in degrees is then passed on to other FCMs in the loop if needed.
Example 1 - RTD with a 100 Ohm Element
• The RTD type and range are chosen to suit the application. BURNS and DIN
type elements are supported for 100 ohm elements. A calibrated 6155B
Isolated RTD Signal Conditioning Module is shipped configured to your
choice of RTD type and range.

94 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Analog Input and Output

For this example assume the RTD is type DIN with a 100 ohm element and
works on a range of 100° C to 300° C.
• The Loop Definition Templet must specify the loop containing an Analog Input
FCM which sends its result to a Linearization FCM. Other FCMs may follow
the Linearization FCM. Since the result of the Linearization FCM is the
temperature value, it is chosen as the measured variable of the loop.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the analog input channel,
1-16.
RTD, TC, OR HI-LEVEL field HI-LEVEL (HI-LEVEL is used instead
of RTD because the controller gets a 1
to 5V signal)
RTD tables indicate that a type DIN RTD with a range of 100 to 300° C
produces a resistance value in 138.5 ohms to 212.02 ohms range. The entries in
the ENGU fields are:
ENGU - LOWER BOUND field 138.5
ENGU - UPPER BOUND field 212.02
The COUNTS fields should be kept at their defaults. That is,
COUNTS - LOWER BOUND field 750
COUNTS - UPPER BOUND field 3750
Input limiting is specified in the normal manner via the INPUT LIMITED
field.
• The Linearization FCM Templet entries for the loop must include the
following:
INPUT SOURCE field PREVIOUS FCM
TEMPERATURE SCALE field C (to specify the output of the
Linearization FCM is scaled in
degrees C)
COMPENSATION TYPE field NONE
ELEMENT TYPE field DIN

3BUR002336R3701 RevA 95
Controller Analog Input and Output Channels Section 3 How to Configure Subsystems to Support

Example 2 - RTD with a 200 Ohm Platinum Element


• The RTD type and range are chosen to suit the application. BURNS and DIN
type elements are supported by the standard linearization tables for 100 ohm
elements. A calibrated 6155BZ Isolated RTD Signal Conditioning Modules
shipped configured to your choice of RTD type and range.
This example assumes the RTD is a BURNS type with a 200 ohm element and
works on a range of 50° C to 450° C.
• The Loop Definition Templet must specify the loop contains an Analog Input
FCM which sends its result to a Linearization FCM. Other FCMs may follow
the Linearization FCM. Since the result of the Linearization FCM is the
temperature value, it is chosen as the measured variable of the loop.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the proper analog input
channel
RTD, TC, OR HI-LEVEL field HI-LEVEL (HI-LEVEL is used instead
of RTD because the controller gets a 1
to 5V signal)
Use RTD tables to find the ohms values for the ENGU fields. However, you
must be careful to insure that the ohms values are the proper ones for a 200
ohm element. Using BURNS RTD tables, it is found that a 100 ohm element
RTD operating on a range of 50 to 450° C produces a resistance value ranging
from 119.66 to 266.34 ohms. The transmitter for a 200 ohm element would be
calibrated for a range of 239.32 to 532.68 ohms.
For linearization to work correctly, the engineering units values must be
entered as resistance values a 100 ohm element would provide over the
specified temperature range. Therefore, the entries in the ENGU fields are:
ENGU - LOWER BOUND field 119.66
ENGU - UPPER BOUND field 266.34
The COUNTS fields should be kept at their defaults. That is,
COUNTS - LOWER BOUND field 750
COUNTS - UPPER BOUND field 750

96 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Controller Analog Input and Output

Input limiting is specified in the normal manner via the INPUT LIMITED
field.
• The Linearization FCM Templet entries for the loop must include the
following:
INPUT SOURCE field PREVIOUS FCM
TEMPERATURE SCALE field C (to specify the output of the
Linearization FCM is scaled in
degrees C)
COMPENSATION TYPE field NONE
ELEMENT TYPE field BURNS

Pulse Inputs for a Controller


Pulse inputs to a controller are brought in by the 6156B Isolated Pulse Signal
Conditioning Module. It can accept inputs ranging from 0 to 375 Hz, 0 to 3 K Hz, or
0 to 24 K Hz. This module is shipped configured to your choice of pulse and range.
Figure 16 shows the signal flow through the hardware and software components
used to convert the millivolt signals into data used by the CCF loops.

CONTROL AREA
Controller Subsystem
Controller CCF Software
Input Loop

Pulse Termination Panel Signal Cond. A/D Analog Input


Input Conversion FCM To other
Module FCMs
Converts field Converts Converts
signal to 1-5V 1-5V to counts to
counts: eng. units
1V = 750
5V = 3750

Figure 16. Pulse Inputs via the 6156B Pulse Input Signal Conditioning Module for a Controller

3BUR002336R3701 RevA 97
Controller Analog Input and Output Channels Section 3 How to Configure Subsystems to Support

• The signal is produced in the field.


• The signal enters the controller at the Signal Conditioning Card File.
• The Signal Conditioning Module converts the signal to a voltage signal in
which 1V represents 0 Hz and 5V represents the high value.
• The analog signal is converted to digital at the controller. The conversion range
is such that 1V is transformed to 750 counts and 5V becomes 3750 counts.
• The input goes to a CCF loop. The first FCM of the loop must be an Analog
Input FCM.
• The Analog Input FCM converts the counts value to an equivalent engineering
units value.
• The engineering units value is then passed on to other FCMs in the loop if
needed.
Example:
• The pulse range should be chosen to suit the application. A calibrated 6156B
Isolated Pulse Signal Conditioning Module is shipped configured to your
choice of range.
• The Loop Definition Templet must specify the loop contains an Analog Input
FCM. Other FCMs can follow the Analog Input FCM.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the analog input channel,
1-16.
RTD, TC, OR HI-LEVEL field HI-LEVEL (HI-LEVEL is used
because the controller sees the signal at
a 1 to 5V level)
ENGU - LOWER BOUND field bottom of engineering units range
ENGU - UPPER BOUND field top of engineering units range
The COUNTS fields should be kept at their defaults. That is,
COUNTS - LOWER BOUND field 750
COUNTS - UPPER BOUND field 3750

98 3BUR002336R3701 RevA
Section 3 How to Configure Subsystems to Support CCF Backup Controller Templet

Input limiting is specified in the normal manner via the INPUT LIMITED field.
See the paragraphs of this section titled Analog Inputs for a Controller, for a method
of handling pulse inputs coming from the interrupting contact inputs of the
controller.

Backup Controller Templet


A Backup Controller Templet, Figure 17, specifies the general parameters for a
Backup Controller.

Figure 17. Backup Controller Templet

TEMPLET NAME Field


Use this field to specify the name all applications use to identify this backup
controller. The templet names must be unique, that is, no two templets can have the
same name.
Valid entry is:
a character string of up to 21 characters

TEMPLET TYPE, PARENT NAME, and DATABASE NAME Fields


These fields are automatically filled in, and are for information only.

3BUR002336R3701 RevA 99
Backup Controller Templet Section 3 How to Configure Subsystems to Support CCF

PHYSICAL DEVICE Field


This field specifies the position of the backup controller in the Controller
Subsystem.
Valid entry is:
an integer from 1 to 12. For 11-1 redundancy, the backup controller is at
position 4.
Default is: 4

SOFTWARE NAME Field


This field specifies the name of the software set downloaded to the backup
controller upon start-up. All redundant controllers in a subsystem and the backup
controller must have the same software name. The cards must have identical
software in order to back them all up. The backup controller does not have to be
connected to a Local Control Panel Plus (LCP+) in order to have LCP software
loaded into it.
Valid entries are:

CONTROLLER This is used for 6004B Control Modules in a subsystem with


11 to 1 redundancy. It is used in a subsystem that either has
no backup controllers or one backup controller in position 4,
and no Manual/Auto Operator Station (M/A Station) or LCP+
is connected to the controller.
CTLR3TO1 This is used for 6004B Control Modules in a subsystem with
3 to 1 redundancy (that is, there are backup controllers in
positions 4, 8 and 12), and no M/A Station or LCP+ is
connected to the controller.
DIGITAL This is used when the controller uses the M/A Station option
and 11 to 1 redundancy. See A170, Operator Station for
details.
DIG3TO1 This is used when the controller uses the M/A Station option
and 3 to 1 redundancy. See A170, Operator Station for
details.

100 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Backup Controller Templet

CONTLCP This is used when the controller uses the LCP+ option and
11 to 1 controller redundancy. One Area Control Panel must
be inserted as a child of the Controller Templet. It must
specify the serial port the LCP+ is connected to via the
PORT NUMBER field, and it must define the name for the
port via the PORT NAME field. The Area Control Panel and
the LCP+ are described in the Local Control Panel Plus
(LCP+) instruction book.
LCP3TO1 This is used when the controller uses the LCP+ option and
3 to 1 controller redundancy. This option is described in the
Local Control Panel Plus (LCP+) instruction book.
SC_CTLR This is used for 6204B Control Modules in a subsystem with
11 to 1 redundancy. The backup controller must be in
position 4.
SC_CTLR3TO1 This is used when the backup controller is a 6204B Control
Module.in a subsystem with 3 to 1 redundancy. The backup
controllers are in positions 4, 8, and 12.

Default is: CONTROLLER

The SC Controller Backup Memory Module (SC-BMC) must


always be placed in the first card file of a subsystem with 11 to 1
redundancy. Also the SC-BMC requires an Extender Module
resident in every card file on the pbus. These SC-BMC Extender
Modules must be specifically jumpered for the card file where they
reside. Failure to follow these directives result in problems with
control redundancy software.

The Smart Device Interface is supported only on SC Controllers.


Therefore, if a subsystem contains a Smart Device Interface, the
only valid entries for the SOFTWARE NAME field are SC_CTLR
and SC_CTLR3TO1.

3BUR002336R3701 RevA 101


Smart I/O Templets Section 3 How to Configure Subsystems to Support CCF

Smart I/O Templets


Each smart device that sends input (variable values) to the Advant OCS must be
supported by one or more CCF loops that reside in the SC Controller. These loops
serve as a mechanism by which the information from words (registers) and bits
(coils) of the smart device are read from the Advant OCS data base and manipulated
as required. See Section 4, Defining Continuous Loops, and Section 5, Input FCMS,
and Section 3.3.5 of the Smart Device Interface User's Guide for information about
configuring loops that receive input from smart devices.
For each smart device serial port providing input for loops, you must complete a
Smart I/O Templet to identify the serial I/O port to which its associated Small
HART Interface Module (SHIM) is connected. You must also complete a Smart I/O
Network Templet for each SHIM connected to the port to identify its SHIM network
address and the following parameters for each smart device connected to that
SHIM:
• smart device's tag name
• smart device's transmitter address on the SHIM
• starting CCF channel number to place four inputs (primary value, secondary
value, tertiary value, and fourth value) read from the smart device
• descriptor for general use

Smart I/O Templet


Figure 18 shows a Smart I/O Templet.

102 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Smart I/O Templet

Figure 18. Smart I/O Templet

TEMPLET NAME Field


Use this field to specify the name all applications use to identify the SHIM
connected to the serial I/O port.
Valid entry is:
an alphanumeric string of up to 8 characters

TEMPLET TYPE, PARENT NAME, and DATABASE NAME Fields


These fields are automatically filled in by the system, and are for information only.

PORT NAME Field


This field specifies the logical name for the serial I/O port that the SHIM is
connected to. The name you specify should be the same as the name specified on the
Serial Port Setup Templet and must be unique system-wide.
Valid entry is:
an alphanumeric string of up to 12 characters, but the first three characters
must be SDI for Smart Device Interface

3BUR002336R3701 RevA 103


Smart I/O Network Templet Section 3 How to Configure Subsystems to Support CCF

Smart I/O Network Templet


Figure 19 shows a Smart I/O Network Templet.

Figure 19. Smart I/O Network Templet

TEMPLET NAME Field


Use this field to specify the name all applications use to identify the SHIM
connected to the serial I/O port.
Valid entry is:
an alphanumeric string of up to 8 characters

104 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Smart I/O Network Templet

PARENT NAME Field


This field is automatically filled in by the system, and is for information only.

NETWORK ADDRESS Field


This field specifies the MODBUSB slave address set via DIP switch S1 on the
SHIM.
Valid entry is:
an integer from 1 to 31 since you can connect up to 31 SHIMs to a serial I/O
port of a SC Controller's I/O Interface Module via a RS-485 Bus

SMART TAG, SMART ADDRESS, CHANNEL and DESCRIPTION Fields


These fields are used to specify the tag name, SHIM address, CCF channel, and
descriptor for each smart device connected to the SHIM. You must complete a row
of fields for each smart device connected to the SHIM. For example, if six smart
devices are connected to the SHIM, complete six rows of fields.
Valid entry for the SMART TAG field is:
an alphanumeric string of up to 8 characters which must be the same as the tag
name specified during the smart device's initial configuration
Valid entry for the SMART ADDRESS field is:
an integer from 1 to 8 identifying the address on the SHIM where the smart
device communicates. You can connect up to 4 smart devices to a SHIM-4,
therefore, valid transmitter addresses for smart devices connected to a SHIM-4
are 1 through 4. You can connect up to 8 smart devices to a SHIM-8, therefore,
valid transmitter addresses for smart devices connected to a SHIM-8 are 1
through 8.
Valid entry for the CHANNEL field is:
an integer in the range of 1 to 32767 for the CCF channel where the first of the
smart device's four input values (primary, secondary, tertiary, and fourth value)
are stored

3BUR002336R3701 RevA 105


CCF in Turbo Nodes Section 3 How to Configure Subsystems to Support CCF

There is only one analog smart device channel table in a subsystem


supporting smart devices. Therefore, if a smart device uses channel
115 for an input, channel 115 should not be used by any other smart
device for input.
Valid entry for the DESCRIPTOR field is:
an alphanumeric string of up to 24 characters

CCF in Turbo Nodes


A Turbo Node Subsystem contains one processor which can execute CCF in
combination with other Turbo Node functions. It can support up to 14 Multibus I/O
modules or 6 Remote I/O or a combination. The loops defined in the subsystem can
either use the I/O facilities of the Multibus I/O, Remote I/O or can get their inputs
from other loops.
Figure 20 shows the templet structure of a Turbo Node Subsystem.

106 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF CCF in Turbo Nodes

Data Base

Configuration Configuration Device


Area Area Descriptor
Directory

Generic DPSS
Device
Descriptor
Templets

Other Remote I/O TCL


Multibus I/O CCF Taylor Ladder Logic Smart I/O
Templets for (One for each Templets
Turbo Node Bus)

Smart I/O
Network

Remote I/O Module


Templets. One per More Loops
module on Field Bus
Loop Breakpoint
Device Loops
Definition Sets

FCM
Templets

Figure 20. CCF Related Templets for Turbo Node Subsystems

3BUR002336R3701 RevA 107


Generic DPSS Templet Section 3 How to Configure Subsystems to Support CCF

Generic DPSS Templet


Generic DPSS Templet, Figure 21, is the parent templet for a number of functions
which in turn have children of their own. Several of the children have direct
influence on CCF. They are described in more detail in later sections of the manual.

Figure 21. Generic DPSS Templet

TEMPLET NAME Field


Use this field to specify the name that all applications use to identify this Turbo
Node. The templet names must be unique, that is, no two templets can have the
same name.
Valid entry is:
a character string of up to 21 characters

108 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Generic DPSS Templet

PARENT NAME Field


This field is automatically filled in by the system, and is for information only.

PHYSICAL DEVICE Field


This field requires an entry. It specifies the DCN address of the Multibus I/O
Subsystem.
Valid entry is:
an integer from 1 to 255. The entry must match the setting of the D/M (DCN to
Multibus) Switch in the Subsystem.

AUTO START Field


This field determines whether the turbo node starts processing automatically when
the software and data base are downloaded to it.
Valid entry is:
YES start processing immediately upon download.
Default is: YES

SOFTWARE NAME Field


This field specifies the name of the software set downloaded to the turbo node upon
start-up.
Valid entries are: TURBO, TURBODP, TURBOGW
Default is: TURBO

3BUR002336R3701 RevA 109


Generic DPSS Templet Section 3 How to Configure Subsystems to Support CCF

If the subsystem has a VAX or Smart Device Interface and other


turbo node functions, the only valid entries for the SOFTWARE
NAME field are TURBO and TURBOGW.
Use TURBO if the subsystem needs all turbo node functions
including data processing, history, console, and interfaces. Use
TURBOGW if it only needs data processing, history, and interface
functions. Do not use TURBODP if the subsystem contains a Smart
Device Interface because it does not support such an interface.
Certain Advant Station node types do not need any ROUTE_LIST
records or only need one. ES nodes only need one and IMS nodes
do not need any ROUTE_LIST records. For such nodes, prepend an
ES or IMS to your entry in the SOFTWARE NAME field of the
GENERICD object.

DO RATE Field
This field specifies the minimum resolution of any pulse output for the subsystem.
For pulse duration outputs, the pulse duration value calculated by the Pulse
Duration Output FCM is rounded to the next lower multiple of the DO rate prior to
production of the pulse. For pulse train outputs, the pulse width and interval
specified through the PO CHANNEL NUMBER, PULSE INTERVAL, and PULSE
WIDTH fields of the Multibus I/O Templet must be multiples of the DO rate.
Valid entry is:
a number of milliseconds as either 20, 40, 100, 200, or 1000
Default is: 40

SECONDARY DP Field
The functionality associated with this field has not been implemented.

BACKUP ENABLE Field


The functionality associated with this field has not been implemented.

110 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Multibus I/O Templet

BACKUP OVERRIDE Field


The functionality associated with this field has not been implemented.

DEFAULT ENVIRONMENT Field


This field identifies the environment automatically loaded upon start-up or
rebooting. This field is only applicable if your system has console functionality.
Valid entry is:
name of a properly defined and compiled environment

NODE TYPE
This field specifies the hardware platform for the GENERICD node.
Valid entry is:
MOD300_NODE This option is for a Multibus-based node.
ADVANT_STATN This option is for an Advant Station.

Multibus I/O Templet


The Multibus I/O Templet, Figure 22 through Figure 24, is used to specify general
parameters and I/O characteristics of a Multibus I/O Subsystem. A Multibus I/O
templet must be configured for each Multibus I/O Subsystem. Each subsystem can
support up to 14 of the following modules:
6100B Analog Input Module
6101B Analog Input Expander Module
6102B Millivolt/Thermocouple Input Module
6105B RTD Input Module
6106B Pulse Input Module
6107B Digital I/O Module
6108B Analog Output Module
The middle portion of the Multibus I/O Templet, Figure 23, is used to specify the
parameters for the analog input and pulse output of the Multibus I/O.

3BUR002336R3701 RevA 111


Multibus I/O Templet Section 3 How to Configure Subsystems to Support CCF

The AI CHAN field and the AI GAIN field are used to specify the gains of the
analog input channels.
You must specify the default gain value in the AI DEFAULT CHAN GAIN field. If
a channel uses this default value, no entry is needed in the AI CHAN and AI GAIN
fields. However, if a channel uses a gain value different from the default, the AI
CHAN and AI GAIN field entries must be completed.
Analog Inputs in Multibus I/O Subsystems on page 118, discusses the affects of
different channel gains on the loops using the analog inputs.

Figure 22. Multibus I/O Templet, Upper Portion

112 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Multibus I/O Templet

Figure 23. Multibus I/O Templet, Middle Portion

3BUR002336R3701 RevA 113


Multibus I/O Templet Section 3 How to Configure Subsystems to Support CCF

Figure 24. Multibus I/O Templet, Lower Portion

TEMPLET NAME Field


Use this field to specify the name that all applications use to identify this
Subsystem. The templet names must be unique, that is, no two templets can have the
same name.
Valid entry is:
a character string of up to 21 characters

114 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Multibus I/O Templet

PARENT NAME Fields


This field is automatically filled by the system, and is for information only.

AO CARDS Field
This field specifies the total number of 6108B Analog Output Modules in this
subsystem. Information on how to use AO channels is provided in Analog Outputs
in Multibus I/O Subsystems on page 124.
Default is: 0

PULSE INPUT CARDS Field


This field specifies the number of 6106B Pulse Input Modules in this subsystem.
Information on how to use pulse inputs is provided in Pulse Inputs in Multibus I/O
Subsystems on page 144.
Default is: 0

RTD INPUT CARDS Field


This field specifies the number of 6105N RTD Input Modules in this subsystem.
Information on how to use RTD inputs is provided in RTDs in Multibus I/O
Subsystems on page 139.
Default is: 0

THERMOCOUPLE CARDS Field


This field specifies the total number of 6102B Millivolt/Thermocouple Input
Modules in this subsystem. Information on how to use T/C inputs is provided in
Thermocouples in Multibus I/O Subsystems on page 126. Information on how to
use millivolt inputs is provided in Millivolt and Voltage Inputs via 6102D
Millivolt/Thermocouple Modules on page 137.
Default is: 0

3BUR002336R3701 RevA 115


Multibus I/O Templet Section 3 How to Configure Subsystems to Support CCF

AI CARD NUMBER and MASTER/SLAVE Fields


Use these fields to specify whether an analog input card is the master or slave card.
For each card, you must enter the card number and either an M for Master (6100B
Analog Input Module) or an S for Slave (6101B Analog Input Expander Module).
Cards are numbered in the order of their hardware addresses (1 is assigned to the
card at the lowest hardware address). A master card can have either one slave or no
slaves. The entry for a slave card must follow the entry for its associated master
card. In the example below, card 2 is the slave of card 1. Analog Inputs in Multibus
I/O Subsystems on page 118, discusses module and channel numbering.
Example:

AI CARD NUMBER MASTER/SLAVE


1 M
2 S

TTL CARD # Field


The digital I/O ports for a Multibus I/O Subsystem are provided by the 6107B
Digital I/O Modules. Each module has 9 ports, each port has 8 channels, for a total
of 72 channels per module. The 8 channels of a port must be either all inputs or all
outputs.
On the left side of the upper portion of the templet, there are two columns of fields
labelled TTL CARD # and 123456789. These fields are used to specify which of the
ports are for digital output and which are for digital input.
The entries to the TTL CARD # and 123456789 fields are the module (card) number
and the designation of each of its ports as either I (input) or O (output).
For example, to specify the first 3 ports on the module with the lowest hardware
address are outputs and the last six ports are inputs, the entries in the TTL CARD #
and 123456789 fields are:

TTL CARD# 1 2 3 4 5 6 7 8 9
1 O O O I I I I I I

116 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Multibus I/O Templet

You can use these short cuts when making entries. If all ports of a card are of the
same type, it is only necessary to put in an entry for port 1, ports 2 to 9
automatically use the same type. If entries are made for ports 1 to 5 only, ports 6 to
9 automatically use the entry made to port 5.
During console configuration, if you specified that you want to use contact outputs
for external alarm indicators, you must make entries to the TTL CARD # and
123456789 fields to support the external alarms as indicated in the Console
Configuration User's Guide.

AI DEFAULT CHAN GAIN Field


Use this field to specify a default gain value for the AI channels of the Multibus I/O.
The gain values are powers of 2 between 1 and 1024 and are listed below.
Valid entries are:1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024
Default is: 1

AI CHANNEL and AI GAIN Fields


This window is used to configure the gain for analog input channels that do not use
the default gain value. For each of these channels, the required entries are the
channel number and the desired gain value. The possible gain values are 1, 2, 4, 8,
16, 32, 64, 128, 256, 512, and 1024.
Example:
AI CHANNEL AI GAIN
1 8
7 128

PO CHANNEL NUMBER, PULSE INTERVAL, and PULSE WIDTH Fields


These fields are used to designate the digital output channels used for pulse outputs.
They also specify the size of the pulses for the channels. These channels are used by
the Pulse Train Output FCMs as described in Pulse Train Output FCM on page 331.
The following items are entered for each of these channels:
• The number of the digital channel being configured for pulse output in the PO
CHANNEL NUMBER column. It must be one of the digital channels

3BUR002336R3701 RevA 117


Analog Inputs in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

configured for output via the DIGITALS 1 through 40 fields on the Controller
I/O Templet.
• The number of milliseconds between consecutive leading edges of pulses in the
PULSE INTERVAL column. It must be a multiple of the DO rate specified on
the Generic DPSS Templet. The default is 80.
• The number of milliseconds between the leading and falling edge of a pulse in
the PULSE WIDTH column. It must be a multiple of the DO rate specified on
the Generic DPSS Templet. The default is 40.
Pulse outputs and other digital outputs are described in Digital Inputs and Outputs in
Multibus I/O Subsystems on page 125.

Analog Inputs in Multibus I/O Subsystems


Analog input channels are provided by the 6100B Analog Input Module and 6101B
Analog Input Expander Module. The 6100B module is a master module with 15
channels. The 6101B module is a slave module with 48 channels. You can use
master modules alone, but the slaves can only exist in master/slave pairs. If the
analog input for a Multibus I/O uses one master/slave combination, the master has
channels 1 to 15 and the slave has channels 16 to 63. If there are multiple modules,
the module at the lowest hardware address is module 1. If module 1 has a slave, the
slave is module 2. If module 1 has no slave, the next master is module 2.
For example, in a Multibus I/O Subsystem with two master/slave analog input
combinations, the channels are numbered as follows:
Module 1 (master) channels 1-15
Module 2 (slave) channels 16-63
Module 3 (master) channels 64-78
Module 4 (slave)channels 79-126
As another example, in a Multibus I/O Subsystem with one master (no slave)
followed by a master/slave combination, the channels are numbered as follows:
Module 1 (master) channels 1-15
Module 2 (master) channels 16-30
Module 3 (slave) channels 31-78

118 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Analog Inputs in Multibus I/O

To set up inputs via an analog input module, you must specify the general
parameters of the analog input modules and the channel gains, and you must
configure the loops which use the analog inputs.
To set up the general structure of the analog I/O you must use the AI CARD
NUMBER fields, the AI DEFAUlT CHAN GAIN field, and the AI CHANNEL and
AI GAIN fields on the Multibus I/O Templet. Multibus I/O Templet on page 111,
describes the entries to these fields.
Figure 25 shows the signal flow through the hardware and software components
used to convert analog signals into values usable by the loops.

CONTROL AREA

CCF Software
Input Loop

Field Termination Panel Analog Input Analog Input Modified SQR Root
Signal Module 6100B FCM FCM

Converts field Converts SQR Root


signal to counts counts to extraction (when
based value and eng. units or needed)
gain specified percent
on Multibus I/O
Templet

Figure 25. Analog Input for a Multibus I/O Subsystem

A synopsis of Figure 25 is that a signal is produced in the field. It enters the


subsystem at the termination panel. (The termination panel has resistors which
allow a voltage input to be generated from current signals from the field.) The
6100B Module (or 6101B Module) converts the signal to a digital value referred to
as counts. The value of the counts depends on the magnitude of the input signal and
the gain for the input channel. The channel gain is a value configurable via the
Multibus I/O Templet. Its default is 1. You can use the gain value to increase the
sensitivity of a channel.
Five examples of channel gain are provided in the paragraphs that follow.
Example 1

3BUR002336R3701 RevA 119


Analog Inputs in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

When the gain is 1, the full voltage range a channel accepts is -10V to +10V. A -10V
input generates a count value of -2048. An input of 0V generates a count of 0, and
an input of +10V generates a count of 2047. The value of the counts generated for
voltages between -10V and +10V is calculated using proportions.
The other possible gains for a channel are 2, 4, 8, 16, 32, 64, 128, 256, 512, and
1024. When one of these gain values is used, the full voltage range of a channel is
equal to:
-(10/g) V to +(10/g) V
where
g is the channel gain
An input of -10/g V generates -2048 counts and +10/g V generates 2047 counts
Example 2
When the gain is 4, the full range of the channel is -2.5V to +2.5V, with -2.5V
generating -2048 counts and +2.5V generating 2047 counts. After being converted
to counts, the input goes to a CCF loop. The Analog Input FCM converts the counts
value to an equivalent engineering units or percent value.
The Modified Square Root FCM is often the second FCM in the loop. A typical
application of this FCM is square root extraction on signals coming from
differential pressure transmitters which do not have built-in square root extractors.
The value in engineering units or percent is then passed on to other FCMs in the
loop if needed.
Example 3 - Differential Pressure Transmitter with Built-in Square Root
Extractor
A transmitter measures differential pressure across an orifice plate. The transmitter
has a built-in square root extractor and provides a 4 to 20mA dc signal proportional
to flow in which 4mA represents 0 flow and 20 mA represents 500 GPM.
The current signal produces a voltage at the termination panel. This voltage is
applied to the fifth channel of a 6101B Analog Input Expander Module, that is,
analog input module 2 for the subsystem. The following items must be configured
to handle this input.
• The Loop Definition Templet must specify the loop contains an Analog Input

120 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Analog Inputs in Multibus I/O

FCM. Other FCMs can follow the Analog Input FCM. Since the result of the
Analog Input is the flow value, it is chosen as the measured variable of the
loop.
• The channel gain for the channel is left at its default of 1.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the analog input channel at
which the input is present (20 for this
example since the signal is brought in at
the fifth channel of a slave module that
is module 2 for the subsystem)
RTD, TC, OR HI-LEVEL field HI-LEVEL
ENGU - LOWER BOUND field engineering units value equivalent to a
1V signal from the field (0 for this
example)
ENGU - UPPER BOUND field engineering units value equivalent to a
5V signal from the field (500 for this
example)
The entries to the COUNTS fields are calculated from the maximum counts of the
channel. When the gain for a channel is 1, an input of 10V leads to 2047 counts and
an input of 0 volts gives 0 counts. Therefore, by a simple proportion, 1 volt
produces a count of 204.7 and 5 volts produces a count of 1023.5.
After rounding off, the entries become:
COUNTS - LOWER BOUND field = 205
COUNTS - UPPER BOUND field = 1024
Input limiting is specified in the normal manner via the INPUT LIMITED field.
Example 4 - Differential Pressure Transmitter Without Built-in Square Root
Extractor
A transmitter measures differential pressure across an orifice plate. It provides a 4 to
20mA dc signal proportional to differential pressure. 4mA represents the differential
pressure at 0 flow and 20mA represents the differential pressure at 500 GPM.

3BUR002336R3701 RevA 121


Analog Inputs in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

The current signal produces a voltage at the termination panel. This voltage is
applied to the tenth channel of the first Analog Input Module. The following items
must be configured.
• The Loop Definition Templet must specify the loop contains an Analog Input
FCM followed by a Modified Square Root FCM. (The Modified Square Root
FCM is required because the transmitter does not have a built-in square root
extractor.) Other FCMs can follow the Modified Square Root FCM for further
processing. Since the result of the Modified Square Root FCM is the flow
value, it is chosen as the loop measured variable.
• The channel gain for the channel is left at its default of 1.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the analog input channel at
which the input is present (10 for this
example)
RTD, TC, OR HI-LEVEL field HI-LEVEL
ENGU - LOWER BOUND and ENGU - UPPER BOUND should be chosen to
scale input to percent because the Modified Square Root FCM requires an
input in percent. Therefore,
ENGU - LOWER BOUND field 0 (for 0% of range)
ENGU - UPPER BOUND field 100 (for 100% of range)
The entries to the COUNTS fields are calculated from the maximum counts of
the channel. When the gain for a channel is 1, an input of 10V leads to 2047
counts and an input of 0 volts gives 0 counts. Therefore, by a simple
proportion, 1 volt produces a count of 204.7 and 5 volts produces a count of
1023.5
After rounding off, the entries become:
COUNTS - LOWER BOUND field 205
COUNTS - UPPER BOUND field 1024
Input limiting is specified in the normal manner by the INPUT LIMITED field.
• The Modified Square Root FCM Templet entries for the loop must include the

122 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Analog Inputs in Multibus I/O

following:
INPUT SOURCE field PREVIOUS FCM
HI ENG UNITS field engineering units value equivalent to a
20mA signal from the field (500 for this
example)
LO ENG UNITS field engineering units value equivalent to a
4mA signal from the field (0 for this
example)
Example 5 - Using a Channel Gain Larger than 1
The signal from a transmitter results in a 0 to 1V input signal being applied to
channel 9 of the first 6100B Module in a subsystem. Since the maximum input is
going to 1V, the following configuration entries show how the board is made more
sensitive to the input by increasing the channel gain.
• The Loop Definition Templet must specify the loop contains an Analog Input
FCM. Other FCMs can follow the Analog Input FCM. Since the result of the
Analog Input is the engineering units value, it is chosen as the measured
variable of the loop.
• The gain for the channel is specified as 8 using these entries to the Multibus I/O
Templet:
AI CHANNEL AI GAIN
9 8
The voltage range for the channel is calculated (-10V/8 to +10V/8) as -1.25V
to +1.25V.
An input of -1.25V generates -2048 counts and an input of +1.25V generates
2047 counts.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the analog input channel at
which the input is present (9 for this
example)
RTD, TC, OR HI-LEVEL field HI-LEVEL

3BUR002336R3701 RevA 123


Analog Outputs in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

ENGU - LOWER BOUND field engineering units value equivalent to a


0V signal from the field
ENGU - UPPER BOUND field engineering units value equivalent to a
1V signal from the field
The entries to the COUNTS fields are calculated from the maximum counts of
the channel. When the gain of the channel is 8, an input of 0V leads to 0 counts
and an input of 1.25V leads to 2047 counts.
Therefore, a proportion to find the counts at 1V takes on the form:
counts/1V = 2047/1.25V
counts = 1637.6
Resulting in the following entries for the COUNTS fields:
COUNTS - LOWER BOUND field 0
COUNTS - UPPER BOUND field 1638 (rounded off)
Input limiting is specified in the normal manner by the INPUT LIMITED field.

Analog Outputs in Multibus I/O Subsystems


Analog output channels are provided by the 6108B Analog Output Module. Each
module has 16 channels. Analog output channels 1 to 16 are on the analog output
module with the lowest hardware address. Channels 16 to 32 are on the module at
the next higher address, and so on.
In general, an analog output channel is used with an Analog Output FCM. The
Analog Output FCM converts a value specified in engineering units or in percent
into a number of counts. The counts determine the value of the voltage produced by
the 6108B Module. The total range of voltage produced is 0V dc to +5V dc. The
conversion is such that 0 counts results in a 0V signal and +4095 counts results in a
+5V signal. The voltage produced by this module is usually used to produce a
current signal at a termination panel. When the 6108B Module is used with the
6146N Termination Panel, a voltage range of 0.5 to 2.5mV from the 6108B Module
is converted to a 4 to 20mA current. 0.5V is produced when the number of counts is
409. 2.5mV is produced when the number of counts is 2047.

124 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCFDigital Inputs and Outputs in Multibus I/O

The ENGU - LOWER BOUND, ENGU - UPPER BOUND, COUNTS - LOWER


BOUND, and COUNTS - UPPER BOUND fields on the Analog Output FCM
Templet set up a scaling equation determining the voltage output to the field. One
common application of these fields is to send a 4 to 20mA dc signal to the field. To
do this, make the following entries:
COUNTS - LOWER BOUND field 409
COUNTS - UPPER BOUND field 2047
ENGU - LOWER BOUND field engineering units value for 4mA signal
to field
ENGU - UPPER BOUND field engineering units value for 20mA
signal
to field

Digital Inputs and Outputs in Multibus I/O Subsystems


Digital channels for digital inputs, digital outputs, and pulse outputs are provided by
the 6107B Digital I/O Module. Each module has 72 channels. Digital channels 1 to
72 are on the module with the lowest hardware address. Channels 73 to 144 are on
the module with the next higher address, and so on. The 72 channels of a module are
divided into 9 ports, with port 1 consisting of the first 8 channels, and so on. Each
port is specified for either digital input or digital output by the TTL CARD # and
123456789 columns of fields on the left side of the upper portion of the Multibus
I/O Templet. The channels specified for output are used for either digital output or
pulse output.
When using the digital channels, the following should be considered:
• Some continuous loops in Multibus I/O require digital inputs. Some of these
loops get the inputs by referencing values in other loops. However, other
continuous loops directly access the digital input channels of the 6107B Digital
I/O Module via Digital Input FCMs. One Digital Input FCM reads the data in
up to 16 digital channels. The channels read by one Digital Input FCM must be
consecutive channels on the Multibus I/O. See Section 4, Defining Continuous
Loops, and Digital Input FCM on page 215 for further information.
• A continuous loop in Multibus I/O sending outputs to the field uses a Digital
Output FCM. One of these FCMs can send outputs to as many as 16

3BUR002336R3701 RevA 125


Thermocouples in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

consecutive output channels. See Digital Output FCM on page 326.


• Device loops usually require digital inputs and send digital outputs to the field.
If a device loop uses Multibus I/O, care must be taken to insure the digital
inputs for the device loop are at consecutive channels in the Multibus I/O. The
outputs from a device loop must be sent to consecutive output channels. The
number of consecutive inputs and outputs required by a device loop is
determined by the device handling algorithm for the loop. These algorithms are
listed in Table 38.
• A continuous loop sends a pulse output to the field via either a Pulse Duration
Output FCM or a Pulse Train Output FCM. See Pulse Duration Output FCM on
page 328, and Pulse Train Output FCM on page 331.
When a Pulse Duration Output FCM is executed, it produces a single pulse
whose duration is set by the FCM algorithm. The pulse is sent to the field via a
digital output channel.
When a Pulse Train Output FCM is executed, it determines the number of
pulses in a train of pulses sent to the field. If it outputs via a Multibus I/O
digital channel, the channel must have been configured for digital output via
the TTL CARD # and 123456789 fields. In addition, a pulse width and
duration must have been specified for the channel via the PO CHANNEL
NUMBER, PULSE INTERVAL, and PULSE WIDTH fields on the lower
portion of the Multibus I/O Templet. The algorithm of the Pulse Train Output
FCM determines the number of pulses in the pulse train.

Thermocouples in Multibus I/O Subsystems


Thermocouple inputs in the Multibus I/O Subsystem are handled by the 6102B
mV/Thermocouple Input Module. This module has five versions. One version
supports voltage inputs, and the others support millivolt and thermocouple inputs.

126 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Thermocouples in Multibus I/O

The characteristics of the thermocouple versions are provided in Table 5.

Table 5. mV/Thermocouple Versions of the 6102B Module

Module Catalog Input Range Thermocouple


Nominal Temperature Range
Number (mV dc) Type
6102BZ10111A ±10 mV dc B 986 to 2715° F (530 to 1491° C)
E -328 to 305° F (-200 to 152° C)
J -346 to 366° F (-210 to 186° C)
K -328 to 474° F (-200 to 246° C)
R 32 to 1762° F (0 to 961° C)
S 32 to 1895° F (0 to 1035° C)
T -430 to 415° F (-257 to 213° C)
6102BZ10121A ±20 mV dc B 986 to 3308° F (530 to 1820° C)
E -328 to 547° F (-200 to 286° C)
J -346 to 391° F (-210 to 199° C)
K -328 to 903° F (-200 to 484° C)
R 32 to 3063° F (0 to 1684° C)
S 32 to 3214° F (0 to 1768° C)
T -430 to 725° F (-257 to 385° C)
6102BZ10131A ±50 mV dc E -328 to 1222° F (-200 to 661° C)
J -346 to 1400° F (-210 to 760° C)
K -328 to 2259° F (-200 to 1232° C)
R 32 to 3214° F (0 to 1768° C)
T -430 to 752° F (-257 to 400° C)
6102BZ10141A ±100 mV dc E -328 to 1832° F (-200 to 1000° C)
K -328 to 2502° F (-200 to 1372° C)

3BUR002336R3701 RevA 127


Thermocouples in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

The linearization for a thermocouple input is performed by the Linearization FCM.


Table 6 lists the standard temperature ranges supported by this FCM.

Table 6. Temperature Ranges Supported by the Linearization FCM

INPUT TYPE TEMPERATURE RANGE


Thermocouple RTD Degrees F (°F) Degrees C (°C)
B 986 to 3308° 530 to 1820°
E -328 to 1832° -200 to 1000°
J -346 to 1400° -210 to 760°
K -328 to 2502 -200 to 1372
R 32 to 3214 0 to 1768
S 32 to 3214 0 to 1768
T -430 to 752 -257 to 400
DIN -328 to 1571 -200 to 855
BURNS -328 TO 1202 -200 to 650

Thermocouple Inputs with Cold Junction Compensation


A Multibus I/O Subsystem can have multiple 6102B Modules. Each module is
equipped with hardware for cold junction compensation. To use compensation for a
module, a CCF loop must be configured to obtain the temperature of the cold
junction at the termination panel. In addition, each thermocouple connected to the
module requires one CCF loop to scale, linearize, and perform the cold junction
compensation for the input. These loops are illustrated in Figure 26. The discussion
that follows summarizes the signal flow for these loops.

128 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Thermocouples in Multibus I/O

.
FIELD CONTROL AREA
High Density I/O Subsystem
T/C Temperature 6102B Module CCF Software
for Cold Sensor
Junction Channels 1 to 16 Chan. 1 loop (cold junc. comp.) Internal link for
Comp. temp. comp.
at chan. Cold junction A/D Conversion chan. 1 Analog Input
effect at all for cold junc. counts
no. 1 FCM
connections signal at chan. 1
between T/C Converts
T/C and copper A/D conversion counts to
inputs at wire for t/c signals at temp value
chan. 2 chan. 2 to 16
to 16 converted to
Termination Panel counts chan. 2
counts Analog Input Linearization Degrees
FCM uVs FCM to next
Converts Table lookup FCM
counts to linearization
temp value and eng unit
conversion
Chan. 2 loop, T/C input (same for 2-16)

Figure 26. Thermocouple with Cold Junction Compensation in a Multibus I/O Subsystem

Signal Flow for the Loop acquiring the Termination Panel Cold Junction
Temperature
• The signal originates at a temperature sensor on the termination panel.
• The signal is applied to the 6102B Module which performs analog to digital
conversion which provides a counts value applied at the first channel of the
module.
• The Analog Input FCM of the loop acquires the counts value and converts it to
degrees. This value represents the temperature at the termination panel. It is
automatically made available to the loops handling the thermocouple inputs.
Signal Flow for the Loops that Handle the Thermocouple Inputs
• The signal is produced in the field by the thermocouple.
• The connection between the thermocouple wires and the screws in the
termination panel creates a cold junction effect. The normal result is a decrease

3BUR002336R3701 RevA 129


Thermocouples in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

in the signal voltage seen by the 6102B Module.


• The signal goes through analog to digital conversion at the 6102B Module
which provides a counts value at one of the channels of the module.
• The signal goes to a CCF loop. The first FCM of the loop must be an Analog
Input FCM, followed by a Linearization FCM.
• The Analog Input FCM converts the counts value to an equivalent voltage
value. (The voltage is in microvolts because the thermocouple tables of the
Linearization FCM must have an input expressed in microvolts.)
• The Linearization FCM uses standard tables for linearization. It also uses the
temperature value determined by the cold junction compensation loop to
eliminate the effect of the cold junction. It then converts the microvolt value
into a temperature value in degrees
• The temperature is then passed on to other FCMs in the loop if needed.
Example:
• The thermocouple type and temperature range should be chosen to suit the
application. Types B, E, J, K, R, S, and T thermocouples are supported by the
Advant OCS.
Assume, for this example, the thermocouple is type J and works on a range of -
200 to +100° C. It is connected to thermocouple channel 30 (the fourteenth
channel on the second thermocouple module).
• The loop acquiring the temperature of the termination panel must include the
following:
• The Loop Definition Templet for the cold junction loop must specify the loop
contains an Analog Input FCM. The result of this FCM is the loop measured
variable.
• The Analog Input FCM Templet entries for the loop must include the
following:
CHANNEL NUMBER field number of the first channel of the
6102B Module (17 for this example)
RTD, TC, OR HI-LEVEL field TC

130 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Thermocouples in Multibus I/O

The termination panel is installed in a control room where the temperature is


between 0 and 50° C. Therefore, the entries in the ENGU fields are:
ENGU - LOWER BOUND field 0
ENGU - UPPER BOUND field 50

For the loop that measures cold junction temp. ENGU are always in
degrees C.

The A/D converters are designed to output count values between -2048 and
+2047. This corresponds to a range of temperature from the sensor of -125 to
+125° C.
The lower counts bound is equal to: (0/-125) x (-2048)
and the upper bound counts is equal to: (50/125) x 2047
Therefore, the entries for the COUNTS fields are:
COUNTS - LOWER BOUND field 0
COUNTS - UPPER BOUND field 19 (rounded off)
• The loop handling the thermocouple input must include the following:
• The Loop Definition Templet must specify the loop contains an Analog Input
FCM which sends its result to a Linearization FCM. Other FCMs can follow
the Linearization FCM.
• The Analog Input FCM Templet entries for the loop must contain the
following:
CHANNEL NUMBER field the number of the channel where the
input is present (30 for this example)
RTD, TC, OR HI-LEVEL field TC

3BUR002336R3701 RevA 131


Thermocouples in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

COUNTS - LOWER BOUND, COUNTS - UPPER BOUND, ENGU -


LOWER BOUND and ENGU - UPPER BOUND fields are calculated by the
following:
a. Using the thermocouple tables, a type J thermocouple operating on a range
of -200 to +100° C is found to produce a voltage ranging from -7.890 mV
to +5.268 mV.
b. The maximum potential effect of the cold junction occurs at a temperature
of 50° C at the termination panel. From thermocouple tables, it is found
that this maximum effect would decrease the voltage by 2.585 mV.
Therefore, the maximum extremes of voltage applied to the 6102B
Module are -10.475 mV to 5.268 mV.
c. At this point, Table 5 is checked to find the necessary version of the
6102B Module. The thermocouple range equates to a span of 15.473 mV
(-10.745 mV to 5.268 mV). If bad input checking is not configured for the
Analog Input FCM, the thermocouple range is used to choose the module.
If bad input checking is used, a larger range must be used. For example, if
the bad input check is established at 10% over or below range, the
maximum voltage range must be expanded by 1.574 mV in each direction.
The overall range now becomes -12.049 mV to 6.842 mV. By checking
Table 5, it is found that the proper version of the module is
6102BZ10121A. Its range of -20 to +20 mV is large enough for the
thermocouple input and the bad input checking.
d. The ENGU - LOWER BOUND and ENGU - UPPER BOUND must be
entered.in microvolts as the Linearization FCM is designed to have an
input scaled in microvolts. Therefore, the thermocouple range (including
cold junction effect) of -10.475 mV to 5.268 mV is entered in the ENGU -
LOWER BOUND and ENGU - UPPER BOUND fields as:
ENGU - LOWER BOUND field = -10.475 x 1000 = -10475
ENGU - UPPER BOUND field = 5.268 x 1000 = 5268

132 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Thermocouples in Multibus I/O

e. The lower and upper counts values are calculated as:


COUNTS - LOWER BOUND field = maximum mV of input x -2048
maximum mV of module
= -10.475 x -2048
-20
= -1073 (rounded off)
COUNTS - UPPER BOUND field = maximum mV of input x 2047
maximum mV of module
= 5.268 x 2047
20
= 539 (rounded off)

The general format of the equations used in this step is:


If mV input is positive: Counts = (mV input/max mV input of
module) x 2047.
If mV input is negative: Counts = (mV input/max mV input of
module) x -2048.

f. Input Limiting is specified in the normal manner via the INPUT


LIMITED Field.
• For Linearization FCM Templet of the loop handling the thermocouple input:
TEMPERATURE SCALE field C specifies output of Linearization
FCM is scaled in degrees C
COMPENSATION TYPE field COLD specifies cold junction
compensation. This also tells the
Linearization FCM to get cold junction
compensation data from the proper
loop.
ELEMENT TYPE field J

3BUR002336R3701 RevA 133


Thermocouples in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

Thermocouples Inputs with Hot Junction Compensation


Hot junction compensation uses a heating element to maintain a constant
temperature at the thermocouple and copper wire junction. The temperature is
specified during configuration of the Linearization FCM so the Linearization FCM
can compensate for the junction temperature.
You must supply the required extra hardware for hot junction compensation.
Figure 27 shows the signal flow through these hardware and software components.

FIELD CONTROL AREA


High Density I/O Subsystem

Termination 6102B Module CCF Software


Heated Panel
Term.
panel A/D conversion T/C Loop
T/C for t/c signals
input converted to
Analog Input Linearization
counts FCM Degrees
counts FCM uVs
to next
Converts Table lookup FCM
counts to linearization
temp value and eng unit
conversion

Copper Wires

Figure 27. Thermocouple with Hot Junction Compensation in a Multibus I/O Subsystem

• The signal is produced in the field by the thermocouple.


• The connection between the thermocouple wires and the screws in the
termination panel creates a junction effect. This normally results in a decrease
in the signal voltage seen by the 6102B Module. However, the hardware you
supply maintains this junction at a constant temperature.
• The signal goes through analog to digital conversion at the 6102B Module
which produces a counts value at one of the channels of the module.
• The input goes to a CCF loop. The first FCM of the loop must be an Analog
Input FCM. It must be followed by a Linearization FCM.

134 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Thermocouples in Multibus I/O

• The Analog Input FCM converts the counts to an equivalent voltage value.
(The voltage is in microvolts because the thermocouple tables of the
Linearization FCM must have an input expressed in microvolts.)
• The Linearization FCM uses standard tables for linearization. The temperature
of the hot junction is specified to the FCM when it is configured. Thus the
FCM can compensate for the junction effect. After it linearizes the signal, the
FCM converts the microvolt value into a value in degrees.
• The value in degrees is then passed on to other FCMs in the loop if needed.
Example:
The thermocouple is type K used in 0 to 1000° F range. The junction is maintained
at 150° F.
• The Loop Definition Templet must specify that the loop has an Analog Input
FCM that sends its result to a Linearization FCM. Other FCMs can follow the
Linearization FCM.
• The Analog Input FCM Templet entries for the loop must contain the
following:
CHANNEL NUMBER field the number of the channel.
RTD, TC, OR HI-LEVEL field TC
COUNTS - LOWER BOUND, COUNTS - UPPER BOUND, ENGU -
LOWER BOUND and ENGU - UPPER BOUND fields are calculated by the
following:
a. Using thermocouple tables, it is found that a type K thermocouple
operating on a range of 0 to +1000° F produces a voltage that ranges from
-.692 mV to +22.251 mV
b. Use thermocouple tables to determine the effect of the hot junction on the
thermocouple. Assume that the junction is kept at 150° F. From the tables,
it is found this would decrease the voltage by 2.666 mV. Therefore, the
range becomes -3.358 mV to 19.595 mV.
c. At this point, Table 5 is checked to find the necessary version of the
6102B Module. The thermocouple range equates to a span of 22.953 mV
(-3.358 mV to 19.595 mV). If bad input checking is not configured for the
Analog Input FCM, the thermocouple range is used to choose the module.

3BUR002336R3701 RevA 135


Thermocouples in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support

If bad input checking is used, a larger range must be used. For example, if
the bad input check is established at 10% over or below range, the
maximum voltage range must be expanded by 2.295 mV in each direction.
The overall range now becomes -5.652 mV to 21.89 mV. By checking
Table 5, it is found that the proper version of the module is
6102BZ10131A. Its range of -50 to +50 mV is large enough for the
thermocouple input and the bad input checking.
d. ENGU - LOWER BOUND and ENGU - UPPER BOUND must be in
microvolts since t/c tables in Linearization FCM are designed for input
scaled in microvolts.
Therefore, the thermocouple range (including junction effects) of -3.358
mV to 19.595 mV becomes:
ENGU - LOWER BOUND field = -3.358 x 1000 = -3358
ENGU - UPPER BOUND field = 19.595 x 1000 = 19595
e. The lower and upper counts values are calculate as:
COUNTS - LOWER BOUND field = maximum mV of input x -2048
maximum mV of module
= -3.358 x -2048
-50
= -138 (rounded off)
COUNTS - UPPER BOUND field = maximum mV of input x 2047
maximum mV of module
= 19.595 x +2047
50
= 802 (rounded off)

The general format of the equations used in this step is:


If mV input is positive: Counts = (mV input/max mV input of
module) x 2047
If mV input is negative: Counts = (mV input/max mV input of
module) x -2048

136 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Millivolt and Voltage Inputs via 6102D

• Configuration requirements for the Linearization FCM Templet are:


TEMPERATURE SCALE field F to specify the output of the
Linearization FCM is scaled in
degrees F.
COMPENSATION TYPE field HOT to specify hot junction
compensation is used. This entry also
tells the system to get hot junction
compensation information from the
entry to the HOT COMP BIAS field of
the templet.
HOT COMP BIAS field temperature at which the termination is
maintained (150 for this example). It
must be entered in the same units as are
selected for the temperature scale.
ELEMENT TYPE field K

Millivolt and Voltage Inputs via 6102D Millivolt/Thermocouple Modules


Millivolt inputs to the Multibus I/O Subsystem are handled by the 6102B
mV/Thermocouple Input Module. This module has five versions. One version
supports voltage inputs, and the others support millivolt and thermocouple inputs.
The input ranges of these versions is provided in Table 7. When a millivolt version
of the module is used, you cannot use channel 1 to produce an input for a loop.
When the voltage version of the module (6102BZ10211A) is used, all 16 channels
are used to produce inputs for loops.

Table 7. Millivolt and Voltage Versions of the 6102B Module

Version Input Range


6102BZ10111A -10 mV to +10 mV dc
6102BZ10121A -20 mV to +20 mV dc
6102BZ10131A -50 mV to +50 mV dc

3BUR002336R3701 RevA 137


Millivolt and Voltage Inputs via 6102D Millivolt/Thermocouple ModulesSection 3 How to Configure

Table 7. Millivolt and Voltage Versions of the 6102B Module (Continued)

Version Input Range


6102BZ10141A -100 mV to +100 mV dc
6102BZ10211A -5 mV to +5 mV dc

For each version the maximum range of counts is -2048 to +2047. A loop that
acquires a millivolt or voltage input from this type of module must have an Analog
Input FCM. The COUNTS - LOWER BOUND, COUNTS - UPPER BOUND,
ENGU - LOWER BOUND, and ENGU - UPPER BOUND fields are used to scale
the counts to a value in engineering units. The general format of the equations used
find the value of the COUNTS fields are:
If mV input is positive: Counts = (mV input/max mV input of module) x 2047
If mV input is negative: Counts = (mV input/max mV input of module) x -2048
Example:
A transmitter produces a signal of -15 to +12mV dc. The signal is -15mV when the
engineering units is 50. The signal is +12mV when the engineering units is 175.
The 6102B Module best suited for this input range is 6102BZ10121A. It has an
input range of -20 to +20mV dc. The span of this module is adequate for the
millivolt range with enough extra to allow for bad input checking. The entries for
ENGU fields on the Analog Input Templet are:
ENGU - LOWER BOUND field 50
ENGU - UPPER BOUND field 175
Since the low range of the inputs is negative, the COUNTS - LOWER BOUND
field is:
Counts = (mV input/max mV input of module) x -2048
= -15 x -2048
-20
= -1536

138 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF RTDs in Multibus I/O Subsystems

Therefore, the COUNTS - LOWER BOUND is -1536. Since the high range of the
millivolt inputs is positive, the COUNTS - UPPER BOUND is calculated as:
Counts = (mV input/max mV input of module) x 2047
= 12 x 2047
20
= 1228.2
Therefore, the entry for the COUNTS - UPPER BOUND field is 1228 (rounded
off).

RTDs in Multibus I/O Subsystems


RTDs are brought into a Multibus I/O Subsystem via a 6105B RTD Input Module.
Linearization for an RTD input is via the Linearization FCM. This FCM has tables
for linearizing DIN RTDs on a range of -328 to 1571° F (-200 to 855° C) and
BURNS RTDs on a range of -328 to 1202° F (-200 to 650° C).
A DIN RTD has a ratio of: R100 DEGC / R0 DEGC = 1.385
A BURNS RTD has a ratio of: R100 DEGC / R0 DEGC = 1.3902
A number of hardware and software components are used to convert the RTD signal
into degrees used by the CCF loops. Figure 28 shows the signal flow through these
hardware and software components.

3BUR002336R3701 RevA 139


RTDs in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support CCF

FIELD CONTROL AREA

High Density I/O Subsystem

Termination 6105B Module CCF Software


Panel
A/D conversion RTD Loop
for RTD signals
converted to Linearization
RTD counts Analog Input
counts FCM ohms FCM Degrees
input to next
Converts Table lookup FCM
counts to linearization
ohm value and ohms to
temp. convert

Figure 28. RTD in a Multibus I/O Subsystem

• The signal is produced in the field by the RTD.


• The signal enters the Multibus I/O Subsystem at the termination panel.
• The analog signal is converted to digital at a 6105B RTD Input Module which
provides a counts value at one of the channels of the module.
• The signal goes to a CCF loop. The first FCM of the loop must be an Analog
Input FCM. It must be followed by a Linearization FCM.
• The Analog Input FCM converts the counts to an equivalent ohms value.
• The Linearization FCM uses standard tables for linearization. It then converts
the ohms value into a value in degrees
• The value in degrees is then passed on to other FCMs in the loop if needed.
Example - 6105B RTD Input Module
The 6105B RTD Input Module accepts signals from RTDs and converts them to
counts used as inputs for loops. Each module has 16 channels. If a Multibus I/O
Subsystem contains more than one 6105B Module, the channels on the module at

140 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF RTDs in Multibus I/O Subsystems

the lowest hardware address are RTD channels 1 to 16. The channels on the module
at the next higher address are channels 17 to 32, and so on.
When an RTD loop is configured, you must calculate how many counts are present
at the input channel for a given ohm measurement produced by the RTD. To
calculate this:
The specifications for the 6105B Module are:
OHM COUNTS
0 -958
100 0
313.74 2047
The counts change by approximately 9.58 for each ohm away from 100 ohms. An
exact equation for finding the counts is:
Counts = (ohms - 100) x 9.5771
The following examples show how this equation is used.
Example 1 - RTD with a 100 Ohm Element
A BURNS type RTD with a 100 ohm element is used over a range of 200 to 500° C.
It is connected to the fourth channel of the third 6105B Module in the subsystem.
• The Loop Definition Templet must specify the loop contains an Analog Input
FCM that sends its result to a Linearization FCM. Other FCMs can follow the
Linearization FCM.
• The Analog Input FCM Templet entries for the loop must contain the
following:
CHANNEL NUMBER field the number of the channel (36 in this
example)
RTD, TC, OR HI-LEVEL field RTD
Using RTD tables, it is found that a 100 ohm BURNS RTD operating on a
range of 200 to 500° C produces resistance measurements that range from
176.85 to 283.36 ohms. Therefore, entries for the ENGU fields are:
ENGU - LOWER BOUND field 176.85

3BUR002336R3701 RevA 141


RTDs in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support CCF

ENGU - UPPER BOUND field 283.36


The lower bound for the count is derived earlier for the 6105B RTD Input
Module as follows:
Counts = (ohms -100) x 9.5771
= (176.85 - 100) x 9.5771
= 736
Therefore, the entry for the COUNTS - LOWER BOUND field is 736. The
upper bound for the count is derived earlier for the 6105B RTD Input Module:
Counts = (283.36 - 100) x 9.58
= 1756
Therefore, the entry for the COUNTS - UPPER BOUND field is 1756. Input
limiting is specified in the normal manner via the INPUT LIMITED field.
• Configuration requirements for the Linearization FCM Templet include:
TEMPERATURE SCALE field C to specify the output of the
Linearization FCM will be scaled in
degrees C
COMPENSATION TYPE field NONE
ELEMENT TYPE field BURNS
Example 2 - RTD with a 200 Ohm Element
A DIN type RTD with a 200 ohm element is used over a range of 50 to 125° C. It is
connected to the second channel of the second 6105B Module in the subsystem.
• The Loop Definition Templet must specify the loop contains an Analog Input
FCM that sends its result to a Linearization FCM. Other FCMs can follow the
Linearization FCM.
• The Analog Input FCM Templet entries for the loop must contain the
following:
CHANNEL NUMBER field the number of the channel(18 in this
example)
RTD, TC, OR HI-LEVEL field RTD

142 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF RTDs in Multibus I/O Subsystems

Use RTD tables to find the ohms values for the ENGU fields. However, you
must exercise caution to insure the ohms values are the proper ones for a 200
ohm element. Using RTD tables, it is found a 100 ohm DIN element RTD
operating on a range of 50 to 125° C produces a resistance value ranging from
119.40 ohms to 147.94 ohms. Multiply these numbers by 2 to find the range for
a 200 ohm element. Thus the range becomes 238.8 ohms to 295.88 ohms.

Verify the calculated range does not exceed 313.74 ohms


(maximum input capacity of 6105B Module).

For linearization to work correctly, the engineering units values must be


entered as resistance values - a 100 ohm element would provide over the
specified temperature range. Therefore the entries for the ENGU fields are:
ENGU - LOWER BOUND field 119.40
ENGU - UPPER BOUND field 147.94
The count fields are calculated based on the actual resistance of the 200 ohm
element. Using the equation derived earlier for the 6105B RTD Input Module.
The lower counts value is calculated as follows:
Counts = (ohms -100) x 9.5771
= (238.80 - 100) x 9.5771
= 1329 leads to
Therefore the entry for the COUNTS - LOWER BOUND field is 1329. The
lower counts value is calculated as follows:
Counts = (295.88 - 100) x 9.5771
= 1876
Therefore the entry for the COUNTS - LOWER BOUND field is 1876. Input
limiting is specified in the normal manner via the INPUT LIMITED field.
• Configuration requirements for the Linearization FCM Templet include:
TEMPERATURE SCALE field C to specify the output of the
Linearization FCM is scaled in
degrees C
COMPENSATION TYPE field NONE
ELEMENT TYPE field DIN

3BUR002336R3701 RevA 143


Pulse Inputs in Multibus I/O Subsystems Section 3 How to Configure Subsystems to Support CCF

Pulse Inputs in Multibus I/O Subsystems


Pulse inputs for a Multibus I/O Subsystem are handled by the 6106B Pulse Input
Module. Each module contains 15 input channels. Pulse input channels 1 to 15 are
on the module that is at the lowest hardware address. Channels 16 to 30 are on the
module at the next higher hardware address, and so on. If the software is at Version
6.0 or 6.1, all the channels on the module are used to produce inputs for the loops. If
the software is at Version 6.2 or above, you cannot use the first channel of a module.
This channel is reserved for a time base utilized when a pulse frequency is required.
A Multibus I/O pulse input loop can get the input from a channel on a Pulse Input
Board. The loops handling the input must have a Pulsed Input FCM. When a Pulsed
Input FCM is executed, it reads the accumulated number of pulses at the channel
and makes this the counts value for the loop. The FCM then resets the counter in the
module to 0. The counter starts accumulating a new pulse count which is read the
next time the FCM is executed.
The configuration of pulse inputs depend on the version level of the software of
your system.
For systems at Version 6.0 or 6.1
A field input is brought to any channel on a module. The input channel for a given
loop is specified via the CHANNEL NUMBER field of the Pulsed Input FCM in
that loop. The COUNTS - LOWER BOUND, COUNTS - UPPER BOUND, ENGU
- LOWER BOUND, and ENGU - UPPER BOUND fields specify the scaling
equation for the counts.
A Pulsed Input FCM is required when the input must be a number of pulses. If the
input must be a pulse frequency, use a Pulsed Input FCM and a Pulse Input (PI)
Time Derivative FCM.
For systems at Version 6.2 or higher
An input from the field is brought to any channel on a module except the first
channel. The channel providing the input for a given loop is specified via the
CHANNEL NUMBER field of the Pulsed Input FCM in that loop.
The COUNTS - LOWER BOUND, COUNTS - UPPER BOUND, ENGU -
LOWER BOUND, and ENGU - UPPER BOUND fields specify the scaling
equation for the counts. The INPUT TYPE field is set to the COUNTS field value if
the pulse count is needed for the input. It is also set at FREQUENCY. When this

144 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF Smart I/O Templets

option is chosen, the pulse value read at the channel is divided by the elapsed time,
and the resulting pulse frequency becomes the counts value for the loop.
A pulse frequency input can also be handled using a combination of a Pulsed Input
FCM and a PI Time Derivative FCM. In this situation, the entry for the INPUT
TYPE field of the Pulsed Input FCM Templet should be set to the entry in the
COUNTS field. This method has a lower resolution than the method described in
the previous paragraph.

Smart I/O Templets


Each smart device that sends input (variable values) to the Advant OCS must be
supported by one or more CCF loops that reside within the Multibus Subsystem.
These loops serve as a mechanism by which the information from words (registers)
and bits (coils) of the smart device are read from the Advant OCS and manipulated
as required. See Section 4, Defining Continuous Loops, and Section 5, Input FCMS,
of this instruction book and Section 3.3.5 of the Smart Device Interface User's
Guide for information about configuring loops that receive input from smart
devices.
Each smart device serial port providing input for loops, requires a Smart I/O
Templet to identify the serial port to which its associated SHIM is connected. You
must also complete a Smart I/O Network Templet for the SHIM connected to the
serial port to identify its SHIM network address and the following parameters for
each smart device connected to that SHIM:
• smart device's tag name
• smart device's transmitter address on the SHIM
• starting CCF channel number to place four inputs (primary value, secondary
value, tertiary value, and fourth value) read from the smart device
• descriptor for general use
Valid entries for the fields for a Multibus Subsystem are the same as for a SC
Controller, however, you can connect only one SHIM to a Multibus serial I/O port.
See Smart I/O Templets on page 102 for examples of the Smart I/O Templets and
the valid entries for their fields.

3BUR002336R3701 RevA 145


CCF Templet Section 3 How to Configure Subsystems to Support CCF

CCF Templet
One CCF Templet, Figure 29, must be configured for each node that executes CCF.
It defines the Loop Processor base rate and other general parameters for the node.
All other templets in the node related to CCF are descendants of the CCF Templet.
.

Figure 29. CCF Templet

TEMPLET NAME Field


Use this field to specify the name all application use to identify the CCF hierarchy
for this node. Templet names must be unique, that is, no two templets can have the
same name.
Valid entry is:
a character string of up to 21 characters

PARENT NAME Field


This field is automatically filled in by the system, and is for information only.

146 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF CCF Templet

BASERATE Field
The base rate is the interval at which the Loop Processor runs. All loops in the
module are processed in multiples of the base rate. For a Controller Subsystem, the
base rate must be less than or equal to 1. If you attempt to compile a controller data
base with a base rate greater than 1, a warning message is generated and the base
rate is set to 1.
Valid entry is time in seconds. Decimal numbers with the smallest possible entry
being 0.100.
Default is: 1
Loop Processing Rate on page 158, describes how this field and the PROCESSING
RATE and PROCESSING PHASE fields of the Loop Definition Templet interact to
determine the actual processing rate for an individual loop.
Consider the load on the subsystem when you choose the CCF base rate and
individual loop processing rates. The Loop Processor must be able to perform all
calculations within the allotted base rate. During runtime, the diagnostic Subsystem
Performance Display indicates processor loading, memory pool usage, and CCF
processing. This display is used to determine if the base rate or system load must be
modified.

ALARM DEADBAND Field


The alarm deadband prevents a continuous variable oscillating at a value near an
alarm deadband from generating spurious alarms. The alarm deadband specified on
the CCF Templet for a module is the default for all real value alarms in the CCF
software for that module.
See Configuring an Alarm in Alarm Handling: Configuration, Detection, Posting,
and Cutout on page 164, for information on the role the deadband plays in alarm
generation.
Valid entry is a percent of span.
Default is: 1

3BUR002336R3701 RevA 147


CCF Templet Section 3 How to Configure Subsystems to Support CCF

INPUT FCM DEADBAND Field


This field is used to specify a deadband in percent that is used with any Analog
Input FCM related to this CCF Templet. The value specified is the percent of span
outside the high and low counts range which is allowed before the input data quality
is declared BAD. See Analog Input FCM on page 201, for detailed information
about its configurable features.
Valid entry is a percent of span.
Default is: 5.0

INPUT LIMITER DB Field


This field is used to specify a deadband used when Input Limiter FCMs are defined
in this module. The Input Limiter FCM is described in Input Limiter FCM on page
467, of this manual.
Valid entry is a percent of span.
Default is: 0.0

EXTERNAL DATA RATE Field


This field specifies the rate at which CCF obtains data from loops outside the node.
Any value from 0.5 to 4.0 seconds is acceptable. Entries are rounded to the next
lower multiple of the CCF base rate. The minimum entry should be the CCF base
rate in the node. Larger entries result in less load on the system.
Valid entry is time in seconds. Entries are in the range of 0.5 to 4.0 seconds.
Default is: 4.0

CCF INIT Field


This field is no longer used to specify which set of initialization values are used at
start-up.
Valid entry is NOT USED.
Default is: NOT USED

148 3BUR002336R3701 RevA


Section 3 How to Configure Subsystems to Support CCF CCF Templet

The entry to this field is ignored by the TRIO software. The TRIO
warmstart action for Output FCMs and device loops is configured
via the INITIAL MODE or INITIAL OUTPUT MODE and
INITIAL COMMAND Fields of their respective templets. See
Parameters Common To All Output FCMS on page 317 and How
To Configure A Device Loop on page 533 of this instruction book
for further information.

MAX SIM AT EXP Field


This field indicates whether the Autotune functionality is available and the
maximum number of Autotune experiments that may be run simultaneously on the
node.
Valid entry is:
a number from 0 to 255. An entry of 0 indicates that the Autotune functionality
is not available on the node. An entry greater than 0 indicates that the Autotune
functionality is available and how many Autotune experiments can run
simultaneously (that is, the number of loops you can apply the Autotune
function to at one time.) See Appendix D, Autotune, of this instruction book
for information about the Autotune functionality.
Default is: 0
Since the average Autotune experiment requires about 1000 bytes of data base
memory, the amount of memory available should be considered when determining
the entry for this field. The larger the entry, the more data base memory is used.
If you change the entry in this field after configuration, you must save/replace the
templet and re-compile, install, and download the node to put the new entry in
effect.
A diagnostic error message is generated if there is insufficient memory to allow the
specified number of Autotune experiments. This diagnostic message also indicates
the maximum number of Autotune experiments allowed due to the memory
constraints.

3BUR002336R3701 RevA 149


CCF Templet Section 3 How to Configure Subsystems to Support CCF

150 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops

General Information
Continuous loops perform control, indication, and calculation functions. Device
loops control discrete devices such as fans and motors. The templets for continuous
loops are described in this section through Section 10, Extended Processing FCMS,
and the templets for device loops are described in Section 11, Defining Device
Loops.
Refer to the appropriate User’s Guide for instructions on using the configurator user
interface. For the Multibus-based configurator, refer to System Configurator User's
Guide. For AdvaBuild, refer to the AdvaBuild Basic Functions User’s Guide.
Two types of templets are needed to define each continuous loop. The first type is
the Loop Definition Templet. You must complete one Loop Definition Templet for
each loop. This templet is used to assign a name to the loop and specify the general
processing and alarm parameters. You must also complete one or more FCM
Templets for each Loop, depending on the required functionality. There are over
fifty different FCM Templets.
For example, to define loop TC105 as a PID controller with square root extraction,
configure the following FCM Templets (Templet names for FCMs are defaults):
Templet Name Templet Type
TC105 Loop Definition Templet
TC105.AIN Analog Input FCM Templet
TC105.SQR Modified Square Root FCM Templet
TC105.PID PID Controller FCM Templet
TC105.AOT Analog Output FCM Templet
Loop level parameters for continuous loops are listed in Data Base Tables.

3BUR002336R3701 RevA 151


Planning a Loop Section 4 Defining Continuous Loops

If you want to use a Primary History Log to collect the MEASURE, RESULT, or
SETPOINT values of a continuous loop for trend display, you must also define a
Primary History Log Templet. See Primary History Log on page 195 for
information on how to configure a Primary History Log.

Planning a Loop
Plan a loop configuration with planning forms in Data Base Planning Forms. Use a
form for the loop definition templet and one for each FCM. When you plan a loop:
• Use a unique system-wide name for the loop.
• List FCMs in the order you wish to have them executed when the loop is
processed.
• A loop can have a maximum of 8 FCMs.
• A loop can have no more than one controller FCM. The controller FCM is
either the PID controller FCM or the Auto/Manual controller FCM.
• A loop can have no more than one totalizer FCM.
• If a loop has a totalizer FCM, it cannot have a PID or Auto/Manual Controller
FCM.
• A loop can have no more than one User Calculations (UCAL) FCM.
• A loop can have a maximum of 3 Primary History Logs.
Rules for FCMs include:
• Use either the default FCM name or use your own name string of up to three
characters.
• Each FCM must have a unique name within the loop. If two or more FCMs of
the same type are in a loop, only one can have the default name, you must
modify the default string for the second similar FCM.
• Since LL is reserved as a keyword to indicate TLL, do not use LL as an FCM
name.
• Complete an FCM form for each type of FCM. The name is assigned by the
configurator. It consists of the loop tag and FCM name. For example, an
Analog Input FCM in Loop T15 has the name T15.AIN and a Modified Square

152 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Planning a Loop

Root FCM has the name T15.SQR.


More specific information on individual FCMs is provided in Section 5, Input
FCMS, through Section 10, Extended Processing FCMS.
The PID controller FCM is treated in a different manner from other FCMs because
the PID Controller FCM Templet can have children. These children are the
Adaptive Gain and Adaptive Reset Templets. When you fill in a templet planning
form for a PID controller, the entry you make to the ADAPTIVE CONTROL field
determines whether you need to fill in the Adaptive Gain and/or Adaptive Reset
templets.
If the entry to the ADAPTIVE GAIN field is:
GAIN fill in an Adaptive Gain Templet
RESET fill in an Adaptive Reset Templet
BOTH fill in an Adaptive Gain and an Adaptive Reset Templet
NONE no Adaptive Templets are needed
The following example shows how to plan a continuous loop that brings in an
analog input and calculates the square root of that input. To plan this loop:
1. Use Table 8 and Section 2, of System Configurator User's Guide, to decide
which FCMs are in the loop. If you are using planning forms, obtain blank
copies of the Loop Definition Templet planning form and the planning form for
each of the FCMs in the loop.
System Configurator Users Guide describes the FCMs you can use to
implement standard process control techniques. This can help you choose
FCMs for a loop.
2. Fill in the loop definition templet planning form. The name you give the
templet becomes the loop tag. In the example, the name of the loop is T15.
During runtime, other applications in the Advant OCS use this name.
It is important to accurately list the FCMs of the loop in the FCMs List edit
window or LOOPS TO PROCESS fields at the bottom of the lower portion of
the templet (Figure 35). List the FCMs in the order you want them to execute
when the loop is processed. Table 8 shows the default FCM names and the
corresponding FCM algorithms.

3BUR002336R3701 RevA 153


Planning a Loop Section 4 Defining Continuous Loops

You can either use the default FCM name or enter up to a 3 character name of
your choice. Each FCM in a loop must have a unique name. If you have two or
more FCMs of the same type, only one of them can have the default name.
You enter the FCM's corresponding algorithm as it appears in Table 8 (without
asterisks).
3. When you are finished with the Loop Definition Templet planning form, fill in
the FCM planning forms for the loop.
Start by writing the templet name in the TEMPLET NAME field. The templet
name for an FCM is automatically assigned by the configurator. It consists of
the loop tag and the FCM name. For example, the Analog Input FCM of loop
T15 is assigned T15.AIN. See the TEMPLET NAME field in Figure 34. For
further information about individual FCMs, refer to Section 5, Input FCMS,
through Section 10, Extended Processing FCMS.

154 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Planning a Loop

Table 8. FCM Names/FCM Types

Default Name Algorithm Default Name FCM Algorithm


Input, Output, and Controller FCMs Time Related FCMs
AIN ANALOG_INPUT DTM DEAD_TIME
AOT ANALOG_OUTPUT DTC DEAD_TIME_COMPENSN
DIN DIGITAL_INPUT FLT FIRST_ORDER_FILTER
DOT DIGITAL_OUTPUT LLG LEAD/LAG_FILTER
PIN PULSED_INPUT DER TIME_DERIVATIVE
PDR PI_TIME_DERIVATIVE INT TIME_INTEGRATION
PDO PULSE_DURATION_OUT TIM TIMER
PTR PULSE_TRAIN_OUT TOT TOTALIZER
PID PID_CONTROLLER CNT COUNTER
AM AUTO/MANUAL_CONTROLR DLY DELAY
Logic FCMs Miscellaneous FCMs
XOR EXCLUSIVE_OR DAT DATA_ENTRY
AND LOGICAL_AND GET GET_GENERIC_VALUE
OR LOGICAL_OR LIM INPUT_LIMITER
NOT LOGICAL_NOT M30 MOD30_MOD300_MAP
COM REAL_COMPARE PUT PUT_GENERIC_VALUE
FF SET/RESET_FLIP-FLOP RED REDUNDANT_SIGNAL
Scaling and Compensation FCMs SFC SELECT_NEXT_FCM
FLW FLOW_CALCULATION SEL SELECTOR
INR INVERSE_NORMALIZE STR STRING_FCM
LKP LINEARIZATION UCL USER_CALCULATIONS

3BUR002336R3701 RevA 155


Configurable Loop Features Section 4 Defining Continuous Loops

Table 8. FCM Names/FCM Types (Continued)

Default Name Algorithm Default Name FCM Algorithm


Scaling and Compensation FCMs (continued) Miscellaneous FCMs (continued)
SQR MODIFIED_SQUARE_ROOT MTH USER_MATH_BLOCK
NRM NORMALIZE Extended Processing FCMs
RB RATIO/BIAS MAV CONT_MOVING_AVERAGE
SCL SCALE_INPUT NPT NON-RATE_PERDC_TOTAL
TMP TEMPERATURE_COMPENSN PAV PERIODIC_AVERAGE
Math FCMs PMX PERIODIC_MAXIMUM
ABS ABSOLUTE_VALUE PMN PERIODIC_MINIMUM
AVG AVERAGE PTO PERIODIC_RATE_TOTAL
DIV DIVISION PSD STANDARD_DEVIATION
EXP EXPONENTIATION SP1 SP_ALGO1_FCM *
MUL MULTIPLICATION SP2 SP_ALGO2_FCM *
LOG NATURAL_LOGARITHM SP3 SP_ALGO3_FCM *
PLY POLYNOMIAL SP4 SP_ALGO4_FCM *
SUB SUBTRACTION SP5 SP_ALGO5_FCM *
ADD SUM_OF_4_INPUTS *These FCMs are implemented only in systems
having special applications software.

Configurable Loop Features


The TEMPLET NAME field of the Loop Definition Templet specifies the system
wide tag for the loop. The tag is used by other applications to access the loop. For
example, a TCL program reads the setpoint of a loop with tag TC105, via
TC105.SETPOINT. The tag also labels loop data on displays or reports, Figure 30
and Figure 31. Tags can contain up to 12 alphanumeric characters (A to Z and 0 to
9), the underscore (_), and the hyphen (-). Tags must be unique.

156 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Configurable Loop Features

The LOOP DESCRIPTOR of the Loop Definition Templet is an additional


descriptor for the loop. It appears on the operational displays and on the
Alarm/Event Log during runtime. See Figure 30 and Figure 31 for examples.

Figure 30. Example of Loop Features as Displayed During Runtime

3BUR002336R3701 RevA 157


Loop Processing Rate Section 4 Defining Continuous Loops

Loop Processing Rate


Each loop is processed (scanned) by the loop processor of the module that contains
the loop. There are two types of processing: normal (periodic) and demand scan
(additional) processing.
The normal loop processing rate depends on the following two templet entries:
• The BASERATE field on the CCF Templet determines the rate the loop
processor runs for the module. No loops are processed at a faster rate than the
base rate.
• The PROCESSING RATE field is rounded up to the nearest multiple of the
base rate and the loop is processed at this resultant rate.
Example:
The BASERATE on the CCF Templet is set to 1.
Loop TC100 PROCESSING RATE is 6.5. The system rounds the entry up to
the next higher multiple of the base rate, in this case 7, and processes the loop
every 7 seconds.
Loop processing is also affected by the PROCESSING PHASE field of the Loop
Definition Templet. Phase allows processing of loops with the same processing rate
to be distributed about the processing periods.
Example:
Loops A, B, C, and D have a processing rate of 4. If the phase feature is not
used, (that is, default = 0) they are processed at the beginning of the processing
interval as shown below.
TIME 0 1 2 3 4 5 6 7 8 9 (seconds)
A A A
B B B
C C C
D D D
If phase is used with loop A at phase 0, loop B at phase 1, loop C at phase 2,
and loop D is assigned phase 3, processing is distributed as shown below.
TIME 0 1 2 3 4 5 6 7 8 9 (seconds)
A B C D A B C D A B

158 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Processing Rate

The phase of a loop is initially assigned via the PROCESSING PHASE field of the
Loop Definition Templet. The phase must be an integer in the range of 0 to the value
calculated using the following formula:
(PR/BR) - 1 (rounded to the next higher integer)
where
PR is the processing rate of the loop
BR is the base rate for CCF in the module that contains the loop
Example:
The base rate for CCF in a module is 0.250. A loop in the module is given a
processing rate of 5. Therefore,
(PR/BR) - 1 = 20 -1 = 19
The loop is assigned a phase of 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,
or 19.
If the loop processor finds that two or more loops are scheduled for processing at a
given time, the loop with the lowest entry in the ORDER OF PROCESSING field
on the Loop Definition Templet is processed first.
In addition to normal processing, you can demand scan of loops. This is
accomplished by setting the DMD_SCAN (demand scan) parameter for the loop to
demand scan. This causes the loop processor to perform one additional scan of the
loop. If the loop is scanned periodically, the demand scan does not replace any of
the normally scheduled scans. The value of the DMD_SCAN parameter is usually
NORMAL. You can change the DMD_SCAN parameter to demand scan via TCL
programs, PUT FCMs, ladder logic or an external computer.
A demand scan also occurs for a loop with a scan rate of 0, if the loop is turned ON
(that is, the loop state is ON). The following other factors can also cause demand
scans to occur:
• Both continuous and device loops are demand scanned when demand scan is
turned ON (that is, the loop state is ON).
• When a digital input channel's state changes.

3BUR002336R3701 RevA 159


Measured Variable Section 4 Defining Continuous Loops

This happens both for loops that are periodically processed and for
loops that have a scan rate of 0. If two or more loops use the same
digital channel, only one of them is demand scanned when the state
of the input at the channel changes.

• Either type of loop is demand scanned when TCL or a program running on a


host computer changes the loop's DMD_SCAN parameter to demand scan.
• All loops with scan rates set at 0 are scanned once on the first CCF cycle of the
node that contains the loop.
• A continuous loop is demand scanned when one of its FCMs is switched to
AUTO output (that is, the OUTPUT MODE is AUTO).
• A continuous loop is demand scanned when one of its FCMs is turned ON (that
is, the FCM MODE is ON).
• A device loop is scanned when a new Device Command (DEV_CMND) is
present.
• You can also configure loops to demand scan in a cascade fashion as a result of
particular loops being scanned (DMND PROCESSING MODE field).
On page three of the Loop Definition Templet, use DMND PROCESSING MODE
field, # LOOPS TO PRESCAN field, and LOOPS TO PROCESS fields to specify
up to five loops to process along with this loop. The DMND PROCESSING MODE
field is used to specify whether the specified loops are processed when this loop is
processed normally or when it is demand scanned, or both. The # LOOPS TO
PRESCAN field determines how many of the loops are scanned before this loop and
how many are scanned after. The LOOPS TO PROCESS fields list the loops for this
type of processing.

Measured Variable
You use the NAME OF MEASURED FCM field on the Loop Definition Templet to
specify the result of one FCM of the loop as the measured variable of the loop. The

160 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Trend Graphs for the Measured Variable

measured variable is accessible by other system applications. The measured


variable is used for the following:
• Used by other loops.
• Used by TCL programs.
• Alarms are defined for it.
• Display on the standard displays.
• A trend is provided on standard trend displays.
• Used in reports.
• Used by the Display Builder for custom graphic displays.
• Periodically sampled and stored by the History.
The MEASURED UNITS field is used to specify an engineering units label for the
measured variable. Figure 31 and Figure 34 show examples of how measured
variables are displayed.

Trend Graphs for the Measured Variable


During runtime, trends of the measured variable's value are displayed on the Group
Trend, Area Trend, Group Status, and Loop Detail Displays. Figure 30 and
Figure 31 show examples of trend graphs. Where you define the rate at which trend
data is collected and the upper and lower boundary values of the trend grid depends
on whether you are using a Primary History Log to collect the trend data.
If you are NOT using a Primary History Log, the rate at which trend data is collected
for a loop is specified via the TREND RATE field of the Loop Definition Templet to
be every 0, 6, 12, 60, 120, 360, 720, 1440, or 2880 seconds. The upper and lower
boundary values for the trend grid are specified through the HI ENG. UNIT LIMIT
and LO ENG. UNIT LIMIT fields, respectively.
If you are using a Primary History Log, the rate at which trend data is collected for a
loop is specified via the STORAGE INTERVAL field of the Primary History Log
Templet to be 0.1-0.6, 0.8-6, 8-10, 12, 15, 16, 18, 20, 24, 25, 30, 36, 40, 45, 48, 50,
60, 72, 75, 80, 90, 100, 120, 144, 150, 180, 200, 225, 240, 300, 360, 400, 450, 600,
720, 900, 1200, 1800 of 3600 seconds. You can also specify an offset to the rate
from 0 to 3600 seconds via the TIME OFFSET field. The upper and lower boundary

3BUR002336R3701 RevA 161


Unit Assignments Section 4 Defining Continuous Loops

values for the trend grid are specified through the PRES RANGE MAX and PRES
RANGE MIN fields, respectively.

Tag

Descriptor
Trend Meas.
Graph Units

Trend Meas.
Lines Value

Figure 31. Details of a Group Trend Display

As Figure 31 shows, a trend grid (graph) on the Group Trend and the Area Trend
Displays provides trend lines for up to 4 loops. When you configure a loop, it is best
to assign it the same trend rate or storage interval value as the other 3 loops to be
displayed with it on the trend grid. For the example in Figure 31, loops FIC110,
TC115, and FC112 should have the same trend rate. Loops are grouped together so
you can view their trends together as a group. This is done via the Console
Configurator as described in the Console Configurator User's Guide.

Unit Assignments
You can assign loops to units via the UNIT ID field. This is useful for systems that
use History Services software. The alarm/event history messages for all loops in a
unit are collected and stored in the same file. If a unit assignment is not made for a
loop, the History Services software stores alarm/event history messages for that
loop in a default unit file.

162 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop State

Loop State
The loop state can be either ON or OFF. When the loop state is ON, it is processed
according to its configured processing rate. When the loop state is OFF, the loop
processor ignores the loop. The initial loop state is configured for the loop by the
LOOP STATE field on the Loop Definition Templet. During runtime, the loop state
is turned on or off by the LOOP MD field of the Loop Detail Display. TCL, PUT
FCMs, Ladder Logic, and external computers can also turn the loop on or off by
making changes to the loop state parameter of the loop.

FCMs Belonging to the Loop


When configuring loops via the Control Builder on a Windows-based Engineering
Station, up to 8 FCMs that comprise the loop are defined by the FCM templets that
are children of the Loop Definition templet. A loop may have a maximum of 8
FCMs. When the loop is processed, the FCMs are executed in the order they are
listed below the parent Loop Definition object.
When configuring loops via the Structure Builder on an HP-UX Engineering Station
or via the Configurator on a Turbo Node console, up to 8 FCMs that comprise the
loop are defined in the NAME OF FCM and ALGORITHM FOR FCM fields at the
bottom of the first page of the Loop Definition Templet, Figure 32. A loop may
have a maximum of 8 FCMs. When the loop is processed, the FCMs are executed in
the order they are listed.
Regardless of the configuration platform you are using, the Configurator initially
assigns a default name to each FCM. You can change the name to a user-defined
string of up to three characters. No two FCMs in a loop can have the same name. If
two FCMs of the same type are included in the loop, one must have its name
changed from the default. Each FCM of the loop is identified by the system by a
combination of the tag and the FCM name. For example, the Analog Input FCM in
Figure 32 is identified as TC-105.AIN since it belongs to loop TC-105.

3BUR002336R3701 RevA 163


Alarm Handling: Configuration, Detection, Posting, and Cutout Section 4 Defining Continuous

Figure 32. FCM List for a Loop Definition Templet

Alarm Handling: Configuration, Detection, Posting, and Cutout


You can define several alarm conditions for a loop. When an alarm becomes active,
the loop processor detects the condition while scanning the loop. CCF notifies the
Alarm/Event Handler of the active alarm condition. The Alarm/Event Handler in
turn notifies the other applications. Table 9 lists the type of alarm conditions you
can define for the measured variable via the Loop Definition Templet.
If the loop contains an Auto/Manual Controller FCM, you can define alarms for the
output of the controller on the Auto/Manual Controller Templet. If the loop has a
PID Controller FCM, you can define alarms for the setpoint, output, and deviation
of the controller on the PID Controller Templet.

164 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Alarm Handling: Configuration, Detection, Posting, and

Types of Alarms Configured on Loop Definition Templet

Table 9. Types of Alarms for the Measured Variable

Alarm Type Alarm is Active When…


HI Measured variable exceeds a specified value
LO Measured variable falls below a specified value
BAD MEASURE Data quality of measured variable goes BAD
HIHI Measured variable exceeds a second specified high value.
This value is greater than or equal to the HI alarm limit.
LOLO Measured variable falls below a second specified low value.
This value is less than or equal to the LO alarm limit.
RATE Measured variable's rate of change exceeds a specified rate
as measured from one loop processing cycle to the next.

Configuring an Alarm
The alarms listed in Table 9 are configured on the second page of the Loop
Definition Templet. In general, three templet fields are required to configure an
alarm: an ENABLE field, an alarm limits field, and a PRIORITY field. The fields
are described below using the high (HI) alarm as an example.
• ENABLE HI ALARMS field must be YES to enable the loop processor to
check for the high alarm.
• The HI LIMIT field is used to specify the alarm limit. The default entry is
PROCESS HI, which uses the value of the HI ENG. UNIT LIMIT field on the
first page of the templet. To use a HI limit other than the default, enter the
desired numerical value in the field.
The HI LIMIT field determines when the alarm goes active. The alarm
deadband feature is used to prevent alarms from oscillating between active and
clear states. An active high alarm condition is cleared when the measured
variable is reduced to the HI LIMIT minus the deadband. Figure 33 show an
example of alarm activation. For this example, the high limit is 80 and the

3BUR002336R3701 RevA 165


Alarm Handling: Configuration, Detection, Posting, and Cutout Section 4 Defining Continuous

deadband is 5. The alarm becomes active when the measured variable reaches
80. It clears when the measured variable goes to 75.

Alarm Clear Active Clear


Status

100
90
90 85
80 79.9
80 75.1 75
79.9
70 75
Engineering Units

5 Deadband
60
Alarm Status Alarm Status
50
50 50 Active Clear

40
30 Alarm status changes to active
at 80 and stays active until
20 variable drops to 75 Alarm Limit: 80
(80- 5 deadband). Deadband: 5
10 Then, alarm changes to clear.
0
Time

Figure 33. Example of Alarm Activation

The deadband is specified in engineering units. If the entered value is 5, the


deadband is 5 engineering units.
The default deadband for a turbo node or controller is specified by the ALARM
DEADBAND field of the CCF Templet for the node or controller. You can change
this default via the ENGU ALARM DEADBAND field on the Loop Definition
Templet The field defines the deadband for HI, HIHI, LO, and LOLO alarms on the
measured variable. If the loop contains a PID Controller FCM, the deadband for the
setpoint high and setpoint low limits is also defined by this field.
HI ALARM PRIORITY field assigns a priority of either standard (STD), medium
(MED), or high (HIGH) to the alarm. The entry to this field affects the way the

166 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Alarm Handling: Configuration, Detection, Posting, and

alarm is annunciated and displayed at the Operator Stations or Multibus-based


consolse. When an Operator Station or Multibus-based console is put on-line, the
operator/engineer can specify that different colors be used to distinguish high,
medium, and standard priority alarm indicators on the operational displays. The
Page Selector/Alarm Panels (PSAPs) of the Operator Stations or Multibus-based
consoles indicate high and medium priority alarms with red LEDs and standard
priority alarms with yellow LEDs. The alarm messages logged by the Alarm/Event
Logger also contain the priority level of the alarms. The default priority for an alarm
is STD.

Sequence of Events When an Alarm is Detected


When CCF detects an alarm condition, it starts a number of events. The
Alarm/Event Handler is notified of the alarm which in turn routes alarm messages to
applications specified on the Configuration Area Templet for the Area containing
the loop. Possible destinations are:
• Alarm/Event Loggers which log the alarm occurrence on logging printers
(optional)
• The History which records the occurrence of the alarm (optional)
• Operator Stations (HP-UX or Windows-based) or Multibus-based consoles
The notified the Operator Stations or Multibus-based consoles indicate the alarm
occurrence in the following manner:
• An Operator Station or Multibus-based console produces an audible tone if
audible alarm annunciation is specified on its Console Setup Page.
• An alarm indicator appears on any display that contains the tag of the loop in
alarm.
• An alarm message is listed on the Alarm Display.
• If a button on the PSAP is configured to call up an operator display containing
the tag in alarm, an alarm indicator LED lights up near the button.
Fetch alarm target blinks with selected priority color. The operator must
acknowledge the alarm through the operator displays. When the alarm clears:
• The Alarm/Event Handler notifies other applications of the alarm clearance.

3BUR002336R3701 RevA 167


Alarm Handling: Configuration, Detection, Posting, and Cutout Section 4 Defining Continuous

• The Alarm/Event Logger logs the cleared condition.


• The History stores the time of clearance.
• If the loop is configured for ringback, the operator must acknowledge the
cleared condition.
• Alarm indication disappears.

Alarm Suppression
The SUPPRESS ALARMS field on the second page of the Loop Definition Templet
is used to prevent the loop from checking for the existence of alarms. This feature is
useful during start-up and shutdown procedures. You can change its value by the
Loop/FCM Display, TCL, Ladder Logic, PUT FCMs, and alien computers.

Alarm Posting
The entry for the ENABLE POSTING field affects the way alarms are logged by the
Alarm/Event Logger and the way alarms are acknowledged at the Operator Stations
or Multibus-based consoles.
When posting is enabled, alarm information for the loop is logged on printers by the
Alarm/Event Logger and alarms are acknowledged at an Operator Station or
Multibus-based console in the manner specified on the Console Setup Page for the
Operator Station or Multibus-based console.
When posting is disabled, alarms are not logged by the Alarm/Event Logger and are
automatically acknowledged at the Operator Stations or Multibus-based consoles.
All other console alarm processing is handled in the normal manner.
The entry made to the ENABLE POSTING field is the initial posting enable for the
loop. During runtime, TCL, Ladder Logic, PUT FCMs, and external computers can
turn posting on or off by writing ENABLED and DISABLED to the Posting Enable
(POSTENAB) parameter.

Alarm Cutout
Cutout allows the alarm posting enable for the loop to place the loop under the
control of an FCM from this or another loop. The result of the FCM determines
whether posting is enabled. For example, you can configure the loop such that when

168 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Alarm Handling: Configuration, Detection, Posting, and

the result of FCM TC300.AND is false (0), posting of alarms for loop TC20 is
disabled.
There are three fields on the Loop Definition Templet affecting cutout. They are:
ENABLE CUTOUT enables or disables the cutout feature. During runtime,
TCL can enable or disable cutout by writing ENABLED
or DISABLED to the Cutout Enable (CO_ENAB)
parameter.
CUTOUT SOURCE specifies the loop FCM whose result is the source of the
cutout signal
CUTOUT STATE specifies the state (true or false) the cutout signal must be
in to cause cutout. False is a value of 0, true is any other
value.

COMP MODE Feature


COMP MODE (computer mode) allows you to specify how certain PID or AM
controller loop parameters are handled. During configuration of the Loop Definition
Templet, the decision to restrict or not restrict is made. If COMP MODE
RESTRICT is NO, COMP MODE is not used. If YES is entered, you may restrict
access of the protected parameters to either the computer or the operator.
Restricted parameters for PID Controller FCMs are SETPOINT, SPT_MODE,
RESULT and OUT_MODE. Restricted parameters for AM Controller FCMs are
RESULT and OUT_MODE.
Once you decide to use COMP MODE, you have two options; LOCAL, where the
operator is able to access the restricted parameters but the computer cannot, and
COMPUTER, where the computer program is allowed access to the restricted
parameters but the operator is not. When the COMPUTER option is selected, the
operator can still change control to LOCAL.
The attributes for COMP MODE reside in relation LCM_DEFIN_N. They are:
COMP_ALL computer restriction enabled
1 enable
0 disable

3BUR002336R3701 RevA 169


Alarm Handling: Configuration, Detection, Posting, and Cutout Section 4 Defining Continuous

COMP_REQ computer mode request. See Table 10.


1 requesting computer mode
0 taking mode to local
COMP_MOD computer mode
0 local
1 computer
These parameters interact as shown in Table 10.

Table 10. COMP MODE Parameters

COMP_REQ COMP_MOD TYPE


0 0 Local control
1 0 Requesting computer control
1 1 Computer control
0 1 Invalid state, event monitor sets COMP_MOD
to 0, when you set COMP_REQ to 0

For a computer to take control of a loop, several parameters must be set in a certain
order:
1. Before the computer can take control of the loop, the COMP_ALL parameter
must be set to 1 for the loop (that is, computer mode restriction is enabled). To
do this, enter YES in the COMP MODE RESTRICT field, or set COMP_ALL
to 1 via a computer program.
2. For the computer to control the loop, it sets the COMP_MOD parameter to 1.
Before this can happen, COMP_REQ must be set to 1. COMP_REQ is set by
changing L (LOCAL) to C (COMPUTER) for the loop on an operational
display, or setting COMP_REQ to 1 via a computer program.
3. When COMP_REQ is set to 1, the computer can set COMP_MOD to 1 to take
control of the loop. The program can now manipulate the restricted parameters
according to the loop configuration.

170 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Alarm Handling: Configuration, Detection, Posting, and

When TCL executes an UPDATEON statement, the system treats


the program as an operator user. This causes a program controlling
the loop to lose control of the loop since it no longer looks like a
program to the system.

Watchdog Timer Feature


The watchdog timer allows the loop to go to a failsafe condition if the program fails.
There is no watchdog timer when the entry in the COMP MODE RESTRICT field
is 0.
The watchdog timer is the WD_COUNT parameter of the loop. When the computer
takes control of the loop, the event monitor automatically sets the WD_COUNT
parameter to the value of the WD_TIME parameter. The value of the WD_TIME
parameter is an amount of time configured by the LINK TIMEOUT field of the PID
or AM Templet. The WD_COUNT parameter decrements by one each loop scan.
The program must periodically reset the WD_COUNT parameter so it does not
reach 0. If the value of the WD_COUNT parameter becomes 0, the system assumes
the program has failed and the loop goes to its configured failsafe state. This is
described in Setting the Watchdog Timer.
The failsafe state for a PID controller is defined by the following fields as described
in Section 7, PID Controller FCMS: SETPT VALUE ON FAIL, CHANGE SEPT
ON FAIL, SETPT MODE ON FAIL, OUTPUT MODE ON FAIL, OUTPUT
VALUE ON FAIL, CHANGE and OUTPT ON FAIL.
The failsafe state for an AM controller is defined by the following fields as
described in Section 6, Auto/Manual Controller FCMs: OUTPUT MODE ON
FAIL, CHANGE OUTPT ON FAIL, and OUTPUT VALUE ON FAIL.

3BUR002336R3701 RevA 171


Alarm Handling: Configuration, Detection, Posting, and Cutout Section 4 Defining Continuous

Setting the Watchdog Timer


In a PID or an AM Controller FCM, you specify time in seconds in the LINK
TIME-OUT field. The default is 60 seconds. Time is stored in the data base in terms
of loop scans using the following equation:
WD_TIME = link timeout in seconds
loop scan rate
WD_TIME is an amount of scans rounded down to the nearest integer. For example,
for a link timeout of 60 seconds, and a scan rate is 0.25 seconds, WD_TIME =
60/0.25 = 240.
When the program takes control of the loop, the event monitor automatically sets
WD_COUNT to the value of WD_TIME. Each time the loop is scanned, the value
of WD_COUNT decrements by one. The program must periodically reset
WD_COUNT to keep its value greater than 0 (that is, so a failsafe condition does
not occur). By using the loop scan rate you can calculate the amount of time
WD_COUNT is initially set to. Then insure your program resets the value of
WD_COUNT frequently enough and to a high enough number of scans to prevent
the watchdog timer from timing out.
If the value of the WD_count parameter becomes 0, the system assumes the
program has failed and the loop goes to its failsafe state as defined on its
configuration templets. The configurable failsafe items and possible values for each
are listed in Table 11.

Table 11. Possible Values for Failsafe Fields

Configurable Items Possible Values


SETPT VALUE ON FAIL If changed, specify the value
CHANGE SETPT ON FAIL Change the value – YES or NO (default)
SETPT MODE ON FAIL LOCAL, REMOTE, NO CHANGE, PREVIOUS (default)
OUTPUT MODE ON FAIL AUTO, MANUAL, NO CHANGE, PREVIOUS (default)
OUTPUT VALUE ON FAIL If changed, specify the value
CHANGE OUTPT ON FAIL Change the value – YES or NO (default)

172 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Alarm Handling: Configuration, Detection, Posting, and

You can write programs to put a loop in the computer mode without an operator
request. You can also write the programs such that they wait for the operator's
request. There is no mechanism for the operator to lock the computer from putting
the loop in the computer mode.
You can put any loop in the LOCAL mode at any time. There is no mechanism for
the computer to lock out this capacity other than having the program continually
monitor the mode (or set up an event on the mode) and keep it in the computer
mode.
A configurable time specifies how long the computer program has to change to the
computer mode after the operator requests it to do so. If this time elapses, the
computer request attribute is reset and loop processing remains in the local mode.
The Display Builder and Reports can read the three parameters related to the
computer mode. The following are the event messages related to the computer
mode:
Changing mode from LOCAL to COMPUTER
Changing mode from COMPUTER to LOCAL (not on watchdog timeout)
Changing the value of the COMP_REQ parameter from 0 to 1
Timeout of computer request (1 to 0)

3BUR002336R3701 RevA 173


Loop Definition Templet Section 4 Defining Continuous Loops

Loop Definition Templet


This section describes the fields on the Loop Definition Templet. Figure 34 shows
the upper portion, and shows the lower portion of the Loop Definition Templet.

Figure 34. Loop Definition Templet, Upper Portion

174 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

Figure 35. Loop Definition Templet, Lower Portion

3BUR002336R3701 RevA 175


Loop Definition Templet Section 4 Defining Continuous Loops

TEMPLET NAME Field


Use this field to specify the name all applications use to identify this loop. The
templet name may contain up to 12 characters. Since the name becomes the tag for
the loop, it must be unique system wide.

The following characters are reserved for internal functions within


the system and should not be used in tag names: * : ? ! %
Other characters such as underscore or hyphen (for example FIC-
135) can be used to separate parts of the tag name.

Though not explicitly prohibited, the slash " / " should not be used in tag
names. ASCII Transistion Files can not be created in the AdvaBuild
server if the tag name contains a slash, " / ". The " / " and " + " characters
are illegal characters for MOD 300 tag names in 800xA.

LOOP DESCRIPTOR Field


This field is used to specify a descriptor for the loop. The descriptor is used with the
tag to identify the loop when its parameters are displayed on operational displays or
the Alarm/Event Log. Figure 30 shows how the descriptor appears on an operational
display.
Valid entry is:
any combination of up to 24 alphanumeric characters. All 24 characters are
printed when information for the loop appears on the Alarm/Event Log, and
only the first 12 characters are shown when the descriptor appears on a display.
Mnemonic: LOOPDESC

PROCESSING RATE Field


This field specifies the interval at which the loop is processed (scanned). The
method by which this field, the PROCESSING PHASE, and BASERATE fields
interact to determine the actual loop processing is described in Loop Processing
Rate on page 158.

176 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

Valid entry is in the form:


hr:min:sec
The minimum acceptable value is the base rate of the module as specified on the
CCF Templet described in CCF in Turbo Nodes on page 106. The maximum value
is 255 times the base rate. The value entered on this field is automatically rounded
up to the next higher multiple of the base rate.
Examples:
Entry Interpreted as:
.25 .25 seconds
5 5 seconds
4:17 4 minutes 17 seconds
2:09:04 2 hours 9 minutes 4 seconds
Default is: 1
Mnemonic: SCANRATE
Label on Loop Detail Display: SCANRATE

If the loop receives analog input from a smart device, a processing


rate must be specified. See the Smart Device Interface User's Guide
for information about configuring loops that support smart devices.

During runtime, you can change the processing rate of the loop via the SCANRATE
field on the Loop Detail Display.

The SCANRATE value on the Loop Detail Display is a multiplier


of the BASE RATE and not a time format (minutes:seconds) as
used for the PROCESSING RATE field.

PROCESSING PHASE Field


Use this field to distribute processing for the loops about the processing interval.
The process by which this field, the PROCESSING PHASE, and BASERATE fields

3BUR002336R3701 RevA 177


Loop Definition Templet Section 4 Defining Continuous Loops

interact to determine the loop processing is described in Loop Processing Rate on


page 158.
Valid entry is:
any integer from 0 to PR/BR-1 (rounded up to the next higher integer if not a
whole number) where PR is the processing rate of the loop, and BR is the base
rate of the module containing the loop.
If an entry greater than (PR/BR-1) is made, a compiler warning is generated when
the data base is compiled and the phase is set to 0.
Mnemonic: PHASE
Label on Loop Detail Display: PHASE

If the loop receives analog input from a smart device and a


processing rate of 0 (zero) is specified, leave at the default value.
See the Smart Device Interface User's Guide for information about
configuring loops that support smart devices.

During runtime, you can change the processing phase of the loop via the PHASE
field on the Loop Detail Display.

NAME OF MEASURED FCM Field


Use this field to specify the result of one of the FCMs in the loop as the loop's
measured variable. The value most representative of the loop is usually chosen as
the measured variable so it is easily accessed by other software items in the system.
How the system uses the measured variable is described in Measured Variable on
page 160.
Valid entry is:
the name of any of the FCMs in the loop.
Default is: the result of the first FCM in the loop
Mnemonic: MEASURE (value of the measured variable)

178 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

TREND RATE Field


This field specifies the rate at which the trend data for the measured variable is
collected. This data is displayed on trend graphs of the Group Trend, Area Trend,
Group Status, and Loop Detail Displays during operation of the system. Figure 30
and Figure 31 contain examples of trend graphs. Trend Graphs for the Measured
Variable on page 161, describes the collection and graphing of the data.
Valid entries are the following number of seconds:
0 (no trend collection), 6, 12, 60, 120, 360, 720, 1440, 2880
Default is: 0 (no trending)
If a value not listed above is entered, the trend collection rate is automatically set to
60 seconds. See the descriptions of the LO ENG. UNIT LIMIT and HI ENG. UNIT
LIMIT fields for additional information on how to configure the trend feature for a
loop.

ORDER OF PROCESSING Field


If two or more loops are scheduled for processing at a given time, the loop with the
lowest entry in the ORDER OF PROCESSING field on the Loop Definition
Templet is processed first.
Valid entry is a number between 0 and 99999.0. Decimal values are allowed.
Default is: 9999.0

LO ENG. UNIT LIMIT Field


This field specifies the lower boundary for the trend graphs displaying the value of
the measured variable on operational displays. Trend Graphs for the Measured
Variable on page 161, describes data collection and graphing. The value of this field
is the default value for the LO LIMIT and LOLO LIMIT fields on the second page
of the Loop Definition Templet. These fields define the low alarm limit and the low
low alarm limit, respectively. The LO ENG. UNIT LIMIT value is also the default
value on the templets of Analog Input, Analog Output, PID Controller, Modified
Square Root, and Normalize FCMs for this loop.
Valid entry is a decimal number.

3BUR002336R3701 RevA 179


Loop Definition Templet Section 4 Defining Continuous Loops

Default is: 0.0


Mnemonic: LO_CONV

HI ENG. UNIT LIMIT Field


This field specifies the upper boundary for the trend graphs displaying the value of
the measured variable on operational displays. Trend Graphs for the Measured
Variable on page 161, describes the collection and graphing of the data and contains
an example of a trend graph. The value of this field becomes the default value for
the HI LIMIT and HIHI LIMIT fields on the second page of the Loop Definition
Templet. These fields respectively define the high alarm limit and high high alarm
limit for the measured variable of the loop. The entry for the HI ENG. UNIT LIMIT
field is also used as a default value on the templets of Analog Input, Analog Output,
PID Controller, Modified Square Root, and Normalize FCMs generated for this
loop.
Valid entry is a decimal number.
Default is: 100.0
Mnemonic: HI_CONV

MEASUREMENT UNITS Field


Use this field to define engineering units labels. The labels are used when the
measured variable of the loop is displayed on operational displays. See Figure 30
for an example.
Valid entry is:
any string of up to 6 alphanumeric characters, for example, GPM, PSIG

LOOP STATE Field


This field determines whether the loop is processed. When LOOP STATE is OFF,
the loop processor ignores the loop. The entry made via the Configurator is the
initial loop state.
Valid entries are:
ON process the loop

180 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

OFF do not process the loop


Default is: ON
Mnemonic: LP_STATE
Label on Loop Detail Display: LOOP MD
In runtime, you can toggle the loop state via the LOOP MD field on the Loop Detail
Display.

EXPORT Field
This field is only used when the system has multiple configurators. If your system
uses a single configurator, do not make an entry in the EXPORT field. If your
system uses multiple configurators, you should read the information on multiple
configurators in the System Configurator User's Guide (for Multibus Turbo Nodes),
the AdvaBuild Basic Functions User’s Guide (for HP-UX Advant Stations), or the
AdvaBuild Control Builder User’s Guide (for Windows-based Engineering Stations)
before configuring any loops.
Loops are referenced by items such as other loops, TCL programs, console groups,
and user-defined operational displays. If a loop is referenced only by items in its
own configurator domain, you do not need to export its data and can leave the
EXPORT field blank. If the loop is referenced by items in other configurator
domains, you must export information about this loop to the other domains.
Part of the export process uses the entry in the EXPORT field to put data from the
loop into the export source file. The entry in the EXPORT field is an alphanumeric
string that represents the higher order hex bits of the configurator data processors
(domains) to receive the export data. For example, the entry 125BE specifies that
data from the loop is exported to configurators in turbo nodes at DCN addresses
(hex) 11, 21, 51, B1, and E1.

3BUR002336R3701 RevA 181


Loop Definition Templet Section 4 Defining Continuous Loops

The following fields are used to define alarm-related loop parameters. Alarm
Handling: Configuration, Detection, Posting, and Cutout on page 164, provides
details of the alarm handling methods.

SUPPRESS ALARMS Field


This field determines if the loop processor checks that alarms defined by this loop
are active.
Valid entries are:
YES suppress alarms (do not check)
NO do not suppress alarms
Default is: NO
Mnemonic: CHK_ENB
Label on Loop Detail Display: AL CHEC

ENABLE POSTING Field


This field specifies whether posting is enabled for the loop. Posting affects the way
alarm information is presented at the Operator Stations or Multibus-based consoles
and on the Alarm/Event Log. Alarm Handling: Configuration, Detection, Posting,
and Cutout on page 164, describes the posting feature.
Valid entries are:
YES enable posting
NO disable posting
Default is: YES
Mnemonic: POSTENAB
Label on Loop Detail Display: AL POST
During runtime, you can suppress or enable alarm posting via the AL POST field of
the Loop Detail Display.

182 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

ENABLE CUTOUT Field


This field specifies whether cutout is enabled for the loop. Cutout allows posting of
the alarms to control the loop from an FCM of this or another loop. Alarm
Handling: Configuration, Detection, Posting, and Cutout on page 164, describes the
posting and cutout features.
Valid entries are:
YES enable the cutout feature
NO disable the cutout feature
Default is: YES
Mnemonic: CO_ENAB

CUTOUT SOURCE Field


This field defines the source for the signal causing cutout. The source should be set
up so its value is in one of two states: true (non-zero) or false (zero). When the state
of the source is equal to the state specified in the CUTOUT STATE field, cutout
exists for the loop.
Alarm Handling: Configuration, Detection, Posting, and Cutout on page 164,
describes the posting and cutout features.
Valid entries are:
.fcmname result of another FCM in the loop is the cutout source
tag.fcmname result of an FCM from another loop is the cutout source

CUTOUT STATE Field


This field defines the state the cutout source must be in to cause cutout. See the
CUTOUT SOURCE field description above.
Valid entries are:
TRUE causes cutout when the cutout signal is true (non-zero)
FALSE causes cutout when the cutout signal is false (zero)
Default is: TRUE

3BUR002336R3701 RevA 183


Loop Definition Templet Section 4 Defining Continuous Loops

Mnemonic: CO_STAT
The remaining fields on page 2 of the Loop Definition Templet display are used to
define alarms for the measured variable. A description of the configuration
procedure for an individual alarm is provided in Alarm Handling: Configuration,
Detection, Posting, and Cutout on page 164.

ENABLE HI ALARMS? Field


This field specifies whether the high alarm for the measured variable is enabled.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

HI LIMIT Field
This field defines the high alarm limit for the measured variable. The alarm
becomes active when the measured variable becomes equal to or greater than the
high limit and clears when the measured variable decreases to the value of the high
limit minus the alarm deadband.
Valid entry is a decimal number.
Default is: PROCESS HI (the value entered in the HI ENG. UNIT LIMIT field)
Mnemonic: HILIMT
Label on Loop Detail Display: HIGH MV
During runtime, you can modify the high alarm limit via the HIGH MV field on the
Loop Detail Display.

HIGH ALARM PRIORITY Field


This field sets the alarm priority which determines how the alarm is displayed on
Operator Stations or Multibus-based consoles. When an Operator Station or
Multibus-based console is on-line, you can specify different colors to distinguish
high, medium, and standard priority alarm indicators on displays. The PSAPs

184 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

indicate high and medium priority alarms with red LEDs and standard priority
alarms with yellow LEDs. Alarm messages logged by the Alarm/Event Logger also
contain the alarm priority level.
Valid entries are:
STD standard priority (3)
MED medium priority (2)
HIGH high priority (1)
Default is: STD

ENABLE LO ALARMS? Field


This field determines if the low alarm for the measured variable is enabled. Valid
entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

LO LIMIT Field
This field defines the low alarm limit for the measured variable. The alarm becomes
active when the measured variable becomes equal to or less than the low limit and
clears when the measured variable increases to the value of the low limit plus the
alarm deadband.
Valid entry is a decimal number.
Default is: PROCESS LO (the value entered in the LO ENG. UNIT LIMIT field)
Mnemonic: LOLIMT
Label on Loop Detail Display: LOW MV
During runtime, you can modify the low alarm limit via the LOW MV field on the
Loop Detail Display.

3BUR002336R3701 RevA 185


Loop Definition Templet Section 4 Defining Continuous Loops

LO ALARM PRIORITY Field


This field specifies the priority level for the low alarm.
Valid entries are:
STD standard priority (3)
MED medium priority (2)
HIGH high priority (1)
Default is: STD

BAD MEASURE ALARMS? Field


This field specifies whether the bad data quality alarm for the measured variable is
enabled. The alarm becomes active whenever the data quality of the measured
variable becomes BAD.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

BAD ALARM PRIORITY Field


This field specifies the priority level for the bad data quality alarm.
Valid entries are:
STD standard priority (3)
MED medium alarm priority (2)
HIGH high priority (1)
Default is: STD

186 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

ENABLE RATE ALARMS? Field


This field specifies whether the rate alarm for the measured variable is enabled. The
rate alarm becomes active when the measured variable changes by an amount
greater than the specified rate limit from one loop processing scan to the next.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: NO

RATE LIMIT Field


This field defines the rate alarm limit for the measured variable. The alarm becomes
active when the variable changes at a rate greater than the limit.
Valid entry is:
a number in engineering units, representing the greatest amount the variable
can change per second.
Default is: 0.0

RATE ALARM PRIORITY Field


This field specifies the priority level for the rate alarm.
Valid entries are:
STD standard priority (3)
MED medium alarm priority (2)
HIGH high priority (1)
Default is: STD

ENGU ALARM DEADBAND Field


This field defines a deadband for the high, low, high high, and low low alarms on
the measured variable. It also becomes the deadband for any setpoint low or setpoint
high alarm for the loop. Alarm deadbands work as described in the paragraphs of

3BUR002336R3701 RevA 187


Loop Definition Templet Section 4 Defining Continuous Loops

Alarm Handling: Configuration, Detection, Posting, and Cutout on page 164,


labeled Configuring an Alarm.
Valid entry is a floating point number in the engineering units of the loop.
Default is: CCF_ALMDB_EU (value of the ALARM DEADBAND field on
the CCF Templet scaled in the engineering units of this loop)
Mnemonic: EU_DEBD

ENABLE HIHI ALARMS? Field


This field specifies whether the high high alarm for the measured variable is
enabled. This is a second high alarm level for the measured variable.
For example, the high alarm for a flow is set at 200 GPM and the high high alarm is
set at 230 GPM. When the flow becomes equal to or higher than 200 GPM, the high
alarm becomes active. If the flow increases to a rate equal to or larger than 230, both
the high high and the high alarms are active.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: NO

HIHI LIMIT Field


This field defines the high high alarm limit for the measured variable. The alarm
becomes active when the measured variable becomes equal to or greater than the
high high limit and clears when the variable decreases to the value of the high high
limit minus the alarm deadband.
Valid entry is a decimal number.
Default is: PROCESS HI (value entered in the HI ENGU. UNIT LIMIT field)
Mnemonic: HIHILIMT
Label on Loop Detail Display: HIHI MV
During runtime, you can modify the high high alarm limit via the HIHI MV field on
the Loop Detail Display.

188 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

HIHI ALARM PRIORITY Field


This field specifies the priority level for the high high alarm.
Valid entries are:
STD standard priority (3)
MED medium alarm priority (2)
HIGH high priority (1)
Default is: STD

ENABLE LOLO ALARMS? Field


This field specifies whether the low low alarm for the measured variable is enabled.
This is a second low alarm level for the measured variable.
For example, the low alarm for a flow is set at 100 GPM and the low low alarm is
set at 80 GPM. When the flow becomes equal to or less than 100 GPM, the low
alarm becomes active. If the flow decreases to a rate equal to or lower than 80, both
the low low and the low alarm are active.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: NO

LOLO LIMIT Field


This field defines the low low alarm limit for the measured variable. The alarm
becomes active when the measured variable becomes equal to or less than the low
low limit and clears when the measured variable increase to the value of the low low
limit plus the alarm deadband.
Valid entry is a decimal number.
Default is: PROCESS LO (value entered In the LO ENGU. UNIT LIMIT field)
Mnemonic: LOLOLIMT
Label on Loop Detail Display: LOLO MV

3BUR002336R3701 RevA 189


Loop Definition Templet Section 4 Defining Continuous Loops

During runtime, you can modify the low low alarm limit via the LOLO MV field on
the Loop Detail Display.

LOLO ALARM PRIORITY Field


This field specifies the priority level for the low low alarm.
Valid entries are:
STD standard priority (3)
MED medium alarm priority (2)
HIGH high priority (1)
Default is: STD

UNIT ID Field
This field assigns the loop to a unit. This is useful for systems that use the History
software. The alarm/event history messages for all loops in a unit are collected and
stored in the same file. If a unit assignment is not made for a loop, the History
Services software stores alarm/event history messages for the loop in a default unit
file.
Valid entry is:
the name of a unit as defined in the TEMPLET NAME field on the Unit Master
Templet for the unit
The following fields are used to specify computer mode and processing items for
the loop.

COMP MODE RESTRICT Field


COMP MODE (computer mode) is used to specify how certain PID or an AM
controller loop parameters are handled. During configuration of the Loop Definition
Templet, you can set loop control to either restricted or not restricted. There are two
entries for this field. They are:
NO no restrictions on control of the protected attributes. The computer
mode feature is used.

190 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

YES control of the protected attributes is restricted to either the operator


or the computer. Computer control indicates that a TCL program or
a program running on a VAX™, IBM PC™ or MODCOMP
computer attached to the Advant OCS, is manipulating PID or AM
parameters.
Default is: NO
Mnemonic: COMP_ALL computer restriction enabled
1 enable
0 disable
COMP_REQ computer mode request. See Table 10.
1 requesting computer mode
0 taking mode to local
COMP_MOD computer mode
0 local
1 computer
For more detailed information regarding COMP MODE see Alarm Handling:
Configuration, Detection, Posting, and Cutout on page 164, labeled Using the
COMP MODE Feature.

ABNORMAL STATE Field


This field specifies whether the system should check the loop for an abnormal
condition. An abnormal condition for a continuous loop is caused by any one of the
following conditions:
• Loop is off
• An FCM is off
• Output of an FCM which is not a PID or AM Controller FCM is in MANUAL
• Output mode of a PID Controller FCM or an AM Controller FCM is not in its
design state as defined on its templet
• Setpoint mode of a PID Controller FCM is not in its design state as defined on

3BUR002336R3701 RevA 191


Loop Definition Templet Section 4 Defining Continuous Loops

its templet
Valid entries are:
YES system checks for an abnormal state. If an abnormal state exists, the
NORMSTAT attribute is set to 1 and the tag is displayed in reverse
video on the operational displays.
NO system does not check for an abnormal state.
Default is: NO
Mnemonic: ENAB_FLG for abnormal state checking
NORMSTAT 0 normal state
1 abnormal state

DMND PROCESSING MODE Field


This field is specifies whether the specified loop(s) are processed when the loop is
processed normally or when it is demand scanned, or both.
Valid entries are:
NONE no extra processing
NORMAL process loops in the LOOPS TO PROCESS fields when this loop is
normally scanned
DEMAND process loops in LOOPS TO PROCESS fields when this loop is
demand scanned
BOTH process loops in LOOPS TO PROCESS fields when this loop is
demand scanned or normally scanned

# LOOPS TO PRESCAN Field


This field determines how many loops in the LOOPS TO PROCESS fields are
processed before this loop is processed and how many are processed after.
Valid entry is:
an integer from 1 to 5 which specifies the number of loops to process before the
loop

192 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Loop Definition Templet

Default: 0
For example, if there are five loops listed in the LOOPS TO PROCESS fields and
the # LOOPS TO PRESCAN field contains a 2, when the DMND PROCESSING
MODE field calls for processing, the first two loops in the LOOPS TO PROCESS
fields are processed before this loop and the last three in the LOOPS TO PROCESS
fields are processed after it.

FCM LIST Edit Window


The FCM LIST edit window is only available on the Loop Definition Templet when
you are configuring a loop via an HP-UX Engineering Station or a Turbo Node
console. Use the NAME OF FCM and ALGORITHM FOR FCM fields of the edit
window to specify up to 8 FCMs in the order they are executed during loop
processing. When configuring the loop via the Control Builder on a Windows-based
Engineering Station, the order in which the FCMs are processed is determined by
the order in which the FCMs are listed below the parent Loop Definition object. See
FCMs Belonging to the Loop on page 163.
In the column of NAME OF FCM fields enter the three character name (fcmname)
for each FCM of the loop in the order they should be processed. No two FCMs in
the loop can have the same name. The object or templet type associated with each
specified FCM name is automatically displayed in the corresponding row in the
column of ALGORITHM FOR FCM fields.

LOOPS TO PROCESS Fields


This column of fields lists the loops to be processed in conjunction with the DMND
PROCESSING MODE field and the # LOOPS TO PRESCAN field.
Valid entries are:
up to 5 loop tags. Each of the 5 fields in the column of LOOPS TO PROCESS
fields can hold one tag. Do not enter the tag of the loop being configured. Up to
five levels of nesting are allowed, that is, loops in the fields demand process
other loops, and so on

3BUR002336R3701 RevA 193


Non-configurable Loop Level Parameters Section 4 Defining Continuous Loops

Non-configurable Loop Level Parameters


The following loop parameters are defined automatically by the system during
runtime. They are not configured via the templets.

DQ_MEAS - Data Quality of Measured Variable


During runtime, TCL programs can read this parameter to determine the data
quality of the measured variable.
Possible states for the parameter are: GOOD, BAD
The data quality of the measured variable goes to BAD whenever the data quality of
any variable used in calculating the measured variable goes to BAD.

DMD_SCAN - Demand Scan


This determines if the loop is processed normally or if a special loop scan is
required. Possible states for the parameter are:
NORMAL process the loop according to the processing rate and phase
parameters
DEMAND_SCANscan the loop immediately. After the scan, the parameter value is
automatically changed back to NORMAL.
During runtime, TCL programs, Ladder Logic, PUT FCMs, and external computers
can cause scanning of a loop by changing the value of this parameter to demand
scan.

ERR_FCM Output FCM which has Failed


This parameter contains the index number of any FCM in the loop which failed
during loop processing. The index numbers, which run from 0 to 7, refer to the order
in which the FCMs are processed in the loop. For example, Figure 36 shows the
FCM list from a Loop Definition Templet. For this loop, the Analog Input FCM has

194 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Primary History Log

an index number of 0, the PID Controller FCM has an index number of 1, and the
Analog Output FCM has an index number of 2.

Figure 36. FCM List From the Loop Definition Templet

MEAS_ALM - Measured Value Alarm Indicator


This parameter indicates if there are any active alarms on the measured variable of
the loop. Possible states for the parameter are: NO_ALARM, DQ_BAD, HIHI, HI,
LO, LOLO

MROC_ALM - Measured Value Rate of Change Alarm Indicator


This parameter indicates whether the rate of change alarm for the measured variable
is active. Possible states for the parameter are:
NO_ALARM
IROC rate of change alarm active

Primary History Log


The Primary History Log is used to collect the MEASURE, RESULT or SETPOINT
values of a continuous loop for trend display or for collection by History Services.
Functionality for Primary History Logs resides only on Advant Controllers,
including the AC410 (PM150) and AC460 (PM510).
Primary History Logs provides the following improvements over traditionally
collected trend data:
• More flexible
– Log size is configurable from 1 to 16,000 points instead of the fixed size
of 300 points for traditionally collected trends.

3BUR002336R3701 RevA 195


Primary History Log Configuration Section 4 Defining Continuous Loops

– Collection rates can be faster than 6 seconds of traditionally collected


trends.
– Retrieval can be specified with most of the parameters available to
History, including selectionTime, timeJustification, logEntry-Order, and
directionOfRequest, allowing retrieval to proceed forward or backward in
time at any rate. Note that advanced History features including
calculations and interpolation are not supported by Primary History Logs.
• Greater precision of data
– Collected values are stored in their original floating point form rather than
scaled into single byte integers. Integer data is stored as four-byte integers.
– Timestamps are stored rather than approximated based on the collection
rate.
• Better status
– No-data and bad_data states status bits are stored with the data as illegal
values in place of actual values.
• More efficient access
– Since data needed by a real History Log is collected by a Primary History
Log, History can use Primary Logs as substitutes for remotely collected
logs, eliminating the overhead of remote subscriptions to loops for every
point collected and providing more accurate timestamps.

Primary History Log Configuration


You configure a Primary History Log via the Primary History Log Templet
(PRIM_LOG), Figure 37, which is a child of the Loop Definition Templet
(LOOP_DEF). To insert a Primary History Log Templet, using the Structure
Builder, select the desired loop in the tree structure, choose Insert from the Edit
menu, and enter the necessary information in the Insert Object dialog box. The
Primary History Log object is placed in hierarchy order after all FCMs. You can
configure a maximum of three Primary History Log Templets per Loop Definition
Templet, allowing you to configure a Primary History Log for each of the three loop
attributes (MEASURE, RESULT, and SETPOINT) for which the log can collect
data.

196 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Primary History Log Configuration

Figure 37. Primary History Log Templet (PRIM_LOG)

The fields of the Primary History Log Templet and valid entries are described
below.

TEMPLET NAME Field


This field is used to identify the loop and attribute from which the Primary History
Log collects data in the following format:
<loopname>.<fcmmane>
where
<loopname> is up to 12 characters identifying the loop from which data is
collected
<fcmname> is up to 3 characters identifying the FCM

3BUR002336R3701 RevA 197


Primary History Log Configuration Section 4 Defining Continuous Loops

Since the name specified is used by other applications (for example, History) to
identify the Primary History Log, the templet name must be unique system wide and
may contain up to 16 characters including the period.

The following characters are reserved for internal functions within


the system and should not be used in loop names: * : ? ! %
Other characters such as underscore or hyphen (for example FIC-
135) can be used to separate parts of the loopname.

PARENT NAME Field


This field is automatically filled by the system.

LOGGED ATTRIBUTE Field


This field identifies the attribute for which the Primary History Log collects data.
Valid entries are:
MEASURE
RESULT
SETPOINT
Default is: MEASURE

PRES RANGE MIN Field


This field specifies the minimum value for log presentation on trend displays.
Valid entry is a floating point number.
Default is: PROCESS LO (the value entered in the LO ENG. UNIT LIMIT field on
the parent Loop Definition Templet)

PRES RANGE MAX Field


This field specifies the maximum value for log presentation on trend displays.
Valid entry is a floating point number.

198 3BUR002336R3701 RevA


Section 4 Defining Continuous Loops Primary History Log Configuration

Default is: PROCESS HI (the value entered in the HI ENG. UNIT LIMIT field on
the parent Loop Definition Templet)

STORAGE INTERVAL Field


This field specifies the collection rate (that is, the time interval between stored log
entries) in seconds.
Valid entries are: 0.1 to 3600 seconds and must be a multiple of the loop’s scan rate
that divides into an hour evenly (that is, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.8, 0.9, 1, 2, 3, 4,
5, 6, 8, 9, 10, 12, 15, 16, 18, 20, 24, 25, 30, 36, 40, 45, 48, 50, 60, 72, 75, 80, 90,100,
120, 144, 150, 180, 200, 225, 240, 300, 360, 400, 450, 600, 720, 900, 1200, 1800,
and 3600)
Default is: 6.0

While the STORAGE INTERVAL may be specified as low as a


tenth of a second, you must realize that such a fast rate places high
loading on the system and is not generally recommended except for
a very small number of loops.

TIME OFFSET Field


This field specifies the offset of collection times within the storage interval in
seconds used to synchronize logs with the same storage rate to distribute loading of
the system.
Valid entries are: 0 to 3600 seconds
Default is: 0

LOAD CAPACITY Field


This field specifies the number of entries to be stored in the log.
Valid entry is an integer from 1 to 16,000.
Default is: 300

3BUR002336R3701 RevA 199


Changing Primary History Log Parameters Section 4 Defining Continuous Loops

LOG ALARMS Field


Since the functionality has not been implemented to log alarms with the data at this
time, the valid and default entry for this field is NO.

Changing Primary History Log Parameters


Only the presentation range for a Primary History Log can be changed from run-
time trend displays.
To change the storage interval or log capacity, you must reconfigure these fields on
the Primary History Log Templet and then incrementally compile, install and
download the database at the LOOP_DEF level.

Adding and Deleting Primary History Logs


You can add new Primary History Logs by configuring a Primary History Log
Templet for each new log and then incrementally compiling, installing, and
downloading the database at the LOOP_DEF level. Deletion of Primary History
Logs in the run-time database is supported by deletion of the Primary History Log
Templet, followed by the incremental compile, install, and download of the database
at the parent LOOP_DEF level.

200 3BUR002336R3701 RevA


Section 5 Input FCMS

General Information
The Input FCMs are used to bring in values from outside the Advant OCS. These
values can come from I/O interfaces of either Controller or Turbo Node
Subsystems. These inputs are further processed before being passed to other FCMs.
The following types of Input FCMs are available: Analog Input, Digital Input, and
Pulsed Input. This section describes how to configure input FCMs. Input FCM
parameters are described in Data Base Tables.

Loops supporting smart devices use Analog Input FCMs to acquire


smart device input values from the analog channel table. See Smart
Device Interface User's Guide, for information about FCMs
supporting smart device input.

Analog Input FCM


An Analog Input FCM brings in an analog value from an I/O driver and converts it
to engineering units. It can also apply a limit to the analog value. Further processing
of analog values is performed by either the First Order Filter, Lead/Lag Filter,
Polynomial, Linearization, or Modified Square Root FCMs. These FCMs are
described in Section 9, Calculator FCMS.
The Analog Input FCM is configured via the Analog Input FCM Templet. Figure 38
shows an example of the Analog Input FCM Templet from the AdvaBuild Templet
Builder running on the Windows platform. The AdvaBuild Template Builder
running on the HP-UX platform and the MOD 300 Configurator views of this
templet are essentially the same, although the user interface differs slightly. This
templet is used to specify the location and type of input, the engineering units range
for the input, input limiting techniques, and FCM initialization parameters.

3BUR002336R3701 RevA 201


Analog Input FCM Section 5 Input FCMS

Figure 38. Analog Input FCM Templet

RTD, TC, OR HI-LEVEL Field


This field is used to specify the type of input module. It is used for loops that get
input from either a TRIO, Burr Brown, or PLC module. It identifies the type of
input channel being requested by the entry in the CHANNEL NUMBER field.
Information on channel numbers in a Multibus I/O Subsystem is provided in
Multibus I/O Templet on page 111.

202 3BUR002336R3701 RevA


Section 5 Input FCMS Analog Input FCM

Valid entries are:


RTD input comes from an RTD (Resistance Temperature Device)
TC input comes from a mV/thermocouple module
HI-LEVEL input comes from a analog input module
Default is: HI-LEVEL
Mnemonic: AI_TYPE

The Analog Input FCM algorithm just divides by 10.0 for TRIO
RTD and TC blocks, therefore, the appropriate RTD or TC entry
must be made to this field.

COUNTS - LOWER BOUND Field


This field specifies the lower limit for the range of counts. It corresponds to the
engineering units lower bound. See Configurable Features of the Analog Input FCM
on page 208, for a description of the counts/engineering units conversion.
Valid entry is an integer between 0 and 32767.
Default is: 750
Mnemonic: LO_COUNT

COUNTS - UPPER BOUND Field


This field specifies the upper limit for the range of raw counts. It corresponds to the
engineering units upper bound. See Configurable Features of the Analog Input FCM
on page 208, for a description of the counts/engineering units conversion.
Valid entry is an integer between 0 and 32767.
Default is: 3750
Mnemonic: HI_COUNT

3BUR002336R3701 RevA 203


Analog Input FCM Section 5 Input FCMS

ENGU - LOWER BOUND Field


This field specifies the engineering units range lower limit. See Configurable
Features of the Analog Input FCM on page 208, for a description of the
counts/engineering units conversion.
Valid entry is a decimal number.
Default is: PROCESS LO (entry made in the LO ENG. UNIT LIMIT field of
the Loop Definition Templet that is the parent of this FCM templet)
Mnemonic: LO_CONV

ENGU - UPPER BOUND Field


This field specifies the engineering units range upper limit. See Configurable
Features of the Analog Input FCM on page 208, for a description of the
counts/engineering units conversion.
Valid entry is a decimal number.
Default is: PROCESS HI (entry made in the HI ENG. UNIT LIMIT field of the
Loop Definition Templet that is the parent of this FCM templet)
Mnemonic: HI_CONV
If the loop receives input from a smart device, the ENGU - LOWER BOUND and
ENGU - UPPER BOUND fields are the lower and upper limit of the engineering
units range specified for the primary value during initial configuration of the smart
device. Upon establishing smart device communication, the ENGU - LOWER
BOUND and ENGU - UPPER BOUND for the primary value are defaulted to the
device's engineering units range.
For secondary, tertiary, and fourth values of a smart device, configure the ENGU -
LOWER BOUND and ENGU - UPPER BOUND fields based on the range of
possible values of variables in the smart device. The secondary, tertiary, and fourth
values' engineering units are not updated by the interface when communication is
established.

204 3BUR002336R3701 RevA


Section 5 Input FCMS Analog Input FCM

INPUT LIMITED Field


This field specifies whether the input signal is limited when it tries to exceed the
high or low bounds. See Configurable Features of the Analog Input FCM on page
208, for details.
Valid entries are:
YES limit the input
NO do not limit the input
Default is: YES
Mnemonic: RANGE_CK

VENDOR TYPE Field


This field is used to specify the type of I/O providing input or receiving output.
Valid entries are:
CONTROLLER Controller I/O (Direct I/O for a controller)
CUSTOM I/O Customized I/O
BURR/BROWN Multibus I/O
PLC I/O Programmable Controller inputs (Serial interface to a PLC)
PROFIBUS I/O Profibus I/O. This vendor type is only available for Advant
Controller 460 subsystems configured on the Windows platform
using the AdvaBuild Control Builder version 3.2 or higher
software.
REMOTE I/O Taylor Remote I/O (TRIO)
S100 I/O
S800 I/O This vendor type is only available for systems that use
Engineering Station version 2.5 or higher.
SMART I/O Smart device inputs (serial interface to a smart device)
Default is: TRIO for either turbo nodes or controllers

3BUR002336R3701 RevA 205


Analog Input FCM Section 5 Input FCMS

Vendor types of PLC I/O and SMART I/O cannot coexist in the
same node.

LAN NUMBER Field


This field requires the number of the field bus that the modules are on. This number
is determined by the field bus connector on the Field Bus Interface module. To
determine which bus the module is on, check to see if the bus is labeled with its bus
number. If it is not, you can trace the bus number by checking to see which
connector the cable is attached to at the Field Bus Interface Module.
You can have up to 6 field buses connected to a turbo node. You can determine
which bus the module is on by checking to see if the bus has been labeled with its
bus number. If the cable is not labeled, the field bus module for that bus must be
pulled out of the Multibus Card File. On this board, there is a cluster of six jumper
positions labeled W7 to W12. There should be a jumper in one of these positions. If
the jumper is in position W7 the module is on Field Bus 1. If the jumper is in
position W8, the module is on Field Bus 2. This progression continues, that is, if the
jumper is in position W12 the module is on Field Bus 6.

BLOCK NUMBER Field


This field specifies the number of the TRIO module containing the input or output
channel. It is only used when the input comes from a TRIO module.
Valid entry is an integer in the range of 1 to 100

206 3BUR002336R3701 RevA


Section 5 Input FCMS Analog Input FCM

CHANNEL NUMBER Field


This field requires an entry. It specifies input the channel number. Channel
numbering depends on the type of I/O. The following is a list of I/O types and
corresponding channel numbers:
Type of I/O Channel Numbering
DIRECT I/O (CONTROLLER) 1 to 16 (See Table 13)
TRIO Analog1-4
RTD1-6
Thermocouple1-6
Millivolt1-6 (See Table 15)
BURR BROWN Channel numbers depend on module type and
quantity. Channel 1 for a type of input (RTD, Hi
Level or Thermocouple) is on the module that has
the lowest hardware address. See Table 14 for
references to detailed information.
PLC I/O See Taylor™ Programmable Controller Interface
User's Guide.
SMART I/O See Smart Device Interface User's Guide.
Valid entry is the channel number at which the input is present

CHANNEL PATH
This field is only available when using the AdvaBuild Templet Builder to configure
the Analog Input FCM. An entry is required in this field if the entry in the
VENDOR TYPE field is either S800 I/O or PROFIBUS I/O.
For S800 I/O, this field is used to specify the LAN, station, cluster, position, and
channel of the I/O point in the following format:
LAN.station.cluster.position.channel
For example, an entry of 1.10.0.4.10 indicates that the S800 I/O point is on LAN 1,
station 10, cluster 0, position 4, channel 10.

3BUR002336R3701 RevA 207


Configurable Features of the Analog Input FCM Section 5 Input FCMS

For PROFIBUS I/O, this field is used to specify the LAN, device, module, and
channel of the I/O point in the following format:
LAN.device.module.channel
For example, an entry of 1.2.5.1 indicates that the Profibus I/O point is on LAN 1,
device 2, module 5, channel 1.

INITIAL OUTPUT MODE Field


This field determines the output mode for the FCM at startup.
Valid entries are:
AUTO FCM determines output values
MAN operator determines output values
Default is: AUTO
Mnemonic: INITMODE

INITIAL OUTPUT Field


This field determines the result (output value of the FCM) in effect upon startup of
the FCM.
Valid entry is a decimal number.
Default is: 0.0
Mnemonic: INIT_OUT

Configurable Features of the Analog Input FCM


The FCM input comes from the analog channel specified in the CHANNEL
NUMBER field of the Analog Input FCM Templet.
The number read at the channel is referred to as counts. The input either comes from
a TRIO module or it is produced in the following manner. A field transmitter
produces a signal (usually 4 to 20 mA dc current) proportional to the process
variable being measured. This current is sent to the termination panel of the
controller or turbo node where it is converted to a voltage (usually 1 to 5V dc).
Some I/O modules allow for multiplication of the voltage by a gain factor

208 3BUR002336R3701 RevA


Section 5 Input FCMS Configurable Features of the Analog Input FCM

determined by the hardware configuration of the board or by the CCF software. The
analog signal is converted to digital. The result is translated into an integer number
which becomes the counts value present at the channel.
In a Controller Subsystem, a standard transmitter 4 mA signal equals 750 counts,
while a 20 mA signal equals 3750 counts. In a Multibus I/O Subsystem the gain of
the I/O modules is set either by hardware or software. To determine the
characteristics of a Multibus I/O channel, consult your Project Data Manual for the
system, the instruction book for the I/O module, and the entries made in the AI
DEFAULT CHANNEL GAIN field and the AI CHANNEL and AI GAIN fields of
the Multibus I/O Templet for the Multibus I/O Subsystem.
The CCF Software converts counts to engineering units using a proportion defined
by the COUNTS - LOWER BOUND, COUNTS - UPPER BOUND, ENGU -
LOWER BOUND, and ENGU - UPPER BOUND fields. The equation set up by
these entries is:
C – LC
EU =  ----------------------  HU – LU  + LU
HC – LC
where
EU is the input value in engineering units
C is the counts
HC is the high counts (entry in COUNTS - UPPER BOUND field)
LC is the low counts (entry in COUNTS - LOWER BOUND field)
HU is the high engineering units (entry in ENGU - UPPER BOUND
field)
LU is the low engineering units (entry in ENGU - LOWER BOUND
field)
For example, a flow rate in a process is being measured. When the flow is at its
expected low value of 200 GPM, the counts at the input is 750. When the flow is at
its expected high value of 800 GPM, the counts are 3750. Therefore, the entries in
the fields of this templet would be:
COUNTS - LOWER BOUND 750
COUNTS - UPPER BOUND 3750
ENGU - LOWER BOUND 200

3BUR002336R3701 RevA 209


Configurable Features of the Analog Input FCM Section 5 Input FCMS

ENGU - UPPER BOUND 800


Input limiting occurs when the INPUT LIMITED field is YES. When limiting is in
effect, the upper bound for the input is the value entered in the COUNTS - UPPER
BOUND field. See Figure 39. The data quality of the input is GOOD as long as the
input is in the deadband region. The deadband is defined by the INPUT FCM
DEADBAND field on the CCF Templet. When the input value exceeds the
deadband, the data quality is BAD. Similar limiting techniques are used at the lower
boundary.
When limiting is not in effect, the input conversion follows the curve defined by the
engineering units/counts proportion. The data quality of the input goes to BAD
when the input exceeds the range of counts by more than the deadband.
Refer to the PROFIBUS Interface for Advant Controller 460 instruction book for
special scaling considerations for Profibus analog inputs.

210 3BUR002336R3701 RevA


Section 5 Input FCMS Analog Input Based on Input Type

Engineering Units Deadband Deadband


Input counts is not
limited inside deadband
when INPUT LIMITED is NO
Engineering Units
Upper Bound

Input count is limited


Limited Values inside deadband when
INPUT LIMITED is YES
Engineering Units
Lower Bound
When input counts goes
beyond deadband, data
quality of input goes to
Unlimited BAD. Last valid input
Values value is used.

Counts - Counts -
Lower Bound Upper Bound
Input Counts

Figure 39. Input Limiting

Analog Input Based on Input Type


Table 12 shows which Analog Input Templet fields are used by the controller and
turbo nodes. An entry of N/A indicates that the templet field is not applicable for the
type of input, and an entry of X indicates that an entry is needed in that templet field
for the type of input.

3BUR002336R3701 RevA 211


212

Analog Input Based on Input Type


Table 12. Quick Reference to Analog Input Fields Based on Input Type

DIRECT I/O TRIO BURR BROWN PLC I/O SMART I/O S100 I/O
FIELDS ON THE ANALOG S800 I/O PROFIBUS I/O
(Controller (Controller or (Turbo Node (Turbo Node (SC Controller (AC 410 or
INPUT TEMPLET (AC 460 ONLY) (AC 460 ONLY)
ONLY) Turbo Node) ONLY) ONLY) or Turbo Node) AC 460)

RTD, TC OR HI-LEVEL N/A X X X X X X X

COUNTS - LOWER BOUND 750 X X X X X X X

COUNTS - UPPER BOUND 3750 X X X X X X X

ENGU - LOWER BOUND X X X X X X X X

ENGU - UPPER BOUND X X X X X X X X

INPUT LIMITED X X X X X X X X

VENDOR TYPE CONTROLLER REMOTE I/O BURR BROWN PLC I/O SMART I/O S100 I/O S800 I/O PROFIBUS I/O

LAN NUMBER N/A X N/A N/A N/A X N/A N/A

BLOCK NUMBER N/A X N/A N/A N/A X N/A N/A

CHANNEL NUMBER X X X X X X N/A N/A

CHANNEL PATH N/A N/A N/A N/A N/A N/A X X

INITIAL OUTPUT MODE X X X X X X X X

INITIAL OUTPUT X X X X X X X X
3BUR002336R3701 RevA

Section 5
Input FCMS
Section 5 Input FCMS Analog Input Based on Input Type

The Analog Input FCM is used for several different types of input. Table 13 through
Table 15 provide references to detailed descriptions of analog input handling.

Table 13. Controller - Direct I/O

TYPE OF INPUT MODULE Refer to:


Voltage or current inputs via the 6050N Analog Inputs for a Controller on page 84
Controller Analog Termination Panel
6150B Non-isolated Analog Signal Conditioning Analog Inputs for a Controller on page 84
6152B Isolated Analog Signal Conditioning Analog Inputs for a Controller on page 84
6153B Isolated Millivolt Signal Conditioning Millivolt Inputs for a Controller on page 88
6154B Isolated Thermocouple Signal Thermocouple Inputs for a Controller on page
Conditioning 90
6155B Isolated RTD Signal Conditioning RTD Inputs for a Controller on page 93
6156B Isolated Pulse Signal Conditioning Pulse Inputs for a Controller on page 97

3BUR002336R3701 RevA 213


Analog Input Based on Input Type Section 5 Input FCMS

Table 14. Turbo Node - Burr Brown

TYPE OF INPUT MODULE Refer to:


6100B Analog Input Module Analog Inputs in Multibus I/O Subsystems on
6101B Analog Input Expander page 118
6102B Millivolt/Thermocouple Thermocouples in Multibus I/O Subsystems on
Input page 126, Millivolt and Voltage Inputs via 6102D
Millivolt/Thermocouple Modules on page 137
6105B RTD Input RTDs in Multibus I/O Subsystems on page 139
6106B Pulse Input Pulse Inputs in Multibus I/O Subsystems on
page 144
6107B Digital I/O Digital Inputs and Outputs in Multibus I/O
Subsystems on page 125
6108B Analog Output Analog Outputs in Multibus I/O Subsystems on
page 124

Table 15. Controller or Turbo Node - TRIO

TYPE OF INPUT MODULE Refer to:


Voltage or current inputs via the 6230B Analog Taylor™ Remote I/O (TRIO) User's Guide
I/O Module
Current inputs via a 6231B Current Analog I/O Taylor™ Remote I/O (TRIO) User's Guide
Module
Millivolt or thermocouple inputs via a 6232B Taylor™ Remote I/O (TRIO) User's Guide
Thermocouple Module
RTD Inputs via a 6233B RTD Input Block Taylor™ Remote I/O (TRIO) User's Guide

214 3BUR002336R3701 RevA


Section 5 Input FCMS Digital Input FCM

Digital Input FCM


A Digital Input FCM reads the state of up to 16 contiguous digital input channels
from digital I/O devices. Figure 40.shows an example of the Digital Input FCM
templet from the AdvaBuild Templet Builder running on the Windows platform.
The AdvaBuild Template Builder running on the HP-UX platform and the MOD
300 Configurator views of this templet are essentially the same, although the user
interface differs slightly.

Figure 40. Digital Input FCM Templet

3BUR002336R3701 RevA 215


Digital Input FCM Section 5 Input FCMS

NUMBER OF POINTS Field


This field specifies the number of inputs to read. When the default is used (1), the
only input read is the first input specified by the CHANNEL NUMBER field. If you
use a value greater than one, the first input and inputs contiguous to it are read. For
example, if the field is set to 5, the first input and the next four contiguous inputs are
read.
Valid entry is an integer between 1 and 16
Default is: 1
Mnemonic: NUM_CON

INVERTED INPUTS Field


This field is used to modify the input bit patterns received by the Digital Input FCM.
Valid entry is a decimal number converted to binary bit positions, specifying which
bits are inverted.
Default is: 0 (no inversion)
Mnemonic: INV_INP
For example, setting INVERTED INPUTS to 4, inverts bit 3 (binary equivalent of
decimal 4). If the input is 1 1 1 0, after the inversion, it is 1 0 1 0. Similarly, a value
of 10 inverts bits 4 and 2 (binary equivalent of decimal 10). In this case, an input of
0 0 0 0 0 becomes 0 1 0 1 0.

216 3BUR002336R3701 RevA


Section 5 Input FCMS Digital Input FCM

VENDOR TYPE Field


This field specifies the type of I/O.
Valid entries are:
CONTROLLER Controller I/O (Direct I/O for a controller)
BURR/BROWN Multibus I/O
PLC I/O Serial interface to a PLC
PROFIBUS I/O Profibus I/O. This vendor type is only available for Advant
Controller 460 subsystems configured on the Windows platform
using the AdvaBuild Control Builder version 3.2 or higher
software.
REMOTE I/O Taylor Remote I/O (TRIO)
S100 I/O
S800 I/O This vendor type is only available for systems that use
Engineering Station version 2.5 or higher.
CUSTOM I/O Customized I/O
Default is: TRIO for either turbo nodes or controllers

LAN NUMBER Field


This field requires the number of the field bus the modules are connected to. This
number is determined by the connector to which the field bus is attached (either 1 or
2 for a controller). You can physically determine which bus the module is on by
checking to see if the bus has been labeled with its bus number. If it has not, you can
trace the bus number by checking to see which connector the cable is attached to at
the Field Bus Interface Module.
In a Turbo Node, you can have up to 6 field buses attached to a turbo node. You can
physically determine which bus the module is on by checking to see if the bus has
been labeled with its bus number. If the cable is not labeled, the field bus module for
that bus must be pulled out of the Multibus Card File. On this board, there is a
cluster of six jumper positions labeled W7 to W12. There should be a jumper in one
of these positions. If the jumper is in position W7 the module is on Field Bus 1. If

3BUR002336R3701 RevA 217


Digital Input FCM Section 5 Input FCMS

the jumper is in position W8, the module is on Field Bus 2. This progression
continues, that is, if the jumper is in position W12 the module is on Field Bus 6.

BLOCK NUMBER Field


This field specifies the number of the module containing the input or output
channel.
Valid entry is an integer in the range of 1 to 30.

CHANNEL NUMBER Field


For Digital Input and Output FCMs, this field specifies the first of up to 16
channels. These channels must be contiguous and on the same module. This field is
used to specify the location of the first input signal. The FCM reads the state of this
and up to 15 contiguous signals following it. See the description for the NUMBER
OF POINTS field.
Channels specified by the CHANNEL NUMBER and NUMBER OF POINTS
fields must be configured for digital input. In a Controller Subsystem, this is done
via the DIGITALS 1 through 40 fields of the Controller Templet. These fields are
described in Controller I/O Templet on page 78. In a Multibus I/O Subsystem, is
done via the TTL CARD # and 123456789 fields of the Multibus I/O Templet. See
Multibus I/O Templet on page 111.
Valid entry is the channel number where the first input is present.
Mnemonic: I_O_ADDR
An entry must be made in this field.

CHANNEL PATH
This field is only available when using the AdvaBuild Templet Builder to configure
the Digital Input FCM. An entry is required in this field if the entry in the VENDOR
TYPE field is either S800 I/O or PROFIBUS I/O.
For S800 I/O, this field is used to specify the LAN, station, cluster, position, and
channel of the I/O point in the following format:
LAN.station.cluster.position.channel

218 3BUR002336R3701 RevA


Section 5 Input FCMS Digital Input FCM

For example, an entry of 1.10.0.4.10 indicates that the S800 I/O point is on LAN 1,
station 10, cluster 0, position 4, channel 10.
For PROFIBUS I/O, this field is used to specify the LAN, device, module, and
channel of the I/O point in the following format:
LAN.device.module.channel
For example, an entry of 1.2.5.1 indicates that the Profibus I/O point is on LAN 1,
device 2, module 5, channel 1.

INITIAL MODE Field


This field determines the output mode for the FCM at startup.
Valid entries are:
AUTO FCM determines output values
MAN operator determines output values
Default is: AUTO
Mnemonic: INITMODE

INITIAL OUTPUT Field


This field determines the result (output value for the FCM) in effect upon startup of
the FCM.
Valid entry is a decimal number
Default is: 0.0
Mnemonic: INIT_OUT

3BUR002336R3701 RevA 219


Pulsed Input FCM Section 5 Input FCMS

Pulsed Input FCM


A pulse input is a count of the pulses accumulated since the device was last sampled
and the counter reset. The Pulsed Input FCM accepts inputs from pulse I/O drivers.
The FCM converts the input to engineering units and applies limits to the input
value. Further processing of pulse inputs is frequently performed by the Pulse Input
Time Derivative and the Totalizer FCMs. See Section 9, Calculator FCMS, for
details. Figure 41 shows the Pulsed Input FCM Templet.

Figure 41. Pulsed Input FCM Templet

220 3BUR002336R3701 RevA


Section 5 Input FCMS Pulsed Input FCM

INPUT TYPE Field


This field specifies whether the input is a pulse count or a pulse frequency. Pulse
frequency is only used in Multibus I/O Subsystems. If the FCM interacts with a
TRIO High Speed Counter Block, ABSOLUTE, STROBE1, and STROBE2 field
are also available. For further information see the Taylor™ Remote I/O (TRIO)
User's Guide.
Valid entries are:
COUNTS pulse count since the last scan of the loop

When measuring a rate (units/time) use the FREQUENCY input


type. This is particularly true when using the TRIO High Speed
Counter. If you use the COUNT input type to try to mimic the
FREQUENCY input by continuously resetting the COUNT via the
INIT_FLG, these continuous resets will overwhelm the database
updater because each reset/update will cause the presets and the
accumulators (COUNT) to be updated. This will cause the
AdvaBuild node to be unusable.

ABSOLUTE present value in the block's accumulator


FREQUENCY pulse frequency, counts represents no. of pulses per second
STROBE1 value in the strobe register of a Type A Counter or strobe register 1
of a Type B Counter
STROBE2 value in strobe register 2 of a Type B Counter
Default is: COUNTS

COUNTS - LOWER BOUND Field


This field specifies the raw counts lower limit corresponding to the engineering
units lower bound. The counts/engineering units conversion is described in
Configurable Features of the Analog Input FCM on page 208.
Valid entry is an integer between 0 and 32767.
Default is: 0

3BUR002336R3701 RevA 221


Pulsed Input FCM Section 5 Input FCMS

Mnemonic: LO_COUNT

COUNTS - UPPER BOUND Field


This field specifies the raw counts upper limit corresponding to the engineering
units upper bound. The counts/engineering units conversion is described in
Configurable Features of the Analog Input FCM on page 208.
Valid entry is an integer between 0 and 32767.
Default is: 100
Mnemonic: HI_COUNT

ENGU - LOWER BOUND Field


This field specifies the lower limit of the engineering units range.
Valid entry is a decimal number.
Default is: PROCESS LO (entry made in the LO ENG. UNIT LIMIT field of
the Loop Definition Templet that is the parent of this FCM templet)
Mnemonic: LO_CONV

ENGU - UPPER BOUND Field


This field specifies the upper limit of the engineering units range.
Valid entry is a decimal number.
Default is: PROCESS HI (entry made in the HI ENG. UNIT LIMIT field of the
Loop Definition Templet that is the parent of this FCM templet)
Mnemonic: HI_CONV

VENDOR TYPE Field


This field specifies the type of I/O.
Valid entries are:
CONTROLLER Controller I/O (Direct I/O for a controller)

222 3BUR002336R3701 RevA


Section 5 Input FCMS Pulsed Input FCM

BURR/BROWN Multibus I/O


PLC I/O Serial interface to a PLC
REMOTE I/O Taylor Remote I/O (TRIO)
CUSTOM I/O Customized I/O
Default value is: REMOTE I/O (TRIO) for either turbo nodes or controllers.

Since pulsed inputs do not support channel path I/O addressing,


they do not support S800 or Profibus I/O and the S800 I/O and
PROFIBUS I/O vendor types are not available.

LAN NUMBER Field


This field requires the number of the field bus the modules are connected to. This
number is determined by the connector on the field bus interface module the field
bus is connected to. To determine which bus the module is on check to see if the bus
is labeled with its bus number. If it is not, you can trace the bus number by checking
to see which connector the cable is attached to at the Field Bus Interface Module.
A Turbo Node can have up to 6 field buses attached to it. To determine which bus
the module is on check to see if the bus is labeled with its bus number. If the cable is
not labeled, the field bus module for that bus must be pulled out of the Multibus
Card File. On this board, there is a cluster of six jumper positions labeled W7 to
W12. There should be a jumper in one of these positions. If the jumper is in position
W7 the module is on Field Bus 1. If the jumper is in position W8, the module is on
Field Bus 2. This progression continues, that is, if the jumper is in position W12 the
module is on Field Bus 6.

BLOCK NUMBER Field


This field specifies the number of the module containing the input or output
channel.
Valid entry is an integer in the range of 1 to 100.

3BUR002336R3701 RevA 223


Pulsed Input FCM Section 5 Input FCMS

CHANNEL NUMBER Field


This field requires an entry. For Digital Input and Output FCMs, this field specifies
the first of up to 16 channels. These channels must be contiguous. If the channels
are for TRIO, they must also be on the same module. This field specifies the input
signal channel number. If the signal is from a TRIO High Speed Counter, this field
identifies the counter providing the count input.
Valid entry is the channel or counter number at which the input is present
The channel must be configured for pulse input. In a Controller Subsystem, use the
ICI 1 - 8 STATUS fields of the Controller Templet as described in Controller I/O
Templet on page 78. Channel numbering for pulse inputs of a Multibus I/O
Subsystem is described in Pulse Inputs in Multibus I/O Subsystems on page 144.
Refer to Section 11 of Taylor™ Remote I/O (TRIO) User's Guide for details on
counters and High Speed Counter Blocks for pulse input.
Mnemonic: I_O_ADDR

OUTPUT 1 or 2 ON/OFF PRESET Fields


These fields specify the output presets. These fields are only used when the FCM
interacts with a TRIO High Speed Counter Block. See Sections 11.2.9 and 11.5.3 of
the Taylor™ Remote I/O (TRIO) User's Guide for more information about the output
presets.
Valid entries are integers within the count limits.
Default is: 0.0000

INITIAL MODE Field


This field determines the output mode for the FCM at startup.
Valid entries are:
AUTO FCM determines output values
MAN operator determines output values
Default is: AUTO
Mnemonic: INITMODE

224 3BUR002336R3701 RevA


Section 5 Input FCMS Pulse Input (PI) Time Derivative FCM

INITIAL OUTPUT Field


This field determines the result (output value of the FCM) in effect upon startup of
the FCM.
Valid entry is a decimal number.
Default is: 0.0
Mnemonic: INIT_OUT

INPUT LIMITED Field


This field specifies whether the input signal is limited when it attempts to exceed the
high or low bounds. The technique of input limiting is described in Configurable
Features of the Analog Input FCM on page 208.
Valid entries are:
YES limit the input
NO do not limit the input
Default is: YES
Mnemonic: RANGE_CK

Pulse Input (PI) Time Derivative FCM


The Pulse Input (PI) Time Derivative FCM performs first order time differentiation
on inputs from a Pulsed Input FCM. Figure 42 shows the fields of the PI Time
Derivative FCM Templet.

3BUR002336R3701 RevA 225


Pulse Input (PI) Time Derivative FCM Section 5 Input FCMS

Figure 42. Pulsed Input (PI) Time Derivative FCM Templet

K  inp-
The equation for the algorithm is: Result = -----------------
t2 – t1
where
K is a scaling constant whose value is configurable
inp is the present input value, usually result of Pulsed Input FCM
t2 - t1 is the time between consecutive FCM scans. t2 is the time of the
present execution and t1 the time of the previous execution

If the Pulsed Input FCM is in Manual, the output of the PI Time


Derivative FCM is set to 0. This is because the time cannot be
determined.

This FCM converts a pulse input value into a number of pulses per second. For
example, a PI Time Derivative FCM is configured to execute every 4 seconds with a
scaling constant of 1. When the input is 1000 pulses, the equation becomes
1  1000
Result = --------------------- = 250 pulses/second
4

226 3BUR002336R3701 RevA


Section 5 Input FCMS Pulse Input (PI) Time Derivative FCM

INPUT SOURCE Field


This field specifies the Pulsed Input FCM that is the source of the input.
Valid entries are:
PREVIOUS FCM result of the previous FCM in the loop is the input
.fcmname result of another FCM in the loop is the input
tag.fcmname result of an FCM from another loop is the input
Default is: PREVIOUS FCM
Mnemonic: INPUT_1

CONSTANT Field
This field specifies the scaling constant. You can choose this constant to express the
result in pulses per minute or hour, and so on.
Valid entry is a decimal number.
Default is: 1.0000

INITIAL MODE Field


This field determines the output mode for the FCM at startup.
Valid entries are:
AUTO FCM determines output values
MAN operator determines output values
Default is: AUTO
Mnemonic: INITMODE

INITIAL OUTPUT Field


This field determines the result (output value of FCM) in effect upon startup of the
FCM.
Valid entry is a decimal number.

3BUR002336R3701 RevA 227


Pulse Input (PI) Time Derivative FCM Section 5 Input FCMS

Default is: 0.0


Mnemonic: INIT_OUT

BAD INPUTS ACCEPTED? Field


Specifies whether an input with a BAD data quality is treated as if the data quality
were GOOD.
Valid entries are: NO, YES
Default is: NO
Mnemonic: WORST_DQ

228 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs

General Information
The Auto/Manual Controller FCM is used to set up a ratio/bias station or a manual
loader. It accepts an input from another FCM and modifies the input with ratio and
bias values. When the Auto/Manual Controller FCM is in the Auto Output Mode,
the modified input becomes the FCM output (result). When it is in the Manual
Output Mode, the output is a value entered by the operator at the Operator Station or
Multibus-based console. When it is in the Track Output Mode, the output tracks the
value of another signal. A block diagram of the Auto/Manual Controller is provided
in Figure 43. A detailed functional block diagram of the FCM is provided in
Figure 44. Auto/Manual Controller FCM parameters are provided in the Data Base
Tables manual.

Manual Output Track Source

Manual Track
Result
Input X  Auto Auto/Manual

Ratio

Bias

Figure 43. Simplified Block Diagram of the Auto/Manual Controller

3BUR002336R3701 RevA 229


Configurable Features Of The Auto/Manual Controller FCM Section 6 Auto/Manual Controller

Configurable Features Of The Auto/Manual Controller


FCM
Processing Rate
The processing rate of the Auto/Manual Controller FCM is determined by the
PROCESSING RATE field, Figure 46. If you use the default (1), the FCM is
processed each time the loop is processed. If the field is changed to 2, the FCM is
processed every second time that the loop is processed. If 3 is entered, the FCM is
processed every third time, and so on.

Ratio and Bias


Several aspects of the ratio and bias are configurable. See Figure 44.
Signal Source You can specify variables outside the FCM as the sources of the
ratio and bias via the REMOTE RATIO SOURCE and
REMOTE BIAS SOURCE fields. The local ratio and local bias
are entries made by you from the Operator Station or Multibus-
based console.
Allowed modes Combinations of remote and local ratio and bias modes used are
specified via the BIAS MODES ALLOWED and RATIO
MODES ALLOWED fields.
Initialization The start-up modes for ratio and bias are specified via the
RATIO MODE and BIAS MODE fields. For the Local Mode,
the initial signal values are specified by the LOCAL BIAS and
LOCAL RATIO fields.
Limits Maximum and minimum limits for signals are specified via the
RATIO HIGH LIMIT, RATIO LOW LIMIT, BIAS HIGH
LIMIT, and BIAS LOW LIMIT fields. The modes using the
limits are specified via the LIMITED RATIO MODES and
LIMITED BIAS MODES fields.

230 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Output

Output
Several aspects of the output are configurable. See Figure 44.
Signal Source You can specify any one of the following as the output source:
Auto FCM determines output value
Manual Output value is entered by operator at the Operator
Station or Multibus-based console
Track Output value is set equal to a specified signal
Allowed modes The combinations of Auto, Manual, and Track used are specified
in the OUTPUT MODES ALLOWED field.
Initialization The start-up mode is specified via the INITIAL MODE field.
For Manual Mode, the initial signal value is specified by the
INITIAL OUTPUT field.
Limits Limits for the output are specified by the OUTPUT HIGH
LIMIT, OUTPUT LOW LIMIT, and OUTPUT RATE LIMIT
fields. The modes using the limits are specified via the
LIMITED OUTPUT MODES field.

Output Alarms
You can configure high, low, rate of change, and data quality alarms for the output
of the Auto/Manual Controller FCM. The high, low, and rate of change alarms are
extensions of the output limiting features. For example, the three fields that specify
the output high limit and output high alarm are:
OUTPUT HIGH LIMIT specifies the maximum output value. This is used
where limiting is allowed by the LIMITED
OUTPUT MODES field.
OUTPUT HIGH ALARMS? specifies whether an alarm is generated when the
output is limited at the output high limit value. The
default is YES.
OUTPUT HIGH PRIORITY specifies the priority for the output high alarm. The
default for this field is STD (standard priority 2).

3BUR002336R3701 RevA 231


Output Alarms Section 6 Auto/Manual Controller FCMs

The output low alarm and output rate of change alarm are configured using fields
similar to those described for the output high alarm.
The data quality alarm is configured via the BAD OUTPUT ALARMS? field. If
you use the default (YES) an alarm is generated when the data quality of the output
is BAD. The BAD OUTPUT PRIORITY field is used to specify the priority for this
type of alarm.

232 3BUR002336R3701 RevA


Section 6

Auto/Manual Result of Track Input


Controller an FCM

Limit Limit Output


Output Rate of Change
Yes Yes
TRACK Limit Limit
Manual

3BUR002336R3701 RevA
Output A/M Result
+ No No (output)
Result of

M
Input Source X
an FCM Track Activate
± =
State

FCM
Track Activator
Attribute
ON

Manual
L-R
Balance OFF
Auto/Manual Controller FCMs

ON
AUTO AUTO
Operator Set RATIO BIAS Output
Local Ratio Modes
Value Auto
Source L/R Allowed
Limit
Ratio Balance OFF
Yes OFF ON
Limit
LOCAL
NONE Track
REMOTE
No OFF

Result of Remote Ratio


an FCM Source

Operator Set Local Bias


Value Source
Limit
Bias
Yes
LOCAL Limit
NONE
REMOTE
No

Result of Remote Bias


an FCM Source

Figure 44. Functional Block Diagram of the Auto/Manual Controller

233
Output Alarms
Bumpless Mode Transfers and Tracking for Auto/Manual Controllers Section 6 Auto/Manual

Bumpless Mode Transfers and Tracking for Auto/Manual Controllers


Switching from Auto to Manual Mode during runtime requires one step and is
bumpless because the Manual output value automatically tracks the Auto output
value when the FCM is in the Auto Mode.
To switch from Manual to Auto bumplessly, use either one of the following
techniques:
• Ratio or Bias Balancing: The BALANCE MODE field used to specify the ratio
and/or the bias is automatically adjusted by the system so the Auto output value
of the controller is equal to the Manual output value.

You should consider the configured limits for ratio and bias when
ratio or bias balancing is used for bumpless transfers. The system
cannot set the ratio or bias beyond the configured limits. Thus,
under certain conditions a bump may occur.

• Output Tracking: You can configure the output of the FCM that supplies the
input for the Auto/Manual Controller FCM to track the TRAK_VAR parameter
of the Auto/Manual Controller FCM. See Figure 45 and the descriptions that
follows.

FIC-101.PID HC-102.AM

Input Ratio Auto


Output and
Bias
TRK_FLAG Manual

TRAK_VAR Remove
Bias &
Ratio

Figure 45. Bumpless Mode Transfers in Auto/Manual Controllers (Output Tracking)

In Figure 45, HC-102.AM is an Auto/Manual Controller. It receives input from PID


Controller FIC-101.PID. When HC-102.AM is not in the Auto Mode, its

234 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Bumpless Mode Transfers and Tracking for Auto/Manual

TRK_FLAG variable is TRUE. This causes FIC- 101.PID to track the TRAK_VAR
of HC-102.AM. If the TRAK_VAR variable is applied to the input of HC-102.AM,
it produces an Auto output value which is the same as the current Manual output
value. The TRAK_VAR, as Figure 45 shows, is the Manual output value adjusted to
compensate for the ratio and bias applied by HC-102.AM. The following equation is
used to do so:

O – B-
TRAK_VAR = -------------
R
where
O is the current Manual Output Value
B is the bias applied by HC-102.AM
R is the ratio applied by HC-102.AM
This equation is used to calculate a value for the TRAK_VAR only when the
controller is not in the Auto Mode. The TRAK_VAR is tracked only when tracking
is initiated by the TRK_FLAG variable. If tracking is initiated by a variable other
than TRK_FLAG, you must ensure a suitable variable is provided for the upstream
controller to track.
Controller FIC-101.PID is configured to track the output of HC-102.AM via five
fields on the templets for all controller FCMs, both Auto/Manual and PID.
The variable being tracked is specified by the following two fields.
TRACK INPUT SOURCE (source) field - specifies the FCM whose variable is
tracked. In the example, Figure 45, the entry is HC102.AM.
TRACK INPUT ATTRIBUT field- specifies the parameter of the Track Input
Source FCM is being tracked. In the example, Figure 45, the entry is
TRAK_VAR.
The variable that specifies when to track is indicated by the following three fields.
TRACK ACTIVATOR SRC (source) field - specifies the FCM with a
parameter commanding the PID Controller FCM to track. In the example,
Figure 45, the entry is HC102.AM.

3BUR002336R3701 RevA 235


COMP MODE Restrictions Section 6 Auto/Manual Controller FCMs

TRACK ACTIVATOR ATTR (attribute) field - specifies the parameter of the


Track Activator Source FCM commanding the controller to track. In the
example, Figure 45, the entry is TRK_FLAG.
TRACK ACTIVATE STATE field - specifies the state of the Track Activator
Attribute which causes tracking. In the example, Figure 45, the entry is TRUE.

When using tracking for bumpless transfer, consider the effects of


output limiting in the tracking controller. If the output of the
tracking controller is limited in the Track Output Mode, it may not
be large enough to prevent a bump.

COMP MODE Restrictions


You can use the COMP MODE (computer mode) feature of continuous loops when
the loop contains an Auto/Manual Controller FCM. Details of this feature are in
provided in Alarm Handling: Configuration, Detection, Posting, and Cutout on page
164. The COMP MODE feature is affected by the following fields of the
Auto/Manual Controller FCM Templet:
• LINK TIME-OUT specifies the time interval for a watchdog timer determining
whether a supervisory program can continue to control the loop
• OUTPUT MODE ON FAIL specifies the output mode the FCM assumes when
the link fails
• CHANGE OUTPT ON FAIL determines whether a new output value is used
• OUTPUT VALUE ON FAIL the output value used if the entry in the CHANGE
OUTPT ON FAIL field is YES

Auto/Manual Controller FCM Templet


This section describes the Auto/Manual Controller FCM Templet. A functional
block diagram of the Auto/Manual algorithm is shown in Figure 44. Figure 46
shows the upper portion, and Figure 47 shows the lower portion of the Auto/Manual
Controller FCM Templet. These figures show most of the configurable fields with
their default values.

236 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Auto/Manual Controller FCM Templet, Upper Portion

Auto/Manual Controller FCM Templet, Upper Portion


Descriptions of the fields in the upper portion of the Auto/Manual Controller FCM
Templet, Figure 46, follow.

Figure 46. Auto/Manual Controller FCM Templet, Upper Portion

3BUR002336R3701 RevA 237


Auto/Manual Controller FCM Templet, Upper Portion Section 6 Auto/Manual Controller FCMs

INPUT SOURCE Field


This field specifies the origin of the process input variable.
Valid entries are:
PREVIOUS FCM previous FCM in the loop is the input
.fcmname result of another FCM in the loop is the input
tag.fcmname result of an FCM from another loop is the input
Default is: PREVIOUS FCM

PROCESSING RATE Field


This field specifies the multiple of the loop processing rate that the algorithm is
executed at.
Valid entry is an integer multiple of loop processing rate specified on Loop
Definition Templet. For example, if the value of this field is 3 and the loop
processing rate is 4 seconds, the controller algorithm is processed every 12 seconds.
Default is: 1
Mnemonic: CTL_RATE

ACTION ON BAD INPUT Field


If the controller input signal goes to BAD data quality, this field specifies the action
to take.
Valid entries are:
FCM OFF controller FCM is turned off
MAN OUT controller FCM goes to the Manual output mode
NONE FCM continues processing according to its configuration
Default is: NONE
Mnemonic: BAD_INP

238 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Auto/Manual Controller FCM Templet, Upper Portion

OUTPUT MODES ALLOWED Field


This field specifies the output modes allowed.
Valid entries are: MAN, AUTO, AUTO/MAN, MAN/TRK, AUTO/MAN/TRK
where
MAN (Manual) you enter the output variable from the the Operator
Station or Multibus-based console
AUTO (Auto) FCM calculates the output variable automatically
TRK (Track) output variable tracks a specified signal
Default is: AUTO/MAN
Mnemonic: OU_MD_AL

TRACK ACTIVATOR SRC Field


This field specifies the FCM that activates tracking in the Auto/Manual Controller
FCM. The FCM attribute that activates tracking is specified by the TRACK
ACTIVATOR ATTR field. Bumpless Mode Transfers and Tracking for
Auto/Manual Controllers on page 234, describes output tracking for Auto/Manual
Controllers. Section 7, PID Controller FCMS, shows how output and setpoint
tracking is used for PID Controllers.
Valid entries are:
.fcmname FCM in this loop is the source
tag.fcmname FCM from another loop is the source
Default is: No Track Activator Signal

TRACK ACTIVATOR ATTR Field


This field specifies the parameter that activates tracking in the Auto/Manual
Controller. The parameter must be in the FCM specified by the TRACK
ACTIVATOR SRC field. The TRACK ACTIVATE STATE field determines the
condition (TRUE or FALSE) that activates tracking.
Valid entry is mnemonic for a parameter in the FCM named in the TRACK
ACTIVATOR SRC field.

3BUR002336R3701 RevA 239


Auto/Manual Controller FCM Templet, Upper Portion Section 6 Auto/Manual Controller FCMs

Default is: TRK_FLAG (mnemonic for Track Flag)

Both PID and Auto/Manual Controller FCMs have TRK_FLAG


variables. In an Auto/Manual Controller FCM, the TRK_FLAG is
TRUE when the FCM is not in the Auto Mode. In a PID Controller
FCM, the TRK_FLAG is TRUE when the FCM is not using the
remote setpoint.

TRACK INPUT SOURCE Field


The controller FCM tracks a signal from another FCM. The specific signal in the
FCM to be tracked is specified by the TRACK INPUT ATTRIBUT field.
Bumpless Mode Transfers and Tracking for Auto/Manual Controllers on page 234,
shows how output tracking is used for Auto/Manual Controllers. Section 7, PID
Controller FCMS, shows how output and setpoint tracking is used for PID
Controllers.
Valid entries are:
.fcmname FCM in the loop is the input source
tag.fcmname FCM from another loop is the input source
Default is: No Track Input Signal

TRACK INPUT ATTRIBUT Field


This field specifies the parameter in the FCM specified in the TRACK INPUT
SOURCE field is the source. See the description of the TRACK INPUT SOURCE
field.
Valid entry is mnemonic for a parameter from the FCM named in the TRACK
INPUT SOURCE field.
Default is: TRAK_VAR

240 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Auto/Manual Controller FCM Templet, Upper Portion

The TRAK_VAR of an Auto/Manual Controller FCM (Bumpless


Mode Transfers and Tracking for Auto/Manual Controllers on page
234) and TRAK_VAR of a PID Controller FCM (Section 7, PID
Controller FCMS) are adjusted values.

TRACK ACTIVATE STATE Field


This field specifies the state the track activator must be in for tracking to occur. See
the description of the TRACK ACTIVATOR ATTR field.
Valid entries are: TRUE, FALSE
Default is: TRUE
Mnemonic: TRK_STAT

BAD INPUTS ACCEPTED? Field


Specifies whether an input with BAD data quality is treated as if the data quality
were GOOD.
Valid entries are: NO, YES
Default is: NO
Mnemonic: WORST_DQ

INITIAL MODE Field


This field specifies the output mode at startup time.
Valid entries are:
MAN start in the Manual Mode
AUTO start in the Auto Mode
Default is: AUTO
Mnemonic: INITMODE

3BUR002336R3701 RevA 241


Auto/Manual Controller FCM Templet, Upper Portion Section 6 Auto/Manual Controller FCMs

INITIAL OUTPUT Field


This field specifies the value of the output at startup time.
Valid entry is a value in percent.
Default is: 0.0
Mnemonic: INIT_OUT

REMOTE RATIO SOURCE Field


This field specifies the source of the remote ratio.
Valid entries are:
.fcmname result of another FCM in the loop is the source
tag.fcmname result of a FCM from another loop is the source
Default is: No Remote Ratio

REMOTE BIAS SOURCE Field


This field specifies the source of the remote bias.
Valid entries are:
.fcmname result of another FCM in the loop is the source
tag.fcmname result of a FCM from another loop is the source
Default is: No Remote Bias

OUTPUT RETURN MODE Field


This field specifies the output mode entered when the FCM stops tracking.
Valid entries are:
PREVIOUS go to the mode active before the output began tracking
MANUAL go to the Manual mode
AUTO go to the Auto mode
Default is: PREVIOUS

242 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Auto/Manual Controller FCM Templet, Upper Portion

Mnemonic: TRKORET

LINK TIME-OUT Field


This field specifies the time interval for a watchdog timer which determines whether
a supervisory program can continue to control the loop. See Alarm Handling:
Configuration, Detection, Posting, and Cutout on page 164, and COMP MODE
Restrictions on page 236, for information on this subject.
Valid entry is a number of seconds.
Default is: 60
Mnemonic: WD_TIME

OUTPUT MODE ON FAIL Field


This field specifies the output mode entered upon a remote link failure. See Alarm
Handling: Configuration, Detection, Posting, and Cutout on page 164, and COMP
MODE Restrictions on page 236 for information on how remote link failure
conditions can occur.
Valid entries are:
PREVIOUS go to the mode that was active before the remote link failure
MANUAL go to the Manual mode
AUTO go to the Auto mode
NO CHANGE remain in the present mode
Default is: PREVIOUS
Mnemonic: OUMDFAIL

CHANGE OUTPT ON FAIL Field


This field specifies if a new output value should be supplied upon a remote link
failure. See Alarm Handling: Configuration, Detection, Posting, and Cutout on page
164, and COMP MODE Restrictions on page 236, for information on how remote
link failure conditions can occur.

3BUR002336R3701 RevA 243


Auto/Manual Controller FCM Templet, Upper Portion Section 6 Auto/Manual Controller FCMs

Valid entries are:


NO do not change the output value
YES change the output value
Default is: NO
Mnemonic: OUVAFAIL

OUTPUT VALUE ON FAIL Field


This field specifies the output value in effect upon a remote link failure if the entry
in the CHANGE OUTPT ON FAIL field is YES. See Alarm Handling:
Configuration, Detection, Posting, and Cutout on page 164, and COMP MODE
Restrictions on page 236, for information on how remote link failure conditions can
occur.
Valid entry is a value in percent.
Default is: 0.0
Mnemonic: OUTRFAIL

BALANCE MODE Field


This field specifies the method for bumpless transfer from Manual to Auto during
runtime.
Transfer from the Auto to Manual is inherently bumpless as the Manual output
value automatically tracks the Auto output when the FCM is in Auto Mode.
Valid entries are:
OFF balancing feature is turned off
RATIO auto ratio; system automatically calculates ratio value for bumpless
transfers from Manual to Auto
BIAS auto bias; system automatically calculates bias value for bumpless
mode transfers from Manual to Auto
BOTH you can manipulate both bias and ratio
Default is: OFF

244 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Auto/Manual Controller FCM Templet, Upper Portion

Mnemonic: BALANCE
When using bias or ratio balancing for bumpless transfer, consider the effect of that
ratio or bias limits. The system cannot set the ratio or bias to values larger than the
configured limits, therefore, a bump can still possibly occur. Bumpless Mode
Transfers and Tracking for Auto/Manual Controllers on page 234 describes a
different method (output tracking) for bumpless mode transfers.

BIAS MODE Field


This field specifies which bias value the controller is presently using. The
configured entry is the initial bias mode. During runtime, this field changes each
time the mode is switched.
Valid entries are:
REM bias is from the remote bias source
LOC bias is from the local source (entered by operator at the Operator
Station or Multibus-based console)
OFF FCM does not use a bias signal
Default is: OFF
Mnemonic: B_MODE

LOCAL BIAS Field


This field specifies the local bias value for the FCM. The configured entry is the
initial local bias. During runtime, you can change the local bias value at the
Operator Station or Multibus-based console.
Valid entry is a decimal number in engineering units.
Default is: 0.0

BIAS MODES ALLOWED Field


This field specifies the bias modes allowed for the FCM.
Valid entries are:
LOC local bias mode is allowed

3BUR002336R3701 RevA 245


Auto/Manual Controller FCM Templet, Upper Portion Section 6 Auto/Manual Controller FCMs

REM remote bias mode is allowed


LOC/REM both local and remote bias modes are allowed
OFF no bias is used
Default is: OFF
Mnemonic: B_MDAL

LIMITED BIAS MODES Field


This field specifies the bias modes to which the bias limits are applied.
Valid entries are:
LOC limits apply to the local bias
REM limits apply to the remote bias
LOC/REM limits apply to both local and remote bias
NONE no limited bias modes
Default is: LOC/REM
Mnemonic: B_LMAL

BIAS HIGH LIMIT Field


This field specifies the high limit for the bias values. This limit only applies to the
bias modes specified in the LIMITED BIAS MODES field.
Valid entry is a decimal value.
Default is: 0.1
Mnemonic: B_HILI

BIAS LOW LIMIT Field


This field specifies the low limit for the bias values. This limit only applies to the
bias modes specified in the LIMITED BIAS MODES field.
Valid entry is a decimal value.

246 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Auto/Manual Controller FCM Templet, Upper Portion

Default is: 0.0


Mnemonic: B_LOLI

RATIO MODE Field


This field specifies which of the possible ratio values the FCM is presently using.
The entry made at configuration time is the initial mode for the ratio. During
runtime, the contents of this field change each time the mode is switched at the
Operator Station or Multibus-based console.
Valid entries are:
REMOTE ratio is from the remote ratio source
LOCAL ratio is from the local source (entered by operator at the Operator
Station or Multibus-based console)
OFF FCM does not use a ratio signal
Default is: OFF
Mnemonic: R_MODE

LOCAL RATIO Field


This field specifies the local ratio value for the FCM. The configured entry is the
initial local ratio. During runtime, you can change the local ratio value at the
Operator Station or Multibus-based console.
Valid entry is a decimal value.
Default is: 1.0

RATIO MODES ALLOWED Field


This field indicates whether ratio modes are allowed.
Valid entries are:
OFF
LOC
REM

3BUR002336R3701 RevA 247


Auto/Manual Controller FCM Templet, Upper Portion Section 6 Auto/Manual Controller FCMs

LOC/REM
Default is: OFF

LIMITED RATIO MODES Field


This field specifies the ratio modes to which the ratio limits are applied.
Valid entries are:
LOC limits apply to the local ratio
REM limits apply to the remote ratio
LOC/REM limits apply to both modes
NONE do not use limits
Default is: LOC/REM
Mnemonic: R_LMAL

RATIO HIGH LIMIT Field


This field specifies the high limit for the ratio values. This limit only applies to the
ratio modes specified in the LIMITED RATIO MODES field.
Valid entry is a decimal value.
Default is: 1.1
Mnemonic: R_HILI

RATIO LOW LIMIT Field


This field specifies the low limit for the ratio values. This limit only applies to the
ratio modes specified in the LIMITED RATIO MODES field.
Valid entry is a decimal value.
Default is: 1.0
Mnemonic: R_LOLI

248 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Auto/Manual Controller FCM Templet, Lower Portion

Auto/Manual Controller FCM Templet, Lower Portion


The lower portion of the Auto/Manual Controller FCM Templet, Figure 47, is used
to define the limits and alarms for the output signal as described below.

Figure 47. Auto/Manual Controller FCM Templet, Lower Portion

LIMITED OUTPUT MODES Field


This field specifies whether the output limits are applied to the manual output, auto
output, and track output signals.

3BUR002336R3701 RevA 249


Auto/Manual Controller FCM Templet, Lower Portion Section 6 Auto/Manual Controller FCMs

Valid entries are: NONE, MAN, AUTO, AUTO/MAN, TRK, MAN/TRK,


AUTO/TRK, ALL
Default is: ALL
Mnemonic: OU_LM_AL

OUTPUT HIGH LIMIT Field


This field specifies the output signal high limit. It can be used when the FCM is in
the modes specified by the LIMITED OUTPUT MODES field. It is also the alarm
limit if an output high alarm is configured.
Valid entry is a decimal number between -14.0 and 114.0%.
Default is: 114.0
Mnemonic: OUT_HILI

OUTPUT LOW LIMIT Field


This field specifies the output signal low limit. It is used to limit the output when the
FCM is in the modes specified by the LIMITED OUTPUT MODES field. It is also
the alarm limit if an output low alarm is configured.
Valid entry is a decimal number between -14.0 and 114.0%.
Default is: -14.0
Mnemonic: OUT_LOLI

OUTPUT ALARM DB Field


The OUTPUT ALARM DB field defines a deadband for the output alarm. Alarm
deadbands work in the manner described in the paragraph of Alarm Handling:
Configuration, Detection, Posting, and Cutout on page 164, labeled Configuring an
Alarm.
Valid entry is a floating point number.
Default: CCF_ALARM_DB (value in the ALARM DEADBAND field on the CCF
Templet)
Mnemonic: OUT_DEBD

250 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Auto/Manual Controller FCM Templet, Lower Portion

OUTPUT RATE LIMIT Field


This field specifies the largest allowed rate of change of the output signal for two
consecutive loop executions. It is used when the FCM is in the mode specified by
the LIMITED OUTPUT MODES field (except for MAN, OUTPUT RATE LIMIT
is not applicable for manual mode). It is also the alarm limit if an output rate of
change alarm is configured.
Valid entry is a decimal number between 0.0 and 128.0%.
Default is: 0.0 (no output rate limit is applied)
Mnemonic: RATE_LIM

OUTPUT HIGH ALARMS? Field


This field specifies whether the high alarm on the output signal is enabled. If the
entry in this field is YES, an alarm occurs when the output is equal to or greater than
the value entered in the OUTPUT HIGH LIMIT field. The alarm clears when the
output is less than the high limit minus the alarm deadband. The alarm deadband is
specified via the CCF Templet.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

OUTPUT LOW ALARMS? Field


This field specifies whether the low alarm on the output signal is enabled. If the
entry in this field is YES, an alarm occurs when the output is equal to or less than
the value entered on the OUTPUT LOW LIMIT field. The alarm clears when the
output is greater than the low limit plus the alarm deadband. The alarm deadband is
specified via the CCF Templet.
Valid entries are:
YES enable the alarm
NO disable the alarm

3BUR002336R3701 RevA 251


Auto/Manual Controller FCM Templet, Lower Portion Section 6 Auto/Manual Controller FCMs

Default is: YES

OUTPUT RATE ALARM? Field


This field specifies whether the rate alarm on the output signal is enabled. If the
entry in this field is YES, an alarm occurs when the rate of change of the output for
two consecutive loop executions is equal to or greater than the value entered in the
OUTPUT RATE LIMIT field.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: NO

BAD OUTPUT ALARMS? Field


This field specifies whether the bad data quality alarm on the output signal is
enabled. If the entry in this field is YES, an alarm occurs when the data quality of
the output is BAD.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

OUTPUT HIGH PRIORITY Field


This field specifies the priority level for the output high alarm.
Valid entries are:
STD standard priority (3)
MED medium priority (2)
HIGH high priority (1)
Default is: STD

252 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Auto/Manual Controller FCM Templet, Lower Portion

OUTPUT LOW PRIORITY Field


This field specifies the priority level for the output low alarm.
Valid entries are:
STD standard priority (3)
MED medium priority (2)
HIGH high priority (1)
Default is: STD

OUTPUT RATE PRIORITY Field


This field specifies the priority level for the output rate alarm.
Valid entries are:
STD standard priority (3)
MED medium priority (2)
HIGH high priority (1)
Default is: STD

BAD OUTPUT PRIORITY Field


This field specifies the priority level for the output bad data quality alarm.
Valid entries are:
STD standard priority (3)
MED medium priority (2)
HIGH high priority (1)
Default is: STD

3BUR002336R3701 RevA 253


Non-configurable Parameters Of The Auto/Manual Controller FCM Section 6 Auto/Manual

DESIGN OUTPUT MODE Field


This field specifies the normal state for the output of this FCM. This is one of the
items checked if the ABNORMAL STATE field of the Loop Definition Templet
specifies the loop be checked for an abnormal condition.
Valid entries are
NONE no normal state defined
AUTO Auto is normal state
MANUAL Manual is normal state
TRACK Track is normal state
Default: none
Mnemonic: INDEX_1

Non-configurable Parameters Of The Auto/Manual


Controller FCM
These parameters are used by algorithms, but are not configurable.

B_DQ - Bias Value Data Quality Parameter


This parameter gives the data quality of the bias value the FCM is currently using.
States for the parameter are: GOOD, BAD

FULL_OUT - Unlimited Output Value Parameter


This parameter gives the value the output would have if no limits are applied. A
closely related parameter is OUT_COND which tells whether the output value the
FCM is currently using is a limited value.

OUT_COND - Output Limit Indicator Parameter


This parameter tells whether or not the output value is currently being limited. A
related parameter is FULL_OUT which gives the value the output if it were not
being limited.

254 3BUR002336R3701 RevA


Section 6 Auto/Manual Controller FCMs Non-configurable Parameters Of The Auto/Manual

States for the parameter are: NOT LIMITED, LIMITED

R_DQ - Ratio Data Quality Parameter


This parameter gives the data quality of the ratio value the FCM is currently using.
Possible states for the parameter are: GOOD, BAD

REM_CRTL - Remote Control Indicator Parameter


This parameter is set to SUPERVISORY when a supervisory package controls the
loop. COMP MODE Restrictions on page 236, provides further information about
this parameter.
Possible states for the parameter are: NORMAL, SUPERVISORY

RESULT - Result of FCM Parameter


This parameter is the result of the FCM calculations. For the Auto/Manual
Controller, it is the same as the output.

RET_OUMD - Output Mode on Return from Supervisory Parameter


This parameter specifies the mode entered when a supervisory package releases
control of the loop. The parameter is set to PREVIOUS when the supervisory
package first takes control. However, the package may change the value of the
parameter.
Possible states for the parameter are:
PREVIOUS go to the mode that was in effect previously
AUTO go to the Auto mode
MAN go to the Manual mode

TRAK_DQ - Track Variable of Data Quality Parameter


This parameter gives the data quality of the TRAK_VAR.
Possible states for the parameter are: GOOD, BAD

3BUR002336R3701 RevA 255


Non-configurable Parameters Of The Auto/Manual Controller FCM Section 6 Auto/Manual

TRK_FLAG - Track Flag Parameter


This parameter is TRUE when the FCM mode is not Auto. In some configurations,
it is used to activate tracking in upstream controllers. See Bumpless Mode Transfers
and Tracking for Auto/Manual Controllers on page 234, for details.

TRAK_VAR - Track Variable Parameter


This parameter is a modified output value other controllers can track. See Bumpless
Mode Transfers and Tracking for Auto/Manual Controllers on page 234, for details.

WD_COUNT - Watchdog Timer


This parameter is the watchdog timer for the controller. When a supervisory
program takes control of the loop, the WD_COUNT parameter is initially set to
WD_TIME, the value specified via the LINK TIME-OUT field. The CCF software
decrements the value of WD_COUNT and periodically resets it to the value of
WD_TIME by the supervisory program. If the value of the WD_COUNT parameter
becomes 0, a remote link failure condition is declared.

256 3BUR002336R3701 RevA


Section 7 PID Controller FCMS

General Information
The PID Controller FCM applies a control algorithm to a continuous process
variable. The algorithm is a variation of a standard PID (proportional, integral,
derivative) control function. This FCM has features common to all FCMs, plus the
following features:
• All standard versions of the PID control algorithm.
• Adaptive gain and adaptive reset: You can modify the gain and/or reset as a
function of any combination of: process input, error, a remote input variable
(result of any FCM), output, and external contact.
• Feedforward and feedback.
• Dead time compensation input.
PID Controller FCM parameters are described in the Data Base Tables manual. The
paragraphs that follow describe the configurable features of the PID Controller
FCM.

Processing Rate
The PID Controller FCM processing rate is determined by the PROCESSING
RATE field on page1 of the PID Controller FCM Templet. If the default (1) is used,
the FCM is processed each time the loop is processed. If the field is changed to 2,
the FCM is processed every second time the loop is processed. If 3 is entered, the
FCM is processed every third time, and so on.

3BUR002336R3701 RevA 257


Setpoint Section 7 PID Controller FCMS

Setpoint
The following are configurable aspects of the setpoint, Figure 48.
Signal Source During runtime, you can specify one of these setpoint sources:
Remote setpoint value is the result of another FCM
Manual setpoint value is entered by the operator at the Operator Station or
Multibus-based console
Track setpoint value is set equal to a specified signal
Ramp setpoint is being ramped from one value to another
Allowed ModesA combination of setpoint modes is specified in the SETPT
MODES ALLOWED field on page 1 of the PID Controller FCM
Templet.
Initialization Initial setpoint mode is specified via the INITIAL SETPT MODE
field. Manual Mode initial value is specified by the INITIAL
SETPOINT field. These fields are on page 1 of the PID Controller
FCM Templet.
Limits Output limits are specified via the SETPOINT HIGH LIMIT and
SETPOINT LOW LIMIT fields. Modes using limits are specified
via the LIMITED SETPT MODES field. These fields are on the
fourth page of the PID Controller FCM Templet.
Bias and Ratio You can use bias and ratio to condition the remote setpoint. Bias
and ratio are described in Ratio and Bias for the Setpoint on page
258.

Ratio and Bias for the Setpoint


You can use ratio and bias to condition the setpoint. Several aspects of the ratio and
bias are configurable on page 3 of the PID Controller FCM Templet as listed below.
See Figure 50.
Signal Source Variables outside the FCM are specified as ratio and bias sources
via the REMOTE RATIO SOURCE and REMOTE BIAS
SOURCE fields. Local ratio and bias are defined by you at the
Operator Station or Multibus-based console.

258 3BUR002336R3701 RevA


Section 7 PID Controller FCMS Output

Allowed Modes Allowed combinations of remote and local ratio and bias modes
are specified via the BIAS MODES ALLOWED and RATIO
MODES ALLOWED fields.
Initialization Initial modes for ratio and bias are specified via the RATIO
MODE and BIAS MODE fields. For Local Mode, initial values
are specified by the LOCAL BIAS and LOCAL RATIO fields.
Limits Maximum and minimum limits for the signals are specified via
the RATIO HIGH LIMIT, RATIO LOW LIMIT, BIAS HIGH
LIMIT, and BIAS LOW LIMIT fields. The modes using the
limits are specified via the LIMITED RATIO MODES and
LIMITED BIAS MODES fields.

Output
Several aspects of the output are configurable as described below. See Figure 48.
Signal Source The output source can be specified as one of three sources:
Auto FCM determines output value
Manual output value is entered by you at the Operator Station or Multibus-
based console
Track output value is set equal to a specified signal
Allowed Modes Allowed output modes are specified in the OUTPUT MODES
ALLOWED field on page 1 of the PID Controller FCM
Templet.
Initialization Initial output mode is specified via the INITIAL MODE field.
Manual Mode initial value is specified by the INITIAL
OUTPUT field. These fields are on page 3 of the PID Controller
FCM Templet.
Limits Limits for the output are specified by the OUTPUT HIGH
LIMIT, OUTPUT LOW LIMIT, and OUTPUT RATE LIMIT
fields on page 3 of the PID Controller FCM Templet. Modes
using limits are specified via the LIMITED OUTPUT MODES
field on page 1 of the PID Controller FCM Templet.

3BUR002336R3701 RevA 259


Output Section 7 PID Controller FCMS

Action Output is specified as direct or reverse acting via the


CONTROLLER ACTION field on page 1 of the PID Controller
FCM Templet.

260 3BUR002336R3701 RevA


Section 7

Limit Tracked
Setpoint Setpoint
Yes ON To
Tracking Limit Setpoint
Result of Setpoint Enable Tracking Sheet 3
an FCM Tracking Source
No Setpoint
TRACK OFF
Limit Local Track
Setpoint Yes LOCAL Activator
Limit
Local Operator Local Setpoint
Set Value RAMP REMOTE
Source

3BUR002336R3701 RevA
No Limit Ramp
Yes Setpoint
Limit
Calculated
Value Ramp Setpoint
PID Controller FCMS

No Limit Remote
ON
Yes Setpoint
Limit Track
Result of Remote Setpoint +

M
an FCM X
Source ± OFF
Local Operator Local Ratio No ON
Set Value Source Setpoint
Modes Remote
ON Allowed
OFF
Remote
Yes ON
Ratio LOCAL Limit
OFF
Modes Ramp
ON Allowed
REMOTE
No OFF
Local Limit in
Present
OFF Mode
Yes
Limit
Result of Remote Ratio
an FCM Source
ON Local Remote
No
Balance

Result of Dead Time Com-


OFF an FCM pensation Source
Local Operator Local Bias Enable
Set Value Source
L-R
Balance Engineering –
M

ON Units Range Deviation


+
Remote Process Variable
LOCAL Result of Setpoint To
M

Bias Input Source PRE-ACT Sheet 2


OFF an FCM
Modes PRE-ACT ON PROCESS
ON ON ERROR Error
Allowed Signal
REMOTE OFF Controller OFF
Local Action
PRE-ACT PRE-ACT
DIRECT
OFF ON PROCESS ON ERROR
Pre-act Pre-act
Result of Remote Bias on Process on Error
Action
an FCM Source
Pre-act REVERSE

Figure 48. Functional Block Diagram of PID Controller (Sheet 1 of 3)


(Derivative)

261
Output
262
Output

Error Signal

OFF Adapt on Reset

Base Reset
ON
ON Adapted Adapt
Response on Gain
Base Gain
Adapt
on Gain
OFF

Deviation ENABLE
Adapted Adapt Adapt Output
From
Deviation Response on Reset
Sheet 1
Adapt on Gain Enable
OFF ENABLE

Process Variable ENABLE


Deviation
Adapt on Reset Enable
OFF
Process
Adapt on Gain Enable
OFF ENABLE
Process Variable

Result of ENABLE
Contact Source Process
an FCM
Adapt on Reset Enable
OFF
Contact
Adapt on Gain Enable
OFF ENABLE
Result of Contact Source
an FCM
Result of Remote ENABLE
an FCM Contact
Variable Source
Adapt on Reset Enable Error Signal
OFF Output
Remote Adapt on Reset Enable
Adapt on Gain Enable Base Reset
OFF ENABLE OFF
Result of Remote
an FCM Variable Source Adapted Reset

Adapted Gain To Sheet 3


Remote
Adapt on Reset Enable
OFF ENABLE Base Gain

OFF Process Variable

Output Last Output


Section 7

From Sheet 3
Output
Adapt on Gain Enable
ENABLE

Figure 49. Functional Block Diagram of PID Controller (Sheet 2 of 3)


PID Controller FCMS

3BUR002336R3701 RevA
Section 7

3BUR002336R3701 RevA
AUTO
From ≠
Sheet 1
Result of Ext Feedback
an FCM Source
PID Controller FCMS

OFF On Error TRACK


Yes Limit
ENABLED OFF Parameter DIR
STANDARD Track Input Limit
from an FCM
Error Track Output Result
OFF No A/M (Output)
ON Signal
On Error MICROSCAN REV
Squared ADD
Reset Limit
(Integral) Limit
MULTIPLY Limited Auto
INTEGRAL Yes
Output
Feedfoward Output

M
OFF
Fixed Control Feedback Type AUTO
Response No Track Activate
Configurable
Value State
Error Signal MANUAL
Yes =
RESET MANUAL
Manual Parameter
FF/FB Track Activator
Manual Reset from an FCM
Reset Limit
No Balancing
Feedforward Result of
Base Reset OFF an FCM
OFF Variable Source
Manual
Adapted
Proportional
Reset Adopt
Limit on Error PROPOR- Yes
From on Reset PROPOR- Limit
ON TIONAL ON Manual
Sheet 2 TIONAL ON Limit
ERROR PROCESS Output Manual Output
No
Reset
Adapted Balance
Gain ON
Limit
Proportional
Base Gain Adopt on Process
on Gain
Process Variable OFF

To Output
Sheet 2

Figure 50. Functional Block Diagram of PID Controller (Sheet 3 of 3)

263
Output
Process Variable Alarms Section 7 PID Controller FCMS

Process Variable Alarms

Output Alarms
High, low, rate of change, and data quality alarms for the output are configurable for
the PID Controller FCM on page 4 of its templet.
The high, low, and rate of change alarms are extensions of output limiting. For
example, the three fields that specify the output high limit and output high alarm
are:
• OUTPUT HIGH LIMIT - specifies the maximum output value. This value is
used as a limit in modes where limiting is allowed by the LIMITED OUTPUT
MODES field.
• OUTPUT HIGH ALARMS? - specifies whether an alarm is generated when
the output is limited at the output high limit value. The default for this field is
YES.
• OUTPUT HIGH PRIORITY - specifies the priority for the output high alarm.
The default for this field is STD (standard priority 2).
Output low alarm and output rate of change alarm are configured in a manner
similar to the output high alarm. The data quality alarm is configured via the BAD
OUTPUT ALARMS? field. If you use the default (YES) an alarm is generated
when the output data quality goes BAD. The BAD OUTPUT PRIORITY field is
used to specify the priority for this type of alarm.

Setpoint Alarms
High, low, and data quality alarms are configurable for the setpoint. They are
configured in the same manner previously described for the corresponding output
alarms.

Deviation Alarms
High and low alarms are defined for the deviation (process variable minus setpoint).
The alarms are configured in the same manner as the corresponding setpoint and
output alarms, but with one major difference. The limits defined for the deviation
are used as alarm limits only. The deviation value is never limited by the system.

264 3BUR002336R3701 RevA


Section 7 PID Controller FCMS Manual Reset

Manual Reset
Manual reset is configurable for controllers not using automatic reset. The manual
reset is an added control term you can enter in the system when the FCM is in the
Auto mode. A simplified equation for the PID algorithm using manual reset is: OP =
G(PV - SP) + MR
where
OP is the output
G is the gain
PV is the process variable
SP is the setpoint
MR is the manual reset
The proportional term of the PID algorithm must be proportional-on-error only if
manual reset is used. This is specified via the following fields on page 1 of the PID
Controller FCM Templet:
INTEGRAL TYPE field set to OFF
PROPORTIONAL ACTION field set to ON ERROR
The manual reset feature is specified via the following four fields:
MANUAL RESET MODE field specifies whether the manual reset feature is
enabled. There are three possibilities for this field.
OFF no manual reset
BALANCE the manual reset feature is enabled. You enter the manual reset
value when the controller is in the Auto mode. The system
automatically manipulates the manual reset to provide bumpless
transfer when the controller is switched to the Auto output
mode.
NO BALANCE the manual reset feature is enabled. You enter the manual reset
value when the controller is in the Auto mode. The system does
not use the manual reset feature to provide bumpless transfer to
the Auto output mode.

3BUR002336R3701 RevA 265


Bumpless Mode Transfers and Tracking for PID Controllers Section 7 PID Controller FCMS

MANUAL RESET VALUE field specifies the initial value of the manual reset.
You can change the value during runtime.
MAN RESET LOW LIMIT and MAN RESET HIGH LIMIT field specify the
minimum and maximum values the software allows for the manual reset value.
These limits pertain to both the operator entered values and the values the software
sets the manual reset to when the MANUAL RESET MODE field has BALANCE
as an entry.

Bumpless Mode Transfers and Tracking for PID Controllers


During runtime, switching from Auto to Manual output mode requires one step and
is bumpless. When the mode is switched to Manual, the output is maintained at the
value prior to switching. You can then manipulate the output value.
There are a number of methods for bumpless switching to Auto output mode or
Remote setpoint state. The application requirements determine which, if any, of the
techniques are suitable.

Some techniques require the system to automatically manipulate a


variable such as bias or reset. You can configure limits for these
variables. The system cannot set a variable to a value beyond the
configured limits for the variable, therefore, a process bump may
still occur when one of these features is used.

Reset Balancing: The system manipulates the reset term of the control algorithm to
provide bumpless transfer to the Auto output mode. This feature is automatically
present when the controller uses integral control action.
Manual Reset Balancing: Controllers configured for manual reset can use the
manual reset value for bumpless transfers to the Auto output mode. This is specified
by setting the MANUAL RESET MODE field to BALANCE. When the controller
is switched to Auto, the system automatically sets the manual reset to a value that
prevents a bump.
Ratio or Bias Balancing: You can use the BALANCE MODE field to specify that
ratio or bias or both ratio and bias are automatically adjusted by the system so the
setpoint value does not change upon switching to the Remote setpoint mode.

266 3BUR002336R3701 RevA


Section 7 PID Controller FCMS Bumpless Mode Transfers and Tracking for PID Controllers

Output and Setpoint Tracking: You can configure the output and setpoint of the
FCM which supplies the input for the PID Controller FCM to track the appropriate
variables to provide bumpless transfer. Figure 51 and its description provide an
example of this method.
Figure 51 shows a cascade connection between two PID controllers. The master
controller, LIC-10.PID, is a level indicating controller whose output becomes the
setpoint for the slave controller, FIC-10.PID. You can employ a combination of
output and setpoint tracking to prevent process bumps when the mode of the slave
controller is switched.

Master Controller Slave Controller


LIC-10.PID FIC-10.PID
Remote
Local Local
Setpoint Auto
Setpoint Output Sequence Ratio and Processing Output
Bias
Remote
Manual
TRK_FLAG
Track Actuator
Process
Variable TRAK_VAR Remove Bias
Track Value
and Ratio

Process
Tank

Process Variable

Figure 51. Bumpless Mode Transfers Using Setpoint and Output Tracking

When FIC-10.PID is not in the Auto output mode or the Remote setpoint state, its
TRK_FLAG variable is TRUE. This causes LIC-10.PID to track the TRAK_VAR
of FIC-10.PID. If TRAK_VAR is applied to the remote setpoint source of FIC-
10.PID, it produces a setpoint that matches the current active setpoint. The
TRAK_VAR, as Figure 51 shows, is the setpoint value adjusted to compensate for
the ratio and bias applied by FIC-10.PID.
Controller LIC-10.PID is configured to track the TRAK_VAR parameter of FIC-
10.PID via five fields on the first page of the templets for all controller FCMs, both
Auto/Manual and PID.

3BUR002336R3701 RevA 267


COMP MODE Restrictions Section 7 PID Controller FCMS

The variable tracked is specified by the following two fields:


TRACK INPUT SOURCE field - specifies the FCM containing the variable
you want to tracked. In the example, Figure 51, the entry is FIC-10.PID.
TRACK INPUT ATTRIBUT field - specifies the parameter of the Track Input
Source FCM you want to tracked. In the example, Figure 51, the entry is
TRAK_VAR.
The variable that activates tracking in the master controller is specified by the
following fields:
TRACK ACTIVATOR SRC field - specifies the FCM whose parameter
activates tracking in the PID Controller FCM. In the example, Figure 51, the
entry is FIC-10.PID.
TRACK ACTIVATOR ATTR field - specifies the actual parameter of the Track
Activator Source FCM that activates tracking. In the example, Figure 51, the
entry is TRK_FLAG.
TRACK ACTIVATE STATE field - specifies the state of the track activator
attribute that causes tracking. In the example, Figure 51, the entry is TRUE.
You can use setpoint tracking in the master controller, LIC-10.PID, to assign a
setpoint value to use before the value set by the algorithm. For example, to assign
the setpoint the value of the process variable, set the SETPT TRACKING SRC
(Setpoint Tracking Source) field of LIC-10.PID to the source of the process variable
of LIC-10.PID and specify track as an allowed setpoint mode. Setpoint tracking
occurs when the output of LIC.10.PID is not in Auto mode.

COMP MODE Restrictions


You can use COMP MODE (computer mode) in continuous loops when the loop
contains a PID Controller FCM. Details are provided in Alarm Handling:
Configuration, Detection, Posting, and Cutout on page 164. COMP MODE is
affected by the following fields on the second page of the PID Controller FCM
Templet:
• LINK TIME-OUT - specifies the time interval for a watchdog timer that
determines whether a supervisory program can continue to control the loop
• OUTPUT MODE ON FAIL - specifies the output mode of the FCM when the

268 3BUR002336R3701 RevA


Section 7 PID Controller FCMS Incremental PID Algorithm

link fails
• CHANGE OUTPT ON FAIL - determines whether a new output value is used
• OUTPUT VALUE ON FAIL - output value if CHANGE OUTPT ON FAIL
field is YES

Incremental PID Algorithm


To select the incremental PID algorithm, enter YES in the INCREMENTAL INC
TYPE field on the PID Controller Templet. The incremental PID algorithm drives a
control element with an incremental signal rather than a full value signal. The
incremental signal drives the control in a positive or negative direction by a fixed
amount (for example, open a valve by 10% or close a valve by 5%). The full valve
signal drives the control element toward an ultimate destination (for example, move
the valve to 75% open).
A typical application is a motor-driven valve driven by two pulse inputs. One input,
when actuated, drives the valve open by a fixed amount. The second drives the
valve closed. The incremental PID control loop for this application is shown and
described below.
AIN-- PID-- SFCM-1 -- PDO-up -- SFCM-2 -- ABS -- PDO-down
where
AIN is the analog input from the field (measured value)
PID is the PID controller algorithm
SFCM-1 & SFCM-2 are Select Next FCMs
PDO-up & PDO-down are pulse duration outputs
ABS is absolute value
PID is the input (pulse duration) source for both PDO-up and PDO-down. When the
result of PID is positive, PDO-up opens the valve by an amount determined by the
pulse duration. When the result of PID is negative, PDO-down closes the valve by
an amount determined by the pulse duration. When the result is zero, neither pulse
duration output is executed and the valve position does not change.

3BUR002336R3701 RevA 269


Incremental PID Algorithm Section 7 PID Controller FCMS

SFCM-1 is configured so an input greater than zero causes PDO-up to execute. An


input less than or equal to zero sets the SFCM-1 result true and causes loop
execution to skip to SFCM-2.
SFCM-2 executes after PDO-up if SFCM-1 selects PDO-up (that is, when the result
of PID is positive). SFCM-2 is executed rather than PDO-up if SFCM-1 selects
SFCM-2 (that is, when the result of PID is negative or zero). SFCM-2 is configured
so an input less than zero causes ABS and PDO-down to execute. When the input is
greater than or equal to zero, SFCM-2 sets its result true and causes loop execution
to skip to the logical END FCM and terminate execution of the loop.
The incremental PID algorithm uses a deadband expressed in engineering units.
This deadband is configured via the INC LOWER DEADBAND and INC UPPER
DEADBAND fields on the PID Controller Templet. When the deviation between
the process value and setpoint is within the deadband, the result of the PID
algorithm is zero and the output does not change. When the deviation crosses the
deadband in either direction, the result of the PID algorithm is either positive or
negative, and drives the control element accordingly.
The incremental PID algorithm also uses a critical value which is the smallest
output of the PID algorithm (absolute value) that causes the pulse duration output
(when applicable) to turn on. When the output of the PID algorithm is below the
critical value, the output has no effect on the control element. This output is stored
and used in the next calculation. In this way, PID algorithm accounts for ineffective
results (that is, results that do not cause the pulse duration outputs to turn on). The
critical value is configured by entering a value in the INC MINIMUM OUTPUT
field on the third page of the PID Controller FCM Templet. The following equation
is used to determine the appropriate critical value:
CV = 100 x DO_RATE
H
where
DO_RATE is the resolution in milliseconds for the pulse digital outputs as
specified on the Controller or Multibus I/O Templet
H is the 100% (HI_COUNT) value for the pulse digital outputs as
defined on the Pulse Duration Output Templet

270 3BUR002336R3701 RevA


Section 7 PID Controller FCMS The PID Controller FCM Configuration Templet Fields

If the critical value is configured as 0 (zero), the algorithm makes no adjustment for
ineffective results. To use the critical value adjust for ineffective results, the integral
response (reset) must be used. Any reset value including 0 (zero) is valid.

If the incremental PID loop must be configured so it is impossible


for both pulse digital outputs to be on at the same time, you can
limit the output of the incremental PID algorithm to plus or minus
the amount resulting in the pulse digital outputs being on for one
scan rate.

The limit is calculated as: LIMIT = (100 x scanrate in seconds)/ (HI_COUNT in


seconds)
For example, if the HI_COUNT for the pulse digital outputs is 15 seconds and the
scanrate is 5 seconds, then the output should be limited to ±33.3 (Limit=(100*5)/15
= 33.3)

The PID Controller FCM Configuration Templet Fields


A functional block diagram of the PID algorithm is shown in Figure 48. Most
configurable fields of the FCM are shown. Some fields are not shown because their
function is too complex or is the result of calculations. The fields are shown set to
their default entries.

PID Controller FCM Templet, Upper Portion


This section describes fields of the upper portion of the templet, Figure 52.

3BUR002336R3701 RevA 271


PID Controller FCM Templet, Upper Portion Section 7 PID Controller FCMS

Figure 52. PID Controller FCM Templet, Upper Portion

272 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Upper Portion

INPUT SOURCE Field


This field specifies the source of the process input variable.
Valid entries are:
PREVIOUS FCM result of the previous FCM in the loop is the input
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Default is: PREVIOUS FCM

PROCESSING RATE Field


The field indicates the multiple of the loop processing rate at which the controller
algorithm is executed.
Valid entry is an integer multiple of the loop processing rate specified on the Loop
Definition Templet. For example, if the value of this field is 3 and the loop
processing rate is 4 seconds, the controller algorithm is processed every 12 seconds.
Default is: 1
Mnemonic: CTL_RATE

BASE GAIN Field


This field specifies the gain (proportional response) in a fixed gain controller. If no
adaptive functions are turned on, the base gain is the active gain of the FCM, and the
FCM operates as a fixed gain controller. When an adaptive gain function is turned
on, all changes in active gain due to the algorithm for that function are based on the
base gain.
Valid entry is a decimal number.
Default is: 0.0
Mnemonic: BS_GAIN

3BUR002336R3701 RevA 273


PID Controller FCM Templet, Upper Portion Section 7 PID Controller FCMS

BASE RESET Field


This field specifies the base value for the reset. If no adaptive functions are turned
on, the base reset is the active reset of the FCM. When an adaptive function is
turned on, all changes in active reset due to the algorithm for that function are based
on the base reset.
Valid entry is a decimal number.
Default entry is: 0.0
Mnemonic: BS_RESET

PREACT TIME Field


This field specifies the Pre-act time value.
Valid entry is a value set between 0 and 32 minutes.
Default is: 0
Mnemonic: PREACTIM

PREACT MODE Field


This field specifies the type of Pre-act response.
Valid entries are:
OFF Pre-act response is turned off
ON PROCESS Pre-act response on the process input signal
ON ERROR Pre-act response on the error signal
Default is: OFF
Mnemonic: PREACT

PROPORTIONAL ACTION Field


This field specifies the type of proportional control action (gain) for the controller.
Valid entries are:
OFF proportional response is turned off

274 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Upper Portion

ON ERROR gain value is determined by error value


ON PROCESS gain value is determined by process input value
Default is: ON ERROR
Mnemonic: PROPTYPE

INTEGRAL TYPE Field


This field specifies the type of integral (reset) control action.
Valid entries are:
NONE reset response is turned off
STD reset response is turned on and is operating with the standard
algorithm. It is used with either adaptive gain or adaptive reset
and/or external feedback. Manual reset must be turned off.
MICROSCAN reset response is turned on and is operating with the microscan
algorithm. It is used with either adaptive gain or adaptive reset, but
not with external feedback. Manual reset must be turned off.
Default is: STD. The standard algorithm and microscan algorithm have
different anti-reset windup characteristics.
Mnemonic: INTGTYPE

OUTPUT MODES ALLOWED Field


This field specifies the output modes allowed.
Valid entries are: MAN, AUTO/MAN, MAN/TRK, AUTO/MAN/TRK, AUTO
where
MAN (Manual).operator controls the output variable from the Operator
Station or Multibus-based console
AUTO (Auto) FCM calculates the output variable automatically
TRK (Track) output variable tracks a specified signal
Default is: AUTO/MAN

3BUR002336R3701 RevA 275


PID Controller FCM Templet, Upper Portion Section 7 PID Controller FCMS

Mnemonic: OU_MD_AL

LIMITED OUTPUT MODES Field


This field specifies whether the output limits are applied to the manual output, track
output, and/or auto output signals.
Valid entries are: NONE, MAN, AUTO, AUTO/MAN, TRK, MAN/TRK,
AUTO/TRK, ALL
Default is: ALL

TRACK ACTIVATOR SRC Field


This field specifies the FCM that activates Auto/Manual Controller FCM tracking.
It is used when the output of the FCM can track a variable from another FCM. The
FCM attribute that activates tracking is specified in the TRACK ACTIVATOR
ATTR field. Bumpless Mode Transfers and Tracking for PID Controllers on page
266, describes output and setpoint tracking.
Valid entries are:
.fcmname FCM in this loop is the source
tag.fcmname FCM from another loop is the source
Default is: No Track Activator Signal

TRACK ACTIVATOR ATTR Field


This field specifies the parameter that activates tracking in the Auto/Manual
Controller. The parameter must be in the FCM specified by the TRACK
ACTIVATOR SRC field. The TRACK ACTIVATE STATE field determines the
condition (TRUE or FALSE) of this parameter to cause tracking.
Valid entry is a mnemonic for the parameter in the FCM named by the TRACK
ACTIVATOR SRC field
Default is: TRK_FLAG (mnemonic for Track Flag)

276 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Upper Portion

Both PID and Auto/Manual Controller FCMs have TRK_FLAG


variables. In an Auto/Manual FCM, the TRK_FLAG is TRUE
when the FCM is not in the Auto mode. In a PID Controller FCM,
the TRK_FLAG is TRUE when the FCM is not in the Auto mode or
is not using the remote setpoint.

TRACK INPUT SOURCE Field


This field specifies a FCM whose signal is tracked by the controller FCM. This
signal is specified via the TRACK INPUT ATTRIBUTE field. See Bumpless Mode
Transfers and Tracking for PID Controllers on page 266, for further information.
Valid entries are:
.fcmname FCM in the loop is the input
tag.fcmname FCM from another loop is the input
Default is: No Track Input Signal

TRACK INPUT ATTRIBUT Field


This field specifies the parameter in the FCM specified in the TRACK INPUT
ATTRIBUTE field that is the source. See the description of the TRACK INPUT
SOURCE field.
Valid entry is a mnemonic for the parameter in the FCM named by the TRACK
INPUT SOURCE field
Default is: TRAK_VAR

The TRAK_VAR of an Auto/Manual Controller FCM is an adjusted


output. The TRAK_VAR of a PID Controller FCM is an adjusted
setpoint. See Bumpless Mode Transfers and Tracking for PID
Controllers on page 266.

3BUR002336R3701 RevA 277


PID Controller FCM Templet, Upper Portion Section 7 PID Controller FCMS

TRACK ACTIVATE STATE Field


This field specifies the state the track activator must be in for tracking to occur. See
the description of the TRACK ACTIVATOR ATTR field.
Valid entries are:
TRUE
FALSE
Default is: TRUE
Mnemonic: TRK_STAT

REMOTE SETPT SOURCE Field


This field specifies the source of the remote setpoint.
Valid entries are:
.fcmname result of another FCM in the loop is the remote setpoint
tag.fcmname result of a FCM from another loop is the remote setpoint
Default is: No Remote Setpoint

SETPT TRACKING SRC Field


This field specifies an FCM whose result is tracked by the setpoint of this FCM.
Setpoint tracking can only occur if TRK is one of the entries on the SETPT MODES
ALLOWED field. Setpoint tracking occurs when the output mode is not Auto.
Valid entries are:
.fcmname result of another FCM in the loop is the setpoint tracking source
tag.fcmname result of a FCM from another loop is the setpoint tracking source
Default is: No Setpoint Tracking

278 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Upper Portion

CONTROLLER ACTION Field


This field specifies whether the FCM output is direct or reverse acting.
Valid entries are:
DIRECT output of FCM increases as input to FCM increases
REVERSE output of FCM decreases as input to FCM increases
Default is: REVERSE
Mnemonic: ACTION

PROCESS HIGH VALUE Field


This field gives the value of the process input corresponding to 100.0% of the range.
Valid entry is a decimal value.
Default is: PROCESS HI (value entered in the HI ENG. UNIT LIMIT field on
the Loop Definition Templet for the loop)
Mnemonic: PROC_HV

PROCESS LOW VALUE Field


This field gives the value of the process input corresponding to 0.0% of the range.
Valid entry is a decimal value.
Default is: PROCESS LO (value entered in the LO ENG. UNIT LIMIT field
on the Loop Definition Templet for the loop)
Mnemonic: PROC_LV

ADAPTIVE CONTROL Field


This field is only displayed in the AdvaBuild Template Builder running on the HP-
UX platform and the MOD 300 Configurator. It is not displayed in the AdvaBuild
Templet Builder running on the Windows platform.
In the AdvaBuild Templet Builder running on the Windows platform, the adaptive
mode is determined by the presence of an ADGAIN and/or ADRESET object below
the PID object. If neither an ADGAIN nor an ADRESET object is a child of the PID

3BUR002336R3701 RevA 279


PID Controller FCM Templet, Upper Portion Section 7 PID Controller FCMS

object, then all adaptive responses are turned off. If only an ADGAIN object is a
child of the PID object, then adaptive functions can change the gain. If only an
ADRESET object is a child of the PID object, then adaptive functions can change
the reset rate. If both an ADGAIN and an ADRESET object are children of the PID
object, then adaptive functions can change the gain and reset.
From the AdvaBuild Template Builder running on the HP-UX platform and the
MOD 300 Configurator, this field specifies whether the enabled adaptive functions
are able to change the gain or reset of the FCM. The adaptive functions are the
process input, deviation, remote input, output, and contact closure adaptive
functions.
Valid entries are:
NONE all adaptive responses are turned off
GAIN adaptive functions can change the gain
RESET adaptive functions can change the reset rate
BOTH adaptive functions can change the gain and reset
Default is: NONE If the entry is GAIN, RESET, or BOTH for this field,
Adaptive Gain and/or Adaptive Reset Templets are generated when
the PID Controller Templet is stored. Instructions for these templets
are provided in Adaptive Gain And Adaptive Reset on page 306.
Mnemonic: ADPTMODE

INITIAL MODE Field


This field specifies the output mode at start-up time.
Valid entries are:
MAN start in the Manual mode
AUTO start in the Auto mode
Default is: AUTO
Mnemonic: INITMODE

280 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Upper Portion

INITIAL OUTPUT Field


This field specifies the value of the output at start-up time.
Valid entry is a value between -14.0 and 114.0%.
Default is: 0.0
Mnemonic: INIT_OUT

INITIAL SETPOINT Field


This field indicates the value of the setpoint at start-up time.
Valid entry is a value scaled in engineering units.
Default is: 0.0
Mnemonic: INIT_SPT

INITIAL SETPT MODE Field


This field specifies the setpoint mode at start-up time.
Valid entries are:
LOC local setpoint mode
REM remote setpoint mode
Default is: LOC
Mnemonic: INITSPMD

LIMITED SETPT MODES Field


This field specifies the setpoint modes to which the setpoint limits are applied.
Valid entries are: NONE, LOC, TRK, REM, RMP, TRK/REM, TRK/RMP,
REM/RMP, LOC/TRK/REM, LOC/TRK/RMP, LOC/TRK, LOC/REM/RMP,
LOC/REM, TRK/REM/RMP, LOC/RMP, ALL
where
LOC is local

3BUR002336R3701 RevA 281


PID Controller FCM Templet, Upper Portion Section 7 PID Controller FCMS

TRK is track
REM is remote
RMP is ramp
Default is: ALL
Mnemonic: SP_LM_AL

SETPOINT MODES ALLOWED Field


This field specifies the possible sources for the setpoint signal.
Valid entries are: LOC, LOC/TRK/REM, LOC/TRK, LOC/TRK/RMP, LOC/REM,
LOC/REM/RMP, LOC/RMP, ALL
where
LOC is local
TRK is track
REM is remote
RMP is ramp
Default entry is: LOC
Mnemonic: SP_MD_AL

MANUAL RESET MODE Field


This field specifies whether the manual reset control action is used and whether it is
used for bumpless transfers. If it is specified as BALANCE, the value of the manual
reset is automatically adjusted by the system to provide bumpless transfers when
switching to the Auto output mode. See Manual Reset on page 265, for the details of
this feature.
Valid entries are:
OFF manual reset response is turned off
BALANCE manual reset response is enabled and used to provide bumpless
transfers to Auto mode

282 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Upper Portion

NO BALANCE manual reset response is enabled but not used to provide


bumpless transfers
Default is: OFF
Mnemonic: M_R_TYPE

MANUAL RESET VALUE Field


This field specifies the initial value of the manual reset.
Valid entry is a value between -127 and 127%.
Default is: 0.0
Mnemonic: M_R_VA

MANUAL RESET HIGH LIMIT Field


This field specifies the high limit for the manual reset value.
Valid entry is a value between -127 and 127%.
Default is: 0.0
Mnemonic: M_R_HILI

MANUAL RESET LOW LIMIT Field


This field specifies the low limit for the manual reset value.
Valid entry is a value between -127 and 127%.
Default is: 0.0
Mnemonic: M_R_LOLI

INCREMENTAL INC TYPE Field


This field selects incremental or full value output for the PID algorithm.
Valid entries are:
NO PID algorithm calculates a full value output
YES PID algorithm calculates an incremental output

3BUR002336R3701 RevA 283


PID Controller FCM Templet, Upper Portion Section 7 PID Controller FCMS

Default: NO
Mnemonic: INC_FLAG

DESIGN OUTPUT MODE Field


This field specifies a normal state for the output of this FCM. This is one of the
items checked if the ABNORMAL STATE field of the Loop Definition Templet
specifies the loop be checked for an abnormal condition.
Valid entries are:
NONE no normal state defined
AUTO Auto mode is normal state
MANUAL Manual mode is normal state
TRACK Track mode is normal state
Default: NONE
Mnemonic: INDEX_1

DESIGN SETPT MODE Field


This field specifies a normal state for the setpoint of this FCM. This is one of the
items checked if the ABNORMAL STATE field of the Loop Definition Templet
specifies the loop be checked for an abnormal condition.
Valid entries are:
NONE no normal state defined
LOCAL Local mode is normal state
REMOTE Remote mode is normal
TRACK Track mode is normal state
RAMP Setpoint mode is being ramped
Default: NONE
Mnemonic: SETPOINT

284 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Middle Portion

PID Controller FCM Templet, Middle Portion


The middle portion of the PID Controller FCM Templet, Figure 53, is used to define
input sources, modes, actions taken for failures, ratio, and bias as described below.

Figure 53. PID Controller FCM Templet, Middle Portion

3BUR002336R3701 RevA 285


PID Controller FCM Templet, Middle Portion Section 7 PID Controller FCMS

INTERACTIVE FORM Field


This field specifies the method to multiply the proportional gain of the FCM by the
integral.
INTERACTIVE FORM:
Output = (G + G * (integral term)) * derivative term
NONINTERACTIVE FORM:
Output = (G + integral term) * derivative term
Valid entries are:
YES use interactive form
NO use non-interactive form
Default is: YES
Mnemonic: INT_FORM

ERROR SQUARED OPTION Field


This field specifies whether the integral calculation uses the error signal or square of
the error signal.
Valid entries are:
NO integral calculation uses the error signal
YES integral calculation uses the square of the error signal
Default is: NO
Mnemonic: ERR_SQR

GAIN LIMIT Field


This field defines a limit for the gain of the controller above which a low pass filter
is activated.
Valid entry is a value set between 0.0 and 125.0.
Default is: 40.0

286 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Middle Portion

Mnemonic: GAIN_LIM

FEEDFORWARD TYPE Field


This field specifies how the feedforward response modifies the unlimited output
signal.
Valid entries are:
ADD after response calculations, the value of the feedforward variable is
added to the signal
MULT after response calculations, the signal is multiplied by the value of
the feedforward variable
Default is: ADD
Mnemonic: FF_TYPE

FF/FB MODE Field


The feedforward and feedback options are specified in this field
Valid entries are:
FF use feedforward
FB use feedback
FF/FB use feedforward and feedback
Default is: FB
Mnemonic: FFFBMODE

FEEDFORWARD SOURCE Field


This field specifies the source of the feedforward variable.
Valid entries are:
.fcmname result of another FCM in the loop is the source
tag.fcmname result of a FCM from another loop is the source
Default entry is: No Feedforward Variable

3BUR002336R3701 RevA 287


PID Controller FCM Templet, Middle Portion Section 7 PID Controller FCMS

EXT FEEDBACK ENABLE Field


This field specifies whether the external feedback function is enabled.
Valid entries are:
NO feedback function is off
YES feedback function is on
Default entry is: NO
Mnemonic: EXFBENAB

EXT FEEDBACK SOURCE Field


This field specifies the source of the signal for the external feedback.
Valid entries are:
.fcmname result of another FCM in the loop is the feedback source
tag.fcmname result of a FCM from another loop is the feedback source
Default entry is: No Feedback Source

ENABLE DEAD TIME Field


This field allows you to add the deadtime compensation input to the process value.
Valid entries are:
NO deadtime compensation is not added to the process signal
YES deadtime compensation is added to the process signal
Default is: NO
Mnemonic: DTC_ENAB

DEAD TIME SOURCE Field


This field adds a compensation signal to the process variable of the control
algorithm thereby permitting a dead time compensated controller.

288 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Middle Portion

Valid entries are:


.fcmname result of another FCM in the loop is the source
tag.fcmname result of a FCM from another loop is the source
Default is: No Dead Time Signal

BALANCE MODE Field


This field indicates whether the system can manipulate the remote setpoint ratio
and/or the remote setpoint bias to prevent process bumps when the setpoint state is
switched to remote.
Valid entries are:
RATIO FCM automatically manipulates ratio value of remote setpoint to
balance transitions to Remote
BIAS controller automatically manipulates bias value of remote setpoint
to balance transitions to Remote
BOTH the system can manipulate both bias and ratio
OFF the balance feature is not used
Default entry is: OFF
Mnemonic: BALANCE

BIAS MODE Field


This field specifies which remote setpoint bias value the FCM is presently using.
The configured entry is the initial bias mode. During runtime, this field changes
each time the mode is switched at the Operator Station or Multibus-based console.
Valid entries are:
REM bias comes from the remote bias source
LOC bias is from the local source (entered by operator at the Operator
Station or Multibus-based console)
OFF controller does not use a bias signal
Default is: OFF

3BUR002336R3701 RevA 289


PID Controller FCM Templet, Middle Portion Section 7 PID Controller FCMS

Mnemonic: B_MODE

LOCAL BIAS Field


This field specifies the local bias value for the FCM. The configured entry is the
initial local bias. During runtime, you can enter the local bias value at the Operator
Station or Multibus-based console.
Valid entry is a decimal value.
Default is: 0.0

REMOTE BIAS SOURCE Field


This field specifies the source of the bias applied to the remote setpoint. In some
cases, the FCM can automatically modify the bias on the remote setpoint. See the
description of the BALANCE MODE field.
Valid entries are:
.fcmname result of another FCM in the loop is the source
tag.fcmname result of a FCM from another loop is the source
Default entry is: No Remote Bias

REMOTE RATIO SOURCE Field


This field specifies the source of the remote setpoint ratio. In some cases, the
algorithm can automatically modify the amount of ratio for the remote setpoint. See
the description for the BALANCE MODE field.
Valid entries are:
.fcmname result of another FCM in the loop is the source
tag.fcmname result of a FCM from another loop is the source
Default entry is: No Remote Ratio

BIAS MODES ALLOWED Field


This field specifies the bias modes allowed for the controller.

290 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Middle Portion

Valid entries are:


LOC local bias mode is allowed
REM remote bias mode is allowed
LOC/REM local and remote bias modes are allowed
OFF no bias is used
Default is: OFF
Mnemonic: B_MDAL

LIMITED BIAS MODES Field


This field specifies the bias limits applied to the bias modes
Valid entries are:
NONE
LOC limits apply to the local bias mode
REM limits apply to the remote bias mode
LOC/REM limits apply to local and remote bias modes
Default is: LOC/REM
Mnemonic: B_LMAL

BAD INPUTS ACCEPTED? Field


This field specifies whether an input with BAD data quality is treated as if the data
quality is GOOD.
Valid entries are:
NO do not accept bad inputs
YES accept bad inputs
Default is: NO
Mnemonic: WORST_DQ

3BUR002336R3701 RevA 291


PID Controller FCM Templet, Middle Portion Section 7 PID Controller FCMS

ACTION ON BAD INPUT Field


This field specifies the action to take if the controller input signal goes to BAD data
quality.
Valid entries are:
FCM OFF controller FCM is turned off
MAN OUT controller FCM goes to the Manual output mode
NONE FCM continues processing according to its configuration
Default is: NONE
Mnemonic: BAD_INP

ACTION ON BAD SETPT Field


This field specifies the action to take if the setpoint signal goes to a BAD data
quality.
Valid entries are:
NONE no special action is taken
MAN OUT output mode is switched to Manual
LOC SPT setpoint mode goes to Local
FCM OFF FCM is turned off
Default is: NONE
Mnemonic: BAD_SPT

SETPOINT RETURN MODE Field


This field specifies the setpoint mode to enter when the mode returns from Track.
Valid entries are:
PREVIOUS go to the mode active before the setpoint went to Track
LOCAL go to the Local mode
REMOTE go to the Remote mode

292 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Middle Portion

Default is: PREVIOUS


Mnemonic: RET_SPMD

SETPT VALUE ON FAIL Field


This field specifies the setpoint value in effect upon a remote link failure.
Valid entry is a value in engineering units.
Default is: 0.0
Mnemonic: SPREFAIL

CHANGE SETPT ON FAIL Field


This field specifies whether a new setpoint value is supplied upon a remote link
failure.
Valid entries are:
NO do not change setpoint
YES change setpoint
Default is: NO
Mnemonic: SPVAFAIL

SETPT MODE ON FAIL Field


This field specifies the setpoint mode entered upon a remote link failure.
Valid entries are:
PREVIOUS go to the mode active before the remote link failure
LOCAL go to the Local mode
REMOTE go to the Remote mode
NO CHANGE remain in the present mode
Default is: PREVIOUS
Mnemonic: SPMDFAIL

3BUR002336R3701 RevA 293


PID Controller FCM Templet, Middle Portion Section 7 PID Controller FCMS

OUTPUT RETURN MODE Field


This field specifies the output mode to enter when the mode returns from Track.
Valid entries are:
PREVIOUS go to the mode active before the output began tracking
MANUAL go to the Manual mode
AUTO go to the Auto mode
Default is: PREVIOUS
Mnemonic: TRKORET

OUTPUT MODE ON FAIL Field


This field specifies the output mode to enter upon a remote link failure. See Alarm
Handling: Configuration, Detection, Posting, and Cutout on page 164, and COMP
MODE Restrictions on page 268, for information on how remote link failure
conditions occur.
Valid entries are:
PREVIOUS go to the mode active before the remote link failure
MANUAL go to the Manual mode
AUTO go to the Auto mode
NO CHANGE remain in the present mode
Default is: PREVIOUS
Mnemonic: OUMDFAIL

OUTPUT VALUE ON FAIL Field


This field specifies the output value effective upon a remote link failure if the entry
in the CHANGE OUTPT ON FAIL field is YES. See Alarm Handling:
Configuration, Detection, Posting, and Cutout on page 164, and COMP MODE
Restrictions on page 268, for information on how remote link failure conditions
occur.
Valid entry is a value in percent.

294 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Middle Portion

Default is: 0.0


Mnemonic: OUTRFAIL

CHANGE OUTPUT ON FAIL Field


This field specifies if a new output value is supplied upon a remote link failure. See
Alarm Handling: Configuration, Detection, Posting, and Cutout on page 164, and
COMP MODE Restrictions on page 268, for information on how remote link failure
conditions occur.
Valid entries are:
NO do not change the output value
YES change the output value
Default is: NO
Mnemonic: OUVAFAIL

LINK TIME-OUT Field


This field specifies the initial time interval for the watchdog timer. The timer is used
to determine whether a supervisory program can continue to control the loop. See
Alarm Handling: Configuration, Detection, Posting, and Cutout on page 164, and
COMP MODE Restrictions on page 268, for information on the procedure used to
determine if a supervisory program can control a loop and the actions taken when it
cannot.
Valid entry is a number of seconds.
Default is: 60
Mnemonic: WD_TIME

BIAS HIGH LIMIT Field


This field specifies the high limit for the bias values. This limit only applies to the
bias modes specified in the LIMITED BIAS MODES field.
Valid entry is a percentage value.
Default is: 0.0

3BUR002336R3701 RevA 295


PID Controller FCM Templet, Middle Portion Section 7 PID Controller FCMS

Mnemonic: B_HILI

BIAS LOW LIMIT Field


This field specifies the low limit for the bias values. This limit only applies to the
bias modes specified in the LIMITED BIAS MODES field.
Valid entry is a percentage value.
Default is: 0.0
Mnemonic: B_LOLI

RATIO MODE Field


This field specifies which remote setpoint ratio value the controller is presently
using. The configured entry is the initial ratio mode. During runtime, the contents of
this field change each time the mode is switched from the Operator Station or
Multibus-based console.
Valid entries are:
REMOTE ratio comes from the remote ratio source
LOCAL ratio is from the local source (entered by operator at the Operator
Station or Multibus-based console)
OFF FCM does not use a ratio signal
Default is: OFF
Mnemonic: R_MODE

LOCAL RATIO Field


This field specifies the local remote setpoint ratio value for the controller. The
configured entry is the initial local ratio. During runtime, you can change the local
ratio value at the Operator Station or Multibus-based console.
Valid entry is a value in engineering units.
Default is: 1.0

296 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Middle Portion

RATIO MODES ALLOWED Field


This field specifies which ratio modes are allowed.
Valid entries are:
LOC ratio from a local source (entered by operator at the Operator
Station or Multibus-based console)
REM ratio comes from remote ratio
LOC/REM applies to both modes
OFF Not in use
Default is: OFF
Mnemonic: R_MDAL

LIMITED RATIO MODES Field


This field specifies the ratio modes to which the ratio limits are applied.
Valid entries are:
NONE
LOC limits apply to the local ratio
REM limits apply to the remote ratio
LOC/REM limits apply to both modes
Default is: LOC/REM
Mnemonic: R_LMAL

RATIO HIGH LIMIT Field


This field specifies the high limit for the ratio values. This limit only applies to the
ratio modes specified in the LIMITED RATIO MODES field.
Valid entry is a value in engineering units.
Default is: 1.1
Mnemonic: R_HILI

3BUR002336R3701 RevA 297


PID Controller FCM Templet, Lower Portion Section 7 PID Controller FCMS

RATIO LOW LIMIT Field


This field specifies the low limit for the ratio values. This limit only applies to the
ratio modes specified in the LIMITED RATIO MODES field.
Valid entry is a value in engineering units.
Default is: 1.0
Mnemonic: R_LOLI

PID Controller FCM Templet, Lower Portion


The lower portion of the PID Controller FCM Templet, Figure 54, is used to define
deadband information, alarm limits, and priorities as described below.

298 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Lower Portion

Figure 54. PID Controller FCM Templet, Lower Portion

3BUR002336R3701 RevA 299


PID Controller FCM Templet, Lower Portion Section 7 PID Controller FCMS

INC MINIMUM OUTPUT Field


This field specifies the critical value for the incremental PID algorithm. The critical
value is the smallest result of the algorithm that affects the output device. For
instance, when pulse duration outputs drive the output device, the critical value is
the smallest result of the PID algorithm that turns on a pulse duration output. When
the result is less than the critical value, the value is stored and the result has no
effect. On the next scan, the stored value is used to calculate a new result. Unused
results are stored until the cumulative result is large enough to use.
The following equation is used to determine the critical value for a pulse duration
output:
CV = (100 x DO_RATE)
(H)
where:
DO_RATE is the resolution in milliseconds for the pulse digital outputs (as
specified on the Controller or Multibus I/O Templet)
H is the 100% (HI_COUNT) value for the pulse digital outputs (as
defined on the Pulse Duration Output Templet)
When the critical value is zero, there is no adjustment for ineffective results. To
make an adjustment for ineffective results, the integral (reset) control action must be
turned on.
Valid entry is a value, in engineering units, which must be greater than or equal to 0
(zero)
Default is: 0.0000
Mnemonic: INC_CV

INC LOWER DEADBAND Field


This field specifies the lower boundary of the deadband for the incremental PID
algorithm.
Valid entry is a value, in engineering units, which must be less than or equal to 0
(zero).
Default: 0.0000

300 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Lower Portion

Mnemonic: INC_L_DB

INC UPPER DEADBAND Field


This field specifies the upper boundary of the deadband for the incremental PID
algorithm.
Valid entries are a value, in engineering units, which must be greater than or equal to
0 (zero).
Default: 0.0000
Mnemonic: INC_H_DB

OUTPUT HIGH LIMIT Field


This field specifies the high limit for the output signal. It is used to limit the output
when the FCM is in the modes specified in the LIMITED OUTPUT MODES field.
It is also the alarm limit if the entry in the OUTPUT HIGH ALARMS? field is YES.
Valid entry is a number between -14.0 and 114.0%.
Default is: 114.0
Mnemonic: OUT_HILI

OUTPUT LOW LIMIT Field


This field specifies the low limit for the output signal. It is used to limit the output
when the FCM is in the modes specified in the LIMITED OUTPUT MODES field.
It is also the alarm limit if the entry in the OUTPUT LOW ALARMS? field is YES.
Valid entry is a number between -14.0 and 114.0%.
Default is: -14.0
Mnemonic: OUT_LOLI

OUTPUT ALARM DB Field


This field is used to define a deadband for the output alarm of this FCM.
Valid entry is a floating point number in percent of range.

3BUR002336R3701 RevA 301


PID Controller FCM Templet, Lower Portion Section 7 PID Controller FCMS

Default is: CCF_ALARM_DB (value in the ALARM DEADBAND field of


the CCF Templet)
Mnemonic: OUT_DEBD

OUTPUT RATE LIMIT Field


This field specifies the highest allowed rate of change of the output signal per
second. It is used when the FCM is in the modes specified in the LIMITED
OUTPUT MODES field (except for MAN, OUTPUT RATE LIMIT is not
applicable for manual mode). It is also the alarm limit if the entry in the OUTPUT
RATE ALARMS? field is YES.
Valid entry is a number between 0.0 and 128.0%.
Default is: 0.0 (no output rate limit is applied)
Mnemonic: RATE_LIM

OUTPUT HIGH ALARMS? Field


This field specifies whether the high alarm on the output signal is enabled. If this
field is YES, an alarm occurs when the output is equal to or greater than the value
entered in the OUTPUT HIGH LIMIT field. The alarm clears when the output
decreases to a value equal to or less than the value of the high limit minus the alarm
deadband (specified on the CCF Templet).
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

OUTPUT LOW ALARMS? Field


This field specifies whether the low alarm on the output signal is enabled. If this
field is YES, an alarm occurs when the output is equal to or less than the value
entered on the OUTPUT LOW LIMIT field. The alarm clears when the output
increases to a value equal to or greater than the value of the low limit plus the alarm
deadband (specified on the CCF Templet).

302 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Lower Portion

Valid entries are:


YES enable the alarm
NO disable the alarm
Default is: YES

OUTPUT RATE ALARMS? Field


This field specifies whether the rate alarm for the output signal is enabled. If this
field is YES, an alarm occurs when the rate of change of the output per second is
equal to or greater than the value entered in the OUTPUT RATE LIMIT field.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

BAD OUTPUT ALARMS? Field


This field specifies whether the bad data quality alarm for the output signal is
enabled. If this field is YES, an alarm occurs when the data quality of the output
goes to BAD.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

SETPOINT HIGH ALARM? Field


This field specifies whether the high alarm for the setpoint signal is enabled. If this
field is YES, an alarm occurs when the output is equal to or greater than the value
entered in the SETPOINT HIGH LIMIT field.
Valid entries are:
YES enable the alarm

3BUR002336R3701 RevA 303


PID Controller FCM Templet, Lower Portion Section 7 PID Controller FCMS

NO disable the alarm


Default is: NO

SETPOINT LOW ALARM? Field


This field specifies whether the low alarm for the setpoint signal is enabled. If this
field is YES, an alarm occurs when the setpoint is equal to or less than the value
entered in the SETPOINT LOW LIMIT field.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: NO

BAD SETPOINT ALARM? Field


This field specifies whether the bad data quality alarm for the setpoint signal is
enabled. If this field is YES, an alarm occurs when the data quality of the setpoint
goes to BAD.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: YES

DEVIATION HI ALARMS? Field


This field specifies whether the high alarm for the deviation signal is enabled. If this
field is YES, an alarm occurs when the deviation is equal to or greater than the value
entered in the DEVIATION HIGH LIMIT field.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: NO

304 3BUR002336R3701 RevA


Section 7 PID Controller FCMS PID Controller FCM Templet, Lower Portion

DEVIATION LOW ALARMS? Field


This field specifies whether the low alarm for the deviation signal is enabled. If this
field is YES, an alarm occurs when the deviation is equal to or less than the value
entered on the DEVIATION LOW LIMIT field.
Valid entries are:
YES enable the alarm
NO disable the alarm
Default is: NO

SETPOINT HIGH LIMIT Field


This field specifies the high limit for the setpoint values. This limit only applies to
the setpoint modes specified in the LIMITED SETPT MODES field. It is also used
as an alarm limit when the entry in the SETPOINT HIGH ALARMS? field is YES.
Valid entry is a decimal value in engineering units.
Default is: PROCESS HI

SETPOINT LOW LIMIT Field


This field specifies the low limit for the setpoint values. This limit only applies to
the setpoint modes specified in the LIMITED SETPT MODES field. It is also used
as an alarm limit when the entry in the SETPOINT LOW ALARMS? field is YES.
Valid entry is a decimal value in engineering units.
Default is: PROCESS LO

DEVIATION HIGH LIMIT Field


This field specifies the high alarm limit for the deviation value. It is used when the
entry in the DEVIATION HI ALARMS? field is YES.
Valid entry is a decimal value in engineering units.
Default is: 0.0

3BUR002336R3701 RevA 305


Adaptive Gain And Adaptive Reset Section 7 PID Controller FCMS

DEVIATION LOW LIMIT Field


This field specifies the low alarm limit for the deviation value. It is used when the
entry in the DEVIATION LOW ALARMS? field is YES.
Valid entry is a decimal value in engineering units.
Default is: 0.0

DEVIATION ALARM DB Field


This field is used to define a deadband for the deviation alarm of this FCM.
Valid entry is a value in engineering units
Default: CCF_ALARM_DB (value in the ALARM DEADBAND field of
the CCF Templet scaled in the engineering units of this loop)
Mnemonic: OUT_DEBD

Output, Setpoint, and Deviation Alarm PRIORITY Fields


These fields (for example, OUTPUT HIGH PRIORITY, SETPT LOW PRIORITY,
DEVN HIGH PRIORITY, and so on) specify the priority levels for their respective
alarms.
Valid entries are:
STD standard priority (3)
MED medium priority (2)
HIGH high priority (1)
Default is: STD

Adaptive Gain And Adaptive Reset


The PID Controller FCM uses adaptive gain and/or adaptive reset to adapt to
changing process conditions. Appendix B, Adaptive Control In The PID Controller
FCM, explains the concepts of adaptive control and the methods by which they are
used by the PID Controller FCM.

306 3BUR002336R3701 RevA


Section 7 PID Controller FCMS Adaptive Gain And Adaptive Reset

Adaptive gain and reset are configured on the Adaptive Gain and Adaptive Reset
Templets. Figure 55 shows the Adaptive Gain Templet, and Figure 56 shows the
Adaptive Reset Templet.

Figure 55. Adaptive Gain Templet

3BUR002336R3701 RevA 307


Adaptive Gain And Adaptive Reset Section 7 PID Controller FCMS

Figure 56. Adaptive Reset Templet

These templets are children of the PID Controller FCM Templet, and have the
following fields.

308 3BUR002336R3701 RevA


Section 7 PID Controller FCMS Adaptive Gain And Adaptive Reset

HIGH LIMIT Field


The field specifies the overall high limit for gain or reset when any adaptive
function is used.
Valid entry is a decimal value.
Default is: 10.0

LOW LIMIT Field


This field specifies the overall low limit for gain or reset when any adaptive
function is in used.
Valid entry is a decimal value.
Default is: 0.0

ENABLE ON CONTACT Field


This field specifies whether the contact adaptive function is turned on.
Valid entries are:
NO contact adaptive function is turned off
YES contact adaptive function is turned on
Default is: NO

CONTACT SOURCE Field


This field specifies the signal source for the contact adaptive function. The source
should be set up so it has two possible conditions: true (closed contacts) or false
(open contacts).
Valid entries are:
.fcmname result of another FCM in the loop is the contact source
tag.fcmname result of a FCM from another loop is the contact source

3BUR002336R3701 RevA 309


Adaptive Gain And Adaptive Reset Section 7 PID Controller FCMS

CONTACT STATE Field


This field specifies on which state of the contacts the gain or reset is adapted by the
contact adaptive function.
Valid entries are:
TRUE apply the contact adaptive function when the signal is true (closed
contacts - non-zero)
FALSE apply the contact adaptive function when the signal is false (open
contacts - zero)
Default is: TRUE

CONTACT GAIN Field


This field specifies the factor by which the base gain or reset is multiplied when the
contact adaptive function is applied.
Valid entry is a decimal value.
Default entry is: 1.0

ENABLE ON REMOTE Field


This field specifies whether the remote variable adaptive function is turned on.
Valid entries are:
NO remote variable adaptive function is turned off
YES remote variable adaptive function is turned on
Default is: NO

REMOTE SOURCE Field


This field specifies the source of the remote variable for the remote variable
adaptive function.
Valid entries are:
.fcmname result of another FCM in the loop is the variable

310 3BUR002336R3701 RevA


Section 7 PID Controller FCMS Adaptive Gain And Adaptive Reset

tag.fcmname result of a FCM from another loop is the variable

REMOTE HIGH LIMIT Field


This field specifies the maximum allowed value for the remote variable adaptive
contribution to the overall gain or reset.
Valid entry is a decimal number.
Default entry is: 0.0

REMOTE LOW LIMIT Field


This field specifies the minimum allowed value for the remote variable adaptive
contribution to the overall gain or reset.
Valid entry is a decimal number.
Default entry is: 0.0

REMOTE UPPER BRKPT Field


This field specifies the upper breakpoint, BP2, for the remote variable adaptive
function. The gain or reset changes when the remote variable becomes greater than
the upper breakpoint.
Valid entry is a decimal value with the same type of units as the remote variable
(eng. units or percent).
Default is 0.0

REMOTE LOWER BRKPT Field


This field specifies the lower breakpoint, BP1, for the remote variable adaptive
function. The gain or reset changes when the remote variable becomes less than the
lower breakpoint.
Valid entry is decimal value with same type of units as the remote variable
(engineering units or percent).
Default is 0.0

3BUR002336R3701 RevA 311


Adaptive Gain And Adaptive Reset Section 7 PID Controller FCMS

REMOTE UPPER FACTOR Field


This field specifies the multiplier of the base gain or reset associated with the upper
breakpoint, BP2, of the remote variable adaptive function.
Valid entry is a decimal value.
Default is: 1.0

REMOTE LOWER FACTOR Field


This field specifies the multiplier of the base gain or reset associated with the lower
breakpoint, BP1, of the remote variable adaptive function.
Valid entry is a decimal value.
Default is: 1.0

ENABLE ON OUTPUT Field


This field specifies whether the output adaptive function is turned on.
Valid entries are:
NO output adaptive function is turned off
YES output adaptive function is turned on
Default is: NO

OUTPUT UPPER BRKPT Field


This field specifies the upper breakpoint, BP2, for the output adaptive function. The
gain or reset starts to change when the size of the output becomes greater than the
upper breakpoint.
Valid entry is a decimal value in percent.
Default is: 1.0

312 3BUR002336R3701 RevA


Section 7 PID Controller FCMS Adaptive Gain And Adaptive Reset

OUTPUT LOWER BRKPT Field


This field specifies the lower breakpoint, BP1, for the output adaptive function. The
gain or reset starts to change when the size of the output becomes less than the lower
breakpoint.
Valid entry is a decimal value in percent.
Default is: 0.0

OUTPUT UPPER FACTOR Field


This field specifies the multiplier of the base gain or reset associated with the upper
breakpoint, BP2, of the output adaptive function.
Valid entry is a decimal value.
Default is: 1.0

OUTPUT LOWER FACTOR Field


This field specifies the multiplier of the base gain or reset associated with the lower
breakpoint, BP1, of the output adaptive function.
Valid entry is a decimal value.
Default is: 1.0

ENABLE ON PROCESS Field


This field specifies whether the process adaptive function is turned on.
Valid entries are:
NO process adaptive function is turned off
YES process adaptive function is turned on
Default is: NO

PROCESS HIGH LIMIT Field


This field specifies the maximum allowed value for the process adaptive
contribution to the overall gain or reset.

3BUR002336R3701 RevA 313


Adaptive Gain And Adaptive Reset Section 7 PID Controller FCMS

Valid entry is a decimal number.


Default is: 0.0

PROCESS LOW LIMIT Field


This field specifies the minimum allowed value for the process adaptive
contribution to the overall gain or reset.
Valid entry is low limit value.
Default entry is: 0.0

PROCESS UPPER BRKPT Field


This field specifies the upper breakpoint, BP2, for the process adaptive function.
The gain or reset starts to change when the size of the process variable becomes
greater than the upper breakpoint.
Valid entry is a decimal value in percent.
Default is 0.0

PROCESS LOWER BRKPT Field


This field specifies the lower breakpoint, BP1, for the process adaptive function.
The gain or reset changes when the process variable becomes less than the lower
breakpoint.
Valid entry is a decimal value in percent.
Default is 0.0

PROCESS UPPER FACTOR Field


This field specifies the multiplier of the base gain or reset associated with the upper
breakpoint, BP2, of the process adaptive function.
Valid entry is a decimal value.
Default is: 1.0

314 3BUR002336R3701 RevA


Section 7 PID Controller FCMS Adaptive Gain And Adaptive Reset

PROCESS LOWER FACTOR Field


This field specifies the multiplier of the base gain or reset associated with the lower
breakpoint, BP1, of the process adaptive function.
Valid entry is a decimal value.
Default is: 1.0

ENABLE ON ERROR Field


This field specifies whether the error adaptive function is turned on.
Valid entries are:
NO error adaptive function is turned off
YES error adaptive function is turned on
Default is: NO

ERROR HIGH LIMIT Field


This field specifies the maximum allowed value for the error adaptive contribution
to the overall gain or reset.
Valid entry is the high limit value.
Default is: 0.0

ERROR LOW LIMIT Field


This field specifies the minimum allowed value for the error adaptive contribution
to the overall gain or reset.
Valid entry is the low limit value.
Default is: 0.0

ERROR UPPER BRKPT Field


This field specifies the upper breakpoint, BP2, for the error adaptive function. The
gain or reset changes when the error becomes greater than the upper breakpoint.
Valid entry is a decimal value in percent.

3BUR002336R3701 RevA 315


Adaptive Gain And Adaptive Reset Section 7 PID Controller FCMS

Default is 0.0

ERROR LOWER BRKPT Field


This field specifies the lower breakpoint, BP1, for the error adaptive function. The
gain or reset changes when the error becomes less than the lower breakpoint.
Valid entry is a decimal value in percent.
Default is: 0.0

ERROR UPPER FACTOR Field


This field specifies the multiplier of the base gain or reset associated with the upper
breakpoint, BP2, of the error adaptive function.
Valid entry is a decimal value.
Default is: 1.0

ERROR LOWER FACTOR Field


This field specifies the multiplier of the base gain or reset associated with the lower
breakpoint, BP1, of the error adaptive function.
Valid entry is a decimal value.
Default is: 1.0

316 3BUR002336R3701 RevA


Section 8 Output FCMS

General Information
Output FCMs send values to the I/O interfaces of Controller and Multibus I/O
Subsystems. The following types of Output FCMs are provided: Analog Output,
Digital Output, Pulse Duration Output, and Pulse Train Output.
This section describes the templets for configuring these FCMs. Parameters
Common To All Output FCMS on page 317, describes the parameters identical to
all Output FCM configuration templets. Analog Output FCM on page 322, through
Pulse Train Output FCM on page 331, describe the items specific to the individual
FCMs. A list of FCM level parameters for Output FCMs is provided in the Data
Base Tables manual.

Parameters Common To All Output FCMS


These fields are on the configuration templets for all Output FCMs.

INPUT SOURCE Field


This field specifies the FCM input source. The input is expressed as a percentage
value or engineering units as specified in the ENGU OR PERCENT field.
Valid entries are:
.fcmname result of another FCM in the same loop is the input
tag.fcmname result of a FCM from another loop is the input
If the input is in percent, it is scaled into counts by the following equation:
I
C =  ---------  HC – LC  + LC
 100

3BUR002336R3701 RevA 317


Parameters Common To All Output FCMS Section 8 Output FCMS

where
C is the counts
I is the input value in percent
HC is the high counts (entry in the COUNTS - UPPER BOUND field)
LC is the low counts (entry in the COUNTS - LOWER BOUND field)
If the input is in engineering units, it is scaled into counts by the following equation:
I – LU
C =  -----------------------  HC – LC  + LC
 HU – LU
where
C is the counts
I is the input value in engineering units
HC is high counts (entry in the COUNTS - UPPER BOUND field)
LC is low counts (entry in the COUNTS - LOWER BOUND field)
HU is high eng. units (entry in the ENGU - UPPER BOUND field)
LU is the low eng. units (entry in the ENGU - LOWER BOUND field)
When the entry in the SIGNAL INVERSION field is YES, the proportions are
inverted such that an input of 80% is treated as 20%. The equations for scaling the
inputs into counts in this case are:
I
C = HC –  ---------  HC – LC 
100

I – LU
C = HC –  -----------------------  HC – LC 
 HU – LU

The UNDER RANGE COUNTS and OVER RANGE COUNTS fields define the
ends of the input range. See Figure 57. They are the lowest and highest count values
that can be output.

318 3BUR002336R3701 RevA


Section 8 Output FCMS Parameters Common To All Output FCMS

Overrange
Counts

Counts
Upperbound

Analog Output
FCM
Counts
Lowerbound
Under Range
Counts

Engineering Units Engineering Units


Lower Bound Upper Bound

Figure 57. Engineering Units Versus Counts for an Analog Output FCM

VENDOR TYPE Field


This field specifies the type of I/O receiving the output.
Valid entries are:
BURR/BROWNMultibus I/O
CONTROLLERController I/O (Direct I/O for a controller)
CUSTOM I/O Customized I/O
PLC I/O
PROFIBUS I/OProfibus I/O. This vendor type is only available for Advant
Controller 460 subsystems configured on the Windows platform
using the AdvaBuild Control Builder version 3.2 or higher
software.
REMOTE I/O Taylor Remote I/O (TRIO)

3BUR002336R3701 RevA 319


Parameters Common To All Output FCMS Section 8 Output FCMS

S100 I/O
S800 I/O This vendor type is only available for systems that use Engineering
Station version 2.5 or higher.
Default is: REMOTE I/O for either Turbo Node or Controller Subsystems.

Since pulse train outputs do not support channel path I/O


addressing, they do not support S800 or Profibus I/O and the S800
I/O and PROFIBUS I/O vendor types are not available when
configuring pulse train outputs.

LAN NUMBER Field


This field specifies the number of field bus where the modules are connected. The
number is determined by the connector on the field bus interface module where the
field bus is connected. It is either 1 or 2 for a Controller Subsystem. To determine
which bus the module is on check if the bus is labeled with its bus number. If it is
not, you can trace the bus number by checking which connector the cable is attached
to at the Field Bus Interface Module.
A turbo node can have up to 6 field buses connected. To determine which bus the
module is on, check if the bus is labeled with its bus number. If the cable is not
labeled, the field bus module for that bus must be pulled out of the Multibus Card
File. This board has a cluster of six jumper positions labeled W7 to W12. A jumper
should be in one of these positions. If a jumper is in position W7, the module is on
Field Bus 1. If the jumper is in position W8, the module is on Field Bus 2 and so on
up to position W12, indicating the module is on Field Bus 6.

BLOCK NUMBER Field


This field specifies the number of the module containing the output channel.
Valid entry is an integer in the range of 1 to 30.

320 3BUR002336R3701 RevA


Section 8 Output FCMS Parameters Common To All Output FCMS

CHANNEL NUMBER Field


This field specifies the output signal destination. This field MUST be defined. The
number of outputs or counts, calculated by the FCM, is sent to this channel. The
counts are converted from digital to analog, and the analog signal is sent to the field.
Information about the analog output channels is provided in Controller Analog
Input and Output Channels on page 83, and Analog Outputs in Multibus I/O
Subsystems on page 124.
Valid entry is the channel number for the output.

INITIAL OUTPUT MODE Field or INITIAL MODE Field


These fields specify the loop output mode at start-up, and can also be used to
specify warmstart action for TRIO, S800, and S100 (DSAX110A, DSDX180A, and
DSDO115A boards).
Valid entries are:
AUTO loop determines output values
MAN on start-up, output FCM uses value specified in INITIAL OUTPUT
field, or performs warmstart action.
Default is: AUTO
Mnemonic: OUTMODE
For warmstart, enter MAN. This puts the FCM in manual as part of warmstart. The
FCM will use the output value read from the output device memory until the
operator changes the FCM’s output value, or changes the Output Mode to AUTO.

INITIAL OUTPUT Field


This determines the initial result (FCM output) at start-up when the entry in the
INITIAL OUTPUT MODE field is MAN.
Valid entry is a decimal number.
Default is: 0.0
Mnemonic: INIT_OUT

3BUR002336R3701 RevA 321


Analog Output FCM Section 8 Output FCMS

BAD INPUTS ACCEPTED? Field


This field specifies the data qualities acceptable for the input signal to the FCM and
the action to take if the data quality becomes unacceptable.
Valid entries are:
YES GOOD and BAD are acceptable data qualities
NO GOOD is the only acceptable data quality for the input
Default is: NO
Mnemonic: WORST_DQ

ACTION ON ERROR Field


This field defines the action taken if the FCM is unable to output a valid signal to
the field.
Valid entries are:
NOTHING continue processing the loop as configured
FCM OFF turn the FCM off
SOURCE OFF turn the source off
GOTO BACKUP for switchover to Backup Controller in Controller Subsystems
with Backup Controller option. For other Controller and
Multibus I/O Subsystems, this choice shuts down CCF
processing when an error condition occurs.
LOOP OFF turn the loop off
Default is: NOTHING

Analog Output FCM


The Analog Output FCM sends analog outputs to I/O interfaces in Controller and
Multibus I/O Subsystems. You Configure this FCM via the Analog Output FCM
Templet. Figure 58 shows an example of the Analog Output FCM Templet from the
AdvaBuild Templet Builder running on the Windows platform. The AdvaBuild
Template Builder running on the HP-UX platform and the MOD 300 Configurator

322 3BUR002336R3701 RevA


Section 8 Output FCMS Analog Output FCM

views of this templet are essentially the same, although the user interface differs
slightly. Fields common to all Output FCMs are described in Parameters Common
To All Output FCMS on page 317. The fields unique to the Analog Output FCM are
described below.

Figure 58. Analog Output FCM Templet

SIGNAL INVERSION Field


This field indicates whether the output signal is inverted before it is sent to the I/O
module. For details, see INPUT SOURCE field in Parameters Common To All
Output FCMS on page 317.

3BUR002336R3701 RevA 323


Analog Output FCM Section 8 Output FCMS

Valid entries are:


YES invert the signal
NO do not invert the signal
Default is: NO
Mnemonic: REVERSE

ENGU OR PERCENT Field


This field specifies whether the FCM input is converted from engineering units or
percent. This determines which scaling equation is used to change input to counts.
For details see INPUT SOURCE field in Parameters Common To All Output FCMS
on page 317.
Valid entries are:
ENGU convert input from engineering units
PERCENT convert input from percent
Default is: PERCENT

COUNTS - LOWER BOUND Field


This field specifies the raw counts lower limit corresponding to the engineering
units lower bound. See INPUT SOURCE field in Parameters Common To All
Output FCMS on page 317, for the equations used to convert to counts.
Valid entry is an integer between 0 and 32767.
Default is: 750
Mnemonic: LO_COUNT

COUNTS - UPPER BOUND Field


This field specifies the raw counts upper limit corresponding to the engineering
units upper bound. See INPUT SOURCE field in Parameters Common To All
Output FCMS on page 317, for the equations used to convert to counts.
Valid entry is an integer between 0 and 32767.

324 3BUR002336R3701 RevA


Section 8 Output FCMS Analog Output FCM

Default is: 3750


Mnemonic: HI_COUNT

ENGU - LOWER BOUND Field


This field specifies the lower limit of the engineering units range. See INPUT
SOURCE field in Parameters Common To All Output FCMS on page 317 for
conversion equations.
Valid entry is a decimal number.
Default is: PROCESS LO (entry made in the LO ENG. UNIT LIMIT field of
the Loop Definition Templet that is the parent of this FCM templet)
Mnemonic: LO_CONV

ENGU - UPPER BOUND Field


This field specifies the upper limit of the engineering units range. See the
description of the INPUT SOURCE field in Parameters Common To All Output
FCMS on page 317, for equations used to convert to counts.
Valid entry is a decimal number.
Default is: PROCESS HI (entry made in the HI ENG. UNIT LIMIT field of the
Loop Definition Templet that is the parent of this FCM templet)
Mnemonic: HI_CONV

CHANNEL PATH
This field is only available when using the AdvaBuild Templet Builder to configure
the Analog Output FCM. An entry is required in this field if the entry in the
VENDOR TYPE field is either S800 I/O or PROFIBUS I/O.
For S800 I/O, this field is used to specify the LAN, station, cluster, position, and
channel of the I/O point in the following format:
LAN.station.cluster.position.channel
For example, an entry of 1.10.0.4.10 indicates that the S800 I/O point is on LAN 1,
station 10, cluster 0, position 4, channel 10.

3BUR002336R3701 RevA 325


Digital Output FCM Section 8 Output FCMS

For PROFIBUS I/O, this field is used to specify the LAN, device, module, and
channel of the I/O point in the following format:
LAN.device.module.channel
For example, an entry of 1.2.5.1 indicates that the Profibus I/O point is on LAN 1,
device 2, module 5, channel 1.

UNDER RANGE COUNTS Field and OVER RANGE COUNTS Field


These fields indicate the lowest and highest count values that can be output. See the
description of the INPUT SOURCE field in Parameters Common To All Output
FCMS on page 317.
Valid entries are integers between 0 and 4095.
Default for the UNDER RANGE COUNTS field is:0
Default for the OVER RANGE COUNTS field is:4095

Digital Output FCM


A Digital Output FCM sends digital signals to up to 16 contiguous digital channels
in the Multibus I/O and Controller Subsystems. Figure 59 shows an example of the
Digital Output FCM Templet from the AdvaBuild Templet Builder running on the
Windows platform. The AdvaBuild Template Builder running on the HP-UX
platform and the MOD 300 Configurator views of this templet are essentially the
same, although the user interface differs slightly.

326 3BUR002336R3701 RevA


Section 8 Output FCMS Digital Output FCM

Figure 59. Digital Output FCM Templet

NUMBER OF POINTS Field


This field specifies the number of output signals to send. If this field is left at its
default value, 1, only the first output is sent. If the entry in this field is changed to a
value greater than 1, outputs are sent to the specified channel and to contiguous
channels.
For example, if 5 is entered, the software sends outputs to the channel specified by
the CHANNEL NUMBER field and to the next 4 contiguous channels.
Valid entry is an integer between 1 and 16.
Default is: 1
Mnemonic: NUM_CON

3BUR002336R3701 RevA 327


Pulse Duration Output FCM Section 8 Output FCMS

INVERTED OUTPUTS Field


This field makes modifications to the bit patterns output by the Digital Output FCM.
Valid entry is a decimal number translated into binary bit positions, specifying
which bits are inverted
Default is: 0 (no inversion)
Mnemonic: INV_INP

CHANNEL PATH
This field is only available when using the AdvaBuild Templet Builder to configure
the Digital Output FCM. An entry is required in this field if the entry in the
VENDOR TYPE field is either S800 I/O or PROFIBUS I/O.
For S800 I/O, this field is used to specify the LAN, station, cluster, position, and
channel of the I/O point in the following format:
LAN.station.cluster.position.channel
For example, an entry of 1.10.0.4.10 indicates that the S800 I/O point is on LAN 1,
station 10, cluster 0, position 4, channel 10.
For PROFIBUS I/O, this field is used to specify the LAN, device, module, and
channel of the I/O point in the following format:
LAN.device.module.channel
For example, an entry of 1.2.5.1 indicates that the Profibus I/O point is on LAN 1,
device 2, module 5, channel 1.

Pulse Duration Output FCM


The Pulse Duration Output FCM sends a signal pulse, measured in milliseconds, to
the field each time it is processed. The duration of the pulse is proportional to the
result of the FCM.
CCF calculates the pulse duration as follows:
1. The input to the Pulse Duration Output FCM is the result of the FCM specified
in the INPUT SOURCE field. The input is assumed in percent.

328 3BUR002336R3701 RevA


Section 8 Output FCMS Pulse Duration Output FCM

2. The input is converted into a number of counts. The scaling factor for the
conversion is the entry in the COUNT - UPPER BOUND field. The counts
correspond to an input of 100%.
For example, if the entry in the COUNTS - UPPER BOUND field is 5000, an
input of 50% is converted to 2500 counts, and an input of 80% is converted to
4000 counts.
3. The number of counts becomes the result of the FCM.
4. The result is sent to the output modules of the Controller or Multibus I/O
Subsystem where it is rounded to a multiple of the basic pulse rate.
5. The rounded value becomes the duration of the pulse which is output at the
channel specified in the CHANNEL NUMBER field of the FCM templet.
Figure 60 shows an example of the Pulse Duration Output FCM Templet from the
AdvaBuild Templet Builder running on the Windows platform. The AdvaBuild
Template Builder running on the HP-UX platform and the MOD 300 Configurator
views of this templet are essentially the same, although the user interface differs
slightly.

3BUR002336R3701 RevA 329


Pulse Duration Output FCM Section 8 Output FCMS

Figure 60. Pulse Duration Output FCM Templet

COUNTS - UPPER BOUND Field


This field defines the length for the pulse duration to treat as 100% of range.
Valid entry is an integer for the pulse duration in milliseconds.
Default is: 100
Mnemonic: HI_COUNT

CHANNEL PATH
This field is only available when using the AdvaBuild Templet Builder to configure
the Pulse Duration Output FCM. An entry is required in this field if the entry in the
VENDOR TYPE field is either S800 I/O or PROFIBUS I/O.

330 3BUR002336R3701 RevA


Section 8 Output FCMS Pulse Train Output FCM

For S800 I/O, this field is used to specify the LAN, station, cluster, position, and
channel of the I/O point in the following format:
LAN.station.cluster.position.channel
For example, an entry of 1.10.0.4.10 indicates that the S800 I/O point is on LAN 1,
station 10, cluster 0, position 4, channel 10.
For PROFIBUS I/O, this field is used to specify the LAN, device, module, and
channel of the I/O point in the following format:
LAN.device.module.channel
For example, an entry of 1.2.5.1 indicates that the Profibus I/O point is on LAN 1,
device 2, module 5, channel 1.

Pulse Train Output FCM


The result of the Pulse Train Output FCM becomes the number of pulses in a pulse
train emitted at a pulse output channel. The following is used to determine the
number of pulses:
1. The input to the Pulse Train Output FCM is the result of the FCM specified in
the INPUT SOURCE field. The input is assumed in percent.
2. The input is converted into a number of counts. The scaling factor for the
conversion is the entry in the COUNTS - UPPER BOUND field which
specifies the counts corresponding to an input of 100%.
For example, if the entry in the COUNTS - UPPER BOUND field is 50, an
input of 50% is converted to 25 counts, and an input of 80% is converted to 40
counts.
3. The number of counts becomes the result of the FCM.
4. The result determines the number of pulses in a pulse train emitted at the
channel specified in the CHANNEL NUMBER field. The channel must have
been configured for pulse train output on the Controller or Multibus I/O
Templet.
Figure 61 shows an example of the Pulse Train Output FCM Templet.

3BUR002336R3701 RevA 331


Pulse Train Output FCM Section 8 Output FCMS

Figure 61. Pulse Train Output FCM Templet

COUNTS - UPPER BOUND Field


This field specifies the number of pulses treated as 100% of range.
Valid entry is an integer for the number of pulses. The pulse width and interval are
defined on the Controller I/O Templet for Controller Subsystems and the Multibus
I/O Templet for Multibus I/O Subsystems.
Default is: 100
Mnemonic: HI_COUNT

332 3BUR002336R3701 RevA


Section 9 Calculator FCMS

General Information
This section describes Calculator FCMs. Parameters are listed in Data Base Tables.
Math Related FCMs
Sum Of 4 Inputs FCM Natural Logarithm FCM
Subtraction FCM Exponentiation FCM
Multiplication FCM Polynomial FCM
Division FCM Absolute Value FCM
Average FCM
Scale Compensation FCMs
Modified Square Root FCM Scale Input FCM
Linearization FCM Flow Calculation FCM
Normalize FCM Temperature Compensation FCM
Inverse Normalize FCM Ratio/Bias FCM
Time Related FCMs
Time Derivative FCM Dead Time FCM
Time Integration FCM Dead Time Compensation FCM
First Order Filter FCM Timer FCM
Totalizer FCM Counter FCM
Lead/Lag Filter FCM Delay Timer FCM

3BUR002336R3701 RevA 333


Items Common To All Calculator FCMS Section 9 Calculator FCMS

Logic FCMs
Logical AND FCM Exclusive OR FCM
Logical OR FCM Set/Reset Flip-flop FCM
Logical NOT FCM Real Compare FCM
Miscellaneous FCMs
Selector FCM User Calculations FCM
Put Generic Value FCM Data Entry FCM
Get Generic Value FCM String FCM
Select Next FCM User Math Block FCM
Redundant Signal Selector FCM MOD30_MOD300_MAP
Input Limiter FCM

Items Common To All Calculator FCMS


Each Calculator FCM has a corresponding configuration templet. Many items on
the templets are common to all Calculator FCMs. Some of these items are
automatically filled in by the system for your reference. Other items are
configurable by you.

Common Configurable Fields for Calculator FCMs


Figure 62 shows a typical Calculator FCM Templet.

334 3BUR002336R3701 RevA


Section 9 Calculator FCMS Common Configurable Fields for Calculator FCMs

Figure 62. Example of a Calculator FCM Templet

The following describes the common fields of FCM templets.

TEMPLET NAME Field


The TEMPLET NAME is the name of this FCM. It is assigned via the FCMs parent
Loop Definition Templet. It has two parts and is in the format: tag.fcmname
where:
tag is the tag of the loop
fcmname is a 3-character identifier. Each FCM type has a default name. Only
one FCM of a given type in a loop can use the default because
FCMs in the same loop can not use the same name

For Data Entry FCMs, four fcmnames have been reserved for
System Performance Data: SYS, MEM, ME1, STK. SYS contains
system and CCF loading information. MEM and ME1 contain
memory pool information. STK contains CCF stack usage data.

3BUR002336R3701 RevA 335


Common Configurable Fields for Calculator FCMs Section 9 Calculator FCMS

For example, TC100.DIV indicates that the FCM performs division (DIV) in loop
TC100.
The TEMPLET NAME field on a FCM Templet is defined when the parent Loop
Definition Templet is configured. The procedure for configuring the Loop
Definition Templet is described in the System Configurator User's Guide.
Mnemonic: FCM_ID is the mnemonic of the FCM name part of this field. It is
usually a key to the data base relation containing the FCM parameters.

PARENT NAME Field


The PARENT NAME field is the name of the parent Loop Definition Templet. It is
filled in by the system. Example: TC100

COMMENT Field
Any appropriate description.

TEMPLET TYPE Field


The TEMPLET TYPE is the type of algorithm for the FCM. It is filled in by the
system.
Example: DIVISION

DATABASE NAME Field


This field identifies the data base where the templet resides. It is filled in by the
system.

INPUT SOURCE or INPUT SOURCE 1 Field


This field specifies the source of the first or the only input for the FCM.
Valid entries are:
PREVIOUS FCM result of the previous FCM in the loop is the input
.fcmname result of another FCM in the loop is the input
tag.fcmname result of an FCM from another loop is the input

336 3BUR002336R3701 RevA


Section 9 Calculator FCMS Common Configurable Fields for Calculator FCMs

Default: PREVIOUS FCM


Mnemonic: INPUT_1

INITIAL MODE Field


The INITIAL MODE field specifies the initial output mode at start-up.
Valid entries are:
MAN start in the Manual mode
AUTO start in the Auto mode
Default: AUTO
Mnemonic: INITMODE

INITIAL OUTPUT Field


The INITIAL OUTPUT field specifies the output value (result) of the FCM at start-
up.
Valid entry is a decimal value.
Default: 0.0
Mnemonic: INIT_OUT

BAD INPUTS ACCEPTED? Field


The BAD INPUTS ACCEPTED? field specifies whether an input with bad data
quality should be treated as if the data quality were good.
Valid entries are:
YES accept both good and bad inputs
NO accept good inputs only
Default: NO
Mnemonic: WORST_DQ

3BUR002336R3701 RevA 337


Common Non-configurable Parameters Section 9 Calculator FCMS

Common Non-configurable Parameters


The following non-configurable parameters are common to most of the Calculator
FCMs.

DATAQUAL Parameter
The DATAQUAL parameter indicates the data quality of the RESULT parameter of
the FCM.
State values are:
0 data quality is bad
1 data quality is good
There are no state mnemonics available for TCL.

DEVLPNUM Parameter
The DEVLPNUM parameter specifies the node/loop number. This is a unique
number assigned by the system to the loop containing the FCM. You can access it
by tag access methods. This value is important if you are using relational access to
acquire values from the FCM. It is a key to the relation containing the FCM
parameters. Relational access is performed via the Put Generic Value and Get
Generic Value FCMs described in Put Generic Value FCM on page 454, and Get
Generic Value FCM on page 458, respectively. The descriptions of the high level
VAX interface functions in the Taylor™ VAX/VMS™ Interface User's Guide also
provide information about relational access.
There are no state values nor state mnemonics available for TCL for this parameter.

FCM_MODE Parameter
This parameter specifies if the FCM is on or off.
State values are:
0 FCM is off
1 FCM is on
State mnemonics available for TCL are:OFF, ON

338 3BUR002336R3701 RevA


Section 9 Calculator FCMS Conditions for Changing the Values of Data Base Parameters

INIT_FLG Parameter
This parameter specifies if the initialization flag parameter is set at normal or
initialize. When it is set at initialize the FCM goes through its initialization routines.
State values are:
0 initialization flag is set at normal
1 initialization flag is set at initialize
There are no state mnemonics available for TCL.

OUT_MODE Parameter
This parameter specifies if the output mode of the FCM is set at manual or auto.
State values are:
0 output mode is Manual (When a Calculator FCM is in the Manual
output mode, the result is entered by an engineer via the Loop/FCM
Display, by a supervisory program, or by a PUT FCM.)
1 output mode is Auto (the algorithm of the FCM determines the
result)
State mnemonics available for TCL are:MANUAL, AUTO

RESULT Parameter
This parameter specifies the result of the FCM calculations. There are no state
values nor state mnemonics available for TCL for this parameter.

Conditions for Changing the Values of Data Base Parameters


Certain parameters in the data base are only changed via the Operator Station or
Multibus-based console or a supervisory program if specific conditions are met. The
rules (dependencies) described here apply to all Calculator FCMs. Some FCMs
have additional rules as described in the applicable section for that FCM.

3BUR002336R3701 RevA 339


Format Of The Calculator FCM Descriptions Section 9 Calculator FCMS

RESULT Parameter
The result of a Calculator FCM is changed if the OUT_MODE parameter is
Manual (0).

OUT_MODE Parameter
The OUT_MODE of a Calculator FCM is only changed to MANUAL (0) or
AUTO (1).

Format Of The Calculator FCM Descriptions


The descriptions of the individual Calculator FCMs have a standard format as
described below.
• Purpose gives a short summary of the FCM's function.
• Default Name, Algorithm Type, and Relation sections list the default name
used on the templet, algorithm type, data base relation name, and keyset for the
data base relation.
The default name and the algorithm type are useful when configuring the FCM
and its parent loop. This procedure is described in System Configurator User's
Guide.
The relation name and its keyset are used when performing relational access of
the FCM's data base parameters. This type of access is used by the Put Generic
Value and Get Generic Value FCMs. It is also used by Ethernet™ Interface high
level functions.
• Algorithm gives the equation performed when the FCM is processed. The
default equation is shown, where applicable.
• Configurable Templet Field Parameters describes each configurable
parameter.
• Non-configurable Data Base Parameters describes each non-configurable
parameter. These are parameters defined by the system and you cannot change
them.
• Tuning and Logging describes a subset of FCM parameters. The information

340 3BUR002336R3701 RevA


Section 9 Calculator FCMS Format Of The Calculator FCM Descriptions

is presented in table format shown in Table 16.

Table 16. Format of a Tuning and Logging Table

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD1_K1 through RDK1-K4 YES YES
(Constant 1 through Constant 4)

A YES in the LOGABLE column of the table means changes to the


parameter's value during runtime are subject to being printed in the alarm/event
log. Logging occurs if the proper configuration/programming activities are
done. The activities include:
• To log changes by operator or engineer at an Operator Station or a Multibus-
based console, a logging printer must be configured to log CCF event messages
from the node or subnode containing the FCM. See System Configurator User's
Guide.
• To log changes by a TCL program running in the node or subnode containing
the FCM, a logging printer must be configured to log CCF event messages
from the node or subnode containing the FCM. See System Configurator User's
Guide.
The program must also have executed an UPDATEON statement prior to
making the parameter changes being logged, as described in Taylor™ Control
Language (TCL) User’s Guide.
• To log changes by a program running on a host computer connected to the
MOD System via a Gateway Subsystem, a logging printer must be configured
to log CCF event messages from the node or subnode containing the FCM. See
System Configurator User's Guide.

3BUR002336R3701 RevA 341


Tuning and Logging Tables for Calculator FCMs Section 9 Calculator FCMS

The program must also use a user ID that enables logging. These user IDs are
entered via the SET_USRID function described in Taylor™ VAX/VMS™
Interface User's Guide.
A YES in the TUNABLE FROM LOOP/FCM DISPLAY column of the
table means a user with engineer privileges can tune (change) the parameter
from the Loop/FCM Display during runtime. For instructions on the
Loop/FCM Display see Appendix D, Autotune.
• Discussion is provided when the FCM requires further explanation.

Tuning and Logging Tables for Calculator FCMs


Table 17. Tuning and Logging Parameters for Sum of 4 Inputs, Average, and
Polynomial FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD1_K1 through RDK1-K4 YES YES
(Constant 1 through Constant 4)

342 3BUR002336R3701 RevA


Section 9 Calculator FCMS Tuning and Logging Tables for Calculator FCMs

Table 18. Tuning and Logging Parameters for Subtraction, Division, Natural
Logarithm and Exponentiation FCMs

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD1_K1 and RD1_K2 YES YES
(Constant 1 and Constant 2)

Table 19. Tuning and Logging Parameters for Multiplication FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD1_K1 (Constant 1) YES YES

3BUR002336R3701 RevA 343


Tuning and Logging Tables for Calculator FCMs Section 9 Calculator FCMS

Table 20. Tuning and Logging Parameters for Absolute Value, Linearization, Flow
Calculation, First Order Filter, Lead/Lag Filter, Dead Time, Dead Time
Compensation, Timer, Delay Timer, Logical AND, Logical OR, Logical NOT,
Exclusive OR, Set/Reset Flip-Flop, Selector, Get Generic Value, and Redundant
Signal Selector FCMs

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES

Table 21. Tuning and Logging Parameters for Modified Square Root FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
HI_ENGU (High Engineering Units) YES YES
LO_ENGU (Low Engineering Units) YES YES

344 3BUR002336R3701 RevA


Section 9 Calculator FCMS Tuning and Logging Tables for Calculator FCMs

Table 22. Tuning and Logging Parameters for Normalize and Inverse Normalize
FCMs

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD0_K1 (Low Range) YES YES
RD1_K2 (High Range) YES YES
RD1_K3 (Scaling Factor) YES YES

Table 23. Tuning and Logging Parameters for Scale Input FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD0_K1 (Old Low Range) YES YES
RD1_K2 (Old High Range) YES YES
RD0_K4 (New Low Range) YES YES
RD1_K3 (New High Range) YES YES

3BUR002336R3701 RevA 345


Tuning and Logging Tables for Calculator FCMs Section 9 Calculator FCMS

Table 24. Tuning and Logging Parameters for Temperature Compensation FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD0_K2 (Des Temp Constant) YES YES
RD1_K1 (Flow Constant) YES YES
RD1_K3 (Den vs. Temp Constant) YES YES

Table 25. Tuning and Logging Parameters for Ratio/Bias FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD0_K1 (Local Bias) YES YES
RD1_K2 (Local Ratio) YES YES

346 3BUR002336R3701 RevA


Section 9 Calculator FCMS Tuning and Logging Tables for Calculator FCMs

Table 26. Tuning and Logging Parameters for Time Derivative and Time
Integration FCMs

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD1_K1 (Constant) YES YES

Table 27. Tuning and Logging Parameters for Totalizer FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD1_K1 (Scale Factor) YES YES

Table 28. Tuning and Logging Parameters for Counter FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES

3BUR002336R3701 RevA 347


Tuning and Logging Tables for Calculator FCMs Section 9 Calculator FCMS

Table 28. Tuning and Logging Parameters for Counter FCM (Continued)

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RD1_K1 (Time Units YES YES
LO_LIMIT (Lower Time Limit) YES YES
HI_LIMIT (Upper Time Limit) YES YES

Table 29. Tuning and Logging Parameters for Real Compare and Select Next
FCMs

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD1_K1 (Compensation Constant) YES YES

Table 30. Tuning and Logging Parameters for Put Generic Value FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
RD1_K1 (Constant to Put) YES YES

348 3BUR002336R3701 RevA


Section 9 Calculator FCMS Tuning and Logging Tables for Calculator FCMs

Table 31. Tuning and Logging Parameters for Input Limiter FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
LO_LIMIT YES YES
HI_LIMIT YES YES

Table 32. Tuning and Logging Parameters for User Calculations FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES
DATA1–DATA4 YES YES

Table 33. Tuning and Logging Parameters for Data Entry FCM

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
DATA1–DATA15 YES YES
DATA16–DATA20 NO NO

3BUR002336R3701 RevA 349


Sum Of 4 Inputs FCM Section 9 Calculator FCMS

Sum Of 4 Inputs FCM


Purpose
This FCM finds the sum of up to 4 input signals, each with an optional scaling
constant.

Default Name, Algorithm Type, and Relation


The default name for Sum of 4 Inputs FCM is ADD. The algorithm is
SUM_OF_4_INPUTS. The FCM is listed on the menu on the Loop Definition
Templet by selecting the MATH softkey.
The data base relation is SUM4_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Sum of 4 Inputs FCM is:
Result = (K1 * inp1) + (K2 * inp2) + (K3 * inp3) + (K4 * inp4)
where
inp1 (INPUT SOURCE 1) through inp4 (INPUT SOURCE 4) are the current
values of the input signals
K1 (CONSTANT 1) through K4 (CONSTANT 4) are the scaling factors; where
K1 is the factor for inp1, and so on
The default version of the algorithm is:
Result = (1 * PREVIOUS FCM)

Configurable Parameters
The Sum of 4 Inputs FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

INPUT SOURCE 2 through 4 Fields


These fields specify the sources of inputs 2 through 4 for the FCM.

350 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Valid entries are:


.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There are no defaults.
Mnemonics: INPUT_2 for INPUT SOURCE 2
INPUT_3 for INPUT SOURCE 3
INPUT_4 for INPUT SOURCE 4

CONSTANT 1 through 4 Fields


These fields specify the values of the constants.
Valid entry is any number
Defaults are: 1.0 for CONSTANT 1
0.0 for CONSTANT 2 through 4
Mnemonics: RD1_K1 for CONSTANT 1
RD1_K2 for CONSTANT 2
RD1_K3 for CONSTANT 3
RD1_K4 for CONSTANT 4

Non-configurable Data Base Parameters


The non-configurable parameters for Sum of 4 Inputs FCMs and are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 17 lists parameters having special runtime features for Sum of 4 Inputs FCMs.

Discussion
The terms of the algorithm are set to their default values in a reasonable manner.
You can elect to make a term into a constant by specifying the scaling constant and
not the input. For example, to set up the equation:
3 * inp1 + 6

3BUR002336R3701 RevA 351


Subtraction FCM Section 9 Calculator FCMS

you need only to set K1 at 3, define a source for inp1 and set K2 at 6, respectively.

Subtraction FCM
Purpose
This FCM subtracts one input from another. You can use constant factors to scale
the inputs.

Default Name, Algorithm Type, and Relation


The default name for the Subtraction FCM is SUB. The algorithm is
SUBTRACTION. The FCM is listed on the menu on the Loop Definition Templet
by selecting the MATH softkey.
The data base relation is DPQ_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Subtraction FCM is:
Result = (K1 * inp1) - (K2 * inp2)
where
inp1 (INPUT SOURCE 1) and inp2 (INPUT SOURCE 2) are the current input
signal values
K1 (CONSTANT 1) and K2 (CONSTANT 2) are the scaling factors; where K1 is
the factor for inp1, and so on
The default version of the algorithm is:
Result = (1 * PREVIOUS FCM) - (1 * 1)

Configurable Parameters
The Subtraction FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

352 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

INPUT SOURCE 2 Field


This field specifies the source of input 2 for the FCM.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.
Mnemonic: INPUT_2

CONSTANT 1 and 2 Fields


CONSTANT 1 and 2 fields specify the values for the constants.
Valid entry is any number.
Default is: 1.0
Mnemonics: RD1_K1 for CONSTANT 1
RD1_K2 for CONSTANT 2

Non-configurable Data Base Parameters


The non-configurable parameters for the Subtraction FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 18 contains a list of parameters having special runtime features for
Subtraction FCMs.

Discussion
The terms of the algorithm are set to appropriate default values. You can make a
term into a constant by specifying the scaling constant and not the input. If there is
no entry in either the INPUT SOURCE 1 or INPUT SOURCE 2 field, the algorithm
uses a value of 1 for the respective input.

3BUR002336R3701 RevA 353


Multiplication FCM Section 9 Calculator FCMS

Multiplication FCM
Purpose
This FCM calculates the product of two inputs. You can also use constants to scale
the product.

Default Name, Algorithm Type, and Relation


The default name for the Multiplication FCM is MUL. The algorithm is
MULTIPLICATION. The FCM is listed on the menu of the Loop Definition
Templet by selecting the MATH softkey.
The data base relation is DPQ_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Multiplication FCM is:
Result = K * inp1 * inp2
where
inp1 (INPUT SOURCE 1) and inp2 (INPUT SOURCE 2) are the current
values of the input signals
K (CONSTANT 1) is the scaling factor
The default version of the algorithm is:
Result = 1 * PREVIOUS FCM * 1

Configurable Parameters
The Multiplication FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

CONSTANT 1 Field
This field specifies the value for constant 1.

354 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Valid entry is any number.


Default is: 1.0
Mnemonic: RD1_K1

INPUT SOURCE 2 Field


This field specifies the source of input 2 for the FCM.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.
Mnemonic: INPUT_2

Non-configurable Data Base Parameters


The non-configurable parameters for the Multiplication FCMs and are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 19 lists parameters having special runtime features for Multiplication FCMs.

Discussion
The terms of the algorithm are set to appropriate default values. You can make a
term into a constant by specifying the scaling constant and not the input.

Division FCM
Purpose
This FCM calculates the quotient of two input signals. You can also use constant
factors to scale the quotient.

3BUR002336R3701 RevA 355


Default Name, Algorithm Type, and Relation Section 9 Calculator FCMS

Default Name, Algorithm Type, and Relation


The default name for the Division FCM is DIV. The algorithm is DIVISION. The
FCM is listed on the menu on the Loop Definition Templet by selecting the MATH
softkey.
The data base relation is DPQ_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Division FCM is:

K 1  inp1
""Result = ------------------------
K 2  inp2

where
inp1 (INPUT SOURCE 1) and inp2 (INPUT SOURCE 2) are the current
values of the input signals
K1 (CONSTANT 1) and K2 (CONSTANT 2) are the scaling factors
The default version of the algorithm is:

1  PREVIOUS FCM
Result = ----------------------------------------------------
11

Configurable Parameters
The Division FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

INPUT SOURCE 2 Field


This field specifies the source of input 2 for the FCM.

356 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Valid entries are:


.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.
Mnemonic: INPUT_2

CONSTANT 1 and 2 Fields


These fields specify the values for the constants.
Valid entry is any number
Default is: 1.0
Mnemonics: RD1_K1 for CONSTANT 1
RD1_K2 for CONSTANT 2

Non-configurable Data Base Parameters


The non-configurable parameters for the Division FCM are described in Common
Non-configurable Parameters on page 338.

Tuning and Logging


Table 18 contains a list of parameters having special runtime features for Division
FCMs.

Discussion
The terms of the algorithm are set to appropriate default values. You can make a
term into a constant by specifying the scaling constant and not the input.
If the values of inp1 and inp2 are both 0.0, the result is set to 0.0. If inp1 is not 0.0
and inp2 is 0.0, the data quality of the result is set to BAD.

3BUR002336R3701 RevA 357


Average FCM Section 9 Calculator FCMS

Average FCM
Purpose
This FCM finds the arithmetic average of up to 4 inputs. You can use constant
factors to scale the inputs.

Default Name, Algorithm Type, and Relation


The default name for the Average FCM is AVG. The algorithm is AVERAGE. The
FCM is listed on the menu on the Loop Definition Templet by selecting the MATH
softkey.
The data base relation is IAVG_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Average FCM is:
 K 1  inp1  +  K 2  inp2  +  K 3  inp3  +  K 4  inp4 
Result = -----------------------------------------------------------------------------------------------------------------------------------------
N
where
inp1 (INPUT SOURCE 1) to inp4 (INPUT SOURCE 4) are the current input
values
K1 (CONSTANT 1) through K4 (CONSTANT 4) are the scaling factors; where
K1 is the factor for inp1, and so on
N is the number (1 to 4) of the inputs being used
The default version of the algorithm is:
 1  PREVIOUS FCM  +  1  1  +  1  1  +  1  1 
Result = --------------------------------------------------------------------------------------------------------------------------------
4

Configurable Parameters
The Average FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

INPUT SOURCE 2 through 4 Fields


These fields specify the sources of inputs 2 through 4 for the FCM.

358 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Valid entries are:


.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.
Mnemonics: INPUT_2, INPUT_3, INPUT_4

CONSTANT 1 through 4 Fields


These fields specify the values for the constants.
Valid entry is any number.
Default is: 1.0
Mnemonics: RD1_K1 for CONSTANT 1
RD1_K2 for CONSTANT 2
RD1_K3 for CONSTANT 3
RD1_K4 for CONSTANT 4

MINIMUM # INPUTS Field


This field specifies the minimum number of inputs that must have a data quality of
GOOD for the algorithm to calculate.
Valid entries are 2, 3, 4 or ALL INPUTS.
Default is: ALL INPUTS
Mnemonic: MIN_INP

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the
Average FCM.

3BUR002336R3701 RevA 359


Tuning and Logging Section 9 Calculator FCMS

INP1ENAB through INP4ENAB Parameters


The terms in the algorithm (K1 * inp1, and so on) are enabled and disabled from
TCL programs by using these parameters. These parameters turn on and turn off
their respective terms.
State values are:
0 respective input is disabled
1 respective input is enabled
State mnemonics available for TCL are:DISABLED, ENABLED

Tuning and Logging


Table 17 contains a list of parameters having special runtime features for Average
FCMs.

Discussion
The terms of the algorithm are set to default values. You can make a term into a
constant by specifying the scaling constant and not the input. The MINIMUM #
INPUTS parameter specifies the number of inputs needing a GOOD data quality for
the algorithm to calculate.

Natural Logarithm FCM


Purpose
This FCM calculates a scaled natural logarithm for an optionally scaled input signal.

Default Name, Algorithm Type, and Relation


The default name for Natural Logarithm is LOG. The algorithm is
NATURAL_LOGARITHM. The FCM is listed on the menu on the Loop Definition
Templet by selecting the MATH softkey.
The data base relation is LOG_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

360 3BUR002336R3701 RevA


Section 9 Calculator FCMS Algorithm

Algorithm
The algorithm for the Natural Logarithm FCM is:
Result = K1 * In (K2 * inp)
where
inp (INPUT SOURCE 1) is the input signal
In is the mathematical symbol for natural logarithm
K1 (CONSTANT 1) is the scaling factor for the log of the product of K2 and the
input signal
K2 (CONSTANT 2) is the scaling factor for the input signal
The default version of the algorithm is:
Result = 1 * In (1 * PREVIOUS FCM)

Configurable Parameters
The Natural Logarithm FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

CONSTANT 1 and 2 Fields


These fields specify the values for the constants.
Valid entry is any number.
Default is: 1.0
Mnemonics: RD1_K1 for CONSTANT 1
RD1_K2 for CONSTANT 2

Non-configurable Data Base Parameters


The DATAQUAL, DEVLPNUM, FCM_MODE, INIT_FLG, OUT_MODE and
RESULT are applicable to Natural Logarithm FCMs and are described in Common
Non-configurable Parameters on page 338.

3BUR002336R3701 RevA 361


Tuning and Logging Section 9 Calculator FCMS

Tuning and Logging


Table 18 has a list of parameters having special runtime features for Natural
Logarithm FCMs.

Discussion
If the product of K2 and inp is less than or equal to 0, the data quality goes bad (that
is, an illegal log of zero or a negative number).

Exponentiation FCM
Purpose
This FCM raises one input signal to a power determined by another input signal.
You can use an optional constant to scale each input.

Default Name, Algorithm Type, and Relation


The default name for the Exponentiation FCM is EXP. The algorithm is
EXPONENTIATION. The FCM is listed on the menu on the Loop Definition
Templet by selecting the MATH softkey.
The data base relation is EXPI_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Exponentiation FCM is:
Result = (K * inp1) (K2 * inp2)
1

where
inp1 (INPUT SOURCE 1) and inp2 (INPUT SOURCE 2) are the current
values of the input signals
K1 (CONSTANT 1) and K2 (CONSTANT 2) are the scaling factors; where K1 is
the factor for inp1, and so on
The default version of the algorithm is:

362 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

Result = (1 * PREVIOUS FCM) (1 * 1)

Configurable Parameters
The Exponentiation FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

CONSTANT 1 and 2 Fields


These fields specify the values for the constants.
Valid entry is any number
Default is: 1.0
Mnemonics: RD1_K1 for CONSTANT 1
RD1_K2 for CONSTANT 2

INPUT SOURCE 2 Field


This field specifies the source of input 2 for the FCM. The input must be in
engineering units.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.
Mnemonic: INPUT_2

Non-configurable Data Base Parameters


Non-configurable parameters for the Exponentiation FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 18 lists parameters having special runtime features for Exponentiation FCMs.

3BUR002336R3701 RevA 363


Discussion Section 9 Calculator FCMS

Discussion
The terms of the algorithm are set to appropriate default values. You can elect to
make a term into a constant by specifying the scaling constant and not the input.
If the inputs and scaling factors are chosen properly, a constant is raised to a
variable power or a variable may be raised to a constant power. This is commonly
used to find the square root of a number. Either or both the base and the exponent
can be negative. In certain cases, the result is the real part of a complex number.

Polynomial FCM
Purpose
This FCM allows for polynomial curve fitting linearization for up to a third order
fit.

Default Name, Algorithm Type, and Relation


The default name for the Polynomial FCM is PLY. The algorithm is
POLYNOMIAL. The FCM is listed on the menu on the Loop Definition Templet by
selecting the MATH softkey.
The data base relation is POLY_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Polynomial FCM is:
Result = K4 + (K3 * inp3) + (K2 * inp2) + (K1 * inp)
where
inp (INPUT SOURCE) is the input
K4 (CONSTANT 4) is the value of the result when the input is 0
K3 (CONSTANT 3) is the coefficient for the third power of the input
K2 (CONSTANT 2) is the coefficient for the second power of the input
K1 (CONSTANT 1) is the coefficient for the first power of the input

364 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

The default version of the algorithm is:


Result = 0 + (1 * PREVIOUS FCM3) + (1 * PREVIOUS FCM2) + (1 *
PREVIOUS FCM)

Configurable Parameters
The Polynomial FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

CONSTANT 1 through 4 Fields


These fields specify the values for the constants.
Valid entry is any number.
Default is: 1.0 for K1 through K3,
0.0 for K4
Mnemonics: RD1_K1 for CONSTANT 1,
RD1_K2 for CONSTANT 2,
RD1_K3 for CONSTANT 3,
RD1_K4 for CONSTANT 4

Non-configurable Data Base Parameters


The non-configurable parameters for the Polynomial FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 17 lists parameters having special runtime features for Polynomial FCMs.

Absolute Value FCM


Purpose
This FCM calculates the absolute value of the input signal.

3BUR002336R3701 RevA 365


Default Name, Algorithm Type, and Relation Section 9 Calculator FCMS

Default Name, Algorithm Type, and Relation


The default name for the Absolute Value FCM is ABS. The algorithm is
ABSOLUTE_VALUE. The FCM is listed on the menu on the Loop Definition
Templet by selecting the MATH softkey.
The data base relation is ABSV_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Absolute Value FCM is:
If inp < 0, then result = -inp
If inp  0, then result = inp
where
inp (INPUT SOURCE 1) is the input
The default versions of the algorithm are:
If PREVIOUS FCM < 0, then result = -PREVIOUS FCM
If PREVIOUS FCM > 0, then result = PREVIOUS FCM

Configurable Parameters
The Absolute Value FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

Non-configurable Data Base Parameters


The non-configurable parameters for the Absolute Value FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 20 lists parameters with special runtime features for Absolute Value FCMs.

366 3BUR002336R3701 RevA


Section 9 Calculator FCMS Modified Square Root FCM

Modified Square Root FCM


Purpose
This FCM calculates the square root of its input for input values greater than 2.47%
of range. For input values less than 2.47%, including negative input values, the
result is calculated by the function described below. Figure 63 show a graph of this
function. Input to this FCM must be in percent, but you can scale the result in an
engineering units range configured for the FCM.
This FCM is often used in loops that get inputs from p transmitters that do not
have built-in square root extractors. Such loops usually have an Analog Input FCM
directly preceding the Modified Square Root FCM. The Analog Input FCM
acquires the input and converts it to percent. The Modified Square Root FCM
extracts the square root and scales the percent value into engineering units. For
examples of these loops see Controller Analog Input and Output Channels on page
83, and Analog Inputs in Multibus I/O Subsystems on page 118.

Default Name, Algorithm Type, and Relation


The default name for the Modified Square Root FCM is SQR. The algorithm is
MODIFIED_SQUARE_ROOT. The FCM is listed on the menu on the Loop
Definition Templet by selecting the SCALE COMPN softkey.
The data base relation f is MSQR_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The result is scaled in engineering units and is defined by the following equation:
Result = M * (HI - LO) + LO
where
HI is the high limit of the engineering unit range for scaling the result
LO is the low limit of the engineering unit range for scaling the result
inp- inp-
If 0 < -------- < 0.01, then M = --------
100 100
inp- inp-
 -------- 
If 0.01 < -------- < 0.0247, then M =  100 – 0.01  10 + 0.01
100

3BUR002336R3701 RevA 367


Algorithm Section 9 Calculator FCMS

inp-
If inp < 0.0247, then M = SQRT --------
100
When the input is negative, the FCM calculates the modified square root of the
absolute value of the input and multiplies the answer by -1. For example:
MSQR(-1) = -MSQR(1)

368 3BUR002336R3701 RevA


Section 9

16 160

3BUR002336R3701 RevA
14 140
Calculator FCMS

12 Actual Square 120


Root Curve
10 100

8 80 Result
Modified Curve
6 60

4 40

2 20
Detailed View Near Zero
-4 -2 -200 -180 -160 -140 -120 -100 -80 -60 -40 -20 Input

2 4 20 40 60 80 100 120 140 160 180 200


-2 -20

-4 -40

-6 -60

-8 -80

-10 -100

-12 -120

Figure 63. Modified Square Root Curve


-14 -140

-16 -160

369
Algorithm
Configurable Parameters Section 9 Calculator FCMS

Configurable Parameters
The Modified Square Root FCM has the following configurable fields in addition to
the fields described in Common Configurable Fields for Calculator FCMs on page
334.

HI ENG UNITS Field


This field specifies the high limit of the engineering units range.
Valid entry is any number.
Default is: PROCESS HI (value of HI ENG. UNIT LIMIT on Loop Definition
Templet)
Mnemonic: HI_ENGU

LO ENG UNITS Field


This field specifies the low limit of the engineering units range.
Valid entry is any number.
Default is: PROCESS LO (value of LO ENG. UNIT LIMIT on Loop
Definition Templet)
Mnemonic: LO_ENGU

Non-configurable Data Base Parameters


The non-configurable parameters for the Modified Square Root FCM are described
in Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 21 lists parameters having special runtime features for Modified Square Root
FCMs.

370 3BUR002336R3701 RevA


Section 9 Calculator FCMS Linearization FCM

Linearization FCM
Purpose
This FCM uses the table look-up method to linearize an input. The linearization
tables support thermocouples and RTDs (Resistance Temperature Devices) used by
the system. As an option, the FCM can linearize according to a table defined by you
via the Breakpoint Sets Templet. The result of this FCM is scaled in degrees C
(Celsius), F (Fahrenheit), K (Kelvin), or R (Rankine).
This FCM is usually preceded in a loop by an Analog Input FCM. For examples of
linearizing thermocouples and RTD inputs see Analog Inputs in Multibus I/O
Subsystems on page 118, Thermocouples in Multibus I/O Subsystems on page 126,
and RTDs in Multibus I/O Subsystems on page 139.

Default Name, Algorithm Type, and Relation


The default name for the Linearization FCM is LKP. The algorithm is
LINEARIZATION. The FCM is listed on the menu on the Loop Definition Templet
via the SCALE COMPN softkey.
The data base relation f is TABL_FCM. Keyset 1 for TABL_FCM is DEVLPNUM,
FCM_ID. When a user-defined linearization table is defined for the FCM, the table
values are held in the BREAKPT_SETS relation. Keyset 1 for BREAKPT_SETS is
BP_SET.

Algorithm
The input signal value is determined by standard straight-line interpolation from
tables.

Configurable Parameters
The Linearization FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

BREAKPOINT SET Field


An entry is only made to this field if the FCM uses a user-defined linearization
table. In this case, you must enter the name assigned to the set on the Breakpoint

3BUR002336R3701 RevA 371


Configurable Parameters Section 9 Calculator FCMS

Sets Templet defining the table. See Discussion on page 374.


Valid entry is set name.
Mnemonic: BP_SET

INVERSE AXIS? Field


This field specifies either normal or inverted axis.
Valid entries are:
NO do not invert axis (input value is the x value in the linearization
table, corresponding y value becomes the result)
YES invert axis (input value is the y value in the linearization table,
corresponding x value becomes the result)
Default is: NO
Mnemonic: INVERSE

TEMPERATURE SCALE Field


This field specifies the temperature scale in which the result of the FCM is scaled.
This field is ignored when a user-defined linearization table is specified via the
BREAKPOINT SET field.
Valid entries are:
C for degrees Celsius
K for degrees Kelvin
F for degrees Fahrenheit
R for degrees Rankine
Default is: F
Mnemonic: TEMPSCAL

COMPENSATION TYPE Field


This field specifies the type of junction compensation used by this FCM.

372 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

Valid entries are:


NONE no temperature compensation. This is always used when the
Linearization FCM is in a Controller Subsystem or when the
Linearization FCM is used for a non-thermocouple input in a
Multibus I/O Subsystem. This entry should also be specified when a
user-defined linearization table is used by the FCM.
COLD cold junction compensation. This is used when the FCM linearizes
a thermocouple input in a Multibus I/O Subsystem. See examples in
Thermocouples in Multibus I/O Subsystems on page 126.
HOT hot junction compensation. This is used when the FCM linearizes a
thermocouple input in a Multibus I/O Subsystem and the customer
supplies the needed equipment to implement the hot junction. For
examples see Thermocouples in Multibus I/O Subsystems on page
126.
Default is: NONE
Mnemonic: COMPTYPE

HOT COMP BIAS Field


This field specifies the temperature at which the thermocouple/termination panel
junction is maintained when hot junction compensation is used. See Thermocouples
in Multibus I/O Subsystems on page 126, Thermocouple Inputs with Hot Junction
Compensation.
Valid entry is the temperature of the junction.
Default is: 0.0
Mnemonic: HOT_BIAS

ELEMENT TYPE Field


This field specifies the type of temperature element.
Valid entries are:
B type B thermocouple

3BUR002336R3701 RevA 373


Non-configurable Data Base Parameters Section 9 Calculator FCMS

E type E thermocouple
J type J thermocouple
K type K thermocouple
N type N thermocouple
R type R thermocouple
S type S thermocouple
T type T thermocouple
DIN DIN type RTD
BURNS Burns type RTD
Default is: J
Mnemonic: FIX_SET

Non-configurable Data Base Parameters


The non-configurable parameters for the Linearization FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 20 a lists parameters having special runtime features for Linearization FCMs.

Discussion
User-defined Linearization Tables - Breakpoint Sets Templet
You can create custom linearization tables via the Breakpoint Sets Templet which is
a child of the CCF Templet. The table defined in Breakpoint Sets Templet is used by
any Linearization FCM in the node of the system containing the Breakpoint Sets
Templet.
The templet name is entered in the TEMPLET NAME field. The table name is
entered in the NAME OF SET field. The table is built by entering up to 11 X,Y pairs
in the edit window.

374 3BUR002336R3701 RevA


Section 9 Calculator FCMS Normalize FCM

To indicate that a Linearization FCM Templet uses a user-defined table, enter the
name assigned to the table in the NAME OF SET field of the Breakpoint Sets
Templet in the BREAKPOINT SET field of the Linearization FCM Templet. The
COMPENSATION TYPE field should be NONE and the TEMPERATURE SCALE
field is ignored.
Breakpoint sets are only used by Linearization FCMs in the subsystem (or control
module) containing the templet. A Linearization FCM in one Controller Subsystem
cannot access a Breakpoint Set Templet in another Controller Subsystem.

Normalize FCM
Purpose
This FCM normalizes a signal from an engineering unit scale to a dimensionless
zero-based scale. See the example in the Discussion segment of this description.

Default Name, Algorithm Type, and Relation


The default name for the Normalize FCM is NRM. The algorithm f is
NORMALIZE. The FCM is listed on the menu on the Loop Definition Templet by
selecting the SCALE COMPN softkey.
The data base relation is SCALING_FCM. Keyset 1 for the relation is
DEVLPNUM, FCM_ID.

Algorithm
The algorithm for the Normalize FCM is:

inp – K 1
Result =  --------------------  K 3
 K2 – K1 
where
inp (INPUT SOURCE) is the input
K1 (LOW RANGE) is the bottom of the engineering units range for the input
K2 (HI RANGE) is the top of the engineering units range for the input

3BUR002336R3701 RevA 375


Configurable Parameters Section 9 Calculator FCMS

K3 (SCALING FACTOR) is the top of the range for the result


The default version of the algorithm is:
PREVIOUS FCM – PROCESS LOW
Result =  ------------------------------------------------------------------------------------------
 PROCESS HI – PROCESS LOW 

Configurable Parameters
The Normalize FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

LOW RANGE Field


This field specifies low range value at the bottom of the engineering units range.
Valid entry is any number
Default is: PROCESS LO (value entered in the LO ENG. UNIT LIMIT field of
the Loop Definition Templet for the loop)
Mnemonic: RD0_K1

HI RANGE Field
This field specifies high range value at the top of the engineering units range.
Valid entry is any number
Default is: PROCESS HI (value entered in the HI ENG. UNIT LIMIT field of
the Loop Definition Templet for the loop)
Mnemonic: RD1_K2

SCALING FACTOR Field


This field specifies the scaling factor for the algorithm.
Valid entry is any number
Default is: 1.0
Mnemonic: RD1_K3

376 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Non-configurable Data Base Parameters


The non-configurable parameters for the Normalize FCM are described in Common
Non-configurable Parameters on page 338.

Tuning and Logging


Table 22 lists parameters having special runtime features for Normalize FCMs.

Discussion
This FCM changes an engineering units value to a percentage of a specified range.
For example, a signal is scaled in an engineering units range of 200 to 600 GPM. To
express the signal value on a scale of 0 to 100%, the algorithm should be configured
with the following values:
LOW RANGE (K1) = 200
HIGH RANGE (K2) = 600
SCALING (K3) = 100
The algorithm makes the conversion. For example, when the input signal is 360
GPM, the equation becomes:
360 – 200
Result =  ------------------------ 100 = 40
 600 – 200

Inverse Normalize FCM


Purpose
This FCM converts a value from a normalized, dimensionless, zero-based scale
(percentage) to a value on an engineering units scale. An example is provided in
Discussion on page 379.

Default Name, Algorithm Type, and Relation


The default name for Inverse Normalize is INR. The algorithm is
INVERSE_NORMALIZE. The FCM is listed on the menu on the Loop Definition
Templet by selecting SCALE COMPN. The data base relation is SCALING_FCM.
Keyset 1 for the relation is DEVLPNUM, FCM_ID.

3BUR002336R3701 RevA 377


Algorithm Section 9 Calculator FCMS

Algorithm
The algorithm for the Inverse Normalize FCM is:
inp
Result =  --------  K 3 – K 1  + K 1
 K2 
where
inp (INPUT SOURCE) is the input signal
K1 (LOW RANGE) is the bottom of range for the engineering units range of
the result
K2 (SCALING) is the top of range value for the input
K3 (HI RANGE) is the top of range value for the engineering units range of the
result

Configurable Parameters
The Inverse Normalize FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

LOW RANGE Field


This field specifies the low range value for the input signal.
Valid entry is any number.
Default is: 0.0
Mnemonic: RD0_K1

HI RANGE Field
This field specifies the top of range value for engineering units range of the result.
Valid entry is any number.
Default is: 100.0
Mnemonic: RD1_K3

378 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

SCALING Field
This field specifies the scaling factor.
Valid entry is any number.
Default is: 100.0
Mnemonic: RD1_K2

Non-configurable Data Base Parameters


The non-configurable parameters for the Inverse Normalize FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 22 lists parameters having special runtime features for Inverse Normalize
FCMs.

Discussion
For example, a signal is expressed in a dimensionless scale of 0 to 100. It is desired
to convert the signal values to an engineering units range of 200 to 600. To do so,
the algorithm should be configured with the following values: K1 = 200, K2 = 100,
K3 = 600. The algorithm can then make the conversion.
For example, when the input value is 40, the equation becomes:
40
Result = ---------  600 – 200  + 200 = 360
100

Scale Input FCM


Purpose
This FCM converts a value from one engineering unit scale to its corresponding
value in another engineering unit scale. See the example in the Discussion segment
of this description.

3BUR002336R3701 RevA 379


Default Name, Algorithm Type, and Relation Section 9 Calculator FCMS

Default Name, Algorithm Type, and Relation


The default name for Scale Input FCM is SCL. The algorithm is SCALE_INPUT.
The FCM is listed on the menu on the Loop Definition Templet by selecting the
SCALE COMPN softkey. The data base relation is SCALING_FCM. Keyset 1 for
the relation is DEVLPNUM, FCM_ID.

Algorithm
The algorithm for the Scale Input FCM is:

inp – K 1
Result =  --------------------   K 3 – K 4  + K 4
 K2 – K1 

where
inp (INPUT SOURCE) is the input signal
K1 (OLD LOW RANGE) is the bottom of range value for the input
K2 (OLD HIGH RANGE) is the top of range value for the input
K3 (NEW HIGH RANGE) is the bottom of range value for the result
K4 (NEW LOW RANGE) is the top of range value for the result
Input and result ranges are scaled in engineering units. The default version of the
algorithm is:
Result = PREVIOUS FCM

Configurable Parameters
The Scale Input FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

OLD LOW RANGE Field


This field specifies low range value of the input.
Valid entry is any number.
Default is: 0.0

380 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Mnemonic: RD0_K1

OLD HIGH RANGE Field


This field specifies high range value of the input.
Valid entry is any number.
Default is: 100.0
Mnemonic: RD1_K2

NEW LOW RANGE Field


This field specifies low range value of the result.
Valid entry is any number.
Default is: 0.0
Mnemonic: RD0_K4

NEW HIGH RANGE Field


This field specifies high range value of the result.
Valid entry is any number.
Default is: 100.0
Mnemonic: RD1_K3

Non-configurable Data Base Parameters


DATAQUAL, DEVLPNUM, FCM_MODE, INIT_FLG, OUT_MODE and
RESULT are applicable to Scale Input FCMs as described in Common Non-
configurable Parameters on page 338.

Tuning and Logging


Table 23 lists parameters having special runtime features for Scale Input FCMs.

3BUR002336R3701 RevA 381


Discussion Section 9 Calculator FCMS

Discussion
For example, you want to convert a signal scaled in an engineering units range of
200 to 400 to a range of 700 to 1000. To do so, the algorithm should be configured
with the following values: K1 = 200, K2 = 400, K3 = 1000, K4 = 700
The algorithm can then make the conversion.When the input value is 300, the
equation is:
300 – 200
Result =  ------------------------   1000 – 700  + 700 = 850
 400 – 200

Flow Calculation FCM


Purpose
This FCM calculates mass and volume flow rates for liquids and gases. Its primary
input is either a differential pressure measurement or a velocity measurement. The
algorithms used by this FCM are listed in Table 34 and Table 35. The algorithm
used is based on the FLOW CALC TECHNIQUE, FLOW CALCULATION TYP,
and COMPENSATION TYPE fields.
For the algorithms in Table 34 and Table 35:
K is the flow coefficient (FLOW_COF) entered in the FLOW COEFFICIENT
field. K is not a meter factor taken directly from the orifice data sheet, and all
unit conversions are implicit in the calculation of K.
h is the differential pressure (INPUT_1) entered in the PRIMARY INPUT
SOURCE field
V is the velocity (INPUT_1) entered in the PRIMARY INPUT SOURCE field
Gf is the density at flow (INPUT_4 or DEN_VAL)
B is the coefficient of thermal expansion (THERMEXP) entered in the COEF
THERM EXP field
dt is delta t, flowing temperature minus standard temperature (Tf -
STD_TEMP)
gT is the specific gravity at standard conditions (SPECGRAV)
G is the density at standard conditions (STD_DEN)

382 3BUR002336R3701 RevA


Section 9 Calculator FCMS Default Name, Algorithm Type, and Relation

Tf (TEMP_VAL) is the flowing temperature (INPUT_2 or TEMP_VAL)


Pf (PRES_VAL) is the flowing pressure (INPUT_3 or PRES_VAL)
If the square root of a negative number is required by the calculation, the algorithm
takes the square root of the absolute value of the number and negates it.

Default Name, Algorithm Type, and Relation


The default name for the Flow Calculation FCM is FLW. The algorithm is
FLOW_CALCULATION. The FCM is listed on the menu on the Loop Definition
Templet by selecting the SCALE COMPN softkey.
The data base relation is FLOW_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

3BUR002336R3701 RevA 383


Algorithm Section 9 Calculator FCMS

Algorithm
Table 34. Flow Calculation Algorithms when the FLOW CALCULATION TECHNIQUE Field
Contains DIF PRESSURE

Compensation Type
Pressure &
None Density Temperature Temperature
Flow
Rate K h K h K h K h

FR @
Calculation

h (1 + Bdt ) hT f
Flowing K h K h/Gf K gT K
Pf G
Flow

FR @ h
K h K hPf
Standard h*G f K (1 + Bdt ) g T K
Tf G

Mass h gT
K h K h*G hPf G
Flow Rate f K [1 + Bdt ] K
Tf

384 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

Table 35. Flow Calculation Algorithms when the FLOW CALCULATION TECHNIQUE Field
Contains VELOCITY

Compensation Type
Pressure &
None Density Temperature Temperature
Flow
KV KV KV KV
Rate

FR @
Calculation

KV KV KV KV
Flowing
Flow

FR @ 1 Pf
KV KV
KV KV G f 1 + Bdt Tf
Standard

gT Pf
Mass KV KV G
KV KV G Tf
Flow Rate f
1 + Bdt

Configurable Parameters
The Flow Calculation FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

PRIMARY INPUT SOURCE Field


This field specifies the primary input source. The input is either a differential
pressure source (h) or a velocity (V) depending on the algorithm used by the FCM.
Table 34 and Table 35 show how the FLOW CALCULATION TYP,
COMPENSATION TYPE, and FLOW CALC TECHNIQUE fields interact to
determine which algorithm is used.

3BUR002336R3701 RevA 385


Configurable Parameters Section 9 Calculator FCMS

Valid entries are:


.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Default is: PREVIOUS FCM
Mnemonic: INPUT_1

FLOW CALCULATION TYP Field


This field specifies the flow calculation method. Table 34 and Table 35 show how
the FLOW CALCULATION TYP, COMPENSATION TYPE, and FLOW CALC
TECHNIQUE fields interact to determine which algorithm the FCM uses.
Valid entries are:
FLOW RATE flow rate in volume units
FR @ FLOWING flow rate at flow conditions
FR @ STANDARD flow rate at standard conditions
MASS FR mass flow rate
Default is: FLOW RATE
Mnemonic: TECHNIQU

COMPENSATION TYPE Field


This field specifies the type of compensation the algorithm uses. Table 34 and
Table 35 show how the FLOW CALCULATION TYP, COMPENSATION TYPE,
and FLOW CALC TECHNIQUE fields interact to determine which algorithm the
FCM uses.
Valid entries are: NONE, PRES & TEMP, TEMP, DENSITY
Default is: NONE
Mnemonic: part of EQ_TYPE

386 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

TEMP INPUT SOURCE Field


This field specifies the remote temperature input source. It is used by the algorithm
when the entry in the TEMP LOC/REM field is REMOTE. The temperature value
must be absolute, that is, degrees Rankine where degrees Rankine = degrees
Fahrenheit + 459.69.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.
Mnemonic: INPUT_2

PRES INPUT SOURCE Field


This field specifies the remote pressure input source. It is used when the entry in the
PRES LOC/REM field is REMOTE. The pressure must be in absolute units, that is,
PSIA.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.
Mnemonic: INPUT_3

DENSITY INPUT SOURCE Field


This field specifies the remote density input source. It is used by the algorithm when
the entry in the DEN LOC/REM field is REMOTE.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.

3BUR002336R3701 RevA 387


Configurable Parameters Section 9 Calculator FCMS

Mnemonic: INPUT_4

TEMP LOC/REM Field


This field specifies whether the temperature source is local or remote.
Valid entries are:
LOCAL temperature source is value in the FLOWING TEMP field.
REMOTE temperature source is remote. The algorithm uses the result of the
FCM named in the TEMP INPUT SOURCE field.
Default is: LOCAL
Mnemonic: TEMP_SRC

PRES LOC/REM Field


This field specifies whether the pressure source is local or remote.
Valid entries are:
LOCAL pressure source is value in the FLOWING PRESSURE field.
REMOTE pressure source is remote. The algorithm uses the result of the FCM
named in the PRES INPUT SOURCE field
Default is: LOCAL
Mnemonic: PRES_SRC

DEN LOC/REM Field


This field specifies whether the density source is local or remote.
Valid entries are:
LOCAL density source value in the FLOWING DENSITY field.
REMOTE density source is remote. The algorithm uses the result of the FCM
named in the DENSITY INPUT SOURCE field.
Default is: LOCAL
Mnemonic: DEN_SRC

388 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

FLOW CALC TECHNIQUE Field


This field specifies the technique used to calculate flow. Table 34 and Table 35
show how the FLOW CALCULATION TYP, COMPENSATION TYPE, and
FLOW CALC TECHNIQUE fields interact to determine which algorithm the FCM
uses.
Valid entries are:
DIFF PRES differential pressure technique is used to calculate flow
VELOCITY velocity technique is used to calculate flow
Default is: DIFF PRES
Mnemonic: TECHNIQU

STANDARD TEMP Field


This field specifies the standard temperature. Temperature must be absolute
(degrees Rankine).
Valid entry is any number.
Default is: 0.0
Mnemonic: STD_TEMP

FLOWING TEMP Field


This field specifies the flow temperature. It is used when the entry in the TEMP
LOC/REM field is LOCAL. The temperature must be absolute (deg. Rankine where
deg. Rankine = deg. Fahrenheit + 459.69).
Valid entry is any number greater than 0.
Default is: 0.0
Mnemonic: TEMP_VAL

FLOWING PRESSURE Field


This field specifies the flow pressure. It is used when the entry in the PRES
LOC/REM field is LOCAL.

3BUR002336R3701 RevA 389


Configurable Parameters Section 9 Calculator FCMS

Valid entry is any number greater than 0. The entry must be in PSIA.
Default is: 1.0
Mnemonic: PRES_VAL

FLOWING DENSITY Field


This field specifies the flow density. It is used when the entry in the DEN
LOC/REM field is LOCAL.
Valid entry is any number greater than 0.
Default is: 1.0
Mnemonic: DEN_VAL

DENSITY SC Field
This field specifies the value for the density at standard conditions.
Valid entry is any number.
Default is: 1.0
Mnemonic: STD_DEN

SPEC GRAV SC Field


This field specifies the value for specific gravity at standard conditions.
Valid entry is any number.
Default is: 1.0
Mnemonic: SPECGRAV

COEF THERM EXP Field


This field specifies the value for the coefficient of thermal expansion.
Valid entry is any number.
Default is: 1.0
Mnemonic: THERMEXP

390 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

FLOW COEFFICIENT Field


This field specifies the value for the flow coefficient.
Valid entry is any number.
Default is: 1.0
Mnemonic: FLOW_COF

Non-configurable Data Base Parameters


The non-configurable parameters for the FLOW CALCULATION FCM are
described in Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 20 lists parameters having special runtime features for Flow Calculation
FCMs.

Discussion
Proper calculation of the flow coefficient K is important. The equation for K is
based on the type of flow calculation and compensation. Two examples are provided
below.
Density Compensated Liquid Flow
This equation is also useful in gas flow applications that use specific gravity
transmitters. To obtain compensated volumetric or mass flow, the value of K is
calculated as follows:

Q f max
K = --------------------------------
SQRT  h  G f 

where
Qf, max is the volumetric flow rate at maximum differential pressure (given
on orifice data sheet)
hmax is the maximum differential pressure (on orifice data sheet)

3BUR002336R3701 RevA 391


Discussion Section 9 Calculator FCMS

Gf is the density of flowing material at flowing conditions as specified


on orifice data sheet
K is not a meter factor taken directly from the orifice data sheet and all unit
conversions are implicit in the calculation of K. Entries in the following fields is
also required:
PRIMARY INPUT SOURCE, h: Source of head across meter. Units depend on
source FCM.
FLOW CALCULATION TYP: Choose required type via NEXT CHOICE key on
keyboard.
COMPENSATION TYPE: Density
DENSITY INPUT SOURCE: Source of flowing density in units used in the
calculation of K. For example, this input could come from either a specific gravity
transmitter or from a calculation involving density as a function of temperature.
DEN LOC/REM: Remote
FLOW CALC TECHNIQUE: Differential Pressure
Compensated Gas Flow Using Differential Pressure Technique
You calculate K as follows:

Q fmax  G
K = -------------------------------------------------------
h max  P f  G
SQRT  ---------------------------------
 Tf 

where
Qf, max are as previously described
& hmax
Tf is temperature, absolute units, given as flowing temperature on
orifice data sheet
Pf is pressure, absolute units, given as flowing pressure on orifice data
sheet

392 3BUR002336R3701 RevA


Section 9 Calculator FCMS Discussion

G is density of flowing material at base conditions as given on orifice


data sheet.
The following fields must also be configured:
PRIMARY INPUT SOURCE, h: Source of head across meter as described
previously.
FLOW CALCULATION TYP: Select type according to required calculation.
COMPENSATION TYPE: Pressure and Temperature.
TEMP INPUT SOURCE: If temperature is Remote, this field should specify an
FCM whose output is the flowing temperature in absolute units. If temperature is
Local, no entry is needed.
PRES INPUT SOURCE: If pressure is remote this field should specify an FCM
whose output is the flowing pressure in absolute units. If pressure is Local, no entry
is needed.
TEMP LOC/REM: Remote if a temperature input is available for compensation. If
entry is Local, a corresponding entry must be made to the flowing pressure field of
this templet.
FLOW CALC TECHNIQUE: Differential Pressure
PRES LOC/REM: Remote if a pressure input is available for compensation. If
entry is Local, a corresponding entry must be made to the flowing pressure field of
this templet.
FLOWING TEMP: If entry to TEMP LOC/REM field is LOC, enter the flowing
temperature from orifice data sheet.
FLOWING PRESSURE: If entry to PRES LOC/REM field is LOC, enter the
flowing pressure from orifice data sheet.
DENSITY SC: Enter density at standard conditions (base conditions on orifice data
sheet).

3BUR002336R3701 RevA 393


Temperature Compensation FCM Section 9 Calculator FCMS

Temperature Compensation FCM


Purpose
This FCM calculates temperature compensated volumetric and mass flow rates for
incompressible fluids.

Default Name, Algorithm Type, and Relation


The default name for the Temperature Compensation FCM is TMP. The algorithm is
TEMPERATURE_COMPENSN. The FCM is listed on the menu on the Loop
Definition Templet by selecting the SCALE COMPN softkey.
The data base relation is TCLF_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithms for the Temperature Compensation FCM are shown below.
Volumetric flow rate:

inp 1
Result =  K 1  SQRT   -------------------------------------------------------
 1 + K 3    inp 2 – K 2 

Mass flow rate:

Result =  K 1  SQR    inp 1   1 + K 3   inp 2 – K 2   

where:
inp1 (DIFF PRESS SOURCE) is the value of the differential pressure
measurement
inp2 (TEMP SOURCE) is the actual temperature of the flow
K1 (FLOW CONST) is the flow constant

394 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

K2 (DES TEMP CONSTANT) is the design temperature for the liquid flow
K3 (DEN VS TEMP CONST) is a function of liquid density vs. temperature
characteristics
The default versions of the algorithms are as shown below.
Volumetric flow rate:
PREVIOUS FCM
Result = 1.0  SQRT  --------------------------------------------------
 1 + TEMP SOURCE
Mass flow rate:
Result = 1.0  SQR  PREVIOUS FCM  1 + TEMP SOURCE  

Configurable Parameters
The Temperature Compensation FCM has the following configurable fields in
addition to the fields described in Common Configurable Fields for Calculator
FCMs on page 334.

TEMP SOURCE Field


This field specifies the temperature source.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.
Mnemonic: INPUT_2

DIFF PRESR SOURCE Field


This field specifies the source of the differential pressure input for the FCM.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Default is PREVIOUS FCM

3BUR002336R3701 RevA 395


Configurable Parameters Section 9 Calculator FCMS

Mnemonic: INPUT_1

FLOW CONSTANT Field


This field specifies the value of the flow constant.
Valid entry is any number.
Default is: 1.0
Mnemonic: RD1_K1

DEN VS TEMP CONST Field


This field specifies the value of the density versus temperature constant.
Valid entry is any number.
Default is: 1.0
Mnemonic: RD1_K3

VOLUME OR MASS FLOW? Field


This field specifies whether the FCM uses volumetric flow rate or mass flow rate
algorithm.
Valid entries are:
MASS use the mass flow rate algorithm
VOL use the volumetric flow rate algorithm
Default is: VOL
Mnemonic: TCLF_OP

DES TEMP CONSTANT Field


This field specifies the design temperature constant.
Valid entry is any number.
Default is: 0.0
Mnemonic: RD0_K2

396 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Non-configurable Data Base Parameters


The non-configurable parameters for the Temperature Compensation FCM are
described in Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 24 lists parameters having special runtime features for Temperature
Compensation FCMs.

Discussion
Setting the VOLUME or MASS FLOW parameter (TCLF_OP) changes the
arithmetic operation code in the algorithm from divide (volume) to multiply (mass).
Otherwise, the formula of the algorithm is executed in the same way for both types
of calculations.
The data quality of the result (DATAQUAL) goes bad if the algorithm attempts to
divide by zero or take the square root of a negative number.

Ratio/Bias FCM
Purpose
Use this FCM to apply bias and ratio to a signal. Bias and ratio sources can be local
or remote.

Default Name, Algorithm Type, and Relation


The default name for the Ratio/Bias FCM is RB. The algorithm is RATIO/BIAS.
The FCM is listed on the menu on the Loop Definition Templet by selecting the
SCALE COMPN softkey.
The data base relation is RABI_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

3BUR002336R3701 RevA 397


Algorithm Section 9 Calculator FCMS

Algorithm
The algorithm for the Ratio/Bias FCM is:
Result =  K 2  inp  + K 1

where
inp (INPUT SOURCE 1) is the input signal
K1 is the bias
K2 is the ratio
The default version of the algorithm is:
Result =  1.0  PREVIOUS FCM  + 0.0

Configurable Parameters
The Ratio/Bias FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

REM BIAS SOURCE Field


This field specifies the remote bias source. It is used when BIAS MODE is
REMOTE.
Valid entries are:
.fcmname result of another FCM in the loop is the bias
tag.fcmname result of a FCM from another loop is the bias
There is no default.
Mnemonic: INPUT_2

REM RATIO SOURCE Field


This field specifies the remote ratio source. It is used when RATIO MODE is
REMOTE.

398 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

Valid entries are:


.fcmname result of another FCM in the loop is the ratio
tag.fcmname result of a FCM from another loop is the ratio
There is no default.
Mnemonic: INPUT_3

LOCAL BIAS Field


This field specifies the local bias value. It is used when the bias mode is LOCAL.
Valid entry is any number.
Default is: 0.0
Mnemonic: RD0_K1

LOCAL RATIO Field


This field specifies the local ratio value. It is used when the ratio mode is LOCAL.
Valid entry is any number.
Default is: 1.0
Mnemonic: RD1_K2

BIAS MODE Field


This field specifies whether the bias mode is local or remote.
Valid entries are:
LOCAL FCM uses the local bias
REMOTE FCM uses the remote bias
Default is: LOCAL
Mnemonic: BIASMODE

3BUR002336R3701 RevA 399


Non-configurable Data Base Parameters Section 9 Calculator FCMS

RATIO MODE Field


This field specifies whether the ratio mode is local or remote.
Valid entries are:
LOCAL FCM uses the local ratio
REMOTE FCM uses the remote ratio
Default is: LOCAL
Mnemonic: RATOMODE

Non-configurable Data Base Parameters


The non-configurable parameters for the Ratio/Bias FCM are described in Common
Non-configurable Parameters on page 338.

Tuning and Logging


Table 25 lists parameters having special runtime features for Ratio/Bias FCMs.

Discussion
Before execution, the algorithm checks the flags that indicate the ratio and bias
sources. Either or both flags can be remote, in which case the source(s) must be
specified. When the mode is local, no remote source need be specified.

Time Derivative FCM


Purpose
This FCM performs a first order time differentiation on its input.

Default Name, Algorithm Type, and Relation


The default name for the Time Derivative FCM is DER. The algorithm is
TIME_DERIVATIVE. The FCM is listed on the menu on the Loop Definition
Templet by selecting the TIME softkey.

400 3BUR002336R3701 RevA


Section 9 Calculator FCMS Algorithm

The data base relation is TDER_INT_FCM. Keyset 1 for the relation is


DEVLPNUM, FCM_ID.

Algorithm
The algorithm for the Time Derivative FCM is:
inp – PREI
Result = K  ----------------------------
T
where
K (CONSTANT) is the scaling constant
inp (INPUT SOURCE) is the value of the input
PREI is the input value from the last scan of the loop on which the calculation
was performed. When the FCM is initialized, this value is set to the value of the
initial input.
T is the time interval in seconds

Configurable Parameters
The Time Derivative FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

CONSTANT Field
This field specifies the value of the scaling constant.
Valid entry is any number.
Default is: 1.0
Mnemonic: RD1_K1

TIME INTERVAL Field


This field specifies the time interval. The entry should be an integer multiple of the
loop scan rate. If it is not a multiple, the calculation rounds it to the next higher
multiple of the scan rate. Enter the number in the Configurator as seconds. The data
base stores it as milliseconds.
Valid entry is a number in seconds.

3BUR002336R3701 RevA 401


Non-configurable Data Base Parameters Section 9 Calculator FCMS

Default is: 0.0


Mnemonic: TIMEINTV

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the Time
Derivative FCM.

PREV_INP Parameter
PREV_INP is equal to the input from the previous loop scan on which the
calculation was performed. When the FCM is initialized, this parameter is set to the
value of the current input. There are no state values nor state mnemonics available
for TCL for this parameter.

TIME_CNT Parameter
TIME_CNT is the milliseconds left until the calculation is done. It is used internally
to calculate the derivative. There are no state values nor state mnemonics for TCL
for this parameter.

Tuning and Logging


Table 26 lists parameters having special runtime features for Time Derivative
FCMs.

Time Integration FCM


Purpose
This FCM performs time integration on its input. The calculation is a trapezoidal
approximation of the integral.

402 3BUR002336R3701 RevA


Section 9 Calculator FCMS Default Name, Algorithm Type, and Relation

Default Name, Algorithm Type, and Relation


The default name for Time Integration FCM is INT. The algorithm is
TIME_INTEGRATION. The FCM is listed on the menu on the Loop Definition
Templet by selecting the TIME softkey.
The relation is TDER_INT_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The integral equation is:

tt
Y = K   t  dt = C
to

The approximation used for the Time Integration FCM with the Totalizer option is:
T
Result =  K  ---  inp + PREI  + PREV
 2
The approximation used for the Time Integration FCM without the Totalizer option
is:
T
Result =  K  ---   inp + PREI 
 2
where
K (SCALE FACTOR) is the scaling constant for the integral
T (TIME INTERVAL) is the sample period in seconds
inp (INPUT SOURCE) is the value of the input
PREI is the input value from the loop scan on which the calculation was last
performed. PREI is initialized to the current input when the FCM is switched to
the AUTO mode.
PREV is the value of the result from the previous sample period (that is, PREV
= result n-1). PREV is initialized to zero when the FCM is switched to the
AUTO mode.

3BUR002336R3701 RevA 403


Configurable Parameters Section 9 Calculator FCMS

Configurable Parameters
The Time Integration FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

TIME INTERVAL Field


This field specifies the time interval. Time interval should be a multiple of the loop
scan rate. If it is not a multiple, the calculation rounds it to the next higher multiple
of the scan rate.
Valid entry is any number (in seconds).
Default is: 0.25
Mnemonic: TIMEINTV

TOTALIZER OPTION Field


This field specifies whether the totalizer option is enabled or disabled. It must be set
to YES to perform its calculation.
Valid entries are:
NO integral calculation is disabled
YES integral calculation is enabled
Default is: NO
Mnemonic: TOTL_OPT

SCALE FACTOR Field


This field specifies the value of the scaling constant.
Valid entry is any number.
Default is: 1.0
Mnemonic: RD1_K1

404 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the Time
Integration FCM.

PREV_INP Parameter
PREV_INP is equal to the input from the last loop scan the calculation was
performed on. There are no state values nor state mnemonics available for TCL for
this parameter.

TIME_CNT Parameter
TIME_CNT is the number of milliseconds left until the calculation is performed. It
is used internally to calculate the integral. There are no state values nor state
mnemonics available for TCL for this parameter.

Tuning and Logging


Table 26 lists parameters having special runtime features for Time Integration
FCMs.

First Order Filter FCM


Purpose
This FCM provides a first order lag function.

Default Name, Algorithm Type, and Relation


The default name for First Order Filter is FLT. The algorithm is
FIRST_ORDER_FILTER. The FCM is listed on the menu on the Loop Definition
Templet by selecting the TIME softkey.
The data base relation is FILT_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

3BUR002336R3701 RevA 405


Algorithm Section 9 Calculator FCMS

Algorithm
Laplace form of the transfer function is:
Y  s - 1
---------- = ---------------
Xs Ls + 1
The algorithm for the First Order Filter FCM is:
T 60L
Result =  ------------------- inp +  ------------------- PREV
T + 60L T + 60L
where
T is the time interval (or processing interval) in seconds between executions of
the FCM
L (LAG TIME) is the lag time constant in minutes
inp (INPUT SOURCE) is the input value
PREV is the result from the previous sample period (that is, PREV = result n-
1). An initial value (PREV = inp) is calculated when the FCM is switched to
the Auto mode.

Configurable Parameters
The First Order Filter FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

LAG TIME Field


This field specifies the value of the lag time.
Valid entry is an amount of time in minutes.
Default is: 0.0
Mnemonic: LAG_TIME

Non-configurable Data Base Parameters


The non-configurable parameters for the First Order Filter FCM are described in
Common Non-configurable Parameters on page 338.

406 3BUR002336R3701 RevA


Section 9 Calculator FCMS Tuning and Logging

Tuning and Logging


Table 20 lists parameters having special runtime features for First Order Filter
FCMs.

Totalizer FCM
Purpose
This FCM calculates a total by adding or subtracting its current input from the total
of the previous input values. You can also compare the total to two user-defined
values.

Default Name, Algorithm Type, and Relation


The default name for the Totalizer FCM is TOT. The algorithm is TOTALIZER.
The FCM is listed on the menu on the Loop Definition Templet by selecting the
TIME softkey.
The data base relation is TOTL_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithms for the Totalizer FCM modes are shown below.
Totalizing in Up Mode:
Result = PREV +  K  inp 

Totalizing in Down Mode:


Result = PREV –  K  inp 

where
PREV is the result from the previous sample period (that is, PREV = result n-
1). In the Up Mode, PREV is initialized to 0 when the FCM is switched to the
Auto output mode. In the Down Mode, it is initialized to the value of Trip Point
2.
inp (INPUT SOURCE) is the input signal

3BUR002336R3701 RevA 407


Configurable Parameters Section 9 Calculator FCMS

K (SCALE FACTOR) is the scaling constant for inp


The default version of the algorithm is:
Result = PREV + (PREVIOUS FCM)

Configurable Parameters
The Totalizer FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

If the FCM is started in Auto mode, the initial output is ignored. If


the FCM is started in Manual, the initial output is used until the
mode is switched to Auto. Then the algorithm acts as described in
Discussion on page 411.

SCALE FACTOR Field


This field specifies the value of the scaling constant.
Valid entry is any number.
Default is: 1.0
Mnemonic: RD1_K1

TRIP POINT 1 Field


This field specifies the value of PREDETERMINED REGISTER NO. 1.
Valid entry is any number greater than or equal to 0.
Default is: NONE
Mnemonic: PR1

TRIP POINT 2 Field


This field specifies the value of the PREDETERMINED REGISTER NO. 2.
Valid entry is a number greater than or equal to the TRIP POINT 1 entry.
Default is: NONE

408 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Mnemonic: PR2

UP OR DOWN Field
This field specifies if the totalizer adds or subtracts each new input from the current
total.
Valid entries are:
UP totalizer adds input
DOWN totalizer subtracts input
Default is: UP
Mnemonic: UP_DOWN

THRESHOLD VALUE Field


This field specifies the threshold value. If the absolute value of the input is lower
than this value, the input is discarded without being applied to the total.
Valid entry is a number greater than or equal to 0.
Default is: 0.0
Mnemonic: THRESHLD

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the
Totalizer FCM.

EN_DIS Parameter
EN_DIS enables or disables totalization. It is set by TCL or an external program.
The result of the Totalizer FCM is frozen at its current value when totalization is
disabled.

3BUR002336R3701 RevA 409


Non-configurable Data Base Parameters Section 9 Calculator FCMS

State values are:


0 totalization is disabled
1 totalization is enabled
State mnemonics available for TCL are:DISABLED, ENABLED

OVERFLOW Parameter
OVERFLOW indicates totalizer overflow. It is set when the total attempts to exceed
99,999,999 or -99,999,999. There are no state mnemonics for TCL.
State values are:
0 no totalizer overflow
1 totalizer overflow

PR1_MODE Parameter
PR1_MODE indicates if the PR1_MODE (predetermined register no.1 mode) is
active or inactive. The mode must be active to set the value of PR1_STAT
(predetermined register no. 1 status) during the totalization. See Discussion on page
411.
State values are:
0 mode is inactive
1 mode is active
State mnemonics available for TCL are:INACTIVE, ACTIVE

PR1_STAT Parameter
PR1_STAT indicates if the status of the PR1_STAT (predetermined register no. 1
status) is set or not set. There are no state mnemonics for TCL. See Discussion on
page 411.
State values are:
0 not set
1 set

410 3BUR002336R3701 RevA


Section 9 Calculator FCMS Tuning and Logging

PR2_MODE Parameter
PR2_MODE indicates if the PR2_MODE (predetermined register no. 2 mode) is
active or inactive. The mode must be active to set the value of PR2_STAT
(predetermined register no. 2 status) during the totalization. See Discussion on page
411.
State values are:
0 mode is inactive
1 mode is active
State mnemonics available for TCL are:INACTIVE, ACTIVE

PR2_STAT Parameter
PR2_STAT indicates if the status of the (predetermined register no. 2 status) is set or
not set. There are no state mnemonics available for TCL. See Discussion on page
411.
State values are:
0 not set
1 set

Tuning and Logging


Table 27 lists parameters having special runtime features for Totalizer FCMs.

Discussion
The algorithm produces a total by summing the input values it receives each sample
period.
The UP or DOWN parameter specifies whether the new increments are added or
subtracted from the current total. The entries for Trip Point 1 and Trip Point 2
parameters provide predetermined breakpoints to which the totalized value is
compared when the corresponding trip point modes are active.
For an upward count, the count starts at zero. When it becomes larger than or equal
to the value of TRIP POINT 1 (PR1), the status of PREDETERMINED REGISTER
NO. 1 (PR1_STAT) is set to 1. When the count becomes equal to or greater than the

3BUR002336R3701 RevA 411


Discussion Section 9 Calculator FCMS

value of TRIP POINT 2 (PR2), the status of PREDETERMINED REGISTER NO.


2 (PR2_STAT) is set. When the count reaches 99,999,999, the status of the
OVERFLOW parameter becomes set, the count overflows to zero, and the upward
count continues.
For a downward count, the count starts at the value of TRIP POINT 2 (PR2). When
it becomes less than or equal to the value of TRIP POINT 1 (PR1), the status of
PREDETERMINED REGISTER NO. 1 (PR1_STAT) is set. When the count
becomes less than or equal to zero, the status of PREDETERMINED REGISTER
NO. 2 (PR2_STAT) is set. When the count reaches -99,999,999, the status of the
OVERFLOW parameter becomes set, the count underflows to zero, and resumes in
the downward direction.
The count total is cleared by one of the following methods:
• Setting the initialization flag (INIT_FLG) at 1
• Switching from Manual to Auto or from Auto to Manual
• Turning the loop off and then back on
• Turning the FCM off and then back on
When a clear signal is received, the count resets to zero for upward counts or to the
value of TRIP POINT 2 for downward counts, and the two predetermined statuses
are reset.
The INITIAL OUTPUT field is ignored if the Totalizer FCM is configured to start
in the Auto mode. If the Totalizer FCM is configured to start in the Manual mode,
the result upon start-up takes on the value entered in the INITIAL OUTPUT field.
However when the Totalizer FCM is switched to the Auto mode, the count takes
place in the manner previously described (that is, up counts start at 0, down counts
start at the value of TRIP POINT 2).
It may be useful to reset the Totalizer based on reaching a limit, a specific time of
day, or a time interval. Some of the possible applications are:
Totalizer Reset according to FCM to provide reset signal
A specific value Signal Comparison FCM
Time of day Timer FCM
Time interval Timer FCM

412 3BUR002336R3701 RevA


Section 9 Calculator FCMS Lead/Lag Filter FCM

When the state of the other FCM determines that the Totalizer should be reset, value
of INIT_FLG should be set to 1 by a CCF Put FCM or a TCL write statement.

Lead/Lag Filter FCM


Purpose
This FCM provides the capability for combined lead/lag filter conditioning.
Illustration of the lead and lag concepts are shown in Figure 64 and Figure 65.

Output

Input

Lead Time Time

Figure 64. Lead Response

3BUR002336R3701 RevA 413


Default Name, Algorithm Type, and Relation Section 9 Calculator FCMS

Input

Time

Lag Output
Time

Time

Figure 65. Lag Response

Default Name, Algorithm Type, and Relation


The default name for the Lead/Lag Filter FCM is LLG. The algorithm is
LEAD/LAG_FILTER. The FCM is listed on the menu on the Loop Definition
Templet by selecting the TIME softkey. The data base relation is LDLG_FCM.
Keyset 1 for the relation is DEVLPNUM, FCM_ID.

Algorithm
Laplace form of the transfer function is:

where
Tp (PREACT TIME) is the Pre-act time in minutes

414 3BUR002336R3701 RevA


Section 9 Calculator FCMS Algorithm

 
Y  s   1 + 60T p s  1 -
----------- =  ------------------------ ----------------------
Xs  T p   1 + 60T l s
 1 + 60 ----- a 
s

a (PREACT GAIN) is the Pre-act gain


Tl (LAG TIME) is the lag time in minutes
The algorithms for the Lead/Lag Filter FCM are:
Result =  K  Y  +   1 – K   PREV 

where
LEAD PORTION = Y =  C  PREY  +  1 + C  a – 1    inp –  a  C  PREI 

Pre Act Portion is:

Tp
C = ------------------------------
 T-
 a----------- + Tp
 60 

Lag Portion is:

T
R =  --------------------
 T + 60T l

where
inp (INPUT SOURCE) is the input signal
PREY is the output from the lead lag filter portion of the calculation from the
previous sample period (that is, PREY = Y n-1). An initial value for PREY must
be calculated every time the FCM is switched to the Auto output mode.

3BUR002336R3701 RevA 415


Configurable Parameters Section 9 Calculator FCMS

The initial value of PREY is equal to the value of:  1 – a   inp


a is the Pre-act gain
PREI is the input from the previous sample (PREI = inp n-1). An initial value of
PREI = 0 must be calculated every time the FCM is switched to Auto output
mode.
PREV is the output for the previous sample period (PREV = result n-1). PREV
= inp initial value is calculated from PREV each time the FCM is switched to
Auto output mode.
T is the time interval in seconds between executions of the filter (the sample
period or processing interval).
Tl (LAG TIME) is the lag time constant in minutes. See Discussion on page
417.

Configurable Parameters
The Lead/Lag Filter FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

LAG TIME Field


This field specifies the value of the lag time.
Valid entry is an amount of time in minutes.
Default is: 0.0
Mnemonic: LAG_TIME

PREACT TIME Field


This field specifies the value of Pre-act time.
Valid entry is an amount of time in minutes.
Default is: 0.0
Mnemonic: PRE_TIME

416 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

PREACT GAIN Field


This field specifies the value of Pre-act gain.
Valid entry is any number.
Default: 16.0
Mnemonic: PRE_GAIN

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameter applies for the
Lead/Lag Filter FCM.

PREV_INP Parameter
PREV_INP is the input from the previous scan. There are no state values or TCL
mnemonics.

Tuning and Logging


Table 20 lists parameters having special runtime features for Lead/Lag Filter FCMs.

Discussion
Initial values for PREY, PREI, and PREV are specified such that the output of the
Lead/Lag Filter FCM is the same as its input for the first sample period in Auto
output mode. In subsequent sample periods, the previous values are updated
normally (set Xn-1 = X n before calculating the next value of X n).
The minimum value for Tl based on sample period and Pre-act time is calculated as
follows. If the value of TI is 0, then the value of Tp minimum is 0.
Tp
Tp  
-  112 , then 0.111  ------------------ + 48  1 + 0.75  PG – 8  T  60   
If 0  ------------
T  60  T  60 
---------------------------------------------------------------------------------------------------------------------
1 + 0.111  1 + 0.75  PG – 8  

Tp T
-  784 , then T I minimum = 16  ------
If 112  ------------
T  60 60

3BUR002336R3701 RevA 417


Dead Time FCM Section 9 Calculator FCMS

Tp T
If 784  ------------
- , then T I -----p-
T  60 minimum = 33

Dead Time FCM


Purpose
This FCM implements a pure dead time. See Figure 66 for an example.

Simulated
Disturbance
Dead Time
FCM
Feedforward
Input

Setpoint
Process

Process Controller

Figure 66. Feed Forward Using Simulated Dead Time

Default Name, Algorithm Type, and Relation


The default name for the Dead Time FCM is DTM. The algorithm f is
DEAD_TIME. The FCM is listed on the menu on the Loop Definition Templet by
selecting the TIME softkey.
The relation is DEDT_FCM. Keyset 1 for the relation is DEVLPNUM, FCM_ID.

Algorithm
In Laplace form, the relationship is:
Y (s) = e-dx X (s)

418 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

where
d is the dead time in seconds

Configurable Parameters
The Dead Time FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

MAX DEAD TIME Field


This field specifies the value of the deadtime time interval. The maximum deadtime
must be entered in seconds via the configurator. When the parameter is changed by
other means, such as a TCL statement or a CCF PUT FCM, the value should be in
milliseconds.
Valid entry is an amount of time in seconds
Default is: 4.0
Mnemonic: TIMEINTV

Non-configurable Data Base Parameters


The non-configurable parameters for the Dead Time FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 20 lists parameters having special runtime features for Dead Time FCMs.

Discussion
The maximum dead time allowed is 20 times the loop processing rate.

3BUR002336R3701 RevA 419


Dead Time Compensation FCM Section 9 Calculator FCMS

Dead Time Compensation FCM


Purpose
When the process contains a dead time which threatens control loop stability, this
FCM provides a compensated process signal to the loop controller.

Default Name, Algorithm Type, and Relation


The default name for the Dead Time Compensation FCM is DTC. The FCM is
DEAD_TIME_COMPENSN. The FCM is listed on the menu on the Loop
Definition Templet by selecting the TIME softkey. The data base relation is
DTC_FCM. Keyset 1 for the relation is DEVLPNUM, FCM_ID.

Algorithm
The algorithms for the Dead Time Compensation FCM are:
y =  p  y  +  1 +  a – 1   p   inp –  a  p  inp n – 1 

Z =  K  y  +  1 – K   Zn – 1

Result = Z – Z 1

where

Tp
P = ------------------------------
 T-
 a----------- + Tp
 60 

T
K =  --------------------
 T + 60T l

y is output of the lead filter calculation from the previous sample period
a (PREACT GAIN) is the Pre-act gain
inp (INPUT SOURCE) is the input

420 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

inpn-1 is the input for the previous sample period. Initial value 0 is entered when
the FCM is switched to Auto.
Zn-1 is the value Z from the previous sample period
Z1 is the Z signal delayed by i1 * T seconds
Tp (PREACT TIME) is the Pre-act time in minutes
T is the sample period in seconds (determined by loop processing rate)
L (LAG TIME) is the time lag in minutes
i1 is an integer constant to specify dead time (Z1), that is, the dead time is equal
to i1 * T seconds

Configurable Parameters
The Dead Time Compensation FCM has the following configurable fields in
addition to the fields described in Common Configurable Fields for Calculator
FCMs on page 334.

MAX DEAD TIME Field


This field specifies the value of the deadtime time interval.
Valid entry is a number in seconds (the data base holds this number internally in
milliseconds).
Default is: 4.0
Mnemonic: TIMEINTV

LAG TIME Field


This field specifies the value of the lag time.
Valid entry is a number in minutes.
Default is: 0.0
Mnemonic: LAG_TIME

3BUR002336R3701 RevA 421


Non-configurable Data Base Parameters Section 9 Calculator FCMS

PREACT TIME Field


This field specifies the value of Pre-act time.
Valid entry is a number in minutes.
Default is: 0.0
Mnemonic: PRE_TIME

PREACT GAIN Field


This field specifies the value of Pre-act gain.
Valid entry is any number.
Default is: 16.0
Mnemonic: PRE_GAIN

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the Dead Time Compensation FCM has the
following parameter.

PREV_INP Parameter
This parameter indicates the value of the input from the previous loop scan. There
are no state values nor state mnemonics available for TCL for this parameter.

Tuning and Logging


Table 20 lists parameters having special runtime features for Dead Time
Compensation FCMs.

Discussion
This FCM provides a compensated process signal to the PID controller for
applications where the dead time inhibits loop stability. See the example in
Figure 67.

422 3BUR002336R3701 RevA


Section 9 Calculator FCMS Timer FCM

Disturbance
Controller FCM

Setpoint Output
Process

Process Dead Time


Input Comp.
Input Dead Time
Compensation
FCM

Figure 67. Dead Time Compensation Example

Timer FCM
Purpose
This FCM provides for triggering an action after a specified elapsed time or at a
specified time of day. Both single shot and periodic timing are supported.

Default Name, Algorithm Type, and Relation


The default name for the Timer FCM is TIM. The algorithm is TIMER. The FCM is
listed on the menu on the Loop Definition Templet by selecting the TIME softkey.
The data base relation is TIMR_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

3BUR002336R3701 RevA 423


Algorithm Section 9 Calculator FCMS

Algorithm
Generally the timer counts down from a specified number to zero. A Select Next
FCM or a Real Compare FCM, may be used to detect when the result of the Timer
FCM becomes zero.
The meaning of the Timer FCM result depends on its sign. A positive result
represents the amount of time left in the timing cycle. For example, a result of 14,
indicates the timer will reach 0 in 14 seconds. A negative result represents the
amount of time until the timer starts timing. For example, a result of -87 indicates
the timer will start in 87 seconds.

Configurable Parameters
The Timer FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

TIMER MODE Field


This field specifies the type of timer.
Valid entries are:
SS IMST Single shot, immediate start timer. The timer starts immediately
after FCM is initialized. The time is entered in the PERIODIC
TIME field. The timer times out once, the FCM is turned off, the
result remains 0 until the FCM is re-initialized.
SS REALST Single shot, relative start timer. The timer starts when an amount of
time equal to RELATIVE START TIME passes after the FCM is
initialized. The time is entered in the PERIODIC TIME field. The
timer times out once, the FCM is turned off, and the result remains
at 0 until the FCM is initialized again.
SS ABSST Single shot, absolute start timer. The timer starts at the time
specified in ABSOLUTE TIME. The time is entered in the
PERIODIC TIME field. The timer times out once, the FCM is
turned off, the result remains at 0 until the FCM is re-initialized.
PER IMST Periodic, immediate start timer. The timer starts immediately after
the FCM is initialized. The time is entered in the PERIODIC TIME

424 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

field. The timer is re-initialized to this time after it has timed out
and the cycle is continuously repeated.
PER REALST Periodic, relative start timer. The timer starts when an amount of
time equal to RELATIVE START TIME passes after the FCM is
initialized. The time is entered in the PERIODIC TIME field. The
timer is re-initialized to this time after it has timed out and the cycle
is continuously repeated.
PER ABSST Periodic, absolute start timer. The timer starts at the time specified
in the ABSOLUTE TIME field. The time is entered in the
PERIODIC TIME field. The timer is re-initialized to this time after
it times out and the cycle is continuously repeated.
P/RE IMST Periodic, immediate start timer with repeat count. The timer starts
immediately after the FCM is initialized. The time is entered in the
PERIODIC TIME field. The timer repeats a number of times equal
to REPEAT COUNT. The FCM is turned off and the result is 0 until
the FCM is re-initialized.
P/RE REALST Periodic, relative start timer with repeat count. The timer starts
when an amount of time equal to RELATIVE START TIME passes
after the FCM is initialized. The time is entered in the PERIODIC
TIME field. The timer repeats a number of times equal to REPEAT
COUNT. The FCM is then turned off and the result remains at 0
until the FCM is re-initialized.
P/RE ABSST Periodic, absolute start timer with repeat count. The timer starts at
the time specified in the ABSOLUTE TIME field. Time is entered
in the PERIODIC TIME field. The timer repeats a number of times
equal to REPEAT COUNT. The FCM is turned off and the result is
0 until the FCM is re-initialized.
Default is: SS IMST
Mnemonic: TIMRTYPE

RELATIVE START TIME Field


This field specifies the time between initial processing of the FCM and the start of
the timer.

3BUR002336R3701 RevA 425


Configurable Parameters Section 9 Calculator FCMS

Valid entries are in the format:


hh:mm:ss time in terms of hour, minute, and second

PERIODIC TIME Field


This field specifies period length. It is used by each type of timer configured for this
FCM.
Valid entries are in the format:
hh:mm:ss time in terms of hour, minute, and second (the data base holds the
number internally in seconds)
There is no default.
Mnemonic: P_TIME

ABSOLUTE TIME Field


This field specifies the Timer start date and time. It is used when TIMER MODE is
ABSST.
Valid entries are in the format:
dd-mmm-yy hh:mm:ss date as month, day, and year and time as hour, minute, and
second (the data base holds the number internally in
seconds
There is no default.
Mnemonic: I_TIME

REPEAT COUNT Field


This field specifies how many times the timer repeats. It is used when TIMER
MODE is P/RE.
Valid entry is any integer
Default is: 1
Mnemonic: REPEAT

426 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the Timer
FCM.

REP_CNT Parameter
REP_CNT indicates the current number of times the timer should repeat. There are
no state values nor state mnemonics for this parameter.

TIME_CNT Parameter
When the timer is running, TIME_CNT gives the amount of time until the timer
reaches 0. When the timer is not running, TIME_CNT gives the amount of time
until the timer starts. There are no state values nor state mnemonics for this
parameter.

OLD_MODE Parameter
This parameter indicates whether the timer is running or not.
State values are:
0 waiting to start the timer
1 timer is running

Tuning and Logging


Table 20 lists parameters having special runtime features for Timer FCMs.

Discussion
The configuration requirements for the FCM depend on the timer mode as described
in the section on the TIMER MODE field. In any mode with a relative or an
absolute start time, as the timer counts down prior to the start time, the result of the
Timer FCM is set to minus the number of seconds remaining before the start of the
first periodic timer cycle. For example, a one minute periodic time with a scan rate

3BUR002336R3701 RevA 427


Counter FCM Section 9 Calculator FCMS

of 1 second that is set for a relative start time of 6 minutes produces the following
result values:
-360, -359, -358, . . . -3, -2, -1, 60, 59, 58, . . . 3, 2, 1, . . .

Counter FCM
Purpose
This is a basic timer whose result is either in seconds or a specified time interval.
This FCM has two inputs. One resets the count, the other enables or disables
counting. You can compare the count to two configured reference values, or you can
initialize the count to a configured value.

Default Name, Algorithm Type, and Relation


The default name for the Counter FCM is CNT. The algorithm is COUNTER. The
FCM is listed on the menu on the Loop Definition Templet by selecting the TIME
softkey. The data base relation is COUNTER_FCM. Keyset 1 for the relation is
DEVLPNUM, FCM_ID.

Algorithm
The result is initialized to the value of the INITIAL OUTPUT field when the FCM
is initialized. When the FCM executes, the value of RESET SOURCE is checked. If
it is 1, the result is reset to the value of INITIAL OUTPUT and FCM processing is
complete.
If the value of RESET SOURCE is 0, the value of the data base flag TIM_EXP2 is
checked. If it is 1, the result is kept at its current value and FCM processing is
complete. If the value of TIM_EXP2 is 0, the ENABLE SOURCE is checked. If the
value of ENABLE SOURCE is 0 (disabled), the result is not changed and FCM
processing is complete. If the value of ENABLE SOURCE is 1 (enabled), the result
is incremented by the amount of elapsed time since the last loop scan. The result is
then checked against the values configured in the LOWER TIME LIMIT and
UPPER TIME LIMIT fields. If the result is greater than or equal to the LOWER
TIME LIMIT value, the data base flag TIM_EXP1 is set to 1. If the result is greater
than or equal to the UPPER TIME LIMIT value, the data base flag TIM_EXP2 is

428 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

set to 1. Timing continues on the next loop scan when TIM_EXP2 is 0. However,
when TIM_EXP2 is 1, the result value is frozen at its current value.

Configurable Parameters
The Counter FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

RESET SOURCE Field


This field specifies the reset source. When the reset signal is not zero, the count is
reset to 0.
Valid entries are:
.fcmname result of another FCM in the loop is the reset signal
tag.fcmname result of a FCM from another loop is the reset signal
There is no default for this field.
Mnemonic: INPUT_1

ENABLE SOURCE Field


This field specifies the enable source. When the enable signal is zero, the count is
suspended.
Valid entries are:
.fcmname result of another FCM in the loop is the enable signal
tag.fcmname result of a FCM from another loop is the enable signal
There is no default for this field.
Mnemonic: INPUT_2

TIME UNITS (SECONDS) Field


This field provides a means to scale the result into the desired time units. The result
is usually calculated in seconds. If this is appropriate for the application, leave this
field at its default value, 1. If another time unit is required, enter the value in this
field. The internal result value (in milliseconds) is converted to seconds and then

3BUR002336R3701 RevA 429


Configurable Parameters Section 9 Calculator FCMS

divided by the entry to become the final result of the FCM. For example, to specify
minutes, enter 60. To specify hours, enter 3600.
Valid entry is a decimal number greater than 0.
Default is: 1.0 (result in seconds)

LOWER TIME LIMIT Field


This field specifies a reference value that the count is compared to. When the count
is less than the value in this field, the data base flag TIM_EXP1 is 0. When the
count is greater than or equal to the value in this field, TIM_EXP1 is set to 1.
Valid entry is a decimal number greater than or equal to 0.
Default is: 2.100000E9
Mnemonic: LO_LIMIT

HIGHER TIME LIMIT Field


This field specifies a reference value that the count is compared to. When the count
is less than the value in this field, the data base flag TIM_EXP2 is 0. When the
count is greater than or equal to the value in this field, TIM_EXP2 is set to 1. When
TIM_EXP2 is 1, the count is frozen at its current value and is not incremented on
subsequent loop scans.
Valid entry is a decimal number greater than or equal to 0.
Default is: 2.100000E9
Mnemonic: HI_LIMIT

430 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

The Counter FCM keeps track of elapsed time internally in


milliseconds (ms), but cannot count for longer than 2.1E9 ms (that
is, a period slightly less than 25 days). Therefore, both the LOWER
TIME LIMIT and HIGHER TIME LIMIT, configured in User Time
Units, must correspond to values within this range.

When making entries to the LOWER TIME LIMIT and HIGHER


TIME LIMIT fields, you must scale the limits appropriately and
write your applications to account for the physical maximum (2^31
ms). To convert a TIME LIMIT in User Time Units to milliseconds,
multiply by the entry in the TIME UNITS field, and then multiply
by 1000. The resulting number must be no greater than 2.1E9. For
example, TIME UNITS=60 (minutes) and proposed TIME
LIMIT=90 (minutes):

(90 min.) x (60 sec./min.) x (1000 ms/sec.) = 5.4E6 which is less


than 2.1E9

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the
Counter FCM.

TIM_EXP1 Parameter
TIM_EXP1 compares the count (result) to the LOWER TIME LIMIT (LO_LIMIT).
State values are:
0 result is less than LOWER TIME LIMIT
1 result is greater than or equal to LOWER TIME LIMIT
There are no state mnemonics available for TCL.

TIM_EXP2 Parameter
TIM_EXP2 compares the count (result) to the UPPER TIME LIMIT (HI_LIMIT).

3BUR002336R3701 RevA 431


Tuning and Logging Section 9 Calculator FCMS

State values are:


0 result is less than UPPER TIME LIMIT
1 result is greater than or equal to UPPER TIME LIMIT. The result is
frozen at current value when TIM_EXP2 goes to 1.
There are no state mnemonics available for TCL.

Tuning and Logging


Table 28 lists parameters having special runtime features for Counter FCMs.

Delay Timer FCM


Purpose
This is a delay timer whose result is ON or OFF. There is one input to this FCM
whose value is also ON or OFF. Two timers are present in the algorithm. One is
related to the time that the input is in the ON state. The other is related to the time
the input is in the OFF state.

Default Name, Algorithm Type, and Relation


The default name for the Delay Timer FCM is DLY. The algorithm is DELAY. The
FCM is listed on the menu on the Loop Definition Templet by selecting the TIME
softkey.
The data base relation is DELAY_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
When the FCM is initialized, the ON and OFF timers are started. If the FCM input
is the same as the previous result (both ON or both OFF) the output remains the
same and both internal timers are reset to 0.
If the FCM input is ON when the previous result is OFF, the ON timer is compared
with the ON DELAY field. If the timer is less, the ON timer is incremented by the
elapsed time since the last loop scan and the result is not changed. If the ON timer is

432 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

greater than or equal to the ON DELAY, the result changes to ON and the ON and
OFF timers are reset to 0.
If the FCM input is OFF when the previous result is ON, the OFF timer is compared
to the OFF DELAY field. If the timer is less, the OFF timer is incremented by the
elapsed time since the last loop scan and the result is not changed. If the OFF timer
is greater than or equal to the OFF DELAY, the result changes to OFF and the ON
timer and OFF timer are reset to 0.

Configurable Parameters
The Delay Timer FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

ON STATE Field
This field allows you to invert the numerical values of the ON and OFF states.
Valid entries are:
NORM 1 = ON and 0 = OFF
INVERT 1 = OFF and 0 = ON
Default is: NORM
Mnemonic: ON_STAT

ON DELAY Field
This field specifies the time to delay when the input is ON and the output is OFF.
Valid entry is an amount of time in milliseconds.
Default is: 0
Mnemonic: ON_DELAY

OFF DELAY Field


This field specifies the time to delay when the input is OFF and the output is ON.
Valid entry is an amount of time in milliseconds.

3BUR002336R3701 RevA 433


Non-configurable Data Base Parameters Section 9 Calculator FCMS

Default is: 0
Mnemonic: OF_DELAY

Non-configurable Data Base Parameters


The non-configurable parameters for the Delay Timer FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 20 lists parameters having special runtime features for Delay Timer FCMs.

Logical AND FCM


Purpose
This FCM performs the AND function on up to 4 inputs. You can configure it to
operate in either a logical or a bitwise mode. In the bitwise mode, you can also
configure bit shifts.

Default Name, Algorithm Type, and Relation


The default name for the Logical AND FCM is AND. The algorithm is
LOGICAL_AND. The FCM is listed on the menu on the Loop Definition Templet
by selecting the LOGIC softkey.
The data base relation is AND_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithms for the Logical AND FCM are:

Logical Mode
If all the defined inputs are not 0, Result = 1. If any of the defined inputs is 0,
Result = 0

434 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

Bitwise Mode
Bits 1 of all inputs are ANDed together to get Bit 1 of the result. Bits 2 are ANDed
together, and so on. The result is a decimal number equivalent to the bit pattern
resulting from the ANDing. Bits in the inputs are shifted to the right or left prior to
ANDing. See Discussion on page 437 for details.

The inputs for this type of FCM are decimal numbers translated into
bit patterns by the FCM. For example, an input of 9 means that bits
0 and 4 are 1 and the rest of the bits are 0.

Configurable Parameters
The Logical AND FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

LOGICAL/BITWISE Field
This field specifies if the mode is logical or bitwise.
Valid entries are:
LOGICAL mode is logical
BITWISE mode is bitwise
Default is: LOGICAL
Mnemonic: LOG_BIT

INPUT SOURCE 2 through 4 Fields


These fields specify the sources of inputs 2, 3 and 4 of the FCM.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There are no defaults.
Mnemonics: INPUT_2, INPUT_3, INPUT_4

3BUR002336R3701 RevA 435


Non-configurable Data Base Parameters Section 9 Calculator FCMS

SHIFT COUNT 1 through 4 Fields


These fields specify how many places the input bits are shifted. SHIFT COUNT 1 is
for input 1, and so on. These fields are used when LOGICAL/BITWISE is
BITWISE.
Valid entries are integer values between 0 and 16.
Default is: 0
Mnemonics: IN1_SHFT for SHIFT COUNT 1,
IN2_SHFT for SHIFT COUNT 2,
IN3_SHFT for SHIFT COUNT 3,
IN4_SHFT for SHIFT COUNT 4

SHIFT DIRECTION 1 through 4 Fields


These fields specify whether input bits are shifted left or right, when
LOGICAL/BITWISE is BITWISE.
Valid entries are:
RIGHT shift input to right
LEFT shift input to left
Default is: LEFT
Mnemonics: IN1_LFRT for SHIFT DIRECTION 1,
IN2_LFRT for SHIFT DIRECTION 2,
IN3_LFRT for SHIFT DIRECTION 3,
IN4_LFRT for SHIFT DIRECTION 4

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the
Logical AND FCM.

436 3BUR002336R3701 RevA


Section 9 Calculator FCMS Tuning and Logging

INP1ENAB through INP4ENAB Parameters


The terms in the algorithm (inp1, inp2, and so on) are enabled and disabled from
TCL programs using these parameters. These parameters turn on and turn off their
respective terms.
State values are:
0 respective input is disabled
1 respective input is enabled
State mnemonics available for TCL are:DISABLED, ENABLED

Tuning and Logging


Table 20 lists parameters having special runtime features for Logical AND FCMs.

Discussion
When LOGICAL/BITWISE is BITWISE, the input bits are ANDed together. Each
input can have up to 16 bits. Left or right shifts are applied to individual inputs
before ANDing. The SHIFT COUNT n field specifies the number of places to shift
Input n. The SHIFT DIRECTION n field specifies whether to shift Input n to the left
or right. Vacated bits are replaced by zeros.

Logical OR FCM
Purpose
This FCM performs the OR function on up to 4 inputs. You can configure it to
operate in either a logical or a bitwise mode. In the bitwise mode, you can also
configure bit shifts.

Default Name, Algorithm Type, and Relation


The default name for the Logical OR FCM is OR. The algorithm is LOGICAL_OR.
The FCM is listed on the menu on the Loop Definition Templet by selecting the
LOGIC softkey.

3BUR002336R3701 RevA 437


Algorithm Section 9 Calculator FCMS

The data base relation is OR_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithms for the Logical OR FCM are:

Logical Mode:
If all of the defined inputs are 0, Result = 0. If any defined input is 1, Result = 1

Bitwise Mode:
Bits 1 of all inputs are ORed together to get Bit 1 of the result. Bits 2 are ORed
together, and so on. The result is a decimal number equivalent to the bit pattern
resulting from the ORing. Bits in the inputs are shifted to the right or left prior
to ORing. See Discussion on page 440, for details.

The inputs for this type of FCM are decimal numbers translated into
bit patterns by the FCM. For example, an input of 9 means that bits
0 and 4 are 1 and the rest of the bits are 0.

Configurable Parameters
The Logical OR FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

LOGICAL/BITWISE Field
This field specifies whether the logical or bitwise version of the algorithm is used.
Valid entries are:
LOGICAL mode is logical
BITWISE mode is bitwise
Default is: LOGICAL
Mnemonic: LOG_BIT

438 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

INPUT SOURCE 2 through 4 Fields


These fields specify the sources of inputs 2, 3 and 4 for the FCM.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There are no defaults.
Mnemonics: INPUT_2, INPUT_3, INPUT_4

SHIFT COUNT 1 through 4 Fields


These fields specify how many positions the bits in the inputs are shifted. SHIFT
COUNT 1 applies to input 1, SHIFT COUNT 2 to input 2, and so on. These fields
are used when LOGICAL/BITWISE is BITWISE.
Valid entries are integer values between 0 and 16.
Default is: 0
Mnemonics: IN1_SHFT for SHIFT COUNT 1
IN2_SHFT for SHIFT COUNT 2
IN3_SHFT for SHIFT COUNT 3
IN4_SHFT for SHIFT COUNT 4

SHIFT DIRECTION 1 through 4 Fields


These fields specify whether the bits in an input are shifted to the left or to the right.
They are used when LOGICAL/BITWISE is BITWISE.
Valid entries are:
RIGHT shift input to right
LEFT shift input to left
Default is: LEFT

3BUR002336R3701 RevA 439


Non-configurable Data Base Parameters Section 9 Calculator FCMS

Mnemonics: IN1_LFRT for SHIFT DIRECTION 1


IN2_LFRT for SHIFT DIRECTION 2
IN3_LFRT for SHIFT DIRECTION 3
IN4_LFRT for SHIFT DIRECTION 4

Non-configurable Data Base Parameters


In addition to the non-configurable parameters (DATAQUAL, DEVLPNUM,
FCM_MODE, INIT_FLG, OUT_MODE and RESULT) described in Common Non-
configurable Parameters on page 338, the following parameter applies for the
Logical OR FCM.

INP1ENAB through INP4ENAB Parameters


The terms in the algorithm (inp1, inp2, and so on) are enabled and disabled from
TCL programs by using these parameters. These parameters turn on and turn off
their respective terms.
State values are:
0 respective input is disabled
1 respective input is enabled
State mnemonics available for TCL are:DISABLED, ENABLED

Tuning and Logging


Table 20 lists parameters having special runtime features for Logical OR FCMs.

Discussion
When LOGICAL/BITWISE is BITWISE, the bits of the inputs are ORed together.
Each input can contain up to 16 bits. Left or right shifts are applied to individual
inputs before ORing. The SHIFT COUNT n field specifies the number of places to
shift Input n. The SHIFT DIRECTION n field specifies whether to shift Input n to
the left or right. Vacated bits are replaced by zeros.

440 3BUR002336R3701 RevA


Section 9 Calculator FCMS Logical NOT FCM

Logical NOT FCM


Purpose
This FCM performs the NOT function on its input. You can configure it to operate
in either a logical or a bitwise mode.

Default Name, Algorithm Type, and Relation


The default name for the Logical NOT FCM is NOT. The algorithm is
LOGICAL_NOT. The FCM is listed on the menu on the Loop Definition Templet
by selecting the LOGIC softkey.
The data base relation is NOT_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithms for the Logical NOT FCM are:

Logical Mode:
If inp = 0, Result = 1. If inp is not 0, Result = 0.

Bitwise Mode:
Individual bits of input are NOTed

The inputs for this type of FCM are decimal numbers translated into
a bit pattern by the FCM. For example, an input of 9 means that bits
0 and 4 are 1 and the rest of the bits are 0.

Configurable Parameters
The Logical NOT FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

3BUR002336R3701 RevA 441


Non-configurable Data Base Parameters Section 9 Calculator FCMS

LOGICAL/BITWISE Field
This field specifies whether the logical or bitwise version of the algorithm is used.
Valid entries are:
LOGICAL mode is logical
BITWISE mode is bitwise
Default is: LOGICAL
Mnemonic: LOG_BIT

Non-configurable Data Base Parameters


The non-configurable parameters for the Logical NOT FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 20 lists parameters having special runtime features for Logical NOT FCMs.

Exclusive OR FCM
Purpose
This FCM performs the exclusive OR function on two inputs. You can configure it
to operate in either a logical or a bitwise mode.

Default Name, Algorithm Type, and Relation


The default name for the Exclusive OR FCM is XOR. The algorithm is
EXCLUSIVE_OR. The FCM is listed on the menu on the Loop Definition Templet
by selecting the LOGIC softkey.
The relation is CMP_EOR_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

442 3BUR002336R3701 RevA


Section 9 Calculator FCMS Algorithm

Algorithm
Inputs for this FCM are digital numbers translated into bit patterns by the FCM. The
algorithms for the Exclusive OR FCM are:

Logical Mode:
In logical mode, all non-zero inputs = 1. The result is determined by the following
truth table:
Inp1 Inp2 Result
0 0 0
0 1 1
1 0 1
1 1 0

Bitwise Mode:
Bits 1 of the inputs are exclusively ORed together to get Bit 1 of the result, and so
on.

Configurable Parameters
The Exclusive OR FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

INPUT SOURCE 2 Field


This field specifies the source of input 2 for the FCM. An entry must be made to this
field
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Mnemonic: INPUT_2

3BUR002336R3701 RevA 443


Non-configurable Data Base Parameters Section 9 Calculator FCMS

LOGICAL/BITWISE ? Field
This field specifies if the mode is logical or bitwise.
Valid entries are:
LOGICAL mode is logical
BITWISE mode is bitwise
Default is: LOGICAL
Mnemonic: LOG_BIT

Non-configurable Data Base Parameters


The non-configurable parameters for the Exclusive OR FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 20 lists parameters having special runtime features for Exclusive OR FCMs.

Set/Reset Flip-flop FCM


Purpose
This FCM provides the Set/Reset Flip-Flop function.

Default Name, Algorithm Type, and Relation


The default name for Set/Reset Flip-Flop is FF. The algorithm is
SET/RESET_FLIP-FLOP. The FCM is listed on the menu on the Loop Definition
Templet by selecting the LOGIC softkey.
The data base relation is SRFF_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

444 3BUR002336R3701 RevA


Section 9 Calculator FCMS Algorithm

Algorithm
The result of this FCM is determined according to the following truth table:
Inp1 Inp2 Result
0 0 prev
0 1 0
1 0 1
1 1 0
where
prev is the value of the result from the previous sample period
any non-zero input is treated as a 1
As long as inp2 (Reset) is 0, the result goes to 1 as soon as inp1 (Set) goes to 1. The
result remains at 1 regardless of the subsequent state of inp1. When inp2 goes to 1,
the result is forced to 0, and remains there as long as inp2 is 1.

Configurable Parameters
The Set/Reset Flip-Flop FCM has the following configurable fields in addition to
the fields described in Common Configurable Fields for Calculator FCMs on page
334.

INPUT SOURCE 2 Field


This field specifies the source of Input 2 for the FCM. An entry must be made in this
field.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Mnemonic: INPUT_2

3BUR002336R3701 RevA 445


Non-configurable Data Base Parameters Section 9 Calculator FCMS

Non-configurable Data Base Parameters


The non-configurable parameters for this FCM are described in Common Non-
configurable Parameters on page 338.

Tuning and Logging


Table 20 lists parameters having special runtime features for Set/Reset Flip-Flop
FCMs.

Discussion
If the application requires, you can leave the set (input 1) or reset (input 2) values
blank on the templet. The system treats the value as 0. If this technique is used, a
YES should be entered in the BAD INPUTS ACCEPTED? field as the undefined
input is given a BAD data quality.

Real Compare FCM


Purpose
This FCM compares two analog signals and provides a logical output if a specified
condition is met.

Default Name, Algorithm Type, and Relation


The default name for the Real Compare FCM is COM. The algorithm is
REAL_COMPARE. The FCM is listed on the menu on the Loop Definition Templet
by selecting the LOGIC softkey.
The data base relation is CPVL_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Real Compare FCM is:
IF inp1 comp inp2 (or comparison constant),
THEN Result NE NORM

446 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

ELSE Result EQ NORM


where
inp1 (INPUT SOURCE 1) and inp2 (INPUT SOURCE 2) are the input signals
comp (COMPARE OPERATOR) represents the type of comparison:
EQ equal to
NE not equal to
GT greater than
GE greater than or equal to
LT less than
LE less than or equal to
NORM is the normal status of the result. You can configure it as 0 or 1.

Configurable Parameters
The Real Compare FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

INPUT SOURCE 2 Field


This field specifies the source of input 2 for the FCM.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Mnemonic: INPUT_2

COMPARISON CONSTANT Field


This field specifies the comparison constant, when INPUT SOURCE 2 is not
specified.
Valid entry is any number.
Default is: 0.0

3BUR002336R3701 RevA 447


Non-configurable Data Base Parameters Section 9 Calculator FCMS

Mnemonic: RD1_K1

COMPARE OPERATOR Field


This field specifies the operator for the comparison constant.
Valid entries are:
EQ equal to
NE not equal to
GT greater than
GE greater than or equal to
LT less than
LE less than or equal to
Default is: EQ
Mnemonic: CMP_OP

NORMAL STATE Field


This field specifies the normal state of the FCM's result.
Valid entries are: 0, 1
Default is: 0
Mnemonic: NORMSTATE

Non-configurable Data Base Parameters


The non-configurable parameters for the Real Compare FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 29 lists parameters having special runtime features for Real Compare FCMs.

448 3BUR002336R3701 RevA


Section 9 Calculator FCMS Selector FCM

Selector FCM
Purpose
This FCM can compare up to four input signals and choose one of them for the
output.

Default Name, Algorithm Type, and Relation


The default name for the Selector FCM is SEL. The algorithm is SELECTOR. The
FCM is listed on the menu on the Loop Definition Templet by selecting the MISC
softkey. The data base relation is SELECTOR_FCM. Keyset 1 for the relation is
DEVLPNUM, FCM_ID.

Algorithm
The FCM can perform parallel, delta, or serial selection on inputs as described in the
discussion.

Configurable Parameters
The Selector FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

INPUT SOURCE 2 through 4 Fields


These fields specify the sources of Inputs 2 through 4 for the FCM.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
There is no default.
Mnemonics: INPUT_2, INPUT_3, INPUT_4

SELECTOR MODE Field


This field configures the selector for serial, parallel or delta selection.

3BUR002336R3701 RevA 449


Configurable Parameters Section 9 Calculator FCMS

Valid entries are:


SERIAL serial selection
PARALLEL parallel selection
DELTA delta selection
Default is: PARALLEL
Mnemonic: SEL_MODE

SELECT OP 1 through 3 Fields


These fields specify the type of comparisons used for the selections that the FCM
can make. SELECT OP 1 should always be defined. The other two SELECT OPs
are defined as needed.
Valid entries are:
LOW select low value
CENTER select center value. For two inputs, the smaller value is chosen. For
four inputs, the second largest is chosen.
HIGH select high value
Default is: LOW
Mnemonics: SELECT_1 for SELECT OP 1,
SELECT_2 for SELECT OP 2,
SELECT_3 for SELECT OP 3

MIN NUMBER OF INPUTS Field


This field specifies the minimum number of inputs with a GOOD data quality that
must be present if the FCM is to perform its algorithm.
Valid entries are: 1, 2, 3, 4, or ALL INPUTS
Default is: ALL INPUTS
Mnemonic: MIN_IMP

450 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the
Selector FCM.

INP1ENAB through INP4ENAB Parameters


The terms in the algorithm (inp1, inp2, and so on) are enabled and disabled from
TCL programs by using these parameters. These parameters turn on and turn off
their respective terms.
State values are:
0 respective input is disabled
1 respective input is enabled
State mnemonics available for TCL are:DISABLED, ENABLED

Tuning and Logging


Table 20 lists parameters having special runtime features for Selector FCMs.

Discussion
You can configure the algorithm to perform either parallel, serial, or delta selection.
Parallel Selection
For parallel selection, the algorithm compares the inputs to find the highest, lowest,
or center value according to the entry in the SELECTOR OP1 field. If there are only
two values when the algorithm is looking for the center, the lower value is selected.
If there are four values, the second largest is selected. See Figure 68.
Serial Selection
For serial selection, Input 1 is compared to Input 2 according to the entry in the
SELECTOR OP1 field. If no other input is turned on, this is the selected output. If
Input 3 is turned on, it is compared to the result of the Input 1/Input 2 selection
according to the entry in the SELECTOR OP2 field. This result is the selected
output if no other input is on. If Input 4 is on, it is compared to the result of the

3BUR002336R3701 RevA 451


Discussion Section 9 Calculator FCMS

previous selection according to the entry in the SELECTOR OP3 field. See
Figure 69 through Figure 71.
Delta Selection
For delta selection, Inputs 1 and 2 are compared according to the entry in the
SELECTOR OP1 field. If no other input is turned on, the result is the selected
output. If Input 3 is turned on, it is compared according to the entry in the
ELECTOR OP3 field with the result of the Input 1/Input 2 selection. The result is
the selected output. If Inputs 3 and 4 are turned on, they are compared according to
the entry in the SELECTOR OP2 field. This result is compared according to the
entry in the SELECTOR OP3 field with the results of the Input 1/Input 2 selection.
See Figure 69 through Figure 71.

Input 1
Input 2
Selector 1 Selected Output
Input 3
Input 4
High

Center Selector
Op1

Low

Figure 68. Parallel Signal Selection

452 3BUR002336R3701 RevA


Section 9 Calculator FCMS Discussion

Input 1
Selector 1 Selected Output
Input 2

High

Center Selector
Op1

Low

Figure 69. Serial and Delta Selection with 2 Inputs

Input 1
Selector 1
Input 2
High

Center Selector
Op1
Selector 2 Selected
Input 3 Output
Low
High

Center Selector
Op2

Low

Figure 70. Serial and Delta Selection with 3 Inputs

3BUR002336R3701 RevA 453


Put Generic Value FCM Section 9 Calculator FCMS

Input 1
Selector 1
Input 2
High

Selector
Center Op1
Selector 2
Low
Input 3
High
Selector
Center Op2

Low

Selector 3 Output
Input 4
High
Selector
Center Op3

Low

Figure 71. Serial and Delta Selection with 4 Inputs

Put Generic Value FCM


Purpose
The FCM writes its result to a user-specified destination parameter in the Controller,
Multibus I/O, Data Processor, or Interface Subsystem containing the FCM. The
result may come from either the INPUT SOURCE field or the CONSTANT TO
PUT field. There are two ways to specify location of the destination parameter:

454 3BUR002336R3701 RevA


Section 9 Calculator FCMS Default Name, Algorithm Type, and Relation

OUTPUT DESTINATION or RELATION name. In most cases OUTPUT


DESTINATION is recommended.

Default Name, Algorithm Type, and Relation


The default name for Put Generic Value is PUT. The algorithm is
PUT_GENERIC_VALUE. The FCM is listed on the menu on the Loop Definition
Templet by selecting the MISC softkey.
The data base relation is PUT_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The FCM writes its result to the destination parameter each time the FCM is
executed.

Configurable Parameters
The Put Generic Value FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

OUTPUT DESTINATION Field


You should use this field to specify output destination when the destination
parameter is in a continuous loop, a device loop, or an FCM. When the destination
is in a continuous loop or a device loop, you must enter a code that represents the
relation that contains the parameter. The tables in the Data Base Tables manual may
help you determine which relation contains the parameter.
When you use this field, leave the RELATION NAME, KEY NAME 1-5, and KEY
VALUE 1-5 fields blank.
Valid entries for OUTPUT DESTINATION are:
tag.fcmname FCM from another loop
.fcmname FCM in the same loop
tag.CTR continuous loop with the destination parameter in the
CTRLOOP_DAT relation

3BUR002336R3701 RevA 455


Configurable Parameters Section 9 Calculator FCMS

tag.DEV discrete loop with the destination parameter in the


DEV_LOOP_DAT relation
tag.LCM discrete or continuous loop with the destination parameter in the
LCM_DEFIN_N relation
Mnemonic: OUT_DEST

RELATION NAME Field


This field is only used when the destination parameter must be accessed via
relational means. The OUTPUT DESTINATION field should be used instead of this
field when possible.
When an entry is made to the RELATION NAME field, entries must also be made
to the appropriate number of KEY NAME and KEY VALUE fields.
Valid entry is the name of the relation containing the destination parameter.
Relations are described and listed in the Data Base Tables manual.

KEY NAME 1 through 5 Fields


These fields are used to give the names of the keys for the relation named in the
RELATION NAME field. They are only used when relational access is used.
Relations have from 1 to 5 keys. Use as many KEY NAME fields as required for the
relation. For example, for most FCM relations, the entries would be KEY NAME 1
= DEVLPNUM and KEY NAME 2 = FCM_ID.
Valid entries are names for relation keys. Data base relations and their keys are
listed in the Data Base Tables manual.

KEY VALUE 1 through 5 Fields


These fields are used to give the values of the keys named in the KEY NAME
fields. Put the value of the key named in the KEY NAME 1 field into the KEY
VALUE 1 field, and so on.
Valid entries are values of key variables.

456 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

ATTRIBUTE NAME Field


This field specifies the mnemonic of the destination parameter.
Valid entry is a parameter mnemonic.
Mnemonic: AID

CONSTANT TO PUT Field


This field specifies a constant to put to the destination parameter. This field is used
if no input source is defined in the INPUT SOURCE field.
Valid entry is any decimal number.
Default is: 0.0
Mnemonic: RD1_K1

Non-configurable Data Base Parameters


The non-configurable parameters for the Put Generic Value FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 30 lists parameters having special runtime features for Put Generic Value
FCM.

Discussion
There are two ways to specify value put to the destination parameter. If there is an
entry in the INPUT SOURCE field, the FCM automatically uses that source. If there
is no entry in the INPUT SOURCE field, the FCM uses the value in the
CONSTANT TO PUT field.
There are two ways to specify the location of the destination parameter. Use the
OUTPUT DESTINATION and ATTRIBUTE NAME fields when the parameter is
in a device loop, a continuous loop, or an FCM. When relational access is required,
use the ATTRIBUTE NAME field and as many KEY NAME and KEY VALUE
fields as are necessary to access the relation containing the parameter.

3BUR002336R3701 RevA 457


Get Generic Value FCM Section 9 Calculator FCMS

A variable from one node can be Put to another node by configuring a Put FCM on
the destination node. This is possible because the input to a Put FCM can be the
result of an FCM from another node. If the source parameter is not a result, a Get
FCM on the source node can be configured to get the parameter value as its result.

Get Generic Value FCM


Purpose
The FCM acquires the value of a user-specified source parameter in the Controller,
Multibus I/O, Data Processor, or Interface Subsystem containing the FCM. You can
also obtain the data quality of the source parameter. You can also configure the
FCM to acquire the current state of an alarm for a measured variable, a setpoint, a
deviation, an output, and so on.

Default Name, Algorithm Type, and Relation


The default name for Get Generic Value is GET. The algorithm is
GET_GENERIC_VALUE. The FCM is listed on the menu on the Loop Definition
Templet by selecting the MISC softkey. The data base relation is GET_FCM.
Keyset 1 for the relation is DEVLPNUM, FCM_ID.

Algorithm
The result of this algorithm is set equal to the parameter being acquired.

Configurable Parameters
The Get Generic Value FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

RELATION NAME Field


This field is only used when the source parameter must be accessed via relational
means. The INPUT SOURCE field should be used instead of this field when
possible.

458 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

When an entry is made to the RELATION NAME field, entries must also be made
to the appropriate number of KEY NAME and KEY VALUE fields.
Valid entry is name of the relation containing the source parameter. Relations are
described and listed in the Data Base Tables manual.

KEY NAME 1 through 5 Fields


These fields are used to give the names of the keys for the relation named in the
RELATION NAME field. They are only used when relational access is used.
Relations have from 1 to 5 keys. Use the number of KEY NAME fields required for
the relation. For example, for most FCM relations, the entries are KEY Name 1 =
DEVLPNUM and KEY NAME 2 = FCM_ID.
Valid entries are names for relation keys. Data base relations are listed in Data Base
Tables.

KEY VALUE 1 through 5 Fields


These fields are used to give the values of the keys named in the KEY NAME
fields. Put the value of the key named in the KEY NAME 1 field into the KEY
VALUE 1 field, and so on.
Valid entries are values of key variables.

INPUT SOURCE Field


You should use this field to specify the input source when the source parameter is in
a continuous loop, a device loop, or an FCM. When the parameter is in a continuous
loop or a device loop, enter a code that represents the relation that contains the
parameter. The tables in the Data Base Tables manual may help you determine
which relation contains the parameter.
When you use this field, leave RELATION NAME, KEY NAME, and KEY
VALUE blank.
Valid entries:
tag.fcmname FCM from another loop
.fcmname FCM in the same loop

3BUR002336R3701 RevA 459


Configurable Parameters Section 9 Calculator FCMS

tag.CTR continuous loop with the source parameter in the CTRLOOP_DAT


relation
tag.DEV discrete loop with the source parameter in the DEV_LOOP_DAT
relation.
tag.LCM discrete or continuous loop with the source parameter in the
LCM_DEFIN_N relation.
Mnemonic: OUT_DEST

ATTRIBUTE NAME Field


This field specifies the mnemonic of the source parameter. An entry must be made
to this field.
Valid entry is a parameter mnemonic.
Mnemonic: AID

DATAQUAL ATTRIBUTE Field


This field specifies the parameter from which to obtain the data quality of the
parameter named in the ATTRIBUTE NAME field. When this parameter is
obtained it is stored in the data quality of the result parameter (DATAQUAL).
Valid entry is a parameter mnemonic.
Mnemonic: DQ_ATTR

ALARM CONDITION Field


This field is used to get the current status of an alarm for the parameter named in the
ATTRIBUTE NAME field. This field specifies the type of alarm to check. It must
be appropriate for the entry in the ATTRIBUTE NAME field. For example, the
SETPT HI entry for this field should only be used when the entry in the
ATTRIBUTE NAME field is a setpoint. You can check only one alarm for a
variable. The alarm status becomes the result of the Get FCM.

460 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Valid entries are:


NONE do not obtain an alarm state
DQ BAD measured variable bad data quality alarm
HIHI measured variable high high alarm
HI measured variable high alarm
LO measured variable low alarm
LOLO measured variable low low alarm
IROC HI measured variable input rate of change alarm
OUT DQ B output bad data quality alarm
OUT HI output high alarm
OUT LO output low alarm
OUT IRC output rate of change alarm
SETPT DQ setpoint bad data quality alarm
SETPT HI setpoint high alarm
SETPT LO setpoint low alarm
DEV DQ BD deviation bad data quality alarm
DEV HI deviation high alarm
DEV LO deviation low alarm
Default is: NONE

Non-configurable Data Base Parameters


The non-configurable parameters for the Get Generic Value FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 20 lists parameters having special runtime features for Get Generic Value
FCMs.

3BUR002336R3701 RevA 461


Discussion Section 9 Calculator FCMS

Discussion
There are two ways to specify source parameter. Use the INPUT SOURCE and
ATTRIBUTE NAME fields when the parameter is in a device loop, a continuous
loop, or an FCM. When relation access is required, use the ATTRIBUTE NAME
field and as many KEY NAME and KEY VALUE fields as are necessary to access
the relation containing the parameter.
To get the data quality of the source parameter, enter the mnemonic for the data
quality parameter of the source parameter in the DATAQUAL ATTRIBUT field.
When the GET is performed, the value of this parameter is stored in the
DATAQUAL parameter of the Get FCM.
To get the current status of an alarm condition, enter the mnemonic of the variable
in question in the ATTRIBUTE NAME field and make the proper entry in the
ALARM CONDITION field. When the GET is performed, the alarm status is stored
as the result of the Get FCM.
You can use the Get FCM to transfer the value of a parameter from one node to
another. For example, if the setpoint of a loop must be communicated to a loop in
another node, use a Get FCM in the source node to get the setpoint value. This sets
the result of the Get FCM equal to the setpoint value. The loop in the destination
node can reference the result of the Get FCM.

Select Next FCM


Purpose
This FCM compares two inputs and determines which FCM in the loop is processed
next.

Default Name, Algorithm Type, and Relation


The default name for the Select Next FCM is SFC. The algorithm is
SELECT_NEXT_FCM. The FCM is listed on the menu on the Loop Definition
Templet by selecting the MISC softkey. The relation is SEL_NEXT_FCM. Keyset 1
for the relation is DEVLPNUM, FCM_ID.

462 3BUR002336R3701 RevA


Section 9 Calculator FCMS Algorithm

Algorithm
The algorithm for the Select Next FCM is:
If Inp1 comp Inp2 (or comparison constant)
THEN process ALTFCM
ELSE process NEXTFCM
where
inp1 (INPUT SOURCE 1) and inp2 (INPUT SOURCE 2) are the input signals
comp (COMPARE OPERATOR) represents the type of comparison:
EQ equal to
NE not equal to
GT greater than
GE greater than or equal to
LT less than
LE less than or equal to
ALTFCM is the alternate FCM processed if the comparison is true. It must be after
the Select Next FCM in the loop. NEXTFCM is the FCM following the Select Next
FCM in the loop. It is processed if the comparison is false.

If expression is TRUE

SELECT ALT. FCM


NEXT FCM NEXT FCM ALT. FCM

If expression is FALSE

Configurable Parameters
The Select Next FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

3BUR002336R3701 RevA 463


Configurable Parameters Section 9 Calculator FCMS

INPUT SOURCE 2 Field


This field specifies the Input 2 source. Input 1 is compared to Input 2 if INPUT
SOURCE 2 is specified. If not, Input 1 is compared to the COMPARISON
CONSTANT.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Mnemonic: INPUT_2

COMPARISON CONSTANT Field


This field specifies the value for the comparison constant. Input 1 is compared to the
comparison constant if no entry is made to the INPUT SOURCE 2 field.
Valid entry is any number.
Default is: 0.0
Mnemonic: RD1_K1

COMPARE OPERATOR Field


This field specifies the value for the comparison constant.
Valid entries are:
EQ equal to
NE not equal to
GT greater than
GE greater than or equal to
LT less than
LE less than or equal to
Default is: EQ
Mnemonic: CMP_OP

464 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

ALT FCM NAME Field


This field specifies the FCM executed if the comparison is true. If the comparison is
false, the next FCM in the loop is executed.
Valid entries are:
.fcmname another FCM in the loop is the destination
END no more FCMs in the loop are processed
Mnemonic: SEL_FCM
An entry must be made in this field.

Non-configurable Data Base Parameters


The non-configurable parameters for the Select Next FCM are described in
Common Non-configurable Parameters on page 338.

Tuning and Logging


Table 29 lists parameters having special runtime features for Select Next FCMs.

Discussion
If the data quality for either Input 1 or Input 2 is BAD, the algorithm still processes
and selects the next FCM to execute. However, the data quality of the Select Next
FCM result will be BAD.

Redundant Signal Selector FCM


Purpose
This FCM provides a backup signal from another source in the event that the
primary signal data quality goes BAD.

Default Name, Algorithm Type, and Relation


The default name for the Redundant Signal Selector FCM is RED. The algorithm is
REDUNDANT_SIGNAL.

3BUR002336R3701 RevA 465


Algorithm Section 9 Calculator FCMS

The data base relation is RDSS_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Redundant Signal Selector FCM is:
IF entry in BAD INPUTS ACCEPTED? field = NO and if qual = GOOD,
THEN Result = inp1, ELSE Result = inp2, ELSE Result = inp1
where
inp1 (INPUT SOURCE 1) and inp2 (INPUT SOURCE 2) are the input signals
qual is the data quality of Input 1

Configurable Parameters
The Redundant Signal Selector FCM has the following configurable fields in
addition to the fields described in Common Configurable Fields for Calculator
FCMs on page 334.

INPUT SOURCE 2 Field


This field specifies the source of Input 2 for the FCM.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Mnemonic: INPUT_2
An entry must be made in this field.

Non-configurable Data Base Parameters


The DATAQUAL, DEVLPNUM, FCM_MODE, INIT_FLG, OUT_MODE and
RESULT are described in Common Non-configurable Parameters on page 338.

466 3BUR002336R3701 RevA


Section 9 Calculator FCMS Tuning and Logging

Tuning and Logging


Table 20 lists parameters having special runtime features for Redundant Signal
Selector FCMs.

Input Limiter FCM


Purpose
This FCM defines analog input high and low limits. When the input exceeds the
high or low limit, the input value is clamped at the specified limit and a flag is set.
The input remains clamped as long as it exceeds the limit. The flag remains set until
the input crosses a configured deadband (below the high limit or above the low
limit). Even after the input returns within the boundaries of the high and low limits
and is no longer clamped, the flag remains set until the input crosses the deadband.
This prevents the flag from being continuously set and reset if the input oscillates
around one of the limits. The deadband is configured on the CCF templet.

Default Name, Algorithm Type, and Relation


The default name for the Input Limiter FCM is LIM. The algorithm is
INPUT_LIMITER. The FCM is listed on the menu on the Loop Definition Templet
by selecting the MISC softkey.
The data base relation is LIMT_PINP. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Input Limiter FCM is:
IF LO < inp < HI, THEN Result = inp
AND HI-FLAG = FALSE AND LO-FLAG = FALSE
IF inp < LO AND LO-ENAB =ENABLED,
THEN Result = LO AND LO-FLAG = TRUE
IF inp > HI AND HI-ENAB = ENABLED,
THEN Result = HI AND HI-FLAG = TRUE

3BUR002336R3701 RevA 467


Configurable Parameters Section 9 Calculator FCMS

where:
inp (INPUT SOURCE) is the input value
HI (HI LIMIT) is the high limit
LO (LO LIMIT) is the low limit
HI_FLAG is the high-limit-in-effect indicator
LO_FLAG is the low-limit-in-effect indicator
LO ENAB (ENABLE LOW LIMIT) is the low limit enable parameter
HI ENAB (ENABLE HIGH LIMIT) is the high limit enable parameter

Configurable Parameters
The Input Limiter FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

HI LIMIT Field
This field specifies the value of the high limit.
Valid entry is any number greater than the value of the low limit.
Default is: 100.0
Mnemonic: HI_LIMIT

LO LIMIT Field
This field specifies the value of the low limit.
Valid entry is any number less than the value of the high limit.
Default is: 0.0
Mnemonic: LO_LIMIT

ENABLE HIGH LIMIT Field


This field specifies whether the high limit is enabled.

468 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

Valid entries are:


NO high limit is disabled
YES high limit is enabled
Default is: YES
Mnemonic: HI_ENAB

ENABLE LOW LIMIT Field


This field specifies whether the low limit is enabled.
Valid entries are:
NO low limit is disabled
YES low limit is enabled.
Default is: YES
Mnemonic: LO_ENAB

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the Input
Limiter FCM.

HI_FLAG Parameter
This parameter specifies the state of the high limit flag.
State values are:
0 false
1 true
There are no state mnemonics available for TCL.

LO_FLAG Parameter
This parameter specifies the state of the low limit flag.

3BUR002336R3701 RevA 469


Tuning and Logging Section 9 Calculator FCMS

State values are:


0 false
1 true
There are no state mnemonics available for TCL.

Tuning and Logging


Table 31 lists parameters having special runtime features for Input Limiter FCMs.

Discussion
The deadband for high and low values is defined in the CCF Templet. The deadband
is defined as a percentage of the range so it can apply to FCMs with different
ranges.
When the input value moves within the deadband limits, it is clamped at the edge of
the deadband.

User Calculations FCM


Purpose
The User Calculations (UCAL) feature allows you to add user-defined algorithms to
CCF processing. Implementing this feature requires two main steps:
• A TCL program to execute the algorithm must be edited, compiled, and loaded.
• A CCF loop with a UCAL FCM must be configured. When processed, the
UCAL FCM starts the TCL program and makes variables available to it. The
program can also pass variables back to the UCAL FCM.
Detailed information about the interaction of the loop and the program is provided
in Discussion on page 473.

Default Name, Algorithm Type, and Relation


The default name for User Calculations is UCL. The algorithm is
USER_CALCULATIONS. The FCM is listed on the menu on the Loop Definition

470 3BUR002336R3701 RevA


Section 9 Calculator FCMS Algorithm

Templet by selecting the MISC softkey. The relations are UCAL_FCM and
UCAL_INPUTS. Keyset 1 for these relations is DEVLPNUM.

Algorithm
The algorithm is determined by the TCL program as described in Discussion on
page 473.

Configurable Parameters
The User Calculations FCM has the following configurable fields in addition to the
fields described in Common Configurable Fields for Calculator FCMs on page 334.

INPUT SOURCE 1 through 4 Fields


These fields specify the sources of Inputs 1 through 4 for the FCM.
Valid entries are:
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Mnemonics: INPUT_1, INPUT_2, INPUT_3, INPUT_4

INIT VALUE FOR VAR 1 through 4 Fields


These fields specify the initial values for the four scratch pad variables, VAR1 to
VAR4, which you can use in the TCL program. See Discussion on page 473.
Valid entry is any number.
Default is: 0.0
Mnemonics: VAR1 for INIT VAL FOR VAR 1
VAR2 for INIT VAL FOR VAR 2
VAR3 for INIT VAL FOR VAR 3
VAR4 for INIT VAL FOR VAR 4

SEQUENCE ID Field
This field is not operable. Do not make any entries to it.

3BUR002336R3701 RevA 471


Non-configurable Data Base Parameters Section 9 Calculator FCMS

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the User
Calculations FCM.

DATA1 through DATA4 Parameters


These parameters specify the current values of Inputs 1 through 4. See Discussion
on page 473.
There are no state values nor state mnemonics available for TCL for this parameter.

DAPL_F1 through DAPL_F4 Parameters


These parameters specify the data qualities of Inputs 1 through 4. See Discussion on
page 473.
State values are:
0 data quality is bad
1 data quality is good
There are no state mnemonics available for TCL.

PROC_DQ Parameter
This parameter should be used by the TCL program to return the data quality of the
value returned via the PROC_VAL parameter. See Discussion on page 473.
State values are:
0 data quality is bad
1 data quality is good
There are no state mnemonics available for TCL.

PROC_VAL Parameter
This parameter should be used by the TCL program to return the result of its
calculation. This value is then copied into the result of the FCM. See Discussion on

472 3BUR002336R3701 RevA


Section 9 Calculator FCMS Tuning and Logging

page 473.
There are no state values nor state mnemonics available for TCL for this parameter.

TIME_CNT Parameter
This parameter specifies the value of the time counter. There are no state values nor
state mnemonics available for TCL for this parameter.

Tuning and Logging


Table 32 lists parameters having special runtime features for User Calculations
FCMs.

Discussion
There are two methods for TCL to implement the UCAL calculation:
• A synchronous UCAL is implemented by a TCL external subroutine which
executes quickly. TCL can re-enter the subroutine, therefore, more than one
CCF loop can use a given UCAL subroutine. However, the subroutine can only
manipulate local data such as loads, stores, and mathematical functions. It
cannot access the data base.
• An asynchronous UCAL is implemented by a TCL program. The TCL
program can access the data base, but it usually executes more slowly than a
synchronous UCAL.

Configuring the Loop Containing the UCAL FCM


When you configure a loop with either a synchronous or asynchronous UCAL
FCM, consider:
• A CCF loop can have only one UCAL FCM whose name must be UCL. Unlike
other FCMs, you cannot change its name.
• For an asynchronous UCAL FCM, the loop must be given a processing rate at
least twice the base rate of the node where the loop resides. When you specify
the processing rate, remember the maximum time for the TCL program to
complete its execution is somewhat less than the processing rate of the loop.

3BUR002336R3701 RevA 473


Discussion Section 9 Calculator FCMS

Configuring the UCAL FCM


The following points should be kept in mind when configuring the UCAL FCM:
• You can configure up to four inputs for the UCAL FCM using the INPUT
SOURCE 1 through 4 fields. When the UCAL FCM is processed, these inputs
are sampled and placed in the DATA1 through DATA4 parameters. These
parameters and their respective data qualities, DAPL_F1 through DAPL_F4,
are accessible by the TCL program.
• Initial values of up to four scratch pad variables are configured in the INIT
VALUE FOR VARIABLE 1 through 4 fields. These initial values are stored in
VAR1 through VAR4. They are accessible by the TCL program.

Loading and Removing TCL Subroutines and Programs


Before the UCAL FCM is processed, the TCL subroutine or program must be made
available to the CCF loop by loading it from a TCL program via a LOAD statement
in the form:
LOAD ('UCAL','prog','tag');
where
prog is the name of the subroutine or program performing the algorithm
tag is the tag of the loop containing the UCAL FCM
To modify a loaded subroutine or program, remove it with a REMOVE statement in
the form:
REMOVE ('UCAL','prog','tag');
and load the modified version with a LOAD statement.
For processing to occur, the CCF loop and UCAL FCM must be on. One way to
accomplish this is with an Auto Load TCL program for the unit. You can design the
program to load all UCAL programs and subroutines for the unit at system
initialization time, and turn on the CCF loops and FCMs when loading is complete.

Synchronous UCAL Implementation and Processing


Writing the TCL External Subroutine for a Synchronous UCAL FCM

474 3BUR002336R3701 RevA


Section 9 Calculator FCMS Discussion

The UCAL FCM passes parameters to the TCL subroutine by reference. This allows
the subroutine to manipulate the parameters as dictated by the subroutine
statements. The modified parameters are then readily available to the UCAL FCM.
The first statement of the subroutine must be in the form:
SUBR name(VAR DATA_ARRAY: ARRAY [1..4] OF REAL;
VAR VALU_ARRAY: ARRAY [1..4] OF REAL;
VAR PROC_VAL: REAL;
VAR DATA_QUALS: ARRAY [0..4] OF BYTES;
VAR LOOP_ARRAY: ARRAY [n..m] OF datatype;
);
where
name becomes the subroutine name
DATA_ARRAY stores values of inputs 1 to 4. Each time the loop runs, it gets
current values for the inputs to pass to the subroutine.
VALU_ARRAY stores four scratch pad values. When the node is initialized, the
scratchpad values are set to initial values as specified by the
INIT VALUE FOR VAR n fields. During runtime, their values
are determined by the TCL subroutine, that is, the values CCF
passes to TCL are the values TCL passed to CCF the previous
time the UCAL finished executing.
PROC_VAL should be used to store the result of the TCL subroutine. When
the subroutine is finished, the UCAL FCM writes the value of
PROC_VAL to its result.
DATA_QUALS the zeroth element of this array is the data quality of
PROC_VAL. The TCL subroutine should set this value after it
has made its calculation.
Elements 1 to 4 are the data qualities related to the four elements
of DATA_ARRAY. When the CCF loop executes, it sets these
values to represent the current data qualities of the inputs. 0
indicates bad data, 1 indicates good.
LOOP_ARRAY is an array used if more data area is needed.

3BUR002336R3701 RevA 475


Discussion Section 9 Calculator FCMS

The subroutine's calculation result should be written to the PROC_VAL variable. Its
data quality should be placed in the zeroth element of the DATA_QUALS array.
When the external subroutine is finished, the UCAL FCM performs some error
checking. If no errors occurred, the value of the PROC_VAL parameter is copied to
the UCAL's RESULT parameter, and the value of the DATA_QUALS[0] parameter
is copied to the DATAQUAL (result data quality) parameter.
I/O, unit-related, and data base access statements cannot be used in synchronous
UCAL’s. These statements include:
SET REPLY
FETCH UNIT_ALARM
INPUT STARTBATCH
OUTPUT ENDBATCH
*RECIPE RECORD
ACTIVATE TRENDON / TRENDOFF
MESG REPORT
After you write the subroutine, you should compile it.
Processing of Loops Containing Synchronous UCAL FCMs
A loop with a synchronous UCAL FCM is processed in almost the same manner as
a standard CCF loop. The events occur as follows:
1. The FCMs preceding the UCAL FCM are executed.
2. The UCAL FCM is executed. It passes parameters by reference to the TCL
subroutine. The CCF Loop Processor waits for the subroutine to complete
processing.
3. When the subroutine is finished, the UCAL FCM makes the result of the TCL
calculation into its result.
4. The remaining FCMs execute.
5. The Loop Processor goes on to the next loop.

476 3BUR002336R3701 RevA


Section 9 Calculator FCMS Discussion

Asynchronous UCAL Implementation and Processing


Writing the TCL Program for an Asynchronous UCAL FCM
Consider the following when you write a TCL program for an asynchronous UCAL
FCM:
• The maximum allowed time for the program to execute is one CCF base rate
less than the loop scan rate.
• The result of the program's calculation should be made in the result of the
UCAL FCM. The preferred method is to pass the result of the program's
calculation to the PROC_VAL parameter of the UCAL FCM. The
corresponding data quality should be passed to the PROC_DQ parameter. The
UCAL FCM performs error checking on these parameters. If no errors
occurred, the value of PROC_VAL is copied to the RESULT, and the value of
PROC_DQ is copied to DATAQUAL (result data quality).
The PROC_VAL and PROC_DQ parameters are referenced using the tag and
FCM name. For example, when the default name of the UCAL FCM is used,
PROC_VAL is used in TCL expressions in the following format:
$'tag'-'UCL'.PROC_VAL
• The following statements cannot be used in asynchronous UCAL FCM
programs: ACTIVATEENDBATCH, MESGRECORD, REPLYTRENDON /
TRENDOFF, UNIT_ALARM*RECIPE, STARTBATCHREPORT.
• After you write the program, you should compile and link it.
A TCL procedure can get any of the following data base parameters associated with
the UCAL:
DATA1 UCAL FCM Input 1
DATA2 UCAL FCM Input 2
DATA3 UCAL FCM Input 3
DATA4 UCAL FCM Input 4
DAPL_F1 Data Quality of Input 1
DAPL_F2 Data Quality of Input 2
DAPL_F3 Data Quality of Input 3

3BUR002336R3701 RevA 477


Discussion Section 9 Calculator FCMS

DAPL_F4 Data Quality of Input 4


VAR1 Initial Value of Variable 1
VAR2 Initial Value of Variable 2
VAR3 Initial Value of Variable 3
VAR4 Initial Value of Variable 4
These values are accessed using the tag and FCM name. For example, when the
default name for the UCAL FCM is used, the value of UCAL FCM Input 1
(DATA1) is accessed by an expression in the form:
$'tag'-'UCL'.DATA1
Thus, you can pass the program result (UCAL_DATA) to the PROC_VAL
parameter in the UCAL using the following expression:
$'TIC101'-'UCL'.PROC_VAL:= UCAL_DATA;
Processing of Loops Containing Asynchronous UCAL FCMs
A loop with a UCAL FCM is processed as follows:
1. The FCMs preceding the UCAL FCM are executed.
2. The UCAL FCM is executed. It starts the TCL program. The Loop Processor
does not wait for the program to complete. It puts the loop with the UCAL
FCM on quick scan. Any FCMs that follow the UCAL FCM are not processed
at this point.
3. The Loop Processor goes on to other loops.
4. While the loop with the UCAL FCM is on quick scan, the Processor does not
wait for the next scan to check this loop. Instead it checks the UCAL FCM at
every base rate cycle.
For example, if the loop scan rate is 4 seconds and the CCF base rate is 1
second, the loop is started and the UCAL FCM is processed between seconds 0
and 1. The UCAL FCM is checked between seconds 1 and 2, and, if needed,
between seconds 2 and 3, and 3 and 4. What occurs when the UCAL FCM is
checked depends on the status of the TCL program:
– If the program is finished, the UCAL FCM and the remaining FCMs are
processed. The loop is put back on normal scan rate and the Processor

478 3BUR002336R3701 RevA


Section 9 Calculator FCMS Data Entry FCM

goes to the next loop.


– If the program timed out (did not complete within the loop scan rate), the
UCAL FCM is turned off, its data quality goes to BAD, the remaining
FCMs of the loop are processed, and the loop is put back on its normal
scan rate. The Loop Processor goes on to the next loop.
– If the program does not finish or time out, the Processor goes to the next
loop. The loop with UCAL FCM stays on quick scan and is checked at the
next base rate cycle. The program must finish by the base rate cycle before
the next scheduled scan. For example, if the loop scan is 4 seconds and the
base rate is 1 second, the program must finish before the Loop Processor
checks it between seconds 3 and 4. If the program does not finish by this
time, the UCAL FCM is turned off, its data quality goes BAD, remaining
FCMs are processed, and the loop is put back on normal scan rate.

Data Entry FCM


Purpose
This FCM allows you to store 20 decimal values in the data base for use by other
applications.

Default Name, Algorithm Type, and Relation


The default name for the Data Entry FCM is DAT. The algorithm is DATA_ENTRY.
The FCM is listed on the menu on the Loop Definition Templet by selecting the
MISC softkey. The data base relation is FCM_DATA. Keyset 1 for the relation is
DEVLPNUM, FCM_ID.

For Data Entry FCMs, four fcmnames have been reserved for
System Performance Data: SYS, MEM, ME1, STK. SYS contains
system and CCF loading information. MEM and ME1 contain
memory pool information. STK contains CCF stack usage data.

3BUR002336R3701 RevA 479


Algorithm Section 9 Calculator FCMS

Algorithm
The FCM makes the data designated in the RESULT ENTRY field the result of the
FCM.

Configurable Parameters
The Data Entry FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

VALUE 1 through 20 Fields


These fields specify the 20 decimal values that the FCM can hold.
Valid entries are decimal numbers.
Default is: 0.0
Mnemonic: DATA1 for VALUE 1 through DATA20 for VALUE 20
The mapping of data for the SYS Data Entry FCM is as follows:
DATA1 CPU load "samples since" time year and month. YYYYMM.0
DATA2 CPU load "samples since" time day, hour and minutes.
DDHHMM.0
DATA3 CPU load number of samples
DATA4 CPU load current %
DATA5 CPU load average %
DATA6 CPU load peak %
DATA7 CCF load "samples since" time year and month. YYYYMM.0
DATA8 CCF load "samples since" time day, hour and minutes.
DDHHMM.0
DATA9 CCF load number of samples
DATA10 CCF load current %
DATA11 CCF load average %
DATA12 CCF load peak %
DATA13 CCF current number of loops
DATA14 CCF average number of loops
DATA15 CCF peak number of loops
DATA16 CCF base rate, in seconds
DATA17 Unused

480 3BUR002336R3701 RevA


Section 9 Calculator FCMS Configurable Parameters

DATA18 Unused
DATA19 Unused
DATA20 Unused

Setting DATA1 of a SYS Data Entry FCM to zero resets the CPU
portion of the System Performance display. Setting DATA7 of a
SYS Data Entry FCM to zero resets the CCF portion of the System
Performance display.

The mapping of data for the MEM Data Entry FCM is as follows:
DATA1 Memory utilization "samples since" time year and month.
YYYYMM.0
DATA2 Memory utilization "samples since" time day, hour and minutes.
DDHHMM.0
DATA3 Memory utilization number of pools up to 8
DATA4 Memory utilization number of samples
DATA5 Memory utilization memory size, in Mbytes
The mapping of the remaining data for the MEM Data Entry FCM and data for the
ME1 Data Entry FCMs (for example, size in KBybtes, current % used, and peak %
used) is entered in order, starting with pool 0, for all of the memory pools as
follows:
DATA6 Pool 0 size in KB
DATA7 Pool 0 current % used
DATA8 Pool 0 peak % used
DATA9 Pool 1 size in KB
DATA10 Pool 1 current % used
DATA11 Pool 1 peak % used
DATA12 Pool 2 size in KB
DATA13 Pool 2 current % used
DATA14 Pool 2 peak % used
DATA15 Pool 3 size in KB
DATA16 Pool 3 current % used
DATA17 Pool 3 peak % used
DATA18 Pool 4 size in KB

3BUR002336R3701 RevA 481


Configurable Parameters Section 9 Calculator FCMS

DATA19 Pool 4 current % used


DATA20 Pool 4 peak % used
The mapping of data for the ME1 Data Entry FCM is as follows:
DATA1 Pool 5 size in KB
DATA2 Pool 5 current % used
DATA3 Pool 5 peak % used
DATA4 Pool 6 size in KB
DATA5 Pool 6 current % used
DATA6 Pool 6 peak % used
DATA7 Pool 7 size in KB
DATA8 Pool 7 current % used
DATA9 Pool 7 peak % used
DATA10 Pool 8 size in KB
DATA11 Pool 8 current % used
DATA12 Pool 8 peak % used
DATA13 Pool 9 size in KB
DATA14 Pool 9 current % used
DATA15 Pool 9 peak % used
DATA16 Pool 10 size in KB
DATA17 Pool 10 current % used
DATA18 Pool 10 peak % used
DATA19 Unused
DATA20 Unused

Setting DATA1 of a MEM Data Entry FCM to zero resets the


memory pool portion of the System Performance display.

The mapping of data for the STK Data Entry FCM is as follows:
DATA1 Percent of stack used
DATA2 Stack size in bytes
DATA3 Number of used bytes
DATA4 Number of unused bytes

482 3BUR002336R3701 RevA


Section 9 Calculator FCMS Non-configurable Data Base Parameters

RESULT ENTRY Field


This field specifies the data value to which the result is set each time the FCM is
executed.
Valid entry is any number between 1 and 20.
Default is: 1
Mnemonic: MEASLREF

Non-configurable Data Base Parameters


The non-configurable parameters for the Data Entry FCM are described in Common
Non-configurable Parameters on page 338.

Discussion
RESULT ENTRY specifies which data value is used as the FCM result. This FCM
provides a means for CCF and the other applications to exchange data. For example,
you can place the current values of TCL variables on custom (Display Builder)
displays. To do this, TCL writes the values to the Data Entry FCM and the displays
read and display these values. Other data manipulations supported by the Data Entry
FCM include:
• TCL can read variables from the FCM and write variables to it.
• CCF loops can obtain the result of a Data Entry FCM.
• CCF loops can use the Get Generic Value FCM to get data from a Data Entry
FCM.
• CCF loops can use the Put Generic Value FCM to place values into a Data
Entry FCM.
• Displays built with the Display Builder can obtain data values from the FCM.
• You can enter data into the FCM via Data Value Targets on custom displays.
• You can put data values from the FCM in reports built with the Report Services
Software.

3BUR002336R3701 RevA 483


String FCM Section 9 Calculator FCMS

String FCM
Purpose
The String FCM allows you to put a user-defined string of up to 40 characters into
the data base.

Default Name, Algorithm Type, and Relation


The default name for the String FCM is STR. The algorithm is STRING_FCM. The
FCM is listed on the menu on the Loop Definition Templet by selecting the MISC
softkey.

Algorithm
There is no algorithm for this FCM. It is a place to store a string variable. The can
be string accessed by TCL programs via tag-FCM access (that is, $'tag'-
'STR'.SVALUE). You can also use it on custom displays. The string can be accessed
even if the loop with the FCM is turned off. The result of the String FCM is a
numerical value not directly related to the string.

Configurable Parameters
The String FCM has the following configurable fields in addition to the fields
described in Common Configurable Fields for Calculator FCMs on page 334.

TEXT STRING VALUE Field


This field is used to enter the string into the FCM.
Valid entry is a character string of up to 40 characters.

User Math Block FCM


Purpose
The User Math Block FCM is used to create user-defined calculations for a
combination of input variables and constants. The FCM is part of a loop in the same

484 3BUR002336R3701 RevA


Section 9 Calculator FCMS Default Name, Algorithm Type, and Relation

manner as other FCMs. When the FCM is executed, its calculation is a real number
that becomes the result of the FCM.
Although you can replicate the functionality of certain calculator FCMs with this
FCM, you should be aware the code is interpreted at runtime and therefore would
probably be slower than a standard FCM. System performance tests have shown a
User Math Block FCM can improve performance when used to replace multiple
FCMs but reduce performance when used to replace a single FCM.

Default Name, Algorithm Type, and Relation


The default name for User Math Block is MTH. The algorithm is
USER_MATH_BLOCK. The FCM is listed on the menu on the Loop Definition
Templet by selecting the MISC softkey.

Algorithm
The User Math Block FCM algorithm is user-defined. There is no default version.

Configurable Parameters
The User Math Block FCM Templet has the following configurable fields in
addition to the fields described in Common Configurable Fields for Calculator
FCMs on page 334.

User Math Block FCM Templet, Upper Portion


The upper portion of the User Math Block FCM, Figure 72 has the following fields.

3BUR002336R3701 RevA 485


User Math Block FCM Templet, Upper Portion Section 9 Calculator FCMS

Figure 72. User Math Block FCM Templet, Upper Portion

486 3BUR002336R3701 RevA


Section 9 Calculator FCMS User Math Block FCM Templet, Upper Portion

INPUT SOURCE I1 Field


This field specifies the FCM whose result is Input I1 for the equation.
Valid entries are:
PREVIOUS FCM previous FCM in the loop
.fcmname name of another FCM in the loop
tag.fcmname tag and FCM name of an FCM from another loop
Default is: PREVIOUS FCM

INPUT SOURCE I2 through I7 Fields


These fields specify FCMs whose results are Inputs I2 through I7. Make entries to
as many of these fields as you need for your equation and leave the others blank.
Valid entries are:
.fcmname name of another FCM in the loop
tag.fcmname tag and FCM name of an FCM from another loop

HIGH LIMIT Field


This field specifies a high limit for the result of the FCM if the entry in the
ENABLE HIGH LIMIT field is YES. The limit applies to the final result only, not
intermediate calculations. When the result is limited, the HI_FLAG attribute is set
to 1. TCL can set events to watch this flag or you can acquire its value using Get
FCMs.
Valid entry is a real number.
Default is: 100.0
Mnemonic: HI_LIMIT

LOW LIMIT Field


This field specifies a low limit for the result of the FCM if the entry in the ENABLE
LOW LIMIT field is YES. The limit applies to the final result only, not intermediate

3BUR002336R3701 RevA 487


User Math Block FCM Templet, Upper Portion Section 9 Calculator FCMS

calculations. When the result is limited, the LO_FLAG attribute is set to 1. TCL can
set events to watch this flag or you can acquire its value using Get FCMs.
Valid entry is a real number.
Default is: 0.0000
Mnemonic: LO_LIMIT

CONSTANTS K1 through K7 Fields


These fields are used to specify up to 7 constants: K1 through K7. You can view and
change K1 through K4 during runtime via the Loop/FCM Display. You can only
view K5 through K7, you cannot change them.
Valid entry is a real number.
Default is: 0.0000
Mnemonic: RD1_K1 to RD1_K7

INITIAL MODE Field


This field is used in the normal CCF fashion.

BAD INPUTS ACCEPTED Field


If bad inputs are not accepted and any one of the inputs goes to BAD, the data
quality of this FCM goes to BAD.

INITIAL RESULT Field


This field specifies an initial result for the FCM. It is available for the first scan of
the FCM. You can view and change the value during runtime via the Loop FCM
Display.
Valid entry is a real number.
Default is: 0.000

488 3BUR002336R3701 RevA


Section 9 Calculator FCMS User Math Block FCM Templet, Upper Portion

INITIAL RES Y1 through Y3 Fields


These fields specify the initial values of the intermediate values of the calculation.
They are available for the first scan of the FCM. You can view the values during
runtime via the Loop FCM Display.
Valid entry is a real number.
Default is: 0.0000
Mnemonics: INIT_Y1 to INIT_Y3

ENABLE HIGH LIMIT Field


This field enables and disables the high alarm limit checking.
Valid entries are:
YES enabled
NO disabled
Default is: NO
Mnemonic: HI_ENAB

ENABLE LOW LIMIT Field


This field enables and disables the low alarm limit checking.
Valid entries are:
YES enabled
NO disabled
Default is: NO
Mnemonic: LO_ENAB

Y0 RESULT Field
This field contains the value of the result during runtime. You can view its value
during runtime via the Loop FCM Display.

3BUR002336R3701 RevA 489


User Math Block FCM Templet, Lower Portion Section 9 Calculator FCMS

Y1 through Y3 INTERIM RES Fields


These fields contain the values of the intermediate calculations during runtime. You
can view them during runtime via the Loop FCM Display.

User Math Block FCM Templet, Lower Portion


Figure 73 shows the lower portion of the User Math Block FCM Templet.

490 3BUR002336R3701 RevA


Section 9 Calculator FCMS User Math Block FCM Templet, Lower Portion

Figure 73. User Math Block FCM Templet, Lower Portion

ERROR POSITION Field


If the data quality of the FCM goes to BAD during runtime, this field should be
checked via the Loop FCM Display. It contains the first position in the Reverse
Polish Notation (RPN) equation in which an error was discovered.

3BUR002336R3701 RevA 491


Non-configurable Data Base Parameters Section 9 Calculator FCMS

ERROR TYPE Field


If an error occurs during runtime, this field provides a brief description. You can
view the description during runtime via the Loop FCM Display.
Possible error messages include:
INCOMPLETE RPN string in data base is incomplete
STACK FAULT Calculation stack full or stack index below zero
SQRT OF NEG Attempt to take square root of negative number
DIV BY ZERO Attempt to divide by zero
BAD Y INDEX Attempt to store a result in Y4 or greater
LOG OF NEG Attempt to take the log of a negative number
DQ BAD D OP Data quality set to BAD by DATAQUALITY operator in the
string
ILLEGAL RPN Illegal rpn string character found, check for string overrun
BAD DQ INPUT Bad data quality of one of the inputs

EQUATION Fields
Enter the equation in normal algebraic format when the appropriate symbol is
available on the keyboard and the interpretation is not ambiguous. Discussion on
page 493, describes the valid statements, expressions, operands, and so on.

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 338, the following parameters apply for the User
Math Block FCM.

HI_FLAG
This parameter indicates whether the result of the FCM is being limited at its high
limit.

492 3BUR002336R3701 RevA


Section 9 Calculator FCMS Discussion

Possible values for the parameter are:


1 result is being limited
0 result is not being limited

LO_FLAG
This parameter indicates whether the result of the FCM is being limited at its low
limit.
Possible values for the parameter are:
1 result is being limited
0 result is not being limited

Discussion

Equation Format
The Configurator translates the equation in the EQUATION fields into a Reverse
Polish Notation (RPN) string. Extraneous parenthesis are deleted, and are not
displayed if you view the math block via the Loop FCM display.
Each time the FCM is executed, the RPN string is interpreted until either an illegal
RPN code is encountered or the string termination code is read. If an error condition
occurs, the data quality is set bad and the error position is noted in the ERROR
POSITION field. The string is evaluated to the end, but the error position displayed
is the first error position encountered.
On the initial scan, the result of the FCM is set to the value in the INITIAL RESULT
field and the intermediate values are set to the values in the INITIAL RES Y1
through INITIAL RES Y3 fields. The calculation is then evaluated as for a normal
scan of the FCM. On subsequent executions, the values in the Y0 RESULT through
Y3 RESULT fields start with the value they contained at the end of the previous
scan.

3BUR002336R3701 RevA 493


Discussion Section 9 Calculator FCMS

Equation Strings
A valid equation string is defined as:
statement [; statement] .
Statements must be separated by semicolons. Commas and parenthesis are also
valid punctuation. Normal algebraic priority rules apply, Table 36. Parenthesis are
used to modify the order of evaluation. Intermediate values and the result are
evaluated in the order they are specified to the Configurator. You can place spaces,
tabs, and carriage returns anywhere in the string to improve readability. They are
ignored by the conversion procedures. The length of the equation string is limited to
200 characters and by the 100 character constraint of the resulting RPN string.

If the equation exceeds 200 characters, you will receive the


message "EQUATION: USER EQUATION IS TOO LONG" in the
compile report. If this error occurs, you may try to correct the
problem by eliminating spaces around any and all operators (for
example, AND,OR,=, and so on) and ";ENDIF" from occurring at
the end of the equation.

If you are configuring CCF on a Multibus-based CDP node, and


you intend to transfer the database to either an IMB PC-based
configurator or an Advant Station Engineering Station, this edit
window has a further restriction of ten lines. If you define an
equation longer than ten lines, and then upload the database to
either an IMB PC-based configurator or an Advant Station
Engineering Station, the equation will be truncated after the tenth
line.

494 3BUR002336R3701 RevA


Section 9 Calculator FCMS Discussion

Table 36. Algebraic Priorities

Item Priority
assignment (=) 01
=, <, <=, >=, <> 02
AND, OR, XOR 04
+, - 05
MOD, *, / 06
unary operators 07
binary & unary functions 08
parenthesis 09
variables & constants 10

There are four types of statements recognized by the conversion procedures.


1. Assignment Statement
The format of an assignment statement is:
Yn = expression
where n is a digit from 0 to 3.
2. Data Quality (DQ) statement
The format of a data quality statement is:
DQ (expression)
If the expression computes to a non-zero value, the data quality of the FCM's
result is set to GOOD. If the expression computes to zero, the data quality is set
to BAD.

3BUR002336R3701 RevA 495


Discussion Section 9 Calculator FCMS

3. Next FCM Statement


The format of a Next FCM statement is:
FCM (expression, expression)
The first expression represents the next FCM (1 through 8) in the loop to
execute. The second expression indicates the last FCM in the loop to execute.
Setting the second expression to END indicates that all FCMs in the loop after
the Next FCM are to execute.
4. IF THEN ELSE Statement
The format of an IF THEN ELSE statement is:
IF (expression) THEN [statement(s)][;] ELSE [statement(s)][;] [ENDIF]
For example:
Y1 = SQU (I2) - K1 * Y1 = SQU (I2) - K1 * I1 * I3;
IF (Y1> =0) THEN
Y0 = (-I2 +SQRT (Y1)) / (2 * I1);
ELSE
Y1 = SQRT (K3 * Y1);
Y0 = (-I2 - SQRT (Y1)) / (2 * I1);
The condition expression is evaluated by CCF each time the IF statement is
executed. When the condition is TRUE (non-zero) the THEN statements are
executed, when it is FALSE (zero) the ELSE statements are executed. The
THEN and ELSE keywords must always be present but may be followed by a
NULL statement. The term ENDIF must be present if there are any statements
following the IF THEN ELSE statement.
Nesting THEN and condition statements is allowed but limited by the 100
character limit of the RPN string.

Constants
The following constants are available:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9
K1, K2, K3, K4, K5, K6, K7 (values specified via CONSTANTS Kn fields of the
templet)

496 3BUR002336R3701 RevA


Section 9 Calculator FCMS Discussion

P 
E e
T loop processing rate in milliseconds
GOOD good data quality, synonym for 1
BAD bad data quality, synonym for 0
END used to indicate the end of the loop
Numeric constants greater than 9 must be used through one of the Kn fields.

Variables
A variable is one of the following:
I1, I2, I3, I4, I5 I6, I7: runtime variable inputs to the FCM. Their sources are
specified through the INPUT SOURCE In fields of the
templet.
Y0: The result of the FCM. On the first scan of the FCM, the
value in the INITIAL RESULT field is used for the value
in the Y0 RESULT field. On subsequent scans, the result
of the previous scan is used.
Y1,Y2,Y3: result of evaluating intermediate equation strings. They
can hold the results of previous statements, either from the
current execution of the FCM or from previous
executions.

Expressions
An expression is defined as:
operand [bin_op operand]
where an operand is defined as any of the following: variable, constant, expression,
unary_op (expression), unary_func (expression), bin_func (expression, expression).

3BUR002336R3701 RevA 497


Discussion Section 9 Calculator FCMS

Operands and Operators


A binary operator (bin_op) performs an operation on two operands (x and y) as
defined below.
= assignment operator (only first equal sign in a statement is used in
this way)
+ sum of x and y
- difference of x minus y
* product of x and y
/ quotient of x divided by y
MOD remainder of int(x) divided by int(y)
logical operators (used like binary operators) are:
= 1 if x equals y, else 0
<> 1 if x not equal to y, else 0
< 1 if x less than y, else 0
<= 1 if x less than or equal to y, else 0
>= 1 if x greater than or equal to y, else 0
> 1 if x greater than y, else 0
AND 1 if x and y are non-zero, else 0
OR 1 if x is non-zero or y is non-zero, else 0
XOR 1 if x is non-zero and y is zero or x is zero and y is non-zero, else 0
unary operators (unary_op) are:
NOT 1 if x is zero, else 0
- negation of x
A unary function (unary_func) performs an operation on the value of the expression
(x) enclosed in parenthesis as defined below.
ABS(x) absolute value
COS(x) cosine (x in radians)

498 3BUR002336R3701 RevA


Section 9 Calculator FCMS MOD30_MOD300_MAP

CUB(x) cube
EXP(x) e to power x
INT(x) integer portion (ignores decimal part)
LN(x) natural logarithm
SIN(x) sine (x in radians)
SQRT(x) square root
SQU(x) square
A binary function (bin_func) performs an operation on the values of two
expressions.
MIN(x,y) the lesser of x and y, x is returned if they are equal
MAX(x,y)the greater of x and y, x is returned if they are equal
This FCM raises one input signal to a power determined by another input signal.
You can use an optional constant to scale each input.

MOD30_MOD300_MAP
This FCM is used when the Advant OCS communicates with a MOD 30 Instrument.
This FCM is addressed in detail in the Taylor™ MOD 30™ Interface User's Guide.

3BUR002336R3701 RevA 499


MOD30_MOD300_MAP Section 9 Calculator FCMS

500 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS

General Information
The Extended Processing FCMs perform mathematical functions on data gathered
over an extended period of time. These FCMs provide information for historical,
long-range evaluation of a process, rather than for direct operational control.
The Extended Processing FCMs are divided into two categories: Continuous
Extended Processing and Periodic Extended Processing FCMs.
Continuous Extended Processing FCMs calculate the moving average of its
inputs continuously (once per loop scan). Detailed information about this category
of Extended Processing FCMs is provided in Continuous Moving Average FCM on
page 508.
Periodic Extended Processing FCMs do not perform their calculation at every
loop scan. Instead, data is collected by the FCM at a specified rate and the
calculation is performed when a specified period of time has elapsed. These FCMs
are described in Standard Deviation FCM on page 510, through Periodic Rate Total
FCM on page 519. Discussion on page 511, uses the Standard Deviation FCM as an
example to describe the collection and calculation rates for the Periodic Extended
Processing FCMs.
This section uses the same format as the Calculator FCM descriptions. This format
is described in Format Of The Calculator FCM Descriptions on page 340 of Section
9, Calculator FCMS. FCM parameter tables are provided in Data Base Tables.

Common Parameters
Each Extended Processing FCM has a templet display in the Data Base
Configurator used to configure the FCM. Many items on the templets are common
to all Extended Processing FCMs. Some of these items are automatically generated

3BUR002336R3701 RevA 501


Common Configurable Parameters Section 10 Extended Processing FCMS

by the system to give you information. Other items are configurable and you
determine their content.

Common Configurable Parameters


The following configurable parameters are common to most of the Extended
Processing FCMs.

TEMPLET NAME Field


This field is for the FCM name. Templet names must be unique, that is, no two
FCMs in a loop can have the same name.
Valid entry is a character string of up to 3 characters
Default is: 3 different characters for each type of FCM. The default name for a
specific FCM is given in the description of that FCM.
Mnemonic: FCM_ID

PARENT NAME Field


This field specifies the templet name of the parent of this FCM. The field is
automatically filled in and is for information only. There is no default nor
mnemonic for this field.

INPUT SOURCE Field


This field specifies the FCM input source. Input must be in engineering units unless
otherwise specified.
Valid entries are:
PREVIOUS FCM result of the previous FCM in the loop is the input
.fcmname result of another FCM in the loop is the input
tag.fcmname result of a FCM from another loop is the input
Default is: PREVIOUS FCM
Mnemonic: INPUT_1

502 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Common Configurable Parameters

START TIME Field


This field indicates the date and time at which the first sample is taken.
Valid entry is in the form:
dd-mmm-yy hh:mm:ss date as day, month, and year and time as hour, minute, and
second (the data base holds the number internally in
seconds)
Default is: 01 JAN 85 00:01:00 (sampling starts as soon as system goes to runtime)
Mnemonic: STARTTIM

SAMPLE RATE Field


This field specifies the interval at which the FCM samples the input value.
Discussion on page 511, describes how the sample rate is used by the periodic
Extended Processing FCMs.
Valid entry is in the form:
hh:mm:ss the sample interval in hours, minutes, seconds
Default is: 00:01:00
Mnemonic: SAMPRATE
The SAMPLE RATE, PERIOD UNIT, and PERIOD SIZE fields must be configured
so the calculation is performed on no more than 127 samples.

PERIOD UNIT Field


This field specifies the time units for the period. It is used with the PERIOD SIZE
field to specify the period for the FCM. Discussion on page 511, describes how the
period is used by periodic Extended Processing FCMs.
Valid entries are: MONTHLY, LAST DAY, WEEKLY, DAILY, HOURLY,
MINUTES
Default is: MINUTES
Mnemonic: PER_TYPE

3BUR002336R3701 RevA 503


Common Configurable Parameters Section 10 Extended Processing FCMS

PERIOD SIZE Field


This field specifies the size of the period. It is used with the PERIOD UNIT field to
specify the period of the FCM. Discussion on page 511, describes how the period is
used by periodic Extended Processing FCMs.
Valid entry is an integer from 1 to 60.
Default is: 1
Mnemonic: PER_AMT
The SAMPLE RATE, PERIOD UNIT, and PERIOD SIZE fields must be configured
so the calculation is performed on no more than 127 samples.

INITIAL MODE Field


This field specifies the output mode at start-up time.
Valid entries are:
MAN start in the Manual mode
AUTO start in the Auto mode
Default is: AUTO
Mnemonic: INITMODE

INITIAL OUTPUT Field


This field specifies the value of the output (result) at start-up time.
Valid entry is a decimal number.
Default is: 0.0
Mnemonic: INIT_OUT

BAD INPUTS ACCEPTED? Field


This field specifies if an input with bad data quality is treated as if the data quality is
good.

504 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Common Non-configurable Parameters

Valid entries are:


YES accept good and bad inputs
NO accept good inputs only
Mnemonic: WORST_DQ

NUM OF INVALID SAMPLES Field


This field specifies the maximum number of samples with a BAD data quality that
can be present and still have output data quality GOOD. This field is not used when
the BAD INPUTS ACCEPTED? field is set to YES.
Valid entry is an integer from 0 to 127.
Default is: 0
Mnemonic: MAX_BAD

Common Non-configurable Parameters


The following non-configurable parameters are common to most Extended
Processing FCMs.

BAD_SAMP Parameter
BAD_SAMP specifies the number of samples with bad data quality that have been
collected so far in the period. The calculation is not performed if this number
becomes greater than the value entered in the NUM OF INVALID SAMPLES field.
There are no state values nor state mnemonics for TCL for this parameter.

DATAQUAL Parameter
This parameter specifies the data quality of the result parameter of the FCM.
State values are:
0 data quality is bad
1 data quality is good
There are no state mnemonics available for TCL.

3BUR002336R3701 RevA 505


Common Non-configurable Parameters Section 10 Extended Processing FCMS

DEVLPNUM Parameter
This parameter specifies the node/loop number. This is a unique number assigned
by the system to the loop containing the FCM.
There are no state values nor state mnemonics available for TCL for this parameter.

FCM_MODE Parameter
This parameter specifies if the FCM is on or off.
State values are:
0 FCM is off
1 FCM is on
State mnemonics available for TCL are: OFF, ON

INIT_FLG Parameter
This parameter specifies if the initialization flag parameter is set at normal or
initialize.
State values are:
0 initialization flag is set at normal
1 initialization flag is set at initialize
There are no state mnemonics available for TCL.

NEXTCALC Parameter
NEXTCALC specifies the next calculation time. This parameter can be used to have
the calculation performed at the end of a TCL batch. When TCL sets NEXTCALC
to 0, the period is automatically ended and the calculation is performed with
whatever samples are present. The result of the FCM is available on the next loop
scan. There are no state values nor state mnemonics available for TCL for this
parameter.

506 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Tuning and Logging Parameters for Extended Processing

NEXTSAMP Parameter
This parameter specifies the time at which the next sample is taken.There are no
state values nor state mnemonics available for TCL for this parameter.

OUT_MODE Parameter
This parameter specifies if the output mode of the FCM is set at manual or auto.
State values are:
0 Manual
1 Auto
State mnemonics available for TCL are: MANUAL, AUTO

PREVTIME Parameter
PREVTIME specifies the previous calculation time. There are no state values nor
state mnemonics available for TCL for this parameter.

RESULT Parameter
RESULT specifies the result of the calculations of the FCM. There are no state
values nor state mnemonics available for TCL for this parameter.

Tuning and Logging Parameters for Extended Processing FCMs


Table 37 lists parameters having special runtime features. A detailed description is
provided in Format Of The Calculator FCM Descriptions on page 340 of Section 9,
Calculator FCMS.

3BUR002336R3701 RevA 507


Continuous Moving Average FCM Section 10 Extended Processing FCMS

Table 37. Common Tuning and Logging Parameters for


Extended Processing FCMs

TUNABLE FROM
PARAMETER LOGABLE
LOOP/FCM DISPLAY
RESULT YES YES
OUT_MODE YES YES
FCM_MODE YES YES

Continuous Moving Average FCM


Purpose
This module determines the moving average of an input over a specified number of
samples. The moving average is calculated in the standard mathematical fashion,
that is, when a new sample is added to the calculation, the oldest sample is
discarded. The result is always available, even if too few samples have been taken to
make up the full complement specified at configuration.

Default Name, Algorithm Type, and Relation


The default name for the Continuous Moving Average FCM is MAV. The algorithm
is CONT_MOVING_AVERAGE. The FCM is listed on the menu, on the Loop
Definition Templet by pressing the EXTD PROC softkey.
The data base relation is CMAV_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

508 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Algorithm

Algorithm
The algorithm for the Continuous Moving Average FCM is:

 inpi
i=1
-------------------
-
Result =
n

where
inpi is the value of the input signal in the ith sample period
n is the number of samples over which the average is calculated

Configurable Parameters
In addition to the configurable fields common to Extended Processing FCM
Templets described in Common Configurable Parameters on page 502, the
following configurable fields apply for the Continuous Moving Average FCM.

NUMBER OF SAMPLES Field


This field specifies the number of samples over which the algorithm is normally
calculated. For the Continuous Moving Average FCM, one sample is collected each
time the FCM is processed. When the FCM is first turned on, the average is
calculated over whatever number of samples are present. As soon as the number of
samples specified by this field is collected, the algorithm is calculated over that
number. On each subsequent loop scan, one new sample is taken and the oldest
sample is discarded.
Valid entry is an integer from 2 to 20
Default is: 2
Mnemonic: SAMPLES

MAX BAD SAMPLES Field


This field specifies the maximum number of bad samples allowable and present to
still perform the calculation.

3BUR002336R3701 RevA 509


Non-configurable Data Base Parameters Section 10 Extended Processing FCMS

Valid entry is any integer from 0 to the value entered on the NUMBER OF
SAMPLES field
Default is: 0
Mnemonic: MAX_BAD

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 505, the Continuous Moving Average FCM has
the following parameter:
SAMP_CNT Parameter
This parameter specifies the current sample count. There are no state values nor
state mnemonics available for TCL for this parameter.

Tuning and Logging


See Tuning and Logging Parameters for Extended Processing FCMs on page 507,
for parameters having special runtime features.

Standard Deviation FCM


Purpose
This module calculates the standard deviation of the input value over a specified
time. The period is synchronized with the real time clock (minutes, hours, and so
on).

Default Name, Algorithm Type, and Relation


The default name for the Standard Deviation FCM is PSD. The algorithm is
STANDARD_DEVIATION. The FCM is listed on the menu, on the Loop
Definition Templet by pressing the EXTD PROC softkey.
The data base relation is STDV_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

510 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Algorithm

Algorithm
The algorithm for the Standard Deviation FCM is:

n n 2
 
  inp 2 – n   inp t 
 t 
Result = SQRT  =1 i=1 -
i---------------------------------------------------------
 n–1 
 
 
 
where
inpi is the value of the input signal of the ith sample period
n is the number of samples over which the standard deviation is calculated. The
value of n is calculated by: (period/sample rate)

Configurable Parameters
The configurable parameters for the Standard Deviation FCM are described in
Common Configurable Parameters on page 502.

Non-configurable Data Base Parameters


The non-configurable parameters for the Standard Deviation FCMs are described in
Common Non-configurable Parameters on page 505.

Tuning and Logging


See Tuning and Logging Parameters for Extended Processing FCMs on page 507,
for parameters having special runtime features.

Discussion
Timing and configuration considerations for the Periodic Extended Processing
FCMs
Three time intervals play a role in processing the Periodic Extended Processing
FCMs.

3BUR002336R3701 RevA 511


Discussion Section 10 Extended Processing FCMS

The first is the scan rate, that is, the rate at which the loop containing the FCM
executes. It is configured for the loop via the Loop Definition Templet. The action
taken by the FCM upon a loop execution depends on its other time intervals as
described in the paragraphs that follow. In general, when the loop is scanned, the
FCM either samples the input value, performs the calculation, or takes no new
action.
The second interval is the sample rate. This is the rate at which the input is sampled.
It is specified via the templet used to configure the FCM. You can make the sample
rate considerably larger than the loop scan rate. For example, you can configure the
sample rate at 5 minutes even though the loop is scanned once a second. The values
sampled are stored until it is time for the FCM to perform its calculation.
The period is the third time interval. The calculation for the algorithm is performed
at the end of the period. It is a greater period of time than the sample rate. This
interval is specified in terms of the following periods:
Months Week Hours
Last Day of Month Days Minutes
Periodic FCMs output the result only at the time when it is calculated at the end of
the period. When the FCM receives a request for the result prior to calculating the
new one, it responds with the result from the previous period.
Timing/Configuration Example for an Extended Processing FCM
The following example illustrates the general timing techniques used by the
periodic Extended Processing FCMs.
A loop has a periodic Extended Processing FCM with a scan rate of 8 seconds. The
following entries were made to the templet of the Extended Processing FCM.
START TIME Field 1-JAN-1985 (default time - start immediately)
SAMPLE RATE Field 33:20 (2000 seconds)
PERIOD UNIT Field HOURS
PERIOD SIZE Field 20
The configuration entries listed above cause the variable to sample initially and then
sample at intervals of 250 loop scans (2000 seconds). The choice of the period, 20

512 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Non-rate Periodic Total FCM

hours (72,000 seconds) assures that 36 samples are collected when it is time to do
the calculation.
When the loop starts processing, the following takes place:
Scan(s) FCM Action
1 Collects sample 1. Start time
2 - 249 No special activity
250 Collects sample 2. The first sample interval has finished.
251 - 499 No special activity.
500 Collects sample 3. The second sample interval has finished.
. .
. .
. .
8750 Collects 36th sample. The thirty fifth sample interval has finished.
End of period 1 calculation performed.
9000 Start of period 2.
. .
. .
. .
17750 End of period 2 calculation performed.

Non-rate Periodic Total FCM


Purpose
This module determines the total value of the input over a specified time period.
The time period is synchronized with the real time clock (minutes, hours, and so
on).

3BUR002336R3701 RevA 513


Default Name, Algorithm Type, and Relation Section 10 Extended Processing FCMS

Default Name, Algorithm Type, and Relation


The default name for the Non-Rate Periodic Total FCM is NPT. The algorithm is
NON-RATE_PERDC_TOTAL. The FCM is listed on the menu on the Loop
Definition Templet by pressing the EXTD PROC softkey.
The data base relation is TOTA_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

Algorithm
The algorithm for the Non-rate Periodic Total FCM is
n

Result =  inpi
i=1

where
inpi is the value of the input signal in the ith sample
n is the number of samples over which the total is calculated. The value of n is
calculated by: (period/sample rate)

Configurable Parameters
The configurable parameters for the Non-rate Periodic Total FCM are described in
Common Configurable Parameters on page 502.

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 505, the following parameter applies for the Non-
rate Periodic Total FCM.

RATE_IND Parameter
This parameter indicates the type of calculation being performed. It is automatically
set at 1 when the Non-rate Periodic Total FCM is configured.
State values are:

514 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Tuning and Logging

0 rate (not used for Non-rate Periodic Total FCM)


1 non rate (required value for the Non-rate Periodic Total FCM)
There are no state mnemonics available for TCL.

Tuning and Logging


See Tuning and Logging Parameters for Extended Processing FCMs on page 507,
for parameters having special runtime features.

Discussion
Discussion on page 511, describes the relationship between the loop scan rate, the
sample rate, and the period. It also gives information about the START TIME,
SAMPLE RATE, PERIOD UNIT, PERIOD SIZE, and NUM OF INVALID
SAMPLES fields.

Periodic Average FCM


Purpose
This FCM determines the arithmetic average of an input signal over a selected time
period. The time period is synchronized with the real time clock (minutes, hours,
shifts, and so on).

Default Name, Algorithm Type, and Relation


The default name for the Periodic Average FCM is PAV. The algorithm is
PERIODIC_AVERAGE. The FCM is listed on the menu on the Loop Definition
Templet by pressing the EXTD PROC softkey.
The data base relation is PERA_FCM. Keyset 1 for the relation is DEVLPNUM,
FCM_ID.

3BUR002336R3701 RevA 515


Algorithm Section 10 Extended Processing FCMS

Algorithm
The algorithm for the Periodic Average FCM is:
n

 inpi
Result = i-------------------
=1 -
n

where
inpi is the value of the input signal in the ith sample
n is the number of samples over which the average is calculated. The value of n
is calculated by:
(period/sample rate)

Configurable Parameters
The configurable parameters for the Periodic Average FCM are described in
Common Configurable Parameters on page 502.

Non-configurable Data Base Parameters


The non-configurable parameters for the Periodic Average FCM are described in
Common Non-configurable Parameters on page 505.

Tuning and Logging


See Tuning and Logging Parameters for Extended Processing FCMs on page 507,
for parameters having special runtime features.

Discussion
Discussion on page 511, describes the relationship between the loop scan rate, the
sample rate, and the period. It also gives information about the START TIME,
SAMPLE RATE, PERIOD UNIT, PERIOD SIZE, and NUM OF INVALID
SAMPLES fields.

516 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Periodic Maximum FCM

Periodic Maximum FCM


Purpose
This module determines the maximum value of an input signal over a specified time
period. The period is synchronized with the real time clock (minutes, hours, shifts,
and so on).

Default Name, Algorithm Type, and Relation


The default name for the Periodic Maximum FCM is PMX. The algorithm is
PERIODIC_MAXIMUM. The FCM is listed on the menu on the Loop Definition
Templet by pressing the EXTD PROC softkey.
The data base relation is MAXVMIN_FCM. Keyset 1 for the relation is
DEVLPNUM, FCM_ID.

Algorithm
The algorithm for the Periodic Maximum FCM is:
IF inp.GE. Result
THEN Result = inp
ELSE Result = Result

Configurable Parameters
The configurable parameters for the Periodic Maximum FCM are described in
Common Configurable Parameters on page 502.

Non-configurable Data Base Parameters


The non-configurable parameters for the Periodic Maximum FCM are described in
Common Non-configurable Parameters on page 505.

Tuning and Logging


See Tuning and Logging Parameters for Extended Processing FCMs on page 507,
for parameters having special runtime features.

3BUR002336R3701 RevA 517


Discussion Section 10 Extended Processing FCMS

Discussion
Discussion on page 511, describes the relationship between the loop scan rate, the
sample rate, and the period. It also gives information about the START TIME,
SAMPLE RATE, PERIOD UNIT, PERIOD SIZE, and NUM OF INVALID
SAMPLES fields.

Periodic Minimum FCM


Purpose
This FCM determines the minimum value of an input signal over a specified time
period. The period is synchronized with the real time clock (minutes, hours, and so
on).

Default Name, Algorithm Type, and Relation


The default name for the Periodic Minimum FCM is PMN. The algorithm is
PERIODIC_MINIMUM. The FCM is listed on the menu on the Loop Definition
Templet by pressing the EXTD PROC softkey.
The data base relation is MAXVMIN_FCM. Keyset 1 for the relation is
DEVLPNUM, FCM_ID.

Algorithm
The algorithm for the Periodic Minimum FCM is:
IF inp.LE. Result
THEN Result = inp
ELSE Result = Result

Configurable Parameters
The configurable parameters for the Periodic Minimum FCM are described in
Common Configurable Parameters on page 502.

518 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Non-configurable Data Base Parameters

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 505, the following parameter applies for the
Periodic Minimum FCM.

FIR_SAMP Parameter
This parameter is the first sample flag. There are no state values nor state
mnemonics available for TCL for this parameter.

Tuning and Logging


See Tuning and Logging Parameters for Extended Processing FCMs on page 507,
for parameters having special runtime features.

Discussion
Discussion on page 511 describes the relationship between the loop scan rate, the
sample rate, and the period. It also gives information about the START TIME,
SAMPLE RATE, PERIOD UNIT, PERIOD SIZE, and NUM OF INVALID
SAMPLES fields.

Periodic Rate Total FCM


Purpose
This FCM measures an integrated total for an input over a specified time period.
The time period is synchronized with the real time clock (minutes, hours, and so
on).

Default Name, Algorithm Type, and Relation


The default name for Periodic Rate Total is PTO. The algorithm is
PERIODIC_RATE_TOTAL. The FCM is listed on the menu on the Loop Definition
Templet by pressing EXTD PROC. The data base relation is TOTA_FCM. Keyset 1
for the relation is DEVLPNUM, FCM_ID.

3BUR002336R3701 RevA 519


Algorithm Section 10 Extended Processing FCMS

Algorithm
The algorithm for the Periodic Rate Total FCM is:
n
T
Result =  inpi  T-----n
i=1

where
inpi is the value of the input signal in the ith sample period
n is the number of samples over which the total is calculated
T is the time period (in seconds) between samples
Tn is a time normalization factor to convert the rate to the proper time units,
that is, 60 for minutes, 3600 for hours, and 1 for seconds. The FCM chooses the
factor used according to the entry in the SAMPLE UNIT field.

Configurable Parameters
In addition to the configurable fields common to Extended Processing FCM
Templets described in Common Configurable Parameters on page 502, the
following configurable field applies for the Periodic Rate Total FCM.

SAMPLE UNIT Field


This field specifies the time units used by the input.
Valid entries are:
SECONDS quantity per second
MINUTES quantity per minute
HOURS quantity per hour
Default is: SECONDS
Mnemonic: TIMENORM

520 3BUR002336R3701 RevA


Section 10 Extended Processing FCMS Non-configurable Data Base Parameters

Non-configurable Data Base Parameters


In addition to the non-configurable parameters described in Common Non-
configurable Parameters on page 505, the following parameter applies for the
Periodic Rate Total FCM.

RATE_IND Parameter
This parameter indicates the type of calculation being performed. It is automatically
set at 0 when the Periodic Rate Total FCM is configured.
State values are:
0 rate (required value for a Periodic Rate Total FCM)
1 non-rate (not used for Periodic Rate Total FCM)
There are no state mnemonics available for TCL.

Tuning and Logging


See Tuning and Logging Parameters for Extended Processing FCMs on page 507,
for parameters having special runtime features.

Discussion
Discussion on page 511, describes the relationship between the loop scan rate, the
sample rate, and the period. It also gives information about the START TIME,
SAMPLE RATE, PERIOD UNIT, PERIOD SIZE, and NUM OF INVALID
SAMPLES fields.

3BUR002336R3701 RevA 521


Discussion Section 10 Extended Processing FCMS

522 3BUR002336R3701 RevA


Section 11 Defining Device Loops

General Information
The term device is used to identify a process item driven by a system output
(momentary or contact) whose state is sensed by a system input (contact). Typical
devices are motors, pumps, switches, and lights.
A device loop is used to display the state of a device at the Operator Station or
Multibus-based console. It detects alarms for the device and it allows you to change
the state of the device. You can configure device loops to execute in Multibus
Subsystems and the controllers of Controller Subsystems.
The system processes individual device loops periodically according to their loop
processing scan. In addition, a device loop is demand scanned whenever you enter a
different device command. This section describes how to define the device loops in
CCF.

If a device loop receives its input from a digital input channel(s),


the loop is automatically demand scanned when the state of the
input changes.
If a device loop receives its input from a continuous loop, it does
not automatically demand scan when the input changes.

Device Handling Mechanisms


The following features are provided for efficient device handling:
Standard Device Handling AlgorithmsSuitable for most traditional devices. Special
algorithms for other devices are configured
as described in How to Configure Special
Device Algorithms on page 569.

3BUR002336R3701 RevA 523


Descriptor Sets Section 11 Defining Device Loops

Device Alarms Refer to Device Alarms on page 530.


User-defined Descriptors or the various states of the devices. Refer to
Descriptor Sets on page 524.

Descriptor Sets
Descriptor sets allow you to describe process device states in common language
terms (for example, ON/OFF, ENABLED/DISABLED or OPEN/CLOSED/HALF
OPEN). The device descriptor sets are defined via the Device Descriptor Templet,
Figure 75. These templets are children of the Device Descriptor Directory Templet,
Figure 74. See Figure 8 and Figure 20 for the location of the Device Descriptor
Directory Templet and Device Descriptor Templets in the templet hierarchy of
Controller and Multibus Subsystems. During runtime, these descriptors appear on
displays, messages, and so on. The descriptors make it easy for you to interpret
states and to issue commands to the devices since the commands are expressed in
simple words like OPEN or CLOSE.
At least one set of descriptors must be defined for each process device type used in
the system. Each state the device can possibly enter must be given a descriptor.
Multiple devices can use the same descriptor set. The descriptor set allows some
states for the device to be declared alarm states so an alarm is generated whenever
the device enters that state. The descriptor set also specifies which states are valid
for you to command the device to enter.
To configure a descriptor set, perform the following steps:
1. Access the Configurator.
2. Access the data base that references the descriptor set(s).
3. Using the menu, call up the Device Descriptor Directory Templet.
The Device Descriptor Directory Templet provides the means to group all
Device Descriptor Templets for the data base in one place. Later, after you have
defined all desired descriptor sets via Device Descriptor Templets, you can
access the Device Descriptor Directory to view a list of all Device Descriptor
Templets you created.
The only entry required on the initial Device Descriptor Directory Templet,
Figure 74, is the directory's name in the TEMPLET NAME field.

524 3BUR002336R3701 RevA


Section 11 Defining Device Loops Descriptor Sets

Figure 74. Device Descriptor Directory Templet

4. After you enter the desired directory's name in the TEMPLET NAME field,
save the Device Descriptor Directory Templet.
5. Using the menu, call up the Device Descriptor Templet, Figure 75.
6. Enter a name, of up to eight alphanumeric characters, for the descriptor set in
the TEMPLET NAME field. ALL templet names in the database must be
unique. By definition, the database is the total of all configurators on the same

3BUR002336R3701 RevA 525


Descriptor Sets Section 11 Defining Device Loops

ring (or set of interconnected rings, in the case of systems with multiple
DCNs).

Figure 75. Device Descriptor Templet

7. Enter the descriptor set in the templet's edit window.


The descriptor set must be set up to support one of the device type algorithms
listed in the Device Type column of Table 38. For example, the descriptor set
shown by Figure 75 is designed to support the device type given by the part of

526 3BUR002336R3701 RevA


Section 11 Defining Device Loops Descriptor Sets

Table 38 shown below.

FEEDBACK FROM DECIMAL OUTPUT FROM DECIMAL


DEVICE TYPE
DEVICE (INPUT) EQUIVALENT COMPUTER EQUIVALENT
4_IN_2_C_OUT 1010 10 00
1001 9 01
0101 5 11

For each device state, the following items must be specified:


NAME OF STATE Enter the name you want for the state on the
operational displays. In Figure 75, each of the three
states of the 4_IN_2_C_OUT Algorithm is given a
name. Names must be unique within the set. Ten
characters can be entered, but you may want to use six
as the maximum because some displays truncate the
name to six.
VALUE OF STATE Enter the decimal equivalent of the feedback (input) as
listed in Table 38. In Figure 75, note that 1 0 1 0 is
specified by decimal 10, and 1 0 0 1 is specified by
decimal 9.
VALID COMMAND This field specifies whether you can command the
device to assume the state. Enter either YES or NO. If
the entry is NO and you attempt to send the device to
this state, an Illegal Command Alarm is generated.
ALARM STATE This field specifies whether a State Alarm is generated
whenever the device enters this state. Enter YES or
NO.
8. After you make all desired descriptor set entries to the Device Descriptor
Templet's edit window, save the templet.

3BUR002336R3701 RevA 527


Descriptor Sets Section 11 Defining Device Loops

9. Repeat steps 5 through 8 until all desired descriptor sets are defined for the data
base.

Table 38. Device Types

FEEDBACK FROM DECIMAL OUTPUT FROM DECIMAL


DEVICE TYPE(1)
DEVICE (INPUT) EQUIVALENT(2) COMPUTER EQUIVALENT(2)
0_IN_2_C_OUT 00 (command only)(3) 0 00 0
11 (command only)(3) 3 11 3
01 (command only)(3) 1 01 1
10 (command only)(3) 2 10 2

0_IN_1_C_OUT 0 (command only)(3) 0 0 0


1 (command only)(3) 1 1 1

0_IN_1_M_OUT 1 (command only)(3) 1 pulse to output channel

0_IN_2_M_OUT 01 (command only)(3) 1 pulse to output channel


10 (command only)(3) 2 pulse to (output
channel+1)

1_IN_1_C_OUT 0 0 0 0
1 1 1 1

1_IN_2_M_OUT 1 1 pulse to output channel


0 0 pulse to (output
channel+1)

2_IN_1_C_OUT 10 2 0 0
01 1 1 1
00 0 no output state

2_IN_2_C_OUT 01 1 01 1
10 2 10 2
00 0 00 0

2_IN_2_M_OUT 01 1 pulse to output channel


10 2 pulse to (output
00 0 channel+1)
no output state

528 3BUR002336R3701 RevA


Section 11 Defining Device Loops Descriptor Sets

Table 38. Device Types (Continued)

FEEDBACK FROM DECIMAL OUTPUT FROM DECIMAL


DEVICE TYPE(1)
DEVICE (INPUT) EQUIVALENT(2) COMPUTER EQUIVALENT(2)
4_IN_2_C_OUT 1010 10 00
1001 9 01
0101 5 11

1_IN_0_OUT 0 0 no output state


1 1 no output state

2_IN_0_OUT any combination of no output state


2 bits

3_IN_0_OUT any combination of no output state


3 bits

4_IN_0_OUT any combination of no output state


4 bits

USER_DEFINED set by TCL program(3) set by TCL program

SPECIAL defined on Special


Device Templet
(1) IN is inputs, OUT is outputs, C is contact, and M is momentary.
(2) The feedback and output patterns must be represented by their decimal equivalents when making entries to
Configurator templets.
(3) The input state is an internally held number for devices that send no feedback signal to the computer.

If you modify a Device Descriptor set, you must compile and install the device
descriptor directory and each loop that references the new descriptor set. You can
compile standard device loops on the loop level. If a special device loop references
the changed set, you must compile on the node level. The environment must also be
compiled and downloaded if any group or graphic has loops that reference the
changed descriptor set. Since the runtime database is only updated for new device
descriptors, you must reboot all Advant Operator Stations to update the runtime
database for modified device descriptors.

3BUR002336R3701 RevA 529


Device Alarms Section 11 Defining Device Loops

Device Alarms
You can configure alarms to be generated for a device. They are described in
Table 39.

Table 39. Device Alarms

ALARM DESCRIPTION
Timeout The system sent a valid command to the device, but the device did not
respond within the specified time, that it had entered in the desired state.
The timeout interval is specified via the TIMER field of the Device Loop
Templet at configuration time.
Unknown State The system cannot read the feedback from the device.
Illegal State The system can read the feedback from the device, but no state is
defined for the feedback bit combination.
State Alarm The device has entered a state defined by the device descriptor set as
an alarm state for the device.
Abnormal State Change The device changed state, but no command to do so was issued.
Abnormal State Change alarms will not occur if the state changes to
match DEV_CMND.
Bad Input Data Quality The data quality of the inputs is BAD. This alarm can only occur when
the input of the device loop is the result of a FCM from another loop.
Illegal Command Systems recognize the command from the operator or the TCL program,
but it is an invalid command as defined by the Device Descriptor
Templet.

Processing Device Loops


This section describes device handling. It is not meant to be an exhaustive
description of the device loop's capabilities. Rather, it points out the basic
procedures used by the device handler.

530 3BUR002336R3701 RevA


Section 11 Defining Device Loops Processing Device Loops

Device Loop Processing Under Normal Circumstances (No Operator or TCL


Commands to Change State of Device)
1. The loop processor starts processing the device loop at its normal time as
determined by the processing and phase parameters. Since there is no operator
or TCL command, the NEW COMMAND parameter (NEW_CMND) has a
value of 0 (no new command). This informs the loop processor that no output
is made to the device.
2. The loop processor checks the input to the loop (feedback from device). It sets
the INPUT ALARM parameter (INP_ALM) to one of the following states as
determined by the state of the input:
INP_ALM 0 N0_ALM
1 DQ_BAD
2 ALARMED_STATE
4 ILLEGAL STATE
3. The loop processor goes on to the next loop.
Device Loop Processing When There is an Operator or TCL Command to
Change the State of Device
When an operator command from the Operator Station or Multibus-based console
or a statement in a TCL program orders a device to change state, the following
happens:
1. The Data Base Manager writes the following changes to the device loop for the
device:
– DEVICE COMMAND (DEV_CMD) goes to the state ordered by the
command from the Operator Station or Multibus-based console or TCL.
– NEW COMMAND (NEW_CMND) is set to 1 to indicate a new command
is present.
– DEMAND SCAN (DMD_SCAN) is set to 1. When DEMAND SCAN is
set to 0, the loop is scanned only when there is a change of state. This
differs from the loop processing rate in that loop, processing occurs at
regular timed intervals whether the state changes or not. Demand Scan is
the preferred scan setting.

3BUR002336R3701 RevA 531


Processing Device Loops Section 11 Defining Device Loops

2. Since the loop is on demand scan, the loop processor starts processing it as
soon as possible without waiting until the normally scheduled loop processing
time.
3. The loop processor checks NEW_CMND and finds there is a new command
for the device. It outputs the corresponding value from Table 38 or Special
Device Descriptor Set to the device. Refer to How to Configure Special Device
Algorithms on page 569, for information about Special Device Descriptor Sets
and how you define them.
4. If the device has inputs and outputs, the loop processor changes DEVICE
TRANSITION (DEV_TRAN) to IN_XITION indicating an output is being
sent to the device. The DEVICE TIMER (TIM1_CNT) is initialized to
TIMER_1, a value configurable through the TIMER field of the Device Loops
Templet. TIM1_CNT starts to decrement.
5. The loop processor puts the device loop on quick scan and goes on to the next
loop.
6. While the device is on quick scan, the loop processor scans it every CCF base
rate cycle (instead of at the normal loop processing rate).
When the loop is scanned, the loop processor checks the input. The following may
occur:
• If the input shows the device has changed to the correct state, the loop
processor checks for alarms. If no alarm condition exists, DEV_TRAN is
changed to NOT_IN_XITION. The loop processor puts the loop on regular
scan and goes on to the next loop.
• If the TIM1_CNT value is greater than 0 and the input shows the device has not
changed state, the loop processor goes on to the next loop. It checks this device
loop again during the next CCF base rate cycle.
• If TIM1_CNT is 0 and the input shows the device has not changed state, a
device timeout alarm is generated. The loop is put in normal scan and the
processor goes to the next loop.

532 3BUR002336R3701 RevA


Section 11 Defining Device Loops Interface with other Software

Interface with other Software


Device loop parameters are accessible by other applications in the system. For
example, the Display Builder can use device values in user-defined displays and
TCL programs can send commands to devices.
The device parameters are all tag accessible and are accessed in expressions
containing the tag of the device and the mnemonic of the parameter. For example,
TCL expresses the DEVICE STATE parameter of a given device as:
$'tag'.DEV_STAT
See Display Builders User's Guide, and Taylor™ Control Language (TCL), for the
syntax rules of the Display Builder and TCL, respectively.
You can access or manipulate many parameters. The following are particularly
useful:
ACT_ALM Action Alarm
DEV_CMND Device Command
DEV_MODE Device Mode
DEV_STAT Device State
INP_ALM Input Alarm
These parameters are described in Non-configurable Parameters of Device Loops
on page 560.

How To Configure A Device Loop


Configuration for each device loop starts on the Device Loop Templet. Figure 76
and Figure 77 show an example of the Device Loop Templet from the AdvaBuild
Templet Builder running on the Windows platform. The AdvaBuild Template
Builder running on the HP-UX platform and the MOD 300 Configurator views of
this templet are essentially the same, although the user interface differs slightly. The
fields are defined below. There are also non-configurable fields for device loops.
The basic steps to configure a device loop are provided in How to Define a Device
Loop on page 565. Each step mentions the fields on the templet important in
carrying out the step.

3BUR002336R3701 RevA 533


How To Configure A Device Loop Section 11 Defining Device Loops

Figure 76. Device Loop Templet, Upper Portion

534 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

TEMPLET NAME (TAG) Field


This field contains the name given to the templet when it is generated. The tag must
be unique system wide, that is, no two loops can have the same tag. Tags can have a
maximum of 12 characters. Allowed characters are letters A through Z, numbers 0
through 9, and hyphen(-).

The following characters are reserved for internal functions within


the system and should not be used in tag names: * : ? ! %
Other characters such as underscore or hyphen (for example FIC-
135) can be used to separate parts of the tag name.

Mnemonic: TAG

EXPORT Field
This field is a special field that is only used when the system employs multiple
configurators. If your system uses a single configurator in a turbo node, do not make
an entry in the EXPORT field. If your system uses multiple configurators, you
should read the information about the multiple configurator feature in the System
Configurator User's Guide before configuring any loops.
The following is a summary of the exporting procedure as it applies to a loop.
Loops are referenced by items such as other loops, TCL programs, console groups,
and Display Builder displays. If a loop is referenced only by items in its own
configurator domain, you do not need to export its data and can leave the EXPORT
field blank. If the loop is referenced by items in other configurator domains, you
must export information about this loop to the other domains.
Part of the exporting process uses the entry in the EXPORT field to put data from
the loop into the export source file. The entry in the EXPORT field is an
alphanumeric string identifying the higher order hex bits of the configurator data
processors (domains) to receive the export data. For example, the entry 125BE
specifies that data from the loop is exported to configurators in turbo nodes at DCN
addresses (hex) 11, 21, 51, B1, and E1.

3BUR002336R3701 RevA 535


How To Configure A Device Loop Section 11 Defining Device Loops

After you enter the hex addresses of configurators you want the receive data, use the
MORE softkey to access the EXPORT SAVE softkey. Then, select the EXPORT
SAVE softkey to put the loop's templet data into the export source file.
Follow the instructions in the System Configurator User's Guide, describing how to
send the export source files to the other configurators.

LOOP DESCRIPTOR Field


This field specifies a loop descriptor. The descriptor is a label included on
operational displays and the Alarm/Event Log. This field does not need a unique
entry, so more than one loop can have the same descriptor. See Figure 30 in Loop
Processing Rate on page 158 for an example of how the descriptor appears on an
operational display.
Valid entry is:
any combination of up to 24 alphanumeric characters. All 24 characters are
printed when information for the loop appears on the Alarm/Event Log, but
only the first 12 characters are shown when the descriptor appears on a display.
Mnemonic: LOOPDESC

PROCESSING RATE Field


This field specifies the loop processing rate. How this field and the CCF BASE
RATE field interact to determine the loop processing is described in Loop
Processing Rate on page 158. You can change the loop processing rate via the
SCANRATE field on the Loop Detail Display.
Valid entry is in the form:
hr:min:sec the range is 0.100 second (min.) to 255 times the base rate (max.).
Processing rate must be greater than or equal to the CCF base rate.
This field is automatically rounded up to the next higher multiple of
the base rate.
Default is: 10

536 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

Examples:
Entry Interpreted as:
0.25 0.25 second
5 5 seconds
4:17 4 minutes 17 seconds
2:09:04 2 hours 9 minutes 4 seconds
Mnemonic: SCANRATE
Label on Loop Detail Display: SCANRATE

The SCANRATE value on the Loop Detail Display is a multiplier


of the BASE RATE and not a time format (minutes:seconds) as
used for the PROCESSING RATE field.

PROCESSING PHASE Field


This field allows for even distribution of loop processing about the processing
interval. How this field, the PROCESSING PHASE field, and BASE RATE field of
the CCF Templet interact to determine the loop processing is described in Loop
Processing Rate on page 158. You can change the processing phase of the loop via
the PHASE field on the Loop Detail Display.
Valid entry is:
any integer from 0 to (PR/BR-1 rounded up to the next higher integer) where
PR is the processing rate of the loop and BR is the base rate of the module
containing the loop. If an entry greater than (PR/BR-1) is made, a compiler
warning is generated when the data base is compiled and the phase is set to 0.
Mnemonic: PHASE
Label on Loop Detail Display: PHASE

DEVICE TYPE Field


This field specifies the device type (device handling algorithm) for the device. The
properties of this field are described in detail in Descriptor Sets on page 524.

3BUR002336R3701 RevA 537


How To Configure A Device Loop Section 11 Defining Device Loops

Valid entries are:


0_IN_2_C_OUT 2_IN_2_M_OUT
0_IN_1_C_OUT 4_IN_2_C_OUT
0_IN_1_M_OUT 1_IN_0_OUT
0_IN_2_M_OUT 2_IN_0_OUT
1_IN_1_C_OUT 3_IN_0_OUT
1_IN_2_M_OUT 4_IN_0_OUT
2_IN_1_C_OUT USER_DEFINED
2_IN_2_C_OUT SPECIAL
Default is: 1_IN_1_C_OUT
Mnemonic: DEV_TYPE

SPECIAL NAME Field


This field is used to configure a custom device algorithm. The entry must be the
templet name you give to the Special Device Templet on which you configure the
special algorithm. When this feature is used, you must also enter SPECIAL in the
DEVICE TYPE field. See How to Configure Special Device Algorithms on page
569.

INPUT SOURCE Field


This field is used when the input is to come from the result of another FCM. The
result of this source FCM should be expressed in terms of a string of bits. When this
option is chosen, the system uses the DEVICE TYPE field to determine the number
of inputs it needs. It automatically takes the correct number of inputs from the lower
order bits of the source FCM. For example, if DEVICE TYPE is 2_IN_1_C_OUT
(2 inputs, 1 contact output) and the source FCM has a 5 bit result, the system
automatically takes the lower two bits of the source FCM as the input for the device
loop. When this method is used to provide the input, the loop does not demand scan
on a state change of the input.

538 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

Valid entry is in the form:


tag.fcmname
where
tag is the tag for the loop containing the FCM
.fcmname is the user-specified name for the FCM
Mnemonic: INPUT_1

VENDOR TYPE Field


Use this field to specify the type of I/O providing the input or receiving the output.
When you use Taylor Remote I/O (TRIO), this field should be left at its default,
REMOTE I/O.
Valid entries are:
BURR/BROWN Multibus I/O
CONTROLLER Controller I/O (Direct I/O for a controller)
CUSTOM I/O Customized I/O
PLC I/O Programmable Controller inputs - Serial interface to a PLC
PROFIBUS I/O Profibus I/O. This vendor type is only available for Advant
Controller 460 subsystems configured on the Windows
platform using the AdvaBuild Control Builder version 3.2 or
higher software.
REMOTE I/O TRIO I/O
S100 I/O S100 I/O
S800 I/O S800 I/O
Default is: REMOTE I/O for either Turbo Node or Controller Subsystems

Since pulsed inputs and pulse train outputs do not support channel
path I/O addressing, they do not support S800 or Profibus I/O and
the S800 I/O and PROFIBUS I/O vendor type is not available.

3BUR002336R3701 RevA 539


How To Configure A Device Loop Section 11 Defining Device Loops

INPUT LAN NUMBER Field


This field is used for TRIO. It specifies the number of the field bus with the input
block. This number is determined by the connector the field bus is attached to. It is
on either Field Bus 1 or 2 for a Controller Subsystem. You can determine which bus
the block is on by checking to see if the bus is labeled with its bus number. If it is
not labeled, you can trace the bus number by checking to see which connector the
cable is attached to at the Field Bus Interface Module.
You can have up to 6 field buses attached to a turbo node. You can determine which
bus the module is on by checking to see if the bus is labeled with its bus number. If
the cable is not labeled, the field bus module for that bus must be pulled out of the
Multibus Card File. On this board there is a cluster of six jumper positions labeled
W7 through W12. There should be a jumper in one of these positions. If the jumper
is in position W7, the module is on Field Bus 1. If the jumper is in position W8, the
module is on Field Bus 2. This progression continues up to a jumper in position
W12, indicating the module is on Field Bus 6.

INPUT BLOCK NUMBER Field


This field specifies number of the block with the input channel. It is used for TRIO
input.
Valid entry is an integer in the range of 1 to 30.

INPUT CHANNEL NUM Field


This field is used when the device loop input comes from the digital input of a
Multibus I/O or Controller Subsystem. If the device algorithm specified in the
DEVICE TYPE field requires more than one input, additional inputs must be
present at input channels consecutive to the channel specified in this field.
Valid entry is the channel number.
There is no default for this field. If no entry is specified for this field, an entry must
be specified for the INPUT SOURCE field.
Mnemonic: IN_IOAD

540 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

OUTPUT LAN NUMBER Field


This field specifies the number of the field bus with the modules. This number is
determined by the connector the field bus is attached to. It is on either Field Bus 1 or
2 for a Controller Subsystem. You can determine which bus the module is on by
checking to see if the bus is labeled with its bus number. If it is not labeled, you can
trace the bus number by checking to see which connector the cable is attached to at
the Field Bus Interface Module.
You can have up to 6 field buses attached to a turbo node. You can determine which
bus the module is on by checking to see if the bus is labeled with its bus number. If
the cable is not labeled, the field bus module for that bus must be pulled out of the
Multibus Card File. On this board there is a cluster of six jumper positions labeled
W7 through W12. There should be a jumper in one of these positions. If the jumper
is in position W7, the module is on Field Bus 1. If the jumper is in position W8, the
module is on Field Bus 2. This progression continues up to a jumper in position
W12, indicating the module is on Field Bus 6.

OUTPUT BLOCK NUMBER Field


This field specifies the number of the block with the output channel. It is used for
TRIO output.
Valid entry is an integer in the range of 1 to 30.

OUTPUT CHANNEL NUM Field


This field is used when the device output goes to the digital output of a Turbo Node
or Controller Subsystem. If the device algorithm specified in the DEVICE TYPE
field requires more than one output, the additional outputs go to channels
consecutive to the channel specified in this field. If the outlet goes to TRIO, all
output channels must be on the same module.
Valid entry is the channel number.
There is no default for this field.
Mnemonic: OUT_IOAD

3BUR002336R3701 RevA 541


How To Configure A Device Loop Section 11 Defining Device Loops

The result of the loop is always set to the output of the device
whether or not an output channel is specified. This is accessible by
other loops.

MOMENTARY CHANNEL# Field


This field is used when you configure a special device algorithm requiring
momentary outputs. The entry to this field is the channel number of the first of up to
4 contiguous digital channels that perform the momentary outputs. The channels
you specify must have been configured for digital output via the appropriate templet
(Controller, Multibus I/O, or a Remote I/O Module Templet.). The duration and the
commands initiating the momentary outputs are specified on the Special Device
Templet. This field is only used when the device type is SPECIAL. For other device
types with momentary outputs, the output channel number is specified in the
OUTPUT CHANNEL NUM field.
Do not define momentary and regular output channels to overlap any channel (see
OUTPUT CHANNEL PATH). TRIO issues a warning and Profibus issues an error
if there is an overlap. S800 does not issue any error/warning about this.

INVERTED INPUTS Field


This field is used to make modifications to the device handling algorithm by
changing the bit patterns of the feedback (input) signals. These patterns are listed in
Table 38.
Valid entry is a decimal number identifying which bits are inverted.
Example:
If a device type supports the following 3 feedback states (as listed in the
Feedback from Device (Input) column of Table 38),
1010
1001
0101
entering a 4 to the INVERTED INPUTS field would invert bit 3 (the binary

542 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

equivalent of decimal 4) so the resulting feedback states are:


1110
1101
0001
Similarly, entering a 10 would invert bits 4 and 2 (the binary equivalent of 10).
Default is: 0 (no inversion)
Mnemonic: INV_INP

INVERTED OUTPUTS Field


This field is used to make modifications to the device handling algorithm by
changing the bit patterns of the output signals. These output signals are listed in
Table 38.
Valid entry is:
a decimal number identifying which bits are inverted. See the description of the
INVERTED INPUTS field for an example of inverting bits.
Default is: 0 (no inversion)
Mnemonic: INV_OUT

TRANSITION OVERRIDE Field


A transition timeout occurs when the system issues a command to a device and the
device does not go to the proper state within the time specified by the TIMER field.
The TRANSITION OVERRIDE field specifies the action applied to the device
command (DEV_CMND) when a transition timeout occurs.
Valid entries are:
NONE no change
STATE set to entry in the DEVICE STATE field (DEV_STAT). If
STATE is specified, but the current state does not correspond
to a valid command, the action taken is the entry in the SAFE
COMMAND field, if a command is specified in that field.

3BUR002336R3701 RevA 543


How To Configure A Device Loop Section 11 Defining Device Loops

SAFE CMD action taken is the entry in the SAFE COMMAND field
PREVIOUS CMD set to the last successful previous command
SPECIAL CMD set to command specified in the SPECIAL COMMAND field
Default is: NONE
Mnemonic: TRANOVRD

LOOP STATE Field


This field determines whether the loop is processed. When LOOP STATE is OFF,
the loop processor ignores the loop. The configuration entry is the initial loop state
for the loop.
Valid entries are:
ON process the loop
OFF do not process the loop
Default is: ON
Mnemonic: LP_STATE
Label on Loop Detail Display: LOOP MD
During runtime, you can turn the state of the loop on and off via the LOOP MD field
on the Loop Detail Display.

ALARM PRIORITY Field


This field specifies the priority level for any alarms occurring for the device.
Valid entries are:
HIGH high (priority 1)
MED medium (priority 2)
STD standard (priority 3)
Default is: STD
Mnemonic: STATE_AL

544 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

POSTING ENABLE Field


This field indicates whether posting is enabled for the loop. Posting affects the way
alarm information is presented at the Operator Stations or Multibus-based consoles
and on the Alarm/Event Log. Alarm Handling: Configuration, Detection, Posting,
and Cutout on page 164, describes the posting feature.
Valid entries are:
YES enable posting
NO disable posting
Default is: YES
Mnemonic: POSTENAB
Label on Loop Detail Display: AL POST
During runtime, you can suppress or enable alarm posting via the AL POST field of
the Loop Detail Display.

SUPPRESS ALARMS Field


This field specifies whether the loop processor checks to see if the alarms defined
by this loop are active.
Valid entries are:
YES suppress alarms (do not check)
NO do not suppress alarms
Default is: NO
Mnemonic: CHK_ENAB
Label on Loop Detail Display: AL CHEC

3BUR002336R3701 RevA 545


How To Configure A Device Loop Section 11 Defining Device Loops

DESCRIPTOR SET Field


This field specifies the descriptor set used for the device.
Valid entry is:
name of the Device Descriptor Templet defining the descriptor set desired for
the device. The descriptors must be suitable to the device handling algorithm
specified in the DEVICE TYPE field.
Mnemonic: STATESET
An entry must be made to this field. Do not leave it blank.

NUMBER OF INPUTS Field


This field is used when the device loop uses either a user-defined device handling
algorithm programmed with TCL, or a special device. For a user-defined device, the
system checks this field to see how many input channels there are to read. For a
special device, the system checks this field to see how many contact inputs there are
to read.
Valid entry is number of inputs.
Default is: 0

NUMBER OF OUTPUTS Field


This field is used when the device loop uses either a user-defined device handling
algorithm programmed with TCL, or a special device. For a user-defined device, the
system checks this field to see how many outputs to send. For a special device, the
system checks this field to see how many contact outputs there are to send.
NUMBER OF OUTPUTS means the number of continuous (non-momentary)
outputs, not the total number of outputs, both continuous and momentary.
To get momentary output channels and no regular output channels, define the
NUMBER OF OUTPUTS to be zero and configure the momentary channels on the
Special Device templet. Only the starting MOMENTARY CHANNEL# is defined
on the device loop.
Valid entry is number of outputs.
Default is: 0

546 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

DEVICE OVERRIDE Field


This field overrides the feedback timer. When set to YES, there are no Timeout
Alarms for the device. See the description of the TIMER field for a description of
Timeout Alarms.
Valid entries are:
NO_CHECK override the feedback timer
NORMAL do not override the feedback timer
Default is: OFF
Mnemonic: DEV_OVRD

SIMULATION MODE Field


This field facilitates testing and simulating device situations with TCL or a host
computer. When the Simulation Mode is ON, the device loop does not perform
inputs and outputs. When it is OFF, inputs and outputs are handled in the normal
manner.
This field defines the initial value of the Simulation Mode. During runtime, you can
turn the mode ON or OFF via the Loop/FCM Display for the device loop. You can
also change the mode by TCL or by programs run on a host computer.
The effect of the Simulation Mode on device processing depends on the state of the
DEVICE OVERRIDE field on the Device Loops Templet. Table 40 lists the
possibilities.
Valid entries are:
ON device simulation mode is on
OFF device simulation mode is off
Default is: OFF
Mnemonic: DEV_INHB

3BUR002336R3701 RevA 547


How To Configure A Device Loop Section 11 Defining Device Loops

Table 40. Effects of Simulation Mode and Device Override on Device Processing

Device
Simulation Mode Effect on Device Processing
Override
OFF(0) OFF (0) Normal device processing
ON (1) OFF (0) Condition for simulating device processing via TCL or host
computer. Device loop does not do inputs or outputs.
The timeout timer runs in normal manner. If DEV_STAT does
not equal DEV_CMND when timer reaches 0, a timeout is
declared. TCL or a program on a host computer can change
DEV_STAT.
Device loop does not change DEV_STAT.
OFF (0) ON (1) Device inputs are ignored.
The timeout timer runs in normal manner.
When timer reaches 0, CCF puts value of DEV_CMND into
DEV_STAT.
ON (1) ON (1) Device loop does not do inputs or outputs.
CCF puts value of DEV_CMND into DEV_STAT as soon as
DEV_CMND is changed (that is, does not wait for timeout
timer).

INITIAL MODE Field


This field determines the output mode for the loop at the start-up.
Valid entries are:
AUTO loop is under the control of TCL or a supervisory package
MAN operator determines output
Default is: AUTO
Mnemonic: INITMODE

548 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

INITIAL COMMAND Field


This field specifies the command sent to the device upon start-up and the warmstart
action.
Valid entries are:
• any of the valid commands defined by the descriptor set for the device
• no entry (blank field) sends out a 0 when the device loop goes on-line
• NO COMMAND sends out nothing, that is, there is no processing on start-up.
This is often used when the device loop interacts with a programmable
controller over a PC interface. The entry NO COMMAND is used to insure the
device loop does not affect the programmable controller when the device loop
goes on-line.
Default is: blank field
Mnemonic: INIT_CMD
Warmstart action is supported for TRIO, S800, and S100 (DSAX110A,
DSDX180A, and DSDO115A boards). For warmstart, enter NO COMMAND. A
device loop with NO COMMAND as its initial command does not perform its
output calculation until its DEV_CMND attribute is altered. On node start-up,
resumption of communication with an I/O device, or loop download, one of two
actions occurs for a device loop configured for warmstart. If there are inputs to the
device, the DEV_CMND attribute is adjusted to command the device to assume the
existing field state. If there are no inputs, the DEV_CMND attribute is set to the
INIT_CMND which is NO COMMAND.

ORDER OF PROCESSING Field


If two or more loops are scheduled for processing at a given time, the loop with the
lowest entry in the ORDER OF PROCESSING field is processed first.
Valid entry is a number between 0 and 99999.0. Decimal values are allowed.
Default is: 9999.0

3BUR002336R3701 RevA 549


How To Configure A Device Loop Section 11 Defining Device Loops

ABNORMAL OVERRIDE Field


This field specifies the action to take if an abnormal state change timeout occurs. If
a device changes state when no command was issued to the device, the abnormal
timer starts counting down from the amount of time specified in the ABNORMAL
TIMER field. If it reaches 0, the action specified in this field is applied to the device
command parameter (DEV_CMND).
Valid entries are:
NONE no change to device command, but abnormal state change
alarm is generated
STATE device command (DEV_CMND) is set to value of Device
State (DEV_STAT), abnormal state change alarm is
generated
SAFE COMMAND device command (DEV_CMND) is set to entry in the SAFE
COMMAND field, abnormal state change alarm is generated
NONE/NA no change, no abnormal state change alarm
STATE/NA set to value of Device State (DEV_STAT), no abnormal state
change alarm
SAFE/NA set to entry in the SAFE COMMAND field, no abnormal
state change alarm
PREVIOUS CMD set to last successful previous command
SPECIAL CMD device command (DEV_CMND) is set to entry in the
SPECIAL COMMAND field
Default is: NONE
Mnemonic: ABNMOVRD

Device change-of-state alarms will not occur when there are no


outputs, unless the device is a special device.

550 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

ABNORMAL TIMER Field


This field specifies the amount of time the abnormal timer is set to when an
abnormal state change occurs. See the description of the ABNORMAL OVERRIDE
field. If you want the specified abnormal override actions to occur, you must enter a
non-zero entry. Abnormal state change alarms will occur (if the device is so
configured), regardless of the entry in this field.
Valid entry is an amount of time in whole seconds.
Default is: 0
Mnemonic: ABNM_TIM

SECONDARY TIMER Field


This field is used when the device loop uses a user-defined TCL device handling
algorithm. It sets the initial time for a countdown timer used by the TCL program
which sets up the user-defined device algorithm.
Valid entry is an amount of time in whole seconds.
Default is: 0
Mnemonic: TIMER_2 is the initialization value for the timer (as defined by the
TIMER field)
TIM2_CNT is the current value of the timer

TIMER Field
This field sets the time for the device loop's feedback timer. When the loop sends a
command to the device, the feedback timer starts counting down. The loop starts
checking its input to see if the device has gone to the desired state. A timeout alarm
is generated if the device has not entered the desired state by the time the timer
expires.
Valid entry is an amount of time in whole seconds.
Default is: 0 (no timeout alarm)

3BUR002336R3701 RevA 551


How To Configure A Device Loop Section 11 Defining Device Loops

Mnemonic: TIMER_1 is the initialization value for the timer (as defined in the
TIMER field on templet)
TIM1_CNT is the current value of the timer
The rest of the fields on the Device Loop Templet, Figure 77, allow you to specify
device interlock, command, action upon error, and restrictions for the device.

Figure 77. Device Loop Templet, Lower Portion

552 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

DEV INTERLOCK ENABLE Field


This field specifies whether the device interlock is enabled or disabled. When it is
enabled, the result of the FCM named in the DEV INTERLOCK SOURCE field
determines whether the device is locked. When the result goes true the device is
locked and the only possible command entry is the one specified in the
PERMITTED COMMAND field.
Valid entries are:
YES enable the interlock
NO disable the interlock
Default is: NO
Mnemonic: LOCKENAB

DEV INTERLOCK SOURCE Field


This field specifies an FCM whose result is the interlock source. See the description
of the DEVICE INTERLOCK ENABLE field for information on this feature.
Valid entry is in the form:
tag.fcmname

SPECIAL COMMAND Field


This field specifies the command automatically sent to the device as part of
transition override. See the description of the TRANSITION OVERRIDE field for
an explanation of this feature.
Valid entry is:
a command from the descriptor set defined for the device on its Device
Descriptor Templet

SAFE COMMAND Field


This field specifies the command automatically sent to the device as part of
transition override or abnormal override. See the descriptions of the TRANSITION

3BUR002336R3701 RevA 553


How To Configure A Device Loop Section 11 Defining Device Loops

OVERRIDE field and the ABNORMAL OVERRIDE field for explanations of these
features.
Valid entry is:
a command from the descriptor set defined for the device on its Device
Descriptor Templet
Mnemonic: SAFECMND

PERMITTED COMMAND Field


This field specifies the only possible command sent to the device as part of device
interlock. See the description of the DEV INTERLOCK ENABLE field for an
explanation of this feature.
Valid entry is:
a command from the descriptor set defined for the device on its Device
Descriptor Templet
Mnemonic: PRM_CMND

REVERT ENABLE Field


This field specifies whether or not revert is enabled. When it is enabled, after the
operator or a program changes the device command (DEV_CMND) state,
DEV_CMND is automatically changed to the command specified in the REVERT
COMMAND field. The revert command is an internal mechanism only and is not
sent to the device, that is, no field changes.
Valid entries are:
YES enable
NO disable
Default: NO
Mnemonic: REVERTS
For example, a valve is opened by pulses (momentary digital outputs). The Device
Descriptor Templet defines the command OPEN to send a pulse to the valve. A
second command, PAUSE, is defined as a waiting state. Revert is enabled and

554 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

PAUSE is specified in the REVERT COMMAND field. After you send an OPEN
command to the valve, DEV_CMND is set to PAUSE. This allows you to change
DEV_CMND to OPEN again, and so on.

REVERT COMMAND Field


This field specifies the command to which DEV_CMND is automatically set as part
of revert.
Valid entry is:
a command from the descriptor set defined for the device on its Device
Descriptor Templet
Mnemonic: REV_CMND

CUTOUT ENABLE Field


This field specifies whether cutout is enabled for the loop. Cutout allows an FCM of
this or another loop to control the posting of the alarms. Alarm Handling:
Configuration, Detection, Posting, and Cutout on page 164, describes the posting
and cutout features.
Valid entry is:
YES enable the cutout feature
NO disable the cutout feature
Default is: NO
Mnemonic: CO_ENAB

CUTOUT SOURCE Field


This field defines the source for the cutout signal. The source should be set up so its
value is in one of two states: true (non-zero) or false (zero). When the state of the
source is equal to the state specified in the CUTOUT STATE field, there is cutout
for the loop. Alarm Handling: Configuration, Detection, Posting, and Cutout on
page 164, describes the posting and cutout.

3BUR002336R3701 RevA 555


How To Configure A Device Loop Section 11 Defining Device Loops

Valid entries are in the form:


.fcmname result of another FCM in the loop is the cutout source
tag.fcmname result of a FCM from another loop is the cutout source

CUTOUT STATE Field


This field defines the state the state that the cutout source must be in to cause cutout.
Valid entries are:
TRUE causes cutout when the cutout signal is true (non-zero)
FALSE causes cutout when the cutout signal is false (zero)
Default is: TRUE
Mnemonic: CO_STAT

UNIT ID Field
This field assigns the loop to a unit. This assignment is useful for systems
containing the History Services software. The alarm/event history messages for all
loops in a unit are collected and stored in the same file. If a unit assignment is not
made for a loop, the History Services software stores alarm/event history messages
for the loop in a default unit file.
Valid entry is:
name of a unit as defined via the TEMPLET NAME field of the Unit Master
Templet for that unit

SEQUENCE ID Field
The function related to this field has not been implemented. This field should be left
blank.

INPUT CHANNEL PATH and OUTPUT CHANNEL PATH


This field is only available when using the AdvaBuild Templet Builder to configure
the Device Loop Templet. An entry is required in this field if the entry in the
VENDOR TYPE field is either S800 I/O or PROFIBUS I/O.

556 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

For S800 I/O, this field is used to specify the LAN, station, cluster, position, and
channel of the respective input or output point in the following format:
LAN.station.cluster.position.channel
For example, an entry of 1.10.0.4.10 indicates that the S800 I/O point is on LAN 1,
station 10, cluster 0, position 4, channel 10.
For PROFIBUS I/O, this field is used to specify the LAN, device, module, and
channel of the respective input or output point in the following format:
LAN.device.module.channel
For example, an entry of 1.2.5.1 indicates that the Profibus I/O point is on LAN 1,
device 2, module 5, channel 1.
Do not define momentary and regular output channels to overlap any channel (see
MOMENTARY CHANNEL#). TRIO issues a warning and Profibus issues an error
if there is an overlap. S800 does not issue any error/warning about this.

OUTPUT ERROR ACTION Field


This field specifies the actions taken when the output driver fails.
Valid entries are:
NOTHING continue normal processing
GOTO BACKUP processing goes to the Backup Controller Module if one is
present. This option shuts down CCF processing in a
Multibus subsystem when the driver fails.
LOOP OFF turn the loop off
Default is: NOTHING
Mnemonic: OUTP_ERR

ENA ACC RESTRICTIONS Field


This field specifies whether access restrictions for the device are enabled or
disabled.
Valid entries are:

3BUR002336R3701 RevA 557


How To Configure A Device Loop Section 11 Defining Device Loops

NO access restrictions are disabled. Engineers, operators, TCL


programs, and programs on host computers can change the device
command.
YES access restrictions are enabled. The device mode determines who
can change the device command. If the mode is MANUAL,
operators and engineers can change the device command. If the
mode is AUTO, TCL programs and programs on host computers
can change the device command.
Default is: NO
Mnemonic: DEV_REST (TCL cannot reference this parameter)

COMP MODE RESTRICT Field


This field is not implemented for device loops.

ABNORMAL STATE Field


This field specifies whether the system should check the device loop for an
abnormal condition. For a device loop, an abnormal condition is caused when either
the loop is off, device override is in effect, or device inhibit is in effect.
Valid entries are:
YES system checks for an abnormal state. If the loop is in an abnormal
state, the NORMSTAT attribute is set to 1 and its tag is displayed in
reverse video on the operator displays.
NO system does not check for an abnormal state
Default is: NO
Mnemonics: ENAB_FLG for abnormal state checking
NORMSTAT 0 normal state
1 abnormal state

558 3BUR002336R3701 RevA


Section 11 Defining Device Loops How To Configure A Device Loop

LOG STATE CHANGES Field


This field provides the means to enable or disable logging of state changes for this
device (that is, an audit trail of device state change messages in a historical archive).
Valid entries are:
YES log state changes for this device. Each time the device loop is
scanned the old and new states are determined. If the old and new
states differ, an attempt is made to send a state change message to
the Alarm/Event package which sends the message to the History
node. If memory cannot be allocated for the state change message,
the History node will display, NOCOMMAND in place of the
missing device states. This indicates to the operator that at least one
state change was not logged.
NO do not log state changes for this device
Default is: NO
Mnemonic: ABNORM_C 0 do not log state changes
1 log state changes

DMND PROCESSING MODE Field, # LOOPS TO PRESCAN Field, and LOOPS


TO PROCESS Field
The DMND PROCESSING MODE field, # LOOPS TO PRESCAN field, and
LOOPS TO PROCESS fields allow you to specify up to 5 loops to process along
with this loop. The DMND PROCESSING MODE field is used to specify whether
the loops are processed when this loop is normally processed or when it is demand
scanned, or both. The # LOOPS TO PRESCAN field determines how many of the
listed loops are scanned before this loop and how many are scanned after. The
LOOPS TO PROCESS fields list the loops for this type of processing.
Valid entries for the DMND PROCESSING MODE field are:
NONE no extra processing
NORMAL process loops as specified in the LOOPS TO PROCESS fields when
this loop is normally scanned
DEMAND process loops as specified in the LOOPS TO PROCESS fields when
this loop is demand scanned

3BUR002336R3701 RevA 559


Non-configurable Parameters of Device Loops Section 11 Defining Device Loops

BOTH process loops as specified in the LOOPS TO PROCESS fields when


this loop is demand or normally scanned

# LOOPS TO PRESCAN Field


This field specifies the loops processed in conjunction with the DMND
PROCESSING MODE field and the LOOPS TO PROCESS field.
For example, if there are five loops listed in the LOOPS TO PROCESS fields, and
the # LOOPS TO PRESCAN field contains two, when the DMND PROCESSING
MODE field calls for processing, the first two loops in the LOOPS TO PROCESS
fields are processed before the device loop and the last three in the LOOPS TO
PROCESS fields are processed after it.
Valid entry is:
an integer from 1 to 5 indicating the number of loops to process before the
device loop
Default is: 1

LOOPS TO PROCESS Fields


This column of fields lists the loops to be processed in conjunction with the DMND
PROCESSING MODE field and the # LOOPS TO PRESCAN field.
Valid entries are:
up to 5 loop tags. Each field in the column of LOOPS TO PROCESS fields can
hold one tag. Do not enter the tag of the loop being configured. Up to five
levels of nesting are allowed, that is, loops in the fields demand process other
loops, and so on

Non-configurable Parameters of Device Loops


These device loop parameters are generated automatically by the system during
runtime. They are not configured via the templets. These parameters are accessible
by other applications via tag access. See Appendix A, Advant OCS Data Base, for
data base access methods.

560 3BUR002336R3701 RevA


Section 11 Defining Device Loops Non-configurable Parameters of Device Loops

ACT_ALM - Action Alarm


This parameter indicates whether there are any active action alarms for the device.
Possible states for the parameter are:
NO_ALARM (0)
ABNORMAL_CH (1) device changed state but no command to do so was issued
TIMEOUT (2) system sent a valid command to the device. The device
did not respond, within the specified time, that it had
entered the desired state. The timeout interval is specified
via the TIMER field of the Device Loops Templet at
configuration time.

DATAQUAL DATA - Quality of the Result


This parameter gives the data quality of the device loop's result parameter.
Possible states for the parameter are: BAD (0), GOOD (1)

DMD_SCAN - Demand Scan


This parameter determines if the loop is processed normally by the loop processor
or if there is a special loop scan.
Possible states for the parameter are:
NORMAL (0) process the loop according to the processing rate and
phase parameters
DEMAND_SCAN (1) scan the loop immediately

DEV_CMND - Device Command


This parameter indicates the command being issued to the device by either the
operator or a supervisory program.
Possible states for the parameter are:
• The value of this parameter is stored as a decimal integer equivalent to one of
the states of the device as specified via the Device Descriptor Templet defining
the descriptor set for the device. See Descriptor Sets on page 524.

3BUR002336R3701 RevA 561


Non-configurable Parameters of Device Loops Section 11 Defining Device Loops

• TCL and Display Builder expressions containing this parameter can use the
descriptors for the states as long as the proper syntax rules are followed.
Example of a TCL Expression:
$'PUMP-1'.DEV_CMND:= #OFF;
See instruction books Display Builder User's Guide, and Taylor™ Control
Language (TCL), for the respective TCL and Display Builder syntax rules.

DEV_MODE - Device Mode


This parameter gives the current control mode of the device.
Possible states for the parameter are:
MANUAL (0) operator determines output
AUTO (1) loop is under the control of TCL or a supervisory package

During runtime, operators cannot change the device mode to


MANUAL if manual enable (MAN_ENAB) is disallowed.
On Process Portal Operator Stations, all users cannot change the
device mode to MANUAL from the faceplate. However, if the user
has the proper authority, they can override this from the Loop FCM
Display.

DEV_INHB - Device Inhibit


This parameter specifies whether the software allows the device to be operated.
Possible states for the parameter:
NORMAL (0) operator or supervisory program can operate the device
INHIBITED (1) no operator or program can operate the device
When the simulation mode is activated (ON), DEV_INHB is set to 1 and outputs for
this device loop are not sent to the field.

562 3BUR002336R3701 RevA


Section 11 Defining Device Loops Non-configurable Parameters of Device Loops

DEV_STAT - Device State


DEV_STAT gives the current state of the device. It is the result of the feedback from
the device. Possible states for the parameter are:
• The value of this parameter is stored as a decimal integer equivalent to one of
the states of the device as specified via the Device Descriptor Templet defining
the descriptor set for the device. See Descriptor Sets on page 524.
• TCL and Display Builder expressions containing this parameter can use the
actual descriptors as long as the proper syntax rules are followed.
Example of a TCL Expression:
$'PUMP-1'.DEV_STAT := #OFF;
See instruction books Display Builder User's Guide, and Taylor™ Control
Language (TCL), for the respective TCL and Display Builder syntax rules.

DEV_TRAN - Device Transition


DEV_TRAN tells whether the device is in transition from one state to another.
Possible states for the parameter are:
NOT_IN_XITION (0) device is not in transition
IN_XITION (1) device is in transition to another state

FIELD_ST - Field State


FIELD_ST is the actual state of the device. It is displayed as STATE on the Loop
Detail Display and as FIELD on the LOOP/FCM Display. The input for FIELD_ST
is read from the field so it is not affected by the Simulation Mode.

INP_ALM - Input Alarms


INP_ALM specifies whether there is an active alarm for the device input. Possible
states are:
NO_ALARM (0)
DQ_BAD (1) data quality of at least one input has gone to BAD

3BUR002336R3701 RevA 563


Non-configurable Parameters of Device Loops Section 11 Defining Device Loops

ALARMED_STA (3) device has entered a alarm state as defined by the device
descriptor set for the device
ILLEGAL_STA (4) system can read the feedback from the device, but no state
is defined for the feedback bit combination

MAN_ENAB - Manual Enable


This parameter specifies whether a user with operator access rights can switch the
device to manual. Engineers and supervisors are always to switch loop to manual.
Possible states for the parameter are: DISALLOWED (0), ALLOWED (1)

PROC_DQ - Product Data Quality


This parameter gives the data quality of the PROC_VAL variable. It is used when
the device is handled via a user-defined algorithm in a TCL program. See
Programming User-defined Device Algorithms With TCL on page 573.
Possible states for the parameter are: BAD (0), GOOD (1)

PROC_VAL - Process Value


This variable is used when the device is handled via a user-defined algorithm in a
TCL program. See Programming User-defined Device Algorithms With TCL on
page 573.

RESULT - Result
This parameter gives the result of the device loop's calculation.

TCL_ALM - TCL Alarm


This parameter specifies whether an alarm is active for a TCL defined device
algorithm. Possible states for the parameter are: NO_ALARM (0), TCL_FAILED
(1), TCL_TIMEOUT (2)

TIM1_CNT
This parameter is the current value of the device timeout timer. It is used by device
loops containing standard algorithms.

564 3BUR002336R3701 RevA


Section 11 Defining Device Loops How to Define a Device Loop

TIM2_CNT
This parameter is the current value of the secondary timer. It is used by TCL
programs that set up user-defined device algorithms.

TIME_CNT
This parameter gives the current value of the TCL timeout timer. Its usage is
described in Programming User-defined Device Algorithms With TCL on page 573.

How to Define a Device Loop


To define a device loop:
1. Specify the device tag. This is accomplished by giving the Device Loop
Templet a name.
The tag serves as the identifier for the loop. It is used whenever the parameters
of the loop are accessed by any software package in the system. The tag is
determined by you and can contain up to 12 characters. Allowable characters
for tags are the letters A through Z, the numbers 0 through 9, and the hyphen (-
). The tag must be unique system wide. Examples of tags are DEV-101 and
PUMP3.
2. Assign a descriptor to the device by making an entry to the LOOP
DESCRIPTOR field.
3. Specify the period at which the device loop is processed. To do so, define
PROCESSING RATE and PROCESSING PHASE. These two fields determine
normal processing of the loop. Whenever there is an active operator command,
the loop is automatically processed regardless of the normal processing period.
4. Specify the inputs source (feedback from the device) using one of the
following options:
Input Option 1 - Input from Direct Digital Input of Controller or
Multibus.
Field Entry
VENDOR TYPE CONTROLLER (if in a Controller
Subsystem)

3BUR002336R3701 RevA 565


How to Define a Device Loop Section 11 Defining Device Loops

BURR/BROWN (if in a Turbo Node


Subsystem)
INPUT LAN NUMBER leave at default
INPUT BLOCK NUMBER leave at default
INPUT CHANNEL NUMBER used to specify input channel number. Some
devices require more than one input. For
these devices, INPUT CHANNEL
NUMBER specifies the first input. The other
inputs must be at channels contiguous to the
first channels The system uses the entry
made for the DEVICE TYPE field to
determine the number of input channels to
read.
Input Option 2 - Input from a TRIO Module.
Field Entry
VENDOR TYPE: REMOTE I/O
INPUT LAN NUMBER number of the field bus containing the TRIO
module providing the input. It is 1 or 2 for a
Controller Subsystem or from 1 to 6 for a
Turbo Node Subsystem.
INPUT BLOCK NUMBER number of TRIO modules supplying inputs
(1 to 30)
INPUT CHANNEL NUMBER channel number of the first input. The other
inputs must be present at channels
consecutive to the first channel. The inputs
must all come from the same module.
However, the inputs can come from a
module other than the one that receives the
output.
Input Option 3 - Use the Input Source Field.
Use INPUT SOURCE to specify the input is the result of an FCM from another
loop. The system uses the DEVICE TYPE field to determine the number of bits

566 3BUR002336R3701 RevA


Section 11 Defining Device Loops How to Define a Device Loop

to read from the result. It takes the correct number of bits starting with the least
significant bit. For example, if the DEVICE TYPE is 2_IN_1_C_OUT (2
inputs, 1 contact output), the system uses the lower two bits of the source
FCM's result as the input for the device loop.
Input Option 4 - No entries
Certain types of devices require no inputs. In this case, no entries are made to
the INPUT SOURCE or the INPUT CHANNEL NUMBER fields.
Input Option 5 - PLC
Receives inputs via PLC interface. Refer to Taylor™ Programmable Controller
Interface User's Guide, for detailed information.
5. Specify the destination for the outputs using one of the following options:
Output Option 1 - Output to direct Digital Input of Controller or Turbo
Node.
The output is sent to the digital output of a Controller or a Turbo Node
Subsystem. In this case, use the OUTPUT CHANNEL NUMBER field to
specify the channel number to which the output is sent. If the device, as
specified in the DEVICE TYPE field, has a second output, it is sent to the next
consecutive output channel. When this option is chosen, the result of the loop is
still accessible by other loops.
Output Option 2 - Output to a TRIO Module.
Field Entry
VENDOR TYPE REMOTE I/O
OUTPUT LAN NUMBER number of field bus with the TRIO output
module
OUTPUT BLOCK NUMBER number of TRIO output modules (up to 30)
OUTPUT CHANNEL NUMBERchannel number of the first output. The other
outputs must be present at channels
consecutive to the first channel. Outputs
must all come from same module. However,
the outputs can come from a module other
than the one that receives the output.

3BUR002336R3701 RevA 567


How to Define a Device Loop Section 11 Defining Device Loops

Output Option 3 - PLC


Sends outputs across the PLC interface. See the Taylor™ Programmable
Controller Interface User's Guide for detailed information.

The device loop always has a result set equal to the current output
(device command) of the loop. This result is accessible by other
loops.

6. Specify how the device is handled. This is accomplished by entries to the


following fields:
Field Entry
DEVICE TYPE specifies the basic device handling algorithm.
These algorithms are listed in Table 38.
DESCRIPTOR SET allows assignment of a set of descriptive words to
the commands you can send to the device
INVERTED INPUTS and entries are made to these fields when minor
INVERTED OUTPUTS changes are made to the input or output states of the
device handling algorithm
7. Specify the alarm handling parameters for the device. To do this, make entries
to the following fields: TIMER, CUTOUT ENABLE, CUTOUT SOURCE,
CUTOUT STATE, ALARM PRIORITY, POSTING ENABLE, SUPPRESS
ALARM and DEVICE OVERRIDE.
8. Specify the action taken if the loop fails in the OUTPUT ERROR ACTION
field.
9. Specify initialization parameters for the device in the INITIAL MODE and
INITIAL COMMAND fields.

568 3BUR002336R3701 RevA


Section 11 Defining Device Loops How to Configure Special Device Algorithms

How to Configure Special Device Algorithms


The Special Device Templet, Figure 78, is used to define the characteristics of a
special device algorithm. You need one of these templets for each type of special
algorithm your system requires.

Figure 78. Special Device Templet

3BUR002336R3701 RevA 569


How to Configure Special Device Algorithms Section 11 Defining Device Loops

A Special Device Templet is used by one or more Device Loops Templets in the
same Turbo Node or Controller Subsystem as the Special Device Templet. If two
different nodes or controllers require the same special algorithm, they must have
their own version of the Special Device Templet setting up the algorithm.
The Special Device Templet, is not a loop templet so it is not compiled, installed, or
downloaded on the loop level. However, if a Special Device Templet is already in a
downloaded data base, you can compile, install, and download a Device Loop
Templet that references it on the loop level.
If a device does not fit into one of the standard categories, a special device type is
created. For example, Special Devices are required for momentary outputs that
require pulses of more than one second. These special devices are similar in some
ways to standard devices. They require a Device Loops Templet that references a
descriptor set. In addition, their Devices Loops Templet must reference a Special
Device Templet defining the algorithm used by the device. This special device
templet specifies the following:
• digital output pattern sent to the field for each of the commands in the device
descriptor set
• 0 to 4 momentary outputs used by the devices
A standard Device Loops Templet must be configured for a special device. Most of
the fields of this templet are used in the normal manner, for example, the TEMPLET
NAME field becomes the device tag, and so on. The following paragraphs describe
the fields handled in a special manner for these device loops.
The DEVICE TYPE field must contain SPECIAL.
The INPUT SOURCE field is not applicable to a special device loop. The input for
one of these loops cannot be the result of an FCM.
The SPECIAL NAME field must contain the name of the Special Device Templet
that defines the algorithm.
The MOMENTARY CHANNEL # field is used to specify the channel number of
the first of up to 4 contiguous digital channels that perform the momentary outputs.
The channels you specify must have been configured for digital output via the
appropriate templet (Controller, Multibus I/O or TRIO). The duration and the
commands that initiate the momentary outputs are specified on the Special Device
Templet.

570 3BUR002336R3701 RevA


Section 11 Defining Device Loops How to Configure Special Device Algorithms

You can invert the momentary outputs using the INVERTED OUTPUTS fields by
entering a decimal value corresponding to the bits to invert.
Example:
If a device type supports the following 3 feedback states (as listed in the
Feedback from Device (Input) column of Table 38),
1010
1001
0101
entering a 4 to the INVERTED INPUTS field would invert bit 3 (the binary
equivalent of decimal 4) so the resulting feedback states are:
1110
1101
0001
Similarly, entering a 10 would invert bits 4 and 2 (the binary equivalent of 10).
For example, an entry of 5 (binary 0101) in the INVERTED OUTPUTS field inverts
the first and third channel, and an entry of 15 (binary 1111) inverts all 4 channels.
The DESCRIPTOR SET field is used in the normal manner, even though this
information is repeated on the Special Device Templet.
If you wish to use the revert feature, you still must use the REVERT ENABLE and
REVERT COMMAND fields, however, the Special Device Templet allows you to
specify which commands are followed by the revert command.

TEMPLET NAME Field


Assign a name to the templet via this field. This name is used by Device Loops
Templets that reference this templet. Note that no two templets can have the same
name. If two or more nodes (or subnodes) require the same special device type, they
each must have a uniquely named Special Device Templet to set up the device type.

DESCRIPTOR SET Field


This field specifies the Device Descriptor Templet associated with this device.

3BUR002336R3701 RevA 571


How to Configure Special Device Algorithms Section 11 Defining Device Loops

# MOMENTARY OUTPUTS Fields


This field specifies the number of momentary outputs (0 to 4) that the special device
is to use. If the special device does not need momentary outputs, leave this field at 0.
Otherwise, enter the number of momentary outputs the device needs and specify the
duration of each output via the MOMENTARY DURATION #n fields. These
outputs must be made at contiguous digital output channels. You must also specify
the channel number for the first of these channels on the MOMENTARY
CHANNEL # field of the Device Loops Templet. Do not define momentary and
regular output channels to overlap any channel.
Valid entry is an integer from 0 to 4.
Default is: 0

MOMENTARY DURATION # 1 through 4 Fields


These fields specify the duration of the momentary outputs.
Valid entry is:
a number of milliseconds. The smallest allowed entry is the digital output rate
of the node or subnode containing the loops. The largest entry is 65535.
Default is: 0

COMMAND, OUTPUT, MOMENTARY OUTPUT, INPUT MASK, and REVERT


Fields
These fields define the commands sent to the device. You must complete a row of
these fields for each device state having a valid command associated with it.

COMMAND Field
This field enters the name of the state. The entry must be the same name entered in
the NAME OF STATE column on the Device Descriptor Templet.

OUTPUT Field
This is a 16 place bit-pattern for the output from the computer for this command.
The least significant bit is on the right. All leading zeros must be included. For

572 3BUR002336R3701 RevA


Section 11 Defining Device Loops Programming User-defined Device Algorithms With TCL

example, 001100000000111. If this field is not needed for the command, enter all
zeros.

MOMENTARY OUTPUT Field


An entry in this field specifies which momentary output channels are to output when
this command is executed. For example, if there are three momentary outputs, an
entry of 0101, specifies that the first and third perform outputs when this command
is executed. If this field is not needed for the command, enter all zeros.

INPUT MASK Field


This field is a 16 place bit-pattern used to verify the device has changed state after
the command is issued. Put ones in the bit pattern for the bits pertinent to the
command. For example, if bits 0, 1, 2, and 4 are pertinent to the command, the entry
should be 0000000000010111. If this field is not needed for the command, enter all
zeros.

REVERT Field
This field specifies whether the system automatically sets DEV_CMND to the entry
in the REVERT COMMAND field after this command is issued. The Revert
Command is an internal mechanism that is not sent to the field.
Valid entries are:
YES follow with the Revert Command
NO do not follow with the Revert Command.

Programming User-defined Device Algorithms With TCL


If none of the standard device algorithms, as listed in Table 38, are suitable for a
particular device, you can write a TCL program to implement the required
algorithm. Implementing TCL device handling for a device requires two main steps:
1. A TCL program to execute the algorithm must be edited and compiled.
2. A CCF device loop must be configured. When processed, the device loop gets
the inputs, starts the TCL program and makes the value of the inputs available

3BUR002336R3701 RevA 573


Processing of Device Loops that Contain User-defined Algorithms Section 11 Defining Device

to the program. The program executes the device algorithm and passes a
parameter back to the device loop which becomes the output.
The following paragraphs contain information about the interaction of the device
loop and the TCL program you should understand prior to implementing a user-
defined device algorithm.

Processing of Device Loops that Contain User-defined Algorithms


A device loop containing a user-defined device algorithm is processed in a manner
different from other loops. The events that occur include:
1. The device loop is started. The loop processor checks the input (feedback)
value of the device and puts this value into the device state parameter
(DEV_STAT).
2. The device loop initializes timer TIME_CNT to the loop processing rate, starts
the TCL program if it is not already running, puts the device loop on quick
scan, and goes on to other loops.
3. The loop processor checks the device during every CCF base rate cycle when
the device loop is on quick scan.
For example, if the scan rate for the device loop is 4 seconds and the CCF base rate
is 1 second, the device loop and TCL program are started between seconds 0 and 1.
The device loop is checked between seconds 1 and 2, and, if needed, between
seconds 2 and 3, and 3 and 4.
The loop processor performs the following each time it checks the device loop:
1. It checks the input (feedback) value of the device and puts this value into the
device state parameter (DEV_STAT).
2. It checks the state of the TCL program and performs one of the following
actions:
– If the program wants outputs made to the device, the loop processor
moves the value of the PROC_VAL parameter to the RESULT parameter
and the value of the PROC_DQ parameter to the DATAQUAL parameter.
It outputs the value of the RESULT parameter to the device and sets timer
TIME_CNT to the sum of the TIMER_1 and TIMER_2 parameters.
TIMER_1 is configured via the TIMER field of the Device Loops

574 3BUR002336R3701 RevA


Section 11 Defining Device Loops Configuring a Device Loop that Contains a TCL Defined

Templet. TIMER_2 is configured via the SECONDARY TIMER field.


The loop stays on quick scan and is checked again at the next CCF base
rate cycle.
The program is allowed to request more than once for outputs. The
TIME_CNT parameter is re-initialized to the sum of the TIMER_1 and
TIMER_2 parameters on each scan that outputs are requested.
See How to Define a Device Loop on page 565, for a description of the
steps that the program must take to signify that it wants CCF to make an
output to the device.
– If the program has completed, the loop processor puts the device loop
back on normal scan and goes to the next loop. (It is possible for the
program to request outputs and acknowledge completion in the same
scan.)
– If the program timed out (that is, the value of the TIME_CNT parameter
reached 0), a TCL timeout alarm is generated, the loop is turned off, and
the loop processor goes on to the next loop.

Configuring a Device Loop that Contains a TCL Defined Algorithm


A device loop containing a user-defined algorithm is configured in the normal
manner. The following points should be kept in mind:
• The device loop must be given a processing (scan) rate at least twice the CCF
base rate of the node containing the loop. When specifying the processing rate,
it should be remembered that the maximum time for the TCL program to
complete its execution is somewhat less than the processing rate of the loop.
• A Device Descriptor Templet must be configured to support the states defined
by the TCL program.
• The Device Loops templet for the device must contain the following entries:
– DEVICE TYPE field must be set to USER DEFINED.
– The NUMBER OF INPUTS field must contain an entry for the device.
– The NUMBER OF OUTPUTS field must contain an entry for the device.
– The DESCRIPTOR SET field must contain the name of the descriptor set

3BUR002336R3701 RevA 575


Requirements for TCL Programs that Implement Device Algorithms Section 11 Defining Device

supporting the algorithm.


– The SECONDARY TIMER field can contain an entry if the TCL program
requires an initialization value for the secondary device timer. This value
is also used in determining if TCL has timed out. See Programming User-
defined Device Algorithms With TCL on page 573

Requirements for TCL Programs that Implement Device Algorithms


This section describes some of the aspects of TCL programs that implement user-
defined device algorithms.
• The TCL program should use the descriptor and states as defined on the Device
Descriptor Templet used by the device loop.
• The program can acquire the device inputs by accessing the device state
parameter (DEV_STAT) of the device loop.
This variable is tag accessible using an expression in the format:
$'tag'.DEV_STAT
• The result of the program's calculation should be made to the result of the
device loop. The preferred method to accomplish this is to pass the result of the
program calculation to the PROC_VAL parameter of the device loop. The
corresponding data quality should be passed to PROC_DQ; (0 - bad data, non-
zero - good).
The program signifies that it wants the value in PROC-VAL sent to the device
by setting OUT_ENAB to a non-zero value.
When the device loop receives these parameters, it does some error checking.
If no errors have occurred, the value of the PROC_VAL parameter (result data
quality) is copied to the RESULT parameter, and the value of the PROC_DQ
parameter is copied to the DATAQUAL and PROC_VAL parameters.
PROC_DQ and DATAQUAL are tag accessible parameters. For example,
PROC_VAL is used in TCL expressions in the following format:
"$'tag'.PROC_VAL"
The RESULT variable is then used to establish the output of the device loop.
• The program has access to both the TIM1_CNT and TIM2_CNT timers of the

576 3BUR002336R3701 RevA


Section 11 Defining Device Loops Loading the TCL Program

device loop. When TCL puts a non-zero value into one of these counters, CCF
starts to decrement that counter. However, TCL must make some provision for
checking the current value of the counter, as CCF does not automatically notify
TCL of a timeout. The TIMER_1 parameter was designed as the initialization
value of the TIM1_CNT parameter. TIMER_1 is configured via the TIMER
field of the Device Loops Templet. Similarly, the TIMER_2 parameter is the
initialization value of the TIM2_CNT parameter. It is configured via the
SECONDARY TIMER field of the Device Loops Templet. TCL can use one or
both of the timers to implement device timeout checking. If necessary, the
program can declare a device timeout alarm by setting the ACT_ALARM
parameter to TIMEOUT (2).

Loading the TCL Program


Before the device loop is processed, the TCL program must be made available to the
device loop by loading it from another TCL program via a LOAD statement in the
form:
LOAD ('SEQUENCE','prog','tag');
where
prog is the name of the program performing the device algorithm
tag is the tag of the device loop
If it is desired to modify the program, the old program is removed with a REMOVE
statement in the format:
REMOVE ('SEQUENCE','prog','tag');
and the modified program is loaded with a LOAD statement.

3BUR002336R3701 RevA 577


Loading the TCL Program Section 11 Defining Device Loops

578 3BUR002336R3701 RevA


Appendix A Advant OCS Data Base

General Information
The CCF portion of the Advant OCS data base is the basis for all process control
and information gathering by the system. The CCF parameters are referenced
(accessed) by:
• Reports (Multibus-based Reports Services and AdvaInform Reports)
• TCL programs
• Display Builder
• History (Multibus-based History Services and AdvaInform History)
• Other applications running on systems interfaced to the Advant OCS
Each of the above applications uses its own specific format for accessing the data
base parameters. These formats are described in the applicable user’s guide. The
basic method used to identify the parameters is the same for all applications. It is
described in Accessing Loop And FCM Parameters on page 579.

Accessing Loop And FCM Parameters


Two types of parameters in the data base are most frequently referenced: loop
values and FCM values.
Loop values are accessed using the tag access method. Since loop values are
unique to a loop, they are identified completely by loop tag and parameter
mnemonic. For example, TCL identifies the measured variable of loop TC100 as:
$'TC100'.MEASURE

3BUR002336R3701 RevA 579


Accessing Loop And FCM Parameters Appendix A Advant OCS Data Base

Similarly, TCL identifies the device state parameter for device PM2000 as:
$'PM2000'.DEV_STAT
The loop level parameters of the continuous loops are described in Section 4,
Defining Continuous Loops. Their mnemonics are listed in Data Base Tables.
The loop level parameters of the device loops are described in Section 11, Defining
Device Loops. Their mnemonics are listed in Data Base Tables.
Some parameters of the Auto/Manual Controller and the PID Controller
FCMs are accessed using tag access. For example, the setpoint parameter is part of
the PID Controller FCM. Since a loop can only have one setpoint, the setpoint is
uniquely identified by an expression that includes the loop's tag and the SETPOINT
mnemonic. TCL identifies the setpoint of loop TC106 as:
$'TC106'.SETPOINT
FCM level parameters for Auto/Manual Controller FCMs and PID Controller FCMs
are listed in Data Base Tables. The tag accessible parameters in these lists are
designated as such.
Most FCM values are only accessible by the FCM access method. This is true
because FCM values can occur more than once in a loop. To uniquely identify these
FCM values, three identifiers are needed: loop tag, FCM name, and parameter
mnemonic. For example, TCL identifies the result of the Analog Input FCM of loop
TC100 as:
$'TC100'-'AIN'.RESULT
Each FCM description in this manual has a corresponding table listing the names
and parameter mnemonics for the FCMs in Data Base Tables.

580 3BUR002336R3701 RevA


Appendix A Advant OCS Data Base Parameters Common To All FCMs

Parameters Common To All FCMs


The following parameters occur in almost all FCMs. They are accessible by the
FCM access method.

Table 41. FCM Parameters Contained by Most FCMs

Description Mnemonic Related Templet Field States


Data Quality of DATAQUAL BAD
the Result GOOD
FCM mode FCM_MODE OFF
ON
Initial Output INIT_OUT INITIAL OUTPUT
Initial Mode INIT_MODE INITIAL MODE AUTO
MAN
Output Mode OUT_MODE AUTO
MANUAL
TRACK(1)
Result RESULT
Bad Inputs WORST_DQ BAD INPUTS ACCEPTED? YES
Accepted(2) NO
(1) The Auto/Manual and PID Controller FCMs are the only ones in which TRACK is a valid output
mode.
(2) The Input FCMs do not contain a Bad Inputs Accepted parameter.

3BUR002336R3701 RevA 581


Parameters Common To All FCMs Appendix A Advant OCS Data Base

582 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID
Controller FCM

General
A fixed gain controller can not change gain to compensate for nonlinear process
loop gain, and provides optimum control at only one point in the range of the
variable, as shown in Figure 79. At all other points in the range, the controller gain
is either too high or too low. An adaptive gain controller can dynamically change its
overall gain, in response to a specific variable, so as to maintain a constant or nearly
constant loop gain. If the gain of the process changes, the gain of the controller
should change directly opposite to the gain of the process to maintain constant loop
gain as shown in Figure 80. An adaptive gain function is used to change controller
gain to compensate for the change in process gain.

3BUR002336R3701 RevA 583


General Appendix B Adaptive Control In The PID Controller FCM

High

Ideal Controller Gain

Gain of Fixed Gain Controller


Gain
Gain too High Gain too Low

Process Gain

Low
0% Variable 100%

Figure 79. Relationship of Gain on Fixed Gain Controller to Ideal Controller Gain

Reset action is the integration of the input error signal. In standard fixed reset action
controllers, the value of the manipulated variable is changed at a rate proportional to
the input error signal. Thus, if deviation (input error) is doubled over a previous
value, the final control element is moved twice as fast. When the controlled variable
is at the setpoint (zero deviation), the final control element remains stationary. This
means at steady state there is no reset action and no offset; that is, error is zero.
A fixed reset controller provides only one setting of reset rate, which may be
optimum for operating conditions. However, this rate may be inadequate during
start-up. The optimum reset rate setting depends on specific process parameters. As
these parameters change, the reset setting must change also to maintain optimum
control response. An adaptive reset function is used to change the controller reset to
compensate for the changes in the process that affect optimum reset rate. An
adaptive reset function is used to change the controller reset to compensate for the
changes in the process that affect optimum reset rate.

584 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCM General

High

Ideal Controller Gain


BP1 and BP2
Adaptive Gain
Active Loop Gain
Gain

Process Gain

Low
0% Variable 100%

Figure 80. Controller Adaptive Gain Changing to Keep Loop Gain Constant

The PID Controller FCM provides the ability to adapt the overall gain, and/or reset
rate, of the controller, based on:
• Process Input Variable
• Remote Input Variable
• Contact Input
• Absolute value of the Error (deviation)
• Controller Output
The adaptive functions for process, deviation, and remote input provide continuous
change to controller gain or reset. The contact input and output adaptive functions
provide a step change in controller gain or reset. Adaptive control on gain or reset is
on one or all of these variables simultaneously.
Because the controller gain is changed in response to a variable, adaptive gain is
used to reduce the effect of process noise, compensate for nonlinear valve

3BUR002336R3701 RevA 585


Definition Of Terms Appendix B Adaptive Control In The PID Controller FCM

characteristics, eliminate overpeaking on start-up, compensate for nonlinear tank


shapes in level control, provide consistent control over a wide range of setpoints,
improve control on interacting processes, compensate for poor tuning of the
controller, and so on.
Because the controller reset rate is changed in response to a variable, adaptive reset
is used to improve control loop start-up characteristics when used in combination
with the MICROSCAN~ Instrument control algorithm, and can provide reset rate
tuning.

Definition Of Terms
The definition of terms which apply to adaptive control are listed below.
ACTIVE GAIN: The actual controller gain currently being used. The equation for
active gain is shown in Figure 81.
ACTIVE GAIN FACTOR: The actual gain factor currently being used for a
specific value of a variable. This is a multiplier applied to the Basic Gain or Basic
Reset.
ACTIVE GAIN FACTOR LIMIT: The maximum and minimum allowed values
for an adaptive function's contribution to the overall controller gain or reset. Active
gain factor limits are specified separately for process, deviation, and remote input
adaptive functions. They are labeled PROCESS LOW LIMIT, PROCESS HIGH
LIMIT, REMOTE LOW LIMIT, and so on the configuration templets. The equation
for active gain is shown in Figure 81.
ACTIVE RESET RATE: The actual controller reset rate currently being used. The
equation for active reset rate is shown in Figure 81.
ADAPTIVE GAIN: The ability to dynamically change the overall gain of the
controller.
ADAPTIVE RESET: The ability to dynamically change the reset rate of the
controller.

586 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCM Definition Of Terms

Optional Functions
May be used in any combination
Active Base Gain Process Deviation Output Remote External
Gain = (Basic * Active * Active * Active * Input * Contact
Controller Gain Gain Gain Active Closure
Response) Factor Factor Factor Gain Gain
Factor Factor

Optional Functions
May be used in any combination
Active Base Reset Process Deviation Output Remote External
Reset = (Basic * Active * Active * Active * Input * Contact
Rate Controller Reset Reset Reset Active Closure
Response) Factor Factor Factor Reset Reset
Factor Factor

Figure 81. Active Gain and Active Reset Rate Equations

ADAPTIVE RESPONSE LIMITS: The maximum and minimum limits for the
controller's overall gain or reset when one or more adaptive functions is used. They
are labeled HIGH LIMIT and LOW LIMIT on the configuration templets.
BASE GAIN: The number representing gain in a fixed gain feedback controller. If
no adaptive gain functions are turned on, the base gain is the active gain of the
controller, and the controller operates as a fixed gain feedback controller. When an
adaptive function is turned on, all changes in active gain due to the algorithm for
that function are based on the base gain.
BASE RESET: The number representing the reset rate, in repeats per minute, in a
fixed reset controller. If no adaptive functions are turned on, the base reset is the
active reset of the controller, and the controller operates as a fixed reset controller.
When an adaptive function is turned on, all changes in active reset due to the
algorithm for that function are based on the base reset.
BREAK POINT 1 (BP1): A location determining where the gain starts to change
on a falling adapted variable. Unless BP1 and BP2 are at the same location, BP1 is
always at a lower point on the variable range than BP2. It is labelled LOWER
BRKPT on the configuration templets.

3BUR002336R3701 RevA 587


Definition Of Terms Appendix B Adaptive Control In The PID Controller FCM

BREAK POINT 2 (BP2): A location determining where the gain starts to change
on a rising adapted variable. Unless BP1 and BP2 are at the same location, BP2 is
always at a upper point on the variable range than BP1. It is labelled UPPER
BRKPT on the configuration templet.
CONTACT GAIN FACTOR: The multiplier of the base gain or base reset
associated with an external contact closure. The value of the gain factor (greater or
less than 1) causes the active gain or the active reset rate to increase or decrease
when the external contact is closed.
ERROR HIGH LIMIT and ERROR LOW LIMIT: See ACTIVE GAIN
FACTOR LIMIT
ERROR LOWER FACTOR and ERROR UPPER FACTOR: See GAIN
FACTOR 1
GAIN FACTOR 1 (GF1): The multiplier of the base gain or reset rate associated
with BP1. The value of the gain factor (greater or less than 1) causes the active gain
or active reset rate to increase or decrease as shown in Figure 85 and Figure 92. The
equation for GF1 for one adaptive gain function (with all other adaptive functions
turned off) is:
GF1 = Active Gain at (BP1 - 10%)
Base Gain
The equation for GF1 for one adaptive reset function (with all other adaptive
functions off) is:
GF1 = Active Reset Rate at (BP1 - 10%)
Base Reset Rate
GAIN FACTOR 2 (GF2): The multiplier of the base gain or reset rate which is
associated with BP2. The value of the gain factor (greater or less than 1) will cause
the active gain or reset to increase or decrease as shown in Figure 85 and Figure 92.
The equation for GF2 for one adaptive gain function (with all other adaptive gain
functions turned off) is:
GF2 = Active Gain at (BP2 + 10%)
Base Gain

588 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCM Adaptive Gain Or Reset Functions

The equation for GF2 for one adaptive reset function (with all other adaptive
functions off) is:
GF2 = Active Reset Rate at (BP2 + 10%)
Base Reset Rate
HIGH LIMIT and LOW LIMIT: See ADAPTIVE RESPONSE LIMIT
HIGH AND LOW OUTPUT LIMITS: The maximum or minimum output value,
respectively, at which the controller's output value (auto control only) is restricted.
These limits do not restrict manual output.
HYSTERESIS: A 1% band around break points set at different values during
which the active gain or reset is in transition for the output adaptive function.
LOOP GAIN: (Process Gain) x (Active Controller Gain)
LOWER BRKPT: See Break Point 1
OUTPUT LOWER FACTOR and OUTPUT UPPER FACTOR: See GAIN
FACTOR 1
PROCESS GAIN: (Delta) Controlled Process Variable
(Delta) Manipulated Variable
PROCESS HIGH LIMIT and PROCESS LOW LIMIT: See ACTIVE GAIN
FACTOR LIMIT
PROCESS LOWER FACTOR and PROCESS UPPER FACTOR: See GAIN
FACTOR 1
REMOTE HIGH LIMIT and REMOTE LOW LIMIT: See ACTIVE GAIN
FACTOR LIMIT
REMOTE LOWER FACTOR and REMOTE UPPER FACTOR: See GAIN
FACTOR 1
UPPER BRKPT: See BREAK POINT 2

Adaptive Gain Or Reset Functions


The subsections that follow describe input and output adaptive gain and reset
functions.

3BUR002336R3701 RevA 589


Process, Deviation, and Remote Input Adaptive Gain or Reset Appendix B Adaptive Control In

Process, Deviation, and Remote Input Adaptive Gain or Reset


The parameters for adaptive algorithms for process, deviation, and remote input
functions are set up in the same manner. A large combination of break points, gain
factors and active gain or reset limits is used to provide many different adaptive
algorithms. Because each adaptive algorithm is set up individually, the number of
overall controller algorithms is very large. The adaptive functions are on gain and/or
reset.

Break Points
The location of the break points determines where the gain or reset starts to change
as a function of the adaptive variable as shown in Figure 82. The gain or reset value
between the break points is the base gain or base reset and never changes. Both
break points can be located at the same range value as shown in Figure 83, or they
may be set at different values as shown in Figure 84. When the two break points are
set at different values, Figure 84, BP1 must be at a lower range value than BP2. The
active gain or reset between the two break points is equal to the base gain or reset
(because the gain factor is always 1 between the two break points), while the active
gain or reset beyond the break points changes as determined by the gain factors.
If the gain factor is less than 1 (for example, 0.875), the gain or reset decreases.
When the gain factor value is 1, the gain or reset does not change. If the gain factor
value is greater than 1 (for example, 2.625), the gain or reset increases.
Both gain factors can increase, both can decrease, or either gain factor can increase
while the other decreases active gain or reset. The combinations of gain factors and
break points are used to produce a large variety of algorithms. Some of the
possibilities are shown in Figure 86.
The gain factor values are multipliers. The base gain or reset is multiplied by the
gain factor for the adaptive gain or reset function. The result is the value of active
gain or reset at one, and only one, point on the range. This point, Figure 87, is 10%
downscale from BP1 or 10% upscale from BP2, and it establishes the slope of the
line in the algorithm.

590 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCM Process, Deviation, and Remote Input

High
Gain will Change
Above BP2
Value Between
BP1 and BP2
Will Change

Base Gain
Active or
Gain Base Reset
or
Reset

Gain will Change


Below BP1

Low
0 Process or Remote Input 100
-100 Deviation Variable% +100

Figure 82. Break Points Determine Where Gain Starts to Change for
Process, Deviation, or Remote Input Adaptive Function

3BUR002336R3701 RevA 591


Process, Deviation, and Remote Input Adaptive Gain or Reset Appendix B Adaptive Control In

High

Active BP1 and BP2


Gain
or
Reset

Low
0 Process or Remote Input 100
-100 Deviation Variable% +100

Figure 83. Both Break Points Have Same Value for Process, Deviation, or
Remote Input Adaptive Function

592 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCM Process, Deviation, and Remote Input

High

Active BP1 Base Gain


Gain
or or Base Reset BP2
Reset

Low
0 Process or Remote Input 100
-100 Deviation Variable% +100

Figure 84. Break Points Have Different Values for Process, Deviation, or
Remote Input Adaptive Function

Gain Factors
The value of the gain factor determines if the active gain or reset increases or
decreases, starting from the break points as shown in Figure 85.

3BUR002336R3701 RevA 593


Process, Deviation, and Remote Input Adaptive Gain or Reset Appendix B Adaptive Control In

High

Values of GF1 Values of GF2


Greater Than 1 Greater Than 1

Active Base Gain


Gain
or BP1 or Base Reset BP2
Reset Values of GF1 Values of GF2
Less Than 1 Less Than 1

Low
0 Process or Remote Input 100
-100 Deviation Variable% +100

Figure 85. Gain Factor Values Determine if Gain or Reset Rate Increases or
Decreases from Break Points for Process, Deviation, or Remote Input Adaptive
Function

594 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCM Process, Deviation, and Remote Input

High High

GF1

GF2

Active Active BP1 and BP2


Gain Gain
or BP1 or
Reset BP2 Reset

GF1 GF2

Low Low
0 Process or Remote Input 100 0 Process or Remote Input
-100 Deviation Variable% +100 -100 Deviation Variable%

High High

GF1

GF2

Active Active
Gain Gain BP1 and BP2
or BP1 BP2 or GF1
Reset Reset

GF2

Low Low
0 Process or Remote Input 0 Process or Remote Input
-100 Deviation Variable% -100 Deviation Variable%

High High

GF2
GF1
Active Active BP1 and BP2
Gain BP1 BP2 Gain
or or
Reset GF1 Reset

GF2

Low Low
0 Process or Remote Input 0 Process or Remote Input
-100 Deviation Variable% -100 Deviation Variable%

Figure 86. Various Combinations of Break Points and Gain Factors Used to Produce a Large
Variety of Algorithms for Process, Deviation, or Remote Input Adaptive Function

3BUR002336R3701 RevA 595


Process, Deviation, and Remote Input Adaptive Gain or Reset Appendix B Adaptive Control In

10
BREAKPOINTS ARE LOCATED

8
Active Gain or BP1 BP2
Reset Factor 6

10

0 10 20 30 40 50 60 70 80 90 100
Process or Remote Input
-50 -40 -30 -20 -10 0 10 20 30 40 50
Deviation Variable &

10 GAIN FACTORS ARE LOCATED

8 GF2

Active Gain or
Reset Factor BP1 BP2
6
GF1

2
10% 10%

10

0 10 20 30 40 50 60 70 80 90 100
Process or Remote Input
-50 -40 -30 -20 -10 0 10 20 30 40 50
Deviation Variable &

10 COMPLETED ALGORITHM

GF2 GF2 value X base gain or base reset


8
determines slope of this line
Active Gain or BP1 BP2
Reset Factor 6 GF1

4
GF1 value X base gain or base reset determines slope of this line

10

0 10 20 30 40 50 60 70 80 90 100
Process or Remote Input
-50 -40 -30 -20 -10 0 10 20 30 40 50
Deviation Variable &

Figure 87. Gain Factors Establish Slope of Algorithm Beyond Break Points for Process, Deviation,
or Remote Input Adaptive Function

596 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCM Process, Deviation, and Remote Input

The equations for active gain or reset for any one adapted variable are as shown
below. When the value of the adapted variable is between the values for BP1 and
BP2, the active gain factor is equal to 1.
AG = BG or AR = BR
When the value of the adapted variable is less than the value for BP1, the active gain
is:

or the active reset is:

When the value of the adapted variable is greater than the value for BP2, the active
gain is:

or the active reset is:

where
AG = Active Gain
AR = Active Reset
BG = Base Gain
BR = Base Reset
GF1 = Gain Factor 1
GF2 = Gain Factor 2

3BUR002336R3701 RevA 597


Process, Deviation, and Remote Input Adaptive Gain or Reset Appendix B Adaptive Control In

BP1 = Break Point 1 in%


BP2 = Break Point 2 in%
%AV = Percent Value of Adapted Variable
The value of GF1 determines the value of active gain or reset at a point 10%
downscale of BP1, Figure 87. This point and BP1 establish the slope of the line
below BP1. The value of GF2 determines the value of active gain or reset at a point
10% upscale of BP2. This point and BP2 establish the slope of the line above BP2.
At other points on the range, active gain or reset is determined from the slopes of
these lines as shown in Figure 88. (Even though the example shown in Figure 88 is
for adaptive gain, it also applies to adaptive reset.) Here BP1 was set at 40% of
range, BP2 was set at 60% of range, the base gain was 6, GF1 equals 0.875, and
GF2 equals 1.124. The base gain (6), multiplied by the gain factor (GF1) for BP1
(0.875), results in an active gain value of 5.25. This active gain value of 5.25 is the
active gain value at 30% of range. In this algorithm, no other point on the range has
this active gain value of 5.25.

598 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCM Process, Deviation, and Remote Input

Active gain is increased by 0.744 between BP2 and GF2


and an additional 0.744 between GF2 and X and so on.

10
Active gain at Y = 7.488 + 0.744 = 8.232

Active gain at X = 6.744 + 0.744 = 7488


8
Y
Active gain at GF2 = base gain x 1.124 = 6.744 X
Base gain = 6 GF2
6
Active Gain or GF1 BP1 BP2
Reset Factor A
4 B

Active gain at GF1 = base gain x 0.875 = 5.25


Active gain at A = 5.25 - 0.75 = 4.5
2
Active gain at B = 4.5 - 0.75 = 3.75
Active gain is reduced by 0.75 between BP1 and GF1
and an additional 0.75 between GF1 and A and so on.
10

0 10 20 30 40 50 60 70 80 90 100
Process or Remote Input
-50 -40 -30 -20 -10 0 10 20 30 40 50
Deviation Variable &

Base Gain = 6.00 BP1 = 40% BP2 = 60% GF1 = 0.875 GF2 = 1.124

Figure 88. Gain Factor Values Determine Active Gain or Reset Rate Upscale of
BP2 and Downscale of BP1 for Process, Deviation, or
Remote Input Adaptive Function

The active gain has decreased (because GF1 was less than 1) by a value of 0.75
between 30% and 40% of range. It decreases an additional 0.75 for each 10% (0.75
per 10%) of range downscale from the location of GF1 at 30% of range. Thus, the
active gain value at 20% of range, Point A in Figure 88, would be the active gain
value at 30% of range (5.25) minus 0.75 and would be equal to 3.75.
Above BP2 the active gain increases because GF2 is greater than 1. As shown in
Figure 88, the active gain increases by 0.744 between BP2 at 60% and GF2 at 70%
and is equal to 6.744 at 70% of range. At 80% of range (Point X) the active gain has

3BUR002336R3701 RevA 599


Output Adaptive Gain or Reset FunctionsAppendix B Adaptive Control In The PID Controller FCM

increased an additional 0.744 (0.0744 per%) to equal 7.488 and at 90% (Point Y)
the active gain is equal to 8.232.

Output Adaptive Gain or Reset Functions


The output adaptive function is similar to the process, deviation, and remote input
adaptive functions, except the change in controller gain or reset due to the gain
factor is a bumpless step change instead of a continuous change. The effect of the
bumpless step change in gain or reset is the same as switching a controller to
manual, changing the gain or reset, and then switching back to automatic.
The output adaptive function is on gain or reset, but not on both simultaneously.

Base Gain or Reset and Break Points


The base gain or base reset and break points, Figure 89, are the same as for the
process, deviation, and remote input adaptive gain functions. Both break points can
be located at the same range value as shown in Figure 90. When the two break
points are set at different values, a hysteresis band of 1% is applied to the
breakpoints as shown in Figure 91. BP1 must be at a lower range value than BP2,
and BP1 must never be set at a range value above BP2.
The gain or reset changes when output value is beyond the break point/hysteresis
band. When the output value is again within the break points, the gain or reset
changes back to the base value. The amount of change for this function is
determined by the gain factor.

600 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCMOutput Adaptive Gain or Reset Functions

High
Gain or Reset Rate will Change
above BP2

Gain or Reset Rate


will not change
between BP1 & BP2
BP1
Active Base Gain
Gain
or BP2
Reset

Gain will Change


below BP1
Low
0% Output 100%

Figure 89. Break Points Determine Where Gain or Reset Rate Changes for
Output Adaptive Function

3BUR002336R3701 RevA 601


Output Adaptive Gain or Reset FunctionsAppendix B Adaptive Control In The PID Controller FCM

High

Active
Gain BP1 & BP2
or
Reset

Low
0% Output 100%

Figure 90. Both Break Points Can Have the Same Value for
Output Adaptive Function

602 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCMOutput Adaptive Gain or Reset Functions

High Hysteresis of 1%

Active
Gain
or BP1
Reset
BP2

Hysteresis of 1%

Low
0% Output 100%

Figure 91. Break Points Can Have Different Values for Output Adaptive Function

Gain Factors
The value of the gain factor determines if the gain or reset increases or decreases,
starting from the break point, as shown in Figure 92. For output values between the
breakpoints, the active gain or reset value is equal to the base gain or reset value.
For output values beyond the break point/hysteresis range, the active gain or reset
value is determined by the gain factors as shown in Figure 93. Other than the fact
that the gain or reset change is a bumpless step change, the gain factor for the output
adaptive function operates the same as the gain factors for the process, deviation,
and remote input adaptive functions above. Some of the algorithms possible are
shown in Figure 94.

3BUR002336R3701 RevA 603


Output Adaptive Gain or Reset FunctionsAppendix B Adaptive Control In The PID Controller FCM

High

Values of GF1 Values of GF2


Greater than 1 Greater than 1

Active Base Gain


Gain BP1 BP2
or or Reset Value
Reset

Values of GF1 Values of GF2


Less than 1 Less than 1

Low
0% Output 100%

Figure 92. Gain Factor Values Determine if Gain or Reset Rate Increases or
Decreases at Break Points for Output Adaptive Function

604 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCMOutput Adaptive Gain or Reset Functions

GF2 Value x Base Value


Determines Active Value
High Hysteresis of 1%
GF1 Value x Base Value
Determines Active Value GF1

Base Gain or
Active Base Reset Rate
Gain
or BP1
Reset
BP2
GF1

Hysteresis of 1%

Low
0% Output 100%

Figure 93. Gain Factors Establish Active Gain or Reset Rate Beyond Break Points
for Output Adaptive Function

3BUR002336R3701 RevA 605


Output Adaptive Gain or Reset FunctionsAppendix B Adaptive Control In The PID Controller FCM

GF1
High High
GF2
GF1

BP1 BP2
Active Active BP1
Gain Gain
or or
Reset Reset

GF1

Low Low
0% Output 100% 0% Output 100%

GF1
High High

BP2

BP1
Active Active
Gain Gain GF2
or or
GF2
Reset Reset

GF1 BP1 & BP2

Low Low
0% Output 100% 0% Output 100%

High High

Active Active
Gain BP2 Gain
BP1 GF1
or or
Reset Reset
GF2
BP1 & BP2
GF1
GF2
Low Low
0% Output 100% 0% Output 100%

Figure 94. Various Combinations of Break Points and Gain Factors Used to Produce
a Large Variety of Algorithms for Output Adaptive Function

606 3BUR002336R3701 RevA


Appendix B Adaptive Control In The PID Controller FCM Contact Input Adaptive Gain or Reset

Contact Input Adaptive Gain or Reset Function


The contact input adaptive function is controlled by an external contact. The closure
of this external contact is time related and/or value related to the process. The
change in controller gain or reset is a bumpless step change, similar to the output
adaptive function. The contact adaptive function is on gain and/or reset.
Break points BP1 and BP2 are not used with this adaptive function. The gain or
reset changes when the external contact is closed, as shown in Figure 95. When the
external contact opens, the gain or reset changes back to the base value. The amount
of change for this function is determined by the contact gain factor as entered in the
CONTACT GAIN field on the configuration templet. The value of the contact gain
factor determines if the gain or reset increases or decreases. Contact gain factor is a
multiplier and is not a value of active gain.

High

Increases if
Cont. GF is
Greater Than 1

Active Base Gain Base Gain


Gain or Reset Value or Reset Value
or
Reset
Decreases if
Cont. GF is
Less Than 1

Low

Figure 95. Contact Input Adaptive Function

3BUR002336R3701 RevA 607


Contact Input Adaptive Gain or Reset FunctionAppendix B Adaptive Control In The PID Controller

608 3BUR002336R3701 RevA


Appendix C Tuning Loops Via Runtime
Displays

General Information
The Advant OCS tuning features allow you to modify loop configuration on-line.
There are two levels of tuning. The first is the Loop Detail Display, which is an
operational display for user’s with operator or engineer status. Via this display you
can tune a limited number of loop parameters. The Loop Detail Display is described
in Operator's Guide.
A second and more comprehensive level of tuning displays is available to engineers
only. For each continuous loop, the following engineer tuning displays are
available:
• Loop FCM Display, Figure 96, is a block diagram showing the structure of the
loop. It shows input sources, result destinations, and FCM status.
• A runtime version of the Loop Definition Templet is used to modify some
fields originally configured via the Loop Definition Templet.
• Runtime versions of the loop's FCM templets. are used to modify some fields
originally configured via the FCM templets.
For each device loop, the engineer tuning display is a runtime version of the Device
Loop Templet.

Engineer Tuning Displays For A Continuous Loop


The subsections that follow describe the displays used by an engineer for tuning
loops.

3BUR002336R3701 RevA 609


Loop FCM Display Appendix C Tuning Loops Via Runtime Displays

Loop FCM Display


The Loop FCM Display, Figure 96, shows the relationships between the functional
class modules (FCMs) that make up the loop. Each FCM in the loop is represented
by a block on the display. Both the default name and the name given to the FCM at
configuration time appear in the block. Each block contains status information for
the FCM.
Using Windows, when a FCM block is selected, the basic control fields become
available on the lower part of the display. Runtime versions of the Loop Definition
and FCM templates are accessible using the LOOP TMPL and FCM TMPL buttons
or by double clicking on the FCM.
Using HP-UX, the display, Figure 97, is accessed during runtime via the
LOOP/FCM function target on the operational displays. It is also accessed by:
1. Pressing the DISP REQUEST key on the alphanumeric keyboard.
2. Typing LOOPFCM,tag where tag is the tag of the required loop.
3. Pressing the ENTER key.
The method described above is used even if no environment has been downloaded.

610 3BUR002336R3701 RevA


Appendix C Tuning Loops Via Runtime Displays Loop FCM Display

Figure 96. Example of Loop FCM Display as Seen on Windows-based Operator Station

3BUR002336R3701 RevA 611


Loop FCM Display Appendix C Tuning Loops Via Runtime Displays

Figure 97. Example of a Loop FCM Display as Seen on a Multibus Console

612 3BUR002336R3701 RevA


Appendix C Tuning Loops Via Runtime Displays Loop FCM Display

Each block has FCM status information which can be a combination of the
following:
Label Item Possible States
MODE FCM mode ON
OFF
OPMD output mode AUTO
MANUAL
TRACK (PID and Auto/Manual Controller
FCMs only)
IDNT (PID Controller FCMs with
Autotuning capabilities only)
SPMD setpoint mode LOCAL (PID Controller FCM only)
REMOTE (PID Controller FCM only)
TRACK (PID Controller FCM only)
STPT setpoint value (PID Controller FCM only)
The output value is shown on the line extending from the right side of the FCM
block.
The status parameters are changed by moving the cursor to the displayed value,
pressing the SELECT key, and entering a new value. The new value is entered via
the regular keyboard keys or, for the mode values, via the NEXT CHOICE key. The
new value is sent to the data base when the ENTER key is pressed. The change is
only made to the runtime data base in the subsystem containing the loop. It is not
made to the installed data base in the data processor containing the Configurator.
The lower right corner of the display above the runtime block has information about
the current loop's name, its state as specified on its Loop Definition Templet, the hex
address of device/subdevice on which it resides, and the decimal address of the
device/subdevice on which it resides. This information is provided as an aid, and
you cannot modify it from this display.
The Loop FCM Display has four softkeys: FCM TEMPLT, LOOP TEMPLT,
LINEAR TABLE, and ATUNE DISPLY.

3BUR002336R3701 RevA 613


Runtime Versions of the Loop Definition and FCM Templets Appendix C Tuning Loops Via

The FCM TEMPLET softkey accesses the runtime versions of the loop FCM
templets. If there is only one FCM in the loop, its templet is accessed when this
softkey is pressed. If there is more than one FCM, pressing the softkey prompts you
to select the specific FCM. Move the cursor to the graphic box for the desired FCM
and press the SELECT key.
The LOOP TEMPLET softkey accesses the runtime version of the Loop Definition
Templet.
The LINEAR TABLE softkey accesses the runtime version of a Breakpoint Sets
Templet (Linearization Update Display) for a specific breakpoint set residing on the
same node as the current loop. If there are no breakpoint sets residing on the same
node as the current loop, a message is displayed and the Linearization Update
Display is not called up. If breakpoint sets reside on the node, you are prompted to
enter the name of the set you want to modify not the templet's name. Enter the set's
name as it appears in the NAME OF SET field on the Breakpoint Sets Templet by
either typing it and pressing the ENTER key, or pressing the NEXT CHOICE key
until the desired set's name is displayed to the right of the prompt and pressing the
ENTER key. Selecting any other portion of the Loop FCM Display or entering
blanks for the set's name in response to the prompts aborts the modification process
before it begins.
The ATUNE DISPLY softkey accesses the Autotune Display used to Autotune PI,
PID, and DTC control loops. See Appendix D, Autotune, for information about
Autotuning and the Autotune Display.

The ATUNE DISPLY softkey is only available if the loop shown in the
current Loop FCM Display contains a PID Controller FCM and an entry
greater than 0 was made in the MAX SIM AT EXP field of the CCF
Templet. Refer to CCF in Turbo Nodes on page 106 for a description of
the CCF Templet.

The LAST PAGE function target is used to exit from the Loop FCM Display.

Runtime Versions of the Loop Definition and FCM Templets


The runtime versions of the templets are used to make the actual tuning changes.
The templets are accessed via the Loop FCM Display as described in Loop FCM

614 3BUR002336R3701 RevA


Appendix C Tuning Loops Via Runtime DisplaysRuntime Versions of the Loop Definition and FCM

Display on page 610. They are similar to the configurator templets with the
following exceptions:
• Their information is always current since it comes directly from the active data
base.
• Some fields are highlighted with a blue background, other fields are not
highlighted. The ones with the blue background are tunable.
• The softkeys are different from the softkeys on the configuration templets.
• The runtime version of the Loop Definition Templet does not contain an FCM
list.
Tuning changes are made to data base items by first changing the information on the
templet and then sending the templet information to the data base. The information
on the templet is changed using the methods described in the applicable
configurator user’s guide Related Documentation on page 49. After new
information is written to a field, the field must be closed by pressing the ENTER
key.
When the required changes have been made to the templet, the information is sent to
the data base by selecting the SAVE softkey. If the save process is not successful, a
message describing the problem is displayed. After corrective action is taken,
usually involving closing the fields with the ENTER key, you can re-try the save
process.
Use the LOOP TEMPLT softkey to exit the templet.

The procedure described above changes both the active data base in
the subsystem containing the loop and the installed data base on the
disk in the data processor containing the Configurator. However,
the Configurator templets originally used to configure the data base
are not immediately modified. They maintain the old value until the
data base is decompiled. Instructions for decompiling a data base
are provided in the applicable configurator user’s guide as
described in Related Documentation on page 49.

3BUR002336R3701 RevA 615


Runtime Versions of the Breakpoint Sets Templet Appendix C Tuning Loops Via Runtime Displays

Runtime Versions of the Breakpoint Sets Templet


The runtime version of the Breakpoint Sets Templet (Linearization Update Display)
is used to change the values of a specific breakpoint set without having to recompile
and install the entire CCF configuration of the node. The templet is accessed via the
Loop FCM Display as described in Loop FCM Display on page 610. It is similar to
the configurator templet with the following exceptions:
• Only the X VALUE Y VALUE edit window with a blue background is tunable.
• The softkeys are replaced by the LOOP DISPLY and SAVE softkeys. Selection
of the LOOP DISPLAY softkey prior to saving any modifications you made
returns you to the Loop FCM Display without saving the modifications.
Tuning changes are made to the data base by first changing the values in the edit
window and then sending the new values to the data base. The values are changed
using the same methods you used to define them. That is, enter up to 11 x,y pairs in
the edit window.
When all required changes are made, the new values are sent to the data base by
selecting the SAVE softkey. If the save process is not successful, a message
describing the problem is displayed. After corrective action is taken, usually
involving the entry of another x,y pair since you must define at least two x,y pairs,
you can re-try to save the new values.

This functionality allows you to modify only linearization tables


existing on the same node as the current loop. It does not allow you
to modify linearization tables residing on another node, create new
tables, delete existing tables, or change the name of the breakpoint
set table.
The procedure described above changes both the active data base in
the subsystem containing the loop and the installed data base on the
disk in the data processor containing the Configurator. However,
the Breakpoint Sets Templets originally used to configure the data
base is not immediately modified. It maintains the old values until
the data base is decompiled. Instructions for decompiling a data
base are provided in the applicable configurator user’s guide as
described in Related Documentation on page 49.
There is no log of the changes made to the breakpoint sets.

616 3BUR002336R3701 RevA


Appendix C Tuning Loops Via Runtime Displays Engineer Tuning Display For A Device Loop

Engineer Tuning Display For A Device Loop


Engineer tuning of device loops is initiated using the LOOP/FCM function target on
the operational displays. This directly accesses the runtime version of the Device
Loop Templet as there is no Loop FCM Display for device loops.
The runtime version is handled in the same manner as the runtime versions of the
Loop Definition and FCM Templets as described in Runtime Versions of the Loop
Definition and FCM Templets on page 614. To briefly summarize:
• Only the fields having a blue background are tunable.
• Make entries using the normal templet entry procedures, terminating each entry
by pressing the ENTER key.
• When all entries have been made to the templet, send the information to the
active data base by selecting the SAVE softkey.

3BUR002336R3701 RevA 617


Engineer Tuning Display For A Device Loop Appendix C Tuning Loops Via Runtime Displays

618 3BUR002336R3701 RevA


Appendix D Autotune

Introduction
This appendix describes the Autotune function in the Advant OCS. It supplements
the standard controller SC Controller User's Guide, and Controller Principal
Modules.
This appendix provides complete information on the Autotune function, and
minimizes the need to refer to other instructions. The content includes an overview,
configuration information, tuning procedures, and error code descriptions.

Overview
Autotune is available for SC Controller and Turbo Node Subsystems with Version 3
or higher firmware and Version 10 or higher software. Autotune does not prevent
manual tuning. You can always tune the controller manually using the procedures
described in this appendix and Operator's Guide.
The Autotune function for SC Controller and Turbo Node Subsystems is an on-
demand, operator-actuated function for tuning PI, PID, and DTC (Dead Time
Compensated) control algorithms. The Autotune function resides wherever CCF
runs along with an Autotune Display for every PID control loop configured in the
data base.
The purpose of Autotune is to automatically calculate the controller tuning
parameters (Gain, Reset, and Pre-act) for a specific process application. Autotune
consists of three phases:
Phase Description
Process With the controller off-line, Autotune runs an
Identification experiment to identify the process parameters.

3BUR002336R3701 RevA 619


Overview Appendix D Autotune

Controller Process parameters from the experiment are used to


Design calculate controller tuning settings. (You can also
enter the tuning settings).
Parameter The controller tuning settings from the controller
Activation design phase are copied into the control algorithm data
base and the controller is then returned to on-line
control.
Depending on operator experience with a particular application, these phases can be
run together in a sequence or one at a time. This is determined by the entries you
make in the fields of the Autotune Display. Autotune Execution on page 639,
describe both sequential and the one-step-at-a-time tuning procedures.
During the process identification phase, the control algorithm is placed in the
Identification mode (IDNT) and Autotune manipulates the control algorithm output.
The controller design and parameter activation phases do not manipulate the output
(they execute in less than two seconds). If Autotune includes the process
identification phase, the control algorithm remains in the identification mode until
all of the phases in the Autotune function have been completed. If Autotune does
not include the process identification phase, the control algorithm does not switch to
the identification mode.

The new controller output mode (identification mode) may have


implications for any TCL or other software programs monitoring
the controller output mode.

The data base parameters for Autotune are described in Data Base Parameters Of
Autotune Function on page 661.
The Autotune Display provides the sole means of initiating Autotune. You cannot
initiate Autotune through a shared display terminal (IBM PC AT) or from a
controller's front panel.
The Autotune function tunes PI, PID, and DTC control algorithms using either of
two methods: closed loop method or open loop method. The procedure used is
similar for both methods. The considerations for selecting the most appropriate
method are provided in Considerations, Requirements, And Functions Of
Autotune Methods on page 621.

620 3BUR002336R3701 RevA


Appendix D Autotune Considerations, Requirements, And Functions Of Autotune Methods

Considerations, Requirements, And Functions Of


Autotune Methods
There are two Autotune methods: closed loop method and open loop method. The
closed loop method is used to tune PI and PID control algorithms, and the open loop
method is used to tune PI, PID and DTC control algorithms. The method you choose
depends on the process dynamics and the control algorithm being used.
Considerations, requirements, and functionality of each method are provided in the
paragraphs that follow.

Closed Loop Method


The closed loop method manipulates the controller output to cause the process to
oscillate. Approximately six cycles of oscillation are needed to identify the process.
The controller output cycles and a process response are shown in Figure 98. The
closed loop method is the default method in the data base.

Considerations and Requirements


Considerations and requirements for the closed loop method are as follows:
• The closed loop method is used to tune PI and PID control algorithms. You
cannot use it to tune DTC control algorithms (use the open loop method
instead).
• The closed loop method is best for tuning processes with frequent load
disturbances.
• The closed loop method must be used to tune processes which do not return to
a steady state after an open loop step change in controller output (for example,
a level control application with a fixed outlet flow and a variable inlet flow).
When an open loop step change in the controller output is applied, the increase
in the inlet flow causes a continuous increase in the level.
• The controller action must be set correctly for the closed loop method to work.
If not set correctly, the controller's output manipulations do not cause the
process to oscillate and the algorithm appears to stall out.

3BUR002336R3701 RevA 621


Closed Loop Method Appendix D Autotune

Hysteresis Band
Hysteresis Band
Process
Process Variable Hysteresis
Hysteresis
Variable
(% of Span) (Enter
(Enterin %
inof%Span)
of Span)
(% of Span)
Steady State Value
Steady
Steady State
State ValueValue Steady
at State Value of
Completion
atatStart
Start of Autotune
of Autotune at Completion
Autotune of
Execution
Execution
Execution Autotune Execution

80.0 80.0 80.0 80.0 80.0 80.0

60.0 60.0 60.0 60.0 60.0 60.0

40.0 40.0 40.0 40.0 40.0 40.0

Output Step
Output Step SizeSize
(Enter
(Enter asas
%% of Span)
of Span)
Controller
Controller Output
(% of Span)
Output
(% of Span)

Figure 98. Example of Controller Output Change and Process Response for Autotune Closed Loop
Method

• Hysteresis must be set at a value larger than the amount of noise present on the
process signal. If not set at a large enough value, the process signal noise is
interpreted as process oscillations and the process parameters are incorrectly
estimated.
• The output step size should be set large enough so that any stiction and
hysteresis present is overcome and the manipulations of the output value result
in changes in the process.

622 3BUR002336R3701 RevA


Appendix D Autotune Closed Loop Method

Algorithm Function
The Autotune algorithm functions as described in the paragraphs that follow when
the closed loop method is used to calculate the optimum tuning parameters for the
process.
Before invoking the Autotune algorithm, make sure the process is in or near a
steady state condition. Once you invoke the algorithm, the controller output is set to
the Identification mode (IDNT) and the controller acts as an ON/OFF Controller.
The Autotune algorithm proceeds sequentially or interactively through its three
phases (process identification, controller design, and parameter activation).
In the process identification phase, the Autotune algorithm manipulates the
controller's output signal via the output step size you specify. The ON/OFF
Controller action causes the process to oscillate. The algorithm monitors the process
for an appropriate oscillation response, generating an error if the anticipated
response is not achieved. Once the proper response is achieved, the Autotune
algorithm requires three oscillation cycles to provide enough sample data to
determine values for the ultimate process gain and ultimate process period
parameters.
Execution of the next phase depends on whether the phases of the algorithm are
running sequentially or interactively. If you are running the phases sequentially, the
controller design phase is executed as soon as the process identification phase is
complete. If you are running the phases interactively, you are notified when the
process identification phase is complete. You may then review the results and
determine whether to proceed with the next phase or reconfigure the experiment
parameters and rerun the process identification phase.
The controller design phase calculates values for the proportional gain, integral
gain, and pre-act time constant tuning parameter based on the controller type and
the results of the process identification phase. Values for these parameters are
calculated in the controller design phase in a few seconds. As upon completion of
the process identification phase, execution of the next phase (parameter activation
phase) depends on whether the phases of the algorithm are running sequentially or
interactively. If you run the phases sequentially, the parameter activation phase is
executed as soon as the controller design phase is complete. If you run the phases
interactively, you are notified when the controller design phase is complete. You
may then review the results and determine whether to proceed with the next phase
or reconfigure the experiment parameters and rerun the process identification and/or

3BUR002336R3701 RevA 623


Open Loop Method Appendix D Autotune

controller design phases. You may also manually adjust the resulting calculated
values and proceed with the next phase.
In the parameter activation phase, the parameter values calculated during the
controller design phase are applied to the control algorithm. This requires one loop
scan to update the data base. Regardless of whether the phases are running
sequentially or interactively, you are notified when this phase is complete and the
controller is placed in the proper operating mode.

Open Loop Method


The open loop method is a generalized form of the familiar step response test. An
output step or semipulse is applied to the controller output and the process response
is monitored. The controller output pulse and a process response are shown in
Figure 99.

624 3BUR002336R3701 RevA


Appendix D Autotune Open Loop Method

.
Steady State Value
Steady State Value Experiment Time
Experiment Time
at Start of Autotune
at Start of Autotune ininMinutes
Minutes
Execution
Execution
Steady State Value
ProcessProcess
Variable Steady State Value
Variable at Completion of
(% of Span) at Completion
Autotune of
Execution
(% of Span) 80.0 80.0 80.0 Autotune
Execution

60.0 60.0 60.0

Controller
40.0 40.0 40.0
Output
Controller Output
(% of Span)
(% of Span)
Output Pulse SizePulse Size
Output
(% of Span)
(% of Span)
Pulse
Pulse Factor
Factor (0 to 0.9)

PulseFactor
Pulse Factor==00 Pulse
Pulse Factor
Factor = 0.5
= 0.5 PulseFactor
Pulse Factor== 0.9
0.9

Figure 99. Example of Controller Output Change and Process Response for
Autotune Open Loop Method

Considerations and Requirements


Considerations and requirements for the open loop method are as follows:
• The open loop method is used to tune PI, PID, and DTC controller algorithms.
• The open loop method is used only on processes which reach a new steady state
following a step change in controller output. Use the closed loop method for
applications that do not reach a new steady state.
• Do not use the open loop method for tuning processes with frequent load
disturbances.

3BUR002336R3701 RevA 625


Open Loop Method Appendix D Autotune

• The output pulse size should be set large enough so that any stiction and
hysteresis present is overcome and the manipulation of the output value results
in changes in the process.
• The experiment time should be long enough to allow the process to return to a
steady state condition following the output pulse.
• The pulse factor determines the shape of the output pulse. When the pulse
factor is 0.00, the output pulse becomes a step change. Typically, the pulse
factor is set at 0.80 so that the process disturbance caused by the process
identification phase experiment is minimized. When the process is noisy, better
identification of the process is obtained by setting the pulse factor at a lower
value.

Algorithm Function
The Autotune algorithm functions as described in the paragraphs that follow when
the open loop method is used to calculate the optimum tuning parameters for the
process.
Before invoking the Autotune algorithm, make sure the process is in or near a
steady state condition. Once you invoke the algorithm, the controller output is set to
the Identification mode (IDNT) and the Autotune algorithm proceeds sequentially
or interactively through its three phases (process identification, controller design,
and parameter activation).
In the process identification phase, the Autotune algorithm introduces a step change
to the controller's output. The algorithm monitors the process for a user-specified
amount of time. The experiment time you specify is based on the dynamics and your
knowledge of the loop. If the experiment time is not sufficient or the anticipated
process response is not observed, an error is generated. Otherwise, the process gain,
lag, and deadtime values are determined.
Execution of the next phase depends on whether the phases of the algorithm are
running sequentially or interactively. If you run the phases sequentially, the
controller design phase is executed as soon as the process identification phase is
complete. If you run the phases interactively, you are notified when the process
identification phase is complete. You may then review the results and determine
whether to proceed with the next phase or reconfigure the experiment parameters
and rerun the process identification phase.

626 3BUR002336R3701 RevA


Appendix D Autotune Accessing The Autotune Display And Functionality

The controller design phase calculates values for the proportional gain, integral
gain, and pre-act time constant tuning parameter based on the controller type and
the results of the process identification phase. Values for these parameters are
calculated in a few seconds. As upon completion of the process identification phase,
execution of the next phase (parameter activation phase) depends on whether the
phases of the algorithm are running sequentially or interactively. If you run the
phases sequentially, the parameter activation phase is executed as soon as the
controller design phase is complete. If you run the phases interactively, you are
notified when the controller design phase is complete. You may then review the
results and determine whether to proceed with the next phase or reconfigure the
experiment parameters and rerun the process identification and/or controller design
phases. You may also manually adjust the resulting calculated values and proceed
with the next phase.
In the parameter activation phase, the parameter values calculated during the
controller design phase are applied to the control algorithm. This requires one loop
scan to update the data base. Regardless of whether the phases are running
sequentially or interactively, you are notified when this phase is complete and the
controller is placed in the proper operating mode.

Accessing The Autotune Display And Functionality


The LOOP/FCM Display provides the only means to access the Autotune function.
This display requires engineer access rights by default, however, your system may
be configured to allow users with other authority levels to access the Loop/FCM
Display.
To access the Autotune function:
1. Call up the LOOP/FCM Display for the loop on which you want to apply the
Autotune algorithm. The loop must include a PID FCM.
2. Select the ATUNE DISPLY softkey.

3BUR002336R3701 RevA 627


Accessing The Autotune Display And Functionality Appendix D Autotune

The ATUNE DISPLY softkey is only available on the Loop/FCM


Display, and the Autotune functionality is only available if you
entered a value greater than 0 in the MAX SIM AT EXP (maximum
simultaneous Autotune experiments) field of the CCF Templet. To
later make the ATUNE DISPLY softkey and the Autotune
functionality available, you must enter a value greater than 0 in the
MAX SIM AT EXP field on the CCF Templet. You must then
save/replace the CCF Templet and recompile, install, and download
the node.
You are allowed to access the same loop on different Operator
Stations or Multibus-based consoles and modifying the Autotune
parameters on each Operator Station or Multibus-based console.
The last saved parameters are stored in the data base, and the
parameters saved first are overwritten. Therefore, to preserve the
integrity of the loop's Autotune parameters and experiments, it is
recommended that you only access the loop on one Operator Station
or Multibus-based console.

This calls up the Autotune Display for the loop. The loop's name is shown on the top
line of the display and softkeys are provided along the bottom of the display. In the
top third of the screen, a graphical representation of the experiment (process
identification phase) shows the trend for both the controller output and process
variable. The bottom portion of the screen has rows and columns of fields listing the
default Autotune parameters for the loop (for example, the Autotuning method, the
Autotune phases to execute, the experiment time, and so on). Just above the
softkeys is a message line where error, warning, and notification messages are
displayed. Descriptions of the notification, error, and warning messages are
provided in Autotune Notification, Error, and Warning Messages on page 652.
Figure 100 shows a typical Autotune Display. The trend lines shown on the graph
are color coded along with their corresponding range values shown to the left of the
graph. The color key on the top line of the display indicates which trend line and
range values are for the controller output and the which are for the process's
measured variable. The controller output trend line and range values are shown in
green, and the process variable trend line and range values are shown in magenta.

628 3BUR002336R3701 RevA


Appendix D Autotune Accessing The Autotune Display And Functionality

The text for configurable Autotune parameter values is displayed in white, and the
text for the four non-configurable parameter values is displayed in yellow. The
Autotune status, active gain, active reset, and active pre-act parameters are non-
configurable because their fields contain current data base information about the
Autotune algorithm and the process values.
When the Autotune Display for a loop is entered for the first time, a set of general
purpose default values is shown in the parameter fields and no trend data is shown
in the graph. Each time the Autotune Display is accessed thereafter, the hard disk is
searched for an experiment stored under the loop's name. If your system is
configured with multiple data processors, only the local node's hard disk is
accessed. If a match is found, the stored trend graph and set of default parameter
values appears on the Autotune Display. Otherwise, a set of general purpose default
parameter values appears in the fields.

3BUR002336R3701 RevA 629


Accessing The Autotune Display And Functionality Appendix D Autotune

AUTOTUNE: TST_LOOP1 OUTPT MEAS


100.00
100.00

50.00

0.00
0.00

TUNE CLSD OPEN DSGN ACTV GAIN RSET PREA


STATUS STEP PULSE TYPE CMPL MD ACTIVE ACTIVE ACTIVE
CMPL 25.000 20.000 PID PREV 2.7257 13.636 0.0183

PHASE HYST FACT GN ADJ ERR MD CALC CALC CALC


I.D.A 1.0000 0.8000 0.5000 MAN 2.7257 13.636 0.0183

METHD PGu EST GN RST ADJ HI LIM HI LIM HI LIM


CLSD 6.0570 0.0000 0.5000 125.00 125.00 30.000

EXP TIM PTu EST LAG LO LIM LO LIM LO LIM


1 0.1333 0.0000 0.0000 0.0000 0.0000

EST DT
0.0000

LAST MSG
SAVE COMPLETE PAGE
LOOP EXEC SAVE STORE ABORT RELEAS SHOW MORE 10 JAN 95 14:21:07
DISPLY DISPLY EXPMNT ATUNE EXPMNT ERRORS LOOPFCM
PIDTEST

Figure 100. Typical Autotune Display as Seen from the Multibus Console

Softkeys
The softkeys and their functions include:
LOOP DISPLY returns you to the Loop/FCM Display. Selection of the LOOP
DISPLY softkey prior to saving the experiment data generates a

630 3BUR002336R3701 RevA


Appendix D Autotune Accessing The Autotune Display And Functionality

warning message, providing you the opportunity to save the data


or return to the Loop/FCM Display without saving the data.
EXEC ATUNE initiates an Autotune experiment by invoking the Autotune
algorithm.
SAVE stores Autotune parameter entries you make in the data base.
When the save is complete, the message, "MODIFIED ITEMS
SAVED," is displayed and the loop's experiment becomes
active. You can verify that the experiment is active by selecting
the LIST ACTIVE softkey.

Unless you save modifications to Autotune parameters prior to


leaving the Autotune Display (by pressing LOOP DISPLY softkey),
a display request, selection of the LIBRARY key, or selection of the
SYSTEM STATUS key, the modifications are lost when you exit
the Autotune Display.
Using EXEC ATUNE and STORE EXPMNT softkeys also saves
parameter entries in the data base. Therefore, you do not need to
save any parameters using the SAVE softkey before you execute or
store an experiment.

STORE EXPMNT stores the currently displayed Autotune parameters and


experiment results on the hard disk, allowing you to access the
data in the future via the LOAD EXPMNT softkey. The STORE
EXPMNT displays a field where you can enter a name for the
stored experiment. By default, the field contains the loop tag
name, however, you can enter a different name for the
experiment (up to 12 alphanumeric characters). After you enter
the Autotune experiment name and it is stored, the experiment's
status remains active until released and made inactive via the
RELEAS EXPMNT softkey. You can verify that the experiment
was stored by the appearance of its name in the pop-up menu
displayed by selecting the LIST STORED softkey.

3BUR002336R3701 RevA 631


Accessing The Autotune Display And Functionality Appendix D Autotune

If you attempt to store an experiment using the same name as a


previously stored experiment, the previously stored experiment data
is overwritten.
If your system is configured with multiple data processors, only the
local node's hard disk is accessed.

ABORT ATUNE aborts the Autotune experiment currently in progress, changing


the Autotune algorithm's status to ERR (error).
RELEAS EXPMNTremoves the current Autotune experiment from the list of active
experiments, thereby, removing the experiment's parameters and
trend data from the data base and freeing up memory for another
experiment. To retain the parameters and experiment data for
future use, store the experiment on the hard disk using the
STORE EXPMNT softkey before releasing the experiment.
SHOW ERRORS allows you to display all errors and warning messages reported
by the Autotune algorithm during the current experiment. The
messages are listed one at a time, in yellow, below the fields for
the Autotune parameters. Error messages are displayed first,
followed by warning messages. With each selection of the
SHOW ERRORS softkey, the next error or warning message is
displayed. An END OF ERRORS message is displayed to
indicate there were no other error or warning messages
generated.

The error and warning messages displayed only apply to the current
Autotune experiment and remain available until another Autotune
experiment is executed.

MORE calls up a second set of softkeys for the Autotune Display.

632 3BUR002336R3701 RevA


Appendix D Autotune Accessing The Autotune Display And Functionality

The second set of softkeys includes the following:


LIST ACTIVE calls up a menu to the right of the Autotune parameters, listing
the loop names for all active experiments on the node where the
loop resides.
LIST STORED calls up a menu to the right of the Autotune parameters, listing
the names of all experiments stored on the hard disk. If your
system is configured with multiple data processors, only the
experiments stored on the local node's hard disk are listed in the
menu window.

Changing Parameter Values


To change configurable Autotune parameters (shown in white on the Autotune
Display):
1. Select a field by moving the cursor to applicable box and press SELECT.
OR
Press NEXT FIELD to move from parameter value to parameter value shown
in white.
2. For parameters with pre-defined choices (PHASE, CMPL MD, and so on),
press NEXT CHOICE to toggle through the choices. Then press ENTER to
select one. You can also type the desired new value for the parameter and press
ENTER.
OR
For parameters without predefined choices, type the desired new value and
press ENTER.

Listing Active Experiments


When using Autotune, you may want to view the parameters for another active
experiment or see if you are close to the limit for the maximum number of
simultaneous experiments. The LIST ACTIVE softkey lists the loop names for all
active experiments on the node where the loop resides to the right of the parameter
fields on the Autotune Display. Up to 10 loop names are listed on the screen at one
time in the order in which their experiments were activated, with the most recently

3BUR002336R3701 RevA 633


Accessing The Autotune Display And Functionality Appendix D Autotune

activated experiment at the beginning of the list. Figure 101 shows an active
experiment list on the Autotune Display.
If all 10 fields of the active experiments list have a name there may be more active
experiments than can be listed on the screen at one time. The up and down arrow
targets to the left of the active experiments list are used to call up the next or
previous page of experiments in the list.
To view the next page of active experiments, move the cursor to the down arrow
target () and press the SELECT key. To view the previous page of stored
experiments, move the cursor to the up arrow target () and press the SELECT key.

634 3BUR002336R3701 RevA


Appendix D Autotune Accessing The Autotune Display And Functionality

AUTOTUNE: TST_LOOP1 OUTPT MEAS


100.00
100.00

50.00

0.00
0.00

TUNE CLSD OPEN DSGN ACTV GAIN RSET PREA


STATUS STEP PULSE TYPE CMPL MD ACTIVE ACTIVE ACTIVE
CMPL 25.000 20.000 PID PREV 2.7257 13.636 0.0183 ACTIVE EXPMNT
TST_LOOP1
PHASE HYST FACT GN ADJ ERR MD CALC CALC CALC LOOP_A
I.D.A 1.0000 0.8000 0.5000 MAN 2.7257 13.636 0.0183 LOOP_C

METHD PGu EST GN RST ADJ HI LIM HI LIM HI LIM


CLSD 6.0570 0.0000 0.5000 125.00 125.00 30.000

EXP TIM PTu EST LAG LO LIM LO LIM LO LIM


1 0.1333 0.0000 0.0000 0.0000 0.0000

EST DT
0.0000

LAST MSG
PAGE
LOOP ATUNE SAVE 10 JAN 95 14:21:07
DISPLY DISPLY LOOPFCM
PIDTEST

Figure 101. Autotune Display Listing Active Experiments as Seen on the Multibus Console

The softkeys available when the active experiments are listed allow you to:
LOOP access the Loop/FCM Display for the currently active
DISPLY experiment

3BUR002336R3701 RevA 635


Accessing The Autotune Display And Functionality Appendix D Autotune

ATUNE removes the list of active experiments from the display


DISPLY and calls up the first set of softkeys on the Autotune
Display
SAVE save the parameter values for the currently active
experiment
To call up the parameters for one of the active experiments listed, you must first call
up the Loop/FCM Display for the loop on which the Autotune algorithm was
applied. This is achieved using the bottom line display request described in Section
4.3.4 of Operator's Guide. Then select the ATUNE DISPLY softkey to call up the
Autotune Display for the loop.

Listing Stored Experiments


When using Autotune, you may want to view the parameters for stored experiments.
The LIST STORED softkey lists the loop names for all experiments stored on the
hard disk to the right of the parameter fields on the Autotune Display. If your system
is configured with multiple data processors, only the experiments stored on the local
node's hard disk are listed in the menu window. Up to 10 loop names are listed on
the screen in alphabetical order. Figure 102 is shows a stored experiment list on the
Autotune Display.

636 3BUR002336R3701 RevA


Appendix D Autotune Accessing The Autotune Display And Functionality

AUTOTUNE: TST_LOOP1 OUTPT MEAS


100.00
100.00

50.00

0.00
0.00

TUNE CLSD OPEN DSGN ACTV GAIN RSET PREA


STATUS STEP PULSE TYPE CMPL MD ACTIVE ACTIVE ACTIVE
CMPL 25.000 20.000 PID PREV 2.7257 13.636 0.0183 STORED EXPMNT
GENERIC
PHASE HYST FACT GN ADJ ERR MD CALC CALC CALC LOOP_A
I.D.A 1.0000 0.8000 0.5000 MAN 2.7257 13.636 0.0183 LOOP_C
TST_LOOP1
METHD PGu EST GN RST ADJ HI LIM HI LIM HI LIM
CLSD 6.0570 0.0000 0.5000 125.00 125.00 30.000

EXP TIM PTu EST LAG LO LIM LO LIM LO LIM


1 0.1333 0.0000 0.0000 0.0000 0.0000

EST DT
0.0000

LAST MSG
PAGE
LOOP ATUNE SAVE STORE LOAD DELETE 10 JAN 95 14:21:07
DISPLY DISPLY EXPMNT EXPMNT EXPMNT LOOPFCM
PIDTEST

Figure 102. Autotune Display Listing Stored Experiments as Seen on the Multibus Console

If all 10 fields of the stored experiments list have a name there may be more stored
experiments than can be listed on the screen at one time. The up and down arrow
targets to the left of the stored experiments list are used to call up the next or
previous page of experiments in the list.

3BUR002336R3701 RevA 637


Accessing The Autotune Display And Functionality Appendix D Autotune

To view the next page of stored experiments, move the cursor to the down arrow
target () and press the SELECT key. To view the previous page of stored
experiments, move the cursor to the up arrow target () and press the SELECT key.
When the list of stored experiments is displayed, the following softkeys are
provided:
LOOP access the Loop/FCM Display for the loop whose
DISPLY Autotune Display is currently shown
ATUNE removes the list of stored experiments from the display
DISPLY and calls up the first set of softkeys on the Autotune
Display
SAVE save the parameter values for the currently active
experiment
STORE store parameters shown on Autotune Display on hard
EXPMNT disk
LOAD replaces parameter values for the current Autotune
EXPMNT experiment with the default parameter values for a
stored experiment of your choice. The loaded
parameter defaults are treated as modifications to the
current experiment's parameters. Therefore, their
values are lost for the current Autotune experiment
when you leave the Autotune Display for any reason
unless saved and/or stored prior to leaving the display
DELETE delete all data from the hard disk for a specific
EXPMNT previously stored experiment
To call up the parameters for one of the stored experiments listed, select its name by
moving the cursor to its field and pressing the SELECT key.
To load the default parameter values for a previously stored experiment, select the
name of the experiment whose values you want to load from the displayed list.
Then, select the LOAD EXPMNT softkey.
To delete an experiment, select the name of the experiment you want to delete from
the displayed list. Then, select the DELETE EXPMNT softkey. When the deletion

638 3BUR002336R3701 RevA


Appendix D Autotune Autotune Execution

process is complete, the experiment's name is removed from the list of store
experiments.

If your system has multiple data processors, only the experiments


stored on the local node's hard disk are listed and available for
loading or deletion.

Autotune Execution
You can execute the phases of the Autotune function together in a sequence or one
at a time. When executed one-step-at-a-time, you are provided the opportunity to
interactively review the results of each phase upon completion. If you are satisfied
with the results of the current phase, you can execute the next phase. If you are not
satisfied with the results of the current phase, you can reconfigure the parameters of
the Autotune algorithm and execute the previous and/or current phase again. The
procedures for both sequential and interactive execution are described in the
paragraphs that follow.
The number of Autotune experiments you can run simultaneously on a node is
limited by the entry in the MAX SIM AT EXP (maximum simultaneous Autotune
experiments) field of the CCF Templet. See CCF in Turbo Nodes on page 106 for a
description of the CCF Templet and its fields.
When Autotune is invoked for a loop, that loop's Autotune experiment is active. The
loop is considered one of the maximum number of simultaneous experiments
allowed. To prevent other loops from overwriting experiment data for this loop, the
Autotune experiment remains active, even after the Autotune algorithm is complete,
until its active status is changed by you.
To change the loop's Autotune experiment to inactive, access the Autotune Display
for the loop and select RELEAS EXPMNT. This frees up the memory used by the
experiment for use by another loop, however, the Autotune parameters and
experiment data for the released experiment is lost. If you want to retain the
parameters and experiment data for future use, store the experiment on the hard disk
before releasing the experiment. To store the experiment, select the STORE
EXPMNT softkey from the Autotune Display.
Once parameter and experiment data is stored on the hard disk using the STORE
EXPMNT, you can access the Autotune Display for the loop and recall saved

3BUR002336R3701 RevA 639


Sequential Autotune Execution Appendix D Autotune

Autotune parameters and experiment data by selecting the LOAD EXPMNT


softkey. The process identification phase graph for the experiment is also shown on
the Autotune Display. This allows you to run the controller design phase of
Autotune without executing the process identification phase again.

Sequential Autotune Execution


This procedure uses the ability of the instrument to execute all phases of Autotune
in sequence. Tuning is completed and the controller is put on-line without operator
intervention.

On new or unfamiliar applications, you may want to interactively


control progression through Autotune phases and review results as
each phase completes. How to do this is covered in Interactive
Autotune Execution on page 644.

To sequentially execute the phases of the Autotune algorithm:


1. With the controller on-line in either Manual or Auto output mode, bring the
process to a steady state condition near its required operating point.
2. Access the Loop/FCM Display for the loop you want to tune.
3. Access the Autotune Display.
Once the Autotune Display is called up, you have three options:
– You can use the default parameter values as shown.
– You can load the general purpose default values or the default parameter
values for a previously stored experiment.
– You can change any of the default parameter values shown.
4. If necessary, load another set of default parameter values as described in
Accessing The Autotune Display And Functionality on page 627. The loaded
values may be the general purpose default values or the default values for a
previously stored experiment.
5. Configure Autotune for either the closed loop or open loop method by making
the appropriate entry to the METHD field of the Autotune Display.

640 3BUR002336R3701 RevA


Appendix D Autotune Sequential Autotune Execution

6. If necessary, configure the parameters for the method selected in Step 5.


Table 42 shows the configurable parameters for each method along with their
valid entries.

For the closed loop method, controller action must be set correctly.
If controller action is not properly set, the controller output
manipulations will not cause the process to oscillate. Thus,
generating a diagnostic error.
For the closed loop method, Hysteresis must be set to a value
greater than the amount of noise present on the process signal. If
Hysteresis is too small, noise on the process may be interpreted as
process oscillations. Thus resulting in incorrect estimates of the
process characteristics.
For both methods, output step size must be large enough to
overcome stiction or hysteresis which may be present in the final
actuator, typically a valve.

Table 42. Autotune Configuration Entries

Entry, Entry,
Parameter
Closed Loop Method Open Loop Method
Autotuning Method (METHD) CLSD OPEN
Completion Mode (CMPL MD) MAN (Manual) MAN (Manual)
AUTO (Automatic) AUTO (Automatic)
PREV (Previous) PREV (Previous)
Controller Gain Limits (HI LIM & LO LIM) Low: 0.0 to 125.0 Low: 0.0 to 125.0
High: 0.0 to 125.0 High: 0.0 to 125.0
Controller Pre-act Limits (HI LIM & LO LIM) Low: 0.0 to 32.0 Low: 0.0 to 32.0
High: 0.0 to 32.0 High: 0.0 to 32.0

3BUR002336R3701 RevA 641


Sequential Autotune Execution Appendix D Autotune

Table 42. Autotune Configuration Entries (Continued)

Entry, Entry,
Parameter
Closed Loop Method Open Loop Method
Controller Reset Limits (HI LIM & LO LIM) Low: 0.0 to 125.0 Low: 0.0 to 125.0
High: 0.0 to 125.0 High: 0.0 to 125.0
Controller Type (TYPE) PI or PID PI, PID, or DTC
Error Mode (ERR MD) MAN (Manual) MAN (Manual)
AUTO (Automatic) AUTO (Automatic)
PREV (Previous) PREV (Previous)
Estimated Process Deadtime (EST DT) Not applicable 0 to 125 minutes
Estimated Process Gain (EST GN) Not applicable 0.0 to 125.0
Estimated Process Lag (EST LAG) Not applicable 0 to 125 minutes
Experiment Time (EXP TIM) Not applicable 1 to 255 minutes
Gain Adjustment Factor (GN ADJ) 0.00 to 1.00 0.00 to 1.00
Hysteresis (HYST) 0.00 to 50.0% Not applicable
Output Pulse Size (OP PULSE) Not applicable -50.0 to 50.0%
Output Step Size (STEP) 0.00 to 50.0% Not applicable
Pulse Factor (PULSE FACT) Not applicable 0.00 to 0.90
Reset Adjustment Factor (RST ADJ) 0.00 to 1.00 0.00 to 1.00
Ultimate Process Gain (PGu) -9.999E-9 to 9.999E9 Not applicable
Ultimate Process Period (PTu) -9.999E-9 to 9.999E9 Not applicable

7. Enter I.D.A in the PHASE field of the Autotune Display.


8. Select the EXEC ATUNE softkey on the Autotune Display.
The Autotune algorithm then verifies the controller's current output mode
before the process identification phase begins. The controller's current output
mode must be Manual, Auto, or Track for the Autotune algorithm to proceed. If
the controller is in Computer mode, execution of the Autotune algorithm is

642 3BUR002336R3701 RevA


Appendix D Autotune Sequential Autotune Execution

denied, a execution failed message is displayed on the Autotune Display.


Autotune Execution And Error Indications on page 650 describes how the
Autotune status and errors are indicated.
During the process identification phase for the closed loop method, trend data
on the Autotune Display is cleared, measured values are collected from the
data base, and trend is redrawn for the collected data. If high and/or low limit
for the controller output or process variable is reached, trend data is limited and
displayed in white on the Autotune Display.
When the algorithm is complete, the STATUS field of the Autotune Display
changes from IDNT (Identification mode) to either CMPL or ERR. CMPL in
the STATUS field indicates the algorithm completed successfully, and the
controller output changes from Identification mode (IDNT) to Completion
mode (that is, the mode specified in the CMPL MD field of the Autotune
Display). ERR in the STATUS field indicates the algorithm completed with
errors, and the controller output changes from Identification mode (IDNT) to
Error mode (that is, the mode specified in the ERR MD field of the Autotune
Display). If the specified Completion or Error mode is an invalid output mode
for the loop, as determined by the OUTPUT MODES ALLOWED field of the
loop's PID Controller FCM Templet, execution of the Autotune algorithm is
allowed. However, an error message is created upon termination of the
algorithm and the controller is placed in the previous output mode. Autotune
Execution And Error Indications on page 650 describes how the Autotune
status and errors are indicated.
9. When the Autotune algorithm is complete, examine the trend graph and the
calculated parameter values appropriate for the Autotuning method selected in
step 5. If you are satisfied with the results and want to store them on the hard
disk, select the STORE EXPMNT softkey and remove the experiment from the
active list by selecting the RELEAS EXPMNT softkey. Otherwise, just select
the RELEAS EXPMNT softkey to remove the experiment from the active list
without storing its results on the hard disk.
If you are not satisfied with the results, reconfigure any experiment parameters
and execute any of the three phases again sequentially by repeating steps 6
through 8 or interactively as described in Interactive Autotune Execution on
page 644.

3BUR002336R3701 RevA 643


Interactive Autotune Execution Appendix D Autotune

To evaluate controller on-line performance when the Autotune algorithm is done,


introduce a setpoint or process load disturbance and observe the recovery of the
process variable.

Interactive Autotune Execution


This procedure steps through the Autotune phases one at a time, to review the
results of each phase. This procedure is recommended for first-time Autotune users,
and for cases where Autotune is being applied to a new or unfamiliar application.
Other situations where the flexibility to run phases interactively is useful include the
following:
• You changed the controller type (PI, PID, or DTC) and want to calculate
optimum tuning parameters for the new controller type. To do so, you only
want run the controller design phase of the Autotune algorithm without running
the process identification phase again.
• You have a good feel for the loop dynamics, want to enter the loop's
characteristics, and run only the controller design phase to determine the
optimum tuning parameters.
• You may not be able to take the controller off-line for the time required to
execute the process identification phase. Thus, you may want to run the
controller design phase and/or parameter activation phase of Autotune without
altering the controller's output mode.
To interactively execute the Autotune algorithm one or two phases at a time:
1. With the controller on-line in either Manual or Auto output mode, allow the
process to reach a steady state condition near its required operating point.
2. Access the Loop/FCM Display for the loop you want to tune.
3. Access the Autotune Display.
Once the Autotune Display is called up, you have three options:
– You can use the default parameter values as shown.
– You can load the general purpose default values or the default parameter
values for a previously stored experiment.
– You can change any of the default parameter values shown.

644 3BUR002336R3701 RevA


Appendix D Autotune Interactive Autotune Execution

4. If necessary, load another set of default parameter values as described in


Accessing The Autotune Display And Functionality on page 627. The loaded
values may be the general purpose default values or the default values for a
previously stored experiment.
5. Configure Autotune for either the closed loop or open loop method by making
the appropriate entry to the METHD field of the Autotune Display.
6. If necessary, configure the parameters for the method selected in Step 5.
Table 42 shows the configurable parameters for each method along with their
valid entries.

For the closed loop method, controller action must be set correctly.
If controller action is not properly set, the controller output
manipulations will not cause the process to oscillate. Thus,
generating a diagnostic error.
For the closed loop method, Hysteresis must be set to a value
greater than the amount of noise present on the process signal. If
Hysteresis is too small, noise on the process may be interpreted as
process oscillations. Thus resulting in incorrect estimates of the
process characteristics.
For both methods, output step size must be large enough to
overcome stiction or hysteresis which may be present in the final
actuator, typically a valve.

The next step you take depends on the phase(s) of the Autotune algorithm you want
to execute.
To execute only the process identification phase:
1. Enter I in the PHASE field of the Autotune Display.
2. Select the EXEC ATUNE softkey.
The Autotune algorithm verifies the controller's current output mode before the
process identification phase begins. The controller's current output mode must
be Manual or Auto for Autotune to proceed. If the controller is in Computer
mode, the Autotune algorithm does not execute, an Autotune error message is

3BUR002336R3701 RevA 645


Interactive Autotune Execution Appendix D Autotune

generated, and an execution failed message is displayed on the Autotune


Display. Autotune Execution And Error Indications on page 650, describes
how the Autotune status and errors are indicated.
Two functions are performed by the process identification phase for the closed
loop method. First, the process response is monitored to verify the loop is a
valid candidate for the closed loop method. Second, another trend value is
added to the trend graph with each loop scan. Therefore, some trend values
may be scrolled off the graph.
If the loop is a valid candidate for the closed loop method, the trend data shown
on the Autotune Display is cleared and the second function begins. During this
function, the required number of measured values necessary to perform the
Autotune calculations are collected from the data base. A subset of all the
measured trend values is displayed to insure it is possible to display the entire
measurement function on one trend graph. If high and/or low limits for the
controller's output or process variable is reached, the trend data is limited and
displayed in white on the Autotune Display.
When the identification phase is complete, the STATUS field of the Autotune
Display changes from IDNT (Identification mode) to either CMPL, WARN or
ERR. CMPL in the STATUS field indicates the algorithm completed
successfully, and the controller output changes from Identification mode
(IDNT) to Completion mode (that is, the mode specified in the CMPL MD
field of the Autotune Display). WARN in the STATUS field indicates the
algorithm completed successfully with a condition you should be aware of, and
the controller output changes from Identification mode (IDNT) to Error mode
(that is, the mode specified in the ERR MD field of the Autotune Display).
ERR in the STATUS field indicates the algorithm completed with errors, and
the controller output changes from the Identification mode (IDNT) to the Error
mode. If the specified Completion or Error mode is an invalid output mode for
the loop, as determined by the entry in OUTPUT MODES ALLOWED field of
the loop's PID Controller FCM Templet, execution of the Autotune algorithm
is allowed. However, an error message is created upon termination of the
algorithm and the controller is placed in the previous output mode.
3. When the identification phase is complete, examine the results shown in the
trend graph and the calculated parameter values for the Autotuning method. If
you are satisfied with the results, execute the next phase(s) of the Autotune

646 3BUR002336R3701 RevA


Appendix D Autotune Interactive Autotune Execution

algorithm as described below. If you are not satisfied with the results,
reconfigure any desired experiment parameters and execute the process
identification phase again.
To execute the process identification and controller design phases:
1. Enter I.D in the PHASE field of the Autotune Display.
2. Select the EXEC ATUNE softkey.
The Autotune algorithm verifies the controller's current output mode before the
process identification phase begins. The controller's current output mode must
be Manual or Auto for the Autotune algorithm to proceed. If the controller is in
Computer mode, the Autotune algorithm does not execute, an execution failed
message is generated, is displayed on the Autotune Display. Autotune
Execution And Error Indications on page 650, describes how the Autotune
status and errors are indicated.
Two functions are performed by the process identification phase for the closed
loop method. First, the process response is monitored to verify the loop is a
valid candidate for the closed loop method. Second, another trend value is
added to the trend graph with each loop scan. Therefore, some trend values
may be scrolled off the graph.
If the loop is a valid candidate for the closed loop method, the trend data shown
on the Autotune Display is cleared and the second function begins. During this
function, the required number of measured values necessary to perform the
Autotune calculations are collected from the data base. A subset of all the
measured trend values is displayed to insure it is possible to display the entire
measurement function on one trend graph. If high and/or low limits for the
controller's output or process variable is reached, the trend data is limited and
displayed in white on the Autotune Display.
When the identification phase is complete, the algorithm automatically
proceeds to the controller design phase unless an error is detected. If an error is
detected, the controller design phase is not performed.
When the controller design phase is complete, the STATUS field of the
Autotune Display changes to either CMPL, WARN or ERR and the controller
output changes to the appropriate Completion or Error mode. If the specified
Completion or Error mode is an invalid output mode for the loop, as

3BUR002336R3701 RevA 647


Interactive Autotune Execution Appendix D Autotune

determined by the OUTPUT MODES ALLOWED field of the loop's PID


Controller FCM Templet, execution of the Autotune algorithm is allowed.
However, an error message is created upon termination of the algorithm and
the controller is placed in the previous output mode. Autotune Execution And
Error Indications on page 650, describes how the Autotune status and errors are
indicated.
3. After the controller design phase is complete, examine the calculated process
gain, reset and pre-act parameter values. If you are satisfied with the results,
execute the next phase of the Autotune algorithm as described below. If you are
not satisfied with the results, reconfigure any desired experiment parameters
and execute the process identification and/or controller design phase again.
To execute only the controller design phase:
1. Enter D in the PHASE field of the Autotune Display.

If only the controller design phase of the Autotune algorithm is


being executed, the controller's output mode does not change to the
Identification mode (IDNT) but remains in the output mode active
prior to execution of the specified phase.

2. Select the EXEC ATUNE softkey.


When the controller design phase is complete, the STATUS field of the
Autotune Display changes to either CMPL, WARN or ERR and the controller
output changes to the appropriate Completion or Error mode. If the specified
Completion or Error mode is an invalid output mode for the loop, as
determined by the OUTPUT MODES ALLOWED field of the loop's PID
Controller FCM Templet, execution of the Autotune algorithm is allowed.
However, an error message is created upon termination of the algorithm and
the controller is placed in the previous output mode. Autotune Execution And
Error Indications on page 650, describes how the Autotune status and errors are
indicated.
3. After the controller design phase is complete, examine the calculated process
gain, reset and pre-act parameter values. If you are satisfied with the results,
execute the next phase of the Autotune algorithm as described below. If you are

648 3BUR002336R3701 RevA


Appendix D Autotune Interactive Autotune Execution

not satisfied with the results, reconfigure any desired experiment parameters
and execute the process identification and/or controller design phase again.
To execute the controller design and parameter activation phases:
1. Enter D.A in the PHASE field.

If only the controller design and parameter activation phases of the


Autotune algorithm are being executed, the controller's output
mode does not change to the Identification mode (IDNT) but
remains in the output mode active prior to execution of the specified
phase.

2. Select the EXEC ATUNE softkey.


When execution of the controller design phase is complete, the algorithm
automatically proceeds to the parameter activation phase.
When the parameter activation phase is complete, the STATUS field of the
Autotune Display changes to either CMPL, WARN or ERR and the controller
output changes to the appropriate Completion or Error mode. If the specified
Completion or Error mode is an invalid output mode for the loop, as
determined by the OUTPUT MODES ALLOWED field of the loop's PID
Controller FCM Templet, execution of the Autotune algorithm is allowed.
However, an error message is created upon termination of the algorithm and
the controller is placed in the previous output mode. Autotune Execution And
Error Indications on page 650, describes how the Autotune status and errors are
indicated.
3. If you are satisfied with the results and want to store them on the hard disk,
select the STORE EXPMNT softkey and remove the experiment from the
active list by selecting the RELEAS EXPMNT softkey. Otherwise, just select
the RELEAS EXPMNT softkey to remove the experiment from the active list
without storing its results on the hard disk. If you are not satisfied with the
results, reconfigure any desired experiment parameters and execute any of the
three phases again.
To execute only the parameter activation phase:
1. Enter A in the PHASE field of the Autotune Display.

3BUR002336R3701 RevA 649


Autotune Execution And Error Indications Appendix D Autotune

If only the parameter activation phase of Autotune is being


executed, the controller output mode does not change to
Identification mode (IDNT) but remains in the output mode active
prior to execution of the specified phase.

2. Select the EXEC ATUNE softkey.


When the parameter activation phase is complete, the STATUS field of the
Autotune Display changes to either CMPL, WARN or ERR and the controller
output changes to the appropriate Completion or Error mode. If the specified
Completion or Error mode is an invalid output mode for the loop, as
determined by the OUTPUT MODES ALLOWED field of the loop's PID
Controller FCM Templet, execution of the Autotune algorithm is allowed.
However, an error message is created upon termination of the algorithm and
the controller is placed in the previous output mode. Autotune Execution And
Error Indications on page 650, describes how the Autotune status and errors are
indicated.
3. If you are satisfied with the results and want to store them on the hard disk,
select the STORE EXPMNT softkey and remove the experiment from the
active list by selecting the RELEAS EXPMNT softkey. Otherwise, just select
the RELEAS EXPMNT softkey to remove the experiment from the active list
without storing its results on the hard disk. If you are not satisfied with the
results, reconfigure any desired experiment parameters and execute any of the
three phases again.
To evaluate controller on-line performance when Autotune is finished,
introduce a setpoint or process load disturbance and observe the recovery of the
process variable.

Autotune Execution And Error Indications


When the controller output mode is changed to Identification mode (IDNT) it is
treated as any other controller output mode. The alarm/event monitor detects the
mode change and generates a parameter change message. This message informs all
system users that the controller output is not a true control signal, but rather it is
being manipulated by the Autotune function. The method by which Autotune

650 3BUR002336R3701 RevA


Appendix D Autotune Autotune Execution And Error Indications

execution and completion is indicated on displays varies depending upon the


display as described below.
Indicating Autotune Execution on Runtime Displays
If Autotune involves the process identification phase, the controller output changes
to Identification mode (IDNT). This is indicated on runtime displays by I, ID, or
IDNT in the output mode field of the loop's status block. The Identification mode ID
depends on the display field's size. For example, on the Loop/FCM Display,
execution of Autotune is indicated by IDNT in the OPMD (output mode) field of
PID control loop's block.
If Autotune involves the controller design and/or parameter activation phase, there
is no indication on runtime displays. This is because the controller output does not
change to Identification mode but remains in the mode active prior to execution of
the Autotune phase(s).
If you attempt to take control of a loop via a runtime display when the controller
output is in Identification mode, control targets are provided at the bottom of the
display. The setpoint and output targets are not available, and the output mode target
has only AUTO and MAN options. The active mode is in white. If neither option is
in white (that is, they are both green) the controller is in Identification mode,
indicating that the Autotune algorithm is running. Selection of either AUTO or
MAN from the output mode control target terminates Autotune and places the
controller output in the Error mode specified on the Autotune Display, not the mode
selected from the control line. The setpoint and output control targets also return to
the display. You can then take control of the loop and select the desired output mode
from the control line.
Indicating Autotune Execution on Autotune Displays
On the Autotune Display, either IDNT (process identification phase), DSGN
(controller design phase), or ACTV (parameter activation phase) in the STATUS
field indicates that the Autotune algorithm is executing and which phase is currently
running.
Indicating Autotune Completion on Runtime Displays
Successful completion of the Autotune algorithm is indicated on runtime displays
(Area Status, Area Trend, and so on) by the change in the controller output from its

3BUR002336R3701 RevA 651


Autotune Notification, Error, and Warning Messages Appendix D Autotune

previous mode (A, AUTO, M, or MAN) or Identification mode (I, ID, or IDNT) to
the Completion mode (A, AUTO, M, or MAN) specified on the Autotune Display.
Indicating Autotune Completion on Autotune Displays
On the Autotune display, CMPL, ERR, or WARN in the STATUS field respectively
indicates execution of the Autotune algorithm either completed successfully or with
errors.
Indicating Autotune Errors and Warnings on Runtime Displays
Autotune errors and warnings are indicated on runtime displays by a change in the
controller output mode from its previous mode (A, AUTO, M, or MAN) or
Identification mode (I, ID, or IDNT) to the Error mode (A, AUTO, M, or MAN)
specified on the Autotune Display. Descriptions of Autotune error and warning
messages are provided in Autotune Notification, Error, and Warning Messages on
page 652.
Indicating Autotune Errors and Warnings on Autotune Displays
On the Autotune display, ERR or WARN in the STATUS field indicates that errors
or warnings were detected during execution of the Autotune algorithm. You can
view the error and/or warning messages one at a time using the SHOW ERRORS
softkey. Descriptions of the Autotune error and warning messages are provided in
Autotune Notification, Error, and Warning Messages on page 652.

Autotune Notification, Error, and Warning Messages


The line just above the softkeys on the Autotune Display is reserved for notification,
error, and warning messages. Regardless of the message type, they are displayed
one at a time in yellow.
Notification messages are generated in response to an operator action (that is,
selection of a softkey). For example, if you select the SAVE softkey, a message
indicates whether the save process failed or succeeded. Such messages are not
stored and are cleared by selection of another softkey function. Table 43 lists the
possible notification messages and their causes.
Error and warning messages are generated by the Autotune algorithm. To view the
Autotune errors and warnings detected during the current experiment, select the
SHOW ERRORS softkey on the Autotune Display. Error messages are displayed
first, and then the warning messages are displayed. The two types of messages are

652 3BUR002336R3701 RevA


Appendix D Autotune Autotune Notification, Error, and Warning Messages

distinguished by the corresponding ERROR: or WARNING: label preceding the


message. With each selection of the SHOW ERRORS softkey, the next error or
warning message is displayed. An END OF ERRORS message is displayed to
indicate no other error or warning messages were generated.

All Autotune error and warning messages for an experiment are


erased when the Autotune algorithm is executed again, at power up,
or when default parameter values are loaded.

Table 44 lists the possible error messages and their causes, and Table 45 lists the
possible warning messages and their causes.

Table 43. Autotune Notification Messages

Notification Message Cause for Notification


AUTOTUNE ABORT This message is displayed when a communications failure occurs
REQUEST FAILED during the abort process. Check the diagnostic messages.
AUTOTUNE ABORT This message is displayed when you select the ABORT ATUNE
REQUEST MADE softkey and confirm aborting the Autotune function.
CONFIGURED MAXIMUM This message is displayed when the maximum number (n) of
NUMBER OF AUTOTUNE experiments, specified on the CCF Templet, are active and you
EXPERIMENTS attempt to call up the Autotune Display for another loop (n+1). When
EXCEEDED this occurs, the "Skeleton Display" (that is, the Autotune Display
without any trend or parameter information) is called up. From this
display, you can only return to the Loop/FCM Display or list the stored
or currently active experiments. Selection of any other softkey function
from the "Skeleton Display" results in the UNABLE TO PERFORM
FUNCTION message.
DUE TO ERR BUILDING This message is displayed when a communications error occurs while
DISPLY, SKELETON trying to build the Autotune Display after selection of the ATUNE
DISPLY ONLY: SEE DISPLY softkey on the Loop/FCM Display.
DIAGS
EXECUTE AUTOTUNE This message is displayed when you select the EXEC ATUNE softkey
REQUEST MADE and confirm execution of the Autotune algorithm.

3BUR002336R3701 RevA 653


Autotune Notification, Error, and Warning Messages Appendix D Autotune

Table 43. Autotune Notification Messages (Continued)

Notification Message Cause for Notification


EXPERIMENT DELETE This message is displayed when a communications failure with the
FAILED hard disk occurs during experiment deletion. Check the diagnostic
messages.
EXPERIMENT DELETED This message is displayed when a stored experiment is successfully
deleted.
EXPERIMENT LOAD This message is displayed when a communications failure with the
FAILED hard disk occurs while loading a previously stored experiment. Check
the diagnostic messages.
EXPERIMENT LOADED This message is displayed when a stored experiment is successfully
loaded.
EXPERIMENT STORE This message is displayed when a communications failure with the
FAILED hard disk occurs while storing an experiment. Check the diagnostic
messages.
EXPERIMENT STORED This message is displayed when an experiment is successfully stored
on the hard disk.
MODIFIED PARAMETERS This message is displayed when you have changed any of the
WILL BE SAVED Autotune parameter values and selected either the STORE EXPMNT
or EXEC ATUNE softkey, but did not explicitly save the modifications
by selecting the SAVE softkey.
NOTHING TO SAVE This message is displayed when you select the SAVE softkey and
there have been no changes to the Autotune parameter values.
PARAMETERS This message is displayed when you have changed any of the
CHANGED; PRESS SAVE Autotune parameter values, and then selected the LOOP DISPLY
TO SAVE NEW VALUES softkey without previously saving the modifications by selecting the
SAVE softkey.
RELEASE EXPERIMENT This message is displayed when a communications failure occurs
REQUEST FAILED while releasing a currently active experiment. Check the diagnostic
messages.
RELEASE EXPERIMENT This message is displayed when you select the RELEAS EXPMNT
REQUEST MADE softkey and confirm releasing the active experiment.

654 3BUR002336R3701 RevA


Appendix D Autotune Autotune Notification, Error, and Warning Messages

Table 43. Autotune Notification Messages (Continued)

Notification Message Cause for Notification


REQUEST TO EXECUTE This message is displayed when a communications failure occurs
AUTOTUNE FAILED while attempting to execute the Autotune algorithm. Check the
diagnostic messages.
SAVE COMPLETE This message is displayed when Autotune parameter values have
been successfully saved.
SAVE FAILED This message is the result of a communications failure while saving
Autotune parameter values. Check the diagnostic messages.
SELECT EXPERIMENT This message is displayed when you select the DELETE EXPMNT
TO BE DELETED softkey without selecting a stored experiment from the stored
experiment list.
SELECT EXPERIMENT This message is displayed when you select the LOAD EXPMNT
TO BE LOADED softkey without selecting the a stored experiment from the stored
experiment list.
THIS EXPERIMENT IS This message is displayed when you attempt to perform a function
EXECUTING: UNABLE which is not allowed because the Autotune experiment is executing.
TO PERFORM THIS The only functions valid when the Autotune experiment is executing
FUNCTION are returning to the Loop/FCM Display, aborting execution of the
Autotune experiment, listing the stored experiments, and listing the
currently active experiments.
THIS EXPERIMENT IS This message is displayed when you select the ABORT ATUNE
NOT EXECUTING: softkey and the Autotune experiment is not executing (that is, the
UNABLE TO ABORT Autotune status is not IDNT).
TREND CLEARED: This message is displayed during the process identification phase of a
STARTING CLOSED closed loop experiment. The time base changes for the trend when
LOOP MEASUREMENTS the appropriate response has been achieved and the Autotune
algorithm begins measuring the response.
UNABLE TO DISPLAY This message is displayed when the Autotune Display trend function
TREND DATA, SEE fails because of a communications failure. The trend data is retrieved
DIAGNOSTICS from either a previously executed experiment or a currently executing
experiment.

3BUR002336R3701 RevA 655


Autotune Notification, Error, and Warning Messages Appendix D Autotune

Table 43. Autotune Notification Messages (Continued)

Notification Message Cause for Notification


UNABLE TO OPEN This message is displayed when you select the LIST STORED
STORED EXPERIMENT softkey and a communications failure occurs while accessing the hard
FILE, SEE DIAGS disk.
UNABLE TO PERFORM This message is displayed when you enter the "Skeleton Display" and
THIS FUNCTION try to perform an Autotune function. The only valid functions from this
display are returning to the Loop/FCM Display, listing the stored
experiments, and listing the currently active experiments.
UNABLE TO READ This message is displayed when you enter the Autotune Display (by
INITIAL ITEM VALUES selecting the ATUNE DISPLY softkey from the Loop/FCM Display)
FROM DISK and are unable to access the hard disk. When this occurs, the default
parameter values are used so you may continue.
UNABLE TO SAVE This message is displayed when you select the SAVE softkey and any
TREND DATA - DATA MAY modified Autotune parameter values are saved, but saving the trend
BE LOST - SEE DIAGS data fails due to a communications failure.

Table 44. Autotune Error Messages

Error Message Cause of Error


A USER ADJUSTMENT This error occurs when you specify a gain or reset adjustment factor
FACTOR IS OUT OF on the Autotune Display that is outside its valid limits. The value of the
BOUNDS; O TO 1 adjustment factor must be between 0.0 and 1.0.
ACTIVATION LIMITS HIT - This error occurs during the parameter activation phase when one of
PARAMETERS OUTSIDE the calculated parameter values (gain, reset, or pre-act) exceeds the
LIMITS high and low limits specified on the Autotune Display.
AUTOTUNE NOT This error occurs when the control algorithm is in the Computer Mode.
ALLOWED WHILE IN The output mode must be either Auto or Manual for the Autotune
COMPUTER MODE algorithm to run.

656 3BUR002336R3701 RevA


Appendix D Autotune Autotune Notification, Error, and Warning Messages

Table 44. Autotune Error Messages (Continued)

Error Message Cause of Error


BAD IDENT STEP; This error applies to the open loop method only. This error is reported
PROCESS PARAMETERS when the process parameters estimated during the process
ARE UNREASONABLE identification phase are unreasonable. Some potential causes of this
error are the process not being near steady state when Autotune was
started, large load disturbances during the identification stage, the
output pulse size not being large enough, or the process is extremely
noisy.
CAN'T ACTIVATE WITH This error occurs during the parameter activation phase. A warning
CONTROLLER PARMS message was generated in one of the previous phases which blocked
DUE TO WARNING the Autotune algorithm from performing the parameter activation
functions. The warning must be corrected before the parameter
activation phase can run error-free.
COMPLETION OR This error occurs when either the completion or error mode specified
ERROR MODE IS NOT on the Autotune Display is not one of the allowed output modes
AN ALLOWED MODE specified on the PID Controller FCM Templet.
DATABASE ADDRESS This is an internal error.
ERROR - A BAD
DBRADDR CALL
DTC NOT ALLOWED - This error applies to the open loop method only. During the parameter
DTC IS DISABLED ON activation phase, the Autotune function checks to see if dead time
THE PID TEMPLET compensation (DTC) is enabled for the PID controller (that is, you
entered YES in the ENABLE DEAD TIME field on the second page of
the PID Controller FCM Templet). If dead time compensation is
disabled (that is, you entered NO in the ENABLE DEAD TIME field of
the PID Controller FCM Templet), you must enable it to perform the
parameter activation phase error-free.

3BUR002336R3701 RevA 657


Autotune Notification, Error, and Warning Messages Appendix D Autotune

Table 44. Autotune Error Messages (Continued)

Error Message Cause of Error


IDENT OUTPUT LIMITS This error occurs when you execute an Autotune function involving
EXCEEDED WITH the process identification phase and the control algorithm's manual
CURRENT PULSE/STEP output limits would be exceeded. Regardless of which Autotuning
method (open or closed loop) you are using, the error is caused by the
current PID output value and the entry of too large an output pulse or
step value on the Autotune Display. The current PID output value plus
or minus the pulse/step value cannot exceed the output high and low
limits specified on the fourth page of the PID Controller FCM Templet.
INVALID CONTROLLER This error occurs when you specify a controller type on the Autotune
TYPE Display that is not valid for the specified Autotuning method (open or
closed loop). For the closed loop method, this error occurs if a
controller type other than PI or PID is specified. For the open loop
method, this error occurs if a controller type other than PI, PID, or
DTC is specified.
INVALID PHASE - PHASE This error occurs when you specify a phase other than I, I.D, I.D.A, D,
NOT IDENT, DESIGN OR D.A, or A in the PHASE field of the Autotune Display.
ACTIVATE
MISMATCH BETWEEN This error occurs when the controller response type is not consistent
CONTRLR TYPE AND with the controller type specified on the Autotune Display. For
EXPERIMENT TYPE example, if the controller response type has gain or reset set to OFF,
the error is reported. Also if PID tuning was requested and the control
algorithm has the pre-act set to OFF, the error is reported.
OPEN LOOP PULSE This error occurs when you specify a pulse factor on the Autotune
FACTOR IS NOT Display that is outside its valid limits. The value of the pulse factor
BETWEEN 0 AND 0.9 must be between 0.00 and 0.90.
OUTPUT PULSE SIZE This error applies to the open loop method only. The error occurs
MAGNITUDE < 0.01 OR > when you specify an output pulse size on the Autotune Display of 0 or
50 with a magnitude less than 0.01% or greater than 50.0%. The value of
the pulse size must be between 0.01 and 50.0.

658 3BUR002336R3701 RevA


Appendix D Autotune Autotune Notification, Error, and Warning Messages

Table 44. Autotune Error Messages (Continued)

Error Message Cause of Error


PID CONTRLR ACT. Near the end of the process identification phase, the Autotune
INCONSISTENT WITH algorithm checks the controller action. This error is reported if the
ACT. OF PROCESS control algorithm controller action parameter was configured
inconsistent with the action of the process.
PROCESS NOISY OR This error applies to the open loop method only. This error occurs if
NOT RESPONDING; the process is extremely noisy and the Autotune algorithm is unable to
CAN'T EST. PROCESS estimate the process parameters from the data collected. Sometimes
this error occurs when the process response to the output pulse is
very small (that is, so small the algorithm is unable to derive useful
information from it). If this is the cause of the error, the experiment
should be repeated with a larger output pulse size.
PROCESS STAYED IN This error applies to the closed loop method only. The error is
IDENTIFICATION PHASE reported during the process identification phase when the
TOO LONG measurement of the process is taking too long. Possible corrective
actions include increasing the step size or lowering the hysteresis
band.
PROCESS VALUE IS NOT This error occurs during the process identification phase when the
WITHIN GIVEN process signal exceeds either the process high or low values
PROCESS LIMITS specified on the first page of the PID Controller FCM Templet.
THE AUTOTUNE This message is displayed when an Autotune experiment is
EXPERIMENT WAS successfully aborted by selecting the ABORT ATUNE softkey and
ABORTED confirming the abort action.
THE LOOP TO BE TUNED This error occurs when the PID loop being tuned is in an OFF state.
IS NOT ON For the Autotune algorithm to function, the loop must be ON.
THE PID LOOP HAS A This error occurs when the processing rate of the loop being tuned is
PROCESSING RATE OF zero. To correct this problem, change the processing rate specified on
ZERO the PID Controller FCM Templet to a value greater than zero.
TRACK IS NOT AN This error occurs when the control algorithm is in the Output Track
ALLOWED MODE FOR Mode. The output mode must be either Auto or Manual for the
AUTOTUNE Autotune algorithm to run.

3BUR002336R3701 RevA 659


Aborting Autotune Execution Appendix D Autotune

Table 45. Autotune Warning Messages

Warning Message Cause for Warning


EXPERIMENT TIME TOO This warning applies to the open loop method only. The experiment
LONG time was longer than necessary. Repeat the process identification
phase with a shorter experiment time.
RESET VALUE TOO This warning occurs when the reset value calculated during the
LARGE - MAXIMUM controller design phase was too large. When this occurs, the default
RESET USED AS maximum reset value of one per CCF scan of the loop is used so you
DEFAULT may continue.
THE EXPERIMENT IS This warning applies to the open loop method only. During the
NOT LONG ENOUGH process identification phase, the Autotune function checks to make
sure the experiment time is long enough to produce reasonable
results from the process data collected. If this check fails, either the
experiment time specified on the Autotune Display is too short or the
process is an integrating process which the open loop method cannot
handle.
THE RATIO OF This warning applies to the closed loop method only. The ratio of
PROCESS PEAK TO process oscillation magnitude to hysteresis value is too small for the
HYSTERESIS TOO best results to be obtained. Increment the output step size and rerun
SMALL the experiment.

Aborting Autotune Execution


You may terminate execution of Autotune at any time by selecting the ABORT
ATUNE softkey. This stops execution of the Autotune algorithm and places the
controller output in the Error mode specified on the Autotune Display.
Other conditions which cause termination of Autotune execution are as follows:
• Power failure.
• An Autotune error occurs. Refer to Table 43 for error information.
• A Computer mode request is made while the controller is in Identification
mode. This terminates execution of Autotune and places the controller in

660 3BUR002336R3701 RevA


Appendix D Autotune Data Base Parameters Of Autotune Function

Computer mode.
• You change the processing rate specified on the loop's Loop Definition Templet
while the controller is in Identification mode.
• You attempt to take control of the loop from a runtime display while the
controller is in Identification mode. This calls up the control targets at the
bottom of the display. The setpoint and output targets are not available, and the
only output mode options available are AUTO and MAN. The active mode is
in white. If neither option is in white (that is, they are both green) the controller
is in Identification mode and Autotune is running. Selection of either AUTO or
MAN from the control line terminates the Autotune algorithm and places the
controller output in the Error mode specified on the Autotune Display, not the
mode selected from the control line. The setpoint and output control targets
also return to the display. You can then take control of the loop and select the
desired output mode from the control line.

Data Base Parameters Of Autotune Function


Table 46 lists the parameters shown on the Autotune Display and their default
values. These parameters are described in detail in the paragraphs that follow.

Table 46. Default Entries for Parameters of Autotune Display

Parameter Defaults To
Active Process Gain, Reset, and Pre-act (ACTIVE) non-configurable
Autotune Phase (PHASE) I.D
Autotune Status (STATUS) NEW
Autotuning Method (METHD) CLSD
Calculated Process Gain, Reset, and Pre-act (CALC) 0.0
Completion Mode (CMPL MD) PREV
Controller Gain Limits (LO LIM and HI LIM) 0.0, 125.0
Controller Pre-act Limits (LO LIM and HI LIM) 0.0, 32.0

3BUR002336R3701 RevA 661


Data Base Parameters Of Autotune Function Appendix D Autotune

Table 46. Default Entries for Parameters of Autotune Display (Continued)

Parameter Defaults To
Controller Reset Limits (LO LIM and HI LIM) 0.0, 125.0
Controller Type (TYPE) PI
Error Mode (ERR MD) MAN
Estimated Process Deadtime (EST DT) 0
Estimated Process Gain (EST GN) 0.0
Estimated Process Lag (EST LAG) 0
Experiment Time (EXP TIM) 1
Gain Adjustment Factor (GN ADJ) 0.50
Hysteresis (HYST) 1.00
Output Pulse Size (PULSE) 10.0
Output Step Size (STEP) 10.0
Pulse Factor (FACT) 0.80
Reset Adjustment Factor (RST ADJ) 0.50
Ultimate Gain (PGu) 0.0
Ultimate Period (PTu) 0.0

Active Gain, Reset, and Pre-act (ACTIVE)


These are non-configurable fields showing the current process gain, reset, and pre-
act values from the data base as specified on the Loop Definition Templet.

Autotune Phase (PHASE)


This is a configurable field that specifies the Autotune phase (step) to execute. The
Autotune phases are either executed individually or automatically in sequence.
Valid entries are:

662 3BUR002336R3701 RevA


Appendix D Autotune Data Base Parameters Of Autotune Function

Code Phase Description


I Process Identifies the process parameters by conducting a
Identification response test.
D Controller Designs the controller tuning settings based on the
Design data from the process identification phase.
A Parameter The controller tuning settings from the controller
Activation design phase are copied into the control algorithm
and the controller is returned to on-line control in the
specified mode.
You must enter a valid entry for each phase you want to execute. Entries are
separated by periods. Do not put a period after the last letter in the entry.
The default Autotune phase is: I.D.
The following are the only valid command entry combinations:
I, D, A, I.D, D.A. I.D.A

Autotune Status (STATUS)


This is a non-configurable field that displays the status of the currently executing
Autotune algorithm as follows:
Code Status Description
NEW New Initial entry. Autotune experiment has never been
executed for this loop.
IDNT Process The process identification experiment is underway.
Identification
DSGN Controller The controller tuning parameters are being
Design calculated.
ACTV Parameter The Autotune algorithm is writing the controller
Activation tuning settings into the control algorithm.
CMPL Complete Execution of the Autotune function is complete.
ERR Error An error occurred during operation of the Autotune
function.

3BUR002336R3701 RevA 663


Data Base Parameters Of Autotune Function Appendix D Autotune

WARN Warning A warning occurred during Autotune.

Autotuning Method (METHD)


This is a configurable field that indicates whether the open or closed method used.
Valid entries are:
Method Description
OPEN Open loop method is used
CLSD Closed loop method is used
The default Autotuning method is: CLSD

Calculated Gain, Reset, and Pre-act (CALC)


These are configurable fields that identify the gain, reset, and pre-act values
calculated during the controller design phase. There values are either user-specified
or calculated based on the specified ultimate gain and period values for the closed
loop method or the estimated gain, lag, and deadtime values for the open loop
method. User-specified values are used in the parameter activation phase and the
corresponding active gain, reset, and pre-act values are changed to the specified
calculated value.
Valid entry for each of these fields is a floating point number. However, if you enter
a value outside of the corresponding controller gain, reset, or pre-act high or low
limits, the appropriate high or low limit is automatically used by the algorithm
instead.
The default value for the calculated gain, reset, and pre-act is: 0

Completion Mode (CMPL MD)


This is a configurable field that identifies which mode the control algorithm should
be put in after Autotune execution involving the process identification phase is
successfully complete.
Valid entries are:
Mode Description

664 3BUR002336R3701 RevA


Appendix D Autotune Data Base Parameters Of Autotune Function

MAN (Manual) Indicates the control algorithm should be put in


manual mode after the parameter activation phase
finishes transferring values into the control algorithm
data base.
AUTO (Automatic) Indicates the control algorithm should be put in
automatic mode after the parameter activation phase
finishes transferring values into the control algorithm
data base.
PREV (Previous) The meaning of PREV depends on whether or not the
control loop was placed in identification mode (result
is PREV in either case). The control algorithm is
placed in identification mode only if the process
identification phase is used. If the control loop was
placed in identification mode, the control algorithm is
put in the same mode it was in before identification
mode. If the control algorithm was not placed in
identification mode, then the control algorithm mode
is not changed.
The default Completion mode is: PREV (Previous)

Controller Gain Limits (HI LIM and LO LIM)


This is a configurable field that specifies the minimum (low limit) and maximum
(high limit) values for the controller gain value written to the control algorithm
during the parameter activation phase. Values for each limit are set between 0.0 and
125.0. If a limit is reached, an error is generated and none of the parameters in the
control algorithm are changed.
The default controller gain limits are:Low Limit 0.0
High Limit 125.0

Do not set the low limit at a value greater than the high limit value.

3BUR002336R3701 RevA 665


Data Base Parameters Of Autotune Function Appendix D Autotune

Controller Pre-act Limits (HI LIM and LO LIM)


This is a configurable field that specifies the minimum (low limit) and maximum
(high limit) values acceptable for the controller pre-act value written to the control
algorithm during the parameter activation phase. Values for each limit are set
between 0.0 and 32.0. If a limit is reached, an error is generated and none of the
parameters in the control algorithm are changed.
The default controller Pre-act limits are:Low Limit 0.0
High Limit 32.0

Do not set the low limit at a value greater than the high limit value.

Controller Reset Limits (HI LIM and LO LIM)


This is a configurable field that specifies the minimum (low limit) and maximum
(high limit) values acceptable for the controller reset value written to the control
algorithm during the parameter activation phase. Values for each limit are set
between 0.0 and 125.0. If a limit is reached, an error is generated and none of the
parameters in the control algorithm are changed.
The default controller reset limits are: Low Limit 0.0
High Limit 125.0

Do not set the low limit at a value greater than the high limit value.

Controller Type (TYPE)


This is a configurable field that specifies the type of control strategy the tuning
parameters are calculated for.
Valid entries are:
Type Description
PI The controller is configured with gain and reset responses.
PID The controller is configured with gain, reset, and pre-act responses.

666 3BUR002336R3701 RevA


Appendix D Autotune Data Base Parameters Of Autotune Function

DTC The controller algorithm is configured with deadtime compensator


control.
The default entry for the controller type is: PI

Error Mode (ERR MD)


This is a configurable field that identifies which mode the control algorithm should
be put in after an error or warning occurs during Autotune execution involving the
process identification phase.
Valid entries are:
Mode Description
MAN (Manual) Indicates the control algorithm should be put in manual mode
after an error occurs.
AUTO (Automatic) Indicates the control algorithm should be put in automatic
mode after an error occurs.
PREV (Previous) The meaning of PREV depends on whether or not the control
loop was placed in identification mode (either way the result
is PREV). The control algorithm is placed in identification
mode only if the process identification phase is included. If
the control loop was placed in identification mode, the
control algorithm is put in the same mode it was in before it
went into identification mode. If the control algorithm was
not placed in identification mode, then the control algorithm
mode is not changed.
The default error mode is: MAN (Manual)

Estimated Process Deadtime (EST DT)


This is a configurable field that specifies the estimated process deadtime the process
identification phase calculates as a result of the experiment run. It is the deadtime
value the controller design phase uses when it calculates the tuning parameters.
If you know the gain, period, and deadtime parameters, you can enter their values.
Autotune then uses these values to calculate the initial tuning parameters for the
loop.

3BUR002336R3701 RevA 667


Data Base Parameters Of Autotune Function Appendix D Autotune

Valid entries for the deadtime value are set between -9.999 and 9.999 with an
exponent between -9 and 9, however, only values between 0 and 125 minutes
produce reasonable results.
The default estimated deadtime is: 0

Estimated Process Gain (EST GN)


This is a configurable field that specifies the estimated process gain the process
identification phase calculates as a result of the experiment run. It is the gain value
the controller design phase uses when it calculates the tuning parameters.
If you know the gain, period, and deadtime parameters, you can enter their values.
The Autotune function then uses these values to calculate the initial tuning
parameters for the loop.
Valid entries for the gain value are set between -9.999 and 9.999 with an exponent
between -9 and 9, however, only values between 0.0 and 125.0 produce reasonable
results.
The default estimated gain is: 0.0

Estimated Process Lag (EST LAG)


This is a configurable field that specifies the estimated process lag the process
identification phase calculates as a result of the experiment run. It is the lag value
the controller design phase uses when it calculates the tuning parameters.
If you know the gain, period, and deadtime parameters, you can enter their values.
The Autotune function then uses these values to calculate the initial tuning
parameters for the loop.
Valid entries for the lag value are set between -9.999 and 9.999 with an exponent
between -9 and 9, however, only values between 0 and 125 minutes produce
reasonable results.
The default estimated process lag is: 0

Experiment Time (EXP TIM)


This is a configurable field that specifies the length of time Autotune collects data
during the process identification phase of an open loop experiment. The time should

668 3BUR002336R3701 RevA


Appendix D Autotune Data Base Parameters Of Autotune Function

be long enough so the process reaches its final value in response to output
manipulations by Autotune.
The Autotune algorithm looks at this parameter at the start of the process
identification phase.
Valid entries for the experiment time are set between 1 and 255 minutes.
The default experiment time is: 1 minute

Gain Adjustment Factor (GN ADJ)


This is a configurable field that specifies the gain adjustment factor used during the
design calculations. It is used to adjust the tuning from conservative to aggressive.
Valid entries for the adjustment factor are set between 0.00 and 1.00.
The default gain adjustment factor is: 0.50

Hysteresis (HYST)
This is a configurable field that specifies the hysteresis value used by the closed
loop Autotune algorithm. This value must be larger than the amount of noise present
in the process signal. If the hysteresis value is not larger than the noise, incorrect
results are obtained.
Valid entries for the hysteresis value are set between 0.00 and 50.0% of the span.
The default hysteresis value is: 1.00%

Output Pulse Size (PULSE)


This is a configurable field that specifies the size and direction of the output pulse
the Autotune algorithm uses in the reaction rate experiment during the open loop
process identification phase. The value should be large enough so it overcomes
value stiction and hysteresis, and the process reacts with a noticeable response and
does not exceed the process input range. The Autotune algorithm looks at this
parameter at the start of the process identification phase.
Valid entries for the output pulse size are set between -50 and 50.0%. A value of 0%
results in an error message and aborts the Autotune function.
The default output pulse size is: 10.0%

3BUR002336R3701 RevA 669


Data Base Parameters Of Autotune Function Appendix D Autotune

Output Step Size (STEP)


This is a configurable field that specifies the size of the output step the Autotune
algorithm uses during the closed loop process identification phase. The output
oscillates at the value it had prior to Autotune execution plus and minus this
amount. The value should be large enough to overcome valve stiction and
hysteresis, and the process reacts with a noticeable response several times larger
than the hysteresis setting entered.
Valid entries for the output step size are set between 0.00 and 50.0% of span.
The default output step size is: 10.0%

Pulse Factor (FACT)


This is a configurable field that specifies the size of the pulse factor which
determines the shape of the output pulse used during the process identification
phase of an open loop experiment. When the pulse factor is set at 0.00, the output
pulse is actually an output step. Typically, the pulse factor is set at 0.80 to minimize
the disturbance to the process caused by the process identification phase
experiment. If the process is noisy, better identification of the process is obtained if
the pulse factor is set at a lower value. The Autotune algorithm looks at this
parameter at the start of the process identification phase.
Valid entries for the pulse factor are set between 0.00 and 0.90.
The default pulse factor is: 0.80

Reset Adjustment Factor (RST ADJ)


This is a configurable field that specifies the value of the reset adjustment factor
used during the design calculations. It is used to adjust the tuning from conservative
to aggressive.
Valid entries for the reset adjustment factor are set between 0.00 and 1.00.
The default reset adjustment factor is: 0.50

670 3BUR002336R3701 RevA


Appendix D Autotune Data Base Parameters Of Autotune Function

Ultimate Gain Factor (PGu)


This is a configurable field that specifies the ultimate gain for the process calculated
by the process identification phase as a result of the experiment run. It is the gain
value the controller design phase uses when it calculates the tuning parameters.
If you know the gain, period, and deadtime parameters, you can enter their values.
The Autotune function then uses these values to calculate the initial tuning
parameters for the loop.
Valid entries for the fixed gain value are set between -9.999 and 9.999 with an
exponent between -9 and 9.
The default ultimate gain factor is: 0.0

Ultimate Period (PTu)


This is a configurable field that specifies the ultimate period for the process
calculated by the process identification phase as a result of the experiment run. It is
the period value the controller design phase uses when it calculates the tuning
parameters.
If you know the gain, period, and deadtime parameters, you can enter their values.
The Autotune function then uses these values to calculate the initial tuning
parameters for the loop.
Valid entries for the fixed period value are set between -9.999 and 9.999 with an
exponent between -9 and 9.
The default ultimate period is: 0.0

3BUR002336R3701 RevA 671


Data Base Parameters Of Autotune Function Appendix D Autotune

672 3BUR002336R3701 RevA


Appendix E Detecting Setpoint/Output
Limiting

What is Setpoint/Output Limiting


Setpoint/output limiting refers to the situation where a control algorithm
(Auto/Manual or PID) does not use the calculated setpoint or output value. For
instance, Output limiting occurs when the output is limited by the configured limits
or to avoid reset windup. Setpoint limiting occurs when the setpoint of a control
algorithm is normally being driven remotely by the output of another control
algorithm, but this normal value is being limited or not used.
You can use the control FCM’s ALG_NUM attribute to detect when that control
algorithm (or a connected control algorithm in a cascade control loop) is limiting its
setpoint or output. ALG_NUM can be presented in graphic displays built with
Display Builder and AdvaInform Display. It can also be referenced in application
programs such as TCL.

How ALG_NUM Works


ALG_NUM is an eight-bit signed integer variable (INTEGER for TCL
applications). Only the two lowest bits (b0 and b1) are used. The low bit (b0)
indicates setpoint/output limiting in the referenced control FCM. This bit is set
(value = 1) when the referenced control algorithm:
• limits its setpoint, or is already at its configured setpoint limit
• limits its calculated output value
If none of these conditions occur, b0 is cleared.
The higher bit (b1) is only used in cascade control applications. This means that
tracking (TRK) must be one of the allowed output modes. If TRK is an allowed

3BUR002336R3701 RevA 673


Using ALG_NUM in other Applications Appendix E Detecting Setpoint/Output Limiting

mode, then the high bit of the referenced control FCM is set (value = 2) when any
one of the following conditions occurs:
• the output in the referenced FCM is in TRACK mode. In this case, the output
of the referenced control FCM is being set by a signal from another control
FCM.
• the TRACK ACTIVATOR or TRACK INPUT attribute in the referenced
FCM points to an attribute in another control FCM (PID or Auto/Manual), and
either or both of the ALG_NUM bits in the second control FCM are set. This
means the setpoint or output in either the second control FCM, or another
control FCM in the cascade chain is being limited.
• the TRACK ACTIVATOR or TRACK INPUT attribute in the referenced
FCM is unavailable (bad data quality).
If none of the above conditions occur, b1 of the referenced control FCM is cleared.
The b0 and b1 bits in ALG_NUM are monitored whenever the control FCM is
running, In particular, b1 is calculated even if the output mode of the FCM is
Manual.
The ALG_NUM attribute for the Auto/Manual FCM operates in the same manner as
for the PID, except that local setpoint limiting does not apply to Auto/manual
FCMs.

Using ALG_NUM in other Applications


ALG_NUM can be presented in graphic displays built with Display Builder and
Display Services. It can also be referenced in application programs such as TCL.

674 3BUR002336R3701 RevA


Appendix E Detecting Setpoint/Output Limiting Using ALG_NUM in other Applications

ALG_NUM has four possible states as described in Table 47.

Table 47. ALG_NUM States

ALG_NUM b0 b1
Description
Value (lower bit) (higher bit)
0 clear clear All control FCMs are using their calculated output and
setpoint values.
1 set clear The output or setpoint in the referenced control FCM is
being limited. Limiting is not occurring in other control
FCMs in the cascade chain.
2 clear set The output or setpoint in the referenced control FCM is
not being limited. Limiting is occurring in at least one
other control FCM in the cascade chain.
3 set set Output or setpoint limiting is occurring in both the
referenced control FCM, and in at least one other control
FCM in the cascade chain.

This application of the ALG_NUM variable only applies to PID and


Auto/Manual FCMs. In other FCMs, ALG_NUM may have a
different function.

3BUR002336R3701 RevA 675


Using ALG_NUM in other Applications Appendix E Detecting Setpoint/Output Limiting

676 3BUR002336R3701 RevA


Contact us

ABB AB ABB Automation LLC


Control Technologies Control Technologies
Västerås, Sweden Abu Dhabi, United Arab Emirates
Phone: +46 (0) 21 32 50 00 Phone: +971 (0) 2 4938 000
e-mail: processautomation@se.abb.com e-mail: processautomation@ae.abb.com
www.abb.com/controlsystems

3BUR002336R3701 RevA
www.abb.com/controlsystems

ABB Automation GmbH ABB China Ltd


Control Technologies Control Technologies
Mannheim, Germany Beijing, China
Phone: +49 1805 26 67 76 Phone: +86 (0) 10 84566688-2193
e-mail: marketing.control-proucts@de.abb.com www.abb.com/controlsystems
www.abb.de/controlsystems

ABB S.P.A. Copyright © 2001-2014 by ABB.


Control Technologies All rights reserved.
Sesto San Giovanni (MI), Italy
Phone: +39 02 24147 555
e-mail: controlsystems@it.abb.com
www.abb.it/controlsystems

ABB Inc.
Control Technologies
Wickliffe, Ohio, USA
Phone: +1 440 585 8500
e-mail: industrialitsolutions@us.abb.com
www.abb.com/controlsystems

ABB Pte Ltd


Control Technologies
Singapore
Phone: +65 6776 5711
e-mail: processautomation@sg.abb.com
www.abb.com/controlsystems

Power and productivity


for a better worldTM

You might also like