You are on page 1of 578

I/A Series®

Integrated Control
Block Descriptions
for FOUNDATION
fieldbus Specific
Control Blocks

B0700EC

Rev B
September 20, 2010
Invensys, Foxboro, I/A Series, InFusion, and the Invensys Logo are trademarks of Invensys plc, its subsidiaries,
and affiliates.
All other brand names may be trademarks of their respective owners.

Copyright 2010 Invensys Systems, Inc.


All rights reserved

SOFTWARE LICENSE AND COPYRIGHT INFORMATION


Before using the Invensys Systems, Inc. supplied software supported by this documentation, you
should read and understand the following information concerning copyrighted software.
1. The license provisions in the software license for your system govern your obligations
and usage rights to the software described in this documentation. If any portion of
those license provisions is violated, Invensys Systems, Inc. will no longer provide you
with support services and assumes no further responsibilities for your system or its
operation.
2. All software issued by Invensys Systems, Inc. and copies of the software that you are
specifically permitted to make, are protected in accordance with Federal copyright
laws. It is illegal to make copies of any software media provided to you by
Invensys Systems, Inc. for any purpose other than those purposes mentioned in the
software license.
Contents
Preface................................................................................................................................. xiii

1. AI – Foundation™ fieldbus Analog Input ......................................................................... 1


1.1 Overview ............................................................................................................................. 1
1.2 Basic Operation .................................................................................................................. 1
1.3 Features ............................................................................................................................... 1
1.4 Block Parameters ................................................................................................................. 2
1.4.1 Parameter Definitions ................................................................................................. 5
1.5 Device Function Block Description .................................................................................. 20
1.5.1 Device Block Operation ............................................................................................ 21
1.5.1.1 Mode ................................................................................................................. 21
1.5.1.2 Simulation ......................................................................................................... 21
1.5.1.3 Conversion ........................................................................................................ 21
1.5.1.4 Cutoff ................................................................................................................ 21
1.5.1.5 Filter .................................................................................................................. 22
1.5.1.6 Alarms ............................................................................................................... 22
1.5.2 Parameter Transforms ............................................................................................... 22
1.6 AI Block Functions ........................................................................................................... 25
1.6.1 Device Function Block Connection ........................................................................... 25
1.6.2 Device Configuration Parameters .............................................................................. 25
1.6.3 Scaling ....................................................................................................................... 26
1.6.4 Block Validation ........................................................................................................ 27
1.6.5 Block Initialization .................................................................................................... 28
1.6.6 I/A Series Parameter Status ........................................................................................ 29
1.6.7 Device Parameter Status ............................................................................................ 29
1.6.8 Block Modes ............................................................................................................. 31
1.6.9 Block Alarming ......................................................................................................... 32
1.6.10 Block Error Processing ............................................................................................ 33
1.6.11 Configuration Error Processing ............................................................................... 33
1.6.12 Process Alarming ..................................................................................................... 33
1.6.13 Block Shutdown ...................................................................................................... 35
1.6.14 Simulation ............................................................................................................... 35
1.6.15 Block States ............................................................................................................. 36
1.7 AI Block Application Example .......................................................................................... 37

2. AO – Foundation™ fieldbus Analog Output .................................................................. 39


2.1 Overview ........................................................................................................................... 39
2.2 Basic Operation ................................................................................................................ 39
2.3 Features ............................................................................................................................. 40
2.4 Block Parameters ............................................................................................................... 40
2.4.1 Parameter Definitions ............................................................................................... 43
2.5 Device Function Block Description .................................................................................. 57

iii
B0700EC – Rev B Contents

2.5.1 Device Block Operation ............................................................................................ 57


2.5.1.1 Mode ................................................................................................................. 58
2.5.1.2 Setpoint ............................................................................................................. 58
2.5.1.3 Out Conversion ................................................................................................. 58
2.5.1.4 Output .............................................................................................................. 59
2.5.1.5 Simulation ......................................................................................................... 59
2.5.1.6 Fault State ......................................................................................................... 59
2.5.1.7 PV Conversion .................................................................................................. 59
2.5.2 AO Parameter Transforms ......................................................................................... 59
2.6 AO Block Functions ......................................................................................................... 65
2.6.1 Device Function Block Connection ........................................................................... 66
2.6.2 Device Configuration Parameters .............................................................................. 66
2.6.3 Scaling ....................................................................................................................... 67
2.6.4 Block Validation ........................................................................................................ 68
2.6.5 Block Initialization .................................................................................................... 69
2.6.6 Block Modes ............................................................................................................. 70
2.6.7 Input Connections .................................................................................................... 70
2.6.8 I/A Series Parameter Status ........................................................................................ 72
2.6.9 Device Parameter Status ............................................................................................ 72
2.6.10 Fault State Handling ............................................................................................... 75
2.6.11 Block Alarming ....................................................................................................... 76
2.6.12 Block Error Processing ............................................................................................ 77
2.6.13 Configuration Error Processing ............................................................................... 77
2.6.14 Bad Alarming .......................................................................................................... 77
2.6.15 Block Shutdown ...................................................................................................... 78
2.6.16 Simulation ............................................................................................................... 79
2.6.17 Block States ............................................................................................................. 79
2.7 AO Block Application Example ........................................................................................ 81

3. DI – Foundation™ fieldbus Discrete Input .................................................................... 83


3.1 Overview ........................................................................................................................... 83
3.2 Basic Operation ................................................................................................................ 83
3.3 Features ............................................................................................................................. 83
3.4 Block Parameters ............................................................................................................... 84
3.4.1 Parameter Definitions ............................................................................................... 86
3.5 Device Function Block Description .................................................................................. 99
3.5.1 Device Block Operation ............................................................................................ 99
3.5.1.1 Mode ................................................................................................................. 99
3.5.1.2 Simulation ....................................................................................................... 100
3.5.1.3 Conversion ...................................................................................................... 100
3.5.1.4 Filter ................................................................................................................ 100
3.5.1.5 Alarms ............................................................................................................. 100
3.5.2 DI Parameter Transforms ........................................................................................ 100
3.6 DI Block Operation ........................................................................................................ 103
3.6.1 Device Function Block Connection ......................................................................... 104
3.6.2 Device Configuration Parameters ............................................................................ 104
3.6.3 Block Validation ...................................................................................................... 105
3.6.4 Block Initialization .................................................................................................. 106
3.6.5 I/A Series Parameter Status ...................................................................................... 107

iv
Contents B0700EC – Rev B

3.6.6 Device Parameter Status .......................................................................................... 107


3.6.7 Block Modes ........................................................................................................... 109
3.6.8 Block Alarming ....................................................................................................... 110
3.6.9 Block Error Processing ............................................................................................ 111
3.6.10 Configuration Error Processing ............................................................................. 111
3.6.11 Process Alarming ................................................................................................... 111
3.6.12 Block Shutdown .................................................................................................... 113
3.6.13 Simulation ............................................................................................................. 113
3.6.14 Block States ........................................................................................................... 114
3.7 DI Block Application Example ........................................................................................ 115

4. DO – Foundation™ fieldbus Discrete Output.............................................................. 117


4.1 Overview ......................................................................................................................... 117
4.2 Basic Operation .............................................................................................................. 117
4.3 Features ........................................................................................................................... 118
4.4 Block Parameters ............................................................................................................. 118
4.4.1 Parameter Definitions ............................................................................................. 121
4.5 Device Function Block Description ................................................................................ 134
4.5.1 Device Block Operation .......................................................................................... 134
4.5.1.1 Mode ............................................................................................................... 135
4.5.1.2 Setpoint ........................................................................................................... 135
4.5.1.3 Out Conversion ............................................................................................... 135
4.5.1.4 Output ............................................................................................................ 135
4.5.1.5 Simulation ....................................................................................................... 136
4.5.1.6 Fault State ....................................................................................................... 136
4.5.1.7 PV_D Conversion ........................................................................................... 136
4.5.2 DO Parameter Transforms ...................................................................................... 136
4.6 DO Block Functions ....................................................................................................... 142
4.6.1 Device Function Block Connection ......................................................................... 142
4.6.2 Device Configuration Parameters ............................................................................ 143
4.6.3 Block Validation ...................................................................................................... 144
4.6.4 Block Initialization .................................................................................................. 145
4.6.5 Block Modes ........................................................................................................... 146
4.6.6 Input Connections .................................................................................................. 146
4.6.7 I/A Series Parameter Status ...................................................................................... 148
4.6.8 Device Parameter Status .......................................................................................... 148
4.6.9 Fault State Handling ............................................................................................... 150
4.6.10 Block Alarming ..................................................................................................... 152
4.6.11 Block Error Processing .......................................................................................... 152
4.6.12 Configuration Error Processing ............................................................................. 153
4.6.13 Bad Alarming ........................................................................................................ 153
4.6.14 Block Shutdown .................................................................................................... 154
4.6.15 Simulation ............................................................................................................. 155
4.6.16 Block States ........................................................................................................... 155
4.7 DO Block Application Example ...................................................................................... 156

5. MAI – Foundation™ fieldbus Multiple Analog Input................................................... 159


5.1 Overview ......................................................................................................................... 159

v
B0700EC – Rev B Contents

5.2 Basic Operation .............................................................................................................. 159


5.3 Features ........................................................................................................................... 160
5.4 Block Parameters ............................................................................................................. 160
5.4.1 Parameter Definitions ............................................................................................. 163
5.5 Device Function Block Description ................................................................................ 177
5.5.1 Device Block Operation .......................................................................................... 177
5.5.1.1 Mode ............................................................................................................... 177
5.5.1.2 Status ............................................................................................................... 178
5.5.1.3 Alarms ............................................................................................................. 178
5.5.1.4 Non-standard Parameters ................................................................................ 178
5.5.2 Parameter Transforms ............................................................................................. 178
5.6 MAI Block Functions ...................................................................................................... 181
5.6.1 Device Function Block Connection ......................................................................... 181
5.6.2 Device Configuration Parameters ............................................................................ 182
5.6.3 Block Validation ...................................................................................................... 182
5.6.4 Block Initialization .................................................................................................. 184
5.6.5 I/A Series Parameter Status ...................................................................................... 184
5.6.6 Device Parameter Status .......................................................................................... 185
5.6.7 Block Modes ........................................................................................................... 187
5.6.8 Block Alarming ....................................................................................................... 188
5.6.9 Block Error Processing ............................................................................................ 188
5.6.10 Configuration Error Processing ............................................................................. 189
5.6.11 Bad Alarm Detection ............................................................................................. 189
5.6.12 Block Shutdown .................................................................................................... 190
5.6.13 Simulation ............................................................................................................. 191
5.6.14 Block States ........................................................................................................... 191
5.7 MAI Block Application Example ..................................................................................... 193

6. MAO - Foundation™ fieldbus Multiple Analog Output............................................... 195


6.1 Overview ......................................................................................................................... 195
6.2 Basic Operation .............................................................................................................. 195
6.3 Features ........................................................................................................................... 196
6.4 Block Parameters ............................................................................................................. 196
6.4.1 Parameter Definitions ............................................................................................. 199
6.5 Device Function Block Description ................................................................................ 214
6.5.1 Device Block Operation .......................................................................................... 214
6.5.1.1 Mode ............................................................................................................... 215
6.5.1.2 Fault State ....................................................................................................... 215
6.5.2 Parameter Transforms ............................................................................................. 215
6.6 MAO Block Functions .................................................................................................... 217
6.6.1 Device Function Block Connection ......................................................................... 218
6.6.2 Device Configuration Parameters ............................................................................ 218
6.6.3 Block Validation ...................................................................................................... 219
6.6.4 Block Initialization .................................................................................................. 221
6.6.5 Block Modes ........................................................................................................... 221
6.6.6 I/A Series Parameter Status ...................................................................................... 222
6.6.7 Device Parameter Status .......................................................................................... 223
6.6.8 Time Stamping ....................................................................................................... 225

vi
Contents B0700EC – Rev B

6.6.9 Input Connections .................................................................................................. 225


6.6.10 Block Alarming ..................................................................................................... 226
6.6.11 Block Error Processing .......................................................................................... 227
6.6.12 Configuration Error Processing ............................................................................. 227
6.6.13 Bad Alarm Detection ............................................................................................. 227
6.6.14 Fault State Handling ............................................................................................. 228
6.6.15 Block Shutdown .................................................................................................... 230
6.6.16 Simulation ............................................................................................................. 231
6.6.17 Block States ........................................................................................................... 231
6.7 MAO Block Application Example ................................................................................... 233

7. MDI – Foundation™ fieldbus Multiple Discrete Input ................................................ 235


7.1 Overview ......................................................................................................................... 235
7.2 Basic Operation .............................................................................................................. 235
7.3 Features ........................................................................................................................... 235
7.4 Block Parameters ............................................................................................................. 236
7.4.1 Parameter Definitions ............................................................................................. 239
7.5 Device Function Block Description ................................................................................ 252
7.5.1 Device Block Operation .......................................................................................... 252
7.5.1.1 Mode ............................................................................................................... 252
7.5.1.2 Status ............................................................................................................... 253
7.5.1.3 Alarms ............................................................................................................. 253
7.5.1.4 Non-standard Parameters ................................................................................ 253
7.5.2 Parameter Transforms ............................................................................................. 253
7.6 MDI Block Functions ..................................................................................................... 255
7.6.1 Device Function Block Connection ......................................................................... 256
7.6.2 Device Configuration Parameters ............................................................................ 256
7.6.3 Block Validation ...................................................................................................... 257
7.6.4 Block Initialization .................................................................................................. 259
7.6.5 I/A Series Parameter Status ...................................................................................... 259
7.6.6 Device Parameter Status .......................................................................................... 259
7.6.7 Block Modes ........................................................................................................... 262
7.6.8 Block Alarming ....................................................................................................... 263
7.6.9 Block Error Processing ............................................................................................ 263
7.6.10 Configuration Error Processing ............................................................................. 264
7.6.11 Bad Alarm Detection ............................................................................................. 264
7.6.12 Block Shutdown .................................................................................................... 265
7.6.13 Simulation ............................................................................................................. 265
7.6.14 Block States ........................................................................................................... 266
7.7 MDI Block Application Example .................................................................................... 267

8. MDO - Foundation™ fieldbus Multiple Discrete Output ............................................ 269


8.1 Overview ......................................................................................................................... 269
8.2 Basic Operation .............................................................................................................. 269
8.3 Features ........................................................................................................................... 270
8.4 Block Parameters ............................................................................................................. 270
8.4.1 Parameter Definitions ............................................................................................. 273

vii
B0700EC – Rev B Contents

8.5 Device Function Block Description ................................................................................ 289


8.5.1 Device Block Operation .......................................................................................... 289
8.5.1.1 Mode ............................................................................................................... 289
8.5.1.2 Fault State ....................................................................................................... 289
8.5.2 Parameter Transforms ............................................................................................. 290
8.6 MDO Block Functions ................................................................................................... 292
8.6.1 Device Function Block Connection ......................................................................... 292
8.6.2 Device Configuration Parameters ............................................................................ 292
8.6.3 Block Validation ...................................................................................................... 293
8.6.4 Block Initialization .................................................................................................. 295
8.6.5 Block Modes ........................................................................................................... 295
8.6.6 I/A Series Parameter Status ...................................................................................... 296
8.6.7 Device Parameter Status .......................................................................................... 297
8.6.8 Time Stamping ....................................................................................................... 299
8.6.9 Input Connections .................................................................................................. 299
8.6.10 Block Alarming ..................................................................................................... 300
8.6.11 Block Error Processing .......................................................................................... 301
8.6.12 Configuration Error Processing ............................................................................. 301
8.6.13 Bad Alarm Detection ............................................................................................. 301
8.6.14 Fault State Handling ............................................................................................. 302
8.6.15 Block Shutdown .................................................................................................... 304
8.6.16 Simulation ............................................................................................................. 305
8.6.17 Block States ........................................................................................................... 305
8.7 MDO Block Application Example .................................................................................. 307

9. PIDFF – Foundation™ fieldbus PID Block .................................................................. 309


9.1 Overview ......................................................................................................................... 309
9.2 Basic Operation .............................................................................................................. 309
9.3 Features ........................................................................................................................... 309
9.4 Block Parameters ............................................................................................................. 310
9.4.1 Parameter Definitions ............................................................................................. 315
9.5 Device PID Function Block Description ......................................................................... 341
9.5.1 Device Block Operation .......................................................................................... 341
9.5.2 Parameter Transforms ............................................................................................. 342
9.6 PIDFF Block Functions .................................................................................................. 353
9.6.1 Device PID Function Block Connection ................................................................. 354
9.6.2 Device Configuration Parameters ............................................................................ 354
9.6.3 Scaling ..................................................................................................................... 355
9.6.4 Block Validation ...................................................................................................... 356
9.6.5 PIDFF Block Initialization ...................................................................................... 358
9.6.6 File Download/Upload ............................................................................................ 358
9.6.7 Block Mode ............................................................................................................. 358
9.6.8 Input Connections .................................................................................................. 360
9.6.9 I/A Series Parameter Status ...................................................................................... 361
9.7 Device Parameter Status .................................................................................................. 361
9.7.1 Fault State Handling ............................................................................................... 364
9.7.2 Alarms ..................................................................................................................... 365
9.7.3 Process Alarms ......................................................................................................... 365

viii
Contents B0700EC – Rev B

9.7.4 Block Error Processing ............................................................................................ 367


9.7.5 Configuration Error Processing ............................................................................... 368
9.7.6 Block Shutdown ...................................................................................................... 368
9.7.7 Simulation ............................................................................................................... 369
9.7.8 Secure Supervisory Control (SSC) ........................................................................... 370
9.7.9 Block States ............................................................................................................. 371
9.8 PIDFF Block Application Examples ................................................................................ 372

10. UNIVFF– Universal Foundation™ fieldbus Block...................................................... 379


10.1 Overview ....................................................................................................................... 379
10.2 Basic Operation ............................................................................................................ 379
10.3 Features ......................................................................................................................... 380
10.4 Block Parameters ........................................................................................................... 380
10.4.1 Parameter Definitions ........................................................................................... 382
10.4.2 Parameter Transforms ........................................................................................... 390
10.5 Block Operation ............................................................................................................ 392
10.5.1 View Data Updates ............................................................................................... 392
10.5.2 Block Validation .................................................................................................... 392
10.5.3 UNIVFF Block Initialization ................................................................................. 394
10.5.4 File Download/Upload .......................................................................................... 394
10.5.5 Block Modes ......................................................................................................... 395
10.5.6 Block Alarming ..................................................................................................... 395
10.5.7 Block Error Processing .......................................................................................... 396
10.5.8 Configuration Error Processing ............................................................................. 396
10.5.9 Block States ........................................................................................................... 396

Appendix A. Legacy AI – Foundation™ fieldbus Analog Input......................................... 399


A.1 Overview ........................................................................................................................ 399
A.2 Basic Operation .............................................................................................................. 399
A.3 Features .......................................................................................................................... 399
A.4 Block Parameters ............................................................................................................ 400
A.4.1 Parameter Definitions ............................................................................................. 402
A.5 Device Function Block Description ................................................................................ 416
A.5.1 Device Block Operation .......................................................................................... 416
A.5.1.1 Mode .............................................................................................................. 416
A.5.1.2 Simulation ...................................................................................................... 417
A.5.1.3 Conversion ...................................................................................................... 417
A.5.1.4 Cutoff ............................................................................................................. 417
A.5.1.5 Filter ............................................................................................................... 417
A.5.1.6 Alarms ............................................................................................................. 417
A.5.2 Parameter Transforms ............................................................................................. 417
A.6 AI Block Functions ......................................................................................................... 420
A.6.1 Device Function Block Connection ........................................................................ 421
A.6.2 Device Configuration Parameters ............................................................................ 421
A.6.3 Scaling .................................................................................................................... 422
A.6.4 Block Status ............................................................................................................ 422
A.6.5 Mode Machine ....................................................................................................... 425

ix
B0700EC – Rev B Contents

A.6.6 Alarms .................................................................................................................... 425


A.6.7 Simulation .............................................................................................................. 426

Appendix B. Legacy AO – Foundation™ fieldbus Analog Output .................................... 427


B.1 Overview ........................................................................................................................ 427
B.2 Basic Operation .............................................................................................................. 427
B.3 Features .......................................................................................................................... 427
B.4 Block Parameters ............................................................................................................ 428
B.4.1 Parameter Definitions ............................................................................................. 431
B.5 Device Function Block Description ................................................................................ 443
B.5.1 Device Block Operation .......................................................................................... 443
B.5.1.1 Mode .............................................................................................................. 444
B.5.1.2 Setpoint .......................................................................................................... 444
B.5.1.3 Out Conversion .............................................................................................. 444
B.5.1.4 Output ............................................................................................................ 445
B.5.1.5 Simulation ...................................................................................................... 445
B.5.1.6 Fault State ....................................................................................................... 445
B.5.1.7 PV Conversion ................................................................................................ 445
B.5.2 AO Parameter Transforms ...................................................................................... 445
B.6 AO Block Functions ....................................................................................................... 451
B.6.1 Device Function Block Connection ........................................................................ 451
B.6.2 Device Configuration Parameters ............................................................................ 451
B.6.3 Scaling .................................................................................................................... 453
B.6.4 Mode Machine ....................................................................................................... 453
B.6.5 Block Status ............................................................................................................ 454
B.6.6 Fault State Handling ............................................................................................... 456
B.6.7 Alarms .................................................................................................................... 457
B.6.8 Simulation .............................................................................................................. 457

Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input ...................................... 459


C.1 Overview ........................................................................................................................ 459
C.2 Basic Operation .............................................................................................................. 459
C.3 Features .......................................................................................................................... 459
C.4 Block Parameters ............................................................................................................ 460
C.4.1 Parameter Definitions ............................................................................................. 462
C.5 Device Function Block Description ................................................................................ 473
C.5.1 Device Block Operation ......................................................................................... 473
C.5.1.1 Mode .............................................................................................................. 473
C.5.1.2 Simulation ...................................................................................................... 474
C.5.1.3 Conversion ..................................................................................................... 474
C.5.1.4 Filter ............................................................................................................... 474
C.5.1.5 Alarms ............................................................................................................ 474
C.5.2 DI Parameter Transforms ....................................................................................... 474
C.6 DI Block Operation ....................................................................................................... 477
C.6.1 Device Function Block Connection ........................................................................ 478
C.6.2 Device Configuration Parameters ........................................................................... 478
C.6.3 Block Status ............................................................................................................ 479

x
Contents B0700EC – Rev B

C.6.4 Mode Machine ....................................................................................................... 481


C.6.5 Alarms .................................................................................................................... 482
C.6.6 Simulation .............................................................................................................. 482

Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output ................................. 483


D.1 Overview ........................................................................................................................ 483
D.2 Basic Operation ............................................................................................................. 483
D.3 Features .......................................................................................................................... 483
D.4 Block Parameters ............................................................................................................ 484
D.4.1 Parameter Definitions ............................................................................................ 486
D.5 Device Function Block Description ............................................................................... 498
D.5.1 Device Block Operation ......................................................................................... 498
D.5.1.1 Mode .............................................................................................................. 499
D.5.1.2 Setpoint .......................................................................................................... 499
D.5.1.3 Out Conversion ............................................................................................. 499
D.5.1.4 Output ........................................................................................................... 499
D.5.1.5 Simulation ...................................................................................................... 500
D.5.1.6 Fault State ...................................................................................................... 500
D.5.1.7 PV_D Conversion .......................................................................................... 500
D.5.2 DO Parameter Transforms ..................................................................................... 500
D.6 DO Block Functions ...................................................................................................... 505
D.6.1 Device Function Block Connection ....................................................................... 506
D.6.2 Device Configuration Parameters ........................................................................... 506
D.6.3 Mode Machine ....................................................................................................... 507
D.6.4 Block Status ........................................................................................................... 508
D.6.5 Fault State Handling .............................................................................................. 511
D.6.6 Alarms .................................................................................................................... 512
D.6.7 Simulation ............................................................................................................. 512

Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input....................... 513


E.1 Overview ........................................................................................................................ 513
E.2 Basic Operation .............................................................................................................. 513
E.3 Features .......................................................................................................................... 513
E.4 Block Parameters ............................................................................................................ 514
E.4.1 Parameter Definitions ............................................................................................. 516
E.5 Device Function Block Description ................................................................................ 528
E.5.1 Device Block Operation .......................................................................................... 529
E.5.1.1 Mode .............................................................................................................. 529
E.5.1.2 Status .............................................................................................................. 529
E.5.1.3 Alarms ............................................................................................................. 529
E.5.1.4 Non-standard Parameters ................................................................................ 530
E.5.1.5 Parameter Transforms ..................................................................................... 530
E.6 MAI Block Functions ..................................................................................................... 532
E.6.1 Device Function Block Connection ........................................................................ 533
E.6.2 Device Configuration Parameters ............................................................................ 533
E.6.3 Block Status ............................................................................................................ 534
E.6.4 Mode Machine ........................................................................................................ 535

xi
B0700EC – Rev B Contents

E.6.5 Alarms .................................................................................................................... 536


E.6.6 Simulation .............................................................................................................. 536

Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output .................. 537
F.1 Overview ......................................................................................................................... 537
F.2 Basic Operation .............................................................................................................. 537
F.3 Features ........................................................................................................................... 537
F.4 Block Parameters ............................................................................................................. 538
F.4.1 Parameter Definitions ............................................................................................. 541
F.5 Device Function Block Description ................................................................................ 555
F.5.1 Device Block Operation .......................................................................................... 555
F.5.1.1 Mode ............................................................................................................... 555
F.5.1.2 Fault State ....................................................................................................... 555
F.5.2 Parameter Transforms ............................................................................................. 556
F.6 MAO Block Functions .................................................................................................... 558
F.6.1 Device Function Block Connection ........................................................................ 558
F.6.2 Device Configuration Parameters ............................................................................ 559
F.6.3 Mode Machine ........................................................................................................ 559
F.6.4 Block Status ............................................................................................................ 560
F.6.5 Fault State Handling ............................................................................................... 561
F.6.6 Alarms ..................................................................................................................... 562
F.6.7 Simulation .............................................................................................................. 562

xii
Preface
This document provides information using a set of FOUNDATION fieldbus specific I/A Series®
blocks to configure resource, transducer, and function blocks in FOUNDATION fieldbus H1
devices.

What You Should Know


Prior to using this book, you should be generally familiar with the I/A Series system. Detailed
information relating to the various I/A Series software and hardware elements is found in the ref-
erence documents listed below. You should also be familiar with the field device’s protocol that
you intend to interface to an I/A Series system.

Revision Information
The blocks described in this document are supported by I/A Series software V8.5 (or later) and
InFusion Engineering Environment software (IEE), V2.0 with Field Device Manager for FOUN-
DATION fieldbus.
Four blocks are new with I/A Series system software V8.5:
MDI
MDO
PIDFF
UNIVFF
As well, additional changes have been made to the other FOUNDATION fieldbus specific I/A Series
blocks (AI, AO, DI, DO, MAI and MAO) for I/A Series system software V8.5. The previous
versions of these blocks (applicable to I/A Series systems with v8.4.3 or earlier software) are
detailed in the appendices of this document.

For this revision of the document (B0700EC-B), the following change was made.
Chapter 9 “PIDFF – Foundation™ fieldbus PID Block”
♦ Updated Bit 26 in Table 9-10. STATUS_OPTS Parameter Format.

Reference Documents
In addition to the information presented in this document, you should be familiar with the fol-
lowing I/A Series and InFusion Enterprise Control System documents:
♦ Implementing FOUNDATION fieldbus in InFusion 2.0 (B0750DA)
♦ Control Processor 270 (CP270) Integrated Control Software Concepts (B0700AG)
Refer to the following Fieldbus Foundation documents for information on device functions
blocks:
♦ AG-181, System Engineering Guidelines

xiii
B0700EC – Rev B Preface

♦ FD-043, Technical Overview, FOUNDATION fieldbus


♦ FF-890, Function Block Application Process - Part 1
♦ FF-891, Function Block Application Process - Part 2
♦ FF-892, Function Block Application Process - Part 3

xiv
1. AI – FOUNDATION™ fieldbus
Analog Input
This chapter describes the I/A Series Analog Input (AI) block, which interfaces the control
system with a corresponding analog input function block operating in a FOUNDATION™
fieldbus H1 device.

1.1 Overview
Analog Input (AI) is a Distributed Control Interface (DCI) block that provides an interface
between the control processor and an analog input function block operating in a FOUNDATION
fieldbus H1 device (the device function block). The AI block is supported on the FCP270 and
ZCP270 when the H1 device is connected to the control station by an FBM228. The AI block
is configured using the Block Configurator in the InFusion Engineering Environment (IEE) as
described in InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion
2.0 (B0750DA).

NOTE
The AI block functionality described in this chapter is applicable only for FBM228s
with the software type (SWTYPE) of “128”. For a description of the legacy AI block
functionality (I/A Series systems v8.4.3 or earlier) where FBM228s have the
SWTYPE of “228”, refer to Appendix A “Legacy AI – Foundation™ fieldbus Ana-
log Input”.

1.2 Basic Operation


The AI block integrates the corresponding device function block into the I/A Series system. On
initialization, user-configured values in the AI block are written to the standard configurable
parameters in the corresponding device function block. During normal operation, the AI block
maintains a publisher/subscriber connection with the device function block to read the value and
status of the device block’s primary output (OUT1). In addition, the AI block provides access to a
variety of operational and diagnostic information via client/server connections with the parame-
ters that are included in the views of the device block. The values read from these parameters are
displayed in the block detail displays and are available for connection to other I/A Series blocks.

1.3 Features
The AI block provides the following features:
♦ Acquires the device analog input function block’s primary output value and status

1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

1
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

♦ Time stamps value and status changes to the block’s output


♦ Accesses the parameters in the device function block’s views using change-driven and
periodic client/server connections
♦ Ensures that changes in the device block’s process values and error conditions are con-
tinuously available for display and connection to the control strategy
♦ Provides for the configuration of device block parameters from the I/A Series system
and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Auto, Manual or Out of
Service
♦ Provides detection and reporting for bad I/O, high and low absolute, and high-high
and low-low alarming
♦ Supports simulation of device block output within the control station

1.4 Block Parameters


Table 1-1 lists the block parameters. See Table 1-11 for mappings between the AI block parame-
ters and their device function block equivalents.

Table 1-1. AI Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 109 109 (AI)
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 9
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0, 1
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path
name <= 25
chars or ECB
block name <=
12 chars
CHANNL channel integer no-con/no-set 1 0 to 32767
DDITEM DD item long no-con/no-set 0x800201D0
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000 0 to 2147483647
STRATG strategy integer no-con/no-set 999 0 to 65535
STOPTS status options packed b no-con/no-set 0x1080 0 to 0xFFFF
IOOPTS I/O options packed bool- no-con/no-set 0x00 0 to 0xFF
ean
PVFTIM PV filter time real no-con/no-set 2.0
LOWCUT low cutoff real no-con/no-set 0.0
L_TYPE linearization type short integer no-con/no-set 1 1 to 3
HSCI1 input high scale real no-con/no-set 100.0 > LSCI1
LSCI1 input low scale real no-con/no-set 0.0 < HSCI1

2
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

Table 1-1. AI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DPTI1 input decimal point integer no-con/no-set 0 0 to 10
EI1 engineering units string no-con/no-set % 1 to 32 chars
EUI1 input eng units index integer no-con/no-set 0 0 to 32767
HSCO1 output high scale real no-con/no-set 100.0 > LSCO1
LSCO1 output low scale real no-con/no-set 0 < HSCO1
DPTO1 output decimal point integer no-con/no-set 0 0 to 10
EO1 eng units, output 1 string no-con/no-set % 1 to 32 chars
EUO1 eng units index integer no-con/no-set 0 0 to 32767
MODE_N normal mode short integer no-con/no-set 0x10 0 to 0xFF
MODE_P permitted mode short integer no-con/no-set 0x19 0 to 0xFF
MODE_T target mode short integer con/no-set 0x10 0 to 0xFF
MEAS simulation input real con/set 0.0
INHOPT inhibit option short integer no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short con/no-set 1 1 to 8
BADOPT bad alarm option boolean no-con/no-set 0 0 to 1
BADGRP bad alarm group short integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 1 to 32 chars
OUTDSC output descriptor string con/no-set blank 1 to 32 chars
HHIOPT high-high low-low alarm options short integer con/no-set 0 0 to 3
HHIGRP high-high low-low alarm group short integer con/no-set 1 1 to 8
HHIPRI high-high low-low alarm priority integer con/no-set 5 1 to 5
ALMHYS alarm hysteresis real con/no-set 2.0
HHILIM high-high alarm limit real con/set 100.0 >=LLOLIM
LLOLIM low-low alarm limit real con/set 0.0 <=HHILIM
HHITXT high-high alarm text string con/no-set blank 1 to 32 chars
LLOTXT low-low alarm text string con/no-set blank 1 to 32 chars
HLOPT high-low alarm option short integer con/no-set 0 0 to 3
HLGRP high-low alarm group short integer con/no-set 1 1 to 8
HLPRI high-low alarm priority Integer con/no-set 5 1 to 5
HILIM high alarm limit real con/set 100.0 >=LOLIM
LOLIM low alarm limit real con/set 0.0 <=HILIM
HITXT high alarm text string con/no-set blank 1 to 32 chars
LOTXT low alarm text string con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration interval integer no-con/set 0 0 to 32767
NASTDB nuisance alarm suppression long integer no-con/set 0 0 to 2147483647
deadband
NASOPT nuisance alarm suppression boolean no-con/set 0 0 to 1
option
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to 2147483647
DVC_ID device ID integer no-con/no-set 0 0 to 0xFFFF
DVCREV device revision long integer no-con/no-set 0 0 to 2147483647

3
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

Table 1-1. AI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


BLKNDX block index long integer no-con/no-set 0 0 to 2147483647
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to
0xFFFFFFFF
AUT_SW auto switch boolean con/no-set 0 0 to 1
BLKERR block error packed bool- con/no-set 0 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0 to
0xFFFFFFFF
CRIT criticality integer con/no-set 1 1 to 5
INHSTA inhibit status packed long con/no-set 0 0 to
0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode integer con/no-set 0 to 0xFF
OOS_SW out of service switch boolean con/set 0 0 to 1
OUT output real con/set 0.0
(settable only
in Manual)
OUTSTS output status packed bool- con/no-set 0 to 0xFFFF
ean
PRTYPE priority type integer con/no-set 0 0, 1, 2, 3, 4, 8
PV process variable real con/no-set 0.0
PVSTS process variable status packed bool- con/no-set 0 0 to 0xFF
ean
TSTAMP time stamp long integer con/no-set 0 ms after mid-
night
UNACK unacknowledged boolean con/set 0 0, 1
BSTATE block state integer con/no-set 0 0 to 11
DEVACK device acknowledge boolean con/set 0 0, 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to
0xFFFFFFFF
FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for each
(array element
1x255)
FDATA2 file data bytes 256 to 510 short integer no-con/no-set all 0s 0 to 255 for each
(array element
1x255)
CFGERR configuration error short no-con/no-set
DEFINE no config errors boolean no-con/no-set 1 ---
DESCRP descriptor string no-con/no-set blank 1 to 32 chars

4
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

Table 1-1. AI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 8 to 13 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
RI1 input range real no-con/no-set 100.0, 0.0,
0.0
RO1 output range real no-con/no-set 100.0, 0.0,
0.0
ST_REV status revision integer no-con/no-set 2 blanks 0 to 65535

1.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a set-
table parameter is changed externally. It wraps around from 32767 to
–32768.

ALMHYS Alarm Hysteresis is a configurable, non-settable real parameter that speci-


fies the hysteresis to be used in the Absolute Alarming and
High-High/Low-Low Alarming logic performed in an AI block. It is
equivalent to the ALARM_HYS parameter in a device AI function block
and is used to calculate the alarm dead band as follows:
Alarm dead band = ALMHYS * (HSCO1 – LSCO1) /100.0

ALMOPT Alarm Options contain packed long values representing the alarm types
that have been configured as options in the block, and the alarm groups
that are in use. Table 1-2 shows how the parameter is used by the AI
block.

Table 1-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
16 Low Absolute Alarm Configured
17 High Absolute Alarm Configured
22 Bad I/O Alarm Configured

5
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

Table 1-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
24 Low-Low Absolute Alarm Configured
25 High-High Absolute Alarm Configured
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table 1-3 shows the bits used by the AI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9

HMA
HHA

CRIT PRTYPE
BAD

LMA
LLA
INH

Table 1-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE on page 336 for values used
in this block
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
16 LMA Low Absolute Alarm ALMSTA.B16
17 HMA High Absolute Alarm ALMSTA.B15
22 BAD Bad I/O Alarm ALMSTA.B10
24 LLA Low-Low Absolute Alarm ALMSTA.B8
25 HHA High-High Absolute Alarm ALMSTA.B7
29 INH Inhibit Alarm. This bit is set when ALMSTA.B3
any of the block’s alarms is inhibited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

6
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and thus MODE_BLK.Target in the associated device function
block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the AI block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the AI
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block. Table 1-4
shows the parameter format.

Table 1-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

7
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device function block represented by the AI block. It is set by
the configurator and the FBM uses it to identify the block in the device.

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 1-5 shows how the bits are used by the AI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DEVACK B9

FDFAIL
FDACT
FDMM
FDOK

UDEF

FBM

TRK
LCK

FFX

BIO
MA
ON

LO
FS

Table 1-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block’s mode is BLKSTA.B29
Local Override
6 TRK The block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual mode
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
11 MA The device block mode is Auto BLKSTA.B21
12 BIO Bad I/O BLKSTA.B20
14 UDEF Block is undefined BLKSTA.B18
15 ON The compound that contains the block BLKSTA.B17
is ON
16 FFX Enhanced FF block connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FBM228 The device’s host FBM is an FBM228 BLKSTA.B13
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK FDATA installed BLKSTA.B11
22 FDMM FDATA mismatch BLKSTA.B10
23 DEVACK Unacknowledged device alarm BLKSTA.B9
24 FS Fault State has been asserted in the BLKSTA.B8
device function block
*Bit 0 is the least significant, low order bit.

8
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the device function block connection as determined by
the FBM228. The following values are used to indicate the current DCI
block state:
0 = Undefined state
1 = Unconnected
2 = Connecting
3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON LINE
11 = Block ON LINE with error - Processing has been completed, but
some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 36.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the AI block becomes undefined due to a
“W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID parameter of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 11 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.

9
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

♦ To return DEFINE to a True value, correct all configuration errors


and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-configurable, non-connectable, non-settable ASCII


string of up to 32 characters used to specify a description for the AI block.
The block value is copied from the TAGDSC parameter.

DEVACK Device Acknowledge is a settable boolean output parameter that is used by


an operator to acknowledge device alarms in the device function block.
DEVACK is set by the CP270 when a device alarm is reported by the
FBM228 at either the ECB201 level or at the DCI block level. DEVACK
is cleared by operator action. The range is 0 to 1:
0 = Device Alarm is acknowledged.
1 = Device Alarm is unacknowledged.
DEVACK is different from UNACK. UNACK is used by the operator to
acknowledge process alarms in the DCI block. DEVACK is used to
acknowledge device alarms at the ECB201 or DCI block level.

NOTE
This parameter is not supported currently.

DPTI1 Input Decimal Point is a configurable, downloadable, non-settable short


integer used to specify the XD_SCALE.decimal parameter of the associated
device function block. The range is 0 to 10.

DPTO1 Output Decimal Point is a configurable, downloadable, non-settable short


integer used to specify the OUT_SCALE.decimal parameter of a device
function block. The range is 0 to 10.

DVC_ID Device Identifier is a configurable, non-settable integer that provides the


Device Identifier of the H1 field device that contains the device function
block represented by the AI block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device.

DVCREV Device Revision is a configurable, non-settable long integer that provides


the Revision level of the H1 field device that contains the device function
block represented by the AI block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device. The IEE
configurator encodes the following data in DVCREV:
Bits 16-23 Bits 8-15 Bits 0-7
Device revision Minimum Device Description Common File Format
(DD) File Revision (CFF) File Revision

10
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

EI1 Engineering Units Input 1 provides the engineering units text for the
MEAS parameter in the AI block. The value configured for this text string
should be consistent with the values used for HSCI1 and LSCI1. This
parameter does not configure units in the device block; see EUI1.

EO1 Engineering Units for Output 1 specifies the engineering units text for the
OUT parameter in an AI block. The value configured for this text string
should be consistent with the values used for HSCO1 and LSCO1. This
parameter does not configure units in the device block; see EUO1.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table 1-6 list the possible values of ERCODE for the AI block.

Table 1-6. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION
W44 - INVALID ENGINEERING RANGE
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in the AI block. The range is 1 (default) to 8.

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)

11
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

generate an alarm message. The parameter has the same format as


BLKERR (Table 1-4).

EUI1 Input Engineering Units Index is a configurable, downloadable, non-set-


table integer used to specify the XD_SCALE.Units Index parameter of the
device function block.

EUO1 Output Engineering Units Index is a configurable, downloadable, non-


settable integer used to specify the OUT_SCALE.Units Index parameter of
the device function block.

FDATA1 File Data #1 and File Data #2 are settable multi-byte arrays that provide
FDATA2 configuration data for the device block represented by the AI block.
This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 510 bytes.

HHIGRP High-High Low-Low Alarm Group is a configurable, non-settable short


integer used to specify the alarm group assigned to High-High and Low-
Low Alarms in the AI block. The range is 1 (default) to 8.

HHILIM High-High Alarm Limit is a configurable, settable real input used to spec-
ify the high limit value to be used in the High-High Alarm detection logic
in the AI block. It is equivalent to the HI_HI_LIM parameter in a device
function block; however, HHILIM does not set the device block parame-
ter.

HHIOPT High-High Low-Low Alarm Option is a configurable, non-settable short


integer used to enable/disable High-High and Low-Low Alarm detection
in the AI block. Valid settings are:
♦ 0 = Disable High-High and Low-Low Alarming
♦ 1 = Enable High-High and Low-Low Alarming
♦ 2 = Enable High-High Alarming only
♦ 3 = Enable Low-Low Alarming only.

HHIPRI High-High Low-Low Priority is a configurable, settable integer input used


to specify the alarm priority to be assigned to High-High and Low-Low
Alarms in the AI block. The range is 1 (the highest) to 5 (default).

HHITXT High-High Alarm Text is a configurable, non-settable ASCII string of up


to 32 characters that describes the High-High Alarm. HHITXT is
included in the High-High Alarm message created when the alarm
condition occurs.

HILIM High Alarm Limit is a configurable, settable real input used to specify the
high limit value to be used in Absolute Alarm detection logic in an AI

12
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

block. It is equivalent to the HI_LIM parameter in a device function


block; however, HILIM does not set the device block parameter.

HITXT High Alarm Text is a configurable, non-settable ASCII string of up to


32 characters that describes the High Absolute Alarm in the AI block.
HITXT is included in the High Alarm message created when the alarm
condition occurs.

HLGRP High Low Alarm Group is a configurable, non-settable short integer used
to specify the alarm group assigned to High Low Absolute Alarms in the
AI block. The range is 1 (default) to 8.

HLOPT High Low Alarm Option is a configurable, non-settable short integer used
to enable or disable High and Low Absolute Alarm detection in an AI
block. Valid settings are:
♦ 0 = Disable High and Low Absolute Alarming
♦ 1 = Enable High and Low Absolute Alarming
♦ 2 = Enable High Absolute Alarming only
♦ 3 = Enable Low Absolute Alarming only.

HLPRI High Low Alarm Priority is a configurable, settable integer input used to
specify the alarm priority to be assigned to High Low Absolute Alarms in
the AI block. The range is 1 (highest) to 5 (default).

HSCI1 Input High Scale specifies the XD_SCALE.EU@100 parameter value of


the associated device function block.

HSCO1 Output High Scale specifies the OUT_SCALE.EU@100 parameter value


of the associated device function block.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm
generation inhibit requests for each type of alarm configured in the block.
Table 1-7 shows how the bits are used by the AI block.

Table 1-7. INHALM Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 15) When True (B16 to B1)
0 Inhibit Low Absolute Alarm INHALM.B16
1 Inhibit High Absolute Alarm INHALM.B15
6 Inhibit Bad I/O Alarm INHALM.B10
8 Inhibit Low-Low Absolute Alarm INHALM.B8
9 Inhibit High-High Absolute Alarm INHALM.B7
*Bit 0 is the least significant, low order bit.
There are no mnemonic names for the individual bits of INHALM.

13
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table 1-8 shows
how the parameter is used with the AI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
BAD B10
B11
B12
B13
B14
HMA B15
LMA B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
HHA B7
LLA B8
B9

Table 1-8. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
16 LMA Low Absolute Alarm Inhibited INHSTA.B16
17 HMA High Absolute Alarm Inhibited INHSTA.B15
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
24 LLA Low-Low Absolute Alarm Inhibited INHSTA.B8
25 HHA High-High Absolute Alarm Inhibited INHSTA.B7
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:

14
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up
to 25 characters (12 for <local_compound_name>, 1 for the
colon, and 12 for the <ecb_name>).

IOOPTS I/O Options is a configurable, downloadable, non-settable, packed


Boolean used to specify the IO_OPTS parameter of the associated device
function block (see Section 1.5.1.4). Table 1-9 shows how the bits are
used by the AI block.

Table 1-9. IOOPTS Parameter Format

Bit
Number* Description, When True
5 Low-cutoff
*Bit 0 is the least significant, low order bit.

L_TYPE Linearization Type is a configurable, downloadable, short integer used


to specify the L_TYPE parameter of the associated device function block:
1 = The value is used directly.
2 = The value field is converted linearly.
3 = The value is converted with the square root.
See Section 1.5.1.3 for further details.

LLOLIM Low-Low Alarm Limit is a configurable, settable real input used to specify
the low limit value to be used in the Low-Low Alarm detection logic in
the AI block. It is equivalent to the LO_LO_LIM parameter in a device
function block; however, LLOLIM does not set the device block
parameter.

LLOTXT Low-Low Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used to describe the Low-Low Alarm in the AI block.
LLOTXT is included in the Low-Low Alarm message created when the
alarm condition occurs.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has the

15
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

format LETTERBUG:DEVNAME, where LETTERBUG is the 6-char-


acter letterbug of the workstation and DEVNAME is the 1- to 6-character
logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOLIM Low Alarm Limit is a configurable, settable real input used to specify the
low limit value to be used in Absolute Alarm detection logic in an AI
block. It is equivalent to the LO_LIM parameter in a device function
block; however, LOLIM does not set the device function block parameter.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block.

LOTXT Low Alarm Text is a configurable, non-settable ASCII string of up to


32 characters that describes the Low Absolute Alarm in the AI block.
LOTXT is included in the Low Alarm message created when the alarm
condition occurs.

LOWCUT Low Cutoff is a configurable, downloadable, non-settable real value used


to specify the LOW_CUT parameter of the associated device function
block. See Section 1.5.1.4.

LSCI1 Input Low Scale specifies the XD_SCALE.EU@0 parameter value of the
device function block.

LSCO1 Output Low Scale specifies the OUT_SCALE.EU@0 parameter value of a


device function block.

MAN_ID Manufacturer Identifier is a configurable, non-settable long integer that


provides the Manufacturer Identifier of the H1 field device that contains
the device function block represented by the AI block. The FBM228
checks the corresponding value in the device resource block to verify that
there is a match between the block and the device.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the associated device function block,
to Manual.

16
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

MEAS Measurement is a value used as the input to the AI block when simulation
is active (SIMOPT = 1) instead of the OUT parameter (and the OUT
parameter in the associated device function block).

MODE_A Actual mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device func-
tion block.

MODE_N Normal mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Normal parameter of the associated
device function block.

MODE_P Permitted mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target mode is a configurable, downloadable, short integer output that


contains the MODE_BLK.Target parameter of the associated device func-
tion block. MODE_T is not directly settable. The AUT_SW, MAN_SW,
and OOS_SW are used to change the MODE_T parameter and thus the
MODE_BLK.Target parameter in the device function block.

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the AI block is initialized,
the block updates the configurable parameters of the function block
matched to the AI block by the configured index (BLKNDX). The
NAME parameter is used to set the Block Tag of the device function
block.

NASOPT Nuisance Alarm Suppression Alarm Option is a configurable, settable


boolean parameter that specifies whether the nuisance alarm delay speci-
fied in NASTDB is implemented by delaying the return to normal
(NASOPT=0) or by delaying alarm detection (NASOPT=1).

NASTDB Nuisance Alarm Suppression Time Deadband is used to reduce the


number of alarm messages generated when a block parameter crosses back
and forth over an alarm limit. When the parameter is set to zero, an alarm
is generated each time the parameter is outside the limit and is cleared
each time it crosses back. Thus, a parameter that is fluttering at the alarm
limit can result in nuisance alarms. NASTDB specifies, in milliseconds, a
time that must lapse before the alarm is cleared and before another alarm
message can be generated. The specified value is rounded up to the nearest
even multiple of the control station BPC. If the parameter passes from
outside one limit to outside the opposite extreme, the deadband is
ignored.

OOS_SW Out of Service Switch is a settable output used to set the MODE_T
parameter, and thus the MODE_BLK.Target in the associated device func-
tion block, to Out of Service.

17
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

OUT Output is a real output that contains the OUT parameter of the associated
device function block. It is settable only in Manual mode.

OUTDSC Output Descriptor is a configurable, non-settable ASCII string of up to


32 characters used as descriptive information in block alarm messages.

OUTSTS Output Status is a non-settable, packed Boolean output that contains the
OUT.Status parameter in the associated device function block. See
Section 1.6.7 for a description of the .Status value.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with
a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,
or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the AI block:
0 = No alarm
1 = High Absolute
2 = Low Absolute
3 = High-High Absolute
4 = Low-Low Absolute
8 = Bad I/O alarm.

18
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

If there is more than one active alarm with highest priority, PRTYPE
reports the alarm type occurring first in the following order: Bad, High-
High Absolute, Low-Low Absolute, High Absolute, and Low Absolute.
For example: if the Bad and High-High Absolute alarms both have
priority 3 and the High Absolute alarm has priority 4, and all three alarms
are active, then CRIT=3 (priority of Bad Alarm) and PRTYPE=8 (Bad
Alarm type).

PV Process Variable is a non-settable real output that contains the PV


parameter of the associated device function block. See Section 1.5.

PVFTIM PV Filter Time is a configurable, downloadable, non-settable real input


that is used to specify the PV_FTIME parameter of the associated device
function block. See Section 1.5.1.5 for further details.

PVSTS Process Variable Status is a non-settable, packed Boolean output that con-
tains the PV.Status of the associated device function block. See
Section 1.6.7 for a description of the .Status value.

RI1 Range Input 1 is a real array consisting of the two parameters HSCI1 and
LSCI1. The array members are configured by their individual names;
however, RI1 and its members can be accessed on an array basis by user
tasks and displays.

RO1 Range Output 1 is a real array consisting of the two parameters HSCO1
and LSCO1. The array members are configured by their individual
names; however, RO1 and its members can be accessed on an array basis
by user tasks and displays.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


AI block is to be simulated.
When SIMOPT= 1 (True), the status and value of OUT are not recovered
from the field, but are computed by the control station based on the simu-
lated value derived from the MEAS parameter. The simulated values are
limited by HSCO1 and LSCO1. If this limiting action forces a clamping
of the entered value, the status of OUT is set to Limited High or Limited
Low, as appropriate.

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block. ST_REV increments
each time a change is made to the configurable device block parameters
from an external source.

STOPTS Status Options is a configurable, downloadable, non-settable, packed


Boolean that is used to specify the STATUS_OPTS parameter of the
associated device function block. The AI block uses only the first eight
bits (least significant, low order bits) as shown in Table 1-10.

19
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

Table 1-10. STATUS_OPTS Parameter Format

Bit* Option Set with Bit


8 Uncertain if MAN Mode
7 BAD if Limited
6 Uncertain if Limited
3 Propagate Fault Forward
* Bit 0 is the least significant, low order bit.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device
function block. The value of TAGDSC is also copied to the DESCRP
parameter to provide a description of the block in I/A Series displays.

TSTAMP Time Stamp, which is expressed in units of milliseconds past midnight, is


updated every time there are changes in the value or status of the OUT
parameter. When the block is in normal operation, the time is from the
FBM228; when the block is in simulation (SIMOPT = 1), the value is
computed by the CP.

TYPE Type is the block type. When an AI block is added to the control database,
the configuration editor enters the value 109 to specify the AI block type.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the alarms display.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period for client/server connections scheduled by the
FBM228 to read the device function block view parameters. The range is
0 to 2147483647 milliseconds; the default is 10000.

1.5 Device Function Block Description


This section describes the FOUNDATION fieldbus analog input device function block, and
includes a block schematic, a brief description of the block’s standard parameter set, and a table
showing the mapping between the I/A Series system AI block parameters and the device function
block parameters.

20
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

1.5.1 Device Block Operation


The H1 device analog input function block processes a measurement from a field device and
makes it available to other function blocks in the OUT parameter (Figure 1-1). The CHANNEL
parameter specifies which of several measurements from the device is to be handled by the block.

PV

Simulation Conversion Cutoff Filter


CHANNEL
L_TYPE Output
XD_SCALE
SIMULATE OUT_SCALE LOW_CUT PV_TIME OUT

Mode FIELD_VAL Alarms


HI_HI_LIM
HI_LIM
LO_LIM
LO_LO_LIM

Figure 1-1. Analog Input Device Function Block Schematic

1.5.1.1 Mode
The device function block supports three modes:
♦ In Auto mode, the OUT parameter reflects the process variable (PV) value and status.
♦ In Manual, the OUT parameter can be set manually and the OUT status reflects the
mode.
♦ In OOS (out of service), the block values are not updated and the status of OUT is set
to BAD. In OOS, changes can be made to configured parameters.

1.5.1.2 Simulation
The SIMULATE parameter in the device function block allows the OUT parameter to be set by
an external source such as a hand-held H1 device for testing. When SIMULATE is enabled, the
actual measurement has no affect on the OUT value and status. Simulation at the device block
level also requires that you set a simulation jumper on the device.
The I/A Series AI block supports simulation within the control processor. The option is set with
the SIMOPT parameter in the AI block, as described in Section 1.6.14.

1.5.1.3 Conversion
The linearization type parameter (L_TYPE) determines whether the measurement is converted
directly, linearly (indirect), or indirectly with the square root.
The XD_SCALE parameter structure determines the high and low scale values, engineering units,
and number of places to the right of the decimal of the value in the selected channel. The
OUT_SCALE parameters provide similar scaling for the value in the OUT parameter.

1.5.1.4 Cutoff
When the Low Cutoff option is selected in IO_OPTS and the converted input value falls below
the value in LOW_CUT, the PV parameter is set to zero.

21
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

1.5.1.5 Filter
Filtering changes the response time of the device to smooth variations in the input readings
caused by rapid changes in the input value. The filtering time (PV_TIME) affects PV, not
FIELD_VAL.

1.5.1.6 Alarms
The device AI function block provides standard FOUNDATION fieldbus alarms plus HI_HI, HI,
LO and LO_LO applied to OUT.
The I/A Series system does not use the alarm features provided by the device blocks, but rather
provides alarm handling options in the CP-resident AI block. The AI block provides detection
and reporting of BAD I/O, high and low absolute and high-high and low-low alarm conditions.

1.5.2 Parameter Transforms


Table 1-11 illustrates the mapping of AI block parameters and parameters in the corresponding
device AI function block. Many of the parameters are straightforward 1:1 mappings that are either
unidirectional or bidirectional. Other mappings require that a data value be re-formatted (or
transformed) to be intelligible in the I/A Series system. From the point of view of the AI block,
the relationship with the device function block can also be described in terms of sink and source
connections:
→ Source-sink The AI block parameter is the source for the corresponding device
function block parameter. Thus, changes to the AI block parameter
are made to the device parameter. For example, when the AI block is
initialized, the TAGDSC value is copied to the device function block
TAG_DESC parameter.
← Sink-source The AI block parameter value is updated by the corresponding device
function block parameter. For example, the MODE_A parameter
reads the device parameter MODE_BLK.Actual to make the actual
device function block mode visible to the control system.
↔ Bidirectional Changes to the AI block parameter are made to the corresponding
device function block parameter and vice versa. For example, when
an AI block is initialized, its STOPTS parameter value is written to
the corresponding device function block parameter, STATUS_OPTS,
to configure how the function block processes block status informa-
tion. Subsequent changes to the status options made at the device are
written back to the AI block STOPTS parameter.

The arrow notation is used in Table 1-11; the mappings are presented in alphabetic order,
arranged by the AI block parameter names.

22
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

Table 1-11. AI Block Parameter Transforms

AI Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SW = 1:
Set MODE_T (request) = AUTO
Set CAS_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP to FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.MA=1 ← MODE_BLK.Actual.AUTO
BLKSTA.MA=0 ← MODE_BLK.Actual.MAN
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← OUT.Status.Bad (Bits 6-7=0)
CHANNL ↔ CHANNEL
DPTI1 ↔ XD_SCALE.Decimal Point
DPTO1 ↔ OUT_SCALE.Decimal Point
EUI1 ↔ XD_SCALE.units Index
EUO1 ↔ OUT_SCALE.units Index
HSCI1 ↔ XD_SCALE.@100%
HSCO1 ↔ OUT_SCALE.@100%
IOOPTS ↔ IO_OPTS
LSCI1 ↔ XD_SCALE.@0%
LSCO1 ↔ OUT_SCALE.@0%
MAN_SW MODE_BLK.Target
When MAN_SW = 1:
Set MODE_T (request) = MAN
Set AUT_SW=0 and OOS_SW=0
Write MODE_T (request) to FBM
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permitted
NAME → Function Block Tag

23
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

Table 1-11. AI Block Parameter Transforms (Continued)

AI Parameter Device Function Block Parameter


OOS_SW MODE_BLK.Target
When OOS_SW =1:
Set MODE_T (request) = OOS
Set AUT_SW=0 and MAN_SW=0
Write MODE_T (request) to FBM
OUT OUT
OUT.value (request) ↔ OUT.Value (in MAN mode only)
OUT.value (actual) ← OUT.Value
OUT.status.LHI ← OUT.Status.Limited Hi (Bit 0),
OUT.status.LLO ← OUT.Status.Limited Lo (Bit 1)
OUT.status.ERR ← OUT.Status.Uncertain (Bits 6-7=1)
OUT.status.BAD ← OUT.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
OUT.status.OOS ← OUT.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
OUTSTS OUT
OUTSTS.value ← OUT.Status
PV PV
PV.value ← PV.Value
PV.status.LHI ← PV.Status.Limited Hi (Bit 0)
PV.status.LLO ← PV.Status.Limited Lo (Bit 1)
PV.status.ERR ← PV.Status.Uncertain (Bits 6-7=1)
PV.status.BAD ← PV.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
PV.status.OOS ← PV.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
PVFTIM ↔ PV_FTIME
PVSTS PV
PVSTS.value ← PV.Status
STOPTS ↔ STATUS_OPTS
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC → TAG_DESC
Note: Changes to TAGDSC are copied to DESCRP.

24
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

1.6 AI Block Functions


The I/A Series AI block provides the interface between CP-resident control blocks and the device
function block in the H1 device.
The AI block OUT and OUTSTS parameters hold the value and status of the device OUT
parameter, while the PV and PVSTS parameters reflect the value and status of the function block’s
process value.
The AI block does not scale or condition the input from the device, as scaling for engineering
units is handled by the device function block. The AI block does, however, enable configuration
of the conversion, cutoff, and filtering options by configuration of corresponding AI block param-
eters that are then written to the device function block.
The AI block and the device function block operate in two asynchronous cycles, both writing to
and reading from shared space in the FBM memory. As with other I/A Series IO blocks, the AI
block executes in the Basic Processing Cycle (BPC) of the control station according to its com-
pound and its PERIOD and PHASE parameters, as described in Integrated Control Software Con-
cepts (B0700AG). The device function block executes once each FBM macrocycle as scheduled by
the FBM228.
The principal task of the AI block is to read a value and status from the corresponding device
block. For this task, the FBM228 establishes a publisher/subscriber connection between the AI
block OUT parameter and the device function block OUT parameter. The one exception is when
the OUT of the device function block is Control In the Field (CIF) mode connected to another
device function block in the same device and “Publish Internal Dev Connections” is not selected
in the Field Device Manager Schedule Config page in IEE.
All other parameter connections are made by the FBM on a client/server basis at the frequency
specified in the UPDPER parameter. The parameter can be set from 0 to 2147483647 millisec-
onds; the default is 10000 (10 seconds). Increasing the frequency of the client/server communica-
tion can significantly add to the load on the H1 segment.

1.6.1 Device Function Block Connection


The configured parameter IOM_ID of the AI block specifies an ECB201 (the device ECB) that
represents the target H1 device and its H1 segment. The ECB201 PARENT parameter identifies
the ECB200 or ECB202 for the host FBM228. The path to the device block is completed as fol-
lows. When the AI block is configured using IEE, the device function block is selected in a
browser which displays the device function blocks based on the device description in the device
ECB. If the connection is not made via the browser, the connection is made based on the AI block
BLKNDX parameter.
To assign function blocks to their device, refer to “Assign the Function Blocks to a Device” in
InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA).

1.6.2 Device Configuration Parameters


The AI block enables the user to set the standard configurable parameters in the corresponding
device function block and manage the device configuration from the I/A Series system. When you
deploy the AI block to the control station, and then download to the FBM228, parameter values
in the AI block to update parameters in the linked device function block.

25
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

The deployment of the AI block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Schedule execution of the device function block
♦ If needed, add a compel data (CD) message to each macrocycle to publish the OUT
parameter value and status
♦ Schedule client/server connections between the AI block and the device function
block for view updates.
Table 1-12 lists the device function block parameters and the AI block parameters used to config-
ure them. For the AI block, the table includes both the six-character (maximum) parameter name
that is used in block detail displays and parameter labels which more closely resemble the FOUN-
DATION fieldbus parameter names. Use the six-character parameter name when connecting
parameters to a process display.

Table 1-12. AI Block Configuration Parameters

Configured with AI Block Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
CHANNEL CHANNL Channel
IO_OPTS IOOPTS Io_opts
L_TYPE L_TYPE L_type
LOW_CUT LOWCUT Low_cut
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
OUT_SCALE.Decimal Point DPTO1 Out_decpt
OUT_SCALE.EU at 0% LSCO1 Out_scale@0
OUT_SCALE.EU at 100% HSCO1 Out_scale@100
OUT_SCALE.Units Index EUO1 Out_eu
PV_FTIME PVFTIM PV_ftim
STATUS_OPTS STOPTS StatusOpt
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc
XD_SCALE.Decimal Point DPTI1 XD_decpt
XD_SCALE.EU at 0% LSCI1 XD_scale@0
XD_SCALE.EU at 100% HSCI1 XD_scale@100
XD_SCALE.Units Index EUI1 XD_eu

1.6.3 Scaling
Table 1-13 lists the AI block parameters used to configure the device function block scaling
parameters. When the device block parameters are changed they are read back to the AI block.

Table 1-13. Scaling Parameters

AI Block Device Function Block


LSCO1 ↔ OUT_SCALE.@0%
HSCO1 ↔ OUT_SCALE.@100%

26
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

Table 1-13. Scaling Parameters (Continued)

AI Block Device Function Block


DPTO1 ↔ OUT_SCALE.Decimal
EUO1 ↔ OUT_SCALE.Units Index
LSCI1 ↔ XD_SCALE.@0%
HSCI1 ↔ XD_SCALE.@100%
DPTI1 ↔ XD_SCALE.Decimal
EUI1 ↔ XD_SCALE.Units Index

1.6.4 Block Validation


The I/A Series AI block initializes when any of these events occur:
♦ The block is installed or reconfigured via the IEE control configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.
When the AI block initializes, the following block validation tests are performed:
♦ If the high input range value (HSCI1) is less than the low input range value (LSCI1),
the block is marked undefined (BLKSTA.UDEF=1) with the error code parameter
(ERCODE) set to “W44 - INVALID ENGINEERING RANGE”.
♦ If the high output range value (HSCO1) is less than the low output range value
(LSCO1), the block is marked undefined (BLKSTA.UDEF=1) with the error code
parameter (ERCODE) set to “W44 - INVALID ENGINEERING RANGE”.
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Auto,
Manual or Out-of-Service, the block is marked undefined (BLKSTA.UDEF=1) with
the error code parameter (ERCODE) set to “W76 - INVALID FF MODE
CONFIGURATION”.
If the FBM simulation is not used (SIMOPT=0), the following validation tests are performed:
♦ If the AI block is installed prior to the installation of the ECB201 block, it is marked
undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE) set to
“W54 - ECB DOES NOT EXIST”. In this case, the AI block configuration is
restarted and re-validated automatically when the ECB201 is installed.
♦ An attempt is made to connect the AI block to the ECB201 specified in the IOM_ID
parameter. The DCI connection address (i.e., the BLKNDX parameter in the AI
block) is used in a connect message to establish a block connection in the FBM228.
♦ If the data connection cannot be resolved due to a lack of configuration information,
an AI connection is made in the FBM, the connection status is marked Unresolved,
and one of the following error strings is stored in the AI block ERCODE parameter:
♦ “W62 - UNRESOLVED CONNECTION”
♦ “W77 - FIELDBUS COMMUNICATIONS FAULT”
♦ “W78 - INVALID FUNCTION BLOCK”
♦ “W80 - FIELDBUS DEVICE NOT FOUND”

27
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

♦ “W82 - FF CONFIGURATION IN PROGRESS”


(In these cases, the AI block is defined, but the output values are marked OOS.)
♦ “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the AI block is defined, and the index of the invalid function block
parameter is stored in the CFGERR parameter.)
♦ If the AI data connection cannot be made for any other reason, the FBM rejects the
connection request and one of the following error strings is stored in the ERCODE
parameter to indicate the reason for the connection error:
♦ “W65 - INVALID POINT ADDRESS”
♦ “W66 - DUPLICATE CONNECTION”
♦ “W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS”
♦ “W68 - INVALID DEVICE CONNECTION”
♦ “W69 - INVALID POINT CONNECTION”
♦ “W74 - FF FUNCTION BLOCK DDITEM MISMATCH”
♦ “W75 - FF FUNCTION BLOCK DDMBR MISMATCH”
♦ “W76 - INVALID FF MODE CONFIGURATION”
♦ “W79 - INVALID PARAMETER INDEX”
(In these cases, the I/A Series AI block is undefined.)
♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the AI
block is undefined with ERCODE set to “W43 - INVALID PERIOD/PHASE
COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the AI
block is undefined with ERCODE set to “W81 - INVALID PARENT DCI ECB
PERIOD/PHASE”.
If there are no configuration errors when the I/A Series AI block is installed, the block is marked
defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the compound containing the
block is turned on, the block also initializes and starts running automatically.

1.6.5 Block Initialization


When the I/A Series AI block initializes, the following are performed:
♦ All alarm status parameters (ALMSTA, INHSTA, CRIT, PRTYPE, UNACK) are
cleared.
♦ The Actual mode parameter (MODE_A) is set to Initialization Manual (IMAN) in
the I/A Series AI block.
♦ The Target mode parameter (MODE_T) is set to only one of the following states, in
order, if multiple bits are set: Auto, Manual, OOS.
♦ The status of the OUT parameter is set to BAD and OOS.
♦ The timestamp for the output is updated.
If not simulating (SIMOPT=0), the following are performed:

28
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

♦ The Target mode is sent to the device AI function block.


♦ If installing the block, or if rebooting and not a Warm Restart, the configuration
parameters are downloaded to the device AI function block.

1.6.6 I/A Series Parameter Status


The status of the device AI function block parameters is provided in the I/A Series AI block in
two forms:
♦ The status of each device function block parameter is available as a separate I/A Series
AI block parameter.
♦ The status of each device function block parameter also is mapped onto equivalent
fields in the value record status of the corresponding I/A Series AI block parameter.
For each device function block parameter containing status information, the following fields are
mapped:
♦ The Quality field (Bits 6-7) is mapped onto the BAD and ERR status bits.
♦ The Sub-status field (Bits 2-5) is ignored, except for the case when the Quality is Bad
and the Sub-status is OOS. In this case, the OOS status bit is set in the I/A Series AI
block parameter.
♦ The Limited High (Bit 0) and Limited Low (Bit 1) fields are mapped onto the LHI,
LLO status bits, respectively.

1.6.7 Device Parameter Status


The analog input device function block OUT and PV parameters have both a value and a status.
The status is contained in a 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits. The
status is read into the AI block parameter, bit for bit. The default displays for the AI block shows
the converted status parameter so that the value need not be decoded. Table 1-14 shows how the
status byte is formatted.
Table 1-14. AI Block Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 SubStatus depends on .Quality, as shown in Table 1-15
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

29
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

Table 1-15 shows the usage of the Substatus bits, which varies depending on which .Quality bits
are set.
Table 1-15. Device Parameter Substatus

Bits 2-5 = SubStatus Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.
4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm

30
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

Table 1-15. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus Description


5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

1.6.8 Block Modes


The AI block provides interactive support of the MODE_BLK function block parameter. The
Target, Permitted, Normal, and Actual modes are provided as separate block parameters.
The configuration of the Target, Permitted, and Normal modes are supported. These parameters
are downloaded to the device AI function block when the I/A Series AI block initializes.
The Target mode can be changed through a group of settable Boolean mode switches provided in
the I/A Series AI block. These mode switches, AUT_SW, MAN_SW, and OOS_SW, allow the
block mode to be changed to Auto, Manual, or Out-of-Service respectively.
♦ Logic in the CP270 prevents more than one switch to be set at a given time. If more
than one switch is set during the same block cycle, only the last switch setting is
honored.
♦ Once set, a mode switch remains set only until the Target mode change is sent to the
FBM228 or until another mode switch is set. At that time, the mode switch is cleared.
♦ The mode switch setting is mapped onto an equivalent Target mode setting sent to
the FBM228.

31
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

The Target mode is a shadow parameter updated from the MODE_BLK function block parame-
ter read back during input scanning of the FBM228.
When the Actual, Permitted, Target, or Normal modes change in the device AI function block,
the corresponding I/A Series mode parameters are updated automatically from the MODE_BLK
function block parameter. In addition, the Actual mode is mapped onto equivalent BLKSTA
parameter bits.
The INITMA parameter and the Auto/Manual override parameters, AUTSW and MANSW, are
not supported in the I/A Series AI block, since these functions do not exist in the device AI func-
tion block.
When the Actual block mode is Auto or Manual, the following are performed:
♦ The OUTSTS status parameter and the value status of the OUT parameter are
updated from data received in the reply to the read message.
♦ The PV input parameter value is updated from data received in the reply to the read
message.
♦ Configuration parameters that have changed since the previous block cycle are
downloaded.
♦ Other View data parameters are updated, if any changes in these parameters have
occurred since the previous block cycle.
♦ Block Error (BLKERR) processing begins.
♦ External configuration changes to function block parameters are propagated.
♦ Configuration Error (CFGERR) processing begins.
♦ If BADOPT=1, Bad Alarming of the inputs is performed.
♦ If HLOPT > 0, High/Low Absolute Alarming of the output is performed.
♦ If HHIOPT > 0, High-High/Low-Low Alarming of the output is performed.
When the Actual block mode is Auto, the following is performed:
♦ The OUT output parameter value and status are updated from data received in the
reply to the read message.
When the Actual block mode is Manual, the operator is allowed to set the OUT output parame-
ter value directly via an OM set operation. When this parameter is changed in the CP, the new
value is sent to the FBM228 which, in turn, updates the corresponding OUT function block
parameter in the field device.

1.6.9 Block Alarming


The AI block performs alarm functions consistent with standard CP270 alarming. This includes
the following types of process alarms:
♦ Bad Alarming, High/Low Absolute Alarming, and High-High/Low-Low Absolute
Alarming of the OUT output.
♦ Informational messages of block errors (BLKERR) reported by the device AI function
block BLOCK_ERR parameter.
♦ Informational messages of function block configuration errors (CFGERR).
The device AI function block alarm detection, alarm events, alarm messaging, and associated
parameters provided by the field device are not supported in the I/A Series AI block.

32
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

1.6.10 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter is performed as
follows:
♦ For every condition specified in ERROPT, a corresponding Informational message is
sent to the ERRGRP alarm group when the condition occurs. The UNACK parame-
ter and the corresponding ALMSTA.UNACK bit also are set. ERROPT has the same
format as BLKERR (Table 1-4 on page 7).
♦ One of the messages listed in Table 1-16 is generated.

Table 1-16. Block Error Messages

ERROPT Bit Message Text


Bit 0 FF Block Error: Out-of-Service
Bit 1 FF Block Error: Power Up
Bit 2 FF Block Error: Maintenance Needed Now
Bit 3 FF Block Error: Readback Check
Bit 4 FF Block Error: Lost NV Data
Bit 5 FF Block Error: Lost Static Data
Bit 6 FF Block Error: Memory Fail
Bit 7 FF Block Error: Output Fail
Bit 8 FF Block Error: Input Fail
Bit 9 FF Block Error: Maintenance Due Soon
Bit 10 FF Block Error: Fault State Active
Bit 11 FF Block Error: Local Override
Bit 12 FF Block Error: Simulation Active
Bit 13 FF Block Error: Link Configuration Error
Bit 14 FF Block Error: Block Configuration Error
Bit 15 FF Block Error: Other (Undefined) Error

1.6.11 Configuration Error Processing


When an FF block configuration parameter cannot be downloaded into the field device, the
parameter index is stored in the CFGERR parameter and the following informational message is
generated:
“FF CFGERR in Parameter nnnnnnnn”
where: nnnnnnnn = ASCII name of the parameter indicated by the index in CFGERR

1.6.12 Process Alarming


If the Bad Alarm option (BADOPT) is set, alarming is performed as follows:
♦ Bad Alarm status information is set in the block when the BAD status of the OUT
parameter is set. The BAD bit is set in the alarm status parameter (ALMSTA.BAD).
The UNACK parameter and the corresponding ALMSTA.UNACK bit also are set.
♦ The CRIT parameter and its corresponding ALMSTA.CRIT field are set to the BAD-
PRI parameter value, and the PRTYPE parameter and its corresponding
ALMSTA.PRTYPE field are set to the appropriate alarm type. Note that this only
happens if there are no other alarms of higher priority in the block.

33
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

♦ When the Bad Alarm condition occurs, a Bad Alarm message is sent to all devices in
the BADGRP alarm group. This message contains the OUTDSC output descriptor,
the BADTXT descriptive text, and the LOOPID loop identifier.
♦ When the Bad alarm condition clears, a return-to-normal message is generated and
sent to all devices in the bad alarm group.
If the Absolute Alarm (HLOPT) or High-High/Low-Low Alarm (HHIOPT) option is set, alarm-
ing is performed as follows:
♦ Alarm status information is set in the block when the alarm condition exists. The
appropriate alarm bit is set in ALMSTA. The UNACK parameter and the correspond-
ing ALMSTA.UNACK bit also are set.
♦ The CRIT parameter and its corresponding ALMSTA.CRIT field are set to the
HLPRI or HHIPRI parameter value, and the PRTYPE parameter and its correspond-
ing ALMSTA.PRTYPE field are set to the appropriate alarm type. Note that this only
happens if there are no other alarms of higher priority in the block.
♦ When the alarm condition occurs, an alarm message is sent to all devices in the
HLGRP or HHIGRP alarm group. This message contains the OUTDSC descriptor,
the appropriate descriptive text, and the LOOPID loop identifier.
♦ When the alarm condition clears, a return-to-normal message is generated and sent to
all devices in the HLGRP or HHIGRP alarm group.
The CRIT, PRTYPE, and corresponding ALMSTA fields are cleared when there are no active
alarms in the block.
The UNACK parameter and the ALMSTA.UNACK bit are cleared in these cases:
♦ When the alarm is acknowledged by an OM set operation at either the compound
level, by setting the compound UNACK=0, or at the block level, by setting the block
UNACK=0.
♦ When all alarm conditions in the block return to normal status, if INHOPT is set
appropriately.
♦ When the block is shut down.
When UNACK is cleared, an Alarm Acknowledge message is generated and sent to all devices in
all alarm groups in the block.
Alarm Inhibiting/Disabling is supported using a combination of the compound CINHIB param-
eter and the INHOPT, INHIB, and INHALM parameters in the I/A Series AI block, to allow the
alarm messages to be inhibited and/or alarm detection to disabled dynamically.
When an alarm type is inhibited or disabled, an appropriate Alarm Disable message is generated
and sent to all devices in the alarm group. If the block is unacknowledged, an Alarm Acknowledge
message also is sent to these devices. In addition, the ALMSTA.INHIB bit is set, and the corre-
sponding INHSTA bit is set.
When an alarm type is uninhibited or enabled, an appropriate Alarm Enable message is generated
and sent to all devices in the alarm group. In addition, the ALMSTA.INHIB bit is cleared if no
other alarm in the block is inhibited, and the corresponding INHSTA bit is cleared.
The Alarm Reprioritization and Alarm Message Regeneration (using AMRTIN) enhancements
also are supported in the I/A Series AI block. Refer to the CP270 Integrated Control Concepts
(B0700AG) user document for details.

34
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

1.6.13 Block Shutdown


The AI block shuts down when any of these events occur:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ The ECB201 connected to the block is deleted.
♦ The AI block is deleted.
When block shutdown occurs, the following actions are taken:
♦ If any alarms are active, an Alarm Disable message is issued to all devices in the bad
alarm group. If the alarms are unacknowledged, an Alarm Acknowledge message also
is sent to these devices.
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, UNACK) are cleared.
If not simulating (SIMOPT=0) and the compound is off, the following actions are taken:
1. If the FF_OOS_OPT bit (Bit 4: 0x0010) is set in the Station block CFGOPT param-
eter, the following additional actions are taken:
♦ The actual mode parameter (MODE_A) is set to OOS.
♦ A write message is sent to the FBM228 with both the OOS and IMAN bits set in
the Target mode. The IMAN bit is set to indicate to the FBM228 that the com-
pound is off.
♦ Otherwise, a write message is sent to the FBM228 with only the OOS bit set in
the Target mode.
2. Otherwise, the following action is taken:
♦ A write message is sent to the FBM228 with both the current state and the IMAN
bits set in the Target mode. The IMAN bit is set to indicate to the FBM228 that
the compound is off.

1.6.14 Simulation
The I/A Series AI block SIMOPT parameter enables simulation of an analog input to the control
system from the corresponding analog input device function block. This feature can be used to
test control schemes requiring analog inputs without actual FBM228 hardware connections.
When SIMOPT= 1 (True), the status and value of OUT are not recovered from the field, but can
be set directly to simulate input from the field.
When simulating (SIMOPT=1), the following functions will be performed:
♦ The MEAS input is stored in the OUT output value when the block mode is Auto.
♦ The OUTSTS output status parameter is set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (AUT_SW, MAN_SW, or
OOS_SW) immediately update the target mode parameter (MODE_T), and the
actual block mode (MODE_A) tracks MODE_T each block cycle.
♦ If any of the alarm options are specified, process alarming of the output is performed.
When simulating, the following functions are not performed:
♦ Downloading of configuration parameters.
♦ Updating of View data parameters.

35
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

♦ Block Error (BLKERR) processing.


♦ External configuration changes to function block parameters.
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA) or Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for
instructions on conducting control simulations from the control station.

1.6.15 Block States


The DCI blocks transition through the states detailed in Table 1-17 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 9).

Table 1-17. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device

36
1. AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

Table 1-17. DCI Block States (BSTATE) (Continued)

BSTATE Value
(Int (Bin)) State Value Description
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

1.7 AI Block Application Example


The AI block can be used in any control block configuration, in any compound except the Station
compound and the Primary ECB compound, in any CP270. It only can be connected to any
device AI function block in a field device hosted by an FBM228, but not to any other device
function block type or to any function block parameter.
Each field device connection must be specified by configuring the name of the ECB201 in the
IOM_ID parameter. The device AI function block connection must be specified by configuring
the AI function block index in the BLKNDX parameter.
Figure 1-2 illustrates an example of the AI block’s use in applications.

37
B0700EC – Rev B 1. AI – Foundation™ fieldbus Analog Input

Parent ECB200/202
(FBM228)

Child ECB201 Child ECB201


(FF H1 Device) (FF H1 Device)

PARENT PARENT

IOM_ID
NAME

AI Block PIDA Block

MEAS OUT MEAS OUT


SPT
BCALCI

IOM_ID IOM_ID
NAME NAME

AI Block PIDA Block AO Block

MEAS OUT MEAS OUT CAS_IN


RSP
BCALCI BCALCO
BCALCO

SUP_IN
SUPBCO

Supervisory Control Application


(e.g. Connoisseur MPC)

Figure 1-2. Application Example with I/A Series AI Block

38
2. AO – FOUNDATION™ fieldbus
Analog Output
This chapter describes the Analog Output (AO) block, which interfaces the control system with
a corresponding analog output function block operating in a FOUNDATION™ fieldbus H1
device.

2.1 Overview
Analog Output (AO) is a Distributed Control Interface (DCI) block that provides an interface
between the control processor and an analog output function block operating in a FOUNDA-
TION fieldbus H1 device (the device function block). The AO block is supported on the
FCP270 and ZCP270 when the H1 device is connected to the control station by an FBM228.
The AO block is configured using the Block Configurator in the InFusion Engineering Envi-
ronment (IEE) as described in InFusion Enterprise Control System: Implementing FOUNDATION
fieldbus in InFusion 2.0 (B0750DA).

NOTE
The AO block functionality described in this chapter is applicable only for
FBM228s with the software type (SWTYPE) of “128”. For a description of the leg-
acy AO block functionality (I/A Series systems v8.4.3 or earlier) where FBM228s
have the SWTYPE of “228”, refer to Appendix B “Legacy AO – Foundation™
fieldbus Analog Output”.

2.2 Basic Operation


The AO block integrates the corresponding device function block into the I/A Series system. On
initialization, user-configured values in the AO block are written to the standard configurable
parameters in the corresponding device function block. If the AO block is connected to another
non-FF block (such as the I/A Series PIDA block), the AO block maintains a publisher/subscriber
connection with the device function block to write a value to the device block CAS_IN parameter,
and reads the value and status of the device block BKCAL_OUT parameter. However, if the AO
block is connected to another FF block (such as PIDFF) the FBM sets up a publisher/subscriber
relationship directly on the FF segment (Control In the Field (CIF) mode) between the device
PID and AO function blocks. If output parameters are communicated over the FF H1 segment,
the FBM is set up to subscribe to these values for faster data updates in the AO block in the CP. In
addition, the AO block provides access to a variety of operational and diagnostic information via
client/server connections with the parameters that are included in the block view data of the
device function block. The values read from these parameters are displayed in the block detail dis-
plays and are available for connection to other I/A Series blocks.

39
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

2.3 Features
The AO block provides the following features:
♦ Two modes: Control in Host (CIH) or Control In the Field (CIF), in which the
device AO function block is directly connected to another device function block
♦ Outputs a setpoint value to the linked device analog output function block, and
acquires the block’s primary output value and status for read-back to the control
system
♦ Time stamps value and status changes to the block's output
♦ Accesses the parameters in the device function block’s views using change-driven and
periodic client/server connections
♦ Ensures that changes in the device function block’s process values and error conditions
are continuously available for display and connection to the control strategy
♦ Supports the device block Fault State handling
♦ Provides for the configuration of device block parameters from the I/A Series system
and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Cascade, Auto, Manual
or Out of Service
♦ Provides detection and reporting for Bad I/O alarming
♦ Supports simulation of device block output within the control station

2.4 Block Parameters


Table 2-1 lists the block parameters. See Table 2-10 for mappings between the AO block parame-
ters and their device function block equivalents.

Table 2-1. AO Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 118 118 (AO)
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 13
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0 = no simulation
1 = simulation
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path
name <= 25 chars
or ECB block
name <=12 chars
CHANNL channel integer no-con/no-set 1 0 to 32767
DDITEM DD item long no-con/no-set 0x800201F0
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000 0 to 2147483647

40
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table 2-1. AO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


STRATG strategy integer no-con/no-set 999 0 to 65535
STOPTS status options packed bool- no-con/no-set 0x800 0 to 0x0800
ean
IOOPTS I/O options packed bool- no-con/no-set 0x1340 0 to 0xFF
ean
SHEDOP mode shed option short no-con/set 0x01 0 TO 8
HSCI1 input high scale real no-con/no-set 100.0 > LSCI1
LSCI1 input low scale real no-con/no-set 0.0 < HSCI1
DPTI1 input decimal point integer /no-set 0 0 to 10
EI1 engineering units string no-con/no-set % 1 to 32 chars
EUI1 input eng. units index integer /no-set 1342 0 to 32767
HSCO1 output high scale real no-con/no-set 100.0 > LSCO1
LSCO1 output low scale real no-con/no-set 0 < HSCO1
DPTO1 output decimal point integer /no-set 0 0 to 10
EO1 output eng units string no-con/no-set % 1 to 32 chars
EUO1 output eng units index integer no-con/no-set 1342 0 to 32767
MODE_N normal mode short integer no-con/no-set 0x20 0 to 0xFF
MODE_P permitted mode short integer no-con/no-set 0x39 0 to 0xFF
MODE_T target mode short integer no-con/no-set 0x20 0 to 0xFF
CAS_IN cascade input real con/set, settable 0.0
only in Cascade
SP setpoint real no-con/set, set- 0.0
table only in Auto
SPHLIM setpoint high limit real con/set 100.0
SPLLIM setpoint low limit real con/set 0.0
PRIBLK primary block boolean no-con/set 0 0 to 1
cascade option
PRITIM primary cascade timer real no-con/set 0.0
FSOPTN faultstate option integer no-con/no-set 0 0 to 7
FSTIME faultstate time real no-con/no-set 20.0 sec
FSVAL faultstate value real no-con/no-set 100.0
INHOPT inhibit option short integer no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short integer con/no-set 1 1 to 8
BADOPT bad alarm option boolean no-con/no-set 0 0 to 1
BADGRP bad alarm group short integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 0 to 32 chars
OUTDSC output descriptor string con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration integer no-con/set 0 0 to 32767
interval
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to 2147483647
DVC_ID device ID integer no-con/no-set 0 0 to 0xFFFF
DVCREV device revision long integer no-con/no-set 0 0 to 2147483647

41
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

Table 2-1. AO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


BLKNDX block index long integer no-con/no-set 0 0 to 2147483647
SETFS set faultstate boolean con/set 0 0 to 1
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to 0xFFFFFFFF
AUT_SW auto switch boolean con/set 0 0 to 1
BCALCO back calc output real con/no-set 0.0
BCOSTS back calc out status packed bool- con/no-set 0 0 to 0xFF
ean
BLKERR block error packed bool- con/no-set 0 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0 TO
0xFFFFFFFF
CASSTS cascade input status real con/no-set 0 0 to 0xFF
CAS_SW cascade switch boolean con/set 0 0 to 1
CRIT criticality integer con/no-set 0 0 to 5
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode short integer con/no-set 0 to 0xFF
OOS_SW out of service switch boolean con/set 0 0 to 1
OUT output real con/set, settable 0.0
only in Manual
OUTSTS output status packed bool- con/no-set 0 0 to 0xFF
ean
PRTYPE priority type integer con/no-set 0 0, 8
PV process variable real con/no-set 0.0
PVSTS process variable packed bool- con/no-set 0 0 to 0xFF
status ean
RBK readback real con/no-set 0.0
RBKSTS readback status packed bool- con/no-set 0 0 to 0xFF
ean
SPSTS setpoint status packed bool- con/no-set 0 0 to 0xFF
ean
TSTAMP time stamp long integer con/no-set 0 ms after midnight
BSTATE block state integer con/no-set 0 0 to 11
DEVACK device acknowledge boolean con/set 0 0, 1
UNACK unacknowledged boolean con/set 0 0, 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for each
(array 1x255) element
FDATA2 file data bytes 256 to short integer no-con/no-set all 0s 0 to 255 for each
510 (array 1x255) element
CFGERR configuration error short integer no-con/no-set 0
DEFINE no config errors boolean no-con/no-set 1 ---

42
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table 2-1. AO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DESCRP descriptor string no-con/no-set blank 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 8 to 13 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
RI1 input range real no-con/no-set 100.0, 0.0,
0.0
RI2 output range real no-con/no-set 100.0, 0.0,
0.0
ST_REV status revision integer no-con/no-set 2 blanks

2.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT Alarm Options contains packed long values representing the alarm types
that have been configured as options in the block, and the alarm groups
that are in use. Table 2-2 shows how the parameter is used by the AO
block.

Table 2-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

43
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table 2-3 shows the bits used by the AO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9
CRIT PRTYPE

BAD
INH

Table 2-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the FF
blocks
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
22 BAD Bad I/O Alarm ALMSTA.B10
29 INH Inhibit Alarm. This bit is set when ALMSTA.B3
any of the block’s alarms is inhibited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and thus the MODE_BLK.Target1 in the associated device
function block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the AO block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the AO
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

44
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BCALCO Back Calculated Output is set equal to the confirmed component of


BKCAL_OUT in the associated AO device block while cascade is initializ-
ing. Since its purpose is to provide the upstream block with a back-calcu-
lated value, connect BCALCO to the BCALCI parameter of the upstream
block.

BCOSTS Back Calculated Output Status is a non-settable, packed Boolean output


that contains the BKCAL_OUT.Status of the associated device function
block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block. Table 2-4
shows the parameter format.

Table 2-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device function block represented by the AO block. It is set
by the configurator and the FBM uses it to identify the block in the
device.

45
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 2-5 shows how the bits are used by the AO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B24
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DEVACK B9

FDFAIL
FDACT
FDMM
FDOK

UDEF

FBM

TRK
LCK

FFX

BIO
ON

MA

LO
FS

LR
Table 2-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local BLKSTA.B29
Override
6 TRK Block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual mode
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
10 LR Device block mode is Cascade. BLKSTA.B24
11 MA The device block mode is Auto. BLKSTA.B21
12 BIO Bad I/O BLKSTA.B20
14 UDEF Block is undefined BLKSTA.B18
15 ON The compound that contains the block BLKSTA.B17
is ON
16 FFX Enhanced FF block connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FBM228 The device is hosted and scheduled by BLKSTA.B13
an FBM228
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK FDATA installed BLKSTA.B11
22 FDMM FDATA mismatch BLKSTA.B10
23 DEVACK Unacknowledged device alarm BLKSTA.B9
24 FS Fault State has been asserted in the BLKSTA.B8
device function block
*Bit 0 is the least significant, low order bit.

46
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the device block connection as determined by the
FBM228. The following values are used to indicate the current DCI block
state:
0 = Undefined state
1 = Unconnected
2 = Connecting
3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON-LINE
11 = Block ON-LINE with error - Processing has been completed, but
some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 79.

CAS_IN Cascade Input is a configurable real input used to specify the CAS_IN
parameter of the associated device function block. It is settable only in
Cascade mode if unlinked.

CAS_SW Cascade Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the associated device function block,
to Cascade.

CASSTS Cascade Input Status is a non-settable, packed Boolean output that


contains the CAS_IN.Status of the associated device AO function block.
See Section 2.6.9 further details.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the FF Function block becomes unde-
fined due to a “W73 - FF FUNCTION BLOCK CONFIGURATION
ERROR”. When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block. See
Section 2.5.1.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5
(default). An output of 0 indicates the absence of alarms.

47
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 49 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string of up to


32 characters used to specify a description for the AO block. DESCRP
tracks TAGDSC.

DEVACK Device Acknowledge is a settable boolean output used to acknowledge


device alarms in the associated device function block. DEVACK is set
when a device alarm status bit is set by the FBM228. DEVACK is cleared
by an operator action.
DEVACK is different from UNACK (described on page 57), which is
used by the operator to acknowledge process alarms in the DCI block.
DEVACK is used to acknowledge device alarms at the ECB201 or DCI
block level.

NOTE
This parameter is not supported currently.

DPTI1 Input Decimal Point is a configurable, downloadable, non-settable short


integer used to specify the XD_SCALE.decimal parameter of the associated
device function block. The range is 0 to 10. See Section 2.5.1.3.

DPTO1 Output Decimal Point is a configurable, downloadable, non-settable


short integer used to specify the PV_SCALE.decimal parameter of the
associated device function block. The range is 0 to 10. See Section 2.5.1.3.

DVC_ID Device Identifier is a configurable, non-settable integer that provides the


Device Identifier of the H1 field device that contains the device function
block represented by the AO block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device.

48
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

DVCREV Device Revision is a configurable, non-settable long integer that provides


the Revision level of the H1 field device that contains the device function
block represented by the AO block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device. The IEE
configurator encodes the following data in DVCREV:
Bits 16-23 Bits 8-15 Bits 0-7
Device revision Minimum Device Description Common File Format
(DD) File Revision (CFF) File Revision

EI1 Input Engineering Units provides the engineering units text for the OUT
parameter. The value configured for this text string should be consistent
with the values used for HSCI1 and LSCI1. This parameter does not con-
figure units in the device block; see EUI1.

EO1 Output Engineering Units specifies the engineering units text for the PV
parameter. The value configured for this text string should be consistent
with the values used for HSCO1 and LSCO1. This parameter does not
configure units in the device function block; see EUO1.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic. Table 2-6 lists the possible values of
ERCODE.

Table 2-6. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION
W44 - INVALID ENGINEERING RANGE
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION

49
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

Table 2-6. Error Code Values

ERCODE
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in the AO block. The range is 1 (default) to 8.

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. The parameter has the same format as
BLKERR (Table 2-4).

EUI1 Input Engineering Units Index is a configurable, downloadable, non-set-


table integer used to specify the XD_SCALE.Units Index parameter of the
device function block.

EUO1 Output Engineering Units Index is a configurable, downloadable, non-


settable integer used to specify the PV_SCALE.Units Index parameter of
the device function block.

FDATA1 File Data #1 and File Data #2 are settable multi-byte arrays that provide
FDATA2 configuration data for the device block represented by the AO block.
This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 510 bytes.

FSOPTN Fault State Option is a configurable integer parameter that specifies the
Fault State conditions and action to be taken by the CP and the FBM for
an output point in the corresponding device AO function block:
♦ Bit 0: 1 = Assert Fault State when the CAS_IN parameter is
sourced by an I/A Series block parameter and the CAS_IN
is BAD, OOS, or has a broken connection.
Note that ERROPT must be configured nonzero for this
option to take effect.
♦ Bit 1: 1 = Assert Fault State when the CAS_IN parameter is
sourced by an I/A Series block parameter and the SETFS
input is set/cleared.
♦ Bit 2: 1 = Assert Fault State if control station-to-FBM communi-
cation is lost (FBM option). This option is enabled only
when the CAS_IN parameter is sourced by an I/A Series
block parameter and the Fault State is enabled at the FBM
level via the FSENAB parameter in the ECB200 or
ECB202.

50
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Bit 0 is the least significant, low order bit.


FSOPTN is independent of the FSTATE_TIME and FSTATE_VAL
parameters and the STATUS_OPTS options configured in the corre-
sponding device AO function block.

FSTIME Fault State Time is a configurable, downloadable, real value used to specify
the FSTATE_TIME parameter of a device function block. See
Section 2.6.10 on page 75.

FSVAL Fault State Value is a configurable, downloadable, non-settable real value


used to specify the FSTATE_VAL parameter of a device AO block. See
Section 2.6.10 on page 75.

HSCI1 Input High Scale specifies the XD_SCALE.EU@100 parameter value of


the associated device function block.

HSCO1 Output High Scale specifies the PV_SCALE.EU@100 parameter value of


the associated device function block.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table 2-7 shows
how parameter is used with the AO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 15 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
BAD B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

51
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

Table 2-7. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up
to 25 characters (12 for <local_compound_name>, 1 for the
colon, and 12 for the <ecb_name>).

IOOPTS I/O Options is a configurable, downloadable, non-settable, packed


Boolean used to specify the IO_OPTS parameter of the associated device
function block. Table 2-8 shows how the bits are used by the AO block.
Table 2-8. IOOPTS Parameter Format

Bit
Number* Description, When True
14 SP-PV Track in Man
12 SP-PV Track in LO
11 SP Track retained target
10 Increase to Close
9 Fault State to Value
8 Fault State on Restart
7 Target to MAN on FS
6 Use PV for BKCAL_OUT
*Bit 0 is the least significant, low order bit.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has

52
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

the format LETTERBUG:DEVNAME, where LETTERBUG is the


6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block, immediately
below the faceplate.

LSCI1 Input Low Scale specifies the XD_SCALE.EU@0 parameter value of the
device function block.

LSCO1 Output Low Scale specifies the PV_SCALE.EU@0 parameter value of the
device function block.

MAN_ID Manufacturer Identifier is a configurable, non-settable long integer that


provides the Manufacturer Identifier of the H1 field device that contains
the device function block represented by the AO block. The FBM228
checks the corresponding value in the device resource block to verify that
there is a match between the block and the device.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the associated device function block,
to Manual.

MODE_A Actual mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device func-
tion block.

MODE_N Normal mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Normal parameter of the associated
device function block.

MODE_P Permitted mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target mode is a configurable, downloadable, short integer output that


contains the MODE_BLK.Target parameter of the associated device func-
tion block. MODE_T is not directly settable. AUT_SW, MAN_SW,

53
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

CAS_SW, and OOS_SW are used to change the MODE_T parameter


and thus the MODE_BLK.Target parameter in the device function block.

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the AO block is initialized,
the block updates the configurable parameters of the function block
matched to the AO block by the configured index (BLKNDX). The
NAME parameter is used to set the Block Tag of the device function
block.

OOS_SW Out of Service Switch is a settable output used to set the MODE_T
parameter, and thus the MODE_BLK.Target in the associated device func-
tion block, to Out of Service.

OUT Output is a real output that contains the OUT parameter of the associated
device function block. It is settable only in Manual mode.

OUTDSC Output Descriptor is a configurable, non-settable ASCII string of up to


32 characters used as descriptive information in block alarm messages.

OUTSTS Output Status is a non-settable, packed Boolean output that contains the
value of OUT.Status in device function blocks. See Section 2.6.9.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with
a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,

54
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PRIBLK Primary Block indicates whether the AO block has a connection from an
upstream block (PRIBLK = 1) or not (PRIBLK = 0). Its value and the
value of PRITIM determine whether the block remains in holding until
the upstream block returns an acknowledgement, remains in holding for a
fixed time delay, or ends the hold after one cycle.

PRITIM Primary Cascade Timer is a configurable parameter used to delay the clos-
ing of the cascade to a primary block when the output is initialized in the
AO block. It is used only if the PRIBLK option is set. If PRITIM = 0 and
PRIBLK is used, the cascade remains open indefinitely until acknowl-
edged by the primary block.

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the AO block:
0 = No alarm
8 = Bad I/O alarm.

PV Process Variable is a non-settable real output that contains the PV


parameter of the associated device function block.

PVSTS Process Variable Status is a non-settable, packed Boolean output that con-
tains the PV.Status of the associated device function block. See
Section 2.6.9.

RBK Readback is a non-settable real output that contains the READBACK


parameter of the associated device function block.

RBKSTS Readback Status is a non-settable, packed Boolean output that contains


the READBACK.Status of the associated device function block. See
Section 2.6.9 on page 72.

RI1 Input Range is a real array consisting of the two parameters HSCI1 and
LSCI1. The array members are configured by their individual names;
however, RI1 and its members can be accessed on an array basis by user
tasks and displays.

RI2 Output Range is a real array consisting of the two parameters HSCO1
and LSCO1. The array members are configured by their individual
names; however, RO1 and its members can be accessed on an array basis
by user tasks and displays.

SETFS Set Fault State Request is a Boolean parameter that requests Fault State
action to be reset by the FBM or field device for the specific output value
of the block. The settings are:
♦ 1 = set Fault State request
♦ 0 = reset Fault State request

55
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

SETFS can only be used when the AO block is connected to another


block in the CP. This parameter has no function if the device AO function
block is CIF connected (that is, connected to this block in CIF mode).
See Section 2.6.10 on page 75.

SHEDOP Mode Shed Options is a configurable, downloadable, short integer that is


used to specify the SHED_OPT parameter of the associated device func-
tion block.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


FF function block is to be simulated.
When SIMOPT= 1 (True) for an output block, there is no DCI connec-
tion established for the block, and the status and value of BCALCO are
not recovered from the field, but are computed by the control station
based on the simulated value change. The simulated behavior of the block
reflects the operational mode of the block (MODE_A).

SP Set Point is a configurable real output that is used to specify the SP param-
eter of the associated device function block. It is settable only in Auto
mode.

SPHLIM Set Point High Limit is a configurable real input that is used to specify the
SP_HI_LIM parameter of the associated device function block. It is
settable if unlinked. See Section 2.5.1.2 for further details.

SPLLIM Set Point Low Limit is a configurable real input that is used to specify the
SP_LO_LIM parameter of the associated device function block. It is
settable if unlinked. See Section 2.5.1.2 for further details.

SPSTS Set Point Status is a non-settable, packed Boolean output that contains the
SP.Status of the associated device function block. See Section 2.6.9.

ST_REV Status Revision is a non-settable integer that contains the ST_REV param-
eter of the associated device function block.

STOPTS Status Options is a configurable, downloadable, non-settable, packed


Boolean that is used to specify the STATUS_OPTS parameter of the asso-
ciated device function block. The AO blocks uses only bit 4 as shown in
Table 2-9.

Table 2-9. STATUS_OPTS Parameter Format

Bit* Option Set with Bit


4 Propagate Fault Backward
* Bit 0 is the least significant, low order bit.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

56
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device
function block. The TAGDSC string is also copied to the DESCRP
parameter to provide the same description for I/A Series block displays.

TSTAMP Time Stamp, which is expressed in units of milliseconds past midnight, is


updated every time there is a change in the value or status of the
BCALCO parameter. The time is provided by the FBM228 when a new
output is sent to the corresponding device AO function block. However,
when the block is in simulation (SIMOPT = 1), the value is computed by
the CP.

TYPE Type is the block type. When an AO block is added to the control data-
base, the configuration editor enters a value of 110 to specify the AO
block type.

UNACK Unacknowledge is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the Current Alarms display.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 to schedule client/server
connections to scan the device function block view parameters. The range
is 0 to 2147483647 milliseconds; the default is 10000.

2.5 Device Function Block Description


This section describes the FOUNDATION fieldbus analog output device function block, and
includes a block schematic, a brief description of the block’s standard parameter set, and a table
showing the mapping between the I/A Series AO block parameters and the device function block
parameters.

2.5.1 Device Block Operation


The analog output device function block processes a setpoint input from another block or an
external source and outputs the value to a field device at the OUT parameter (Figure 2-1). The
value is output to the hardware specified in the device block CHANNEL parameter.

57
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

BKCAL_OUT

Setpoint Out Output


CAS_IN Conversion
OUT
SP_RATE_DN
SP_RATE_UP PV_SCALE
SP_HI_LM XD_SCALE
SP_LO_LIM
Simulation
SP PV
CHANNEL

SIMULATE
Mode PV Fault
Conversion State

SHED_OPT READBACK
PV_SCALE FSTATE_TIME
XD_SCALE FSTATE_VAL

Figure 2-1. Device AO Function Block Schematic

2.5.1.1 Mode
The device AO block supports the following modes:
♦ Man - Manual allows you to set the OUT parameter.
♦ Auto - In Auto, the OUT parameter reflects the SP value.
♦ Cas - Cascade allows the OUT parameter to be set by an external source connected to
the CAS_IN parameter.
♦ OOS - When the mode is Out of Service, the block is not processed, the output
channel is maintained at the last value, and the status of OUT is set to BAD.
♦ IMan - Initialization Manual indicates that the path to the output hardware is closed.
The output remains at its last value.
♦ LO - Local Override is set when the resource block has been placed in LO or Fault
State is active. In LO, the output of the block does not respond to CAS_IN.

2.5.1.2 Setpoint
The source of the Setpoint depends on the block mode as described in Section 2.5.1.1. The SP
value is limited to the range defined by SP_HI_LIM and SP_LO_LIM. When the block is in Auto
mode, the rate at which changes in the SP value are passed to the OUT value are limited by the
SP_RATE_DN and SP_RATE_UP parameters.

2.5.1.3 Out Conversion


The PV_SCALE and XD_SCALE parameters scale the setpoint before it is copied to the PV and
OUT parameters respectively.

58
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

2.5.1.4 Output
This value is passed to the device’s transducer block to provide the “setpoint” to the servo-position
circuit that actually manipulates the valve position.

2.5.1.5 Simulation
When the SIMULATE parameter in the device function block is set, the OUT parameter value is
not sent to the device, and the BKCAL_OUT can be set an external source such as a hand-held
H1 device for testing. Simulation at the device block level also requires that you set a simulation
jumper on the device.
Simulation of the control loop involving an analog output to an H1 device can be accomplished
entirely within the control station and not involve communication with the H1 devices, as
described in Section 2.6.16.

2.5.1.6 Fault State


The AO block has two Fault State options, which are set in the IO_OPTS parameter:
♦ Fault State on Restart sets the OUT parameter to a specified value when the device is
recycled because of a loss of power or for some other reason. The value is specified in
FSTATE_VAL.
♦ Fault State to Value sets the OUT parameter to a specified value if the block has not
received a value for output from its configured source within the time specified in
FSTATE_TIME. As with the restart option, the value is specified in FSTATE_VAL.
In the case of both options, the device detects the condition and takes the Fault State action.

2.5.1.7 PV Conversion
The PV_SCALE parameter is used to convert the SP to percent of span. The XD_SCALE range is
used to convert percent of span to the number used by the hardware. This allows portions of the
SP span to cause full span movement of the output. The Increase to close option in IO_OPTS can
be used to invert the span.

2.5.2 AO Parameter Transforms


Table 2-10 shows the mapping of the AO block parameters to the parameters in the related device
function block. Many of the parameters are straightforward 1:1 mappings that are either unidirec-
tional or bidirectional. Other mappings require that a value be re-formatted (or transformed) to
be intelligible in the I/A Series system.
From the point of view of the AO block, the relationship with the device function block can also
be described in terms of sink and source connections:
→ Source-sink The AO block parameter is the source for the corresponding device
function block parameter. Thus, changes to the AO block parameter
are copied to the device function block parameter. For example, when
the AO block is initialized, the TAGDSC value is copied to the
device function block TAG_DESC parameter.

59
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

← Sink-source The AO block parameter value is updated by the corresponding


device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual function block mode visible to the control system.
↔ Bidirectional Changes to the AO block parameter are made to the corresponding
device function block parameter and vice versa. For example, when
an AO block is initialized, its MODE_T parameter value is written to
the device block parameter, MODE_BLK.Target, to configure the
block’s target mode. Subsequently, the MODE_BLK.Target value is
written back to the AO block MODE_T parameter.

The arrow notation is used in the Table 2-10 descriptions of AO parameter transforms. These are
presented in alphabetic order, arranged by the AO block parameter names.

Table 2-10. AO Block Parameter Transforms

FF Function block
Parameter Device Analog Output Block Parameter
AUT_SW MODE_BLK.Target
When AUT_SW = 1:
Set MODE_T (request) = AUTO
Set CAS_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM

60
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table 2-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
BCALCO BKCAL_OUT, OUT, CAS_IN, MODE_BLK.Actual
BCALCO.value ← BKCAL_OUT.Value if not simulating (SIMOPT=0)
← OUT.Value if simulating (SIMOPT=1)

BCALCO.status.LHI ← BKCAL_OUT.Status.Limited Hi (Bit 0),


or MODE_BLK.Actual is not Cascade,
or BKCAL_OUT.Status.Bad (Bits 6-7=0),
or CP-FBM communication failure,
or the DCI connection record indicates an Initialization Request
(IR), Local Override (LO), Open Loop (LHI and LLO), Not Invited
(NI), or Failsafe Active (FSA) condition in the AO function block.

BCALCO.status.LLO ← BKCAL_OUT.Status.Limited Lo (Bit 1),


or MODE_BLK.Actual is not Cascade,
or BKCAL_OUT.Status.Bad (Bits 6-7=0),
or CP-FBM communication failure,
or the DCI connection record indicates an Initialization Request
(IR), Local Override (LO), Open Loop (LHI and LLO), Not Invited
(NI), or Failsafe Active (FSA) condition in the AO function block.

BCALCO.status.BAD ← BKCAL_OUT.Status.Bad (Bits 6-7=0)


or CP-FBM communication failure
BCALCO.status.OOS ← BKCAL_OUT.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
BCOSTS BKCAL_OUT
BCOSTS.value ← BKCAL_OUT.Status
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP-FBM communication is failed or FBM is Off-Line

61
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

Table 2-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
BLKSTA MODE_BLK.Actual, BKCAL_OUT
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.HLD ← CAS_IN source value is BAD
BLKSTA.TRK ← CAS MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.LR=1 ← MODE_BLK.Actual.CAS
BLKSTA.LR=0 ← MODE_BLK.Actual.AUTO or MAN
BLKSTA.MA=1 ← MODE_BLK.Actual.CAS or AUTO
BLKSTA.MA=0 ← MODE_BLK.Actual.MAN
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← BKCAL_OUT.Status.Bad (Bits 6-7=0)
BLKSTA.FS ← BKCAL_OUT.Status.Good (Bits 6-7=0)
and Substatus.FSA (bits2-5= 7)
CASSTS CAS_IN
CASSTS.value ← CAS_IN.Status
CAS_IN CAS_IN, BKCAL_OUT
CAS_IN.value (request) → CAS_IN.Value (in CAS mode only if non-FF connection)
CAS_IN.value (actual) ← BKCAL_OUT.Value if initializing;
← CAS_IN.Value if not initializing

CAS_IN.status.LHI ← CAS_IN.Status.Limited Hi (Bit 0)


or CAS_IN source value is LHI
CAS_IN.status.LLO ← CAS_IN.Status.Limited Lo (Bit 1)
or CAS_IN source value is LLO
CAS_IN.status.ERR ← CAS_IN.Status.Uncertain (Bits 6-7=1)
or CAS_IN source value is ERR
CAS_IN.status.BAD ← CAS_IN.Status.Bad (Bits 6-7=0),
or CAS_IN source value is BAD,
or CP-FBM communications failure

CAS_IN.status.OOS ← CAS_IN.Status.Bad (Bits 6-7=0)


and Substatus.OOS (bits2-5= 7),
or CAS_IN source value is OOS,
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
CHANNL ↔ CHANNEL
DPTI1 ↔ XD_SCALE decimal pt
DPTO1 ↔ PV_SCALE decimal pt
EUI1 ↔ XD_SCALE units index
EUO1 ↔ PV_SCALE units index

62
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table 2-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
FSTIME ↔ FSTATE_TIME
FSVAL ↔ FSTATE_VAL
HSCI1 ↔ XD_SCALE @ 100%
HSCO1 ↔ PV_SCALE @ 100%
IOOPTS ↔ IO_OPTS
LSCI1 ↔ XD_SCALE @ 0%
LSCO1 ↔ PV_SCALE @ 0%
MAN_SW MODE_BLK.Target
When MAN_SW = 1:
Set MODE_T (request) = MAN
Set CAS_SW=0, AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permitted
MODE_T MODE_BLK.Target
MODE_T.value (request) ← MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW is set =1:
Set MODE_T (request) = OOS
Set CAS_SW=0, AUT_SW=0, MAN_SW=0
Write MODE_T (request) to FBM
OUT OUT
OUT.value (request) → OUT.Value (in MAN mode only)
OUT.value (actual) ← OUT.Value
OUT.status.LHI ← OUT.Status.Limited Hi (Bit 0)
OUT.status.LLO ← OUT.Status.Limited Lo (Bit 1)
OUT.status.ERR ← OUT.Status.Uncertain (Bits 6-7=1)
OUT.status.BAD ← OUT.Status.Bad (Bits 6-7=0) or CP-FBM communication failure
OUT.status.OOS ← OUT.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
OUTSTS OUT
OUTSTS.value ← OUT.Status

63
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

Table 2-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
PV PV
PV.value ← PV.Value
PV.status.LHI ← PV.Status.Limited Hi (Bit 0)
PV.status.LLO ← PV.Status.Limited Lo (Bit 1)
PV.status.ERR ← PV.Status.Uncertain (Bits 6-7=1)
PV.status.BAD ← PV.Status.Bad (Bits 6-7=0) or CP-FBM communication failure
PV.status.OOS ← PV.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
PVSTS PV
PVSTS.value ← PV.Status
RBK READBACK
RBK.value ← READBACK.Value
RBK.status.LHI ← READBACK.Status.Limited Hi (Bit 0)
RBK.status.LLO ← READBACK.Status.Limited Lo (Bit 1)
RBK.status.ERR ← READBACK.Status.Uncertain (Bits 6-7=1)
RBK.status.BAD ← READBACK.Status.Bad (Bits 6-7=0) or
CP-FBM communication failure
RBK.status.OOS ← READBACK.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
RBKSTS READBACK
RBKSTS.value ← READBACK.Status
SHEDOP ↔ SHEDOP

64
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table 2-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
SP SP
SP.value (request) → SP.Value (in AUTO mode only)
SP.value (actual) ← SP.Value
SP.status.LHI ← SP.Status.Limited Hi (Bit 0)
SP.status.LLO ← SP.Status.Limited Lo (Bit 1)
SP.status.BAD ← SP.Status.Bad (Bits 6-7=0) or CP-FBM communication failure
SP.status.OOS ← SP.Status.Bad (Bits 6-7=0) a and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
SPHLIM SP_HI_LIM
SPHLIM.value (request) → SP_HI_LIM.Value
SPHLIM.value (actual) ← SP_HI_LIM.Value
SPHLIM.status.OOS ← SPHLIM source value is OOS,
or Compound is Off,
or FBM228 is Off-Line,
or CP-FBM communication failure
SPLLIM SP_LO_LIM
SPLLIM.value (request) → SP_LO_LIM.Value
SPLLIM.value (actual) ← SP_LO_LIM.Value
SPLLIM.status.OOS ← SPLLIM source value is OOS,
or Compound is Off,
or FBM228 is Off-Line,
or CP-FBM communication failure
SPSTS SP
SPSTS.value ← SP.Status
STOPTS ↔ STATUS_OPTS
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC ← TAG_DESC
Note: Changes to TAGDSC are copied to DESCRP.

2.6 AO Block Functions


With each execution, the device AO function block’s CAS_IN parameter receives a value either
from an I/A Series system control block (via CIH mode) such as PIDA, or another device func-
tion block (via CIF mode), such as PIDFF. The AO block also reads the value and status from the
device function block’s BKCAL_OUT parameter.
The AO block does not scale or condition the output to the device, as scaling for engineering
units is handled by the function block. The AO block does, however, enable you to set the values
for the device function block’s PV_SCALE and XD_SCALE parameters.

65
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

2.6.1 Device Function Block Connection


The configured parameter IOM_ID of the AO block specifies an ECB201 (the device ECB) that
represents the target H1 device. The ECB201 PARENT parameter identifies the ECB200 or
ECB202 for the FBM228. The path to the device block is completed as follows. When the AO
block is configured using IEE, the device function block is selected in a browser which displays
the device function blocks based on the device description in the device ECB. If the connection is
not made via the browser, it is made based on the AO block BLKNDX parameter.
To assign function blocks to their device, refer to “Assign the Function Blocks to a Device” in
InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA).

2.6.2 Device Configuration Parameters


The AO block enables you to set the standard configurable parameters in the device function
block and manage the device configuration from the I/A Series system control database. When
you deploy the AO block to the control station, and then download to the FBM228, parameter
values in the AO block update parameters in the linked device AO block.
The deployment of the AO block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Configure a Compel Data (CD) message for each macrocycle to write the AO block
CAS_IN parameter to the device function block CAS_IN parameter
♦ Schedule execution of the device function block
♦ Configure a CD message for each macrocycle to publish the device function block’s
BKCAL_OUT to be read by the AO block BCALCO parameter.
♦ Schedule client/server connections between the AO block and the device function
block for view updates.
Table 2-11 lists the device function block parameters and the AO block parameters used to con-
figure them. For the AO block, the table includes both the six-character (maximum) parameter
name that is used in block detail displays and parameter labels which more closely resemble the
FOUNDATION fieldbus parameter names. Use the six-character parameter name when connecting
parameters to a process display.

Table 2-11. AO Block Configuration Parameters

Configured with AO Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
CHANNEL CHANNL Channel
FSTATE_TIME FSTIME Fstate_Time
FSTATE_VAL FSVAL Fstate _Val
IO_OPTS IOOPTS Io_opts
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
PV_SCALE.Decimal Point DPTO1 PV_decpt
PV_SCALE.EU at 100% LSCO1 PV_scale@0
PV_SCALE.EU at 100% HSCO1 PV_scale@100

66
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table 2-11. AO Block Configuration Parameters (Continued)

Configured with AO Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
PV_SCALE.Units Index EUO1 PV_eu
SHED_OPTS SHEDOP Shed_opt
SP SP SP
SP_HI_LIM SPHLIM Sp_hi_lim
SP_LO_LIM SPLLIM Sp_lo_lim
STATUS_OPTS STOPTS StatusOpt
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc
XD_SCALE.Decimal Point DPTI1 XD_decpt
XD_SCALE.EU at 0% LSCI1 XD_scale@0
XD_SCALE.EU at 100% HSCI1 XD_scale@100
XD_SCALE.Units Index EUI1 XD_eu

The following are suggested and required AO parameter settings:


♦ Configure MODE_P to include at least Cascade, Auto, and Out of Service.
Other modes are optional.
♦ Set MODE_T to Cascade and Auto.
♦ Configure IOOPTS to include SP_PV Track in LO (required), and FS to Value and
Use FS on Restart (recommended).
♦ Use the STOPTS parameter to set the STATUS_OPTS: Propagate Fail Backward
(required).
♦ Configure SHEDOP to Normal Shed, Normal Return.
♦ Set the Fault State option in the resource block’s FEATURE_SEL parameter.

2.6.3 Scaling
Table 2-12 lists AO block parameters used to set the device function block scaling parameters.

Table 2-12. Scaling Parameters

AO Block Device Function Block


LSCO1 ↔ PV_SCALE.@0%
HSCO1 ↔ PV_SCALE.@100%
DPTO1 ↔PV_SCALE Decimal
EUO1 ↔ PV_SCALE Units Index
LSCI1 ↔ XD_SCALE.@0%
HSCI1 ↔ XD_SCALE.@100%
DPTI1 ↔ XD_SCALE Decimal
EUI1 ↔ XD_SCALE.Units Index

67
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

2.6.4 Block Validation


The I/A Series AO block initializes when any of these events occur:
♦ The block is installed or reconfigured via the IEE control configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.
When the AO block initializes, the following block validation tests are performed:
♦ A cross-over validation test of the XD range is performed. If HSCI1 < LSCI1, the
block is marked undefined (BLKSTA.UDEF=1) with the error code parameter
(ERCODE) set to “W44 - INVALID ENGINEERING RANGE”.
♦ A cross-over validation test of the PV range is performed. If HSCO1 < LSCO1, the
block is marked undefined (BLKSTA.UDEF=1) with ERCODE set to “W44 -
INVALID ENGINEERING RANGE”.
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Cascade,
Auto, Manual or Out-of-Service, or if the Target mode is not one of the Permitted
states, the block is marked undefined (BLKSTA.UDEF=1) with the ERCODE set to
“W76 - INVALID FF MODE CONFIGURATION”.
If the FBM simulation is not used (SIMOPT=0), the following validation tests are performed:
♦ If the AO block is installed prior to the installation of the ECB201 block, it is marked
undefined (BLKSTA.UDEF=1) with ERCODE set to “W54 - ECB DOES NOT
EXIST”. In this case, the AO block configuration is restarted and re-validated auto-
matically when the ECB201 is installed.
♦ An attempt is made to connect the AO block to the ECB201 specified in the
IOM_ID parameter. The DCI connection address (i.e., the BLKNDX parameter in
the AO block) is used in a connect message to establish a block connection in the
FBM228.
♦ If the device block connection cannot be resolved due to a lack of configuration infor-
mation, one of the following error strings is stored in the AO block ERCODE
parameter:
♦ “W62 - UNRESOLVED CONNECTION”
♦ “W77 - FIELDBUS COMMUNICATIONS FAULT”
♦ “W78 - INVALID FUNCTION BLOCK”
♦ “W80 - FIELDBUS DEVICE NOT FOUND”
♦ “W82 - FF CONFIGURATION IN PROGRESS”
(In these cases, the AO block is defined, but the output values are marked OOS.)
♦ “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the AO block is defined, and the index of the invalid function block
parameter is stored in the CFGERR parameter.)
♦ If the AO data connection cannot be made for any other reason, the FBM rejects the
connection request and one of the following error strings is stored in the ERCODE
parameter to indicate the reason for the connection error:

68
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

♦ “W65 - INVALID POINT ADDRESS”


♦ “W66 - DUPLICATE CONNECTION”
♦ “W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS”
♦ “W68 - INVALID DEVICE CONNECTION”
♦ “W69 - INVALID POINT CONNECTION”
♦ “W74 - FF FUNCTION BLOCK DDITEM MISMATCH”
♦ “W75 - FF FUNCTION BLOCK DDMBR MISMATCH”
♦ “W76 - INVALID FF MODE CONFIGURATION”
♦ “W79 - INVALID PARAMETER INDEX”
♦ “W83 - INVALID FF PARAMETER CONNECTION”
♦ “W84 - INVALID FF PARAMETER TYPE”
♦ “W85 - INVALID CONNECTION TYPE”
♦ “W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH”
(In these cases, the I/A Series AO block is undefined.)
♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the AO
block is undefined with ERCODE set to “W43 - INVALID PERIOD/PHASE
COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the AO
block is undefined with ERCODE set to “W81 - INVALID PARENT DCI ECB
PERIOD/PHASE”.
If there are no configuration errors when the I/A Series AO block is installed, the block is marked
defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the compound containing the
block is turned on, the block also initializes and starts running automatically.

2.6.5 Block Initialization


When the I/A Series AO block initializes, the following are performed:
♦ All alarm status parameters (ALMSTA, INHSTA, CRIT, PRTYPE, UNACK) are
cleared.
♦ All parameter history values are initialized to the current parameter settings.
♦ The Target mode parameter (MODE_T) is set to only one of the following states, in
order, if multiple bits are set: Cascade, Auto, Manual, OOS.
If not simulating (SIMOPT=0), the following are performed:
♦ The Target mode is sent to the device AO function block.
♦ If installing the block, or if rebooting and not a Warm Restart, the following occurs:
1. The Tuning and Configuration parameters are downloaded to the device AO function
block.
2. The Actual mode parameter (MODE_A) is set to Initialization Manual (IMAN) in
the AO block.
3. The PVSTS, SPSTS, and OUTSTS parameters are set to Bad OOS.

69
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

2.6.6 Block Modes


The AO block provides interactive support of the MODE_BLK function block parameter. The
Target, Permitted, Normal, and Actual modes are provided as separate MODE_T, MODE_P,
MODE_N, and MODE_A block parameters, respectively.
The configuration of the Target, Permitted, and Normal modes are supported. These parameters
are downloaded to the device AO function block when the I/A Series AO block initializes.
The Target mode can be changed through a group of settable Boolean mode switches provided in
the I/A Series AO block. These mode switches, CAS_SW, AUT_SW, MAN_SW, and OOS_SW,
allow the block mode to be changed to the Cascade, Auto, Manual, or Out-of-Service states
respectively.
The mode switch setting is mapped onto an equivalent Target mode setting sent to the FBM228.
Logic in the CP270 prevents more than one switch to be set at a given time. If more than one
switch is set during the same block cycle, only the last switch setting is honored. Once set, a mode
switch remains set only until the Target mode change is sent to the FBM228 or until another
mode switch is set. At that time, the mode switch is cleared.
The Target mode is updated from the MODE_BLK function block parameter read back during
input scanning of the FBM228.
When the Actual, Permitted, Target, or Normal modes change in the device AO function block,
the corresponding I/A Series AO block mode parameters are updated automatically from the
MODE_BLK function block parameter. In addition, the Actual mode is mapped onto equivalent
BLKSTA parameter bits.
The INITMA parameter and the Auto/Manual override parameters, AUTSW and MANSW, are
not supported in the I/A Series AO block, since these functions do not exist in the device AO
function block.
The Actual block mode (MODE_BLK.Actual) is provided in two forms:
♦ The Actual mode is stored in the MODE_A output parameter.
♦ The Actual mode also is mapped onto equivalent bits in the BLKSTA block status
parameter.
The mapping of Actual mode state to BLKSTA bits are as follows
♦ The OOS state is mapped onto the OOS value status bit of the BLKSTA parameter.
♦ The IMAN state is mapped onto the BLKSTA.TRK status bit.
♦ The LO state is mapped onto both the BLKSTA.TRK and BLKSTA.LO status bits.
♦ The MAN state sets BLKSTA.MA=0 and BLKSTA.LR=0.
♦ The AUTO state sets BLKSTA.MA=1 and BLKSTA.LR=0.
♦ The CAS state sets BLKSTA.LR=1 and BLKSTA.MA=1.

2.6.7 Input Connections


The CP270 supports connections to the inputs in the I/A Series AO block from connectable
input or output parameters of any I/A Series control or I/O block. These inputs are updated each
block cycle from data in the I/A Series source block parameter.

70
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

The CP270 propagates the BAD, OOS, and ERR status of these input parameters to their corre-
sponding device function block parameters by writing the status to the FBM228 when a change
occurs.
When the Update Source of an input connection is not a device function block parameter, the
BlockName specified in the connection is the name of the I/A Series block; the ParameterName
is the 1-6 character name of the parameter in the I/A Series block.
The CP270 also supports connections to specific inputs in the AO blocks from parameters con-
tained in device function blocks mapped to any standard I/A Series control or I/O block. These
inputs are updated each block cycle from data in the device function block parameter; the data
contained in the specified I/A Series source parameter will not be used. The inputs of this type are
listed in Table 2-13 below.
When the source of an input connection is a device function block parameter, the I/A Series block
connection is made by the CP270, and the source BlockName and ParameterName are extracted
from the connection and appended to a connect message. This message is sent to the FBM228 to
establish a fieldbus connection to the function block source parameter.
When the source of an input connection is a device function block parameter, the BlockName is
the TagName of the device function block, which is the same as the name of the source I/A Series
block. The ParameterName is the 1-6 character name of the parameter in the source I/A Series
block for those connections listed in Table 2-14 below. In these cases, the name of the I/A Series
block parameter is converted to the equivalent function block parameter index by the CP270
prior to appending it to the connect message. In all other cases, the ParameterName must be con-
figured to be the parameter index of the function block parameter.
If the fieldbus connection cannot be made due to an invalid BlockName or ParameterName, the
ERCODE parameter in the block is set to the following text and the block is undefined:
“W83 - INVALID FF PARAMETER CONNECTION”

Table 2-13. AO Input Connections

AO Input Parameter(s) Connection Source Update Source


CAS_IN I/A Series parameter in I/A Series I/A Series source block parameter
control block or I/O block
FF parameter in I/A Series FF FF function block parameter
block
Any other input I/A Series parameter in I/A Series I/A Series source block parameter
control block or I/O block

71
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

Table 2-14. Standard FF Block Parameter Connections

Input Parameter Source Parameter


Block Type Parameter Block Type Parameter Name Parameter Index
PIDFF IN AI OUT 8
MAI OUT1-OUT8 8-15
CAS_IN PIDFF OUT 9
FFVAL AI OUT 8
MAI OUT1-OUT8 8-15
TRKVAL AI OUT 8
MAI OUT1-OUT8 8-15
TRKIND DI OUT_D 8
MDI OUT_D1- 8-15
OUT_D8
BCALCI AO BCALCO 25
PIDFF BCALCO 31
AO CAS_IN PIDFF OUT 9

2.6.8 I/A Series Parameter Status


The status of the device AO function block parameters is provided in the I/A Series AO block in
two forms:
♦ The status of each device function block parameter is available as a separate I/A Series
AO block parameter.
♦ The status of each device function block parameter also is mapped onto equivalent
fields in the value record status of the corresponding I/A Series AO block parameter.
For each device function block parameter containing status information, the following fields are
mapped:
♦ The Quality field (Bits 6-7) is mapped onto the BAD and ERR status bits.
♦ The Sub-status field (Bits 2-5) is ignored, except for the case when the Quality is Bad
and the Sub-status is OOS. In this case, the OOS status bit is set in the I/A Series AO
block parameter.
♦ The Limited High (Bit 0) and Limited Low (Bit 1) fields are mapped onto the LHI,
LLO status bits, respectively.

2.6.9 Device Parameter Status


The device analog output function block OUT and PV parameters have both a value and a status.
The status is contained in a 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits. The
status is read into the AO block parameter, bit for bit. The default displays for the AO block

72
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

shows the converted status parameter so that the value need not be decoded. Table 2-15 shows
how the status byte is formatted.
Table 2-15. Device Parameter Status Format

Bits Description
0-1 Limits:
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 SubStatus depends on .Quality, as shown in Table 2-16
6-7 Quality:
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table 2-16 shows the usage of the Substatus bits, which varies depending on the bits set
in .Quality.

Table 2-16. Device Parameter Substatus

Bits 2-5 = SubStatus and Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced in by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.

73
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

Table 2-16. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus and Description


3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.
4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.

74
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table 2-16. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus and Description


8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

2.6.10 Fault State Handling


Three distinct Fault State options can be configured in the FSOPTN parameter in the I/A Series
AO block:
♦ Initiate Fault State upon loss of CP communications (Bit 2=1)
♦ Initiate Fault State if Bad CAS_IN (Bit 0=1)
♦ Initiate Fault State if SETFS (Bit 1=1)
The Initiate Fault State upon loss of CP communications (Bit 2=1) option is used only by the
FBM228 logic to assert the fault state when CP-to-FBM communications are lost. To support
this option, a Fault State enable (FSENAB) and a Fault State timer (FSDLAY) may be configured
in an ECB200 or ECB202. The Fault State timer counts down periodically between its receipt of
read/write messages. When either message is received for a device AO function block, its fault
state timer is reset to the FSDLAY value. If the Fault State timer expires, the FBM228 sets the IFS
status bit of the CAS_IN of the device AO function block, driving the field output to the
FSTATE_VAL value configured in the AO block. When the CP communications are restored, the
Fault State timers are reset automatically to full value by the first read or write message to each
connection. If the Fault State had been previously asserted by a request from the CP and the Fault
State condition still exists in the CP, the write message requests the IFS status bit to remain set in
the function block. Otherwise, the write message requests the IFS status bit to be cleared.
If the Initiate Fault State if Bad CAS_IN (Bit 0=1) option is set, the CP270 requests the FBM228
to assert the Fault State when the CAS_IN parameter is sourced by an I/A Series parameter and
the CAS_IN is BAD, OOS, or has a broken linkage to the source parameter.
If the Initiate Fault State if SETFS (Bit 1=1) option is set, the CP270 requests the FBM228 to
assert the Fault State when the CAS_IN parameter is sourced by an I/A Series parameter and the
SETFS parameter is set.
In either of the two latter cases, when the FBM receives an explicit request from the CP to assert
the Fault State, the FBM sets the IFS status bit of the CAS_IN parameter of the device AO func-
tion block, driving the field output to the FSTATE_VAL value configured in the AO block. These
actions are taken independent of the FSENAB option.
In addition, the CP270 requests the FBM228 to assert the Fault State in these cases:
♦ When the I/A Series AO block is deleted, if any of the FSOPTN options are config-
ured in the block.
♦ When the compound containing the I/A Series AO block is deleted, if any of the
FSOPTN options are configured in the block.
♦ When the compound containing the I/A Series AO block is turned off, if any of the
FSOPTN options are configured in the block and the Station block CFGOPT option
Bit 4 is set to 0.
In addition to the Fault State options in the FSOPTN parameter, options may be configured in
the IOOPTS, FSTIME, and FSVAL parameters to specify Fault State actions to be performed in
the device AO function block.

75
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

The device Fault State options are designed primarily to deal with communication failures above
the device, while working in concert with ECB options. Enabling Fault State is effective under
two external conditions
♦ When Faultstate is asserted by the connected FBM
♦ When communications to the device are lost and the device AO function block mode
is CAS.
The actual Fault State behavior taken by the device AO function block is specified in the parame-
ters listed in the table below.

Table 2-17. Fault State Parameters in the Device AO Function Block

I/A Series
Parameter Description
IOOPTS Configures the device block parameter IO_OPTS to enable/disable two
Fault State options:
1) Fault State on Restart: Selecting this option causes the device to go to
the value specified in FSTATE_VAL on a device RESTART. If this option
is not selected and the device block can go to its target mode upon
RESTART, the last saved setpoint (SP) is used for generating the Faultstate
position.
2) Fault State to Value: When this option is selected, the block uses the
value specified in FSTATE_VAL. When the option is not selected, the last
saved setpoint is used.
FSVAL Configures FSTATE_VAL in the device AO function block, specifying the
value that is asserted when one of the Fault State options is invoked.
FSTIME Configures FSTATE_TIME in the device AO function block, setting the
period that the fault condition must last before the block asserts the speci-
fied value. A Fault State action does not occur until the FSTATE_TIME
interval has expired.

NOTE
An additional requirement for Fault State handling at the device level is that the
Fault State option must be selected in the device resource block, that is,
(0x4)FaultState must be selected in FEATURE_SEL.

2.6.11 Block Alarming


The AO block performs alarm functions consistent with standard CP270 alarming. This includes
the following types of process alarms:
♦ Bad Alarming of the BCALCO output.
♦ Informational messages of block errors (BLKERR) reported by the device AO func-
tion block BLOCK_ERR parameter.
♦ Informational messages of function block configuration errors (CFGERR).
The device AO function block alarm detection, alarm events, alarm messaging, and associated
parameters provided by the field device are not supported in the I/A Series AO block.

76
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

2.6.12 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter is performed as
follows:
♦ For every condition specified in ERROPT, a corresponding Informational message is
sent to the ERRGRP alarm group when the condition occurs. The UNACK parame-
ter and the corresponding ALMSTA.UNACK bit also are set. ERROPT has the same
format as BLKERR (Table 2-4 on page 45).
♦ One of the messages listed in Table 2-18 is generated.

Table 2-18. Block Error Messages

ERROPT Bit Message Text


Bit 0 FF Block Error: Out-of-Service
Bit 1 FF Block Error: Power Up
Bit 2 FF Block Error: Maintenance Needed Now
Bit 3 FF Block Error: Readback Check
Bit 4 FF Block Error: Lost NV Data
Bit 5 FF Block Error: Lost Static Data
Bit 6 FF Block Error: Memory Fail
Bit 7 FF Block Error: Output Fail
Bit 8 FF Block Error: Input Fail
Bit 9 FF Block Error: Maintenance Due Soon
Bit 10 FF Block Error: Fault State Active
Bit 11 FF Block Error: Local Override
Bit 12 FF Block Error: Simulation Active
Bit 13 FF Block Error: Link Configuration Error
Bit 14 FF Block Error: Block Configuration Error
Bit 15 FF Block Error: Other (Undefined) Error

2.6.13 Configuration Error Processing


When an FF block configuration parameter cannot be downloaded into the field device, the
parameter index is stored in the CFGERR parameter and the following informational message is
generated:
“FF CFGERR in Parameter nnnnnnnn”
where: nnnnnnnn = ASCII name of the parameter indicated by the index in CFGERR

2.6.14 Bad Alarming


If the Bad Alarm option (BADOPT) is set, alarming is performed as follows:
♦ Bad Alarm status information is set in the block when the BAD status of the
BCALCO parameter is set. The BAD bit is set in the alarm status parameter
(ALMSTA.BAD). The UNACK parameter and the corresponding
ALMSTA.UNACK bit also are set.
♦ The CRIT parameter and its corresponding ALMSTA.CRIT field are set to the
BADPRI parameter value, and the PRTYPE parameter and its corresponding
ALMSTA.PRTYPE field are set to the appropriate alarm type.

77
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

♦ When the Bad Alarm condition occurs, a Bad Alarm message is sent to all devices in
the BADGRP alarm group. This message contains the OUTDSC output descriptor,
the BADTXT descriptive text, and the LOOPID loop identifier.
♦ When the Bad alarm condition clears, a return-to-normal message is generated and
sent to all devices in the bad alarm group.
The CRIT, PRTYPE, and corresponding ALMSTA fields are cleared when there are no active
alarms in the block.
The UNACK parameter and the ALMSTA.UNACK bit are cleared in these cases:
♦ When the alarm is acknowledged by an OM set operation at either the compound
level, by setting the compound UNACK=0, or at the block level, by setting the block
UNACK=0.
♦ When all alarm conditions in the block return to normal status, if INHOPT is set
appropriately.
♦ When the block is shut down.
When UNACK is cleared, an Alarm Acknowledge message is generated and sent to all devices in
all alarm groups in the block.
Alarm Inhibiting/Disabling is supported using a combination of the compound CINHIB param-
eter and the INHOPT, INHIB, and INHALM parameters in the I/A Series AO block, to allow
the alarm messages to be inhibited and/or alarm detection to disabled dynamically.
When an alarm type is inhibited or disabled, an appropriate Alarm Disable message is generated
and sent to all devices in the alarm group. If the block is unacknowledged, an Alarm Acknowledge
message also is sent to these devices. In addition, the ALMSTA.INHIB bit is set, and the corre-
sponding INHSTA bit is set.
When an alarm type is uninhibited or enabled, an appropriate Alarm Enable message is generated
and sent to all devices in the alarm group. In addition, the ALMSTA.INHIB bit is cleared if no
other alarm in the block is inhibited, and the corresponding INHSTA bit is cleared.
The Alarm Reprioritization and Alarm Message Regeneration (using AMRTIN) enhancements
also are supported in the I/A Series AO block. Refer to the CP270 Integrated Control Concepts
(B0700AG) user document for details.

2.6.15 Block Shutdown


The AO block shuts down when any of these events occur:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ The ECB201 connected to the block is deleted.
♦ The AO block itself is deleted.
When block shutdown occurs, the following actions are taken:
♦ If any alarms are active, an Alarm Disable message is issued to all devices in the bad
alarm group. If the alarms are unacknowledged, an Alarm Acknowledge message also
is sent to these devices.
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, UNACK) are cleared.
If not simulating (SIMOPT=0) and the compound is off, the following actions are taken:

78
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

1. If the FF_OOS_OPT bit (Bit 4: 0x0010) is set in the Station block CFGOPT param-
eter, the following additional actions are taken:
♦ The actual mode parameter (MODE_A) is set to OOS.
♦ A write message is sent to the FBM228 with both the OOS and IMAN bits set in
the Target mode. The IMAN bit is set to indicate to the FBM228 that the com-
pound is off.
♦ Otherwise, a write message is sent to the FBM228 with only the OOS bit set in
the Target mode.
2. Otherwise, the following action is taken:
♦ A write message is sent to the FBM228 with both the current state and the IMAN
bits set in the Target mode. The IMAN bit is set to indicate to the FBM228 that
the compound is off.

2.6.16 Simulation
The I/A Series AO block SIMOPT parameter enables simulation of an analog input to the con-
trol system from the corresponding analog input device function block. This feature can be used
to test control schemes requiring analog inputs without actual FBM228 hardware connections.
When SIMOPT= 1 (True), the status and value of OUT are not recovered from the field, but can
be set directly to simulate input from the field.
When simulating (SIMOPT=1), the following functions will be performed:
♦ The CAS_IN input is stored in the OUT output value when the block mode is Auto.
♦ The OUTSTS output status parameter is set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (CAS_SW, AUT_SW, MAN_SW,
or OOS_SW) immediately update the target mode parameter (MODE_T), and the
actual block mode (MODE_A) tracks MODE_T each block cycle.
♦ If the Bad Alarm option is specified (BADOPT =1), bad alarming of the BCALCO
parameter is performed.
When simulating, the following functions are not performed:
♦ Downloading of configuration parameters.
♦ Updating of View data parameters.
♦ Block Error (BLKERR) processing.
♦ External configuration changes to function block parameters.
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA) or Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for
instructions on conducting control simulations from the control station.

2.6.17 Block States


The DCI blocks transition through the states detailed in Table 2-19 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 47).

79
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

Table 2-19. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

80
2. AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

2.7 AO Block Application Example


The AO block can be used in any control block configuration, in any compound except the Sta-
tion compound and the Primary ECB compound, in any CP270. It only can be connected to any
device AO function block in a field device hosted by an FBM228, but not to any other device
function block type or to any function block parameter.
Each field device connection must be specified by configuring the name of the ECB201 in the
IOM_ID parameter. The device AO function block connection must be specified by configuring
the AO function block index in the BLKNDX parameter.
Figure 2-2 illustrates an example of the AO block’s use in applications.

Parent ECB200/202
(FBM228)

Child ECB201 Child ECB201


(FF H1 Device) (FF H1 Device)

PARENT PARENT

IOM_ID
NAME

AI Block PIDA Block

MEAS OUT MEAS OUT


SPT
BCALCI

IOM_ID IOM_ID
NAME NAME

AI Block PIDA Block AO Block

MEAS OUT MEAS OUT CAS_IN


RSP
BCALCI BCALCO
BCALCO

Figure 2-2. Application Example with I/A Series AO Block

81
B0700EC – Rev B 2. AO – Foundation™ fieldbus Analog Output

82
3. DI – FOUNDATION™ fieldbus
Discrete Input
This chapter describes the I/A Series Discrete Input (DI) block, which interfaces the control
system with a corresponding discrete input function block operating in a FOUNDATION™
fieldbus H1 device.

3.1 Overview
Discrete Input (DI) is a Distributed Control Interface (DCI) block that provides an interface
between the control processor and a discrete input function block operating in a FOUNDATION
fieldbus H1 device (the device function block). The DI block is supported on the FCP270 and
ZCP270 when the H1 device is connected to the control station by an FBM228. The DI block
is configured using the Block Configurator in the InFusion Engineering Environment (IEE) as
described in InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion
2.0 (B0750DA).

NOTE
The DI block functionality described in this chapter is applicable only for
FBM228s with the software type (SWTYPE) of “128”. For a description of the leg-
acy DI block functionality (I/A Series systems v8.4.3 or earlier) where FBM228s
have the SWTYPE of “228”, refer to Appendix C “Legacy DI – Foundation™
fieldbus Discrete Input”.

3.2 Basic Operation


The DI block integrates the corresponding device function block into the I/A Series system. On
initialization, user-configured values in the DI block are written to the standard configurable
parameters in the corresponding device function block. During normal operation, the DI block
maintains a publisher/subscriber connection with the device function block to read the value and
status of the device block’s primary output (OUT_D). In addition, the DI block provides access
to a variety of operational and diagnostic information via client/server connections with the
parameters that are included in the views of the device block. The values read from these parame-
ters are displayed in the block detail displays and are available for connection to other I/A Series
blocks.

3.3 Features
The DI block provides the following features:
♦ Acquires the device DI function block’s primary output value and status
♦ Time stamps value and status changes to the block’s output

83
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

♦ Accesses the parameters in the device function block’s views using change-driven and
periodic client/server connections
♦ Ensures that changes in the device function block’s process values and error conditions
are continuously available for display and connection to the control strategy.
♦ Provides for the configuration of device function block parameters from the I/A Series
system and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Auto, Manual or Out of
Service
♦ Provides alarm detection and reporting for Bad I/O
♦ Supports simulation of the device function block output within the control station

3.4 Block Parameters


Table 3-1 lists the block parameters. See Table 3-11 for mappings between DI block
parameters and their device function block equivalents.

Table 3-1. DI Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 119 119 (DI)
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 13
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0 to 1
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path
name <= 25 chars
or ECB block
name <=12 chars
IOOPTS I/O options packed bool- no-con/no-set 0x00 0 to 0xFF
ean
CHANNL channel integer no-con/no-set 1 0 to 32767
DDITEM DD item long no-con/no-set 0x80020210
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000 0 to 2147483647
STRATG strategy integer no-con/no-set 999 0 to 65535
PVFTIM PV filter real no-con/no-set 2.0
STOPTS status options packed bool- no-con/no-set 0x1080 0 to 0xFFFF
ean
OUT_ST output state integer no-con/no-set 0 0 to 32767
XD_ST XD state integer no-con/set 0 0 to 32767
MODE_N normal mode short integer no-con/set 0x10 0 to 0xFF
MODE_P permitted mode short integer no-con/set 0x19 0 to 0xFF
MODE_T target mode short integer no-con/set 0x10 0 to 0xFF
IN simulation input integer con/no-set 0 0 to 255

84
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table 3-1. DI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


INHOPT inhibit option short integer no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/n0-set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short integer con/no-set 1 1 to 8
BADOPT bad alarm option boolean no-con/no-set 0 0 to 1
BADGRP bad alarm group short integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 1 to 32 chars
OUTDSC output descriptor string con/no-set blank 1 to 32 chars
DSCOPT discrete alarm option boolean no-con/no-set 0 0 to 1
DSCGRP discrete alarm group short integer no-con/no-set 1 1 to 8
DSCPRI discrete alarm priority integer con/set 5 1 to 5
DSCLIM discrete alarm limit short integer no-con/no-set 0 0 to 255
DSCTXT discrete alarm text string no-con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration integer no-con/set 0 0 to 32767
interval
NASTDB nuisance alarm long integer no-con/set 0 0 to 2147483647
suppression deadband
NASOPT nuisance alarm suppres- boolean no-con/set 0 0 to 1
sion option
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to 2147483647
DVC_ID device ID integer no-con/no-set 0 0 to 0xFFFF
DVCREV device revision long integer no-con/no-set 0 0 to 2147483647
BLKNDX block index long integer no-con/no-set 0 0 to 2147483647
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to 0xFFFFFFFF
AUT_SW auto switch boolean con/no-set 0 0 to 1
BLKERR block error packed bool- con/no-set 0 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0-0xFFFFFFFF
CRIT criticality integer con/no-set 0 0 to 5
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode short integer con/no-set 0 to 0xFF
OOS_SW out of service switch boolean con/set 0 0 to 1
OUTSTS output status packed bool- con/no-set 0 0 to 0x00FF
ean
OUT_D discrete output integer con/set, settable 0 0 to 255
only in Manual
PRTYPE priority type integer con/no-set 0 0, 8, 9
PVSTS process variable status packed bool- con/no-set 0 0 to 0x00FF
ean

85
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

Table 3-1. DI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


BSTATE block state integer con/no-set 0 0 to 11
DEVACK device acknowledge boolean con/set 0 0, 1
PV_D discrete process variable integer con/no-set
TSTAMP time stamp long integer con/no-set 0 ms after midnight
UNACK unacknowledged boolean con/set 0 0, 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
CFGERR configuration error short integer no-con/no-set 0
DEFINE no config errors boolean no-con/no-set 1 ---
DESCRP descriptor string no-con/no-set blank 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for each
(array 1x255) element
FDATA2 file data bytes 256 to 510 short integer no-con/no-set all 0s 0 to 255 for each
(array 1x255) element
LOCKID lock identifier string no-con/no-set 2 blanks 8 to 13 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
ST_REV status revision integer no-con/no-set 2 blanks 0 to 65535

3.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT Alarm Options contain packed long values representing the alarm types
that have been configured as options in the block, and the alarm groups
that are in use. Table 3-2 shows how the parameter is used by the DI
block.

Table 3-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use

86
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table 3-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
22 Bad I/O Alarm Configured
26 Discrete Alarm Configured
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table shows the bits used by the DI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9
DSC

CRIT PRTYPE
BAD
INH

Table 3-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the DI
block
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
22 BAD Bad I/O Alarm ALMSTA.B10
26 DSC Discrete State Alarm ALMSTA.B6
29 INH Inhibit Alarm. This bit is set when ALMSTA.B3
any of the block’s alarms is inhibited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and thus the MODE_BLK.Target1 in the associated device
function block, to Auto.
1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

87
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the FF block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the DI
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block. Table 3-4
shows the parameter format.

Table 3-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device function block represented by the DI block. It is set by
the configurator and the FBM uses it to identify the block in the device.

88
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 3-5 shows how the bits are used by the DI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DEVACK B9

FDFAIL
FDACT
FDMM
FDOK

UDEF

FBM

TRK
LCK

FFX

BIO
ON

MA

LO
FS Table 3-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local BLKSTA.B29
Override
6 TRK The block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual Mode
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
11 MA The device block mode is Auto BLKSTA.B21
12 BIO Bad I/O BLKSTA.B20
14 UDEF The block is undefined BLKSTA.B18
15 ON The compound that contains the block BLKSTA.B17
is ON
16 FFX Enhanced FF block connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FBM228 The host FBM for the H1 device is an BLKSTA.B13
FBM228
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK FDATA installed BLKSTA.B11
22 FDMM FDATA mismatch BLKSTA.B10
23 DEVAC Unacknowledged device alarm BLKSTA.B9
K
24 FS Fault State has been asserted in the BLKSTA.B8
device function block
*Bit 0 is the least significant, low order bit.

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the device block connection as determined by the

89
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

FBM228. The following values are used to indicate the current DCI block
state:
0 = Undefined state
1 = Unconnected
2 = Connecting
3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON-LINE
11 = Block ON-LINE with error - Processing has been completed, but
some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 114.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the DI block becomes undefined due to a
“W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.
See FF-890-1.4 for further details.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 92 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.

90
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

♦ To return DEFINE to a True value, correct all configuration errors


and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-configurable, non-connectable, non-settable ASCII


string of up to 32 characters used to specify a description for the DI block.
DESCRP tracks the TAGDSC parameter, and is updated when TAGDSC
is modified.

DEVACK Device Acknowledge is a settable boolean output used to acknowledge


device alarms in the associated device function block. DEVACK is set
when a device alarm status bit is set by the FBM228. DEVACK is cleared
by an operator action.
DEVACK is different from UNACK (described on page 98), which is
used by the operator to acknowledge process alarms in the DCI block.
DEVACK is used to acknowledge device alarms at the ECB201 or DCI
block level.

NOTE
This parameter is not supported currently.

DSCGRP Discrete Alarm Group is a configurable, non-settable short integer that


specifies the group used for reporting alarms messages from the DI block.

DSCLIM Discrete Alarm Limit is a configurable, non-settable short integer used to


specify the limit value to be used in the discrete alarm logic performed in
the DI block. It is equivalent to the DISC_LIM parameter in a device
function block; however, DSCLIM does not set the device block
parameter.

DSCOPT Discrete Alarm Option is a configurable non-settable Boolean used to


specify whether or not discrete alarming is to be performed in the block:
♦ 0 disables Discrete Alarming (default)
♦ 1 enables Discrete Alarming.

DSCPRI Discrete Alarm Priority is a configurable short integer input that specifies
the Alarm Priority to be assigned to discrete alarms in the block. It is setta-
ble if unlinked. The range is 1 (highest) to 5 (default).

DSCTXT Discrete Alarm Text is a configurable, non-settable string used as


descriptive text in DI block discrete alarm messages. The range is 1 to
32 ASCII characters.

DVC_ID Device Identifier is a configurable, non-settable integer that provides the


Device Identifier of the H1 field device that contains the device function
block represented by the DI block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device.

91
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

DVCREV Device Revision is a configurable, non-settable long integer that provides


the Revision level of the H1 field device that contains the device function
block represented by the DI block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device. The IEE
configurator encodes the following data in DVCREV:
Bits 16-23 Bits 8-15 Bits 0-7
Device revision Minimum Device Description Common File Format
(DD) File Revision (CFF) File Revision

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic. Table 3-6 lists the possible values of
ERCODE.
Table 3-6. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting block error (BLKERR)
messages in the DI block. The range is 1 (default) to 8.

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. The parameter has the same format as
BLKERR (Table 3-4).

92
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

FDATA1 File Data #1 and File Data #2 are settable multi-byte arrays that provide
FDATA2 configuration data for the device block represented by the DI block.
This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 510 bytes.

IN Simulation Input is a value used as the input to the DI block when simu-
lation is active (SIMOPT = 1). In this mode the DI block is disconnected
from the field device.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm
generation inhibit requests for each type of alarm configured in the block.
Table 3-7 shows how the bits are used by the DI block.
Table 3-7. INHALM Parameter Format

Boolean
Bit* Connection
(0 to 15) Description, When True (B16 to B1)
6 Inhibit Bad I/O Alarm INHALM.B10
10 Inhibit Discrete Alarm INHALM.B6
*Bit 0 is the least significant, low order bit.
There are no mnemonic names for the individual bits of INHALM.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

93
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table 3-8 shows
how parameter is used with the DI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

BAD B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
DSC B6
B7
B8
B9
Table 3-8. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
26 DSC Discrete Alarm Inhibited INHSTA.B6
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up
to 25 characters (12 for <local_compound_name>, 1 for the
colon, and 12 for the <ecb_name>).

IOOPTS I/O Options is a configurable, downloadable, non-settable, packed


Boolean used to specify the IO_OPTS parameter of the associated device
function block. The DI uses a single bit as shown in Table 3-9.

Table 3-9. IOOPTS Parameter Format

Bit
Number* Description, When True
15 Invert

94
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table 3-9. IOOPTS Parameter Format (Continued)

Bit
Number* Description, When True
*Bit 0 is the least significant, low order bit.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block, immediately
below the faceplate.

MAN_ID Manufacturer Identifier is a configurable, non-settable long integer that


provides the Manufacturer Identifier of the H1 field device that contains
the device function block represented by the DI block. The FBM228
checks the corresponding value in the device resource block to verify that
there is a match between the block and the device.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the associated device function block,
to Manual.

MODE_A Actual mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device func-
tion block.

MODE_N Normal mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Normal parameter of the associated
device function block.

MODE_P Permitted mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

95
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

MODE_T Target mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Target parameter of the associated
device function block. The parameter is not directly settable; the
AUT_SW, MAN_SW, and OOS_SW can be used to change the
MODE_T parameter and thus the MODE_BLK.Target parameter in the
device function block.

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the DI block is initialized,
the block updates the configurable parameters of the function block
matched to the DI block by the configured index (BLKNDX). The
NAME parameter is used to set the Block Tag of the device function
block.

NASOPT Nuisance Alarm Suppression Alarm Option is a configurable, settable


boolean parameter that specifies whether the nuisance alarm delay speci-
fied in NASTDB is implemented by delaying the return to normal
(NASOPT=0) or by delaying alarm detection (NASOPT=1).

NASTDB Nuisance Alarm Suppression Time Deadband is used to reduce the


number of alarm messages generated when a block parameter crosses back
and forth over an alarm limit. When the parameter is set to zero, an alarm
is generated each time the parameter is outside the limit and is cleared
each time it crosses back. Thus, a parameter that is fluttering at the alarm
limit can result in nuisance alarms. NASTDB specifies, in milliseconds, a
time that must lapse before the alarm is cleared and before another alarm
message can be generated. The specified value is rounded up to the nearest
even multiple of the control station BPC. If the parameter passes from
outside one limit to outside the opposite extreme, the deadband is
ignored.

OOS_SW Out of Service Switch is a settable output used to set the parameter
MODE_BLK.Target to Out of Service in the associated device function
block.

OUT_D Discrete Output is a short integer output that contains the OUT_D
parameter of the associated device function block. It is settable only in
Manual mode.

OUT_ST Output State is a configurable, non-settable integer that is used to specify


the OUT_STATE parameter of the associated device DI function block.
The range is 0 to 32767.

OUTDSC Output Descriptor is a configurable, non-settable ASCII string of up to


32 characters used as descriptive information in block alarm messages.

OUTSTS Output Status is a non-settable, packed Boolean output that contains the
OUT_D.Status parameter in the associated device function. See
Section 3.6.6.

96
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with
a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,
or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the DI block:
0 = No alarm
8 = Bad I/O alarm
9 = Discrete state alarm.

PV_D Discrete Process Variable is a non-settable short integer output that con-
tains the PV_D parameter of the associated device function block.

PVFTIM PV Filter Time is a configurable, downloadable, non-settable real input


that is used to specify the PV_FTIME parameter of the associated device
function block. See Section 3.5.1.4 for a description of the filter.

PVSTS Process Variable Status is a non-settable, packed Boolean output that con-
tains the PV_D.Status of the associated device function block. See
Section 3.6.6 for a description of the status value.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


DI block is to be simulated.

97
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

When SIMOPT= 1 (True), the status and value of OUT_D are not recov-
ered from the field, but are computed by the control station based on the
simulated value change. The simulated value is derived from the IN
parameter. The simulated behavior of the block reflects the operational
mode of the block (MODE_A).

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block. ST_REV is incre-
mented by one each time a configurable parameter is updated by an exter-
nal source.

STOPTS Status Options is a configurable, downloadable, non-settable, packed


Boolean that is used to specify the STATUS_OPTS parameter of the
associated device function block (Table 3-10).

Table 3-10. STATUS_OPTS Parameter Format

Bit
Number* Option Set with Bit
8 Uncertain if MAN Mode
3 Propagate Fault Forward
* Bit 0 is the least significant, low order bit.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


specifies the TAG_DESC parameter of the associated device function
block. The TAGDSC value is also copied to the DI block DESCRP
parameter to provide a description of the block in I/A Series displays.

TSTAMP Time Stamp, which is expressed in units of milliseconds past midnight, is


updated every time there is a change in the value or status of the OUT_D
parameter. During normal operation, the time is from the FBM228.
When the block is in simulation (SIMOPT = 1), the value is computed by
the CP.

TYPE Type is the block type. When a DI block is added to the control database,
the configuration editor enters a numeric value of 119 to specify the block
type as DI.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator acknowledge
pick on a default display, a user display, or an alarms display.

98
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 to schedule client/server
connections to the device function block view parameters. The range is
0 to 2147483647 milliseconds; the default is 10000.

XD_ST XD State is a configurable, non-settable integer that is used to specify the


XD_STATE parameter of the associated device function block. The range
is 0 to 32767.

3.5 Device Function Block Description


This section describes the FOUNDATION fieldbus discrete input device function block, and
includes a block schematic, a brief description of the block’s standard parameter set, and a table
showing the mapping between the I/A Series system DI block parameters and the device function
block parameters.

3.5.1 Device Block Operation


The FOUNDATION fieldbus discrete input H1 function block (device function block) processes a
discrete input from a field device and makes it available to other function blocks at the OUT_D
parameter (Figure 3-1). OUT_D includes a value and a status. The CHANNEL parameter speci-
fies which of several inputs from the device is to be handled by the block.

PV_D

Simulation Conversion Filter


CHANNEL
Output
SIMULATE_D INVERT PV_TIME OUT_D

FIELD_VAL_D
Alarms

Mode
DISC

Figure 3-1. DI Function Block Schematic

3.5.1.1 Mode
The DI block supports three settable modes:
♦ In Auto mode, the OUT_D parameter reflects the process variable (PV_D) value and
status.
♦ In Manual mode, the OUT_D parameter is disconnected from the field and can be set
manually. The OUT_D status reflects the mode.
♦ In OOS (out of service) mode, the block values are not updated and the status of
OUT_D is set to BAD. In OOS, changes can be made to configured parameters.

99
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

3.5.1.2 Simulation
The SIMULATE parameter in the device function block allows the OUT_D parameter to be set
by an external source for testing. When SIMULATE is enabled, the actual measurement has no
affect in the OUT_D value and status. Simulation at the device block level also requires that you
set a simulation jumper on the device.
The I/A Series DI block supports simulation within the control processor. The option is set with
the SIMOPT parameter in the DI block, as described in Section 3.6.13.

3.5.1.3 Conversion
When the Invert option is selected in IO_OPTS, the discrete input is logically inverted.

3.5.1.4 Filter
Filtering changes the response time of the device to smooth variations in the input readings
caused by rapid changes in the input value. The filtering time (PV_TIME) is applied to PV_D,
not to FIELD_VAL_D.

3.5.1.5 Alarms
In addition to the standard block alarms, the device DI function block sets an alarm when the
value of PV_D matches the value in DISC_LIM. The alarm condition is added to the OUT_D
status; however, no alarm is generated if the value in DISC_LIM is 255.
The I/A Series system does not use the alarm features provided by the device blocks, but rather
provides alarm handling options in the DI block. The DI block enables BAD alarming using stan-
dard I/A Series alarm parameters.

3.5.2 DI Parameter Transforms


Table 3-11 shows the mapping of DI block parameters to parameters in the related device func-
tion block parameters. Many of the parameters are straightforward 1:1 mappings that are either
unidirectional or bidirectional. Other mappings require that a data value be re-formatted (or
transformed) to be intelligible in the I/A Series system. From the point of view of the DI block,
the relationship with the device function block can also be described in terms of sink and source
connections:
→ Source-sink The DI block parameter is the source for the corresponding device
function block parameter. Thus, changes to the DI block parameter
are made to the device parameter. For example, when the DI block is
initialized, the TAGDSC value is copied to the device function block
TAG_DESC parameter.

100
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

← Sink-source The DI block parameter value is updated by the corresponding device


function block parameter. For example, the MODE_A parameter
reads the device parameter MODE_BLK.Actual to make the actual
device function block mode visible to the control system.
↔ Bidirectional Changes to the DI block parameter are made to the corresponding
device function block parameter and vice versa. For example, when a
DI block is initialized, its STOPTS parameter value is written to the
device DI block parameter, STATUS_OPTS, to configure how the
function block processes block status information. Subsequent
changes to the status option made at the device are written back to
the DI block STOPTS parameter.

The arrow notation is used in Table 3-11, which describes the parameter transforms for the DI
and the related device function block. These are presented in alphabetic order, arranged by the DI
block parameter names.
Table 3-11. DI Block Parameter Transforms

DI Block Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SW = 1:
Set MODE_T (request) = AUTO
Set MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP-FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.MA=1 ← MODE_BLK.Actual.AUTO
BLKSTA.MA=0 ← MODE_BLK.Actual.MAN
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← OUT_D.Status.Bad (Bits 6-7=0)
CHANNL ↔ CHANNEL
IOOPTS ↔ IO_OPTS
MAN_SW MODE_BLK.Target
When MAN_SW = 1:
Set MODE_T (request) = MAN
Set AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM

101
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

Table 3-11. DI Block Parameter Transforms (Continued)

DI Block Parameter Device Function Block Parameter


MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permitted
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW is set =1:
Set MODE_T (request) = OOS
Set AUT_SW=0, MAN_SW=0
Write MODE_T (request) to FBM
OUTSTS OUT_D
OUTSTS.value ← OUT_D.Status
OUT_D OUT_D
OUT_D.value (request) → OUT_D.Value (in MAN mode only)
OUT_D.value (actual) ← OUT_D.Value
OUT_D.status.LHI ← OUT_D.Status.Limited Hi (Bit 0)
OUT_D.status.LLO ← OUT_D.Status.Limited Lo (Bit 1)
OUT_D.status.ERR ← OUT_D.Status.Uncertain (Bits 6-7=1)
OUT_D.status.BAD ← OUT_D.Status.Bad (Bits 6-7=0) or
CP-FBM communication failure
OUT_D.status.OOS ← OUT_D.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0

102
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table 3-11. DI Block Parameter Transforms (Continued)

DI Block Parameter Device Function Block Parameter


OUT_ST ← OUT_STATE
PVFTIM ↔ PV_FTIME
PVSTS PV_D
PVSTS.value ← PV_D.Status
PV_D PV_D
PV_D.value ← PV_D.Value
PV_D.status.LHI ← PV_D.Status.Limited Hi (Bit 0)
PV_D.status.LLO ← PV_D.Status.Limited Lo (Bit 1)
PV_D.status.ERR ← PV_D.Status.Uncertain (Bits 6-7=1)
PV_D.status.BAD ← PV_D.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
PV_D.status.OOS ← PV_D.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5=
7), or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
STOPTS ↔ STATUS_OPTS
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC → TAG_DESC
Note: Changes to TAGDSC are copied to DESCRP.

3.6 DI Block Operation


The DI block establishes a publisher/subscriber connection with the device function block of the
specified H1 device, and makes the function block’s calculated value (OUT_D) available to the
control blocks in the I/A Series system.
The I/A Series DI block provides the interface between the CP-resident control blocks and the
device discrete input function block.
The DI block’s OUT_D and OUTSTS parameters hold the value and status of the device func-
tion block OUT_D parameter, while the PV_D and PVSTS parameters reflect the value and sta-
tus of the device function block’s primary value.
The DI block enables setting of the Invert option through configuration of the IOOPTS parame-
ter in the DI block. The block also supports the function block’s alarm features and mode param-
eters.
The DI block and the device function block operate in two asynchronous cycles, both writing to
and reading from shared space in the FBM memory. The DI block executes in the Basic Process-
ing Cycle (BPC) of the control station according to its compound, and its PERIOD and PHASE
parameters, which are described in Integrated Control Software Concepts (B0700AG). The device
function block executes once each FBM macrocycle as scheduled by the Link Active Schedule in
the FBM228.

103
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

The principal task of the DI block is to read a discrete value and status from the device. For this
task, the FBM228 establishes a publisher/subscriber connection between the DI block OUT_D
parameter and device function block OUT_D parameter. The one exception is when the OUT_D
of the device function block is Control In the Field (CIF) mode connected to another device
function block in the same device and “Publish Internal Dev Connections” is not selected in the
Field Device Manager Schedule Config page in IEE.
All other parameter connections are made by the FBM on a client/server basis at the
frequency specified in the DI block UPDPER parameter. This parameter can be set from 0
to 2147483647 milliseconds; the default is 10000 (10 seconds); however, increasing the
frequency of client/server communication significantly adds to the load on the H1 segment.

3.6.1 Device Function Block Connection


The configured parameter IOM_ID of the DI block specifies an ECB201 (the device ECB) that
represents the target H1 device. The ECB201 PARENT parameter identifies the ECB200 or
ECB202 for the FBM228. The path to the device block is completed as follows. When the DI
block is configured using IEE, the device function block is selected in a browser which displays
the device function blocks based on the device description in the device ECB. If the connection is
not configured in the browser. If the connection is not made via the browser, the connection is
made based on the DI block BLKNDX parameter.
To assign function blocks to their device, refer to “Assign the Function Blocks to a Device” in
InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA).

3.6.2 Device Configuration Parameters


The DI block enables you to set the standard configurable parameters in the corresponding device
function block using an I/A Series control configuration editor (i.e. the IEE Block Configurator)
and manage the device configuration in the control database. When the DI block is deployed to
the control station, and the FBM228 is downloaded, parameter values in the DI block update
parameters in the linked device function block.
The deployment of the DI block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Schedule execution of the device function block
♦ If needed, add a compel data (CD) message to each macrocycle to publish the
OUT_D parameter value and status
♦ Schedule client/server connections between the DI block and the device function
block for view updates.
Table 3-12 lists the device function block parameters and the DI block parameters used to config-
ure them. For the DI block, the table includes both the six-character (maximum) parameter name
that is used in block detail displays and the parameter labels which more closely resemble the
FOUNDATION fieldbus parameter names. Use the six-character parameter name when connecting
parameters to a process display.

104
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table 3-12. DI Block Configuration Parameters

Configured with DI Block Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
CHANNEL CHANNL Channel
IO_OPTS IOOPTS Io_opts
L_TYPE L_TYPE L_type
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
OUT_STATE OUT_ST OUT_state
PV_FTIME PVFTIM PV_ftim
STATUS_OPTS STOPTS StatusOpt
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc
XD_STATE XD_ST XD_state

3.6.3 Block Validation


The DI block initializes when any of these events occur:
♦ The block is installed or reconfigured via the IEE control configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.
When the I/A Series DI block initializes, the following block validation test is performed:
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Auto,
Manual or Out-of-Service, the block is marked undefined (BLKSTA.UDEF=1) with
the error code parameter (ERCODE) set to “W76 - INVALID FF MODE
CONFIGURATION”.
If the FBM simulation is not used (SIMOPT=0), the following validation tests are performed:
♦ If the DI block is installed prior to the installation of the ECB201 block, it is marked
undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE) set to
“W54 - ECB DOES NOT EXIST”. In this case, the DI block configuration is
restarted and re-validated automatically when the ECB201 is installed.
♦ An attempt is made to connect the DI block to the ECB201 specified in the IOM_ID
parameter. The DCI connection address (i.e., the BLKNDX parameter in the DI
block) is used in a connect message to establish a block connection in the FBM228.
♦ If the block connection cannot be resolved due to a lack of configuration information,
a block connection is made in the FBM, the connection status is marked Unresolved,
and one of the following error strings is stored in the block ERCODE parameter:
♦ “W62 - UNRESOLVED CONNECTION”
♦ “W77 - FIELDBUS COMMUNICATIONS FAULT”
♦ “W78 - INVALID FUNCTION BLOCK”

105
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

♦ “W80 - FIELDBUS DEVICE NOT FOUND”


♦ “W82 - FF CONFIGURATION IN PROGRESS”
(In these cases, the DI block is defined, but the output values are marked OOS.)
♦ “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the DI block is defined, and the index of the invalid function block
parameter is stored in the CFGERR parameter.)
♦ If the DI data connection cannot be made for any other reason, the FBM rejects the
connection request and one of the following error strings is stored in the ERCODE
parameter to indicate the reason for the connection error:
♦ “W65 - INVALID POINT ADDRESS”
♦ “W66 - DUPLICATE CONNECTION”
♦ “W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS”
♦ “W68 - INVALID DEVICE CONNECTION”
♦ “W69 - INVALID POINT CONNECTION”
♦ “W74 - FF FUNCTION BLOCK DDITEM MISMATCH”
♦ “W75 - FF FUNCTION BLOCK DDMBR MISMATCH”
♦ “W76 - INVALID FF MODE CONFIGURATION”
♦ “W79 - INVALID PARAMETER INDEX”
(In these cases, the I/A Series DI block is undefined.)
♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the
I/A Series DI block is undefined with ERCODE set to “W43 - INVALID
PERIOD/PHASE COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the
I/A Series DI block is undefined with ERCODE set to “W81 - INVALID PARENT
DCI ECB PERIOD/PHASE”.
If there are no configuration errors when the I/A Series DI block is installed, the block is marked
defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the compound containing the
block is turned on, the block also initializes and starts running automatically.

3.6.4 Block Initialization


When the I/A Series DI block initializes, the following are performed:
♦ All alarm status parameters (ALMSTA, INHSTA, CRIT, PRTYPE, UNACK) are
cleared.
♦ The Actual mode parameter (MODE_A) is set to Initialization Manual (IMAN) in
the I/A Series DI block.
♦ The Target mode parameter (MODE_T) is set to only one of the following states, in
order, if multiple bits are set: Auto, Manual, OOS.
♦ The status of the OUT_D parameter is set to BAD and OOS.
♦ The Timestamps for the output is updated.

106
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

If not simulating (SIMOPT=0), the following are performed:


♦ The Target mode is sent to the DI device function block.
♦ If installing the block, or if rebooting and not a Warm Restart, the configuration
parameters are downloaded to the device DI function block.

3.6.5 I/A Series Parameter Status


The status of the device DI function block parameters are provided in the I/A Series DI block in
two forms:
♦ The status of each device function block parameter is available as a separate I/A Series
DI block parameter.
♦ The status of each device function block parameter also is mapped onto equivalent
fields in the value record status of the corresponding I/A Series DI block parameter.
For each device function block parameter containing status information, the following fields are
mapped:
♦ The Quality field (Bits 6-7) are mapped onto the BAD and ERR status bits.
♦ The Sub-status field (Bits 2-5) are ignored, except for the case when the Quality is Bad
and the Sub-status is OOS. In this case, the OOS status bit will be set in the I/A Series
DI block parameter.
♦ The Limited High (Bit 0) and Limited Low (Bit 1) fields are mapped onto the LHI,
LLO status bits, respectively.

3.6.6 Device Parameter Status


The device function block OUT_D and PV_D parameters have both a value and a status. The sta-
tus is contained in a 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits. The status is
read into the DI block parameter, bit for bit. The default displays for the DI block shows the con-
verted status parameter so that the value need not be decoded. Table 3-13 shows how the status
byte is formatted.
Table 3-13. Device Parameter Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 SubStatus depends on .Quality, as shown in Table 3-13
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (Non-cascade)
3 = Good (Cascade)

Table 3-13 shows how the Substatus bits are used given the bits set for .Quality.

107
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

Table 3-14. Device Parameter Substatus

Bits 2-5 = Substatus and Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced in by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.
4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm

108
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table 3-14. Device Parameter Substatus (Continued)

Bits 2-5 = Substatus and Description


5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

3.6.7 Block Modes


The DI block provides interactive support of the MODE_BLK function block parameter. The
Target, Permitted, Normal, and Actual modes are provided as separate block parameters.
The configuration of the Target, Permitted, and Normal modes are supported. These parameters
are downloaded to the device DI function block when the I/A Series DI block initializes.
The Target mode can be changed through a group of settable Boolean mode switches provided in
the I/A Series DI block. These mode switches, AUT_SW, MAN_SW, and OOS_SW, allow the
block mode to be changed to Auto, Manual, or Out-of-Service respectively.
♦ Logic in the CP270 prevents more than one switch to be set at a given time. If more
than one switch is set during the same block cycle, only the last switch setting is
honored.
♦ Once set, a mode switch remains set only until the Target mode change is sent to the
FBM228 or until another mode switch is set. At that time, the mode switch is cleared.
♦ The mode switch setting is mapped onto an equivalent Target mode setting sent to
the FBM228.

109
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

The Target mode is a shadow parameter updated from the MODE_BLK function block parame-
ter read back during input scanning of the FBM228.
When the Actual, Permitted, Target, or Normal modes change in the device DI function block,
the corresponding I/A Series mode parameters are updated automatically from the MODE_BLK
function block parameter. In addition, the Actual mode is mapped onto equivalent BLKSTA
parameter bits.
The INITMA parameter and the Auto/Manual override parameters, AUTSW and MANSW, are
not supported in the I/A Series DI block, since these functions do not exist in the device DI func-
tion block.
When the Actual block mode is Auto or Manual, the following are performed:
♦ The OUTSTS status parameter and the value status of the OUT_D parameter are
updated from data received in the reply to the read message.
♦ The PV_D parameter value is updated from data received in the reply to the read
message.
♦ Configuration parameters that have changed since the previous block cycle are
downloaded.
♦ Other View data parameters are updated, if any changes in these parameters have
occurred since the previous block cycle.
♦ Block Error (BLKERR) processing begins.
♦ External configuration changes to function block parameters are propagated.
♦ Configuration Error (CFGERR) processing begins.
♦ If BADOPT=1, Bad Alarming of the output is performed.
♦ If DSCOPT>0, Discrete Alarming of the output is performed.
When the Actual block mode is Auto, the following is performed:
♦ The OUT_D parameter value and status are updated from data received in the reply
to the read message.
When the Actual block mode is Manual, the operator is allowed to set the OUT_D parameter
value directly via an OM set operation. When this happens, the new output value is sent to the
FBM228 which, in turn, updates the corresponding OUT_D function block parameter in the
field device.

3.6.8 Block Alarming


The DI block performs alarm functions consistent with standard CP270 alarming. This includes
the following types of process alarms:
♦ Bad Alarming and Discrete Alarming of the OUT_D output
♦ Informational messages of block errors (BLKERR) reported by the device DI function
block BLOCK_ERR parameter.
♦ Informational messages of function block configuration errors (CFGERR).
The device DI function block alarm detection, alarm events, alarm messaging, and associated
parameters provided by the field device are not supported in the I/A Series DI block.

110
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

3.6.9 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter is performed as
follows:
♦ For every condition specified in ERROPT, a corresponding Informational message is
sent to the ERRGRP alarm group when the condition occurs. The UNACK parame-
ter and the corresponding ALMSTA.UNACK bit also are set. ERROPT has the same
format as BLKERR (Table 3-4 on page 88).
♦ One of the messages listed in Table 3-15 is generated.

Table 3-15. Block Error Messages

ERROPT Bit Message Text


Bit 0 FF Block Error: Out-of-Service
Bit 1 FF Block Error: Power Up
Bit 2 FF Block Error: Maintenance Needed Now
Bit 3 FF Block Error: Readback Check
Bit 4 FF Block Error: Lost NV Data
Bit 5 FF Block Error: Lost Static Data
Bit 6 FF Block Error: Memory Fail
Bit 7 FF Block Error: Output Fail
Bit 8 FF Block Error: Input Fail
Bit 9 FF Block Error: Maintenance Due Soon
Bit 10 FF Block Error: Fault State Active
Bit 11 FF Block Error: Local Override
Bit 12 FF Block Error: Simulation Active
Bit 13 FF Block Error: Link Configuration Error
Bit 14 FF Block Error: Block Configuration Error
Bit 15 FF Block Error: Other (Undefined) Error

3.6.10 Configuration Error Processing


When an FF block configuration parameter cannot be downloaded into the field device, the
parameter index is stored in the CFGERR parameter and the following informational message is
generated:
“FF CFGERR in Parameter nnnnnnnn”
where: nnnnnnnn = ASCII name of the parameter indicated by the index in CFGERR

3.6.11 Process Alarming


If the Bad Alarm option (BADOPT) is set, alarming is performed as follows:
♦ Bad Alarm status information is set in the block when the BAD status of the OUT_D
parameter is set. The BAD bit is set in the alarm status parameter (ALMSTA.BAD).
The UNACK parameter and the corresponding ALMSTA.UNACK bit also are set.
♦ The CRIT parameter and its corresponding ALMSTA.CRIT field are set to the BAD-
PRI parameter value, and the PRTYPE parameter and its corresponding
ALMSTA.PRTYPE field are set to the appropriate alarm type. Note that this only
happens if there are no other alarms of higher priority in the block.

111
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

♦ When the Bad Alarm condition occurs, a Bad Alarm message is sent to all devices in
the BADGRP alarm group. This message contains the OUTDSC output descriptor,
the BADTXT descriptive text, and the LOOPID loop identifier.
♦ When the Bad alarm condition clears, a return-to-normal message is generated and
sent to all devices in the bad alarm group.
If the Discrete Alarm (DSCOPT) option is set, alarming is performed as follows:
♦ Alarm status information is set in the block when the alarm condition exists. The
appropriate alarm bit is set in ALMSTA. The UNACK parameter and the correspond-
ing ALMSTA.UNACK bit also are set.
♦ The CRIT parameter and its corresponding ALMSTA.CRIT field are set to the
DSCPRI parameter value, and the PRTYPE parameter and its corresponding ALM-
STA.PRTYPE field are set to the appropriate alarm type. Note that this only happens
if there are no other alarms of higher priority in the block.
♦ When the alarm condition occurs, an alarm message is sent to all devices in the
DSCGRP alarm group. This message contains the OUTDSC descriptor, the appro-
priate descriptive text, and the LOOPID loop identifier.
♦ When the alarm condition clears, a return-to-normal message is generated and sent to
all devices in the DSCGRP alarm group.
The CRIT, PRTYPE, and corresponding ALMSTA fields are cleared when there are no active
alarms in the block.
The UNACK parameter and the ALMSTA.UNACK bit are cleared in these cases:
♦ When the alarm is acknowledged by an OM set operation at either the compound
level, by setting the compound UNACK=0, or at the block level, by setting the block
UNACK=0.
♦ When all alarm conditions in the block return to normal status, if INHOPT is set
appropriately.
♦ When the block is shut down.
When UNACK is cleared, an Alarm Acknowledge message is generated and sent to all devices in
all alarm groups in the block.
Alarm Inhibiting/Disabling is supported using a combination of the compound CINHIB param-
eter and the INHOPT, INHIB, and INHALM parameters in the I/A Series DI block, to allow
the alarm messages to be inhibited and/or alarm detection to disabled dynamically.
When an alarm type is inhibited or disabled, an appropriate Alarm Disable message is generated
and sent to all devices in the alarm group. If the block is unacknowledged, an Alarm Acknowledge
message also is sent to these devices. In addition, the ALMSTA.INHIB bit is set, and the corre-
sponding INHSTA bit is set.
When an alarm type is uninhibited or enabled, an appropriate Alarm Enable message is generated
and sent to all devices in the alarm group. In addition, the ALMSTA.INHIB bit is cleared if no
other alarm in the block is inhibited, and the corresponding INHSTA bit is cleared.
The Alarm Reprioritization and Alarm Message Regeneration (using AMRTIN) enhancements
also are supported in the I/A Series DI block. Refer to the CP270 Integrated Control Concepts
(B0700AG) user document for details.

112
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

3.6.12 Block Shutdown


The DI block shuts down when any of these events occur:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ The ECB201 connected to the block is deleted.
♦ The DI block is deleted.
When block shutdown occurs, the following actions are taken:
♦ If any alarms are active, an Alarm Disable message is issued to all devices in the bad
alarm group. If the alarms are unacknowledged, an Alarm Acknowledge message also
is sent to these devices.
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, UNACK) are cleared.
If not simulating (SIMOPT=0) and the compound is off, the following actions are taken:
1. If the FF_OOS_OPT bit (Bit 4: 0x0010) is set in the Station block CFGOPT param-
eter, the following additional actions are taken:
♦ The actual mode parameter (MODE_A) is set to OOS.
♦ A write message is sent to the FBM228 with both the OOS and IMAN bits set in
the Target mode. The IMAN bit is set to indicate to the FBM228 that the com-
pound is off.
♦ Otherwise, a write message is sent to the FBM228 with only the OOS bit set in
the Target mode.
2. Otherwise, the following action is taken:
♦ A write message is sent to the FBM228 with both the current state and the IMAN
bits set in the Target mode. The IMAN bit is set to indicate to the FBM228 that
the compound is off.

3.6.13 Simulation
The I/A Series DI block SIMOPT parameter enables simulation of a discrete input to the control
system from the corresponding device DI function block. This feature can be used to test control
schemes requiring discrete inputs without actual FBM228 hardware connections.
When SIMOPT= 1 (True), the status and value of OUT_D are not recovered from the field, but
can be set directly to simulate input from the field.
When simulating (SIMOPT=1), the following functions will be performed:
♦ The IN input is stored in the OUT_D output value when the block mode is Auto.
♦ The OUTSTS output status parameter is set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (AUT_SW, MAN_SW, or
OOS_SW) immediately update the target mode parameter (MODE_T), and the
actual block mode (MODE_A) tracks MODE_T each block cycle.
♦ If any of the alarm options are specified, process alarming of the output is performed.
When simulating, the following functions are not performed:
♦ Downloading of configuration parameters.
♦ Updating of View data parameters.

113
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

♦ Block Error (BLKERR) processing.


♦ External configuration changes to function block parameters.
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA) or Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for
instructions on conducting control simulations from the control station.

3.6.14 Block States


The DCI blocks transition through the states detailed in Table 3-16 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 89).

Table 3-16. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device

114
3. DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table 3-16. DCI Block States (BSTATE) (Continued)

BSTATE Value
(Int (Bin)) State Value Description
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

3.7 DI Block Application Example


The DI block can be used in any control block configuration, in any compound except the Sta-
tion compound and the Primary ECB compound, in any CP270. It only can be connected to any
device DI function block in a field device hosted by an FBM228, but not to any other device
function block type or to any function block parameter.
Each field device connection must be specified by configuring the name of the ECB201 in the
IOM_ID parameter. The device DI function block connection must be specified by configuring
the DI function block index in the BLKNDX parameter.
The device DI function block output values will be available as connectable I/A Series DI block
parameters which can be connected to other blocks to perform additional functions not provided
by the I/A Series DI block.
Figure 3-2 illustrates an example of the DI block’s use in applications.

115
B0700EC – Rev B 3. DI – Foundation™ fieldbus Discrete Input

Parent ECB200/202

Child ECB201 Child ECB201

PARENT PARENT

IOM_ID IOM_ID
NAME NAME

DI Block LOGIC Block DO Block

PV_D OUT_D BI01 BO01 CASIND


OUT_D
BI08 BO08

IOM_ID IOM_ID
NAME NAME

DI Block DO Block

PV_D OUT_D CASIND


OUT_D

Figure 3-2. Application Example with I/A Series DI Block

116
4. DO – FOUNDATION™ fieldbus
Discrete Output
This chapter describes the I/A Series Discrete Output (DO) block, which interfaces the control
system with a corresponding Discrete Output function block operating in a FOUNDATION™
fieldbus H1 device.

4.1 Overview
Discrete Output (DO) is a Distributed Control Interface (DCI) block that provides an inter-
face between the control processor and a discrete output function block operating in a
FOUNDATION fieldbus H1 device (the device function block). The DO block is supported on
the FCP270 and ZCP270 when the H1 device is connected to the control station by an
FBM228. The DO block is configured using the Block Configurator in the InFusion Engineer-
ing Environment (IEE) as described in InFusion Enterprise Control System: Implementing FOUN-
DATION fieldbus in InFusion 2.0 (B0750DA).

NOTE
The DO block functionality described in this chapter is applicable only for
FBM228s with the software type (SWTYPE) of “128”. For a description of the leg-
acy DO block functionality (I/A Series systems v8.4.3 or earlier) where FBM228s
have the SWTYPE of “228”, refer to Appendix D “Legacy DO – Foundation™
fieldbus Discrete Output”.

4.2 Basic Operation


The DO block integrates the corresponding device function block into the I/A Series system. On
initialization, user-configured values in the DO block are written to the standard configurable
parameters in the corresponding device function block. During normal operation, the DO block
maintains a publisher/subscriber connections with the device function block to write a value to
the device block CAS_IN_D1 parameter and to read the value and status of the device block
BKCAL_OUT_D parameter. However, if the DO block is connected to another FF block, the
FBM sets up a publisher/subscriber relationship directly on the FF segment (Control In the Field
(CIF) mode) between another device block and DO function blocks. If output parameters are
communicated over the FF H1 segment, the FBM is set up to subscribe to these values for faster
data updates in the DO block in the CP.
In addition, the DO block provides access to a variety of operational and diagnostic information
via client/server connections with the parameters that are included in the block view data of the
device block. The values read from these parameters are displayed in the block detail displays and
are available for connection to other I/A Series blocks.
1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

117
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

4.3 Features
The DO block provides the following features:
♦ Outputs a setpoint value the linked discrete output device function block, and
acquires the block’s primary output value and status for read-back to the control
system
♦ Time stamps value and status changes to the block's output
♦ Accesses the parameters in the device function block’s views using change-driven and
periodic client/server connections
♦ Ensures that changes in the device function block’s process values and error conditions
are continuously available for display and connection to the control strategy
♦ Supports the device block Fault State handling
♦ Provides for configuration of device block parameters from the I/A Series system and
management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Cascade, Auto, Manual
or Out of Service
♦ Provides alarm reporting for Bad I/O
♦ Supports simulation of device block output within the control station

4.4 Block Parameters


Table 4-1 lists the block parameters. See Table 4-10 for mappings between DO block
parameters and their device function block equivalents.

Table 4-1. DO Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 120 120 (DO)
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 13
PHASE block execution phase short integer no-con/no-set 0 ---
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to 2147483647
DVC_ID device ID integer no-con/no-set 0 0 to 0xFFFF
DVCREV device revision long integer no-con/no-set 0 0 to 2147483647
BLKNDX block index long integer no-con/no-set 0 0 to 2147483647

118
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table 4-1. DO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0, 1
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path
name <= 25 chars
or ECB block
name <=12 chars
CHANNL channel integer no-con/no-set 1 0 to 32767
DDITEM DD item long no-con/no-set 0x80020230
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000 0 to 2147483647
STRATG strategy integer no-con/no-set 999 0 to 65535
STOPTS status options packed bool- no-con/no-set 0x800 0 to 0x800
ean
IOOPTS I/O options packed bool- no-con/no-set 0x1340 0 to 0xFF
ean
SHEDOP mode shed option short integer no-con/set 1 0 to 8
PV_ST PV state integer no-con/set 0 0 to 32767
XD_ST XD state integer no-con/set 0 0 to 32767
MODE_N normal mode short integer no-con/set 0x10 0 to 0xFF
MODE_P permitted mode short integer no-con/set 0x39 0 to 0xFF
MODE_T target mode short integer no-con/set 0x10 0 to 0xFF
CASIND cascade input real con/set, settable 0
only in Cascade
SP_D discrete setpoint integer con/set, settable only when mode is Auto
PRIBLK primary block boolean no-con/no-set 0 0 to 1
PRITIM primary cascade timer real no-con/no-set 0.0
FSOPTN faultstate option integer no-con/no-set 0 0 to 7
FSTIME faultstate time real no-con/no-set 20.0 sec
FSVALD faultstate value integer no-con/no-set 1
INHOPT inhibit option short integer no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short con/no-set 8 1 to 8
BADOPT bad alarm option boolean no-con/no-set 0 0 to 1
BADGRP bad alarm group short integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 1 to 32 chars
OUTDSC output descriptor string con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration integer no-con/set 0 0 to 32767
interval
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to 0xFFFFFFFF
AUT_SW auto switch boolean con/no-set 0 0 to 1
BSTATE block state integer con/no-set 0 0 to 11

119
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

Table 4-1. DO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DEVACK device acknowledge boolean con/set 0 0, 1
BCALCO back calc output integer con/no-set 0
BCOSTS back calc status packed bool- con/no-set 0 0 to 0xFF
ean
BLKERR block error packed bool- con/no-set 0 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0-0xFFFFFFFF
CAS_SW cascade switch boolean con/set 0 0 to 1
CASSTS cascade input status packed bool- con/no-set 0 0 to 0xFF
ean
CRIT criticality integer con/no-set 0 0 to 5
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode short integer con/no-set 0 to 0xFF
OOS_SW out of service switch boolean con/set 0 0 to 1
OUTSTS output status packed bool- con/no-set 0 0 to 0x00FF
ean
OUT_D discrete output integer con/set 0
PRTYPE priority type integer con/no-set 0 0, 8
PVSTS process variable status packed bool- con/no-set 0 to 0xFF
ean
PV_D discrete process integer con/no-set 0
variable
RBKSTS readback status packed bool- con/no-set 0 0 to 0xFF
ean
RBK_D discrete readback integer con/no-set 0
SETFS set faultstate boolean con/set 0 0 to 1
SPSTS setpoint status packed bool- con/no-set 0 0 to 0xFF
ean
TSTAMP time stamp long integer con/no-set 0 ms after midnight
UNACK unacknowledged boolean con/set 0 0, 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
CFGERR configuration error short integer no-con/no-set
DEFINE no config errors boolean no-con/no-set 1 ---
DESCRP descriptor string no-con/no-set blank 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 8 to 13 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
ST_REV status revision integer no-con/no-set 2 blanks
FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for each
(array 1x255) element
FDATA2 file data bytes 256 to short integer no-con/no-set all 0s 0 to 255 for each
510 (array 1x255) element

120
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

4.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT Alarm Options contain packed long values representing the alarm types
that have been configured as options in the block, and the alarm groups
that are in use. Table 4-2 shows how the parameter is used by the DO
block.

Table 4-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table 4-3 shows the bits used by the DO.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9

CRIT PRTYPE
BAD
INH

121
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

Table 4-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the DO
blocks
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
22 BAD Bad I/O Alarm ALMSTA.B10
29 INH Inhibit Alarm. This bit is set when ALMSTA.B3
any of the block’s alarms is inhibited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and thus MODE_BLK.Target in the associated device function
block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the DO block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the DO
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BCALCO Back Calculated Output is set equal to the confirmed component of


BKCAL_OUT_D in the associated device function block while cascade is
initializing. Since its purpose is to provide the upstream block with a back-
calculated value, connect BCALCO to the BCALCI parameter of the
upstream block.

122
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

BCOSTS Back Calculated Output Status is a non-settable, packed Boolean output


that contains the BKCAL_OUT_D.Status of the associated device func-
tion block. See Section 4.6.8 for information on .Status.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block. Table 4-4
shows the parameter format.

Table 4-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device function block represented by the DO block. It is set
by the configurator and the FBM uses it to identify the block in the
device.

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 4-5 shows how the bits are used by the
DO blocks.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B24
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DEVACK B9

FDFAIL
FDACT
FDMM
FDOK

HOLD
UDEF

FBM

TRK
LCK

FFX

BIO
ON

MA

LO
LR
FS

123
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

Table 4-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local BLKSTA.B29
Override
6 TRK Block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual mode
7 HOLD CAS_IN_D value is BAD BLKSTA.B25
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
10 LR Device block mode is Cascade. BLKSTA.B24
(0 indicates the device block mode is
either Auto or Manual.)
11 MA The device block mode is Auto. BLKSTA.B21
12 BIO Bad I/O BLKSTA.B20
14 UDEF Block is undefined. There is a configura- BLKSTA.B18
tion error
15 ON The compound that contains the block BLKSTA.B17
is ON
16 FFX Enhanced FF block connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FBM228 The H1 device is hosted and scheduled BLKSTA.B13
by an FBM228
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK FDATA installed BLKSTA.B11
22 FDMM FDATA mismatch BLKSTA.B10
23 DEVACK Unacknowledged device alarm BLKSTA.B9
24 FS Fault State has been asserted in the BLKSTA.B8
device function block
*Bit 0 is the least significant, low order bit.

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the device block connection as determined by the
FBM228. The following values are used to indicate the current DCI block
state:
0 = Undefined state
1 = Unconnected
2 = Connecting

124
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON-LINE
11 = Block ON-LINE with error - Processing has been completed, but
some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 155.

CASIND Cascade Input Discrete is a configurable real input used to specify the
CAS_IN_D parameter of the associated device function block. It is setta-
ble only if Cascade mode is unlinked.

CAS_SW Cascade Switch is a settable output used to set the MODE_T parameter,
and thus MODE_BLK.Target in the associated device function block, to
Cascade.

CASSTS Cascade Input Status is a non-settable, packed Boolean output that con-
tains the CAS_IN_D.Status of the associated device function block. See
Section 4.6.8 for information on .Status.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the DO block becomes undefined due to
a “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEVACK Device Acknowledge is a settable boolean output used to acknowledge


device alarms in the associated device function block. DEVACK is set
when a device alarm status bit is set by the FBM228. DEVACK is cleared
by an operator action.

125
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

DEVACK is different from UNACK (described on page 134), which is


used by the operator to acknowledge process alarms in the DCI block.
DEVACK is used to acknowledge device alarms at the ECB201 or DCI
block level.

NOTE
This parameter is not supported currently.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See ERRCODE for a list of all possible validation errors in this
block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string of up to


32 characters used to specify a description for the DO block.
♦ 0 disables Discrete Alarming (default)
♦ 1 enables Discrete Alarming.

DVC_ID Device Identifier is a configurable, non-settable integer that provides the


Device Identifier of the H1 field device that contains the device function
block represented by the DO block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device.

DVCREV Device Revision is a configurable, non-settable long integer that provides


the Revision level of the H1 field device that contains the device function
block represented by the DO block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device. The IEE
configurator encodes the following data in DVCREV:
Bits 16-23 Bits 8-15 Bits 0-7
Device revision Minimum Device Description Common File Format
(DD) File Revision (CFF) File Revision

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table 4-6 lists the possible error codes for a DO block.

126
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table 4-6. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in a DO block. The range is 1 (default) to 8.

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. The parameter has the same format as
BLKERR (Table 4-4).

FDATA1 File Data #1 and File Data #2 are settable multi-byte arrays that provide
FDATA2 configuration data for the device block represented by the DO block.
This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 510 bytes.

127
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

FSOPTN Fault State Option is a configurable integer parameter that specifies the
Fault State conditions and action to be taken by the CP and the FBM or
an output point in the corresponding device DO function block:
♦ Bit 0: 1 = Assert Fault State when the CASIND parameter is
sourced by an I/A Series block parameter and the CASIND
is BAD, OOS, or has a broken connection.
Note that ERROPT must be configured nonzero for this
option to take effect.
♦ Bit 1: 1 = Assert Fault State when the CASIND parameter is
sourced by an I/A Series block parameter and the SETFS
input is set/cleared.
♦ Bit 2: 1 = Assert Fault State if control station-to-FBM communi-
cation is lost (FBM option). This option is enabled only
when the CASIND parameter is sourced by an I/A Series
block parameter and the Fault State is enabled at the FBM
level via the FSENAB parameter in the ECB200 or
ECB202.

Bit 0 is the least significant, low order bit. FSOPTN is independent of the
FSTATE_TIME and FSTATE_VAL_D parameters and the
STATUS_OPTS options configured in the corresponding device DO
function block.

FSTIME Fault State Time is a configurable, downloadable, real value used to specify
the FSTATE_TIME parameter of a device function block. See
Section 4.6.9 on page 150.

FSVALD Fault State Value is a configurable, downloadable, non-settable integer


value used to specify the FSTATE_VAL_D parameter of a device function
block. See Section 4.6.9 on page 150.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

128
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,


automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table 4-7 shows
how parameter is used with the DO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

BAD B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

Table 4-7. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up
to 25 characters (12 for <local_compound_name>, 1 for the
colon, and 12 for the <ecb_name>).

129
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

IOOPTS I/O Options is a configurable, downloadable, non-settable, packed


Boolean used to specify the IO_OPTS parameter of the associated device
function block. Table 4-8 shows how the bits are used by the DO block.
Table 4-8. IOOPTS Parameter Format

Bit
Number* Description, When True
15 Invert
14 SP-PV Track in Man
12 SP-PV Track in LO
11 SP Track retained target
9 Fault State to Value
8 Fault State on Restart
7 Target to MAN on FS
6 Use PV for BKCAL_OUT
*Bit 0 is the least significant, low order bit.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block, immediately
below the faceplate.

MAN_ID Manufacturer Identifier is a configurable, non-settable long integer that


provides the Manufacturer Identifier of the H1 field device that contains
the device function block represented by the DO block. The FBM228
checks the corresponding value in the device resource block to verify that
there is a match between the block and the device.

MAN_SW Manual Switch is a settable Boolean output used to set the MODE_T
parameter, and thus MODE_BLK.Target in the associated device function
block, to Manual.

130
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

MODE_A Actual mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device func-
tion block.

MODE_N Normal mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Normal parameter of the associated
device function block.

MODE_P Permitted mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Target parameter of the associated
device function block.
Note that CAS_SW, AUT_SW, MAN_SW, and OOS_SW can be used to
change the MODE_T parameter and thus the MODE_BLK.Target
parameter in the device function block.

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the DO block is initialized,
the block updates the configurable parameters of the function block
matched to the DO block by the configured index (BLKNDX). The
NAME parameter is used to set the Block Tag of the device function
block.

OOS_SW Out of Service Switch is a settable Boolean output used to set the
MODE_T parameter, and thus MODE_BLK.Target in the associated
device function block, to Out of Service.

OUT_D Discrete Output is an integer output that contains the OUT_D parameter
of the associated device function block. It is settable only in Manual
mode.

OUTDSC Output Descriptor is a configurable, non-settable ASCII string of up to


32 characters used as descriptive information in block alarm messages.

OUTSTS Output Status is a non-settable, packed Boolean output that contains the
OUT_D.Status parameter in the associated device function block. Refer to
“Device Parameter Status” on page 148 for information on .Status.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

131
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with
a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,
or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PRIBLK Primary Block indicates whether the DO block has a connection from an
upstream block (PRIBLK = 1) or not (PRIBLK = 0). Its value and the
value of PRITIM determine whether the block remains in holding until
the upstream block returns an acknowledgement, remains in holding for a
fixed time delay, or ends the hold after one cycle.

PRITIM Primary Cascade Timer is a configurable parameter used to delay the clos-
ing of the cascade to a primary block when the output is initialized in the
DO block. It is used only if the PRIBLK option is set. Note that PRITM
must be non-zero or the cascade will remain open indefinitely.

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the DO block:
0 = No alarm
8 = Bad I/O alarm

PV_D Discrete Process Variable is a non-settable integer output that contains the
PV_D parameter of the associated device function block.

PV_ST Primary Value States is a configurable parameter used to set the


PV_STATE parameter in the device function block. The PV_STATE
parameter provides indexed text for the states of the PV_D value reported
in PV_D.Status in the device block and PVSTS parameter in the DO
block.

PVSTS Process Variable Status is a non-settable, packed Boolean output that con-
tains the PV_D.Status of the associated device function block. Refer to
“Device Parameter Status” on page 148 for information on .Status.

132
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

RBK_D Discrete Readback is a non-settable integer output that contains the


READBACK_D parameter of the associated device function block.

RBKSTS Readback Status is a non-settable, packed Boolean output that contains


the READBACK.Status of the associated device function block. Refer to
“Device Parameter Status” on page 148 for information on .Status.

SETFS Set Fault State Request is a Boolean parameter that requests Fault State
action to be reset by the FBM or field device for the specific output value
of the block. The settings are:
♦ 1 = set Fault State request
♦ 0 = reset Fault State request.

SHEDOP Mode Shed Options is a configurable, downloadable, short integer that is


used to specify the SHED_OPT parameter of the associated device func-
tion block. Its range to 0 to 8.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


DO block is to be simulated. When SIMOPT= 1 (True), there is no DCI
connection established for the block, and the status and value of
BCALCO are not recovered from the field, but are computed by the con-
trol station based on the simulated value change. The simulated behavior
of the block reflects the operational mode of the block (MODE_A).

SP_D Discrete Set Point is a configurable, integer output that is used to specify
the SP_D parameter of the associated device function block. It is settable
only in Auto mode.

SPSTS Set Point Status is a non-settable, packed Boolean output that contains the
SP._DStatus of the associated device function block. Refer to “Device
Parameter Status” on page 148 for information on .Status.

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block.

STOPTS Status Options is a configurable, downloadable, non-settable, packed


Boolean that is used to specify the STATUS_OPTS parameter of the
associated device function block. The block use only bit 4 (0 is the least
significant, low order bit) as shown in Table 4-9.

Table 4-9. STATUS_OPTS Parameter Format

Bit Number* Option Set with Bit


4 Propagate Fault Backward
* Bit 0 is the least significant, low order bit.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

133
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device func-
tion block.

TSTAMP Time Stamp, which is expressed in units of milliseconds past midnight, is


updated every time there is a change in the value or status of the
BCALCO parameter. The time is from the FBM228 when a new output
is sent to device function block. However, when the block is in simulation
(SIMOPT = 1), the value is computed by the CP.

TYPE Type is the block type. When a DO block is added to the control data-
base, the configurator enters a numeric value of 120 to specify the DO
block type.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the Current Alarms display.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 to scan the device function
block parameter. The range is 0 to 2147483647 milliseconds; the default
is 10000.

XD_ST XD State is a configurable, non-settable integer that is used to specify the


XD_STATE parameter of the associated device function block. The range
is 0 to 32767.

4.5 Device Function Block Description


This section describes the FOUNDATION fieldbus discrete output device function block, and
includes a block schematic, a brief description of the block’s standard parameter set, and a table
showing the mapping between the I/A Series DO block parameters and the device function block
parameters.

4.5.1 Device Block Operation


The discrete output device function block processes a setpoint input from another block or an
external source and outputs the value to a field device at the OUT_D parameter (Figure 4-1). The
value is output to the hardware specified in the device block CHANNEL parameter.

134
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

BKCAL_OUT_D

Setpoint Out Output


Conversion
CAS_IN_D
OUT_D

INVERT

Simulation
SP_D PV
CHANNEL

SIMULATE_D
Mode PV Fault
Conversion State

SHED_OPT
FSTATE_TIME READBACK_D
INVERT FSTATE_VAL_D

Figure 4-1. Discrete Output Device Function Block Schematic

4.5.1.1 Mode
The device function block supports the following modes:
♦ Man - Manual allows you to set the OUT_D parameter.
♦ Auto - In Auto, the OUT_D parameter reflects the SP_D value.
♦ Cas - Cascade allows the OUT_D parameter to be set by an external source connected
to the CAS_IN_D parameter.
♦ OOS - When the mode is Out of Service, the block is not processed, the output
channel is maintained at the last value, and the status of OUT is set to BAD.
♦ IMan - Initialization Manual indicates that the path to the output hardware is closed.
The output remains at its last value.
♦ LO - Local Override is set when the resource block has been placed in LO or a fault
state is active. In LO, the output of the block does not respond to CAS_IN_D.

4.5.1.2 Setpoint
The source of the Setpoint depends on the block mode as described in Section 4.5.1.1.

4.5.1.3 Out Conversion


If the Invert is set in the IO_OPTS parameter, the block performs a boolean NOT on SP_D
before copying the value to OUT_D.

4.5.1.4 Output
This value is passed to the device’s transducer block to provide the “setpoint” to the servo-position
circuit that actually manipulates the valve position.

135
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

4.5.1.5 Simulation
When the SIMULATE parameter in the device function block is set, the OUT_D parameter value
is not sent to the device, and the BKCAL_OUT_D can be set an external source such as a hand-
held H1 device for testing. Simulation at the device block level also requires that you set a simula-
tion jumper on the device.
Simulation of the control loop involving a discrete output to an H1 device can be accomplished
entirely within the control station and not involve communication with the H1 devices, as
described in Section 4.6.15.

4.5.1.6 Fault State


The block has two Fault State options, which are set in the IO_OPTS parameter:
♦ Fault State on Restart sets the OUT_D parameter to a specified value when the device
is recycled because of a loss of power or some other reason. The value is specified in
FSTATE_VAL_D.
♦ Fault State to Value sets the OUT_D parameter to a specified value if the block has not
received a value for output from its configured source within the time specified in
FSTATE_TIME. As with the restart option, the value is specified in FSTATE_VAL_D.
In the case of both options, the device detects the condition and takes the faultstate action.

4.5.1.7 PV_D Conversion


If the device supports a readback value, it is used for READBACK_D, which in turn is used for
PV_D. If the Invert is set in the IO_OPTS parameter, the block performs a Boolean NOT on the
READBACK_D before it is copied to PV_D.

4.5.2 DO Parameter Transforms


Table 4-10 shows the mapping of DO block parameters to the parameters in the related device
function block. Many of the parameters are straightforward 1:1 mappings that are either unidirec-
tional or bidirectional. Other mappings require that a data value be re-formatted (or transformed)
to be intelligible in the I/A Series system. From the point of view of the DO block, the relation-
ship with the device function block can also be described in terms of sink and source connections:
→ Source-sink The DO block parameter is the source for the corresponding device
function block parameter. Thus, changes to the DO block parameter
are made to the device parameter. For example, when the DO block is
initialized, the TAGDSC value is copied to the device function block
TAG_DESC parameter.

136
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

← Sink-source The DO block parameter value is updated by the corresponding


device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual device function block mode visible to the control system.
↔ Bidirectional Changes to the DO block parameter are made to the corresponding
device function block parameter and vice versa. For example, when a
DO block is initialized, its STOPTS parameter value is written to the
device DO block parameter, STATUS_OPTS, to configure how the
function block processes block status information. Subsequent
changes to the status option made at the device are written back to
the DO block STOPTS parameter.

The arrow notation is used in Table 4-10, which describes the parameter transforms for the DO
and the related device function block. These are presented in alphabetic order, arranged by the
DO block parameter names.

Table 4-10. DO Block Parameter Transforms

DO Block Parameter Device Discrete Output Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SW = 1:
Set MODE_T (request) = AUTO
Set CAS_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM

137
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

Table 4-10. DO Block Parameter Transforms (Continued)

DO Block Parameter Device Discrete Output Block Parameter


BCALCO BKCAL_OUT_D, OUT_D CAS_IN_D, MODE_BLK.Actual

BCALCO.value ← BKCAL_OUT_D.Value if not simulating (SIMOPT=0)


← OUT_D.Value if simulating (SIMOPT=1)

BCALCO.status.LHI ← BKCAL_OUT_D.Status.Limited Hi (Bit 0),


or MODE_BLK.Actual is not Cascade,
or BKCAL_OUT_D.Status.Bad (Bits 6-7=0),
or CP-FBM communication failure,
or the DCI connection record indicates an Initialization Request
(IR), Local Override (LO), Open Loop (LHI and LLO), Not
Invited (NI), or Fault State Active (FSA) condition in the device
DO function block.

BCALCO.status.LLO ← BKCAL_OUT_D.Status.Limited Lo (Bit 1),


or MODE_BLK.Actual is not Cascade,
or BKCAL_OUT_D.Status.Bad (Bits 6-7=0),
or CP-FBM communication failure,
or the DCI connection record indicates an Initialization Request
(IR), Local Override (LO), Open Loop (LHI and LLO), Not
Invited (NI), or Fault State Active (FSA) condition in the device
DO function block.
BCALCO.status.BAD ← BKCAL_OUT_D.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
BCALCO.status.OOS ← BKCAL_OUT_D.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
BCOSTS BKCAL_OUT_D
BCOSTS.value ← BKCAL_OUT_D.Status
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP-FBM communication is failed or FBM is Off-Line

138
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table 4-10. DO Block Parameter Transforms (Continued)

DO Block Parameter Device Discrete Output Block Parameter


BLKSTA MODE_BLK.Actual, BKCAL_OUT_D
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.HLD ← CASIND source value is BAD
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.LR=1 ← MODE_BLK.Actual.CAS
BLKSTA.LR=0 ← MODE_BLK.Actual.AUTO or MAN
BLKSTA.MA=1 ← MODE_BLK.Actual.CAS or AUTO
BLKSTA.MA=0 ← MODE_BLK.Actual.MAN
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← BKCAL_OUT_D.Status.Bad (Bits 6-7=0)
BLKSTA.FS ← BKCAL_OUT_D.Status.Good (Bits 6-7=0)
and Substatus.FSA (bits2-5= 7)
CASSTS CAS_IN_D
CASSTS.value ← CAS_IN_D.Status
CASIND CAS_IN_D, BKCAL_OUT_D
CASIND.value (request) → CAS_IN_D.Value (in CAS mode only if non-FF connection)
CASIND.value (actual) ← BKCAL_OUT_D.Value if initializing;
← CAS_IN_D.Value if not initializing;
CASIND.status.LHI ← CAS_IN_D.Status.Limited Hi (Bit 0)
or CASIND source value is LHI
CASIND.status.LLO ← CAS_IN_D.Status.Limited Lo (Bit 1)
or CASIND source value is LLO
CASIND.status.ERR ← CAS_IN_D.Status.Uncertain (Bits 6-7=1)
or CASIND source value is ERR
CASIND.status.BAD ← CAS_IN_D.Status.Bad (Bits 6-7=0),
or CASIND source value is BAD,
or CP-FBM communication failure
CASIND.status.OOS ← CAS_IN_D.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or CASIND source value is OOS,
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
CAS_SW MODE_BLK.Target
When CAS_SW=1:
Set MODE_T (request) = CAS
Set AUT_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
CHANNL ↔ CHANNEL
FSTIME ↔ FSTATE_TIME
FSVALD ↔ FSTATE_VAL_D

139
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

Table 4-10. DO Block Parameter Transforms (Continued)

DO Block Parameter Device Discrete Output Block Parameter


IOOPTS ↔ IO_OPTS
MAN_SW MODE_BLK.Target
When MAN_SW = 1:
Set MODE_T (request) = MAN
Set CAS_SW=0, AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permitted
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW=1:
Set MODE_T (request) = OOS
Set CAS_SW=0, AUT_SW=0, MAN_SW=0
Write MODE_T (request) to FBM
OUTSTS OUT_D
OUTSTS.value ← OUT_D.Status
OUT_D OUT_D
OUT_D.value (request) → OUT_D.Value (in MAN mode only)
OUT_D.value (actual) ← OUT_D.Value
OUT_D.status.LHI ← OUT_D.Status.Limited Hi (Bit 0)
OUT_D.status.LLO ← OUT_D.Status.Limited Lo (Bit 1)
OUT_D.status.ERR ← OUT_D.Status.Uncertain (Bits 6-7=1)
OUT_D.status.BAD ← OUT_D.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
OUT_D.status.OOS ← OUT_D.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0

140
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table 4-10. DO Block Parameter Transforms (Continued)

DO Block Parameter Device Discrete Output Block Parameter


PVSTS PV_D
PVSTS.value ← PV_D.Status
PV_D PV_D
PV_D.value ← PV_D.Value
PV_D.status.LHI ← PV_D.Status.Limited Hi (Bit 0)
PV_D.status.LLO ← PV_D.Status.Limited Lo (Bit 1)
PV_D.status.ERR ← PV_D.Status.Uncertain (Bits 6-7=1)
PV_D.status.BAD ← PV_D.Status.Bad (Bits 6-7=0)
PV_D.status.OOS or CP-FBM communication failure
← PV_D.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
PV_ST ↔ PV_STATE
RBKSTS READBACK_D
RBKSTS.value ← READBACK_D.Status
RBK_D READBACK_D
RBK_D.value ← READBACK_D.Value
RBK_D.status.LHI ← READBACK_D.Status.Limited Hi (Bit 0)
RBK_D.status.LLO ← READBACK_D.Status.Limited Lo (Bit 1)
RBK_D.status.ERR ← READBACK_D.Status.Uncertain (Bits 6-7=1)
RBK_D.status.BAD ← READBACK_D.Status.Bad (Bits 6-7=0) or
CP-FBM communication failure
RBK_D.status.OOS ← READBACK_D.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
SHEDOP ↔ SHEDOP

141
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

Table 4-10. DO Block Parameter Transforms (Continued)

DO Block Parameter Device Discrete Output Block Parameter


SPSTS SP_D
SPSTS.value ← SP_D.Status
SP_D SP_D
SP_D.value (request) → SP_D.Value (in AUTO mode only)
SP_D.value (actual) ← SP_D.Value
SP_D.status.LHI ← SP_D.Status.Limited Hi (Bit 0)
SP_D.status.LLO ← SP_D.Status.Limited Lo (Bit 1)
SP_D.status.BAD ← SP_D.Status.Bad (Bits 6-7=0)
SP_D.status.OOS or CP-FBM communication failure
← SP_D.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
STOPTS ↔ STATUS_OPTS
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC ← TAG_DESC
Note: Changes to TAGDSC are copied to DESCRP.
XD_ST ↔ XD_STATE

4.6 DO Block Functions


With each execution, the DO block receives a value from an I/A Series system control block and
writes the value to the device function block’s CAS_IN_D parameter. The DO block also reads
the value and status from the device function block’s BKCAL_OUT_D parameter.
The DO block does not condition the output to the device directly, as conditioning is handled by
the device function block, as specified in its IO_OPTS parameter. The DO block does, however,
enable you to configure the parameter via the IOOPTS parameter.

4.6.1 Device Function Block Connection


The configured parameter IOM_ID of the DO block specifies an ECB201 (the device ECB) that
represents the target H1 device. The ECB201 PARENT parameter identifies the ECB200 or
ECB202 for the FBM228. The path to the device block is completed as follows. When the DO
block is configured using IEE, the device function block is selected in a browser which displays
the device function blocks based on the device description in the device ECB. If the connection is
not configured in the browser. If the connection is not made via the browser, the connection is
made based on the DO block BLKNDX parameter.
To assign function blocks to their device, refer to “Assign the Function Blocks to a Device” in
InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA).

142
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

4.6.2 Device Configuration Parameters


The DO block enable you to configure key parameters in the corresponding device function
block and manage the configuration from the I/A Series system. When you deploy the DO block
to the control station, and then download the FBM228, parameter values in the DO block
update parameters in the linked device function block.
The deployment of the DO block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Configure a Compel Data (CD) message for each macrocycle to write the DO block
CASIND parameter to the device function block CAS_IN_D parameter
♦ Schedule execution of the device function block
♦ Configure a CD message for each macrocycle to publish the device function block’s
BKCAL_OUT_D to be read by the DO block BCALCO parameter.
♦ Schedule client/server connections between the DO block and the device function
block for view updates.
Table 4-11 lists the device function block parameters and the DO block parameters used to con-
figure them. For the DO block, the table includes both the six-character (maximum) parameter
name that is used in block detail displays and the parameter labels which more closely resemble
the FOUNDATION fieldbus parameter names. Use the six-character parameter name when con-
necting parameters to a process display.

Table 4-11. DO Block Configuration Parameters

Configured with DO Block Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
CHANNEL CHANNL Channel
FSTATE_TIME FSTIME Fstate_Time
FSTATE_VAL_D FSVAL Fstate_Val
IO_OPTS IOOPTS Io_opts
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
PV_ST PV_ST PV_state
SHED_OPTS SHEDOP ShedOpt
SP_D SP_D Sp_d
STATUS_OPTS STOPTS StatusOpt
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc

The following are required DO parameter settings:


♦ Configure MODE_P to include at least Cascade, Auto and Out of Service. Other
modes are optional.
♦ Set MODE_T to Cascade and Auto.
♦ Configure IOOPTS to include:
♦ SP_PV Track in LO (required)

143
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

♦FS to Value (recommended)


♦ Use FS on Restart (recommended).
♦ Use the STOPTS parameter to set the STATUS_OPTS to Propagate Fail Backward
(required).
♦ Configure SHEDOP to Normal shed, normal return.
♦ Set the Fault State option in the resource block’s FEATURE_SEL parameter.

4.6.3 Block Validation


The I/A Series DO block initializes when any of these events occur:
♦ The block is installed or reconfigured via the IEE control configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.
When the DO block initializes, the following block validation test is performed:
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Cascade,
Auto, Manual or Out-of-Service, or if the Target mode is not one of the Permitted
states, the block is marked undefined (BLKSTA.UDEF=1) with the ERCODE set to
“W76 - INVALID FF MODE CONFIGURATION”.
If the FBM simulation is not used (SIMOPT=0), the following validation tests are performed:
♦ If the DO block is installed prior to the installation of the ECB201 block, it is marked
undefined (BLKSTA.UDEF=1) with ERCODE set to “W54 - ECB DOES NOT
EXIST”. In this case, the DO block configuration is restarted and re-validated auto-
matically when the ECB201 is installed.
♦ An attempt is made to connect the DO block to the ECB201 specified in the
IOM_ID parameter. The DCI connection address (i.e., the BLKNDX parameter in
the DO block) is used in a connect message to establish a block connection in the
FBM228.
♦ If the device block connection cannot be resolved due to a lack of configuration infor-
mation, one of the following error strings is stored in the DO block ERCODE
parameter:
♦ “W62 - UNRESOLVED CONNECTION”
♦ “W77 - FIELDBUS COMMUNICATIONS FAULT”
♦ “W78 - INVALID FUNCTION BLOCK”
♦ “W80 - FIELDBUS DEVICE NOT FOUND”
♦ “W82 - FF CONFIGURATION IN PROGRESS”
(In these cases, the DO block is defined, but the output values are marked OOS.)
♦ “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the DO block is defined, and the index of the invalid function block
parameter is stored in the CFGERR parameter.)
♦ If the device block connection cannot be made for any other reason, the FBM rejects
the connection request and one of the following error strings is stored in the

144
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

ERCODE parameter to indicate the reason for the connection error:


♦ “W65 - INVALID POINT ADDRESS”
♦ “W66 - DUPLICATE CONNECTION”
♦ “W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS”
♦ “W68 - INVALID DEVICE CONNECTION”
♦ “W69 - INVALID POINT CONNECTION”
♦ “W74 - FF FUNCTION BLOCK DDITEM MISMATCH”
♦ “W75 - FF FUNCTION BLOCK DDMBR MISMATCH”
♦ “W76 - INVALID FF MODE CONFIGURATION”
♦ “W79 - INVALID PARAMETER INDEX”
♦ “W83 - INVALID FF PARAMETER CONNECTION”
♦ “W84 - INVALID FF PARAMETER TYPE”
♦ “W85 - INVALID CONNECTION TYPE”
♦ “W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH”
(In these cases, the I/A Series DO block is undefined.)
♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the DO
block is undefined with ERCODE set to “W43 - INVALID PERIOD/PHASE
COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the DO
block is undefined with ERCODE set to “W81 - INVALID PARENT DCI ECB
PERIOD/PHASE”.
If there are no configuration errors when the I/A Series DO block is installed, the block is marked
defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the compound containing the
block is turned on, the block also initializes and starts running automatically.

4.6.4 Block Initialization


When the I/A Series DO block initializes, the following are performed:
♦ All alarm status parameters (ALMSTA, INHSTA, CRIT, PRTYPE, UNACK) are
cleared.
♦ All parameter history values are initialized to the current parameter settings.
♦ The Target mode parameter (MODE_T) is set to only one of the following states, in
order, if multiple bits are set: Cascade, Auto, Manual, OOS.
If not simulating (SIMOPT=0), the following are performed:
♦ The Target mode is sent to the device DO function block.
♦ If installing the block, or if rebooting and not a Warm Restart, the following occurs:
1. The Configuration parameters are downloaded to the device DO function block.
2. The Actual mode parameter (MODE_A) is set to Initialization Manual (IMAN) in
the DO block.

145
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

3. The PVSTS, SPSTS, and OUTSTS parameters are set to Bad OOS.

4.6.5 Block Modes


The DO block provides interactive support of the MODE_BLK function block parameter. The
Target, Permitted, Normal, and Actual modes are provided as separate MODE_T, MODE_P,
MODE_N, and MODE_A block parameters, respectively.
The configuration of the Target, Permitted, and Normal modes are supported. These parameters
are downloaded to the device DO function block when the I/A Series DO block initializes.
The Target mode can be changed through a group of settable Boolean mode switches provided in
the I/A Series DO block. These mode switches, CAS_SW, AUT_SW, MAN_SW, and OOS_SW,
allow the block mode to be changed to the Cascade, Auto, Manual, or Out-of-Service states
respectively.
The mode switch setting is mapped onto an equivalent Target mode setting sent to the FBM228.
Logic in the CP270 prevents more than one switch to be set at a given time. If more than one
switch is set during the same block cycle, only the last switch setting is honored. Once set, a mode
switch remains set only until the Target mode change is sent to the FBM228 or until another
mode switch is set. At that time, the mode switch is cleared.
The Target mode is updated from the MODE_BLK function block parameter read back during
input scanning of the FBM228.
When the Actual, Permitted, Target, or Normal modes change in the device DO function block,
the corresponding I/A Series DO block mode parameters are updated automatically from the
MODE_BLK function block parameter. In addition, the Actual mode is mapped onto equivalent
BLKSTA parameter bits.
The INITMA parameter and the Auto/Manual override parameters, AUTSW and MANSW, are
not supported in the I/A Series DO block, since these functions do not exist in the device DO
function block.
The Actual block mode (MODE_BLK.Actual) is provided in two forms:
♦ The Actual mode is stored in the MODE_A output parameter.
♦ The Actual mode also is mapped onto equivalent bits in the BLKSTA block status
parameter.
The mapping of Actual mode state to BLKSTA bits are as follows
♦ The OOS state is mapped onto the OOS value status bit of the BLKSTA parameter.
♦ The IMAN state is mapped onto the BLKSTA.TRK status bit.
♦ The LO state is mapped onto both the BLKSTA.TRK and BLKSTA.LO status bits.
♦ The MAN state sets BLKSTA.MA=0 and BLKSTA.LR=0.
♦ The AUTO state sets BLKSTA.MA=1 and BLKSTA.LR=0.
♦ The CAS state sets BLKSTA.LR=1 and BLKSTA.MA=1.

4.6.6 Input Connections


The CP270 supports connections to the inputs in the I/A Series DO block from connectable
input or output parameters of any I/A Series control or I/O block. These inputs are updated each
block cycle from data in the I/A Series source block parameter.

146
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

The CP270 propagates the BAD, OOS, and ERR status of these input parameters to their corre-
sponding device function block parameters by writing the status to the FBM228 when a change
occurs.
When the Update Source of an input connection is not a device function block parameter, the
BlockName specified in the connection is the name of the I/A Series block; the ParameterName
is the 1-6 character name of the parameter in the I/A Series block.
The CP270 also supports connections to specific inputs in the DO blocks from parameters con-
tained in device function blocks mapped to any standard I/A Series control or I/O block. These
inputs are updated each block cycle from data in the device function block parameter; the data
contained in the specified I/A Series source parameter will not be used. The inputs of this type are
listed in Table 4-12 below.
When the source of an input connection is a device function block parameter, the I/A Series block
connection is made by the CP270, and the source BlockName and ParameterName are extracted
from the connection and appended to a connect message. This message is sent to the FBM228 to
establish a fieldbus connection to the function block source parameter.
When the source of an input connection is a device function block parameter, the BlockName is
the TagName of the device function block, which is the same as the name of the source I/A Series
block. The ParameterName is the 1-6 character name of the parameter in the source I/A Series
block for those connections listed in Table 4-13 below. In these cases, the name of the I/A Series
block parameter is converted to the equivalent function block parameter index by the CP270
prior to appending it to the connect message. In all other cases, the ParameterName must be con-
figured to be the parameter index of the function block parameter.
If the fieldbus connection cannot be made due to an invalid BlockName or ParameterName, the
ERCODE parameter in the block is set to the following text and the block is undefined:
“W83 - INVALID FF PARAMETER CONNECTION”

Table 4-12. DO Input Connections

DO Input Parameter(s) Connection Source Update Source


CASIND I/A Series parameter in I/A Series I/A Series source block parameter
control block or I/O block
FF parameter in I/A Series FF FF function block parameter
block
Any other input I/A Series parameter in I/A Series I/A Series source block parameter
control block or I/O block

Table 4-13. Standard FF Block Parameter Connections

Input Parameter Source Parameter


Block Type Parameter Block Type Parameter Name Parameter Index
DO CASIND DI OUT_D 8
MDI OUT_D1 - 8 to 15
OUT_D8

147
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

4.6.7 I/A Series Parameter Status


The status of the device DO function block parameters is provided in the I/A Series DO block in
two forms:
♦ The status of each device function block parameter is available as a separate I/A Series
DO block parameter.
♦ The status of each device function block parameter also is mapped onto equivalent
fields in the value record status of the corresponding I/A Series DO block parameter.
For each device function block parameter containing status information, the following fields are
mapped:
♦ The Quality field (Bits 6-7) is mapped onto the BAD and ERR status bits.
♦ The Sub-status field (Bits 2-5) is ignored, except for the case when the Quality is Bad
and the Sub-status is OOS. In this case, the OOS status bit is set in the I/A Series DO
block parameter.
♦ The Limited High (Bit 0) and Limited Low (Bit 1) fields are mapped onto the LHI,
LLO status bits, respectively.

4.6.8 Device Parameter Status


The device discrete output function block OUT_D and PV_D parameters have both a value and
a status. The status is contained in a 8-bit byte, which is parsed into .Quality, .SubStatus,
and .Limits. The status is read into the DO block parameter, bit for bit. The default displays for
the DO block shows the converted status parameter so that the value need not be decoded.
Table 4-14 shows how the status byte is formatted.

Table 4-14. Device Parameter Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 SubStatus depends on .Quality, as shown in Table 4-15
6-7 Quality:
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table 4-15 shows how the .SubStatus bits are used given the bits set in .Quality.

Table 4-15. Device Parameter Substatus

Bits 2-5 = SubStatus and Description


When .Quality is Bad (Bits 6-7 = 0)

148
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table 4-15. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus and Description


0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced in by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.
4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.

149
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

Table 4-15. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus and Description


6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

4.6.9 Fault State Handling


Three distinct Fault State options can be configured in the FSOPTN parameter in the I/A Series
DO block:
♦ Initiate Fault State upon loss of CP communications (Bit 2=1)
♦ Initiate Fault State if Bad CASIND (Bit 0=1)
♦ Initiate Fault State if SETFS (Bit 1=1)
The Initiate Fault State upon loss of CP communications (Bit 2=1) option is used only by the
FBM228 logic to assert the fault state when CP-to-FBM communications are lost. To support
this option, a Fault State enable (FSENAB) and a Fault State timer (FSDLAY) may be configured
in an ECB200 or ECB202. The Fault State timer counts down periodically between its receipt of
read/write messages. When either message is received for a device DO function block, its fault
state timer is reset to the FSDLAY value. If the Fault State timer expires, the FBM228 sets the IFS
status bit of the CASIND of the device DO function block, driving the field output to the
FSTATE_VAL_D value configured in the DO block. When the CP communications are restored,
the Fault State timers are reset automatically to full value by the first read or write message to each
connection. If the Fault State had been previously asserted by a request from the CP and the Fault
State condition still exists in the CP, the write message requests the IFS status bit to remain set in

150
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

the function block. Otherwise, the write message requests the IFS status bit to be cleared.
If the Initiate Fault State if Bad CASIND (Bit 0=1) option is set, the CP270 requests the FBM228
to assert the Fault State when the CASIND parameter is sourced by an I/A Series parameter and
the CASIND is BAD, OOS, or has a broken linkage to the source parameter.
If the Initiate Fault State if SETFS (Bit 1=1) option is set, the CP270 requests the FBM228 to
assert the Fault State when the CASIND parameter is sourced by an I/A Series parameter and the
SETFS parameter is set.
In either of the two latter cases, when the FBM receives an explicit request from the CP to assert
the Fault State, the FBM sets the IFS status bit of the CASIND parameter of the device DO func-
tion block, driving the field output to the FSTATE_VAL_D value configured in the DO block.
These actions are taken independent of the FSENAB option.
In addition, the CP270 requests the FBM228 to assert the Fault State in these cases:
♦ When the I/A Series DO block is deleted, if any of the FSOPTN options are config-
ured in the block.
♦ When the compound containing the I/A Series DO block is deleted, if any of the
FSOPTN options are configured in the block.
♦ When the compound containing the I/A Series DO block is turned off, if any of the
FSOPTN options are configured in the block and the Station block CFGOPT option
Bit 4 is set to 0.
In addition to the Fault State options in the FSOPTN parameter, options may be configured in
the IOOPTS, FSTIME, and FSVAL parameters to specify Fault State actions to be performed in
the device DO function block.
The device Fault State options are designed primarily to deal with communication failures above
the device, while working in concert with ECB options. Enabling Fault State is effective under
two external conditions
♦ When Faultstate is asserted by the connected FBM
♦ When communications to the device are lost and the device DO function block mode
is CAS.
The actual Fault State behavior taken by the device DO function block is specified in the parame-
ters listed in the table below.

Table 4-16. Fault State Parameters in the Device DO Function Block

I/A Series
Parameter Description
IOOPTS Configures the device block parameter IO_OPTS to enable/disable two
Fault State options:
1) Fault State on Restart: Selecting this option causes the device to go to
the value specified in FSTATE_VAL_D on a device RESTART. If this
option is not selected and the device block can go to its target mode upon
RESTART, the last saved setpoint (SP) is used for generating the Faultstate
position.
2) Fault State to Value: When this option is selected, the block uses the
value specified in FSTATE_VAL_D. When the option is not selected, the
last saved setpoint is used.

151
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

Table 4-16. Fault State Parameters in the Device DO Function Block

I/A Series
Parameter Description
FSVAL Configures FSTATE_VAL_D in the device DO function block, specifying
the value that is asserted when one of the Fault State options is invoked.
FSTIME Configures FSTATE_TIME in the device DO function block, setting the
period that the fault condition must last before the block asserts the speci-
fied value. A Fault State action does not occur until the FSTATE_TIME
interval has expired.

NOTE
An additional requirement for Fault State handling at the device level is that the
Fault State option must be selected in the device resource block, that is,
(0x4)FaultState must be selected in FEATURE_SEL.

4.6.10 Block Alarming


The DO block performs alarm functions consistent with standard CP270 alarming. This includes
the following types of process alarms:
♦ Bad Alarming of the BCALCO output.
♦ Informational messages of block errors (BLKERR) reported by the device DO func-
tion block BLOCK_ERR parameter.
♦ Informational messages of function block configuration errors (CFGERR).
The device DO function block alarm detection, alarm events, alarm messaging, and associated
parameters provided by the field device are not supported in the I/A Series DO block.

4.6.11 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter is performed as
follows:
♦ For every condition specified in ERROPT, a corresponding Informational message is
sent to the ERRGRP alarm group when the condition occurs. The UNACK parame-
ter and the corresponding ALMSTA.UNACK bit also are set. ERROPT has the same
format as BLKERR (Table 4-4 on page 123).
♦ One of the messages listed in Table 4-17 is generated.

Table 4-17. Block Error Messages

ERROPT Bit Message Text


Bit 0 FF Block Error: Out-of-Service
Bit 1 FF Block Error: Power Up
Bit 2 FF Block Error: Maintenance Needed Now
Bit 3 FF Block Error: Readback Check
Bit 4 FF Block Error: Lost NV Data
Bit 5 FF Block Error: Lost Static Data

152
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table 4-17. Block Error Messages

ERROPT Bit Message Text


Bit 6 FF Block Error: Memory Fail
Bit 7 FF Block Error: Output Fail
Bit 8 FF Block Error: Input Fail
Bit 9 FF Block Error: Maintenance Due Soon
Bit 10 FF Block Error: Fault State Active
Bit 11 FF Block Error: Local Override
Bit 12 FF Block Error: Simulation Active
Bit 13 FF Block Error: Link Configuration Error
Bit 14 FF Block Error: Block Configuration Error
Bit 15 FF Block Error: Other (Undefined) Error

4.6.12 Configuration Error Processing


When an FF block configuration parameter cannot be downloaded into the field device, the
parameter index is stored in the CFGERR parameter and the following informational message is
generated:
“FF CFGERR in Parameter nnnnnnnn”
where: nnnnnnnn = ASCII name of the parameter indicated by the index in CFGERR

4.6.13 Bad Alarming


If the Bad Alarm option (BADOPT) is set, alarming is performed as follows:
♦ Bad Alarm status information is set in the block when the BAD status of the
BCALCO parameter is set. The BAD bit is set in the alarm status parameter
(ALMSTA.BAD). The UNACK parameter and the corresponding
ALMSTA.UNACK bit also are set.
♦ The CRIT parameter and its corresponding ALMSTA.CRIT field are set to the
BADPRI parameter value, and the PRTYPE parameter and its corresponding
ALMSTA.PRTYPE field are set to the appropriate alarm type.
♦ When the Bad Alarm condition occurs, a Bad Alarm message is sent to all devices in
the BADGRP alarm group. This message contains the OUTDSC output descriptor,
the BADTXT descriptive text, and the LOOPID loop identifier.
♦ When the Bad alarm condition clears, a return-to-normal message is generated and
sent to all devices in the bad alarm group.
The CRIT, PRTYPE, and corresponding ALMSTA fields are cleared when there are no active
alarms in the block.
The UNACK parameter and the ALMSTA.UNACK bit are cleared in these cases:
♦ When the alarm is acknowledged by an OM set operation at either the compound
level, by setting the compound UNACK=0, or at the block level, by setting the block
UNACK=0.
♦ When all alarm conditions in the block return to normal status, if INHOPT is set
appropriately.
♦ When the block is shut down.

153
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

When UNACK is cleared, an Alarm Acknowledge message is generated and sent to all devices in
all alarm groups in the block.
Alarm Inhibiting/Disabling is supported using a combination of the compound CINHIB param-
eter and the INHOPT, INHIB, and INHALM parameters in the I/A Series DO block, to allow
the alarm messages to be inhibited and/or alarm detection to disabled dynamically.
When an alarm type is inhibited or disabled, an appropriate Alarm Disable message is generated
and sent to all devices in the alarm group. If the block is unacknowledged, an Alarm Acknowledge
message also is sent to these devices. In addition, the ALMSTA.INHIB bit is set, and the corre-
sponding INHSTA bit is set.
When an alarm type is uninhibited or enabled, an appropriate Alarm Enable message is generated
and sent to all devices in the alarm group. In addition, the ALMSTA.INHIB bit is cleared if no
other alarm in the block is inhibited, and the corresponding INHSTA bit is cleared.
The Alarm Reprioritization and Alarm Message Regeneration (using AMRTIN) enhancements
also are supported in the I/A Series DO block. Refer to the CP270 Integrated Control Concepts
(B0700AG) user document for details.

4.6.14 Block Shutdown


The I/A Series DO block shuts down when any of these events occur:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ The ECB201 connected to the block is deleted.
♦ The DO block itself is deleted.
When block shutdown occurs, the following actions are taken:
♦ If any alarms are active, an Alarm Disable message is issued to all devices in the bad
alarm group. If the alarms are unacknowledged, an Alarm Acknowledge message also
is sent to these devices.
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, UNACK) are cleared.
If not simulating (SIMOPT=0) and the compound is off, the following actions are taken:
1. If the FF_OOS_OPT bit (Bit 4: 0x0010) is set in the Station block CFGOPT param-
eter, the following additional actions are taken:
♦ The actual mode parameter (MODE_A) is set to OOS.
♦ A write message is sent to the FBM228 with both the OOS and IMAN bits set in
the Target mode. The IMAN bit is set to indicate to the FBM228 that the com-
pound is off.
♦ Otherwise, a write message is sent to the FBM228 with only the OOS bit set in
the Target mode.
2. Otherwise, the following action is taken:
♦ A write message is sent to the FBM228 with both the current state and the IMAN
bits set in the Target mode. The IMAN bit is set to indicate to the FBM228 that
the compound is off.

154
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

4.6.15 Simulation
The I/A Series DO block SIMOPT parameter enables simulation of an discrete input to the con-
trol system from the corresponding device DO function block. This feature can be used to test
control schemes requiring analog inputs without actual FBM228 hardware connections.
When SIMOPT= 1 (True), the status and value of OUT_D are not recovered from the field, but
can be set directly to simulate input from the field.
When simulating (SIMOPT=1), the following functions will be performed:
♦ The CASIND input is stored in the OUT_D output value when the block mode is
Auto.
♦ The OUTSTS output status parameter is set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (CAS_SW, AUT_SW, MAN_SW,
or OOS_SW) immediately update the target mode parameter (MODE_T), and the
actual block mode (MODE_A) tracks MODE_T each block cycle.
♦ If the Bad Alarm option is specified (BADOPT =1), bad alarming of the BCALCO
parameter is performed.
When simulating, the following functions are not performed:
♦ Downloading of configuration parameters.
♦ Updating of View data parameters.
♦ Block Error (BLKERR) processing.
♦ External configuration changes to function block parameters.
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA) or Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for
instructions on conducting control simulations from the control station.

4.6.16 Block States


The DCI blocks transition through the states detailed in Table 4-18 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 124).

Table 4-18. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.

155
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

Table 4-18. DCI Block States (BSTATE) (Continued)

BSTATE Value
(Int (Bin)) State Value Description
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

4.7 DO Block Application Example


The DO block can be used in any control block configuration, in any compound except the Sta-
tion compound and the Primary ECB compound, in any CP270. It only can be connected to any
device DO function block in a field device hosted by an FBM228, but not to any other device
function block type or to any function block parameter.

156
4. DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Each field device connection must be specified by configuring the name of the ECB201 in the
IOM_ID parameter. The device DO function block connection must be specified by configuring
the DO function block index in the BLKNDX parameter.
The device DO function block output values will be available as connectable I/A Series DI block
parameters which can be connected to other blocks to perform additional functions not provided
by the I/A Series DO block.
Figure 4-2 illustrates an example of the DO block’s use in applications.

Parent ECB200/202

Child ECB201 Child ECB201

PARENT PARENT

IOM_ID IOM_ID
NAME NAME

DI Block LOGIC Block DO Block

PV_D OUT_D BI01 BO01 CASIND


OUT_D
BI08 BO08

IOM_ID IOM_ID
NAME NAME

DI Block DO Block

PV_D OUT_D CASIND


OUT_D

Figure 4-2. Application Example with I/A Series DO Block

157
B0700EC – Rev B 4. DO – Foundation™ fieldbus Discrete Output

158
5. MAI – FOUNDATION™ fieldbus
Multiple Analog Input
This chapter describes the Multiple Analog Input (MAI) block, which interfaces the control
system with a corresponding multiple analog input function block operating in a
FOUNDATION™ fieldbus H1 device.

5.1 Overview
Multiple Analog Input (MAI) is a Distributed Control Interface (DCI) block that provides an
interface between the control processor and a multiple analog input function block operating in
a FOUNDATION fieldbus H1 device (the device function block). The MAI block is supported
on the FCP270 and ZCP270 when the H1 device is connected to the control station by an
FBM228. The MAI block is configured using the Block Configurator in the InFusion Engi-
neering Environment (IEE) as described in InFusion Enterprise Control System: Implementing
FOUNDATION fieldbus in InFusion 2.0 (B0750DA).

NOTE
The MAI block functionality described in this chapter is applicable only for
FBM228s with the software type (SWTYPE) of “128”. For a description of the leg-
acy MAI block functionality (I/A Series systems v8.4.3 or earlier) where FBM228s
have the SWTYPE of “228”, refer to Appendix E “Legacy MAI – Foundation™
fieldbus Multiple Analog Input”.

5.2 Basic Operation


The MAI block integrates the corresponding device function block into the I/A Series system. On
initialization, user-configured parameters in the MAI block are written to key configurable
parameters in the corresponding device function block. During normal operation, the MAI
block’s OUTn (where n is 1 through 8) and OUTSTn parameters hold the value and status of the
function block OUT-n parameters. When the block is not in simulation mode, the PVn parame-
ters reflect the value and status of the function block OUT-n1 parameters. When the block is in
simulation mode (SIMOPT = 1), PVn is settable and is used to change the OUTn value.
In addition, the MAI block provides access to a variety of operational and diagnostic information
via client/server connections with the parameters that are included in the block View data of the
device block. The values read from these parameters are displayed in the block detail displays and
are available for connection to other I/A Series blocks.

1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

159
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

5.3 Features
The MAI block provides the following features:
♦ Acquires the status and value of up to eight published outputs (OUT-1 through OUT-
8) from an multiple analog input (MAI) device function block
♦ Time stamps value and status changes to the eight outputs
♦ Accesses the parameters in the device function block’s Views using change-driven and
periodic client/server connections
♦ Ensures that changes in the device function block’s process values and error conditions
are continuously available for display and connection to the control strategy
♦ Provides for the configuration of selected device block parameters from the I/A Series
system and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Auto, Manual or Out of
Service
♦ Provides alarm reporting for Bad I/O for each output
♦ Supports simulation of the MAI device block output values within the control station

5.4 Block Parameters


Table 5-1 lists the block parameters. See Table 5-11 for mappings between MAI parameters and
their device function block equivalents.

Table 5-1. MAI Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 35 35 (MAI)
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 9
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0, 1
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path
name <= 25
chars or ECB
block name <=
12 chars
CHANNL channel integer no-con/no-set 1 0 to 32767
CHMASK channel mask packed bool- no-con/no-set blank 0x00 to 0xFF
ean
DDITEM DD item long no-con/no-set 0x800209B0
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000 0 to 2147483647
STRATG strategy integer no-con/no-set 999 0 to 65535
MODE_N normal mode short integer no-con/no-set 0x10 0 to 0xFF
MODE_P permitted mode short integer no-con/no-set 0x19 0 to 0xFF

160
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table 5-1. MAI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


MODE_T target mode short integer con/no-set 0x10 0 to 0xFF
HSCO1 output high scale real no-con/no-set 100.0 > LSCO1
LSCO1 output low scale real no-con/no-set 0 < HSCO1
EO1 output eng units string no-con/no-set % 1 to 32 chars
DESCR1 OUT1 descriptor string no-con/no-set 2 blanks 1 to 32 chars
DESCR2 OUT2 descriptor
DESCR3 OUT3 descriptor
DESCR4 OUT4 descriptor
DESCR5 OUT5 descriptor
DESCR6 OUT6 descriptor
DESCR7 OUT7 descriptor
DESCR8 OUT8 descriptor
INHOPT inhibit option short integer no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short integer con/no-set 8 1 to 8
BADOPT bad alarm option boolean no-con/no-set 0 0 to 1
BADGRP bad alarm group short integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration interval integer no-con/set 0 0 to 32767
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to 2147483647
DVC_ID device ID integer no-con/no-set 0 0 to 0xFFFF
DVCREV device revision long integer no-con/no-set 0 0 to 2147483647
BLKNDX block index long integer no-con/no-set 0 0 to 2147483647
BLKOPT block options integer no-con/no-set 0 0 to 0xFFFF
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to
0xFFFFFFFF
AUT_SW auto switch boolean con/no-set 0 0 to 1
BLKERR block error packed bool- con/no-set 0 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0 to
0xFFFFFFFF
BSTATE block state integer con/no-set 0 0 to 11
CRIT criticality integer con/no-set 1 1 to 5
INHSTA inhibit status packed long con/no-set 0 0 to
0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode short integer con/no-set 0 0 to 0xFF
OOS_SW out of service switch boolean con/set 0 0 to 1

161
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

Table 5-1. MAI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


OUT1 OUT_1 real con/no-set 0.0
OUT2 OUT_2 (settable in
manual only)
OUT3 OUT_3
OUT4 OUT_4
OUT5 OUT_5
OUT6 OUT_6
OUT7 OUT_7
OUT8 OUT_8
OUTST1 OUT1 status packed bool- con/no-set 0 0 to 0xFFFF
OUTST2 OUT2 status ean
OUTST3 OUT3 status
OUTST4 OUT4 status
OUTST5 OUT5 status
OUTST6 OUT6 status
OUTST7 OUT7 status
OUTST8 OUT8 status
PRTYPE priority type integer con/no-set 0 0, 8
PV1 OUT_1 real con/no-set 0.0
PV2 OUT_2 settable when
SIMOPT = 1
PV3 OUT_3
PV4 OUT_4
PV5 OUT_5
PV6 OUT_6
PV7 OUT_7
PV8 OUT_8
TSTMP1 OUT1 time stamp long integer con/no-set 0 ms after mid-
TSTMP2 OUT2 time stamp night
TSTMP3 OUT3 time stamp
TSTMP4 OUT4 time stamp
TSTMP5 OUT5 time stamp
TSTMP6 OUT6 time stamp
TSTMP7 OUT7 time stamp
TSTMP8 OUT8 time stamp
UNACK unacknowledged boolean con/set 0 0, 1
DEVACK device acknowledge boolean con/set 0 0, 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to
0xFFFFFFFF
CFGERR configuration error short integer no-con/no-set 0
DEFINE no config errors boolean no-con/no-set 1 ---
DESCRP descriptor string no-con/no-set blank 1 to 32 chars

162
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table 5-1. MAI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 1 to 32 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
RO1 output range string no-con/no-set 100.0, 0.0,
0.0
ST_REV status revision integer no-con/no-set 2 blanks 0 to 65535
FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for each
(array element
1x255)
FDATA2 file data bytes 256 to 510 short integer no-con/no-set all 0s 0 to 255 for each
(array element
1x255)

5.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT Alarm Options contain packed long values representing the alarm options
that have been configured in the block and the alarm groups that are in
use. Table 5-2 shows MAI usage of the parameter.

Table 5-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
8 Channel 8
9 Channel 7
10 Channel 6
11 Channel 5
12 Channel 4
13 Channel 3
14 Channel 2

163
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

Table 5-2. ALMOPT Parameter Format (Continued)

Bit
Number*
(0 to 31) Configured Alarm Option, When True
15 Channel 1
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table 5-3 shows the bits used by the MAI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
1=BAD B17
2=BAD B18
3=BAD B19
4 =BAD B20
5=BAD B21
6=BAD B22
7=BAD B23
8=BAD B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

CRIT
UNAK

PRTYPE
BAD
INH

Table 5-3. ALMSTA Parameter Format

Bit Boolean
Number Connection
(0 to 31)* Name Description (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the MAI
block
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
8 Channel 8 Bad Alarm ALMSTA.B24
9 Channel 7 Bad Alarm ALMSTA.B23
10 Channel 6 Bad Alarm ALMSTA.B22
11 Channel 5 Bad Alarm ALMSTA.B21
12 Channel 4 Bad Alarm ALMSTA.B20
13 Channel 3 Bad Alarm ALMSTA.B19
14 Channel 2 Bad Alarm ALMSTA.B18
15 Channel 1 Bad Alarm ALMSTA.B19
22 BAD Bad I/O Alarm: at least one channel ALMSTA.B10
is not usable
29 INH Inhibit Alarm at least one channel is ALMSTA.B3
inhibited
30 UNAK Unacknowledged: There is at least ALMSTA.B2
one unacknowledged alarm
*Bit 0 is the least significant, low order bit.

164
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and therefore MODE_BLK.Target in the associated device
function block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm mes-
sages for this block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the MAI
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block. Table 5-4
shows the parameter format. A given device might not support all bits in
the status word.

165
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

Table 5-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device function block represented by the MAI block. It is set
by the configurator and the FBM uses it to identify the block in the
device. The index is acquired when the MAI block is bound to a DD
either when the device is templated or the block instance is assigned to a
device instance.

BLKOPT Block Options is a configurable, non-settable integer parameter that spec-


ifies a set of optional features in the associated device function block, as
follows:
♦ Bits 0 through 7:
1= Use Publisher/Subscriber connection for channels 1-8
respectively
0= Use Client/Server connection for channels 1-8 respectively
♦ Bits 8-15: 0 (reserved)
Bit 0 is the low-order least significant, low order bit.
CHMASK determines which inputs are to be processed.

166
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 5-5 shows how the bits are used by the MAI
block. A given device might not support all bits in the bits described in the
table.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DEVACK B9

FDFAIL
FDACT
FDMM
FDOK

UDEF

FBM

TRK
LCK

FFX

BIO
ON

MA

LO
FS

Table 5-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local BLKSTA.B29
Override
6 TRK The block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual mode
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
11 MA The block mode is Auto BLKSTA.B21
12 BIO Bad I/O: at least one channel is Bad BLKSTA.B20
14 UDEF The block is undefined BLKSTA.B18
15 ON The compound that contains the block BLKSTA.B17
is ON
16 FFX Enhanced FF block connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FBM228 The H1 device is hosted and scheduled BLKSTA.B13
by an FBM228
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK FDATA installed BLKSTA.B11
22 FDMM FDATA mismatch BLKSTA.B10
23 DEVACK Unacknowledged device alarm BLKSTA.B9
24 FS Fault State has been asserted in the BLKSTA.B8
device function block
* Bit 0 is the least significant, low order bit.

167
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the device block connection as determined by the
FBM228. The following values are used to indicate the current DCI block
state:
0 = Undefined state
1 = Unconnected
2 = Connecting
3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON-LINE
11 = Block ON-LINE with error - Processing has been completed, but
some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 191.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the MAI block becomes undefined due to
a “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index shown in
Table 5-6.

Table 5-6. CFGERR Index

Value Device Function Block Parameter with Error


2 TAG_DESC
3 STRATEGY
5 MODE_BLK
7 CHANNEL

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.
CHANNEL specifies the I/O subsystem by its the transducer block chan-
nel. Refer to the device documentation to identify the correct channel and
any special rules concerning mapping of the device output to the OUT_n
parameters.

CHMASK Channel Mask is a configurable, non-settable packed boolean parameter


that specifies which parameters are to be processed by the MAI block.

168
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

CHMASK does not affect any device function block settings. Table 5-7
shows the parameter format.

Table 5-7. Channel Mask Parameter Format

Bit Number* Parameter Input to be


(0 to 15) Processed When Bit Is Set
0 OUT1
1 OUT2
2 OUT3
3 OUT4
4 OUT5
5 OUT6
6 OUT7
7 OUT8
8-15 Reserved
*Bit 0 is the least significant, low order bit.

CHMASK has a higher priority than BLKOPT.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 170 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string of up to


32 characters used to specify a description for the block. The parameter
tracks the TAGDSC parameter, and is updated when the TAGDSC is
modified.

169
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

DESCRn OUTn Descriptor (where n is 1 through 8) is a configurable, non-settable


(n is 1 through 8) string of up to 32 characters that describes OUTn parameter. If Bad
Alarming is configured (BADOPT= 1), the DESCRn string is included in
the Bad Alarming message for the OUTn parameter.

DEVACK Device Acknowledge is a settable boolean output used to acknowledge


device alarms in the associated device function block. DEVACK is set
when a device alarm status bit is set by the FBM228. DEVACK is cleared
by an operator action.
DEVACK is different from UNACK (described on page 177), which is
used by the operator to acknowledge process alarms in the DCI block.
DEVACK is used to acknowledge device alarms at the ECB201 or DCI
block level.

NOTE
This parameter is not supported currently.

DVC_ID Device Identifier is a configurable, non-settable integer that provides the


Device Identifier of the H1 field device that contains the device function
block represented by the MAI block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device.

DVCREV Device Revision is a configurable, non-settable long integer that provides


the Revision level of the H1 field device that contains the device function
block represented by the MAI block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device. The IEE
configurator encodes the following data in DVCREV:
Bits 16-23 Bits 8-15 Bits 0-7
Device revision Minimum Device Description Common File Format
(DD) File Revision (CFF) File Revision

EO1 Engineering Units for Output 1 specifies the engineering units text for all
OUTn parameters in the MAI block. The value configured for this text
string should be consistent with the values used for HSCO1 and LSCO1.
In the MAI block, EO1, HSCO1 and LSCO1 are used for scaling the
outputs in detail displays and other I/A Series system uses. These parame-
ter do not configure units and scaling in the device function block. How-
ever, they should reflect the device scaling.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table 5-8 lists the possible values of ERCODE for the MAI block.

170
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table 5-8. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION
W44 - INVALID ENGINEERING RANGE
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in the MAI block. The range is 1 to 8 (default).

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (from the device
block BLOCK_ERR parameter) generate an alarm message. The parameter
has the same format as BLKERR (Table 5-4).

FDATA1 File Data #1 and File Data #2 are settable multi-byte arrays that provide
FDATA2 configuration data for the device block represented by the MAI block.
This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 510 bytes.

HSCO1 Output High Scale specifies the high scale value for OUTn parameters in
the MAI block. The value configured for HSCO1 should be consistent
with the values used for EO1 and LSCO1. In the MAI block, EO1,
HSCO1 and LSCO1 are used for scaling the outputs in detail displays

171
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

and other I/A Series system uses. These parameter do not configure units
and scaling in the device function block. However, they should reflect the
device scaling.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm gener-
ation-inhibit requests for each type of alarm configured in the block.
Table 5-9 shows how the bits are used by the MAI block.

Table 5-9. INHALM Parameter Format

Bit Boolean
Number* Connection
(0 to 15) BAD Alarm Inhibited When True (B16 to B1)
8 Channel 1 INHALM.B8
9 Channel 2 INHALM.B7
10 Channel 3 INHALM.B6
11 Channel 4 INHALM.B5
12 Channel 5 INHALM.B4
13 Channel 6 INHALM.B3
14 Channel 7 INHALM.B2
15 Channel 8 INHALM.B1
*Bit 0 is the least significant, low order bit.
There are no mnemonic names for the individual bits of INHALM.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

172
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table 5-10
shows how parameter is used with the MAI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
CH8 B1
CH7 B2
CH6 B3
CH5 B4
CH4 B5
CH3 B6
CH2 B7
CH1 B8
B9 Table 5-10. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) When True (B32 to B1)
24 Channel 1 alarms inhibited INHSTA.B8
25 Channel 2 alarms inhibited INHSTA.B7
26 Channel 3 alarms inhibited INHSTA.B6
27 Channel 4 alarms inhibited INHSTA.B5
28 Channel 5 alarms inhibited INHSTA.B4
29 Channel 6 alarms inhibited INHSTA.B3
30 Channel 7 alarms inhibited INHSTA.B2
31 Channel 8 alarms inhibited INHSTA.B1
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up
to 25 characters (12 for <local_compound_name>, 1 for the
colon, and 12 for the <ecb_name>).

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has

173
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

the format LETTERBUG:DEVNAME, where LETTERBUG is the


6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the display task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block.

LSCO1 Output Low Scale specifies the low scale value for OUTn parameters in
the MAI block. The value configured for LSCO1 should be consistent
with the values used for EO1 and HSCO1. In the MAI block, EO1,
HSCO1 and LSCO1 are used for scaling the outputs in detail displays
and other I/A Series system uses. These parameter do not configure units
and scaling in the device function block. However, they should reflect the
device scaling.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and therefore MODE_BLK.Target in the associated device function block,
to Manual.

MODE_A Actual Mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device func-
tion block.

MODE_N Normal Mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Normal parameter of the associated
device function block.

MODE_P Permitted Mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target Mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Target parameter of the associated
device function block.
Note that AUT_SW, MAN_SW, and OOS_SW can be used to change
the MODE_T parameter and thus the MODE_BLK.Target parameter in
the device function block.

174
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the MAI block is initialized,
the block updates the configurable parameters of the function block
matched to the MAI block by the configured index (BLKNDX). The
NAME parameter is used to set the Block Tag of the device function
block.

OOS_SW Out of Service Switch is a settable output used set the MODE_T parame-
ter, and therefore MODE_BLK.Target in the associated device function
block, to Out of Service.

OUTn OUTn (where n is 1 through 8) is a real output contains the OUT_n


(n is 1 through 8) parameter of the associated device function block when the block is in
Auto mode and not simulating (SIMOPT =0). It is settable only in Man-
ual mode. When the block is simulating (SIMOPT =1), OUTn tracks the
latest PVn value set by an operator (when the block is in Manual mode) or
an application (when the block mode is Auto).

OUTSTn OUTn Status (where n is 1 through 8) is a non-configurable, non-settable


(n is 1 through 8) packed boolean that contains the OUT_n.Status from the associated
device function block. Section 5.6.6.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
* If the BPC is 0.2 second, this period is treated internally as
0.6 second, but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with
a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,

175
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the MAI block:
0 = No alarm
8 = Bad I/O alarm.

PVn Process Variable n (where n is 1 through 8) is a real output that contains


(n is 1 through 8) the OUT_n parameter of the associated device function block (even when
the block mode is Manual). PVn is non-settable when the block is in nor-
mal operation (SIMOPT = 0). When the block is in simulation mode
(SIMOPT =1), PVn is settable.

RO1 Range Output 1 is a real array consisting of the two parameters: HSCO1
and LSCO1. The array members are configured by their individual
names; however, RO1 and its members can be accessed on an array basis
by user tasks and displays.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


OUTn outputs of the MAI block are to be simulated.
When SIMOPT= 1 (True), the status and value of OUTn are not recov-
ered from the field, but are copied from the corresponding PVn parameter
if the block is in Auto mode. When SIMOPT= 1 (True), PVn is settable.
The simulated values are limited by HSCO1 and LSCO1. If this limiting
action forces a clamping of the entered value, the status of OUTn is set to
Limited High or Limited Low, as appropriate.

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block. ST_REV is incre-
mented by one each time a configurable parameter in the device function
block is modified by an external source.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device
function block. The TAGDSC string is also copied to the MAI block
parameter DESCRP, which describes the block in I/A Series displays.

TSTMPn Time Stamp n (where n is 1 through 8) is a non-settable long integer that


(n is 1 through 8) represents the time of the last change to the value or status of an OUTn
parameter of the MAI block. The time is in milliseconds past midnight.
During normal operation, the time is from the FBM228; when the block
is in simulation (SIMOPT = 1), the value is computed by the CP.

176
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

TYPE Type is the block type. When an MAI block is added to the control data-
base, the configuration editor enters a numeric value of 35 to specify the
MAI block type.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the system management dis-
play.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 client/server connections
that scan the device function block View parameters. The range is 0 to
2147483647 milliseconds; the default is 10000

5.5 Device Function Block Description


This section describes the FOUNDATION fieldbus multiple analog input device function block,
and includes a block schematic, a brief description of the block’s standard parameter set, and a
table showing the mapping between the I/A Series system MAI block parameters and the device
function block parameters.

5.5.1 Device Block Operation


The FOUNDATION fieldbus multiple analog input device function block processes up to eight
measurements from a field device and makes them available in the OUT_n (where n is 1 through
8) parameters (Figure 5-1).
The CHANNEL parameter specifies the source of the transducer block output data unit that is
parsed by the block and mapped to the OUT_n parameters.

PV_n
(n = 1 to 8)
CHANNEL
Outputs
OUT_n
(n = 1 o 8)

Mode Alarms
BLOCK_ALM

Figure 5-1. MAI Device Function Block Schematic

5.5.1.1 Mode
The device function block supports three selectable modes:

177
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

♦ In Auto mode, the block’s output parameters (OUT_1 to OUT_8) reflect the process
variables’ (PV_1 to PV_8) values and status.
♦ In Manual, the OUT_n parameter can be set manually and the OUT_n.Status reflects
the mode.
♦ In OOS (out of service), the block values are not updated and the status of OUT_n is
set to BAD. In OOS, changes can be made to configured parameters.

5.5.1.2 Status
The device function block provides an eight-bit status for each output value, using the standard
function block value status, which is further parsed in to .Quality, .SubStatus, and .Limits bits.
The .SubStatus bits in this block are device-specific. Refer to “Device Parameter Status” on
page 185 for use of the bits.

5.5.1.3 Alarms
The BLOCK_ALM parameter is used for all configuration, hardware connection, and system
problems in the block.
The I/A Series system does not use the alarm features provided by the device blocks, but rather
provides alarm handling and error reporting options in the I/A Series MAI block. The MAI block
enables BAD alarming using standard I/A Series alarm parameters (see Section 5.6.8).

5.5.1.4 Non-standard Parameters


Device manufacturers offer a variety of device function block parameters which are specified in
their included documentation. These parameters are not supported by the I/A Series MAI block,
but can be configured using Field Device Manager.

5.5.2 Parameter Transforms


Table 5-11 shows the mapping of MAI parameters to parameters in the related device function
block. Many of the parameters are straightforward 1:1 mappings that are either unidirectional or
bidirectional. Other mappings require that a data value be re-formatted (or transformed) to be
intelligible in the I/A Series system.
From the point of view of the MAI block, the relationship with the device function block can also
be described in terms of sink and source connections:
→ Source-sink The MAI block parameter is the source for the corresponding func-
tion block parameter. Thus, changes to the MAI block parameter are
made to the device function block parameter. For example, when the
MAI block is initialized, the TAGDSC value is copied to the device
function block TAG_DESC parameter.

178
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

← Sink-source The MAI block parameter value is updated by the corresponding


device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual function block mode visible to the control system.
↔ Bidirectional Changes to the MAI block parameter are made to the corresponding
device function block parameter and vice versa. For example, when
the MAI block is initialized, its MODE_T parameter value is written
to the device block parameter, MODE_BLK.Target, to configure the
block’s target mode. Subsequently, the MODE_BLK.Target value is
written back to the MAI block MODE_T parameter.

The arrow notation is used in the Table 5-11 descriptions of MAI parameter transforms. These
are presented in alphabetic order, arranged by the MAI block parameter names.

Table 5-11. MAI Block Parameter Transforms

MAI Block Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target

When AUT_SW = 1:
Set MODE_T (request) = AUTO
MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP to FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.MA=0 ← MODE_BLK.Actual.MAN
BLKSTA.MA=1 ← MODE_BLK.Actual.AUTO
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← Any OUTn.Status.Bad (Bits 6-7=0), n=1-8
CHANNL ↔ CHANNEL
HSCO1 ↔ OUT_SCALE.@100%
LSCO1 ↔ OUT_SCALE.@0%
MAN_SW MODE_BLK.Target
When MAN_SW =1:
Set MODE_T (request) = MAN
AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permitted

179
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

Table 5-11. MAI Block Parameter Transforms (Continued)

MAI Block Parameter Device Function Block Parameter


MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW =1:
Set MODE_T (request) = OOS
AUT_SW=0, MAN_SW=0
Write MODE_T (request) to FBM
OUTn (n = 1 to 8) OUTn (n = 1 to 8) in Auto Mode only if not Simulating
OUTn.value ← OUTn.Value
OUTn.status.LHI ← OUTn.Status.Limited Hi (Bit 0),
OUTn.status.LLO ← OUTn.Status.Limited Lo (Bit 1)
OUTn.status.ERR ← OUTn.Status.Uncertain (Bits 6-7=1)
OUTn.status.BAD ← OUTn.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure,
or FF H1 Device is Failed or Disabled
OUTn.status.OOS ← OUTn.Status.Bad (Bits 6-7=0) and Substatus.OOS
(bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
OUTSTn OUT_n
OUTSTn.value ← OUT_n.Status
PVn (n = 1 to 8) OUT_n (n = 1 to 8) (when block is not simulating)

PVn.value ←OUT_n.Value
PVn.status.LHI ← OUT_n.Status.Limited Hi (Bit 0)
PVn.status.LLO ← OUT_n.Status.Limited Lo (Bit 1)
PVn.status.ERR ← OUT_n.Status.Uncertain (Bits 6-7=1)
PVn.status.BAD ← OUT_n.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
or H1 device is Failed or Disabled.
PVn.status.OOS ← OUT_n.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5=
7),
or Compound is Off
or FBM228 is Off-Line or DCI Not Ready
or H1 Device is Failed or Disabled
or CP-FBM communication failure
or DCI_COMM_DATA.connect_status <= 0
PVFTIM ↔ PV_FTIME
STRATG ↔ STRATEGY

180
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table 5-11. MAI Block Parameter Transforms (Continued)

MAI Block Parameter Device Function Block Parameter


ST_REV ← ST_REV
TAGDSC → TAG_DESC
Note: Changes to TAGDSC are copied to DESCRP.

5.6 MAI Block Functions


The I/A Series MAI block provides the interface between CP-resident control blocks and the
device function block in the H1 device.
The MAI block OUTn (where n is 1 through 8) and OUTSTn parameters hold value and status,
respectively, of the device function block OUT_n parameter.
The device function block provides the outputs in engineering units determined by the device and
connected devices. The I/A Series MAI block does not configure scaling in the device. Instead, the
scaling parameters in the MAI block (HSCO1, LSCO1 and EO1) specify the range and unit of
measure label for OUT_n parameters as used in detail displays and other I/A Series system uses of
the outputs. The same display scaling is used for all block outputs, and should reflect the range
and unit of measure configured in the device.
The block also supports the function block’s mode parameters.
The MAI block and the device function block operate in two asynchronous cycles, both writing
to and reading from shared space in the FBM memory. As with other I/A Series IO blocks, the
MAI block executes in the Basic Processing Cycle (BPC) of the control station according to its
compound and its PERIOD and PHASE parameters, as described in Control Processor 270
(CP270) Integrated Control Software Concepts (B0700AG). The device MAI block executes once
each FBM macrocycle as scheduled by the FBM228.
The principal task of the MAI block is to read values and status from the corresponding device
block. For this task, publisher/subscriber and/or client/server connections (which are based on the
BLKOPT and CHMASK parameters) are maintained between the MAI block OUTn parameters
and the device function block OUT_n parameters.
All other parameter connections are made by the FBM228 on a client/server basis at the fre-
quency specified in the UPDPER parameter. The parameter can be set from 0 to 2147483647
milliseconds; the default is 10000 (10 seconds). Increasing the frequency of the client/server com-
munication can significantly add to the load on the H1 segment.

5.6.1 Device Function Block Connection


The configured parameter IOM_ID of the MAI block specifies an ECB201 (the device ECB) that
represents the target H1 device. The ECB201 PARENT parameter identifies the ECB200 or
ECB202 for the FBM228. The path to the device block is completed as follows. When the MAI
block is configured using IEE, the device function block is selected in a browser which displays
the device function blocks based on the device description in the device ECB. If the connection is
not made via the browser, the connection is made based on the MAI block BLKNDX parameter.
The MAI block CHANNL parameter is used to configure the device block CHANNEL parame-
ter and thus identify the I/O subsystem equipment providing the inputs. Refer to the device doc-
umentation for the appropriate channel assignment.

181
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

The CHMASK parameter is used to specify which of the eight device block outputs are to be pro-
cessed by the MAI block. CHMASK does not affect any settings in the device function block.
The BLKSTA parameter is used to specify the current block operational states.
To assign function blocks to their device, refer to “Assign the Function Blocks to a Device” in
InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA).

5.6.2 Device Configuration Parameters


The MAI block enables you to set key configurable parameters in the corresponding device func-
tion block and manage the configuration from the I/A Series system. When you deploy the MAI
block to the control station, and then download the FBM228, parameter values in the MAI block
update parameters in the linked device function block.
The deployment of the MAI block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Schedule execution of the device function block
♦ If needed, add compel data (CD) messages to each macrocycle to publish the OUT_n
parameter values and status, as specified by the BLKOPT and CHMASK parameters.
♦ Schedule client/server connections between the MAI block and the device function
block for view updates
Table 5-12 lists the device function block parameters and the MAI block parameters used to con-
figure them. For the MAI, the table includes both the six-character (maximum) parameter name
that is used in block detail displays and the parameter labels which more closely resemble the
FOUNDATION fieldbus parameter names. Use the six-character parameter name when connecting
parameters to a process display.

Table 5-12. MAI Block Configuration Parameters

Configured with MAI Block Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
CHANNEL CHANNL Channel
FF_BLOCK.BLOCK_TAG NAME Name
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc

5.6.3 Block Validation


The I/A Series MAI block initializes when any of these events occur:
♦ The block is installed or reconfigured via the IEE control configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.

182
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

When the MAI block initializes, the following block validation tests are performed:
♦ If the high range value (HSCO1) is not less than the low range value (LSCO1), the
block is marked undefined (BLKSTA.UDEF=1) with the error code parameter
(ERCODE) set to “W44 - INVALID ENGINEERING RANGE”.
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Auto,
Manual or Out-of-Service, the block is marked undefined (BLKSTA.UDEF=1) with
the error code parameter (ERCODE) set to “W76 - INVALID FF MODE
CONFIGURATION”.
If the FBM simulation is not used (SIMOPT=0), the following validation tests are performed:
♦ If the MAI block is installed prior to the installation of the ECB201 block, it is
marked undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE)
set to “W54 - ECB DOES NOT EXIST”. In this case, the MAI block configuration
is restarted and re-validated automatically when the ECB201 is installed.
♦ An attempt is made to connect the MAI block to the ECB201 specified in the
IOM_ID parameter. The DCI connection address (i.e., the NAME parameter in the
MAI block) is used in a connect message to establish a block connection in the
FBM228. The CHMASK parameter is embedded in the connect message to indicate
which of the 1-8 input channels are to be enabled.
♦ If the data connection cannot be resolved due to a lack of configuration information,
a block connection is made in the FBM, the connection status is marked Unresolved,
and one of the following error strings is stored in the block ERCODE parameter:
♦ “W62 - UNRESOLVED CONNECTION”
♦ “W77 - FIELDBUS COMMUNICATIONS FAULT”
♦ “W78 - INVALID FUNCTION BLOCK”
♦ “W80 - FIELDBUS DEVICE NOT FOUND”
♦ “W82 - FF CONFIGURATION IN PROGRESS”
(In these cases, the MAI block is defined, but the output values are marked OOS.)
♦ “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the MAI block is defined, and the index of the invalid function block
parameter is stored in the CFGERR parameter.)
♦ If the MAI data connection cannot be made for any other reason, the FBM rejects the
connection request and one of the following error strings is stored in the ERCODE
parameter to indicate the reason for the connection error:
♦ “W65 - INVALID POINT ADDRESS”
♦ “W66 - DUPLICATE CONNECTION”
♦ “W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS”
♦ “W68 - INVALID DEVICE CONNECTION”
♦ “W69 - INVALID POINT CONNECTION”
♦ “W74 - FF FUNCTION BLOCK DDITEM MISMATCH”
♦ “W75 - FF FUNCTION BLOCK DDMBR MISMATCH”
♦ “W76 - INVALID FF MODE CONFIGURATION”
♦ “W79 - INVALID PARAMETER INDEX”

183
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

(In these cases, the MAI block is undefined.)


♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the MAI
block is undefined with ERCODE set to “W43 - INVALID PERIOD/PHASE
COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the MAI
block is undefined with ERCODE set to “W81 - INVALID PARENT DCI ECB
PERIOD/PHASE”.
If there are no configuration errors when the I/A Series MAI block is installed, the block is
marked defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the compound con-
taining the block is turned on, the block also initializes and starts running automatically.

5.6.4 Block Initialization


When the I/A Series MAI block initializes, the following are performed:
♦ All alarm status parameters (ALMSTA, INHSTA, CRIT, PRTYPE, UNACK) are
cleared.
♦ The Actual mode parameter (MODE_A) is set to Initialization Manual (IMAN) in
the I/A Series MAI block.
♦ The Target mode parameter (MODE_T) is set to only one of the following states, in
order, if multiple bits are set: Auto, Manual, OOS.
♦ The status of all OUT1-OUT8 parameters not specified in CHMASK are set to BAD
and OOS.
♦ The timestamps for each of the 1-8 outputs are updated.
If not simulating (SIMOPT=0), the following are performed:
♦ The Target mode is sent to the device MAI function block.
♦ If installing the block, or if rebooting and not a Warm Restart, the configuration
parameters are downloaded to the device MAI function block.

5.6.5 I/A Series Parameter Status


The status of the device MAI function block parameters is provided in the I/A Series MAI block
in two forms:
♦ The status of each device function block parameter is available as a separate I/A Series
MAI block parameter.
♦ The status of each device function block parameter also is mapped onto equivalent
fields in the value record status of the corresponding I/A Series MAI block parameter.
For each device function block parameter containing status information, the following fields are
mapped:
♦ The Quality field (Bits 6-7) is mapped onto the BAD and ERR status bits.
♦ The Sub-status field (Bits 2-5) is ignored, except for the case when the Quality is Bad
and the Sub-status is OOS. In this case, the OOS status bit is set in the I/A Series
MAI block parameter.

184
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

♦ The Limited High (Bit 0) and Limited Low (Bit 1) fields are mapped onto the LHI,
LLO status bits, respectively.

5.6.6 Device Parameter Status


NOTE
The .SubStatus bits in multiple discrete input blocks vary with the specific I/O sub-
system or multi-sensor device, and may not be the same as the standard
FOUNDATION fieldbus bit assignment used in other device function blocks.

Table 5-13 shows how the status byte is formatted.

Table 5-13. MAI Device Parameter Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 Refer to the device documentation
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table 5-14 shows the usage of the Substatus bits, which varies depending on which .Quality bits
are set.
Table 5-14. Device Parameter Substatus

Bits 2-5 = SubStatus Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.

185
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

Table 5-14. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus Description


6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.
4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.

186
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table 5-14. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus Description


3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

5.6.7 Block Modes


The MAI block provides interactive support of the MODE_BLK function block parameter. The
Target, Permitted, Normal, and Actual modes are provided as separate block parameters.
The configuration of the Target, Permitted, and Normal modes are supported. These parameters
are downloaded to the device MAI function block when the I/A Series MAI block initializes.
The Target mode can be changed through a group of settable Boolean mode switches provided in
the I/A Series MAI block. These mode switches, AUT_SW, MAN_SW, and OOS_SW, allow the
block mode to be changed to Auto, Manual, or Out-of-Service respectively.
♦ Logic in the CP270 prevents more than one switch to be set at a given time. If more
than one switch is set during the same block cycle, only the last switch setting is
honored.
♦ Once set, a mode switch remains set only until the Target mode change is sent to the
FBM228 or until another mode switch is set. At that time, the mode switch is cleared.
♦ The mode switch setting is mapped onto an equivalent Target mode setting sent to
the FBM228.
The Target mode is a shadow parameter updated from the MODE_BLK function block parame-
ter read back during input scanning of the FBM228.
When the Actual, Permitted, Target, or Normal modes change in the MAI device function block,
the corresponding I/A Series mode parameters are updated automatically from the MODE_BLK
function block parameter. In addition, the Actual mode is mapped onto equivalent BLKSTA
parameter bits.
The INITMA parameter and the Auto/Manual override parameters, AUTSW and MANSW, are
not supported in the I/A Series MAI block, since these functions do not exist in the device MAI
function block.
When the Actual block mode is Auto or Manual, the following are performed:

187
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

♦ The OUTST1-OUTST8 status parameters and the value status of the OUT1-OUT8
parameters are updated from data received in the reply to the read message. The
CHMASK parameter is used to determine which outputs to process.
♦ The PV_D1-PV_D8 input parameter values are updated from data received in the
reply to the read message. The CHMASK parameter is used to determine which
inputs to process.
♦ Configuration parameters that have changed since the previous block cycle are
downloaded.
♦ Other View data parameters are updated, if any changes in these parameters have
occurred since the previous block cycle.
♦ Block Error (BLKERR) processing begins.
♦ External configuration changes to function block parameters are propagated.
♦ Configuration Error (CFGERR) processing begins.
♦ If BADOPT=1, Bad Alarming of the inputs is performed.
When the Actual block mode is Auto, the following is performed:
♦ The OUT1-OUT8 output parameter values and status are updated from data
received in the reply to the read message. The CHMASK parameter is used to deter-
mine which outputs to process.
When the Actual block mode is Manual, the operator is allowed to set any of the OUT1-OUT8
output parameter values directly via an OM set operation. When any of these parameters are
changed in the CP, the new values are sent to the FBM228 which, in turn, updates the corre-
sponding function block parameters in the field device.

5.6.8 Block Alarming


The MAI block performs alarm functions consistent with standard CP270 alarming. This
includes the following types of process alarms:
♦ Bad Alarming of each of the OUT1-OUT8 outputs. The CHMASK parameter pro-
vides a bitmap that used to determine which outputs to process.
♦ Informational messages of block errors (BLKERR) reported by the device MAI func-
tion block BLOCK_ERR parameter.
♦ Informational messages of function block configuration errors (CFGERR).
The device MAI function block alarm detection, alarm events, alarm messaging, and associated
parameters provided by the field device are not supported in the I/A Series MAI block.

5.6.9 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter is performed as
follows:
♦ For every condition specified in ERROPT, a corresponding Informational message is
sent to the ERRGRP alarm group when the condition occurs. The UNACK parame-
ter and the corresponding ALMSTA.UNACK bit also are set. ERROPT has the same
format as BLKERR (Table 5-4 on page 166).
♦ One of the messages listed in Table 5-15 is generated.

188
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table 5-15. Block Error Messages

ERROPT Bit Message Text


Bit 0 FF Block Error: Out-of-Service
Bit 1 FF Block Error: Power Up
Bit 2 FF Block Error: Maintenance Needed Now
Bit 3 FF Block Error: Readback Check
Bit 4 FF Block Error: Lost NV Data
Bit 5 FF Block Error: Lost Static Data
Bit 6 FF Block Error: Memory Fail
Bit 7 FF Block Error: Output Fail
Bit 8 FF Block Error: Input Fail
Bit 9 FF Block Error: Maintenance Due Soon
Bit 10 FF Block Error: Fault State Active
Bit 11 FF Block Error: Local Override
Bit 12 FF Block Error: Simulation Active
Bit 13 FF Block Error: Link Configuration Error
Bit 14 FF Block Error: Block Configuration Error
Bit 15 FF Block Error: Other (Undefined) Error

5.6.10 Configuration Error Processing


When an FF block configuration parameter cannot be downloaded into the field device, the
parameter index is stored in the CFGERR parameter and the following informational message is
generated:
“FF CFGERR in Parameter nnnnnnnn”
where: nnnnnnnn = ASCII name of the parameter indicated by the index in CFGERR

5.6.11 Bad Alarm Detection


Bad alarm detection is supported when the Bad alarm configuration option (BADOPT) is set.
Bad alarm status information is generated when any point is bad. This philosophy is consistent
with the handling of state alarms in the BLNALM block.
Bad alarm messages are generated for each point independently when its status is bad (i.e.,
OUTn.BAD, where n=1-8).
When the point value becomes bad, a bad alarm message is created and sent to all devices in the
bad alarm group specified by the BADGRP parameter. This message contains a “BAD_n” (if
OUTn) text string to identify the appropriate point. This message also contains the respective
DESCRn point descriptor, the descriptive text in the BADTXT parameter, and the loop identifier
in the LOOPID parameter.
When the point value becomes good, a return-to-normal message is generated and sent to all
devices in the bad alarm group.
When any point value is bad, the BAD bit is set in the alarm status parameter (ALMSTA.BAD).
The UNACK parameter and the ALMSTA.UNACK bit are set. The CRIT parameter and ALM-
STA.CRIT field are set to the BADPRI parameter value, and the PRTYPE parameter and ALM-
STA.PRTYPE field are set to the Bad alarm type.

189
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

When all point values have returned to good status, BAD, CRIT, PRTYPE and their correspond-
ing fields in ALMSTA are cleared.
The UNACK parameter and the ALMSTA.UNACK bit are cleared in these cases:
♦ When the alarm is acknowledged at the compound level, by setting the compound
UNACK=0, or at the block level, by setting the block UNACK=0.
♦ When all point values return to normal, if INHOPT is set appropriately.
♦ When the block is shut down.
When UNACK is cleared, an Alarm Acknowledge message is generated and sent to all devices in
the bad alarm group.
Alarm Inhibiting/Disabling is supported using a combination of the compound CINHIB param-
eter and the INHOPT, INHIB, and INHALM parameters in the MAI block, to allow the bad
alarm messages to be inhibited and/or the alarm detection to disabled dynamically.
The INHALM parameter can be used to inhibit or disable bad alarming selectively for any group
of the 1-8 points.
When Bad alarming is inhibited or disabled, an Alarm Disable message is generated and sent to all
devices in the alarm group. If the Alarm is unacknowledged, an Alarm Acknowledge message also
is sent to these devices. The ALMSTA.INHIB bit is set, and the appropriate INHSTA.BAD bits
are set.
When Bad alarming is uninhibited or enabled, an Alarm Enable message is generated and sent to
all devices in the alarm group. The appropriate BAD bits in the INHSTA parameter are cleared,
and the ALMSTA.INHIB bit is cleared if all channels are uninhibited or enabled.
The Alarm Reprioritization and Alarm Message Regeneration (using AMRTIN) enhancements
also are supported in this MAI block. Refer to the Control Processor 270 (CP270) Integrated Con-
trol Software Concepts (B0700AG) for details.

5.6.12 Block Shutdown


The MAI block shuts down when any of these events occur:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ The ECB201 connected to the block is deleted.
♦ The MAI block is deleted.
When block shutdown occurs, the following actions are taken:
♦ If any Bad Alarms are active, an Alarm Disable message is issued to all devices in the
bad alarm group. If the Bad Alarms are unacknowledged, an Alarm Acknowledge mes-
sage also is sent to these devices.
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, UNACK) are cleared.
If not simulating (SIMOPT=0) and the compound is off, the following actions are taken:
1. If the FF_OOS_OPT bit (Bit 4: 0x0010) is set in the Station block CFGOPT param-
eter, the following additional actions are taken:
♦ The actual mode parameter (MODE_A) is set to OOS.

190
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

♦ A write message is sent to the FBM228 with both the OOS and IMAN bits set in
the Target mode. The IMAN bit is set to indicate to the FBM228 that the com-
pound is off.
♦ Otherwise, a write message is sent to the FBM228 with only the OOS bit set in
the Target mode.
2. Otherwise, the following action is taken:
♦ A write message is sent to the FBM228 with both the current state and the IMAN
bits set in the Target mode. The IMAN bit is set to indicate to the FBM228 that
the compound is off.

5.6.13 Simulation
The I/A Series MAI block SIMOPT parameter enables simulation of multiple analog inputs to
the control system from the corresponding multiple analog input device function block. This fea-
ture can be used to test control schemes requiring analog inputs without actual FBM228 hard-
ware connections.
When SIMOPT= 1 (True), the status and value of OUTn are not recovered from the field, but
can be set directly to simulate input from the field.
When simulating (SIMOPT=1), the following functions will be performed:
♦ The PVn inputs are settable and are stored to the OUTn output values when the
block mode is Auto. The CHMASK parameter will be used to determine which out-
puts to process.
♦ The OUTSTn output status parameters are set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (AUT_SW, MAN_SW, or
OOS_SW) immediately update target mode parameter (MODE_T), and the actual
block mode (MODE_A) tracks MODE_T each block cycle.
♦ If BADOPT=1, Bad Alarming of the inputs is performed.
When simulating, the following functions are not performed:
♦ Downloading of configuration parameters.
♦ Updating of View data parameters.
♦ Block Error (BLKERR) processing.
♦ External configuration changes to function block parameters.
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA) or Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for
instructions on conducting control simulations from the control station.

5.6.14 Block States


The DCI blocks transition through the states detailed in Table 5-16 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 168).

191
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

Table 5-16. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

192
5. MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

5.7 MAI Block Application Example


The MAI block can be used in any control block configuration, in any compound except the Sta-
tion compound and the Primary ECB compound, in any CP270. It only can be connected to any
device MAI function block in a field device hosted by an FBM228, but not to any other device
function block type or to any function block parameter.
Each field device connection must be specified by configuring the name of the ECB201 in the
IOM_ID parameter. The device MAI function block connection must be specified by configur-
ing the MAI function block index in the BLKNDX parameter.
Figure 5-2 illustrates an example of the MAI block’s use in applications.

Parent ECB200/202

Child ECB201 Child ECB201

PARENT PARENT

IOM_ID IOM_ID
NAME NAME

MAI Block PIDA Block AO Block

PV1 OUT1 MEAS OUT CAS_IN


BCALCI BCALCO
PV8 OUT8

IOM_ID
NAME

PIDA Block AO Block

MEAS OUT CAS_IN


BCALCI BCALCO

Figure 5-2. Application Example with I/A Series MAI Block

193
B0700EC – Rev B 5. MAI – Foundation™ fieldbus Multiple Analog Input

194
6. MAO - FOUNDATION™ fieldbus
Multiple Analog Output
This chapter describes the Multiple Analog Output (MAO) block, which interfaces the control
system with a corresponding multiple analog output function block operating in a
FOUNDATION™ fieldbus H1 device.

6.1 Overview
Multiple Analog Output (MAO) is a Distributed Control Interface (DCI) block that provides
an interface between the control processor and a multiple analog output function block operat-
ing in a FOUNDATION fieldbus H1 device (the device function block). The MAO block is sup-
ported on the FCP270 and ZCP270 when the H1 device is connected to the control station by
an FBM228. The MAO block is configured using the Block Configurator in the InFusion
Engineering Environment (IEE) as described in InFusion Enterprise Control System: Implement-
ing FOUNDATION fieldbus in InFusion 2.0 (B0750DA).

NOTE
The MAO block functionality described in this chapter is applicable only for
FBM228s with the software type (SWTYPE) of “128”. For a description of the leg-
acy MAO block functionality (I/A Series systems v8.4.3 or earlier) where FBM228s
have the SWTYPE of “228”, refer to Appendix F “Legacy MAO – Foundation™
fieldbus Multiple Analog Output”.

6.2 Basic Operation


The MAO block integrates the corresponding device function block into the I/A Series system.
On initialization, user-configured parameters in the MAO block are written to key configurable
parameters in the corresponding device function block.
During normal operation, the MAO block’s IN_n (where n is 1 through 8) are written to the
IN_n1 parameters of the device function block. The outputs are then read back to MAO block
IN_n and INSTn parameters, which hold the value and status, respectively, of the device IN_n
parameters.
When the block is in simulation mode (SIMOPT = 1), the IN_n values are not written to the
device function block, but the value of each IN_n is updated as if it had been read back from the
device, and the status of each IN_n is set to Good, Non-Cascade.
In addition to providing outputs to the device function block, the MAO block provides access to
a variety of operational and diagnostic information via client/server connections with the parame-
ters that are included in the block view data of the device block. The values read from these

1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

195
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

parameters are displayed in the block detail displays and are available for connection to other I/A
Series blocks.

6.3 Features
The MAO block provides the following features:
♦ Provides up to eight analog outputs (IN_1 through IN_8) to the linked device func-
tion block
♦ Acquires the value and status of the device block outputs
♦ Time stamps changes to the value and status of the device block outputs
♦ Accesses the parameters in the device function block’s Views using change-driven and
periodic client/server connections
♦ Ensures that changes in a device’s process values and error conditions are continuously
available for display and connection to the control strategy
♦ Provides for the configuration of device block parameters from the I/A Series system
and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Auto or Out of Service
♦ Provides alarm detection and reporting for Bad I/O
♦ Supports simulation of device block outputs within the control station.

6.4 Block Parameters


Table 6-1 lists the block parameters. See Table 6-16 for mappings of MAO parameters and their
device function block equivalents.

Table 6-1. MAO Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 36 36 [MAO]
TAGDSC tag descriptor string no-con/no-set 2 blanks 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 13
PHASE block execution phase integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0 = no simulation
1 = simulation
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path name
<= 25 chars or ECB
block name <=12
chars
CHANNL channel integer no-con/no-set 1 0 to 32767
CHMASK channel mask packed bool- no-con/no-set blank 0x00 to 0xFF
ean
DDITEM DD item ID long no-con/no-set 0x800209D0
DDMBR DD member ID long no-con/no-set 0x00

196
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-1. MAO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


UPDPER view update period long no-con/no-set 10000 ms 0 to 2147483647ms
STRATG strategy integer no-con/no-set 999 0 to 65535
MOOPTS MO_OPTS block packed bool- no-con/no-set 0xFF00 0 to 0xFFFF
options ean
HSCO1 output display high real no-con/no-set 100.0 > LSCO1
scale
LSCO1 output display low real no-con/no-set 0 < HSCO1
scale
EO1 eng units display string no-con/no-set % 1 to 32 chars
DESCR1 IN_1 descriptor string no-con/no-set 2 blanks 1 to 32 chars
DESCR2 IN_2 descriptor
DESCR3 IN_3 descriptor
DESCR4 IN_4 descriptor
DESCR5 IN_5 descriptor
DESCR6 IN_6 descriptor
DESCR7 IN_7 descriptor
DESCR8 IN_8 descriptor
MODE_N normal mode short integer no-con/no-set 0x10 0 to 0xFF
MODE_P permitted mode short integer no-con/no-set 0x11 0 to 0xFF
MODE_T target mode short integer no-con/no-set 0x10 0 to 0xFF
IN_1 IN_1 real con/set 0.0
IN_2 IN_2
settable when
IN_3 IN_3
unlinked
IN_4 IN_4
IN_5 IN_5
IN_6 IN_6
IN_7 IN_7
IN_8 IN_8
FSOPTN faultstate option short integer no-con/no-set 0x00 0x00, 0x01, 0x04,
0x05
FSTIME faultstate time real no-con/no-set 20.0 sec
FSV_1 faultstate value 1 real no-con/no-set 100
FSV_2 faultstate value 2
FSV_3 faultstate value 3
FSV_4 faultstate value 4
FSV_5 faultstate value 5
FSV_6 faultstate value 6
FSV_7 faultstate value 7
FSV_8 faultstate value 8
INHOPT inhibit option short integer no-con/no-set 0 0 to 3
INHIB alarm inhibit switch boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short integer con/no-set 8 1 to 8
BADOPT bad alarm option boolean no-con/no-set 1 0 to 1

197
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

Table 6-1. MAO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


BADGRP bad alarm group integer no-con/no-set 0 1 to 8
BADPRI bad alarm priority integer con/set 5 1 to 5
BADTXT bad alarm text string con/no-set 2 blanks 0 to 32 chars
AMRTIN alarm regeneration integer no-con/set 0 0 to 32767
interval
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to 2147483647
DVC_ID device ID integer no-con/no-set 0 0 to 0xFFFF
DVCREV device revision long integer no-con/no-set 0 0 to 2147483647
BLKNDX block index long integer no-con/no-set 0 0 to 2147483647
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to 0xFFFFFFFF
AUT_SW auto switch boolean con/set 0 0 to 1
BLKERR block error packed bool- con/no-set blank 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0 to 0xFFFFFFFF
CRIT alarm criticality integer con/no-set 0 0 to 5
FSTATE faultstate status packed bool- con/no-set 0 0 to 0xFFFF
ean
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
INST_1 IN_1 status packed bool- con/no-set 0 0 to 0xFF
INST_2 IN_2 status ean
INST_3 IN_3 status
INST_4 IN_4status
INST_5 IN_5 status
INST_6 IN_6 status
INST_7 IN_7 status
INST_8 IN_8 status
MODE_A actual mode short integer con/no-set 0 to 0xFF
OOS_SW out of service switch boolean con/set 0 0 to 1
PRTYPE priority type integer con/no-set 0 0, 8
TSTMP1 IN_1 time stamp long integer con/no-set 0 ms since midnight
TSTMP2 IN_2 time stamp
TSTMP3 IN_3 time stamp
TSTMP4 IN_4 time stamp
TSTMP5 IN_5 time stamp
TSTMP6 IN_6 time stamp
TSTMP7 IN_7 time stamp
TSTMP8 IN_8 time stamp
UNACK unacknowledged boolean con/set 0 0, 1
BSTATE block state integer con/no-set 0 0 to 11
DEVACK device acknowledge boolean con/set 0 0, 1

198
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-1. MAO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
CFGERR configuration error short no-con/no-set 0
DEFINE no config errors boolean no-con/no-set 1 0, 1
DESCRP descriptor string no-con/no-set 2 blanks 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks (Table 6-8)
LOCKID lock identifier string no-con/no-set 2 blanks 1 to 32 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
RO1 output range string no-con/no-set 100.0, 0.0,
0.0
ST_REV status revision integer no-con/no-set 0 0 to65535
FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for each
(array 1x255) element
FDATA2 file data bytes 256 to short integer no-con/no-set all 0s 0 to 255 for each
510 (array 1x255) element

6.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT The Alarm Options parameter contains packed long values representing
the alarm types that have been configured as options in the block (based
on BADOPT which enables Bad Alarming and CHMASK which identi-
fies which channels are to be processed by the block), and the alarm
groups that are in use. Table 6-2 shows how the parameter is used by the
MAO block.

Table 6-2. ALMOPT Parameter Format

Bit Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
8 Channel 8 option
9 Channel 7 option

199
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

Table 6-2. ALMOPT Parameter Format (Continued)

Bit Number*
(0 to 31) Configured Alarm Option, When True
10 Channel 6 option
11 Channel 5 option
12 Channel 4 option
13 Channel 3 option
14 Channel 2 option
15 Channel 1 option
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table 6-3 shows the bits used by the function blocks.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
CH1 Bad B17
CH2 Bad B18
CH3 Bad B19
CH4 Bad B20
CH5 Bad B21
CH6 Bad B22
CH7 Bad B23
CH8 Bad B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

CRIT PRTYPE
UNAK

HMA
LMA
BAD
INH

Table 6-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter PRTYPE ---
for values used in the blocks
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
8 Channel 8 BAD alarm ALMSTA.B24
9 Channel 7 BAD alarm ALMSTA.B23
10 Channel 6 BAD alarm ALMSTA.B22
11 Channel 5 BAD alarm ALMSTA.B21
12 Channel 4 BAD alarm ALMSTA.B20
13 Channel 3 BAD alarm ALMSTA.B19
14 Channel 2 BAD alarm ALMSTA.B18
15 Channel 1 BAD alarm ALMSTA.B17

200
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
22 BAD Bad I/O Alarm. ALMSTA.B10
Set when any IN_n.Status.Bad=1
Cleared when all IN_n.Status.Bad = 0
29 INH Inhibit Alarm. This bit is set when any ALMSTA.B3
of the alarms for any channel is inhib-
ited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set MODE_T, and thus
MODE_BLK.Target in the associated device function block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the MAO block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the MAO
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block. Table 6-4
shows the parameter format.

Table 6-4. BLKERR Parameter Format

Bit* Error Code


0 Out of Service

201
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

Table 6-4. BLKERR Parameter Format (Continued)

Bit* Error Code


1 Power-up
2 Device Needs Maintenance Now
3 Readback Check Failed
4 Lost NV Data
5 Lost Static Data
6 Memory Failure
7 Output Failure
8 Input Failure
9 Device Needs Maintenance Soon
10 Device Fault State Set
11 Local Override
12 Simulate Active
13 Link Configuration Error
14 Block Configuration Error
15 Other (most significant bit)
*Bit 0 is the least significant, low order bit.

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device function block represented by the MAO block. It is set
by the configurator and the FBM uses it to identify the block in the
device.

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 6-5 shows how the bits are used by the
MAO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B24
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DEVACK B9

FDFAIL
FDACT
FDMM

HOLD
FDOK

UDEF

FBM

TRK
LCK

FFX

BIO
ON

MA

LO
LR
FS

Table 6-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local Override BLKSTA.B29
6 TRK The block is being tracked as the device function BLKSTA.B26
block is in Local Override or Initialization Manual
mode

202
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-5. BLKSTA Parameter Format (Continued)

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
8 FBM There is a communication failure between BLKSTA.B24
CP and FBM
11 MA The device block mode is Auto BLKSTA.B21
12 BIO Bad I/O: at least one channel is bad BLKSTA.B20
14 UDEF Block is undefined. See DEFINE, ERCODE, and BLKSTA.B18
CFGERR
15 ON The compound that contains the block is ON BLKSTA.B17
16 FFX Enhanced FF block connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FBM228 The H1 device is hosted and scheduled by an BLKSTA.B13
FBM228
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK FDATA installed BLKSTA.B11
22 FDMM FDATA mismatch BLKSTA.B10
23 DEVACK Unacknowledged device alarm BLKSTA.B9
24 FS Fault state BLKSTA.B8
* Bit 0 is the least significant, low order bit.

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the device block connection as determined by the
FBM228. The following values are used to indicate the current DCI block
state:
0 = Undefined state
1 = Unconnected
2 = Connecting
3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON-LINE
11 = Block ON-LINE with error - Processing has been completed, but
some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 231.

203
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the Function block becomes undefined
due to a W73 - FF FUNCTION BLOCK CONFIGURATION
ERROR. When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index
(Table 6-6).

Table 6-6. CFGERR Index

Value* Device Block Parameter with Error


2 TAG_DESC
3 STRATEGY
5 MODE_BLK
7 CHANNEL
16 MO_OPTS
17 FSTATE_TIME
18 FSTATE_VAL1
19 FSTATE_VAL2
20 FSTATE_VAL3
21 FSTATE_VAL4
22 FSTATE_VAL5
23 FSTATE_VAL6
24 FSTATE_VAL7
25 FSTATE_VAL8
*Bit 0 is the least significant, low order bit.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.
CHANNEL specifies the I/O subsystem by its the transducer block chan-
nel. Refer to the device documentation to identify the correct channel and
any special rules concerning mapping of IN_n parameters to device out-
puts.

CHMASK Channel Mask is a configurable, non-settable packed boolean parameter


that specifies which parameters are to be processed by the MAO block.
CHMASK does not affect any device function block settings. Table 6-7
shows the parameter format.

Table 6-7. Channel Mask Parameter Format

Bit Number* Output to be Processed


(0 to 15) When Bit Is Set
0 IN_1
1 IN_2

204
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-7. Channel Mask Parameter Format (Continued)

Bit Number* Output to be Processed


(0 to 15) When Bit Is Set
2 IN_3
3 IN_4
4 IN_5
5 IN_6
6 IN_7
7 IN_8
8-15 Reserved
*Bit 0 is the least significant, low order bit.

CHMASK has a higher priority than BLKOPT.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 206 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string data store of


up to 32 characters that describes the MAO block. DESCRP tracks
TAGDSC, and is updated when TAGDSC is configured.

DESCRn Descriptor n (where n is 1 to 8) is a configurable, non-settable string of up


(n = 1 to 8) to 32 characters that describes the IN_n input. If BAD Alarming is con-
figured (BADOPT = 1), this descriptor is included in the BAD Alarm
message for the respective point.

EO1 Engineering Units for Output 1 specifies the engineering units text for the
block’s eight outputs (IN_n) in detail displays and other I/A Series system

205
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

uses. The limit should be consistent with the display range parameters,
LSCO1 and HSCO1.
This parameter does not affect scaling in the device function block. Refer
to the device documentation for scaling information. EO1 should be con-
sistent with the engineering units used by the connected devices.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table 6-8 lists the possible values of ERCODE for the MAO block, and
the significance of each value in this block.

Table 6-8. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION
W44 - INVALID ENGINEERING RANGE
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages. The range is 1 to 8 (default).

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. Table 6-9 shows the parameter format.

206
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-9. ERROPT Parameter Format

Bit* Error Code


0 Out of Service
1 Power-up
2 Device Needs Maintenance Now
3 Readback Check Failed
4 Lost NV Data
5 Lost Static Data
6 Memory Failure
7 Output Failure
8 Input Failure
9 Device Needs Maintenance Soon
10 Device Fault State Set
11 Local Override
12 Simulate Active
13 Link Configuration Error
14 Block Configuration Error
15 Other
*Bit 0 is the least significant, low order bit.

FDATA1 File Data #1 and File Data #2 are settable multi-byte arrays that provide
FDATA2 configuration data for the device block represented by the MAO block.
This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 510 bytes.

FSOPTN Fault State Option is a configurable integer parameter that specifies under
what conditions the FBM228 will force the device to take the Fault State
action configured in the device function block (Table 6-10).

Table 6-10. Fault State Options

Bit Description, when True


0 Assert Fault State if IN_n is Bad.
2 Assert Fault State if control station-to-FBM communication
is lost (FBM option). This option is enabled only if Fault
State is enabled at the FBM level via the FSENAB parameter
in the ECB200 or ECB202.

FSOPTN is dependent upon how the Fault State parameters are config-
ured in the device with which the MAO block is being used (see

207
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

MOOPTS). The Fault State can also be turned off in the device, which
would render FSOPTN ineffective. See Section 6.6.14.

FSTATE Fault State is a non-settable packed boolean output that contains the
FSTATE_STATUS parameter of the device function block, which shows
the Fault State of each channel. Table 6-11 shows the parameter format
for MAO and the device function block parameters.

Table 6-11. Format of the Fault State Status Parameters

Bit* Description When True


0 Fault State asserted for channel 1
1 Fault State asserted for channel 2
2 Fault State asserted for channel 3
3 Fault State asserted for channel 4
4 Fault State asserted for channel 5
5 Fault State asserted for channel 6
6 Fault State asserted for channel 7
7 Fault State asserted for channel 8
*Bit 0 is the least significant, low order bit.

FSTIME Fault State Time is a configurable, downloadable, real value used to specify
the FSTATE_TIME parameter of a device function block, which is the
time in milliseconds a fault must persist before the Fault State is asserted
for the affected output. Refer to Section 6.6.14.

FSV_n Fault State Value n (where n is 1 through 8) is a configurable, download-


(n = 1 to 8) able, non-settable real value used to specify the FSTATE_VALn parameter
of a device function block. Refer to Section 6.6.14.

HSCO1 High Scale for Output Range 1 specifies the upper range value for the
block’s eight outputs (IN_n) in detail displays and other I/A Series system
uses. The limit should be consistent with the other display scaling param-
eters, LSCO1 and EO1.
This parameter does not affect scaling in the device function block or con-
nected devices, but should be consistent with the device block scaling.
Refer to the device documentation for information on scaling the outputs.

IN_n Input n (where n is 1 through 8) is a connectable real input that contains


(n = 1 to 8) the value to written to the IN_n parameter of the device function block.
In Control in the Field (CIF) mode, the IN_n parameters of the device
function block come from another device function block output (on the
same FF H1 segment).

INHALM Inhibit Alarm contains packed Boolean values that represent alarm
generation inhibit requests for each type of alarm configured in the block.
Table 6-12 shows how the bits are used by the MAO block.

208
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-12. INHALM Parameter Format

Boolean
Bit Description, Connection
Number* When True (B16 to B1)
8 Inhibit Channel 1 BAD Alarm INHALM.B8
9 Inhibit Channel 2 BAD Alarm INHALM.B7
10 Inhibit Channel 3 BAD Alarm INHALM.B6
11 Inhibit Channel 4 BAD Alarm INHALM.B5
12 Inhibit Channel 5 BAD Alarm INHALM.B4
13 Inhibit Channel 6 BAD Alarm INHALM.B3
14 Inhibit Channel 7 BAD Alarm INHALM.B2
15 Inhibit Channel 8 BAD Alarm INHALM.B1
*Bit 0 is the least significant, low order bit.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option is a configurable, non-settable, non-connectable short


integer parameter that specifies how the block responds when alarms from
the block are inhibited (Table 6-13).

Table 6-13. Alarm Inhibit Options

Value Action Taken When an Alarm is Inhibited


0 Disables alarm messages but does not disable alarm detection.
1 Disables both alarm messages and alarm detection. If an alarm
condition exists at the time the alarm transitions into the inhib-
ited state, the alarm indicator is cleared.
2 Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges return-to-normal messages.
“Into alarm” messages can be acknowledged by explicitly set-
ting UNACK False.
3 Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly set-
ting UNACK False.

209
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table 6-14
shows how parameter is used with the MAO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
CH8 B1
CH7 B2
CH6 B3
CH5 B4
CH4 B5
CH3 B6
CH2 B7
CH1 B8
B9 Table 6-14. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) When True (B32 to B1)
24 Channel 1 alarms inhibited INHSTA.B8
25 Channel 2 alarms inhibited INHSTA.B7
26 Channel 3 alarms inhibited INHSTA.B6
27 Channel 4 alarms inhibited INHSTA.B5
28 Channel 5 alarms inhibited INHSTA.B4
29 Channel 6 alarms inhibited INHSTA.B3
30 Channel 7 alarms inhibited INHSTA.B2
31 Channel 8 alarms inhibited INHSTA.B1
*Bit 0 is the least significant, low order bit.

INST_n IN_n Status (where n is 1 through 8) is a non-settable packed boolean


(n = 1 to 8) output that contains the IN_n.Status parameters of the device function
block. Refer to Section 6.6.7 for information on the device function
block .Status bits.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up

210
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

to 25 characters (12 for <local_compound_name>, 1 for the


colon, and 12 for the <ecb_name>).

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the display task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block, immediately
below the faceplate.

LSCO1 Low Scale for Output Range 1 is a real value that defines the lower range
value for the block’s eight outputs (IN_n) in detail displays and other
I/A Series system uses. The limit should be consistent with the display
scaling parameters, HSCO1 and EO1.
This parameter does not affect scaling in the device function block or con-
nected devices, but should be consistent with the device block scaling.
Refer to the device documentation for information on scaling the outputs.

MODE_A Actual Mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device func-
tion block.

MODE_N Normal Mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Normal parameter of the associated
device function block.

MODE_P Permitted Mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Target parameter of the associated
device function block.

211
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

The AUT_SW and OOS_SW can be used to change the MODE_T


parameter and thus the MODE_BLK.Target parameter in the device func-
tion block.

MOOPTS Multiple Output Options is a configurable, downloadable, non-settable,


packed boolean value that configures the device function block
MO_OPTS parameter to specify the Fault State actions and restart usage
for each output channel in the device. Table 6-15 shows the parameter
format for MAO and the device Function block.

Table 6-15. Format of the Multiple Output Options Parameters

Bit* Option Set When True


0 Fault State to value for channel 1
1 Fault State to value for channel 2
2 Fault State to value for channel 3
3 Fault State to value for channel 4
4 Fault State to value for channel 5
5 Fault State to value for channel 6
6 Fault State to value for channel 7
7 Fault State to value for channel 8
8 Use Fault State value on RESTART for channel 1
9 Use Fault State value on RESTART for channel 2
10 Use Fault State value on RESTART for channel 3
11 Use Fault State value on RESTART for channel 4
12 Use Fault State value on RESTART for channel 5
13 Use Fault State value on RESTART for channel 6
14 Use Fault State value on RESTART for channel 7
15 Use Fault State value on RESTART for channel 8
*Bit 0 is the least significant, low order bit.

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the MAO block is initial-
ized, the block updates the configurable parameters of the function block
matched to the MAO block by the configured index (BLKNDX). The
NAME parameter is used to set the Block Tag of the device function
block.

OOS_SW Out of Service Switch is a settable output used to set the parameter
MODE_T, and thus MODE_BLK.Target in the associated device function
block, to Out of Service.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value

212
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with
a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,
or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm:
0 = No alarm
8 = Bad I/O alarm.

RO1 Range Output 1 is a real array consisting of the two parameters HSCO1
and LSCO1. The array members are configured by their individual
names; however, RO1 and its members can be accessed on an array basis
by user tasks and displays.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


MAO block is to be simulated. When SIMOPT= 1 (True), there is no
output to the device function block, and the status and value of the IN_n
parameters are not recovered from the field. The simulated behavior of the
block reflects the operational mode of the block (MODE_A).

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

213
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


specifies the TAG_DESC parameter of the associated device function
block. Changes to TAGDSC are copied to DESCRP.

TSTMPn Time Stamp n (where n is 1 through 8) contains the time (in milliseconds
(n = 1 to 8) since midnight) of the latest change in the IN_n parameter in the device
function block.
The time is from the FBM228 when a new value is sent to device function
block. However, when the block is in simulation (SIMOPT = 1), the value
is computed by the CP.

TYPE Type is the block type. When an MAO block is added to the control data-
base, the configuration editor sets TYPE to 36, causing the block type to
be identified as MAO in operator and system management displays.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the Current Alarms display.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 for client/server connec-
tions for scanning scan the device function block view parameters. The
range is 0 to 2147483647 milliseconds; the default is 10000.

6.5 Device Function Block Description


This section describes the FOUNDATION fieldbus multiple analog output device function block,
and includes a block schematic, a brief description of the block’s standard parameter set, and a
table showing the mapping between the I/A Series system MAO block parameters and the device
function block parameters.

6.5.1 Device Block Operation


The FOUNDATION fieldbus multiple analog output function block processes up to eight inputs
from another block or an external source received at IN_n, and outputs the values to a field device
(Figure 6-1). The CHANNEL parameter specifies the transducer block channel of the equipment
to receive the output.

214
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

IN_1
IN_2
IN_3 Output Snap
IN_4 to CHANNEL
Block
Transducer
IN_5 Algorithm
Block
IN_6 Inputs
IN_7
IN_8

Figure 6-1. Device MAO Function Block Schematic

6.5.1.1 Mode
The device MAO block supports the following modes:
♦ Auto - In Auto, the block output reflects IN_n.
♦ OOS - When the mode is Out of Service, the block is not processed, the output
channel is maintained at the last value, and the status of IN_n is set to BAD.
♦ LO - Local Override is set when the resource block has been placed in LO or a Fault
State is active. In LO, the output of the block does not respond to IN_n.

6.5.1.2 Fault State


The MAO block has two faultstate options, which are set individually for each channel in the
MO_OPTS parameter:
♦ Fault State on Restart sets each IN_n parameter to a specified value when the device is
recycled because of a loss of power or for some other reason. The value is specified in
FSTATE_VALn.
♦ Fault State to Value sets each IN_n parameter to a specified value if the block has not
received a value for output from its configured source within the time specified in
FSTATE_TIME. As with the restart option, the value is specified in FSTATE_VALn.
In the case of both options, the device detects the condition and takes the fault state action.

6.5.2 Parameter Transforms


Table 6-16 illustrates the mapping of I/A Series MAO parameters to parameters in the related
device function block. Many of the parameters are straightforward 1:1 mappings that are either
unidirectional or bidirectional. Other mappings require that a data value be re-formatted (or
transformed) to be intelligible in the I/A Series system.

215
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

From the point of view of the MAO block, the relationship with the device function block can
also be described in terms of sink and source connections:
→ Source-sink The MAO block parameter is the source for the corresponding func-
tion block parameter. Thus, changes to the MAO block parameter are
made to the device function block parameter. For example, when the
MAO block is initialized, the TAGDSC value is copied to the device
function block TAG_DESC parameter.
← Sink-source The MAO block parameter value is updated by the corresponding
device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual function block mode visible to the control system.
↔ Bidirectional Changes to the MAO block parameter are made to the corresponding
device function block parameter and vice versa. For example, when
the MAO block is initialized, its MODE_T parameter value is writ-
ten to the device block parameter, MODE_BLK.Target, to configure
the block’s target mode. Subsequently, the MODE_BLK.Target value
is written back to the MAO block MODE_T parameter.

The arrow notation is used in the Table 6-16 descriptions of MAO parameter transforms. These
are presented in alphabetic order, arranged by the I/A Series MAO block parameter names.

Table 6-16. MAO Parameter Transforms

MAO Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SW → 1:
Set MODE_T (request) = AUTO
Set OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP-FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.MA=1 ← MODE_BLK.Actual.AUTO
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← any IN_n.Status.Bad (Bits 6-7=0)
CHANNL ↔ CHANNEL
FSTATE ↔ FSTATE_STATUS
FSTIME ↔ FSTATE_TIME
FSVn (n = 1 to 8) ↔ FSTATE_VALn (n = 1 to 8)

216
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-16. MAO Parameter Transforms (Continued)

MAO Parameter Device Function Block Parameter


IN_n (n = 1 to 8) IN_n (n = 1 to 8) in Auto mode is not simulating)
IN_n.value (request) → IN_n.Value (request)
IN_n.value (actual) ← IN_n.Value (actual)

IN_n.status.LHI ← IN_n.Status.Limited Hi (Bit 0)


IN_n.status.LLO ← IN_n.Status.Limited Lo (Bit 1)
IN_n.status.ERR ← IN_n.Status.Uncertain (Bits 6-7 = 1)
IN_n.status.BAD ← IN_n.Status.Bad (Bits 6-7 = 0)
or there is an CP-FBM communications failure
or the H1 device is failed or disabled

IN_n.status.OOS ← IN_n.Status.Bad (Bits 6-7 = 0) and Susbtatus.OOS (bits 2-7 = 7)


or the compound is Off
or the FBM228 is Off-line or DCI is Not Ready
or the H1 device is failed or disabled
or there is an CP-FBM communications failure
or the DCI_COMM_DATA.connect_status <= 0
INST_n (n = 1 to 8) IN_n (n = 1 to 8)
INST_n.value ← IN_n.Staus
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permitted
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
MOOPTS ↔ MOOPTS
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW is set =1:
Set MODE_T (request) = OOS
Set AUT_SW=0
Write MODE_T (request) to FBM
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC ↔ TAG_DESC
Note: Changes to TAGDSC are copied to DESCRP.

6.6 MAO Block Functions


With each execution, the MAO block receives up to eight setpoint values from I/A Series system
control blocks, such as an MAI block, and writes a value and status to each device function block

217
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

IN_n parameter selected in the CHMASK parameter. The MAO block then reads back the value
and status of the IN_n parameters.
The MAO block does not scale or condition the output to the device. However, the MAO range
and units parameters (HSCO1, LSCO1 and EIO) scale the IN_n parameters for details displays
and other I/A Series system uses.
The MAO block supports the device block Fault State functions and Mode Machine.

6.6.1 Device Function Block Connection


The MAO block interfaces with a multiple analog output block operating in an I/O subsystem,
remote indicator, or similar device on an H1 segment hosted by an FBM228. The configured
parameter IOM_ID of the MAO block specifies the ECB201 (the device ECB) that represents
the target device. The ECB201 PARENT parameter identifies the FBM228’s equipment control
block (ECB200 or ECB202).
The path to the device block is completed as follows. When the MAO block is configured using
IEE, the device function block is selected in a browser which displays the device function blocks
based on the device description in the device ECB. If the connection is not made via the browser,
the connection is made based on the MAO block BLKNDX parameter.
The MAO block CHANNL parameter is used to configure the device block CHANNEL parame-
ter and thus identify the I/O subsystem to receive the outputs. Refer to the device documentation
for the appropriate channel assignment.
CHMASK parameter is used to specify which of the eight device block inputs are to be processed
by the MAO block. CHMASK does not affect any settings in the device function block.
To assign function blocks to their device, refer to “Assign the Function Blocks to a Device” in
InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA).

6.6.2 Device Configuration Parameters


The MAO block enables you to configure selected parameters in the corresponding device
function block and manage the configuration from the I/A Series system. When you deploy the
MAO block to the control station, and then download the FBM228, parameter values in the
MAO block update parameters in the linked device function block.
Table 6-17 lists the device function block parameters and the MAO block parameters used to
configure them. For the I/A Series block, the table includes both the six-character parameter name
that is used in block detail displays and the parameter labels which more closely resemble the
FOUNDATION fieldbus parameter names. Use the six-character parameter name when connecting
parameters to a process display.

Table 6-17. MAO Block Configuration Parameters

Configured with I/A Series MAO Block Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
CHANNEL CHANNL Channel
FF_BLOCK.BLOCK_TAG NAME Name

218
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-17. MAO Block Configuration Parameters (Continued)

Configured with I/A Series MAO Block Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
FSTATE_TIME FSTIME Fstate_Time
FSTATE_VALn FSVn Fstate _Val
MO_OPTS MOOPTS Multiple_options
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc

The following are suggested and required MAO parameter settings:


♦ Configure MODE_P to include at least Auto and Out of Service. Other modes are
optional.
♦ Set MODE_T to Auto.
♦ Configure MO OPTS to include FS to Value and Use FS on Restart for each channel
(recommended).
♦ Set the Fault State option in the resource block’s FEATURE_SEL parameter.

6.6.3 Block Validation


The MAO block initializes when any of these events occur:
♦ The block is installed or reconfigured via the IEE control configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.
When the I/A Series MAO block initializes, the following block validation tests are performed:
♦ If the high range value (HSCO1) is not less than the low range value (LSCO1), the
block is marked undefined (BLKSTA.UDEF=1) with the error code parameter
(ERCODE) set to “W44 - INVALID ENGINEERING RANGE”.
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Auto,
Manual or Out-of-Service, the block is marked undefined (BLKSTA.UDEF=1) with
the error code parameter (ERCODE) set to “W76 - INVALID FF MODE
CONFIGURATION”.
If the FBM simulation is not used (SIMOPT=0), the following validation tests are performed:
♦ If the MAO block is installed prior to the installation of the ECB201 block, it is
marked undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE)
set to “W54 - ECB DOES NOT EXIST”. In this case, the MAO block configuration
is restarted and re-validated automatically when the ECB201 is installed.
♦ An attempt is made to connect the MAO block to the ECB201 specified in the
IOM_ID parameter. The DCI connection address (i.e., the NAME parameter in the
MAO block) is used in a connect message to establish a block connection in the

219
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

FBM228. The CHMASK parameter is embedded in the connect message to indicate


which of the 1-8 input channels are to be enabled.
♦ If the data connection cannot be resolved due to a lack of configuration information,
a block connection is made in the FBM, the connection status is marked Unresolved,
and one of the following error strings is stored in the block ERCODE parameter:
♦ “W62 - UNRESOLVED CONNECTION”
♦ “W77 - FIELDBUS COMMUNICATIONS FAULT”
♦ “W78 - INVALID FUNCTION BLOCK”
♦ “W80 - FIELDBUS DEVICE NOT FOUND”
♦ “W82 - FF CONFIGURATION IN PROGRESS”
(In these cases, the MAO block is defined, but the output values are marked OOS.)
♦ “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the MAO block is defined, and the index of the invalid function block
parameter is stored in the CFGERR parameter.)
♦ If the MAO data connection cannot be made for any other reason, the FBM rejects
the connection request and one of the following error strings is stored in the
ERCODE parameter to indicate the reason for the connection error:
♦ “W65 - INVALID POINT ADDRESS”
♦ “W66 - DUPLICATE CONNECTION”
♦ “W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS”
♦ “W68 - INVALID DEVICE CONNECTION”
♦ “W69 - INVALID POINT CONNECTION”
♦ “W74 - FF FUNCTION BLOCK DDITEM MISMATCH”
♦ “W75 - FF FUNCTION BLOCK DDMBR MISMATCH”
♦ “W76 - INVALID FF MODE CONFIGURATION”
♦ “W79 - INVALID PARAMETER INDEX”
(In these cases, the I/A Series MAO block is undefined.)
♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the
I/A Series MAO block is undefined with ERCODE set to “W43 - INVALID
PERIOD/PHASE COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the
I/A Series MAO block is undefined with ERCODE set to “W81 - INVALID PAR-
ENT DCI ECB PERIOD/PHASE”.
If there are no configuration errors when the I/A Series MAO block is installed, the block is
marked defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the compound con-
taining the block is turned on, the block also initializes and starts running automatically.

220
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

6.6.4 Block Initialization


When the I/A Series MAO block initializes, the following are performed:
♦ All alarm status parameters (ALMSTA, INHSTA, CRIT, PRTYPE, UNACK) are
cleared.
♦ The Actual mode parameter (MODE_A) is set to Initialization Manual (IMAN) in
the I/A Series MAO block.
♦ The Target mode parameter (MODE_T) is set to only one of the following states, in
order, if multiple bits are set: Auto, Manual, OOS.
♦ The status of all IN_1-IN_8 parameters not specified in CHMASK are set to BAD
and OOS.
♦ The timestamps for each of the 1-8 outputs are updated.
If not simulating (SIMOPT=0), the following are performed:
♦ The Target mode is sent to the device MAO function block.
♦ If installing the block, or if rebooting and not a Warm Restart, the configuration
parameters are downloaded to the device MAO function block.

6.6.5 Block Modes


The MAO block provides interactive support of the MODE_BLK function block parameter. The
Target, Permitted, Normal, and Actual modes are provided as separate block parameters.
The configuration of the Target, Permitted, and Normal modes are supported. These parameters
are downloaded to the device MAO function block when the I/A Series MAO block initializes.
The Target mode can be changed through a group of settable Boolean mode switches provided in
the I/A Series MAO block. These mode switches, AUT_SW and OOS_SW, allow the block
mode to be changed to Auto, or Out-of-Service respectively.
♦ Logic in the CP270 prevents more than one switch to be set at a given time. If more
than one switch is set during the same block cycle, only the last switch setting is
honored.
♦ Once set, a mode switch remains set only until the Target mode change is sent to the
FBM228 or until another mode switch is set. At that time, the mode switch is cleared.
♦ The mode switch setting is mapped onto an equivalent Target mode setting sent to
the FBM228.
The Target mode is a shadow parameter updated from the MODE_BLK function block parame-
ter read back during input scanning of the FBM228.
When the Actual, Permitted, Target, or Normal modes change in the MAO device function
block, the corresponding I/A Series mode parameters are updated automatically from the
MODE_BLK function block parameter. In addition, the Actual mode is mapped onto equivalent
BLKSTA parameter bits.
The INITMA parameter and the Auto override parameter, AUTSW, are not supported in the
I/A Series MAO block, since these functions do not exist in the device MAO function block.
When the Actual block mode is Auto, the following are performed:

221
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

♦ Requested changes to the IN_1-IN_8 parameters by the I/A Series user or by a source
connection are saved in the I/A Series MAO block and written to the device MAO
function block via the FBM228.
♦ The actual IN_1-IN_8 input parameter values and status are updated from readback
data received in the reply to a read message. The CHMASK parameter is used to
determine which values to process.
♦ Downloading of configuration parameters that have changed since the previous block
cycle.
♦ Updating of the Fault State (FSTATE) parameter from the View data.
♦ Other View data parameters are updated, if any changes in these parameters have
occurred since the previous block cycle.
♦ Block Error (BLKERR) processing begins.
♦ External configuration changes to function block parameters are propagated.
♦ Configuration Error (CFGERR) processing begins.
♦ If BADOPT=1, Bad Alarming of the inputs is performed.
The Actual block mode (MODE_BLK.Actual) is provided in the I/A Series MAO block in the fol-
lowing two forms, and then the following occurs:
♦ The Actual mode is stored in the MODE_A output parameter.
♦ The Actual mode also is mapped onto equivalent bits in the BLKSTA block status
parameter,.
♦ The OOS state is mapped onto the OOS value status bit of the BLKSTA parameter.
♦ The IMAN state is mapped onto the BLKSTA.TRK status bit.
♦ The LO state is mapped onto both the BLKSTA.TRK and BLKSTA.LO status bits.
♦ The AUTO state sets BLKSTA.MA=1.

6.6.6 I/A Series Parameter Status


The status of the device MAO function block parameters is provided in the I/A Series MAO
block in two forms:
♦ The status of each device function block parameter is available as a separate I/A Series
MAO block parameter.
♦ The status of each device function block parameter also is mapped onto equivalent
fields in the value record status of the corresponding I/A Series MAO block
parameter.
For each device function block parameter containing status information, the following fields are
mapped:
♦ The Quality field (Bits 6-7) is mapped onto the BAD and ERR status bits.
♦ The Sub-status field (Bits 2-5) is ignored, except for the case when the Quality is Bad
and the Sub-status is OOS. In this case, the OOS status bit is set in the I/A Series
MAO block parameter.
♦ The Limited High (Bit 0) and Limited Low (Bit 1) fields are mapped onto the LHI,
LLO status bits, respectively.

222
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

6.6.7 Device Parameter Status


The device function block IN_n parameters have both a value and a status, which are sourced
from another device. Typically, the input is from an MAO block, in which case the status of IN_n
is the status of the of MAO block IN_n parameter.
The status is contained in an 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits.
The status is read into the MAO block parameter, bit for bit. The default displays for the MAO
block shows the converted status parameter so that the value need not be decoded. Table 6-18
shows how the status byte is formatted.

NOTE
The .SubStatus bits in multiple analog output blocks vary with the specific I/O sub-
system or multi-output device, and may not be the same as the standard
FOUNDATION fieldbus bit assignment usage in other device function blocks. Refer
to the device documentation for information about how the .SubStatus bits are
used.

The Status bit format is shown in Table 6-18.

Table 6-18. Device Parameter Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 Refer to the device documentation
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table 6-19 shows the usage of the Substatus bits, which varies depending on which .Quality bits
are set.
Table 6-19. Device Parameter Substatus

Bits 2-5 = SubStatus Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced by a link object within the
resource.

223
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

Table 6-19. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus Description


3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.
4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).

224
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table 6-19. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus Description


2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

6.6.8 Time Stamping


The I/A Series MAO block provides timestamps for each of its IN_1-IN_8 input parameters.
These timestamps are stored in the parameters TSTMP1-TSTMP8.
The FBM228 does not provide timestamps for the MAO block connection.
Each block cycle, the CP270 updates the timestamp for any of the IN_1-IN_8 parameters when
the block initializes and when the parameter value or status changes, i.e. the new value or status
differs from the previous value stored in the block.
The CHMASK parameter is used to determine which parameters to process.
The current eight (8) byte UTC timestamp maintained by the CP270 are stored in the block for
each of the IN_1-IN_8 parameters. The CP270 also calculates this timestamp in four byte milli-
seconds since midnight and stores this value in the respective TSTMPn parameter.
When simulation mode is used, all timestamps continue to be provided by the CP270.

6.6.9 Input Connections


The CP270 supports connections to the inputs in the I/A Series MAO block from connectable
input or output parameters of any I/A Series control or I/O block. These inputs are updated each
block cycle from data in the I/A Series source block parameter.
The CP270 propagates the BAD, OOS, and ERR status of these input parameters to their corre-
sponding device function block parameters by writing the status to the FBM228 when a change
occurs. The FBM228 maps the BAD or OOS status into the Bad status of the function block
input parameter (IN_n.Status Bits 6-7=0) and it will map the ERR status into the Uncertain sta-
tus of the function block parameter (IN_n.Status Bits 6-7=1).
When the Update Source of an input connection is not a device function block parameter, the
BlockName specified in the connection is the name of the I/A Series block; the ParameterName
is the 1-6 character name of the parameter in the I/A Series block.

225
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

The CP270 also supports connections to specific inputs in the MAO blocks from parameters con-
tained in device function blocks mapped to any standard I/A Series control or I/O block. These
inputs are updated each block cycle from data in the function block parameter; the data contained
in the specified I/A Series source parameter will not be used. The inputs of this type are listed in
Table 6-20 below.
When the source of an input connection is a device function block parameter, the I/A Series block
connection is made by the CP270, and the source BlockName and ParameterName are extracted
from the connection and appended to a connect message. This message is sent to the FBM228 to
establish a fieldbus connection to the function block source parameter.
When the source of an input connection is a device function block parameter, the BlockName is
the TagName of the device function block, which is the same as the name of the source I/A Series
block. The ParameterName is the 1-6 character name of the parameter in the source I/A Series
block for those connections listed in Table 6-21 below. In these cases, the name of the I/A Series
block parameter is converted to the equivalent function block parameter index by the CP270
prior to appending it to the connect message. In all other cases, the ParameterName must be con-
figured to be the parameter index of the function block parameter.
If the fieldbus connection cannot be made due to an invalid BlockName or ParameterName, the
ERCODE parameter in the block is set to the following text and the block is undefined:
“W83 - INVALID FF PARAMETER CONNECTION”

Table 6-20. MAO Input Connections

MAO Input Parameter(s) Connection Source Update Source


IN_1 - IN_8 I/A Series control block, I/O I/A Series source block parameter
block, or DCI block
FF parameter in DCI block FF function block parameter
Any other input I/A Series control block, I/O I/A Series source block parameter
block, or DCI block

Table 6-21. Standard FF Block Parameter Connections

Input Parameter Source Parameter


Block Type Parameter Block Type Parameter Name Parameter Index
MAO IN_1 - IN_8 AI OUT 8
MAI OUT_1 - 8-15
OUT_8

6.6.10 Block Alarming


The MAO block performs alarm functions consistent with standard CP270 alarming. This
includes the following types of process alarms:
♦ Bad Alarming of each of the IN_1-IN_8 outputs. The CHMASK parameter provides
a bitmap that used to determine which outputs to process.
♦ Informational messages of block errors (BLKERR) reported by the device MAO func-
tion block BLOCK_ERR parameter.

226
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

♦ Informational messages of function block configuration errors (CFGERR).


The device MAO function block alarm detection, alarm events, alarm messaging, and associated
parameters provided by the field device are not supported in the I/A Series MAO block.

6.6.11 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter is performed as
follows:
♦ For every condition specified in ERROPT, a corresponding Informational message is
sent to the ERRGRP alarm group when the condition occurs. The UNACK parame-
ter and the corresponding ALMSTA.UNACK bit also are set.
♦ One of the messages listed in Table 6-22 is generated.

Table 6-22. Block Error Messages

ERROPT Bit Message Text


Bit 0 FF Block Error: Out-of-Service
Bit 1 FF Block Error: Power Up
Bit 2 FF Block Error: Maintenance Needed Now
Bit 3 FF Block Error: Readback Check
Bit 4 FF Block Error: Lost NV Data
Bit 5 FF Block Error: Lost Static Data
Bit 6 FF Block Error: Memory Fail
Bit 7 FF Block Error: Output Fail
Bit 8 FF Block Error: Input Fail
Bit 9 FF Block Error: Maintenance Due Soon
Bit 10 FF Block Error: Fault State Active
Bit 11 FF Block Error: Local Override
Bit 12 FF Block Error: Simulation Active
Bit 13 FF Block Error: Link Configuration Error
Bit 14 FF Block Error: Block Configuration Error
Bit 15 FF Block Error: Other (Undefined) Error

6.6.12 Configuration Error Processing


When a device MAO function block configuration parameter cannot be downloaded into the
field device, the parameter index is stored in the CFGERR parameter and the following informa-
tional message is generated:
“FF CFGERR in Parameter nnnnnnnn”
where: nnnnnnnn = ASCII name of the parameter indicated by the index in CFGERR

6.6.13 Bad Alarm Detection


Bad alarm detection is supported when the Bad alarm configuration option (BADOPT) is set.
Bad alarm status information is generated when any point is bad. This philosophy is consistent
with the handling of state alarms in the BLNALM block.
Bad alarm messages are generated for each point independently when its status is bad (i.e.,
IN_n.BAD, where n=1-8).

227
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

When the point value becomes bad, a bad alarm message is created and sent to all devices in the
bad alarm group specified by the BADGRP parameter. This message contains a “BAD_n” (if
IN_n) text string to identify the appropriate point. This message also contains the respective
DESCRn point descriptor, the descriptive text in the BADTXT parameter, and the loop identifier
in the LOOPID parameter.
When the point value becomes good, a return-to-normal message is generated and sent to all
devices in the bad alarm group.
When any point value is bad, the BAD bit is set in the alarm status parameter (ALMSTA.BAD).
The UNACK parameter and the ALMSTA.UNACK bit are set. The CRIT parameter and ALM-
STA.CRIT field are set to the BADPRI parameter value, and the PRTYPE parameter and ALM-
STA.PRTYPE field are set to the Bad alarm type.
When all point values have returned to good status, BAD, CRIT, PRTYPE and their correspond-
ing fields in ALMSTA are cleared.
The UNACK parameter and the ALMSTA.UNACK bit are cleared in these cases:
♦ When the alarm is acknowledged at the compound level, by setting the compound
UNACK=0, or at the block level, by setting the block UNACK=0.
♦ When all point values return to normal, if INHOPT is set appropriately.
♦ When the block is shut down.
When UNACK is cleared, an Alarm Acknowledge message is generated and sent to all devices in
the bad alarm group.
Alarm Inhibiting/Disabling is supported using a combination of the compound CINHIB param-
eter and the INHOPT, INHIB, and INHALM parameters in the MAO block, to allow the bad
alarm messages to be inhibited and/or the alarm detection to disabled dynamically.
The INHALM parameter can be used to inhibit or disable bad alarming selectively for any group
of the 1-8 points.
When Bad alarming is inhibited or disabled, an Alarm Disable message is generated and sent to all
devices in the alarm group. If the Alarm is unacknowledged, an Alarm Acknowledge message also
is sent to these devices. The ALMSTA.INHIB bit is set, and the appropriate INHSTA.BAD bits
are set.
When Bad alarming is uninhibited or enabled, an Alarm Enable message is generated and sent to
all devices in the alarm group. The appropriate BAD bits in the INHSTA parameter are cleared,
and the ALMSTA.INHIB bit is cleared if all channels are uninhibited or enabled.
The Alarm Reprioritization and Alarm Message Regeneration (using AMRTIN) enhancements
also are supported in this MAI block. Refer to the Control Processor 270 (CP270) Integrated Con-
trol Software Concepts (B0700AG) for details.

6.6.14 Fault State Handling


A Fault State Enable (FSENAB) option may be configured in an ECB200 or ECB202. This
option is downloaded in a message sent from the FCP270/ZCP270 when the FBM228 is reboo-
ted and when the configuration of the ECB200/202 is changed. It is used by the FBM to enable
or disable the logic to assert a fault state action to field device outputs automatically when a CP-
to-FBM communications loss is detected by the FBM.
A Fault State Delay (FSDLAY) value also must be configured in the ECB200/202. This value is
downloaded when the FBM is rebooted and when the configuration of the ECB200/202 is

228
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

changed. The fault state timer counts down and is reset to the FSDLAY value when the read or
write message is received.
Two distinct fault state options may be configured in the FSOPTN parameter in the MAO block.
These fault state options are downloaded into the FBM228 when the MAO block connection is
established. The options are:
♦ FSOPTN Bit 2: 1= Assert Fault State upon loss of CP communication
♦ FSOPTN Bit 0: 1= Assert Fault State if Bad Output (i.e. IN_1-IN_8)
The Fault State Timer (FSTIME) and Fault State Values (FSVAL_1-FSVAL_8) are downloaded
into the device function block when the MAO block initializes and any of these values is re-con-
figured.
If the FSENAB option is set and the Assert Fault State upon loss of CP communications option is
configured, FBM228 performs the following actions:
♦ The fault state timer counts down periodically between receipt of read and write mes-
sages. When either message is received for an MAO function block, its failsafe timer is
reset to the FSDLAY value.
♦ If the fault state timer expires, the FBM sets the status of each of the IN_1-IN_8 func-
tion block parameters to BAD in the field device (IN_n.Status Bits 6-7=0).
♦ When the CP communications is restored, the failsafe timers are reset to full value
automatically by the first read or write message to each connection.
♦ If the fault state had been previously asserted by a request from the CP and the failsafe
condition still exists in the CP, the write message requests the BAD status to remain
set in the IN_1-IN_8 function block parameters. Otherwise, the write message
requests the status of these parameters to be set to Good Non-Cascade in the field
device (IN_n.Status Bits 6-7=2).
These actions are taken independent of the FSENAB option.
The FBM configuration does not establish the device Fault State behavior as that is determined by
options in the device function blocks. Different behaviors can be set for each device connected to
the FBM, and in the case of the multiple analog output devices, for each channel.
The device Fault State options are designed primarily to deal with communication failures above
the device, while working in concert with ECB options. Enabling Fault State is effective under
two external conditions:
♦ When Fault State is asserted by the connected FBM
♦ When communications to the device are lost and the device MAO block mode is
Auto.
The actual Fault State behavior taken by the device function block is specified in the following
I/A Series system MAO block parameters (Table 6-23).

229
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

Table 6-23. Fault State Parameters in the Device MAO Function Block

Parameter Description
MOOPTS Configures the device function block MO_OPTS parameter to enable/dis-
able two Fault State options for each output (IN_n).
♦ Use Fault State on Restart n: Selecting this option causes the IN_n
output to go to the value specified in FSTATE_VALn on a device
RESTART. If this option is not selected and the device can go to its tar-
get mode upon RESTART, the last saved setpoint is used for generating
the Fault State position.
♦ Fault State to Value n: When this option is selected, the block uses the
value specified for output n in FSTATE_VALn. When the option is not
selected, the last saved setpoint is used.
FSVn Configures FSTATE_VALn in the device function block to specify the value
that is asserted when one of the faultstate options is invoked for the channel.
FSTIME Configures FSTATE_TIME in the device function block to set the period
that the fault condition must last before the block asserts the specified value.
A Fault State action does not occur until the FSTATE_TIME interval has
expired.

6.6.15 Block Shutdown


The MAO block shuts down when any of these events occur:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ The ECB201 connected to the block is deleted.
♦ The MAO block is deleted.
When block shutdown occurs, the following actions are taken:
♦ If any Bad alarms are active, an Alarm Disable message is issued to all devices in the
bad alarm group. If the Bad alarms are unacknowledged, an Alarm Acknowledge mes-
sage also is sent to these devices.
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, UNACK) are cleared.
If not simulating (SIMOPT=0) and the compound is off, one of the following actions is taken:
1. If the compound is off, one of the following actions is taken:
a. If the FF_OOS_OPT bit (Bit 4: 0x0010) is set in the Station block CFGOPT
parameter, the following additional actions are taken:
♦ The actual mode parameter (MODE_A) is set to OOS.
♦ A write message is sent to the FBM228 with both the OOS and IMAN bits
set in the Target mode. The IMAN bit is set to indicate to the FBM228 that
the compound is off.
♦ Otherwise, a write message is sent to the FBM228 with only the OOS bit set
in the Target mode.
b. Otherwise, one of the following actions is taken:

230
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

♦A write message is sent to the FBM228 with both the current state and the
IMAN bits set in the Target mode. The IMAN bit is set to indicate to the
FBM228 that the compound is off.
♦ Otherwise, if the FSOPTN is set, a write message will be sent to the FBM228
to drive the IN_1-IN_8 parameters to their fault state values. The FBM sets
the status of the IN_1-IN_8 parameters to BAD (IN_n.Status Bits 6-7=0) in
the field device.
2. Otherwise, if the FSOPTN is set, a write message is sent to the FBM228 to drive the
IN_1-IN_8 parameters to their fault state values. The FBM sets the status of the
IN_1-IN_8 parameters to BAD (IN_n.Status Bits 6-7=0) in the field device.

6.6.16 Simulation
The I/A Series MAO block SIMOPT parameter enables simulation of output to and readback
from the corresponding multiple analog output device function block. This feature can be used to
test control schemes requiring analog outputs without the actual FBM228 hardware connections.
When SIMOPT= 1 (True), the value contained in IN_n is not written to the H1 device and the
value and status of IN_n are not recovered from the device function block. However, the IN_n
and INST_n parameters are updated as if the value and status had been read back from the device.
When SIMOPT= 1, the following functions are performed:
♦ The actual values and status of the IN_n inputs are updated from the requested values
and status each block cycle when the Actual block mode is Auto. The CHMASK
parameter determines which values to process.
♦ The INST_n input status parameters is set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (AUT_SW or OOS_SW) immedi-
ately update target mode parameter (MODE_T), and the actual block mode
(MODE_A) tracks MODE_T each block cycle.
♦ If BADOPT=1, Bad Alarming of the inputs is performed.
When SIMOPT = 1, the following functions are not performed:
♦ Downloading of configuration parameters
♦ Updating of View data parameters
♦ Block Error (BLKERR) processing
♦ External configuration changes to function block parameters
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA) or Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for
instructions on conducting control simulations from control station.

6.6.17 Block States


The DCI blocks transition through the states detailed in Table 6-24 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 203).

231
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

Table 6-24. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

232
6. MAO - Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

6.7 MAO Block Application Example


The MAO block can be used in any control block configuration, in any compound except the
Station compound and the Primary ECB compound, in any CP270. It only can be connected to
any device MAO function block in a field device hosted by an FBM228, but not to any other
device function block type or to any function block parameter.
Each field device connection must be specified by configuring the name of the ECB201 in the
IOM_ID parameter. The device MAO function block connection must be specified by configur-
ing the MAO function block index in the BLKNDX parameter.

NOTE
Since the MAO function block does not support cascade initialization, it is strongly
recommended that the I/A Series MAO block be used in non-control configura-
tions only. It should not be used to drive actuators in the field device.

Figure 6-2 illustrates an example of the MAO block’s use in applications.

Parent ECB200/202

Child ECB201 Child ECB201

PARENT PARENT

IOM_ID IOM_ID
NAME NAME

MAI Block CALCA Block MAO Block

PV1 OUT1 RI01 RO01 IN_1


RO02 IN_2
RO03 IN_3
PV8 OUT8 RI08 RO04 IN_4

IOM_ID
NAME

MAI Block CALCA Block

PV1 OUT1 RI01 RO01 IN_5


RO02 IN_6
RO03 IN_7
PV8 OUT8 RI08 RO04 IN_8

Figure 6-2. Application Example with I/A Series MAO Block

233
B0700EC – Rev B 6. MAO - Foundation™ fieldbus Multiple Analog Output

234
7. MDI – FOUNDATION™ fieldbus
Multiple Discrete Input
This chapter describes the Multiple Discrete Input (MDI) block, which interfaces the control
system with a corresponding multiple discrete input function block operating in a
FOUNDATION™ fieldbus H1 device.

7.1 Overview
Multiple Discrete Input (MDI) is a Distributed Control Interface (DCI) block that provides
an interface between the control processor and a multiple discrete input function block operat-
ing in a FOUNDATION fieldbus H1 device (the device function block). The MDI block is sup-
ported on the FCP270 and ZCP270 when the H1 device is connected to the control station by
an FBM228. The MDI block is configured using the Block Configurator in the InFusion Engi-
neering Environment (IEE) as described in InFusion Enterprise Control System: Implementing
FOUNDATION fieldbus in InFusion 2.0 (B0750DA).

NOTE
The MDI block functionality described in this chapter is applicable only for
FBM228s with the software type (SWTYPE) of “128”.

7.2 Basic Operation


The MDI block integrates the corresponding device function block into the I/A Series system. On
initialization, user-configured parameters in the MDI block are written to key configurable
parameters in the corresponding device function block. During normal operation, the MDI
block’s OUT_Dn (where n is 1 through 8) and OUTSTn parameters hold the value and status of
the device OUT_Dn parameters. When the block is not in simulation mode, the PV_Dn param-
eters reflect the value and status of the device OUT_Dn1 parameters. When the block is in simu-
lation mode (SIMOPT = 1), PV_Dn is settable and is used to change the OUT_Dn value.
In addition, the MDI block provides access to a variety of operational and diagnostic information
via client/server connections with the parameters that are included in the block view data of the
device block. The values read from these parameters are displayed in the block detail displays and
are available for connection to other I/A Series blocks.

7.3 Features
The MDI block provides the following features:

1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

235
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

♦ Acquires the status and value of up to eight published outputs (OUT_D1 through
OUT_D8) from a multiple discrete input device function block
♦ Time stamps value and status changes to the eight outputs
♦ Accesses the parameters in the device function block’s views using change-driven and
periodic client/server connections
♦ Ensures that changes in the device function block’s process values and error conditions
are continuously available for display and connection to the control strategy
♦ Provides for the configuration of selected device block parameters from the I/A Series
system and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Auto, Manual or Out of
Service
♦ Provides alarm reporting for Bad I/O for each device block output
♦ Supports simulation of the device block output values within the control station

7.4 Block Parameters


Table 7-1 lists the block parameters. See Table 7-11 for mappings between MDI parameters and
their device function block equivalents.

Table 7-1. MDI Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 37 37 (MDI)
TAGDSC tag descriptor string no-con/no-set 2 blanks 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 9
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0, 1
IOM_ID ECB identifier string no-con/no-set null any valid path
name <= 25 chars
or ECB block name
<=12 chars
CHANNL channel integer no-con/no-set 1 0 to 32767
CHMASK channel mask packed bool- no-con/no-set 0xFF 0x00 to 0xFF
ean
DDITEM DD item long no-con/no-set 0x80020970
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000 0 to 2147483647
STRATG strategy integer no-con/no-set 999 0 to 65535
MODE_N normal mode short integer no-con/no-set 0x10 0 to 0xFF
MODE_P permitted mode short integer no-con/no-set 0x19 0 to 0xFF
MODE_T target mode short integer con/no-set 0x10 0 to 0xFF

236
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

Table 7-1. MDI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DESCR1 OUT_D1 descriptor string no-con/no-set 2 blanks 1 to 32 chars
DESCR2 OUT_D2 descriptor
DESCR3 OUT_D3 descriptor
DESCR4 OUT_D4 descriptor
DESCR5 OUT_D5 descriptor
DESCR6 OUT_D6 descriptor
DESCR7 OUT_D7 descriptor
DESCR8 OUT_D8 descriptor
INHOPT inhibit option short integer no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short integer con/no-set 8 1 to 8
BADOPT bad alarm option boolean no-con/no-set 0 0 to 1
BADGRP bad alarm group short integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration interval integer no-con/set 0 0 to 32767
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to 2147483647
DVC_ID device ID integer no-con/no-set 0 0 to 0xFFFF
DVCREV device revision long integer no-con/no-set 0 0 to 2147483647
BLKNDX block index long integer no-con/no-set 0 0 to 2147483647
BLKOPT block options integer no-con/no-set 0 0 to 0x00FF
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to 0xFFFFFFFF
AUT_SW auto switch boolean con/no-set 0 0 to 1
BLKERR block error packed bool- con/no-set 0 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0 to 0xFFFFFFFF
BSTATE block state integer con/no-set 0 0 to 11
CRIT criticality integer con/no-set 1 1 to 5
DEVACK device acknowledge boolean con/set 0 0, 1
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode short integer con/no-set 0 0 to 0xFF
OOS_SW out of service switch boolean con/set 0 0 to 1

237
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

Table 7-1. MDI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


OUT_D1 OUT_D1 short integer con/no-set 0
OUT_D2 OUT_D2 (settable in
manual only)
OUT_D3 OUT_D3
OUT_D4 OUT_D4
OUT_D5 OUT_D5
OUT_D6 OUT_D6
OUT_D7 OUT_D7
OUT_D8 OUT_D8
OUTST1 OUT1 status packed bool- con/no-set 0 0 to 0xFFFF
OUTST2 OUT2 status ean
OUTST3 OUT3 status
OUTST4 OUT4 status
OUTST5 OUT5 status
OUTST6 OUT6 status
OUTST7 OUT7 status
OUTST8 OUT8 status
PRTYPE priority type integer con/no-set 0 0,8
PV_D1 OUT_D1 short integer con/no-set, 0
PV_D2 OUT_D2 settable when
SIMOPT=1
PV_D3 OUT_D3
PV_D4 OUT_D4
PV_D5 OUT_D5
PV_D6 OUT_D6
PV_D7 OUT_D7
PV_D8 OUT_D8
TSTMP1 OUT_D1 time stamp long integer con/no-set 0 ms after midnight
TSTMP2 OUT_D2 time stamp
TSTMP3 OUT_D3 time stamp
TSTMP4 OUT_D4 time stamp
TSTMP5 OUT_D5 time stamp
TSTMP6 OUT_D6 time stamp
TSTMP7 OUT_D7 time stamp
TSTMP8 OUT_D8 time stamp
UNACK unacknowledged boolean con/set 0 0, 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for each
(array element
1x255)
FDATA2 file data bytes 256 to 510 short integer no-con/no-set all 0s 0 to 255 for each
(array element
1x255)
CFGERR configuration error short integer no-con/no-set 0
DEFINE no config errors boolean no-con/no-set 1 ---
DESCRP descriptor string no-con/no-set blank 1 to 32 chars

238
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

Table 7-1. MDI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 1 to 32 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
ST_REV status revision integer no-con/no-set 2 blanks 0 to 65535

7.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT Alarm Options contain packed long values representing the alarm options
that have been configured in the block and the alarm groups that are in
use. Table 7-2 shows MDI usage of the parameter.

Table 7-2. ALMOPT Parameter Format

Bit Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
8 Channel 8
9 Channel 7
10 Channel 6
11 Channel 5
12 Channel 4
13 Channel 3
14 Channel 2
15 Channel 1
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

239
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table 7-3 shows the bits used by the MDI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
B13
B14
B15
B16
1=BAD B17
2=BAD B18
3=BAD B19
4 =BAD B20
5=BAD B21
6=BAD B22
7=BAD B23
8=BAD B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
CRIT
UNAK

PRTYPE

BAD
INH

Table 7-3. ALMSTA Parameter Format

Bit Boolean
Number Connection
(0 to 31)* Name Description (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the MDI
block
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
8 Channel 8 Bad Alarm ALMSTA.B24
9 Channel 7 Bad Alarm ALMSTA.B23
10 Channel 6 Bad Alarm ALMSTA.B22
11 Channel 5 Bad Alarm ALMSTA.B21
12 Channel 4 Bad Alarm ALMSTA.B20
13 Channel 3 Bad Alarm ALMSTA.B19
14 Channel 2 Bad Alarm ALMSTA.B18
15 Channel 1 Bad Alarm ALMSTA.B19
22 BAD Bad I/O Alarm: at least one channel ALMSTA.B10
is not usable
29 INH Inhibit Alarm at least one channel is ALMSTA.B3
inhibited
30 UNAK Unacknowledged: There is at least ALMSTA.B2
one unacknowledged alarm
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and therefore MODE_BLK.Target in the associated device
function block, to Auto.

240
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm mes-
sages for this block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the MDI
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block. Table 7-4
shows the parameter format. A given device might not support all bits in
the status word.

Table 7-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

241
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device function block represented by the MDI block. It is set
by the configurator and the FBM uses it to identify the block in the
device. The index is acquired when the MDI block is bound to a DD
either when the device is templated or the block instance is assigned to a
device instance.

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 7-5 shows how the bits are used by the MDI
block. A given device might not support all bits in the bits described in the
table.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

UDEF

FBM

TRK
LCK

BIO
MA
ON

LO
FS

Table 7-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local Over- BLKSTA.B29
ride
6 TRK The block is being tracked as the device function BLKSTA.B26
block is in Local Override or Initialization Man-
ual mode
8 FBM There is a communication failure between BLKSTA.B24
CP and FBM
11 MA The block mode is Auto BLKSTA.B21
12 BIO Bad I/O: at least one channel is Bad BLKSTA.B20
14 UDEF The block is undefined BLKSTA.B18
15 ON The compound that contains the block is ON BLKSTA.B17
16 FFX Enhanced FF block connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FBM228 The H1 device is hosted and scheduled by an BLKSTA.B13
FBM228
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK FDATA installed BLKSTA.B11
22 FDMM FDATA mismatch BLKSTA.B10
23 DEVACK Unacknowleged device alarm BLKSTA.B9
* Bit 0 is the least significant, low order bit.

242
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

BLKOPT Block Options is a configurable, non-settable integer parameter that spec-


ifies the access method for each of the inputs processed by the block.
♦ Bits 0 through 7:
1= Use Publisher/Subscriber connection for channels 1-8
respectively
0= Use Client/Server connection for channels 1-8 respectively
♦ Bits 8-15: 0 (reserved)
Bit 0 is the low-order least significant, low order bit.
CHMASK determines which inputs are to be processed.

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the FF function block connection as determined by the
FBM228. The following values are used to indicate the current DCI block
state:
0 = Undefined state
1 = Unconnected
2 = Connecting
3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON-LINE
11 = Block ON-LINE with error - Processing has been completed, but
some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 266.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the MDI block becomes undefined due to
a “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index shown in
Table 7-6.

Table 7-6. CFGERR Index

Value Device Function Block Parameter with Error


2 TAG_DESC
3 STRATEGY
5 MODE_BLK

243
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

Table 7-6. CFGERR Index (Continued)

Value Device Function Block Parameter with Error


7 CHANNEL

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.
CHANNEL specifies the I/O subsystem by its the transducer block chan-
nel. Refer to the device documentation to identify the correct channel and
any special rules concerning mapping of the device output to the
OUT_Dn parameters.

CHMASK Channel Mask is a configurable, non-settable packed boolean parameter


that specifies which parameters are to be processed by the MDI block.
CHMASK does not affect any device function block settings. Table 7-7
shows the parameter format.

Table 7-7. Channel Mask Parameter Format

Bit Number* Input to be Processed


(0 to 15) When Bit Is Set
0 OUT_D1
1 OUT_D2
2 OUT_D3
3 OUT_D4
4 OUT_D5
5 OUT_D6
6 OUT_D7
7 OUT_D8
8-15 Reserved
*Bit 0 is the least significant, low order bit.

CHMASK has a higher priority than BLKOPT.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation

244
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

testing. See “ERCODE” on page 246 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string of up to


32 characters used to specify a description for the block. The parameter
tracks the TAGDSC parameter, and is updated when the TAGDSC is
modified.

DESCRn OUT_Dn Descriptor (where n is 1 through 8) is a configurable, non-set-


(n is 1 through 8) table string of up to 32 characters that describes OUT_Dn parameter. If
Bad Alarming is configured (BADOPT= 1), the DESCRn string is
included in the Bad Alarming message for the OUT_Dn parameter.

DEVACK Device Acknowledge is a settable boolean output parameter that is used by


an operator to acknowledge device alarms in the device function block.
DEVACK is set by the CP270 when a device alarm is reported by the
FBM228 at either the ECB201 level or at the DCI block level. DEVACK
is cleared by operator action. The range is 0 to 1:
0 = Device Alarm is acknowledged.
1 = Device Alarm is unacknowledged.
DEVACK is different from UNACK (page 252). UNACK is used by the
operator to acknowledge process alarms in the DCI block. DEVACK is
used to acknowledge device alarms at the ECB201 or DCI block level.

NOTE
This parameter is not supported currently.

DVC_ID Device Identifier is a configurable, non-settable integer that provides the


device identifier of the H1 field device that contains the device function
block represented by the MDI block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device.

DVCREV Device Revision is a configurable, non-settable long integer that provides


the revision level of the H1 field device that contains the device function
block represented by the MDI block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to

245
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

verify that there is a match between the block and the device. The IEE
configurator encodes the following data in DVCREV:
Bits 16-23 Bits 8-15 Bits 0-7
Device revision Minimum Device Description Common File Format
(DD) File Revision (CFF) File Revision

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table 7-8 lists the possible values of ERCODE for the MDI block

Table 7-8. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DECREC MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in the MDI block. The range is 1 to 8 (default).

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (from the device
block BLOCK_ERR parameter) generate an alarm message. The parameter
has the same format as BLKERR (Table 7-4).

246
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

FDATA1, File Data #1 and File Data #2 are settable multi-byte arrays that provide
FDATA2 configuration data for the device function block represented by the MDI
block.
This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 510 bytes.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm gener-
ation-inhibit requests for each type of alarm configured in the block.
Table 7-9 shows how the bits are used by the MDI block.

Table 7-9. INHALM Parameter Format

Bit Boolean
Number* Connection
(0 to 15) BAD Alarm Inhibited When True (B16 to B1)
8 Channel 1 INHALM.B8
9 Channel 2 INHALM.B7
10 Channel 3 INHALM.B6
11 Channel 4 INHALM.B5
12 Channel 5 INHALM.B4
13 Channel 6 INHALM.B3
14 Channel 7 INHALM.B2
15 Channel 8 INHALM.B1
*Bit 0 is the least significant, low order bit.
There are no mnemonic names for the individual bits of INHALM.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.

247
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

“Into alarm” messages can be acknowledged by explicitly setting


UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table 7-10
shows how parameter is used with the MDI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
CH8 B1
CH7 B2
CH6 B3
CH5 B4
CH4 B5
CH3 B6
CH2 B7
CH1 B8
B9

Table 7-10. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) When True (B32 to B1)
24 Channel 1 alarms inhibited INHSTA.B8
25 Channel 2 alarms inhibited INHSTA.B7
26 Channel 3 alarms inhibited INHSTA.B6
27 Channel 4 alarms inhibited INHSTA.B5
28 Channel 5 alarms inhibited INHSTA.B4
29 Channel 6 alarms inhibited INHSTA.B3
30 Channel 7 alarms inhibited INHSTA.B2
31 Channel 8 alarms inhibited INHSTA.B1
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up
to 25 characters (12 for <local_compound_name>, 1 for the
colon, and 12 for the <ecb_name>).

248
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the display task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block.

MAN_ID Manufacturer Identifier is a configurable, non-settable long integer that


provides the Manufacturer Identifier of the H1 field device that contains
the device function block represented by this block. The FBM228 checks
the corresponding value in the device resource block to verify that there is
a match between the block and the device.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and therefore MODE_BLK.Target in the associated device function block,
to Manual.

MODE_A Actual Mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device func-
tion block.

MODE_N Normal Mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Normal parameter of the associated
device function block.

MODE_P Permitted Mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target Mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Target parameter of the associated
device function block.
Note that AUT_SW, MAN_SW, and OOS_SW can be used to change
the MODE_T parameter and thus the MODE_BLK.Target parameter in
the device function block.

249
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the MDI block is initial-
ized, the block updates the configurable parameters of the function block
matched to the MDI block by the configured index (BLKNDX). The
NAME parameter is used to set the Block Tag of the device function
block.

OOS_SW Out of Service Switch is a settable output used set the MODE_T parame-
ter, and therefore MODE_BLK.Target in the associated device function
block, to Out of Service.

OUT_Dn OUT_Dn (where n is 1 through 8) is a short discrete output that contains


(n is 1 through 8) the OUT_Dn parameter of the associated device function block when the
block is in Auto mode and not simulating (SIMOPT =0). It is
settable only in Manual mode.
When the block is simulating (SIMOPT =1), OUT_Dn tracks the latest
PV_Dn value set by an operator (when the block is in Manual mode) or
an application (when the block mode is Auto).

OUTSTn OUT_Dn Status (where n is 1 through 8) is a non-configurable, non-set-


(n is 1 through 8) table packed boolean that contains the OUT_Dn.Status from the associ-
ated device function block. Section 7.6.6.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
* If the BPC is 0.2 second, this period is treated internally as
0.6 second, but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with

250
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,
or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the MDI block:
0 = No alarm
8 = Bad I/O alarm.

PV_Dn Discrete Process Variable n (where n is 1 through 8) is a discrete output


(n is 1 through 8) that contains the OUT_Dn parameter of the associated device function
block (even when the block mode is Manual).
PV_Dn is not settable when the block is in normal operation (SIMOPT =
0). When the block is in simulation mode (SIMOPT =1), PV_Dn is setta-
ble.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


OUT_Dn outputs of the MDI block are to be simulated.
When SIMOPT= 1 (True), the status and value of OUT_Dn are not
recovered from the field, but are computed by the control station based on
the simulated value change. When SIMOPT= 1 (True), PV_Dn is setta-
ble.

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block. ST_REV is incre-
mented by one each time a configurable parameter in the device function
block is modified by an external source.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device
function block. The TAGDSC string is also copied to the MDI block
parameter DESCRP, which describes the block in I/A Series displays.

TSTMPn Time Stamp n (where n is 1 through 8) is a non-settable long integer that


(n is 1 through 8) represents the time of the last change to the value or status of an
OUT_Dn parameter of the MDI block. The time is in milliseconds past
midnight. During normal operation, the time is from the FBM228; when
the block is in simulation (SIMOPT = 1), the value is computed by the
CP.

TYPE Type is the block type. When an MDI block is added to the control data-
base, the configuration editor enters a numeric value of 35 to specify the
MDI block type.

251
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the system management dis-
play.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 client/server connections
that scan the device function block View parameters. The range is 0 to
2147483647 milliseconds; the default is 10000

7.5 Device Function Block Description


This section describes the FOUNDATION fieldbus multiple discrete input device function block,
and includes a block schematic, a brief description of the block’s standard parameter set, and a
table showing the mapping between the I/A Series system MDI block parameters and the device
function block parameters.

7.5.1 Device Block Operation


The FOUNDATION fieldbus multiple discrete input device function block processes up to eight
measurements from a field device and makes them available in the OUT_Dn (where n is 1
through 8) parameters (Figure 7-1).
The CHANNEL parameter specifies the source of the transducer block output data unit that is
parsed by the block and mapped to the OUT_Dn parameters.

PV_Dn
(n = 1 to 8)
CHANNEL
Outputs
OUT_Dn
(n = 1 o 8)

Mode Alarms
BLOCK_ALM

Figure 7-1. MDI Device Function Block Schematic

7.5.1.1 Mode
The device function block supports three selectable modes:
♦ In Auto mode, the block’s output parameters (OUT_D1 to OUT_D8) reflect the pro-
cess variables’ (PV_D1 to PV_D8) values and status.
♦ In Manual, the OUT_Dn parameter can be set manually.

252
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

♦ In OOS (out of service), the block values are not updated and the status of OUT_Dn
is set to BAD. In OOS, changes can be made to configured parameters.

7.5.1.2 Status
The device function block provides an eight-bit status for each output value, using the standard
function block value status, which is further parsed in to .Quality, .SubStatus, and .Limits bits.
The .SubStatus bits in this block are device-specific. Refer to “Device Parameter Status” on
page 259 for use of the bits.

7.5.1.3 Alarms
The BLOCK_ALM parameter is used for all configuration, hardware connection, and system
problems in the block.
The I/A Series system does not use the alarm features provided by the device blocks, but rather
provides alarm handling and error reporting options in the I/A Series MDI block. The MDI
block enables BAD alarming using standard I/A Series alarm parameters.

7.5.1.4 Non-standard Parameters


Device manufacturers offer a variety of device function block parameters which are not specified
in their included documentation. These parameters are not supported by the I/A Series MDI
block, but can be configured using Field Device Manager.

7.5.2 Parameter Transforms


Table 7-11 shows the mapping of MDI parameters to parameters in the related device function
block. Many of the parameters are straightforward 1:1 mappings that are either unidirectional or
bidirectional. Other mappings require that a data value be re-formatted (or transformed) to be
intelligible in the I/A Series system.
From the point of view of the MDI block, the relationship with the device function block can also
be described in terms of sink and source connections:
→ Source-sink The MDI block parameter is the source for the corresponding func-
tion block parameter. Thus, changes to the MDI block parameter are
made to the device function block parameter. For example, when the
MDI block is initialized, the TAGDSC value is copied to the device
function block TAG_DESC parameter.
← Sink-source The MDI block parameter value is updated by the corresponding
device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual function block mode visible to the control system.
↔ Bidirectional Changes to the MDI block parameter are made to the corresponding
device function block parameter and vice versa. For example, when
the MDI block is initialized, its MODE_T parameter value is written
to the device block parameter, MODE_BLK.Target, to configure the
block’s target mode. Subsequently, the MODE_BLK.Target value is
written back to the MDI block MODE_T parameter.

The arrow notation is used in the Table 7-11 descriptions of MDI parameter transforms. These
are presented in alphabetic order, arranged by the MDI block parameter names.

253
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

Table 7-11. MDI Block Parameter Transforms

MDI Block Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target

When AUT_SW = 1:
Set MODE_T (request) = AUTO
MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP to FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.MA=0 ← MODE_BLK.Actual.MAN
BLKSTA.MA=1 ← MODE_BLK.Actual.AUTO
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← OUT.Status.Bad (Bits 6-7=0)
CHANNL ↔ CHANNEL
HSCO1 ↔ OUT_SCALE.@100%
LSCO1 ↔ OUT_SCALE.@0%
MAN_SW MODE_BLK.Target
When MAN_SW =1:
Set MODE_T (request) = MAN
AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permitted
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW =1:
Set MODE_T (request) = OOS
AUT_SW=0, MAN_SW=0
Write MODE_T (request) to FBM

254
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

Table 7-11. MDI Block Parameter Transforms (Continued)

MDI Block Parameter Device Function Block Parameter


OUT_Dn (n = 1 to 8) OUT_Dn (n = 1 to 8)
OUT_Dn.value (request) ↔ OUT_Dn.Value (in MAN mode only)
OUT_Dn.value (actual) ← OUT_Dn.Value
OUT_Dn.status.LHI ← OUT_Dn.Status.Limited Hi (Bit 0),
OUT_Dn.status.LLO ← OUT_Dn.Status.Limited Lo (Bit 1)
OUT_Dn.status.ERR ← OUT_Dn.Status.Uncertain (Bits 6-7=1)
OUT_Dn.status.BAD ← OUT_Dn.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
OUT_Dn.status.OOS ← OUT_Dn.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-
5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
OUTSTn OUT_Dn
OUTSTn.value ← OUT_Dn.Status
PV_Dn (n = 1 to 8) OUT_Dn (n = 1 to 8) (when block is not simulating)

PV_Dn.value ←OUT_Dn.Value
PV_Dn.status.LHI ← OUT_Dn.Status.Limited Hi (Bit 0)
PV_Dn.status.LLO ← OUT_Dn.Status.Limited Lo (Bit 1)
PV_Dn.status.ERR ← OUT_Dn.Status.Uncertain (Bits 6-7=1)
PV_Dn.status.BAD ← OUT_Dn.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
or H1 device is Failed or Disabled.
PV_Dn.status.OOS ← OUT_Dn.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-
5= 7),
or Compound is Off
or FBM228 is Off-Line or DCI Not Ready
or H1 Device is Failed or Disabled
or CP-FBM communication failure
or DCI_COMM_DATA.connect_status <= 0
PVFTIM ↔ PV_FTIME
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC → TAG_DESC
Note: Changes to TAGDSC are copied to DESCRP.

7.6 MDI Block Functions


The I/A Series MDI block provides the interface between CP-resident control blocks and the
device function block in the H1 device.

255
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

The MDI block OUT_Dn (where n is 1 through 8) and OUTSTn parameters hold value and sta-
tus, respectively, of the device function block OUT_Dn parameter.
The block also supports the function block’s mode parameters.
The MDI block and the device function block operate in two asynchronous cycles, both writing
to and reading from shared space in the FBM memory. As with other I/A Series IO blocks, the
MDI block executes in the Basic Processing Cycle (BPC) of the control station according to its
compound and its PERIOD and PHASE parameters, as described in Control Processor 270
(CP270) Integrated Control Software Concepts (B0700AG). The device MDI block executes once
each FBM macrocycle as scheduled by the FBM228.
The principal task of the MDI block is to read values and status from the corresponding device
block. For this task, publisher/subscriber and/or client/server connections (which are based on the
BLKOPT and CHMASK parameters) are maintained between the MDI block OUT_Dn param-
eters and the device function block OUT_Dn parameters.
All other parameter connections are made by the FBM228 on a client/server basis at the fre-
quency specified in the UPDPER parameter. The parameter can be set from 0 to 2147483647
milliseconds; the default is 10000 (10 seconds). Increasing the frequency of the client/server com-
munication can significantly add to the load on the H1 segment.

7.6.1 Device Function Block Connection


The configured parameter IOM_ID of the MDI block specifies an ECB201 (the device ECB)
that represents the target H1 device. The ECB201 PARENT parameter identifies the ECB200 or
ECB202 for the FBM228. The path to the device block is completed as follows. When the MDI
block is configured using IEE, the device function block is selected in a browser which displays
the device function blocks based on the device description in the device ECB. If the connection is
not made via the browser, the connection is made based on the MDI block BLKNDX parameter.
The MDI block CHANNL parameter is used to configure the device block CHANNEL parame-
ter and thus identify the I/O subsystem equipment providing the inputs. Refer to the device doc-
umentation for the appropriate channel assignment.
CHMASK parameter is used to specify which of the eight device block outputs are to be pro-
cessed by the MDI block. CHMASK does not affect any settings in the device function block.
The BLKSTA parameter is used to specify the current block operational states.
To assign function blocks to their device, refer to “Assign the Function Blocks to a Device” in
InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA).

7.6.2 Device Configuration Parameters


The MDI block enables you to set key configurable parameters in the corresponding device func-
tion block and manage the configuration from the I/A Series system. When you deploy the MDI
block to the control station, and then download the FBM228, parameter values in the MDI block
update parameters in the linked device function block.
The deployment of the MDI block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Schedule execution of the device function block

256
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

♦ If needed, add compel data (CD) messages to each macrocycle to publish the
OUT_Dn parameter values and status as specified by the BLKOPT and CHMASK
parameters.
♦ Schedule client/server connections between the MDI block and the device function
block for view updates.
Table 7-12 lists the device function block parameters and the MDI block parameters used to con-
figure them. For the MDI, the table includes both the six-character (maximum) parameter name
that is used in block detail displays and the parameter labels which more closely resemble the
FOUNDATION fieldbus parameter names. Use the six-character parameter name when connecting
parameters to a process display.

Table 7-12. MDI Block Configuration Parameters

Configured with MDI Block Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
CHANNEL CHANNL Channel
FF_BLOCK.BLOCK_TAG NAME Name
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc

7.6.3 Block Validation


The MDI block initializes when any of these events occur:
♦ The block is installed or reconfigured via the IEE control configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.
When the I/A Series MDI block initializes, the following block validation test is performed:
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Auto,
Manual or Out-of-Service, the block is marked undefined (BLKSTA.UDEF=1) with
the error code parameter (ERCODE) set to “W76 - INVALID FF MODE
CONFIGURATION”.
If the FBM simulation is not used (SIMOPT=0), the following validation tests are performed:
♦ If the MDI block is installed prior to the installation of the ECB201 block, it is
marked undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE)
set to “W54 - ECB DOES NOT EXIST”. In this case, the MDI block configuration
is restarted and re-validated automatically when the ECB201 is installed.
♦ An attempt is made to connect the MDI block to the ECB201 specified in the
IOM_ID parameter. The DCI connection address (i.e., the BLKNDX parameter in
the MDI block) is used in a connect message to establish a block connection in the

257
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

FBM228. The CHMASK parameter is embedded in the connect message to indicate


which of the 1-8 input channels are to be enabled.
♦ If the block connection cannot be resolved due to a lack of configuration information,
a block connection is made in the FBM, the connection status is marked Unresolved,
and one of the following error strings is stored in the block ERCODE parameter:
♦ “W62 - UNRESOLVED CONNECTION”
♦ “W77 - FIELDBUS COMMUNICATIONS FAULT”
♦ “W78 - INVALID FUNCTION BLOCK”
♦ “W80 - FIELDBUS DEVICE NOT FOUND”
♦ “W82 - FF CONFIGURATION IN PROGRESS”
(In these cases, the MDI block is defined, but the output values are marked OOS.)
♦ “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the MDI block is defined, and the index of the invalid function block
parameter is stored in the CFGERR parameter.)
♦ If the block connection cannot be made for any other reason, the FBM rejects the
connection request and one of the following error strings is stored in the ERCODE
parameter to indicate the reason for the connection error:
♦ “W65 - INVALID POINT ADDRESS”
♦ “W66 - DUPLICATE CONNECTION”
♦ “W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS”
♦ “W68 - INVALID DEVICE CONNECTION”
♦ “W69 - INVALID POINT CONNECTION”
♦ “W74 - FF FUNCTION BLOCK DDITEM MISMATCH”
♦ “W75 - FF FUNCTION BLOCK DDMBR MISMATCH”
♦ “W76 - INVALID FF MODE CONFIGURATION”
♦ “W79 - INVALID PARAMETER INDEX”
♦ “W83 - INVALID FF PARAMETER CONNECTION”
♦ “W84 - INVALID FF PARAMETER TYPE”
♦ “W85 - INVALID CONNECTION TYPE”
♦ “W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH”
(In these cases, the I/A Series MDI block is undefined.)
♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the
I/A Series MDI block is undefined with ERCODE set to “W43 - INVALID
PERIOD/PHASE COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the
I/A Series MDI block is undefined with ERCODE set to “W81 - INVALID PAR-
ENT DCI ECB PERIOD/PHASE”.
If there are no configuration errors when the I/A Series MDI block is installed, the block is
marked defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the compound con-

258
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

taining the block is turned on, the block also initializes and starts running automatically.

7.6.4 Block Initialization


When the I/A Series MDI block initializes, the following are performed:
♦ All alarm status parameters (ALMSTA, INHSTA, CRIT, PRTYPE, UNACK) are
cleared.
♦ The Actual mode parameter (MODE_A) is set to Initialization Manual (IMAN) in
the I/A Series MDI block.
♦ The Target mode parameter (MODE_T) is set to only one of the following states, in
order, if multiple bits are set: Auto, Manual, OOS.
♦ The status of all OUT_D1-OUT_D8 parameters not specified in CHMASK are set
to BAD and OOS.
♦ The Timestamps for each of the 1-8 outputs are updated.
If not simulating (SIMOPT=0), the following are performed:
♦ The Target mode is sent to the MDI device function block.
♦ If installing the block, or if rebooting and not a Warm Restart, the configuration
parameters are downloaded to the device MDI function block.

7.6.5 I/A Series Parameter Status


The status of the device MDI function block parameters are provided in the I/A Series MDI
block in two forms:
♦ The status of each device function block parameter is available as a separate I/A Series
MDI block parameter.
♦ The status of each device function block parameter also is mapped onto equivalent
fields in the value record status of the corresponding I/A Series MDI block parameter.
For each device function block parameter containing status information, the following fields are
mapped:
♦ The Quality field (Bits 6-7) are mapped onto the BAD and ERR status bits.
♦ The Sub-status field (Bits 2-5) are ignored, except for the case when the Quality is Bad
and the Sub-status is OOS. In this case, the OOS status bit will be set in the I/A Series
MDI block parameter.
♦ The Limited High (Bit 0) and Limited Low (Bit 1) fields are mapped onto the LHI,
LLO status bits, respectively.

7.6.6 Device Parameter Status


NOTE
The .SubStatus bits in multiple discrete input blocks vary with the specific I/O sub-
system or multi-sensor device, and may not be the same as the standard
FOUNDATION fieldbus bit assignment used in other device function blocks.

Table 7-13 shows how the status byte is formatted.

259
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

Table 7-13. Device Parameter Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 Refer to the device documentation
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table 7-14 shows the usage of the Substatus bits, which varies depending on which .Quality bits
are set.
Table 7-14. Device Parameter Substatus

Bits 2-5 = SubStatus Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.

260
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

Table 7-14. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus Description


4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

261
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

7.6.7 Block Modes


The Target mode can be changed through a group of settable Boolean mode switches provided in
the MDI block. These mode switches, AUT_SW, MAN_SW, and OOS_SW, allow the block
mode to be changed to Auto, Manual, or Out-of-Service respectively.
♦ Logic in the CP270 prevents more than one switch to be set at a given time. If more
than one switch is set during the same block cycle, only the last switch setting is
honored.
♦ Once set, a mode switch remains set only until the Target mode change is sent to the
FBM228 or until another mode switch is set. At that time, the mode switch is cleared.
♦ The mode switch setting is mapped onto an equivalent Target mode setting sent to
the FBM228.
The Target mode is a shadow parameter updated from the MODE_BLK function block parame-
ter read back during input scanning of the FBM228.
When the Actual, Permitted, Target, or Normal modes change in the MDI device function block,
the corresponding I/A Series mode parameters are updated automatically from the MODE_BLK
function block parameter. In addition, the Actual mode is mapped onto equivalent BLKSTA
parameter bits.
The INITMA parameter and the Auto/Manual override parameters, AUTSW and MANSW, are
not supported in the I/A Series MDI block, since these functions do not exist in the device MDI
function block.
When the Actual block mode is Auto or Manual, the following are performed:
♦ The OUTST1-OUTST8 status parameters and the value status of the OUT_D1-
OUT_D8 parameters are updated from data received in the reply to the read message.
The CHMASK parameter is used to determine which outputs to process.
♦ The PV_D1-PV_D8 input parameter values are updated from data received in the
reply to the read message. The CHMASK parameter is used to determine which
inputs to process.
♦ Configuration parameters that have changed since the previous block cycle are
downloaded.
♦ Other View data parameters are updated, if any changes in these parameters have
occurred since the previous block cycle.
♦ Block Error (BLKERR) processing begins.
♦ External configuration changes to function block parameters are propagated.
♦ Configuration Error (CFGERR) processing begins.
♦ If BADOPT=1, Bad Alarming of the inputs is performed.
When the Actual block mode is Auto, the following is performed:
♦ The OUT_D1-OUT_D8 output parameter values and status are updated from data
received in the reply to the read message. The CHMASK parameter is used to deter-
mine which outputs to process.
When the Actual block mode is Manual, the operator is allowed to set any of the OUT_D1-
OUT_D8 output parameter values directly via an OM set operation:
♦ The Actual block mode (MODE_BLK.Actual) is provided in the MDI block in two
forms:

262
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B


The Actual mode is stored in the MODE_A output parameter.
♦ The Actual mode also is mapped onto equivalent bits in the BLKSTA block status
parameter.
♦ The OOS state is mapped onto the OOS value status bit of the BLKSTA parameter.
♦ The IMAN state is mapped onto the BLKSTA.TRK status bit.
♦ The LO state is mapped onto both the BLKSTA.TRK and BLKSTA.LO status bits.
♦ The MAN state sets BLKSTA.MA=0.
♦ The AUTO state sets BLKSTA.MA=1.

7.6.8 Block Alarming


The MDI block performs alarm functions consistent with standard CP270 alarming. This
includes the following types of process alarms:
♦ Bad Alarming of each of the OUT_D1-OUT_D8 outputs. The CHMASK parameter
provides a bitmap that used to determine which outputs to process.
♦ Informational messages of block errors (BLKERR) reported by the MDI function
block BLOCK_ERR parameter.
♦ Informational messages of function block configuration errors (CFGERR).
The device function block alarm detection, alarm events, alarm messaging, and associated param-
eters provided by the field device are not supported in this MDI block.

7.6.9 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter is performed as
follows:
♦ For every condition specified in ERROPT, a corresponding Informational message is
sent to the ERRGRP alarm group when the condition occurs. The UNACK parame-
ter and the corresponding ALMSTA.UNACK bit also are set. ERROPT has the same
format as BLKERR (Table 7-4 on page 241).
♦ One of the messages listed in Table 7-15 is generated.

Table 7-15. Block Error Messages

ERROPT Bit Message Text


Bit 0 FF Block Error: Out-of-Service
Bit 1 FF Block Error: Power Up
Bit 2 FF Block Error: Maintenance Needed Now
Bit 3 FF Block Error: Readback Check
Bit 4 FF Block Error: Lost NV Data
Bit 5 FF Block Error: Lost Static Data
Bit 6 FF Block Error: Memory Fail
Bit 7 FF Block Error: Output Fail
Bit 8 FF Block Error: Input Fail
Bit 9 FF Block Error: Maintenance Due Soon
Bit 10 FF Block Error: Fault State Active
Bit 11 FF Block Error: Local Override

263
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

Table 7-15. Block Error Messages

ERROPT Bit Message Text


Bit 12 FF Block Error: Simulation Active
Bit 13 FF Block Error: Link Configuration Error
Bit 14 FF Block Error: Block Configuration Error
Bit 15 FF Block Error: Other (Undefined) Error

7.6.10 Configuration Error Processing


When an FF block configuration parameter cannot be downloaded into the field device, the
parameter index is stored in the CFGERR parameter and the following informational message is
generated:
“FF CFGERR in Parameter nnnnnnnn”
where: nnnnnnnn = ASCII name of the parameter indicated by the index in CFGERR

7.6.11 Bad Alarm Detection


Bad alarm detection is supported when the Bad alarm configuration option (BADOPT) is set.
Bad alarm status information is generated when any point is bad. This philosophy is consistent
with the handling of state alarms in the BLNALM block.
Bad alarm messages are generated for each point independently when its status is bad (i.e.,
OUT_Dn.BAD, where n=1-8).
When the point value becomes bad, a bad alarm message is created and sent to all devices in the
bad alarm group specified by the BADGRP parameter. This message contains a “BAD_n” (if
OUT_Dn) text string to identify the appropriate point. This message also contains the respective
DESCRn point descriptor, the descriptive text in the BADTXT parameter, and the loop identifier
in the LOOPID parameter.
When the point value becomes good, a return-to-normal message is generated and sent to all
devices in the bad alarm group.
When any point value is bad, the BAD bit is set in the alarm status parameter (ALMSTA.BAD).
The UNACK parameter and the ALMSTA.UNACK bit are set. The CRIT parameter and ALM-
STA.CRIT field are set to the BADPRI parameter value, and the PRTYPE parameter and ALM-
STA.PRTYPE field are set to the Bad alarm type.
When all point values have returned to good status, BAD, CRIT, PRTYPE and their correspond-
ing fields in ALMSTA are cleared.
The UNACK parameter and the ALMSTA.UNACK bit are cleared in these cases:
♦ When the alarm is acknowledged at the compound level, by setting the compound
UNACK=0, or at the block level, by setting the block UNACK=0.
♦ When all point values return to normal, if INHOPT is set appropriately.
♦ When the block is shut down.
When UNACK is cleared, an Alarm Acknowledge message is generated and sent to all devices in
the bad alarm group.
Alarm Inhibiting/Disabling is supported using a combination of the compound CINHIB param-
eter and the INHOPT, INHIB, and INHALM parameters in the MDI block, to allow the bad

264
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

alarm messages to be inhibited and/or the alarm detection to disabled dynamically.


The INHALM parameter can be used to inhibit or disable bad alarming selectively for any group
of the 1-8 points.
When Bad alarming is inhibited or disabled, an Alarm Disable message is generated and sent to all
devices in the alarm group. If the Alarm is unacknowledged, an Alarm Acknowledge message also
is sent to these devices. The ALMSTA.INHIB bit is set, and the appropriate INHSTA.BAD bits
are set.
When Bad alarming is uninhibited or enabled, an Alarm Enable message is generated and sent to
all devices in the alarm group. The appropriate BAD bits in the INHSTA parameter are cleared,
and the ALMSTA.INHIB bit is cleared if all channels are uninhibited or enabled.
The Alarm Reprioritization and Alarm Message Regeneration (using AMRTIN) enhancements
also are supported in this MDI block. Refer to the Control Processor 270 (CP270) Integrated Con-
trol Software Concepts (B0700AG) for details.

7.6.12 Block Shutdown


The MDI block shuts down when any of these events occur:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ The ECB201 connected to the block is deleted.
♦ The MDI block is deleted.
When block shutdown occurs, the following actions are taken:
♦ If any Bad Alarms are active, an Alarm Disable message is issued to all devices in the
bad alarm group. If the Bad Alarms are Unacknowledged, an Alarm Acknowledge
message also is sent to these devices.
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, UNACK) are cleared.
If not simulating (SIMOPT=0) and the compound is off, the following actions are taken:
1. If the FF_OOS_OPT bit (Bit 4: 0x0010) is set in the Station block CFGOPT param-
eter, the following additional actions are taken:
♦ The actual mode parameter (MODE_A) is set to OOS.
♦ A write message is sent to the FBM228 with both the OOS and IMAN bits set in
the Target mode. The IMAN bit is set to indicate to the FBM228 that the com-
pound is off.
♦Otherwise, a write message is sent to the FBM228 with only the OOS bit set in
the Target mode.
2. Otherwise, the following action is taken:
♦ A write message is sent to the FBM228 with both the current state and the IMAN
bits set in the Target mode. The IMAN bit is set to indicate to the FBM228 that
the compound is off.

7.6.13 Simulation
The MDI block SIMOPT parameter enables simulation of multiple discrete inputs to the control
system from the corresponding multiple discrete input device function block. This feature can be

265
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

used to test control schemes requiring discrete inputs without actual FBM228 hardware connec-
tions.
When SIMOPT= 1 (True), the status and value of OUT_Dn are not recovered from the field, but
can be set directly to simulate input from the field.
When simulating (SIMOPT=1), the following functions will be performed:
♦ The PV_Dn inputs are settable and are stored to the OUT_Dn output values when
the block mode is Auto. The CHMASK parameter will be used to determine which
outputs to process.
♦ The OUTSTn output status parameters are set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (AUT_SW, MAN_SW, or
OOS_SW) immediately update target mode parameter (MODE_T), and the actual
block mode (MODE_A) tracks MODE_T each block cycle.
♦ If BAO=1, Bad Alarming of the inputs is performed.
When simulating, the following functions are not performed:
♦ Downloading of configuration parameters.
♦ Updating of View data parameters.
♦ Block Error (BLKERR) processing.
♦ External configuration changes to function block parameters.
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing Foundation fieldbus in InFusion 2.0
(B0750DA) or Implementing Foundation fieldbus on the I/A Series System (B0700BA) for instruc-
tions on conducting control simulations from the control station.

7.6.14 Block States


The DCI blocks transition through the states detailed in Table 7-16 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 243).

Table 7-16. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block

266
7. MDI – Foundation™ fieldbus Multiple Discrete Input B0700EC – Rev B

Table 7-16. DCI Block States (BSTATE) (Continued)

BSTATE Value
(Int (Bin)) State Value Description
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

7.7 MDI Block Application Example


The MDI block can be used in any control block configuration, in any compound except the Sta-
tion compound and the Primary ECB compound, in any CP270. It only can be connected to any
device MDI function block in a field device hosted by an FBM228, but not to any other device
function block type or to any function block parameter.
Each field device connection must be specified by configuring the name of the ECB201 in the
IOM_ID parameter. The device MDI function block connection must be specified by configur-
ing the MDI function block index in the BLKNDX parameter.
Figure 7-2 illustrates an example of the MDI block’s use in applications.

267
B0700EC – Rev B 7. MDI – Foundation™ fieldbus Multiple Discrete Input

Parent ECB200/202

Child ECB201 Child ECB201

PARENT PARENT

IOM_ID IOM_ID
NAME NAME

MDI Block LOGIC Block DO Block

PV_D1 OUT_D1 BI01 BO01 CASIND


OUT_D
PV_D8 OUT_D8 BI08 BO08

IOM_ID
NAME

DO Block

CASIND
OUT_D

Figure 7-2. Application Example with I/A Series MDI Block

268
8. MDO - FOUNDATION™ fieldbus
Multiple Discrete Output
This chapter describes the Multiple Discrete Output (MDO) block, which interfaces the control
system with a corresponding multiple discrete output function block operating in a
FOUNDATION™ fieldbus H1 device.

8.1 Overview
Multiple Discrete Output (MDO) is a Distributed Control Interface (DCI) block that pro-
vides an interface between the control processor and a multiple discrete output function block
operating in a FOUNDATION fieldbus H1 device (the device function block). The MDO block
is supported on the FCP270 and ZCP270 when the H1 device is connected to the control sta-
tion by an FBM228. The MDO block is configured using the Block Configurator in the InFu-
sion Engineering Environment (IEE) as described in InFusion Enterprise Control System:
Implementing FOUNDATION fieldbus in InFusion 2.0 (B0750DA).

NOTE
The MDO block functionality described in this chapter is applicable only for
FBM228s with the software type (SWTYPE) of “128”.

8.2 Basic Operation


The MDO block integrates the corresponding device function block into the I/A Series system.
On initialization, user-configured parameters in the MDO block are written to key configurable
parameters in the corresponding device function block.
During normal operation, the MDO block’s IN_Dn (where n is 1 through 8) are written to the
IN_Dn1 parameters of the device function block. The outputs are then read back to MDO block
IN_Dn and INSTn parameters, which hold the value and status, respectively, of the device IN_D
parameters.
When the block is in simulation mode (SIMOPT = 1), the IN_Dn values are not written to the
device function block, but the value of each IN_Dn is updated as if it had been read back from
the device, and the status of each IN_Dn is set to Good, Non-Cascade.
In addition to providing outputs to the device function block, the MDO block provides access to
a variety of operational and diagnostic information via client/server connections with the parame-
ters that are included in the block view data of the device block. The values read from these
parameters are displayed in the block detail displays and are available for connection to other
I/A Series blocks.

1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

269
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

8.3 Features
The MDO block provides the following features:
♦ Provides up to eight discrete outputs (IN_D1 through IN_D8) to the linked device
function block
♦ Acquires the value and status of the device block outputs
♦ Time-stamps changes to the value and/or status of the device block outputs
♦ Accesses the parameters in the device function block’s View using change-driven and
periodic client/server connections
♦ Ensures that changes in a device’s process values and error conditions are continuously
available for display and connection to the control strategy
♦ Provides for the configuration of device block parameters from the I/A Series system
and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Auto or Out of Service
♦ Supports the device function’s fault state operation
♦ Provides alarm detection and reporting for Bad I/O
♦ Supports simulation of device block outputs within the control station.

8.4 Block Parameters


Table 8-1 lists the block parameters. See Table 8-16 for mappings of MDO parameters and their
device function block equivalents.

Table 8-1. MDO Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 38 38 [MDO]
TAGDSC tag descriptor string no-con/no-set 2 blanks 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 13
PHASE block execution phase integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0 = no simulation
1 = simulation
IOM_ID ECB identifier string no-con/no-set 0 (null) any valid path
name <= 25
chars or ECB
block name <=12
chars
CHANNL channel integer no-con/no-set 1 0 to 32767
CHMASK channel mask packed bool- no-con/no-set 0xFF 0x00 to 0xFF
ean
DDITEM DD item ID long no-con/no-set 0x800209B0 -
DDMBR DD member ID long no-con/no-set 0x00 -
UPDPER view update period long no-con/no-set 10000 ms 0 to
2147483647ms

270
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-1. MDO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


STRATG strategy integer no-con/no-set 999 0 to 65535
MOOPTS MO_OPTS block packed bool- no-con/no-set 0xFF00 0 to 0xFFFF
options ean
MODE_N normal mode short integer no-con/no-set 0x10 0 to 0xFF
MODE_P permitted mode short integer no-con/no-set 0x11 0 to 0xFF
MODE_T target mode short integer no-con/no-set 0x10 0 to 0xFF
IN_D1 IN_D1 short integer con/set 0 0 to 255
IN_D2 IN_D2
settable when
IN_D3 IN_D3
unlinked
IN_D4 IN_D4
IN_D5 IN_D5
IN_D6 IN_D6
IN_D7 IN_D7
IN_D8 IN_D8
FSOPTN faultstate option short integer no-con/no-set 0x00 0x00, 0x01, 0x04,
0x05
FSTIME faultstate time real no-con/no-set 20.0 sec
FSV_D1 faultstate value 1 short integer no-con/no-set 0 0 to 255
FSV_D2 faultstate value 2
FSV_D3 faultstate value 3
FSV_D4 faultstate value 4
FSV_D5 faultstate value 5
FSV_D6 faultstate value 6
FSV_D7 faultstate value 7
FSV_D8 faultstate value 8
DESCR1 IN_D1 descriptor string no-con/no-set 2 blanks 1 to 32 chars
DESCR2 IN_D2 descriptor
DESCR3 IN_D3 descriptor
DESCR4 IN_D4 descriptor
DESCR5 IN_D5 descriptor
DESCR6 IN_D6 descriptor
DESCR7 IN_D7 descriptor
DESCR8 IN_D8 descriptor
INHOPT inhibit option short integer no-con/no-set 0 0 to 3
INHIB alarm inhibit switch boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short integer con/no-set 8 1 to 8
BADOPT bad alarm option boolean no-con/no-set 1 0, 1
BADGRP bad alarm group integer no-con/no-set 0 1 to 8
BADPRI bad alarm priority integer con/set 5 1 to 5
BADTXT bad alarm text string con/no-set 2 blanks 0 to 32 chars
AMRTIN alarm regeneration integer no-con/set 0 0 to 32767
interval
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to 2147483647

271
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Table 8-1. MDO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DVC_ID device ID long integer no-con/no-set 0 0 to 2147483647
DVCREV device revision integer no-con/no-set 0 0x0000 to
0xFFFF
BLKNDX block index long integer no-con/no-set 0 0 to 2147483647
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to 0xFFFFFFFF
AUT_SW auto switch boolean con/set 0 0 to 1
BLKERR block error packed bool- con/no-set 0 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0 to 0xFFFFFFFF
BSTATE block state integer con/no-set 0 0 to 11
CRIT alarm criticality integer con/no-set 0 0 to 5
DEVACK device acknowledge boolean con/set 0 0, 1
FSTATE faultstate status packed bool- con/no-set 0 0 to 0xFFFF
ean
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
INST_1 IN_D1 status packed bool- con/no-set 0 0 to 0xFF
INST_2 IN_D2 status ean
INST_3 IN_D3 status
INST_4 IN_D4status
INST_5 IN_D5 status
INST_6 IN_D6 status
INST_7 IN_D7 status
INST_8 IN_D8 status
MODE_A actual mode short integer con/no-set 0 to 0xFF
OOS_SW out of service switch boolean con/set 0 0 to 1
PRTYPE priority type integer con/no-set 0 0, 8
TSTMP1 IN_D1 time stamp long integer con/no-set 0 ms since mid-
TSTMP2 IN_D2 time stamp night
TSTMP3 IN_D3 time stamp
TSTMP4 IN_D4 time stamp
TSTMP5 IN_D5 time stamp
TSTMP6 IN_D6 time stamp
TSTMP7 IN_D7 time stamp
TSTMP8 IN_D8 time stamp
UNACK unacknowledged boolean con/set 0 0, 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
CFGERR configuration error short integer no-con/no-set 0
DEFINE no config errors boolean no-con/no-set 1 0, 1
DESCRP descriptor string no-con/no-set 2 blanks 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks See ERCODE
below

272
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-1. MDO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for each
(array 1x255) element
FDATA2 file data bytes 256 to short integer no-con/no-set all 0s 0 to 255 for each
510 (array 1x255) element
LOCKID lock identifier string no-con/no-set 2 blanks 1 to 32 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
ST_REV status revision integer no-con/no-set 0 0 to65535

8.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT The Alarm Options parameter contains packed long values representing
the alarm types that have been configured as options in the block (based
on BADOPT which enables Bad Alarming and CHMASK which identi-
fies which channels are to be processed by the block), and the alarm
groups that are in use. Table 8-2 shows how the parameter is used by the
MDO block.

Table 8-2. ALMOPT Parameter Format

Bit Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
8 Channel 8 option
9 Channel 7 option
10 Channel 6 option
11 Channel 5 option
12 Channel 4 option
13 Channel 3 option

273
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Table 8-2. ALMOPT Parameter Format (Continued)

Bit Number*
(0 to 31) Configured Alarm Option, When True
14 Channel 2 option
15 Channel 1 option
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table 8-3 shows the bits used by the function blocks.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
CH1 Bad B17
CH2 Bad B18
CH3 Bad B19
CH4 Bad B20
CH5 Bad B21
CH6 Bad B22
CH7 Bad B23
CH8 Bad B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

CRIT PRTYPE
UNAK

HMA
BAD

LMA
INH

Table 8-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter PRTYPE ---
for values used in the blocks
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
8 Channel 8 BAD alarm ALMSTA.B24
9 Channel 7 BAD alarm ALMSTA.B23
10 Channel 6 BAD alarm ALMSTA.B22
11 Channel 5 BAD alarm ALMSTA.B21
12 Channel 4 BAD alarm ALMSTA.B20
13 Channel 3 BAD alarm ALMSTA.B19
14 Channel 2 BAD alarm ALMSTA.B18
15 Channel 1 BAD alarm ALMSTA.B17

274
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-3. ALMSTA Parameter Format (Continued)

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
16 LMA Low Absolute Alarm ALMSTA.B16
17 HMA High Absolute Alarm ALMSTA.B15
22 BAD Bad I/O Alarm. ALMSTA.B10
Set when any IN_Dn.Status.Bad=1
Cleared when all IN_Dn.Status.Bad = 0
29 INH Inhibit Alarm. This bit is set when any of ALMSTA.B3
the alarms for any channel is inhibited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set MODE_T, and thus
MODE_BLK.Target in the associated device function block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the MDO block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the MDO
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block. Table 8-4
shows the parameter format.

275
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Table 8-4. BLKERR Parameter Format

Bit* Error Code


0 Out of Service
1 Power-up
2 Device Needs Maintenance Now
3 Readback Check Failed
4 Lost NV Data
5 Lost Static Data
6 Memory Failure
7 Output Failure
8 Input Failure
9 Device Needs Maintenance Soon
10 Device Fault State Set
11 Local Override
12 Simulate Active
13 Link Configuration Error
14 Block Configuration Error
15 Other (most significant bit)
*Bit 0 is the least significant, low order bit.

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 8-5 shows how the bits are used by the
MDO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B24
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DEVACK B9

FDFAIL
FDACT
FDMM

HOLD
FDOK

UDEF

FBM

TRK
LCK

FFX

BIO
MA
ON

LO
LR
FS

Table 8-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local Override BLKSTA.B29
6 TRK The block is being tracked as the device function BLKSTA.B26
block is in Local Override or Initialization Manual
mode
8 FBM There is a communication failure between BLKSTA.B24
CP and FBM

276
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-5. BLKSTA Parameter Format (Continued)

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
10 LR Local/Remote BLKSTA.B22
11 MA The device block mode is Auto BLKSTA.B21
12 BIO Bad I/O: at least one channel is bad BLKSTA.B20
14 UDEF Block is undefined. See DEFINE, ERCODE, and BLKSTA.B18
CFGERR
15 ON The compound that contains the block is ON BLKSTA.B17
16 FFX Enhanced FF block connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FBM228 The H1 device is hosted and scheduled by an BLKSTA.B13
FBM228
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK File data installed BLKSTA.B11
22 FDMM File data mismatch BLKSTA.B10
23 DEVACK Unacknowledged device alarm BLKSTA.B9
24 FS Fault State BLKSTA.B8
* Bit 0 is the least significant, low order bit.

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device function block represented by the MDO block. It is set
by the configurator and the FBM uses it to identify the block in the
device.

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the FF function block connection as determined by the
FBM228. The following values are used to indicate the current DCI block
state:
0 = Undefined state
1 = Unconnected
2 = Connecting
3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON-LINE

277
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

11 = Block ON-LINE with error - Processing has been completed, but


some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 305.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the Function block becomes undefined
due to a “W73 - FF FUNCTION BLOCK CONFIGURATION
ERROR”. When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index
(Table 8-6).

Table 8-6. CFGERR Index

Value* Device Block Parameter with Error


2 TAG_DESC
3 STRATEGY
5 MODE_BLK
7 CHANNEL
16 MO_OPTS
17 FSTATE_TIME
18 FSTATE_VAL_D1
19 FSTATE_VAL_D2
20 FSTATE_VAL_D3
21 FSTATE_VAL_D4
22 FSTATE_VAL_D5
23 FSTATE_VAL_D6
24 FSTATE_VAL_D7
25 FSTATE_VAL_D8
*Bit 0 is the least significant, low order bit.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.
CHANNEL specifies the I/O subsystem by its the transducer block chan-
nel. Refer to the device documentation to identify the correct channel and
any special rules concerning mapping of IN_Dn parameters to device out-
puts.

CHMASK Channel Mask is a configurable, non-settable packed boolean parameter


that specifies which parameters are to be processed by the MDO block.
CHMASK does not affect any device function block settings. Table 8-7
shows the parameter format.

278
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-7. Channel Mask Parameter Format

Bit Number* Output to be Processed


(0 to 15) When Bit Is Set
0 IN_D1
1 IN_D2
2 IN_D3
3 IN_D4
4 IN_D5
5 IN_D6
6 IN_D7
7 IN_D8
8-15 Reserved
*Bit 0 is the least significant, low order bit.

CHMASK has a higher priority than BLKOPT.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 280 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string data store of


up to 32 characters that describes the MDO block. DESCRP tracks
TAGDSC, and is updated when TAGDSC is configured.

DESCRn Descriptor n (where n is 1 to 8) is a configurable, non-settable string of up


(n = 1 to 8) to 32 characters that describes the IN_Dn input. If BAD Alarming is con-
figured (BADOPT = 1), this descriptor is included in the BAD Alarm
message for the respective point.

279
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

DEVACK Device Acknowledge is a settable boolean output parameter that is used by


an operator to acknowledge device alarms in the device function block.
DEVACK is set by the CP270 when a device alarm is reported by the
FBM228 at either the ECB201 level or at the DCI block level. DEVACK
is cleared by operator action. The range is 0 to 1:
0 = Device Alarm is acknowledged.
1 = Device Alarm is unacknowledged.
DEVACK is different from UNACK (page 288). UNACK is used by the
operator to acknowledge process alarms in the DCI block. DEVACK is
used to acknowledge device alarms at the ECB201 or DCI block level.

NOTE
This parameter is not supported currently.

DVC_ID Device Identifier is a configurable, non-settable integer that provides the


device identifier of the H1 field device that contains the device function
block represented by the MDO block. It is set by the IEE configurator.
The FBM228 checks the corresponding value in the device resource block
to verify that there is a match between the block and the device.

DVCREV Device Revision is a configurable, non-settable long integer that provides


the revision level of the H1 field device that contains the device function
block represented by the MDO block. The FBM228 checks the corre-
sponding value in the device resource block to verify that there is a match
between the block and the device. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device. The IEE
configurator encodes the following data in DVCREV:
Bits 16-23 Bits 8-15 Bits 0-7
Device revision Minimum Device Description Common File Format
(DD) File Revision (CFF) File Revision

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table 8-8 lists the possible values of ERCODE for the MDO block, and
the significance of each value in this block.

Table 8-8. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS

280
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-8. Error Code Values (Continued)

ERCODE
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DECREC MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages. The range is 1 to 8 (default).

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. Table 8-9 shows the parameter format.

Table 8-9. ERROPT Parameter Format

Bit* Error Code


15 Other
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed

281
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Table 8-9. ERROPT Parameter Format (Continued)

Bit* Error Code


2 Device Needs Maintenance Now
1 Power-up
0 Out of Service
*Bit 0 is the least significant, low order bit.

FDATA1, File Data #1 and File Data #2 are settable multi-byte arrays that provide
FDATA2 configuration data for the device function block represented by the MDO
block.
This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 510 bytes.

FSOPTN Fault State Option is a configurable integer parameter that specifies speci-
fies the Fault State conditions and action to be taken by the CP and the
FBM for an output point in the corresponding device MDO function
block (Table 8-10).

Table 8-10. Fault State Options

Bit1 Description, when True


0 Assert Fault State if any IN_Dn Output is Bad.
2 Assert Fault State if control station-to-FBM communication
is lost (FBM option). This option is enabled only if Fault
State is enabled at the FBM level via the FSENAB parameter
in the ECB200 or ECB202.
1. Bit 0 is the least significant, low order bit.

FSOPTN is independent of the FSTATE_TIME and FSTATE_VAL_Dn


parameters and the MO_OPTS options configured in the corresponding
device MDO function block. See Section 8.6.14.

FSTATE Fault State is a non-settable packed boolean output that contains the
FSTATE_STATUS parameter of the device function block, which shows
the Fault State of each channel. Table 8-11 shows the parameter format
for MDO and the device function block parameters.

Table 8-11. Format of the Fault State Status Parameters

Bit* Description When True


0 Fault State asserted for channel 1
1 Fault State asserted for channel 2

282
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-11. Format of the Fault State Status Parameters (Continued)

Bit* Description When True


2 Fault State asserted for channel 3
3 Fault State asserted for channel 4
4 Fault State asserted for channel 5
5 Fault State asserted for channel 6
6 Fault State asserted for channel 7
7 Fault State asserted for channel 8
*Bit 0 is the least significant, low order bit.

FSTIME Fault State Time is a configurable, downloadable, real value used to specify
the FSTATE_TIME parameter of a device function block, which is the
time in milliseconds a fault must persist before the Fault State is asserted
for the affected output. Refer to Section 8.6.14.

FSV_Dn Fault State Value n (where n is 1 through 8) is a configurable, download-


(n = 1 to 8) able, non-settable integer value used to specify the FSTATE_VAL_Dn
parameter of the device function block. Refer to Section 8.6.14.

IN_Dn Discrete Input n (where n is 1 through 8) is a short integer output that


(n = 1 to 8) contains the value of the IN_Dn parameter value to be sent to the device
function block.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm
generation inhibit requests for each type of alarm configured in the block.
Table 8-12 shows how the bits are used by the MDO block.

Table 8-12. INHALM Parameter Format

Boolean
Bit Description, Connection
Number* When True (B16 to B1)
8 Inhibit Channel 1 BAD Alarm INHALM.B8
9 Inhibit Channel 2 BAD Alarm INHALM.B7
10 Inhibit Channel 3 BAD Alarm INHALM.B6
11 Inhibit Channel 4 BAD Alarm INHALM.B5
12 Inhibit Channel 5 BAD Alarm INHALM.B4
13 Inhibit Channel 6 BAD Alarm INHALM.B3
14 Inhibit Channel 7 BAD Alarm INHALM.B2
15 Inhibit Channel 8 BAD Alarm INHALM.B1
*Bit 0 is the least significant, low order bit.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message

283
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

reporting; the alarm handling and detection functions are determined by


the INHOPT setting.

INHOPT Inhibit Option is a configurable, non-settable, non-connectable short


integer parameter that specifies how the block responds when alarms from
the block are inhibited (Table 8-13).

Table 8-13. Alarm Inhibit Options

Value Action Taken When an Alarm is Inhibited


0 Disables alarm messages but does not disable alarm detection.
1 Disables both alarm messages and alarm detection. If an alarm
condition exists at the time the alarm transitions into the inhib-
ited state, the alarm indicator is cleared.
2 Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges return-to-normal messages.
“Into alarm” messages can be acknowledged by explicitly set-
ting UNACK False.
3 Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly set-
ting UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table 8-14
shows how parameter is used with the MDO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
CH8 B1
CH7 B2
CH6 B3
CH5 B4
CH4 B5
CH3 B6
CH2 B7
CH1 B8
B9

Table 8-14. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) When True (B32 to B1)
24 Channel 1 alarms inhibited INHSTA.B8
25 Channel 2 alarms inhibited INHSTA.B7
26 Channel 3 alarms inhibited INHSTA.B6
27 Channel 4 alarms inhibited INHSTA.B5
28 Channel 5 alarms inhibited INHSTA.B4

284
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-14. INHSTA Parameter Format (Continued)

Bit Boolean
Number* Description, Connection
(0 to 31) When True (B32 to B1)
29 Channel 6 alarms inhibited INHSTA.B3
30 Channel 7 alarms inhibited INHSTA.B2
31 Channel 8 alarms inhibited INHSTA.B1
*Bit 0 is the least significant, low order bit.

INST_n IN_Dn Status (where n is 1 through 8) is a non-settable packed boolean


(n = 1 to 8) output that contains the IN_Dn.Status parameters of the device function
block. Refer to Section 8.6.7 for information on the device function
block .Status bits.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up
to 25 characters (12 for <local_compound_name>, 1 for the
colon, and 12 for the <ecb_name>).

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the display task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a

285
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

new LOCKRQ is accepted, and a new ownership workstation identifier is


written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block, immediately
below the faceplate.

MAN_ID Manufacturer Identifier is a configurable, non-settable long integer that


provides the Manufacturer Identifier of the H1 field device that contains
the device function block represented by this block. The FBM228 checks
the corresponding value in the device resource block to verify that there is
a match between the block and the device.

MODE_A Actual Mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device func-
tion block.

MODE_N Normal Mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Normal parameter of the associated
device function block.

MODE_P Permitted Mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Target parameter of the associated
device function block.
The AUT_SW and OOS_SW can be used to change the MODE_T
parameter and thus the MODE_BLK.Target parameter in the device func-
tion block.

MOOPTS Multiple Output Options is a configurable, downloadable, non-settable,


packed boolean value that configures the device function block
MO_OPTS parameter to specify the Fault State actions and restart usage
for each output channel in the device. Table 8-15 shows the parameter
format for MDO and the device Function block.

Table 8-15. Format of the Multiple Output Options Parameters

Bit* Option Set When True


0 Fault State value for channel 1
1 Fault State value for channel 2
2 Fault State value for channel 3
3 Fault State value for channel 4
4 Fault State value for channel 5
5 Fault State value for channel 6

286
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-15. Format of the Multiple Output Options Parameters

Bit* Option Set When True


6 Fault State value for channel 7
7 Fault State value for channel 8
8 Use Fault State value on RESTART for channel 1
9 Use Fault State value on RESTART for channel 2
10 Use Fault State value on RESTART for channel 3
11 Use Fault State value on RESTART for channel 4
12 Use Fault State value on RESTART for channel 5
13 Use Fault State value on RESTART for channel 6
14 Use Fault State value on RESTART for channel 7
15 Use Fault State value on RESTART for channel 8
*Bit 0 is the least significant, low order bit.

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the MDO block is initial-
ized, the block updates the configurable parameters of the function block
matched to the MDO block by the configured index (BLKNDX). The
NAME parameter is used to set the Block Tag of the device function
block.

OOS_SW Out of Service Switch is a settable output used to set the parameter
MODE_T, and thus MODE_BLK.Target in the associated device function
block, to Out of Service.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second

287
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Period Length Period Length


*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with
a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,
or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm:
0 = No alarm
8 = Bad I/O alarm.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


MDO block is to be simulated. When SIMOPT= 1 (True), there is no
output to the device function block, and the status and value of the
IN_Dn parameters are not recovered from the field. The simulated behav-
ior of the block reflects the operational mode of the block (MODE_A).

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


specifies the TAG_DESC parameter of the associated device function
block. Changes to TAGDSC are copied to DESCRP.

TSTMPn Time Stamp n (where n is 1 through 8) contains the time (in milliseconds
(n = 1 to 8) since midnight) of the latest change in the IN_Dn parameter in the device
function block.
The time is from the FBM228 when a new value is sent to device function
block. However, when the block is in simulation (SIMOPT = 1), the value
is computed by the CP.

TYPE Type is the block type. When an MDO block is added to the control data-
base, the configuration editor sets TYPE to 36, causing the block type to
be identified as MDO in operator and system management displays.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the Current Alarms display.

288
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 for client/server connec-
tions for scanning scan the device function block view parameters. The
range is 0 to 2147483647 milliseconds; the default is 10000.

8.5 Device Function Block Description


This section describes the FOUNDATION fieldbus multiple discrete output device function block,
and includes a block schematic, a brief description of the block’s standard parameter set, and a
table showing the mapping between the I/A Series system MDO block parameters and the device
function block parameters.

8.5.1 Device Block Operation


The FOUNDATION fieldbus multiple discrete output function block processes up to eight setpoint
inputs from another block or an external source received at IN_Dn, and outputs the values to a
field device (Figure 8-1). The CHANNEL parameter specifies the transducer block channel of the
equipment to receive the output.

IN_D1
IN_D2
IN_D3 Output Snap
IN_D4 to CHANNEL
Block
Transducer
IN_D5 Algorithm
Block
IN_D6 Inputs
IN_D7
IN_D8

Figure 8-1. Device MDO Function Block Schematic

8.5.1.1 Mode
The device MDO block supports the following modes:
♦ Auto - In Auto, the block output reflects IN_Dn.
♦ OOS - When the mode is Out of Service, the block is not processed, the output
channel is maintained at the last value, and the status of IN_Dn is set to BAD.
♦ LO - Local Override is set when the resource block has been placed in LO or a Fault
State is active. In LO, the output of the block does not respond to IN_Dn.

8.5.1.2 Fault State


The MDO block has two faultstate options, which are set individually for each channel in the
MO_OPTS parameter:
♦ Fault State on Restart sets each IN_Dn parameter to a specified value when the device
is recycled because of a loss of power or for some other reason. The value is specified
in parameters including FSTATE_VAL_Dn.

289
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

♦ Fault State to Value sets each IN_Dn parameter to a specified value if the block has not
received a value for output from its configured source within the time specified in
FSTATE_TIME. As with the restart option, the value is specified in
FSTATE_VAL_Dn.
In the case of both options, the device detects the condition and takes the fault state action.

8.5.2 Parameter Transforms


Table 8-16 illustrates the mapping of I/A Series MOA parameters to parameters in the related
device function block. Many of the parameters are straightforward 1:1 mappings that are either
unidirectional or bidirectional. Other mappings require that a data value be re-formatted (or
transformed) to be intelligible in the I/A Series system.
From the point of view of the MDO block, the relationship with the device function block can
also be described in terms of sink and source connections:
→ Source-sink The MDO block parameter is the source for the corresponding func-
tion block parameter. Thus, changes to the MDO block parameter
are made to the device function block parameter. For example, when
the MDO block is initialized, the TAGDSC value is copied to the
device function block TAG_DESC parameter.
← Sink-source The MDO block parameter value is updated by the corresponding
device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual function block mode visible to the control system.
↔ Bidirectional Changes to the MDO block parameter are made to the device func-
tion block parameter and vice versa. For example, when the MDO
block is initialized, its MODE_T parameter value is written to the
corresponding device block parameter, MODE_BLK.Target, to con-
figure the block’s target mode. Subsequently, the MODE_BLK.Target
value is written back to the MDO block MODE_T parameter.

The arrow notation is used in the Table 8-16 descriptions of MDO parameter transforms. These
are presented in alphabetic order, arranged by the I/A Series MDO block parameter names.

Table 8-16. MDO Parameter Transforms

MDO Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SW → 1:
Set MODE_T (request) = AUTO
Set OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP-FBM communication is failed or FBM is Off-Line

290
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-16. MDO Parameter Transforms (Continued)

MDO Parameter Device Function Block Parameter


BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.MA=1 ← MODE_BLK.Actual.AUTO
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← IN_Dn.Status.Bad (Bits 6-7=0)
CHANNL ↔ CHANNEL
FSTATE ← FSTATE_STATUS
FSTIME ↔ FSTATE_TIME
FSV_Dn (n = 1 to 8) ↔ FSTATE_VAL_Dn (n = 1 to 8)
IN_Dn (n = 1 to 8) IN_Dn (n = 1 to 8), in Auto mode is not simulating
IN_Dn.value (request) → IN_Dn.Value (request)
IN_Dn.value (actual) ← IN_Dn.Value (actual)

IN_Dn.status.LHI ← IN_Dn.Status.Limited Hi (Bit 0)


IN_Dn.status.LLO ← IN_Dn.Status.Limited Lo (Bit 1)
IN_Dn.status.ERR ← IN_Dn.Status.Uncertain (Bits 6-7 = 1)
IN_Dn.status.BAD ← IN_Dn.Status.Bad (Bits 6-7 = 0)
or there is an CP-FBM communications failure
or the H1 device is failed or disabled

IN_Dn.status.OOS ← IN_Dn.Status.Bad (Bits 6-7 = 0) and Susbtatus.OOS (bits 2-7 =


7)
or the compound is Off
or the FBM228 is Off-line or DCI is Not Ready
or the H1 device is failed or disabled
or there is an CP-FBM communications failure
or the DCI_COMM_DATA.connect_status <= 0
INST_n (n = 1 to 8) IN_Dn (n = 1 to 8)
INST_n.value ← IN_Dn.Staus
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ← MODE_BLK.Normal
MODE_P ← MODE_BLK.Permitted
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
MOOPTS ↔ MOOPTS
NAME → Function Block Tag

291
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Table 8-16. MDO Parameter Transforms (Continued)

MDO Parameter Device Function Block Parameter


OOS_SW MODE_BLK.Target
When OOS_SW is set =1:
Set MODE_T (request) = OOS
Set AUT_SW=0
Write MODE_T (request) to FBM
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC ↔ TAG_DESC
Note: Changes to TAGDSC are copied to DESCRP.

8.6 MDO Block Functions


With each execution, the MDO block receives up to eight setpoint values from I/A Series system
control blocks, such as an MDI block, and writes a value and status to each device function block
IN_Dn parameter selected in the CHMASK parameter. The MDO block then reads back the
value and status of the IN_Dn parameters.
The MDO block supports the device block Fault State functions and Mode Machine.

8.6.1 Device Function Block Connection


The MDO block interfaces with a multiple discrete output block operating in an I/O subsystem,
remote indicator, or similar device on an H1 segment hosted by an FBM228. The configured
parameter IOM_ID of the MDO block specifies the ECB201 (the device ECB) that represents
the target device. The ECB201 PARENT parameter identifies the FBM228’s equipment control
block (ECB200 or ECB202).
The path to the device block is completed as follows. When the MDO block is configured using
IEE, the device function block is selected in a browser which displays the device function blocks
based on the device description in the device ECB. If the connection is not made via the browser,
the connection is made based on the MDO block BLKNDX parameter.
The MDO block CHANNL parameter is used to configure the device block CHANNEL param-
eter and thus identify the I/O subsystem to receive the outputs. Refer to the device documenta-
tion for the appropriate channel assignment.
CHMASK parameter is used to specify which of the eight device block inputs are to be processed
by the MDO block. CHMASK does not affect any settings in the device function block.
To assign function blocks to their device, refer to “Assign the Function Blocks to a Device” in
InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA).

8.6.2 Device Configuration Parameters


The MDO block enables you to configure selected parameters in the corresponding device
function block and manage the configuration from the I/A Series system. When you deploy the
MDO block to the control station, and then download the FBM228, parameter values in the
MDO block update parameters in the linked device function block.

292
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-17 lists the device function block parameters and the MDO block parameters used to
configure them. For the I/A Series block, the table includes both the six-character parameter name
that is used in block detail displays and parameter labels which more closely resemble the FOUN-
DATION fieldbus parameter names. Use the six-character parameter name when connecting
parameters to a process display.

Table 8-17. MDO Block Configuration Parameters

Configured with I/A Series MDO Block Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label
CHANNEL CHANNL Channel
FF_BLOCK.BLOCK_TAG NAME Name
FSTATE_TIME FSTIME Fstate_Time
FSTATE_VAL_Dn FSV_Dn Fstate _Val
MO_OPTS MOOPTS Multiple_options
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc

The following are suggested and required MDO parameter settings:


♦ Configure MODE_P to include at least Auto and Out of Service. Other modes are
optional.
♦ Set MODE_T to Auto.
♦ Configure MO OPTS to include FS to Value and Use FS on Restart for each channel
(recommended).
♦ Set the Fault State option in the resource block’s FEATURE_SEL parameter.

8.6.3 Block Validation


The MDO block initializes when any of these events occur:
♦ The block is installed or reconfigured via the IEE control configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.
When the I/A Series MDO block initializes, the following block validation test is performed:
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Auto or
Out-of-Service, the block is marked undefined (BLKSTA.UDEF=1) with the error
code parameter (ERCODE) set to “W76 - INVALID FF MODE
CONFIGURATION”.
If the FBM simulation is not used (SIMOPT=0), the following validation tests are performed:
♦ If the MDO block is installed prior to the installation of the ECB201 block, it is
marked undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE)

293
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

set to “W54 - ECB DOES NOT EXIST”. In this case, the MDO block configuration
is restarted and re-validated automatically when the ECB201 is installed.
♦ An attempt is made to connect the MDO block to the ECB201 specified in the
IOM_ID parameter. The DCI connection address (i.e., the BLKNDX parameter in
the MDO block) is used in a connect message to establish a block connection in the
FBM228. The CHMASK parameter is embedded in the connect message to indicate
which of the 1-8 input channels are to be enabled.
♦ If the block data connection cannot be resolved due to a lack of configuration infor-
mation, a block connection is made in the FBM, the connection status is marked
Unresolved, and one of the following error strings is stored in the block ERCODE
parameter:
♦ “W62 - UNRESOLVED CONNECTION”
♦ “W77 - FIELDBUS COMMUNICATIONS FAULT”
♦ “W78 - INVALID FUNCTION BLOCK”
♦ “W80 - FIELDBUS DEVICE NOT FOUND”
♦ “W82 - FF CONFIGURATION IN PROGRESS”
(In these cases, the I/A Series MDO block is defined, but the output values are
marked OOS.)
♦ “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the MDO block is defined, and the index of the invalid function block
parameter is stored in the CFGERR parameter.)
♦ If the block data connection cannot be made for any other reason, the FBM rejects the
connection request and one of the following error strings is stored in the ERCODE
parameter to indicate the reason for the connection error:
♦ “W65 - INVALID POINT ADDRESS”
♦ “W66 - DUPLICATE CONNECTION”
♦ “W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS”
♦ “W68 - INVALID DEVICE CONNECTION”
♦ “W69 - INVALID POINT CONNECTION”
♦ “W74 - FF FUNCTION BLOCK DDITEM MISMATCH”
♦ “W75 - FF FUNCTION BLOCK DDMBR MISMATCH”
♦ “W76 - INVALID FF MODE CONFIGURATION”
♦ “W79 - INVALID PARAMETER INDEX”
♦ “W83 - INVALID FF PARAMETER CONNECTION”
♦ “W84 - INVALID FF PARAMETER TYPE”
♦ “W85 - INVALID CONNECTION TYPE”
♦ “W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH”
(In these cases, the I/A Series MDO block is undefined.)
♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the

294
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

I/A Series MDO block is undefined with ERCODE set to “W43 - INVALID
PERIOD/PHASE COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the
I/A Series MDO block is undefined with ERCODE set to “W81 - INVALID PAR-
ENT DCI ECB PERIOD/PHASE”.
If there are no configuration errors when the I/A Series MDO block is installed, the block is
marked defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the compound con-
taining the block is turned on, the block also initializes and starts running automatically.

8.6.4 Block Initialization


When the I/A Series MDO block initializes, the following are performed:
♦ All alarm status parameters (ALMSTA, INHSTA, CRIT, PRTYPE, UNACK) are
cleared.
♦ The Actual mode parameter (MODE_A) is set to Initialization Manual (IMAN) in
the I/A Series MDO block.
♦ The Target mode parameter (MODE_T) is set to only one of the following states, in
order, if multiple bits are set: Auto, OOS.
♦ The status of all IN_D1-IN_D8 parameters not specified in CHMASK are set to
BAD and OOS.
♦ The Timestamps for each of the 1-8 inputs are updated.
If not simulating (SIMOPT=0), the following are performed:
♦ The Target mode is sent to the device MDO function block.
♦ If installing the block, or if rebooting and not a Warm Restart, the configuration
parameters are downloaded to the device MDO function block.

8.6.5 Block Modes


The MDO block provides interactive support of the MODE_BLK function block parameter. The
Target, Permitted, Normal, and Actual modes are provided as separate DCI block parameters.
The configuration of the Target, Permitted, and Normal modes are supported. These parameters
are downloaded to the device MDO function block when the I/A Series MDO block initializes.
The Target mode is changeable through a group of settable Boolean mode switches provided in
the I/A Series MDO block. These mode switches, AUT_SW, and OOS_SW, allow the block
mode to be changed to Auto or Out-of-Service respectively.
♦ Logic in the CP270 prevents more than one switch to be set at a given time. If more
than one switch is set during the same block cycle, only the last switch setting is
honored.
♦ Once set, a mode switch remains set only until the Target mode change is sent to the
FBM228 or until another mode switch is set. At that time, the mode switch is cleared.
♦ The mode switch setting will be mapped onto an equivalent Target mode setting sent
to the FBM228.
The Target mode is a shadow parameter updated from the MODE_BLK function block parame-
ter read back during input scanning of the FBM228.

295
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

When the Actual, Permitted, Target, or Normal modes change in the device MDO function
block, the corresponding DCI mode parameters are updated automatically from the MODE_BLK
function block parameter. In addition, the Actual mode is mapped onto equivalent BLKSTA
parameter bits.
When the Actual block mode is Auto, the following additional functions are performed:
♦ Requested changes to the IN_D1-IN_D8 parameters by the I/A Series user or by a
source connection are saved in the DCI block and written to the device MDO func-
tion block via the FBM228.
♦ The actual IN_D1-IN_D8 input parameter values and status are updated from read-
back data received in the reply to a read message. The CHMASK parameter is used to
determine which values to process.
♦ Downloading of configuration parameters that have changed since the previous block
cycle.
♦ Updating of the Fault State (FSTATE) parameter from the View data.
♦ Other View data parameters are updated, if any changes in these parameters have
occurred since the previous block cycle.
♦ Block Error (BLKERR) processing begins.
♦ External configuration changes to function block parameters are propagated.
♦ Configuration Error (CFGERR) processing begins.
♦ If BADOPT=1, Bad Alarming of the inputs is performed.
The Actual block mode (MODE_BLK.Actual) is provided in the I/A Series MDO block in two
forms:
♦ The Actual mode is stored in the MODE_A output parameter.
♦ The Actual mode also is mapped onto equivalent bits in the BLKSTA block status
parameter.
♦ The OOS state is mapped onto the OOS value status bit of the BLKSTA parameter.
♦ The IMAN state is mapped onto the BLKSTA.TRK status bit.
♦ The LO state is mapped onto both the BLKSTA.TRK and BLKSTA.LO status bits.
♦ The AUTO state sets BLKSTA.MA=1.

8.6.6 I/A Series Parameter Status


The status of the device MDO function block parameters are provided in the I/A Series MDO
block in two forms:
♦ The status of each FF function block parameter is available as a separate I/A Series
MDO block parameter.
♦ The status of each FF function block parameter also is mapped onto equivalent fields
in the value record status of the corresponding I/A Series MDO block parameter.
♦ The Quality field (Bits 6-7) are mapped onto the BAD and ERR status bits.
♦ The Substatus field (Bits 2-5) is ignored, except for the case when the Quality is Bad
and the Substatus is OOS. In this case, the OOS status bit is set in the DCI MDO
block parameter.

296
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

♦ The Limited High (Bit 0) and Limited Low (Bit 1) fields are mapped onto the LHI
and LLO status bits.

8.6.7 Device Parameter Status


The device function block IN_Dn parameters have both a value and a status, which are sourced
from another device. Typically, the input is from an MAI block, in which case the status of
IN_Dn is the status of the MAI block OUT_n parameter.
The status is contained in an 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits.
The status is read into the MDO block parameter, bit for bit. The default displays for the MDO
block shows the converted status parameter so that the value need not be decoded. Table 8-18
shows how the status byte is formatted.

NOTE
The .SubStatus bits in multiple discrete output blocks vary with the specific I/O
subsystem or multi-output device, and may not be the same as the standard
FOUNDATION fieldbus bit assignment usage in other device function blocks.

The Status bit format is shown in Table 8-18.

Table 8-18. Device Parameter Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 Refer to the device documentation
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table 8-19 shows the usage of the Substatus bits, which varies depending on which .Quality bits
are set.
Table 8-19. Device Parameter Substatus

Bits 2-5 = SubStatus Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced by a link object within the
resource.

297
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Table 8-19. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus Description


3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.
4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).

298
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

Table 8-19. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus Description


2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

8.6.8 Time Stamping


The I/A Series MDO block provides timestamps for each of its IN_D1-IN_D8 input parameters.
These timestamps are stored in the parameters TSTMP1-TSTMP8.
The FBM228 does not provide timestamps for the MDO block connection.
Each block cycle, the CP270 updates the timestamp for any of the IN_D1-IN_D8 parameters
when the block initializes and when the parameter value changes, i.e. the new value differs from
the previous value stored in the block.
The CHMASK parameter is used to determine which parameters to process.
The current eight (8) byte UTC timestamp maintained by the CP270 are stored in the block for
each of the IN_D1-IN_D8 parameters. The CP270 also calculates this timestamp in four byte
milliseconds since midnight and stores this value in the respective TSTMPn parameter.
When simulation mode is used, all timestamps continue to be provided by the CP270.

8.6.9 Input Connections


The CP270 supports connections to the inputs in the I/A Series MDO block from connectable
input or output parameters of any I/A Series control or I/O block. These inputs are updated each
block cycle from data in the I/A Series source block parameter.
The CP270 propagates the BAD, OOS, and ERR status of these input parameters to their corre-
sponding device function block parameters by writing the status to the FBM228 when a change
occurs. The FBM228 maps the BAD or OOS status into the Bad status of the function block
input parameter (IN_Dn.Status Bits 6-7=0) and it will map the ERR status into the Uncertain sta-
tus of the function block parameter (IN_Dn.Status Bits 6-7=1).
When the Update Source of an input connection is not an FF function block parameter, the
BlockName specified in the connection is the name of the I/A Series block; the ParameterName
is the 1-6 character name of the parameter in the I/A Series block.

299
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

The CP270 also supports connections to specific inputs in the MDO blocks from parameters
contained in device function blocks mapped to any standard I/A Series control or I/O block.
These inputs are updated each block cycle from data in the function block parameter; the data
contained in the specified I/A Series source parameter will not be used. The inputs of this type are
listed in Table 8-20 below.
When the source of an input connection is a function block parameter, the I/A Series block con-
nection is made by the CP270, and the source BlockName and ParameterName are extracted
from the connection and appended to a connect message. This message is sent to the FBM228 to
establish a fieldbus connection to the function block source parameter.
When the source of an input connection is a function block parameter, the BlockName is the
TagName of the FF function block, which is the same as the name of the source I/A Series block.
The ParameterName is the 1-6 character name of the parameter in the source I/A Series block for
those connections listed in Table 8-21 below. In these cases, the name of the I/A Series block
parameter is converted to the equivalent function block parameter index by the CP270 prior to
appending it to the connect message. In all other cases, the ParameterName must be configured
to be the parameter index of the function block parameter.
If the fieldbus connection cannot be made due to an invalid BlockName or ParameterName, the
ERCODE parameter in the block is set to the following text and the block is undefined:
“W83 - INVALID FF PARAMETER CONNECTION”

Table 8-20. MDO Input Connections

MDO Input Parameter(s) Connection Source Update Source


IN_D1 - IN_D8 I/A Series control block, I/O I/A Series source block parameter
block, or DCI block
FF parameter in DCI block FF function block parameter
Any other input I/A Series control block, I/O I/A Series source block parameter
block, or DCI block

Table 8-21. Standard FF Block Parameter Connections

Input Parameter Source Parameter


Block Type Parameter Block Type Parameter Name Parameter Index
MDO IN_D1 - IN_D8 DI OUT_D 8
MDI OUT_D1 - 8-15
OUT_D8

8.6.10 Block Alarming


The MDO block performs alarm functions consistent with standard CP270 alarming. This
includes the following types of process alarms:
♦ Bad Alarming of each of the IN_D1-IN_D8 outputs. The CHMASK parameter pro-
vides a bitmap that used to determine which outputs to process.
♦ Informational messages of block errors (BLKERR) reported by the MDO function
block BLOCK_ERR parameter.

300
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

♦ Informational messages of function block configuration errors (CFGERR).


The device function block alarm detection, alarm events, alarm messaging, and associated param-
eters provided by the field device are not supported in this MDO block.

8.6.11 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter is performed as
follows:
♦ For every condition specified in ERROPT, a corresponding Informational message is
sent to the ERRGRP alarm group when the condition occurs. The UNACK parame-
ter and the corresponding ALMSTA.UNACK bit also are set. ERROPT has the same
format as BLKERR (Table 8-4 on page 276).
♦ One of the messages listed in Table 8-22 is generated.

Table 8-22. Block Error Messages

ERROPT Bit Message Text


Bit 0 FF Block Error: Out-of-Service
Bit 1 FF Block Error: Power Up
Bit 2 FF Block Error: Maintenance Needed Now
Bit 3 FF Block Error: Readback Check
Bit 4 FF Block Error: Lost NV Data
Bit 5 FF Block Error: Lost Static Data
Bit 6 FF Block Error: Memory Fail
Bit 7 FF Block Error: Output Fail
Bit 8 FF Block Error: Input Fail
Bit 9 FF Block Error: Maintenance Due Soon
Bit 10 FF Block Error: Fault State Active
Bit 11 FF Block Error: Local Override
Bit 12 FF Block Error: Simulation Active
Bit 13 FF Block Error: Link Configuration Error
Bit 14 FF Block Error: Block Configuration Error
Bit 15 FF Block Error: Other (Undefined) Error

8.6.12 Configuration Error Processing


When a device block configuration parameter cannot be downloaded into the field device, the
parameter index is stored in the CFGERR parameter and the following informational message is
generated:
“FF CFGERR in Parameter nnnnnnnn”
where: nnnnnnnn = ASCII name of the parameter indicated by the index in CFGERR

8.6.13 Bad Alarm Detection


Bad alarm detection is supported when the Bad alarm configuration option (BADOPT) is set.
Bad alarm status information is generated when any point is bad. This philosophy is consistent
with the handling of state alarms in the BLNALM block.

301
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Bad alarm messages are generated for each point independently when its status is bad (i.e.,
IN_Dn.BAD, where n=1-8).
When the point value becomes bad, a bad alarm message is created and sent to all devices in the
bad alarm group specified by the BADGRP parameter. This message contains a “BAD_n” (if
IN_Dn) text string to identify the appropriate point. This message also contains the respective
DESCRn point descriptor, the descriptive text in the BADTXT parameter, and the loop identifier
in the LOOPID parameter.
When the point value becomes good, a return-to-normal message is generated and sent to all
devices in the bad alarm group.
When any point value is bad, the BAD bit is set in the alarm status parameter (ALMSTA.BAD).
The UNACK parameter and the ALMSTA.UNACK bit are set. The CRIT parameter and ALM-
STA.CRIT field are set to the BADPRI parameter value, and the PRTYPE parameter and ALM-
STA.PRTYPE field are set to the Bad alarm type.
When all point values have returned to good status, BAD, CRIT, PRTYPE and their correspond-
ing fields in ALMSTA are cleared.
The UNACK parameter and the ALMSTA.UNACK bit are cleared in these cases:
♦ When the alarm is acknowledged at the compound level, by setting the compound
UNACK=0, or at the block level, by setting the block UNACK=0.
♦ When all point values return to normal, if INHOPT is set appropriately.
♦ When the block is shut down.
When UNACK is cleared, an Alarm Acknowledge message is generated and sent to all devices in
the bad alarm group.
Alarm Inhibiting/Disabling is supported using a combination of the compound CINHIB param-
eter and the INHOPT, INHIB, and INHALM parameters in the MDO block, to allow the bad
alarm messages to be inhibited and/or the alarm detection to disabled dynamically.
The INHALM parameter can be used to inhibit or disable bad alarming selectively for any group
of the 1-8 points.
When Bad alarming is inhibited or disabled, an Alarm Disable message is generated and sent to all
devices in the alarm group. If the Alarm is unacknowledged, an Alarm Acknowledge message also
is sent to these devices. The ALMSTA.INHIB bit is set, and the appropriate INHSTA.BAD bits
are set.
When Bad alarming is uninhibited or enabled, an Alarm Enable message is generated and sent to
all devices in the alarm group. The appropriate BAD bits in the INHSTA parameter are cleared,
and the ALMSTA.INHIB bit is cleared if all channels are uninhibited or enabled.
The Alarm Reprioritization and Alarm Message Regeneration (using AMRTIN) enhancements
also are supported in this MDO block. Refer to the Control Processor 270 (CP270) Integrated Con-
trol Software Concepts (B0700AG) for details.

8.6.14 Fault State Handling


A Fault State Enable (FSENAB) option may be configured in an ECB200 or ECB202. This
option is downloaded in a message sent from the FCP270/ZCP270 when the FBM228 is reboo-
ted and when the configuration of the ECB200/202 is changed. It is used by the FBM to enable
or disable the logic to assert a fault state action to field device outputs automatically when a CP-
to-FBM communications loss is detected by the FBM.

302
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

A Fault State Delay (FSDLAY) value also must be configured in the ECB200/202. This value is
downloaded when the FBM is rebooted and when the configuration of the ECB200/202 is
changed. The fault state timer counts down and is reset to the FSDLAY value when the read or
write message is received.
Two distinct fault state options may be configured in the FSOPTN parameter in the MDO
block. These fault state options are downloaded into the FBM228 when the MDO block connec-
tion is established. The options are:
♦ FSOPTN Bit 2: 1= Assert Fault State upon loss of CP communication
♦ FSOPTN Bit 0: 1= Assert Fault State if Bad Output
The Fault State Timer (FSTIME) and Fault State Values (FSVAL_1-FSVAL_8) are downloaded
into the device function block when the MDO block initializes and any of these values is re-con-
figured.
If the FSENAB option is set and the Assert Fault State upon loss of CP communications option is
configured, FBM228 performs the following actions:
♦ The fault state timer counts down periodically between receipt of read and write mes-
sages. When either message is received for a device MDO function block, its failsafe
timer is reset to the FSDLAY value.
♦ If the fault state timer expires, the FBM sets the status of each of the IN_D1-IN_D8
function block parameters to BAD in the field device (IN_Dn.Status Bits 6-7=0).
♦ When the CP communications is restored, the failsafe timers are reset to full value
automatically by the first read or write message to each connection.
♦ If the fault state had been previously asserted by a request from the CP and the failsafe
condition still exists in the CP, the write message requests the BAD status to remain
set in the IN_D1-IN_D8 function block parameters. Otherwise, the write message
requests the status of these parameters to be set to Good Non-Cascade in the field
device (IN_Dn.Status Bits 6-7=2).
These actions are taken independent of the FSENAB option.
The FBM configuration does not establish the device Fault State behavior as that is determined by
options in the device function blocks. Different behaviors can be set for each device connected to
the FBM, and in the case of the multiple discrete output devices, for each channel.
The device Fault State options are designed primarily to deal with communication failures above
the device, while working in concert with ECB options. Enabling Fault State is effective under
two external conditions:
♦ When Fault State is asserted by the connected FBM
♦ When communications to the device are lost and the device MDO block mode is
Auto.
The actual Fault State behavior taken by the device function block is specified in the following
I/A Series system MDO block parameters (Table 8-23).

303
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Table 8-23. Fault State Parameters in the Device MDO Function Block

Parameter Description
MOOPTS Configures the device function block MO_OPTS parameter to enable/dis-
able two Fault State options for each output (IN_Dn).
♦ Use Fault State on Restart n: Selecting this option causes the IN_Dn
output to go to the value specified in FSTATE_VAL_Dn on a device
RESTART. If this option is not selected and the device can go to its tar-
get mode upon RESTART, the last saved setpoint is used for generating
the Fault State position.
♦ Fault State to Value n: When this option is selected, the block uses the
value specified for output n in FSTATE_VAL_Dn. When the option is
not selected, the last saved setpoint is used.
FSV_Dn Configures FSTATE_VAL_Dn in the device function block to specify the
value that is asserted when one of the faultstate options is invoked for the
channel.
FSTIME Configures FSTATE_TIME in the device function block to set the period
that the fault condition must last before the block asserts the specified value.
A Fault State action does not occur until the FSTATE_TIME interval has
expired.

8.6.15 Block Shutdown


The MDO block shuts down when any of these events occur:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ The ECB201 connected to the block is deleted.
♦ The MDO block is deleted.
When block shutdown occurs, the following actions are taken:
♦ If any Bad alarms are active, an Alarm Disable message is issued to all devices in the
bad alarm group. If the Bad alarms are unacknowledged, an Alarm Acknowledge mes-
sage also is sent to these devices.
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, UNACK) are cleared.
If not simulating (SIMOPT=0) and the compound is off, one of the following actions is taken:
1. If the compound is off, one of the following actions is taken:
a. If the FF_OOS_OPT bit (Bit 4: 0x0010) is set in the Station block CFGOPT
parameter, the following additional actions are taken:
♦The actual mode parameter (MODE_A) is set to OOS.
♦ A write message is sent to the FBM228 with both the OOS and IMAN bits
set in the Target mode. The IMAN bit is set to indicate to the FBM228 that
the compound is off.
♦ Otherwise, a write message is sent to the FBM228 with only the OOS bit set
in the Target mode.
b. Otherwise, one of the following actions is taken:

304
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

♦A write message is sent to the FBM228 with both the current state and the
IMAN bits set in the Target mode. The IMAN bit is set to indicate to the
FBM228 that the compound is off.
♦ Otherwise, if the FSOPTN is set, a write message will be sent to the FBM228
to drive the IN_D1-IN_D8 parameters to their fault state values. The FBM
sets the status of the IN_D1-IN_D8 parameters to BAD (IN_Dn.Status Bits
6-7=0) in the field device.
2. Otherwise, if the FSOPTN is set, a write message is sent to the FBM228 to drive the
IN_D1-IN_D8 parameters to their fault state values. The FBM sets the status of the
IN_D1-IN_D8 parameters to BAD (IN_Dn.Status Bits 6-7=0) in the field device.

8.6.16 Simulation
The I/A Series MDO block SIMOPT parameter enables simulation of output to and readback
from the corresponding multiple discrete output device function block. This feature can be used
to test control schemes requiring discrete outputs without the actual FBM228 hardware connec-
tions.
When SIMOPT= 1 (True), the value contained in IN_Dn is not written to the H1 device and the
value and status of IN_Dn are not recovered from the device function block. However, the
IN_Dn and INST_Dn parameters are updated as if the value and status had been read back from
the device.
When SIMOPT= 1, the following functions are performed:
♦ The actual values and status of the IN_Dn inputs are updated from the requested val-
ues and status each block cycle when the Actual block mode is Auto. The CHMASK
parameter determines which values to process.
♦ The INSTn input status parameters is set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (AUT_SW, MAN_SW, or
OOS_SW) immediately update target mode parameter (MODE_T), and the actual
block mode (MODE_A) tracks MODE_T each block cycle.
♦ If BADOPT=1, Bad Alarming of the inputs is performed.
When SIMOPT = 1, the following functions are not performed:
♦ Downloading of configuration parameters
♦ Updating of View data parameters
♦ Block Error (BLKERR) processing
♦ External configuration changes to function block parameters
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA) or Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for
instructions on conducting control simulations from control station.

8.6.17 Block States


The DCI blocks transition through the states detailed in Table 8-24 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 277).

305
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

Table 8-24. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

306
8. MDO - Foundation™ fieldbus Multiple Discrete Output B0700EC – Rev B

8.7 MDO Block Application Example


The MDO block can be used in any control block configuration, in any compound except the
Station compound and the Primary ECB compound, in any CP270. It only can be mapped to
any device MDO function block in a field device hosted by an FBM228, but not to any other
device function block type or to any function block parameter.
Each field device connection must be specified by configuring the name of the ECB201 in the
IOM_ID parameter. The device MDO function block connection must be specified by configur-
ing the MDO function block index in the BLKNDX parameter.

NOTE
Since the device MDO function block does not support cascade initialization, it is
strongly recommended that the I/A Series MDO block be used only in non-control
configurations. It should not be used to drive actuators in the field device.

Figure 8-2 illustrates an example of the MDO block’s use in applications.

Parent ECB200/202

Child ECB201 Child ECB201

PARENT PARENT

IOM_ID
NAME

MDI Block CALCA Block MDO Block

PV_D1 OUT_D1 BI01

PV_D8 OUT_D8 BI08


BO01 IN_D1
BO02 IN_D2
BO03 IN_D3
BO04 IN_D4
IOM_ID BO05 IN_D5
BO06 IN_D6
NAME BO07 IN_D7
BO08 IN_D8
MDI Block

PV_D1 OUT_D1 BI09

PV_D8 OUT_D8 BI16

Figure 8-2. Application Example with I/A Series MDO Block

307
B0700EC – Rev B 8. MDO - Foundation™ fieldbus Multiple Discrete Output

308
9. PIDFF – FOUNDATION™ fieldbus
PID Block
This chapter describes the I/A Series FOUNDATION™ fieldbus PID (PIDFF) block, which
interfaces the control system with a corresponding PID function block operating in a
FOUNDATION fieldbus H1 device.

9.1 Overview
FOUNDATION fieldbus PID (PIDFF) is a Distributed Control Interface (DCI) block that pro-
vides an interface between the control processor and a PID function block operating in a
FOUNDATION fieldbus H1 device. The PIDFF block is supported on the FCP270 and ZCP270
when the H1 device is connected to the control station by an FBM228. The PIDFF block is
configured using the InFusion Engineering Environment (IEE) as described in InFusion Enter-
prise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0 (B0750DA).

NOTE
The PIDFF block functionality described in this chapter is applicable only for
FBM228s with the software type (SWTYPE) of “128”.
All device PID function blocks are not functionally equivalent. Refer to the device’s
vendor documentation for more details.

9.2 Basic Operation


The PIDFF block integrates the corresponding device PID function block into the I/A Series sys-
tem. It is a “linked” block that acts as an interface to a device PID function block, instead of exe-
cuting a control algorithm itself. On initialization, user-configured values in the PIDFF block are
written to the configurable parameters in the device PID function block. During normal opera-
tion, the PIDFF block acquires the value and status of the PID block input and input parameters,
and makes these values available to other blocks in the I/A Series system.
In addition, the PIDFF block provides access to a variety of operational and diagnostic informa-
tion via client/server connections with the parameters that are included in the block view data of
the device block. The values read from these parameters are displayed in the block detail displays
and are available for connection to other I/A Series blocks.
Refer to “PIDFF Block Application Examples” on page 372 for examples of how this block is used
with device PID function blocks in applications.

9.3 Features
♦ Acquires the block’s primary output value and status for read-back to the control
system

309
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

♦ Accesses the parameters in the device PID function block’s views using change-driven
and periodic client/server connections
♦ Ensures that changes in the device PID function block’s process values and error con-
ditions are continuously available for display and connection to the control strategy
♦ Supports the device block Fault State handling
♦ Provides for the configuration of device block parameters from the I/A Series system
and management of the device configuration in the control database
♦ Enables users to set the block mode of the device PID function block to Remote Cas-
cade, Cascade, Auto, Manual, or Out of Service
♦ Provides detection and reporting for process alarms including Bad I/O, High/Low
Absolute, High-High/Low-Low Absolute, High-Low Deviation, and High-Low
Output
♦ Supports the calculation of a simulated output with gain, reset, and rate action within
the control station.

9.4 Block Parameters


The standard PIDFF block parameters listed in this section include those which determine the
block’s behavior in the control processor and those PIDFF parameters that are mapped to the
standard parameters in the device PID block. These parameters are available in I/A Series configu-
rators and displays.
When a PIDFF block is bound to a Device Description (DD), either during templating of the
device type or when a block instance is assigned to a specific device, the block acquires the
extended, or custom, parameters which the device manufacturer has added to its version of the
Foundation fieldbus PID block. These extended parameters are available for configuration and
display in Field Device Manager displays. The extended parameters are encapsulated in the
FDATA1 and FDATA2 parameters when the block is deployed to the control processor and
FBM228 so they can be downloaded to the device PID block.

Table 9-1. PIDFF Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE DCI block type short integer no-con/no-set 127 127 [PIDFF]
TAGDSC TAG_DESC1 string no-con/no-set 2 blanks 1to 32 chars
PERIOD DCI block period short integer no-con/no-set 1
PHASE DCI block phase integer no-con/no-set 0
LOOPID loop identifier string no-con/set 2 blanks 1to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0 to 1
IOM_ID ECB201 pathname string no-con/no-set 2 blanks any valid path
name <= 25
chars or ECB
block name <=12
chars
DDITEM DD Item ID long integer no-con/no-set 0x
800202B0

310
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-1. PIDFF Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DDMBR DD Member ID long integer no-con/no-set 0x00
UPDPER view update period long integer no-con/no-set 10000ms 0 to 2147483647
STRATG STRATEGY integer no-con/no-set 999 0-65535
STOPTS STATUS_OPTS packed b no-con/no-set 0 0 to 0x00FF
CTLOPT CONTROL_OPTS packed b no-con/no-set 0x0000 0-0xFFFF
BYPASS BYPASS short integer no-con/no-set 1 1 to 2
SHEDOP SHED_OPT short integer no-con/set 1 0-8
PVFTIM PV_FTIME real no-con/no-set 0.0
BALTIM BAL_TIM real con/set 0.0
GAIN GAIN real con/set 0.0
RESET RESET real con/set 10000.0
RATE RATE real con/set 0.0
MODE_N MODE_BLK.Normal short integer no-con/no-set 0x10 0 to 0xFF
MODE_P MODE_BLK.Permitted short integer no-con/no-set 0x79 0 to 0xFF
MODE_T MODE_BLK.Target short integer no-con/no-set 0x10 0 to 0xFF
SUPOPT supervisory option short integer no-con/no-set 0 0, 1 or 3
SUPGRP supervisory group short integer no-con/no-set 0 0 to 7
INITSE initialize SE mode short integer no-con/no-set 0 0 to 2
FLBOPT fallback option short integer no-con/no-set 0 0 to 3
FSOPTN failsafe option short integer no-con/no-set 0 0 to 7
PRIBLK primary cascade option boolean no-con/no-set 0 0 to 1
PRITIM primary cascade timer real no-con/no-set 0.0 secs
MA Auto/Manual input boolean con as input/ 0 0 to 1
set if unlinked
IN IN real con/no-set 0.0 any real
CAS_IN CAS_IN real con/set in CAS, if 0.0
unlinked
SP SP real con/set in Auto 0.0
SPHLIM SP_HI_LIM real con/set if 100.0 >=SPLLIM
unlinked
SPLLIM SP_LO_LIM real con/set if 0.0 <=SPHLIM
unlinked
SPRATD SP_RATE_DN real no-con/no-set 0.0
SPRATU SP_RATE_UP real no-con/no-set 0.0
LR remote/local input boolean con/set if 0 0-1
unlinked
HSCI1 PV_SCALE @ 100% real no-con/no-set 100.0 >=LSCI1
LSCI1 PV_SCALE @ 0% real no-con/no-set 0.0 <=HSCI1
DPTI1 PV_SCALE.DECIMAL short integer no-con/no-set 0 0-10
EI1 PV_SCALE eng units string no-con/no-set % 1-32 chars
EUI1 PV_SCALE.units index integer no-con/no-set 1342 0-32767
OUTHLM OUT_HI_LIM real con/set if 100.0 >=OUTLLM
unlinked
OUTLLM OUT_LO_LIM real con/set if 0.0 <=OUTHLM
unlinked
BCALCI BKCAL_IN real con/no-set 0.0
BKCALH BKCAL_HYS real no-con/no-set 0.0 0 to 100%

311
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-1. PIDFF Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


HSCO1 OUT_SCALE @ 100% real no-con/no-set 100.0 >=LSCO1
LSCO1 OUT_SCALE @ 0% real no-con/no-set 0.0 <=HSCO1
DPTO1 OUT_SCALE.DECI- short integer no-con/no-set 0 0-10
MAL
EO1 OUT_SCALE eng units string no-con/no-set % 1-32 chars
EUO1 OUT_SCALE.units integer no-con/no-set 1342 0-32767
index
TRKIND TRK_IN_D short integer con/set if 0 0 to 1
unlinked
TRKVAL TRK_VAL real con/set if 0.0 any real
unlinked
HSCI2 TRK_SCALE @ 100% real no-con/no-set 100.0 >=LSCI2
LSCI2 TRK_SCALE @ 0% real no-con/no-set 0.0 <=HSCI2
DPTI2 TRK_SCALE.DECI- short integer no-con/no-set 0 0-10
MAL
EI2 TRK_SCALE eng units string no-con/no-set % 1-32 chars
EUI2 TRK_SCALE.units integer no-con/no-set 1342 0-32767
index
FFGAIN FF_GAIN real con/set 0.0
FFVAL FF_VAL real con/set if 0.0
unlinked
HSCI3 FF_SCALE @ 100% real no-con/no-set 100.0 >=LSCI3
LSCI3 FF_SCALE @ 0% real no-con/no-set 0.0 <=HSCI3
DPTI3 FF_SCALE.DECIMAL short integer no-con/no-set 0 0-10
EI3 FF_SCALE eng units string no-con/no-set % 1-32 chars
EUI3 FF_SCALE.units index integer no-con/no-set 1342 0-32767
INHOPT alarm inhibit option short integer no-con/no-set 0 0-3
INHIB alarm inhibit switch boolean con/set if 0 0-1
unlinked
INHALM inhibit alarms packed b con/set if 0 0 to 0xFFFF
unlinked
MANALM manual alarm option short integer no-con/no-set 1 0-4
ERROPT block error alarm packed b no-con/no-set 0xFFFE 0 to 0xFFFF
option
ERRGRP block error alarm group short integer no-con/no-set 8 1 to 8
BADOPT bad alarm option boolean no-con/no-set 0 0 to 1
BADGRP bad alarm group short integer no-con/set 1 1 to 8
BADPRI bad alarm priority integer con/set if 5 1 to 5
unlinked
BADTXT bad alarm text string no-con/no-set 2 blanks 1 to 32 chars
PVDESC PV descriptor string no-con/no-set 2 blanks 1 to 32 chars
OUTDSC OUT descriptor string no-con/no-set 2 blanks 1 to 32 chars
HHIOPT hi hi/lo lo alarm option short integer no-con/no-set 0 0 to 3
ALMHYS ALARM_HYS real no-con/set 2.0 any real >=0.0
HHIGRP hi hi/lo lo alarm group short integer no-con/set 1 1 to 8
HHIPRI hi hi/lo lo alarm priority integer con/set 5 1 to 5
HHILIM hi hi alarm limit real con/set 100.0
LLOLIM lo o alarm limit real con/set 0.0

312
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-1. PIDFF Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


HHITXT hi hi alarm text string no-con/no-set 2 blanks 1 to 32 chars
LLOTXT lo lo alarm text string no-con/no-set 2 blanks 1 to 32 chars
HLOPT high/low alarm option short integer no-con/no-set 0 0 to 3
HLGRP high/low alarm group short integer no-con/set 1 1 to 8
HLPRI high/low alarm priority integer con/set 5 1 to 5
HILIM high alarm limit real con/set 100.0
LOLIM low alarm limit real con/set 0.0
HITXT high alarm text string no-con/no-set 2 blanks 1 to 32 chars
LOTXT low alarm text string no-con/no-set 2 blanks 1 to 32 chars
DEVOPT deviation alarm option short integer no-con/no-set 0 0 to 3
DEVGRP deviation alarm group short integer no-con/set 1 1 to 8
DEVPRI deviation alarm priority integer con/set 5 1 to 5
HDLIM high deviation alarm real con/set 100.0
limit
LDLIM low deviation alarm real con/set 0.0
limit
HDTXT high deviation alarm string no-con/no-set 2 blanks 1 to 32 chars
text
LDTXT low deviation alarm text string no-con/no-set 2 blanks 1 to 32 chars
OALOPT output alarm option short integer no-con/no-set 0 0 to 3
OUTGRP output alarm group short integer no-con/set 1 1 to 3
OUTPRI output alarm priority integer con/set 5 1 to 5

HOALIM high output alarm limit real con/set 100.0


LOALIM low output alarm limit real con/set 0.0
HOATXT high output alarm text short integer no-con/no-set 2 blanks 1 to 32 chars
LOATXT low output alarm text short integer no-con/no-set 2 blanks 1 to 32 chars
AMRTIN alarm regeneration integer no-con/no-set 0 0 to 32767 secs
timer
NASTDB alarm deadband timer long integer no-con/no-set 0 0 to
2147483647ms

NASOPT nuisance alarm sup- boolean no-con/no-set 0 0 to 1


pression
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to 2147483647
DVC_ID device ID integer no-con/no-set 0 0 to 0xFFFF
DVCREV device revision long integer no-con/no-set 0 0 to 2147483647
BLKNDX block index long integer no-con/no-set 0 0 to 2147483647
BLKOPT block options integer no-con/no-set 0 0 to 7
SETFS set failsafe request boolean con/no-set 0 0 to 1
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 0 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to
0xFFFFFFFF
AUT_SW switch to Auto mode boolean con/set 0 0 to 1
BCALCO BKCAL_OUT real con/no-set 0.0

313
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-1. PIDFF Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


BCISTS BKCAL_IN.Status packed b con/no-set 0 0 to 0xFF
BCOSTS BKCAL_OUT.Status packed b con/no-set 0 0 to 0xFF
BLKERR BLOCK_ERR packed b con/no-set 0 0 to 0xFFFF
BLKSTA block status packed long con/no-set 0 0 to
0xFFFFFFFF
BSTATE block state integer con/no-set 0 0 to 11
CASSTS CAS_IN.Status packed b con/no-set 0 0 to 0xFF
CRIT alarm criticality integer con/no-set 0 0 to 5
DEVACK device acknowledge boolean con/set 0 0, 1
FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for each
(array 1x255) element
FDATA2 file data bytes 256 to short integer no-con/no-set all 0s 0 to 255 for each
510 (array 1x255) element
FFVSTS FF_VAL.Status packed b con/no-set 0xFFFE 0 to 0xFF
FLBREQ fallback request short integer con/set 0 0 to 2
INHSTA inhibit status packed long con/no-set 0 0 to
0xFFFFFFFF
INSTS IN.Status packed b con/no-set 0 0 to 0xFFFF
MODE_A MODE_BLK.Actual short integer con/no-set 0 0 to 0xFF
OOS_SW switch to OOS mode boolean con/set 0 0 to 1
OUT OUT real con/set if manual 0
OUTSTS OUT.Status packed b con/no-set 0 0 to 0xFFFF
PRTYPE priority type integer con/no-set 0 0 to 8
PV PV real con/no-set 0
PVSTS PV.Status packed b con/no-set 0 0 to 0xFFFF
RCISTS RCAS_IN.Status packed b con/no-set 0 0 to 0xFFFF
RCOSTS RCAS_OUT.Status packed b con/no-set 0 0 to 0xFFFF
SPSTS SP.Status packed b con/no-set 0 0 to 0xFF
SUP_IN RCAS_IN real con/set if super- 0
visory enabled
SUPBCO RCAS_OUT real con/no-set 0.0
TRISTS TRK_IN_D.Status packed b con/no-set 0 0 to 0xFF
TRVSTS TRK_VAL.Status packed b con/no-set 0 0 to 0xFF
UNACK unacknowledged alarm boolean con/set 0 0, 1
Data Store
ALMOPT alarm option packed long no-con/no-set 0 0 to
0xFFFFFFFF
CAS_SW switch to CAS mode boolean no-con/set 0 1 to 0
CFGERR configuration error short integer no-con/no-set 0
DEFINE no config errors boolean no-con/no-set 1 0, 1
DESCRP block descriptor string no-con/no-set 2 blanks 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks
LOCKID lock identifier string no-con/no-set 2 blanks 1 to 32 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
MAN_SW switch to MAN mode boolean no-con/set 0 1 to 0
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
RCASSW switch to RCAS mode boolean no-con/set 0 1 to 0

314
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-1. PIDFF Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


RI1 PV_SCALE real no-con/no-set 100.0,
0.0,0.0
RI2 TRK_SCALE real no-con/no-set 100.0,
0.0,0.0
RI3 FF_SCALE real no-con/no-set 100.0,
0.0,0.0
RO1 output range string no-con/no-set 100.0, 0.0,
0.0
SE supervisory enable boolean no-con/set 0 0 to 1
ST_REV ST_REV integer no-con/no-set 0 0 to 65535

1.
Device function block parameters are shown in this document in italics. Function blocks may
use different names for these parameters.

9.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMHYS Alarm Hysteresis is a configurable, downloadable, non-settable real


parameter that sets the ALARM_HYS parameter of the device PID block.
ALARM_HYS is the amount by which the process variable (PV) must
return within the alarm limits before the alarm condition clears.
ALARM_HYS is expressed as a percent of the PV span.

ALMOPT Alarm Options contain packed long values representing the alarm options
that have been configured in the block and the alarm groups that are in
use. Table 9-2 shows PIDFF usage of the parameter.

Table 9-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
16 Low absolute alarm option (HLOPT=1 or 3)
17 High absolute alarm option (HLOPT=1 or 2)

315
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-2. ALMOPT Parameter Format (Continued)

Bit
Number*
(0 to 31) Configured Alarm Option, When True
18 Low output alarm option (OALOPT=1 or 3)
19 High output alarm option (OALOPT=1 or 2)
20 Low deviation alarm (DEVOPT=1 or 3)
21 High deviation alarm (DEVOPT=1 or 2)
22 Bad alarm option (BADOPT=1)
24 Low-low alarm option (HHIOPT=1 or 3)
25 High-high alarm option (HHIOPT=1 or 2)
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table 9-3 shows the bits used by the PIDFF block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9

CRIT PRTYPE
BAD
LLO
INH
HHI

HO
HD

HA
LO
LD

LA

Table 9-3. ALMSTA Parameter Format

Bit Boolean
Number Connection
(0 to 31)* Name Description (B32 to B1)
0 to 4 PTYP_MSK Priority type: See parameter PRTYPE on ---
page 336 for values used in this block
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
16 LA Low absolute alarm ALMSTA.B16
17 HA High absolute alarm ALMSTA.B15
18 LO Low output alarm ALMSTA.B14
19 HO High output alarm ALMSTA.B13
20 LD Low deviation alarm ALMSTA.B12
21 HD High deviation alarm ALMSTA.B11
22 BAD Bad alarm ALMSTA.B10
27 LLO Low-low alarm ALMSTA.B5
28 HHI High-high alarm ALMSTA.B4
29 INH Alarms Inhibited ALMSTA.B3

316
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-3. ALMSTA Parameter Format (Continued)

Bit Boolean
Number Connection
(0 to 31)* Name Description (B32 to B1)
30 UNAK Unacknowledged: There is at least one unac- ALMSTA.B2
knowledged alarm.
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and therefore MODE_BLK.Target in the device PID block, to
Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm mes-
sages for this block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the PIDFF
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BALTIM Balance Time is a configurable, downloadable, settable real output that


specifies the BAL_TIM tuning parameter of the device PID block.
BAL_TIM specifies the time for the internal working value of bias or ratio
to return to the operator set bias or ratio, in seconds. In the device PID
function block, it may be used to specify the time constant at which the
integral term will move to obtain balance when the output is limited and
the mode is Auto, CAS, or RCAS.

BCALCI Back-Calculated Input is a configurable, downloadable, non-settable real


parameter that contains the BKCAL_IN parameter of the device PID
function block.

317
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

BCALCI is usually connected to the BKCAL_OUT parameter of a down-


stream device AO or PID function block to prevent reset windup and pro-
vide bumpless transfer to closed loop control.

BCALCO Back-Calculated Output is a non-settable real output that contains the


BKCAL_OUT parameter of the device PID block.
BCALCO is usually connected to the BKCAL_IN parameter of an
upstream device PID function block or to the BCALCI of an I/A Series
control block to prevent reset windup and provide bumpless transfer to
closed loop control.

BCISTS Back-Calculated Input Status is a non-settable packed boolean output that


contains the BKCAL_IN.Status of the device PID block. See Section 9.7
for a description of the .Status value.

BCOSTS Back-Calculated Output Status is a non-settable packed boolean output


that contains the BKCAL_OUT.Status of the device PID block. See
Section 9.7 for a description of the .Status value.

BKCALH Back Calculated Hysteresis is a configurable, downloadable, non-settable


real parameter that specifies the BKCAL_HYS parameter of the device
PID block.
BKCAL_HYS is the amount that the output must change away from its
output limit before the limit status is turned off, expressed as a percent of
the span of the output.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the device PID block. Table 9-4 shows the
parameter format.

Table 9-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed

318
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-4. BLKERR Parameter Format (Continued)

Bit Error Code


2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device function block represented by the PIDFF block. The
index is acquired when the PIDFF is bound to a DD either when the
device is templated or the block instance is assigned to a device instance. It
is set by the configurator and the FBM uses it to identify the block in the
device.

BLKOPT Block Options is a configurable, non-settable integer parameter that spec-


ifies whether specific device PID function block parameters exist and are
sourced by I/A Series block parameters (i.e. they are NOT sourced by
other function block parameters), as follows:
♦ Bit 0: 1=Tracking inputs (TRK_IND, TRK_VAL) exist and are
sourced by I/A Series block parameters.
♦ Bit 1: 1= Feedforward input (FF_VAL) exists and is sourced by an
I/A Series block parameter.
♦ Bit 2: 1= Cascade Input (CAS_IN) exists and is sourced by an
I/A Series block parameter.

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 9-5 shows how the bits are used by the PIDFF
block. A given device might not support all bits in the bits described in the
table.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DEVACK B9

FDFAIL
FDACT
FDMM
FDOK

UDEF

FBM

TRK
LCK

FFX

BIO
ON

MA
SC
SE

LO
LR
FS

FF
FL

Table 9-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local Override BLKSTA.B29
6 TRK The block is being tracked as the device function BLKSTA.B26
block is in Local Override or Initialization Manual
mode

319
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
8 FBM There is a communication failure between BLKSTA.B24
CP and FBM
10 LR Local/Remote BLKSTA.B22
11 MA The block mode is Auto BLKSTA.B21
12 BIO Bad I/O: at least one channel is Bad BLKSTA.B20
14 UDEF The block is undefined BLKSTA.B18
15 ON The compound that contains the block is ON BLKSTA.B17
16 FFX Enhanced FF Block Connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FF FF block connection BLKSTA.B13
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK FDATA installed BLKSTA.B11
22 FDMM FDATA mismatch BLKSTA.B10
23 DEVACK Unacknowledged device alarm (DEVACK) BLKSTA.B9
24 FS Failsafe asserted BLKSTA.B8
28 SE Supervisor enabled BLKSTA.B3
29 SC Supervisor control BLKSTA.B2
30 FL Fallback state BLKSTA.B1
* Bit 0 is the least significant, low order bit.

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the device PID block connection as determined by the
FBM228. The following values are used to indicate the current DCI block
state:
0 = Undefined state
1 = Unconnected
2 = Connecting
3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON-LINE

320
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

11 = Block ON-LINE with error - Processing has been completed, but


some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 371.

BYPASS Bypass is a non-settable short integer that contains the BYPASS parameter
of the device PID block.
In the device function block, the normal control algorithm may be
bypassed through this parameter. When BYPASS is set, the setpoint value
(in percent) is directly transferred to the output. To prevent a bump on
transfer to/from bypass, the setpoint is automatically initialized to the out-
put value or process variable, respectively, and the path broken flag is set
for one execution.

CAS_IN Cascade In is a real input that specifies the CAS_IN value, the remote set
point, in the PID block.
CAS_IN can be linked either to an I/A Series block parameter or to a
device function block parameter. CAS_IN is settable when it is unlinked
and the block is CAS mode.

CAS_SW Cascade Switch is a settable Boolean output used to set the MODE_T
parameter, and therefore MODE_BLK.Target in the device PID block, to
CAS.

CASSTS Cascade Status is a non-settable, packed Boolean output that contains the
CAS_IN.Status of the device PID block. See Section 9.7for a description
of the .Status value.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device PID
block parameter when the PIDFF block becomes undefined due to a
“W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index shown in
Table 9-6.

Table 9-6. CFGERR Index

Value Device Function Block Parameter with Error


2 TAG_DESC
3 STRATEGY
5 MODE_BLK
10 PV_SCALE
11 OUT_SCALE
13 CONTROL_OPTS
14 STATUS_OPTS
16 PV_FTIME
17 BYPASS

321
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-6. CFGERR Index (Continued)

Value Device Function Block Parameter with Error


19 SP_RATE_DN
20 SP_RATE_UP
23 GAIN
24 RESET
25 BAL_TIME
26 RATE
30 BKCAL_HYS
34 SHED_OPT
37 TRK_SCALE
41 FF_SCALE
42 FF_GAIN

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

CTLOPT Control Options is a configurable, downloadable, non-settable packed


boolean parameter that specifies the CONTROL_OPTS parameter of the
device PID block. The parameter enumerates the options you may select
to alter the calculations done in a control block.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the device PID block. The parameter value is acquired
when DD is bound to the PIDFF block either during device templating or
when the block is assigned to a device.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the device PID block. The parameter value
is acquired when DD is bound to the PIDFF block either during device
templating or when the block is assigned to a device.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 239 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string of up to


32 characters used to specify a description for the block. The parameter

322
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

tracks the TAGDSC parameter, and is updated when the TAGDSC is


modified.

DEVACK Device Acknowledge is a settable boolean output used by the operator to


acknowledge device alarms in the device PID block. DEVACK is set when
a device alarm status bit is set by the FBM228. DEVACK is cleared by an
operator action.
DEVACK is different from UNACK (described on page 340), which is
used by the operator to acknowledge process alarms in the PIDFF block.
DEVACK is used to acknowledge device alarms at the ECB201 or DCI
block level.

NOTE
This parameter is not supported currently.

DEVGRP Deviation Alarm Group is a configurable, non-settable short integer used


to specify the alarm group assigned to High Deviation and Low Deviation
in the block. The range is 1 (default) to 8.

DEVOPT Deviation Alarm Option is a configurable, non-settable short integer used


to enable/disable high deviation and low deviation alarm detection in the
block. Valid settings are:
0 = Disable high deviation and low deviation alarming
1 = Enable high deviation and low deviation alarming
2 = Enable high deviation alarming only
3 = Enable low deviation alarming only.

DEVPRI Deviation Priority is a configurable, settable integer input used to specify


the alarm priority to be assigned to high deviation and low deviation
alarms in the block. The range is 1 (the highest) to 5 (default).

DPTI1 PV Scale Decimal Point is a configurable, downloadable, non-settable


short integer that specifies the device function block’s PV_SCALE.Decimal
parameter, which sets the number of places to the right of the decimal
used in displays of the PV parameter. The range is 0 to 10.

DPTI2 Track Scale Decimal Point is a configurable, downloadable, non-settable


short integer that specifies the device function block’s TRK_SCALE.Deci-
mal parameter, which sets the number of places to the right of the decimal
used in displays of the TRK_VAL parameter. The range is 0 to 10.

DPTI3 FF Scale Decimal Point is a configurable, downloadable, non-settable


short integer that specifies the device function block’s FF_SCALE.Decimal
parameter, which sets the number of places to the right of the decimal
used in displays of the FF_VAL parameter.The range is 0 to 10.

DPTO1 OUT Scale Decimal Point is a configurable, downloadable, non-settable


short integer that specifies the device function block’s OUT_SCALE.deci-

323
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

mal parameter, which sets the number of places to the right of the decimal
used in displays of the OUT parameter. The range is 0 to 10.

DVC_ID Device Identifier is a configurable, non-settable integer that provides the


Device Identifier of the H1 field device that contains the device function
block represented by the PIDFF block. It is set by the IEE configurator.
The FBM228 checks the corresponding value in the device resource block
to verify that there is a match between the block and the device.

DVCREV Device Revision is a configurable, non-settable long integer that provides


the Revision level of the H1 field device that contains the device function
block represented by the PIDFF block. It is set by the IEE configurator.
The FBM228 checks the corresponding value in the device resource block
to verify that there is a match between the block and the device. The IEE
configurator encodes the following data in DVCREV:
Bits 16-23 Bits 8-15 Bits 0-7
Device revision Minimum Device Description Common File Format
(DD) File Revision (CFF) File Revision

EI1 PV Engineering Units is a configurable non-settable ASCII string of up to


32 characters used to label the process value (PV parameter) in the
I/A Series block. This parameter does not configure units in the device
block; see EUI1.

EI2 TRKVAL Engineering Units is a configurable, non-settable ASCII string


of up to 32 characters used to label the track value (TRKVAL parameter)
in the I/A Series block, This parameter does not configure units in the
device block; see EUI2.

EI3 FF Scale Engineering Units is a configurable, non-settable ASCII string of


up to 32 characters used to label the feedforward value (FFVAL parame-
ter) in the I/A Series block. This parameter does not configure units in the
device block; see EUI3.

EO1 OUT Scale Engineering Units is a configurable, non-settable ASCII string


of up to 32 characters used to label output value (OUT parameter) in the
I/A Series block. This parameter does not configure units in the device
block; see EUO1.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table 9-7 lists the possible values of ERCODE for the PIDFF block.

Table 9-7. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION

324
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-7. Error Code Values (Continued)

ERCODE
W44 - INVALID ENGINEERING RANGE
W48 - INVALID BLOCK OPTION
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DECREC MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in the PIDFF block. The range is 1 to 8 (default).

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (from the device
block BLOCK_ERR parameter) generate an alarm message. The parameter
has the same format as BLKERR (Table 9-4).

EUI1 PV Scale Units Index is a configurable, downloadable, non-settable inte-


ger used to specify the PV_SCALE.Units Index parameter of the device
function block.

EUI2 Track Scale Units Index is a configurable, downloadable, non-settable


integer used to specify the TRK_SCALE.Units Index parameter of the
device function block.

EUI3 Feed Forward Units Index is a configurable, downloadable, non-settable


integer used to specify the FF_SCALE.Units Index parameter of the device
function block.

325
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

EUO1 Out Units Index is a configurable, downloadable, non-settable integer


used to specify the OUT_SCALE.Units Index parameter of the device
function block.

FDATA1 File Data #1 and File Data #2 are settable multi-byte arrays that provide
FDATA2 configuration data for the PID block represented by the PIDFF block.
These parameters encapsulate extended PID parameters that were
acquired from the device DD and configured using Field Device Manager,
as well as schedule and connection information.
This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 510 bytes.

FFGAIN Feed Forward Gain is a configurable, settable real output that specifies the
FF_GAIN parameter of the device PID block. It may be sourced by an
I/A Series block parameter or by a device block parameter. The FF_Gain
value is multiplied by the feed forward input (FF_VAL) before the gain is
added to the calculated control output.

FFVAL Feed Forward Value is a configurable real input that specifies the feed for-
ward input (FF_VAL parameter) of the device PID block. It may be
sourced by an I/A Series block parameter or by a device function block
parameter.

FFVSTS Feed Forward Value Status is a non-settable packed boolean output that
contains the FF_VAL.Status parameter of the device PID block. See
Section 9.7 for a description of the .Status value.

FLBOPT Fallback Option is a short integer input that defines the control action to
be taken by the block when a Supervisory fallback occurs:
0 = Take no fallback action (default)
1 = Set the Target Mode to Auto
2 = Set the Target Mode to Manual
3 = Set the Target Mode to Cascade
FLBOPT is disabled if either LR or MA is driven by a source parameter.

FLBREQ Fallback Request is a short integer output that is an explicit request for the
block to go to the Fallback state, with recovery at the block level (when SE
is set), and/or at the group level (when the appropriate group enable bit is
set in SUPENA).
0 = No fallback requested
1 = Fallback requested; recovery at block or group level
2 = Fallback requested; recovery only at block level
FLBREQ is disabled if either LR or MA is driven by a source parameter.

326
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

FSOPTN Fault State Option is a configurable integer parameter that specifies the
Fault State conditions and action to be taken by the CP and the FBM for
an output point in the corresponding device PID function block:
♦ Bit 0: 1 = Assert Fault State when the CAS_IN parameter is
sourced by an I/A Series parameter and the CAS_IN is
BAD, OOS, or has a broken connection.
Note that ERROPT must be configured nonzero for this
option to take effect.
♦ Bit 1: 1 = Assert Fault State when the CAS_IN parameter is
sourced by an I/A Series parameter and the SETFS input is
set/cleared.
♦ Bit 2: 1 = Assert Fault State if control station-to-FBM communi-
cation is lost (FBM option). This option is enabled only
when the CAS_IN parameter is sourced by an I/A Series
parameter and the Fault State is enabled at the FBM level
via the FSENAB parameter in the ECB200 or ECB202.

FSOPTN is independent of the FSTATE_TIME and FSTATE_VAL


parameters and the STATUS_OPTS options configured in the corre-
sponding device PID block.

GAIN Gain is a configurable, downloadable, settable real output that specifies


the GAIN tuning parameter of the device PID block.

HDLIM High Deviation Alarm Limit is a configurable, settable real input used to
specify the high limit value to be used in the Deviation Alarm detection
logic in the block. It is equivalent to the DV_HI_LIM parameter in a
device function block; however, HDLIM does not set the corresponding
device block parameter.

HDTXT High Deviation Alarm Text is a configurable, non-settable ASCII string of


up to 32 characters that describes the High Deviation Alarm. HDTXT is
included in the High Deviation Alarm message created when the alarm
condition occurs.

HHIGRP High-High Low-Low Alarm Group is a configurable, non-settable short


integer used to specify the alarm group assigned to High-High and Low-
Low Alarms in the block. The range is 1 (default) to 8.

HHILIM High-High Alarm Limit is a configurable, settable real input used to spec-
ify the high limit value to be used in the High-High Alarm detection logic
in the PIDFF block. It is equivalent to the HI_HI_LIM parameter in a
device PID block; however, HHILIM does not set the corresponding
device block parameter.

HHIOPT High-High Low-Low Alarm Option is a configurable, non-settable short


integer used to enable/disable High-High and Low-Low Alarm detection
in the block. Valid settings are:
♦ 0 = Disable High-High and Low-Low Alarming

327
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

♦ 1 = Enable High-High and Low-Low Alarming


♦ 2 = Enable High-High Alarming only
♦ 3 = Enable Low-Low Alarming only.

HHIPRI High-High Low-Low Priority is a configurable, settable integer input used


to specify the alarm priority to be assigned to High-High and Low-Low
Alarms in the block. The range is 1 (the highest) to 5 (default).

HHITXT High-High Alarm Text is a configurable, non-settable ASCII string of up


to 32 characters that describes the High-High Alarm. HHITXT is
included in the High-High Alarm message created when the alarm
condition occurs.

HILIM High Alarm Limit is a configurable, settable real input used to specify the
high limit value to be used in Absolute Alarm detection logic in a PIDFF
block. It is equivalent to the HI_LIM parameter in a PID function block;
however, HILIM does not set the corresponding device block parameter.

HITXT High Alarm Text is a configurable, non-settable ASCII string of up to


32 characters that describes the High Absolute Alarm in the block.
HITXT is included in the High Alarm message created when the alarm
condition occurs.

HLGRP High Low Alarm Group is a configurable, non-settable short integer used
to specify the alarm group assigned to High Low Absolute Alarms in the
PIDFF block. The range is 1 (default) to 8.

HLOPT High Low Alarm Option is a configurable, non-settable short integer used
to enable or disable High and Low Absolute Alarm detection in a PIDFF
block. Valid settings are:
♦ 0 = Disable High and Low Absolute Alarming
♦ 1 = Enable High and Low Absolute Alarming
♦ 2 = Enable High Absolute Alarming only
♦ 3 = Enable Low Absolute Alarming only.

HLPRI High Low Alarm Priority is a configurable, settable integer input used to
specify the alarm priority to be assigned to High Low Absolute Alarms in a
PIDFF block. The range is 1 (highest) to 5 (default).

HOALIM High Output Alarm Limit is a configurable, settable real input used to
specify the high limit value to be used in Absolute Alarm detection logic in
the block for high output alarms. It is equivalent to the OUT_HI_LIM
parameter in a device PID function block; however, HOALIM does not
set the corresponding device block parameter.

HOATXT High Output Alarm Text is a configurable, non-settable ASCII string of


up to 32 characters that describes the High Output Alarm in the block.
HOATXT is included in the High Output Alarm message created when
the alarm condition occurs.

328
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

HSCI1 Input High Scale 1 specifies the PV_SCALE@100% parameter value of


the device PID block.

HSCI2 Input High Scale 2 specifies the TRK_SCALE@100% parameter value of


the device PID block.

HSCI3 Input High Scale 3 specifies the FF_SCALE@100% parameter value of


the device PID block.

HSCO1 Output High Scale specifies the OUT_SCALE@100% parameter value of


the device PID block.

IN Input is a configurable real input that specifies the primary input value of
the device PID function block (IN parameter). It may be sourced from an
I/A block parameter or from a device PID function block parameter.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm
generation inhibit requests for each type of alarm configured in the block.
Table 9-8 shows how the bits are used by the PIDFF block.

Table 9-8. INHALM Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 15) Name When True (B16 to B1)
16 LA Inhibit Low Absolute Alarm INHALM.B16
17 HA Inhibit High Absolute Alarm INHALM.B15
18 LO Inhibit Low Output Alarm INHALM.B14
19 HO Inhibit High Output Alarm INHALM.B13
20 LD Inhibit Low Deviation Alarm INHALM.B12
21 HD Inhibit High Deviation Alarm INHALM.B11
22 BAD Inhibit Bad I/O Alarm INHALM.B10
24 LLO Inhibit Low-Low Absolute Alarm INHALM.B8
25 HHI Inhibit High-High Absolute Alarm INHALM.B7
*Bit 0 is the least significant, low order bit.
There are no mnemonic names for the individual bits of INHALM.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
0 = When an alarm is inhibited, disables alarm messages but does not
disable alarm detection.

329
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

1 = When an alarm is inhibited, disables both alarm messages and alarm


detection. If an alarm condition exists at the time the alarm transitions
into the inhibited state, the alarm indicator is cleared.
2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages. “Into alarm”
messages can be acknowledged by explicitly setting UNACK False.
3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages. “Into alarm”
messages can be acknowledged by explicitly setting UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table 9-9 shows
how the parameter is used with the PIDFF block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
BAD B10
B11
B12
B13
B14
HMA B15
LMA B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
HHA B7
LLA B8
B9

HO
HD

LO
LD

Table 9-9. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
16 LMA Low Absolute Alarm Inhibited INHSTA.B16
17 HMA High Absolute Alarm Inhibited INHSTA.B15
18 LO Low Output Alarm Inhibited INHSTA.B14
19 HO High Output Alarm Inhibited INHSTA.B13
20 LD Low Deviation Alarm Inhibited INHSTA.B12
21 HD High Deviation Alarm Inhibited INHSTA.B11
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
24 LLA Low-Low Absolute Alarm Inhibited INHSTA.B8
25 HHA High-High Absolute Alarm Inhibited INHSTA.B7
*Bit 0 is the least significant, low order bit.

INITSE Initial Supervisory Enable specifies the initial Supervisory Control state in
a block configured for Supervisory Control (SUPOPT = 1 or 3) when the
block initializes due to reboot, installing the block, or turning on the com-
pound. Options are:
0 = Disable Supervisory Control, i.e., set the Target mode (MODE_T) to
the highest state below Remote Cascade that is specified in the Permitted
Mode (MODE_P).

330
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

1 = Enable Supervisory Control, i.e., set the Target Mode (MODE_T) to


the Remote Cascade state.
2 = Do not change the Supervisory Control state, i.e., do not alter the Tar-
get Mode (MODE_T).

INSTS Input Status is a non-settable packed boolean output that contains the
IN.Status of the associated the device PID block. See Section 9.7 for a
description of the .Status value.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up
to 25 characters (12 for <local_compound_name>, 1 for the
colon, and 12 for the <ecb_name>).
For details on setting the IOM_ID and Point Number in IEE, refer to the
section “DCI Blocks” in Implementing FOUNDATION fieldbus in InFusion
2.0 (B0750DA).

LDLIM Low Deviation Alarm Limit is a configurable, settable real input used to
specify the low limit value to be used in the Deviation Alarm detection
logic in the block. It is equivalent to the DV_LO_LIM parameter in a
device PID function block; however, LDLIM does not set the device block
parameter.

LDTXT Low Deviation Alarm Text is a configurable, non-settable ASCII string of


up to 32 characters that describes the Low Deviation Alarm. HDTXT is
included in the Low Deviation Alarm message created when the alarm
condition occurs.

LLOLIM Low-Low Alarm Limit is a configurable, settable real input used to specify
the low limit value to be used in the Low-Low Alarm detection logic in
the PIDFF block. It is equivalent to the LO_LO_LIM parameter in a
device PID block; however, LLOLIM does not set the device block
parameter.

LLOTXT Low-Low Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used to describe the Low-Low Alarm in the PIDFF block.

331
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

LLOTXT is included in the Low-Low Alarm message created when the


alarm condition occurs.

LOALIM Low Alarm Limit is a configurable, settable real input used to specify the
low limit value to be used in Low Output Alarm detection logic in the
PIDFF block. It is equivalent to the OUT_LO_LIM parameter in a device
PID function block; however, LOALIM does not set the device block
parameter.

LOATXT Low Output Alarm Text is a configurable, non-settable ASCII string of up


to 32 characters used to describe the Low Output Alarm in the PIDFF
block. LLOTXT is included in the Low Output Alarm message created
when the alarm condition occurs.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has the
format LETTERBUG:DEVNAME, where LETTERBUG is the 6-char-
acter letterbug of the workstation and DEVNAME is the 1- to 6-character
logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOLIM Low Alarm Limit is a configurable, settable real input used to specify the
low limit value to be used in Absolute Alarm detection logic in a PIDFF
block. It is equivalent to the LO_LIM parameter in a device PID function
block; however, LOLIM does not set the device PID function block
parameter.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block.

LOTXT Low Alarm Text is a configurable, non-settable ASCII string of up to


32 characters that describes the Low Absolute Alarm in the PIDFF block.
LOTXT is included in the Low Alarm message created when the alarm
condition occurs.

LR Local/Remote is a boolean input that controls the source of the setpoint


(0 = Local; 1 = Remote) to be used by the device PID block algorithm.

332
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

When LR is set to Remote, the Target mode will be set to Cascade. While
the Actual mode is Cascade, the block’s setpoint will be provided by the
CAS_IN parameter.
When LR is set to Local, the Target mode will be set to Auto. While the
Actual mode is Auto, the block's setpoint will be provided by the SP
parameter.

LSCI1 PV Low Scale Value specifies the PV_SCALE@0% parameter value of the
device PID function block.

LSCI2 TRK Scale Value In specifies the TRK_SCALE@0% parameter value of


the device PID function block.

LSCI3 FF Scale Value In specifies the FF_SCALE@0% parameter value of the


device PID function block.

LSCO1 Output Low Scale specifies the OUT_SCALE@0% parameter value of a


device PID function block.

MA Manual/Auto is a Boolean input that controls the source of the block's


output (0 = Manual; 1 = Auto).
When MA is set to Auto, the Target mode will be set to Auto. While the
Actual mode is Auto, the block's output will be provided by device PID
block algorithm.
When MA is set to Manual, the Target mode will be set to Manual. While
the Actual mode is Manual, the block's output will be provided by an OM
set to the OUT parameter.

MAN_ID Manufacturer Identifier is a configurable, non-settable long integer that


provides the Manufacturer Identifier of the H1 field device that contains
the device PID function block represented by the PIDFF block. The
parameter value is acquired from the DD when the DD is bound to the
block template or the block instances is assigned to a device. The FBM228
checks the corresponding value in the device resource block to verify that
there is a match between the block and the device.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the PID block, to Manual.

MANALM Manual Alarm Option is a configurable input which enables or disables


configured alarm options to function in Manual mode. Normally alarms
are processed only in the Auto mode. Values for the PIDFF block:
0 = No alarming in Manual
1 = Full alarming in Manual
2 = No output alarming in Manual
3 = No output alarming in Track
4 = No output alarming in Manual or Track.

333
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

MODE_A Actual mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the device PID block.

MODE_N Normal mode is a configurable, downloadable, non-settable, short


integer output that contains the MODE_BLK.Normal parameter of the
device PID block.

MODE_P Permitted mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
device PID block.

MODE_T Target mode is a configurable, downloadable, packed short integer that


contains the MODE_BLK.Target parameter of the device PID block.
MODE_T is not directly settable. The RCASSW, CAS_SW, AUT_SW,
MAN_SW, and OOS_SW are used to change the MODE_T parameter
and thus the MODE_BLK.Target parameter in the device PID function
block.

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the PID block is initialized,
the block updates the configurable parameters of the function block
matched to the PID block by the configured index (BLKNDX). The
NAME parameter is used to set the Block Tag of the device function
block.

NASOPT Nuisance Alarm Suppression Alarm Option is a configurable, settable


boolean parameter that specifies whether the nuisance alarm delay speci-
fied in NASTDB is implemented by delaying the return to normal
(NASOPT=0) or by delaying alarm detection (NASOPT=1).

NASTDB Nuisance Alarm Suppression Time Deadband is used to reduce the


number of alarm messages generated when a block parameter crosses back
and forth over an alarm limit. When the parameter is set to zero, an alarm
is generated each time the parameter is outside the limit and is cleared
each time it crosses back. Thus, a parameter that is fluttering at the alarm
limit can result in nuisance alarms. NASTDB specifies, in milliseconds, a
time that must lapse before the alarm is cleared and before another alarm
message can be generated. The specified value is rounded up to the nearest
even multiple of the control station BPC. If the parameter passes from
outside one limit to outside the opposite extreme, the deadband is
ignored.

OALOPT Output Alarm Option is a configurable, non-settable short integer that


specifies whether Low Output Alarming and High Output Alarming are
to be performed:
♦ 0 (default) disables High Output and Low Out Alarming
♦ 1 enables High Output and Low Out Alarming
♦ 2 enables High Output only
♦ 3 enables Low Out Alarming only.

334
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

OOS_SW Out of Service Switch is a settable output used to set the MODE_T
parameter, and thus the MODE_BLK.Target in the device PID block, to
Out of Service.

OUT Out is a real output that contains the OUT parameter of the device PID
block. OUT is settable when the block is in Manual mode.

OUTDSC Output Descriptor is a configurable, non-settable ASCII string of up to


32 characters used as descriptive information in output block alarm,
High/Low Output alarm messages in the PIDFF block. (PVDESC is used
for other alarms.)

OUTGRP Output Alarm Group is a configurable, non-settable short integer parame-


ter used to specify the Alarm Group to be used for reporting Low Output
Alarm and High Output Alarm messages. The range is 1 (default) to 8.

OUTHLM Output High Limit is a configurable real input that specifies the
OUT_HI_LIM parameter of the device PID block. It is settable if
unlinked. OUT_HI_LIM sets the maximum output value.

OUTLLM Output Low Limit is a configurable real input that specifies the
OUT_LO_LIM parameter of the device PID block. It is settable if
unlinked. OUT_LO_LIM sets the minimum output value.

OUTPRI Output Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Low Output Alarm and High Output
Alarms in the block. BADPRI is settable if unlinked.

OUTSTS Output Status is a non-settable, packed Boolean output that contains the
OUT.Status of the device PID block. See Section 9.7 for a description of
the .Status value.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

335
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with
a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,
or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PRIBLK Primary Block indicates whether the PIDFF block has a connection from
an upstream block (PRIBLK = 1) or not (PRIBLK = 0). Its value and the
value of PRITIM determine whether the block remains in holding until
the upstream block returns an acknowledgement, remains in holding for a
fixed time delay, or ends the hold after one cycle.

PRITIM Primary Cascade Timer is a configurable parameter used to delay the clos-
ing of the cascade to a primary block when the output is initialized in the
PIDFF block. It is used only if the PRIBLK option is set. If PRITIM = 0
and PRIBLK is used, the cascade remains open indefinitely until acknowl-
edged by the primary block.

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the PIDFF block:
♦ 0 = No active alarm
♦ 1 = High Absolute
♦ 2 = Low Absolute
♦ 3 = High-High Absolute
♦ 4 = Low-Low Absolute
♦ 5 = High Deviation
♦ 6 = Low Deviation
♦ 8 = BAD Alarm
If there is more than one active alarm with highest priority, PRTYPE
reports the alarm type occurring first in the following order: Bad, High-
High Absolute, Low-Low Absolute, High Absolute, Low Absolute, High
Deviation, Low Deviation, High Output, and Low Output. For example:

336
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

if the Bad and High-High Absolute alarms both have priority 3 and the
Deviation alarm has priority 4, and all three alarms are active, then
CRIT = 3 (priority of Bad Alarm) and PRTYPE = 8 (Bad Alarm type).

PV Process Variable is a non-settable real output that contains the PV


parameter of the device PID block.

PVDESC Point Descriptor is a configurable non-settable string of up to 32 ASCII


characters used as descriptive information in High/Low Absolute, Hi-Hi
Lo-Lo Absolute, and Deviation Alarm messages in the PIDFF block.

PVFTIM PV Filter Time is a configurable, downloadable, non-settable real parame-


ter that specifies the PV_FTIME parameter of the device PID block.
PV_FTIME is the time constant of a single exponential filter for the PV, in
seconds.

PVSTS Process Variable Status is a non-settable, packed Boolean output that con-
tains the PV.Status of the device PID block. See Section 9.7 for a descrip-
tion of the .Status value.

RATE Rate is a configurable, downloadable, settable real output that specifies the
RATE tuning parameter of the device PID block. RATE defines the deriv-
ative time constant, in seconds.

RCASSW Remote Cascade Switch is a settable output that is used to set the Target
Mode to Remote Cascade in the device PID block.

RCISTS Remote Cascade Input Status is a non-settable packed boolean output that
contains the RCAS_IN.Status of the device PID block. See Section 9.7 for
a description of the .Status value.

RCOSTS Remote Cascade Output Status is a non-settable packed boolean output


that contains the RCAS_OUT.Status of the device PID block. See
Section 9.7 for a description of the .Status value.

RESET Reset is a configurable, downloadable, settable real output that specifies


the RESET tuning parameter of the device PID block. RESET specifies
the integral time constant, in seconds per repeat.

RI1 Input Range 1 is a non-settable real data array that contains a copy of the
HSCI1 (PV_SCALE@100%) and LSCI1 (PV_SCALE@0%) engineering
range scaling parameters.

RI2 Input Range 1 is a non-settable real data array that contains a copy of the
HSCI2 (TRK_SCALE@100%) and LSCI2 (TRK_SCALE@0%) engineer-
ing range scaling parameters.

RI3 Input Range 1 is a non-settable real data array that contains a copy of the
HSCI3 (FF_SCALE@100%) and LSCI3 (FF_SCALE@0%) engineering
range scaling parameters.

337
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

RO1 Output Range 1 is a non-settable real data array that contains a copy of
the HSCO1 (OUT_SCALE@100%) and LSCO1 (OUT_SCALE@0%)
engineering range scaling parameters.

SE SE Supervisory Enable is a boolean input that enables or disables Supervi-


sory Control in this block.
0 = disable Supervisory Control by setting the Target mode (MODE_T)
to the highest state below Remote Cascade specified in the Permitted
Mode (MODE_P) parameter.
1 = enable Supervisory Control by setting the Target mode (MODE_T)
to the Remote Cascade state.

SETFS Set Failsafe is a non-configurable, settable boolean output that when set
causes the CP270 to request the FBM228 to assert failsafe in the device
PID block. The set failsafe request is implemented if the SETFS option is
set in the FSOPTN parameter (bit 1 =1).

SHEDOP Mode Shed Options is a configurable, downloadable, short integer that is


used to specify the SHED_OPT parameter of the device PID block.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


PIDFF block is to be simulated.
When SIMOPT= 1 (True), the status and value of OUT are not recovered
from the field, but are computed by the control station based on the simu-
lated value derived from a PID algorithm. The simulated values are lim-
ited by HSCI1 and LSCI1. If this limiting action forces a clamping of the
entered value, the status of OUT is set to Limited High or Limited Low,
as appropriate.

SP Set Point is a configurable, downloadable, real parameter that specifies the


value of the SP parameter of the device PID block. SP is settable when the
block is in Auto.

SPHLIM Set Point High Limit is a configurable, downloadable, real parameter that
specifies the value of the SP_HI_LIM parameter in the device PID block.
SPHLIM is settable if the parameter is unlinked.

SPLLIM Set Point Low Limit is a configurable, downloadable, real parameter that
specifies the value of the SP_LO_LIM parameter in the device PID block.
SPLLIM is settable if the parameter is unlinked.

SPRATD Set Point Rate Down is a configurable, downloadable, non-settable real


parameter that sets the SP_RATE_DN parameter of the device PID block.
SP_RATE_DN is the rate in PV units per second at which downward set-
point changes are acted on in Auto mode. If the ramp rate is set to 0, the
setpoint is used immediately. Rate limiting applies only in Auto.

338
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

SPRATU Set Point Rate Up is a configurable, downloadable, non-settable real


parameter that is used to specifies the SP_RATE_UP parameter of the
device PID block.
SP_RATE_UP is the rate in PV units per second at which upward setpoint
changes are acted on in Auto mode. If the ramp rate is set to 0, the set-
point is used immediately. Rate limiting applies only in Auto.

SPSTS Set Point Status is a non-settable, packed Boolean output that contains the
SP.Status of the device PID block. See Section 9.7 for a description of
the .Status value.

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the device PID block. ST_REV increments each time a
change is made to the configurable device block parameters from an exter-
nal source.

STOPTS Status Options is a configurable, downloadable, non-settable, packed


Boolean that is used to specify the STATUS_OPTS parameter of the
device PID block. The PIDFF block uses the five bits listed in Table 9-10.

Table 9-10. STATUS_OPTS Parameter Format

Bit* Option Set with Bit


17 Initiate Fault State (IFS) if IN is BAD
18 Initiate Fault State (IFS) if CAS_IN is BAD
19 Use Uncertain as Good
22 Set Target Mode to MAN if IN is BAD
26 Set Target Mode to Next Permitted Mode if CAS_IN is
BAD
* Bit 0 is the least significant, low order bit.
Note that bits 17 and 18 in STATUS_OPTS are independent of
the FSOPTN parameter options.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the device PID block.

SUP_IN Supervisory Input is a non-configurable, real parameter that contains the


value of the RCAS_IN parameter of the device PID block. The parameter
is settable only when the Secure Supervisory Control is enabled (SE = 1).

SUPBCO Supervisory Output is a non-configurable, non-settable real output that


contains the RCAS_OUT parameter of the device PID block.

SUPGRP Supervisory Group is a short integer input (1 to 8) that specifies one of


eight groups to which this block is assigned for Supervisory Control.

SUPOPT Supervisory Option is a configurable short integer input that specifies


whether or not this block is under control of a Supervisory Control appli-
cation:

339
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

♦ 0 = No Supervisory control
♦ 1 = Set Point Control (SPC) of the block's Secure Supervisory
Control (SSC)
♦ 3 = SPC, with an implicit acknowledge by the CP
Be aware that option 1 requires an explicit acknowledge by the application
software to close the supervisory cascade. This must be done by setting the
ACK status bit in the SUP_IN parameter using special OM access func-
tions.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device
function block. The value of TAGDSC is also copied to the DESCRP
parameter to provide a description of the block in I/A Series displays.

TRISTS Track Input Status is a non-settable packed boolean output that contains
the TRK_IN_D.Status of the device PID block. See Section 9.7 for a
description of the .Status value.

TRKIND Track Input is a configurable short integer input that specifies the
TRK_IN_D parameter of the device PID block. It may be sourced by an
I/A Series block parameter or by a device PID function block parameter.
TRK_IN_D is used to initiate external tracking of the block output to the
value specified by TRK_VAL.

TRKVAL Track Value is a configurable real input that specifies the TRK_VAL
parameter of the device PID block. It may be sourced by from I/A Series
block parameter or from a device PID function block parameter.
TRK_VAL used as the track value when external tracking is enabled by
TRK_IN_D.

TRVSTS Track Value Status is a non-settable packed boolean output that contains
the TRK_VAL.Status of the device PID block. Section 9.7 for a descrip-
tion of the .Status value.

TYPE Type is the block type. When a PIDFF block is added to the control data-
base, the configuration editor enters the value 127 to specify the PIDFF
block type.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the alarms display.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period for client/server connections scheduled by the
FBM228 to read the device PID function block view parameters. The
range is 0 to 2147483647 milliseconds; the default is 10000.

340
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

9.5 Device PID Function Block Description


This section describes the FOUNDATION fieldbus device PID function block, and includes a block
schematic, a brief description of the block’s standard parameter set, and a table showing the map-
ping between the I/A Series system PIDFF block parameters and the device PID function block
parameters.

9.5.1 Device Block Operation


The H1 device PID function block supports the inputs and outputs shown in Figure 9-1.

Figure 9-1. PID Device PID Function Block Inputs and Outputs

The process value to be controlled is connected to the IN input (Figure 9-2). This value is passed
through a filter whose time constant is PV_FTIME. The value is then shown as the PV, which is
used in conjunction with the SP in the PID algorithm. A PID will not integrate if the limit status
of IN is constant.

Figure 9-2. Device PID Function Block Diagram

341
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

The switch BYPASS is available to the operator if the Bypass Enable control option is true. Bypass
is used in secondary cascade controllers that have a bad PV. The Bypass Enable option is necessary
because not all cascade control schemes will be stable if BYPASS is true. BYPASS can only be
changed when the block mode is Man or O/S. While it is set, the value of SP, in percent of range,
is passed directly to the target output, and the value of OUT is used for BKCAL_OUT.
When the mode is changed to Cas, the upstream block is requested to initialize to the value of
OUT. When a block is in Cas mode, then on the transition out of bypass, the upstream block is
requested to initialize to the PV value, regardless of the “Use PV for BKCAL_OUT” option.
GAIN, RESET, and RATE are the tuning constants for the P, I, and D terms, respectively. Gain is
a dimensionless number. RESET and RATE are time constants expressed in seconds. There are
existing controllers that are tuned by the inverse value of some or all of them, such as proportional
band and repeats per minute. The human interface to these parameters should be able to display
the user's preference.
The Direct Acting control option, if true, causes the output to increase when the PV exceeds the
SP. If false, the output will decrease when the PV exceeds the SP. It will make the difference
between positive and negative feedback, so it must be set properly, and never changed while in an
automatic mode. The setting of the option must also be used in calculating the limit state for
BKCAL_OUT.
The output supports the feed forward algorithm. The FF_VAL input brings in an external value
which is proportional to some disturbance in the control loop. The value is converted to percent
of output span using the values of parameter FF_SCALE. This value is multiplied by the
FF_GAIN and added to the target output of the PID algorithm. If the status of FF_VAL is Bad,
the last usable value will be used, because this prevents bumping the output. When the status
returns to good, the block will adjust its integral term to maintain the previous output.
The output supports the track algorithm.
There is an option to use either the SP value after limiting or the PV value for the BKCAL_OUT
value.
PID supported the following modes: O/S, IMan, LO, Man, Auto, Cas, and RCas.
The alarm types are the Standard block alarm plus standard HI_HI, HI, DV_HI, DV_LO, LO,
and LO_LO alarms applied to PV.
The I/A Series system does not use the alarm features provided by the device blocks, but rather
provides alarm handling options in the CP-resident PDIFF block. The PIDFF block provides
detection and reporting for BAD I/O, high and low absolute and high-high and low-low alarm
conditions. See Section 9.7.3.

9.5.2 Parameter Transforms


Table 9-11 illustrates the mapping of PIDFF block parameters and parameters in the correspond-
ing device PID function block. Many of the parameters are straightforward 1:1 mappings that are
either unidirectional or bidirectional. Other mappings require that a data value be re-formatted
(or transformed) to be intelligible in the I/A Series system. From the point of view of the PIDFF

342
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

block, the relationship with the device PID function block can also be described in terms of sink
and source connections:
→ Source-sink The PIDFF block parameter is the source for the corresponding
device PID function block parameter. Thus, changes to the PIDFF
block parameter are made to the device parameter. For example,
when the PIDFF block is initialized, the TAGDSC value is copied to
the device PID function block TAG_DESC parameter.
← Sink-source The PIDFF block parameter value is updated by the corresponding
device PID function block parameter. For example, the MODE_A
parameter reads the device parameter MODE_BLK.Actual to make
the actual device PID function block mode visible to the control sys-
tem.
↔ Bidirectional Changes to the PIDFF block parameter are made to the correspond-
ing device PID function block parameter and vice versa. For example,
when a PIDFF block is initialized, its STOPTS parameter value is
written to the equivalent device PID function block parameter,
STATUS_OPTS, to configure how the function block processes block
status information. Subsequent changes to the status options made at
the device are written back to the PIDFF block STOPTS parameter.

The arrow notation is used in Table 9-11; the mappings are presented in alphabetic order,
arranged by the PIDFF block parameter names.

Table 9-11. PIDFF Parameter Transformations

PIDFF Parameter Device PID Function Block Parameter


AUT_SW MODE_BLK.Target
If the LR and MA parameters are NOT linked, the following action
will be taken when AUT_SWÆ1:
Set MODE_T (request) = AUTO
Set MAN_SW=0, OOS_SW=0
Set SE=0 and BLKSTA.SE=0
Write MODE_T (request) to FBM
BALTIM BAL_TIME
BALTIM.value (request) Æ BAL_TIME
BALTIM.value (actual) Å BAL_TIME
BALTIM.status.OOS Å BALTIM source value is OOS, or Compound is Off

343
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


BCALCI BKCAL_IN
BCALCI.value Å BKCAL_IN.Value

BCALCI.status.LHI Å BKCAL_IN.Status.Limited Hi(Bit 0)


BCALCI.status.LLO Å BKCAL_IN.Status.Limited Lo(Bit 1)
BCALCI.status.ERR Å BKCAL_IN.Status.Uncertain (Bits 6-7=1)
BCALCI.status.BAD Å BKCAL_IN.Status.Bad (Bits 6-7=0)
or CP-FBM communications failure
BCALCI.status.OOS Å BKCAL_IN.Status.Bad (Bits 6-7=0), Substatus.OOS (bits2-5= 7)
or Compound is Off
or FBM228 is Off-Line or DCI Not Ready
or FF H1 Device is Failed or Disabled
or CP-FBM communications failure
or DCI_COMM_DATA.connect_status <= 0
BCALCO BKCAL_OUT, CAS_IN, MODE_BLK.Actual
BCALCO.value Å BKCAL_OUT.Value if initializing;
Å CAS_IN.Value if not initializing

BCALCO.status.LHI Å BKCAL_OUT.Status.Limited Hi(Bit 0)


or MODE_BLK.Actual is not Cascade
or BKCAL_OUT.Status.Bad (Bits 6-7=0),
or CP-FBM communications failure,
or the DCI connection record indicates an Initialization Request
(IR), Local Override (LO), Open Loop (LHI and LLO), Not
Invited (NI), or Failsafe Active (FSA) condition in the PID
function block.

BCALCO.status.LLO Å BKCAL_OUT.Status.Limited Lo(Bit 1)


or MODE_BLK.Actual is not Cascade
or BKCAL_OUT.Status.Bad (Bits 6-7=0)
or CP-FBM communications failure
or the DCI connection record indicates an Initialization Request
(IR), Local Override (LO), Open Loop (LHI and LLO),
Not Invited (NI), or Failsafe Active (FSA) condition in the PID
function block.

BCALCO.status.BAD Å BKCAL_OUT.Status.Bad (Bits 6-7=0)


or CP-FBM communications failure
BCALCO.status.OOS Å BKCAL_OUT.Status.Bad (Bits 6-7=0), Substatus.OOS (bits2-5=
7)
or Compound is Off
or FBM228 is Off-Line or DCI Not Ready
or FF H1 Device is Failed or Disabled
or CP-FBM communications failure
or DCI_COMM_DATA.connect_status <= 0

344
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


BCISTS BKCAL_IN
BCISTS.value Å BKCAL_IN.Status
BCOSTS BKCAL_OUT
BCOSTS.value Å BKCAL_OUT.Status
BKCALH ÅÆ BKCAL_HYS
BLKERR BLOCK_ERR
BLKERR.value Å BLOCK_ERR
BLKERR.status.OOS Å CP-FBM communications is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual, BKCAL_OUT
BLKSTA.status.OOS Å MODE_BLK.Actual.OOS
BLKSTA.HLD Å CAS_IN source value is BAD

BLKSTA.TRK Å MODE_BLK.Actual.IMAN or LO
or BKCAL_IN.Status.Limited Hi and Low (Bits 0-1),
or BKCAL_OUT.Status.Limited Hi and Low (Bits 0-1)

BLKSTA.LO Å MODE_BLK.Actual.LO
BLKSTA.SE=0 cleared when CAS_SWÆ 1, AUT_SWÆ1, or MAN_SWÆ 1
BLKSTA.SE=1 set when RCASSWÆ1
BLKSTA.SC=0 Å MODE_BLK.Actual.AUTO or MAN or CAS
BLKSTA.SC=1 Å MODE_BLK.Actual.RCAS
BLKSTA.LR=0 Å MODE_BLK.Actual.AUTO or MAN or RCAS
BLKSTA.LR=1 Å MODE_BLK.Actual.CAS
BLKSTA.MA=0 Å MODE_BLK.Actual.MAN
BLKSTA.MA=1 Å MODE_BLK.Actual.AUTO or CAS or RCAS
BLKSTA.FBM Å CP-FBM communications is failed
BLKSTA.BIO Å IN.Status.Bad (Bits 6-7=0) or BCALCI.Status.Bad (Bits 6-7=0)
BLKSTA.FS Å OUT.Status. Good_Cascade (Bits 6-7=3) and Substatus.IFS
(Bits 2-5= 8
BYPASS Å> BYPASS
CASSTS CAS_IN
CASSTS.value Å CAS_IN.Status

345
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


CAS_IN CAS_IN, BKCAL_OUT
CAS_IN.value (request) Æ CAS_IN.Value (in CAS mode only if non-FF connection)
CAS_IN.value (actual) Å BKCAL_OUT.Value if initializing;
Å CAS_IN.Value if not initializing

CAS_IN.status.LHI Å CAS_IN.Status.Limited Hi(Bit 0)


or CAS_IN source value is LHI
CAS_IN.status.LLO Å CAS_IN.Status.Limited Lo(Bit 1)
or CAS_IN source value is LLO
CAS_IN.status.ERR Å CAS_IN.Status.Uncertain (Bits 6-7=1)
or CAS_IN source value is ERR
CAS_IN.status.BAD Å CAS_IN.Status.Bad (Bits 6-7=0)
or CAS_IN source value is BAD,
or CP-FBM communications failure

CAS_IN.status.OOS Å CAS_IN.Status.Bad (Bits 6-7=0), Substatus.OOS (bits2-5= 7)


or CAS_IN source value is OOS,
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communications failure,
or DCI_COMM_DATA.connect_status <= 0
CAS_SW MODE_BLK.Target
If the LR and MA parameters are NOT linked, the following action
will be taken when CAS_SWÆ1:
Set MODE_T (request) = CAS and AUTO
Set AUT_SW=0, MAN_SW=0, OOS_SW=0, RCASSW=0
Set SE=0 and BLKSTA.SE=0
Write MODE_T (request) to FBM
CTLOPT ÅÆ CONTROL_OPTS
DPTI1 ÅÆ PV_SCALE decimal pt
DPTI2 ÅÆ TRK_SCALE decimal pt
DPTI3 ÅÆFF_SCALE decimal pt
DPTO1 ÅÆ OUT_SCALE decimal pt
EUI1 ÅÆ PV_SCALE units index
EUI2 ÅÆ TRK_SCALE units index
EUI3 ÅÆ FF_SCALE units index
EUO1 ÅÆ OUT_SCALE units index
FFGAIN FFGAIN
FFGAIN.value (request) Æ FFGAIN
FFGAIN.value (actual) Å FFGAIN
FFGAIN.status.OOS Å FFGAIN source value is OOS, or Compound is Off

346
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


GAIN GAIN
GAIN.value (request) Æ GAIN
GAIN.value (actual) Å GAIN
GAIN.status.OOS Å GAIN source value is OOS, or Compound is Off
HSCI1 ÅÆ PV_SCALE @ 100%
HSCI2 ÅÆ TRK_SCALE @ 100%
HSCI3 ÅÆ FF_SCALE @ 100%
HSCO1 ÅÆ OUT_SCALE @ 100%
IN IN
IN.value (request) Æ IN.Value (if non-FF connection)
IN.value (actual) Å IN.Value

IN.status.LHI Å IN.Status.Limited Hi(Bit 0)


IN.status.LLO Å IN.Status.Limited Lo(Bit 1)
IN.status.ERR Å IN.Status.Uncertain (Bits 6-7=1)
IN.status.BAD Å IN.Status.Bad (Bits 6-7=0)
IN.status.OOS or CP-FBM communications failure
Å IN.Status.Bad (Bits 6-7=0),Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communications failure,
or DCI_COMM_DATA.connect_status <= 0
INSTS IN
INSTS.value Å IN.Status

347
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


LR MODE_BLK.Actual, MODE_BLK.Target

LR.value (actual) If MODE_BLK.Actual = CAS: Set LR (actual) =1


If MODE_BLK.Actual = RCAS, AUTO, or MAN:
Set LR (actual) = 0

LR.value (request) If the MA parameter is linked, the LR parameter will be disabled.


If the MA parameter is not linked, the following LR actions will be
taken:

When LR (request) 0Æ1:


If MODE_A = RCAS, AUTO, MAN, or OOS,
Set MODE_T (request) = CAS
Write MODE_T (request) to FBM
When LR (request) 1Æ0:
If MODE_A = RCAS, CAS, or OOS,
If MA (actual) = 1:
Set MODE_T (request) = AUTO
Else Set MODE_T (request) = MAN
Write MODE_T (request) to FBM
LSCI1 ÅÆ PV_SCALE @ 0%
LSCI2 ÅÆ TRK_SCALE @ 0%
LSCI3 ÅÆ FF_SCALE @ 0%
LSCO1 ÅÆ OUT_SCALE @ 0%
MAN_SW MODE_BLK.Target
If the LR and MA parameters are NOT linked, the following action
will be taken when MAN_SWÆ1:
Set MODE_T (request) = MAN
Set CAS_SW=0, AUT_SW=0, RCASSW=0, OOS_SW=0
Set SE=0 and BLKSTA.SE=0
Write MODE_T (request) to FBM

348
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


MA MODE_BLK.Actual, MODE_BLK.Target

MA.value (actual) If MODE_BLK.Actual = RCAS, CAS, or AUTO:


Set MA (actual) =1
If MODE_BLK.Actual = MAN:
Set MA (actual) =0

If the LR parameter is linked, the MA parameter will be disabled.


MA.value (request) If the LR parameter is not linked, the following MA actions will be
taken:

When MA (request) 0Æ1:


If MODE_A = MAN or OOS,
Set MODE_T (request) = AUTO
Write MODE_T (request) to FBM
When MA (request) 1Æ0:
If MODE_A = RCAS, CAS, AUTO, or OOS,
Set MODE_T (request) = MAN
Write MODE_T (request) to FBM
MODE_A MODE_BLK.Actual
MODE_A.value Å MODE_BLK.Actual
When MODE_BLK.Actual=RCAS: Set BLKSTA.SC=1
MODE_N ÅÆ MODE_BLK.Normal
MODE_P ÅÆMODE_BLK.Permitted
MODE_T MODE_BLK.Target
MODE_T.value (request) Æ MODE_BLK.Target
MODE_T.value (actual) Å MODE_BLK.Target
NAME Æ Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SWÆ1:
Set MODE_T (request) = OOS
Set CAS_SW=0, MAN_SW=0, RCASSW=0, AUT_SW=0
Set SE=0 and BLKSTA.SE=0
Write MODE_T (request) to FBM

349
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


OUT OUT
OUT.value (request) Æ OUT.Value (in MAN mode only)
OUT.value (actual) Å OUT.Value

OUT.status.LHI Å OUT.Status.Limited Hi(Bit 0)


OUT.status.LLO Å OUT.Status.Limited Lo(Bit 1)
OUT.status.ERR Å OUT.Status.Uncertain (Bits 6-7=1)
OUT.status.BAD Å OUT.Status.Bad (Bits 6-7=0) or CP-FBM communications
failure
OUT.status.OOS Å OUT.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communications failure,
or DCI_COMM_DATA.connect_status <= 0
OUTHLM OUT_HI_LIM
OUTHLM.value (request) Æ OUT_HI_LIM.Value
OUTHLM.value (actual) Å OUT_HI_LIM.Value
OUTHLM.status.OOS Å OUTHLM source value is OOS,
or Compound is Off
OUTLLM OUT_LO_LIM
OUTLLM.value (request) Æ OUT_LO_LIM.Value
OUTLLM.value (actual) Å OUT_LO_LIM.Value
OUTLLM.status.OOS Å OUTLLM source value is OOS,
or Compound is Off
OUTSTS OUT
OUTSTS.value Å OUT.Status
PV PV, BKCAL_OUT
PV.value Å PV.Value
PV.status.LHI Å PV.Status.Limited Hi (Bit 0)
PV.status.LLO Å PV.Status.Limited Lo (Bit 1)
PV.status.ERR Å PV.Status.Uncertain (Bits 6-7=1)
PV.status.BAD Å PV.Status.Bad (Bits 6-7=0) or CP-FBM communications failure
PV.status.OOS Å PV.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communications failure,
or DCI_COMM_DATA.connect_status <= 0
PVFTIM ÅÆ PV_FTIME
PVSTS PV
PVSTS.value Å PV.Status

350
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


RATE RATE
RATE.value (request) Æ RATE
RATE.value (actual) Å RATE
RATE.status.OOS Å RATE source value is OOS, or Compound is Off
RCASSW MODE_BLK.Target
When RCASSW is set =1:
Set MODE_T (request) = RCAS and AUTO
Set CAS_SW=0, AUT_SW=0, MAN_SW=0, OOS_SW=0
Set SE=1 and BLKSTA.SE=1
Write MODE_T (request) to FBM
RCISTS RCAS_IN
RCISTS.value Å RCAS_IN.Status
RCOSTS RCAS_OUT
RCOSTS.value Å RCAS_OUT.Status
RESET RESET
RESET.value (request) Æ RESET
RESET.value (actual) Å RESET
RESET.status.OOS Å RESET source value is OOS,
or Compound is Off
SHEDOP ÅÆ SHEDOP
SP SP
SP.value (request) Æ SP.Value (in AUTO mode only)
SP.value (actual) Å SP.Value

SP.status.LHI Å SP.Status.Limited Hi(Bit 0)


SP.status.LLO Å SP.Status.Limited Lo(Bit 1)
SP.status.BAD Å SP.Status.Bad (Bits 6-7=0) or CP-FBM communications failure

SP.status.OOS Å SP.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),


or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communications failure,
or DCI_COMM_DATA.connect_status <= 0
SPHLIM SP_HI_LIM
SPHLIM.value (request) Æ SP_HI_LIM.Value
SPHLIM.value (actual) Å SP_HI_LIM.Value
SPHLIM.status.OOS Å SPHLIM source value is OOS,
or Compound is Off
SPLLIM SP_LO_LIM
SPLLIM.value (request) Æ SP_LO_LIM.Value
SPLLIM.value (actual) Å SP_LO_LIM.Value
SPLLIM.status.OOS Å SPLLIM source value is OOS,
or Compound is Off

351
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


SPSTS SP
SPSTS.value Å SP.Status
STOPTS ÅÆ STATUS_OPTS
STRATG ÅÆSTRATEGY
ST_REV Å ST_REV
SUP_IN RCAS_IN, RCAS_OUT
SUP_IN.value (request) Æ RCAS_IN.Value (in RCAS mode only)
SUP_IN.value (actual) Å RCAS_OUT.Value if initializing;
Å RCAS_IN.Value if not initializing

SUP_IN.status.ACK Æ RCAS_IN.Status.Initialize Acknowledge (Bit x)


When 0Æ1 transition:
Set SUP_IN.status.ACK=0
Set SUPBCO.sttus.INITC=0
SUP_IN.status.LHI Å RCAS_IN.Status.Limited Hi (Bit 0) or SUP_IN source value is
LHI
SUP_IN.status.LLO Å RCAS_IN.Status.Limited Lo (Bit 1) or SUP_IN source value is
LLO
SUP_IN.status.ERR Å RCAS_IN.Status.Uncertain (Bits 6-7=1) or SUP_IN source value
is ERR
SUP_IN.status.BAD Å RCAS_IN.Status.Bad (Bits 6-7=0), or SUP_IN source value is
BAD, or CP-FBM communications failure
SUP_IN.status.OOS Å RCAS_IN.Status.Bad (Bits 6-7=0) and Substatus.OOS
(bits2-5= 7),
or SUP_IN source value is OOS,
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communications failure,
or DCI_COMM_DATA.connect_status <= 0

352
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-11. PIDFF Parameter Transformations (Continued)

PIDFF Parameter Device PID Function Block Parameter


SUPBCO RCAS_OUT
SUPBCO.value Å RCAS_OUT.Value

SUPBCO.status.INITC Å RCAS_OUT.Status.Initialize Request (Bit x)


When 0Æ1 transition:
Set SUPBCO.status.INITC=1
SUPBCO.status.LHI Å RCAS_OUT.Status.Limited Hi (Bit 0)
SUPBCO.status.LLO Å RCAS_OUT.Status.Limited Lo (Bit 1)
SUPBCO.status.ERR Å RCAS_OUT.Status.Uncertain (Bits 6-7=1)
SUPBCO.status.BAD Å RCAS_OUT.Status.Bad (Bits 6-7=0)
or CP-FBM communications failure
SUPBCO.status.OOS Å RCAS_OUT.Status.Bad (Bits 6-7=0), Substatus.OOS
(bits 2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or FF H1 Device is Failed or Disabled,
or CP-FBM communications failure,
or DCI_COMM_DATA.connect_status <= 0
TAGDSC Æ TAG_DESC
Note: Changes to TAGDSC are copied to DESCRP.

9.6 PIDFF Block Functions


The I/A Series PIDFF block provides the interface between the control processor and the PID
device PID function block in the H1 device.
The PIDFF block OUT and OUTSTS parameters hold the value and status of the device OUT
parameter, while the PV and PVSTS parameters reflect the value and status of the function block’s
primary value.
The PIDFF block does not scale or condition the output from the device, as scaling for engineer-
ing units is handled by the device PID block. The PIDFF block does, however, enable configura-
tion of the scaling in the PID block.
The PIDFF block and the device PID function block operate in two asynchronous cycles, both
writing to and reading from shared space in the FBM memory. As with other I/A Series control
blocks, the PIDFF block executes in the Basic Processing Cycle (BPC) of the control station
according to its compound and its PERIOD and PHASE parameters, as described in Integrated
Control Software Concepts (B0700AG). The device PID function block executes once each FBM
macrocycle as scheduled by the FBM228.
The principal task of the PIDFF block is to read a value and status from the corresponding device
block. For this task, the FBM228 establishes a subscriber connection between the PIDFF block
and any published parameters in the PID. (If the PID’s OUT is connected to the CAS-IN param-
eter of an AO block in the same device, this intra-device connection might not be published. The
OUT value and status will still be available to the PIDFF block via periodic view data update.)
All other parameter connections are made by the FBM on a client/server basis at the frequency
specified in the UPDPER parameter. The parameter can be set from 0 to 2147483647 millisec-

353
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

onds; the default is 10000 (10 seconds). Increasing the frequency of the client/server communica-
tion can significantly add to the load on the H1 segment.

9.6.1 Device PID Function Block Connection


The configured parameter IOM_ID of the PIDFF block specifies an ECB201 (the device ECB)
that represents the target H1 device and its H1 segment. The ECB201 PARENT parameter iden-
tifies the ECB200 or ECB202 for the host FBM228. The path to the device block is completed in
when the PIDFF block is assigned to a device PID block in a browser which displays the device
PID function blocks based on the device description in the device ECB. This assignment names
the device PID function block.
More information on connecting to device PID function blocks is provided in Implementing
FOUNDATION fieldbus in InFusion 2.0 (B0750DA).

9.6.2 Device Configuration Parameters


The PIDFF block enables the user to set the standard configurable parameters in the correspond-
ing device PID function block and manage the device configuration from the I/A Series system.
When you deploy the PIDFF block to the control station and the FBM228, parameter values in
the PIDFF block update parameters in the device PID block.
The deployment of the PIDFF block to the control processor also:
♦ Deploys a segment schedule to the FBM which includes execution of the PID func-
tion block and Compel Data (CD) messages for the PID block’s publisher/subscriber
connections.
♦ Schedules client/server connections between the PIDFF block and the device function
block for view updates
Table 9-12 lists the device PID function block parameters and the PIDFF block parameters used
to configure them. For the PIDFF block, the table includes both the six-character (maximum)
parameter name that is used in block detail displays and the parameter labels used in IEE, which
more closely resemble the FOUNDATION fieldbus parameter names. Use the six-character parame-
ter name when connecting parameters to a process display.

Table 9-12. PID Block Configuration Parameters

Configured with PIDFF Block Parameter


Device PID Block
Parameter Name in Process Displays IEE Configurator Label
BAL_TIME BALTIM Balance Time
BKCAL_HYS BKCALH Back Calculated Hysteresis
CONTROL_OPTS CTLOPT Control Options
FF_SCALE.@0% LSCI3 FF_SCALE @0%
FF_SCALE.@100% HSCI3 FF_SCALE @100%
FF_SCALE.decimal pt DPTI3 FF_SCALE decimal pt
FF_SCALE.units index EUI3 FF_SCALE units index
FFGAIN FFGAIN Feed Forward Gain
GAIN GAIN Gain
MODE_BLK.Normal MODE_N Normal Mode
MODE_BLK.Permitted MODE_P Permitted Mode
MODE_BLK.Target MODE_T Target Mode

354
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-12. PID Block Configuration Parameters (Continued)

Configured with PIDFF Block Parameter


Device PID Block
Parameter Name in Process Displays IEE Configurator Label
OUT_HI_LIM OUTHLM High Output Limit
OUT_LO_LIM OUTLLM Low Output Limit
OUT_SCALE.@0% LSCO1 OUT_SCALE @0%
OUT_SCALE.@100% HSCO1 OUT_SCALE @100%
OUT_SCALE.decimal pt DPT01 OUT_SCALE decimal pt
OUT_SCALE.units index EUO1 OUT_SCALE units index
PV_FTIME PVFTIM PV Filter Time
PV_SCALE.@0% LSCI1 PV_SCALE @0%
PV_SCALE.@100% HSCI1 PV_SCALE @100%
PV_SCALE.decimal pt DPTI1 PV_SCALE decimal pt
PV_SCALE.units index EUI1 PV_SCALE units index
RATE RATE Rate
SHEDOP SHEDOP Mode Shed Options
SP SP Set Point
SP_HI_LIM SPHLIM Set Point High Limit
SP_LO_LIM SPLLIM Set Point Low Limit
STATUS_OPT STOPTS Status Options
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag Descriptor
TRK_SCALE.@0% LSCI2 TRK_SCALE @0%
TRK_SCALE.@100% HSCI2 TRK_SCALE @100%
TRK_SCALE.decimal pt DPTI2 TRK_SCALE decimal pt
TRK_SCALE.units index EUI2 TRK_SCALE units index

9.6.3 Scaling
Table 9-13 lists the PIDFF block parameters used to configure the device PID block scaling
parameters. When the device block parameters are changed, they are read back to the PIDFF
block.

Table 9-13. Scaling Parameters

PIDFF Block Device PID Block


LSCO1 ↔ OUT_SCALE.@0%
HSCO1 ↔ OUT_SCALE.@100%
DPTO1 ↔ OUT_SCALE.Decimal
EUO1 ↔ OUT_SCALE.Units Index
LSCI1 ↔ PV_SCALE.@0%
HSCI1 ↔ PV_SCALE.@100%
DPTI1 ↔ PV_SCALE.Decimal
EUI1 ↔ PV_SCALE.Units Index
LSCI2 ↔ TRK_SCALE.@0%
HSCI2 ↔ TRK_SCALE.@100%

355
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-13. Scaling Parameters (Continued)

PIDFF Block Device PID Block


DPTI2 ↔ TRK_SCALE.Decimal
EUI2 ↔ TRK_SCALE.Units Index
LSCI3 ↔ FF_SCALE.@0%
HSCI3 ↔ FF_SCALE.@100%
DPTI3 ↔ FF_SCALE.Decimal
EUI3 ↔ FF_SCALE.Units Index

9.6.4 Block Validation


The PIDFF block initializes when any of these events occurs:
♦ The block is installed or reconfigured via the IEE configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.
When the PIDFF block initializes, the following block validation tests are performed:
♦ A cross-over validation test of the PV range - If HSCI1 <= LSCI1, the block will be
marked undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE)
set to “W44 - INVALID ENGINEERING RANGE”.
♦ A cross-over validation test of the OUT range - If HSCO1 <= LSCO1, the block will
be marked undefined (BLKSTA.UDEF=1) with ERCODE set to “W44 - INVALID
ENGINEERING RANGE”.
♦ Validation of the Supervisory Control option (SUPOPT) - If SUPOPT != 0 and
SUPOPT != SPC, or if SUPOPT= SPC and RCAS is not Permitted, the block will be
marked undefined (BLKSTA.UDEF=1) with ERCODE set to “W48 - INVALID
BLOCK OPTION”.
♦ If SUPOPT is non-zero, the SUPGRP parameter is validated. If SUPGRP < 1 or > 8,
the block is marked as undefined (BLKSTA.UDEF=1) with ERCODE is set to “W48
- INVALID BLOCK OPTION”.
♦ Validation of the Supervisory Fallback Option (FLBOPT - If FLBOPT < 0 or
FLBOPT > GO_TO_REMOTE, or if FLBOPT is in range and either LR or MA is
linked, the block is marked as undefined (BLKSTA.UDEF=1) with ERCODE set to
“W48 - INVALID BLOCK OPTION”.
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Remote,
Cascade, Cascade, Auto, Manual or Out-of-Service, or if the Target mode is not one
of the Permitted states, the block is marked as undefined (BLKSTA.UDEF=1) with
ERCODE set to “W76 - INVALID FF MODE CONFIGURATION”.
If the FBM simulation is not used (SIMOPT=0), the following validation tests are performed as
well:
♦ If the PIDFF block is installed prior to the installation of the ECB201 block, it is
marked as undefined (BLKSTA.UDEF=1) with ERCODE is set to “W54 - ECB

356
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

DOES NOT EXIST”. In this case, the PIDFF block configuration will be restarted
and re-validated automatically when the ECB201 is installed.
♦ An attempt is made to connect the PIDFF block to the ECB201 specified in the
IOM_ID parameter. The DCI connection address (i.e., the BLKNDX parameter in
the PIDFF block) is used in a connect message to establish a block connection in the
FBM228.
♦ If the device block connection cannot be resolved due to a lack of configuration infor-
mation, one of the following error strings is stored in the DCI block ERCODE
parameter:
♦ “W62 - UNRESOLVED CONNECTION”
♦ “W77 - FIELDBUS COMMUNICATIONS FAULT”
♦ “W78 - INVALID FUNCTION BLOCK”
♦ “W80 - FIELDBUS DEVICE NOT FOUND”
♦ “W82 - FF CONFIGURATION IN PROGRESS”
(In these cases, the DCI block is defined, but the output values are marked OOS.)
♦ “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the PIDFF block is defined, and the index of the invalid function block
parameter is stored in the CFGERR parameter.)
♦ If the device block connection cannot be made for any other reason, the FBM rejects
the connection request and one of the following error strings is stored in the
ERCODE parameter to indicate the reason for the connection error:
♦ “W65- INVALID POINT ADDRESS”
♦ “W66 - DUPLICATE CONNECTION”
♦ “W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS”
♦ “W68 - INVALID DEVICE CONNECTION”
♦ “W69 - INVALID POINT CONNECTION”
♦ “W74 - FF FUNCTION BLOCK DDITEM MISMATCH”
♦ “W75 - FF FUNCTION BLOCK DDMBR MISMATCH”
♦ “W76 - INVALID FF MODE CONFIGURATION”
♦ “W79 - INVALID PARAMETER INDEX”
♦ “W83 - INVALID FF PARAMETER CONNECTION”
♦ “W84 - INVALID FF PARAMETER TYPE”
♦ “W85 - INVALID CONNECTION TYPE”
♦ “W86 - MAN_ID, DVC_ID, OR DVCREV MISMATCH”
(In these cases, the PIDFF block is undefined.)
♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the
PIDFF block is undefined with ERCODE set to “W43 - INVALID
PERIOD/PHASE COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the

357
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

PIDFF block is undefined with ERCODE set to “W81 - INVALID PARENT DCI
ECB PERIOD/PHASE”.
If there are no configuration errors when the DCI PIDFF block is installed, the block is marked as
defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the compound containing the
block is turned on, the block also initializes and starts running automatically.

9.6.5 PIDFF Block Initialization


When the PIDFF block initializes, the following functions are performed:
♦ All alarm status parameters (ALMSTA, INHSTA, CRIT, PRTYPE, UNACK) are
cleared.
♦ All parameter history values are initialized to the current parameter settings.
♦ The Target mode parameter (MODE_T) is set to only one of the following states, in
order, if multiple bits are set: Remote Cascade, Cascade, Auto, Manual, OOS.
If not simulating (SIMOPT=0), the following additional functions are performed:
♦ The Target mode is sent to the PIDFF function block.
♦ If installing the block, or if rebooting and not a Warm Restart, the following actions
are taken:
♦ The Tuning and Configuration parameters are downloaded to the PID Function
Block.
♦ The Actual mode parameter (MODE_A) is set to Initialization Manual (IMAN)
in the DCI PIDFF block.
♦ The PVSTS, SPSTS, and OUTSTS parameters is set to Bad OOS.

9.6.6 File Download/Upload


The FDATA1 and FDATA2 parameters are provided in the PIDFF block to support downloading
non-standard configuration data to the corresponding device PID function block. Each of the
FDATA parameters is an OM settable array of 255 bytes. The entire data file consists of up to 510
bytes (2 x 255) of configuration information.
The CP270 downloads the entire data file automatically to the FBM228 when FDATA1 is writ-
ten via an OM write access operation. This download also occurs automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The CP270 also uploads these param-
eters automatically from the FBM228 upon request from the FBM228.
To report the status of the FDATA configuration file, Download Active and Download Failure
indicators are mapped onto new status bits in the Block Status (BLKSTA) parameter for each
block. File Installed and File Mismatch status bits also are provided in the BLKSTA parameter.

9.6.7 Block Mode


The PIDFF block provides interactive support of the MODE_BLK function block parameter.
The Target, Permitted, Normal, and Actual modes are provided as separate MODE_T,
MODE_P, MODE_N, and MODE_A block parameters, respectively.
The configuration of the Target, Permitted, and Normal modes are supported. These parameters
are downloaded to the PID function block when the PIDFF block initializes.

358
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

The Target mode is changeable through a group of settable boolean mode switches provided in
the PIDFF block. These mode switches, RCASSW, CAS_SW, AUT_SW, MAN_SW, and
OOS_SW, allow the block mode to be changed to the Remote Cascade, Cascade, Auto, Manual,
or Out-of-Service states respectively.
The mode switch setting is mapped onto an equivalent Target mode setting sent to the FBM228.
See the PIDFF Parameter Transformations table for mapping details.
Logic in the CP270 prevents more than one switch to be set at a given time. If more than one
switch is set during the same block cycle, only the last switch setting is honored. Once set, a mode
switch remains set only until the Target mode change is sent to the FBM228 or until another
mode switch is set. At that time, the mode switch is cleared.
MA and LR parameters also are provided to allow an I/A Series application to change the Target
mode through a parameter connection. If neither the MA nor LR parameter is linked, the user
application can change the block mode to Auto, Manual, Cascade, or Remote Cascade using the
LR or MA parameters, or the operator can change the mode using the AUT_SW, MAN_SW,
CAS_SW, RCAS_SW, or OOS_SW mode switches described above.
If either the MA or LR parameter is linked, the operator cannot change the block mode to any
state except OOS using the mode switches, since the switches cannot override the linked LR or
MA parameter. MA and LR cannot both be linked, or they would fight each other. Therefore, if
MA is linked, LR is disabled, and if LR is linked, MA is disabled.
Also, if either LR or MA is linked, the FLBOPT and FLBREQ parameters used in Secure Super-
visory Control (SSC) are disabled.
The Target mode is a shadow parameter updated from the MODE_BLK function block parame-
ter read back during input scanning of the FBM228.
When the Actual, Permitted, Target, or Normal modes change in the PID function block, the
corresponding DCI PIDFF mode parameters are updated automatically from the MODE_BLK
Function Block parameter. In addition, the Actual mode is mapped onto equivalent BLKSTA
parameter bits, as specified in Table 9-11 on page 343.
The INITMA parameter and the Auto/Manual override parameters, AUTSW and MANSW, are
not supported in the DCI PIDFF block, since these functions do not exist in the device PID
function block. The same is true of the INITLR parameter and the Remote/Local override
parameters, REMSW and LOCSW.
The Actual block mode (MODE_BLK.Actual) will be provided in two forms:
♦ The Actual mode is stored in the MODE_A output parameter.
♦ The Actual mode also is mapped onto equivalent bits in the BLKSTA block status
parameter:
The mapping of Actual mode state to BLKSTA bits will be as follows:
♦ The OOS state is mapped onto the OOS value status bit of the BLKSTA parameter.
♦ The IMAN state is mapped onto the BLKSTA.TRK status bit.
♦ The LO state is mapped onto both the BLKSTA.TRK and BLKSTA.LO status bits.
♦ The MAN state sets BLKSTA.MA=0, BLKSTA.LR=0, and BLKSTA.SC=0.
♦ The AUTO state sets BLKSTA.MA=1, BLKSTA.LR=0, and BLKSTA.SC=0.
♦ The CAS state sets BLKSTA.LR=1, BLKSTA.MA=1, and BLKSTA.SC=0.

359
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

♦ The RCAS state sets BLKSTA.LR=0, BLKSTA.MA=1, BLKSTA.SE=1, and


BLKSTA.SC=1.

9.6.8 Input Connections


The CP270 supports connections to all inputs in the PIDFF block from connectable input or
output parameters of any I/A Series control or I/O block. These inputs are updated each block
cycle from data in the I/A Series source block parameter. The CP270 propagates the BAD, OOS,
and ERR status of these input parameters to their corresponding device PID function block
parameters by writing the status to the FBM228 when the change occurs.
When the update source of an input connection is NOT a device PID function block parameter,
the BlockName specified in the connection is the name of the I/A Series block; the Parameter-
Name is the 1-6 character name of the parameter in the I/A Series block.
The CP270 also supports connections to specific inputs in the PIDFF blocks from parameters
contained in device PID function blocks mapped to any standard I/A Series control or I/O block.
These inputs are updated each block cycle from data in the device PID function block parameter;
the data contained in the specified I/A Series source parameter will NOT be used. The inputs of
this type are listed in Table 9-14 below.
When the source of an input connection is a device PID function block parameter, the I/A Series
connection is made by the CP270, and the source BlockName and ParameterName are extracted
from the connection and sent to the FBM228. This message establishes a fieldbus connection to
the device PID function block source parameter.
When the source of an input connection is a device PID function block parameter, the Block-
Name will be the TagName of the device PID function block, which is the same as the name of
the source I/A Series block. The ParameterName is the 1-6 character name of the parameter in
the source I/A Series block for those connections listed in Table 9-15 below. In these cases, the
name of the device block parameter is converted to the equivalent device PID function block
Parameter Index by the CP270 prior to sending it to the FBM228. In all other cases, the Parame-
terName must be configured to be the Parameter Index of the device PID function block parame-
ter.
If the fieldbus connection cannot be made due to an invalid BlockName or ParameterName, the
ERCODE parameter in the block is set to the following text and the block is undefined:
“W83 - INVALID FF PARAMETER CONNECTION”

Table 9-14. PIDFF Input Connections

Input Parameter(s) Connection Source Update Source


IN, CAS_IN, FFVAL, I/A Series parameter in I/A Series I/A Series source block
TRKVAL, TRKIND control block or I/O block parameter
FF parameter in I/A Series FF block FF function block parameter
BCALCI FF parameter in I/A Series FF block FF function block parameter
Any other input I/A Series parameter in I/A Series I/A Series source block
control block or I/O block parameter

360
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-15. Standard FF Block Parameter Connections

Input Parameter Source Parameter


Block Type Parameter Block Type Parameter Parameter Index
PIDFF IN AI OUT 8
MAI OUT1-OUT8 8-15
CAS_IN PIDFF OUT 9
FFVAL AI OUT 8
MAI OUT1-OUT8 8-15
TRKVAL AI OUT 8
MAI OUT1-OUT8 8-15
TRKIND DI OUT_D 8
MDI OUT_D1-OUT_D8 8-15
BCALCI AO BCALCO 25
PIDFF BCALCO 31
AO CAS_IN PIDFF OUT 9

9.6.9 I/A Series Parameter Status


The status of the device PID function block parameters is provided in the PIDFF block in two
forms:
♦ The status of each device PID function block parameter is available as a separate
PIDFF block parameter.
♦ The status of each device PID function block parameter also is mapped onto equiva-
lent fields in the value record status of the corresponding PIDFF block parameter.
For each device PID function block parameter containing status information, the following fields
are mapped:
♦ The Quality field (Bits 6-7) are mapped onto the BAD and ERR status bits.
♦ The Sub-status field (Bits 2-5) are ignored, except for the case when the Quality is Bad
and the Sub-status is OOS. In this case, the OOS status bit are set in the PIDFF block
parameter.
♦ The Limited High (Bit 0) and Limited Low (Bit 1) fields are mapped onto the LHI,
LLO status bits, respectively.

9.7 Device Parameter Status


The device PID block input and output parameters (Figure 9-1) have both a value and a status.
The status is contained in a 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits. The
status is read into the PIDFF block parameter, bit for bit. The default displays for the PIDFF

361
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

block shows the converted status parameter so that the value need not be decoded. Table 9-16
shows how the status byte is formatted.
Table 9-16. Device Parameter Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 SubStatus depends on .Quality, as shown in Table 9-17
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table 9-17 shows the usage of the Substatus bits, which varies depending on which .Quality bits
are set.
Table 9-17. Device Parameter Substatus

Bits 2-5 = SubStatus Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced in by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.

362
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Table 9-17. Device Parameter Substatus (Continued)

Bits 2-5 = SubStatus Description


4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

363
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

9.7.1 Fault State Handling


Three distinct Fault State options can be configured in the FSOPTN parameter in the PIDFF
block:
♦ Initiate Fault State upon loss of CP communications (Bit 2=1)
♦ Initiate Fault State if Bad CAS_IN (Bit 0=1)
♦ Initiate Fault State if SETFS (Bit 1=1)
The first option is used only by the FBM228 logic to assert the fault state when CP-to-FBM com-
munications are lost. To support this option, a Fault State enable (FSENAB) and a Fault State
timer (FSDLAY) may be configured in an ECB200 or ECB202. The fault state timer counts
down periodically between its receipt of read/write messages. When either message is received for
a PID function block, its fault state timer is reset to the FSDLAY value. If the Fault State timer
expires, the FBM228 will set the IFS status bit of the CAS_IN (or RCAS_IN if the Actual mode is
RCAS) of the PID function block in the field device. The field device sets the IFS status in the
OUT output parameter of the PID function block. This status propagates to the CAS_IN of the
downstream AO block, driving the field output to the FSTATE_VAL value configured in the AO
block. When the CP communications are restored, the Fault State timers are reset automatically
to full value by the first read or write message to each connection. If the fault state had been previ-
ously asserted by a request from the CP and the fault state condition still exists in the CP, the
write message requests the IFS status bit to remain set in the function block. Otherwise, the write
message requests the IFS status bit to be cleared.
If the second option is set, the CP270 requests the FBM228 to assert the Fault State when the
CAS_IN parameter is sourced by an I/A Series parameter and the CAS_IN is BAD, OOS, or has
a broken linkage to the source parameter.
If the third option is set, the CP270 requests the FBM228 to assert the Fault State when the
CAS_IN parameter is sourced by an I/A Series parameter and the SETFS parameter is set.
In either of the two latter cases, when the FBM receives an explicit request from the CP to assert
the Fault State, the FBM sets the IFS status bit of the CAS_IN (or RCAS_IN if the Actual mode is
RCAS) parameter of the PID function block in the field device. The field device sets the IFS sta-
tus in the OUT output parameter of the PID function block. This status propagates to the
CAS_IN of the downstream AO block, driving the field output to the FSTATE_VAL value con-
figured in the AO block. These actions are taken independent of the FSENAB option.
In addition, the CP270 requests the FBM228 to assert the Fault State in these cases:
♦ When the PIDFF block is deleted, if any of the FSOPTN options are configured in
the block.
♦ When the compound containing the PIDFF block is deleted, if any of the FSOPTN
options are configured in the block.
♦ When the compound containing the PIDFF block is turned off, if any of the
FSOPTN options are configured in the block and the Station block CFGOPT option
Bit 4 is set to 0.
In addition to the Fault State options in the FSOPTN parameter, options may be configured in
the FSTIME, FSVAL, and STOPTS parameter to specify Fault State actions to be performed in
the device PID function block.
The following options may be specified in the STOPTS parameter:
♦ Initiate Fault State if Bad CAS_IN (Bit 0=1)

364
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

♦ Initiate Fault State if Bad IN (Bit 1=1)

NOTE
An additional requirement for Fault State handling at the device level is that the
Fault State option must be selected in the device resource block, that is,
(0x4)FaultState must be selected in FEATURE_SEL.

9.7.2 Alarms
The PIDFF block performs alarm functions consistent with standard I/A Series CP270 alarming,
including:
♦ Absolute Alarming, High-High /Low-Low Alarming, High/Low Deviation Alarming,
and High/Low Output Alarming
♦ Bad Alarming of the analog input parameter (IN) and the analog output via the back-
calculated input parameter (BCALCI).
♦ Informational messages of block errors (BLKERR) reported by the PID block’s
BLOCK_ERR parameter.
♦ Informational messages of PID block configuration errors (CFGERR).
The PID block process alarm detection, alarm events, alarm messaging, and associated parameters
provided by the H1 field device are not supported in the PIDFF block.
Refer to Integrated Control Software Concepts (B0700AG) for information on alarm functionality.

9.7.3 Process Alarms


Table 9-18 summarizes the parameters used in configuring the process alarms provided by the
PIDFF block, while Table 9-19 specifies the conditions for generating and clearing the alarms (if
enabled).

Table 9-18. PIDFF Block Alarm Parameters

Alarm Type Option Limits Priority Group Text


BAD BADOPT=1 -- BADPRI BADGRP BADTXT
High Absolute HLOPT=1 or 2 HILIM HLPRI HLGRP HITXT
Low Absolute HLOPT=1 or 3 LOLIM HLPRI HLGRP LOTXT
High-High Absolute HHIOPT=1 or 2 HHLIM HHIPRI HHIGRP HHITXT
Low-Low Absolute HHIOPT=1 or 3 LLOLIM HHIPRI HHIGRP LLOTXT
High Deviation DEVOPT=1 or 2 HDLIM DEVPRI DEVGRP HDTXT
Low Deviation DEVOPT=1 or 3 LDLIM DEVPRI DEVGRP LDTXT
High Output OLAOPT=1 or 2 HOALIM OUTPRI OUTGRP HOATXT
Low Output OLAPT=1 or 3 LOALIM OUTPRI OUTGRP LOATXT

Table 9-19. PIDFF Process Alarm Conditions

Alarm Set When Cleared When


Bad Alarm IN.Status.BAD=1 or IN.Status.BAD=0 and BCALCI.Status.BAD=0
BCALCI.Status.BAD=1

365
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-19. PIDFF Process Alarm Conditions (Continued)

Alarm Set When Cleared When


High Absolute IN > HILIM IN < HILIM - (ALMHYS*(HSCI1-LSCI1)/100.0)
Low Absolute IN < LOLIM IN > LOLIM+(ALMHYS*(HSCI1-LSCI1)/100.0)
High-High Absolute IN > HHILIM IN < HHILIM-(ALMHYS*(HSCI1-LSCI1)/100.0)
Low-Low Absolute IN < LLOLIM IN > LLOLIM+(ALMHYS*(HSCI1-LSCI1)/100.0)
High Deviation IN > SP + HDLIM IN < SP + HDLIM - (ALMHYS*(HSCI1-LSCI1)/100.0)
Low Deviation IN < SP – LDLIM IN > SP – LDLIM + (ALMHYS*(HSCI1-LSCI1)/100.0)
High Output OUT > HOALIM OUT < HOALIM - (ALMHYS*(HSCO1-LSCO1)/100.0)
Low Output OUT < LOALIM OUT > LOALIM+(ALMHYS*(HSCO1-LSCO1)/100.0)

If the Bad Alarm option (BADOPT) is set, alarming will be performed as follows:
♦ Bad Alarm status information is set in the block when the BAD status of the IN
parameter or BCALCI parameter is set. The BAD is set in the alarm status parameter
(ALMSTA.BAD). The UNACK parameter and the corresponding ALM-
STA.UNACK bit also are set.
♦ The CRIT parameter and its corresponding ALMSTA.CRIT field will be set to the
BADPRI parameter value, and the PRTYPE parameter and its corresponding ALM-
STA.PRTYPE field will be set to the appropriate alarm type. Note that this will
happen only if there are no other alarms of higher priority in the block.
♦ When the Bad Alarm condition occurs, a Bad Alarm message will be sent to all devices
in the BADGRP alarm group. This message will contain the OUTDSC output
descriptor, the BADTXT descriptive text, and the LOOPID loop identifier. Separate
messages will be sent for the IN and BCALCI parameters.
♦ When the Bad alarm condition clears for either the IN or BCALCI parameter, a
return-to-normal message will be generated and sent to all devices in the bad alarm
group.
If the Absolute Alarm (HLOPT), High-High/Low-Low Alarm (HHIOPT), Deviation Alarm
(DEVOPT), or Output Alarm (OALOPT) option is set, alarming will be performed as follows:
♦ Alarm status information will be set in the block when the alarm condition exists (see
Table 9-3 for the alarm detection algorithms and corresponding ALMSTA settings).
The appropriate alarm bit will be set in ALMSTA. The UNACK parameter and the
corresponding ALMSTA.UNACK bit also are set.
♦ The CRIT parameter and its corresponding ALMSTA.CRIT field will be set to the
HLPRI, HHIPRI, DEVPRI, or OUTPRI parameter value, and the PRTYPE parame-
ter and its corresponding ALMSTA.PRTYPE field will be set to the appropriate alarm
type. Note that this will happen only if there are no other alarms of higher priority in
the block.
♦ When the alarm condition occurs, an alarm message will be sent to all devices in the
HLGRP, HHIGRP, DEVGRP, or OUTGRP alarm group. This message will contain
the PVDESC or OUTDSC descriptor, the appropriate descriptive text, and the
LOOPID loop identifier.
♦ When the alarm condition clears, a return-to-normal message will be generated and
sent to all devices in the HLGRP, HHIGRP, DEVGRP, or OUTGRP alarm group.

366
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

The CRIT, PRTYPE, and corresponding ALMSTA fields will be cleared when there are no active
alarms in the block.
The UNACK parameter and the ALMSTA.UNACK bit will be cleared in these cases:
♦ When the alarm is acknowledged by an OM set operation at either the compound
level, by setting the compound UNACK=0, or at the block level, by setting the block
UNACK=0.
♦ When all alarm conditions in the block return to normal status, if INHOPT is set
appropriately.
♦ When the block is shut down.
When UNACK is cleared, an Alarm Acknowledge message will be generated and sent to all
devices in all alarm groups in the block.
Alarm Inhibiting/Disabling will be supported using a combination of the compound CINHIB
parameter and the INHOPT, INHIB, and INHALM parameters in the DCI block, to allow the
alarm messages to be inhibited and/or alarm detection to disabled dynamically.
When an alarm type is inhibited or disabled, an appropriate Alarm Disable message will be gener-
ated and sent to all devices in the alarm group. If the block is unacknowledged, an Alarm
Acknowledge message also will be sent to these devices. In addition, the ALMSTA.INHIB bit will
be set, and the corresponding INHSTA bit will be set.
When an alarm type is uninhibited or enabled, an appropriate Alarm Enable message will be gen-
erated and sent to all devices in the alarm group. In addition, the ALMSTA.INHIB bit will be
cleared if no other alarm in the block is inhibited, and the corresponding INHSTA bit will be
cleared.
In Auto, the block processes all alarms. When the block is in Manual, the MANALM value deter-
mines which alarms are processed:
0 = Disable all alarms in Manual
1 = Process all alarms in Manual
2 = No Output alarming in Manual
3 = No Output alarming in Track
4 = No Output alarming in Manual or Track
In addition to these functions, the Alarm Reprioritization, Alarm Message Regeneration, and
Delayed Alarming enhancements are provided in the PIDFF block.

9.7.4 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter is performed as
follows:
♦ For every condition specified in ERROPT, a corresponding Informational message is
sent to the ERRGRP alarm group when the condition occurs. The UNACK parame-
ter and the corresponding ALMSTA.UNACK bit also is set.
♦ One of the messages listed in Table 9-20 is generated.

367
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-20. Block Error Messages

Bit Set Message Text


0 FF Block Error: Out-of-Service
1 FF Block Error: Power Up
2 FF Block Error: Maintenance Needed Now
3 FF Block Error: Readback Check
4 FF Block Error: Lost NV Data
5 FF Block Error: Lost Static Data
6 FF Block Error: Memory Fail
7 FF Block Error: Output Fail
8 FF Block Error: Input Fail
9 FF Block Error: Maintenance Due Soon
10 FF Block Error: Fault State Active
11 FF Block Error: Local Override
12 FF Block Error: Simulation Active
13 FF Block Error: Link Configuration Error
14 FF Block Error: Block Configuration Error
15 FF Block Error: Other (Undefined) Error

9.7.5 Configuration Error Processing


When a PIDFF block configuration parameter cannot be downloaded to the PID block, the
parameter index is stored in the CFGERR parameter and the following informational message is
generated:
“FF CFGERR in Parameter nnnnnnnn”
where: nnnnnnnn = ASCII name of the parameter indicated by the index in CFGERR

9.7.6 Block Shutdown


The PIDFF block will shutdown when any of these events occurs:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ The ECB201 connected to the block is deleted.
♦ The PIDFF block is deleted.
When block shutdown occurs, the following actions are taken:
♦ If any alarms are active, an Alarm Disable message will be issued to all devices in the
alarm groups configured in the block. If the alarms are Unacknowledged (i.e.
UNACK is set), an Alarm Acknowledge message also will be sent to these alarm
devices.
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, and UNACK) will be
cleared.
If not simulating (SIMOPT=0), the following actions also are taken:
♦ If the compound is off, the following occurs:
♦ If the FF_OOS_OPT bit (Bit 4: 0x0010) is set in the Station block CFGOPT
parameter, the following actions will be taken:

368
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

♦ The actual mode parameter (MODE_A) will be set to OOS.


♦ A write message will be sent to the FBM228 with both the OOS and IMAN
bits set in the Target mode. The IMAN bit will be set to indicate to the
FBM228 that the compound is off.
♦ Otherwise, a write message is sent to the FBM228 with both the current state and
the IMAN bits set in the Target mode. The IMAN bit will be set to indicate to the
FBM228 that the compound is off.
-OR-
If the FSOPTN is set and the DCI block connection is healthy, a write message
will be sent to the FBM228 to assert the Fault State. See “Fault State Handling”
on page 364 for details.

9.7.7 Simulation
Simulation of a control loop involving a PIDFF block and PID device block can be performed
using the SIMULATE parameters in the device PID function blocks as described Section 9.5, or
the simulation can be performed entirely within the control station by using the PIDFF block
simulation option (SIMOPT=1) and the equivalent functionality in other blocks in the strategy.
This function can be used to test control schemes without requiring actual FBM228 hardware
connections.
When simulating within the control station by using SIMOPT=1, the following functions will be
performed:
♦ When the Actual block mode is Remote Cascade, Cascade, or Auto, the block output
(OUT) is simulated using the following calculation:
OUT = P_Term + I_Term
where:
P_Term = GAIN * (SP – IN – D_Term)
D_Term is calculated as follows:
Derivative = RATE/60.0
Tau = Derivative * Period in Cycles
V_Term = Previous_V_Term + IN – (V_term – Previous W_Term)/(Tau/2 +1)
W_Term = Previous W_Term + V_Term/(Tau/2 +1)
D_Term = V_Term * (Derivative + Tau)/(Tau + (1/Period in Cycles)
I_Term is calculated as follows:
Integral = RESET/60.0
FeedBack = BCALCI if linked; = OUT otherwise
I_Term = (FeedBack – Previous I_Term)/ (Integral * Period in Cycles + 1)
On a transition from OOS, IMAN, or Manual mode to Remote Cascade, Cascade, or
Auto mode, the following terms will be initialized:
V_Term = 0.0
W_Term = IN
I_Term = OUT – P_Term
♦ Changes to the Target mode via the mode switches will be processed. The Target
mode parameter (MODE_T) will be updated immediately when any of the mode
switches (RCAS_SW, CAS_SW, AUT_SW, MAN_SW, or OOS_SW) is changed.

369
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

♦ The Actual block mode (MODE_A) will track the Target mode (MODE_T) each
block cycle.
♦ When allowed, changes to any of the Shadow parameters will be updated
immediately.
♦ All Function Block status parameters will be set to Good Non-Cascade (0x80).
♦ The SUP_IN, SUPBCO, CAS_IN, and BCALCO parameters will track the SP
parameter when the Actual mode is Auto or Manual.
♦ The SUP_IN, SUPBCO, SP, and BCALCO parameters will track the CAS_IN
parameter when the Actual mode is Cascade.
♦ The CAS_IN, SUPBCO, SP, and BCALCO parameters will track the SUP_IN
parameter when the Actual mode is Remote Cascade.
♦ If BADOPT=1, Bad Alarming of the inputs will be performed.
♦ If HLOPT >0, High-Low Absolute Alarming will be performed.
♦ If HHIOPT >0, Hi-HI Lo-Lo Absolute Alarming will be performed.
♦ If DEVOPT >0, Deviation Alarming will be performed
♦ .If OALOPT >0, Output Alarming will be performed.
When simulating, the following functions will not be performed:
♦ Block File Download/Upload operations.
♦ Downloading of configuration parameters.
♦ Updating of View data parameters.
♦ Block Error (BLKERR) processing.
♦ External configuration changes to function block parameters.
♦ Configuration Error (CFGERR) processing.
♦ Device Alarm Acknowledgement (DEVACK).
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA) for instructions on conducting control simulations from the devices or in the control
station.

9.7.8 Secure Supervisory Control (SSC)


The I/A Series Secure Supervisory Control functions (SSC) are supported in the PIDFF block,
including the Supervisory Group functions provided in the Station Block, and the SUPOPT,
SUPGRP, INITSE, SE, SUP_IN, and SUPBCO parameters (and their associated functionality).
The Supervisory Control state is mapped onto the Remote Cascade (RCAS) mode supported by
the device PID function block.
While in the Supervisory Control state, the SUP_IN parameter is used by the supervisory applica-
tion to provide the RCAS_IN value to be used as the set point by the device PID function block
algorithm.
Supervisory Control can be enabled in one of two ways:
1. An RCAS switch is available on the appropriate PIDFF view in the supervisory appli-
cation. When this switch is set by an operator, the Target mode is set to RCAS, the SE
parameter and the BLKSTA.SE bit are set, and the CP270 sends a command to the
FBM228 requesting the Target mode to be set to RCAS.

370
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

2. The SE parameter also can be set directly by a supervisory application or by a process


operator. When this happens, the Target mode is set to RCAS, the BLKSTA.SE bit is
set, and a command is sent to the FBM228 requesting the Target mode to be set to
RCAS.
When the Actual mode in the device PID function block transitions into the RCAS state, the
BLKSTA.SC bit is set to indicate that the Supervisory Control state is active.
Supervisory Control can be disabled in one of two ways:
1. The operator can switch the PIDFF block mode to the Cascade, Auto, Manual, or
OOS state. When this happens, the SE parameter is cleared, the SC and SE bits in
BLKSTA are cleared, and a command is sent to the FBM228 requesting the Target
mode to be set to the desired mode.
2. The SE parameter can be cleared directly by an operator or by a supervisory applica-
tion program. When this happens, the SC and SE bits are cleared in BLKSTA, and a
command is sent to the FBM228 requesting the Target mode to be set to the next
highest configured Permitted mode below RCAS (i.e. Cascade, Auto, or Manual).
When Secure Supervisory Control (SSC) is configured, the CP270 checks for transitions in the
Fallback state of the group to which the PIDFF block is assigned. It also checks for transitions in
the block Fallback state.
When the PIDFF supervisory group or the PIDFF block transitions to the Fallback state, the Tar-
get mode is set to the state specified in the FLBOPT parameter.

9.7.9 Block States


The DCI blocks transition through the states detailed in Table 9-21 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 320).

Table 9-21. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.

371
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

Table 9-21. DCI Block States (BSTATE) (Continued)

BSTATE Value
(Int (Bin)) State Value Description
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

9.8 PIDFF Block Application Examples


PIDFF blocks may be configured in single loop or cascade configurations. In multi-level cascades,
PIDFF blocks may be configured at any level of the cascade connected to other I/A Series blocks
or DCI FF blocks.
The following figures illustrate examples of the PIDFF block’s use in loops in applications:
♦ Figure 9-3 “Application Example - Simple Loop with PID Family or RATIO Block”
on page 373 (provided to show a typical PID-family block in a similar application as a
PIDFF block)
♦ Figure 9-4 “Application Example - Simple Loop with PIDFF Block” on page 374
♦ Figure 9-5 “Application Example - Cascade Loop with PID Family or RATIO Block
as Primary” on page 375
♦ Figure 9-6 “PIDFF Application Example - Cascade Loop with PIDFF Block as Pri-
mary” on page 376
♦ Figure 9-7 “Application Example - Cascade Loop with FOUNDATION fieldbus
Backup Strategy” on page 377

372
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

Secure Supervisory Control (SSC) may be performed in any of these configurations as desired.

I/A Series Workstation CP270 FF Field Device

AI Block AI Function Block


Connoisseur/
User Application
OUT OUT

SUPBCO SUP_IN
MEAS

SUP_IN
SUPBCO

PIDA Block*

BCALCI

OUT

CAS_IN CAS_IN

AO Block AO Function Block


BCALCO BKCAL_OUT

* Any PID family or RATIO block.

Figure 9-3. Application Example - Simple Loop with PID Family or RATIO Block

373
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

I/A Series Workstation CP270 FF Field Device

AI Block AI Function Block


Connoisseur/
User Application
OUT OUT

SUPBCO SUP_IN
IN IN

SUP_IN RCAS_IN
SUPBCO RCAS_OUT

PIDFF Block PID Function Block

BCALCI BKCAL_IN

OUT OUT

CAS_IN CAS_IN

AO Block AO Function Block


BCALCO BKCAL_OUT

Figure 9-4. Application Example - Simple Loop with PIDFF Block

374
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

I/A Series Workstation CP270 FF Field Device

AI Block AI Function Block


Connoisseur/
User Application

OUT OUT

SUPBCO SUP_IN
MEAS

SUP_IN
SUPBCO

PIDA Block*

BCALCI

OUT

AI Block AI Function Block

OUT OUT

IN IN

CAS_IN CAS_IN

PIDFF Block PID Function Block

BCALCO BKCAL_OUT
BCALCI BKCAL_IN
OUT OUT

CAS_IN CAS_IN

AO Block AO Function Block


BCALCO BKCAL_OUT

* Any PID family or RATIO block.

Figure 9-5. Application Example - Cascade Loop with PID Family or RATIO Block as Primary

375
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

I/A Series Workstation CP270 FF Field Device

AI Block AI Function Block


Connoisseur/
User Application

OUT OUT

SUPBCO SUP_IN
IN IN

SUP_IN RCAS_IN
SUPBCO RCAS_OUT

PIDFF Block PID Function Block

BCALCI BKCAL_IN

OUT OUT

AI Block AI Function Block

OUT OUT

IN IN

CAS_IN CAS_IN

PIDFF Block PID Function Block

BCALCO BKCAL_OUT
BCALCI BKCAL_IN
OUT OUT

CAS_IN CAS_IN

AO Block AO Function Block


BCALCO BKCAL_OUT

Figure 9-6. PIDFF Application Example - Cascade Loop with PIDFF Block as Primary

376
9. PIDFF – Foundation™ fieldbus PID Block B0700EC – Rev B

I/A Series Workstation CP270 FF Field Device

AI Block AI Function Block


Connoisseur/
User Application

OUT OUT

SUPBCO SUP_IN
IN IN

PIDFF Block PID Function Block

BCALCI BKCAL_IN

OUT OUT

AI Block AI Function Block

OUT OUT

IN IN

CAS_IN CAS_IN
SUP_IN RCAS_IN
SUPBCO RCAS_OUT

PIDFF Block PID Function Block

BCALCO BKCAL_OUT
BCALCI BKCAL_IN
OUT OUT

CAS_IN CAS_IN

AO Block AO Function Block


BCALCO BKCAL_OUT

Figure 9-7. Application Example - Cascade Loop with FOUNDATION fieldbus Backup Strategy

377
B0700EC – Rev B 9. PIDFF – Foundation™ fieldbus PID Block

378
10. UNIVFF– Universal
FOUNDATION™ fieldbus Block
This chapter describes the universal FOUNDATION fieldbus (UNIVFF) block, which interfaces
the control system with a corresponding device block operating in a FOUNDATION™ fieldbus
H1 device.

10.1 Overview
Universal FOUNDATION fieldbus (UNIVFF) is a Distributed Control Interface (DCI) block
that provides an interface between the control processor and a resource, transducer or function
block operating in a FOUNDATION fieldbus H1 device (the device block). The function block
type can be any FF device block type not supported by a dedicated FOUNDATION fieldbus
function block such as AI or AO. Standard function blocks supported by the UNIVFF block
include:
.
Arithmetic Bias/Gain Control Selector
Dead Time Device Control Input Selector
Integrator Lead Lag Manual Loader
Output Splitter PD Control Ratio
Set Point Ramp Generator Signal Characterizer

The UNIVFF block is supported on the FCP270 and ZCP270 when the H1 device is con-
nected to the control station by an FBM228. The UNIVFF block is configured using the Block
Configurator in the InFusion Engineering Environment (IEE), V2.0 or later, as described in
InFusion Enterprise Control System: Implementing FOUNDATION fieldbus in InFusion 2.0
(B0750DA).

NOTE
The UNIFF block functionality described in this chapter is applicable only for
FBM228s with the software type (SWTYPE) of “128”.

10.2 Basic Operation


Device templates are created in the InFusion Engineering Environment (IEE) when device
description (DD) files and common file format (CFF) files for the device are imported into a base
device template. With the import, the UNIVFF block definition is used as a parent template for
the creation of device-specific resource, transducer and function block templates.
Function blocks are templated with one of the dedicated function block types described in the
previous chapters. If there is no dedicated function block for the type, IEE uses the UNIVFF
block as the parent template.

379
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

The parent UNIVFF block template acquires the block parameters described in the DD. Block
instances can then be derived from various device-specific block types and assigned to devices that
were created from the same device template.
You cannot create a block instance directly from the UNIVFF block and assign that block to a
device.
A UNIVFF instance enables configuration of a device block using Field Device Manager. The
configured values are then deployed to the control processor and FBM228, which in turn down-
loads the configuration to the corresponding block in the device to which the block is assigned.
During normal operation, the UNIVFF block acquires data from the device block for display and
connection within the I/A Series system, allows the operator to set the block mode and monitor
the health of the block.

10.3 Features
♦ Accesses the parameters in the device block’s views using change-driven and periodic
client/server connections
♦ Provides for the configuration of device block parameters from the I/A Series system
and management of the device configuration in the control database
♦ Enables users to set the mode of the device block to Auto, Manual or Out of Service
and Cascade (if supported by the block type)
♦ Provides detection and reporting of device alarms

10.4 Block Parameters


The standard UNIVFF block parameters listed in this section include those which determine the
block’s behavior in the control processor and those that are mapped to the standard parameters,
common to all FOUNDATION fieldbus device blocks. These parameters are available in I/A Series
configurators and displays.
When a UNIVFF block is bound to a Device Description (DD) during template creation for the
device type, the block acquires the extended, or custom, parameters which the device manufac-
turer has added to its version of the FOUNDATION fieldbus block. These extended parameters are
available for configuration and display in Field Device Manager displays. The extended parame-
ters are encapsulated in the FDATA1, FDATA2, FDATA3 and FDATA4 parameters when the
block is deployed to the control processor and FBM228 so they can be downloaded to the device
block.

Table 10-1. UNIVFF Block Parameters

Name Description Type Accessibility1 Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE DCI block type integer no-con/no-set 52 52 [UNIVFF]
TAGDSC TAG_DESC2 char no-con/no-set 2 blanks 1to 32 chars
PERIOD DCI block period short integer no-con/no-set 1
PHASE DCI block phase integer no-con/no-set 0

380
10. UNIVFF– Universal Foundation™ fieldbus Block B0700EC – Rev B

Table 10-1. UNIVFF Block Parameters (Continued)

Name Description Type Accessibility1 Default Units/Range


LOOPID loop identifier string no-con/set 2 blanks 1to 32 chars
IOM_ID ECB201 pathname string no-con/no-set 2 blanks any valid path
name <= 25
chars or ECB
block name <=
12 chars
DDITEM DD Item ID long integer no-con/no-set 0x
00000000
DDMBR DD Member ID long integer no-con/no-set 0x00
UPDPER view update period long integer no-con/no-set 10000ms 0 to
2147483647
STRATG STRATEGY integer no-con/no-set 999 0 to 65535
MODE_N MODE_BLK.Normal short integer no-con/no-set 0x10 0 to 0xFF
MODE_P MODE_BLK.Permitted short integer no-con/no-set 0x11 0 to 0xFF
MODE_T MODE_BLK.Target short integer con/no-set 0x10 0 to 0xFF
ERROPT block error alarm option packed b no-con/no-set 0xFFFE 0 to 0xFFFF
ERRGRP block error alarm group short integer no-con/no-set 8 1 to 8
MAN_ID manufacturer ID long integer no-con/no-set 0 0 to
2147483647
DVC_ID device ID integer no-con/no-set 0 0 to 0xFFFF
DVCREV device revision long integer no-con/no-set 0 0 to
2147483647
BLKNDX block index long integer no-con/no-set 0 0 to
2147483647
FBTYPE function block type string no-con/no-set 2 blanks 1 to 32 chars
PROFIL function block profile num- integer no-con/no-set 0 0 to 0xFFFF
ber
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 0 to 32768
AUT_SW switch to Auto mode boolean no-con/set 0 0 to 1
BLKERR BLOCK_ERR packed b con/no-set 0 0 to 0xFFFF
BLKSTA block status packed long con/no-set 0 0 to
0xFFFFFFFF
BSTATE block state integer con/no-set 0 0 to 11
DEVACK device acknowledge boolean con/set 0 0, 1
MAN_SW switch to MAN mode boolean no-con/set 0 1 to 0
MODE_A MODE_BLK.Actual short integer con/no-set 0 0 to 0xFF
OOS_SW switch to OOS mode boolean con/set 0 0, 1
UNACK unacknowledged alarm boolean con/set 0 0, 1
Data Stores
CAS_SW switch to CAS mode boolean no-con/set 0 1 to 0
CFGERR configuration error short integer no-con/no-set 0
DEFINE no config errors boolean no-con/no-set 1 0, 1
DESCRP block descriptor string no-con/no-set 2 blanks 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks

381
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

Table 10-1. UNIVFF Block Parameters (Continued)

Name Description Type Accessibility1 Default Units/Range


FDATA1 file data bytes 1 to 255 short integer no-con/no-set all 0s 0 to 255 for
(array 1x255) each element
FDATA2 file data bytes 256 to 510 short integer no-con/no-set all 0s 0 to 255 for
(array 1x255) each element
FDATA3 file data bytes 511 to 765 short integer no-con/set all 0s all 1s
(array 1x255)
FDATA4 file data bytes 766 to 1020 short integer no-con/set all 0s all 1s
(array 1x255)
LOCKID lock identifier string no-con/no-set 2 blanks 1 to 32 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/set 2 blanks 1 to 32 chars
ST_REV ST_REV integer no-con/no-set 0 0 to 65535

1. No-con = non-connectable. No-set = non-settable.


2.
Device function block parameters are shown in this document in italics. Function blocks may
use different names for these parameters.

10.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and therefore MODE_BLK.Target in the associated device
block, to Auto.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device block. Table 10-2 shows
the parameter format.

382
10. UNIVFF– Universal Foundation™ fieldbus Block B0700EC – Rev B

Table 10-2. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKNDX Block Index is a configurable, non-settable long integer that contains the
index of the device block represented by the UNIVFF block. The index is
acquired when the UNIVFF template is bound to a DD either when the
device is templated. It is set by the configurator and the FBM uses it to
identify the block in the device.

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table 10-3 shows how the bits are used by the UNIVFF
block. A given device might not support all bits described in the table.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DEVACK B9

FDFAIL
FDACT
FDMM
FDOK

UDEF

FBM

TRK
LCK

FFX
ON

MA

LO
FF

Table 10-3. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device block mode is Local Override BLKSTA.B29

383
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

Table 10-3. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
6 TRK The block is being tracked as the device block is in BLKSTA.B26
Local Override or Initialization Manual mode
8 FBM There is a communication failure between BLKSTA.B24
CP and FBM
11 MA The block mode is Auto BLKSTA.B21
14 UDEF The block is undefined BLKSTA.B18
15 ON The compound that contains the block is ON BLKSTA.B17
16 FFX Enhanced FOUNDATION fieldbus block connection BLKSTA.B16
17 FDACT Download active BLKSTA.B15
18 FDFAIL Download failure BLKSTA.B14
19 FF FOUNDATION fieldbus block connection BLKSTA.B13
20 LCK A workstation has locked this block BLKSTA.B12
21 FDOK FDATA installed BLKSTA.B11
22 FDMM FDATA mismatch BLKSTA.B10
23 DEVACK Unacknowledged device alarm BLKSTA.B9
* Bit 0 is the least significant, low order bit.

BSTATE Block State is a non-configurable, non-settable integer output that con-


tains the state of the device block connection as determined by the
FBM228. The following values are used to indicate the current DCI block
state:
0 = Undefined state
1 = Unconnected
2 = Connecting
3 = Connecting Failed
4 = Scheduling Block
5 = Scheduling Failed
6 = Creating Block Connections
7 = Creating Block Connections Failed
8 = Writing Block Parameters
9 = Writing Block Parameters Failed
10 = Block ON-LINE
11 = Block ON-LINE with error - Processing has been completed, but
some step of the processing failed. The block status is reported to CP.
Block state transitions are explained in “Block States” on page 396.

384
10. UNIVFF– Universal Foundation™ fieldbus Block B0700EC – Rev B

CAS_SW Cascade Switch is a settable Boolean output used to set the MODE_T
parameter, and therefore MODE_BLK.Target in the associated device
block, to CAS.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
block parameter when the UNIVFF block becomes undefined due to a
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR. When
this happens, the system generates an alarm message that contains the
ASCII name of the parameter assigned to the index shown in Table 10-4.
Table 10-4. CFGERR Index

Value Device Block Parameter with Error


0 No configuration error
2 Index of TAG_DESC parameter
3 Index of STRATEGY parameter
5 Index of MODE_BLK parameter
1, 4, 6 to Index of any other device block parameter
255

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 386 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.

DESCRP Description is a non-connectable, non-settable ASCII string of up to


32 characters used to specify a description for the block. The parameter
tracks the TAGDSC parameter, and is updated when the TAGDSC is
modified.

DEVACK Device Acknowledge is a settable boolean output used to acknowledge


device alarms in the associated device block. DEVACK is set when a
device alarm status bit is set by the FBM228. DEVACK is cleared by an
operator action.
DEVACK is different from UNACK (described on page 390), which is
used by the operator to acknowledge process alarms in the DCI block.

385
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

DEVACK is used to acknowledge device alarms at the ECB201 or DCI


block level.

NOTE
This parameter is not supported currently.

DVC_ID Device Identifier is a configurable, non-settable integer that provides the


Device Identifier of the H1 field device that contains the device block rep-
resented by the UNIVFF block. It is set by the IEE configurator. The
FBM228 checks the corresponding value in the device resource block to
verify that there is a match between the block and the device.

DVCREV Device Revision is a configurable, non-settable long integer that provides


the Revision level of the H1 field device that contains the device block
represented by the UNIVFF block.
It is set by the IEE configurator. The FBM228 checks the corresponding
value in the device resource block to verify that there is a match between
the block and the device. The IEE configurator encodes the following data
in DVCREV:
Bits 16-23 Bits 8-15 Bits 0-7
Device revision Minimum Device Description Common File Format
(DD) File Revision (CFF) File Revision

ERCODE Error Code is a string data store that indicates the type of configuration
error that caused the block’s DEFINE parameter to be set False.
Validation of configuration does not proceed past the first error encoun-
tered by the block logic.
Table 10-5 lists the possible values of ERCODE for the UNIVFF block.

Table 10-5. Error Code Values

ERCODE
W43 - INVALID PERIOD/PHASE COMBINATION
W54 - ECB DOES NOT EXIST
W62 - UNRESOLVED CONNECTION
W65 - INVALID POINT ADDRESS
W66 - DUPLICATE CONNECTION
W67 - INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 - INVALID DEVICE CONNECTION
W69 - INVALID POINT CONNECTION
W73 - FF FUNCTION BLOCK CONFIGURATION ERROR
W74 - FF FUNCTION BLOCK DDITEM MISMATCH
W75 - FF FUNCTION BLOCK DDMBR MISMATCH
W76 - INVALID FF MODE CONFIGURATION
W77 - FIELDBUS COMMUNICATION FAULT
W78 - INVALID FUNCTION BLOCK
W79 - INVALID PARAMETER INDEX

386
10. UNIVFF– Universal Foundation™ fieldbus Block B0700EC – Rev B

Table 10-5. Error Code Values (Continued)

ERCODE
W80 - FIELDBUS DEVICE NOT FOUND
W81 - INVALID PARENT DCI ECB PERIOD/PHASE
W82 - FF CONFIGURATION IN PROGRESS
W83 - INVALID FF PARAMETER CONNECTION
W84 - INVALID FF PARAMETER TYPE
W85 - INVALID CONNECTION TYPE
W86 - MAN_ID, DVC_ID, OR DECREC MISMATCH

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in the UNIVFF block. The range is 1 to 8 (default).

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device block error conditions (from the device block
BLOCK_ERR parameter) generate an alarm message. The parameter has
the same format as BLKERR (Table 10-2).

FBTYPE Function Block Type is a configurable, non-settable string that contains


the 1 to 32 character ASCII text name of the corresponding device block
represented by the UNIVFF.

FDATA1 File Data #1 through File Data #4 are settable multi-byte arrays that pro-
FDATA2 vide configuration data for the device block represented by the UNIVFF
FDATA3 block.
FDATA4 This file data is downloaded automatically into the FBM228 when the
FDATA1 parameter is changed in the CP270 via an OM write access
operation. This download also will occur automatically when the CP270
or FBM228 reboots and when the FBM228 is put on-line. The size of
each FDATAn parameter is 255 bytes, for a total array size of 1020 bytes.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station, and is between 1-12 characters. The
station concatenates the <cp_letterbug>_ECB name with the
block name of the ECB to form the full pathname.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB. The full pathname can be up

387
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

to 25 characters (12 for <local_compound_name>, 1 for the


colon, and 12 for the <ecb_name>).

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has the
format LETTERBUG:DEVNAME, where LETTERBUG is the 6-char-
acter letterbug of the workstation and DEVNAME is the 1- to 6-character
logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block.

MAN_ID Manufacturer Identifier is a configurable, non-settable long integer that


provides the Manufacturer Identifier of the H1 field device that contains
the device block represented by the UNIVFF block. The FBM228 checks
the corresponding value in the device resource block to verify that there is
a match between the block and the device.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the associated device block, to Man-
ual.

MODE_A Actual mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device block.

MODE_N Normal mode is a configurable, downloadable, non-settable, short integer


output that contains the MODE_BLK.Normal parameter of the associated
device block.

MODE_P Permitted mode is a configurable, downloadable, non-settable, short inte-


ger output that contains the MODE_BLK.Permitted parameter of the
associated device block.

MODE_T Target mode is a configurable, downloadable, short integer output that


contains the MODE_BLK.Target parameter of the associated device block.
MODE_T is not directly settable. The AUT_SW, MAN_SW, and
OOS_SW are used to change the MODE_T parameter, and thus the

388
10. UNIVFF– Universal Foundation™ fieldbus Block B0700EC – Rev B

MODE_BLK.Target parameter in the device block, to Auto, Manual and


OOS, respectively.

NAME Name is a user-defined string of up to 12 characters for naming the


matching function block in the device. When the UNIVFF block is ini-
tialized, the block updates the configurable parameters of the function
block matched to the UNIVFF block by the configured index
(BLKNDX). The NAME parameter is used to set the Block Tag of the
device function block.

OOS_SW Out of Service Switch is a settable output used to set the MODE_T
parameter, and thus the MODE_BLK.Target in the associated device
block, to Out of Service.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is a zero-based integer input that causes the block to execute at a
specific BPC within the time determined by the PERIOD. For instance,
assuming that the BPC of the I/A Series station is 0.5 second, a block with
a PERIOD of 3 (2.0 seconds) can execute within the first, second, third,
or fourth BPC of the 2-second time period. See Integrated Control Software
Concepts (B0700AG).

PROFIL Profile Number is a configurable, non-settable integer that contains the


profile number that is assigned by the Fieldbus Foundation to uniquely
identify the type of resource, transducer or function block to which this
UNIVFF is connected.

389
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device block. ST_REV increments each time a
change is made to the configurable device block parameters from an exter-
nal source.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device block.
STRATEGY is used to define groupings of blocks in the H1 device.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


specifies the TAG_DESC parameter of the associated device block. The
value of TAGDSC is also copied to the DESCRP parameter to provide a
description of the block in I/A Series displays.

TYPE Type is the block type. When a UNIVFF block is added to the control
database, the configuration editor enters the value 52 to specify the
UNIVFF block type.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block has a process alarm. It is setta-
ble, but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the alarms display.
UNACK is different from DEVACK (described on page 385), which is
used by the operator to acknowledge device alarms at the ECB201 or DCI
block level. UNACK is used by the operator to acknowledge process
alarms in the DCI block.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period for client/server connections scheduled by the
FBM228 to read the device block view parameters. The range is 0 to
2147483647 milliseconds; the default is 10000.

10.4.2 Parameter Transforms


Table 10-6 illustrates the mapping of UNIVFF block parameters and parameters in the linked
device PID function block. Many of the parameters are straightforward 1:1 mappings that are
either unidirectional or bidirectional. Other mappings require that a data value be re-formatted
(or transformed) to be intelligible in the I/A Series system. From the point of view of the

390
10. UNIVFF– Universal Foundation™ fieldbus Block B0700EC – Rev B

UNIVFF block, the relationship with the device block can also be described in terms of sink and
source connections:
→ Source-sink The UNIVFF block parameter is the source for the corresponding
device block parameter. Thus, changes to the UNIVFF block param-
eter are made to the device parameter. For example, when the
UNIVFF block is initialized, the TAGDSC value is copied to the
device block TAG_DESC parameter.
← Sink-source The UNIVFF block parameter value is updated by the corresponding
device block parameter. For example, the MODE_A parameter reads
the device parameter MODE_BLK.Actual to make the actual device
block mode visible to the control system.
↔ Bidirectional Changes to the UNIVFF block parameter are made to the corre-
sponding device block parameter and vice versa. For example, when
an UNIVFF block is initialized, its STOPTS parameter value is writ-
ten to the equivalent device block parameter, STATUS_OPTS, to
configure how the function block processes block status information.
Subsequent changes to the status options made at the device are writ-
ten back to the UNIVFF block STOPTS parameter.

The arrow notation is used in Table 10-6; the mappings are presented in alphabetic order,
arranged by the UNIVFF block parameter names.

Table 10-6. UNIVFF Parameter Transformations

UNIVFF Parameter Device Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SWÆ1:
Set MODE_T (request) = AUTO
Set CAS_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value Å BLOCK_ERR
BLKERR.status.OOS Å CP-FBM communications is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ÅMODE_BLK.Actual.OOS
BLKSTA.TRK ÅMODE_BLK.Actual.IMAN or LO
BLKSTA.LO ÅMODE_BLK.Actual.LO
BLKSTA.LR=0 ÅMODE_BLK.Actual.AUTO or MAN
BLKSTA.LR=1 ÅMODE_BLK.Actual.CAS
BLKSTA.MA=0 ÅMODE_BLK.Actual.MAN
BLKSTA.MA=1 ÅMODE_BLK.Actual.AUTO
BLKSTA.FBM Å CP-FBM communications is failed
CAS_SW MODE_BLK.Target
When CAS_SWÆ1:
Set MODE_T (request) = CAS and AUTO
Set AUT_SW=0, MAN_SW=0, OOS_SW=
Write MODE_T (request) to FBM

391
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

Table 10-6. UNIVFF Parameter Transformations (Continued)

UNIVFF Parameter Device Block Parameter


MAN_SW MODE_BLK.Target
When MAN_SWÆ1:
Set MODE_T (request) = MAN
Set CAS_SW=0, AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
MODE_A MODE_BLK.Actual
MODE_A.value Å MODE_BLK.Actual
MODE_N Å MODE_BLK.Normal
MODE_P Å MODE_BLK.Permitted
MODE_T MODE_BLK.Target
MODE_T.value (request) MODE_BLK.Target
MODE_T.value (actual) Å MODE_BLK.Target
NAME Æ Device Block Tag
OOS_SW MODE_BLK.Target
When OOS_SWÆ1:
Set MODE_T (request) = OOS
Set CAS_SW=0, MAN_SW=0, AUT_SW=0
Write MODE_T (request) to FBM
PROFIL Æ Profile Number in resource, transducer, or function block
header
STRATG Å STRATEGY
ST_REV Å ST_REV
TAGDSC Æ TAG_DESC

10.5 Block Operation


10.5.1 View Data Updates
During normal operation the CP270 scans the FBM228 each BPC for the data required for pro-
cessing by the UNIVFF blocks ready for execution that cycle. View data is updated every cycle.

10.5.2 Block Validation


The UNIVFF block initializes when any of these events occurs:
♦ The block is installed or reconfigured via the control configurator in a running
compound.
♦ The compound in which the block resides is turned ON.
♦ The CP is rebooted and the compound in which the block resides initializes ON.
♦ The ECB201 connected to the block is installed or reconfigured.
When the UNIVFF block initializes, the following block validation tests are performed:
♦ If the Target mode (MODE_T) or the Permitted mode (MODE_P) is not Cascade,
Auto, Manual or Out-of-Service, the block is marked undefined (BLKSTA.UDEF=1)

392
10. UNIVFF– Universal Foundation™ fieldbus Block B0700EC – Rev B

with the error code parameter (ERCODE) set to “W76 – INVALID FF MODE
CONFIGURATION”.
♦ If the UNIVFF block is installed prior to the installation of the ECB201 block, it is
marked undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE)
set to “W54 – ECB DOES NOT EXIST”. In this case, the UNIVFF block is
restarted and re-validated automatically when the ECB201 is installed.
♦ An attempt will be made to connect the UNIVFF block to the ECB201 specified in
the IOM_ID parameter. The DCI connection address (i.e., the NAME parameter in
the UNIVFF block) is used in a connect message to establish a DCI data connection
in the FBM228.
♦ If the UNIVFF connection cannot be resolved due to a lack of configuration informa-
tion, a DCI data connection is made in the FBM, the connection status is marked
Unresolved, and one of the following error strings will be stored in the ERCODE
parameter:
“W62 – UNRESOLVED CONNECTION”
“W77 – FIELDBUS COMMUNICATIONS FAULT”
“W78 – INVALID FUNCTION BLOCK”
“W80 – FIELDBUS DEVICE NOT FOUND”
“W82 – FF CONFIGURATION IN PROGRESS”
“W73 – FF FUNCTION BLOCK CONFIGURATION ERROR”
(In this case, the UNIVFF block will be defined, and the index of the invalid func-
tion block parameter will be stored in the CFGERR parameter.)
♦ If the DCI data connection cannot be made for any other reason, the FBM rejects the
connection request and one of the following error strings will be stored in the
ERCODE parameter to indicate the reason for the connection error:
“W65 – INVALID POINT ADDRESS”
“W66 – DUPLICATE CONNECTION”
“W67 – INSUFFICIENT FBM MEMORY/CONNECTIONS”
“W68 – INVALID DEVICE CONNECTION”
“W69 – INVALID POINT CONNECTION”
“W74 – FF FUNCTION BLOCK DDITEM MISMATCH”
“W75 – FF FUNCTION BLOCK DDMBR MISMATCH”
“W76 – INVALID FF MODE CONFIGURATION”
“W79 – INVALID PARAMETER INDEX”
“W83 – INVALID FF PARAMETER CONNECTION”
“W84 – INVALID FF PARAMETER TYPE
“W85 – INVALID CONNECTION TYPE”
“W86 – MAN_ID, DVC_ID, OR DVCREV MISMATCH”
(In these cases, the DCI block is undefined.)
♦ If the PERIOD/PHASE combination is inconsistent, or if the PERIOD/PHASE
combination conflicts with the compound PERIOD/PHASE combination, the

393
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

UNIVFF block is undefined with ERCODE set to “W43 – INVALID


PERIOD/PHASE COMBINATION”.
♦ If the PERIOD/PHASE combination conflicts with the PERIOD/PHASE combina-
tion of the Parent ECB200 or ECB202 to which the ECB201 is connected, the
UNIVFF block is undefined with ERCODE set to “W81 – INVALID PARENT
DCI ECB PERIOD/PHASE”.
♦ If there are no configuration errors when the UNIVFF block is installed, the block is
marked defined (BLKSTA.UDEF=0) and ERCODE is cleared (nulled). If the com-
pound containing the block is turned on, the block also will initialize and start
running automatically.

10.5.3 UNIVFF Block Initialization


When the UNIVFF block initializes, the following functions will be performed:
♦ The Actual mode parameter (MODE_A) will be set to Initialization Manual (IMAN)
in the UNIVFF block.
♦ The Target mode parameter (MODE_T) will be set to only one of the following
states, in order, if multiple bits are set: Cascade, Auto, Manual, OOS.
♦ The Target mode will be sent to the device block via the write message.
♦ If installing the block, or if rebooting and not a Warm Restart, the configuration
parameters will be downloaded to the device block via the write message.

10.5.4 File Download/Upload


Parameters FDATA1 through FDATA4 provided in the UNIVFF block support download-
ing/uploading a data file of configuration information to the appropriate resource, transducer, or
function block.
The UNIVFF block does not provide I/A Series input parameters to connect to parameters from
other FOUNDATION fieldbus blocks. Connections to the inputs of the underlying device block are
made by the FBM228 using configuration information contained in the downloaded data file.
Each of the FDATA parameters is an OM settable array of 255 bytes. The entire data file consists
of up to 1020 bytes (4 x 255) of configuration information.
The CP270 downloads the entire data file automatically to the FBM228 when the FDATA1
parameter is written via an OM write access operation. This download also occurs automatically
when the CP270 or FBM228 reboots and when the FBM228 is put on-line.
The CP270 uploads the data file automatically from the FBM228 upon request from the
FBM228.
For each UNIVFF block, a Status Extension field is supported in the reply to a read message. The
Status Extension contains Device Alarm, Download Active, and Download Failure bit indicators
set by the FBM228 when appropriate.
The Download Active and Download Failure indicators are mapped onto status bits in the Block
Status (BLKSTA) parameter for each block. File Installed and File Mismatch status bits are also
provided in the BLKSTA parameter .

394
10. UNIVFF– Universal Foundation™ fieldbus Block B0700EC – Rev B

10.5.5 Block Modes


The UNIVFF block provides interactive support of the MODE_BLK device block parameter. The
Target, Permitted, Normal, and Actual modes are mapped to separate UNIVFF block parameters.
The configuration of the Target, Permitted, and Normal modes are supported, subject to the con-
straints defined in Table 10-6. These parameters are downloaded to FF block when the UNIVFF
block initializes.
The Target mode is changeable through a group of settable Boolean mode switches provided in
the UNIVFF block. These mode switches, AUT_SW, MAN_SW, and OOS_SW, allow the block
mode to be changed to Auto, Manual, or Out-of-Service respectively.
♦ Logic in the CP270 prevents more than one switch from being set at a given time. If
more than one switch is set during the same block cycle, only the last switch setting is
honored.
♦ Once set, a mode switch will remain set only until the Target mode change is sent to
the FBM228 or until another mode switch is set. At that time, the mode switch will
be cleared.
♦ The mode switch setting will be mapped onto an equivalent Target mode setting sent
to the FBM228. See Table 10-6 for mapping details.
The Target mode will be a shadow parameter updated from the MODE_BLK function block
parameter read back during input scanning of the FBM228.
When the Actual, Permitted, Target, or Normal modes change in the device block, the corre-
sponding UNIVFF block mode parameters will be updated automatically from the MODE_BLK
parameter. In addition, the Actual mode will be mapped onto equivalent BLKSTA parameter bits,
as specified in Table 10-3.
The Actual block mode (MODE_BLK.Actual) will be provided in two forms:
♦ The Actual mode will be stored in the MODE_A output parameter.
♦ The Actual mode also will be mapped onto equivalent bits in the BLKSTA block sta-
tus parameter as follows:
♦ The OOS state will be mapped onto the OOS value status bit of the BLKSTA
parameter.
♦ The IMAN state will be mapped onto the BLKSTA.TRK status bit.
♦ The LO state will be mapped onto both the BLKSTA.TRK and BLKSTA.LO
status bits.
♦ The MAN state will set BLKSTA.MA=0.
♦ The AUTO state will set BLKSTA.MA=1.

10.5.6 Block Alarming


The UNIVFF block provides alarm messages for the following cases:
♦ Informational messages of block errors (BLKERR) reported by the device block
BLOCK_ERR parameter.
♦ Informational messages of function block configuration errors (CFGERR).
The device block alarm detection, alarm events, alarm messaging, and associated parameters pro-
vided by the H1 field device are not supported in the UNIVFF block.

395
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

10.5.7 Block Error Processing


If the Block Error option (ERROPT) is set, alarming of the BLKERR parameter will be per-
formed as follows:
♦ For every condition specified in ERROPT, a corresponding Informational message
will be sent to the ERRGRP alarm group when the condition occurs. The UNACK
parameter and the corresponding ALMSTA.UNACK bit also are set. Refer to
Table 10-2 for a layout of the ERROPT parameter.
♦ One of the following messages listed in Table 10-7 will be generated.
Table 10-7. Information Messages Indicating a Block Error

Bit Message
0 FF Block Error: Out-of-Service
1 FF Block Error: Power Up
2 FF Block Error: Maintenance Needed Now
3 FF Block Error: Readback Check
4 FF Block Error: Lost NV Data
5 FF Block Error: Lost Static Data
6 FF Block Error: Memory Fail
7 FF Block Error: Output Fail
8 FF Block Error: Input Fail
9 FF Block Error: Maintenance Due Soon
10 FF Block Error: Fault State Active
11 FF Block Error: Local Override
12 FF Block Error: Simulation Active
13 FF Block Error: Link Configuration Error
14 FF Block Error: Block Configuration Error
15 FF Block Error: Other (Undefined) Error

10.5.8 Configuration Error Processing


When a UNIVFF block configuration parameter cannot be downloaded into the field device, the
parameter index will be stored in the CFGERR parameter and the following informational mes-
sage will be generated:
FF CFGERR in Parameter nnnnnnnn
where: nnnnnnnn = ASCII name of the parameter indicated by the parameter index in
CFGERR if TAG_DESC, STRATGEY, or MODE_BLK parameter = parameter index
indicated in CFGERR if any other function block parameter

10.5.9 Block States


The DCI blocks transition through the states detailed in Table 10-8 below. A block’s current state
is recorded in bits 0-7 of the BSTATE parameter (see page 384).

396
10. UNIVFF– Universal Foundation™ fieldbus Block B0700EC – Rev B

Table 10-8. DCI Block States (BSTATE)

BSTATE Value
(Int (Bin)) State Value Description
0 (00000000) Undefined -
1 (00000001) Unconnected A DCI block has been deleted/undeployed
from the CP configuration.
2 (00000010) Connecting A DCI block has been created in the CP;
The FBM is creating the block structures in
an internal FBM database.
3 (00000011) Connecting Failed The FBM can fail to create a new block for a
number of reasons. For example:
- Connection already exists.
- FBM is out of memory
- No block match
- Invalid block
4 (00000100) Scheduling Block Execution A block schedule is being created.
5 (00000101) Scheduling Block Execution A schedule configuration failed. The FBM
Failed could not deploy block or LAS schedule.
Check schedule or schedule configuration.
6 (00000110) Creating Block Connections Publisher/Subscriber connections are being
created.
7 (00000111) Creating Block Connections FBM failed to create block Publisher/Sub-
Failed scriber connections. Check the configura-
tion. This may be a temporary condition
while the FBM is processing other blocks.
8 (00001000) Writing Block Parameters Block parameters are being written to a
device
9 (00001001) Writing Block Parameters FBM failed to write parameters to device
Failed resident block. The block detailed display
“Maintenance” overlay may have more
information. Verify block configuration in
IEE. Use the Field Device Manager to com-
pare configuration data base with device
database.
10 (00001010) Block ON LINE - OK Connection processing has been successful
and data/point connection has been estab-
lished.
11 (00001011) Block ON LINE – Error Processing has been completed, but some
step of the processing failed. The block
detailed display “Maintenance” overlay may
have more information. Also check the
System Manager status information for the
corresponding FF H1 device.

397
B0700EC – Rev B 10. UNIVFF– Universal Foundation™ fieldbus Block

398
Appendix A. Legacy AI –
FOUNDATION™ fieldbus Analog
Input
This appendix describes the legacy I/A Series Analog Input (AI) block, shipped with I/A Series
systems with v8.4.3 or earlier software, used with an FBM228 with SWTYPE=228. The AI
block interfaces the control system with a corresponding analog input function block operating
in a FOUNDATION™ fieldbus H1 device.

A.1 Overview
Analog Input (AI) is a Distributed Control Interface (DCI) block that provides an interface
between the control processor and an analog input function block operating in a FOUNDATION
fieldbus H1 device (the device function block). The AI block is supported on the FCP270 and
ZCP270 when the H1 device is connected to the control station by an FBM228 (with
SWTYPE=228). The AI block is configured using the Block Configurator in the InFusion
Engineering Environment (IEE) as described in InFusion Enterprise Control System: Implement-
ing FOUNDATION fieldbus (B0750BC) or with the I/A Series Configuration Component
(IACC) software as described in Implementing FOUNDATION fieldbus on the I/A Series System
(B0700BA).

A.2 Basic Operation


The AI block integrates the linked device function block into the I/A Series system. On initializa-
tion, user-configured values in the AI block are written to the standard configurable parameters in
the device function block. During normal operation, the AI block maintains a publisher/sub-
scriber connection with the device function block to read the value and status of the device block’s
primary output (OUT1). In addition, the AI block provides access to a variety of operational and
diagnostic information via client/server connections with the parameters that are included in
Views 1, 2, and 4 of the device block. The values read from these parameters are displayed in the
block detail displays and are available for connection to other I/A Series blocks.

A.3 Features
The AI block provides the following features:
♦ Acquires the device analog input function block’s primary output value and status
♦ Time stamps value and status changes
♦ Accesses the parameters in the device function block’s View 1, View 2 and View 4
using change-driven and periodic client/server connections

1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

399
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

♦ Ensures that changes in the device block’s process values and error conditions are con-
tinuously available for display and connection to the control strategy
♦ Provides for the configuration of device block parameters from the I/A Series system
and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Auto, Manual or Out of
Service
♦ Provides detection and reporting for bad I/O, high and low absolute, and high-high
and low-low alarming
♦ Supports simulation of device block output within the control station

A.4 Block Parameters


Table A-1 lists the block parameters. See Table A-11 for mappings between the AI block parame-
ters and their device function block equivalents.

Table A-1. AI Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set AI
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 9
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0, 1
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path,
up to 12 chars
CHANNL channel integer no-con/no-set 1
DDITEM DD item long no-con/no-set 0x800201D0
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000 0 to 2147483647
STRATG strategy integer no-con/no-set 0 to 65535
STOPTS status options packed bool- no-con/no-set 0x1080 0 to 0xFFFF
ean
IOOPTS I/O options packed bool- no-con/no-set 0x00 0 to 0xFF
ean
PVFTIM PV filter time real no-con/no-set 2.0
LOWCUT low cutoff real no-con/no-set 0.0
L_TYPE linearization type short integer no-con/no-set 1
HSCI1 high scale input real no-con/no-set 100.0 >LSCI1
LSCI1 low scale input real no-con/no-set 0.0 <HSCI1
DPTI1 input decimal point integer no-con/no-set 0 0 to 10
EI1 engineering units string no-con/no-set % 1 to 32 chars
EUI1 input eng units index integer no-con/no-set 0 0 to 32767
HSCO1 output high scale real no-con/no-set 100.0
LSCO1 output low scale real no-con/no-set 0

400
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

Table A-1. AI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DPTO1 output decimal point integer no-con/no-set 0 0 to 10
EO1 eng units, output 1 string no-con/no-set % 1 to 32 chars
EUO1 eng units index integer no-con/no-set 0 0 to 32767
MODE_N normal mode integer no-con/no-set 0x10 0 to 0xFFFF
MODE_P permitted mode integer no-con/no-set 0x19 0 to 0xFFFF
MODE_T target mode integer con/no-set 0x10 0 to 0xFFFF
MEAS optional input real con/set 0.0
INHOPT inhibit option short no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short con/no-set 1 1 to 8
BADOPT bad alarm option short no-con/no-set 0 0 to 1
BADGRP bad alarm group integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 1 to 32 chars
OUTDSC output descriptor string con/no-set blank 1 to 32 chars
HHIOPT high-high low-low alarm options integer con/no-set 0 0 to 3
HHIGRP high-high low-low alarm group integer con/no-set 1 1 to 8
HHIPRI high-high low-low alarm priority integer con/no-set 5 1 to 5
ALMHYS alarm hysteresis real con/no-set 2.0
HHILIM high-high alarm limit real con/set 100.0
LLOLIM low-low alarm limit real con/set 0.0
HHITXT high-high alarm text string con/no-set blank 1 to 32 chars
LLOTXT low-low alarm text string con/no-set blank 1 to 32 chars
HLOPT high-low alarm option short con/no-set 0 0 to 3
HLGRP high-low alarm group short con/no-set 1 1 to 8
HLPRI high-low alarm priority Integer con/no-set 5 1 to 5
HILIM high alarm limit real con/set 100.0
LOLIM low alarm limit real con/set 0.0
HITXT high alarm text string con/no-set blank 1 to 32 chars
LOTXT low alarm text string con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration interval integer no-con/set 0 0 to 32767
NASTDB nuisance alarm suppression long integer no-con/set 0 0 to 2147483647
deadband
NASOPT nuisance alarm suppression boolean no-con/set 0 0 to 1
option
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set
AUT_SW auto switch boolean con/no-set 0 0 to 1
BLKERR block error packed bool- con/no-set blank 0 to 0xFFFF
ean

401
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

Table A-1. AI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


BLKSTA block status packed long con/no-set 0 0 to
0xFFFFFFFF
CRIT criticality integer con/no-set 1 1 to 5
INHSTA inhibit status packed long con/no-set 0 0 to
0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode integer con/no-set 0 to 0xFFFF
OOS_SW out of service switch boolean con/set 0 0 to 1
OUT output real con/no-set 0.0
OUTSTS output status packed bool- con/no-set 0 to 0xFFFF
ean
PRTYPE priority type integer con/no-set 0 0, 1, 2,
PV process variable real con/no-set 0.0
PVSTS process variable status packed bool- con/no-set 0 to 0xFF
ean
TSTAMP time stamp long integer con/no-set 0 ms after mid-
night
UNACK unacknowledged boolean con/set 0 0 to 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to
0xFFFFFFFF
CFGERR configuration error short no-con/no-set
DEFINE no config errors boolean no-con/no-set 1 ---
DESCRP descriptor string no-con/no-set blank 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 8 to 13 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
RO1 range output string no-con/no-set 0.0 - 100.0 1 to 32 chars
ST_REV status revision integer no-con/no-set 2 blanks 0 to 65535

A.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a set-
table parameter is changed externally. It wraps around from 32767 to
–32768.

ALMHYS Alarm Hysteresis is a configurable, non-settable real parameter that speci-


fies the hysteresis to be used in the Absolute Alarming and
High-High/Low-Low Alarming logic performed in an AI block. It is
equivalent to the ALARM_HYS parameter in a device AI function block
and is used to calculate the alarm dead band as follows:
Alarm dead band = ALMHYS * (HSCO1 – LSCO1) /100.0

ALMOPT Alarm Options contain packed long values representing the alarm types
that have been configured as options in the block, and the alarm groups

402
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

that are in use. Table A-2 shows how the parameter is used by the AI
block.

Table A-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
16 Low Absolute Alarm Configured
17 High Absolute Alarm Configured
22 Bad I/O Alarm Configured
24 Low-Low Absolute Alarm Configured
25 High-High Absolute Alarm Configured
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table A-3 shows the bits used by the AI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9

HMA
HHA

CRIT PRTYPE
BAD

LMA
LLA
INH

403
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

Table A-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the FF
blocks
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
16 LMA Low Absolute Alarm ALMSTA.B16
17 HMA High Absolute Alarm ALMSTA.B15
22 BAD Bad I/O Alarm ALMSTA.B10
24 LLA Low-Low Absolute Alarm ALMSTA.B8
25 HHA High-High Absolute Alarm ALMSTA.B7
29 INH Inhibit Alarm. This bit is set when ALMSTA.B3
any of the block’s alarms is inhibited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and thus MODE_BLK.Target in the associated device function
block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the AI block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the AI
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

404
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block.
Table A-4 shows the parameter format.

Table A-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table A-5 shows how the bits are used by the AI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

UDEF

FBM

TRK
LCK

BIO
MA
ON

LO

Table A-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block’s mode is BLKSTA.B29
Local Override
6 TRK The block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual mode

405
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

Table A-5. BLKSTA Parameter Format (Continued)

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
11 MA The device block mode is Auto BLKSTA.B21
12 BIO Bad I/O BLKSTA.B20
14 UDEF Block is undefined BLKSTA.B18
15 ON The compound that contains the block BLKSTA.B17
is ON
19 FBM228 The device’s host FBM is an FBM228 BLKSTA.B13
20 LCK A workstation has locked this block BLKSTA.B12
*Bit 0 is the least significant, low order bit.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the AI block becomes undefined due to a
“W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.
See FF-890-1.4 for further details.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.
See FF-890-1.4 for further details.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 407 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.

406
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-configurable, non-connectable, non-settable ASCII


string of up to 32 characters used to specify a description for the AI block.
The block value is copied from the TAGDSC parameter.

DPTI1 Input Decimal Point is a configurable, downloadable, non-settable short


integer used to specify the XD_SCALE.decimal parameter of the associated
device function block. The range is 0 to 10.

DPTO1 Output Decimal Point is a configurable, downloadable, non-settable short


integer used to specify the OUT_SCALE.decimal parameter of a device
function block. The range is 0 to 10.

EI1 Engineering Units Input 1 provides the engineering units text for the
MEAS parameter in the AI block. The value configured for this text string
should be consistent with the values used for HSCI1 and LSCI1. This
parameter does not configure units in the device block; see EUI1.

EO1 Engineering Units for Output 1 specifies the engineering units text for the
OUT parameter in an AI block. The value configured for this text string
should be consistent with the values used for HSCO1 and LSCO1. This
parameter does not configure units in the device block; see EUO1.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table A-6 list the possible values of ERCODE for the AI block.

Table A-6. ERCODE Values

ERCODE Value
W43 INVALID PERIOD/PHASE COMBINATION
W54 ECB DOES NOT EXIST
W62 UNRESOLVED CONNECTION
W65 INVALID POINT ADDRESS
W66 DUPLICATE CONNECTION
W67 INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 INVALID DEVICE CONNECTION
W69 INVALID POINT CONNECTION
W73 FF FUNCTION BLOCK CONFIGURATION ERROR
W74 FF FUNCTION BLOCK DDITEM MISMATCH
W75 FF FUNCTION BLOCK DDMBR MISMATCH
W76 INVALID FF MODE CONFIGURATION
W77 FIELDBUS COMMUNICATION FAULT
W78 INVALID FUNCTION BLOCK
W79 INVALID PARAMETER INDEX
W80 FIELDBUS DEVICE NOT FOUND

407
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in the AI block. The range is 1 (default) to 8.

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. The parameter has the same format as
BLKERR (Table A-4).

EUI1 Input Engineering Units Index is a configurable, downloadable, non-set-


table integer used to specify the XD_SCALE.Units Index parameter of the
device function block.

EUO1 Output Engineering Units Index is a configurable, downloadable, non-


settable integer used to specify the OUT_SCALE.Units Index parameter of
the device function block.

HHIGRP High-High Low-Low Alarm Group is a configurable, non-settable short


integer used to specify the alarm group assigned to High-High and Low-
Low Alarms in the AI block. The range 1 (default) to 8.

HHILIM High-High Alarm Limit is a configurable, settable real input used to spec-
ify the high limit value to be used in the High-High Alarm detection logic
in the AI block. It is equivalent to the HI_HI_LIM parameter in a device
function block; however, HHILIM does not set the device block parame-
ter.

HHIOPT High-High Low-Low Alarm Option is a configurable, non-settable short


integer used to enable/disable High-High and Low-Low Alarm detection
in the AI block. Valid settings are:
♦ 0 = Disable High-High and Low-Low Alarming
♦ 1 = Enable High-High and Low-Low Alarming
♦ 2 = Enable High-High Alarming only
♦ 3 = Enable Low-Low Alarming only.

HHIPRI High-High Low-Low Priority is a configurable, settable integer input used


to specify the alarm priority to be assigned to High-High and Low-Low
Alarms in the AI block. The range is 1 (the highest) to 5 (default).

HHITXT High-High Alarm Text is a configurable, non-settable ASCII string of up


to 32 characters that describes the High-High Alarm. HHITXT is
included in the High-High Alarm message created when the alarm
condition occurs.

HILIM High Alarm Limit is a configurable, settable real input used to specify the
high limit value to be used in Absolute Alarm detection logic in an AI
block. It is equivalent to the HI_LIM parameter in a device function
block; however, HILIM does not set the device block parameter.

408
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

HITXT High Alarm Text is a configurable, non-settable ASCII string of up to


32 characters that describes the High Absolute Alarm in the AI block.
HITXT is included in the High Alarm message created when the alarm
condition occurs.

HLGRP High Low Alarm Group is a configurable, non-settable short integer used
to specify the alarm group assigned to High Low Absolute Alarms in the
AI block. The range is 1 (default) to 8.

HLOPT High Low Alarm Option is a configurable, non-settable short integer used
to enable or disable High and Low Absolute Alarm detection in an AI
block. Valid settings are:
♦ 0 = Disable High and Low Absolute Alarming
♦ 1 = Enable High and Low Absolute Alarming
♦ 2 = Enable High Absolute Alarming only
♦ 3 = Enable Low Absolute Alarming only.

HLPRI High Low Alarm Priority is a configurable, settable integer input used to
specify the alarm priority to be assigned to High Low Absolute Alarms in a
FF AI block. The range is 1 (highest) to 5 (default).

HSCI1 Input High Scale specifies the XD_SCALE.EU_100 parameter value of


the associated device function block.

HSCO1 Output High Scale specifies the OUT_SCALE.EU_100 parameter value


of the associated device function block.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm
generation inhibit requests for each type of alarm configured in the block.
Table A-7 shows how the bits are used by the AI block.

Table A-7. INHALM Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 15) When True (B16 to B1)
0 Inhibit Low Absolute Alarm INHALM.B16
1 Inhibit High Absolute Alarm INHALM.B15
6 Inhibit Bad I/O Alarm INHALM.B10
8 Inhibit Low-Low Absolute Alarm INHALM.B8
9 Inhibit High-High Absolute Alarm INHALM.B7
*Bit 0 is the least significant, low order bit.
There are no mnemonic names for the individual bits of INHALM.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message

409
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

reporting; the alarm handling and detection functions are determined by


the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table A-8 shows
how the parameter is used with the AI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
BAD B10
B11
B12
B13
B14
HMA B15
LMA B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
DSC B6
HHA B7
LLA B8
B9

Table A-8. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
16 LMA Low Absolute Alarm Inhibited INHSTA.B16
17 HMA High Absolute Alarm Inhibited INHSTA.B15
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
24 LLA Low-Low Absolute Alarm Inhibited INHSTA.B8
25 HHA High-High Absolute Alarm Inhibited INHSTA.B7
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound

410
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

<cp_letterbug>_ECB, where cp_letterbug is the station letterbug


of the I/A Series station.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB.

IOOPTS I/O Options is a configurable, downloadable, non-settable, packed


Boolean used to specify the IO_OPTS parameter of the associated device
function block (see Section A.5.1.4). Table A-9 shows how the bits are
used by the AI block.

Table A-9. IO_OPTS Parameter Format

Bit Boolean
Number* Description, When True Connection
5 Low-cut IO_OPTS.B27
*Bit 0 is the least significant, low order bit.

L_TYPE Linearization Type is a configurable, downloadable, short integer used


to specify the L_TYPE parameter of the associated device function block:
1 = The value is used directly.
2 = The value field is converted linearly.
3 = The value is converted with the square root.
See Section A.5.1.3 for further details.

LLOTXT Low-Low Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used to describe the Low-Low Alarm in the AI block.
LLOTXT is included in the Low-Low Alarm message created when the
alarm condition occurs.

LLOLIM Low-Low Alarm Limit is a configurable, settable real input used to specify
the low limit value to be used in the Low-Low Alarm detection logic in
the AI block. It is equivalent to the LO_LO_LIM parameter in a device
function block; however, LLOLIM does not set the device block
parameter.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has the
format LETTERBUG:DEVNAME, where LETTERBUG is the 6-char-
acter letterbug of the workstation and DEVNAME is the 1- to 6-character
logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier

411
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

accompanying the SETVAL command is entered into the LOCKID


parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOLIM Low Alarm Limit is a configurable, settable real input used to specify the
low limit value to be used in Absolute Alarm detection logic in an AI
block. It is equivalent to the LO_LIM parameter in a device function
block; however, LOLIM does not set the device function block parameter.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block.

LOTXT Low Alarm Text is a configurable, non-settable ASCII string of up to


32 characters that describes the Low Absolute Alarm in the AI block.
LOTXT is included in the Low Alarm message created when the alarm
condition occurs.

LOWCUT Low Cutoff is a configurable, downloadable, non-settable real value used


to specify the LOW_CUT parameter of the associated device function
block. See Section A.5.1.4.

LSCI1 Input Low Scale specifies the XD_SCALE.EU_0 parameter value of the
device function block.

LSCO1 Output Low Scale specifies the OUT_SCALE.EU_0 parameter value of a


device function block.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the associated device function block,
to Manual.

MEAS Measurement is a value used as the input to the AI block when simulation
is active (SIMOPT = 1) instead of the OUT parameter (and the OUT
parameter in the associated device function block).

MODE_A Actual mode is a non-configurable, non-settable, packed Boolean output


that contains the MODE_BLK.Actual parameter of the associated device
function block.

MODE_N Normal mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Normal parameter of the
associated device function block.

MODE_P Permitted mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

412
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

MODE_T Target mode is a configurable, downloadable, packed Boolean output that


contains the MODE_BLK.Target parameter of the associated device func-
tion block. MODE_T is not directly settable. The AUT_SW, MAN_SW,
and OOS_SW are used to change the MODE_T parameter and thus the
MODE_BLK.Target parameter in the device function block.

NAME Name is a user-defined string of up to 12 characters for accessing the


block and its parameters, and identifying the matching device function
block in the device. When the I/A Series block is initialized, the block
updates the configurable parameters of the device function block whose
Function Block Tag matches the NAME parameter. If there is no match-
ing Function Block Tag, the block renames the first available analog input
function block and updates the other configurable parameters.

NASOPT Nuisance Alarm Suppression Alarm Option is a configurable, settable


boolean parameter that specifies whether the nuisance alarm delay speci-
fied in NASTDB is implemented by delaying the return to normal
(NASOPT=0) or by delaying alarm detection (NASOPT=1).

NASTDB Nuisance Alarm Suppression Time Deadband is used to reduce the


number of alarm messages generated when a block parameter crosses back
and forth over an alarm limit. When the parameter is set to zero, an alarm
is generated each time the parameter is outside the limit and is cleared
each time it crosses back. Thus, a parameter that is fluttering at the alarm
limit can result in nuisance alarms. NASTDB specifies, in milliseconds, a
time that must lapse before the alarm is cleared and before another alarm
message can be generated. The specified value is rounded up to the nearest
even multiple of the control station BPC. If the parameter passes from
outside one limit to outside the opposite extreme, the deadband is
ignored.

OOS_SW Out of Service Switch is a settable output used to set the MODE_T
parameter, and thus the MODE_BLK.Target in the associated device func-
tion block, to Out of Service.

OUT Output is a real output that contains the OUT parameter of the associated
device function block. It is settable only in Manual mode.

OUTDSC Output Descriptor is a configurable, non-settable ASCII string of up to


32 characters used as descriptive information in block alarm messages.

OUTSTS Output Status is a non-settable, packed Boolean output that contains the
OUT.Status parameter in the associated device function block. See
Section A.6.4 for a description of the .Status value.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.

413
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. For instance, assuming that
the BPC of the I/A Series station is 0.5 second, a block with a PERIOD of
3 (2.0 seconds) can execute within the first, second, third, or fourth BPC
of the 2-second time period. See Integrated Control Software Concepts
(B0193AW).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the AI block:
0 = No alarm
8 = Bad I/O alarm.

PV Process Variable is a non-settable real output that contains the PV


parameter of the associated device function block. See Section A.5.

PVFTIM PV Filter Time is a configurable, downloadable, non-settable real input


that is used to specify the PV_FTIME parameter of the associated device
function block. See Section A.5.1.5 for further details.

PVSTS Process Variable Status is a non-settable, packed Boolean output that con-
tains the PV.Status of the associated device function block. See
Section A.6.4 for a description of the .Status value.

RO1 Range Output 1 is a real array consisting of the two parameters HSCO1
and LSCO1. The array members are configured by their individual
names; however, RO1 and its members can be accessed on an array basis
by user tasks and displays.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


AI block is to be simulated.

414
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

When SIMOPT= 1 (True), the status and value of OUT are not recovered
from the field, but are computed by the control station based on the simu-
lated value derived from the MEAS parameter. The simulated values are
limited by HSCI1 and LSCI1. If this limiting action forces a clamping of
the entered value, the status of OUT is set to Limited High or Limited
Low, as appropriate.

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block. ST_REV increments
each time change is made to the configurable device block parameters
from an external source.

STOPTS Status Options is a configurable, downloadable, non-settable, packed


Boolean that is used to specify the STATUS_OPTS parameter of the
associated device function block. The AI block uses only first eight bits
(least significant, low order bits) as show in Table A-10.

Table A-10. STATUS_OPTS Parameter Format

Bit* Option Set with Bit


8 Uncertain if MAN Mode
7 BAD if Limited
6 Uncertain if Limited
5 Target to MAN if BAD In
4 Propagate Fault Backward
3 Propagate Fault Forward
* Bit 0 is the least significant, low order bit.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device
function block. The value of TAGDSC is also copied to the DESCRP
parameter to provide a description of the block in I/A Series displays.

TSTAMP Time Stamp, which is expressed in units of milliseconds past midnight, is


updated every time there is a change in the value of the OUT parameter.
When the block is in normal operation, the time is from the FBM228;
when the block is in simulation (SIMOPT = 1), the value is computed by
the CP.

TYPE Type is the block type. When an AI block is added to the control database,
the configuration editor enters the value 109 to specify the AI block type.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,

415
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the alarms display.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period for client/server connections scheduled by the
FBM228 to read the device function block View 1, View 2 and View 4
parameters. The range is 0 to 2147483647 milliseconds; the default is
10000.

A.5 Device Function Block Description


This section describes the FOUNDATION fieldbus analog input device function block, and
includes a block schematic, a brief description of the block’s standard parameter set, and a table
showing the mapping between the I/A Series system AI block parameters and the device function
block parameters.

A.5.1 Device Block Operation


The H1 device analog input function block processes a measurement from a field device and
makes it available to other function blocks in the OUT parameter (Figure A-1). The CHANNEL
parameter specifies which of several measurements from the device is to be handled by the block.

PV

Simulation Conversion Cutoff Filter


CHANNEL
L_TYPE Output
XD_SCALE
SIMULATE OUT_SCALE LOW_CUT PV_TIME OUT

Mode FIELD_VAL Alarms


HI_HI_LIM
HI_LIM
LO_LIM
LO_LO_LIM

Figure A-1. Analog Input Device Function Block Schematic

A.5.1.1 Mode
The device function block supports three modes:
♦ In Automatic mode, the OUT parameter reflects the process variable (PV) value and
status.
♦ In Manual, the OUT parameter can be set manually and the OUT status reflects the
mode.
♦ In OOS (out of service), the block values are not updated and the status of OUT is set
to BAD. In OOS, changes can be made to configured parameters.

416
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

A.5.1.2 Simulation
The SIMULATE parameter in the device function block allows the OUT parameter to be set by
an external source such as a hand-held H1 device for testing. When SIMULATE is enabled, the
actual measurement has no affect on the OUT value and status. Simulation at the device block
level also requires that you set a simulation jumper on the device.
The I/A Series AI block supports simulation within the control processor. The option is set with
the SIMOPT parameter in the AI block, as described in Section A.6.7.

A.5.1.3 Conversion
The linearization type parameter (L_TYPE) determines whether the measurement is converted
directly, linearly (indirect), or indirectly with the square root.
XD_SCALE parameter structure determines the high and low scale values, engineering units,
and number of places to the right of the decimal of the value in the selected channel. The
OUT_SCALE parameters provide similar scaling for the value in the OUT parameter.

A.5.1.4 Cutoff
When the Low Cutoff option selected in IO_OPTS and the converted input value falls below the
value in LOW_CUT, the PV parameter is set to zero.

A.5.1.5 Filter
Filtering changes the response time of the device to smooth variations in the input readings
caused by rapid changes in the input value. The filtering time (PV_TIME) is applied to PV, not to
FIELD_VAL.

A.5.1.6 Alarms
The device AI function block provides standard FOUNDATION fieldbus alarms plus HI_HI, HI,
LO and LO_LO applied to OUT.
The I/A Series system does not use the alarm features provided by the device blocks, but rather
provides alarm handling options in the CP-resident AI block. The AO block provides detection
and reporting form BAD I/O, high and low absolute and high-high and low-low alarm condi-
tions. See Section A.6.6.

A.5.2 Parameter Transforms


Table A-11 illustrates the mapping of AI block parameters and parameters in the linked device
function block. Many of the parameters are straightforward 1:1 mappings that are either unidirec-
tional or bidirectional. Other mappings require that a data value be re-formatted (or transformed)

417
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

to be intelligible in the I/A Series system. From the point of view of the AI block, the relationship
with the device function block can also be described in terms of sink and source connections:
→ Source-sink The AI block parameter is the source for the matching device func-
tion block parameter. Thus, changes to the AI block parameter are
made to the device parameter. For example, when the AI block is ini-
tialized, the TAGDSC value is copied to the device function block
TAG_DESC parameter.
← Sink-source The AI block parameter value is updated by the corresponding device
function block parameter. For example, the MODE_A parameter
reads the device parameter MODE_BLK.Actual to make the actual
device function block mode visible to the control system.
↔ Bidirectional Changes to the AI block parameter are made to the corresponding
device function block parameter and vice versa. For example, when
an AI block is initialized, its STOPTS parameter value is written to
the equivalent device function block parameter, STATUS_OPTS, to
configure how the function block processes block status information.
Subsequent changes to the status options made at the device are writ-
ten back to the AI block STOPTS parameter.

The arrow notation is used in Table A-11; the mappings are presented in alphabetic order,
arranged by the AI block parameter names.

Table A-11. AI Block Parameter Transforms

AI Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SW = 1:
Set MODE_T (request) = AUTO
Set CAS_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP to FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.FBM CP-FBM communication is failed
BLKSTA.BIO OUT.Status.Bad (Bits 6-7=0)
CHANNL ↔ CHANNEL
DPTI1 ↔ XD_SCALE.Decimal Point
DPTO1 ↔ OUT_SCALE.Decimal Point
EUI1 ↔ XD_SCALE.units Index
EUO1 ↔ OUT_SCALE.units Index
HSCI1 ↔ XD_SCALE.@100%

418
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

Table A-11. AI Block Parameter Transforms (Continued)

AI Parameter Device Function Block Parameter


HSCO1 ↔ OUT_SCALE.@100%
IOOPTS ↔ IO_OPTS
LSCI1 ↔ XD_SCALE.@0%
LSCO1 ↔ OUT_SCALE.@0%
MAN_SW MODE_BLK.Target
When MAN_SW = 1:
Set MODE_T (request) = MAN
Set AUT_SW=0 and OOS_SW=0
Write MODE_T (request) to FBM
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual)
← MODE_BLK.Target
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permit
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW =1:
Set MODE_T (request) = OOS
Set AUT_SW=0 and MAN_SW=0
Write MODE_T (request) to FBM
OUT OUT
OUT.value (request) ↔ OUT.Value (in MAN mode only)
OUT.value (actual) ← OUT.Value
OUT.status.LHI ← OUT.Status.Limited Hi (Bit 0),
OUT.status.LLO ← OUT.Status.Limited Lo (Bit 1)
OUT.status.ERR ← OUT.Status.Uncertain (Bits 6-7=1)
OUT.status.BAD ← OUT.Status.Bad (Bits 6-7=0)
OUT.status.OOS or CP-FBM communication failure
← OUT.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0

419
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

Table A-11. AI Block Parameter Transforms (Continued)

AI Parameter Device Function Block Parameter


OUTSTS OUT
OUTSTS.value → OUT.Status
PV PV
PV.value ← PV.Value
PV.status.LHI ← PV.Status.Limited Hi (Bit 0)
PV.status.LLO ← PV.Status.Limited Lo (Bit 1)
PV.status.ERR ← PV.Status.Uncertain (Bits 6-7=1)
PV.status.BAD ← PV.Status.Bad (Bits 6-7=0)
PV.status.OOS or CP-FBM communication failure
← PV.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
PVFTIM ↔ PV_FTIME
PVSTS PV
PVSTS.value ← PV.Status
STOPTS ↔ STATUS_OPTS
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC → TAG_DESC

A.6 AI Block Functions


The I/A Series AI block provides the interface between CP-resident control blocks and the device
function block in the H1 device.
The AI block OUT and OUTSTS parameters hold the value and status of the device OUT
parameter, while the PV and PVSTS parameters reflect the value and status of the function block’s
primary value.
The AI block does not scale or condition the input from the device, as scaling for engineering
units is handled by the device function block. The AI block does, however, enable configuration
of the conversion, cutoff, and filtering options by configuration of corresponding AI block param-
eters that are then written to the device function block.
The AI block and the device function block operate in two asynchronous cycles, both writing to
and reading from shared space in the FBM memory. As with other I/A Series IO blocks, the AI
block executes in the Basic Processing Cycle (BPC) of the control station according to its com-
pound and its PERIOD and PHASE parameters, as described in Integrated Control Software Con-
cepts (B0700AG). The device function block executes once each FBM macrocycle as scheduled by
the FBM228.
The principal task of the AI block is to read a value and status from the corresponding device
block. For this task, the FBM228 establishes a publisher/subscriber connection between the AI
block OUT parameter and the device function block OUT parameter.

420
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

All other parameter connections are made by the FBM on a client/server basis at the frequency
specified in the UPDPER parameter. The parameter can be set from 0 to 2147483647 millisec-
onds; the default is 10000 (10 seconds). Increasing the frequency of the client/server communica-
tion can significantly add to the load on the H1 segment.

A.6.1 Device Function Block Connection


The configured parameter IOM_ID of the AI block specifies an ECB201 (the device ECB) that
represents the target H1 device and its H1 segment. The ECB201 PARENT parameter identifies
the ECB200 or ECB202 for the host FBM228. The path to the device block is completed in one
of two ways, depending on which configuration editor is used:
♦ When the AI block is configured in IACC, the AI block is connected to the device
block whose tag matches the NAME parameter of the AI block. If there is no match-
ing device block tag, the AI block binds to the first un-initialized analog input device
block and re-tags the device block accordingly.
♦ When the AI block is configured using IEE, the device function block is selected in a
browser which displays the device function blocks based on the device description in
the device ECB. If the connection is not made via the browser, the connection is made
based on the AI block NAME parameter.

A.6.2 Device Configuration Parameters


The AI block enables the user to set the standard configurable parameters in the corresponding
device function block and manage the device configuration from the I/A Series system. When you
deploy the AI block to the control station, and then download the FBM228, parameter values in
the AI block update parameters in the linked device function block.
The deployment of the AI block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Schedule execution of the device function block
♦ If needed, add a compel data (CD) message to each macrocycle to publish the OUT
parameter value and status
♦ Schedule client/server connections between the AI block and the device function
block for view updates
Table A-12 lists the device function block parameters and the AI block parameters used to config-
ure them. For the AI block, the table includes both the six-character (maximum) parameter name
that is used in block detail displays and the parameter labels used in IACC, which more closely
resemble the FOUNDATION fieldbus parameter names. Use the six-character parameter name
when connecting parameters to a process display.

Table A-12. AI Block Configuration Parameters

Configured with AI Block Parameter


Device Function Block
Parameter Name in Process Displays IACC Label
CHANNEL CHANNL Channel
IO_OPTS IOOPTS Io_opts
L_TYPE L_TYPE L_type
LOW_CUT LOWCUT Low_cut

421
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

Table A-12. AI Block Configuration Parameters (Continued)

Configured with AI Block Parameter


Device Function Block
Parameter Name in Process Displays IACC Label
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
OUT_SCALE.Decimal Point DPTO1 Out_decpt
OUT_SCALE.EU at 0% LSCO1 Out_scale@0
OUT_SCALE.EU at 100% HSCO1 Out_scale@100
OUT_SCALE.Units Index EUO1 Out_eu
PV_FTIME PVFTIM PV_ftim
STATUS_OPTS STOPTS StatusOpt
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc
XD_SCALE.Decimal Point DPTI1 XD_decpt
XD_SCALE.EU at 0% LSCI1 XD_scale@0
XD_SCALE.EU at 100% HSCI1 XD_scale@100
XD_SCALE.Units Index EUI1 XD_eu

A.6.3 Scaling
Table 10-9 lists the AI block parameters used to configure the device function block scaling
parameters. When the device block parameters are changed they are read back to the AI block.

Table 10-9. Scaling Parameters

AI Block Device Function Block


LSCO1 ↔ OUT_SCALE.@0%
HSCO1 ↔ OUT_SCALE.@100%
DPTO1 ↔ OUT_SCALE.Decimal
EUO1 ↔ OUT_SCALE.Units Index
LSCI1 ↔ XD_SCALE.@0%
HSCI1 ↔ XD_SCALE.@100%
DPTI1 ↔ XD_SCALE.Decimal
EUI1 ↔ XD_SCALE.Units Index

A.6.4 Block Status


The analog input device function block OUT and PV parameters have both a value and a status.
The status is contained in a 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits. The
status is read into the AI block parameter, bit for bit. The default displays for the AI block shows

422
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

the converted status parameter so that the value need not be decoded. Table A-13 shows how the
status byte is formatted.
Table A-13. AI Block Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 SubStatus depends on .Quality, as shown in Table A-14
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table A-14 shows the usage of the Substatus bits, which varies depending on which .Quality bits
are set.
Table A-14. AI Block Substatus

Bits 2-5 = SubStatus Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced in by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.

423
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

Table A-14. AI Block Substatus (Continued)

Bits 2-5 = SubStatus Description


4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

424
Appendix A. Legacy AI – Foundation™ fieldbus Analog Input B0700EC – Rev B

A.6.5 Mode Machine


The AI block mode and switch parameters support the FOUNDATION fieldbus state machine
schema, which is functionally equivalent to a single rotary switch that can be set to one of the per-
mitted states such as OOS, MAN, and AUTO.
The possible states are enumerated in the device function block MODE.Permitted parameter,
while the MODE.Target and MODE.Normal parameters specify the target and normal states,
respectively.
To transition the device to a different state, a request is written to the MODE.Target parameter.
Depending on device/block operation, it is possible for the actual mode of the function block to
differ from the desired Target. The actual mode can be read from the device function block
MODE_BLK.Actual.
The AI block supports the device function block mode parameters with the configurable
MODE_T, MODE_P, and MODE_N parameters and the output parameter MODE_A.
To change the mode of the device function block from the I/A Series system, a mode request is
issued with the value of MODE_T via a switch parameter and written to MODE_BLK.Target.
The target value written to the device is rung back to be reflected in the MODE_T parameter.
In the AI block, MODE_T, and thus the function block MODE.Target, is set by one of three set-
table boolean parameters:
♦ AUT_SW changes the target mode to Automatic in which the device block OUT
parameter holds the block’s computed value
♦ MAN_SW changes the target mode to Manual so the device block OUT parameter
can be set with the AI block OUT parameter
♦ OOS_SW changes the target mode to Out of Service, so that the device block config-
uration can be modified.
Refer to Table A-11 for a description of the switch parameter actions and mapping of the AI block
mode parameters to their device block equivalents.

A.6.6 Alarms
The AI block uses standard I/A Series alarm detection and reporting features, rather than the
alarm features of the device function block, to provide bad I/O, high and low absolute, and high-
high and low-low alarming. The functionality is configured with the parameters described in
Table 10-10.

Table 10-10. AI Block Alarm Parameters

Alarm Type Option Limits Priority Group Text


BAD BADOPT=1 -- BADPRI BADGRP BADTXT
High Absolute HLOPT=1 or 2 HILIM HLPRI HLGRP HITXT
Low Absolute HLOPT=1 or 3 LOLIM HLPRI HLGRP LOTXT
High-High Absolute HHIOPT=1 or 2 HHLIM HHIPRI HHIGRP HHITXT
Low-Low Absolute HLOPT=1 or 3 LLOLIM HHIPRI HHIGRP LLOTXT

Refer to Integrated Control Software Concepts (B0700AG) for information on alarm functionality.

425
B0700EC – Rev B Appendix A. Legacy AI – Foundation™ fieldbus Analog

A.6.7 Simulation
Simulation of a control loop involving analog input from an H1 device can be performed using
the SIMULATE parameters in the device function blocks as described Section A.5.1.2, or the
simulation can be performed entirely within the control station by using the AI simulation option
and the equivalent functionality in the output blocks.
When SIMOPT= 1 (True), the status and value of OUT are not recovered from the field, but are
computed by the control station based on the simulated value derived from the MEAS parameter.
The simulated values are limited by HSCI1 and LSCI1. If this limiting action forces a clamping
of the entered value, the status of OUT is set to Limited High or Limited Low, as appropriate.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus (B0750BC) or
Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for instructions on con-
ducting control simulations from the device or control station.

426
Appendix B. Legacy AO –
FOUNDATION™ fieldbus Analog
Output
This appendix describes the legacy Analog Output (AO) block, shipped with I/A Series systems
with v8.4.3 or earlier software, used with an FBM228 with SWTYPE=228. The AO block
interfaces the control system with a corresponding analog output function block operating in a
FOUNDATION™ fieldbus H1 device.

B.1 Overview
Analog Output (AO) is a Distributed Control Interface (DCI) block that provides an interface
between the control processor and an analog output function block operating in a FOUNDA-
TION fieldbus H1 device (the device function block). The AO block is supported on the
FCP270 and ZCP270 when the H1 device is connected to the control station by an FBM228
(with SWTYPE=228). The AO block is configured using the Block Configurator in the InFu-
sion Engineering Environment (IEE) as described in InFusion Enterprise Control System: Imple-
menting FOUNDATION fieldbus (B0750BC) or with the I/A Series Configuration Component
(IACC) software as described in Implementing FOUNDATION fieldbus on the I/A Series System
(B0700BA).

B.2 Basic Operation


The AO block integrates the linked device function block into the I/A Series system. On initial-
ization, user-configured values in the AO block are written to the standard configurable parame-
ters in the device function block. During normal operation, the AO block maintains a
publisher/subscriber connection with the device function block to write a value to the device
block CAS_IN parameter, and reads the value and status of the device block BKCAL_OUT
parameter. In addition, the AO block provides access to a variety of operational and diagnostic
information via client/server connections with the parameters that are included in Views 1, 2, and
4 of the device block. The values read from these parameters are displayed in the block detail dis-
plays and are available for connection to other I/A Series blocks.

B.3 Features
The AO block provides the following features:
♦ Outputs a setpoint value to the linked device analog output function block, and
acquires the block’s primary output value and status for read-back to the control
system
♦ Time stamps value and status changes
♦ Accesses the parameters in the device function block’s View 1, View 2 and View 4
using change-driven and periodic client/server connections

427
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

♦ Ensures that changes in the device function block’s process values and error conditions
are continuously available for display and connection to the control strategy
♦ Supports the device block Fault State handling
♦ Provides for the configuration of device block parameters from the I/A Series system
and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Automatic, Cascade,
Manual or Out of Service
♦ Provides detection and reporting for Bad I/O alarming
♦ Supports simulation of device block output within the control station

B.4 Block Parameters


Table B-1 lists the block parameters. See Table B-10 for mappings between the AO block
parameters and their device function block equivalents.

Table B-1. AO Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set AO
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 13
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0 = no simulation
1 = simulation
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path, up
to 12 chars
CHANNL channel integer no-con/no-set 1
DDITEM DD item long no-con/no-set 0x800201F0
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000 0 to 2147483647
STRATG strategy integer no-con/no-set 0 to 65535
STOPTS status options packed bool- no-con/no-set 0x1080 0 to 0xFFFF
ean
IOOPTS I/O options packed bool- no-con/no-set 0x1340 0 to 0xFF
ean
SHEDOP mode shed option short no-con/set 0x01 0 TO 8
HSCI1 high scale input real no-con/no-set 100.0 >LSCI1
LSCI1 low scale input real no-con/no-set 0.0 <HSCI1
DPTI1 input decimal point integer /no-set 0 0 to 10
EI1 engineering units string no-con/no-set % 1 to 32 chars
EUI1 input eng. units index integer /no-set 1342 0 to 32767
HSCO1 output high scale real no-con/no-set 100.0
LSCO1 output low scale real no-con/no-set 0
DPTO1 output decimal point integer /no-set 0 0 to 10

428
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table B-1. AO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


EO1 eng units, output 1 string no-con/no-set % 1 to 32 chars
EUO1 eng units index integer no-con/no-set 1342 0 to 32767
MODE_N normal mode integer no-con/no-set 0x20 0 to 0xFFFF
MODE_P permitted mode integer no-con/no-set 0x39 0 to 0xFFFF
MODE_T target mode integer no-con/no-set 0x20
CAS_IN cascade input real con/set 0.0
SP setpoint real no-con/set 0.0
SPHLIM setpoint high limit real con/set 100.0
SPLLIM setpoint low limit real con/set 0.0
PRIBLK primary block boolean no-con/set 0
cascade option
PRITIM primary cascade timer real no-con/set 0.0
FSOPTN faultstate option integer no-con/no-set 0 0 to 7
FSTIME faultstate time real no-con/no-set 20.0 sec
FSVAL faultstate value real no-con/no-set 100.0
INHOPT inhibit option short no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short con/no-set 1 1 to 8
BADOPT bad alarm option short no-con/no-set 0 0 to 3
BADGRP bad alarm group integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 0 to 32 chars
OUTDSC output descriptor string con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration integer no-con/set 0 0 to 32767
interval

429
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

Table B-1. AO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set
AUT_SW auto switch boolean con/set 0 0 to 1
BCALCO back calc output real con/no-set
BCOSTS back calc out status packed bool- con/no-set 0 to 0xFF
ean
BLKERR block error packed bool- con/no-set blank 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0 TO
0xFFFFFFFF
CASSTS cascade input status real con/no-set 0 to 0xFF
CAS_SW cascade switch boolean con/set 0
CRIT criticality integer con/no-set 0 0 to 5
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode integer con/no-set 0 to 0xFFFF
OOS_SW out of service switch boolean con/set 0 0 to 1
OUT output real con/no-set
OUTSTS output status packed bool- con/no-set 0 to 0xFF
ean
PRTYPE priority type integer con/no-set 0 0, 1, 2, 3, 4, 8, 25
PV process variable real con/no-set
PVSTS process variable packed bool- con/no-set 0 to 0xFF
status ean
RBK readback real con/no-set
RBKSTS readback status packed bool- con/no-set 0 to 0xFF
ean
SPSTS setpoint status packed bool- con/no-set 0 to 0xFF
ean
SETFS set faultstate boolean con/set
TSTAMP time stamp long integer con/no-set 0 ms after midnight
UNACK unacknowledged boolean con/set 0 0 to 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
CFGERR configuration error short no-con/no-set
DEFINE no config errors boolean no-con/no-set 1 ---
DESCRP descriptor string no-con/no-set blank 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 8 to 13 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
RI1 range input string no-con/no-set 100,0,100
ST_REV status revision integer no-con/no-set 2 blanks

430
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

B.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT Alarm Options contains packed long values representing the alarm types
that have been configured as options in the block, and the alarm groups
that are in use. Table B-2 shows how the parameter is used by the AO
block.

Table B-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table B-3 shows the bits used by the AO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9

CRIT PRTYPE
BAD
INH

431
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

Table B-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the FF
blocks
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
22 BAD Bad I/O Alarm ALMSTA.B10
29 INH Inhibit Alarm. This bit is set when ALMSTA.B3
any of the block’s alarms is inhibited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and thus the MODE_BLK.Target1 in the associated device
function block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the AO block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the AO
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BCALCO Back Calculated Output is set equal to the confirmed component of


BKCAL_OUT in the associated AO device block while cascade is initializ-

1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

432
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

ing. Since its purpose is to provide the upstream block with a back-calcu-
lated value, connect BCALCO to the BCALCI parameter of the upstream
block.

BCOSTS Back Calculated Output Status is a non-settable, packed Boolean output


that contains the BKCAL_OUT.Status of the associated device function
block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block.
Table B-4 shows the parameter format.

Table B-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table B-5 shows how the bits are used by the AO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B24
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

UDEF

FBM

TRK
LCK

BIO
MA
ON

LO
LR
FS

433
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

Table B-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local BLKSTA.B29
Override
6 TRK Block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual mode
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
10 LR Device block mode is Cascade. BLKSTA.B24
(0 indicates the device block mode is
either Auto or Manual.)
11 MA The device block mode is Auto. BLKSTA.B21
12 BIO Bad I/O BLKSTA.B20
14 UDEF Block is undefined BLKSTA.B18
15 ON The compound that contains the block BLKSTA.B17
is ON
19 FBM228 The device is hosted and scheduled by BLKSTA.B13
an FBM228
20 LCK A workstation has locked this block. BLKSTA.B12
24 FS Fault State has been asserted in the BLKSTA.B8
device function block
*Bit 0 is the least significant, low order bit.

CAS_IN Cascade Input is a configurable real input used to specify the CAS_IN
parameter of the associated device function block. It is settable only in
Cascade mode if unlinked.

CAS_SW Cascade Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the associated device function block,
to Cascade.

CASSTS Cascade Input Status is a non-settable, packed Boolean output that


contains the CAS_IN.Status of the associated device AO function block.
See Section B.6.5 further details.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the FF Function block becomes unde-
fined due to a “W73 - FF FUNCTION BLOCK CONFIGURATION
ERROR”. When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index.

434
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block. See
Section B.5.1.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5
(default). An output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 435 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string of up to


32 characters used to specify a description for the AO block. DESCRP
tracks TAGDSC.

DPTI1 Input Decimal Point is a configurable, downloadable, non-settable short


integer used to specify the XD_SCALE.decimal parameter of the associated
device function block. The range is 0 to 10. See Section B.5.1.3.

DPTO1 Output Decimal Point is a configurable, downloadable, non-settable


short integer used to specify the PV_SCALE.decimal parameter of the
associated device function block. The range is 0 to 10. See
Section B.5.1.3.

EI1 Engineering Units Input 1 provides the engineering units text for the
OUT parameter. The value configured for this text string should be con-
sistent with the values used for HSCI1 and LSCI1. This parameter does
not configure units in the device block; see EUI1.

EO1 Engineering Units for Output 1 specifies the engineering units text for the
PV parameter. The value configured for this text string should be consis-
tent with the values used for HSCO1 and LSCO1. This parameter does
not configure units in the device function block; see EUO1.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.

435
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

Validation of configuration errors does not proceed past the first error
encountered by the block logic. Table B-6 lists the possible values of
ERCODE.

Table B-6. ERRCODE Values

ERCODE Value
W43 INVALID PERIOD/PHASE COMBINATION
W54 ECB DOES NOT EXIST
W62 UNRESOLVED CONNECTION
W65 INVALID POINT ADDRESS
W66 DUPLICATE CONNECTION
W67 INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 INVALID DEVICE CONNECTION
W69 INVALID POINT CONNECTION
W73 FF FUNCTION BLOCK CONFIGURATION ERROR
W74 FF FUNCTION BLOCK DDITEM MISMATCH
W75 FF FUNCTION BLOCK DDMBR MISMATCH
W76 INVALID FF MODE CONFIGURATION
W77 FIELDBUS COMMUNICATION FAULT
W78 INVALID FUNCTION BLOCK
W79 INVALID PARAMETER INDEX
W80 FIELDBUS DEVICE NOT FOUND

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in the AO block. The range is 1 (default) to 8.

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. The parameter has the same format as
BLKERR (Table B-4).

EUI1 Input Engineering Units Index is a configurable, downloadable, non-set-


table integer used to specify the XD_SCALE.Units Index parameter of the
device function block.

EUO1 Output Engineering Units Index is a configurable, downloadable, non-


settable integer used to specify the PV_SCALE.Units Index parameter of
the device function block.

FSOPTN Fault State Option is a configurable integer parameter that specifies the
Fault State conditions and action to be taken by the FBM and the con-
nected H1 device for an output point in the AO block:
♦ Bit 0: 1 = Assert Fault State if there is an input or measurement
error.
Note that ERROPT must be configured nonzero for this
option to take effect.

436
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

♦ Bit 1: 1 = Set/Clear Fault State when SETFS input is set/cleared.


♦ Bit 2: 1 = Assert Fault State if control station-to-FBM communi-
cation is lost (FBM option). This option is enabled only if
Fault State is enabled at the FBM level via the FSENAB
parameter in the ECB200 or ECB202.

Bit 0 is the least significant, low order bit. FSOPTN is dependent upon
how the Fault State parameters are configured in the device with which
the AO block is being used. The Fault State can also be turned off in the
device resource block, which would render FSOPTN ineffective.

FSTIME Fault State Time is a configurable, downloadable, real value used to specify
the FSTATE_TIME parameter of a device function block. See
Section B.6.6.

FSVAL Fault State Value is a configurable, downloadable, non-settable real value


used to specify the FSTATE_VAL parameter of a device AO block. See
Section B.6.6.

HSCI1 Input High Scale specifies the XD_SCALE.EU_100 parameter value of


the associated device function block.

HSCO1 Output High Scale specifies the PV_SCALE.EU_100 parameter value of


the associated device function block.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

437
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table B-7 shows
how parameter is used with the AO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 15 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

BAD B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
Table B-7. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB.

IOOPTS I/O Options is a configurable, downloadable, non-settable, packed


Boolean used to specify the IO_OPTS parameter of the associated device
function block. Table B-8 shows how the bits are used by the AO block.
Table B-8. IO_OPTS Parameter Format

Bit Boolean
Number* Description, When True Connection
14 SP-PV Track in Man IO_OPTS.B18
12 SP-PV Track in LO IO_OPTS.B19
11 SP Track retained target IO_OPTS.B21

438
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table B-8. IO_OPTS Parameter Format (Continued)

Bit Boolean
Number* Description, When True Connection
9 Fault State to Value IO_OPTS.B23
8 Fault State on Restart IO_OPTS.B24
7 Target to MAN on FS IO_OPTS.B25
6 Use PV for BKCAL_OUT IO_OPTS.B26
*Bit 0 is the least significant, low order bit.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block, immediately
below the faceplate.

LSCI1 Input Low Scale specifies the XD_SCALE.EU_0 parameter value of the
device function block.

LSCO1 Output Low Scale specifies the PV_SCALE.EU_0 parameter value of the
device function block.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the associated device function block,
to Manual.

MODE_A Actual mode is a non-configurable, non-settable, packed Boolean output


that contains the MODE_BLK.Actual parameter of the associated device
function block.

MODE_N Normal mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Normal parameter of the
associated device function block.

439
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

MODE_P Permitted mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target mode is a configurable, downloadable, packed Boolean output that


contains the MODE_BLK.Target parameter of the associated device func-
tion block. MODE_T is not directly settable. AUT_SW, MAN_SW,
CAS_SW, and OOS_SW are used to change the MODE_T parameter
and thus the MODE_BLK.Target parameter in the device function block.

NAME Name is a user-defined string of up to 12 characters for accessing the


block and its parameters, and identifying the matching device function
block in the device. When the I/A Series block is initialized, the block
updates the configurable parameters of the function block whose Function
Block Tag matches the NAME parameter. If there is no matching Func-
tion Block Tag, the block renames the first available block of the function
block and updates the other configurable parameters.

OOS_SW Out of Service Switch is a settable output used to set the MODE_T
parameter, and thus the MODE_BLK.Target in the associated device func-
tion block, to Out of Service.

OUT Output is a real output that contains the OUT parameter of the associated
device function block. It is settable only in Manual mode.

OUTDSC Output Descriptor is a configurable, non-settable ASCII string of up to


32 characters used as descriptive information in block alarm messages.

OUTSTS Output Status is a non-settable, packed Boolean output that contains the
value of OUT.Status in device function blocks. See Section B.6.5.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes

440
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Period Length Period Length


4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. For instance, assuming that
the BPC of the I/A Series station is 0.5 second, a block with a PERIOD of
3 (2.0 seconds) can execute within the first, second, third, or fourth BPC
of the 2-second time period. See Integrated Control Software Concepts
(B0700AG).

PRIBLK Primary Block indicates whether the AO block has a connection from an
upstream block (PRIBLK = 1) or not (PRIBLK = 0). Its value and the
value of PRITIM determine whether the block remains in holding until
the upstream block returns an acknowledgement, remains in holding for a
fixed time delay, or ends the hold after one cycle.

PRITIM Primary Cascade Timer is a configurable parameter used to delay the clos-
ing of the cascade to a primary block when the output is initialized in the
AO block. It is used only if the PRIBLK option is set. If PRITIM = 0 and
PRIBLK is used, the cascade remains open indefinitely until acknowl-
edged by the primary block.

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the AO block:
0 = No alarm
8 = Bad I/O alarm.

PV Process Variable is a non-settable real output that contains the PV


parameter of the associated device function block.

PVSTS Process Variable Status is a non-settable, packed Boolean output that con-
tains the PV.Status of the associated device function block. See
Section B.6.5.

RBK Readback is a non-settable real output that contains the READBACK


parameter of the associated device function block.

RBKSTS Readback Status is a non-settable, packed Boolean output that contains


the READBACK.Status of the associated device function block. See
Section B.6.5.

RO1 Range Output 1 is a real array consisting of the two parameters HSCO1
and LSCO1. The array members are configured by their individual
names; however, RO1 and its members can be accessed on an array basis
by user tasks and displays.

441
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

SETFS Set Fault State Request is a Boolean parameter that requests Fault State
action to be reset by the FBM or field device for the specific output value
of the block. The settings are:
♦ 1 = set Fault State request
♦ 0 = reset Fault State request
See Section B.6.6.

SHEDOP Mode Shed Options is a configurable, downloadable, short integer that is


used to specify the SHED_OPT parameter of the associated device func-
tion block.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


FF function block is to be simulated.
When SIMOPT= 1 (True) for an output block, there is no DCI connec-
tion established for the block, and the status and value of BCALCO are
not recovered from the field, but are computed by the control station
based on the simulated value change. The simulated behavior of the block
reflects the operational mode of the block (MODE_A).

SP Set Point is a non-connectable, configurable real output that is used to


specify the SP parameter of the associated device function block. It is set-
table only in Auto mode.

SPHLIM Set Point High Limit is a configurable real input that is used to specify the
SP_HI_LIM parameter of the associated device function block. It is
settable if unlinked. See Section B.5.1.2 for further details.

SPLLIM Set Point Low Limit is a configurable real input that is used to specify the
SP_LO_LIM parameter of the associated device function block. It is
settable if unlinked. See Section B.5.1.2 for further details.

SPSTS Set Point Status is a non-settable, packed Boolean output that contains the
SP.Status of the associated device function block. See Section B.6.5.

ST_REV Status Revision is a non-settable integer that contains the ST_REV param-
eter of the associated device function block.

STOPTS Status Options is a configurable, downloadable, non-settable, packed


Boolean that is used to specify the STATUS_OPTS parameter of the asso-
ciated device function block. The AO blocks uses only bit 4 as shown in
Table B-9.

Table B-9. STATUS_OPTS Parameter Format

Bit* Option Set with Bit


4 Propagate Fault Backward
* Bit 0 is the least significant, low order bit.

442
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device
function block. The TAGDSC string is also copied to the DESCRP
parameter to provide the same description for I/A Series block displays.

TSTAMP Time Stamp, which is expressed in units of milliseconds past midnight, is


updated every time there is a change in the value of the BCALCO param-
eter. The time is from the FBM228 when a new output is sent to device
function block. However, when the block is in simulation (SIMOPT = 1),
the value is computed by the CP.

TYPE Type is the block type. When an AO block is added to the control data-
base, the configuration editor enters a value of 110 to specify the AO
block type.

UNACK Unacknowledge is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the Current Alarms display.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 to schedule client/server
connections to scan the device function block View 1, View 2, and View 4
parameters. The range is 0 to 2147483647 milliseconds; the default is
10000.

B.5 Device Function Block Description


This section describes the FOUNDATION fieldbus analog output device function block, and
includes a block schematic, a brief description of the block’s standard parameter set, and a table
showing the mapping between the I/A Series AO block parameters and the device function block
parameters.

B.5.1 Device Block Operation


The analog output device function block processes a setpoint input from another block or an
external source and outputs the value to a field device at the OUT parameter (Figure B-1). The
value is output to the hardware specified in the device block CHANNEL parameter.

443
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

BKCAL_OUT
RCAS_OUT

Setpoint Out Output


CAS_IN Conversion
OUT
SP_RATE_DN
SP_RATE_UP PV_SCALE
SP_HI_LM XD_SCALE
SP_LO_LIM
Simulation
SP PV
CHANNEL

SIMULATE
Mode PV Fault
Conversion State

SHED_OPT READBACK
PV_SCALE FSTATE_TIME
XD_SCALE FSTATE_VAL

Figure B-1. Device AO Function Block Schematic

B.5.1.1 Mode
The device AO block supports the following modes:
♦ Man - Manual allows you to set the OUT parameter.
♦ Auto - In Automatic, the OUT parameter reflects the SP value.
♦ Cas - Cascade allows the OUT parameter to be set by an external source connected to
the CAS_IN parameter.
♦ OOS - When the mode is Out of Service, the block is not processed, the output
channel is maintained at the last value, and the status of OUT is set to BAD.
♦ IMan - Initialization Manual indicates that the path to the output hardware is closed.
The output remains at its last value.
♦ LO - Local Override is set when the resource block has been placed in LO or a Fault
State is active. In LO, the output of the block does not respond to CAS_IN.

B.5.1.2 Setpoint
The source of the Setpoint depends on the block mode as described in Section B.5.1.1. The SP
value is limited to the range defined by SP_HI_LIM and SP_LO_LIM. When the block is in Auto
mode, the rate at which changes in the SP value are passed to the OUT value are limited by the
SP_RATE_DN and SP_RATE_UP parameters.

B.5.1.3 Out Conversion


The PV_SCALE and XD_SCALE parameters scale the setpoint before it is copied to the PV and
OUT parameters respectively.

444
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

B.5.1.4 Output
This value is passed to the device’s transducer block to provide the “setpoint” to the servo-position
circuit that actually manipulates the valve position.

B.5.1.5 Simulation
When the SIMULATE parameter in the device function block is set, the OUT parameter value is
not sent to the device, and the BKCAL_OUT can be set an external source such as a hand-held
H1 device for testing. Simulation at the device block level also requires that you set a simulation
jumper on the device.
Simulation of the control loop involving an analog output to an H1 device can be accomplished
entirely within the control station and not involve communication with the H1 devices, as
described in Section B.6.8.

B.5.1.6 Fault State


The AO block has two Fault State options, which are set in the IO_OPTS parameter:
♦ Fault State on Restart sets the OUT parameter to a specified value when the device is
recycled because of a loss of power or for some other reason. The value is specified in
FSATE_VAL.
♦ Fault State to Value sets the OUT parameter to a specified value if the block has not
received a value for output from its configured source within the time specified in
FSTATE_TIME. As with the restart option, the value is specified in FSATE_VAL.
In the case of both options, the device detects the condition and takes the Fault State action.

B.5.1.7 PV Conversion
The PV_SCALE parameter is used to convert the SP to percent of span. The XD_SCALE range is
used to convert percent of span to the number used by the hardware. This allows portions of the
SP span to cause full span movement of the output. The Increase to close option in IO_OPTS can
be used to invert the span. See FF-891, Section 4.9.3 for a description of the AO block scaling.

B.5.2 AO Parameter Transforms


Table B-10 shows the mapping of the AO block parameters to the parameters in the related device
function block. Many of the parameters are straightforward 1:1 mappings that are either unidirec-
tional or bidirectional. Other mappings require that a value be re-formatted (or transformed) to
be intelligible in the I/A Series system.
From the point of view of the AO block, the relationship with the device function block can also
be described in terms of sink and source connections:
→ Source-sink The AO block parameter is the source for the matching device func-
tion block parameter. Thus, changes to the AO block parameter are
copied to the device function block parameter. For example, when
the AO block is initialized, the TAGDSC value is copied to the
device function block TAG_DESC parameter.

445
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

← Sink-source The AO block parameter value is updated by the corresponding


device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual function block mode visible to the control system.
↔ Bidirectional Changes to the AO block parameter are made to the device function
block parameter and vice versa. For example, when an AO block is
initialized, its MODE_T parameter value is written to the device
block parameter, MODE_BLK.Target, to configure the block’s target
mode. Subsequently, the MODE_BLK.Target value is written back to
the AO block MODE_T parameter.

The arrow notation is used in the Table B-10 descriptions of AO parameter transforms. These are
presented in alphabetic order, arranged by the AO block parameter names.

Table B-10. AO Block Parameter Transforms

FF Function block
Parameter Device Analog Output Block Parameter
AUT_SW MODE_BLK.Target
When AUT_SW = 1:
Set MODE_T (request) = AUTO
Set CAS_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM

446
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table B-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
BCALCO BKCAL_OUT, CAS_IN, MODE_BLK.Actual
BCALCO.value ← BKCAL_OUT.Value if initializing;
← CAS_IN.Value if not initializing
BCALCO.status.LHI ← BKCAL_OUT.Status.Limited Hi (Bit 0),
or MODE_BLK.Actual is not Cascade,
or BKCAL_OUT.Status.Bad (Bits 6-7=0),
or CP-FBM communication failure,
or the DCI connection record indicates
an Initialization Request (IR), Local Override (LO),
Open Loop (LHI and LLO), Not Invited (NI), or
Fault State Active (FSA) condition in the AO function block.
BCALCO.status.LLO ← BKCAL_OUT.Status.Limited Lo (Bit 1),
or MODE_BLK.Actual is not Cascade,
or BKCAL_OUT.Status.Bad (Bits 6-7=0),
or CP-FBM communication failure,
or the DCI connection record indicates
an Initialization Request (IR), Local Override (LO),
Open Loop (LHI and LLO), Not Invited (NI),
or Fault State Active (FSA) condition in the AO function block.
BCALCO.status.BAD ← BKCAL_OUT.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
BCALCO.status.OOS ← BKCAL_OUT.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
BCOSTS BKCAL_OUT
BCOSTS.value ← BKCAL_OUT.Status
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP-FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual, BKCAL_OUT
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.HLD ← CAS_IN source value is BAD
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← BKCAL_OUT.Status.Bad (Bits 6-7=0)
BLKSTA.FS ← BKCAL_OUT.Status.Good (Bits 6-7=0)
and Substatus.FSA (bits2-5= 7)
CASSTS CAS_IN
CASSTS.value ← CAS_IN.Status

447
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

Table B-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
CAS_IN CAS_IN, BKCAL_OUT
CAS_IN.value (request) → CAS_IN.Value (in CAS mode only)
CAS_IN.value (actual) ← BKCAL_OUT.Value if initializing;
← CAS_IN.Value if not initializing
CAS_IN.status.LHI ← CAS_IN.Status.Limited Hi (Bit 0)
or CAS_IN source value is LHI
CAS_IN.status.LLO ← CAS_IN.Status.Limited Lo (Bit 1)
or CAS_IN source value is LLO
CAS_IN.status.ERR ← CAS_IN.Status.Uncertain (Bits 6-7=1)
or CAS_IN source value is ERR
CAS_IN.status.BAD ← CAS_IN.Status.Bad (Bits 6-7=0),
or CAS_IN source value is BAD,
or CP-FBM communication failure
CAS_IN.status.OOS ← CAS_IN.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or CAS_IN source value is OOS,
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
CHANNL ↔ CHANNEL
DPTI1 ↔ PV_SCALE decimal pt
DPTO1 ↔ XD _SCALE decimal pt
EUI1 ↔ PV _SCALE units index
EUO1 ↔ XD _SCALE units index
FSTIME ↔ FSTATE_TIME
FSVAL ↔ FSTATE_VAL
HSCI1 ↔ PV _SCALE @ 100%
HSCO1 ↔ XD _SCALE @ 100%
IOOPTS ↔ IO_OPTS
LSCI1 ↔ PV _SCALE @ 0%
LSCO1 ↔ XD _SCALE @ 0%
MAN_SW MODE_BLK.Target
When MAN_SW = 1:
Set MODE_T (request) = MAN
Set CAS_SW=0, AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal

448
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table B-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
MODE_P ↔ MODE_BLK.Permit
MODE_T MODE_BLK.Target
MODE_T.value (request) ← MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW is set =1:
Set MODE_T (request) = OOS
Set CAS_SW=0, AUT_SW=0, MAN_SW=0
Write MODE_T (request) to FBM
OUT OUT
OUT.value (request) → OUT.Value (in MAN mode only)
OUT.value (actual) ← OUT.Value
OUT.status.LHI ← OUT.Status.Limited Hi (Bit 0)
OUT.status.LLO ← OUT.Status.Limited Lo (Bit 1)
OUT.status.ERR ← OUT.Status.Uncertain (Bits 6-7=1)
OUT.status.BAD ← OUT.Status.Bad (Bits 6-7=0) or CP-FBM communication failure
OUT.status.OOS ← OUT.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
OUTSTS OUT
OUTSTS.value ← OUT.Status
PV PV, BKCAL_OUT
PV.value ← PV.Value if IO_OPTS.Use PV for BKCAL_OUT (Bit 9)= 0
← BKCAL_OUT if IO_OPTS.Use PV for BKCAL_OUT (Bit 9)= 1
PV.status.LHI ← PV.Status.Limited Hi (Bit 0)
PV.status.LLO ← PV.Status.Limited Lo (Bit 1)
PV.status.ERR ← PV.Status.Uncertain (Bits 6-7=1)
PV.status.BAD ← PV.Status.Bad (Bits 6-7=0) or CP-FBM communication failure
PV.status.OOS ← PV.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
PVSTS PV
PVSTS.value ← PV.Status

449
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

Table B-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
RBK READBACK
RBK.value ← READBACK.Value
RBK.status.LHI ← READBACK.Status.Limited Hi (Bit 0)
RBK.status.LLO ← READBACK.Status.Limited Lo (Bit 1)
RBK.status.ERR ← READBACK.Status.Uncertain (Bits 6-7=1)
RBK.status.BAD ← READBACK.Status.Bad (Bits 6-7=0) or
CP-FBM communication failure
RBK.status.OOS ← READBACK.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
RBKSTS READBACK
RBKSTS.value ← READBACK.Status
SHEDOP ↔ SHEDOP
SP SP
SP.value (request) ← SP.Value (in AUTO mode only)
SP.value (actual) ← SP.Value
SP.status.LHI ← SP.Status.Limited Hi (Bit 0)
SP.status.LLO ← SP.Status.Limited Lo (Bit 1)
SP.status.BAD ← SP.Status.Bad (Bits 6-7=0) or CP-FBM communication failure
SP.status.OOS ← SP.Status.Bad (Bits 6-7=0) a and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
SPHLIM SP_HI_LIM
SPHLIM.value (request) → SP_HI_LIM.Value (in AUTO mode only)
SPHLIM.value (actual) ← SP_HI_LIM.Value
SPHLIM.status.OOS ← SPHLIM source value is OOS,
or Compound is Off,
or FBM228 is Off-Line,
or CP-FBM communication failure
SPLLIM SP_LO_LIM
SPLLIM.value (request) → SP_LO_LIM.Value (in AUTO mode only)
SPLLIM.value (actual) ← SP_LO_LIM.Value
SPLLIM.status.OOS ← SPLLIM source value is OOS,
or Compound is Off,
or FBM228 is Off-Line,
or CP-FBM communication failure

450
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table B-10. AO Block Parameter Transforms (Continued)

FF Function block
Parameter Device Analog Output Block Parameter
SPSTS SP
SPSTS.value ← SP.Status
STOPTS ↔ STATUS_OPTS
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC ← TAG_DESC

B.6 AO Block Functions


With each execution, the AO block receives a value from an I/A Series system control block, such
as PIDA, and writes the value to the device function block’s CAS_IN parameter. The AO block
also reads the value and status from the device function block’s BKCAL_OUT parameter.
The AO block does not scale or condition the output to the device, as scaling for engineering
units is handled by the function block. The AO block does, however, enable you to set the values
for the device function block’s PV_SCALE and XD_SCALE parameters.

B.6.1 Device Function Block Connection


The configured parameter IOM_ID of the AO block specifies an ECB201 (the device ECB) that
represents the target H1 device. The ECB201 PARENT parameter identifies the ECB200 or
ECB202 for the FBM228. The path to the device block is completed in one of two ways, depend-
ing on which configuration editor is used:
♦ When the AO block is configured in IACC, the AO block is connected to the device
block whose tag matches the NAME parameter of the AO block. If there is no match-
ing device block tag, the AO block binds to the first un-initialized analog output
device function block and re-tags the device function block accordingly.
♦ When the AO block is configured using IEE, the device function block is selected in a
browser which displays the device function blocks based on the device description in
the device ECB. If the connection is not made via the browser, it is made based on the
AO block NAME parameter.

B.6.2 Device Configuration Parameters


The AO block enables you to set the standard configurable parameters in the device function
block and manage the device configuration from the I/A Series system control database. When
you deploy the AO block to the control station, and then download the FBM228, parameter val-
ues in the AO block update parameters in the linked device block AO block.
The deployment of the AO block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Configure a Compel Data (CD) message for each macrocycle to write the AO block
CASIN parameter to the device function block CAS_IN parameter
♦ Schedule execution of the device function block

451
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

♦ Configure a CD message for each macrocycle to publish the device function block’s
BKCAL_OUT to be read by the AO block BCALCO parameter.
♦ Schedule client/server connections between the AO block and the device function
block for view updates.
Table B-11 lists the device function block parameters and the AO block parameters used to con-
figure them. For the AO block, the table includes both the six-character (maximum) parameter
name that is used in block detail displays and the IACC parameter labels, which more closely
resemble the FOUNDATION fieldbus parameter names. Use the six-character parameter name
when connecting parameters to a process display.

Table B-11. AO Block Configuration Parameters

Configured with AO Parameter


Device Function Block
Parameter Name in Process Displays Label in IACC
CHANNEL CHANNL Channel
FSTATE TIME FSTIME Fstate_Time
FSTATE VALUE FSVAL Fstate _Val
IO_OPTS IOOPTS Io_opts
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
PV_SCALE.Decimal Point DPTO1 PV_decpt
PV_SCALE.EU at 100% LSCO1 PV_scale@0
PV_SCALE.EU at 100% HSCO1 PV_scale@100
PV_SCALE.Units Index EUO1 PV_eu
SHED_OPTS SHEDOP Shed_opt
SP SP SP
SP_HI_LIM SPHLIM Sp_hi_lim
SP_LO_LIM SPLLIM Sp_lo_lim
STATUS_OPTS STOPTS StatusOpt
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc
XD_SCALE.Decimal Point DPTI1 XD_decpt
XD_SCALE.EU at 0% LSCI1 XD_scale@0
XD_SCALE.EU at 100% HSCI1 XD_scale@100
XD_SCALE.Units Index EUI1 XD_eu

The following are suggested and required AO parameter settings:


♦ Configure MODE_P to include at least Cascade, Auto, and Out of Service.
Other modes are optional.
♦ Set MODE_T to Cascade and Auto.
♦ Configure IO OPTS to include SP_PV Track in LO (required), and FS to Value and
Use FS on Restart (recommended).
♦ Use the STOPTS parameter to set the STATUS_OPTS: Propagate Fail Backward
(required).
♦ Configure SHEDOP to Normal Shed, Normal Return.

452
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

♦ Set the Fault State option in the resource block’s FEATURE_SEL parameter.
The following IO_OPTS features are not supported:
♦ Invert (do not use)
♦ SP Track Retained Target
♦ Increase to Close (do not use)
♦ Target to Man if FS Asserted.

B.6.3 Scaling
Table B-12 lists AO block parameters used to set the device function block scaling parameters.

Table B-12. Scaling Parameters

AO Block Device Function Block


LSCO1 ↔ PV_SCALE.@0%
HSCO1 ↔ PV_SCALE.@100%
DPTO1 ↔PV_SCALE Decimal
EUO1 ↔ PV _SCALE Units Index
LSCI1 ↔ XD_SCALE.@0%
HSCI1 ↔ XD_SCALE.@100%
DPTI1 ↔ XD _SCALE Decimal
EUI1 ↔ XD_SCALE.Units Index

B.6.4 Mode Machine


The AO block mode and switch parameters support the FOUNDATION fieldbus state machine
schema, which is functionally equivalent to a single rotary switch that can be set to one of the per-
mitted states such as OOS, MAN, AUTO and CAS.
The possible states are enumerated in the device function block MODE.Permitted parameter,
while the MODE.Target and MODE.Normal parameters specify the target and normal states,
respectively.
To transition the device to a different state, a request is written to the MODE.Target parameter.
Depending on device/block operation, it is possible for the actual mode of the function block to
differ from the desired Target. The actual mode can be read from the device function block
MODE_BLK.Actual.
The AO block supports the device function block mode parameters with the configurable
MODE_T, MODE_P, and MODE_N parameters and the output parameter MODE_A.
To change the mode of the device function block from the I/A Series system, a mode request is
issued with the value of MODE_T via a switch parameter and written to MODE_BLK.Target in
the device. The target value written to the device is rung back to be reflected in the MODE_T
parameter.
In the AO block, MODE_T, and thus the function block MODE.Target, is set by one of four set-
table boolean parameters:
♦ AUT_SW changes the target mode to Automatic so that device block OUT parameter
reflects the SP (setpoint) parameter

453
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

♦ CAS_SW changes the target mode to Cascade in which OUT is derived from the
CAS_IN parameter (which in turn is set by the AO block CASIN parameter).
♦ MAN_SW changes the target mode to Manual so that the device OUT parameter can
be set via the AO block OUT parameter.
♦ OOS_SW changes the target mode to Out of Service so that the configurable device
block parameters can be modified.
Refer to Table B-10 for a description of the switch parameter actions and mapping of the AO
block mode parameters to their device block equivalents.

B.6.5 Block Status


The device analog output function block OUT and PV parameters have both a value and a status.
The status is contained in a 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits. The
status is read into the AO block parameter, bit for bit. The default displays for the AO block
shows the converted status parameter so that the value need not be decoded. Table B-13 shows
how the status byte is formatted.
Table B-13. AO Block Status Format

Bits Description
0-1 Limits:
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 SubStatus depends on .Quality, as shown in Table B-14
6-7 Quality:
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table B-14 shows the usage of the Substatus bits, which varies depending on the bits set
in .Quality.

Table B-14. AO Block SubStatus

Bits 2-5 = SubStatus and Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced in by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.

454
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table B-14. AO Block SubStatus (Continued)

Bits 2-5 = SubStatus and Description


4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.
4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).

455
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

Table B-14. AO Block SubStatus (Continued)

Bits 2-5 = SubStatus and Description


2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

B.6.6 Fault State Handling


Failsafe parameters in the FBM228 equipment control block (ECB200 or ECB202) and the AO
block support the Fault State operation in the device function block. The Fault State action is
designed to provide levels of fault protection for communication errors between various levels of
the hardware architecture. The AO block provides options for placing an output device into a
Fault State condition, with the output being driven to a user-determined value or the last good
value.
The FBM228 can be configured to force the attached H1 devices to take their configured Fault
State actions when a communication error between the FBM and the control station persists for
more than a specified period. The ECB failsafe options are designed to assert Fault State at the
device level for a communication failure above the FBM. The assertion does not establish the
device Fault State behavior as that is determined by options in the device function block. Differ-
ent behaviors can be set for each device connected to the FBM.
The device Fault State options are designed primarily to deal with communication failures above
the device, while working in concert with ECB options. Enabling Fault State is effective under
two external conditions:
♦ When Fault State is asserted by the connected FBM
♦ When communications to the device are lost and the device AO block mode is CAS
or RCAS.
The actual Fault State behavior taken by the device function block is specified in the following
AO block parameters listed in Table B-15.

456
Appendix B. Legacy AO – Foundation™ fieldbus Analog Output B0700EC – Rev B

Table B-15. Fault State Parameters in the AO Block

Parameter Description
FSOPTN Enables one or more faultstate operations in the AO block as follows:
♦ 0 Disable all options
♦ 1 Assert Fault State on an input or measurement error
♦ 2 Set or clear Fault State when SETFS is set or cleared
♦ 3 Assert Fault State if the FBM228 detects a failure in communica-
tions with the control station
♦ 7 Sets options 1, 2, and 3 (recommended setting)
IO_OPTS Configures the device block parameter IO_OPTS to enable/disable two
Fault State options:
♦ Fault State on Restart: Selecting this option causes the device to go
to the value specified in FSTATE_VAL on a device RESTART. If
this option is not selected and the device block can go to its target
mode upon RESTART, the last saved setpoint (SP) is used for gen-
erating the Fault State position.
♦ Fault State to Value: When this option is selected, the block uses
the value specified in FSTATE_VAL. When the option is not
selected, the last saved setpoint is used.
FSVAL Configures FSTATE_VAL in the device function block, specifying the
value that is asserted when one of the faultstate options is invoked.
FSTIME Configures FSTATE_TIME in the device function block, setting the
period that the fault condition must last before the block asserts the spec-
ified value. A Fault State action does not occur until the FSTATE_TIME
interval has expired.

NOTE
An additional requirement for Fault State handling at the device level is that the
Fault State option must be selected in the device resource block, that is,
(0x4)FaultState must be selected in FEATURE_SEL.

B.6.7 Alarms
The AO block uses standard I/A Series alarm parameters, rather than the alarm features of the
device function block, to specify how to report to the control system when the OUT value is bad.
Alarming is enabled when BADOPT is set to 1 (TRUE). The alarm priority and alarm group are
specified in BADPRI and BADGRP, respectively. The alarm message is specified in BADTXT.
Refer to Integrated Control Software Concepts (B0700AG) for information on alarm functionality.

B.6.8 Simulation
Simulation of a control loop involving an analog output to an H1 device can be performed using
the SIMULATE parameters in the device function blocks as described Section B.5.1.5, or the
simulation can be performed entirely within the control station by using the AO block simulation
option and the equivalent functionality in the input blocks.

457
B0700EC – Rev B Appendix B. Legacy AO – Foundation™ fieldbus Analog

When SIMOPT= 1 (True), the value in CASIN is not sent to the device, but is copied directly to
the BCALCO parameter. The status and value of BKCAL_OUT are not recovered from the field.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus (B0750BC) or
Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for instructions on con-
ducting control simulations from the devices or in the control station.

458
Appendix C. Legacy DI –
FOUNDATION™ fieldbus Discrete
Input
This appendix describes the legacy I/A Series Discrete Input (DI) block, shipped with I/A Series
systems with v8.4.3 or earlier software, used with an FBM228 with SWTYPE=228. The DI
block interfaces the control system with a corresponding discrete input function block operating
in a FOUNDATION™ fieldbus H1 device.

C.1 Overview
Discrete Input (DI) is a Distributed Control Interface (DCI) block that provides an interface
between the control processor and a discrete input function block operating in a FOUNDATION
fieldbus H1 device (the device function block). The DI block is supported on the FCP270 and
ZCP270 when the H1 device is connected to the control station by an FBM228 (with
SWTYPE=228). The DI block is configured using the Block Configurator in the InFusion
Engineering Environment (IEE) as described in InFusion Enterprise Control System: Implement-
ing FOUNDATION fieldbus (B0750BC) or with the I/A Series Configuration Component
(IACC) software as described in Implementing FOUNDATION fieldbus on the I/A Series System
(B0700BA).

C.2 Basic Operation


The DI block integrates the linked device function block into the I/A Series system. On initializa-
tion, user-configured values in the DI block are written to the standard configurable parameters
in the device function block. During normal operation, the DI block maintains a publisher/sub-
scriber connection with the device function block to read the value and status of the device block’s
primary output (OUT_D). In addition, the DI block provides access to a variety of operational
and diagnostic information via client/server connections with the parameters that are included in
Views 1, 2, and 4 of the device block. The values read from these parameters are displayed in the
block detail displays and are available for connection to other I/A Series blocks.

C.3 Features
The DI block provides the following features:
♦ Acquires the device function block’s primary output value and status
♦ Time stamps value and status changes
♦ Accesses the parameters in the device function block’s View 1, View 2 and View 4
using change-driven and periodic client/server connections
♦ Ensures that changes in the device function block’s process values and error conditions
are continuously available for display and connection to the control strategy.

459
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

♦ Provides for the configuration of device function block parameters from the I/A Series
system and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Auto, Manual or Out of
Service
♦ Provides alarm detection and reporting for Bad I/O
♦ Supports simulation of device block output within the control station

C.4 Block Parameters


Table C-1 lists the block parameters. See Table C-11 for mappings between DI block
parameters and their device function block equivalents.

Table C-1. DI Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set DI
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 13
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0 to 1
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path, up
to 12 chars
IOOPTS I/O options packed bool- no-con/no-set 0x00
ean
CHANNL channel integer no-con/no-set 1
DDITEM DD item long no-con/no-set 0x80020210
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000
STRATG strategy integer no-con/no-set
PVTIM PV filter real no-con/no-set 2.0
STOPTS status options packed bool- no-con/no-set 0x800
ean
OUT_ST output state integer no-con/no-set
XD_ST XD state integer no-con/set 0 0 to 32767
MODE_N normal mode integer no-con/set 0x10
MODE_P permitted mode integer no-con/set 0x19
MODE_T target mode integer no-con/set 0x10
IN simulation input integer con/no-set 0
INHOPT inhibit option short no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/n0-set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short con/no-set 1 1 to 8

460
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table C-1. DI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


BADOPT bad alarm option short no-con/no-set 0 0 to 3
BADGRP bad alarm group integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 1 to 32 chars
OUTDSC output descriptor string con/no-set blank 1 to 32 chars
DSCOPT discrete alarm option boolean no-con/no-set 0 0 to 1
DSCGRP discrete alarm group short no-con/no-set 1 1 to 8
DSCPRI discrete alarm priority integer con/set 5 1 to 5
DSCLIM discrete alarm limit short integer no-con/no-set 0 0 to 255
DSCTXT discrete alarm text string no-con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration integer no-con/set 0 0 to 32767
interval
NASTDB nuisance alarm long integer no-con/set 0 0 to 2147483647
suppression deadband
NASOPT nuisance alarm suppres- boolean no-con/set 0 0 to 1
sion option
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set
AUT_SW auto switch boolean con/no-set 0 0 to 1
BLKERR block error packed bool- con/no-set blank
ean
BLKSTA block status packed long con/no-set 0 0 to 0xFFFFFFFF
CRIT criticality integer con/no-set 0 0 to 5
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode integer con/no-set
OOS_SW out of service switch boolean con/set 0 0 to 1
OUTSTS output status packed bool- con/no-set
ean
OUT_D discrete output short con/set
PRTYPE priority type integer con/no-set 0 0, 1, 2, 3, 4, 8, 25
PVSTS process variable status packed bool- con/no-set
ean
PV_D discrete process variable real con/no-set
TSTAMP time stamp long integer con/no-set 0 ms after midnight
UNACK unacknowledged boolean con/set 0 0 to 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
CFGERR configuration error short no-con/no-set
DEFINE no config errors boolean no-con/no-set 1 ---

461
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

Table C-1. DI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DESCRP descriptor string no-con/no-set blank 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 8 to 13 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
ST_REV status revision integer no-con/no-set 2 blanks 0 to 65535

C.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT Alarm Options contain packed long values representing the alarm types
that have been configured as options in the block, and the alarm groups
that are in use. Table C-2 shows how the parameter is used by the DI
block.

Table C-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
22 Bad I/O Alarm Configured
26 Discrete Alarm Configured
*Bit 0 is the least significant, low order bit.

462
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table shows the bits used by the DI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9
DSC
CRIT PRTYPE

BAD
INH

Table C-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the FF
blocks
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
22 BAD Bad I/O Alarm ALMSTA.B10
26 DSC Discrete State Alarm ALMSTA.B6
29 INH Inhibit Alarm. This bit is set when ALMSTA.B3
any of the block’s alarms is inhibited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and thus the MODE_BLK.Target1 in the associated device
function block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the FF block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the DI
block:
♦ 0 (default) disables Bad Alarming

1. Device function block parameters are shown in this document in italics. Function blocks may use
different names for these parameters.

463
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block.
Table C-4 shows the parameter format.

Table C-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table C-5 shows how the bits are used by the DI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

UDEF

FBM

TRK
LCK

BIO
ON

MA

LO

464
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table C-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local BLKSTA.B29
Override
6 TRK The block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual Mode
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
11 MA The device block mode is Auto BLKSTA.B21
12 BIO Bad I/O BLKSTA.B20
14 UDEF The block is undefined BLKSTA.B18
15 ON The compound that contains the block BLKSTA.B17
is ON
19 FBM228 The host FBM for the H1 device is an BLKSTA.B13
FBM228
20 LCK A workstation has locked this block. BLKSTA.B12
*Bit 0 is the least significant, low order bit.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the DI block becomes undefined due to a
“W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 466 for a list of all possible validation
errors in this block.

465
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

♦ If DEFINE = 0, no further processing of the block occurs,


including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-configurable, non-connectable, non-settable ASCII


string of up to 32 characters used to specify a description for the DI block.
DESCRP tracks the TAGDSC parameter, and is updated when TAGDSC
is modified.

DSCGRP Discrete Alarm Group is a configurable, non-settable short integer that


specifies the group used for reporting alarms messages from the DI block.

DSCLIM Discrete Alarm Limit is a configurable, non-settable short integer used to


specify the limit value to be used in the discrete alarm logic performed in
the DI block. It is equivalent to the DISC_LIM parameter in a device
function block; however, DSCLIM does not set the device block
parameter.

DSCOPT Discrete Alarm Option is a configurable non-settable Boolean used to


specify whether or not discrete alarming is to be performed in the block:
♦ 0 disables Discrete Alarming (default)
♦ 1 enables Discrete Alarming.

DSCPRI Discrete Alarm Priority is a configurable short integer input that specifies
the Alarm Priority to be assigned to discrete alarms in the block. It is setta-
ble if unlinked. The range is 1 (highest) to 5 (default).

DSCTXT Discrete Alarm Text is a configurable, non-settable string used as


descriptive text in DI block discrete alarm messages. The range is 1 to
32 ASCII characters.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic. Table C-6 lists the possible values of
ERCODE.
Table C-6. Error Code Values

ERCODE Value
W43 INVALID PERIOD/PHASE COMBINATION
W54 ECB DOES NOT EXIST
W62 UNRESOLVED CONNECTION
W65 INVALID POINT ADDRESS
W66 DUPLICATE CONNECTION
W67 INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 INVALID DEVICE CONNECTION
W69 INVALID POINT CONNECTION

466
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table C-6. Error Code Values (Continued)

ERCODE Value
W73 FF FUNCTION BLOCK CONFIGURATION ERROR
W74 FF FUNCTION BLOCK DDITEM MISMATCH
W75 FF FUNCTION BLOCK DDMBR MISMATCH
W76 INVALID FF MODE CONFIGURATION
W77 FIELDBUS COMMUNICATION FAULT
W78 INVALID FUNCTION BLOCK
W79 INVALID PARAMETER INDEX
W80 FIELDBUS DEVICE NOT FOUND

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting block error (BLKERR)
messages in the block. The range is 1 (default) to 8.

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. The parameter has the same format as
BLKERR (Table C-4).

IN Simulation Input is a value used as the input to the DI block when simu-
lation is active (SIMOPT = 1). In this mode the DI block is disconnected
from the field device.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm
generation inhibit requests for each type of alarm configured in the block.
Table C-7 shows how the bits are used by the DI block.
Table C-7. INHALM Parameter Format

Boolean
Bit* Connection
(0 to 15) Description, When True (B16 to B1)
6 Inhibit Bad I/O Alarm INHALM.B10
10 Inhibit Discrete Alarm INHALM.B6
*Bit 0 is the least significant, low order bit.
There are no mnemonic names for the individual bits of INHALM.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.

467
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,


automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table C-8 shows
how parameter is used with the DI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
BAD B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
DSC B6
B7
B8
B9

Table C-8. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
26 DSC Discrete Alarm Inhibited INHSTA.B6
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB.

IOOPTS I/O Options is a configurable, downloadable, non-settable, packed


Boolean used to specify the IO_OPTS parameter of the associated device
function block. The DI uses a single bit as shown in Table C-9.

468
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table C-9. IO_OPTS Parameter Format

Bit Boolean
Number* Description, When True Connection
15 Invert IO_OPTS.B17
*Bit 0 is the least significant, low order bit.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block, immediately
below the faceplate.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and thus the MODE_BLK.Target in the associated device function block,
to Manual.

MODE_A Actual mode is a non-configurable, non-settable, packed Boolean output


that contains the MODE_BLK.Actual parameter of the associated device
function block.

MODE_N Normal mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Normal parameter of the
associated device function block.

MODE_P Permitted mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Target parameter of the
associated device function block. The parameter is not directly settable;
the AUT_SW, MAN_SW, and OOS_SW can be used to change the

469
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

MODE_T parameter and thus the MODE_BLK.Target parameter in the


device function block.

NAME Name is a user-defined string of up to 12 characters for accessing the


block and its parameters, and identifying the matching device function
block in the device. When the I/A Series block is initialized, the block
updates the configurable parameters of the function block whose Function
Block Tag matches the NAME parameter. If there is no matching Func-
tion Block Tag, the block renames the first available block of the function
block and updates the other configurable parameters.

NASOPT Nuisance Alarm Suppression Alarm Option is a configurable, settable


boolean parameter that specifies whether the nuisance alarm delay speci-
fied in NASTDB is implemented by delaying the return to normal
(NASOPT=0) or by delaying alarm detection (NASOPT=1).

NASTDB Nuisance Alarm Suppression Time Deadband is used to reduce the


number of alarm messages generated when a block parameter crosses back
and forth over an alarm limit. When the parameter is set to zero, an alarm
is generated each time the parameter is outside the limit and is cleared
each time it crosses back. Thus, a parameter that is fluttering at the alarm
limit can result in nuisance alarms. NASTDB specifies, in milliseconds, a
time that must lapse before the alarm is cleared and before another alarm
message can be generated. The specified value is rounded up to the nearest
even multiple of the control station BPC. If the parameter passes from
outside one limit to outside the opposite extreme, the deadband is
ignored.

OOS_SW Out of Service Switch is a settable output used to set the parameter
MODE_BLK.Target to Out of Service in the associated device function
block.

OUT_D Discrete Output is a short integer output that contains the OUT_D
parameter of the associated device function block. It is settable only in
Manual mode.

OUT_ST Output State is a configurable, non-settable integer that is used to specify


the OUT_STATE parameter of the associated device DI function block.
The range is 0 to 32767.

OUTDSC Output Descriptor is a configurable, non-settable ASCII string of up to


32 characters used as descriptive information in block alarm messages.

OUTSTS Output Status is a non-settable, packed Boolean output that contains the
OUT_D.Status parameter in the associated device function. See
Section C.6.3.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value

470
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. For instance, assuming that
the BPC of the I/A Series station is 0.5 second, a block with a PERIOD of
3 (2.0 seconds) can execute within the first, second, third, or fourth BPC
of the 2-second time period. See Integrated Control Software Concepts
(B0193AW).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the DI block:
0 = No alarm
8 = Bad I/O alarm
9 = Discrete state alarm.

PV_D Discrete Process Variable is a non-settable short integer output that con-
tains the PV_D parameter of the associated device function block.

PVFTIM PV Filter Time is a configurable, downloadable, non-settable real input


that is used to specify the PV_FTIME parameter of the associated device
function block. See Section C.5.1.4 for a description of the filter.

PVSTS Process Variable Status is a non-settable, packed Boolean output that con-
tains the PV.Status of the associated device function block. See
Section C.6.3 for a description of the status value.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


DI block is to be simulated.
When SIMOPT= 1 (True), the status and value of OUT_D are not recov-
ered from the field, but are computed by the control station based on the

471
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

simulated value change. The simulated value is derived from the IN


parameter. The simulated behavior of the block reflects the operational
mode of the block (MODE_A).

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block. ST_REV is incre-
mented by one each time a configurable parameter is updated by an exter-
nal source.

STOPTS Status Options is a configurable, downloadable, non-settable, packed


Boolean that is used to specify the STATUS_OPTS parameter of the
associated device function block (Table C-10).

Table C-10. STATUS_OPTS Parameter Format

Bit
Number* Option Set with Bit
8 Uncertain if MAN Mode
3 Propagate Fault Forward
* Bit 0 is the least significant, low order bit.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


specifies the TAG_DESC parameter of the associated device function
block. The TAGDSC value is also copied to the DI block DESCRP
parameter to provide a description of the block in I/A Series displays.

TSTAMP Time Stamp, which is expressed in units of milliseconds past midnight, is


updated every time there is a change in the value of the IN_D parameter.
During normal operation, the time is from the FBM228. When the block
is in simulation (SIMOPT = 1), the value is computed by the CP.

TYPE Type is the block type. When a DI block is added to the control database,
the configuration editor enters a numeric value of 119 to specify the block
type as DI.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator acknowledge
pick on a default display, a user display, or an alarms display.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 to schedule client/server
connections to the device function block View 1, View 2, and View 4

472
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

parameters. The range is 0 to 2147483647 milliseconds; the default is


10000.

XD_ST XD State is a configurable, non-settable integer that is used to specify the


XD_STATE parameter of the associated device function block. The range
is 0 to 32767.

C.5 Device Function Block Description


This section describes the FOUNDATION fieldbus discrete input device function block, and
includes a block schematic, a brief description of the block’s standard parameter set, and a table
showing the mapping between the I/A Series system DI block parameters and the device function
block parameters. Refer to FF-891, Function Block Application Process - Part 2 (FF-891-4.2) for a
detailed description of the block.

C.5.1 Device Block Operation


The FOUNDATION fieldbus discrete input H1 function block (device function block) processes a
discrete input from a field device and makes it available to other function blocks at the OUT_D
parameter (Figure C-1). OUT_D includes a value and a status. The CHANNEL parameter speci-
fies which of several inputs from the device is to be handled by the block.

PV_D

Simulation Conversion Filter


CHANNEL
Output
SIMULATE_D INVERT PV_TIME OUT_D

FIELD_VAL_D
Alarms

Mode
DISC

Figure C-1. DI Function Block Schematic

C.5.1.1 Mode
The DI block supports three settable modes:
♦ In Automatic mode, the OUT_D parameter reflects the process variable (PV_D) value
and status.
♦ In Manual mode, the OUT_D parameter is disconnected from the field and can be set
manually. The OUT_D status reflects the mode.
♦ In OOS (out of service) mode, the block values are not updated and the status of
OUT_D is set to BAD. In OOS, changes can be made to configured parameters.

473
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

C.5.1.2 Simulation
The SIMULATE parameter in the device function block allows the OUT_D parameter to be set
by an external source for testing. When SIMULATE is enabled, the actual measurement has no
affect in the OUT_D value and status. Simulation at the device block level also requires that you
set a simulation jumper on the device.
The I/A Series DI block supports simulation within the control processor. The option is set with
the SIMOPT parameter in the AI block, as described in Section C.6.6.

C.5.1.3 Conversion
When the Invert option is selected in IO_OPTS, the discrete input is logically inverted.

C.5.1.4 Filter
Filtering changes the response time of the device to smooth variations in the input readings
caused by rapid changes in the input value. The filtering time (PV_TIME) is applied to PV_D,
not to FIELD_VAL_D.

C.5.1.5 Alarms
In addition to the standard block alarms, the device DI function block sets an alarm when the
value of PV_D matches the value in DISC_LIM. The alarm condition is added to the OUT_D
status; however, no alarm is generated if the value in DISC_LIM is 255.
The I/A Series system does not use the alarm features provided by the device blocks, but rather
provides alarm handling options in the DI block. The DI block enables BAD alarming using stan-
dard I/A Series alarm parameters.

C.5.2 DI Parameter Transforms


Table C-11 shows the mapping of DI block parameters to parameters in the related device func-
tion block parameters. Many of the parameters are straightforward 1:1 mappings that are either
unidirectional or bidirectional. Other mappings require that a data value be re-formatted (or
transformed) to be intelligible in the I/A Series system. From the point of view of the DI block,
the relationship with the device function block can also be described in terms of sink and source
connections:
→ Source-sink The DI block parameter is the source for the matching device func-
tion block parameter. Thus, changes to the DI block parameter are
made to the device parameter. For example, when the DI block is
initialized, the TAGDSC value is copied to the device function block
TAG_DESC parameter.

474
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

← Sink-source The DI block parameter value is updated by the corresponding device


function block parameter. For example, the MODE_A parameter
reads the device parameter MODE_BLK.Actual to make the actual
device function block mode visible to the control system.
↔ Bidirectional Changes to the DI block parameter are made to the device corre-
sponding device function block parameter and vice versa. For exam-
ple, when a DI block is initialized, its STOPTS parameter value is
written to the device DI block parameter, STATUS_OPTS, to config-
ure how the function block processes block status information. Sub-
sequent changes to the status option made at the device are written
back to the DI block STOPTS parameter.

The arrow notation is used in Table C-11, which describes the parameter transforms for the DI
and the related device function block. These are presented in alphabetic order, arranged by the DI
block parameter names.
Table C-11. DI Block Parameter Transforms

DI Block Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SW = 1:
Set MODE_T (request) = AUTO
Set CAS_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP-FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.FBM CP-FBM communication is failed
BLKSTA.BIO OUT_D.Status.Bad (Bits 6-7=0)
CHANNL ↔ CHANNEL
IOOPTS ↔ IO_OPTS
MAN_SW MODE_BLK.Target
When MAN_SW = 1:
Set MODE_T (request) = MAN
Set CAS_SW=0, AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM

475
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

Table C-11. DI Block Parameter Transforms (Continued)

DI Block Parameter Device Function Block Parameter


MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permit
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW is set =1:
Set MODE_T (request) = OOS
Set CAS_SW=0, AUT_SW=0, MAN_SW=0
Write MODE_T (request) to FBM
OUTSTS OUT_D
OUTSTS.value ← OUT_D.Status
OUT_D OUT_D
OUT_D.value (request) → OUT_D.Value (in MAN mode only)
OUT_D.value (actual) ← OUT_D.Value
OUT_D.status.LHI ← OUT_D.Status.Limited Hi (Bit 0)
OUT_D.status.LLO ← OUT_D.Status.Limited Lo (Bit 1)
OUT_D.status.ERR ← OUT_D.Status.Uncertain (Bits 6-7=1)
OUT_D.status.BAD ← OUT_D.Status.Bad (Bits 6-7=0) or
CP-FBM communication failure
OUT_D.status.OOS ← OUT_D.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0

476
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table C-11. DI Block Parameter Transforms (Continued)

DI Block Parameter Device Function Block Parameter


OUT_ST ↔ OUT_STATE
PVFTIM ↔ PV_FTIME
PVSTS PV_D
PVSTS.value ← PV_D.Status
PV_D PV_D
PV_D.value ← PV_D.Value
PV_D.status.LHI ← PV_D.Status.Limited Hi (Bit 0)
PV_D.status.LLO ← PV_D.Status.Limited Lo (Bit 1)
PV_D.status.ERR ← PV_D.Status.Uncertain (Bits 6-7=1)
PV_D.status.BAD ← PV_D.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
PV_D.status.OOS ← PV_D.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5=
7), or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
STOPTS ↔ STATUS_OPTS
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC → TAG_DESC

C.6 DI Block Operation


The DI block establishes a publisher/subscriber connection with the device function block of the
specified H1 device, and makes the function block’s calculated value (OUT_D) available to the
control blocks in the I/A Series system.
The I/A Series DI block provides the interface between the CP-resident control blocks and the
device discrete input function block.
The DI block’s OUT_D and OUTSTS parameters hold the value and status of the device func-
tion block OUT_D parameter, while the PV_D and PVSTS parameters reflect the value and sta-
tus of the device function block’s primary value.
The DI block enables setting of the Invert option through configuration of the IOOPTS parame-
ter in the DI block. The block also supports the function block’s alarm features and mode param-
eters.
The DI block and the device function block operate in two asynchronous cycles, both writing to
and reading from shared space in the FBM memory. The DI block executes in the Basic Process-
ing Cycle (BPC) of the control station according to its compound, and its PERIOD and PHASE
parameters, which are described in Integrated Control Software Concepts (B0700AG). The device
function block executes once each FBM macrocycle as scheduled by the Link Active Schedule in
the FBM228.

477
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

The principal task of the DI block is to read a discrete value and status from the device. For this
task, the FBM228 establishes a publisher/subscriber connection between the DI block OUT_D
parameter and device function block OUT_D parameter.
All other parameter connections are made by the FBM on a client/server basis at the
frequency specified in the DI block UPDPER parameter. This parameter can be set from 0
to 2147483647 milliseconds; the default is 10000 (10 seconds); however, increasing the
frequency of client/server communication significantly adds to the load on the H1 segment.

C.6.1 Device Function Block Connection


The configured parameter IOM_ID of the DI block specifies an ECB201 (the device ECB) that
represents the target H1 device. The ECB201 PARENT parameter identifies the ECB200 or
ECB202 for the FBM228. The path to the device block is completed in one of two different
ways, depending on which configuration editor is used:
♦ When the DI block is configured in IACC, the DI block is connected to the device
block whose tag matches the NAME parameter of the DI block. If there is no match-
ing device block tag, the DI block binds to the first un-initialized analog input device
block and re-tags the device block accordingly.
♦ When the DI block is configured using IEE, the device function block is selected in a
browser which displays the device function blocks based on the device description in
the device ECB. If the connection is not configured in the browser. If the connection
is not made via the browser, the connection is made based on the DI block NAME
parameter.

C.6.2 Device Configuration Parameters


The DI block enables you to set the standard configurable parameters in the corresponding device
function block using an I/A Series control configuration editor (either IACC or the IEE Block
Configurator) and manage the device configuration in the control database. When the DI block is
deployed to the control station, and the FBM228 is downloaded, parameter values in the DI
block update parameters in the linked device function block.
The deployment of the DI block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Schedule execution of the device function block
♦ Add a compel data (CD) message to each macrocycle to acquire the OUT_D parame-
ter value and status published by the block
♦ Schedule client/server connections between the DI block and the device function
block for view updates.
Table C-12 lists the device function block parameters and the DI block parameters used to config-
ure them. For the DI block, the table includes both the six-character (maximum) parameter name
that is used in block detail displays and the parameter labels used in the IACC editors, which
more closely resemble the FOUNDATION fieldbus parameter names. Use the six-character parame-
ter name when connecting parameters to a process display.

478
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table C-12. DI Block Configuration Parameters

Configured with DI Block Parameter


Device Function Block
Parameter Name in Process Displays IACC Parameter Label
CHANNEL CHANNL Channel
IO_OPTS IOOPTS Io_opts
L_TYPE L_TYPE L_type
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
OUT_STATE OUT_ST OUT_state
PV_FTIME PVFTIM PV_ftim
STATUS_OPTS STOPTS StatusOpt
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc
XD_STATE XD_ST XD_state

C.6.3 Block Status


The device function block OUT_D and PV_D parameters have both a value and a status. The sta-
tus is contained in a 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits. The status is
read into the DI block parameter, bit for bit. The default displays for the DI block shows the con-
verted status parameter so that the value need not be decoded. Table C-13 shows how the status
byte is formatted.
Table C-13. DI Block Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 SubStatus depends on .Quality, as shown in Table C-13
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (Non-cascade)
3 = Good (Cascade)

Table C-13 shows how the Substatus bits are used given the bits set for .Quality.

Table C-14. DI Block Substatus

Bits 2-5 = Substatus and Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.

479
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

Table C-14. DI Block Substatus (Continued)

Bits 2-5 = Substatus and Description


1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced in by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.
4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.

480
Appendix C. Legacy DI – Foundation™ fieldbus Discrete Input B0700EC – Rev B

Table C-14. DI Block Substatus (Continued)

Bits 2-5 = Substatus and Description


When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

C.6.4 Mode Machine


The DI block mode and switch parameters support the FOUNDATION fieldbus state machine
schema, which is functionally equivalent to a single rotary switch that can be set to one of the per-
mitted states such as OOS, MAN, and AUTO.
The possible states are enumerated in the device function block MODE.Permitted parameter,
while the MODE.Target and MODE.Normal parameters specify the target and normal states,
respectively.
To transition the device to a different state, a request is written to the MODE.Target parameter.
Depending on device/block operation, it is possible for the actual mode of the function block to
differ from the desired Target. The actual mode can be read from the device function block
MODE_BLK.Actual.
The DI block support the device function block mode parameters with the configurable
MODE_T, MODE_P, and MODE_N parameters and the output parameter MODE_A.
To change the mode of the device function block from the I/A Series system, a mode request is
issued with the value of MODE_T via a switch parameter and written to MODE_BLK.Target.
The target value written to the device is rung back to be reflected in the MODE_T parameter.
In the DI block, MODE_T, and thus the function block MODE.Target, is set by one of three set-
table boolean parameters:

481
B0700EC – Rev B Appendix C. Legacy DI – Foundation™ fieldbus Discrete

♦ AUT_SW changes target mode to Auto in which the OUT_D parameter reflects the
block’s computed value (PV_D).
♦ MAN_SW changes to target mode to Manual so the OUT_D can be set.
♦ OOS_SW changes to target mode to Out of Service so that configurable device block
parameters can be modified.
Refer to Table C-11 for a description of the switch parameter actions and mapping of the DI
block mode parameters to their device block equivalents.

C.6.5 Alarms
The DI block uses standard I/A Series alarm detection and reporting features, rather than the
alarm features of the device function block, to report to the control system when the OUT_D
value is bad or the value matches a user-defined discrete value (discrete limit). Alarming is config-
ured using the parameters show in Table C-15.

Table C-15. DI Block Alarm Parameters

Alarm Type Option Limits Priority Group Text


BAD BADOPT=1 -- BADPRI BADGRP BADTXT
Discrete Limit DSCOPT=1 DSCLIM DSCPRI DSCGRP DSCTXT

Refer to Integrated Control Software Concepts (B0700AG) for information on alarm functionality.

C.6.6 Simulation
Simulation of a control loop involving a discrete input from an H1 device can be performed using
the SIMULATE parameters in the device function blocks as described Section C.5.1.2, or the
simulation can be performed entirely within the control station by using the DI block simulation
option and the equivalent functionality in the output blocks.
When SIMOPT= 1 (True), the status and value of OUT_D are not recovered from the field, but
are computed by the control station based on the simulated value derived from the IN parameter.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus (B0750BC) or
Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for instructions on con-
ducting control simulations from the H1 devices or using DI and other blocks in the control
station.

482
Appendix D. Legacy DO –
FOUNDATION™ fieldbus Discrete
Output
This appendix describes the legacy I/A Series Discrete Output (DO) block, shipped with
I/A Series systems with v8.4.3 or earlier software, used with an FBM228 with SWTYPE=228.
The DO block interfaces the control system with a corresponding Discrete Output function
block operating in a FOUNDATION™ fieldbus H1 device.

D.1 Overview
Discrete Output (DO) is a Distributed Control Interface (DCI) block that provides an inter-
face between the control processor and a discrete output function block operating in a
FOUNDATION fieldbus H1 device (the device function block). The DO block is supported on
the FCP270 and ZCP270 when the H1 device is connected to the control station by an
FBM228 (with SWTYPE=228). The DO block is configured using the Block Configurator in
the InFusion Engineering Environment (IEE) as described in InFusion Enterprise Control Sys-
tem: Implementing FOUNDATION fieldbus (B0750BC) or with the I/A Series Configuration
Component (IACC) software as described in Implementing FOUNDATION fieldbus on the I/A
Series System (B0700BA).

D.2 Basic Operation


The DO block integrates the linked device function block into the I/A Series system. On initial-
ization, user-configured values in the DO block are written to the standard configurable parame-
ters in the device function block. During normal operation, the DO block maintains a
publisher/subscriber connections with the device function block to write a value to the device
block CAS_IN parameter and to read the value and status of the device block BKCAL_OUT
parameter. In addition, the DO block provides access to a variety of operational and diagnostic
information via client/server connections with the parameters that are included in Views 1, 2, and
4 of the device block. The values read from these parameters are displayed in the block detail dis-
plays and are available for connection to other I/A Series blocks.

D.3 Features
The DO block provides the following features:
♦ Outputs a setpoint value the linked discrete output device function block, and
acquires the block’s primary output value and status for read-back to the control
system
♦ Time stamps value and status changes
♦ Accesses the parameters in the device function block’s View 1, View 2 and View 4
using change-driven and periodic client/server connections

483
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

♦ Ensures that changes in the device function block’s process values and error conditions
are continuously available for display and connection to the control strategy
♦ Supports the device block Fault State handling
♦ Provides for configuration of device block parameters from the I/A Series system and
management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Automatic, Cascade,
Manual or Out of Service
♦ Provides alarm reporting for Bad I/O
♦ Supports simulation of device block output within the control station

D.4 Block Parameters


Table D-1 lists the block parameters. See Table D-10 for mappings between DO block
parameters and their device function block equivalents.

Table D-1. DO Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set DO
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 13
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0, 1
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path, up
to 12 chars
CHANNL channel integer no-con/no-set 1
DDITEM DD item long no-con/no-set 0x80020230
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000
STRATG strategy integer no-con/no-set
STOPTS status options packed bool- no-con/no-set 0x800
ean
IOOPTS I/O options packed bool- no-con/no-set 0x1340
ean
SHEDOP mode shed option short no-con/set 0x01
PV_ST PV state integer no-con/set 0 0 to 32767
XD_ST XD state integer no-con/set 0 0 to 32767
MODE_N normal mode integer no-con/set 0x20
MODE_P permitted mode integer no-con/set 0x39
MODE_T target mode integer no-con/set 0x20
CASIND cascade input real con/set 0
SP_D discrete setpoint short con/set (settable when mode is auto
PRIBLK primary block boolean no-con/no-set 0
PRITIM primary cascade timer real no-con/no-set 0.0

484
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table D-1. DO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


FSOPTN faultstate option integer no-con/no-set 0
FSTIME faultstate time real no-con/no-set 20.0 sec
FSVALD faultstate value integer no-con/no-set 1
INHOPT inhibit option short no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short con/no-set 8 1 to 8
BADOPT bad alarm option short no-con/no-set 0 0 to 3
BADGRP bad alarm group integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 1 to 32 chars
OUTDSC output descriptor string con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration integer no-con/set 0 0 to 32767
interval
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set
AUT_SW auto switch boolean con/no-set 0 0 to 1
BCALCO back calc output integer con/no-set
BCOSTS back calc status packed bool- con/no-set
ean
BLKERR block error packed bool- con/no-set blank
ean
BLKSTA block status packed long con/no-set 0 0-0xFFFFFFFF

485
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

Table D-1. DO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


CAS_SW cascade switch boolean con/set
CASSTS cascade input status packed bool- con/no-set
ean
CRIT criticality integer con/no-set 0 0 to 5
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode integer con/no-set
OOS_SW out of service switch boolean con/set 0 0 to 1
OUTSTS output status packed bool- con/no-set
ean
OUT_D discrete output integer con/set
PRTYPE priority type integer con/no-set 0 0, 1, 2, 3, 4, 8, 25
PVSTS process variable status packed bool- con/no-set
ean
PV_D discrete process integer con/no-set
variable
RBKSTS readback status packed bool- con/no-set
ean
RBK_D discrete readback integer con/no-set
SETFS set faultstate boolean con/set
SPTST setpoint status packed bool- con/no-set
ean
TSTAMP time stamp long integer con/no-set 0 ms after midnight
UNACK unacknowledged boolean con/set 0 0 to 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
CFGERR configuration error short no-con/no-set
DEFINE no config errors boolean no-con/no-set 1 ---
DESCRP descriptor string no-con/no-set blank 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 8 to 13 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
ST_REV status revision integer no-con/no-set 2 blanks

D.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT Alarm Options contain packed long values representing the alarm types
that have been configured as options in the block, and the alarm groups
that are in use. Table D-3 shows how the parameter is used by the DO
block.

486
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table D-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table D-3 shows the bits used by the DO.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9

CRIT PRTYPE
BAD
INH

Table D-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the DO
blocks
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
22 BAD Bad I/O Alarm ALMSTA.B10
29 INH Inhibit Alarm. This bit is set when ALMSTA.B3
any of the block’s alarms is inhibited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is

487
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

rounded up to the closest value that is an even multiple of the station


BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and thus MODE_BLK.Target in the associated device function
block, to Auto.

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the DO block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the DO
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BCALCO Back Calculated Output is set equal to the confirmed component of


BKCAL_OUT_D in the associated device function block while cascade is
initializing. Since its purpose is to provide the upstream block with a back-
calculated value, connect BCALCO to the BCALCI parameter of the
upstream block.

BCOSTS Back Calculated Output Status is a non-settable, packed Boolean output


that contains the BKCAL_OUT_D.Status of the associated device func-
tion block. See Section D.6.4 for information on .Status.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block.
Table D-4 shows the parameter format.

488
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table D-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table D-5 shows how the bits are used by the
DO blocks.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B24
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

HOLD
UDEF

FBM

TRK
LCK

BIO
ON

MA

LO
LR
FS

Table D-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local BLKSTA.B29
Override
6 TRK Block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual mode
7 HOLD CAS_IN_D value is BAD BLKSTA.B25

489
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

Table D-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
10 LR Device block mode is Cascade. BLKSTA.B24
(0 indicates the device block mode is
either Auto or Manual.)
11 MA The device block mode is Auto. BLKSTA.B21
12 BIO Bad I/O BLKSTA.B20
14 UDEF Block is undefined. There is a configura- BLKSTA.B18
tion error
15 ON The compound that contains the block BLKSTA.B17
is ON
19 FBM228 The H1 device is hosted and scheduled BLKSTA.B13
by an FBM228
20 LCK A workstation has locked this block. BLKSTA.B12
24 FS Fault State has been asserted in the BLKSTA.B8
device function block
*Bit 0 is the least significant, low order bit.

CASIND Cascade Input Discrete is a configurable real input used to specify the
CAS_IN_D parameter of the associated device function block. It is setta-
ble only if Cascade mode is unlinked.

CAS_SW Cascade Switch is a settable output used to set the MODE_T parameter,
and thus MODE_BLK.Target in the associated device function block, to
Cascade.

CASSTS Cascade Input Status is a non-settable, packed Boolean output that con-
tains the CAS_IN_D.Status of the associated device function block. See
Section D.6.4 for information on .Status.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the DO block becomes undefined due to
a “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.
See FF-890-1.4 for further details.

490
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See ERRCODE for a list of all possible validation errors in this
block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string of up to


32 characters used to specify a description for the DO block.
♦ 0 disables Discrete Alarming (default)
♦ 1 enables Discrete Alarming.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table D-6 lists the possible error codes for a DO block.

Table D-6. Error Code Values

ERCODE Value
W43 INVALID PERIOD/PHASE COMBINATION
W54 ECB DOES NOT EXIST
W62 UNRESOLVED CONNECTION
W65 INVALID POINT ADDRESS
W66 DUPLICATE CONNECTION
W67 INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 INVALID DEVICE CONNECTION
W69 INVALID POINT CONNECTION
W73 FF FUNCTION BLOCK CONFIGURATION ERROR
W74 FF FUNCTION BLOCK DDITEM MISMATCH
W75 FF FUNCTION BLOCK DDMBR MISMATCH
W76 INVALID FF MODE CONFIGURATION
W77 FIELDBUS COMMUNICATION FAULT

491
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

Table D-6. Error Code Values

ERCODE Value
W78 INVALID FUNCTION BLOCK
W79 INVALID PARAMETER INDEX
W80 FIELDBUS DEVICE NOT FOUND

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in a DO block. The range is 1 (default) to 8.

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. The parameter has the same format as
BLKERR (Table D-4).

FSOPTN Fault State Option is a configurable integer parameter that specifies the
Fault State conditions and action to be taken by the FBM and the con-
nected H1 device for an output point in a DO block:
♦ Bit 0: 1 = Assert Fault State if there is an input or measurement
error.
Note that ERROPT must be configured nonzero for this
option to take effect.
♦ Bit 1: 1 = Set/Clear Fault State when SETFS input is set/cleared.
♦ Bit 2: 1 = Assert Fault State if control station-to-FBM communi-
cation is lost (FBM option). This option is enabled only if
Fault State is enabled at the FBM level via the FSENAB
parameter in the ECB200 or ECB202.

Bit 0 is the least significant, low order bit. FSOPTN is dependent upon
how the Fault State parameters are configured in the device with which
the DO block is being used. The Fault State can also be turned off in the
device, which renders FSOPTN ineffective. See Section D.6.5.

FSTIME Fault State Time is a configurable, downloadable, real value used to specify
the FSTATE_TIME parameter of a device function block. See
Section D.6.5.

FSVALD Fault State Value is a configurable, downloadable, non-settable integer


value used to specify the FSTATE_VAL parameter of a device function
block. See Section D.6.5.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:

492
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

♦ 0 = When an alarm is inhibited, disables alarm messages but does


not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table D-7 shows
how parameter is used with the DO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
BAD B10
B11
B12
B13
B14
HMA B15
LMA B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
DSC B6
B7
B8
B9

Table D-7. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
16 LMA Low Absolute Alarm Inhibited INHSTA.B16
17 HMA High Absolute Alarm Inhibited INHSTA.B15
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
26 DSC Discrete Alarm Inhibited INHSTA.B6
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated

493
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

blocks are located. The pathname must be of the form


<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB.

IOOPTS I/O Options is a configurable, downloadable, non-settable, packed


Boolean used to specify the IO_OPTS parameter of the associated device
function block. Table D-8 shows how the bits are used by the DO block.
Table D-8. IOOPTS Parameter Format

Bit Boolean
Number* Description, When True Connection
15 Invert IO_OPTS.B17
14 SP-PV Track in Man IO_OPTS.B18
12 SP-PV Track in LO IO_OPTS.B19
11 SP Track retained target IO_OPTS.B21
9 Fault State to Value IO_OPTS.B23
8 Fault State on Restart IO_OPTS.B24
7 Target to MAN on FS IO_OPTS.B25
6 Use PV for BKCAL_OUT IO_OPTS.B26
*Bit 0 is the least significant, low order bit.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the Display Manager task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block, immediately
below the faceplate.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and thus MODE_BLK.Target in the associated device function block, to
Manual.

494
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

MODE_A Actual mode is a non-configurable, non-settable, packed Boolean output


that contains the MODE_BLK.Actual parameter of the associated device
function block.

MODE_N Normal mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Normal parameter of the
associated device function block.

MODE_P Permitted mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Target parameter of the
associated device function block.
Note that AUT_SW, MAN_SW, CAS_SW, and OOS_SW can be used to
change the MODE_T parameter and thus the MODE_BLK.Target
parameter in the device function block.

NAME Name is a user-defined string of up to 12 characters for accessing the


block and its parameters, and identifying the matching device function
block in the device. When the I/A Series block is initialized, the block
updates the configurable parameters of the function block whose Function
Block Tag matches the NAME parameter. If there is no matching Func-
tion Block Tag, the block renames the first available block of the function
block and updates the other configurable parameters.

OOS_SW Out of Service Switch is a settable output used to set the MODE_T
parameter, and thus MODE_BLK.Target in the associated device function
block, to Out of Service.

OUT_D Discrete Output is a short integer output that contains the OUT_D
parameter of the associated device function block. It is settable only in
Manual mode.

OUTDSC Output Descriptor is a configurable, non-settable ASCII string of up to


32 characters used as descriptive information in block alarm messages.

OUTSTS Output Status is a non-settable, packed Boolean output that contains the
OUT_D.Status parameter in the associated device function block.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

495
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. For instance, assuming that
the BPC of the I/A Series station is 0.5 second, a block with a PERIOD of
3 (2.0 seconds) can execute within the first, second, third, or fourth BPC
of the 2-second time period. See Integrated Control Software Concepts
(B0193AW).

PRIBLK Primary Block indicates whether the DO block has a connection from an
upstream block (PRIBLK = 1) or not (PRIBLK = 0). Its value and the
value of PRITIM determine whether the block remains in holding until
the upstream block returns an acknowledgement, remains in holding for a
fixed time delay, or ends the hold after one cycle.

PRITIM Primary Cascade Timer is a configurable parameter used to delay the clos-
ing of the cascade to a primary block when the output is initialized in the
DO block. It is used only if the PRIBLK option is set. If PRITIM = 0 and
PRIBLK is used, the cascade remains open indefinitely until acknowl-
edged by the primary block.

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the DO block:
0 = No alarm
8 = Bad I/O alarm
9 = Discrete state alarm.

PV_D Discrete Process Variable is a non-settable short integer output that con-
tains the PV_D parameter of the associated device function block.

PV_ST Primary Value States is a configurable parameter used to set the


PV_STATE parameter in the device function block. The PV_STATE
parameter provides indexed text for the states of the PV_D value reported
in PV_D.Status in the device block and PVSTS parameter in the DO
block.

496
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

PVSTS Process Variable Status is a non-settable, packed Boolean output that con-
tains the PV.Status of the associated device function block.

RBK_D Discrete Readback is a non-settable short integer output that contains the
READBACK_D parameter of the associated device function block.

RBKSTS Readback Status is a non-settable, packed Boolean output that contains


the READBACK.Status of the associated device function block. See
FF-891-1.4 for further details.

SETFS Set Fault State Request is a Boolean parameter that requests Fault State
action to be reset by the FBM or field device for the specific output value
of the block. The settings are:
♦ 1 = set Fault State request
♦ 0 = reset Fault State request.

SHEDOP Mode Shed Options is a configurable, downloadable, short integer that is


used to specify the SHED_OPT parameter of the associated device func-
tion block.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


DO block is to be simulated. When SIMOPT= 1 (True), there is no DCI
connection established for the block, and the status and value of
BCALCO are not recovered from the field, but are computed by the con-
trol station based on the simulated value change. The simulated behavior
of the block reflects the operational mode of the block (MODE_A).

SP_D Discrete Set Point is a configurable, short integer output that is used to
specify the SP_D parameter of the associated device function block. It is
settable only in Auto mode.

SPSTS Set Point Status is a non-settable, packed Boolean output that contains the
SP._DStatus of the associated device function block.

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block.

STOPTS Status Options is a configurable, downloadable, non-settable, packed


Boolean that is used to specify the STATUS_OPTS parameter of the
associated device function block. The block use only bit 4 (0 is the least
significant, low order bit) as shown in Table D-9.

Table D-9. STATUS_OPTS Parameter Format

Bit Number* Option Set with Bit


4 Propagate Fault Backward
* Bit 0 is the least significant, low order bit.

497
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device func-
tion block.

TSTAMP Time Stamp, which is expressed in units of milliseconds past midnight, is


updated every time there is a change in the value of the BCALCO param-
eter. The time is from the FBM228 when a new output is sent to device
function block. However, when the block is in simulation (SIMOPT = 1),
the value is computed by the CP.

TYPE Type is the block type. When a DO block is added to the control data-
base, IACC enters a numeric value of 120 to specify the DO block type.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the Current Alarms display.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 to scan the device function
block parameter. The range is 0 to 2147483647 milliseconds; the default
is 10000.

XD_ST XD State is a configurable, non-settable integer that is used to specify the


XD_STATE parameter of the associated device function block. The range
is 0 to 32767.

D.5 Device Function Block Description


This section describes the FOUNDATION fieldbus discrete output device function block, and
includes a block schematic, a brief description of the block’s standard parameter set, and a table
showing the mapping between the I/A Series DO block parameters and the device function block
parameters. Refer to FF-891, Function Block Application Process - Part 2 (FF-891-4.10) for detailed
description of the block.

D.5.1 Device Block Operation


The discrete output device function block processes a setpoint input from another block or an
external source and outputs the value to a field device at the OUT_D parameter (Figure D-1).
The value is output to the hardware specified in the device block CHANNEL parameter.

498
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

BKCAL_OUT_D
RCAS_OUT_D

Setpoint Out Output


Conversion
CAS_IN_D
OUT_D
RCAS_IN_D
INVERT

Simulation
SP_D PV
CHANNEL

SIMULATE_D
Mode PV Fault
Conversion State

SHED_OPT
FSTATE_TIME READBACK_D
INVERT FSTATE_VAL_D

Figure D-1. Discrete Output Device Function Block Schematic

D.5.1.1 Mode
The device function block supports the following modes:
♦ Man - Manual allows you to set the OUT_D parameter.
♦ Auto - In Automatic, the OUT_D parameter reflects the SP_D value.
♦ Cas - Cascade allows the OUT_D parameter to be set by an external source connected
to the CAS_IN_D parameter.
♦ OOS - When the mode is Out of Service, the block is not processed, the output
channel is maintained at the last value, and the status of OUT is set to BAD.
♦ IMan - Initialization Manual indicates that the path to the output hardware is closed.
The output remains at its last value.
♦ LO - Local Override is set when the resource block has been placed in LO or a fault
state is active. In LO, the output of the block does not respond to CAS_IN_D.

D.5.1.2 Setpoint
The source of the Setpoint depends on the block mode as described in Section D.5.1.1.

D.5.1.3 Out Conversion


If the Invert is set in the IO_OPTS parameter, the block performs a boolean NOT on SP_D
before copying the value to OUT_D.

D.5.1.4 Output
This value is passed to the device’s transducer block to provide the “setpoint” to the servo-position
circuit that actually manipulates the valve position.

499
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

D.5.1.5 Simulation
When the SIMULATE parameter in the device function block is set, the OUT_D parameter value
is not sent to the device, and the BKCAL_OUT can be set an external source such as a hand-held
H1 device for testing. Simulation at the device block level also requires that you set a simulation
jumper on the device.
Simulation of the control loop involving a discrete output to an H1 device can be accomplished
entirely within the control station and not involve communication with the H1 devices, as
described in Section D.6.7.

D.5.1.6 Fault State


The block has two Fault State options, which are set in the IO_OPTS parameter:
♦ Fault State on Restart sets the OUT_D parameter to a specified value when the device
is recycled because of a loss of power or some other reason. The value is specified in
FSATE_VAL_D.
♦ Fault State to Value sets the OUT_D parameter to a specified value if the block has not
received a value for output from its configured source within the time specified in
FSTATE_TIME. As with the restart option, the value is specified in FSATE_VAL_D.
In the case of both options, the device detects the condition and takes the faultstate action.

D.5.1.7 PV_D Conversion


If the device supports a readback value, it is used for READBACK_D, which in turn is used for
PV_D. If the Invert is set in the IO_OPTS parameter, the block performs a Boolean NOT on the
READBACK_D before it is copied to PV_D.

D.5.2 DO Parameter Transforms


Table D-10 shows the mapping of DO block parameters to the parameters in the related device
function block. Many of the parameters are straightforward 1:1 mappings that are either unidirec-
tional or bidirectional. Other mappings require that a data value be re-formatted (or transformed)
to be intelligible in the I/A Series system. From the point of view of the DO block, the relation-
ship with the device function block can also be described in terms of sink and source connections:
→ Source-sink The DO block parameter is the source for the matching device func-
tion block parameter. Thus, changes to the DO block parameter are
made to the device parameter. For example, when the DO block is
initialized, the TAGDSC value is copied to the device function block
TAG_DESC parameter.

500
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

← Sink-source The DO block parameter value is updated by the corresponding


device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual device function block mode visible to the control system.
↔ Bidirectional Changes to the DO block parameter are made to the device corre-
sponding device function block parameter and vice versa. For exam-
ple, when a DO block is initialized, its STOPTS parameter value is
written to the device DO block parameter, STATUS_OPTS, to con-
figure how the function block processes block status information.
Subsequent changes to the status option made at the device are writ-
ten back to the DO block STOPTS parameter.

The arrow notation is used in Table D-10, which describes the parameter transforms for the DO
and the related device function block. These are presented in alphabetic order, arranged by the
DO block parameter names.

Table D-10. DO Block Parameter Transforms

DO Block Parameter Device Discrete Output Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SW = 1:
Set MODE_T (request) = AUTO
Set CAS_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM

501
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

Table D-10. DO Block Parameter Transforms (Continued)

DO Block Parameter Device Discrete Output Block Parameter


BCALCO BKCAL_OUT_D, CAS_IN_D, MODE_BLK.Actual
BCALCO.value ← BKCAL_OUT_D.Value if initializing;
← CAS_IN_D.Value if not initializing
BCALCO.status.LHI ← BKCAL_OUT_D.Status.Limited Hi (Bit 0),
or MODE_BLK.Actual is not Cascade,
or BKCAL_OUT_D.Status.Bad (Bits 6-7=0),
or CP-FBM communication failure,
or the DCI connection record indicates
an Initialization Request (IR), Local Override (LO),
Open Loop (LHI and LLO), Not Invited (NI),
or Fault State Active (FSA) condition in the DO function block.
BCALCO.status.LLO ← BKCAL_OUT_D.Status.Limited Lo (Bit 1),
or MODE_BLK.Actual is not Cascade,
or BKCAL_OUT_D.Status.Bad (Bits 6-7=0),
or CP-FBM communication failure,
or the DCI connection record indicates an
Initialization Request (IR), Local Override (LO),
Open Loop (LHI and LLO), Not Invited (NI),
or Fault State Active (FSA) condition in the DO function block.
BCALCO.status.BAD ← BKCAL_OUT_D.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
BCALCO.status.OOS ← BKCAL_OUT_D.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
BCOSTS BKCAL_OUT_D
BCOSTS.value ← BKCAL_OUT_D.Status
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP-FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual, BKCAL_OUT_D
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.HLD ← CAS_IN source value is BAD
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← BKCAL_OUT_D.Status.Bad (Bits 6-7=0)
BLKSTA.FS ← BKCAL_OUT_D.Status.Good (Bits 6-7=0)
and Substatus.FSA (bits2-5= 7)
CASSTS CAS_IN_D
CASSTS.value ← CAS_IN_D.Status

502
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table D-10. DO Block Parameter Transforms (Continued)

DO Block Parameter Device Discrete Output Block Parameter


CASIND CAS_IN_D, BKCAL_OUT_D
CASIND.value (request) → CAS_IN_D.Value (in CAS mode only)
CASIND.value (actual) ← CAS_IN_D.Value
CASIND.status.LHI ← CAS_IN_D.Status.Limited Hi (Bit 0)
or CAS_IN source value is LHI
CASIND.status.LLO ← CAS_IN_D.Status.Limited Lo (Bit 1)
or CAS_IN source value is LLO
CASIND.status.ERR ← CAS_IN_D.Status.Uncertain (Bits 6-7=1)
or CAS_IN source value is ERR
CASIND.status.BAD ← CAS_IN_D.Status.Bad (Bits 6-7=0),
or CAS_IN source value is BAD,
or CP-FBM communication failure
CASIND.status.OOS ← CAS_IN_D.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or CAS_IN source value is OOS,
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
CAS_SW MODE_BLK.Target
When CAS_SW=1:
Set MODE_T (request) = CAS
Set AUT_SW=0, MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
CHANNL ↔ CHANNEL
FSTIME ↔ FSTATE_TIME
FSVALD ↔ FSTATE_VAL_D
IOOPTS ↔ IO_OPTS
MAN_SW MODE_BLK.Target
When MAN_SW = 1:
Set MODE_T (request) = MAN
Set CAS_SW=0, AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permit
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
NAME → Function Block Tag

503
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

Table D-10. DO Block Parameter Transforms (Continued)

DO Block Parameter Device Discrete Output Block Parameter


OOS_SW MODE_BLK.Target
When OOS_SW=1:
Set MODE_T (request) = OOS
Set CAS_SW=0, AUT_SW=0, MAN_SW=0
Write MODE_T (request) to FBM
OUTSTS OUT_D
OUTSTS.value ← OUT_D.Status
OUT_D OUT_D
OUT_D.value (request) → OUT_D.Value (in MAN mode only)
OUT_D.value (actual) ← OUT_D.Value
OUT_D.status.LHI ← OUT_D.Status.Limited Hi (Bit 0)
OUT_D.status.LLO ← OUT_D.Status.Limited Lo (Bit 1)
OUT_D.status.ERR ← OUT_D.Status.Uncertain (Bits 6-7=1)
OUT_D.status.BAD ← OUT_D.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
OUT_D.status.OOS ← OUT_D.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
PVSTS PV_D
PVSTS.value ← PV_D.Status
PV_D PV_D, BKCAL_OUT_D
PV_D.value ← PV_D.Value if IO_OPTS.Use PV for BKCAL_OUT (Bit 9)= 0
← BKCAL_OUT_D.Value if IO_OPTS.
Use PV for BKCAL_OUT (Bit 9)= 1
PV_D.status.LHI ← PV_D.Status.Limited Hi (Bit 0)
PV_D.status.LLO ← PV_D.Status.Limited Lo (Bit 1)
PV_D.status.ERR ← PV_D.Status.Uncertain (Bits 6-7=1)
PV_D.status.BAD ← PV_D.Status.Bad (Bits 6-7=0)
PV_D.status.OOS or CP-FBM communication failure
← PV_D.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
PV_ST ↔ PV_STATE
RBKSTS READBACK_D
RBKSTS.value ← READBACK_D.Status

504
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table D-10. DO Block Parameter Transforms (Continued)

DO Block Parameter Device Discrete Output Block Parameter


RBK_D READBACK_D
RBK_D.value ← READBACK_D.Value
RBK_D.status.LHI ← READBACK_D.Status.Limited Hi (Bit 0)
RBK_D.status.LLO ← READBACK_D.Status.Limited Lo (Bit 1)
RBK_D.status.ERR ← READBACK_D.Status.Uncertain (Bits 6-7=1)
RBK_D.status.BAD ← READBACK_D.Status.Bad (Bits 6-7=0) or
CP-FBM communication failure
RBK_D.status.OOS ← READBACK_D.Status.Bad (Bits 6-7=0)
and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
SHEDOP ↔ SHEDOP
SPSTS SP_D
SPSTS.value ← SP_D.Status
SP_D SP_D
SP_D.value (request) → SP_D.Value (in AUTO mode only)
SP_D.value (actual) ← SP_D.Value
SP_D.status.LHI ← SP_D.Status.Limited Hi (Bit 0)
SP_D.status.LLO ← SP_D.Status.Limited Lo (Bit 1)
SP_D.status.BAD ← SP_D.Status.Bad (Bits 6-7=0)
SP_D.status.OOS or CP-FBM communication failure
← SP_D.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5= 7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
STOPTS ↔ STATUS_OPTS
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC ← TAG_DESC
XD_ST ↔ XD_STATE

D.6 DO Block Functions


With each execution, the DO block receives a value from an I/A Series system control block and
writes the value to the device function block’s CAS_IN parameter. The DO block also reads the
value and status from the device function block’s BKCAL_OUT_D parameter.

505
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

The DO block does not condition the output to the device directly, as conditioning is handled by
the device function block, as specified in its IO_OPTS parameter. The DO block does, however,
enable you to configure the parameter via the IOOPTS parameter.

D.6.1 Device Function Block Connection


The configured parameter IOM_ID of the DO block specifies an ECB201 (the device ECB) that
represents the target H1 device. The ECB201 PARENT parameter identifies the ECB200 or
ECB202 for the FBM228. The path to the device block is completed in one of two ways, depend-
ing on which configuration editor is used:
♦ When the DO block is configured in IACC, the DO block is connected to the device
block whose tag matches the NAME parameter of the DO block. If there is no match-
ing device block tag, the DO block binds to the first un-initialized discrete input
device block and re-tags the device block accordingly.
♦ When the DO block is configured using IEE, the device function block is selected in
a browser which displays the device function blocks based on the device description in
the device ECB. If the connection is not configured in the browser. If the connection
is not made via the browser, the connection is made based on the DO block NAME
parameter.

D.6.2 Device Configuration Parameters


The DO block enable you to configure key parameters in the corresponding device function
block and manage the configuration from the I/A Series system. When you deploy the DO block
to the control station, and then download the FBM228, parameter values in the DO block
update parameters in the linked device function block.
The deployment of the DO block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Configure a Compel Data (CD) message for each macrocycle to write the DO block
CASIN parameter to the device function block CAS_IN_D parameter
♦ Schedule execution of the device function block
♦ Configure a CD message for each macrocycle to publish the device function block’s
BKCAL_OUT_D to be read by the DO block BCALCO parameter.
♦ Schedule client/server connections between the DO block and the device function
block for view updates.
Table D-11 lists the device function block parameters and the DO block parameters used to con-
figure them. For the DO block, the table includes both the six-character (maximum) parameter
name that is used in block detail displays and the IACC parameter labels, which more closely
resemble the FOUNDATION fieldbus parameter names. Use the six-character parameter name
when connecting parameters to a process display.

506
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table D-11. DO Block Configuration Parameters

Configured with DO Block Parameter


Device Function Block
Parameter Name in Process Displays Parameter Label in IACC
CHANNEL CHANNL Channel
FSTATE TIME FSTIME Fstate_Time
FSTATE VALUE FSVAL Fstate_Val
IO_OPTS IOOPTS Io_opts
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
PV_ST PV_ST PV_state
SHED_OPTS SHEDOP ShedOpt
SP_D SP_D Sp_d
STATUS_OPTS STOPTS StatusOpt
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc

The following are required DO parameter settings:


♦ Configure MODE_P to include at least Cascade, Auto and Out of Service. Other
modes are optional.
♦ Set MODE_T to Cascade and Auto.
♦ Configure IOOPTS to include:
♦ SP_PV Track in LO (required)
♦ FS to Value (recommended)
♦ Use FS on Restart (recommended).
♦ Use the STOPTS parameter to set the STATUS_OPTS to Propagate Fail Backward
(required).
♦ Configure SHEDOP to Normal shed, normal return.
♦ Set the Fault State option in the resource block’s FEATURE_SEL parameter.
The following IO_OPTS are not supported:
♦ Invert. Use extreme caution in setting this option.
♦ SP Track Retained Target
♦ Increase to Close. Use extreme caution in setting this option.
♦ Target to Man if FS Asserted
♦ Low Cutoff (This normally has no meaning in a DO block).

D.6.3 Mode Machine


The DO block mode and switch parameters support the FOUNDATION fieldbus state machine
schema, which is functionally equivalent to a single rotary switch that can be set to one of the per-
mitted states such as Auto, Cascade, Manual and Out of Service.

507
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

The possible states are enumerated in the device function block MODE.Permitted parameter,
while the MODE.Target and MODE.Normal parameters specify the target and normal states,
respectively.
To transition the device to a different state, a request is written to the MODE.Target parameter.
Depending on device/block operation, it is possible for the actual mode of the function block to
differ from the desired Target. The actual mode can be read from the device function block
MODE_BLK.Actual.
The DO block support the device function block mode parameters with the configurable
MODE_T, MODE_P, and MODE_N parameters and the output parameter MODE_A.
To change the mode of the device function block from the I/A Series system, a mode request is
issued with the value of MODE_T via a switch parameter and written to MODE_BLK.Target.
The target value written to the device is rung back to be reflected in the MODE_T parameter.
In the DO block, MODE_T, and thus the function block MODE.Target, is set by one of four set-
table boolean parameters:
♦ AUT_SW changes the target mode to Automatic so that device block OUT_D
parameter reflects the SP_D (setpoint) parameter
♦ CAS_SW changes the target mode to Cascade in which OUT_D is derived from the
CAS_IN_D parameter (which in turn is set by the DO block CASIND parameter).
♦ MAN_SW changes the target mode to Manual so that the device OUT parameter can
be set via the DO block OUT parameter.
♦ OOS_SW changes the target mode to Out of Service so that the configurable device
block parameters can be modified.
Refer to Table D-10 for a description of the switch parameter actions and mapping of the DO
block mode parameters to their device block equivalents.

D.6.4 Block Status


The device discrete output function block OUT_D and PV_D parameters have both a value and
a status. The status is contained in a 8-bit byte, which is parsed into .Quality, .SubStatus,
and .Limits. The status is read into the DO block parameter, bit for bit. The default displays for
the DO block shows the converted status parameter so that the value need not be decoded.
Table 10-11 shows how the status byte is formatted.

508
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

Table 10-11. DO Block Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 SubStatus depends on .Quality, as shown in Table D-12
6-7 Quality:
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

Table D-12 shows how the .SubStatus bits are used given the bits set in .Quality.

Table D-12. DO Block Substatus

Bits 2-5 = SubStatus and Description


When .Quality is Bad (Bits 6-7 = 0)
0 NonSpecific. There is no specific reason why the value is bad. Used for
propagation.
1 ConfigurationError. Set if the value is not useful because there is some other prob-
lem with the block, depending on what a specific manufacturer can detect.
2 NotConnected. Set if this input is not referenced in by a link object within the
resource.
3 DeviceFailure. Set if the source of the value is affected by a device failure.
4 SensorFailure. Set if the device can determine this condition. The Limits define
which direction has been exceeded.
5 NoComm_WithLastUsableValue. Set if this value had been set by communication,
which has now failed.
6 NoComm_WithNoUsableValue. Set if there has never been any communication
with this value since it was last changed.
7 OutOfService. The value is not reliable because the block is not being evaluated,
and may be under construction by a configurator. Set if the block mode is OOS.
When .Quality is Uncertain (Bits 6-7 = 1)
0 NonSpecific. There is no specific reason why the value is uncertain. Used for propa-
gation.
1 LastUsableValue. Whatever was writing this value has stopped doing so.
2 SubstituteValue. Set when the value is written when the block is not Out of Service.
3 InitialValue. Set when the value of an input parameter is written while the block is
Out of Service.

509
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

Table D-12. DO Block Substatus (Continued)

Bits 2-5 = SubStatus and Description


4 SensorConversionNotAccurate. Set if the value is at one of the sensor limits.
5 EngUnitRangeViolation. Set if the value lies outside of the range of values defined
for this parameter.
6 Subnormal. Set if a value derived from multiple values has less than the required
number of Good sources.
When .Quality is Good_NonCascade (Bits 6-7 = 2)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 ActiveBlockAlarm. Set if the value is good and the block has an active Block Alarm.
2 ActiveAdvisoryAlarm. Set if the value is good and the block has an active Alarm
with a priority less than 8.
3 ActiveCriticalAlarm. Set if the value is good and the block has an active Alarm with
a priority greater than or equal to 8.
4 UnacknowledgedBlockAlarm. Set if the value is good and the block has an unac-
knowledged Block Alarm
5 UnacknowledgedAdvisoryAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority less than 8.
6 UnacknowledgedCriticalAlarm. Set if the value is good and the block has an unac-
knowledged Alarm with a priority greater than or equal to 8.
When .Quality is Good_Cascade (Bits 6-7 = 3)
0 NonSpecific. There is no specific reason why the value is good. No error or special
condition is associated with this value.
1 InitializationAcknowledge. The value is an initialized value from a source (cascade
input, remote-cascade in, and remote-output in parameters).
2 InitializationRequest. The value is an initialization value for a source (back calcula-
tion input parameter), because the lower loop is broken or the mode is wrong.
3 NotInvited. The value is from a block which does not have a target mode that
would use this input. This covers all cases other than Fault State Active, Local Over-
ride, and Not Selected. The target mode can be the next permitted mode of higher
priority in the case of shedding a supervisory computer.
4 NotSelected. The value is from a Control Selector which has not selected the corre-
sponding input. This tells the upper block to limit in one direction, not to initialize.
5 This SubStatus is not used.
6 LocalOverride. The value is from a block that has been overridden by a local key
switch.
7 Fault State Active. The value is from a block that has Fault State active. The failure
of normal control must be propagated to a PID block for alarm and display pur-
poses. This also implies Not Invited.
8 Initiate Fault State. The value is from a block that wants its downstream output
block to go to Fault State.

510
Appendix D. Legacy DO – Foundation™ fieldbus Discrete Output B0700EC – Rev B

D.6.5 Fault State Handling


Failsafe parameters in the FBM228 equipment control block (either an ECB200 or an ECB202)
and the DO block provide support for the Fault State operation in the device function block,
which provides levels of fault protection for communication errors between various levels of the
hardware architecture. The fault protection provides options for placing an output device into a
Fault State condition, with the output being driven to a user-predetermined or last good value.
The FBM228 can be configured to force the attached devices to take their configured Fault State
actions when a communication error between the FBM and the control station persists for more
than a specified period. The ECB Fault State options are designed to assert Fault State at the
device level for a communication failure above the FBM. The assertion does not establish the
device Fault State behavior as that is determined by options in the output type device function
blocks. Different behaviors can be set for each device connected to the FBM.
The device Fault State options are designed primarily to deal with communication failures above
the device, while working in concert with ECB options. Enabling Fault State is effective under
two external conditions:
♦ When Fault State is asserted by the connected FBM
♦ When communications to the device are lost and the device DO block mode is CAS
or RCAS.
The actual Fault State behavior taken by the device function block is specified in the DO block
parameters listed in Table 10-12.

Table 10-12. Fault State Parameters in the DO Block

Parameter Description
FSOPTN Enables one or more faultstate operations in the DO block as follows:
♦ 0 Disable all options
♦ 1 Assert Fault State on an input or measurement error
♦ 2 Set or clear Fault State when SETFS is set or cleared
♦ 3 Assert Fault State if the FBM228 detects a failure in communica-
tions with the control station
♦ 7 Sets options 1, 2, and 3 (recommended setting)
IO_OPTS Configures IO_OPTS in the device function block to enable/disable two
Fault State options:
♦ Fault State on Restart: Selecting this option causes the device to go
to the value specified in FSTATE_VAL_D on a device RESTART. If
this option is not selected and the device block can go to its target
mode upon RESTART, the last saved setpoint (SP_D) is used for
generating the Fault State position.
♦ Fault State to Value: When this option is selected, the block uses
the value specified in FSTATE_VAL_D. When the option is not
selected, the last saved setpoint is used.
FSVALD Configures FSTATE_VAL_D in the device function block, specifying the
value that is asserted when one of the faultstate options is invoked.

511
B0700EC – Rev B Appendix D. Legacy DO – Foundation™ fieldbus Discrete

Table 10-12. Fault State Parameters in the DO Block (Continued)

Parameter Description
FSTIME Configures FSTATE_TIME in the device function block, setting the
period that the fault condition must last before the block asserts the spec-
ified value. A Fault State action does not occur until the FSTATE_TIME
interval has expired.

NOTE
An additional requirement for Fault State handling at the device level is that the
Fault State option must be selected in the device resource block, that is,
(0x4)FaultState must be selected in FEATURE_SEL.

D.6.6 Alarms
The DO block uses standard I/A Series alarm detection and reporting features, rather than the
alarm features of the device function block, to report to the control system when the OUT_D
value is bad. Alarming is enabled when the BADOPT parameter is set to 1. The alarm priority
and alarm group are specified in BADPRI and BADGRP, respectively. The alarm message is spec-
ified in BADTXT.
Refer to Integrated Control Software Concepts (B0700AG) for information on alarm functionality.

D.6.7 Simulation
Simulation of a control loop involving discrete output to an H1 device can be performed using
the SIMULATE parameters in the device function blocks as described Section D.5.1.5, or the
simulation can be performed entirely within the control station by using the DO simulation
option and the equivalent functionality in the input blocks.
When SIMOPT= 1 (True), CASIND is not written to CAD_IN_D in the device function block,
and the BCALCO value is not read from BKCAL_OUT_D in the device block. The CASIND
value is copied to BCALCO to simulate confirmed output from the device function block.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus (B0750BC) or
Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for instructions on run-
ning simulations from the actual devices or using DO and other control block to run the simu-
lations in the control station.

512
Appendix E. Legacy MAI –
FOUNDATION™ fieldbus Multiple
Analog Input
This appendix describes the legacy Multiple Analog Input (MAI) block, shipped with I/A Series
systems with v8.4.3 or earlier software, used with an FBM228 with SWTYPE=228. The MAI
block interfaces the control system with a corresponding multiple analog input function block
operating in a FOUNDATION™ fieldbus H1 device.

E.1 Overview
Multiple Analog Input (MAI) is a Distributed Control Interface (DCI) block that provides an
interface between the control processor and a multiple analog input function block operating in
a FOUNDATION fieldbus H1 device (the device function block). The MAI block is supported
on the FCP270 and ZCP270 when the H1 device is connected to the control station by an
FBM228 (with SWTYPE=228). The MAI block is configured using the Block Configurator in
the InFusion Engineering Environment (IEE) as described in InFusion Enterprise Control Sys-
tem: Implementing FOUNDATION fieldbus (B0750BC) or with the I/A Series Configuration
Component (IACC) software as described in Implementing FOUNDATION fieldbus on the I/A
Series System (B0700BA).

E.2 Basic Operation


The MAI block integrates the linked device function block into the I/A Series system. On initial-
ization, user-configured parameters in the MAI block are written to key configurable parameters
in the device function block. During normal operation, the MAI block’s OUTn (where n is 1
through 8) and OUTSTn parameters hold the value and status of the device OUT_n parameters.
When the block is not in simulation mode, the PVn parameters reflect the value and status of the
device OUT_n parameters. When the block is in simulation mode (SIMOPT = 1), PVn is settable
and is used to change the OUTn value.
In addition, the MAI block provides access to a variety of operational and diagnostic information
via client/server connections with the parameters that are included in Views 1, 2, and 4 of the
device block. The values read from these parameters are displayed in the block detail displays and
are available for connection to other I/A Series blocks.

E.3 Features
The MAI block provides the following features:
♦ Acquires the status and value of up to eight published outputs (OUT_1 through
OUT_8) from a multiple analog input device function block
♦ Time stamps value and status changes

513
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

♦ Accesses the parameters in the device function block’s View 1, View 2 and View 4
using change-driven and periodic client/server connections
♦ Ensures that changes in the device function block’s process values and error conditions
are continuously available for display and connection to the control strategy
♦ Provides for the configuration of selected device block parameters from the I/A Series
system and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Auto, Manual or Out of
Service
♦ Provides alarm reporting for Bad I/O for each device block output
♦ Supports simulation of device block output within the control station

E.4 Block Parameters


Table E-1 lists the block parameters. See Table E-11 for mappings between MAI parameters and
their device function block equivalents.

Table E-1. MAI Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 35 35 (MAI)
TAGDSC tag descriptor string no-con/no-set blank 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 9
PHASE block execution phase short integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0, 1
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path,
up to 12 chars
CHANNL channel integer no-con/no-set 1 0 to 32767
CHMASK channel mask packed bool- no-con/no-set blank 0x00 to 0xFF
ean
DDITEM DD item long no-con/no-set blank
DDMBR DD member long no-con/no-set 0x00
UPDPER update period long no-con/no-set 10000 0 to 2147483647
STRATG strategy integer no-con/no-set 0 to 65535
MODE_N normal mode integer no-con/no-set 0x10 0 to 0xFFFF
MODE_P permitted mode integer no-con/no-set 0x19 0 to 0xFFFF
MODE_T target mode integer con/no-set 0x10 0 to 0xFFFF
HSCO1 output high scale for display real no-con/no-set 100.0 >= LSCO1
LSCO1 output low scale for display real no-con/no-set 0 <= HSCO1
EO1 output eng units for display string no-con/no-set % 1 to 32 chars

514
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table E-1. MAI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DESCR1 OUT1 descriptor string no-con/no-set 2 blanks 1 to 32 chars
DESCR2 OUT2 descriptor
DESCR3 OUT3 descriptor
DESCR4 OUT4 descriptor
DESCR5 OUT5 descriptor
DESCR6 OUT6 descriptor
DESCR7 OUT7 descriptor
DESCR8 OUT8 descriptor
INHOPT inhibit option short no-con/no-set 0 0 to 3
INHIB alarm inhibit boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short con/no-set 8 1 to 8
BADOPT bad alarm option short no-con/no-set 0 0 to 1
BADGRP bad alarm group integer no-con/no-set 1 1 to 8
BADPRI bad alarm priority integer con/set 5 0 to 5
BADTXT bad alarm text string con/no-set blank 1 to 32 chars
AMRTIN alarm regeneration interval integer no-con/set 0 0 to 32767
Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set
AUT_SW auto switch boolean con/no-set 0 0 to 1
BLKERR block error packed bool- con/no-set blank 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0 to
0xFFFFFFFF
CRIT criticality integer con/no-set 1 1 to 5
INHSTA inhibit status packed long con/no-set 0 0 to
0xFFFFFFFF
MAN_SW manual switch boolean con/set 0 0 to 1
MODE_A actual mode integer con/no-set 0 to 0xFFFF
OOS_SW out of service switch boolean con/set 0 0 to 1
OUT1 OUT_1 real con/no-set 0.0
OUT2 OUT_2 (settable in
manual only)
OUT3 OUT_3
OUT4 OUT_4
OUT5 OUT_5
OUT6 OUT_6
OUT7 OUT_7
OUT8 OUT_8

515
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

Table E-1. MAI Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


OUTST1 OUT1 status packed bool- con/no-set 0 0 to 0xFFFF
OUTST2 OUT2 status ean settable when
SIMOPT = 1
OUTST3 OUT3 status
OUTST4 OUT4 status
OUTST5 OUT5 status
OUTST6 OUT6 status
OUTST7 OUT7 status
OUTST8 OUT8 status
PRTYPE priority type integer con/no-set 0 0, 1, 2
PV1 OUT_1 real con/no-set
PV2 OUT_2
PV3 OUT_3
PV4 OUT_4
PV5 OUT_5
PV6 OUT_6
PV7 OUT_7
PV8 OUT_8
TSTMP1 OUT1 time stamp long integer con/no-set 0 ms after mid-
TSTMP2 OUT2 time stamp night
TSTMP3 OUT3 time stamp
TSTMP4 OUT4 time stamp
TSTMP5 OUT5 time stamp
TSTMP6 OUT6 time stamp
TSTMP7 OUT7 time stamp
TSTMP8 OUT8 time stamp
UNACK unacknowledged boolean con/set 0 0 to 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to
0xFFFFFFFF
CFGERR configuration error short no-con/no-set
DEFINE no config errors boolean no-con/no-set 1 ---
DESCRP descriptor string no-con/no-set blank 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks 1 to 43 chars
LOCKID lock identifier string no-con/no-set 2 blanks 8 to 13 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
RO1 range output string no-con/no-set 100,0,100 1 to 32 chars
ST_REV status revision integer no-con/no-set 2 blanks 0 to 65535

E.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

516
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

ALMOPT Alarm Options contain packed long values representing the alarm options
that have been configured in the block and the alarm groups that are in
use. Table E-2 shows MAI usage of the parameter.

Table E-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
8 Channel 8
9 Channel 7
10 Channel 6
11 Channel 5
12 Channel 4
13 Channel 3
14 Channel 2
15 Channel 1
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

517
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table E-3 shows the bits used by the MAI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
B13
B14
B15
B16
1=BAD B17
2=BAD B18
3=BAD B19
4 =BAD B20
5=BAD B21
6=BAD B22
7=BAD B23
8=BAD B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
CRIT
UNAK

PRTYPE

BAD
INH

Table E-3. ALMSTA Parameter Format

Bit Boolean
Number Connection
(0 to 31)* Name Description (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ---
PRTYPE for values used in the MAI
block
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
8 Channel 8 Bad Alarm ALMSTA.B24
9 Channel 7 Bad Alarm ALMSTA.B23
10 Channel 6 Bad Alarm ALMSTA.B22
11 Channel 5 Bad Alarm ALMSTA.B21
12 Channel 4 Bad Alarm ALMSTA.B20
13 Channel 3 Bad Alarm ALMSTA.B19
14 Channel 2 Bad Alarm ALMSTA.B18
15 Channel 1 Bad Alarm ALMSTA.B19
22 BAD Bad I/O Alarm: at least one channel ALMSTA.B10
is not usable
29 INH Inhibit Alarm at least one channel is ALMSTA.B3
inhibited
30 UNAK Unacknowledged: There is at least ALMSTA.B2
one unacknowledged alarm
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set the MODE_T
parameter, and therefore MODE_BLK.Target in the associated device
function block, to Auto.

518
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm mes-
sages for this block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the MAI
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block.
Table E-4 shows the parameter format. A given device might not support
all bits in the status word.

Table E-4. BLKERR Parameter Format

Bit Error Code


15 Other (most significant bit)
14 Block Configuration Error
13 Link Configuration Error
12 Simulate Active
11 Local Override
10 Device Fault State Set
9 Device Needs Maintenance Soon
8 Input Failure
7 Output Failure
6 Memory Failure
5 Lost Static Data
4 Lost NV Data
3 Readback Check Failed
2 Device Needs Maintenance Now
1 Power-up
0 Out of Service (least significant, low order bit)

519
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table E-5 shows how the bits are used by the MAI
block. A given device might not support all bits in the bits described in the
table.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

UDEF

FBM

TRK
LCK

BIO
ON

MA

LO
FS

Table E-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local BLKSTA.B29
Override
6 TRK The block is being tracked as the device BLKSTA.B26
function block is in Local Override or
Initialization Manual mode
8 FBM There is a communication failure BLKSTA.B24
between CP and FBM
11 MA The block mode is Auto BLKSTA.B21
12 BIO Bad I/O: at least one channel is Bad BLKSTA.B20
14 UDEF The block is undefined BLKSTA.B18
15 ON The compound that contains the block BLKSTA.B17
is ON
19 FBM228 The H1 device is hosted and scheduled BLKSTA.B13
by an FBM228
20 LCK A workstation has locked this block BLKSTA.B12
* Bit 0 is the least significant, low order bit.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the MAI block becomes undefined due to
a “W73 - FF FUNCTION BLOCK CONFIGURATION ERROR”.
When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index shown in
Table E-6.

520
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table E-6. CFGERR Index

Value Device Function Block Parameter with Error


2 TAG_DESC
3 STRATEGY
5 MODE_BLK
7 CHANNEL

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.
CHANNEL specifies the I/O subsystem by its the transducer block chan-
nel. Refer to the device documentation to identify the correct channel and
any special rules concerning mapping of the device output to the OUT_n
parameters.

CHMASK Channel Mask is a configurable, non-settable packed boolean parameter


that specifies which parameters are to be processed by the MAI block.
CHMASK does not affect any device function block settings. Table E-7
shows the parameter format.

Table E-7. Channel Mask Parameter Format

Bit Number* Input to be Processed


(0 to 15) When Bit Is Set
0 OUT1
1 OUT2
2 OUT3
3 OUT4
4 OUT5
5 OUT6
6 OUT7
7 OUT8
8-15 Reserved
*Bit 0 is the least significant, low order bit.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

521
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 522 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string of up to


32 characters used to specify a description for the block. The parameter
tracks the TAGDSC parameter, and is updated when the TAGDSC is
modified.

DESCRn OUTn Descriptor (where n is 1 through 8) is a configurable, non-settable


(n is 1 through 8) string of up to 32 characters that describes OUTn parameter. If Bad
Alarming is configured (BADOPT= 1), the DESCRn string is included in
the Bad Alarming message for the OUTn parameter.

EO1 Engineering Units for Output 1 specifies the engineering units text for all
OUTn parameters in the MAI block. The value configured for this text
string should be consistent with the values used for HSCO1 and LSCO1.
In the MAI block, EO1, HSCO1 and LSCO1 are used for scaling the
outputs in detail displays and other I/A Series system uses. These parame-
ter do not configure units and scaling in the device function block. How-
ever, they should reflect the device scaling.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
Table E-8 lists the possible values of ERCODE for the MAI block

Table E-8. Error Code Values

ERCODE Value
W43 INVALID PERIOD/PHASE COMBINATION
W44 INVALID ENGINEERING RANGE
W54 ECB DOES NOT EXIST
W62 UNRESOLVED CONNECTION
W65 INVALID POINT ADDRESS
W66 DUPLICATE CONNECTION
W67 INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 INVALID DEVICE CONNECTION
W69 INVALID POINT CONNECTION
W73 FF FUNCTION BLOCK CONFIGURATION ERROR

522
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table E-8. Error Code Values (Continued)

ERCODE Value
W74 FF FUNCTION BLOCK DDITEM MISMATCH
W75 FF FUNCTION BLOCK DDMBR MISMATCH
W76 INVALID FF MODE CONFIGURATION
W77 FIELDBUS COMMUNICATION FAULT
W78 INVALID FUNCTION BLOCK
W79 INVALID PARAMETER INDEX
W80 FIELDBUS DEVICE NOT FOUND
W81 INVALID PARENT DCI ECB PERIOD/PHASE
W82 FF CONFIGURATION IN PROGRESS

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages in the MAI block. The range is 1 to 8 (default).

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (from the device
block BLOCK_ERR parameter) generate an alarm message. The parameter
has the same format as BLKERR (Table E-4).

HSCO1 Output High Scale specifies the high scale value for OUTn parameters in
the MAI block. The value configured for HSCO1 should be consistent
with the values used for EO1 and LSCO1. In the MAI block, EO1,
HSCO1 and LSCO1 are used for scaling the outputs in detail displays
and other I/A Series system uses. These parameter do not configure units
and scaling in the device function block. However, they should reflect the
device scaling.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm gener-
ation-inhibit requests for each type of alarm configured in the block.
Table E-9 shows how the bits are used by the MAI block.

Table E-9. INHALM Parameter Format

Bit Boolean
Number* Connection
(0 to 15) BAD Alarm Inhibited When True (B16 to B1)
8 Channel 1 INHALM.B8
9 Channel 2 INHALM.B7
10 Channel 3 INHALM.B6
11 Channel 4 INHALM.B5
12 Channel 5 INHALM.B4
13 Channel 6 INHALM.B3

523
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

Table E-9. INHALM Parameter Format

Bit Boolean
Number* Connection
(0 to 15) BAD Alarm Inhibited When True (B16 to B1)
14 Channel 7 INHALM.B2
15 Channel 8 INHALM.B1
*Bit 0 is the least significant, low order bit.
There are no mnemonic names for the individual bits of INHALM.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.

INHOPT Inhibit Option specifies the following actions applying to all block alarms:
♦ 0 = When an alarm is inhibited, disables alarm messages but does
not disable alarm detection.
♦ 1 = When an alarm is inhibited, disables both alarm messages and
alarm detection. If an alarm condition exists at the time the alarm
transitions into the inhibited state, the alarm indicator is cleared.
♦ 2 = Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.
♦ 3 = Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly setting
UNACK False.

INHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table E-10
shows how parameter is used with the MAI block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
CH8 B1
CH7 B2
CH6 B3
CH5 B4
CH4 B5
CH3 B6
CH2 B7
CH1 B8
B9

Table E-10. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) When True (B32 to B1)
24 Channel 1 alarms inhibited INHSTA.B8

524
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table E-10. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) When True (B32 to B1)
25 Channel 2 alarms inhibited INHSTA.B7
26 Channel 3 alarms inhibited INHSTA.B6
27 Channel 4 alarms inhibited INHSTA.B5
28 Channel 5 alarms inhibited INHSTA.B4
29 Channel 6 alarms inhibited INHSTA.B3
30 Channel 7 alarms inhibited INHSTA.B2
31 Channel 8 alarms inhibited INHSTA.B1
*Bit 0 is the least significant, low order bit.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the display task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

525
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.
LOOPID is displayed on the detail display of the block.

LSCO1 Output Low Scale specifies the low scale value for OUTn parameters in
the MAI block. The value configured for LSCO1 should be consistent
with the values used for EO1 and HSCO1. In the MAI block, EO1,
HSCO1 and LSCO1 are used for scaling the outputs in detail displays
and other I/A Series system uses. These parameter do not configure units
and scaling in the device function block. However, they should reflect the
device scaling.

MAN_SW Manual Switch is a settable output used to set the MODE_T parameter,
and therefore MODE_BLK.Target in the associated device function block,
to Manual.

MODE_A Actual Mode is a non-configurable, non-settable, short integer output that


contains the MODE_BLK.Actual parameter of the associated device func-
tion block.

MODE_N Normal Mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Normal parameter of the
associated device function block.

MODE_P Permitted Mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target Mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Target parameter of the
associated device function block.
Note that AUT_SW, MAN_SW, and OOS_SW can be used to change
the MODE_T parameter and thus the MODE_BLK.Target parameter in
the device function block.

NAME Name is a user-defined string of up to 12 characters for accessing the


block and its parameters, and identifying the matching device function
block in the device. When the I/A Series block is initialized, the block
updates the configurable parameters of the device function block whose
Function Block Tag matches the NAME parameter. If there is no match-
ing Function Block Tag, the block renames the first available block of the
function block and updates the other configurable parameters.

OOS_SW Out of Service Switch is a settable output used set the MODE_T parame-
ter, and therefore MODE_BLK.Target in the associated device function
block, to Out of Service.

OUTn OUTn (where n is 1 through 8) is a real output contains the OUT_n


(n is 1 through 8) parameter of the associated device function block. It is settable only in
Manual mode.

526
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

OUTSTn OUTn Status (where n is 1 through 8) is non-configurable, non-settable


(n is 1 through 8) packed boolean that contains the OUT_n.Status from the associated
device function block. Section E.6.3.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
* If the BPC is 0.2 second, this period is treated internally as
0.6 second, but the PERIOD parameter remains 1.

PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. For instance, assuming that
the BPC of the I/A Series station is 0.5 second, a block with a PERIOD of
3 (2.0 seconds) can execute within the first, second, third, or fourth BPC
of the 2-second time period. See Integrated Control Software Concepts
(B0700AG).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the MAI block:
0 = No alarm
8 = Bad I/O alarm.

PVn Process Variable n (where n is 1 through 8) is a real output that contains


(n is 1 through 8) the OUT_n parameter of the associated device function block (even when
the block mode is Manual). PVn is non-settable when the block is in nor-
mal operation (SIMOPT = 0). When the block is in simulation mode
(SIMOPT =1), PVn is settable.

RO1 Range Output 1 is a real array consisting of the two parameters: HSCO1
and LSCO1. The array members are configured by their individual
names; however, RO1 and its members can be accessed on an array basis
by user tasks and displays.

527
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

SIMOPT Simulation Option is a configurable parameter that specifies whether the


MAI block is to be simulated.
When SIMOPT= 1 (True), the status and value of OUTn are not recov-
ered from the field, but are computed by the control station based on the
simulated value change. When SIMOPT= 1 (True), PVn is settable. The
simulated values are limited by HSCO1 and LSCO1. If this limiting
action forces a clamping of the entered value, the status of OUTn is set to
Limited High or Limited Low, as appropriate.

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block. ST_REV is incre-
mented by one each time a configurable parameter in the device function
block is modified by an external source.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


is used to specify the TAG_DESC parameter of the associated device
function block. The TAGDSC string is also copied to the MAI block
parameter DESCRP, which describes the block in I/A Series displays.

TSTMPn Time Stamp n (where n is 1 through 8) is non-settable long integer that


(n is 1 through 8) represents the time of the last change to the OUTn parameter of the MAI
block. The time is in milliseconds past midnight. During normal opera-
tion, the time is from the FBM228; when the block is in simulation
(SIMOPT = 1), the value is computed by the CP.

TYPE Type is the block type. When an MAI block is added to the control data-
base, the configuration editor enters a numeric value of 35 to specify the
MAI block type.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the system management dis-
play.

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 client/server connections
that scan the device function block View 1, View 2, and View 4 parame-
ters. The range is 0 to 2147483647 milliseconds; the default is 10000.

E.5 Device Function Block Description


This section describes the FOUNDATION fieldbus multiple analog input device function block,
and includes a block schematic, a brief description of the block’s standard parameter set, and a

528
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

table showing the mapping between the I/A Series system MAI block parameters and the device
function block parameters. Refer to FF-893, Function Block Application Process - Part 4 (FF-893-
5.1) for a detailed description of the block.

E.5.1 Device Block Operation


The FOUNDATION fieldbus multiple analog input device function block processes up to eight
measurements from a field device and makes them available in the OUT_n (where n is 1 through
8) parameters (Figure E-1).
The CHANNEL parameter specifies the source of the transducer block output data unit that is
parsed by the block and mapped to the OUT_n parameters.

PV_n
(n = 1 to 8)
CHANNEL
Outputs
OUT_n
(n = 1 o 8)

Mode Alarms
BLOCK_ALM

Figure E-1. MAI Device Function Block Schematic

E.5.1.1 Mode
The device function block supports three selectable modes:
♦ In Automatic mode, the block’s output parameters (OUT_1 to OUT_8) reflect the
process variables’ (PV_1 to PV_8) values and status.
♦ In Manual, the OUT_n parameter can be set manually and the OUT_n.Status reflects
the mode.
♦ In OOS (out of service), the block values are not updated and the status of OUT_n is
set to BAD. In OOS, changes can be made to configured parameters.

E.5.1.2 Status
The device function block provides an eight-bit status for each output value, using the standard
function block value status, which is further parsed in to .Quality, .SubStatus, and .Limits bits.
The .SubStatus bits in this block are device-specific. Refer to the device manufacturer’s documen-
tation for use of the bits.

E.5.1.3 Alarms
The BLOCK_ALM parameter is used for all configuration, hardware connection, and system
problems in the block.

529
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

The I/A Series system does not use the alarm features provided by the device blocks, but rather
provides alarm handling and error reporting options in the I/A Series MAI block. The MAI block
enables BAD alarming using standard I/A Series alarm parameters (see Section E.6.5).

E.5.1.4 Non-standard Parameters


Device manufacturers offer a variety of device function block parameters not specified in FF-893,
Function Block Application Process - Part 4 (FF-893-5.1). These parameters are not supported by
the I/A Series MAI block, but can be configured using Field Device Manager.

E.5.1.5 Parameter Transforms


Table E-11 shows the mapping of MAI parameters to parameters in the related device function
block. Many of the parameters are straightforward 1:1 mappings that are either unidirectional or
bidirectional. Other mappings require that a data value be re-formatted (or transformed) to be
intelligible in the I/A Series system.
From the point of view of the MAI block, the relationship with the device function block can also
be described in terms of sink and source connections:
→ Source-sink The MAI block parameter is the source for the matching function
block parameter. Thus, changes to the MAI block parameter are
made to the device function block parameter. For example, when the
MAI block is initialized, the TAGDSC value is copied to the device
function block TAG_DESC parameter.
← Sink-source The MAI block parameter value is updated by the corresponding
device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual function block mode visible to the control system.
↔ Bidirectional Changes to the MAI block parameter are made to the device function
block parameter and vice versa. For example, when the MAI block is
initialized, its MODE_T parameter value is written to the device
block parameter, MODE_BLK.Target, to configure the block’s target
mode. Subsequently, the MODE_BLK.Target value is written back to
the MAI block MODE_T parameter.

The arrow notation is used in the Table E-11 descriptions of MAI parameter transforms. These
are presented in alphabetic order, arranged by the MAI block parameter names.

Table E-11. MAI Block Parameter Transforms

MAI Block Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target

When AUT_SW = 1:
Set MODE_T (request) = AUTO
MAN_SW=0, OOS_SW=0
Write MODE_T (request) to FBM

530
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table E-11. MAI Block Parameter Transforms (Continued)

MAI Block Parameter Device Function Block Parameter


BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP to FBM communication is failed or FBM is Off-Line
BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.MA=0 ← MODE_BLK.Actual.MAN
BLKSTA.MA=1 ← MODE_BLK.Actual.AUTO
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← OUT.Status.Bad (Bits 6-7=0)
CHANNL ↔ CHANNEL
HSCO1 ↔ OUT_SCALE.@100%
LSCO1 ↔ OUT_SCALE.@0%
MAN_SW MODE_BLK.Target
When MAN_SW =1:
Set MODE_T (request) = MAN
AUT_SW=0, OOS_SW=0
Write MODE_T (request) to FBM
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ↔ MODE_BLK.Normal
MODE_P ↔ MODE_BLK.Permit
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
NAME → Function Block Tag
OOS_SW MODE_BLK.Target
When OOS_SW =1:
Set MODE_T (request) = OOS
AUT_SW=0, MAN_SW=0
Write MODE_T (request) to FBM

531
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

Table E-11. MAI Block Parameter Transforms (Continued)

MAI Block Parameter Device Function Block Parameter


OUTn (n = 1 to 8) OUT_n (n = 1 to 8)
OUTn.value (request) ↔ OUT_n.Value (in MAN mode only)
OUTn.value (actual) ← OUT_n.Value
OUTn.status.LHI ← OUT_n.Status.Limited Hi (Bit 0),
OUTn.status.LLO ← OUT_n.Status.Limited Lo (Bit 1)
OUTn.status.ERR ← OUT_n.Status.Uncertain (Bits 6-7=1)
OUTn.status.BAD ← OUT_n.Status.Bad (Bits 6-7=0)
OUTn.status.OOS or CP-FBM communication failure
← OUT_n.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5=
7),
or Compound is Off,
or FBM228 is Off-Line or DCI Not Ready,
or H1 Device is Failed or Disabled,
or CP-FBM communication failure,
or DCI_COMM_DATA.connect_status <= 0
OUTSTn OUT_n
OUTSTn.value → OUT_n.Status
PVn (n = 1 to 8) OUT_n (n = 1 to 8) (when block is not simulating)

PVn.value ←OUT_n.Value
PVn.status.LHI ← OUT_n.Status.Limited Hi (Bit 0)
PVn.status.LLO ← OUT_n.Status.Limited Lo (Bit 1)
PVn.status.ERR ← OUT_n.Status.Uncertain (Bits 6-7=1)
PVn.status.BAD ← OUT_n.Status.Bad (Bits 6-7=0)
or CP-FBM communication failure
or H1 device is Failed or Disabled.
PVn.status.OOS ← OUT_n.Status.Bad (Bits 6-7=0) and Substatus.OOS (bits2-5=
7),
or Compound is Off
or FBM228 is Off-Line or DCI Not Ready
or H1 Device is Failed or Disabled
or CP-FBM communication failure
or DCI_COMM_DATA.connect_status <= 0
PVFTIM ↔ PV_FTIME
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC → TAG_DESC

E.6 MAI Block Functions


The I/A Series MAI block provides the interface between CP-resident control blocks and the
device function block in the H1 device.
The MAI block OUTn (where n is 1 through 8) and OUTSTn parameters hold value and status,
respectively, of the device function block OUT_n parameter.

532
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

The device function block provides the outputs in engineering units determined by the device and
connected devices. The I/A Series MAI block does not configure scaling in the device. Instead, the
scaling parameters in the MAI block (HSCO1, LSCO1 and EO1) specify the range and unit of
measure label for OUT_n parameters as used in detail displays and other I/A Series system uses of
the outputs. The same display scaling is used for all block outputs, and should reflect the range
and unit of measure configured in the device.
The block also supports the function block’s mode parameters.
The MAI block and the device function block operate in two asynchronous cycles, both writing
to and reading from shared space in the FBM memory. As with other I/A Series IO blocks, the
MAI block executes in the Basic Processing Cycle (BPC) of the control station according to its
compound and its PERIOD and PHASE parameters, as described in Control Processor 270
(CP270) Integrated Control Software Concepts (B0700AG). The device MAI block executes once
each FBM macrocycle as scheduled by the FBM228.
The principal task of the MAI block is to read values and status from the corresponding device
block. For this task, a publisher/subscriber connection is maintained between the MAI block
OUTn parameters and the device function block OUT_n parameters.
All other parameter connections are made by the FBM228 on a client/server basis at the fre-
quency specified in the UPDPER parameter. The parameter can be set from 0 to 2147483647
milliseconds; the default is 10000 (10 seconds). Increasing the frequency of the client/server com-
munication can significantly add to the load on the H1 segment.

E.6.1 Device Function Block Connection


The configured parameter IOM_ID of the MAI block specifies an ECB201 (the device ECB) that
represents the target H1 device. The ECB201 PARENT parameter identifies the ECB200 or
ECB202 for the FBM228. The path to the device block is completed in one of two different
ways, depending on which configuration editor is used:
♦ When the MAI block is configured in IACC, the MAI block is connected to the
device block whose tag matches the NAME parameter of the MAI block. If there is no
matching device block tag, the MAI block binds to the first un-initialized multiple
analog input device block and re-tags the device block accordingly.
♦ When the MAI block is configured using IEE, the device function block is selected in
a browser which displays the device function blocks based on the device description in
the device ECB. If the connection is not made via the browser, the connection is made
based on the MAI block NAME parameter.
The MAI block CHANNL parameter is used to configure the device block CHANNEL parame-
ter and thus identify the I/O subsystem equipment providing the inputs. Refer to the device doc-
umentation for the appropriate channel assignment.
CHMASK parameter is used to specify which of the eight device block outputs are to be pro-
cessed by the MAI block. CHMASK does not affect any settings in the device function block.

E.6.2 Device Configuration Parameters


The MAI block enables you to set key configurable parameters in the corresponding device func-
tion block and manage the configuration from the I/A Series system. When you deploy the MAI
block to the control station, and then download the FBM228, parameter values in the MAI block
update parameters in the linked device function block.

533
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

The deployment of the MAI block to the FBM228 also causes the FBM to change the schedule as
follows:
♦ Schedule execution of the device function block
♦ Add compel data (CD) messages to each macrocycle to publish the OUT_n parameter
values and status
♦ Schedule client/server connections between the MAI block and the device function
block for view updates.
Table E-12 lists the device function block parameters and the MAI block parameters used to con-
figure them. For the MAI, the table includes both the six-character (maximum) parameter name
that is used in block detail displays and the parameter labels used in IACC, which more closely
resemble the FOUNDATION fieldbus parameter names. Use the six-character parameter name
when connecting parameters to a process display.

Table E-12. MAI Block Configuration Parameters

Configured with MAI Block Parameter


Device Function Block
Parameter Name in Process Displays Label in IACC
CHANNEL CHANNL Channel
FF_BLOCK.BLOCK_TAG NAME Name
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc

E.6.3 Block Status


The multiple analog input device function block OUT_n parameters have both a value and a sta-
tus. The status is contained in a 8-bit byte, which is further parsed in to .Quality, .SubStatus,
and .Limits bits. The status is read into the MAI block parameter, bit for bit. The default displays
for the MAI block shows the converted status parameter so that the value need not be decoded.

NOTE
The .SubStatus bits in multiple analog input blocks vary with the specific I/O sub-
system or multi-sensor device, and may not be the same as the standard
FOUNDATION fieldbus bit assignment used in other device function blocks. Refer to
the device documentation for information about how the .SubStatus bits are used.

Table E-13 shows how the status byte is formatted.

534
Appendix E. Legacy MAI – Foundation™ fieldbus Multiple Analog Input B0700EC – Rev B

Table E-13. MAI Block Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 Refer to the device documentation
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

E.6.4 Mode Machine


The MAI block mode and switch parameters support the FOUNDATION fieldbus state machine
schema, which is functionally equivalent to a single rotary switch that can be set to one of the per-
mitted states such as OOS, MAN, and AUTO.
The possible states are enumerated in the device function block MODE.Permitted parameter,
while the MODE.Target and MODE.Normal parameters specify the target and normal states,
respectively.
To transition the device to a different state, a request is written to the MODE.Target parameter.
Depending on device/block operation, it is possible for the actual mode of the function block to
differ from the desired Target. The actual mode can be read from the device function block
MODE_BLK.Actual.
The MAI block supports the device function block mode parameters with the configurable
MODE_T, MODE_P, and MODE_N parameters and the output parameter MODE_A.
To change the mode of the device function block from the I/A Series system, a mode request is
issued with the value of MODE_T via a switch parameter and written to MODE_BLK.Target.
The target value written to the device is rung back to be reflected in the MODE_T parameter.
In the MAI block, MODE_T, and thus the function block MODE.Target, is set by one of three
settable boolean parameters:
♦ AUT_SW changes the target mode to Auto so that OUT_n parameters hold the val-
ues processed by the device function block
♦ MAN_SW changes target mode to Manual so that the device function block OUT_n
parameters can be set via the MAI block OUTn parameters.
♦ OOS_SW changes the target mode to Out of Service so the device function block’s
configuration can be changed.
Refer to Table E-11 for a description of the switch parameter actions and mapping of the MAI
block mode parameters to their device block equivalents.

535
B0700EC – Rev B Appendix E. Legacy MAI – Foundation™ fieldbus Multiple

E.6.5 Alarms
The MAI block uses standard I/A Series alarm parameters, rather than the alarm features of the
device function block, to report to the control system when the OUTn value is bad. Bad IO
Alarming is enabled when BADOPT=1. The block processes alarms for those outputs that are
selected in CHMASK. The alarm priority and alarm group are set with BADPRI and BADGRP,
respectively. The alarm message text is set with BADTXT.
Refer to Control Processor 270 (CP270) Integrated Control Software Concepts (B0700AG) for infor-
mation on alarm functionality.

E.6.6 Simulation
The I/A Series MAI block SIMOPT parameter enables simulation of multiple analog inputs to
the control system from the corresponding multiple analog input device function block. This fea-
ture can be used to test control schemes requiring analog inputs without actual FBM228 hard-
ware connections.
When SIMOPT= 1 (True), the status and value of OUTn are not recovered from the field, but
can be set directly to simulate input from the field.
When simulating (SIMOPT=1), the following functions will be performed:
♦ The PVn inputs are settable and are stored to the OUTn output values when the
block mode is Auto. The CHMASK parameter will be used to determine which out-
puts to process.
♦ The OUTSTn output status parameters are set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (AUT_SW, MAN_SW, or
OOS_SW) immediately update target mode parameter (MODE_T), and the actual
block mode (MODE_A) tracks MODE_T each block cycle.
♦ If BAO=1, Bad Alarming of the inputs is performed.
When simulating, the following functions are not performed:
♦ Downloading of configuration parameters.
♦ Updating of View data parameters.
♦ Block Error (BLKERR) processing.
♦ External configuration changes to function block parameters.
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing Foundation fieldbus (B0750BC) or
Implementing Foundation fieldbus on the I/A Series System (B0700BA) for instructions on conduct-
ing control simulations from the control station.

536
Appendix F. Legacy MAO –
FOUNDATION™ fieldbus Multiple
Analog Output
This appendix describes the legacy Multiple Analog Output (MAO) block, shipped with
I/A Series systems with v8.4.3 or earlier software, used with an FBM228 with SWTYPE=228.
The MAO block interfaces the control system with a corresponding multiple analog output
function block operating in a FOUNDATION™ fieldbus H1 device.

F.1 Overview
Multiple Analog Output (MAO) is a Distributed Control Interface (DCI) block that provides
an interface between the control processor and a multiple analog output function block operat-
ing in a FOUNDATION fieldbus H1 device (the device function block). The MAO block is sup-
ported on the FCP270 and ZCP270 when the H1 device is connected to the control station by
an FBM228 (with SWTYPE=228). The MAO block is configured using the Block Configura-
tor in the InFusion Engineering Environment (IEE) as described in InFusion Enterprise Control
System: Implementing FOUNDATION fieldbus (B0750BC) or with the I/A Series Configuration
Component (IACC) software as described in Implementing FOUNDATION fieldbus on the I/A
Series System (B0700BA).

F.2 Basic Operation


The MAO block integrates the linked device function block into the I/A Series system. On initial-
ization, user-configured parameters in the MAO block are written to key configurable parameters
in the device function block.
During normal operation, the MAO block’s IN_n (where n is 1 through 8) are written to the
IN_n parameters of the device function block. The outputs are then read back to MAO block
IN_n and INSTn parameters, which hold the value and status, respectively, of the device IN_n
parameters.
When the block is in simulation mode (SIMOPT = 1), the IN_n values are not written to the
device function block, but the value of each IN_n is updated as if it had been read back from the
device, and the status of each IN_n is set to Good, Non-Cascade.
In addition to providing outputs to the device function block, the MAO block provides access to
a variety of operational and diagnostic information via client/server connections with the parame-
ters that are included in Views 1, 2, and 4 of the device block. The values read from these param-
eters are displayed in the block detail displays and are available for connection to other I/A Series
blocks.

F.3 Features
The MAO block provides the following features:

537
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

♦ Provides up to eight analog outputs (IN_1 through IN_8) to the linked device func-
tion block
♦ Acquires the value and status of the device block outputs
♦ Time stamps value and status changes
♦ Accesses the parameters in the device function block’s View 1, View 2 and View 4
using change-driven and periodic client/server connections
♦ Ensures that changes in a device’s process values and error conditions are continuously
available for display and connection to the control strategy
♦ Provides for the configuration of device block parameters from the I/A Series system
and management of the device configuration in the control database
♦ Enables users to set the mode of the device function block to Automatic or Out of
Service
♦ Provides alarm detection and reporting for Bad I/O
♦ Supports simulation of device block output within the control station.

F.4 Block Parameters


Table F-1 lists the block parameters. See Table F-16 for mappings of MAO parameters and their
device function block equivalents.

Table F-1. MAO Block Parameters

Name Description Type Accessibility Default Units/Range


Configurable Parameters
NAME block name string no-con/no-set 2 blanks 1 to 12 chars
TYPE block type short integer no-con/no-set 36 36 [MAO]
TAGDSC tag descriptor string no-con/no-set 2 blanks 1 to 32 chars
PERIOD block sample time short integer no-con/no-set 1 0 to 13
PHASE block execution phase integer no-con/no-set 0 ---
LOOPID loop identifier string no-con/no-set 2 blanks 1 to 32 chars
SIMOPT simulation option boolean no-con/no-set 0 0 = no simulation
1 = simulation
IOM_ID ECB identifier string no-con/no-set 2 blanks any valid path, up to
12 chars
CHANNL channel integer no-con/no-set 1
CHMASK channel mask packed bool- no-con/no-set blank 0x00 to 0xFF
ean
DDITEM DD item ID long no-con/no-set 0x800209D0
DDMBR DD member ID long no-con/no-set 0x00
UPDPER view update period long no-con/no-set 10000 ms 0 to 2147483647ms
STRATG strategy integer no-con/no-set 999 0 to 65535
HSCO1 output display high real no-con/no-set 100.0 >= LSCO1
scale
LSCO1 output display low real no-con/no-set 0 <= HSCO1
scale
EO1 eng units display string no-con/no-set % 1 to 32 chars

538
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table F-1. MAO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


DESCR1 IN_1 descriptor string no-con/no-set 2 blanks 1 to 32 chars
DESCR2 IN_2 descriptor
DESCR3 IN_3 descriptor
DESCR4 IN_4 descriptor
DESCR5 IN_5 descriptor
DESCR6 IN_6 descriptor
DESCR7 IN_7 descriptor
DESCR8 IN_8 descriptor
MODE_N normal mode short integer no-con/no-set 0x10 0 to 0xFF
MODE_P permitted mode short integer no-con/no-set 0x11 0 to 0xFF
MODE_T target mode short integer no-con/no-set 0x10 0 to 0xFF
IN_1 IN_1 real con/set 0.0
IN_2 IN_2
unsettable when
IN_3 IN_3
unlinked
IN_4 IN_4
IN_5 IN_5
IN_6 IN_6
IN_7 IN_7
IN_8 IN_8
FSOPTN faultstate option short integer no-con/no-set 0 0x00, 0x04
FSTIME faultstate time real no-con/no-set 20.0 sec
FSV_1 faultstate value 1 real no-con/no-set 100
FSV_2 faultstate value 2
FSV_3 faultstate value 3
FSV_4 faultstate value 4
FSV_5 faultstate value 5
FSV_6 faultstate value 6
FSV_7 faultstate value 7
FSV_8 faultstate value 8
INHOPT inhibit option short no-con/no-set 0 0 to 3
INHIB alarm inhibit switch boolean con/set 0 0 to 1
INHALM inhibit alarm packed bool- con/set 0 0 to 0xFFFF
ean
ERROPT error options packed bool- no-con/no-set 0xFFFE 0 to 0xFFFF
ean
ERRGRP error alarm group short con/no-set 8 1 to 8
BADOPT bad alarm option short no-con/no-set 1 0, 1
BADGRP bad alarm group integer no-con/no-set 0 1 to 8
BADPRI bad alarm priority integer con/set 5 1 to 5
BADTXT bad alarm text string con/no-set 2 blanks 0 to 32 chars
AMRTIN alarm regeneration integer no-con/set 0 0 to 32767
interval

539
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

Table F-1. MAO Block Parameters (Continued)

Name Description Type Accessibility Default Units/Range


Non-Configurable Parameters
Outputs
ACHNGE alternate change integer con/no-set 0 -32768 to 32767
ALMSTA alarm status packed long con/no-set 0 0 to 0xFFFF
AUT_SW auto switch boolean con/set 0 0 to 1
BLKERR block error packed bool- con/no-set blank 0 to 0xFFFF
ean
BLKSTA block status packed long con/no-set 0 0 to 0xFFFFFFFF
CRIT alarm criticality integer con/no-set 0 0 to 5
FSTATE faultstate status packed bool- con/no-set 0 0 to 0xFFFF
ean
INHSTA inhibit status packed long con/no-set 0 0 to 0xFFFFFFFF
INST_1 IN_1 status packed bool- con/no-set 0 0 to 0xFF
INST_2 IN_2 status ean
INST_3 IN_3 status
INST_4 IN_4status
INST_5 IN_5 status
INST_6 IN_6 status
INST_7 IN_7 status
INST_8 IN_8 status
MODE_A actual mode integer con/no-set 0 to 0xFFFF
OOS_SW out of service switch boolean con/set 0 0 to 1
PRTYPE priority type integer con/no-set 0 0, 8
TSTMP1 IN_1 time stamp long integer con/no-set 0 ms since midnight
TSTMP2 IN_2 time stamp
TSTMP3 IN_3 time stamp
TSTMP4 IN_4 time stamp
TSTMP5 IN_5 time stamp
TSTMP6 IN_6 time stamp
TSTMP7 IN_7 time stamp
TSTMP8 IN_8 time stamp
UNACK unacknowledged boolean con/set 0 0 to 1
Data Stores
ALMOPT alarm options packed long no-con/no-set 0 0 to 0xFFFFFFFF
CFGERR configuration error short no-con/no-set 0
DEFINE no config errors boolean no-con/no-set 1 0, 1
DESCRP descriptor string no-con/no-set 2 blanks 1 to 32 chars
ERCODE configuration error string no-con/no-set 2 blanks (Table F-8)
LOCKID lock identifier string no-con/no-set 2 blanks 1 to 32 chars
LOCKRQ lock request boolean no-con/no-set 0 0 to 1
OWNER owner name string no-con/no-set 2 blanks 1 to 32 chars
RO1 output scale string no-con/no-set 100.0
ST_REV status revision integer no-con/no-set 0 0 to65535

540
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

F.4.1 Parameter Definitions


ACHNGE Alternate Change is an integer output that is incremented each time a
settable parameter is changed externally. It wraps around from 32767 to
–32768.

ALMOPT The Alarm Options parameter contains packed long values representing
the alarm types that have been configured as options in the block (based
on BADOPT which enables Bad Alarming and CHMASK which identi-
fies which channels are to be processed by the block), and the alarm
groups that are in use. Table F-2 shows how the parameter is used by the
MAO block.

Table F-2. ALMOPT Parameter Format

Bit
Number*
(0 to 31) Configured Alarm Option, When True
0 (lsb) Alarm Group 8 in Use
1 Alarm Group 7 in Use
2 Alarm Group 6 in Use
3 Alarm Group 5 in Use
4 Alarm Group 4 in Use
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
8 Channel 8 option
9 Channel 7 option
10 Channel 6 option
11 Channel 5 option
12 Channel 4 option
13 Channel 3 option
14 Channel 2 option
15 Channel 1 option
22 Bad I/O Alarm Configured
*Bit 0 is the least significant, low order bit.

541
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. Table F-3 shows the bits used by the function blocks.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
B13
B14
B15
B16
CH1 Bad B17
CH2 Bad B18
CH3 Bad B19
CH4 Bad B20
CH5 Bad B21
CH6 Bad B22
CH7 Bad B23
CH8 Bad B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
CRIT PRTYPE
UNAK

HMA
BAD

LMA
INH

Table F-3. ALMSTA Parameter Format

Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter PRTYPE ---
for values used in the blocks
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
8 Channel 8 BAD alarm ALMSTA.B24
9 Channel 7 BAD alarm ALMSTA.B23
10 Channel 6 BAD alarm ALMSTA.B22
11 Channel 5 BAD alarm ALMSTA.B21
12 Channel 4 BAD alarm ALMSTA.B20
13 Channel 3 BAD alarm ALMSTA.B19
14 Channel 2 BAD alarm ALMSTA.B18
15 Channel 1 BAD alarm ALMSTA.B17
22 BAD Bad I/O Alarm. ALMSTA.B10
Set when any IN_n.Status.Bad=1
Cleared when all IN_n.Status.Bad = 0
29 INH Inhibit Alarm. This bit is set when any ALMSTA.B3
of the alarms for any channel is inhib-
ited
30 UNAK Unacknowledged ALMSTA.B2
*Bit 0 is the least significant, low order bit.

AMRTIN Alarm Message Regeneration Time Interval specifies the rate at which
alarm messages are generated for alarm conditions that have not been
cleared. The interval is specified in seconds. The configured interval is
rounded up to the closest value that is an even multiple of the station
BPC. A value of 0 disables alarm message regeneration.

AUT_SW Auto Switch is a settable Boolean output used to set MODE_T, and thus
MODE_BLK.Target in the associated device function block, to Auto.

542
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

BADGRP Bad Alarm Group is a configurable, non-settable short integer parameter


used to specify the Alarm Group to be used for reporting Bad Alarm
messages in the MAO block. The range is 1 (default) to 8.

BADOPT Bad Alarm Option is a configurable, non-settable Boolean parameter used


to specify whether or not Bad Alarming is to be performed in the MAO
block:
♦ 0 (default) disables Bad Alarming
♦ 1 enables Bad Alarming.

BADPRI Bad Alarm Priority is a configurable integer input used to specify the
Alarm Priority to be assigned to Bad Alarms in the block. BADPRI is
settable if unlinked. The range is 1 (highest) to 5 (default).

BADTXT Bad Alarm Text is a configurable, non-settable ASCII string of up to


32 characters used as descriptive text in Bad Alarm messages in the block.

BLKERR Block Error is a non-settable, packed Boolean output that contains the
BLOCK_ERR parameter of the associated device function block.
Table F-4 shows the parameter format.

Table F-4. BLKERR Parameter Format

Bit* Error Code


0 Out of Service
1 Power-up
2 Device Needs Maintenance Now
3 Readback Check Failed
4 Lost NV Data
5 Lost Static Data
6 Memory Failure
7 Output Failure
8 Input Failure
9 Device Needs Maintenance Soon
10 Device Fault State Set
11 Local Override
12 Simulate Active
13 Link Configuration Error
14 Block Configuration Error
15 Other (most significant bit)
*Bit 0 is the least significant, low order bit.

543
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block


operational states. Table F-5 shows how the bits are used by the
MAO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

B10
B11
B12
FBM228 B13
B14
B15
B16
B17
B18
B19
B20
B21
B24
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9

HOLD
UDEF

FBM

TRK
LCK

BIO
ON

MA

LO
LR
FS

Table F-5. BLKSTA Parameter Format

Bit Boolean
Number* Connection
(0 to 31) Name Operational States When True (B32 to B1)
3 LO The device function block mode is Local Override BLKSTA.B29
6 TRK The block is being tracked as the device function BLKSTA.B26
block is in Local Override or Initialization Manual
mode
8 FBM There is a communication failure between BLKSTA.B24
CP and FBM
11 MA The device block mode is Auto BLKSTA.B21
12 BIO Bad I/O: at last on channel is bad BLKSTA.B20
14 UDEF Block is undefined. See DEFINE, ERCODE, and BLKSTA.B18
CFGERR
15 ON The compound that contains the block is ON BLKSTA.B17
19 FBM228 The H1 device is hosted and scheduled by an BLKSTA.B13
FBM228
20 LCK A workstation has locked this block BLKSTA.B12
* Bit 0 is the least significant, low order bit.

CFGERR Configuration Error is a non-configurable, non-settable short integer


parameter that contains the index of the incorrectly configured device
function block parameter when the Function block becomes undefined
due to a W73 - FF FUNCTION BLOCK CONFIGURATION
ERROR. When this happens, the system generates an alarm message that
contains the ASCII name of the parameter assigned to the index
(Table F-6).

544
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table F-6. CFGERR Index

Value* Device Block Parameter with Error


2 TAG_DESC
3 STRATEGY
5 MODE_BLK
7 CHANNEL
16 MO_OPTS
17 FSTATE_TIME
18 FSTATE_VAL1
19 FSTATE_VAL2
20 FSTATE_VAL3
21 FSTATE_VAL4
22 FSTATE_VAL5
23 FSTATE_VAL6
24 FSTATE_VAL7
25 FSTATE_VAL8
*Bit 0 is the least significant, low order bit.

CHANNL Channel is a configurable, downloadable, integer parameter that specifies


the CHANNEL parameter of the associated device function block.
CHANNEL specifies the I/O subsystem by its the transducer block chan-
nel. Refer to the device documentation to identify the correct channel and
any special rules concerning mapping of IN_n parameters to device out-
puts.

CHMASK Channel Mask is a configurable, non-settable packed boolean parameter


that specifies which parameters are to be processed by the MAO block.
CHMASK does not affect any device function block settings. Table F-7
shows the parameter format.

Table F-7. Channel Mask Parameter Format

Bit Number* Output to be Processed


(0 to 15) When Bit Is Set
0 IN_1
1 IN_2
2 IN_3
3 IN_4
4 IN_5
5 IN_6
6 IN_7
7 IN_8

545
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

Table F-7. Channel Mask Parameter Format (Continued)

Bit Number* Output to be Processed


(0 to 15) When Bit Is Set
8-15 Reserved
*Bit 0 is the least significant, low order bit.

CRIT Criticality is an integer output that indicates the priority of the block’s
highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.

DDITEM DD Item is a configurable, non-settable long integer used to specify the


DD Item ID of the associated device function block.

DDMBR DD Member is a configurable, non-settable long integer used to


specify the DD Member ID of the associated device function block.

DEFINE Define is a data store that indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block
initializes, DEFINE is set to 0 if any configured parameters fail validation
testing. See “ERCODE” on page 546 for a list of all possible validation
errors in this block.
♦ If DEFINE = 0, no further processing of the block occurs,
including further validation of remaining parameters.
♦ To return DEFINE to a True value, correct all configuration errors
and reinstall the block.
♦ If DEFINE = 0, the bit BLKSTA.UDEF = 1.

DESCRP Description is a non-connectable, non-settable ASCII string data store of


up to 32 characters that describes the MAO block. DESCRP tracks
TAGDSC, and is updated when TAGDSC is configured.

DESCRn Descriptor n (where n is 1 to 8) is a configurable, non-settable string of up


(n = 1 to 8) to 32 characters that describes the IN_n input. If BAD Alarming is con-
figured (BADOPT = 1), this descriptor is included in the BAD Alarm
message for the respective point.

EO1 Engineering Units for Output 1 specifies the engineering units text for the
block’s eight outputs (IN_n) in detail displays and other I/A Series system
uses. The limit should be consistent with the display range parameters,
LSCO1 and HSCO1.
This parameter does not affect scaling in the device function block. Refer
to the device documentation for scaling information. EO1 should be con-
sistent with the engineering units used by the connected devices.

ERCODE Error Code is a string data store that indicates the type of configuration
error which caused the block’s DEFINE parameter to be set False.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.

546
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table F-8 lists the possible values of ERCODE for the MAO block, and
the significance of each value in this block.

Table F-8. ERCODE Texts

ERCODE Value
W43 INVALID PERIOD/PHASE COMBINATION
W44 INVAID ENGINEERING RANGE
W54 ECB DOES NOT EXIST
W62 UNRESOLVED CONNECTION
W65 INVALID POINT ADDRESS
W66 DUPLICATE CONNECTION
W67 INSUFFICIENT FBM MEMORY/CONNECTIONS
W68 INVALID DEVICE CONNECTION
W69 INVALID POINT CONNECTION
W73 FF FUNCTION BLOCK CONFIGURATION ERROR
W74 FF FUNCTION BLOCK DDITEM MISMATCH
W75 FF FUNCTION BLOCK DDMBR MISMATCH
W76 INVALID FF MODE CONFIGURATION
W77 FIELDBUS COMMUNICATION FAULT
W78 INVALID FUNCTION BLOCK
W79 INVALID PARAMETER INDEX
W80 FIELDBUS DEVICE NOT FOUND
W81 INVALID PARENT DCI ECB PERIOD/PHASE
W82 FF CONFIGURATION IN PROGRESS

ERRGRP Error Alarm Group is a configurable, non-settable short integer used to


specify the Alarm Group to be used for reporting Block Error (BLKERR)
messages. The range is 1 to 8 (default).

ERROPT Error Options is a non-connectable, non-settable, packed Boolean that


specifies which device function block error conditions (BLOCK_ERR)
generate an alarm message. Table F-9 shows the parameter format.

Table F-9. ERROPT Parameter Format

Bit* Error Code


0 Out of Service
1 Power-up
2 Device Needs Maintenance Now
3 Readback Check Failed
4 Lost NV Data
5 Lost Static Data
6 Memory Failure
7 Output Failure
8 Input Failure

547
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

Table F-9. ERROPT Parameter Format (Continued)

Bit* Error Code


9 Device Needs Maintenance Soon
10 Device Fault State Set
11 Local Override
12 Simulate Active
13 Link Configuration Error
14 Block Configuration Error
15 Other
*Bit 0 is the least significant, low order bit.

FSOPTN Fault State Option is a configurable integer parameter that specifies under
what conditions the FBM228 will force the device to take the Fault State
action configured in the device function block (Table F-10).

Table F-10. Fault State Options

Bit Description, when True


0 Assert Fault State if measurement is Bad.
2 Assert Fault State if control station-to-FBM communication
is lost (FBM option). This option is enabled only if Fault
State is enabled at the FBM level via the FSENAB parameter
in the ECB200 or ECB202.

FSOPTN is dependent upon how the Fault State parameters are config-
ured in the device with which the MAO block is being used (see
MOOPTS). The Fault State can also be turned off in the device, which
would render FSOPTN ineffective. See Section F.6.5.

FSTATE Fault State is a non-settable packed boolean output that contains the
FSTATE_STATUS parameter of the device function block, which shows
the Fault State of each channel. Table F-11 shows the parameter format
for MAO and the device function block parameters.

Table F-11. Format of the Fault State Status Parameters

Bit* Description When True


0 Fault State asserted for channel 1
1 Fault State asserted for channel 2
2 Fault State asserted for channel 3
3 Fault State asserted for channel 4
4 Fault State asserted for channel 5
5 Fault State asserted for channel 6
6 Fault State asserted for channel 7

548
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table F-11. Format of the Fault State Status Parameters (Continued)

Bit* Description When True


7 Fault State asserted for channel 8
*Bit 0 is the least significant, low order bit.

FSTIME Fault State Time is a configurable, downloadable, real value used to specify
the FSTATE_TIME parameter of a device function block, which is the
time in milliseconds a fault must persist before the Fault State is asserted
for the affected output. Refer to Section F.6.5.

FSV_n Fault State Value n (where n is 1 through 8) is a configurable, download-


(n = 1 to 8) able, non-settable real value used to specify the FSTATE_VALn parameter
of a device function block. Refer to Section F.6.5.

HSCO1 High Scale for Output Range 1 specifies the upper range value for the
block’s eight outputs (IN_n) in detail displays and other I/A Series system
uses. The limit should be consistent with the other display scaling param-
eters, LSCO1 and EO1.
This parameter does not affect scaling in the device function block or con-
nected devices, but should be consistent with the device block scaling.
Refer to the device documentation for information on scaling the outputs.

IN_n Input n (where n is 1 through 8) is a connectable real input that contains


(n = 1 to 8) the value to written to the IN_n parameter of the device function block.

INHALM Inhibit Alarm contains packed Boolean values that represent alarm
generation inhibit requests for each type of alarm configured in the block.
Table F-12 shows how the bits are used by the MAO block.

Table F-12. INHALM Parameter Format

Boolean
Bit Description, Connection
Number* When True (B16 to B1)
8 Inhibit Channel 1 BAD Alarm INHALM.B8
9 Inhibit Channel 2 BAD Alarm INHALM.B7
10 Inhibit Channel 3 BAD Alarm INHALM.B6
11 Inhibit Channel 4 BAD Alarm INHALM.B5
12 Inhibit Channel 5 BAD Alarm INHALM.B4
13 Inhibit Channel 6 BAD Alarm INHALM.B3
14 Inhibit Channel 7 BAD Alarm INHALM.B2
15 Inhibit Channel 8 BAD Alarm INHALM.B1
*Bit 0 is the least significant, low order bit.

INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
suppresses all alarm message reporting. INHIB affects only alarm message

549
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

reporting; the alarm handling and detection functions are determined by


the INHOPT setting.

INHOPT Inhibit Option is a configurable, non-settable, non-connectable short


integer parameter that specifies how the block responds when alarms from
the block are inhibited (Table F-13).

Table F-13. Alarm Inhibit Options

Value Action Taken When an Alarm is Inhibited


0 Disables alarm messages but does not disable alarm detection.
1 Disables both alarm messages and alarm detection. If an alarm
condition exists at the time the alarm transitions into the inhib-
ited state, the alarm indicator is cleared.
2 Same as 0 for inhibited alarms. For uninhibited alarms,
automatically acknowledges return-to-normal messages.
“Into alarm” messages can be acknowledged by explicitly set-
ting UNACK False.
3 Same as 1 for inhibited alarms. For uninhibited alarms,
automatically acknowledges “return-to-normal” messages.
“Into alarm” messages can be acknowledged by explicitly set-
ting UNACK False.

IINHSTA Inhibit Status contains packed long values that represent the current
inhibit status of each alarm type configured in the block. Table F-14
shows how parameter is used with the MAO block.

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B17
B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
CH8 B1
CH7 B2
CH6 B3
CH5 B4
CH4 B5
CH3 B6
CH2 B7
CH1 B8
B9

Table F-14. INHSTA Parameter Format

Bit Boolean
Number* Description, Connection
(0 to 31) When True (B32 to B1)
24 Channel 1 alarms inhibited INHSTA.B8
25 Channel 2 alarms inhibited INHSTA.B7
26 Channel 3 alarms inhibited INHSTA.B6
27 Channel 4 alarms inhibited INHSTA.B5
28 Channel 5 alarms inhibited INHSTA.B4

550
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table F-14. INHSTA Parameter Format (Continued)

Bit Boolean
Number* Description, Connection
(0 to 31) When True (B32 to B1)
29 Channel 6 alarms inhibited INHSTA.B3
30 Channel 7 alarms inhibited INHSTA.B2
31 Channel 8 alarms inhibited INHSTA.B1
*Bit 0 is the least significant, low order bit.

INST_n IN_n Status (where n is 1 through 8) is a non-settable packed boolean


(n = 1 to 8) output that contains the IN_n.Status parameters of the device function
block. Refer to Section F.6.4 for information on the device function
block .Status bits.

IOM_ID I/O Module Identifier is a user-configurable string that specifies the H1


device by its ECB name. IOM_ID can be formatted in either of two ways,
depending on the location of the ECB in question:
♦ By the name of the device ECB (ECB201). For this format, the
ECB201 must reside in the station ECB compound
<cp_letterbug>_ECB, where cp_letterbug is the station letterbug
of the I/A Series station.
♦ By the full pathname of the external device ECB (ECB201).
For this format, the ECB201 must reside in the station
ECB compound or a compound where its associated
blocks are located. The pathname must be of the form
<local_compound_name>:<ecb_name> where <ecb_name> is
the NAME parameter of the ECB.

LOCKID Lock Identifier is a string identifying the workstation that has locked
access to the block via a successful setting of LOCKRQ. LOCKID has
the format LETTERBUG:DEVNAME, where LETTERBUG is the
6-character letterbug of the workstation and DEVNAME is the 1 to
6-character logical device name of the display task.

LOCKRQ Lock Request is a Boolean input which can be set True or False only by a
SETVAL command from the LOCK U/L toggle key on workstation dis-
plays. When LOCKRQ is set True in this fashion, a workstation identifier
accompanying the SETVAL command is entered into the LOCKID
parameter of the block. Thereafter, set requests to any of the block’s
parameters are only honored (subject to the usual access rules) from the
workstation whose identifier matches the contents of LOCKID.
LOCKRQ can be set False by any workstation at any time, whereupon a
new LOCKRQ is accepted, and a new ownership workstation identifier is
written to LOCKID.

LOOPID Loop Identifier is a configurable ASCII string of up to 32 characters used


to identify the loop or process with which the block is associated.

551
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

LOOPID is displayed on the detail display of the block, immediately


below the faceplate.

LSCO1 Low Scale for Output Range 1 is a real value that defines the lower range
value for the block’s eight outputs (IN_n) in detail displays and other
I/A Series system uses. The limit should be consistent with the display
scaling parameters, HSCO1 and EO1.
This parameter does not affect scaling in the device function block or con-
nected devices, but should be consistent with the device block scaling.
Refer to the device documentation for information on scaling the outputs.

MODE_A Actual Mode is a non-configurable, non-settable, packed Boolean output


that contains the MODE_BLK.Actual parameter of the associated device
function block.

MODE_N Normal Mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Normal parameter of the
associated device function block.

MODE_P Permitted Mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Permitted parameter of the
associated device function block.

MODE_T Target mode is a configurable, downloadable, non-settable, packed


Boolean output that contains the MODE_BLK.Target parameter of the
associated device function block.
The AUT_SW and OOS_SW can be used to change the MODE_T
parameter and thus the MODE_BLK.Target parameter in the device func-
tion block.

MOOPTS Multiple Output Options is a configurable, downloadable, non-settable,


packed boolean value that configures the device function block
MO_OPTS parameter to specify the Fault State actions and restart usage
for each output channel in the device. Table F-15 shows the parameter
format for MAO and the device Function block.

Table F-15. Format of the Multiple Output Options Parameters

Bit* Option Set When True


0 Fault State to value for channel 1
1 Fault State to value for channel 2
2 Fault State to value for channel 3
3 Fault State to value for channel 4
4 Fault State to value for channel 5
5 Fault State to value for channel 6
6 Fault State to value for channel 7
7 Fault State to value for channel 8

552
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table F-15. Format of the Multiple Output Options Parameters

Bit* Option Set When True


8 Use Fault State value on RESTART for channel 1
9 Use Fault State value on RESTART for channel 2
10 Use Fault State value on RESTART for channel 3
11 Use Fault State value on RESTART for channel 4
12 Use Fault State value on RESTART for channel 5
13 Use Fault State value on RESTART for channel 6
14 Use Fault State value on RESTART for channel 7
15 Use Fault State value on RESTART for channel 8
*Bit 0 is the least significant, low order bit.

NAME Name is a user-defined string of up to 12 characters for accessing the


block and its parameters, and identifying the matching device function
block in the device. When the I/A Series block is initialized, the block
updates the configurable parameters of the function block whose Function
Block Tag matches the NAME parameter. If there is no matching Func-
tion Block Tag, the block renames the first available block of the function
block and updates the other configurable parameters.

OOS_SW Out of Service Switch is a settable output used to set the parameter
MODE_T, and thus MODE_BLK.Target in the associated device function
block, to Out of Service.

OWNER Owner is a string of up to 32 ASCII characters that allocates control


blocks to applications. Attempts to set OWNER are successful only if the
present value of OWNER is the null string, an all-blank string, or a value
identical to the value in the set request. Otherwise, the request is rejected
with a LOCKED_ACCESS error.
OWNER can be cleared by any application with the null string, which is
always accepted, regardless of the current value of OWNER. Once the
null string is set, the value can be reset as desired.

PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. PERIOD values range from 0 to 9 and map
to the following period time lengths:
Period Length Period Length
0 0.1 second 5 30 seconds
1 0.5 second* 6 1 minute
2 1.0 second 7 10 minutes
3 2.0 seconds 8 60 minutes
4 10 seconds 9 0.2 second
*If the BPC is 0.2 second, this period is treated internally as 0.6 second,
but the PERIOD parameter remains 1.

553
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. For instance, assuming that
the BPC of the I/A Series station is 0.5 second, a block with a PERIOD of
3 (2.0 seconds) can execute within the first, second, third, or fourth BPC
of the 2-second time period. See Integrated Control Software Concepts
(B0700AG).

PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm:
0 = No alarm
8 = Bad I/O alarm.

RO1 Range Output 1 is a real array consisting of the two parameters HSCO1
and LSCO1. The array members are configured by their individual
names; however, RO1 and its members can be accessed on an array basis
by user tasks and displays.

SIMOPT Simulation Option is a configurable parameter that specifies whether the


MAO block is to be simulated. When SIMOPT= 1 (True), there is no
output to the device function block, and the status and value of the IN_n
parameters are not recovered from the field. The simulated behavior of the
block reflects the operational mode of the block (MODE_A).

ST_REV Status Revision is a non-settable integer that contains the ST_REV


parameter of the associated device function block.

STRATG Strategy is a configurable, downloadable, non-settable integer that is used


to specify the STRATEGY parameter of the associated device function
block.

TAGDSC Tag Descriptor is a configurable, downloadable, non-settable string that


specifies the TAG_DESC parameter of the associated device function
block. Changes to TAGDSC are copied to DESCRP.

TSTMPn Time Stamp n (where n is 1 through 8) contains the time (in milliseconds
(n = 1 to 8) since midnight) of the latest change in the IN_n parameter in the device
function block.
The time is from the FBM228 when a new value is sent to device function
block. However, when the block is in simulation (SIMOPT = 1), the value
is computed by the CP.

TYPE Type is the block type. When an MAO block is added to the control data-
base, the configuration editor sets TYPE to 36, causes the block type to be
identified as MAO in operator and system management displays.

UNACK Unacknowledged is a Boolean output parameter that is set True for


notification purposes whenever the block goes into alarm. It is settable,
but sets are only allowed to clear UNACK to False, and never in the
opposite direction. UNACK is cleared by an operator “acknowledge”
pick on a default display, a user display, or the Current Alarms display.

554
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

UPDPER Update Period is a configurable, non-settable long integer that is used to


specify the update period used by an FBM228 for client/server connec-
tions for scanning scan the device function block View 1, View 2 and
View 4 parameters. The range is 0 to 2147483647 milliseconds; the
default is 10000.

F.5 Device Function Block Description


This section describes the FOUNDATION fieldbus multiple analog output device function block,
and includes a block schematic, a brief description of the block’s standard parameter set, and a
table showing the mapping between the I/A Series system MAO block parameters and the device
function block parameters. Refer to FF-893, Function Block Application Process - Part 4 (FF-893-
5.1) for a detailed description of the block.

F.5.1 Device Block Operation


The FOUNDATION fieldbus multiple analog output function block processes up to eight setpoint
inputs from another block or an external source received at IN_n, and outputs the values to a field
device (Figure F-1). The CHANNEL parameter specifies the transducer block channel of the
equipment to receive the output.

IN_1
IN_2
IN_3 Output Snap
IN_4 to CHANNEL
Block
Transducer
IN_5 Algorithm
Block
IN_6 Inputs
IN_7
IN_8

Figure F-1. Device MAO Function Block Schematic

F.5.1.1 Mode
The device MAO block supports the following modes:
♦ Auto - In Automatic, the block output reflects IN_n.
♦ OOS - When the mode is Out of Service, the block is not processed, the output
channel is maintained at the last value, and the status of IN_n is set to BAD.
♦ LO - Local Override is set when the resource block has been placed in LO or a Fault
State is active. In LO, the output of the block does not respond to IN_n.

F.5.1.2 Fault State


The MAO block has two faultstate options, which are set individually for each channel in the
MO_OPTS parameter:

555
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

♦ Fault State on Restart sets each IN_n parameter to a specified value when the device is
recycled because of a loss of power or for some other reason. The value is specified in
FSATE_VALn.
♦ Fault State to Value sets each IN_n parameter to a specified value if the block has not
received a value for output from its configured source within the time specified in
FSTATE_TIME. As with the restart option, the value is specified in FSATE_VALn.
In the case of both options, the device detects the condition and takes the fault state action.

F.5.2 Parameter Transforms


Table F-16 illustrates the mapping of I/A Series MAO parameters to parameters in the related
device function block. Many of the parameters are straightforward 1:1 mappings that are either
unidirectional or bidirectional. Other mappings require that a data value be re-formatted (or
transformed) to be intelligible in the I/A Series system.
From the point of view of the MAO block, the relationship with the device function block can
also be described in terms of sink and source connections:
→ Source-sink The MAO block parameter is the source for the matching function
block parameter. Thus, changes to the MAO block parameter are
made to the device function block parameter. For example, when the
MAO block is initialized, the TAGDSC value is copied to the device
function block TAG_DESC parameter.
← Sink-source The MAO block parameter value is updated by the corresponding
device function block parameter. For example, the MODE_A param-
eter reads the device parameter MODE_BLK.Actual to make the
actual function block mode visible to the control system.
↔ Bidirectional Changes to the MAO block parameter are made to the device func-
tion block parameter and vice versa. For example, when the MAO
block is initialized, its MODE_T parameter value is written to the
device block parameter, MODE_BLK.Target, to configure the block’s
target mode. Subsequently, the MODE_BLK.Target value is written
back to the MAO block MODE_T parameter.

The arrow notation is used in the Table F-16 descriptions of MAO parameter transforms. These
are presented in alphabetic order, arranged by the I/A Series MAO block parameter names.

Table F-16. MAO Parameter Transforms

MAO Parameter Device Function Block Parameter


AUT_SW MODE_BLK.Target
When AUT_SW → 1:
Set MODE_T (request) = AUTO
Set OOS_SW=0
Write MODE_T (request) to FBM
BLKERR BLOCK_ERR
BLKERR.value ← BLOCK_ERR
BLKERR.status.OOS ← CP-FBM communication is failed or FBM is Off-Line

556
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table F-16. MAO Parameter Transforms (Continued)

MAO Parameter Device Function Block Parameter


BLKSTA MODE_BLK.Actual
BLKSTA.status.OOS ← MODE_BLK.Actual.OOS
BLKSTA.TRK ← MODE_BLK.Actual.IMAN or LO
BLKSTA.LO ← MODE_BLK.Actual.LO
BLKSTA.MA=1 ← MODE_BLK.Actual.AUTO
BLKSTA.FBM ← CP-FBM communication is failed
BLKSTA.BIO ← BKCAL_OUT.Status.Bad (Bits 6-7=0)
CHANNL ↔ CHANNEL
FSTATE ↔ FSTATE_STATUS
FSTIME ↔ FSTATE_TIME
FSVn (n = 1 to 8) ↔ FSTATE_VALn (n = 1 to 8)
IN_n (n = 1 to 8) IN_n (n = 1 to 8) in Auto mode is not simulating)
IN_n.value (request) → IN_n.Value (request)
IN_n.value (actual) ← IN_n.Value (actual)

IN_n.status.LHI ← IN_n.Status.Limited Hi (Bit 0)


IN_n.status.LLO ← IN_n.Status.Limited Lo (Bit 1)
IN_n.status.ERR ← IN_n.Status.Uncertain (Bits 6-7 = 1)
IN_n.status.BAD ← IN_n.Status.Bad (Bits 6-7 = 0)
or there is an CP-FBM communications failure
or the H1 device is failed or disabled

IN_n.status.OOS ← IN_n.Status.Bad (Bits 6-7 = 0) and Susbtatus.OOS (bits 2-7 = 7)


or the compound is Off
or the FBM228 is Off-line or DCI is Not Ready
or the H1 device is failed or disabled
or there is an CP-FBM communications failure
or the DCI_COMM_DATA.connect_status <= 0
INST_n (n = 1 to 8) IN_n (n = 1 to 8)
INST_n.value → IN_n.Staus
MODE_A MODE_BLK.Actual
MODE_A.value ← MODE_BLK.Actual
MODE_N ← MODE_BLK.Normal
MODE_P ← MODE_BLK.Permit
MODE_T MODE_BLK.Target
MODE_T.value (request) → MODE_BLK.Target
MODE_T.value (actual) ← MODE_BLK.Target
MOOPTS ↔ MOOPTS
NAME → Function Block Tag

557
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

Table F-16. MAO Parameter Transforms (Continued)

MAO Parameter Device Function Block Parameter


OOS_SW MODE_BLK.Target
When OOS_SW is set =1:
Set MODE_T (request) = OOS
Set AUT_SW=0
Write MODE_T (request) to FBM
STRATG ↔ STRATEGY
ST_REV ← ST_REV
TAGDSC ↔ TAG_DESC

F.6 MAO Block Functions


With each execution, the MAO block receives up to eight setpoint values from I/A Series system
control blocks, such as an MAI block, and writes a value and status to each device function block
IN_n parameter selected in the CHMASK parameter. The MAO block then reads back the value
and status of the IN_n parameters.
The MAO block does not scale or condition the output to the device. However, the MAO range
and units parameters (HSCO1, LSCO1 and EIO) scale the IN_n parameters for details displays
and other I/A Series system uses.
The MAO block supports the device block Fault State functions and Mode Machine.

F.6.1 Device Function Block Connection


The MAO block interfaces with a multiple analog output block operating in an I/O subsystem,
remote indicator, or similar device on an H1 segment hosted by an FBM228. The configured
parameter IOM_ID of the MAO block specifies the ECB201 (the device ECB) that represents
the target device. The ECB201 PARENT parameter identifies the FBM228’s equipment control
block (ECB200 or ECB202).
The path to the device block is completed in one of two different ways, depending on which con-
figuration editor is used:
♦ When the MAO block is configured in IACC, the MAO block is connected to the
device block whose tag matches the NAME parameter of the MAO block. If there is
no matching device block tag, the MMAO block binds to the first un-initialized mul-
tiple analog output device block and re-tags the device block accordingly.
♦ When the MAO block is configured using IEE, the device function block is selected
in a browser which displays the device function blocks based on the device description
in the device ECB. If the connection is not made via the browser, the connection is
made based on the MAO block NAME parameter.
The MAO block CHANNL parameter is used to configure the device block CHANNEL parame-
ter and thus identify the I/O subsystem to receive the outputs. Refer to the device documentation
for the appropriate channel assignment.
CHMASK parameter is used to specify which of the eight device block inputs are to be processed
by the MAO block. CHMASK does not affect any settings in the device function block.

558
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

F.6.2 Device Configuration Parameters


The MAO block enables you to configure selected parameters in the corresponding device
function block and manage the configuration from the I/A Series system. When you deploy the
MAO block to the control station, and then download the FBM228, parameter values in the
MAO block update parameters in the linked device function block.
Table F-17 lists the device function block parameters and the MAO block parameters used to
configure them. For the I/A Series block, the table includes both the six-character parameter name
that is used in block detail displays and the IACC parameter labels, which more closely resemble
the FOUNDATION fieldbus parameter names. Use the six-character parameter name when con-
necting parameters to a process display.

Table F-17. MAO Block Configuration Parameters

Configured with I/A Series MAO Block Parameter


Device Function Block
Parameter Name in Process Displays Label in IACC
CHANNEL CHANNL Channel
FF_BLOCK.BLOCK_TAG NAME Name
FSTATE_TIME FSTIME Fstate_Time
FSTATE_VALUE_n FSVn Fstate _Val
MO_OPTS MOOPTS Multiple_options
MODE_BLK.Normal MODE_N Mode_n
MODE_BLK.Permitted MODE_P Mode_p
MODE_BLK.Target MODE_T Mode_t
STRATEGY STRATG Strategy
TAG_DESC TAGDSC Tag_desc

The following are suggested and required MAO parameter settings:


♦ Configure MODE_P to include at least Auto and Out of Service. Other modes are
optional.
♦ Set MODE_T to Auto.
♦ Configure MO OPTS to include FS to Value and Use FS on Restart for each channel
(recommended).
♦ Set the Fault State option in the resource block’s FEATURE_SEL parameter.

F.6.3 Mode Machine


The MAO block mode and switch parameters support the FOUNDATION fieldbus state machine
schema, which is functionally equivalent to a single rotary switch that can be set to one of the per-
mitted states such as OOS and AUTO.
The possible states are enumerated in the device function block MODE.Permitted parameter,
while the MODE.Target and MODE.Normal parameters specify the target and normal states,
respectively.
To transition the device to a different state, a request is written to the MODE.Target parameter.
Depending on device/block operation, it is possible for the actual mode of the function block to
differ from the desired Target. The actual mode can be read from the device function block
MODE_BLK.Actual.

559
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

The MAO block support the device function block mode parameters with the configurable
MODE_T, MODE_P, and MODE_N parameters and the output parameter MODE_A.
To change the mode of the device function block from the I/A Series system, a mode request is
issued with the value of MODE_T via a switch parameter and written to MODE_BLK.Target.
The target value written to the device is rung back to be reflected in the MODE_T parameter.
In the MAO block, MODE_T, and thus the function block MODE.Target, is set by two settable
boolean parameters:
♦ AUT_SW changes the target mode to Auto so that the device block derives its output
from the IN_n parameters
♦ OOS_SW changes the target mode to Out of Service so the device function block’s
configuration can be changed.
Refer to Table F-16 for a description of the switch parameter actions and mapping of the MAO
block mode parameters to their device block equivalents.

F.6.4 Block Status


The device function block IN_n parameters have both a value and a status, which are sourced
from another device. Typically, the input is from an MAI block, in which case the status of IN_n
is the status of the of MAI block OUT_n parameter.
The status is contained in an 8-bit byte, which is parsed into .Quality, .SubStatus, and .Limits.
The status is read into the MAO block parameter, bit for bit. The default displays for the MAO
block shows the converted status parameter so that the value need not be decoded. Table F-18
shows how the status byte is formatted.

NOTE
The .SubStatus bits in multiple analog output blocks vary with the specific I/O sub-
system or multi-output device, and may not be the same as the standard
FOUNDATION fieldbus bit assignment usage in other device function blocks. Refer
to the device documentation for information about how the .SubStatus bits are
used.

The Status bit format is shown in Table F-18.

Table F-18. MAO Block Status Format

Bits Description
0-1 Limits
0 = Not limited
1 = High limited
2 = Low limited
3 = Constant (both high and low limited bits set)
2-5 Refer to the device documentation

560
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

Table F-18. MAO Block Status Format (Continued)

Bits Description
6-7 Quality
0 = Bad
1 = Uncertain
2 = Good (non-cascade)
3 = Good (cascade)

F.6.5 Fault State Handling


Failsafe parameters in the FBM228 equipment control block (ECB200 or ECB202) and the
MAO block provide support for the Fault State operation in the device block, which provides lev-
els of fault protection for communication errors between various levels of the hardware architec-
ture. The fault protection provides options for placing an output device into a Fault State
condition, with the output being driven to a user-predetermined or last good value.
The FBM228 can be configured to force the attached devices to take their configured Fault State
actions when a communication error between the FBM and the control station persists for more
than a specified period. The ECB Failsafe options are designed to assert Fault State at the device
level for a communication failure above the FBM. The options are set with the FSENAB and
FSDLAY parameters in the FBM228’s ECB.
The FBM configuration does not establish the device Fault State behavior as that is determined by
options in the device function blocks. Different behaviors can be set for each device connected to
the FBM, and in the case of the multiple analog output devices, for each channel.
The device Fault State options are designed primarily to deal with communication failures above
the device, while working in concert with ECB options. Enabling Fault State is effective under
two external conditions:
♦ When Fault State is asserted by the connected FBM
♦ When communications to the device are lost and the device MAO block mode is
Auto.
The actual Fault State behavior taken by the device function block is specified in the following
I/A Series system MAO block parameters (Table F-19).

Table F-19. Fault State Parameters in the MAO Block

Parameter Description
FSOPTN Specifies when Fault State is asserted by the FBM228:
♦ When bit 0 = 1, assert Fault State if measurement is Bad.
♦ When bit 2 = 1, assert Fault State if control station-to-FBM communi-
cation is lost (FBM option). This option is enabled only if Fault State
is enabled at the FBM level via the FSENAB parameter in the ECB200
or ECB202.

561
B0700EC – Rev B Appendix F. Legacy MAO – Foundation™ fieldbus Multiple

Table F-19. Fault State Parameters in the MAO Block

Parameter Description
MOOPTS Configures the device function block MO_OPTS parameter to enable/dis-
able two Fault State options for each output (IN_n).
♦ Use Fault State on Restart n: Selecting this option causes the IN_n
output to go to the value specified in FSTATE_VALn on a device
RESTART. If this option is not selected and the device can go to its tar-
get mode upon RESTART, the last saved setpoint is used for generating
the Fault State position.
♦ Fault State to Value n: When this option is selected, the block uses the
value specified for output n in FSTATE_VALn. When the option is not
selected, the last saved setpoint is used.
FSVn Configures FSTATE_VALn in the device function block to specify the value
that is asserted when one of the faultstate options is invoked for the channel.
FSTIME Configures FSTATE_TIME in the device function block to set the period
that the fault condition must last before the block asserts the specified value.
A Fault State action does not occur until the FSTATE_TIME interval has
expired.

F.6.6 Alarms
The MAO block uses standard I/A Series alarm parameters, rather than the alarm features of the
device function block, to specify how to report to the control system when the IN_n value is bad.
When BADOPT=1, Bad I/O Alarming is enabled for the channels selected in CHMASK. The
alarm priority and alarm group are set with BADPRI and BADGRP, respectively. The alarm mes-
sage text is set with BADTXT.
Refer to Control Processor 270 (CP270) Integrated Control Software Concepts (B0700AG) for infor-
mation on alarm functionality.

F.6.7 Simulation
The I/A Series MAO block SIMOPT parameter enables simulation of output to and readback
from the corresponding multiple analog output device function block. This feature can be used to
test control schemes requiring analog outputs without the actual FBM228 hardware connections.
When SIMOPT= 1 (True), the setpoint contained in IN_n is not written to the H1 device and
the value and status of IN_n are not recovered from the device function block. However, the IN_x
and INST_x parameters are updated as if the value and status had been read back from the device.
When SIMOPT= 1, the following functions are performed:
♦ The actual values and status of the IN_x inputs are updated from the requested values
and status each block cycle when the Actual block mode is Auto. The CHMASK
parameter determines which values to process.
♦ The INSTx input status parameters is set to Good Non-Cascade (0x80).
♦ Changes to the target mode via the mode switches (AUT_SW, MAN_SW, or
OOS_SW) immediately update target mode parameter (MODE_T), and the actual
block mode (MODE_A) tracks MODE_T each block cycle.
♦ If BAO=1, Bad Alarming of the inputs is performed.

562
Appendix F. Legacy MAO – Foundation™ fieldbus Multiple Analog Output B0700EC – Rev B

When SIMOPT = 1, the following functions are not performed:


♦ Downloading of configuration parameters
♦ Updating of View data parameters
♦ Block Error (BLKERR) processing
♦ External configuration changes to function block parameters
♦ Configuration Error (CFGERR) processing.
Refer to InFusion Enterprise Control System: Implementing FOUNDATION fieldbus (B0750BC) or
Implementing FOUNDATION fieldbus on the I/A Series System (B0700BA) for instructions on con-
ducting control simulations from control station.

563
Invensys Operations Management
5601 Granite Parkway Suite 1000
Plano, TX 75024
United States of America
http://www.iom.invensys.com

Global Customer Support


Inside U.S.: 1-866-746-6477
Outside U.S.: 1-508-549-2424 or contact your
local Invensys representative.
Email: iom.support@invensys.com
Website: http://support.ips.invensys.com

You might also like