B0193ax2 Aa
B0193ax2 Aa
Integrated Control
Block Descriptions
Volume 2 of 3,
ECB – MOVLV
B0193AX
Rev AA
September 20, 2010
Invensys, Foxboro, FoxCAE, FoxView, InFusion, I/A Series, the IPS logo, and EXACT are trademarks of
Invensys plc, its subsidiaries, and affiliates.
All other brand names may be trademarks of their respective owners.
Tables................................................................................................................................. xxiii
Preface............................................................................................................................... xxvii
32. ECB5 – Digital In, Sustained/Momentary, and Digital Out ....................................... 833
Overview ............................................................................................................................... 833
Functional Diagram ......................................................................................................... 834
Parameters ............................................................................................................................. 835
Parameter Definitions ...................................................................................................... 836
iii
B0193AX – Rev AA Contents
iv
Contents B0193AX – Rev AA
v
B0193AX – Rev AA Contents
vi
Contents B0193AX – Rev AA
vii
B0193AX – Rev AA Contents
viii
Contents B0193AX – Rev AA
ix
B0193AX – Rev AA Contents
x
Contents B0193AX – Rev AA
xi
B0193AX – Rev AA Contents
xii
Contents B0193AX – Rev AA
xiii
B0193AX – Rev AA Contents
xiv
Contents B0193AX – Rev AA
xv
B0193AX – Rev AA Contents
xvi
Contents B0193AX – Rev AA
xvii
B0193AX – Rev AA Contents
xviii
Figures
29-1. ECB1 Diagram ......................................................................................................... 807
30-1. ECB2 Diagram ......................................................................................................... 815
31-1. ECB4 Diagram ......................................................................................................... 825
32-1. ECB5 Diagram ......................................................................................................... 834
33-1. ECB6 Diagram ......................................................................................................... 847
34-1. ECB7 Diagram ......................................................................................................... 855
35-1. ECB8 Diagram ......................................................................................................... 863
36-1. ECB9 Diagram ......................................................................................................... 875
38-1. ECB12 Diagram ....................................................................................................... 895
38-2. Application Example for ECB12 and ECB18 ............................................................ 901
38-3. ECB13 Block Diagram ............................................................................................. 903
38-4. ECB13 Diagram ....................................................................................................... 904
38-5. ECB14 Diagram ....................................................................................................... 921
39-1. ECB15 Diagram ....................................................................................................... 929
40-1. ECB16 Diagram ....................................................................................................... 935
41-1. ECB18 Block I/O Diagram ....................................................................................... 943
41-2. ECB18 Functional Diagram ..................................................................................... 944
41-3. FBM18/ECB18 Real-time Data Flow ....................................................................... 954
42-1. ECB19 Diagram ....................................................................................................... 957
43-1. ECB21 Diagram ....................................................................................................... 963
44-1. ECB22 Block I/O Diagram ....................................................................................... 969
44-2. ECB22 Diagram ....................................................................................................... 970
44-3. ECB22 Data Flow ..................................................................................................... 979
45-1. ECB23 Diagram ....................................................................................................... 981
46-1. ECB34 Diagram ....................................................................................................... 991
47-1. ECB36 Diagram ..................................................................................................... 1003
48-1. ECB38R with FBM46 Configuration ..................................................................... 1015
48-2. Typical FBM246 and ECB38R Configuration ........................................................ 1016
49-1. ECB39 (AMSPRI) Diagram .................................................................................... 1027
49-2. AMSPRI Block I/O Diagram .................................................................................. 1035
49-3. AMSPRI Data Flow ................................................................................................ 1036
50-1. ECB41 Diagram ..................................................................................................... 1037
51-1. ECB42 Diagram ..................................................................................................... 1043
52-1. ECB43 Diagram ..................................................................................................... 1049
53-1. ECB44 Diagram ..................................................................................................... 1057
54-1. ECB46 Diagram ..................................................................................................... 1065
55-1. ECB47 Diagram ..................................................................................................... 1073
55-2. ECB47 Block I/O Diagram ..................................................................................... 1080
55-3. ECB47 Data Flow ................................................................................................... 1081
56-1. ECB47R Diagram ................................................................................................... 1084
56-2. ECB47R Block I/O Diagram .................................................................................. 1092
56-3. ECB47R Data Flow ................................................................................................ 1093
57-1. ECB52 Diagram ..................................................................................................... 1095
58-1. ECB53 Diagram ..................................................................................................... 1105
xix
B0193AX – Rev AA Figures
xx
Figures B0193AX – Rev AA
xxi
B0193AX – Rev AA Figures
xxii
Tables
27-1. List of ECBs .............................................................................................................. 793
28-1. ECBP Parameters ...................................................................................................... 799
28-2. BADALM Status Indication ...................................................................................... 800
29-1. ECB1 Parameters ...................................................................................................... 808
30-1. ECB2 Parameters ...................................................................................................... 815
31-1. ECB4 Parameters ...................................................................................................... 825
32-1. ECB5 Parameters ...................................................................................................... 835
33-1. ECB6 Parameters ...................................................................................................... 848
34-1. ECB7 Parameters ...................................................................................................... 856
35-1. ECB8 Parameters ...................................................................................................... 864
36-1. ECB9 Parameters ...................................................................................................... 876
37-1. ECB11 Parameters .................................................................................................... 887
37-2. BADALM Status Indication ...................................................................................... 888
38-1. ECB12 Parameters .................................................................................................... 896
38-2. ECB13 Parameters .................................................................................................... 904
38-3. HIU Measurement Points ......................................................................................... 917
38-4. ECB14 Parameters .................................................................................................... 921
39-1. ECB15 Parameters .................................................................................................... 929
40-1. ECB16 Parameters .................................................................................................... 935
40-2. Modbus Protocol Function Codes for Modicon Programmable Controllers .............. 941
41-1. ECB18 Parameters .................................................................................................... 945
42-1. ECB19 Parameters .................................................................................................... 957
43-1. ECB21 Parameters .................................................................................................... 963
44-1. ECB22 Parameters .................................................................................................... 970
45-1. ECB23 Parameters .................................................................................................... 982
46-1. ECB34 Parameters .................................................................................................... 992
47-1. ECB36 Parameters .................................................................................................. 1004
48-1. ECB38R Parameters ............................................................................................... 1017
49-1. ECB39 Parameters .................................................................................................. 1029
50-1. ECB41 Parameters .................................................................................................. 1037
51-1. ECB42 Parameters .................................................................................................. 1043
52-1. ECB43 Parameters .................................................................................................. 1049
53-1. ECB44 Parameters .................................................................................................. 1057
54-1. ECB46 Parameters .................................................................................................. 1066
55-1. ECB47 Parameters .................................................................................................. 1074
56-1. ECB47R Parameters ............................................................................................... 1085
57-1. ECB52 Parameters .................................................................................................. 1095
58-1. ECB53 Parameters .................................................................................................. 1105
59-1. ECB73 Parameters .................................................................................................. 1114
60-1. ECB53 Parameters .................................................................................................. 1122
60-2. Additional Status Byte 1 and 3 ................................................................................ 1135
60-3. Additional Status Byte 2 and 4 ................................................................................ 1135
60-4. Valve Status No. 1 Overview ................................................................................... 1136
60-5. Valve Status No. 2 Overview ................................................................................... 1137
xxiii
B0193AX – Rev AA Tables
xxiv
Tables B0193AX – Rev AA
xxv
B0193AX – Rev AA Tables
xxvi
Preface
This document, Integrated Control Block Descriptions, provides operational and reference informa-
tion for using I/A Series® control blocks, equipment control blocks (ECBs) and window equip-
ment control blocks (window ECBs).
You use this document to gain detailed knowledge of the operation of each I/A Series Control
block. Using this knowledge, you can determine the correct block to apply to your control
strategy. You configure your control strategy using the InFusion™ Engineering Environment
(IEE), the Integrated Control Configurator (ICC), or the I/A Series Configuration Component
(IACC). While configuring your control strategy, you select the appropriate block, and connect
and/or configure the blocks individual parameters.
Before using this document you should be familiar with the concepts of the I/A Series control sys-
tem. For I/A Series Release V8.0 (L03-2) and later releases, refer to Control Processor 270 (CP270)
Integrated Control Software Concepts (B0700AG). For I/A Series releases prior to Release V8.0
(L03-2), refer to Integrated Control Software Concepts (B0193AW).
NOTE
If you are looking for documentation on a specific Equipment Control Block, refer
to Chapter 27 “Equipment Control Blocks” on page 793 for a complete list of the
appropriate documents for each Equipment Control Block.
NOTE
Distributed Control Interface (DCI) blocks for FOUNDATION™ fieldbus devices
(such as AI, AO, DI, DO, MAI, MAO, MDI and MDO) are provided in Integrated
Control Block Descriptions for FOUNDATION fieldbus Specific Control Blocks
(B0700EC).
Audience
This book is intended for experienced process engineers and application programmers.
Contents
The document is divided into sections. Each section describes one I/A Series block – with the
exception of Equipment Control Blocks (ECBs) and Window Equipment Control Blocks, which
describe multiple blocks of the same basic design.
Each control block section, if required, contains the following:
♦ A brief functional summary.
♦ A list of features and options.
♦ A list and a description of each of the parameters used by the block.
♦ Diagrams illustrating inputs, outputs, options and operation.
xxvii
B0193AX – Rev AA Preface
Revision Information
For this release of the document (B0193AX-AA), the following changes were made to this
volume:
Global
♦Changed all references from “Bit 0 is the least significant bit (starting from the right)”
to “Bit 0 is the least significant, low order bit.”
♦ Removed the “Boolean Connection (B32 to B1)” column and the line “There are no
mnemonic names for the individual bits of ALMOPT” from all descriptions of the
ALMOPT parameter, as ALMOPT is not connectable in any block.
Chapter 31 “ECB4 – Pulse In and Analog Output”
♦ Updated table in FSMM04 parameter description.
Chapter 36 “ECB9 – Remote/Manual”
♦Updated the bit resolutions for the RES09 parameter.
♦ Added the values of FPM09 when used with 200 Series FBMs.
♦ Updated the P13F09 to P16F09 parameters descriptions, as they are not used in
ECB09.
♦ Removed the “10” Dual-bit Code Value from SMPM09 as it is not supported by
ECB09.
Chapter 41 “ECB18 – Intelligent Transmitter 2 (Child)”
♦ Added “Peer-to-Peer Connections of Real-Type Block Inputs” on page 955.
Chapter 41 “ECB18 – Intelligent Transmitter 2 (Child)”
Chapter 44 “ECB22 – Mass Flow Transmitter”
Chapter 60 “ECB74 – Valve and Transmitter Child ECB”
Chapter 67 “EXC – Exception Sequence Block”
Chapter 69 “FFTUNE – Feedforward Tuner Block”
Chapter 73 “IND – Independent Sequence Block”
Chapter 75 “LIM – Limiter Block”
Chapter 76 “LLAG – Lead Lag Block”
Chapter 82 “MDACT Motor Driven Actuator Controller”
Chapter 84 “MON – Monitor Block”
♦ Added a reference to “Peer-to-Peer Connections of Real-Type Block Inputs” on
page 955 to this block’s DELTI1/DELTI2/etc. parameter description.
Chapter 47 “ECB36 – MDACT Pulse Width Tristate”
♦Updated definitions of the EXTYPE and RESMD parameters.
♦ Added the values of FPMMD when used with 200 Series FBMs.
Chapter 48 “ECB38R – Intelligent Transmitter 2 Interface (Redundant Parent)”
xxviii
Preface B0193AX – Rev AA
♦
Updated “Overview” on page 1015 to indicate that AOUTR blocks should be used
with ECB38R instead of AOUT blocks.
Chapter 57 “ECB52 – DPIDA Controller”
♦ Added FBM204 and FBM227 to Figure 57-1.
Chapter 79 “MATH – Mathematics Block”
♦ Updated the RI01 to RI08 parameters’ description.
Chapter 82 “MDACT Motor Driven Actuator Controller”
♦ Updated the ALMOPT parameter description to correct the alarm groups associated
with bits 0-7.
♦ Corrected the CEOPT parameter description to indicate when CEOPT = 1,
MDACT goes into a hold state when CPMEAS experiences peer-to-peer path failure
when CPCONT is configured in the ECB, not when MEASMD is experiencing peer-
to-peer path failure..
♦ Corrected the CPMEAS parameter description to indicate that CPMEAS is a real, not
an integer.
♦ Corrected the ERROR parameter description to indicate that ERROR equals
Setpoint minus Measurement, and not vice versa.
♦ Updated the GAPDBM and REPTMD parameter descriptions.
♦ Corrected the IOM_ID parameter description to indicate that the MDACT block
supports ECB34 and ECB36, not ECB52.
♦ Updated the STRKOP parameter description as STRKOP does not require SE=1 to
run - it works independent of SE.
♦ Removed the incorrect text on fixing the ‘W48 - INVALID BLOCK OPTION’
warning in “PRIBLK and PRITIM Functionality” on page 1598.
Reference Documents
Refer to the following documents for additional information:
♦ Integrated Control Software Concepts (B0193AW) for I/A Series releases prior to V8.0
♦ Control Processor 270 (CP270) Integrated Control Software Concepts (B0700AG) for
I/A Series Release V8.0 and later releases
♦ Supervisory Set Point Control (B0193RY)
♦ Fieldbus Cluster I/O User’s Guide (B0193RB)
♦ Enhanced PLC Block Descriptions (B0193YQ)
♦ Integrated Control Configurator (B0193AV)
♦ I/A Series Configuration Component (IACC) User’s Guide (B0400BP)
♦ Integrated Control Block Descriptions for FOUNDATION fieldbus Specific Control Blocks
(B0700EC)
♦ FOUNDATION fieldbus H1 Interface Module (FBM220/221) User Guide (B0400FD)
♦ Field Device System Integrators (FBM230/231/232/233) User’s Guide (B0700AH)
xxix
B0193AX – Rev AA Preface
xxx
27. Equipment Control Blocks
This chapter provides a list of all the Equipment Control Blocks (ECBs) and identifies the
documents which describe each of these ECBs in detail.
ECB Descriptions
Equipment Control Blocks (ECBs) serve as a “holding place” for their associated device’s
software data. They are executed in the control processor (CP) according to their period and
phase in the block processing cycle (BPC).
Table 27-1 lists the ECBs by number, followed by a brief description. Specific ECB parameters
and parameter descriptions are contained in subsequent chapters. Some ECB descriptions are
contained in their specific subsystem documentation, as shown below.
Most of these documents are available on the I/A Series Electronic Documentation CD-ROM
(part number K0173TQ or K0173WT) and through the IOM Global Customer Support
webpage (http://support.ips.invensys.com).
793
B0193AX – Rev AA 27. Equipment Control Blocks
794
27. Equipment Control Blocks B0193AX – Rev AA
795
B0193AX – Rev AA 27. Equipment Control Blocks
796
27. Equipment Control Blocks B0193AX – Rev AA
NOTE
ECB2 and ECB9 are used with the SPEC 200 Control Integrator, as described in
SPEC 200 Control Integrator User’s Guide (B0193RD).
NOTE
ECB5 and ECB9 are used with the SPEC 200 MICRO Control Integrator as
described in SPEC 200 MICRO Control Integrator User’s Guide (B0193RR).
NOTE
ECB9 is used with the SPEC 200 CCM Control Integrator as described in
SPEC 200 CCM Control Integrator User’s Guide (B0193VU).
797
B0193AX – Rev AA 27. Equipment Control Blocks
NOTE
ECB33 and ECB35 are not used with any equipment at this time; they were origi-
nally scheduled for use in DCS Fieldbus Modules for Fisher PROVOX Series 20
Systems, but these systems now use existing blocks.
798
28. Primary ECB (ECBP or ECB11)
This chapter covers Primary ECB (ECBP or ECB11) and its parameters.
Parameters
Table 28-1. ECBP Parameters
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
799
B0193AX – Rev AA 28. Primary ECB (ECBP or ECB11)
ACTION Equipment Change Action is a packed Boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
Bit 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
BADALM Bad Alarm specifies whether Bad I/O points are alarmed at the System
Monitor level. The BADALM causes the devices in the SMDH to turn
yellow when certain warning conditions exist. BADALM is a bit-mapped
short integer where the bits have the meanings shown in Table 28-2 when
they are set (bits not shown are unused):
800
28. Primary ECB (ECBP or ECB11) B0193AX – Rev AA
BAUD Baud is an indexed, short, integer input that determines the baud rate for
the PIO subsystem. Baud can only be changed by the FBM Configure
function of the Integrated Control Configurator. The index values range
from 0 to 9 and map to the following baud rates.
Value Baud Rate
0 268k
1 76.8k
2 38.4k
3 19.2k
4 9600
5 4800
6 2400
7 1200
8 600
9 300
BUSOPT Bus Switch Option is an indexed, short integer input that determines bus
preference and bus switching capability. BUSOPT can be changed at the
workstation. The index values range from 1 to 4 and map to the following
configurations:
Value Bus Preference Bus Switching
1 A bus only Bus switching is disabled
2 B bus only Bus switching is disabled
3 A bus default Bus switching is enabled
4 B bus default Bus switching is enabled
801
B0193AX – Rev AA 28. Primary ECB (ECBP or ECB11)
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECBP, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the
PARAMETER VALUE” acceptable range.
802
28. Primary ECB (ECBP or ECB11) B0193AX – Rev AA
Message Value
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FIBER Fiber is a settable, non-connectable short integer that indicates the pres-
ence or absence of fiber optic PIO bus cables. It allows for an adjustment
for long turnaround times on long cables. A zero value indicates the
absence of fiber optic cables. When fiber optic cables are present then the
parameter value should be the cable length divided by four kilometers.
This parameter is only used if Bit 1 of the MPOLL parameter is set ((mul-
tiple scanning with one broadcast, MPOLL = 2, 3, 6, or 7).
FIBER is also used with the FoxGuard Manager ECBP.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
I/O writes and certain other messages that require high security use a spe-
cial acknowledge sequence that allows fault-tolerant CPs to compare out-
puts. Optimized Write uses a different acknowledge sequence that retains
the checking but requires fewer messages. This optimization applies only
to writing outputs.
Multipoll Scanning optimization uses a single message to request data
from multiple FBMs. It is not implemented on CP10’s. Multipoll Scan-
ning optimization does not apply to FBMs that support intelligent trans-
mitters. FBMs with EEROM revision levels below 40.1 cannot
communicate with the CP if MPOLL is non-zero. You should update the
EEROM revision level before setting MPOLL to a non-zero value.
803
B0193AX – Rev AA 28. Primary ECB (ECBP or ECB11)
When MPOLL has a value greater than 3, the selective read (SELRD)
option can be configured to optimize communication of measurements to
an FBM request. The FBM returns the data for the channels selected by
bits in the SELRD parameter in the parent FBM’s ECB.
For a definition of Selective Read, see the parameter SELRD in ECB12,
ECB22, ECB23 and ECB38.
For a definition of fiber cable, see the parameter FIBER in this ECB.
PERBSW Periodic Bus Switch specifies the time between automatic PIO bus switch-
ing, in units of Basic Processing Cycles. A negative value disables periodic
bus switching; a positive value enables it.
804
28. Primary ECB (ECBP or ECB11) B0193AX – Rev AA
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
TYPE When you enter “ECB11” or select “ECB11” from the block type list
under Show, an identifying integer is created specifying this block type.
805
B0193AX – Rev AA 28. Primary ECB (ECBP or ECB11)
806
29. ECB1 – Analog Input
This chapter discusses ECB1 (analog input) and provides a functional diagram and
parameters.
Overview
The Equipment Control Block 1 (ECB1) provides the software interface for FBMs which support
analog input signals only. ECB1 is used between the FBMs and the I/O blocks listed in
Figure 29-1. One ECB handles all the analog input signals from one FBM.
Functional Diagram
FBM202
FBM203
AIN
FBM211
ECB1 FBM212
MAIN FBM213
AINR FBM01
FBM02
FBM03
FBM03A
FBM03B
FBM19
FBM33
FBM33A
FBM33B
FBM36
807
B0193AX – Rev AA 29. ECB1 – Analog Input
Parameters
Table 29-1. ECB1 Parameters
Parameter Definitions
ACHNGE A Change is an integer output that is incremented each time a settable
parameter is changed externally. It wraps around from 32767 to -32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
808
29. ECB1 – Analog Input B0193AX – Rev AA
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
809
B0193AX – Rev AA 29. ECB1 – Analog Input
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 errors does not proceed past the first error encountered
by the block logic. For ECB1, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE BLOCK”
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
810
29. ECB1 – Analog Input B0193AX – Rev AA
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
For a list of hardware types for FBM200-299s, refer to DIN Rail Mounted
Subsystem User’s Guide (B0400FA).
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
811
B0193AX – Rev AA 29. ECB1 – Analog Input
Value Status
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains at 11
**** If the BPC is not 2.0 sec. this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
RES01 Resolution 01 for ECB1 is an indexed input that dictates the A/D integra-
tion time and update periods for all channels of ECB1.
For an FBM201, FBM202, FBM203, or FBM211, RES01 values range
from 1 to 5 and map to the values shown below. For an FBM212 or
FBM213, you should use RES01 values of 3 and 4.
812
29. ECB1 – Analog Input B0193AX – Rev AA
.
Res Value Resolution Integration Time Update Time
5 15 bits 50 ms 25 ms
1 15 bits 100 ms 25 ms
2 15 bits 200 ms 25 ms
3 15 bits 500 ms 25 ms
4 15 bits 1000 ms 25 ms
NOTE
To prevent possible aliasing of measurement inputs, set the integration time equal
to or greater than the ECB1 execution time specified by the parameter PERIOD,
which must not be less than the BPC.
ROC1 to ROC16 Rate of Change Limit for Channels 1 through 16 are integer inputs that
specify the threshold for Rate of Change violation in units of normalized
counts per 100 ms. If the normalized A/D channel input experiences a
bipolar Rate of Change violation, the channel status is set BAD. For
example, when ROC1 is used with Last Good Value (LASTGV) in AIN
and MAIN, it allows the best LASTGV available during open circuit con-
ditions. The default value of 0 disables this feature.
There are many FBM types that use ECB1, and they can have 4, 6, 8, 12,
or 16 analog channels. Configure the ROCx values that you need for your
specific FBM. For example, FBM211 has 16 analog channels and requires
ROC1 through ROC16 to show the rate of changes without having a ref-
erence.
813
B0193AX – Rev AA 29. ECB1 – Analog Input
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
For a list of software types for FBM200-299s, refer to DIN Rail Mounted
Subsystem User’s Guide (B0400FA).
TYPE When you enter “ECB1” or select “ECB1” from the block type list under
Show, an identifying integer is created specifying this block type.
814
30. ECB2 – Analog Input and
Analog Output
This chapter covers ECB2 (analog input and output) and provides a functional diagram and
parameters.
Overview
The Equipment Control Block 2 (ECB2) provides the software interface for FBMs which support
both analog input and output signals only. ECB2 is used between the FBMs and the I/O blocks
listed in Figure 30-1. One ECB2 handles all the analog input signals, and a second ECB2 handles
all the analog output signals from one FBM.
Functional Diagram
FBM204
AIN
FBM205(R)
AINR ECB2
FBM04
AOUTR
AOUT FBM05(R)
Parameters
Table 30-1. ECB2 Parameters
815
B0193AX – Rev AA 30. ECB2 – Analog Input and Analog Output
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
816
30. ECB2 – Analog Input and Analog Output B0193AX – Rev AA
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
817
B0193AX – Rev AA 30. ECB2 – Analog Input and Analog Output
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 errors does not proceed past the first error encountered
by the block logic. For ECB2, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE BLOCK”
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FS5D02 to FS8D02
Failsafe, channel 5 to 8 Data, for ECB type 2 is an unsigned integer input
that specifies the fallback value for the channel 5 to 8 output, and is writ-
ten to the fallback value register.
The value represents the D/A raw count and is related to the intended sig-
nal conditioning. For example, if this output is going to a 4 to 20 mA
device (output engineering units range of 0 to 100% is equivalent to a raw
count range of 12800 to 64000), then FS5D02 to FS8D02 is typically
within that range ± 2%.
818
30. ECB2 – Analog Input and Analog Output B0193AX – Rev AA
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth), do not reset this timer.
819
B0193AX – Rev AA 30. ECB2 – Analog Input and Analog Output
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
FSMM02 Failsafe Main Mask, ECB type 02 provides the four bits to the hold/fall-
back register that determine how the four output channels (05, 06, 07,
and 08) respond during Failsafe. If the bit = 1, the output goes to hold and
takes its value from the current value register. If the bit = 0, the output
goes to fallback and assumes the value from the fallback register.
FSMM02 is digitally coded as follows:
CHANNEL NUMBER 08 07 06 05 xx xx xx xx
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
For a list of hardware types for FBM204/FBM205, refer to DIN Rail
Mounted Subsystem User’s Guide (B0400FA).
820
30. ECB2 – Analog Input and Analog Output B0193AX – Rev AA
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
821
B0193AX – Rev AA 30. ECB2 – Analog Input and Analog Output
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
RES02 Resolution ECB2 is an indexed input that dictates the A/D resolution,
integration and update periods for all channels of ECB2.
For an FBM204 or FBM205, RES02 values range from 1 to 5 and map to
the following values.
Res Value Resolution Integration Time Update Time
5 15 bits 50 ms 25 ms
1 15 bits 100 ms 25 ms
2 15 bits 200 ms 25 ms
3 15 bits 500 ms 25 ms
4 15 bits 1000 ms 25 ms
NOTE
To prevent possible aliasing of measurement inputs, set the integration time equal
to or greater than the ECB2 execution time specified by the parameter PERIOD,
which must not be less than the BPC.
ROC1 to ROC4 Rate of Change Limit for Channels 1 through 4 are integer inputs that
specify the threshold for Rate of Change violation in units of normalized
counts per 100 ms. If the normalized A/D channel input experiences a
bipolar Rate of Change violation, the channel status is set BAD. For
example, when ROC1 is used with Last Good Value (LASTGV) in AIN
and MAIN, it allows the best LASTGV available during open circuit con-
ditions. The default value of 0 disables this feature.
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
822
30. ECB2 – Analog Input and Analog Output B0193AX – Rev AA
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
For a list of software types for FBM204/FBM205, refer to DIN Rail
Mounted Subsystem User’s Guide (B0400FA).
TYPE When you enter “ECB2” or select “ECB2” from the block type list under
Show, an identifying integer is created specifying this block type.
823
B0193AX – Rev AA 30. ECB2 – Analog Input and Analog Output
824
31. ECB4 – Pulse In and Analog
Output
This chapter covers ECB4 (pulse in and analog output) providing a functional diagram and
parameters.
Overview
The Equipment Control Block 4 (ECB4) provides the software interface for FBMs which support
pulse input for the FBM206, and pulse input and analog output signals for the FBM06. ECB4 is
used between the FBMs and the I/O blocks listed in Figure 31-1.
Functional Diagram
I/O Block ECB S/W FBM H/W I/O Block ECB S/W FBM H/W
Type Type Type Type Type Type
PULSE IN / ANALOG OUT PULSE INPUT ONLY
MAIN AIN
AOUT
AOUTR
Parameters
Table 31-1. ECB4 Parameters
825
B0193AX – Rev AA 31. ECB4 – Pulse In and Analog Output
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.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit
Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
0 ON_LINE ACTION.B16
1 OFF_LINE ACTION.B15
826
31. ECB4 – Pulse In and Analog Output B0193AX – Rev AA
Bit
Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
2 RUN_DIAG ACTION.B14
3 DOWNLOAD ACTION.B13
4 CALIB1 # ACTION.B12
5 CALIB2 # ACTION.B11
6 UNDECLAR_ECB ACTION.B10
* Bit 0 is the least significant, low order bit.
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
827
B0193AX – Rev AA 31. ECB4 – Pulse In and Analog Output
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 errors does not proceed past the first error encountered
by the block logic. For ECB4, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE BLOCK”
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FS5D04 to FS8D04
Failsafe, channel 5 to 8 Data, for ECB type 4 is an unsigned integer input
that specifies the fallback value for the channel 5 to 8 output, and is writ-
ten to the fallback value register.
The value represents the D/A raw count and is related to the intended sig-
nal conditioning. For example, if this output is going to a 4 to 20 mA
828
31. ECB4 – Pulse In and Analog Output B0193AX – Rev AA
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
829
B0193AX – Rev AA 31. ECB4 – Pulse In and Analog Output
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect Failsafe configuration. Setting FSENAB false does prevent
the FBM from going to the Failsafe state because of a CP-to-FBM communications
failure, but it cannot prevent the FBM from going to Failsafe for any other reason.
FSMM04 Failsafe Mask Main for ECB4 is a short integer value that determines
which of the four analog outputs hold their current value (1 = True =
Hold), and which outputs assume the fallback values specified by the
channel data (0 = False = fallback value). FSMM04 is digitally coded as
follows:
Bit No. Channel No.
7 (MSB) 08
6 07
5 06
4 05
3 xx
2 xx
1 xx
0 (LSB) xx
830
31. ECB4 – Pulse In and Analog Output B0193AX – Rev AA
If the FBM associated with the ECB4, is part of a redundant pair, each of
the bits 4 to 7 must be configured as 0 (that is, fallback to the specified
value), or redundant operation will not be achieved.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
For a list of hardware types for FBM206, refer to DIN Rail Mounted Sub-
system User’s Guide (B0400FA).
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
831
B0193AX – Rev AA 31. ECB4 – Pulse In and Analog Output
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
RES04 Resolution ECB4 is an indexed input that dictates the A/D resolution,
integration and update periods for all channels of ECB4. RES04 values
range from 1 to 4 and map to the following values.
Value Resolution Integration Period Update Time
1 12 bits 100 ms 25 ms
2 13 bits 200 ms 25 ms
3 14 bits 500 ms 25 ms
4 15 bits 1000 ms 25 ms
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
For a list of software types for FBM206, refer to DIN Rail Mounted Sub-
system User’s Guide (B0400FA).
TYPE When you enter “ECB4” or select “ECB4” from the block type list under
Show, an identifying integer is created specifying this block type.
832
32. ECB5 – Digital In,
Sustained/Momentary, and Digital
Out
This chapter covers ECB5 (digital in, sustained/momentary, and digital out), providing a
functional diagram and parameters.
Overview
The Equipment Control Block 5 (ECB5) provides the software interface for FBMs which support
Digital In (DI), Sustained/Momentary (S/M), and Digital Out (DO) signals. ECB5 is used
between the FBMs and the I/O blocks listed in Figure 32-1. One ECB5 handles all the input/out-
put signals from one FBM.
833
B0193AX – Rev AA 32. ECB5 – Digital In, Sustained/Momentary, and Digital
Functional Diagram
242
CIN
MCIN 7A 12A
COUT 7B 12B
MCOUT
8 13
ECB5
9A 14A
9B 14B
MTR 9C 14C
MOVLV 9D 14D
VLV
GDEV 10 15
11 16
20 21
24A 25A
24B 25B
24C 25C
26A 27A
26B 27B
26C 27C
41A 42A
41C 42C
MAIN EXPANDER
834
32. ECB5 – Digital In, Sustained/Momentary, and Digital Out B0193AX – Rev AA
Parameters
Table 32-1. ECB5 Parameters
835
B0193AX – Rev AA 32. ECB5 – Digital In, Sustained/Momentary, and Digital
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
0 ON_LINE ACTION.B16
1 OFF_LINE ACTION.B15
2 RUN_DIAG ACTION.B14
3 DOWNLOAD ACTION.B13
4 CALIB1 # ACTION.B12
5 CALIB2 # ACTION.B11
6 UNDECLAR_ECB ACTION.B10
* Bit 0 is the least significant, low order bit.
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
836
32. ECB5 – Digital In, Sustained/Momentary, and Digital Out B0193AX – Rev AA
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
B9
Bit Number* Boolean Connection
(0 to 31) Description When True (B32 to B1)
0 ECB is on-scan ECBSTA.B32
1 Device is shutdown ECBSTA.B31
2 Device is secured ECBSTA.B30
5 Output point is open ECBSTA.B27
6 Bypass is active ECBSTA.B26
7 Initialization is complete ECBSTA.B25
8 Device is not ready ECBSTA.B24
9 Communications failed ECBSTA.B23
10 Device is out of service (OOS) ECBSTA.B22
11 Device is failed ECBSTA.B21
12 Point(s) are BAD ECBSTA.B20
13 ECB configuration error ECBSTA.B19
14 ECB is undefined ECBSTA.B18
15 ECB is on ECBSTA.B17
* Bit 0 is the least significant, low order bit.
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 errors does not proceed past the first error encountered
by the block logic. For ECB5, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE BLOCK”
837
B0193AX – Rev AA 32. ECB5 – Digital In, Sustained/Momentary, and Digital
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FPE05 Filter Period Expander for ECB5 is an indexed input that specifies the
time period of the digital filter used for debouncing the discrete inputs
from the expander FBM input channels 17 through 32.
For 100 Series FBMs and competitive migration modules, FPE05 values
range from 0 to 3. For 200 Series FBMs and competitive migration mod-
ules with version 1.25H or later firmware, the FPE05 values range from
0 to 4. These values map to the following period values, depending on
whether ECB5 is used with 100 Series or 200 Series FBMs:
FPE05 Period for Period for
Value 100 Series FBMs 200 Series FBMs
0 4 ms No Filtering
1 8 ms 4 ms
2 16 ms 8 ms
3 32 ms 16 ms
4 n/a 32 ms
FPM05 Filter Period Main for ECB5 is an indexed input that specifies the time
period of the digital filter used for debouncing the discrete inputs from the
main FBM input channels 1 through 16.
For 100 Series FBMs and competitive migration modules, FPM05 values
range from 0 to 3. For 200 Series FBMs and competitive migration mod-
ules with version 1.25H or later firmware, the FPM05 values range from
0 to 4. These values map to the following period values, depending on
whether ECB5 is used with 100 Series or 200 Series FBMs:
FPM05 Period for Period for
Value 100 Series FBMs 200 Series FBMs
0 4 ms No Filtering
1 8 ms 4 ms
2 16 ms 8 ms
3 32 ms 16 ms
4 n/a 32 ms
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
838
32. ECB5 – Digital In, Sustained/Momentary, and Digital Out B0193AX – Rev AA
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
FSDE05 Failsafe Data Expansion module for ECB5 is a short value that determines
the fallback values for the digital outputs from the expansion module.
Modules typically have eight digital outputs, while FBM242 has 16 digital
outputs. FSDE05 is digitally coded as follows:
Bit No. Channel No. FBM242 Channel No.
7 25 9
6 26 10
5 27 11
4 28 12
3 29 13
2 30 14
1 31 15
0 (LSB) 32 16
For example, if you want channels 25, 27, 28 and 32 to assume a fallback
value of 1, while channels 26, 29, 30 and 31 assume a fallback value of 0,
then enter the decimal value 177 (FSDE05 = 10110001 = 177).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x”; in this case you would enter 0xB1.
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSDM05 Failsafe Data Main for ECB5 is a short integer value that determines the
fallback value (0 or 1) for the digital outputs from the main module.
Modules typically have eight digital outputs, while FBM242 has 16 digital
outputs. FSDM05 is digitally coded as follows:
Bit No. Channel No. FBM242 Channel No.
7 09 1
6 10 2
839
B0193AX – Rev AA 32. ECB5 – Digital In, Sustained/Momentary, and Digital
For example, if you want channels 09, 11, 12, and 16 to assume a fallback
value of 1 while channels 10, 13, 14 and 15 assume a fallback value of 0,
then enter the decimal value 177 (FSDM05 = 10110001 = 177).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x”; in this case you would enter 0xB1.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
FSME05 Failsafe Mask Expansion for ECB5 is a short value that determines which
of the digital outputs of the expansion module will hold its current value
(1 = True = Hold), and which outputs will assume the fallback values spec-
ified by FSDE05 (0 = False = fallback value). Modules typically have eight
digital outputs, while FBM242 has 16 digital outputs. FSME05 is
digitally coded as follows:
Bit No. Channel No. FBM242 Channel No.
7 25 9
6 26 10
5 27 11
4 28 12
3 29 13
2 30 14
1 31 15
0 (LSB) 32 16
840
32. ECB5 – Digital In, Sustained/Momentary, and Digital Out B0193AX – Rev AA
For example, if you want channels 28, 29, 30 and 32 to assume the fall-
back value in FSDE05, while channels 25, 26, 27 and 31 hold their cur-
rent value, then enter the decimal value 226 (FSME05 = 11100010 =
226).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x”; in this case you would enter 0xE2.
FSMM05 Failsafe Mask Main for ECB5 is a short integer value that determines
which of the digital outputs will hold their current value (1 = True =
Hold), and which outputs will assume the fallback values specified by
FSDM05 (0 = False = fallback value). Modules typically have eight digital
outputs, while FBM242 has 16 digital outputs. FSMM05 is digitally
coded as follows:
Bit No. Channel No. FBM242 Channel No.
7 09 1
6 10 2
5 11 3
4 12 4
3 13 5
2 14 6
1 15 7
0 (LSB) 16 8
For example, if you want channels 12, 13, 14 and 16 to assume the fall-
back value in FSDM05, while channels 09, 10, 11 and 15 hold their cur-
rent value, then enter the decimal value 226 (FSMM05 = 11100010 =
226).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x;” in this case you would enter 0xE2.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
For a list of hardware types for FBM200-299s, refer to DIN Rail Mounted
Subsystem User’s Guide (B0400FA).
841
B0193AX – Rev AA 32. ECB5 – Digital In, Sustained/Momentary, and Digital
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM.
P09E05 to P16E05
Pulse, channels 25 to 32, Expander (Channels 9 to 16 in FBM242), for
ECB Type 5 is a short integer value that, when the channel 25 one-bit
code in SME05 is 1, fixes the length of the momentary pulse. The pulse is
generated when the channel 25 (9 in FBM242) digital output makes a 0
to 1 transition. There is no action on a 1 to 0 transition. The time units
are integer multiples of 10 ms. For example, if a 20 ms pulse is desired,
enter “2.”
The maximum pulse width setting is 255. This yields a 2.5 second (2550
ms) pulse.
P09M05 to P16M05
Pulse, channels 9 to 16, Main (Channels 1 to 8 in FBM242), for ECB
Type 5 is a short integer value that, when the channel 9 one-bit code in
SMM05 is 1, fixes the length of the momentary pulse. The pulse is gener-
ated when the channel 9 (1 in FBM242) digital output makes a 0 to 1
transition. There is no action on a 1 to 0 transition. The time units are
integer multiples of 10 ms. For example, if a 20 ms pulse is desired, enter
“2.”
The maximum pulse width setting is 255. This yields a 2.5 second (2550
ms) pulse.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators or Gate-
ways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
842
32. ECB5 – Digital In, Sustained/Momentary, and Digital Out B0193AX – Rev AA
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SME05 Sustain-Momentary Expander for ECB5 is a short integer value that dic-
tates the output action of each of the eight digital outputs of the expan-
sion FBM. Each of the digital output channels is given a one-bit code.
Modules typically have eight digital outputs, while FBM242 has 16 digital
outputs. SME05 is digitally coded as follows:
Bit No. Channel No. FBM242 Channel No.
7 25 9
6 26 10
5 27 11
4 28 12
3 29 13
2 30 14
1 31 15
0 (LSB) 32 16
843
B0193AX – Rev AA 32. ECB5 – Digital In, Sustained/Momentary, and Digital
NOTE
Do not use this procedure for pulse durations greater than 2.5 sec. Use the COUT
block pulse option parameter, PLSOPT, instead.
! CAUTION
If you configure both the FBM and the COUT block for pulse (momentary) opera-
tion, the results may not be as expected.
SMM05 Sustain-Momentary Main for ECB5 is a short integer value that dictates
the output action of each of the eight digital outputs of the main FBM.
Each of the digital output channels is given a one-bit code. Modules
typically have eight digital outputs, while FBM242 has 16 digital outputs.
SMM05 is digitally coded as follows:
Bit No. Channel No. FBM242 Channel No.
7 09 1
6 10 2
5 11 3
4 12 4
3 13 5
2 14 6
1 15 7
0 (LSB) 16 8
844
32. ECB5 – Digital In, Sustained/Momentary, and Digital Out B0193AX – Rev AA
NOTE
Do not use this procedure for pulse durations greater than 2.5 sec. Use the COUT
block pulse option parameter, PLSOPT, instead.
! CAUTION
If you configure both the FBM and the COUT block for pulse (momentary) opera-
tion, the results may not be as expected.
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
For a list of software types for FBM200-299s, refer to DIN Rail Mounted
Subsystem User’s Guide (B0400FA).
TYPE When you enter “ECB5” or select “ECB5” from the block type list under
Show, an identifying integer is created specifying this block type.
845
B0193AX – Rev AA 32. ECB5 – Digital In, Sustained/Momentary, and Digital
846
33. ECB6 – Sequence of Events
Input
This chapter covers ECB6 (sequence of events input), providing a functional diagram and
parameters.
Overview
The Equipment Control Block 6 (ECB6) provides the software interface for FBMs which support
sequence of events inputs only. ECB6 is used between the FBMs and the I/O blocks listed in
Figure 33-1.
Functional Diagram
SEQUENCE OF EVENTS
I/O BLOCK ECB S/W FBM H/W
Type Type Type
7A 12A
7B 12B
EVENT
20 21
207
MCIN
207b
207c
217
847
B0193AX – Rev AA 33. ECB6 – Sequence of Events Input
Parameters
Table 33-1. ECB6 Parameters
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
848
33. ECB6 – Sequence of Events Input B0193AX – Rev AA
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
849
B0193AX – Rev AA 33. ECB6 – Sequence of Events Input
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 errors does not proceed past the first error encountered
by the block logic. For ECB6, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the accept-
VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE BLOCK”
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
850
33. ECB6 – Sequence of Events Input B0193AX – Rev AA
FPE06 Filter Period Expander for ECB6 is an indexed input that specifies the
time period of the digital filter used for debouncing the discrete inputs
from the expander FBM input channels 17 through 32.
For 100 Series FBMs and competitive migration modules, FPE06 values
range from 0 to 3. For 200 Series FBMs and competitive migration mod-
ules with version 1.25H or later firmware, the FPE06 values range from
0 to 4. These values map to the following period values, depending on
whether ECB6 is used with 100 Series or 200 Series FBMs:
FPE06 Period for Period for
Value 100 Series FBMs 200 Series FBMs
0 4 ms No Filtering
1 8 ms 4 ms
2 16 ms 8 ms
3 32 ms 16 ms
4 n/a 32 ms
FPM06 Filter Period Main for ECB6 is an indexed input that specifies the time
period of the digital filter used for debouncing the discrete inputs from the
main FBM input channels 1 through 16.
For 100 Series FBMs and competitive migration modules, FPM06 values
range from 0 to 3. For 200 Series FBMs and competitive migration mod-
ules with version 1.25H or later firmware, the FPM06 values range from
0 to 4. These values map to the following period values, depending on
whether ECB6 is used with 100 Series or 200 Series FBMs:
FPM06 Period for Period for
Value 100 Series FBMs 200 Series FBMs
0 4 ms No Filtering
1 8 ms 4 ms
2 16 ms 8 ms
3 32 ms 16 ms
4 n/a 32 ms
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
851
B0193AX – Rev AA 33. ECB6 – Sequence of Events Input
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the
following period time lengths. (Integrator and Gateway blocks have differ-
ent period values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
852
33. ECB6 – Sequence of Events Input B0193AX – Rev AA
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB6” or select “ECB6” from the block type list under
Show, an identifying integer is created specifying this block type.
853
B0193AX – Rev AA 33. ECB6 – Sequence of Events Input
854
34. ECB7 – Digital and Pulse Count
In
This chapter covers ECB7 (digital and pulse count out), providing a functional diagram and
parameters.
Overview
The Equipment Control Block 7 (ECB7) provides the software interface for FBMs which support
Digital Input (DI) and Pulse Output signals. ECB7 is used between the FBMs and the I/O blocks
listed in Figure 34-1. One ECB7 handles all the input and output signals from one FBM.
Functional Diagram
AINR 7A 12A
7B 12B
AIN
MAIN 8 13
ECB7
CIN
20 21
MCIN
207
207b
207c
217
217
MAIN EXPANDER
855
B0193AX – Rev AA 34. ECB7 – Digital and Pulse Count In
Parameters
Table 34-1. ECB7 Parameters
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask.
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
856
34. ECB7 – Digital and Pulse Count In B0193AX – Rev AA
Bit
Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
0 ON_LINE ACTION.B16
1 OFF_LINE ACTION.B15
2 RUN_DIAG ACTION.B14
3 DOWNLOAD ACTION.B13
4 CALIB1 # ACTION.B12
5 CALIB2 # ACTION.B11
6 UNDECLAR_ECB ACTION.B10
* Bit 0 is the least significant, low order bit.
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
857
B0193AX – Rev AA 34. ECB7 – Digital and Pulse Count In
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 errors does not proceed past the first error encountered
by the block logic. For ECB7, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the accept-
VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE BLOCK”
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
858
34. ECB7 – Digital and Pulse Count In B0193AX – Rev AA
FPE07 Filter Period Expander for ECB7 is an indexed input that specifies the
time period of the digital filter used for debouncing the discrete inputs
from the expander FBM input channels 17 through 32.
For 100 Series FBMs and competitive migration modules, FPE07 values
range from 0 to 3. For 200 Series FBMs and competitive migration mod-
ules with version 1.25H or later firmware, the FPE07 values range from
0 to 4. These values map to the following period values, depending on
whether ECB7 is used with 100 Series or 200 Series FBMs:
FPE07 Period for Period for
Value 100 Series FBMs 200 Series FBMs
0 4 ms No Filtering
1 8 ms 4 ms
2 16 ms 8 ms
3 32 ms 16 ms
4 n/a 32 ms
FPM07 Filter Period Main for ECB7 is an indexed input that specifies the time
period of the digital filter used for debouncing the discrete inputs from the
main FBM input channels 1 through 16.
For 100 Series FBMs and competitive migration modules, FPM07 values
range from 0 to 3. For 200 Series FBMs and competitive migration mod-
ules with version 1.25H or later firmware, the FPM07 values range from
0 to 4. These values map to the following period values, depending on
whether ECB7 is used with 100 Series or 200 Series FBMs:
FPM07 Period for Period for
Value 100 Series FBMs 200 Series FBMs
0 4 ms No Filtering
1 8 ms 4 ms
2 16 ms 8 ms
3 32 ms 16 ms
4 n/a 32 ms
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
859
B0193AX – Rev AA 34. ECB7 – Digital and Pulse Count In
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
860
34. ECB7 – Digital and Pulse Count In B0193AX – Rev AA
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB7” or select “ECB7” from the block type list under
Show, an identifying integer is created specifying this block type.
861
B0193AX – Rev AA 34. ECB7 – Digital and Pulse Count In
862
35. ECB8 – Ladder Logic or DC
Out/Validated Input
This chapter covers ECB8 (Ladder Logic or DC Out/Validated Input) and provides a
functional diagram and parameters.
Overview
The Equipment Control Block 8 (ECB8) provides the software interface for the FBMs and the
I/O blocks which support ladder logic, as listed in Figure 35-1.
Functional Diagram
LADDER LOGIC
I/O Block ECB S/W FBM H/W
Type Type Type
207
219
241
241b
241c
241d
7A 12A
7B 12B
PLB 8 13
9A 14A
9B 14B
CIN ECB8 9C 14C
9D 14D
10 15
MCIN
11 16
20 21
24A 25A
24B 25B
24C 25C
26A 27A
26B 27B
26C 27C
41A 42A
41C 42C
MAIN EXPANDER
Figure 35-1. ECB8 Diagram
863
B0193AX – Rev AA 35. ECB8 – Ladder Logic or DC Out/Validated Input
Parameters
Table 35-1. ECB8 Parameters
864
35. ECB8 – Ladder Logic or DC Out/Validated Input B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
865
B0193AX – Rev AA 35. ECB8 – Ladder Logic or DC Out/Validated Input
COILTB Coil Table is a 32-element array that contains the ladder coil table.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
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 errors does not proceed past the first error encountered
866
35. ECB8 – Ladder Logic or DC Out/Validated Input B0193AX – Rev AA
by the block logic. For ECB8, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE BLOCK”
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FOFACT Force Off Action is short data store request that drives elements of the coil
table, designated by the force off mask (FOFMSK), to the Off states.
FOFMSK Force Off Mask is a short data store used to specify the particular elements
of the coil table, that are set to the Off state with the force off action
(FOFACT) command.
FONACT Force On Action is a short data store that drives the particular elements of
the coil table, designated by the force on mask (FONMSK), to the On
state.
FONMSK Force On Mask is a short data store used to specify the particular elements
of the coil state to the On state, with the force on action (FONACT)
command.
FPE08 Filter Period Expander for ECB8 is an indexed input that specifies the
time period of the digital filter used for debouncing the discrete inputs
from the expander FBM input channels 17 through 32.
For 100 Series FBMs and competitive migration modules, FPE08 values
range from 0 to 3. For 200 Series FBMs and competitive migration mod-
ules with version 1.25H or later firmware, the FPE08 values range from
0 to 4. These values map to the following period values, depending on
whether ECB8 is used with 100 Series or 200 Series FBMs:
FPE08 Period for Period for
Value 100 Series FBMs 200 Series FBMs
0 4 ms No Filtering
1 8 ms 4 ms
867
B0193AX – Rev AA 35. ECB8 – Ladder Logic or DC Out/Validated Input
FPM08 Filter Period FBM for ECB8 is an indexed input that specifies the time
period of the digital filter used for debouncing the discrete inputs from the
main FBM input channels 1 through 16.
For 100 Series FBMs and competitive migration modules, FPM08 values
range from 0 to 3. For 200 Series FBMs and competitive migration mod-
ules with version 1.25H or later firmware, the FPM08 values range from
0 to 4. These values map to the following period values, depending on
whether ECB8 is used with 100 Series or 200 Series FBMs:
FPM08 Period for Period for
Value 100 Series FBMs 200 Series FBMs
0 4 ms No Filtering
1 8 ms 4 ms
2 16 ms 8 ms
3 32 ms 16 ms
4 n/a 32 ms
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
NOTE
ECB8 fail-safe is not operational when ladder logic is not configured in the associ-
ated FBM.
FSDE08 Failsafe Data Expansion module for ECB8 is a short value that determines
the fallback values for the eight digital outputs from the expansion mod-
ule. FSDE08 is digitally coded as follows:
Bit No. Channel No.
7 25
6 26
5 27
868
35. ECB8 – Ladder Logic or DC Out/Validated Input B0193AX – Rev AA
For example, if you want channels 25, 27, 28 and 32 to assume a fallback
value of 1, while channels 26, 29, 30 and 31 assume a fallback value of 0,
then enter the decimal value 177 (FSDE08 = 10110001 = 177).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x”; in this case you would enter 0xB1.
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSDM08 Failsafe Data Main for ECB8 is a short integer value that determines the
fallback value (0 or 1) for the eight digital outputs from the main module.
FSDM08 is digitally coded as follows:
Bit No. Channel No.
7 09
6 10
5 11
4 12
3 13
2 14
1 15
0 (LSB) 16
For example, if you want channels 09, 11, 12, and 16 to assume a fallback
value of 1 while channels 10, 13, 14 and 15 assume a fallback value of 0,
then enter the decimal value 177 (FSDM08 = 10110001 = 177).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x”; in this case you would enter 0xB1.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
869
B0193AX – Rev AA 35. ECB8 – Ladder Logic or DC Out/Validated Input
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
FSME08 Failsafe Mask Expansion for ECB8 is a short value that determines which
of the eight digital outputs of the expansion module will hold its current
value (1 = True = Hold), and which outputs will assume the fallback values
specified by FSDE08 (0 = False = fallback value). FSME05 is digitally
coded as follows:
Bit No. Channel No.
7 25
6 26
5 27
4 28
3 29
2 30
1 31
0 (LSB) 32
For example, if you want channels 28, 29, 30 and 32 to assume the fall-
back value in FSDE08, while channels 25, 26, 27 and 31 hold their cur-
rent values, then enter the decimal value 226 (FSME08 = 11100010 =
226).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x”; in this case you would enter 0xE2.
FSMM08 Failsafe Mask Main for ECB Type 8 is a short integer value that deter-
mines which of the eight digital outputs will hold it’s current value (1 =
True = Hold), and which outputs will assume the fallback values specified
by FSDM08 (0 = False = fallback value). FSMM08 is digitally coded as
follows:
Bit No. Channel No.
7 09
6 10
5 11
4 12
3 13
870
35. ECB8 – Ladder Logic or DC Out/Validated Input B0193AX – Rev AA
For example, if you want channels 12, 13, 14 and 16 to assume the fall-
back value in FSDM08, while channels 09, 10, 11 and 15 hold their cur-
rent value, then enter the decimal value 226 (FSMM08 = 11100010 =
226).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x;” in this case you would enter 0xE2.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
For a list of hardware types for FBM200-299s, refer to DIN Rail Mounted
Subsystem User’s Guide (B0400FA).
LCODE1 to LCODE5
Ladder Codes 1 through 5 are short data stores that contain a 255-byte
segment of the ladder logic image that gets loaded in an FBM.
LDBASE Ladder Data Base is a short data store that is the PLB monitor realtime
database. LDBASE= PLBSTA + COILTB + REGTBL.
NEWSTA New Status is a short data store that is the desired status change of a
loaded PLB ladder requested by the Status Update command flag
(STAUP).
Bit No. Indicated Operation Status
0 L machine error (LSB)
1 Initialize
2 Single Scan
3 Hold (outputs)
4 Outputs in Failsafe
5 I/O connected
6 Test Mode
7 Run Mode
871
B0193AX – Rev AA 35. ECB8 – Ladder Logic or DC Out/Validated Input
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM.
OVRDIS Override Disable is a boolean input. When true, OVRDIS causes the
FBM ladder logic to regain control of any physical outputs that, at the
time of a communication failure, were overridden by a PLB block that was
in the Manual state.
PLB output overrides are defined by the parameters, MAE_1 to MAE_16.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators or Gate-
ways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
872
35. ECB8 – Ladder Logic or DC Out/Validated Input B0193AX – Rev AA
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PLBDWN PLB Code Download is a short data store that is a request flag to down-
load the L-code.
REFNR Register Reference is a short data store that is an index into the ladder reg-
ister table (see REGTBL) used with REGUP and REGVAL.
REGTBL Register Table Array is a short data store that contains the ladder status
registers. The table consists of 96 elements.
REGUP Register Update Request is a flag that forces a new register value
(REGVAL) and register reference number (REFNR) to be loaded into an
FBM ladder.
REGVAL Register Value is the desired register value that is loaded into an FBM lad-
der upon request via the REGUP parameter.
SIMCIN Simulated CIN is an ECB packed long parameter, representing the CIN
values to be used by the FBM ladder logic, when in simulation mode
(SIMOPT=1).
STAUP Status Update is a request flag that loads a desired FBM ladder status
mode (NEWSTA).
873
B0193AX – Rev AA 35. ECB8 – Ladder Logic or DC Out/Validated Input
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
For a list of software types for FBM200-299s, refer to DIN Rail Mounted
Subsystem User’s Guide (B0400FA).
TYPE When you enter “ECB8” or select “ECB8” from the block type list under
Show, an identifying integer is created specifying this block type.
874
36. ECB9 – Remote/Manual
This chapter covers ECB9 (remote/manual) and provides a functional diagram and
parameters.
Overview
The Equipment Control Block 9 (ECB9) provides the software interface for FBMs which support
analog input and output, and digital input and output signals only. ECB9 is used between the
FBMs and the I/O blocks listed in Figure 36-1.
Functional Diagram
AI / AO / DI / DO
I/O BLOCK ECB S/W FBM H/W
Type Type Type
AIN
AOUT
17A
CIN
17B
COUT
17C
17D
ECB9
MTR 22
MOVLV
VLV
GDEV
AINR
AOUTR
875
B0193AX – Rev AA 36. ECB9 – Remote/Manual
Parameters
Table 36-1. ECB9 Parameters
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
876
36. ECB9 – Remote/Manual B0193AX – Rev AA
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
0 ON_LINE ACTION.B16
1 OFF_LINE ACTION.B15
2 RUN_DIAG ACTION.B14
3 DOWNLOAD ACTION.B13
4 CALIB1 # ACTION.B12
5 CALIB2 # ACTION.B11
6 UNDECLAR_ECB ACTION.B10
* Bit 0 is the least significant, low order bit.
BADRNG Bad Range specifies whether low range error detection is enabled in
FBM17 for the four analog input channels. For each bit, 0 = enable, 1 =
disable.
Bit 0: AI1 (LSB)
Bit 1: AI2
Bit 2: AI3
Bit 3: AI4
Bits 4 to 7: Unused (MSB)
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
877
B0193AX – Rev AA 36. ECB9 – Remote/Manual
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
Bit Number* Boolean Connection
(0 to 31) Description When True (B32 to B1)
0 ECB is on-scan ECBSTA.B32
1 Device is shutdown ECBSTA.B31
2 Device is secured ECBSTA.B30
5 Output point is open ECBSTA.B27
6 Bypass is active ECBSTA.B26
7 Initialization is complete ECBSTA.B25
8 Device is not ready ECBSTA.B24
9 Communications failed ECBSTA.B23
10 Device is out of service (OOS) ECBSTA.B22
11 Device is failed ECBSTA.B21
12 Point(s) are BAD ECBSTA.B20
13 ECB configuration error ECBSTA.B19
14 ECB is undefined ECBSTA.B18
15 ECB is on ECBSTA.B17
* Bit 0 is the least significant, low order bit.
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 errors does not proceed past the first error encountered
by the block logic. For ECB9, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not
compatible with compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
878
36. ECB9 – Remote/Manual B0193AX – Rev AA
Message Value
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE
BLOCK”
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FPM09 Filter Period Main FBM for ECB9 is an indexed input that specifies the
time period of the digital filter used for debouncing the discrete inputs
from the main FBM.
For 100 Series FBMs, FPM09 values range from 0 to 3 and map to the
following period values:
0 = 4 ms
1 = 8 ms
2 = 16 ms
3 = 32 ms
For 200 Series FBMs, FPM09 values range from 0 to 4 and map to the
following period values:
0 = No filtering
1 = 4 ms
2 = 8 ms
3 = 16 ms
4 = 32 ms
FS5D09 to FS6D09
Failsafe, channel 5 to 6 Data, for ECB type 9 is an unsigned integer input
that specifies the fallback value for the channel 5 to 6 output, and is writ-
ten to the fallback value register.
The value represents the D/A raw count and is related to the intended sig-
nal conditioning. For example, if this output is going to a 0 to 10 V device
(output engineering units range of 0 to 100% is equivalent to a raw count
range of 1600 to 64000), then FS5D09 to FS6D09 is typically within that
range ± 2%.
The formula for determining the count value is:
Count Value = ((Eng Value - Low Scale) / (High Scale - Low Scale)) *
Span Count+ Offset Count
For example, for a 0 to 10 V device, determine the count for a fallback
value of 25 percent of full scale:
Count Value = ((25 - 0) / (100 - 0)) * (64000 - 1600) + 1600 =
17200
879
B0193AX – Rev AA 36. ECB9 – Remote/Manual
Fallback values can range from 0 to 65535 counts. You may enter the
value using the decimal or hexadecimal notation. Hexadecimal entry has a
range of 0x0000 to 0xFFFF, representing a decimal range of 0 to 65535.
For decimal entry, the configurator considers this parameter to be a signed
integer. For a value in the range 0 to 32767, enter the count value. For a
value in the range 32768 to 65535, enter the count value minus 65536.
For example, to get a count of 62000, enter -3536.
880
36. ECB9 – Remote/Manual B0193AX – Rev AA
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSDM09 Failsafe Data Main for ECB Type 9 is a short integer input that deter-
mines the fallback value (0 or 1) for the four digital outputs. FSDM09 is
digitally coded as follows:
Bit No. Channel No.
7 11
6 12
5 13
4 14
3 xx
2 xx
1 xx
0 (LSB) xx
For example, if you want channels 11 and 13 to fall back to the value 1,
and channels 12 and 14 to fall back to 0, then enter 160 (the decimal
value for the binary 10100000).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x”. In this case you would enter 0xA0.
NOTE
Be careful. The position of the digital output data bits in the Failsafe Data parame-
ter FSDM09 is not the same as the mask bits in the Failsafe Mask parameter
FSMM09.
881
B0193AX – Rev AA 36. ECB9 – Remote/Manual
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
FSMM09 Failsafe Mask Main for ECB9 is a short input that specifies the failsafe
action taken during FBM failsafe mode for the 2 AOs and the 4 DOs. (1=
True=Hold and 0=False=fallback value). FSMM09 is coded as follows:
Bit No. Channel No.
7 xx
6 xx
5 06
4 05
3 11
2 12
1 13
0 (LSB) 14
NOTE
Be careful. The position of the digital output data bits in the Failsafe Data parame-
ter FSDM09 is not the same as the mask bits in the Failsafe Mask parameter
FSMM09.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
882
36. ECB9 – Remote/Manual B0193AX – Rev AA
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM.
P13F09 to P16F09
These parameters are not used.
P13N09 to P16N09
For ECB09, P13N09 refers to channel 11 rather than channel 13, and so
forth.
Pulse, Channel 11, On Time for ECB9 is a short input that when the
channel 11 dual-bit code is 01, fixes the length of the momentary pulse.
The pulse is generated when the channel 11 digital output makes a 0 to 1
transition. There is no action on a 1 to 0 transition. The time units are
integer multiples of 10 ms; i.e., if a 20 ms pulse is desired, enter “2.”
When the channel 11 dual-bit code is 10, P13N09 fixes the length of the
active portion of the pulse cycle. P13F09 fixes the length of the inactive
portion. The pulse train is initiated when the Channel 11 digital output
makes a 0 to 1 transition. The number of pulses in the train are deter-
mined by an analog input. There is no action on a 1 to 0 transition. The
time units are integer multiples of 10 ms; that is, if a 20 ms pulse is
desired, enter “2.”
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators or Gate-
ways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
883
B0193AX – Rev AA 36. ECB9 – Remote/Manual
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
RES09 Resolution ECB9 values are indexed inputs that dictate the A/D resolu-
tion, integration and update periods for all channels of ECB9. RES09 val-
ues range from 1 to 4 and map to the following values.
Resolution for Resolution for Integration Update
Value 100 Series FBMs 200 Series FBMs Period Time
1 12 bits 15 bits 100 ms 10 ms
2 13 bits 15 bits 200 ms 10 ms
3 14 bits 15 bits 500 ms 25 ms
4 15 bits 15 bits 1000 ms 50 ms
NOTE
To prevent possible aliasing of measurement inputs, set the integration time equal
to or greater than the ECB9 execution time specified by the parameter PERIOD,
which must not be less than the BPC.
ROC1 to ROC4 Rate of Change Limit for Channels 1 through 4 are integer inputs that
specify the threshold for Rate of Change violation in units of normalized
counts per 100 ms. If the normalized A/D channel input experiences a
bipolar Rate of Change violation, the channel status is set BAD. For
example, when ROCx is used with Last Good Value (LASTGV) in AIN
884
36. ECB9 – Remote/Manual B0193AX – Rev AA
and MAIN, it allows the best LASTGV available during open circuit con-
ditions. The default value of 0 disables this feature.
SMPM09 Sustain-Momentary-Pulse Mask for ECB9 is a short integer value that dic-
tates the output action of each of the four digital outputs. Each of the four
digital output channels is given a two-bit code. SMPM09 is digitally
coded as follows:
Bit Nos. Channel No.
7 and 6 11
5 and 4 12
3 and 2 13
1 and 0 (LSB) 14
Each channel’s dual-bit code decodes to the actions listed below: Dual bit
codes of 10 are not supported:
Dual-bit
Code Value Action
00 Output is sustained at appropriate logic level.
01 Output is momentary (see P13N09 for duration).
10 Reserved
11 Reserved
For example, if channels 11 and 12 are to have pulse train outputs, while
channel 13 is to have momentary outputs and channel 14 is to have sus-
tained output, then enter the decimal value 164 (bits 7, 5, and 2 = true).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x;” in this case you would enter 0xA4.
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB9” or select “ECB9” from the block type list under
Show, an identifying integer is created specifying this block type.
885
B0193AX – Rev AA 36. ECB9 – Remote/Manual
886
37. ECB11 (ECBP, Primary ECB)
This chapter covers ECB11 (ECBP, Primary ECB) and its parameters.
Parameters
Table 37-1. ECB11 Parameters
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to
-32768.
887
B0193AX – Rev AA 37. ECB11 (ECBP, Primary ECB)
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
BIT 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
BADALM Bad Alarm specifies whether Bad I/O points are alarmed at the System
Monitor level. The BADALM causes the devices in the SMDH to turn
yellow when certain warning conditions exist. BADALM is a bit-mapped
short integer where the bits have the meanings shown in Table 37-2 when
they are set (bits not shown are unused):
888
37. ECB11 (ECBP, Primary ECB) B0193AX – Rev AA
BAUD Baud is an indexed, short, integer input that determines the baud rate for
the PIO subsystem. Baud can only be changed by the FBM Configure
function of the Integrated Control Configurator. The index values range
from 0 to 9 and map to the following baud rates.
Value Baud Rate
0 268k
1 76.8k
2 38.4k
3 19.2k
4 9600
5 4800
6 2400
7 1200
8 600
9 300
BUSOPT Bus Switch Option is an indexed, short integer input that determines bus
preference and bus switching capability. BUSOPT can be changed at the
workstation. The index values range from 1 to 4 and map to the following
configurations:
Value Bus Preference Bus Switching
1 A bus only Bus switching is disabled
2 B bus only Bus switching is disabled
3 A bus default Bus switching is enabled
4 B bus default Bus switching is enabled
BUSSEL Bus Selection is a character data store. BUSSEL commands the PIO pri-
mary to initialize its PIO communications over the specified PIO BUS.
= [A | B]
where:
A = Select bus A
B = Select bus B
BUSTYP Bus Type is a character input that determines whether the standard ports
or the modem port are used. Enter “R” to select the RS485 standard port,
or “M” to select the RS232 Modem port. BUSTYP can be changed only
by the FBM Configure function of the Integrated Control Configurator.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
889
B0193AX – Rev AA 37. ECB11 (ECBP, Primary ECB)
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
B9
Bit Number* Boolean Connection
(0 to 31) Description When True (B32 to B1)
0 ECB is on-scan ECBSTA.B32
1 Device is shutdown ECBSTA.B31
2 Device is secured ECBSTA.B30
5 Output point is open ECBSTA.B27
6 Bypass is active ECBSTA.B26
7 Initialization is complete ECBSTA.B25
8 Device is not ready ECBSTA.B24
9 Communications failed ECBSTA.B23
10 Device is out of service (OOS) ECBSTA.B22
11 Device is failed ECBSTA.B21
12 Point(s) are BAD ECBSTA.B20
13 ECB configuration error ECBSTA.B19
14 ECB is undefined ECBSTA.B18
15 ECB is on ECBSTA.B17
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 errors does not proceed past the first error encountered
by the block logic. For ECB11, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
890
37. ECB11 (ECBP, Primary ECB) B0193AX – Rev AA
FIBER Fiber is a short integer that indicates the presence or absence of fiber optic
PIO bus cables. It allows for an adjustment for long turnaround times on
long cables. A zero value indicates the absence of fiber optic cables. When
fiber optic cables are present then the parameter value should be the cable
length divided by four kilometers. This parameter is only used if Bit 1 of
the MPOLL parameter is set ((multiple scanning with one broadcast,
MPOLL = 2, 3, 6, or 7).
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
MPOLL Multipoll is a short integer option that defines optimization options for
Fieldbus scanning, as follows:
Value Field Bus Scanning optimization Option
0 No optimization.
1 Enable Optimized Write.
2 Enable Multipoll Scanning of up to four FBMs with one broad-
cast message.
3 Enable Optimized Write and Multipoll Scanning.
4 Enable Selective Read for FBM18, FBM38, and FBM39.
5 Enable Optimized Write and Selective Read.
6 Enable Multipoll Scanning and Selective Read.
7 Enable Optimized Write, Multipoll Scanning, and Selective
Read. Seven is the default value.
I/O writes and certain other messages that require high security use a spe-
cial acknowledge sequence that allows fault-tolerant CPs to compare out-
puts. Optimized Write uses a different acknowledge sequence that retains
the checking but requires fewer messages. This optimization applies only
to writing outputs.
Multipoll Scanning optimization uses a single message to request data
from multiple FBMs. It is not implemented on CP10’s. Multipoll Scan-
ning optimization does not apply to FBMs that support intelligent trans-
mitters. FBMs with EEROM revision levels below 40.1 cannot
communicate with the CP if MPOLL is non-zero. You should update the
EEROM revision level before setting MPOLL to a non-zero value.
When MPOLL has a value greater than 3, the selective read (SELRD)
option can be configured to optimize communication of measurements to
an FBM request. The FBM returns the data for the channels selected by
bits in the SELRD parameter in the parent FBM’s ECB.
For a definition of Selective Read, see the parameter SELRD in ECB12,
ECB22, ECB23 and ECB38. For a definition of fiber cable, see the
parameter FIBER in this ECB.
891
B0193AX – Rev AA 37. ECB11 (ECBP, Primary ECB)
NRBUS Number of Bus is a short integer input that specifies the number of PIO
busses in the network. Enter “1” or “2.” NRBUS can only be changed by
the FBM Configure function of the CIO Configurator.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
PERBSW Periodic Bus Switch specifies the time between automatic PIO bus switch-
ing, in units of Basic Processing Cycles. A negative value disables periodic
bus switching; a positive value enables it.
892
37. ECB11 (ECBP, Primary ECB) B0193AX – Rev AA
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
TYPE When you enter “ECB11” or select “ECB11” from the block type list
under Show, an identifying integer is created specifying this block type.
893
B0193AX – Rev AA 37. ECB11 (ECBP, Primary ECB)
894
38. ECB12 – Intelligent
Transmitter 2 Interface
This chapter covers the ECB12 (Intelligent Transmitter 2 Interface) and provides a functional
diagram and parameters.
Overview
The Equipment Control Block 12 (ECB12) provides the software interface for FBM18 and
FBM43, which control Intelligent Transmitters (ITs) such as 820/860 Series and Intelligent Pres-
sure Transmitters, RTT10 Temperature Transmitter, IMT10/20/25 Magnetic Flowmeters, and
Vortex Flowmeters. As shown in Figure 38-1, ECB12 is a parent IT ECB that may be used in
conjunction with ECB18, which is also used for these ITs. When used with FBM43, ECB12 sup-
ports dual baud rate communications.
Functional Diagram
(CHILD) AINR
(CHILD)
895
B0193AX – Rev AA 38. ECB12 – Intelligent Transmitter 2 Interface
Parameters
Table 38-1. ECB12 Parameters
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask.
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
896
38. ECB12 – Intelligent Transmitter 2 Interface B0193AX – Rev AA
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
897
B0193AX – Rev AA 38. ECB12 – Intelligent Transmitter 2 Interface
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 errors does not proceed past the first error encountered
by the block logic. For ECB12, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
898
38. ECB12 – Intelligent Transmitter 2 Interface B0193AX – Rev AA
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
* If the BPC is 0.2 sec. this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec. this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
899
B0193AX – Rev AA 38. ECB12 – Intelligent Transmitter 2 Interface
*** If the BPC is 0.5 sec. this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec. this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, and CP40B only.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SECURE Secure Protocol is a boolean option, that acts as a flag to select Secure Pro-
tocol name checking (that is, DevNam) on the transmitter.
0 = Do not use secure protocol on the transmitter bus
1 = Use secure protocol on the transmitter bus
SELRD Selective Read is a configurable packed long parameter that allows you to
specify which channels from intelligent field devices require real time
scanning. Maximum optimization for FBMs that support intelligent
transmitters also requires configuring the MPOLL parameter in the ECBP
(ECB11) appropriately.
SELRD is a bit mask. The working part of SELRD is three bytes long. All
24 channels are selected by 0xFFFFFF or -1 (the default). Each of the
three bytes, defined by a pair of hexadecimal digits, is associated with one
of the three measurements (aux2, aux1 and primary) potentially available
from the transmitter. The format of the mask is 0x2211PP where: 22
selects aux2, 11 selects aux1, and pp selects the primary. Within each byte,
channel 1 is represented by the high order bit of SELRD, with the remain-
ing channels following left to right.
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
C10
C11
C12
C13
C14
C15
C16
C17
C18
C19
C20
C21
C22
C23
C24
C25
C26
C27
C28
C29
C30
C31
C32
C1
C2
C3
C4
C5
C6
C7
C8
C9
900
38. ECB12 – Intelligent Transmitter 2 Interface B0193AX – Rev AA
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB12” or select “ECB12” from the block type list
under Show, an identifying integer is created specifying this block type.
Application Example
This section provides information for the relationship amongst parent ECBs (ECB12), child
ECBs (ECB18), and Analog Input blocks.
FBM18 and FBM43 (Points 1-24) provide Intelligent Field Device inputs for AIN, AINR, and
MAIN blocks.
Figure 38-2 shows an example of these blocks used in an application. If ECB18 is built during
configuration/definition, then the parameter PARENT in ECB18 is the same as the parameter
DEV_ID of the parent ECB (ECB12). In the ECB12, DEV_ID is the FBM18 letterbug. Note
that ECB18, rather than ECB12, is the Window ECB. Also note that the child ECB (ECB18)
does not have to be in the same compound as the parent ECB.
ECB12CMP = Compound
Must be pathname Name for parent
Compound:name
Analog Input Block unless parent is in ECB Parent Channel 3
Compound_ECB,
AIN then can be NAME ECB12 FBM18
parameter
NAME = AINTT NAME = IT01
TYPE = AIN TYPE = ECB12
IOMOPT = 1 DEV_ID = FM1801
IOM_ID = ECB12CMP:IT01 HWTYPE = 18 FM180
PNT_NO = 3 SWTYPE = 12 Letterbug
SCI = 0
ECB Child
CHAN is always 1- 8
ECB18 IT2
Primary measurement is
equal to CHAN
First auxiliary measurement NAME = TT1324
is 9 - 16. TYPE = ECB18
Second auxiliary measurement DEV_ID = TEMP01 Parent name parameter
is 17 - 24. PARENT = IT01 only when parent is in
CHAN = 3 Compound:ECB
901
B0193AX – Rev AA 38. ECB12 – Intelligent Transmitter 2 Interface
902
28. ECB13 – Hydrostatic Tank
Gauge
This chapter gives a general overview of the ECB13 (Hydrostatic Tank Gauge), providing
functional and I/O diagrams and describing its features, parameters, and detailed operations.
Overview
The Hydrostatic Tank Gauge (HTG) Equipment Control Block (ECB13) is a Window ECB sup-
porting the Hydrostatic Tank Gauge. It directly receives HTG measurement values, status condi-
tions, and selected configuration data for input to process monitoring (see Figure 38-3). Window
ECBs share a fundamental design described in detail in Window ECBs in the appropriate Inte-
grated Control Software Concepts document (B0700AG or B0193AW).
Real-Time
Measurements 1 to 24 Input Points 1 to 24
Real-Time Status Status Words 1 to 9
As shown in Figure 38-3, the ECB13 dynamic data consists of up to 24 tank measurements and 9
status inputs. Non-dynamic data includes alarm setpoints, I/O names, system select parameters,
and maintenance data (letterbug, alias, and so forth). A default I/A Series display with several lev-
els of detail can be used. A group of HTGs can be supervised through a Tank Farm display.
The ECB13 does not generate process alarms, but provides the output parameters for other blocks
to generate them. Selected alarm setpoints can be adjusted by the operator through the window
ECB display without entering the IFD environment. An HTG support compound is provided. A
typical, full-featured HTG support compound consists of 13 Measurement alarm blocks, 14 state
alarm blocks, and a variable number of message blocks.
ECB13 options include a security feature for selected actions, and last good value retention.
903
B0193AX – Rev AA 28. ECB13 – Hydrostatic Tank Gauge
Functional Diagram
ECB13 is used between the FBM and the I/O blocks listed in Figure 38-4.
MAIN
Features
The features are:
♦ Up to 24 input points for monitoring the process
♦ Bypass option for manual manipulation of individual measurements for control
simulation
♦ Alarm setpoints and names for engineering units for connection to local alarm blocks
♦ A number of status conditions (general, alarm, and hardware) and contact input
names for connection to local alarm and message blocks
♦ Settable (enable/disable) alarm detection controls (mass deviation alarm, autho-
rized/unauthorized movement alarm, density rate-of-change alarm, flow rate alarm)
♦ Settable (allow/disallow) product inbound and outbound movements
♦ Settable high and low flow setpoints
♦ Bad measurement detection
The options are:
♦ Security option for selected actions
♦ Last good value retention
Parameters
Table 38-2. ECB13 Parameters
904
28. ECB13 – Hydrostatic Tank Gauge B0193AX – Rev AA
905
B0193AX – Rev AA 28. ECB13 – Hydrostatic Tank Gauge
906
28. ECB13 – Hydrostatic Tank Gauge B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
907
B0193AX – Rev AA 28. ECB13 – Hydrostatic Tank Gauge
Bit
Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
0 ON_LINE ACTION.B16
1 OFF_LINE ACTION.B15
2 RUN_DIAG ACTION.B14
3 DOWNLOAD ACTION.B13
4 CALIB1 # ACTION.B12
5 CALIB2 # ACTION.B11
6 UNDECLAR_ECB ACTION.B10
* Bit 0 is the least significant, low order bit.
ALMHP1 to ALMHP3
High Pressure Alarm Setpoint for Transmitters 1 through 3 are real out-
puts.
ALMHT1 to ALMHT3
High Temperature Alarm Setpoint for Sensors 1 through 3 are real
outputs.
ALMLP1 to ALMLP3
Low Pressure Alarm Setpoint for Transmitters 1 through 3 are real
outputs.
ALMLT1 to ALMLT3
Low Temperature Alarm Setpoint for Sensors 1 through 3 are real outputs.
908
28. ECB13 – Hydrostatic Tank Gauge B0193AX – Rev AA
ALMST1 to ALMST2
Alarm Status for WORD 1 and WORD 2 are packed boolean outputs.
ASSEL Set Alarm Select is a packed boolean output that is the shadow parameter
for the two high-order bytes of SELALM.
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
BYPS32 Bypass 32 governs point value bypassing. If a particular bit of the parame-
ter is set then the value and status are not copied from the device value
into the point value. The high order bit controls bypass of the first param-
eter in the list.
DAUXRE Device Value for the Auxiliary Reference Density is a real output.
909
B0193AX – Rev AA 28. ECB13 – Hydrostatic Tank Gauge
DDENRO Device Value for the Density Rate of Change is a real output.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV01 to DEV03
Device Descriptors 1 to 3 are used in ECB13 to support HTG applica-
tions. They are settable strings of up to 32 characters.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
DLEVEL Device Value for the Level of the Product is a real output.
DPRESS1 to DPRESS3
Device Value for Pressures 1 through 3 are real outputs.
DTEMP1 to DTEMP3
Device Value for Sensor Temperatures 1 through 3 are real outputs.
910
28. ECB13 – Hydrostatic Tank Gauge B0193AX – Rev AA
DVAPSG Device Value for the Vapor Specific Gravity is a real output.
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECB13, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
911
B0193AX – Rev AA 28. ECB13 – Hydrostatic Tank Gauge
Message Value
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
GENST1 to GENST2
General Status of word 1 and word 2 are packed boolean outputs.
912
28. ECB13 – Hydrostatic Tank Gauge B0193AX – Rev AA
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
LABSTA Lab Status is used in ECB13 for HTG applications. It is an integer output
value.
LEGST1 to LEGST2
Legal Status for word 1 and word 2 are packed boolean outputs.
LSTG32 Last Good Value 32 is a packed long value which is bit-mapped to the
ECB13 measurement parameters. The most significant bit of LSTG32
maps to the first point, the next most significant bit maps to the second
point, and so on. If a bit is set and the corresponding device value is Out-
of-Service or Bad, then only the status of the device value is copied into
the status of the point value, and the last good value of the point value is
preserved.
913
B0193AX – Rev AA 28. ECB13 – Hydrostatic Tank Gauge
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
914
28. ECB13 – Hydrostatic Tank Gauge B0193AX – Rev AA
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, and CP40B only.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PRESS1 to PRESS3
Pressure 1 through 3 are real outputs.
SELALM Alarm Select is a packed boolean data store for HTG database configura-
tion parameter (#2).
SELDSP Display Select is a packed boolean data store for HTG database configura-
tion parameter (#3).
SEL_HW Select Hardware is a packed boolean data store for the HTG database con-
figuration.
SIGNIF Number of Significant Bits to be Displayed is a short integer data store for
HTG database configuration parameter (digit 7 in #2).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
915
B0193AX – Rev AA 28. ECB13 – Hydrostatic Tank Gauge
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TEMP1 to TEMP3
Sensor Temperatures 1 through 3 are real outputs.
TYPE When you enter “ECB13” or select “ECB13” from the block type list
under Show, an identifying integer is created specifying this block type.
UPLREQ Upload Request is a boolean input (0 = false; 1 = true). When set to 1, the
ECB, through the PIOMAINT, will initiate the HIU (HTG Interface
Unit) or FBP10 database upload procedure to update the ECB non-
dynamic data. When the upload is done, UPLREQ is reset to 0.
WRTLCK Write Lock, when true, causes the ECB to delay any write down requests.
916
28. ECB13 – Hydrostatic Tank Gauge B0193AX – Rev AA
Detailed Operation
ECB13 is a Window ECB supporting the Hydrostatic Tank Gauge. It directly receives HTG mea-
surement values, status conditions, and selected configuration data for input to process monitor-
ing. ECB13 operates in conformance with the general Window ECB design philosophy. For more
details, see “General Window ECB Concepts” in the appropriate Integrated Control Software Con-
cepts document (B0700AG or B0193AW).
HTG Support
Key Parameters: All (See Table 38-2)
The ECB13 dynamic data consists of up to 24 tank measurements and 9 status inputs.
The ECB13 operates in conformance with the general Window ECB design philosophy. For
more details, see “General Window ECB Concepts” in the appropriate Integrated Control Software
Concepts document (B0700AG or B0193AW).
The ECB13 supports its parameters by communicating directly with the Hydrostatic Tank Gauge
(HTG) Interface Unit (HIU). All HTG measurements and contact point status indicators are
ECB parameters. Each point has two associated parameters controlled by a third to support simu-
lation: DEVICE_VALUE (data always from the device and always secured), POINT_VALUE
(the connection point for the CP), and the BYPASS switch, which controls whether
POINT_VALUE is set by DEVICE_VALUE or manually from the I/A Series Display.
The parameter LSTG32 controls the last good value functionality of the POINT_VALUES, with
the most significant bit of LSTG32 controlling Point 1, and so forth.
The points correspond to the HIU Measurements in Table 38-3.
917
B0193AX – Rev AA 28. ECB13 – Hydrostatic Tank Gauge
Flow Rate Alarm setpoints are set through two settable parameters, ALMMFL and ALMLFL.
The following HIU parameters can be set directly from the I/A Series display:
♦ Inbound/Outbound Movement allowed/not allowed.
♦ Mass Deviation Alarm and Unauthorized Movement Alarm enable/disable.
♦ Flow Rate Alarm enable/disable.
♦ Flow Rate Alarm setpoint HI/LO.
Hardware faults reported in the display include:
♦ Calibration error
♦ Database error
♦ Sensor Power Lost
♦ Pressure P1, P2, or P3 Lost
♦ Temperature T1, T2, or T3 Lost
♦ RTD Lost
♦ Enclosure Temperature Lost
♦ Level Mismatch.
To collect real time data from the instrument to send on to the CP, the Input Scanner:
1. Requests the data from the HIU and uses the I/O buffer to store received data.
2. Calls a specific HTG function to process received data by:
a. Updating the values and status of the ECB outputs.
b. Working out the bypass and last good value retention logic.
c. Taking remedial actions if there is an HIU/HTG status change or communication
problem.
Since the HIU has a completely self-contained control algorithm in its hardware, the only real
time output points (from the CP to the ECB13) consist of a subset of parameters which the user
can set from the display:
♦ ASSEL, a shadow output for the SEALM bit fields settable from the operator’s display
♦ ALMHFL, the high flow rate alarm limit
♦ ALMLFL, the low flow rate alarm limit.
918
28. ECB13 – Hydrostatic Tank Gauge B0193AX – Rev AA
Mirroring the behavior of the Input Scanner, the Output Scanner calls an ECB function to fill an
output buffer and then sets the NEED_OUTPUT flag. Upon a response from the HIU, another
ECB function stores the actual device values into the output ECB parameters.
HTG states and status conform to the window ECB model and utilize the standard window ECB
parameters.
Apart from the complete upload effected by the initialization procedure, the ECB13 always
reflects the most recent changes in the HIU database.
Alarming
Key Parameters: ALM_HD, ALM_HL, ALM_HT, ALM_LD, ALM_LL, ALM_LT, ALM_MD,
ALMDRC, ALMHFL, ALMHHL, ALMHP1 to ALMHP3, ALMHT1 to ALMHT3, ALM-
HWC, ALMLFL, ALMLP1 to ALMLP3, ALMLT1 to ALMLT3, ALMLWC, ALMST1 to
ALMST2
The ECB13 does not generate process alarms itself, but is connected through its outputs to alarm
blocks which do generate process alarms. The outputs are inputs into Alarm blocks which reside
in a generic compound used to initiate alarming. This enables you to customize the HIU alarm-
ing to your own needs. HTG hardware faults generate system messages on the system printer.
Alarm setpoints include:
♦ High-high levels (ALMHHL)
♦ High and low levels (ALM_HL and ALM_LL)
♦ Liquid temperature high and low (ALM_HT and ALM_LT)
♦ High and low density (ALM_HD and ALM_LD)
♦ High and low water level (ALMHWC and ALMLWC)
♦ High and low transmitter temperatures (ALMHT1 to ALMHT3 and ALMLT1 to
ALMLT3)
♦ High and low transmitter pressures (ALMHP1 to ALMHP3 and ALMLP1 to
ALMLP3)
♦ High and low product flow (ALMHFL and ALMLFL)
♦ Rate-of-change of product density (ALMDRC)
♦ Mass deviation (ALM_MD).
For information on ECB13 alarming, refer to the section “HTG Support Compound Structure”
in Measurement Integration (B0193RA).
919
B0193AX – Rev AA 28. ECB13 – Hydrostatic Tank Gauge
920
29. ECB14 – Panel-Mounted
Display
This chapter covers the ECB14 (Panel-Mounted Display), providing a functional diagram and
parameters.
Overview
The Equipment Control Block 14 (ECB14) provides the software interface for the Panel
Mounted Display. ECB14 is used between the Panel Display Station and the DSI block, as shown
in Figure 38-5. One ECB14 handles all the analog input signals from one Panel Display Station.
Functional Diagram
DSI ECB14 DS
Parameters
Table 38-4. ECB14 Parameters
921
B0193AX – Rev AA 29. ECB14 – Panel-Mounted Display
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
922
29. ECB14 – Panel-Mounted Display B0193AX – Rev AA
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
COLID1 to COLID3
Column Identifiers 1 through 3 are nine-character strings that identify the
parameters assigned to the Column 1 through 3 Displays. The Display
Station presents these identifiers on the first row of characters (the
Selected Identifier Display) at the top of the front panel when Columns 1,
2, or 3 is the selected variable.
DECPL1 to DECPL3
Decimal Placement for Columns 1 through 3 are short integers that set
the number of decimal places in the Column 1 through 3 Displays. They
also fix the resolution of the Selected Value Display. DECPL1 to DECPL3
have a range of 0 to 3. Enter 0 to obtain a displayable range of -9999 to
9999 and a resolution of 1.0. Enter 3 to obtain a displayable range of -
0.999 to 9.999 and a resolution of 0.001.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
923
B0193AX – Rev AA 29. ECB14 – Panel-Mounted Display
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
B9
Bit Number* Boolean Connection
(0 to 31) Description When True (B32 to B1)
0 ECB is on-scan ECBSTA.B32
1 Device is shutdown ECBSTA.B31
2 Device is secured ECBSTA.B30
5 Output point is open ECBSTA.B27
6 Bypass is active ECBSTA.B26
7 Initialization is complete ECBSTA.B25
8 Device is not ready ECBSTA.B24
9 Communications failed ECBSTA.B23
10 Device is out of service (OOS) ECBSTA.B22
11 Device is failed ECBSTA.B21
12 Point(s) are BAD ECBSTA.B20
13 ECB configuration error ECBSTA.B19
14 ECB is undefined ECBSTA.B18
15 ECB is on ECBSTA.B17
ENGUN1 to ENGUN3
Engineering Units for Columns 1 through 3 are four-character string that
are displayed as the last four characters on the second row of characters
(the Selected Value Display) when Columns 1, 2, or 3 are the selected
variable. The first five characters on this row display the value.
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 errors does not proceed past the first error encountered
by the block logic. For ECB14, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
924
29. ECB14 – Panel-Mounted Display B0193AX – Rev AA
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
925
B0193AX – Rev AA 29. ECB14 – Panel-Mounted Display
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
LRV1 to LRV3 Lower Range Value for Columns 1 through 3 are integers that specify the
base value for the Columns 1 through 3 Displays, and limit values for the
Selected Value Displays. Allowable range is from -9999 to +9999. The
decimal position is set by the DECPL1 to DECPL3 parameters.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
926
29. ECB14 – Panel-Mounted Display B0193AX – Rev AA
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B only.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
RES14 Resolution 14 is a short integer input that dictates the fault tolerant
action. A value of zero disables fault tolerance. Enter 128 (or 0x80 for 80
Hex) to enable fault tolerance.
RMPTIM Ramping Timeout Time is a short integer that indicates the length of time
(in 0.1 seconds) after the last UP or DOWN ARROW key depression,
that the lower alphanumeric display shows the local value before it reverts
to the most recent value from the Unit Controller. For example, if RMP-
TIM equals 20 (default value) the display reverts to the most recent UC
block value after the ramping keys have been inactive for 2.0 seconds. The
local value is equal to the last received block value from the UC prior to
the start of ramping plus the accumulated ramping, and/or jogging, incre-
ments.
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TICK1 to TICK3 Tick/Bar Selector for Column 1 through 3 Displays are short integers that
tells the Display Station whether the column is to have a bargraph display
(for example, TICK1 = 2) or a single value tick display (for example,
TICK1 = 0).
TYPE When you enter “ECB14” or select “ECB14” from the block type list
under Show, an identifying integer is created specifying this block type.
927
B0193AX – Rev AA 29. ECB14 – Panel-Mounted Display
URV1 to URV3 Upper Range Value for Columns 1 through 3 are integers that specify the
peak value for the Column 1 to 3 Displays, and a limit value for the
Selected Value Display. Allowable range is from -9999 to +9999. The dec-
imal position is set by the DECPL1 to DECPL3 parameter.
928
39. ECB15 – Allen-Bradley PLC ECB
This chapter covers the ECB15 (Allen-Bradley PLC ECB), providing a functional diagram
and parameters.
Overview
The Equipment Control Block 15 (ECB15) provides the software interface for Allen-Bradley Pro-
grammable Logic Controllers. ECB15 is used between the A-B PLCs and the ABSCAN blocks, as
shown in Figure 39-1.
Refer to Integrators for Allen-Bradley Controllers (B0193RG) for details on configuring ECB15.
Functional Diagram
A/B Comm
ABSCAN ECB15 Adapter
Parameters
Table 39-1. ECB15 Parameters
929
B0193AX – Rev AA 39. ECB15 – Allen-Bradley PLC ECB
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
BUSSEL Bus Selection is a character data store. BUSSEL commands the PIO pri-
mary to initialize its PIO communications over the specified PIO BUS.
= [“A” | “B”]
where:
A = Select bus A
B = Select bus B
930
39. ECB15 – Allen-Bradley PLC ECB B0193AX – Rev AA
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECB15, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
931
B0193AX – Rev AA 39. ECB15 – Allen-Bradley PLC ECB
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the
PARAMETER VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FLTPNT Floating Point is an input integer that defines the floating point format
used when converting the raw data from the PLC. 1=IEEE format.
HBEAT Heart Beat Flag is a boolean input. This flag defines whether the Gateway
will send a heartbeat to the configured device on the Data Highway (DH).
The Integrators use the Diagnostic Loop command as an optional health-
checking heartbeat to specified Controllers. With HBEAT set to 1 for a
Controller, the Diagnostic Loop command is issued under the following
circumstances:
♦ periodically (about every 16 seconds) if there are no other commu-
nications to the Controller (such as when all compounds with
ABSCAN blocks to read the Controller have been turned off );
♦ immediately when the Controller state is changed from offline to
online (through the System Manager);
♦ immediately following restoration of communications to the Con-
troller after communications had been interrupted for any reason;
♦ any time the Integrator is rebooted.
If the heartbeat option is selected and the Controller fails to respond prop-
erly to the heartbeat, the Controller is failed.
NOTE
The SLC-5/04 with firmware Rev. 15 or earlier cannot respond to the Diagnostic
Loop command. Therefore, configuring HBEAT to 1 for such a Controller causes
the Controller to be failed.
932
39. ECB15 – Allen-Bradley PLC ECB B0193AX – Rev AA
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
PCADDR PC Address is an integer option. AB: valid PLC addresses are from 1 to
255 (0 to 377 octal). MOD: valid PC addresses are from 1 to 247.
This parameter contains the address of the Controller on the Data High-
way network. Each Controller address is configured within it, with
switches or software. For those Controllers that connect to the DH net-
work through a CAM, PCADDR is the address of the CAM.
For a direct-connect application (such as the PLC-5 family and the
SLC-5/04) the default value of 0 need not be changed.
PCTYPE PC Type is an indexed integer input that specifies the types of Allen-Brad-
ley controllers which the Integrators can be configured to access are:
PCTYPE Controller Model
2 Any member of the PLC-2 family
3 Any member of the PLC-3 family
5 Any member of the PLC-5 family
6 The SLC-5/04*
* The SLC-5/04 is the only member of the
SLC family supported by the Integrators.
933
B0193AX – Rev AA 39. ECB15 – Allen-Bradley PLC ECB
RES15 Resolution 02 is an indexed input that dictates the A/D resolution, inte-
gration and update periods for all channels of ECB15. RES15 values range
from 1 to 4 and map to the following values.
Value Resolution Integration Period Update Time
1 12 bits 100 ms 25 ms
2 13 bits 200 ms 25 ms
3 14 bits 500 ms 25 ms
4 15 bits 1000 ms 25 ms
STMSTS Station Manager Status is the station manager status of the device.
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB15” or select “ECB15” from the block type list
under Show, an identifying integer is created specifying this block type.
934
40. ECB16 – Modicon PC ECB
This chapter covers the ECB16 (Modicon PC ECB), providing a functional diagram and
parameters.
Overview
The Equipment Control Block 16 (ECB16) provides the software interface for Modicon Pro-
grammable Logic Controllers and the MDSCAN block, as shown in Figure 40-1. One ECB han-
dles all the I/O signals from one PLC.
Refer to Integrators for Modbus and Modbus Plus Devices (B0193RL) for an in-depth description of
ECB16, and details on configuring ECB16 for a system incorporating Modicon PLCs.
Functional Diagram
MODICON
MDSCAN ECB16 Modem
Parameters
Table 40-1. ECB16 Parameters
935
B0193AX – Rev AA 40. ECB16 – Modicon PC ECB
Parameter Definitions
NOTE
The Modicon integrator can be used to communicate with any device which has
implemented the Modbus protocol to the extent that it can respond with a proper
Modbus protocol reply to appropriate Modbus commands issued by the integrator
as a master device. Refer to Integrators for Modbus and Modbus Plus Devices
(B0193RL) for special instructions on how to configure the ECB16 parameters for
communication with Modbus-compliant devices.
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
936
40. ECB16 – Modicon PC ECB B0193AX – Rev AA
BUSSEL Bus Selection is a character data store. BUSSEL commands the PIO pri-
mary to initialize its PIO communications over the specified PIO BUS.
= [“A” | “B”]
where:
A = Select bus A
B = Select bus B
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
937
B0193AX – Rev AA 40. ECB16 – Modicon PC ECB
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 errors does not proceed past the first error encountered
by the block logic. For ECB16, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FLTPNT Floating Point is an input integer that defines the floating point format
used when converting the raw data from the PLC. 1=IEEE format.
HBEAT Heart Beat Flag is a boolean input. This flag defines whether the Gateway
sends a heartbeat to the configured device on the data Highway.
The integrators use the Loopback Diagnostic Test command (function
code 8 with diagnostic code 0) as a health-checking heartbeat to devices
with HBEAT set to 1. If the device can respond properly to this com-
mand, you should select this option. Setting HBEAT to a 1 issues loop-
back diagnostic test command under the following circumstances:
938
40. ECB16 – Modicon PC ECB B0193AX – Rev AA
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. It must be
configured to 32. Once HWTYPE is set, it cannot be edited via the Inte-
grated Control Configurator.
MULTWR Multiple Write is a boolean option that indicates if the PC supports the
Modicon functions, Force Multiple Coils, and Load Multiple Registers.
Enter:
0 = (No) for a 484 type PC.
1 = (Yes) for a PC from the 584 family, an 884 type PC, or a 984 type PC.
Depending on how it is set, MULTWR affects Modbus protocol in the
following manner. The Modbus protocol allows for writing data to a sin-
gle digital data (function code 5) or a single analog datum (function code
6). (For a description of these function codes, refer to “Modbus Protocol
Function Codes” on page 941.) For efficiency, it also provides for writing
to multiple contiguous digital data with a single command (function code
15) or to multiple contiguous analog data with a single command (func-
tion code 16). Selecting the multiple write option (MULTWR = 1) results
in the use of function codes 15 and 16 for (all) writes, instead of function
codes 5 and 6.
Function codes 15 and 16 incur more communications overhead than
codes 5 and 6. Therefore, unless there is the likelihood that multiple con-
tiguous digital or analog data requires being written to at one time, MUL-
TWR should be set to 0. (Note that writes are done only on a change-
driven basis; if the value of a digital or analog datum in a device is already
equal to the value desired by an output block in the integrator, no write
command is issued.)
(Refer also to the DATYPE parameter of the MDSCAN block, as
described in Integrators for Modbus and Modbus Plus Devices (B0193RL).)
939
B0193AX – Rev AA 40. ECB16 – Modicon PC ECB
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
PCADDR PC Address is an integer option. AB: valid PLC addresses are from 1 to
255 (0 to 377 octal). MOD: valid PC addresses are from 1 to 247.
Refer to Integrators for Modbus and Modbus Plus Devices (B0193RL) for
the PCADDR settings and addresses for all Modbus-compliant devices
and configurations.
PCTYPE PC Type is an indexed integer input that specifies the type of Modicon PC
interfacing with this ECB. Enter as:
1 = 484 type PC
2 = 584 type PC and Triconex
3 = 884 type PC
4 = 984 type PC and C50 RTU.
For all other devices, use the default value of 2 for PCTYPE.
RES16 Resolution 16 is an indexed input that dictates the A/D resolution, inte-
gration and update periods for all channels of ECB16. RES16 values range
from 1 to 4 and map to the following values.
Value Resolution Integration Period Update Time
1 12 bits 100 ms 25 ms
2 13 bits 200 ms 25 ms
3 14 bits 500 ms 25 ms
4 15 bits 1000 ms 25 ms
940
40. ECB16 – Modicon PC ECB B0193AX – Rev AA
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. It must be configured to 16. After
SWTYPE is configured, it appears in a darker color indicating that this
parameter cannot be edited using the FBM Configure function.
TYPE When you enter “ECB16” or select “ECB16” from the block type list
under Show, an identifying integer is created specifying this block type.
Table 40-2. Modbus Protocol Function Codes for Modicon Programmable Controllers
Code Function
1 Read Coil Status
2 Read Input Status
3 Read Holding Registers
4 Read Input Registers
5 Force Single Coil
6 Preset Single Register
8 Loopback Diagnostic Test
15 Force Multiple Coils
16 Preset Multiple Registers
20 Read General Reference
21 Write General Reference
Which of these function codes is used for a particular transaction between the integrator and the
device is controlled by you through the HBEAT and MULTWR parameters of the ECB16 (as dis-
cussed above) and the DATYPE parameter of the MDSCAN block (as discussed in Integrators for
Modbus and Modbus Plus Devices (B0193RL)).
941
B0193AX – Rev AA 40. ECB16 – Modicon PC ECB
942
41. ECB18 – Intelligent Transmitter
2 (Child)
This chapter gives a general overview of the ECB18 (Intelligent Transmitter 2 (Child)),
providing functional and I/O diagrams and describing its features, parameters and detailed
operations.
Overview
The Intelligent Transmitter window ECB (ECB18) receives up to three measurement values and
status conditions from the device for integration into the control scheme, as shown in
Figure 41-1. ECB18 is internally a window ECB interface to ECB12, and ECB23.Window ECBs
share a fundamental design described in detail in Window ECBs in the appropriate Integrated
Control Software Concepts document (B0700AG or B0193AW).
From the ECB18, you can set upper and lower scale values for each input. Status conditions are
also available, for display and for optional connections to the control scheme. The ECB18 sup-
ports both hardware fault reporting and bad measurement detection.
Optional features include marking primary measurements as bad when the temperature measure-
ment is out of range, and last good value retention.
Functional Diagram
ECB18 is used between the devices and the I/O blocks listed in Figure 41-2.
943
B0193AX – Rev AA 41. ECB18 – Intelligent Transmitter 2 (Child)
IT2 INTERFACE
MAIN
ECB18 IT2
(CHILD)
ECB18 IT2
(CHILD)
IT2 INTERFACE / ANALOG OUT IT2 IN / ANALOG OUT (DUAL BAUD RATE)
I/O BLOCK ECB S/W FBM H/W I/O BLOCK ECB S/W FBM H/W
Type Type Type Type Type Type
(PARENT) (PARENT)
AINR AIN
AOUTR AOUT
ECB18 IT2 ECB18 IT2
Features
The features are:
♦ Up to 3 measurement input values
♦ Upper and lower scale values for each input
♦ A number of status conditions for display and optional connection to control blocks
♦ Bypass which allows the manual manipulation of individual inputs to control scheme
♦ Bad measurement detection
944
41. ECB18 – Intelligent Transmitter 2 (Child) B0193AX – Rev AA
Parameters
Table 41-1. ECB18 Parameters
945
B0193AX – Rev AA 41. ECB18 – Intelligent Transmitter 2 (Child)
Parameter Definitions
NOTE
For a description on how to set up an ECB18 with an Intelligent Transmitter, refer
to Measurement Integration (B0193RA).
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
946
41. ECB18 – Intelligent Transmitter 2 (Child) B0193AX – Rev AA
BADOPT Bad and Out-Of-Range Option is a configurable integer input that speci-
fies the conditions that set the BAD output true, when the block is in
Auto, or in Manual with MANALM set true. BADOPT values range from
0 to 3, and map to the following conditions:
0 = Bad_Status
1 = Bad_Status or Low Out-of-Range
2 = Bad_Status or High Out-of-Range
3 = Bad_Status or Low Out-of-Range or High Out-of-Range.
Bad_Status is the OR output of the two inputs, ECB Status and Channel
Status, so that Bad_Status is true when either ECB Status or Channel Sta-
tus is true. Channel status is the OR output of the rate-of-change status,
measurement limits status, and other FBM data conversion checks. The
ECB parameter ROC1 specifies the rate-of-change limit for the measure-
ment input. Block parameters MEASHL and MEASLL specify the mea-
surement limits.
To provide backward compatibility, BADOPT defaults to 3, and the High
(HOR) and Low (LOR) out-of-range conditions set the BAD output true
when the BADOPT parameter is defaulted.
Select BADOPT so that the sensor failure mode is included in the BAD
output. For instance, for current loops enter a 1 for BADOPT, since cur-
rent loops fail to zero current, which is a detectable failure mode. Con-
versely, do not use the high out-of-range test for bad detection, because a
high signal condition is a typical mode of transmitter operation (that is,
high flow), and does not constitute a failure mode. For thermocouples,
you might enter a value of 2, because they fail to the high end of the scale.
BYPS16 Bypass 16 controls the bypassing of point value updating from raw values.
When the control bit of BYPS16 is set, the point value is released. When
reset, the point value is secured and copied from the raw value. The high-
order bit of this parameter controls the first raw value - point value pair in
the list.
947
B0193AX – Rev AA 41. ECB18 – Intelligent Transmitter 2 (Child)
CHAN Channel is a short input that represents the number of the parent FBM
channel (1 of 8) assigned to the IT2 being supported by ECB. CHAN
appears in a darker color indicating that this parameter was determined by
the FBM Fix operation and cannot be edited using the FBM Configure
function.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DELTI1 to DELTI3
Change Delta for Input Ranges 1 through 3 are a real values that define
the minimum percent of the input range that triggers change driven con-
nections for parameters in the range of RI1 through RI3. The default
value is 1.
Entering a 1 causes the Object Manager to recognize and respond to a
change of 1 percent of the full error range. If communication is within the
same CP that contains the block’s compound, change deltas have no
effect.
Refer to “Peer-to-Peer Connections of Real-Type Block Inputs” on
page 955 for details on how the I/A Series software affects the change delta
percentage during operation.
DEVNAM Device Name is a 6-character soft letterbug identifier for the IT2. The
channel letterbug ID defined during System Configuration/Definition
must match the DEVNAM in the Intelligent Field Device Configuration.
The Hand-Held Terminal can display and/or reconfigure this IT2 param-
eter.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
948
41. ECB18 – Intelligent Transmitter 2 (Child) B0193AX – Rev AA
EGU_1 to EGU_3
Engineering Units Measurement 1 to 3 are 6-character data stores. These
units are associated with ECB18 and ECB22.
When configuring these units, if the menu has the units you desire for the
selected measurement, pick on that entry and the configurator assigns the
selected units.
Custom enables you to enter units not included in the menu provided.
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 errors does not proceed past the first error encountered
by the block logic. For ECB18, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
949
B0193AX – Rev AA 41. ECB18 – Intelligent Transmitter 2 (Child)
Message Value
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
HSCI1 to HSCI3 High Scale for Input Ranges 1 through 3 are real values that define the
upper limit of the measurement ranges. EI1 to EI3 define the units. Make
the range and units consistent with the measurement source. A typical
value is 100 (percent).
IT_TYP Instrument Type is a short integer that identifies the transmitter type to
the system. The numbers used are:
Device Number
820 1 to 29
IMT10 42
RTT10 49
CFT10 32
IVAL1 to IVAL3 Raw Value from Instruments 1 through 3 are real inputs.
LO_RNG Lower Range Value for 820 Series is a real data store for conversion to
plant units.
LRL_1U to LRL_2U
Lower Range Limits 1 to 2 are the lower range limits for MEASx.
LSCI1 to LSCI3 Low Scale for Input Ranges 1 through 3 are real values that define the
lower limit of the measurement ranges. A typical value is 0 (percent). EI1
to EI3 define the units. Make the range and units consistent with those of
the measurement source.
LSTG16 Last good value for the output is a packed boolean. When set to True the
value is good.
950
41. ECB18 – Intelligent Transmitter 2 (Child) B0193AX – Rev AA
MEAS1 to MEAS3
Point Values 1 through 3 are real outputs from the instrument.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
PARENT Parent ECB is a string. Parameter is the name of the ECB that is parent to
this child. Name of the ECB can be up to 12 chars, or 6 chars if resides in
the ECB compound. PARENT appears in a darker color indicating that
this parameter was determined by the FBM Fix operation and cannot be
edited using the FBM Configure function.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec. this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec. this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
951
B0193AX – Rev AA 41. ECB18 – Intelligent Transmitter 2 (Child)
*** If the BPC is 0.5 sec. this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec. this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
RI1 to RI3 Range Input 1 to 3 are arrays of real values that specify the high and low
engineering scale and change delta of a particular real input. For a given
block, it also forms an association with a group of real input parameters
that have the same designated range and change delta.
SLOPE1 to SLOPE3
Recalibration Slope for Measurements 1 through 3 are real data store
values.
TAGNAM Tag Name is an arbitrary 14-character text that describes the IT2 associ-
ated with this configured channel of an ECB18. Both the Control Config-
urator and the Hand-Held Terminal can display and/or reconfigure this
IT2 parameter.
TAGNO Tag Number is an arbitrary 12-character text that describes the IT2 associ-
ated with this configured channel of an ECB18. Both the Control config-
urator and the Hand-Held Terminal can display and/or reconfigure this
IT2 parameter.
TYPE When you enter “ECB18” or select “ECB18” from the block type list
under Show, an identifying integer is created specifying this block type.
UP_RNG Upper Range Value is a real value. For 820 Series, UP_RNG is set for easy
conversion to plant units. For MAGFLOW, UP_RNG is used to set the
measurement range.
952
41. ECB18 – Intelligent Transmitter 2 (Child) B0193AX – Rev AA
URL_1U to URL_2U
Upper Range Limits 1 to 2 are the upper range limits for MEASx.
ZERO1 to ZERO3
Recalibration Offset for Measurements 1 through 3 are real data store
values.
953
B0193AX – Rev AA 41. ECB18 – Intelligent Transmitter 2 (Child)
Detailed Operation
Configuration, starting, and downloading are handled as in all other window ECBs.
During input scanning, the CP distributes the real format data to the ECB18 attached to ECB12,
or ECB23. ECB18 connections to an ECB12 or ECB23 are identical.
Automatic uploads from the instrument to the ECB12 or ECB23 also occur whenever the instru-
ment configuration is changed from a hand-held configurator.
Whether uploaded from the instrument or configured at the Integrated Control Configurator,
parameter Device Name (DEVNAM) must be identical to parameter Device ID (DEV_ID) in
the ECB18 for the instrument. The default value for DEVNAM, which is the six-character array
“DevNam”, is a wild card which matches any value of DEV_ID.
Two options are specific to ECB18, SCLOPT and BADOPT.
SCLOPT addresses the fact that for displays, scale values from some transmitters have different
functions than are required. In those cases, setting SCLOPT allows HSCIx and LSCIx to be used
for scale values, instead of inputs for scale.
BADOPT, when set, allows you to mark the primary measurement as BAD when the temperature
measurement from the transmitter (the third measurement) is out of a specified range, as set by
the absolute high and low range parameters (HIRNG and LORNG, respectively). The following
table lists the available BADOPT values, and the corresponding verification.
Figure 41-3 shows how the real time data flows from the FBM hardware to the ECB12 message
area, then to the output value records in ECB18.
Control Processor
FBM Bus
Hardware ECB12
18 Messages
Input Message Area
ECB18
Control
Block Inputs Output Points
954
41. ECB18 – Intelligent Transmitter 2 (Child) B0193AX – Rev AA
955
B0193AX – Rev AA 41. ECB18 – Intelligent Transmitter 2 (Child)
956
42. ECB19 – 760 Micro Controller
This chapter covers the ECB19 (760 Micro Controller), providing a functional diagram and
parameters.
Functional Diagram
760 CONTROLLER INTERFACE
I/O BLOCK ECB S/W FBM H/W
Type Type Type
760
D760 ECB19
CONTROLLER
Parameters
Table 42-1. ECB19 Parameters
957
B0193AX – Rev AA 42. ECB19 – 760 Micro Controller
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
0 ON_LINE ACTION.B16
1 OFF_LINE ACTION.B15
2 RUN_DIAG ACTION.B14
3 DOWNLOAD ACTION.B13
4 CALIB1 # ACTION.B12
5 CALIB2 # ACTION.B11
6 UNDECLAR_ECB ACTION.B10
* Bit 0 is the least significant, low order bit.
BUSSEL Bus Selection is a character data store. BUSSEL commands the PIO pri-
mary to initialize its PIO communications over the specified PIO BUS.
= [“A” | “B”]
where:
A = Select bus A
B = Select bus B
958
42. ECB19 – 760 Micro Controller B0193AX – Rev AA
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECB19, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
959
B0193AX – Rev AA 42. ECB19 – 760 Micro Controller
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the
PARAMETER VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
HBEAT Heart Beat Flag is a boolean input. This flag defines whether the Integra-
tor or Gateway sends a heartbeat to the configured device on the data
Highway.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
MCADDR Micro Controller Address is a data store that is the address of the 761 con-
troller associated with this ECB. Enter an integer between 0 and 99.
MCSTYL Micro Controller Style is a 2-character data store that indicates the type of
station associated with this ECB. Enter AA, AB, AC, AD, or AC as
stamped on the label affixed to the top of the controller.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
960
42. ECB19 – 760 Micro Controller B0193AX – Rev AA
Value Status
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators or Gate-
ways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
961
B0193AX – Rev AA 42. ECB19 – 760 Micro Controller
RES19 Resolution 19 is an indexed input that dictates the A/D resolution, inte-
gration and update periods for all channels of ECB19. RES19 values range
from 1 to 4 and map to the following values.
Value Resolution Integration Period Update Time
1 12 bits 100 ms 25 ms
2 13 bits 200 ms 25 ms
3 14 bits 500 ms 25 ms
4 15 bits 1000 ms 25 ms
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB19” or select “ECB19” from the block type list
under Show, an identifying integer is created specifying this block type.
962
43. ECB21 – 761 Micro Controller
This chapter covers the ECB21 (761 Micro Controller), providing a functional diagram and
parameters.
Functional Diagram
761
D761 ECB21
CONTROLLER
Parameters
Table 43-1. ECB21 Parameters
963
B0193AX – Rev AA 43. ECB21 – 761 Micro Controller
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
BUSSEL Bus Selection is a character data store. BUSSEL commands the PIO pri-
mary to initialize its PIO communications over the specified PIO BUS.
= [“A” | “B”]
where:
A = Select bus A
B = Select bus B
964
43. ECB21 – 761 Micro Controller B0193AX – Rev AA
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECB21, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
965
B0193AX – Rev AA 43. ECB21 – 761 Micro Controller
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
HBEAT Heart Beat Flag is a boolean input. This flag defines whether the Integra-
tor or Gateway sends a heartbeat to the configured device on the data
Highway.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
MCADDR Micro Controller Address is a data store that is the address of the 761 con-
troller associated with this ECB. Enter an integer between 0 and 99.
MCSTYL Micro Controller Style is a 2-character data store that indicates the type of
station associated with this ECB. Enter AA, AB, AC, AD, or AC as
stamped on the label affixed to the top of the controller.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
966
43. ECB21 – 761 Micro Controller B0193AX – Rev AA
Value Status
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators or Gate-
ways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
967
B0193AX – Rev AA 43. ECB21 – 761 Micro Controller
RES21 Resolution 21 is an indexed input that dictates the A/D resolution, inte-
gration and update periods for all channels of ECB21. RES21 values range
from 1 to 4 and map to the following values.
Value Resolution Integration Period Update Time
1 12 bits 100 ms 25 ms
2 13 bits 200 ms 25 ms
3 14 bits 500 ms 25 ms
4 15 bits 1000 ms 25 ms
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB21” or select “ECB21” from the block type list
under Show, an identifying integer is created specifying this block type.
968
44. ECB22 – Mass Flow Transmitter
This chapter gives a general overview of the ECB22 (Mass Flow Transmitter), providing
functional and I/O diagrams and describing its features, parameters, I/O diagram, and
detailed operations.
Overview
The Mass Flow Transmitter Window ECB (ECB22) receives up to 6 fully conditioned measure-
ments from the device each scan cycle for connection to the control scheme, as shown in
Figure 44-1. Status condition reporting, simulation control and bad value detection are also avail-
able. A last good value retention capability is optional. Window ECBs share a fundamental design
described in detail in Window ECBs in the appropriate Integrated Control Software Concepts docu-
ment (B0700AG or B0193AW).
Channel Status
Device Status 1 Transmitter Status
Device Status 2
Configuration Data Hardware Fault Messages
Functional Diagram
ECB22 is used between the Coriolis Mass Flow Transmitter and the I/O blocks listed in
Figure 44-2.
969
B0193AX – Rev AA 44. ECB22 – Mass Flow Transmitter
38
AIN ECB22
(CORIOLIS)
AINR
MAIN
Features
The features are:
♦ Up to 6 measurement output values, including:
♦ Mass Flow
♦ Density
♦ Temperature
♦ Total
♦ Volumetric Flow
♦ Percent Solids
♦ A number of status conditions for display and optional connection to control blocks
♦ Bypass which allows the manual manipulation of individual inputs to the control
scheme
♦ Bad measurement detection
The options are:
♦ Last good value retention
Parameters
Table 44-1. ECB22 Parameters
970
44. ECB22 – Mass Flow Transmitter B0193AX – Rev AA
971
B0193AX – Rev AA 44. ECB22 – Mass Flow Transmitter
Parameter Definitions
NOTE
For a description on how to set up an ECB22 with a mass flow transmitter, refer to
Measurement Integration (B0193RA).
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
0 ON_LINE ACTION.B16
1 OFF_LINE ACTION.B15
2 RUN_DIAG ACTION.B14
3 DOWNLOAD ACTION.B13
4 CALIB1 # ACTION.B12
5 CALIB2 # ACTION.B11
6 UNDECLAR_ECB ACTION.B10
* Bit 0 is the least significant, low order bit.
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
BYPS16 Bypass 16 controls the bypassing of point value updating from raw values.
When the control bit of BYPS16 is set, the point value is released. When
reset, the point value is secured and copied from the raw value. The high-
order bit of this parameter controls the first raw value - point value pair in
the list.
972
44. ECB22 – Mass Flow Transmitter B0193AX – Rev AA
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DELTI1 to DELTI8
Change Delta for Input Ranges 1 through 8 are a real values that define
the minimum percent of the input range that triggers change driven con-
nections for parameters in the range of RI1 through RI8. The default
value is 1.
Entering a 1 causes the Object Manager to recognize and respond to a
change of 1 percent of the full error range. If communication is within the
same CP that contains the block’s compound, change deltas have no
effect.
Refer to “Peer-to-Peer Connections of Real-Type Block Inputs” on
page 955 for details on how the I/A Series software affects the change delta
percentage during operation.
DEVNAM Device Name is a 6-character soft letterbug identifier for the IT2. The
channel letterbug ID defined during System Configuration must match
the DEVNAM in the Intelligent Field Device Configuration. The Hand-
Held Terminal can display and/or reconfigure this IT2 parameter.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
973
B0193AX – Rev AA 44. ECB22 – Mass Flow Transmitter
EGU1 to EGU8 Engineering Units 1 to 8 are configurable strings associated with Measure-
ments 1 to 8, used in displays.
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 errors does not proceed past the first error encountered
by the block logic. For ECB22, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not
compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE occurred.
BLOCK”
974
44. ECB22 – Mass Flow Transmitter B0193AX – Rev AA
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
IT_TYP Instrument Type is a short integer that identifies the transmitter type to
the system. The numbers used are:
Device Number
820 1 to 29
IMT10 42
RTT10 49
CFT10 32
975
B0193AX – Rev AA 44. ECB22 – Mass Flow Transmitter
IVAL1 to IVAL8 Instrument Values 1 to 8 are the raw device values from instrument points
1 to 8. The raw values are the reported values before application of last
good value or bypass functionality.
LRL_1 to LRL_8 Lower Range Limits 1 to 8 are the limits for MEAS1 to MEAS8
respectively.
LSTG16 Last good value for the output is a packed boolean. When set to True the
value is good.
MEAS1 to MEAS8 Point Values 1 to 8 are the instrument measurements 1 to 8 to which the
control scheme connects. They constitute the raw values in IVAL1 to
IVAL8, after application of bypass and last good value functionality.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the
following period time lengths. (Integrator and Gateway blocks have differ-
ent period values than shown here.
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
976
44. ECB22 – Mass Flow Transmitter B0193AX – Rev AA
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
RI1 to RI8 Range Input is an array of real values that specify the high and low engi-
neering scale and change delta of a particular real input. For a given block,
it also forms an association with a group of real input parameters that have
the same designated range and change delta.
SELRD Selective Read is a configurable packed long parameter that allows you to
specify which channels from intelligent field devices require real time
scanning. Maximum optimization for FBMs that support intelligent
transmitters also requires configuring the MPOLL parameter in the ECBP
(ECB11) appropriately.
SELRD is a bit mask. The working part of SELRD is three bytes long. All
24 channels are selected by 0xFFFFFF or -1 (the default). Each of the
three bytes, defined by a pair of hexadecimal digits, is associated with one
of the three measurements (aux2, aux1 and primary) potentially available
from the transmitter. The format of the mask is 0x2211PP where: 22
selects aux2, 11 selects aux1, and pp selects the primary. Within each byte,
channel 1 is represented by the high order bit of SELRD, with the remain-
ing channels following left to right.
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
C10
C11
C12
C13
C14
C15
C16
C17
C18
C19
C20
C21
C22
C23
C24
C25
C26
C27
C28
C29
C30
C31
C32
C1
C2
C3
C4
C5
C6
C7
C8
C9
977
B0193AX – Rev AA 44. ECB22 – Mass Flow Transmitter
SERNO Instrument Serial Number is a real short integer data store for Coriolis.
SLOPE1 to SLOPE8
Recalibration Slope for Measurements 1 through 8 are real data store
values.
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TAGNAM Tag Name is an arbitrary 14-character text that describes the IT2 associ-
ated with this configured channel of an ECB18. Both the Control Config-
urator and the Hand-Held Terminal can display and/or reconfigure this
IT2 parameter.
TAGNO Tag Number is an arbitrary 12-character text that describes the IT2 associ-
ated with this configured channel of an ECB18. Both the Control config-
urator and the Hand-Held Terminal can display and/or reconfigure this
IT2 parameter.
TYPE When you enter “ECB22” or select “ECB22” from the block type list
under Show, an identifying integer is created specifying this block type.
URL_1 to URL_8 Upper Range Limits 1 to 8 are the limits for MEAS1 to MEAS8 respec-
tively.
ZERO1 to ZERO8
Recalibration Offset for Measurements 1 through 8 are real data store
values.
978
44. ECB22 – Mass Flow Transmitter B0193AX – Rev AA
Detailed Operation
The ECB22 contains the data for the Mass Flow Transmitter device. The data flow is shown in
Figure 44-3.
Transmitter Messages
Mass Flow PIO Bus Output Points
Input Messages
ECB22
Control Processor
979
B0193AX – Rev AA 44. ECB22 – Mass Flow Transmitter
980
45. ECB23 – Intelligent
Transmitter 2 Interface (Parent)
This chapter covers the ECB23 (Intelligent Transmitter 2 Interface (Parent)), providing a
functional diagram and parameters.
Overview
The Equipment Control Block 23 (ECB23) provides the software interface for FBMs which sup-
port Intelligent Field Device (RS-232C) signals and analog output signals, using single or dual
baud rate. ECB23 is used between the FBMs and the I/O blocks listed in Figure 45-1, depending
on whether single or dual baud rate communications are required.
Functional Diagram
IT2 INTERFACE / ANALOG OUT IT2 IN / ANALOG OUT (DUAL BAUD RATE)
I/O BLOCK ECB S/W FBM H/W I/O BLOCK ECB S/W FBM H/W
Type Type Type Type Type Type
(PARENT) (PARENT)
AINR AIN
AOUTR AOUT
ECB18 IT2 ECB18 IT2
981
B0193AX – Rev AA 45. ECB23 – Intelligent Transmitter 2 Interface (Parent)
Parameters
Table 45-1. ECB23 Parameters
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
982
45. ECB23 – Intelligent Transmitter 2 Interface (Parent) B0193AX – Rev AA
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
0 ON_LINE ACTION.B16
1 OFF_LINE ACTION.B15
2 RUN_DIAG ACTION.B14
3 DOWNLOAD ACTION.B13
4 CALIB1 # ACTION.B12
5 CALIB2 # ACTION.B11
6 UNDECLAR_ECB ACTION.B10
* Bit 0 is the least significant, low order bit.
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
983
B0193AX – Rev AA 45. ECB23 – Intelligent Transmitter 2 Interface (Parent)
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
B9
Bit Number* Boolean Connection
(0 to 31) Description When True (B32 to B1)
0 ECB is on-scan ECBSTA.B32
1 Device is shutdown ECBSTA.B31
2 Device is secured ECBSTA.B30
5 Output point is open ECBSTA.B27
6 Bypass is active ECBSTA.B26
7 Initialization is complete ECBSTA.B25
8 Device is not ready ECBSTA.B24
9 Communications failed ECBSTA.B23
10 Device is out of service (OOS) ECBSTA.B22
11 Device is failed ECBSTA.B21
12 Point(s) are BAD ECBSTA.B20
13 ECB configuration error ECBSTA.B19
14 ECB is undefined ECBSTA.B18
15 ECB is on ECBSTA.B17
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 errors does not proceed past the first error encountered
by the block logic. For ECB23, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
984
45. ECB23 – Intelligent Transmitter 2 Interface (Parent) B0193AX – Rev AA
Message Value
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FS5D23 to FS8D23
Failsafe Channels (5 to 8) Data is an integer input that specifies the fall-
back value for the controller output. The value represents the D/A raw
count value and must be related to the intended signal conditioning. For
example, if this output is going to a 4 to 20 ma device (raw count range:
12800 to 64000), then FS5D23 must be within that range.
The formula for determining the count value is:
Count Value = ((Eng Value - Low Scale) / (High Scale - Low Scale)) *
Span + offset counts
Example: For a 4 to 20 ma device, determine the count for a fallback value
of 25 percent of full scale.
Count Value = ((25 - 0) / (100 - 0)) * (64000 - 12800) + 12800 = 25600
Fallback values range from 0 to 64000 counts. You can enter the value
into the data base as a 16-bit signed integer with the most significant bit
(MSB) as the sign bit. Any value greater than 32767 requires that the sign
bit be true (1), indicating a negative number. For counts of more than
32767, the value to enter is the count minus 65536. For example, to get a
count of 62000, enter -3536.
62000 - 65536 = -3536
You can also enter the fallback value into the data base in hexadecimal for-
mat.
Sample count values for a 4 to 20 mA device are listed below.
Entry
% Count Value (Integer) (Hexadecimal)
0 12800 12800 0x3200
25 25600 25600 0x6400
50 38400 -27136 0x9600
75 51200 -14336 0xC800
100 64000 -1536 0xFA00
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
985
B0193AX – Rev AA 45. ECB23 – Intelligent Transmitter 2 Interface (Parent)
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
FSMM23 Failsafe Mask Main is a short integer value that determines which of the
four analog outputs will hold their current value (1 = True = Hold), and
which outputs will assume the fallback values specified by the channel
data (0 = False = fallback value). FSMM23 is digitally coded as follows:
Bit 7 6 5 4 3 2 1 0
Channel 08 07 06 05
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
986
45. ECB23 – Intelligent Transmitter 2 Interface (Parent) B0193AX – Rev AA
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
987
B0193AX – Rev AA 45. ECB23 – Intelligent Transmitter 2 Interface (Parent)
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SECURE Secure Protocol is a boolean option, that acts as a flag to select Secure Pro-
tocol on the transmitter.
0 = Do not use secure protocol on the transmitter bus
1 = Use secure protocol on the transmitter bus
SELRD Selective Read is a configurable packed long parameter that allows you to
specify which channels from intelligent field devices require real time
scanning. Maximum optimization for FBMs that support intelligent
transmitters also requires configuring the MPOLL parameter in the ECBP
(ECB11) appropriately.
SELRD is a bit mask. The working part of SELRD is three bytes long. All
24 channels are selected by 0xFFFFFF or -1 (the default). Each of the
three bytes, defined by a pair of hexadecimal digits, is associated with one
of the three measurements (aux2, aux1 and primary) potentially available
from the transmitter. The format of the mask is 0x2211PP where: 22
selects aux2, 11 selects aux1, and pp selects the primary. Within each byte,
channel 1 is represented by the high order bit of SELRD, with the remain-
ing channels following left to right.
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
C10
C11
C12
C13
C14
C15
C16
C17
C18
C19
C20
C21
C22
C23
C24
C25
C26
C27
C28
C29
C30
C31
C32
C1
C2
C3
C4
C5
C6
C7
C8
C9
988
45. ECB23 – Intelligent Transmitter 2 Interface (Parent) B0193AX – Rev AA
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB23” or select “ECB23” from the block type list
under Show, an identifying integer is created specifying this block type.
989
B0193AX – Rev AA 45. ECB23 – Intelligent Transmitter 2 Interface (Parent)
990
46. ECB34 – MDACT Feedback Lag
Tristate
This chapter covers the ECB34 (MDACT Feedback Lag Tristate), providing a functional
diagram and parameters.
Overview
The ECB34 provides the interface to the feedback lag control algorithm in the FBM17 for the
MDACT block, to control processes through tri-state devices. As well, during input and output
scans, the ECB34 contains data exchanged between other I/O blocks (AIN, AOUT, CIN, and
COUT) in the Control Processor and those I/O points of the FBM17 that are not used by the
MDACT controller.
ECB34 is used between FBM17 and the I/O blocks listed in Figure 46-1.
Functional Diagram
17
MDACT ECB34 17A
17B
GDEV 17C
17D
MTR
MOVLV
VLV
COUT
CIN
AIN
AOUT
AINR
AOUTR
991
B0193AX – Rev AA 46. ECB34 – MDACT Feedback Lag Tristate
NOTE
Refer to the chapter “MDACT” in this document for additional information on
how ECB34 is used with the MDACT block.
Parameters
Table 46-1. ECB34 Parameters
992
46. ECB34 – MDACT Feedback Lag Tristate B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
993
B0193AX – Rev AA 46. ECB34 – MDACT Feedback Lag Tristate
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
CHAREN Characterizer Enable is a boolean input, which when true, specifies that
the FBM characterize the measurement input, FBM analog Point1, using
a 21-point characterizer.
CPCONT Control Processor Control option is a boolean input, which when true,
specifies that the algorithm in the FBM use the MDACT block parameter
CPMEAS, in place of the Point1 measurement input.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
994
46. ECB34 – MDACT Feedback Lag Tristate B0193AX – Rev AA
ENDPMD End Point is a short integer input that specifies the end point of the closed
interval in which interpolation is to be performed. It is specified in terms
of the i-th X data point. During characterization, if the measurement is
greater than the ending X data point, then the output is extrapolated using
the left-most line segment in the closed interval. All breakpoints greater
than ENDPMD are ignored.
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 errors does not proceed past the first error encountered
by the block logic. For ECB34, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
FDBK Feedback option is a boolean input. When true, FDBK specifies that the
feedback-lag algorithm in the FBM calculate and use feedback-lag. You
can use this algorithm without feedback lag.
995
B0193AX – Rev AA 46. ECB34 – MDACT Feedback Lag Tristate
FPMMD Filter Period Main FBM for MDACT are indexed inputs that specify the
time period of the digital filter used for debouncing the discrete inputs
from the main FBM. FPMMD values range from 0 to 3 and map to the
following period values:
0 = 4 ms
1 = 8 ms
2 = 16 ms
3 = 32 ms
FS5DMD to FS6DMD
Failsafe, channel 5 to 6 Data, for MDACT is an unsigned integer input
that specifies the fallback value for the channel 5 to 6 output, and is writ-
ten to the fallback value register.
The value represents the D/A raw count and is related to the intended sig-
nal conditioning. For example, if this output is going to a 0 to 10 V device
(output engineering units range of 0 to 100% is equivalent to a raw count
range of 1600 to 64000), then FS5DMD to FS6DMD is typically within
that range ± 2%.
The formula for determining the count value is:
Count Value = ((Eng Value - Low Scale) / (High Scale - Low Scale)) *
Span Count+ Offset Count
For example, for a 0 to 10 V device, determine the count for a fallback
value of 25 percent of full scale:
Count Value = ((25 - 0) / (100 - 0)) * (64000 - 1600) + 1600 =
17200
Fallback values can range from 0 to 65535 counts. You may enter the
value using the decimal or hexadecimal notation. Hexadecimal entry has a
range of 0x0000 to 0xFFFF, representing a decimal range of 0 to 65535.
For decimal entry, the configurator considers this parameter to be a signed
integer. For a value in the range 0 to 32767, enter the count value. For a
value in the range 32768 to 65535, enter the count value minus 65536.
For example, to get a count of 62000, enter -3536.
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
996
46. ECB34 – MDACT Feedback Lag Tristate B0193AX – Rev AA
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSDMMD Failsafe Data Main for MDACT is a short integer value that determines
the fallback value (0 or 1) for the four digital outputs. FSDMMD is digi-
tally coded as follows:
Bit 7 6 5 4 3 2 1 0
Channel 11 12 13 14
For example, if you want channels 11 and 13 to fall back to the value 1,
and channels 12 and 14 to fall back to 0, then enter 10 (the decimal value
for the binary 00001010).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x”. In this case you would enter 0x0A.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
FSMMMD Failsafe Mask for MDACT is a short integer input that specifies the fail
safe action taken during FBM fail safe mode for the 2 AOs and the 4
DOs:
0 = fallback value
1 = Hold
FSMMD is coded as follows:
Bit 7 6 5 4 3 2 1 0
Channel x x 6 5 11 12 13 14
997
B0193AX – Rev AA 46. ECB34 – MDACT Feedback Lag Tristate
HOLDDI Hold Digital Input is an option which specifies whether the third FBM 17
digital input point (Point 9) is to be used as an external means of com-
manding the MDACT algorithm to hold its outputs. If HOLDDI = 0,
Point 9 is used for the hold function; if HOLDDI = 1, the algorithm
ignores Point 9, and it can be used as a general purpose digital input point
by any appropriate block.
HORVAL High Out-of-Range Value is an integer input that specifies the high limit
for range checking of the FBM Point1 measurement input. This check
does not affect the channel status of the point as sent to the CP, but
MDACT block parameter HORMD indicates the result.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
INVDFI Invert Device Fail option is a boolean input that specifies inversion of the
Device Fail input (channel 10) in an FBM17 to determine the fail state of
the field device:
0 = No inversion
1 = Invert
INVLIM Invert Limit Switch option is a boolean input. When true, INVLIM spec-
ifies that the increase and decrease limit switch inputs, FBM Points 7 and
8, are true when they are open or at low voltage. When INVLIM is false, it
specifies that the limit switch inputs are true when they are closed or at
high voltage.
998
46. ECB34 – MDACT Feedback Lag Tristate B0193AX – Rev AA
LORVAL Low-Out-of-Range Value is an integer input that specifies the low limit
for range checking of the FBM Point1 measurement input. This check
does not affect the channel status of the point as sent to the CP, but
MDACT block parameter LORMD indicates the result.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
999
B0193AX – Rev AA 46. ECB34 – MDACT Feedback Lag Tristate
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PNLOPT Panel Option is a boolean input that specifies the use of the local opera-
tor’s panel (Foxboro® Deutschland) for manual operation of the control-
ler output in an FBM17.
0 = No panel
1 = Panel
If PNLOPT is set to true, all FBM17 I/O channels are used by the
MDACT controller; that is, there are no spare channels available to you
for other blocks in this configuration.
RESMD Resolution for MDACT is an indexed input that dictates the A/D resolu-
tion, integration and update periods for all AI channels of an MDACT
FBM17. RESMD values range from 1 to 4 and map to the following val-
ues.
Value Resolution Integration Period Update Time
1 12 bits 100 ms 25 ms
2 13 bits 200 ms 25 ms
3 14 bits 500 ms 25 ms
4 15 bits 1000 ms 25 ms
ROC1MD to ROC4MD
FBM Rate of Change limit for Channels 1 through 4 are integer inputs
that specify the threshold for Rate of Change violation in units of
normalized raw counts per 100 ms. FBMs containing analog input points
1000
46. ECB34 – MDACT Feedback Lag Tristate B0193AX – Rev AA
STRPMD Start Point is an integer input that specifies the index number of the
breakpoint at which the active portion of the characterization curve
begins. The default value of 1 starts the active portion of the curve at
(X_1MD, Y_1MD).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB34” or select “ECB34” from the block type list
under Show, an identifying integer is created specifying this block type.
X_1MD to X_21MD
These are the abscissa values of the breakpoints in the series of line seg-
ments that make up the characterization curve for the Point1 measure-
ment input. X_1MD is the abscissa value of the first breakpoint. The
abscissa value (the value of X) must increase monotonically with the X
index number, that is, X_2MD must have a greater value than X_1MD,
X_3MD must be greater than X_2MD, and so on. If this condition is not
met, the block is declared “undefined” at installation time, and is not
operational. X values are inputs in this curve. Enter them in normalized
raw counts within a range of 0 to 65535 counts.
Y_1MD to Y_21MD
These are the ordinate values of the breakpoints in the series of line seg-
ments that make up the characterization curve for the Point1 measure-
ment input. Y_1MD is the ordinate value of the first breakpoint. Y values
are outputs in this curve. Enter them in normalized raw counts, within a
range of 0 to 65535 counts.
1001
B0193AX – Rev AA 46. ECB34 – MDACT Feedback Lag Tristate
1002
47. ECB36 – MDACT Pulse Width
Tristate
This chapter covers the ECB36 (MDACT Pulse Width Tristate), providing a functional
diagram and parameters.
Overview
The ECB36 provides the interface to the pulse width modulation control algorithm in the
FBM17 for the MDACT block, to control processes through tri-state devices.
The FBM17 with ECB36 and MDACT supports a local operator’s panel (supplied by
Foxboro Deutschland). If the local operator’s panel option (PNLOPT) in ECB36 is set to true, all
FBM17 I/O channels are used by the MDACT controller; that is, there are no spare channels
available to you for other blocks in this configuration.
ECB36 is used between FBM17 and the I/O blocks listed in Figure 47-1.
Functional Diagram
MTR
MOVLV
VLV
COUT
CIN
AIN
AOUT
AINR
AOUTR
1003
B0193AX – Rev AA 47. ECB36 – MDACT Pulse Width Tristate
NOTE
Refer to the chapter “MDACT” in this document for additional information on
how ECB36 is used with the MDACT block.
Parameters
Table 47-1. ECB36 Parameters
1004
47. ECB36 – MDACT Pulse Width Tristate B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to
-32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1005
B0193AX – Rev AA 47. ECB36 – MDACT Pulse Width Tristate
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
CHAREN Characterizer Enable is a boolean input, which when true, specifies that
the FBM characterize the measurement input, FBM analog Point1, using
a 21-point characterizer.
CPCONT Control Processor Control option is a boolean input, which when true,
specifies that the algorithm in the FBM use the MDACT block parameter
CPMEAS, in place of the Point1 measurement input.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
1006
47. ECB36 – MDACT Pulse Width Tristate B0193AX – Rev AA
ENDPMD End Point is a short integer input that specifies the end point of the closed
interval in which interpolation is to be performed. It is specified in terms
of the i-th X data point. During characterization, if the measurement is
greater than the ending X data point, then the output is extrapolated using
the left-most line segment in the closed interval. All breakpoints greater
than ENDPMD are ignored.
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 errors does not proceed past the first error encountered
by the block logic. For ECB36, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the
PARAMETER VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type is not used in the ECB36, as FBM expander modules
cannot be used with ECB36.
1007
B0193AX – Rev AA 47. ECB36 – MDACT Pulse Width Tristate
FPMMD Filter Period Main FBM for MDACT are indexed inputs that specify the
time period of the digital filter used for debouncing the discrete inputs
from the main FBM.
For 100 Series FBMs, FPMMD values range from 0 to 3 and map to the
following period values:
0 = 4 ms
1 = 8 ms
2 = 16 ms
3 = 32 ms
For 200 Series FBMs, FPMMD values range from 0 to 4 and map to the
following period values:
0 = No filtering
1 = 4 ms
2 = 8 ms
3 = 16 ms
4 = 32 ms
FS5DMD to FS6DMD
Failsafe, channel 5 to 6 Data, for MDACT is an unsigned integer input
that specifies the fallback value for the channel 5 to 6 output, and is writ-
ten to the fallback value register.
The value represents the D/A raw count and is related to the intended sig-
nal conditioning. For example, if this output is going to a 0 to 10 V device
(output engineering units range of 0 to 100% is equivalent to a raw count
range of 1600 to 64000), then FS5DMD to FS6DMD is typically within
that range ± 2%.
The formula for determining the count value is:
Count Value = ((Eng Value - Low Scale) / (High Scale - Low Scale)) *
Span Count+ Offset Count
For example, for a 0 to 10 V device, determine the count for a fallback
value of 25 percent of full scale:
Count Value = ((25 - 0) / (100 - 0)) * (64000 - 1600) + 1600 =
17200
Fallback values can range from 0 to 65535 counts. You may enter the
value using the decimal or hexadecimal notation. Hexadecimal entry has a
range of 0x0000 to 0xFFFF, representing a decimal range of 0 to 65535.
For decimal entry, the configurator considers this parameter to be a signed
integer. For a value in the range 0 to 32767, enter the count value. For a
value in the range 32768 to 65535, enter the count value minus 65536.
For example, to get a count of 62000, enter -3536.
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
1008
47. ECB36 – MDACT Pulse Width Tristate B0193AX – Rev AA
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSDMMD Failsafe Data Main for MDACT is a short integer value that determines
the fallback value (0 or 1) for the four digital outputs. FSDMMD is digi-
tally coded as follows:
Bit 7 6 5 4 3 2 1 0
Channel 11 12 13 14
For example, if you want channels 11 and 13 to fall back to the value 1,
and channels 12 and 14 to fall back to 0, then enter 10 (the decimal value
for the binary 00001010).
The value can be entered in hexadecimal code by prefacing the hex value
with “0x”. In this case you would enter 0x0A.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
1009
B0193AX – Rev AA 47. ECB36 – MDACT Pulse Width Tristate
FSMMMD Failsafe Mask for MDACT is a short integer input that specifies the fail
safe action taken during FBM fail safe mode for the 2 AOs and the 4
DOs:
0 = fallback value
1 = Hold
FSMMD is coded as follows:
Bit 7 6 5 4 3 2 1 0
Channel x x 6 5 11 12 13 14
HOLDDI Hold Digital Input is an option which specifies whether the third FBM 17
digital input point (Point 9) is to be used as an external means of com-
manding the MDACT algorithm to hold its outputs. If HOLDDI = 0,
Point 9 is used for the hold function; if HOLDDI = 1, the algorithm
ignores Point 9, and it can be used as a general purpose digital input point
by any appropriate block.
HORVAL High Out-of-Range Value is an integer input that specifies the high limit
for range checking of the FBM Point1 measurement input. This check
does not affect the channel status of the point as sent to the CP, but
MDACT block parameter HORMD indicates the result.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
INVDFI Invert Device Fail option is a boolean input that specifies inversion of the
Device Fail input (channel 10) in an FBM17 to determine the fail state of
the field device:
1010
47. ECB36 – MDACT Pulse Width Tristate B0193AX – Rev AA
0 = No inversion
1 = Invert
INVLIM Invert Limit Switch option is a boolean input. When true, INVLIM spec-
ifies that the increase and decrease limit switch inputs, FBM Points 7 and
8, are true when they are open or at low voltage. When INVLIM is false, it
specifies that the limit switch inputs are true when they are closed or at
high voltage.
INVOUT Formerly used for bi-state version of MDACT algorithm. Presently this is
unused.
LORVAL Low-Out-of-Range Value is an integer input that specifies the low limit
for range checking of the FBM Point1 measurement input. This check
does not affect the channel status of the point as sent to the CP, but
MDACT block parameter LORMD indicates the result.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
1011
B0193AX – Rev AA 47. ECB36 – MDACT Pulse Width Tristate
Value Status
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the
following period time lengths. (Integrator and Gateway blocks have differ-
ent period values than shown here.)
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PNLOPT Panel Option is a boolean input that specifies the use of the local opera-
tor’s panel (Foxboro Deutschland) for manual operation of the controller
output in an FBM17.
0 = No panel
1 = Panel
1012
47. ECB36 – MDACT Pulse Width Tristate B0193AX – Rev AA
If PNLOPT is configured false, the FBM17 reads and reports only the
field device fail input. If INVDFI is set true, the FBM inverts the device
fail input.
If PNLOPT is set to true, all FBM17 I/O channels are used by the
MDACT controller; that is, there are no spare channels available to you
for other blocks in this configuration.
RESMD Resolution for MDACT is an indexed input that dictates the A/D resolu-
tion, integration and update periods for all AI channels of an MDACT
FBM17. RESMD can be configured to values from 1 to 4 and map to the
values in the table listed below. Also note that the setting is applied to all
four AI channels of the FBM17.
ROC1MD to ROC4MD
FBM Rate of Change limit for Channels 1 through 4 are integer inputs
that specify the threshold for Rate of Change violation in units of normal-
ized raw counts per 100 ms. FBMs containing analog input points per-
form rate-of-change checking on each such point by using ROC1MD
through ROC4MD.
If the input changes by more than that amount in 100 milliseconds, or if
the normalized A/D channel input experiences a bipolar ROC violation,
the channel status is set BAD. The default value of zero (0) for any
ROCxMD parameter disables rate-of-change checking for that channel.
STRPMD Start Point is an integer input that specifies the index number of the
breakpoint at which the active portion of the characterization curve
begins. The default value of 1 starts the active portion of the curve at
(X_1MD, Y_1MD).
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB36” or select “ECB36” from the block type list
under Show, an identifying integer is created specifying this block type.
1013
B0193AX – Rev AA 47. ECB36 – MDACT Pulse Width Tristate
X_1MD to X_21MD
These are the abscissa values of the breakpoints in the series of line seg-
ments that make up the characterization curve for the Point1 measure-
ment input. X_1MD is the abscissa value of the first breakpoint. The
abscissa value (the value of X) must increase monotonically with the X
index number, that is, X_2MD must have a greater value than X_1MD,
X_3MD must be greater than X_2MD, and so on. If this condition is not
met, the block is declared “undefined” at installation time, and is not
operational. X values are inputs in this curve. Enter them in normalized
raw counts within a range of 0 to 65535 counts.
Y_1MD to Y_21MD
These are the ordinate values of the breakpoints in the series of line seg-
ments that make up the characterization curve for the Point1 measure-
ment input. Y_1MD is the ordinate value of the first breakpoint. Y values
are outputs in this curve. Enter them in normalized raw counts, within a
range of 0 to 65535 counts.
1014
48. ECB38R – Intelligent
Transmitter 2 Interface (Redundant
Parent)
This chapter covers the ECB38R (Intelligent Transmitter 2 Interface (Redundant Parent)),
providing a functional diagram and parameters.
Overview
The Equipment Control Block 38 Redundant (ECB38R) provides the software interface for
FBMs which support redundant Intelligent Field Device input and analog output signals at dual
baud rate. ECB38R is used between FBM46 or FBM246 and the I/O blocks shown in
Figure 48-1 and Figure 48-2.
If you are using an ECB38R, it is highly recommended that you use a Redundant Analog Output
(AOUTR) block with the FBM46/FBM246 and not Analog Output (AOUT) block(s), even
though the software allows it. It is especially important that you do use an AOUTR block instead
of using one AOUT block for each partner in an FBM46/FBM246 pair.
Using AOUT blocks with the ECB38R may cause situations in which one FBM will not take over
properly for the other, or in which the CP may send empty packets to the FBMs and cause traffic
on the PIO bus.
Functional Diagram
AIN
AOUTR
ECB18 IT2
1015
B0193AX – Rev AA 48. ECB38R – Intelligent Transmitter 2 Interface (Redundant
AIN*
PNT
MEAS
REALM REALM
or PID or
MEALM MEALM
Optional Real (REALM) OUT or Optional Real (REALM)
or Measurement (MEALM) or Measurement (MEALM)
Alarm Block Alarm Block
AOUTR**
To Displays and
Maintenance or
Data Collection
ECB74 ECB18
Water
1016
48. ECB38R – Intelligent Transmitter 2 Interface (Redundant Parent) B0193AX – Rev AA
Parameters
Table 48-1. ECB38R Parameters
1017
B0193AX – Rev AA 48. ECB38R – Intelligent Transmitter 2 Interface (Redundant
Parameter Definitions
NOTE
For a description on how to set up an ECB38R with 820, 860, 870, and I/A Series
intelligent transmitters, refer to Measurement Integration (B0193RA).
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to
-32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
0 ON_LINE ACTION.B16
1 OFF_LINE ACTION.B15
2 RUN_DIAG ACTION.B14
3 DOWNLOAD ACTION.B13
4 CALIB1 # ACTION.B12
5 CALIB2 # ACTION.B11
6 UNDECLAR_ECB ACTION.B10
* Bit 0 is the least significant, low order bit.
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
1018
48. ECB38R – Intelligent Transmitter 2 Interface (Redundant Parent) B0193AX – Rev AA
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECB38R, the following list specifies the possible
values of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
1019
B0193AX – Rev AA 48. ECB38R – Intelligent Transmitter 2 Interface (Redundant
Message Value
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
1020
48. ECB38R – Intelligent Transmitter 2 Interface (Redundant Parent) B0193AX – Rev AA
Entry Notation
% Count Value (Decimal) (Hexadecimal)
50 38400 -27136 0x9600
75 51200 -14336 0xC800
100 64000 -1536 0xFA00
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
1021
B0193AX – Rev AA 48. ECB38R – Intelligent Transmitter 2 Interface (Redundant
FSMM23 Failsafe Mask Main is a short integer value that determines which of the
four analog outputs hold it’s current value (1 = True = Hold), and which
outputs assume the fallback values specified by the channel data (0 = False
= fallback value). FSMM23 is digitally coded as follows:
Bit 7 6 5 4 3 2 1 0
Channel 08 07 06 05
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
1022
48. ECB38R – Intelligent Transmitter 2 Interface (Redundant Parent) B0193AX – Rev AA
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
*** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
1023
B0193AX – Rev AA 48. ECB38R – Intelligent Transmitter 2 Interface (Redundant
SECURE Secure Protocol is a boolean option, that acts as a flag to select Secure Pro-
tocol on the transmitter.
0 = Do not use secure protocol on the transmitter bus
1 = Use secure protocol on the transmitter bus
SELRD Selective Read is a configurable packed long parameter that allows you to
specify which channels from intelligent field devices require real time
scanning. Maximum optimization for FBMs that support intelligent
transmitters also requires configuring the MPOLL parameter in the ECBP
(ECB11) appropriately.
SELRD is a bit mask. The working part of SELRD is three bytes long. All
24 channels are selected by 0xFFFFFF or -1 (the default). Each of the
three bytes, defined by a pair of hexadecimal digits, is associated with one
of the three measurements (aux2, aux1 and primary) potentially available
from the transmitter. The format of the mask is 0x2211PP where: 22
selects aux2, 11 selects aux1, and pp selects the primary. Within each byte,
channel 1 is represented by the high order bit of SELRD, with the remain-
ing channels following left to right.
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
C10
C11
C12
C13
C14
C15
C16
C17
C18
C19
C20
C21
C22
C23
C24
C25
C26
C27
C28
C29
C30
C31
C32
C1
C2
C3
C4
C5
C6
C7
C8
C9
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
1024
48. ECB38R – Intelligent Transmitter 2 Interface (Redundant Parent) B0193AX – Rev AA
TYPE When you enter “ECB38R” or select “ECB38R” from the block type list
under Show, an identifying integer is created specifying this block type.
1025
B0193AX – Rev AA 48. ECB38R – Intelligent Transmitter 2 Interface (Redundant
1026
49. ECB39 – AMSPRI
This chapter gives a general overview of the ECB39 (AMSPRI), providing functional and I/O
diagrams and describing its features, parameters and detailed operations.
Overview
The window ECB for the gas chromatograph (called AMSPRI or ECB39) provides 931D gas
chromatograph analysis data and status information for direct input into the control scheme, sim-
ulation control, and bad value detection. Optionally, secondary control blocks (AMSSEC) can
provide additional instrument measurement and status data.
Alone among the window ECBs, the AMSPRI ECB also provides for inputs from the CP, to be
downloaded to the device, for a range of purposes. Window ECBs share a fundamental design
described in detail in Window ECBs in the appropriate Integrated Control Software Concepts docu-
ment (B0700AG or B0193AW).
Functional Diagram
Features
The AMSPRI features are:
♦ Up to 12 discrete data sets as inputs to the control scheme. Each data set contains:
♦ A real value
♦ 8 user-configurable status conditions (packed booleans)
♦ An event strobe indicator
♦Out-of-service and Bad flags
♦ Up to 5 user-defined text strings for display enhancement
♦ Up to 12 user-defined strings for labeling (for example, data sets) for display
enhancement
1027
B0193AX – Rev AA 49. ECB39 – AMSPRI
1028
49. ECB39 – AMSPRI B0193AX – Rev AA
Parameters
Table 49-1. ECB39 Parameters
1029
B0193AX – Rev AA 49. ECB39 – AMSPRI
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
CMNT01 to CMNT12
Channel Text for channels 1 to 12 are user-defined character strings out-
put to the Gas Chromatograph for labelling channels on the display.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
1030
49. ECB39 – AMSPRI B0193AX – Rev AA
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECB39, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
1031
B0193AX – Rev AA 49. ECB39 – AMSPRI
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FGCB01 to FGCB12
From GC Booleans 1 through 12 are booleans from the Gas Chromato-
graph.
FGCI01 to FGCI12
From GC Instrument 1 through 12 are real instrument values from the
Gas Chromatograph.
FGCR01 to FGCR12
From GC Real 1 through 12 are real point values from the Gas Chro-
matograph for use in the control strategy.
FGCRM From GC Real Mask is a packed boolean bypass mask for GC reals.
FGCSDL From GC Status Data Lower is a packed boolean from the Gas Chromato-
graph (raw instrument value).
FGCSDU From GC Status Data Upper is the second packed boolean from the Gas
Chromatograph (raw instrument value).
FGCSPL From GC Status Point Lower is the first status packed boolean from the
Gas Chromatograph (point value).
FGCSPU From GC Status Point Upper is the second status packed boolean from
the Gas Chromatograph (point value).
FGCSTM From GC Status Mask is a packed long bypass mask for GC status.
GCPER GC Personality is character array that holds the personality code from the
GC.
GCPER1 GC Personality 1 is long that holds the software version code of the GC.
GCPER2 GC Personality 2 is long that holds the user version code of the GC.
1032
49. ECB39 – AMSPRI B0193AX – Rev AA
GDESC1 to GDESC5
General Description 1 through 5 are user-defined strings for general
description of displays at the GC.
HWREV Hardware Revision is short that holds the hardware version code of the
FBM.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
LSTG16 Last Good Value 16 is a packed boolean value which is bit-mapped to the
ECB39 measurement parameters. The most significant bit of LSTG16
maps to the first point, the next most significant bit maps to the second
point, and so on. If a bit is set and the corresponding device value is Out-
of-Service or Bad, then only the status of the device value is copied into
the status of the point value, and the last good value of the point value is
preserved.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the
following period time lengths. (Integrator and Gateway blocks have differ-
ent period values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
1033
B0193AX – Rev AA 49. ECB39 – AMSPRI
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TGCB01 to TGCB32
To CG Boolean 1 to 32 are boolean outputs to the Gas Chromatograph.
TGCBM To GC Boolean Mask is a packed long bypass mask for masking booleans
to the GC.
TGCBSL To GC Booleans Lower are the first booleans to the Gas Chromatograph.
TGCBSU To GC Booleans Upper are the second booleans to the Gas Chromato-
graph.
TGCR1 to TGCR6
To GC Reals 1 through 6 are first through sixth real values to Gas Chro-
matograph.
1034
49. ECB39 – AMSPRI B0193AX – Rev AA
TGCRM To GC Real Mask is a packed boolean bypass mask for masking real values
to the GC.
TGCRS1 to TGCRS6
To GC Real Second 1 through 6 are real values of the second group of
outputs to the Gas Chromatograph.
TGCS1M to TGCS3M
To GC Status 1 to 3 Mask are boolean bypass masks for GC status 1 to 3.
TGCS1S to TGCS3S
To GC Status 1 to 3 Shadow are boolean bypass masks for GC status 1 to
3 shadow outputs.
TGCST1 to TGCST3
To GC Status 1 to 3 are the first through third packed boolean status out-
puts to the Gas Chromatograph
TGCSTL To GC Status Lower is the first status shadow output to the Gas
Chromatograph.
TGCSTU To GC Status Upper is the second status shadow output to the Gas Chro-
matograph.
TYPE When you enter “ECB39” or select “ECB39” from a configurator list, it
creates an identifying integer specifying this block type.
I/O Diagram
1035
B0193AX – Rev AA 49. ECB39 – AMSPRI
Detailed Operation
AMSPRI
Configuration, starting, and downloading are handled as in all other window ECBs.
During initialization, AMSPRI does a read back of its output data to the device and updates its
outputs accordingly.
During input scanning, the block moves data from the device input buffer into the Window ECB
outputs. Messages from the GC are set corresponding status and out-of-service bits in the block
outputs.
During output scanning, the block moves its outputs to the output buffer to be sent to the device.
AMSSEC
The AMSSEC block interrogate its associated AMSPRI Window ECB to determine if the second-
ary data in the AMSPRI input buffer has its data. If it has, the AMSSEC block moves its data
from the input buffer into its output parameters. The block also updates the status of the data.
Figure 49-3 shows how the real-time data flows to and from the GC to the AMSPRI input and
output value records.
Gas
Control Processor
Chromatograph
AMSPRI
Output Message
Input Message
Output Pnts
Shadow Outputs
Input Pnts
GCSEC
BLOCK
Output Pnts
1036
50. ECB41 – Analog Input FBC
This chapter covers the ECB41 (Analog Input FBC), providing a functional diagram and
parameters.
Functional Diagram
FBC21
AIN
ECB41 FBC01
MAIN FBC17
FBC02
AINR
Parameters
Table 50-1. ECB41 Parameters
1037
B0193AX – Rev AA 50. ECB41 – Analog Input FBC
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1038
50. ECB41 – Analog Input FBC B0193AX – Rev AA
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
1039
B0193AX – Rev AA 50. ECB41 – Analog Input FBC
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 errors does not proceed past the first error encountered
by the block logic. For ECB41, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the
PARAMETER VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE occurred.
BLOCK”
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
1040
50. ECB41 – Analog Input FBC B0193AX – Rev AA
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PARENT Parent ECB is a string. Parameter is the name of the ECB that is parent to
this child. Name of the ECB can be up to 12 chars, or 6 chars if it resides
in the ECB compound.
PARENT appears in a darker color indicating that this parameter was
determined by the FBM Fix operation and cannot be edited using the
FBM Configure function.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
1041
B0193AX – Rev AA 50. ECB41 – Analog Input FBC
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
TYPE When you enter “ECB41” or select “ECB41” from the block type list
under Show, an identifying integer is created specifying this block type.
1042
51. ECB42 – Digital Input FBC
This chapter covers the ECB42 (Digital Input FBC), providing a functional diagram and
parameters.
Functional Diagram
CIN
GDEV
Parameters
Table 51-1. ECB42 Parameters
1043
B0193AX – Rev AA 51. ECB42 – Digital Input FBC
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6
B10 5 4 3 2 1 0
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1044
51. ECB42 – Digital Input FBC B0193AX – Rev AA
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECB42, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
1045
B0193AX – Rev AA 51. ECB42 – Digital Input FBC
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the
PARAMETER VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
1046
51. ECB42 – Digital Input FBC B0193AX – Rev AA
OF_INP Offset to Inputs is the zero-based offset, in bytes, of the first block input
from the head of the block. It is used internally.
OF_OUT Offset to Outputs is the zero-based offset, in bytes, of the first block out-
put from the head of the block. It is used internally.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PARENT Parent ECB is a string. Parameter is the name of the ECB that is parent to
this child. Name of the ECB can be up to 12 chars, or 6 chars if it resides
in the ECB compound.
PARENT appears in a darker color indicating that this parameter was
determined by the FBM Fix operation and cannot be edited using the
FBM Configure function.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrator and Gate-
ways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
1047
B0193AX – Rev AA 51. ECB42 – Digital Input FBC
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
TYPE When you enter “ECB42” or select “ECB42” from the block type list
under Show, an identifying integer is created specifying this block type.
1048
52. ECB43 – Analog Output FBC
This chapter covers the ECB43 (Analog Output FBC), providing a functional diagram and
parameters.
Functional Diagram
AOUT
ECB43 FBC04
AOUTR
Parameters
Table 52-1. ECB43 Parameters
1049
B0193AX – Rev AA 52. ECB43 – Analog Output FBC
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1050
52. ECB43 – Analog Output FBC B0193AX – Rev AA
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
1051
B0193AX – Rev AA 52. ECB43 – Analog Output FBC
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 errors does not proceed past the first error encountered
by the block logic. For ECB43, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the
PARAMETER VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE occurred.
BLOCK”
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
FSD01 to FSD16 Failsafe, channel 1 to 16 Data, is an unsigned integer input that specifies
the fallback value for the channel 1 to 16 output, and is written to the fall-
back value register.
The value represents the D/A raw count and is related to the intended sig-
nal conditioning. For example, if this output is going to a 4 to 20 mA
device (output engineering units range of 0 to 100% is equivalent to a raw
count range of 12800 to 64000), then FSD01 to FSD16 is typically
within that range ± 2%.
The formula for determining the count value is:
Count Value = ((Eng Value - Low Scale) / (High Scale - Low Scale)) *
Span Count+ Offset Count
For example, for a 4 to 20 mA device, determine the count for a fallback
value of 25 percent of full scale:
Count Value = ((25 - 0) / (100 - 0)) * (64000 - 12800) + 12800 =
25600
1052
52. ECB43 – Analog Output FBC B0193AX – Rev AA
Fallback values can range from 0 to 65535 counts. You may enter the
value using the decimal or hexadecimal notation. Hexadecimal entry has a
range of 0x0000 to 0xFFFF, representing a decimal range of 0 to 65535.
For decimal entry, the configurator considers this parameter to be a signed
integer. For a value in the range 0 to 32767, enter the count value. For a
value in the range 32768 to 65535, enter the count value minus 65536.
For example, to get a count of 62000, enter -3536.
Sample count values for a 4 to 20 mA output device are listed in the fol-
lowing table.
Entry Notation
% Count Value (Decimal) (Hexadecimal)
-2 11776 11776 0x2E00
0 0 0 0x0
0 12800 12800 0x3200
25 25600 25600 0x6400
50 38400 -27136 0x9600
75 51200 -14336 0xC800
100 64000 -1536 0xFA00
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
1053
B0193AX – Rev AA 52. ECB43 – Analog Output FBC
FSMM1 to FSMM2
Each of the Failsafe Mask 1 to 2 parameters contains one byte which spec-
ifies the Failsafe action to be taken by the corresponding group of eight
outputs. In FSMM1, bit 7 (msb) specifies the action for output 1, while
bit 0 (lsb) defines the action to be taken by output 8. Bit 7 in FSMM2
determines the Failsafe action for output 9, and so on up to output 16,
which is controlled by bit 0 in FSMM2. When the control bit is set to 0,
the output uses a predetermined Failsafe value, and when it is set to 1 the
output holds the last value.
Parameter Bit 7 6 5 4 3 2 1 0
FSMM1 Channel 1 2 3 4 5 6 7 8
FSMM2 Channel 9 10 11 12 13 14 15 16
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
# Description
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
1054
52. ECB43 – Analog Output FBC B0193AX – Rev AA
# Description
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PARENT Parent ECB is a string. Parameter is the name of the ECB that is parent to
this child. Name of the ECB can be up to 12 chars, or 6 chars if it resides
in the ECB compound.
PARENT appears in a darker color indicating that this parameter was
determined by the FBM Fix operation and cannot be edited using the
FBM Configure function.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrator and Gate-
ways, PERIOD values range from 0 to 13 and map to the
following period time lengths. (Integrator and Gateway blocks have differ-
ent period values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
1055
B0193AX – Rev AA 52. ECB43 – Analog Output FBC
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
TYPE When you enter “ECB43” or select “ECB43” from the block type list
under Show, an identifying integer is created specifying this block type.
1056
53. ECB44 – Digital Output FBC
This chapter covers the ECB44 (Digital Output FBC), providing a functional diagram and
parameters.
Functional Diagram
VLV
COUT
GDEV
ECB44 FBC09
MOVLV
MTR
MCOUT
Parameters
Table 53-1. ECB44 Parameters
1057
B0193AX – Rev AA 53. ECB44 – Digital Output FBC
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to
-32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1058
53. ECB44 – Digital Output FBC B0193AX – Rev AA
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
1059
B0193AX – Rev AA 53. ECB44 – Digital Output FBC
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 errors does not proceed past the first error encountered
by the block logic. For ECB44, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the
PARAMETER VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE occurred.
BLOCK”
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSDM1 to FSDM4
Each of these parameters contains a byte that specifies the failsafe values
for a group of eight output channels. Bit 7 (MSB) in FSDM1 specifies the
failsafe value for channel 1 on the module, bit 7 in FSDM2 is the failsafe
value for channel 9, and so on. Note that the failsafe value can be either 1
or 0. The value is used by the channel if its bit in the FSMMx parameters
is set to 0.
1060
53. ECB44 – Digital Output FBC B0193AX – Rev AA
Parameter Bit 7 6 5 4 3 2 1 0
FSDM1 Channel 1 2 3 4 5 6 7 8
FSDM2 Channel 9 10 11 12 13 14 15 16
FSDM3 Channel 17 18 19 20 21 22 23 24
FSDM4 Channel 25 26 27 28 29 30 31 32
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
FSMM1 to FSMM4
Each of the Failsafe Mask 1 to 4 parameters contains one byte which spec-
ifies the Failsafe action to be taken by the corresponding group of eight
outputs. In FSMM1, bit 7 (msb) specifies the action for output 1, while
bit 0 (lsb) defines the action to be taken by output 8. Bit 7 in FSMM2
determines the Failsafe action for output 9, and so on up to output 32,
which is controlled by bit 0 in FSMM4. When the control bit is set to 0,
the output will use a predetermined Failsafe value, and when it is set to 1
the output will hold the last value.
Parameter Bit 7 6 5 4 3 2 1 0
FSMM1 Channel 1 2 3 4 5 6 7 8
FSMM2 Channel 9 10 11 12 13 14 15 16
FSMM3 Channel 17 18 19 20 21 22 23 24
FSMM4 Channel 25 26 27 28 29 30 31 32
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
1061
B0193AX – Rev AA 53. ECB44 – Digital Output FBC
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
PARENT Parent ECB is a string. Parameter is the name of the ECB that is parent to
this child. Name of the ECB can be up to 12 chars, or 6 chars if resides in
the ECB compound. PARENT appears in a darker color indicating that
this parameter was determined by the FBM Fix operation and cannot be
edited using the FBM Configure function.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators or Gate-
ways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
1062
53. ECB44 – Digital Output FBC B0193AX – Rev AA
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
TYPE When you enter “ECB44” or select “ECB44” from the block type list
under Show, an identifying integer is created specifying this block type.
1063
B0193AX – Rev AA 53. ECB44 – Digital Output FBC
1064
54. ECB46 – Digital Input/Digital
Output FBC
This chapter covers the ECB46 (Digital Input/Digital Output FBC), providing a functional
diagram and parameters.
Functional Diagram
CIN
MCIN
COUT
GDEV
ECB46 FBC10
MOVLV
MTR
VLV
MCOUT
1065
B0193AX – Rev AA 54. ECB46 – Digital Input/Digital Output FBC
Parameters
Table 54-1. ECB46 Parameters
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1066
54. ECB46 – Digital Input/Digital Output FBC B0193AX – Rev AA
BUSMID Bus Module Identification specifies the number of digital input channels
in the associated FBC. The values are as follows:
Value Digital I/O Channels
Blank or 32 32 digital input channels, 32 digital output channels
40 40 digital input channels, 24 digital output channels
48 48 digital input channels, 16 digital output channels
56 56 digital input channels, 8 digital output channels
64 64 digital input channels, 0 digital output channels
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
1067
B0193AX – Rev AA 54. ECB46 – Digital Input/Digital Output FBC
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 errors does not proceed past the first error encountered
by the block logic. For ECB46, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not
compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
1068
54. ECB46 – Digital Input/Digital Output FBC B0193AX – Rev AA
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
B9
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSDM1 to FSDM4
Each of these parameters contains a byte that specifies the failsafe values
for a group of eight output channels. Bit 7 (MSB) in FSDM1 specifies the
failsafe value for channel 33 (the first digital output channel) on the mod-
ule, bit 7 in FSDM2 is the failsafe value for channel 41 (the ninth digital
output channel), and so on. Note that the failsafe value can be either 1 or
0. The value is used by the channel if its bit in the FSMMx parameters is
set to 0.
Parameter Bit 7 6 5 4 3 2 1 0
FSDM1 Channel 33 34 35 36 37 38 38 40
FSDM2 Channel 41 42 43 44 45 46 47 48
FSDM3 Channel 49 50 51 52 53 54 55 56
FSDM4 Channel 57 58 59 60 61 62 63 64
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
FSENAB does not affect the Failsafe configuration. Setting FSENAB false does pre-
vent the FBM from going to the Failsafe state because of a CP-to-FBM communica-
tions failure, but it cannot prevent the FBM from going to Failsafe for any other
reason.
1069
B0193AX – Rev AA 54. ECB46 – Digital Input/Digital Output FBC
FSMM1 to FSMM4
Each of the Failsafe Mask 1 to 4 parameters contains one byte which spec-
ifies the Failsafe action to be taken by the corresponding group of eight
outputs. In FSMM1, bit 7 (msb) specifies the action for channel 33 (the
first digital output channel), while bit 0 (lsb) defines the action to be
taken by channel 40. Bit 7 in FSMM2 determines the Failsafe action for
channel 41, and so on up to channel 64, which is controlled by bit 0 in
FSMM4. When the control bit is set to 0, the output uses a predeter-
mined Failsafe value, and when it is set to 1 the output holds the last
value.
Parameter Bit 7 6 5 4 3 2 1 0
FSMM1 Channel 33 34 35 36 37 38 39 40
FSMM2 Channel 41 42 43 44 45 46 47 48
FSMM3 Channel 49 50 51 52 53 54 55 56
FSMM4 Channel 57 58 59 60 61 62 63 64
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM or FBC.
1070
54. ECB46 – Digital Input/Digital Output FBC B0193AX – Rev AA
PARENT Parent ECB is a string. Parameter is the name of the ECB that is parent to
this child. Name of the ECB can be up to 12 chars, or 6 chars if resides in
the ECB compound. PARENT appears in a darker color indicating that
this parameter was determined by the FBM Fix operation and cannot be
edited using the FBM Configure function.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
TYPE When you enter “ECB46” or select “ECB46” from the block type list
under Show, an identifying integer is created specifying this block type.
1071
B0193AX – Rev AA 54. ECB46 – Digital Input/Digital Output FBC
1072
55. ECB47 – FBP10 Interface to
Cluster I/O
This chapter gives a general overview of the ECB47 (FBP10 Interface to Cluster I/O),
providing functional and I/O diagrams and describing its features, parameters and detailed
operations.
Overview
The FBP10 serves as a communications interface for the attached FBCs, and its ECB (ECB47)
serves as a parent for the individual child ECBs of the FBCs in the cluster. The ECB47 retains and
reports various types of status information for the FBCs, as well as the status of the FBP10 itself.
The ECB47 does not contain any dynamic data. This data is stored in a buffer within the FBP10
memory corresponding to each FBC.
At 100 millisecond intervals, the FBP10 scans its attached FBCs and reads status and data from
the FBC input channels into packets in its memory. These packets are updated with each FBC
scan cycle.
The FBP10 responds to read requests from the CP by sending the status and data from its data-
base for the requested FBC to the CP. The CP then stores the data, which has been scaled from
the 12-bit resolution to the 16-bit I/A Series standard, in the child ECB for that FBC.
The output types of control blocks transmit data to the child ECBs during block processing.
These output values are held in the ECBs until the next Fieldbus scan delivers the values to the
FBP10 database. The FBP10 updates the database for the addressed FBC, and at the next FBC
scanning cycle the stored data is scaled from 16 to 12 bits and delivered to the output FBC.
Functional Diagram
ECB47 FBC10
1073
B0193AX – Rev AA 55. ECB47 – FBP10 Interface to Cluster I/O
Features
The features are:
♦ Conversion between 12-bit and I/A Series (16-bit) resolution
♦ Centralized communication control
♦ Failsafe reporting for cluster
♦ Detection/reporting of non-installed FBCs
♦ Detection/reporting of non-configured FBCs
♦ Detection/reporting of incorrectly configured FBCs
♦ Centralized initialization of FBCs in cluster
♦ Offloading of memory requirements of individual FBCs.
The options are:
♦ Fan/Power Detection option
♦ Error Reporting option
♦ Bus switching enable/disable.
Parameters
Table 55-1. ECB47 Parameters
1074
55. ECB47 – FBP10 Interface to Cluster I/O B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1075
B0193AX – Rev AA 55. ECB47 – FBP10 Interface to Cluster I/O
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
CRDST1 to CRDST4
Card Status 1 is a bit mapped parameter which shows the I/O cards’ sta-
tus. The MSB corresponds to the first I/O card, and the LSB to card 32. If
a bit is set the card has a hardware fault or configuration mismatch.
CRDST2 is similar to CRDST1 but for cards 33 to 64.
CRDST3 is similar to CRDST1 but for cards 65 to 96.
CRDST4 is similar to CRDST1 but for cards 97 to 128.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
1076
55. ECB47 – FBP10 Interface to Cluster I/O B0193AX – Rev AA
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 errors does not proceed past the first error encountered
by the block logic. For ECB47, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FANPWR Fan Power is a configurable boolean parameter used to specify the fan
power option in a cluster I/O system.
FBPSTA FBP Status is a packed long parameter that indicates the status of the
FBP10. Individual bits in this parameter can be connected to the input of
a STALM or MSG block to generate process alarm and state change mes-
sages. The following bit assignments are currently defined to indicate sta-
tus conditions. (Bit 31 is the msb and bit 0 is the lsb).
Bit FBP10 Status
0 There is a letterbug conflict for some slot.
1 The Fieldbus bus has failed.
14 There has been a power or fan failure.
25 The redundant (backup) Fieldbus has failed.
29 The FBP10 database has changed. This bit is reset when a
CP read request has been served.
30 At least one output-type FBC is in the Failsafe state.
1077
B0193AX – Rev AA 55. ECB47 – FBP10 Interface to Cluster I/O
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
NCONF1 to NCONF4
Not Configured 1 is a packed long parameter which provides an index of
which Cluster I/O enclosure slots are configured. The first bit (msb) is for
slot 1 where the FBP10 is installed, the next bit is for slot 2 and so on.
When the bit is 1, no configuration information has been downloaded for
this slot; when the bit is 0, there is information for the configuration. This
parameter only indicates the presence of configuration data, not whether
it is correct.
NCONF2 is similar to NCONF1 but for cards 33 to 64.
NCONF3 is similar to NCONF1 but for cards 65 to 96.
NCONF4 is similar to NCONF1 but for cards 97 to 128.
NINST1 to NINST4
Not Installed 1 is a packed long parameter that shows which slots in the
Cluster I/O enclosure are filled and which are empty. The first bit (msb) is
for slot 1 where the FBP10 is installed, the next bit is for slot 2, and so on.
When the bit is 0, the slot is empty; when the bit is 1, there is a module
installed. This parameter only indicates whether a module is physically
installed in the slot, not whether it is configured.
NINST2 is similar to NINST1 but for cards 33 to 64.
NINST3 is similar to NINST1 but for cards 65 to 96.
NINST4 is similar to NINST1 but for cards 97 to 128.
NMTCH1 to NMTCH4
The No Match 1 parameter is used to flag any mismatch between the
modules actually Installed in the Cluster I/O enclosure and the way they
are configured. The first bit (msb) is for slot 1, where the FBP10 is
installed; the next bit is for slot 2, and so on. When the bit is 0, the config-
uration matches the module in the slot. (An empty slot is considered
1078
55. ECB47 – FBP10 Interface to Cluster I/O B0193AX – Rev AA
matched by lack of configuration data for the slot). When the bit is 1,
there is a mismatch between the installation and the configuration data.
NMTCH2 is similar to NMTCH1 but for cards 33 to 64.
NMTCH3 is similar to NMTCH1 but for cards 65 to 96.
NMTCH4 is similar to NMTCH1 but for cards 97 to 128.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
1079
B0193AX – Rev AA 55. ECB47 – FBP10 Interface to Cluster I/O
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
TYPE When you enter “ECB47” or select it from a configurator list, it creates an
identifying integer specifying this block type.
UPLREQ Upload Request is a boolean input (0 = false; 1 = true). When set to 1, the
ECB, through the PIOMAINT, initiates the FBP10 database upload pro-
cedure to update the ECB non-dynamic data. When the upload is done,
UPLREQ is reset to 0.
I/O Diagram
Empty Slots
Error Reporting Option
Non-Configured Slots
Fan Power Monitor Option
Slot Configuration Mismatches
FBC in Failsafe
Period/Phase Database Change
Revision Levels
Fan or Power Failure
1080
55. ECB47 – FBP10 Interface to Cluster I/O B0193AX – Rev AA
Detailed Operation
When power is applied to the FBP10, it executes its power-up diagnostics, loads the resident soft-
ware from flash ROM to RAM, and reads its letterbug. If the last two digits of the letterbug do
not match the slot number (01), the status of the device is marked accordingly. The device status
is read on every Fieldbus scan, and made available to System Management.
On the first CP scan after the FBP10 has indicated Ready status, the CP downloads configuration
data for each FBC in the cluster, including Failsafe masks and fallback values for each FBC. If
there is a mismatch between the card type as specified in the configuration data and the actual
card installed, the FBP10 sets the individual FBC status as errored.
The FBP10 then initializes each module in the cluster according to the locally stored configura-
tion, and the FBCs operate with these settings until the configuration is changed, either by Sys-
tem Management or via the Integrated Control Configurator.
On the next input scan, the CP reads the FBC data and status information for each FBC sched-
uled to be processed in that period and phase, from the FBP10 database, and updates the appro-
priate child ECBs.
On each output scan, the CP transfers the output data from those output-type control blocks
scheduled for that period/phase, and stores the data in the appropriate child ECB.
Within each scan, the ECBs are processed in the order that they were installed into the CP data-
base, and according to the proper periods and phases, except that the parent (ECB47) is processed
before its children. This allows the children to be turned OFF in the same processing cycle as the
parent is turned OFF, and similarly for an OFF-to-ON transition of the parent.
CONTROL PROCESSOR
FBC
FBC PARENT
Comm. Status
PIO Bus
FBP10 Messages Cluster Status
ECB47 Control
FBC Failsafe
Cluster Controls
Strategy
Data
Data CHILD FBC Status
ECB
FBC
Data
Data CHILD
ECB FBC Status
1081
B0193AX – Rev AA 55. ECB47 – FBP10 Interface to Cluster I/O
1082
56. ECB47R – Redundant FBP10
Interface to Cluster I/O
This chapter gives a general overview of the ECB47R (Redundant FBP10 Interface to
Cluster I/O), providing functional and I/O diagrams and describing its features, parameters
and detailed operations.
Overview
Redundant Fieldbus Processor 10 (FBP10) cards serve as a communications interface for the
attached Fieldbus Cards (FBCs) in a Fieldbus Cluster I/O subsystem. The ECB47R serves as a
parent for the individual child ECBs of the FBCs in the cluster. The ECB47R retains and reports
various types of status information for the FBCs, as well as the status of the redundant FBP10s.
The ECB47R does not contain any dynamic data. This data is stored in a buffer within the
FBP10 memory corresponding to each FBC.
The primary FBP10 is the only card of a redundant pair that communicates with the CP via
ECB47R and the child ECBs. Both the primary and secondary FBP10s maintain communica-
tions with the FBCs and monitor each other’s state. If the primary FBP10 fails, the secondary
FBP10 immediately assumes control of the communications between the CP and the FBCs.
At 100 millisecond intervals, the FBP10 scans its attached FBCs and reads status and data from
the FBC input channels into packets in its memory. These packets are updated with each FBC
scan cycle.
The FBP10 responds to read requests from the CP by sending the status and data from its data-
base for the requested FBC to the CP. The CP then stores the data, which has been scaled from
the 12-bit resolution to the 16-bit I/A Series standard, in the child ECB for that FBC.
The output types of control blocks transmit data to the child ECBs during block processing.
These output values are held in the ECBs until the next Fieldbus scan delivers the values to the
FBP10 database. The FBP10 updates the database for the addressed FBC, and at the next FBC
scanning cycle the stored data is scaled from 16 to 12 bits and delivered to the output FBC.
1083
B0193AX – Rev AA 56. ECB47R – Redundant FBP10 Interface to Cluster I/O
Functional Diagram
FBP10
ECB47R*
FBP10
Features
The features are:
♦ Redundant FBP10 card support.
♦ FBP10 status reporting
♦ Conversion between 12-bit and I/A Series (16-bit) resolution
♦ Centralized communication control
♦ Failsafe reporting for cluster
♦ Detection/reporting of non-installed FBCs
♦ Detection/reporting of non-configured FBCs
♦ Detection/reporting of incorrectly configured FBCs
♦ Centralized initialization of FBCs in cluster
♦ Offloading of memory requirements of individual FBCs.
The options are:
♦ Fan power option
♦ Error reporting option
♦ Bus switching enable/disable.
1084
56. ECB47R – Redundant FBP10 Interface to Cluster I/O B0193AX – Rev AA
Parameters
Table 56-1. ECB47R Parameters
1085
B0193AX – Rev AA 56. ECB47R – Redundant FBP10 Interface to Cluster I/O
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to -
32768.
ACTION Equipment Change Action is a 16-bit, packed boolean that indicates the
key action(s) requested on the SMDH Equipment Change display for the
FBP10. The following table lists the supported actions:
Action Packed Boolean Value
Main Module Request 0x0001
Backup Module Request 0x0002
Reset Error Counters 0x0004
Mode Switch 0x0008
Go On-line 0x0010
Go Off-line 0x0020
EEPROM Update 0x0040
Cold Start 0x0080
HDLC Bus A Enable; Bus B Disable 0x0100
HDLC Bus B Enable; Bus A Disable 0x0200
HDLC Bus A Enable; Bus B Enable 0x0400
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
CRDST1 to CRDST4
Card Status 1 is a bit mapped parameter which shows the I/O cards’ sta-
tus. The MSB corresponds to the first I/O card, and the LSB to card 32. If
a bit is set the card has a hardware fault or configuration mismatch.
CRDST2 is similar to CRDST1 but for cards 33 to 64.
CRDST3 is similar to CRDST1 but for cards 65 to 96.
CRDST4 is similar to CRDST1 but for cards 97 to 128.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
1086
56. ECB47R – Redundant FBP10 Interface to Cluster I/O B0193AX – Rev AA
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBP10. It must end in 01, even for a
redundant FBP10.
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECB47R, the following list specifies the possible
values of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
1087
B0193AX – Rev AA 56. ECB47R – Redundant FBP10 Interface to Cluster I/O
Message Value
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FANPWR Fan Power is a configurable boolean parameter used to specify the fan
power option in a cluster I/O system. Set this parameter to 1 when the
PM20/20B Power Monitor Module is installed for the Fieldbus Cluster.
FBPSTA FBP Status is a packed long parameter that indicates the status of the
FBP10. Individual bits in this parameter can be connected to the input of
a STALM or MSG block to generate process alarm and state change mes-
sages. The following bit assignments are currently defined to indicate sta-
tus conditions.
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
B9
HWREV Hardware Revision is the revision level of the FBP10 that connects to this
ECB. Once HWREV is set, it cannot be edited via the Integrated Control
Configurator.
HWTYPE Hardware Type is the type of device that connects to this ECB. Enter 87
in this parameter to specify the hardware type for the redundant FBP10.
Once HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
1088
56. ECB47R – Redundant FBP10 Interface to Cluster I/O B0193AX – Rev AA
LADDR Logical Address of the primary FBP10 is a short data store that is assigned
by the CP only.
NCONF1 to NCONF4
Not Configured 1 is a packed long parameter which provides an index of
which Cluster I/O enclosure slots are configured. The first bit (msb) is for
slot 1 where the FBP10 is installed, the next bit is for slot 2 and so on.
When the bit is 1, no configuration information has been downloaded for
this slot; when the bit is 0, there is information for the configuration. This
parameter only indicates the presence of configuration data, not whether
it is correct.
NCONF2 is similar to NCONF1 but for cards 33 to 64.
NCONF3 is similar to NCONF1 but for cards 65 to 96.
NCONF4 is similar to NCONF1 but for cards 97 to 128.
NINST1 to NINST4
Not Installed 1 is a packed long parameter that shows which slots in the
Cluster I/O enclosure are filled and which are empty. The first bit (msb) is
for slot 1 where the FBP10 is installed, the next bit is for slot 2, and so on.
When the bit is 0, the slot is empty; when the bit is 1, there is a module
installed. This parameter only indicates whether a module is physically
installed in the slot, not whether it is configured.
NINST2 is similar to NINST1 but for cards 33 to 64.
NINST3 is similar to NINST1 but for cards 65 to 96.
NINST4 is similar to NINST1 but for cards 97 to 128.
NMTCH1 to NMTCH4
The No Match 1 parameter is used to flag any mismatch between the
modules actually Installed in the Cluster I/O enclosure and the way they
are configured. The first bit (msb) is for slot 1, where the FBP10 is
installed; the next bit is for slot 2, and so on. When the bit is 0, the config-
uration matches the module in the slot. (An empty slot is considered
matched by lack of configuration data for the slot). When the bit is 1,
there is a mismatch between the installation and the configuration data.
NMTCH2 is similar to NMTCH1 but for cards 33 to 64.
NMTCH3 is similar to NMTCH1 but for cards 65 to 96.
NMTCH4 is similar to NMTCH1 but for cards 97 to 128.
1089
B0193AX – Rev AA 56. ECB47R – Redundant FBP10 Interface to Cluster I/O
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device is failed
1 Communication is failed
2 Ride through
3 Go maintenance off
4 Go ECB off
5 Going on
6 Module is OK
7 Maintenance is off
8 ECB is off
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec.,
but the PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec.,
but the PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec.,
but the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as
5.0 sec., but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, CP60, FCP270, and ZCP270.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
1090
56. ECB47R – Redundant FBP10 Interface to Cluster I/O B0193AX – Rev AA
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
RDSTAT Redundant FBP Status is a packed boolean output parameter that indi-
cates the status of the redundant FBP10. Individual bits in this parameter
can be connected to the input of a STALM or MSG block to generate pro-
cess alarm and state change messages. The following bit assignments are
currently defined to indicate status conditions.
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Value (Hex.) FBP10 Status
0x0001 Slot 1 communication is failed
0x0002 Slot 2 communication is failed
0x0004 Slot 1 device is failed
0x0008 Slot 2 device is failed
0x0010 Slot 1 is not ready
0x0020 Slot 2 is not ready
0x0040 Slot 1 is off-line
0x0080 Slot 2 is off-line
0x0100 Slot 1 is active
0x0200 Slot 2 is active
* Bit 0 is the least significant, low order bit.
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type (47 for redundant FBP10s) is the ECB type. After
SWTYPE is configured, it appears in a darker color indicating that this
parameter cannot be edited using the FBM Configure function.
TLADDR Logical Address of the tracking module is a short data store parameter.
TYPE When you enter “ECB47R” or select it from a configurator list, it creates
an identifying integer specifying this block type.
UPLREQ Upload Request is a boolean input (0 = false; 1 = true). When set to 1, the
ECB, through the PIOMAINT, initiates the FBP10 database upload pro-
cedure to update the ECB non-dynamic data. When the upload is done,
UPLREQ is reset to 0.
1091
B0193AX – Rev AA 56. ECB47R – Redundant FBP10 Interface to Cluster I/O
I/O Diagram
FBP10 Status
Empty Slots
Error Reporting Option
Non-Configured Slots
Fan Power Monitor Option
Slot Configuration Mismatches
FBC in Failsafe
Period/Phase Database Change
Revision Levels
Fan or Power Failure
Detailed Operation
The primary FBP10 is the only card of a redundant pair that communicates with the CP via
ECB47R and the child ECBs (see Figure 56-3). Both the primary and secondary FBP10s main-
tain communications with the FBCs and monitor each other’s state. If the primary FBP10 fails,
the secondary FBP10 immediately assumes control of the communications between the CP and
the FBCs.
When power is applied to the FBP10, it executes its power-up diagnostics, loads the resident soft-
ware from flash ROM to RAM, and reads its letterbug. If the last two digits of the letterbug do
not match the slot number (01), the status of the device is marked accordingly. The device status
is read on every Fieldbus scan, and made available to System Management.
On the first CP scan after the FBP10 has indicated Ready status, the CP downloads configuration
data for each FBC in the cluster, including Failsafe masks and fallback values for each FBC. If
there is a mismatch between the card type as specified in the configuration data and the actual
card installed, the FBP10 sets the individual FBC status as errored.
The FBP10 then initializes each module in the cluster according to the locally stored configura-
tion, and the FBCs operate with these settings until the configuration is changed, either by Sys-
tem Management or via the Integrated Control Configurator.
On the next input scan, the CP reads the FBC data and status information for each FBC sched-
uled to be processed in that period and phase, from the FBP10 database, and updates the appro-
priate child ECBs (see Figure 56-3).
On each output scan, the CP transfers the output data from those output-type control blocks
scheduled for that period/phase, and stores the data in the appropriate child ECB.
1092
56. ECB47R – Redundant FBP10 Interface to Cluster I/O B0193AX – Rev AA
Within each scan, the ECBs are processed in the order that they were installed into the CP data-
base, and according to the proper periods and phases, except that the parent (ECB47R) is pro-
cessed before its children. This allows the children to be turned OFF in the same processing cycle
as the parent is turned OFF, and similarly for an OFF-to-ON transition of the parent.
FBC Parent
Comm. Status
PIO Bus
Messages Cluster Status
Primary
FBP10 ECB47R
FBC Failsafe
Cluster Controls
Data Control
Data Strategy
Child
ECB FBC Status
Second.
FBP10
Data
Data Child
ECB FBC Status
FBC
1093
B0193AX – Rev AA 56. ECB47R – Redundant FBP10 Interface to Cluster I/O
1094
57. ECB52 – DPIDA Controller
This chapter covers the ECB52 (DPIDA Controller), providing a functional diagram and
parameters.
Functional Diagram
FBM04
FBM17
FBM204
FBM227
Parameters
Table 57-1. ECB52 Parameters
1095
B0193AX – Rev AA 57. ECB52 – DPIDA Controller
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.
ACTION Equipment Change Action is a 16-bit, packed boolean, data store that is a
request from the Station Manager to perform an action related to a partic-
ular FBM:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1096
57. ECB52 – DPIDA Controller B0193AX – Rev AA
ATC Air-To-Close is a boolean input that specifies reversing the controller out-
put for use with air-to-close valves. If ATC is set true, the span of the FBM
analog output is reversed. For example, a 100% output drives 0 V dc or
4 mA, while a 0% output drives 10 V dc or 20 mA. Inversion does not
effect the OUT and BCALCO parameters.
CYCLE Cycle is a short integer input that represents the actual cycle time that the
controller is using, expressed in CYCTIM values. If FBM processor load-
ing is greater than the configured CYCTIM allows, the controller adap-
tively selects a slower CYCTIM value that allows it to handle the load.
CYCTIM Cycle Time is a short integer that specifies the cycle time of the controller
algorithm in 5 ms increments as follows:
Value Time (ms) Value Time (ms)
0 (default) 50 6 30
2 10 7 35
3 15 8 40
4 20 9 45
5 25 10 50
1097
B0193AX – Rev AA 57. ECB52 – DPIDA Controller
Processor power limits the options usable at fast cycles. If the cycle time is
too fast for the configured options, the FBM adaptively selects a slower
CYCTIM value that allows it to handle processor loading. 10 ms cycle
times are possible only for nonredundant measurement inputs without
characterizer or square root conditioning. 15 ms cycles can support input
signal conditioning or redundancy but not both.
NOTE
As the controller cycle time is reduced, the precision of the analog conversion is
reduced. See the FLTOP and FLTTIM parameter descriptions.
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
1098
57. ECB52 – DPIDA Controller B0193AX – Rev AA
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 errors does not proceed past the first error encountered
by the block logic. For ECB52, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FLTOPT Filter Option is a short integer input that specifies the number of sam-
pling windows for analog conversion averaging:
0= average over two sampling windows to provide anti-alias filter-
ing (default)
1= average over one sampling window
FLTTIM Filter Time is a short integer input that specifies the sampling window in 5
ms increments from 1 to the value of CYCTIM. The default value of 0
sets the sampling window equal to the controller cycle time. This is the
optimal setting for almost all cases.
Value Time (ms) Value Time (ms)
0 (default) CYCTIM 6 30
1 5 7 35
2 10 8 40
3 15 9 45
4 20 10 50
5 25
1099
B0193AX – Rev AA 57. ECB52 – DPIDA Controller
FS5DPD Failsafe channel 5 Data is an unsigned integer input that specifies the fall-
back value for the controller output, and is written to the fallback value
register.
The value represents the D/A raw count and is related to the intended sig-
nal conditioning. For example, if this output is going to a 4 to 20 mA
device (output engineering units range of 0 to 100% is equivalent to a raw
count range of 12800 to 64000), then FS5DPD is typically within that
range ± 2%.
The formula for determining the count value is:
Count Value = ((Eng Value - Low Scale) / (High Scale - Low Scale)) *
Span Count+ Offset Count
For example, for a 4 to 20 mA device, determine the count for a fallback
value of 25 percent of full scale:
Count Value = ((25 - 0) / (100 - 0)) * (64000 - 12800) + 12800 =
25600
Fallback values can range from 0 to 65535 counts. You may enter the
value using the decimal or hexadecimal notation. Hexadecimal entry has a
range of 0x0000 to 0xFFFF, representing a decimal range of 0 to 65535.
For decimal entry, the configurator considers this parameter to be a signed
integer. For a value in the range 0 to 32767, enter the count value. For a
value in the range 32768 to 65535, enter the count value minus 65536.
For example, to get a count of 62000, enter -3536.
Sample count values for a 4 to 20 mA output device are listed in the fol-
lowing table.
Entry Notation
% Count Value (Decimal) (Hexadecimal)
-2 11776 11776 0x2E00
0 0 0 0x0
0 12800 12800 0x3200
25 25600 25600 0x6400
50 38400 -27136 0x9600
75 51200 -14336 0xC800
100 64000 -1536 0xFA00
FSAFE Failsafe Map is a 32-bit data store that is bit-mapped to maintain the Fail-
safe state of each output channel related to the ECB. All bits are set by the
PIO/ECB interface when the FBM undergoes Failsafe at the module level.
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
B9
1100
57. ECB52 – DPIDA Controller B0193AX – Rev AA
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Failure
(or software) Failsafe state. This state asserts the output values specified by
the Failsafe configuration. PIO security commands (for example, heart-
beat, read-device status, and so forth) do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a boolean input that enables the FSDLAY timer.
When the FSDLAY timer expires while the FBM is waiting for a commu-
nication from the CP (Communications Failure), the FBM enters the
Failsafe state and takes the action specified by FSOPT.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
If communications fail with FSENAB set false, the FBM does not enter
Failsafe for this reason. Setting FSENAB false does not prevent the FBM
from going to Failsafe for other reasons, such as:
♦ FBM reboot
♦ EEPROM update
♦ FBM taken off-line from the System Management Displays
♦ Power failure
♦ FBM restart
FSMMPD Failsafe Mask Main for ECB Type 52 is a short integer input that specifies
the Failsafe action taken during FBM Failsafe mode for the analog and
digital outputs.
0 = fallback value
1 = Hold
FSOPT Failsafe Option specifies the action to be taken by the controller when a
Communications Failure occurs with FSENAB set true while the control-
ler is in Auto or Hold:
Upon Failsafe recovery from Hold, the controller goes to Auto.
0 = No mode change; control to last set point
1 = Go to Hold
2 = Go to Hold with output set Failsafe
3 = Go to Manual
4 = Go to Manual with output set Failsafe
Upon Failsafe recovery from Manual, the controller stays in Manual.
HMSCAL High Measurement Scale is an integer input (0 to 64000) that specifies the
FBM count value (default = 64000) that represents a measurement value
of 100.0%.
1101
B0193AX – Rev AA 57. ECB52 – DPIDA Controller
HORVAL High Out-of-Range Value is an integer input that specifies the high limit
in counts for range checking of the FBM measurement inputs MEASn
configured by REDOPT. If OORENB is set true and a measurement is
greater than this limit, its status is set Bad.
HOSCAL High Output Scale is an integer input (0 to 64000) that specifies the FBM
count value (default = 64000) that represents an output value of 100.0%.
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
INVDFI Invert Device Fail option is a boolean input that specifies inversion of the
Device Fail input (channel 10) in an FBM17 to determine the fail state of
the field device:
0 = No inversion
1 = Invert
LMSCAL Low Measurement Scale is an integer input (0 to 64000) that specifies the
FBM count value (default = 0) that represents a measurement value of
0.0%.
LORVAL Low-Out-of-Range Value is an integer input that specifies the low limit
for range checking of the FBM measurement inputs MEASn
configured by REDOPT. If OORENB is set true and a measurement is
less than this limit, its status is set Bad.
LOSCAL Low Output Scale is an integer input (0 to 64000) that specifies the FBM
count value (default = 0) that represents an output value of 0.0%.
NUMPTS Number of Points is a short integer input (2 to 9) that specifies the num-
ber of X, Y coordinates (default= 2) for characterizing the selected mea-
surement.
1102
57. ECB52 – DPIDA Controller B0193AX – Rev AA
OPSTAT Module Operational Status is a short integer data store that indicates the
following FBM operational status:
Value Definition
0 Device failed
1 Communications failed
2 Ride through
3 Go maintenance off
4 Go ECB off
5 Going on
6 Module OK
7 Maintenance off
8 ECB off
OUOM01 Output Message Index 0 is a short integer data store that specifies the off-
set in the ECB buffer of the output message from the CP to the FBM.
PERIOD Period is an indexed input that dictates the ECB52 input scan period and
allowable PHASE values. Use the same PERIOD and PHASE values for
the ECB52 and DPIDA blocks. PERIOD values range from 0 to 13 and
map to the following period time lengths:
Period Length Period Length
0 0.1 s 7 10 m
1 0.5 s* 8 60 m
2 1.0 s 9 0.2 s
3 2.0 s 10 5.0 s**
4 10 s 11 0.6 s*
5 30 s 12 6.0 s**
6 1m 13 0.050 s***
* If the basic processing cycle (BPC is set via the System Configurator) is
0.2 s this period is treated internally as 0.6 s, but the PERIOD parameter
remains 1.
** If the BPC is 2.0 s this period is treated internally as 6.0 s, but the
PERIOD parameter remains 10.
*** CP40 and CP40B.
PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. For a CP with a BPC of 0.5
s and a PERIOD of 2.0 s, the legal PHASE values are 0, 1, 2, and 3. Use
the same PERIOD and PHASE values for the ECB52 and DPIDA blocks.
Refer to the appropriate Integrated Control Software Concepts document
(B0700AG or B0193AW).
1103
B0193AX – Rev AA 57. ECB52 – DPIDA Controller
PNLOPT Panel Option is a boolean input that specifies the use of the local opera-
tor’s panel (Foxboro Deutschland) for manual operation of the controller
output in an FBM17.
0 = No panel
1 = Panel
REDOPT Redundancy Option is a short integer input that specifies redundant mea-
surement inputs MEASn for FBM04, FBM17, FBM204 and FBM227:
0 = no redundancy (default; channel 1 only)
1 = dual redundancy (channels 1 and 2)
2 = triple redundancy (channels 1, 2 and 3)
SQRENB Square Root Enable is a boolean input that enables or disables application
of the square root function to the scaled measurement.
0 = Disable (default)
1 = Enable
SWREV Software Revision is the revision level of the FBM software type ECB52.
Once SWREV is set, it cannot be edited via the Integrated Control Con-
figurator.
SWTYPE Software Type is the ECB52 type. Once SWTYPE is set, it cannot be
edited via the Integrated Control Configurator.
TYPE Type is a system-level mnemonic label indicating the block type. Enter
ECB52 or select ECB52 from the block type list under Show when con-
figuring the block.
X_1PD to X_9PD Integer input coordinate values for an 8-segment characterizer that condi-
tions the selected measurement when CHAREN is set true. The values
range from 0 to 4000 counts representing 0 to 100%. They must be
monotonically increasing.
Y_1PD to Y_9PD Integer output coordinate values of an 8-segment characterizer that condi-
tions the selected measurement when CHAREN is set true. They are
required to be monotonically increasing. The values range from 0 to 4000
counts representing 0 to 100%. They must be monotonically increasing.
1104
58. ECB53 – Analog Output
This chapter discusses ECB53 (analog output) and provides a functional diagram and
parameters.
Overview
The Equipment Control Block 53 (ECB53) provides the software interface for FBMs which sup-
port analog output signals only. ECB53 is used between the FBMs and the I/O blocks listed in
Figure 58-1. Redundant ECB53s are necessary to handle redundant analog output signals.
Functional Diagram
AOUTR FBM237(R)
ECB53
AOUT FBM37
Parameters
Table 58-1. ECB53 Parameters
1105
B0193AX – Rev AA 58. ECB53 – Analog Output
Parameter Definitions
ACHNGE Alternate Change is a integer output that is incremented each time a setta-
ble parameter is changed externally. It wraps around from 32767 to
-32768.
ACTION Equipment Change Action is a packed boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1106
58. ECB53 – Analog Output B0193AX – Rev AA
BUSWDS Bus Switch Disable is a boolean input that enables or disables FBM port
switching:
0 = Enable port switching
1 = Disable port switching
DEFINE Define is a boolean data store. When true, it indicates that the block has
no configuration errors. It is the inverse of UDEF in parameter BLKSTA.
When the block initializes, DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM.
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
B9
1107
B0193AX – Rev AA 58. ECB53 – Analog Output
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 errors does not proceed past the first error encountered
by the block logic. For ECB53, the following list specifies the possible val-
ues of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EXTYPE Expansion Type specifies the type of FBM expander module connected to
the main FBM. EXTYPE appears in a darker color, indicating that this
parameter was determined by the FBM Fix operation, and cannot be
edited using the FBM Configure function.
1108
58. ECB53 – Analog Output B0193AX – Rev AA
Sample count values for a 4 to 20 mA output device are listed in the fol-
lowing table.
Entry Notation
% Count Value (Decimal) (Hexadecimal)
-2 11776 11776 0x2E00
0 0 0 0x0
0 12800 12800 0x3200
25 25600 25600 0x6400
50 38400 -27136 0x9600
75 51200 -14336 0xC800
100 64000 -1536 0xFA00
FSAFE Failsafe Map is a 32-bit, packed long, data store that is bit-mapped to
maintain the Failsafe state of each output channel related to the ECB. All
bits are set by the PIO/ECB interface when the FBM undergoes Failsafe at
the module level.
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
B9
FSDLAY Failsafe Delay is a long integer input timer. When enabled by FSENAB, it
specifies (in units of 0.01 seconds), the length of time the FBM waits for a
communication from the CP before entering a Communications Fail (or
software) Failsafe state. This state asserts the output values specified by the
Failsafe configuration. PIO security commands (for example, heartbeat,
read-device status, and so forth), do not reset this timer.
For example, the default value of 1000 causes the FBM to wait 10 seconds
between CP communications before going to the Failsafe state, if
FSENAB is configured true.
FSENAB Failsafe Timer Enable is a configured boolean input. When true, it enables
the FSDLAY timer to detect a communications failure and place the FBM
in the Failsafe state. If communications fail with FSENAB false, there is
no failsafe activity.
0 = Disable FSDLAY timer
1 = Enable FSDLAY timer
NOTE
NOTE: FSENAB does not affect the Failsafe configuration. Setting FSENAB false
does prevent the FBM from going to the Failsafe state because of a CP-to-FBM
communications failure, but it cannot prevent the FBM from going to Failsafe for
any other reason.
1109
B0193AX – Rev AA 58. ECB53 – Analog Output
FSMM53 Failsafe Main Mask, ECB type 53 provides the eight bits to the hold/fall-
back register that determine how the eight output channels (01, 02, 03,
04, 05, 06, 07, and 08) respond during Failsafe. If the bit = 1, the output
goes to hold and takes its value from the current value register. If the bit =
0, the output goes to fallback and assumes the value from the fallback reg-
ister.
FSMM53 is digitally coded as follows:
Bit number 7 6 5 4 3 2 1 0 (LSB)
Channel number 08 07 06 05 04 03 02 01
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. Once HWREV is set, it cannot be edited via the Integrated
Control Configurator.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control
Configurator.
For a list of hardware types for FBM237, refer to DIN Rail Mounted Sub-
system User’s Guide (B0400FA).
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 COMM failed
2 Ride through
3 Go maint. off
4 Go ECB off
5 Going on
6 MOD ok
7 Maint. off
8 ECB off
OUOM01 Output Message Index 0 is a short data store specifying the offset in the
ECB buffer of the output message from the CP to the FBM.
1110
58. ECB53 – Analog Output B0193AX – Rev AA
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
SWREV Software Revision is the revision level of the ECB. SWREV appears in a
darker color indicating that this parameter was determined by the System
Configurator/Definition and cannot be edited using the FBM Configure
function.
SWTYPE Software Type is the ECB type. After SWTYPE is configured, it appears in
a darker color indicating that this parameter cannot be edited using the
FBM Configure function.
For a list of software types for FBM237, refer to DIN Rail Mounted Sub-
system User’s Guide (B0400FA).
TYPE When you enter “ECB53” or select “ECB53” from the block type list
under Show, an identifying integer is created specifying this block type.
1111
B0193AX – Rev AA 58. ECB53 – Analog Output
1112
59. ECB73 – Valve and Transmitter
Parent ECB
This chapter discusses ECB73 (the valve and transmitter parent ECB) and provides a
functional diagram and parameters.
Overview
The Equipment Control Block 73 (ECB73) provides the software interface to the Intelligent Posi-
tioner network with which it communicates. (For more details on the Intelligent Positioner, refer
to Intelligent Positioner (B0193VH).) Only one ECB73 per FBM is required, no matter how
many physical ports may be configured in this configuration. Configuration of more than one
ECB73 is not needed, but does not cause any errors. This block is created when the I/A Series
workstation is first booted up with no database yet added.
1113
B0193AX – Rev AA 59. ECB73 – Valve and Transmitter Parent ECB
Functional Diagram
AIN*
PNT
MEAS
REALM REALM
or PID or
MEALM MEALM
Optional Real (REALM) OUT or Optional Real (REALM)
or Measurement (MEALM) or Measurement (MEALM)
Alarm Block Alarm Block
AOUT**
To Displays and
Maintenance or
Data Collection
ECB74 ECB18
Water
Parameters
Table 59-1. ECB73 Parameters
1114
59. ECB73 – Valve and Transmitter Parent ECB B0193AX – Rev AA
1. PHASE range depends on the BPC, compound PERIOD and PHASE, and block PERIOD.
Parameter Definitions
ACHNGE A Change is an integer output that is incremented each time a settable
parameter is changed externally. It wraps around from 32767 to -32768.
ACTION Equipment Change Action is a packed Boolean data store that is a request
from the Station Manager to perform an action related to a
particular FBM. The format of the request is a 2-byte mask:
Bit 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Boolean B1 B2 B3 B4 B5 B6 B7 B8 B9 B10 B11 B12 B13 B14 B15 B16
BUSWDS Bus Switch Disable is a Boolean input that enables or disables FBM port
switching:
1115
B0193AX – Rev AA 59. ECB73 – Valve and Transmitter Parent ECB
DEFINE Define is a Boolean data store. When true, it indicates that the block has
no configuration errors. DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DEV_ID Device Identification is a text identifier used by the System Manager (dis-
plays and messages). The value used for the NAME parameter is com-
monly used for the DEV_ID parameter.
ECBSTA ECB Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the ECB73, only the following (unshaded) bits are used:
3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 9 8 7 6 5 4 3 2 1 0
1 0 9 8 7 6 5 4 3 2 1 0 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
B9
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 errors does not proceed past the first error encountered
by the block logic. The following list specifies the possible values of
ERCODE, and the significance of each value in this block:
1116
59. ECB73 – Valve and Transmitter Parent ECB B0193AX – Rev AA
HWREV Hardware Revision is the revision level of the FBM type that connects to
this ECB. For the Intelligent Positioner, the revision level is 43.
HWTYPE Hardware Type is the type of FBM that connects to this ECB. Hardware
Type is the number 43 for ECB73, and must be configured to 43.
NAME The text name identifies the ECB73. It is not configurable and cannot be
left blank.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. A block period must be an integral multiple
of its compound period. For stations, the PHASE number must be within
the range determined by the number of cycles in the specified period.
PERIOD values range from 0 to 13 and map to the following period time
1117
B0193AX – Rev AA 59. ECB73 – Valve and Transmitter Parent ECB
Period
Value Length Phase Values
0 0.1 sec [0] default
1 0.5 sec [0] default
2 1.0 sec [0, 1]
3 2.0 sec [0, 1, 2, 3]
4 10 sec [0 to 19]
5 30 sec [0 to 59]
6 1 min [0 to 119]
7 10 min [0 to 119]
8 1 hour [0 to 7199]
9 0.2 sec [0] default
10 5.0 sec [0 to 9]
11 600 ms non-cfg
12 6 sec non-cfg
131 50 ms ---
1. CP40 Only
! CAUTION
When configuring the block PERIOD, make sure that the block PHASE value is
within the valid range for that PERIOD. An invalid PHASE value is not flagged by
the ICC and results in the block not being processed.
PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. The PHASE value defaults
to 0 and is best left at 0 unless processor loading factors compel you to
consider phase configuration. See “Block Phasing” in Integrated Control
Software Concepts (B0193AW) before attempting phase configuration.
1118
59. ECB73 – Valve and Transmitter Parent ECB B0193AX – Rev AA
SELRD Selective Read is a configurable packed long parameter that allows you to
specify which channels from Intelligent Positioners require real-time scan-
ning. The bit masks contained in this parameter are not defined, and,
therefore, not in use by the Intelligent Positioner. It should be left config-
ured to the default value of -1.
SWTYPE Software Type is the number 73 for the ECB73 and is not configurable.
TYPE Block Type for this ECB is ECB73 and is not configurable.
Application Example
In an I/A Series workstation with Intelligent Positioners, a compound typically contains:
♦ An ECB74 to transfer data to and from an Intelligent Positioner into the correspond-
ing ECB73, AOUT, and PID block.
♦ I/O blocks to get data from the ECB73 for further processing, or to write data to the
ECB73 for transmission to the Intelligent Positioner. The AOUT block is necessary to
provide characterization for the output signal.
♦ Data processing and control blocks which process the input data and generate output
data and alarm data to implement the control system design.
NOTE
If you wish to include alarming, add and configure a real (REALM) or measurement
(MEALM) alarm block, and link it to the PID block.
Figure 59-1 shows an illustration of a typical compound used with the Intelligent Positioner and
FBM43.
! CAUTION
The Intelligent Positioner must take the first port in the FBM43. The ECB74 and
AOUT software require the positioner’s communications to be assigned to this first
channel (PNT_NO must equal 1).
Blocks in other compounds get their inputs from and send their outputs to the ECB74 blocks,
using peer-to-peer connections. These compounds have no need for an ECB, and are not dis-
cussed in this document.
The following parameters are typically used when connecting other blocks to the ECB74:
♦ IOM_ID = COMPOUND:BLOCK of ECB74 (can be the letterbug if the com-
pound is a station _ECB and the block name is the letterbug of the Intelligent
Positioner)
♦ PNT_NO = 1
♦ SCO = 14
♦ IOMOPT = 0 or 2 (For AOUT, 1).
1119
B0193AX – Rev AA 59. ECB73 – Valve and Transmitter Parent ECB
! CAUTION
The IOMOPT parameter must not equal 1 for any block except the AOUT block;
the IOMOPT parameter must be set to 0 or 2 for all other blocks or they do not
function.
If you set IOMOPT to 0, you may use any valid SCI value to condition the input,
or use characterization, if available. If IOMOPT is set to 2, signal conditioning or
characterization are unavailable, and the values of SCI and EXTBLK are ignored.
1120
60. ECB74 – Valve and Transmitter
Child ECB
This chapter discusses ECB74 (the valve and transmitter child ECB) and provides a functional
diagram and parameters.
Overview
The Equipment Control Block 74 (ECB74) is used with the ECB73 to provides the software
interface to the Intelligent Positioner network with which it communicates. (For more details on
the Intelligent Positioner, refer to Intelligent Positioner (B0193VH).) When the ECB73 has been
successfully configured and is on-line, an ECB74 should be configured for each Intelligent Posi-
tioner with which the I/A Series workstation is to communicate. The ECB74 is used exclusively
for the definition of a Intelligent Positioner to be accessed by a I/A Series workstation. An ECB74
is a reserved block of memory that is allocated at the time the ECB is added to the database
through the ICC.
The ECB74 can be linked to graphics, historical data collection, and other blocks (such as the
AOUT) directly. Refer to Figure 60-1 for an illustration of an ECB74 in a compound.
1121
B0193AX – Rev AA 60. ECB74 – Valve and Transmitter Child ECB
Functional Diagram
AIN*
PNT
MEAS
REALM REALM
or PID or
MEALM MEALM
Optional Real (REALM) OUT or Optional Real (REALM)
or Measurement (MEALM) or Measurement (MEALM)
Alarm Block Alarm Block
AOUT**
To Displays and
Maintenance or
Data Collection
ECB74 ECB18
Water
Parameters
Table 60-1. ECB53 Parameters
1122
60. ECB74 – Valve and Transmitter Child ECB B0193AX – Rev AA
1123
B0193AX – Rev AA 60. ECB74 – Valve and Transmitter Child ECB
1124
60. ECB74 – Valve and Transmitter Child ECB B0193AX – Rev AA
1. PHASE range depends on the BPC, compound PERIOD and PHASE, and block PERIOD.
Parameter Definitions
ACCEPT Operator Accept Database Change is a non-connectable, settable Boolean
input.
ACTION Equipment Change Action is a packed Boolean data store that is a request
from the Station Manager to perform an action related to a particular
FBM. The format of the request is a 2-byte mask:
Bit 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Boolean B1 B2 B3 B4 B5 B6 B7 B8 B9 B10 B11 B12 B13 B14 B15 B16
ATC Air to Close control action: parameter indicates whether the valve is con-
nected in a normally open or normally closed configuration, and inverts
the Setpoint output from the AOUT block and inverts the Setpoint and
Position measurements:
0 = Direct, normal operation, no inversion
1 = Reverse acting, invert output and measurements.
It is a configurable, non-settable, non-connectable short integer.
Note that the overall system allows this action to be applied in three
places: the AOUT block, the ECB74, and inside the Intelligent
Positioner.
1125
B0193AX – Rev AA 60. ECB74 – Valve and Transmitter Child ECB
CCOUNT Cycle Count is a measurement that tallies the number of valve direction
changes (open/close). These changes must exceed a certain gap value (the
Cycle Limit, see below) to be included in the Cycle Count. It is a non-
configurable, non-settable, non-connectable long integer. (It is writable, to
zero, to reset the count.)
CLIMIT Cycle Limit is a value that contains the number of cycles (qualifying
motions occurring in either direction) necessary to trigger an alarm condi-
tion. When the Cycle Count equals or exceeds this number, an alarm bit is
raised in the Intelligent Positioner additional status (refer to “Additional
Status Bytes” on page 1134). It is a non-configurable, non-settable, non-
connectable long integer.
DEFINE Define is a Boolean data store. When true, it indicates that the block has
no configuration errors. DEFINE is set to 0 (undefined) if the block
detects a parameter configuration error. To return DEFINE to a true state,
correct all configuration errors and reinstall the block.
DELTI1 to DELTI5
Change Delta for Input Ranges 1 through 5 are real, non-connectable,
non-settable values that define the resolution as a percent of the
measurement range. Entering a 1 causes the Object Manager to recognize
and respond to a change of 1 percent of the full error range.
1126
60. ECB74 – Valve and Transmitter Child ECB B0193AX – Rev AA
DEV_ID Device Identification is a text identifier used by the System Manager (dis-
plays and messages). The value used for the NAME parameter is com-
monly used for the DEV_ID parameter.
ECBSTA ECB Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the ECB74, only the following (unshaded) bits are used:
3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 9 8 7 6 5 4 3 2 1 0
1 0 9 8 7 6 5 4 3 2 1 0 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
B9
1127
B0193AX – Rev AA 60. ECB74 – Valve and Transmitter Child ECB
EGU_1 to EGU_5
Engineering Units Measurement 1 to 5 are non-connectable, non-settable
6-character data stores. These units are associated with both the ECB18
and ECB74.
When configuring these units, if the menu has the units you desire for the
selected measurement, pick on that entry and ICC assigns the selected
units.
Custom enables you to enter units not included in the menu provided.
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 errors does not proceed past the first error encountered
by the block logic. The following list specifies the possible values of
ERCODE, and the significance of each value in this block:
FAILSF Fail-Safe mode indicates whether the valve utilizes its fail-safe capabilities
when it enters a fail-safe state. It is a non-configurable, non-settable, non-
connectable short integer:
0 = De-energize valve
1 = Hold
2 = Use user-defined fallback position.
FAILTM Fail-safe Watchdog Timer indicates how long, in seconds, the Intelligent
Positioner waits before entering a fail-safe state. Zero indicates that it will
never “time-out” and never enter this fail-safe state. It is a non-config-
urable, non-settable, non-connectable real.
FBPOS Fail-safe Fallback Position is the position that the valve moves to when it is
in fail-safe operation and the fallback option has been set to use the fall-
1128
60. ECB74 – Valve and Transmitter Child ECB B0193AX – Rev AA
HIALRM High-High Alarm is when the valve position exceeds this parameter, the
high alarm status bit in the secondary device status and additional status is
set. It is a non-configurable, non-settable, non-connectable real.
HIWARN High Alarm is when the valve position exceeds this parameter, the
Hi Warning status bit in the secondary device status and additional status
is set. It is a non-configurable, non-settable, non-connectable real.
HSCI1 to HSCI5 High Scale for Input Ranges 1 through 5 are real, non-connectable, non-
settable values that define the upper limit of the measurement ranges. You
should make the range and units consistent with the measurement source.
IFDTYP Intelligent Field Device Type indicates the type of Intelligent Positioner. It
should read SRD991. It is a non-configurable, non-settable, non-connect-
able integer.
IV2STA Valve Status is the valve’s channel, primary, and secondary status bytes. It
is a non-configurable, non-settable, connectable packed long (most signif-
icant bit to least significant bit = | reserved - unused | secondary status |
primary status | channel status |).
LOALRM When the valve position exceeds the Low-Low Alarm parameter, the low
alarm status bit in the secondary device status and additional status is set.
It is a non-configurable, non-settable, non-connectable real.
LOWARN When the valve position exceeds the Low Alarm parameter, the low warn-
ing status bit in the secondary device status and additional status is set. It
is a non-configurable, non-settable, non-connectable real.
LRL1 to LRL5 Lower Range Limits 1 through 5 are the limits for MEAS1 to MEAS5
respectively.
1129
B0193AX – Rev AA 60. ECB74 – Valve and Transmitter Child ECB
LSCI1 to LSCI5 Low Scale for Input Ranges 1 through 5 are real, non-connectable, non-
settable values that define the lower limit of the measurement ranges. You
should make the range and units consistent with those of the measure-
ment source.
NAME The Text Name identifies the ECB74. The value configured for the
NAME parameter of the ECB74 is used by all blocks (I/O blocks such as
the AOUT block) that wish to access the Intelligent Positioner. It is not
configurable or settable, and cannot be left blank.
NOERPT No Error Reporting, when set, inhibits that ECB74 block from generating
system alarms. It is a configurable, settable, non-connectable short integer.
OUOM01 Output Message Index 0 is a short integer data store that specifies the off-
set in the ECB buffer of the output message from the CP to the FBM.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. A block period must be an integral multiple
of its compound period. For stations other than gateways, the PHASE
number must be within the range determined by the number of cycles in
the specified period. PERIOD values range from 0 to 13 and map to the
following period time lengths and allowable PHASE values:
Period
Value Length Phase Values
0 0.1 sec [0] default
1 0.5 sec [0] default
2 1.0 sec [0, 1]
1130
60. ECB74 – Valve and Transmitter Child ECB B0193AX – Rev AA
Period
Value Length Phase Values
3 2.0 sec [0, 1, 2, 3]
4 10 sec [0 to 19]
5 30 sec [0 to 59]
6 1 min [0 to 119]
7 10 min [0 to 119]
8 1 hour [0 to 7199]
9 0.2 sec [0] default
10 5.0 sec [0 to 9]
11 600 ms non-cfg
12 6 sec non-cfg
131 50 ms ---
1.
CP40 only
! CAUTION
When configuring the block PERIOD, make sure that the block PHASE value is
within the valid range for that PERIOD. An invalid PHASE value is not flagged by
the ICC and results in the block not being processed.
PHASE Phase is an integer input that determines when the block executes. The
PHASE value defaults to 0 and is best left at 0 unless processor loading
factors compel you to consider phase configuration. See “Block Phasing”
in Integrated Control Software Concepts (B0193AW) before attempting
phase configuration.
POSITN Valve Position Measurement is the valve’s position that is normally mea-
sured as percent full scale. It is a non-configurable, non-settable, connect-
able real (default: 0.0 to 100.0%).
POSLIN The POSLIN parameter is the mounting compensation of the valve. This
byte field is either 3 (linear) or 2 (tangential/rotary). It is a non-config-
urable, non-settable, non-connectable short integer.
POWRUP Power Up Action controls how the valve behaves when power is applied:
1 = On-line:, hold current position as a de-energized valve
2 = Fail-safe: use fail-safe settings.
This parameter is a non-configurable, non-settable, non-connectable short
integer.
RI1 to RI5 Range Input is an array of real, non-connectable, non-settable values that
specify the high and low engineering scale and change delta of a particular
real input. For a given block, it also forms an association with a group of
1131
B0193AX – Rev AA 60. ECB74 – Valve and Transmitter Child ECB
real input parameters that have the same designated range and change
delta.
SEN1UN Sensor #1 Units indicates the units of measure for Sensor #1 (AUX2):
6 = PSIg
7 = kPa
12 = Bar
It is a non-configurable, non-settable, non-connectable short integer.
SEN2UN Sensor #2 Units indicates the units of measure for Sensor #2 (AUX3):
6 = PSIg
7 = kPa
12 = Bar
It is a non-configurable, non-settable, non-connectable short integer.
SETPNT Setpoint Measurement is a readback of the setpoint value that the valve is
currently using. It is a non-configurable, non-settable, connectable real
(default: 0.0 to 100.0%).
SPRING Spring Type is a byte field that specifies whether the spring opens (1), or
closes (2) the valve, or whether there is no spring at all (0). Only valid if
VALVAC parameter is single. This parameter is a non-configurable, non-
settable, non-connectable short integer.
SUMLIM Travel Sum Limit is a field that specifies the limit of how far the valve can
travel in its openings and closings. If the value is exceeded, an alarm con-
dition is raised in the Intelligent Positioner’s additional status area. It is a
non-configurable, non-settable, non-connectable long integer.
1132
60. ECB74 – Valve and Transmitter Child ECB B0193AX – Rev AA
TEMPUN Temperature Units is a byte field that specifies whether Celsius or Fahren-
heit degrees are used for the internal temperature sensor. It does not effect
internal temperature reports. It is a non-configurable, non-settable, non-
connectable short integer.
32 = Celsius
33 = Fahrenheit
TRVSUM Travel Sum is a four-byte integer field that contains the actual summarized
travel value in full strokes for the packing travel. Each change in the pack-
ing travel must exceed a deadband value in order to be counted in this
parameter, so as not to take jitter movement into account. Travel Sum is a
non-configurable, non-settable, non-connectable long integer. (It is reset-
table by a write of zero.)
TYPE Type is a system-level mnemonic label indicating the block type. Block
TYPE for this ECB is ECB74 and is non-configurable, non-settable, and
non-connectable.
URL1 to URL5 Upper Range Limits 1 to 5 are the limits for MEAS1 to MEAS5 respec-
tively.
VALVAC Actuator Action specifies whether the actuator acts in one or two direc-
tions:
1 = Single acting
2 = Double acting
It is a non-configurable, non-settable, non-connectable short integer.
VALVTY Valve Type specifies whether the Intelligent Positioner is designed to work
with various types of valves. This parameter indicates the type of valve to
which the Intelligent Positioner is currently connected:
1 = Rotary
3 = Globe
4 = Butterfly
5 = Ball
6 = Diaphragm
It is a non-configurable, non-settable, non-connectable short integer.
1133
B0193AX – Rev AA 60. ECB74 – Valve and Transmitter Child ECB
1 = Linear
2 = Equal Percentage
3 = Quick Open
4 = Custom
ZERCON Control Action indicates how the valve acts as an increasing setpoint sig-
nal is applied:
0 = Set +; Opens (Direct Acting)
1 = Set +; Closes (Reverse Acting)
It is a non-configurable, non-settable, non-connectable short integer.
Application Example
Refer to “Application Example” on page 1119.
The Additional Status bytes are four bytes that contain additional status information for the Intel-
ligent Positioner. The first byte contains the system errors. The second byte contains the process
errors. The error conditions indicated in the first and second bytes are reflected only as long as the
error remains. Once the underlying fault has been corrected, the first and second bytes indicate
the error is no longer present.
The third byte is a historical record of the first byte, which indicates conditions that have existed
but have been cleared. The fourth byte is a historical record of the second byte.
Each bit is separate.
The explanation of the activity or event associated with the setting of each bit in the first and third
bytes is as follows:
1134
60. ECB74 – Valve and Transmitter Child ECB B0193AX – Rev AA
0000 0000
(Bit Position: 7 6 5 4 3 2 1 0)
Note: 0 = good 1 = bad or subsequent action required
Figure 60-3. Additional Status Bytes – Second and Fourth
The explanation of the activity or event associated with the setting of each bit in the second and
fourth bytes is as follows:
Hexadecimal Bit
Value Position Set Condition
1 Bit 0 Indicates the travel position is above the high alarm setpoint.
2 Bit 1 Indicates the travel position is below the low alarm setpoint.
4 Bit 2 Indicates the travel position is above the high high alarm setpoint.
8 Bit 3 Indicates the travel position is below the low low alarm setpoint.
10 Bit 4 Difference between setpoint requested and current position
exceeds allowed for user specified time.
20 Bit 5 Autostart was run and did not complete successfully.
40 Bit 6 Air supply pressure (AUX3) has exceeded or dropped below
specified limits.
1135
B0193AX – Rev AA 60. ECB74 – Valve and Transmitter Child ECB
Hexadecimal Bit
Value Position Set Condition
80 Bit 7 Output pressure (AUX2) has exceeded or dropped below
specified limits.
0000 0000
(Bit Position: 7 6 5 4 3 2 1 0)
Note: 0 = good 1 = bad or subsequent action required
Figure 60-4. Valve Status No. 1
The explanation of the activity or event associated with the setting of each bit is shown in
Table 60-4:
Hexadecimal Bit
Value Position Set Condition
0 Bits 1, 0 These bits indicate the Intelligent Positioner’s current mode, as
follows:
♦ 00 – ON-LINE mode (normal)
1 Bits 1, 0 ♦ 01 – LOCAL mode (normal, only PC20 is allowed to
write setpoint)
2 Bits 1, 0 ♦ 10 – CALIBRATE mode (autostart)
3 Bits 1, 0 ♦ 11 – OFF-LINE mode (FAULT, off-line)
4 Bit 2 Indicates there has been an EEPROM burn request, or the
Intelligent Positioner is in an incorrect mode. The current
command issued is valid, but not currently executable.
0 Bits 4, 3 Indicates setpoint health, as follows:
♦ 00 – OK, operation of Intelligent Positioner is normal
1136
60. ECB74 – Valve and Transmitter Child ECB B0193AX – Rev AA
Hexadecimal Bit
Value Position Set Condition
8 Bits 4, 3 ♦ 01 – Warning condition, alarm is set but Intelligent
Positioner is still functional
10 Bits 4, 3 ♦ 10 – Error condition, the Intelligent Positioner is
non-functional (this error supersedes all warnings)
18 Bits 4, 3 ♦ 11 – Out of Service. Intelligent Positioner cannot operate the
setpoint because it is in OFF-LINE, LOCAL or CALIBRATE
mode.
20 Bit 5 Indicates a Current Diagnostic Error exists.
0 indicates that the current error condition has been corrected.
1 indicates that the current diagnostic error condition is valid and
corrective action must be taken.
40 Bit 6 Indicates an error has occurred that is described in the Secondary
Status. It requests FBM action to correct the error. Refer to
“VALVE STATUS NO. 2” on page 1137 to identify the error.
80 Bit 7 A 1 indicates the Intelligent Positioner is running in analog
(600 baud), and a 0 indicates if it is running in digital (4800 baud)
While this bit is set to 1 by default, it should be set to 0.
0000 0000
(Bit Position: 7 6 5 4 3 2 1 0)
Note: 0 = good 1 = bad or subsequent action required
Figure 60-5. Valve Status No. 2
The explanation of the activity or event associated with the setting of each bit is shown in
Table 60-5:
Hexadecimal Bit
Value Position Set Message Condition
1 Bit 0 Failsafe Timeout Currently in fail-safe time out.
1137
B0193AX – Rev AA 60. ECB74 – Valve and Transmitter Child ECB
Hexadecimal Bit
Value Position Set Message Condition
2 Bit 1 Additional Status Indicates an error has occurred that is
described in the Additional Status.
4 Bit 2 - Reserved, previously used to indicate a bad
FoxCom connection.
8 Bit 3 HI Alarm Exceeded Indicates the travel position is above the
high alarm setpoint.
10 Bit 4 LO Alarm Exceeded Indicates the travel position is below the
low alarm setpoint.
20 Bit 5 HI Warng Exceeded Indicates the travel position is above the
high high alarm setpoint.
40 Bit 6 LO Warng Exceeded Indicates the travel position is below the
low low alarm setpoint.
80 Bit 7 Ctrl Dif Out of R Difference between setpoint requested and
current position exceeds the amount
allowed for user-specified time.
1138
61. ECB110 – Interface for FCM10
Family of Devices
This chapter describes ECB110, which provides an I/A Series interface between a Control
Processor 60 (CP60) and a single or redundant module for the Fieldbus Communications
Module (FCM10) family of devices. These devices include: FCM10E, FCM10Ef,
WFCM10E, WFCM10Ef, FBI10E, FBI10Ef, DCM10E and DCM10Ef. A functional
diagram and parameter descriptions are provided.
Functional Diagram
FCM10
CP60 ECB110
FCM10
Parameters
Table 61-1. ECB110 Parameters
1139
B0193AX – Rev AA 61. ECB110 – Interface for FCM10 Family of Devices
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.
ACTION Equipment Change Action is a 16-bit, packed boolean that indicates the
key action(s) requested on the SMDH Equipment Change display for the
FCM110. The following table lists the supported actions:
Action Packed Boolean Value
Main Module Request 0x0001
Backup Module Request 0x0002
Reset Error Counters 0x0004
Mode Switch 0x0008
Go On-line 0x0010
Go Off-line 0x0020
EEPROM Update 0x0040
Cold Start 0x0080
HDLC Bus A Enable; Bus B Disable 0x0100
HDLC Bus B Enable; Bus A Disable 0x0200
HDLC Bus A Enable; Bus B Enable 0x0400
1140
61. ECB110 – Interface for FCM10 Family of Devices B0193AX – Rev AA
DEV_ID Device ID is a character array that specifies the 6-character letterbug iden-
tifier of the FCM10.
EADDRA Ethernet Address A is a string data store that contains the low-order hexa-
decimal digits of the Bus A MAC address of an FCM10. Its format is
“hhhhhh”, where each h = 0 to F. (The full MAC address is
00006Chhhhhh).
EADDRB Logical MAC Bus B address is a string data store that contains the low-
order hexadecimal digits of the Bus B MAC address of an FCM100. Its
format is “hhhhhh”, where each h = 0 to F. (The full MAC address is
00006Chhhhhh).
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
B9
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 errors does not proceed past the first error encountered
by the block logic. For ECB210, the following list specifies the possible
values of ERCODE, and the significance of each value in this block:
Message Value
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
1141
B0193AX – Rev AA 61. ECB110 – Interface for FCM10 Family of Devices
HWTYPE Hardware Type is the type of device that connects to this ECB. Once
HWTYPE is set, it cannot be edited via the Integrated Control Configu-
rator. HWTYPE must be set to 200.
LADDR Logical Address is the address assigned to the FCM10 as a secondary mod-
ule on the control station to FCM10 link.
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 Communication failed
2 Ride through
3 Go maintenance off
4 Go ECB off
5 Going on
6 Module OK
7 Maintenance off
8 ECB off
STATA Status of Link A is a 16-bit data store that is bit-mapped to indicate the
status of communications link A.
Packed Boolean Value Status
0x0000 FBI10E or DCM10E
0x0200 FCM10E or WFCM10E
0x0400 FCM10Ef or WFCM10Ef
0x0001 Bad FCM image (please download)
0x0010 Power #2 is lost
0x0020 Power #1 is lost
0x0800 2 Mbps, else 268 Kbps
0x4000 HDLC in loopback mode
0xFFFF No data
STATB Status of Link B is a 16-bit data store that is bit-mapped to indicate the
status of communications link B. See STATA parameter definition for a
description of the status values.
TYPE This is the block Type. When you enter “ECB110” or select it from a con-
figurator list, an identifying integer is created specifying this block type.
For this ECB, the value of TYPE is 310.
1142
62. ECB200 – Single Module DCI
FBM Interface
This chapter describes ECB200, which provides an I/A Series interface for single module DCI
FBMs. Functional diagrams and parameter descriptions are provided
Functional Diagram
Control
FBM
Blocks
ECB201* ECB200** See
See
Table 62-1
Table 62-1
Table 62-1. DCI FBMs and I/O Control Blocks Using ECB200
1143
B0193AX – Rev AA 62. ECB200 – Single Module DCI FBM Interface
Table 62-1. DCI FBMs and I/O Control Blocks Using ECB200
Parameters
Table 62-2. ECB200 Parameters
1144
62. ECB200 – Single Module DCI FBM Interface B0193AX – Rev AA
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.
ACTION Equipment Change Action indicates the key action(s) requested on the
SMDH equipment change page. The supported actions are:
1145
B0193AX – Rev AA 62. ECB200 – Single Module DCI FBM Interface
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
B9
1146
62. ECB200 – Single Module DCI FBM Interface B0193AX – Rev AA
maintenance cycle, the CP will perform the requested action. This gives
the redundant APACS modules time to take over control, if necessary,
before the action is performed. This behavior is used to force a switchover
if the Master module is the one selected to go off-line. Otherwise, the
switch will occur after the action and the associated blocks may be Out-
Of-Service for one BPC.
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 errors does not proceed past the first error encountered
by the block logic. For ECB200, the following list specifies the possible
values of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FBMSTS FBM Status is an output parameter of an ECB200 that indicates the status
of the FBM. It is based on the FBM reply to the Read Status command
from the control station.
Byte 0* Bit 0: 1 = DCI Configuration Ready
(supplied by FBM)
Bit 1: 1 = FBM Comm Fail
(supplied by control station)
Bit 2: 1 = FBM Off-Line
(supplied by control station)
Bit 3: 1 = DB Download Failed **
(supplied by FBM)
Bit 4: 1 = DB Download Active **
(supplied by FBM)
Bit 5: 1 = Unresolved Connection
(supplied by control station)
Bits 6 - 7 = 0 (reserved for future use)
1147
B0193AX – Rev AA 62. ECB200 – Single Module DCI FBM Interface
FBMTYP FBM Type is a 32-character array that identifies the type of FBM sup-
ported by a DCI parent ECB200.
FDATA1 FDATA1 is a 255 byte array that contains bytes 1-255 of the Port file
specified by FILEID and downloaded initially into the FBM224/230/232
via the DB_Download SMDH action key. When the download is com-
pleted, this data is uploaded automatically into the CP and saved in the
ECB200.
When used with DCI FBMs and FBM222, the DCI software provides
configuration data to a DCI FBM by downloading the FDATA1-
FDATA4 parameters of an ECB200, ECB201, or ECB202 automatically
to the DCI FBM when the FDATA1 parameter is written in the CP270.
This allows FBM222 configuration data to be downloaded without using
the DB download key actions.
FDATA2 FDATA2 is a 255 byte array that contains bytes 256-510 of the Port file
specified by FILEID and downloaded initially into the FBM224/230/232
via the DB_Download SMDH action key. When the download is com-
pleted, this data is uploaded automatically into the CP and saved in the
ECB200.
FDATA3 FDATA3 is a 255 byte array that contains bytes 511-765 of the Port file
specified by FILEID and downloaded initially into the FBM224/230/232
via the DB_Download SMDH action key. When the download is com-
pleted, this data is uploaded automatically into the CP and saved in the
ECB200.
FDATA4 FDATA4 is a 255 byte array that contains bytes 766-1020 of the Port file
specified by FILEID and downloaded initially into the FBM224/230/232
via the DB_Download SMDH action key. When the download is com-
pleted, this data is uploaded automatically into the CP and saved in the
ECB200.
1148
62. ECB200 – Single Module DCI FBM Interface B0193AX – Rev AA
1149
B0193AX – Rev AA 62. ECB200 – Single Module DCI FBM Interface
FILEID File Identifier is the name of the Port file which is to be downloaded from
the control station, using pass-through, when the SMDH DB Download
action is specified.
For FBM223 (PROFIBUS™), FILEID must be user configured to con-
tain the name of the file that defines the FBM223 port communication
parameters. (Refer to PROFIBUS-DP Communication Interface Module
(FBM223) User’s Guide, B0400FE, for more information.)
For FBM224 (Modbus®), FBM230/232 (FDSI), FILEID must be user
configured to contain the name of the file that defines the port communi-
cation parameters. (Refer to Modbus® Communication Interface Module
(FBM224) User’s Guide or Field Device System Integrators
(FBM230/231/232/233) User’s Guide (B0700AH) for additional informa-
tion.)
This parameter does not apply to H1 (FBM220/221), HART™
(FBM214/215) FBMs, or H1 (FBM228)
FILREV File Revision Number is the revision number of the latest DCI download
file sent to the FBM by the DCI server via the ECB201. It is supplied by
the ECB in the response to the READ_CONFIGURATION_DATA
command.
This parameter does not apply to H1, HART™, or Modbus® FBMs.
1150
62. ECB200 – Single Module DCI FBM Interface B0193AX – Rev AA
HWREV Hardware Revision contains the version number of the FBM software rep-
resented by this ECB200. It is supplied by the ECB in the response to the
READ_REVISION_DATA command.
1151
B0193AX – Rev AA 62. ECB200 – Single Module DCI FBM Interface
LADDR Logical Address is the HDLC address assigned to the FBM as a secondary
on the control station to FBM link.
OPSTAT Operational Status is a one-byte short integer indicating the current status
of the ECB and the communications link to the FBM. When a DCI con-
trol block is connected to a parameter located in the FBM, the value of
OPSTAT, together with the DCI connection status information in the
control block, determines whether the point is Bad and/or Out-of-Service.
The following settings are valid:
0 = Device Failure
1 = Communications Failure
2 = Temporary Communications Failure
3 = Going Maintenance Off-Line
4 = Going Off-Line
5 = Going On-Line
6 = Module OK
7 = Maintenance Off-Line
8 = Off-Line
1152
62. ECB200 – Single Module DCI FBM Interface B0193AX – Rev AA
PHASE Phase is a configured integer input that causes the ECB to be scanned at a
specific BPC within the time determined by the PERIOD. For instance,
an ECB with PERIOD of 3 (2.0 sec.) can be scanned within the first, sec-
ond, third, or fourth BPC of the 2-second time period, assuming the BPC
of the control station is 0.5 sec.
PORTEX Port Existence is a configurable bit string that defines the existence of each
port for the associated FBM. It is used by the ECB200 detail display and
by System Management software to support the FBM. The mapping is:
Bit 0 = 1: Port 1 exists (applies to FBM220/221/223/224/228/230)
Bit 1 = 1: Port 2 exists (applies to FBM221/223 224/228/230)
Bit 2 = 1: Port 3 exists (applies to FBM221/224/230/228/230)
Bit 3 = 1: Port 4 exists (applies to FBM221/224/230/228/230).
This parameter does not apply to HART™ FBMs (FBM214/215).
PORTST Port Status is a bit map that contains status information for each of the
ports in a multi-port FBM. The bits presently assigned are:
Bit 0 = 1: Port 1 failed (applies to FBM220/221/223/224/228/230)
Bit 1 = 1: Port 2 failed (applies to FBM221/223/224/228/230)
Bit 2 = 1: Port 3 failed (applies to FBM221/224/228/230)
Bit 3 = 1: Port 4 failed (applies to FBM221/224/228/230)
Bit 16 = 1: Port 1 disabled (applies to FBM223/224/228/230)
Bit 17 = 1: Port 2 disabled (applies to FBM223/224/228/230)
Bit 18 = 1: Port 3 disabled (applies to FBM224/228/230)
Bit 19 = 1: Port 4 disabled (applies to FBM224/228/230)
PORTST is linkable, with a connection output (source).
This parameter does not apply to HART™ FBMs (FBM214/215).
SFILID Software file name (filename.ziph) of the type of I/O Device Driver asso-
ciated with FBM230/232.
1153
B0193AX – Rev AA 62. ECB200 – Single Module DCI FBM Interface
SWREV Software Revision contains the version number of the FBM software rep-
resented by this ECB200. It is supplied by the ECB in the response to the
READ_REVISION_DATA command.
SWTYPE Software Type is always identical to the hardware type (HWTYPE) in the
DCI family of ECBs:
Device SWTYPE
FBM220 (FF H1 Single Port) 220
FBM221 (FF H1 Quad Port) 221
FBM223 (PROFIBUS™ Dual Port) 223
FBM214 (HART™ Analog Input) 214
FBM215 (HART™ Analog Output) 215
FBM224 (Modbus®) 224
FBM228 (FF H1) 228
FBM230 (FDSI) 230
FBM232 (FDSI) 232
TYPE This is the block Type. When you enter “ECB200” or select it from a con-
figurator list, an identifying integer is created specifying this block type.
For this ECB, the value of TYPE is 311.
VERNUM Version Number is a 1-32 character array that contains the version num-
ber of the FBM represented by this ECB200. It is supplied by the ECB in
response to the READ_CONFIGURATION_DATA command.
This parameter does not apply to Modbus® FBM224.
1154
63. ECB201 – Device Interface
This chapter describes ECB201, which provides an I/A Series interface for devices connected to
FBMs that use DCI blocks. Functional diagrams and parameter descriptions are provided.
Functional Diagram
ECB200
Control
Blocks FBM
ECB201* or or See
See
Table 63-1 Table 63-1
ECB202
Table 63-1. DCI FBMs and I/O Control Blocks Using ECB201
1155
B0193AX – Rev AA 63. ECB201 – Device Interface
Table 63-1. DCI FBMs and I/O Control Blocks Using ECB201 (Continued)
Parameters
Table 63-2. ECB201 Parameters
1156
63. ECB201 – Device Interface B0193AX – Rev AA
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.
ACTION Equipment Change Action indicates the key action(s) requested on the
SMDH equipment change page. The supported actions are:
Action Packed Boolean Value
Enable 0x0001
Disable 0x0002
DB Download 0x0800
(FBM223, FBM230/231/232/233,
and FBM224 only)
1157
B0193AX – Rev AA 63. ECB201 – Device Interface
1158
63. ECB201 – Device Interface B0193AX – Rev AA
1159
B0193AX – Rev AA 63. ECB201 – Device Interface
1160
63. ECB201 – Device Interface B0193AX – Rev AA
NOTE
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.
1161
B0193AX – Rev AA 63. ECB201 – Device Interface
DEVSTS Device Status is an output bit mapped parameter indicating the status of
the field device hosted by the associated FBM. Presently assigned bits are:
Byte 0* Bit 0: 1 = DCI Configuration Ready
(supplied by FBM)
Bit 1: 1 = Device Fail
(supplied by FBM)
Bit 2: 1 = Device Disabled
(supplied by FBM)
Bit 3: 1 = DB Download Failed**
(supplied by FBM)
Bit 4: 1 = DB Download Active**
(supplied by FBM)
Bit 5: 1 = Unresolved Connection
(supplied by control station)
Bit 6: = 0 (reserved for future use)
Bit 7: 1 = DB Download Success**
Byte 1 Bit 0: 1 = PROFIBUS-DP™ Device
Bit 1: 1 = Fieldbus H1 Device
Bit 2: 1 = HART™ Device
Bit 3: 1 = FSDI Device
Bit 4= 0 (reserved for future use)
Bit 5: 1 = Modbus® Device
Bit 6: 1 = System Alarm
(supplied by FBM)
Bit 7: 1 = System Message
(supplied by FBM)
Bytes 2 - 3 = 0 (reserved for future use)
* Byte 0 is the least significant, low-order byte;
Bit 0 is the least significant, low-order bit.
** Applicable to FBM223/230/231/232/233 only.
1162
63. ECB201 – Device Interface B0193AX – Rev AA
DVNAME Device Name is the name of the field device associated with the ECB201.
It is used by the FBM to validate the identity of the field device when the
device connection is made. For this parameter, lowercase letters and spe-
cial characters (for example, &, @, *) are not allowed.
For the Modbus® FBM224, DVNAME is used to specify the address of
the Modbus® field device. Refer to Modbus® Communication Interface
Module (FBM224) User’s Guide for details.
DVTYPE Device Type is a 32-character array that can be used to identify the type of
field device represented by the associated ECB201.
For Modbus® FBM224 and FDSI FBM230/231/232/233, DVTYPE is
currently not used.
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
B9
1163
B0193AX – Rev AA 63. ECB201 – Device Interface
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 errors does not proceed past the first error encountered
by the block logic. For ECB201, the following list specifies the possible
values of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the accept-
VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE BLOCK”
1164
63. ECB201 – Device Interface B0193AX – Rev AA
FDATA1 FDATA1 is a 255 byte array that contains bytes 1-255 of the Device file
specified by FILEID and downloaded initially into the FBM via the
DB_Download SMDH action key. When the download is completed,
this data is uploaded automatically into the CP and saved in the ECB201.
When used with DCI FBMs and FBM222, the DCI software provides
configuration data to a DCI FBM by downloading the FDATA1-
FDATA4 parameters of an ECB200, ECB201, or ECB202 automatically
to the DCI FBM when the FDATA1 parameter is written in the CP270.
This allows FBM222 configuration data to be downloaded without using
the DB download key actions.
FDATA2 FDATA2 is a 255 byte array that contains bytes 256-510 of the Device file
specified by FILEID and downloaded initially into the FBM via the
DB_Download SMDH action key. When the download is completed,
this data is uploaded automatically into the CP and saved in the ECB201.
FDATA3 FDATA3 is a 255 byte array that contains bytes 511-765 of the Device file
specified by FILEID and downloaded initially into the FBM via the
DB_Download SMDH action key. When the download is completed,
this data is uploaded automatically into the CP and saved in the ECB201.
FDATA4 FDATA4 is a 255 byte array that contains bytes 766-1020 of the Device
file specified by FILEID and downloaded initially into the FBM via the
DB_Download SMDH action key. When the download is completed,
this data is uploaded automatically into the CP and saved in the ECB201.
FILEID File Identifier is the name of the Device file which is to be downloaded
from the control station, using pass-through, when the SMDH DB
Download action is specified.
1165
B0193AX – Rev AA 63. ECB201 – Device Interface
FILEREV File Revision Number is the revision number of the latest DCI download
file sent to the FBM by the DCI server via the ECB201. It is supplied by
the ECB in the response to the READ_CONFIGURATION_DATA
command.
This parameter does not apply to H1, HART™, or Modbus® FBMs.
Device HWTYPE
FBM220 (FF H1 Single Port) 220
FBM221 (FF H1 Quad Port) 221
™
FBM223 (PROFIBUS Dual Port) 223
™ Analog Input)
FBM214 (HART 214
™
FBM215 (HART Analog Output) 215
™
FBM216 (Redundant HART Analog Input) 216
™ Analog Output) 218
FBM218 (Redundant HART
FBM224 (Modbus®) 224
FBM230 (FDSI, Four Serial Ports, Single) 230
FBM231 (FDSI, Four Serial Ports, Redundant) 231
FBM232 (FDSI, Ethernet, Single) 232
FBM233 (FDSI, Ethernet, Redundant) 233
LADDR Logical Address is the HDLC address assigned to the FBM as a secondary
on the control station-to-FBM link.
1166
63. ECB201 – Device Interface B0193AX – Rev AA
MODLID Model Identifier is returned by the FBM in the response to a Device Level
Read_Configuration_Data command. It identifies the model of the device
supported by the ECB201.
For Modbus® FBM224 and FDSI FBM230/231/232/233, MODLID is
currently not used.
OPSTAT Operational Status is a one-byte short integer indicating the current status
of the ECB and the communication link to the field device. When a DCI
control block is connected to a parameter located in the field device, the
value of OPSTAT, together with the DCI connection status information
in the control block, determines whether the point is Bad and/or Out-of-
Service. The following settings are valid:
0 = Device Failure
1 = Communications Failure
2 = Temporary Communications Failure
3 = Going Maintenance Off-Line
4 = Going Off-Line (Going Communications Disabled)
5 = Going On-Line (Going Communications Enabled)
6 = Module OK (Communications Enabled)
7 = Maintenance Off-Line
8 = Off-Line (Communications Disabled)
PARENT Parent ECB is the full pathname of the ECB200 or ECB202 that supports
the FBM hosting this field device.
PHASE Phase is a configured integer input that causes the ECB to be scanned at a
specific BPC within the time determined by the PERIOD. For instance,
an ECB with PERIOD of 3 (2.0 sec.) can be scanned within the first, sec-
ond, third, or fourth BPC of the 2-second time period, assuming the BPC
of the control station is 0.5 sec.
1167
B0193AX – Rev AA 63. ECB201 – Device Interface
Device SWTYPE
FBM220 (FF H1 Single Port) 220
FBM221 (FF H1 Quad Port) 221
FBM223 (PROFIBUS™ Dual Port) 223
FBM214 (HART™ Analog Input) 214
FBM215 (HART™ Analog Output) 215
FBM216 (Redundant HART™ Analog Input) 216
FBM218 (Redundant HART™ Analog Output) 218
FBM224 (Modbus®) 224
FBM230 (FDSI, Four Serial Ports, Single) 230
FBM231 (FDSI, Four Serial Ports, Redundant) 231
FBM232 (FDSI, Ethernet, Single) 232
FBM233 (FDSI, Ethernet, Redundant) 233
TYPE This is the block Type. When you enter “ECB201” or select it from a con-
figurator list, an identifying integer is created specifying this block type.
For this ECB, the value of TYPE is 312.
VERNUM Version Number is a 32-character array that contains the version number
of the field device hosted by the FBM.
1168
63. ECB201 – Device Interface B0193AX – Rev AA
1169
B0193AX – Rev AA 63. ECB201 – Device Interface
1170
64. ECB202 – REDUNDANT DCI
FBM Interface
This chapter describes ECB202, which provides an I/A Series interface for redundant DCI
FBMs. Functional diagrams and parameter descriptions are provided.
Functional Diagram
Control
FBM
Blocks
ECB201* ECB202** See
See
Table 64-1
Table 64-1
Table 64-1. DCI FBMs and I/O Control Blocks Using ECB202
FBM228
FBM216/218 Foundation FBM231/233
I/O Block (HART) fieldbus (FDSI)
AI X
AO X
BIN X X
BINR X X
BOUT X
BOUTR X
DI X
DO X
IIN X X X
IOUT X
PAKIN X X X
PAKOUT X
PLSOUT X
RIN X X X
RINR X X X
1171
B0193AX – Rev AA 64. ECB202 – REDUNDANT DCI FBM Interface
Table 64-1. DCI FBMs and I/O Control Blocks Using ECB202
FBM228
FBM216/218 Foundation FBM231/233
I/O Block (HART) fieldbus (FDSI)
ROUT X X
STRIN X X
STROUT X
Parameters
Table 64-2. ECB202 Parameters
1172
64. ECB202 – REDUNDANT DCI FBM Interface B0193AX – Rev AA
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.
ACTION Equipment Change Action indicates the key action(s) requested on the
SMDH equipment change page. The supported actions are:
Action Packed Boolean Value
Switchover 0x1000
Main Go on-line 0x4001
Main Go off-line 0x4002
Main Download 0x4008
Main EEPROM update 0x6000
Backup Go on-line 0x8001
Backup Go off-line 0x8002
Backup Download 0x8008
Backup EEPROM update 0xA000
Enable Port 1* 0x0004
Disable Port 1* 0x0400
Enable Port 2* 0x0010
Disable Port 2* 0x0020
Enable Port 3* 0x0040
1173
B0193AX – Rev AA 64. ECB202 – REDUNDANT DCI FBM Interface
BDIAG Backup Processor Diagnostics is a packed long integer output that con-
tains status information about specific faults detected by the backup mod-
ule of a redundant DCI FBM pair.
For Redundant HART™ FBMS , FBM228 and FBM231/232, BDIAG is
defined as follows:
.
1174
64. ECB202 – REDUNDANT DCI FBM Interface B0193AX – Rev AA
Byte 2 = 0 (reserved for future Bit 0: 1 = Revision Mis- Bit 0: 1 = Cannot Load
use) match Driver
Bit 1: 1 = Redundancy Bit 1: 1 = Port File Invalid
Role Conflict
Bit 2: 1 = Live List Mis-
match
Bit 3: 1 = Partner not in
Live List
Bit 4: 1 =Time Not In
Sync
Bit 5: 1 = Macrocycle
Overflow
Bit 6: 1 = H1 Comm
Overrun
Bit 7: 1 =Not LAS
*Byte 0 is the least significant, low-order byte;
Bit 0 is the least significant, low-order bit.
BMODE Backup Processor Mode is the operational mode of the backup module of
a Redundant DCI FBM pair.
For redundant HART™ FBMs and FBM228/231/233, BMODE has one
of these settings:
0 = Not Operational
1 = Off Line
2 = Master
3 = Tracker
BPORT Backup Processor Port Status is a bit string that contains the status of each
Fieldbus port in a multi-port backup module in a Redundant DCI FBM.
Bits 0 -3: 1 = Port 1 through Port 4 Failed in Backup module, displayed
only if port _exist bit is set
Bits 16-19: 1 = Port 1 through Port 4 Disabled in Backup module, dis-
played only if port _exist bit is set
BPORT applies to FBM228/231/233. BPORT does not apply to the
redundant HART™ FBMs.
1175
B0193AX – Rev AA 64. ECB202 – REDUNDANT DCI FBM Interface
The first four characters of the FBM letterbug are created per user prefer-
ence, but they must match the first four characters of the FCM name. For
a redundant FBM pair, the last two characters reflect the physical position
of the module pair and its associated baseplate. For additional informa-
tion, refer to DIN Rail Mounted Subsystem User’s Guide (B0400FA).
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
B9
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
1176
64. ECB202 – REDUNDANT DCI FBM Interface B0193AX – Rev AA
of configuration errors does not proceed past the first error encountered
by the block logic. For ECB202, the following list specifies the possible
values of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block
PERIOD not compatible with
compound PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FBMSTS FBM Status is an output parameter that indicates the status of the FBM.
It is based on the FBM reply to the Read Status command from the con-
trol station.
Byte 0* Bit 0: 1 = DCI Configuration Ready
(supplied by FBM)
Bit 1: 1 = FBM Comm Fail
(supplied by control station)
Bit 2: 1 = FBM Off-Line
(supplied by control station)
Bit 3: 1 = DB Download Failed **
(supplied by FBM)
Bit 4: 1 = DB Download Active **
(supplied by FBM)
Bit 5: 1 = Unresolved Connection
(supplied by control station)
Bits 6 - 7 = 0 (reserved for future use)
Byte 1 Bit 0: 1 = PROFIBUS-DP FBM
Bit 1: 1 = Fieldbus H1 FBM
Bit 2: 1 = HART™ FBM
Bit 3: 1 = FSDI FBM
Bit 4= 0 (reserved for future use)
Bit 5= Modbus® FBM
Bit 6: 1 = System Alarm (supplied by FBM)
Bit 7: 1 = System Message (supplied by FBM)
Bytes 2 - 3 = 0 (reserved for future use)
* Byte 0 is the least significant, low-order byte;
Bit 0 is the least significant, low-order bit.
**Not Applicable to Redundant HART™ FBMs.
1177
B0193AX – Rev AA 64. ECB202 – REDUNDANT DCI FBM Interface
FBMTYP FBM Type is a 32-character array that identifies the type of FBM sup-
ported by a DCI parent ECB202.
FDATA1 FDATA1 is a 255 byte array that contains bytes 1-255 of the Port file
specified by FILEID and downloaded initially into a Redundant FDSI
FBM231/233 via the DB_Download SMDH action key. When the
download is completed, this data is uploaded automatically into the CP
and saved in the ECB202.
When used with DCI FBMs and FBM222, the DCI software provides
configuration data to a DCI FBM by downloading the FDATA1-
FDATA4 parameters of an ECB200, ECB201, or ECB202 automatically
to the DCI FBM when the FDATA1 parameter is written in the CP270.
This allows FBM222 configuration data to be downloaded without using
the DB download key actions.
This parameter does not apply to the redundant HART™ FBMs and
FBM228.
FDATA2 FDATA2 is a 255 byte array that contains bytes 256-510 of the Port file
specified by FILEID and downloaded initially into a Redundant FDSI
FBM231/233 via the DB_Download SMDH action key. When the
download is completed, this data is uploaded automatically into the CP
and saved in the ECB202.
This parameter does not apply to the redundant HART™ FBMs and
FBM228.
FDATA3 FDATA3 is a 255 byte array that contains bytes 511-765 of the Port file
specified by FILEID and downloaded initially into a Redundant FDSI
FBM231/233 via the DB_Download SMDH action key. When the
download is completed, this data is uploaded automatically into the CP
and saved in the ECB202.
This parameter does not apply to the redundant HART™ FBMs and
FBM228.
FDATA4 FDATA4 is a 255 byte array that contains bytes 766-1020 of the Port file
specified by FILEID and downloaded initially into a Redundant FDSI
FBM231/233 via the DB_Download SMDH action key. When the
download is completed, this data is uploaded automatically into the CP
and saved in the ECB202.
This parameter does not apply to the redundant HART™ FBMs and
FBM228.
1178
64. ECB202 – REDUNDANT DCI FBM Interface B0193AX – Rev AA
FDIAG FBM Diagnostic Status contains status information about specific faults
detected by the FDSI FBM231/233 diagnostic software.
FILEID File Identifier is the name of the Port file which is to be downloaded from
the control station, using pass-through, when the SMDH DB Download
action is specified.
This parameter does not apply to the redundant HART™ FBMs.
FILREV File Revision Number is the revision number of the latest DCI download
file sent to the FBM by the DCI server via the ECB201.
This parameter does not apply to the redundant HART™ FBMs.
1179
B0193AX – Rev AA 64. ECB202 – REDUNDANT DCI FBM Interface
HWREV Hardware Revision contains the version number of the FBM software rep-
resented by this ECB202. It is supplied by the ECB in the response to the
READ_REVISION_DATA command.
LADDR Logical Address is the HDLC address assigned to the FBM as a secondary
on the control station to FBM link.
1180
64. ECB202 – REDUNDANT DCI FBM Interface B0193AX – Rev AA
MDIAG Main Processor Diagnostics is a packed long integer output that contains
status information about specific faults detected by the main module of a
redundant DCI FBM pair.
For redundant HART™ FBMS and FBM231/233, MDIAG is defined as
follows:
1181
B0193AX – Rev AA 64. ECB202 – REDUNDANT DCI FBM Interface
Byte 2 = 0 (reserved for future use) Bit 0: 1 = Revision Mis- Bit 0: 1 = Cannot Load
match Driver
Bit 1: 1 = Redundancy Bit 1: 1 = Port File
Role Conflict Invalid
Bit 2: 1 = Live List Mis-
match
Bit 3: 1 = Partner not in
Live List
Bit 4: 1 =Time Not In
Sync
Bit 5: 1 = Macrocycle
Overflow
Bit 6: 1 = H1 Comm
Overrun
Bit 7: 1 =Not LAS
*Byte 0 is the least significant, low-order byte;
Bit 0 is the least significant, low-order bit.
MMODE Main Processor Mode is the operational mode of the main module of a
redundant DCI FBM pair.
For redundant FBM216/218/228/231/233, MMODE has one of these
settings:
0 = Not Operational
1 = Off Line
2 = Master
3 = Tracker
MPORT Main Processor Port Status is a bit string that contains the status of each
Fieldbus port in a multi-port main module in a redundant DCI FBM.
Bits 0 -3: 1 = Port 1 through Port 4 Failed in Main module, displayed
only if port _exist bit is set
Bits 16-19: 1 = Port 1 through Port 4 Disabled in Main module, dis-
played only if port _exist bit is set
MPORT applies to FBM228/231/233. MPORT does not apply to the
redundant HART™ FBMs.
OPSTAT Operational Status is a one-byte short integer indicating the current status
of the ECB and the communications link to the FBM. When a DCI con-
trol block is connected to a parameter located in the FBM, the value of
OPSTAT, together with the DCI connection status information in the
control block, determines whether the point is Bad and/or Out-of-Service.
The following settings are valid:
0 = Device Failure
1 = Communications Failure
1182
64. ECB202 – REDUNDANT DCI FBM Interface B0193AX – Rev AA
PHASE Phase is a configured integer input that causes the ECB to be scanned at a
specific BPC within the time determined by the PERIOD. For instance,
an ECB with PERIOD of 3 (2.0 sec.) can be scanned within the first, sec-
ond, third, or fourth BPC of the 2-second time period, assuming the BPC
of the control station is 0.5 sec.
PORTEX A configurable decimal number that defines the existence of each port for
the associated FBM. For FBM231 see Table 64-3. For FBMs232/233
value is always 1. This parameter does not apply to the redundant
HART™ FBMs.
1183
B0193AX – Rev AA 64. ECB202 – REDUNDANT DCI FBM Interface
PORTST Port Status for FBM224/230/231.This parameter does not apply to the
redundant HART™ FBMs.
.
Byte FBM224/230/231
Byte 0-1 Port Status
Bit 0: 1 = Port 1 Failed
Bit 1: 1 = Port 2 Failed
Bit 2: 1 = Port 3 Failed
Bit 3: 1 = Port 4 Failed
Byte 2-3 Bit 0: 1 = Port 1 Disabled
Bit 1: 1 = Port 2 Disabled
Bit 2: 1 = Port 3 Disabled
Bit 3: 1 = Port 4 Disabled
*Byte 0 is the least significant, low-order byte;
Bit 0 is the least significant, low-order bit.
SFILID Software file name (filename.ziph) of the type of I/O Device Driver asso-
ciate with FBM231/233.
SWREV Software Revision contains the version number of the FBM software rep-
resented by this ECB202. It is supplied by the ECB in the response to the
READ_REVISION_DATA command
SWTYPE Software Type is always identical to the hardware type (HWTYPE) in the
DCI family of ECBs:
Device SWTYPE
FBM216 (redundant HART™ Analog Input) 216
FBM218 (redundant HART™ Analog Output) 218
FBM228 (redundant Foundation fieldbus) 228
FBM231 (FDSI) 231
FBM233 (FDSI) 233
1184
64. ECB202 – REDUNDANT DCI FBM Interface B0193AX – Rev AA
TYPE This is the block Type. When you enter “ECB202” or select it from a con-
figurator list, an identifying integer is created specifying this block type.
For this ECB, the value of TYPE is 313.
VERNUM Version Number is a 1-32 character array that contains the version num-
ber of the FBM represented by this ECB202. It is supplied by the ECB in
the response to the READ_CONFIGURATION_DATA command.
1185
B0193AX – Rev AA 64. ECB202 – REDUNDANT DCI FBM Interface
1186
65. ECB210 – Redundant FCM100
Interface
This chapter describes ECB210, which provides an I/A Series interface between a Z-Module
Control Processor 270 (ZCP270) and a redundant Fieldbus Communications Module
(FCM100) pair. A functional diagram and parameter descriptions are provided.
Functional Diagram
FCM100
ZCP270 ECB210
FCM100
Parameters
Table 65-1. ECB210 Parameters
1187
B0193AX – Rev AA 65. ECB210 – Redundant FCM100 Interface
1188
65. ECB210 – Redundant FCM100 Interface B0193AX – Rev AA
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.
ACTION Equipment Change Action is a 16-bit, packed boolean that indicates the
key action(s) requested on the SMDH Equipment Change display for the
FCM100. The following table lists the supported actions:
1189
B0193AX – Rev AA 65. ECB210 – Redundant FCM100 Interface
BDIAG Backup Module Diagnostics is a packed long integer output that contains
status information about specific faults detected by the backup module of
a redundant FCM100 pair. The following table shows the layout of the
status data:
Byte* Bit* Mode or Status
Byte 0 0 = Not Operational
1 = Off Line
2 = Master
3 = Tracker
4 = No Partner
5 = Debugging
Bytes 1-2 0 1 = Power B is off
1 1 = Power A is off
2 1 = HDLC B has a fault
3 1 = HDLC A has a fault
4 1 = Ethernet B has a fault
5 1 = Ethernet A has a fault
6 1 = Ethernet B has no link
7 1 = Ethernet A has no link
8 1 = Ethernet B has no ping
9 1 = Ethernet A has no ping
10 1 = Strobe B has no pulse
11 1 = Strobe A has no pulse
12 1 = Interlink fault
13 1 = Interlink slot conflict
14 1 = Infrared comm. fault
15 1 = Flash fault
Byte 3 Reserved for future use
* Byte 0 is the least significant, low-order byte.
Bit 0 is the least significant, low-order bit.
BMODE Backup Processor Mode is a short integer output that indicates the opera-
tional mode of the backup module of a redundant FCM100 pair:
Value Mode
0 Not Operational
1 Off Line
2 Master
3 Tracker
4 Master has no Partner
5 Debugging
1190
65. ECB210 – Redundant FCM100 Interface B0193AX – Rev AA
BUSOPT Bus Switch Option is an indexed, short integer input that determines bus
preference and bus switching capability. BUSOPT can be changed at the
workstation. The index values range from 1 to 4 and map to the following
configurations:
DEV_ID Device ID is a character array that specifies the 6-character letterbug iden-
tifier of the FCM100.
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
B9
1191
B0193AX – Rev AA 65. ECB210 – Redundant FCM100 Interface
ERR1A Main Ethernet Bus A Errors is a long integer that contains the accumu-
lated errors for Ethernet Port A reported by the main module of an
FCM100. It is cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
ERR1B Main Ethernet Bus B Errors is a long integer that contains the accumu-
lated errors for Ethernet Port B reported by the main module of an
FCM100. It is cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
ERR2A Backup Ethernet Bus A Errors is a long integer that contains the accumu-
lated errors for Ethernet Port A reported by the backup module of an
FCM100. It is cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
ERR2B Backup Ethernet Bus B Errors is a long integer that contains the accumu-
lated errors for Ethernet Port B reported by the backup module of an
FCM100. It is cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
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 errors does not proceed past the first error encountered
by the block logic. For ECB210, the following list specifies the possible
values of ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
ETHST1 Main Ethernet Status is an array of long integers that contain the current
Status/Error counters for both Ethernet ports reported by the main mod-
ule of an FCM100. These counters are cleared by the SMDH Reset Errors
action key on FCM100 Equipment Change display. The following table
shows the layout of these counters:
Array Element Element Description
1 Count of data packets transmitted
2 Count of data packets received
1192
65. ECB210 – Redundant FCM100 Interface B0193AX – Rev AA
ETHST2 Backup Ethernet Status is an array of long integers that contain the cur-
rent Status/Error counters for both Ethernet ports reported by the backup
module of an FCM100. These counters are cleared by the SMDH Reset
Errors action key on the FCM100 Equipment Change display. For a lay-
out of these counters, see the ETHST1 parameter description.
FCMPST FCM Pair Status is a packed long integer data store that contains run-time
status information for both modules of the FCM100 pair. The following
table shows the layout of the status data:
1193
B0193AX – Rev AA 65. ECB210 – Redundant FCM100 Interface
FCMST1 Main FCM Status is a packed long integer that contains the operating sta-
tus of the main module of an FCM100. The following table shows the
layout of the status bits:
Byte* Bit** Status
Byte 0 0 Not used
1 1 = FCM installed in main slot
2-3 Not used
4 1 = Ethernet bus B disabled
5 1 = Ethernet bus A disabled
6 1 = HDLC bus B disabled
7 1 = HDLC bus A disabled
Byte 1 8-11 Not used
12 1 = Module has an active partner
13 1 = Module is on-line
14-15 Not used
Byte 2 16 1 = FCM in debug mode
17-23 Not used
Byte 3 24-31 Reserved for future use
* Byte 0 is the least significant, low-order byte.
** Bit 0 is the least significant, low-order bit.
FCMST2 Backup FCM Status is a packed long integer that contains the operating
status of the backup module of an FCM100. For a layout of this status, see
the FCMST1 parameter description.
HDLST1 Main HDLC Status is an array of long integers that contain the current
Status/Error counters for both HDLC ports reported by the main module
of an FCM100. These counters are cleared by the SMDH Reset Errors
1194
65. ECB210 – Redundant FCM100 Interface B0193AX – Rev AA
HDLST2 Backup HDLC Status is an array of long integers that contain the current
Status/Error counters for both HDLC ports reported by the backup mod-
ule of an FCM100. These counters are cleared by the SMDH Reset Errors
action key on the FCM100 Equipment Change display. For a layout of
these counters, see the HDLCST1 parameter description.
HERR1A Main HDLC Bus A Errors is a long integer that contains the accumulated
errors over its HDLC Port A reported by the main module of an
FCM100. It will be cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
HERR1B Main HDLC Bus B Errors is a long integer that contains the accumulated
errors over its HDLC Port B reported by the main module of an
FCM100. It is cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
HERR2A Backup HDLC Bus A Errors is a long integer that contains the accumu-
lated errors over its HDLC Port A reported by the backup module of an
FCM100. It is cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
HERR2B Backup HDLC Bus B Errors is a long integer that contains the accumu-
lated errors over its HDLC Port B reported by the backup module of an
FCM100. It is cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
1195
B0193AX – Rev AA 65. ECB210 – Redundant FCM100 Interface
HWPRT1 Main Hardware Part Number is a 1 to 32 character ASCII array that con-
tains the hardware part number of the main module of an FCM100. It is
retrieved by the control station from the vault information stored in the
main module.
LMACA Logical MAC Bus A address is a configurable 6-character ASCII array that
contains the low-order hexadecimal digits of the Bus A MAC address of an
FCM100. Its format is “hhhhhh”, where each h = 0 to F. (The full MAC
address is 00006Chhhhhh).
LMACB Logical MAC Bus B address is a configurable 6-character ASCII array that
contains the low-order hexadecimal digits of the Bus B MAC address of an
FCM100. Its format is “hhhhhh”, where each h = 0 to F. (The full MAC
address is 00006Chhhhhh).
1196
65. ECB210 – Redundant FCM100 Interface B0193AX – Rev AA
retrieved by the control station from the vault information stored in the
main module.
MDIAG Main Module Diagnostics is a packed long integer output that contains
status information about specific faults detected by the main module of a
redundant FCM100 pair. For a layout of this status, see the BDIAG
parameter description.
MMERR1 Main Mismatch Errors is a long integer that contains the accumulated
mismatch errors (that is, main Ethernet messages versus backup Ethernet
messages) over both Ethernet ports reported by the main module of an
FCM100. It is cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
MMERR2 Backup Mismatch Errors is a long integer that contains the accumulated
mismatch errors (that is, main Ethernet messages versus backup Ethernet
messages) over both Ethernet ports reported by the backup module of an
FCM100. It is cleared by the SMDH Reset Errors action key on the
FCM100 Equipment Change display.
MMODE Main Module Mode is a short integer output that contains the operational
mode of the main module of a redundant FCM100 pair:
Value Mode
0 Not Operational
1 Off Line
2 Master
3 Tracker
4 Master has no Partner
5 Debugging
1197
B0193AX – Rev AA 65. ECB210 – Redundant FCM100 Interface
OPSTAT Module Operational Status is a short data store to indicate the following
operational status:
Value Status
0 Device failed
1 Communication failed
2 Ride through
3 Go maintenance off
4 Go ECB off
5 Going on
6 Module OK
7 Maintenance off
8 ECB off
OSVER1 Main OS Version is a 1 to 32 character ASCII array that contains the ver-
sion number of the operating system in the main module of an FCM100.
It is retrieved by the control station from the vault information stored in
the main module.
PHASE Phase is a configured integer input that causes the ECB to be scanned at a
specific BPC within the time determined by the PERIOD. For instance,
an ECB with PERIOD of 3 (2.0 sec.) can be scanned within the first, sec-
ond, third, or fourth BPC of the 2-second time period, assuming the BPC
of the control station is 0.5 sec.
1198
65. ECB210 – Redundant FCM100 Interface B0193AX – Rev AA
SKTST1 Main Socket Status is an array of long integers that contain the current
Socket Status/Error counters reported by the main module of an
FCM100. These counters are cleared by the SMDH Reset Errors action
key on the FCM100 Equipment Change display. The following table
shows the layout of these counters:
SKTST2 Backup Socket Status is an array of long integers that contain the current
Socket Status/Error counters reported by the backup module of an
FCM100. These counters are cleared by the SMDH Reset Errors action
key on the FCM100 Equipment Change display. For a layout of these
counters, see the SKTST1 parameter definition.
STMSTS Station Manager Status is the station manager status of the device.
SWVER1 Main Software Version is a 1 to 32 character ASCII array that contains the
version number of the application software in the main module of an
FCM100. It is retrieved by the control station from the vault information
stored in the main module.
TDRST1 Main TDR Status is an array of long integers that contain the current
TDR/SOE Status/Error counters reported by the main module of an
FCM100. These counters are cleared by the SMDH Reset Errors action
key on the FCM100 Equipment Change display. The following table
shows the layout of these counters:
1199
B0193AX – Rev AA 65. ECB210 – Redundant FCM100 Interface
Array
Element Element Description
1 Count of data packets transmitted
2 Count of command acknowledgements from HSDAI
3 Count of TDR/SOE configurations received
4 Count of workstation packet transactions
5 Count of packet transmission failures
6 Count of all data reception errors
7 Count of TDR/SOE configuration failures
8 Count of HSDAI transmissions below packet minimum
9 Count of lost connections
10 Count of active structures not found
11 Count of failures to listen/accept sockets
12 Count of fifth time HSDAI tried to connect
TDRST2 Backup TDR Status is an array of long integers that contain the current
TDR/SOE Status/Error counters reported by the backup module of an
FCM100. These counters are cleared by the SMDH Reset Errors action
key on the FCM100 Equipment Change display. For a layout of these
counters, see the TDRST1 parameter definition.
TYPE This is the block Type. When you enter “ECB210” or select it from a con-
figurator list, an identifying integer is created specifying this block type.
For this ECB, the value of TYPE is 314.
1200
66. EVENT – Event Block
This chapter gives a general overview of the EVENT Block, providing an I/O diagram and
describing its features, parameters and detailed operations.
Overview
The EVENT block provides event messages and Auto/Manual control for a group of up to
32 boolean-type inputs read from a digital-input-only type FBM (Fieldbus Module). The
EVENT block also provides up to 32 boolean-type outputs for connection into control schemes
and for general contact input state monitoring. The FBM detects contact state changes (events)
and stores the event records in a circular queue. The EVENT block provides one message for each
event detected and recorded by the FBM.
I/O Diagram
1201
B0193AX – Rev AA 66. EVENT – Event Block
Features
The features are:
♦ Up to 32 boolean-type outputs for connection into control schemes
♦ Event message reporting for up to 32 boolean inputs
♦ Event output parameters
♦ Manual/Auto mode for disconnecting control schemes from the process, for simula-
tion and checkout purposes
♦ Bad FBM detection and reporting
♦ Last good value retention.
The options are:
♦ IVO_1–IVO_32, Point inversion
♦ BAO, Bad Alarm Option
♦ INHOPT, Inhibit/Disable alarming
♦ TAO, Trip Alarm Option, enables an alarm message for each state change of the TRIP
parameter
♦ INITMA, Initialize Manual/Auto, specifies the desired state of the MA input during
initialization.
Parameters
Table 66-1. EVENT Block Parameters
1202
66. EVENT – Event Block B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
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. For the EVENT block, only the following unshaded bits
are used:
1203
B0193AX – Rev AA 66. EVENT – Event 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
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number1
(0 to 31) Configured Alarm Option When True
0 Alarm Group 8 in Use
1 Alarm Group 7 in Use
7 Alarm Group 1 in Use
22 Bad I/O Alarm Configured
1.
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. For the EVENT block, only the following bits are used:
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
TRIP B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9
CRIT PRTYPE
BAD
INH
1204
66. EVENT – Event Block B0193AX – Rev AA
AMRTIN Alarm Regeneration Timer is a configurable integer that specifies the time
interval for an alarm condition to exist continuously, after which a new
unacknowledged alarm condition and its associated alarm message is gen-
erated.
ANM_1 to ANM_32
Alarm Name for Inputs 1 through 32 are user-defined strings of up to
12 characters that identify the input as the cause of the event (that is, the
alarm source), in the alarm message. Each serves as a point descriptor
label, (for example, “PLT3 F2 SDR”).
BAD Bad is a boolean output parameter which is set true when the input to the
block is unacceptable in any way. The BAD bit of BLKSTA
(BLKSTA.BAD) is also set true whenever BAD is true.
BAG Bad Alarm Group is a short integer input that directs bad I/O alarm mes-
sages to one of eight groups of alarm devices. You can change the group
number through the workstation.
BAO Bad Alarm Option is a configurable boolean which, when configured true,
enables alarm generation for each state change of the BAD parameter.
BAP Bad Alarm Priority is an integer input, ranging from 1 to 5, that sets the
priority level of the bad I/O alarm (1 is the highest priority).
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the EVENT block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
FBM
BAD
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
8 FBM FBM Failure BLKSTA.B24
11 MA Manual(= false)/Auto(= true) BLKSTA.B21
12 BAD Bad I/O (I/O Blocks only - BLKSTA.B20
block in BAD state)
14 UDEF Undefined BLKSTA.B18
1205
B0193AX – Rev AA 66. EVENT – Event Block
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
15 ON Compound On BLKSTA.B17
17 TRIP Tripped BLKSTA.B15
20 WLCK Workstation Lock BLKSTA.B12
CIN_1 to CIN_32
Contact Inputs 1 through 32 are block output parameters originating as
the 32 input values from physical input channels in the FBM. The actual
number of channels available depends on the hardware implemented. The
value of each CIN_x is presented in inverted form if its corresponding
IVO_x parameter is true.
CRIT Criticality is an integer output that indicates the priority, ranging from 1
to 5, of the block’s highest currently active alarm (1 is the highest priority).
An output of zero indicates the absence of alarms.
CURSYN The Current Synch Status is an indexed output parameter that indicates
the FBM synchronization status for the current input scan. Index values
range from 0 to 3 and map to the following status conditions:
0= In synch
A specified set of FBMs have compared their internal clocks to
the time included in a broadcast message sent from the host CP
(SET_SEQUENCE_NUMBER), and they are equivalent.
This authenticated time has been sent to all FBMs from the CP
in a TIME_WAS message.
1= Out of synch: Sequence number mismatch
The sequence number received in the most recent TIME_WAS
message was not equal to the sequence number stored at the
preceding SET_SEQUENCE_NUMBER message.
2= Out of synch: Lost TIME_WAS
An excessive time has elapsed since the most recent
SET_SEQUENCE_NUMBER without receipt of a following
TIME_WAS.
3= Out of synch: Not yet synchronized
This condition exists after the FBM code has been initiated and
before the first synchronization message is delivered.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
DEFINE to a true value, correct all configuration errors and reinstall the
block.
1206
66. EVENT – Event Block B0193AX – Rev AA
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM or FBC. DEV_ID is a character
array and IOM_ID is a string type. DEV_ID does not allow the use of the
ECB NAME parameter or ECB pathname in specifying the connected
FBM or FBC.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the EVENT block, the following
list specifies the possible values of ERCODE, and the significance of each
value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not
compatible with compound
PERIOD.
“W46 – INVALID INPUT The source parameter specified in the
CONNECTION” input connection cannot be found in
the source block, or the source param-
eter is not connectable, or an invalid
boolean extension connection has
been configured.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE occurred.
BLOCK”
EVGRP Event Group is a short integer input that directs event messages to one of
eight groups of devices. You can change the group number through the
workstation.
EVPRI Event Priority is an integer input (1 to 5) that sets the priority level for the
event alarm (1 is the highest priority).
EVSYN The Event Synch Status is an integer output that defines the FBM syn-
chronization status when the event is recorded in the FBMs circular
queue. Index values range from 0 to 3 and map to the following status
conditions:
1207
B0193AX – Rev AA 66. EVENT – Event Block
0= In synch
A specified set of FBMs have compared their internal clocks to
the time included in a broadcast message sent from the host
CP (SET_SEQUENCE_NUMBER), and they are equiva-
lent. This authenticated time has been sent to all FBMs from
the CP in a TIME_WAS message.
1= Out of synch: Sequence number mismatch
The sequence number received in the most recent
TIME_WAS message was not equal to the sequence number
stored at the preceding SET_SEQUENCE_NUMBER mes-
sage.
2= Out of synch: Lost TIME_WAS
An excessive time has elapsed since the most recent
SET_SEQUENCE_NUMBER without receipt of a following
TIME_WAS.
3= Out of synch: Not yet synchronized
This condition exists after the FBM code has been initiated
and before the first synchronization message is delivered.
EV_IN Event In Pointer is an integer (0 to 127) output that specifies the location
in the FBM’s circular queue where the next event is stored.
INHALM Inhibit Alarm contains packed boolean values that represent alarm inhibit
requests for each alarm type or point configured in the block. For the
EVENT block, only the following bits are used:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
INHIB Inhibit is a boolean input. When true, it inhibits all block alarms; the
alarm handling and detection functions are determined by the INHOPT
setting. Alarms can also be inhibited based on INHALM and the com-
pound parameter CINHIB.
1208
66. EVENT – Event Block B0193AX – Rev AA
INHOPT Inhibit Option specifies the following actions applying to all block alarms:
0= When an alarm is inhibited, disable alarm messages but do
not disable alarm detection.
1= When an alarm is inhibited, disable both alarm messages and
alarm detection. If an alarm condition already exists at the
time the alarm transitions into the inhibited state, clear the
alarm indicator.
2= Same as 0 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
3= Same as 1 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
INHSTA Inhibit Status contains packed long values that represent the actual inhibit
status of each alarm type configured in the block. For the EVENT block,
only the following bits are used:
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
UNACK B2
B3
B4
B5
B6
B7
B8
B9
TRIP
INH
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
29 INH Inhibit Alarm INHSTA.B3
30 UNACK Unacknowledged INHSTA.B2
31 TRIP Trip Alarm INHSTA.B1
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
1209
B0193AX – Rev AA 66. EVENT – Event Block
IOM_ID Fieldbus Module Identifier is a configurable string that specifies the path-
name of the FBM or FBC to which the block is connected.
IOM_ID has the form CompoundName:BlockName, where Compound-
Name is the 1-12 character name of the local compound containing the
ECB, and BlockName is the 1-12 character block name of the ECB.
If the compound containing the ECB is the CPletterbug_ECB compound
where CPletterbug is the station letterbug of the CP, the CompoundName
may be omitted from the IOM_ID configuration. In this case, the 1-12
character ECB block name is sufficient.
IVO_1 to IVO_32
Invert Options 1 through 32 are boolean inputs. When IVO is true, the
block inverts the value of the FBM input before writing it to the CIN out-
put. The event alarm messages process an off-to-on state change at the
input as an on-to-off state change. You can change IVO only by reconfig-
uring the block.
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
1210
66. EVENT – Event Block B0193AX – Rev AA
external task or program can set the event outputs and the contact out-
puts, CIN_1 through CIN_32, to simulate an event occurrence.
NM0_1 to NM0_32
Name 0, Inputs 1 through 32, are user-defined strings of up to
12 characters that describe, in event messages, a logical 1 to 0 transition
for Inputs 1 through 32, after IVO_1 through IVO_32 are taken into
consideration (that is, have inverted the applicable inputs).
NM1_1 to NM1_32
Name 1, Inputs 1 through 32, are user-defined strings of up to
12 characters that describe, in event messages, a logical 0 to 1 transition
for Inputs 1 through 32, after IVO_1 through IVO_32 are taken into
consideration (that is, have inverted the applicable inputs).
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the
following period time lengths. (Integrator and Gateway blocks have differ-
ent period values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
1211
B0193AX – Rev AA 66. EVENT – Event Block
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2 second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. The PRTYPE output of this block
consists of the following alarm types:
0 = No active alarm
8 = Bad
20 = Event Trip
If both alarms are active and have the same priority, PRTYPE reports the
alarm type of the Bad alarm (8).
For example, if the Bad and Event Trip alarms both have priority 3 and
both of them are active PRTYPE = 8. If the Bad alarm has Priority 4 and
the Event Trip alarm has priority 1 and both alarms are active, PRTYPE =
20.
PT_ID Point Identifier is an integer output (1 to 32) that identifies the contact
input point for the event currently being processed. If you observe a
PT_ID of “xx” or a PT_POL greater than 1, the EVENT block is losing
events.
PT_POL Point Polarity is an integer output (0 or 1) that gives the direction of tran-
sition (0 = 1 to 0 transition; 1 = 0 to 1 transition) for the contact input
point of the event currently being processed. The value of PT_POL is
physical, and does not reflect any inversion specified by the IVO_x for the
point. If you observe a PT_ID of “xx” or a PT_POL greater than 1, the
EVENT block is losing events.
REC_NO The Record Number is an integer output (0 to 127) that gives the address
location, in the FBM’s circular queue, of the event record currently being
processed.
TAG Trip Alarm Group is a short integer input that directs TRIP alarm mes-
sages to one of eight groups of alarm devices. You can change the group
number through the workstation.
TAO Trip Alarm Option, when configured true, enables an alarm message for
each state change of the TRIP parameter. This parameter is not writable
while the block is in operation.
TAP Trip Alarm Priority is an integer input (1 to 5) that sets the alarm priority
for the TRIP output (1 is the highest priority).
1212
66. EVENT – Event Block B0193AX – Rev AA
TIMSTP Time Stamp is a 27-bit integer output (0 to 86400000) that gives the
time, in milliseconds past midnight, when the FBM generates the event
record currently being processed.
TRIP Trip is a boolean output that is set true when the block reads a new (unre-
ported) event record from the FBM. If another new event record is not
read from the FBM within the trip deadtime TRP_DT, the block sets the
TRIP output false.
TRP_DT Trip Deadtime is an integer input that specifies, in seconds, when the
TRIP output returns to false after being set true for an event alarm. If the
block does not detect another new event record within the trip deadtime
(quiescent time), the TRIP output is set false.
TYPE When you enter “EVENT” or select “EVENT” from the block type list
under Show, an identifying integer is created specifying this block type.
UNACK Unacknowledge is a boolean output that the block sets to True when it
detects an alarm. It is typically reset by operator action.
Detailed Operation
General Operation
The EVENT block provides event messages and Auto/Manual control for a group of up to
32 boolean-type inputs read from a specific FBM (Fieldbus Module). The EVENT block also
provides up to 32 boolean-type outputs for connection into control schemes and for general con-
tact input state monitoring.
The FBM detects contact state changes in either direction (events), time stamps each event, and
stores the event records in a circular queue that can store 128 records, that is, events.
Each execution cycle, the EVENT block scans the boolean inputs from the FBM and updates the
boolean outputs, CIN_1 through CIN_32. (The values of CIN_1 through CIN_32 are subject to
optional inversion based on IVO_1 through IVO_32.) The block also checks for and reads one
event record from the FBM.
To determine which channels to process, the EVENT block checks the ECB to determine if the
configured FBM has an Expansion card. It also validates the type of Main and Expansion card in
the FBM.
The block then checks the status of the FBM. If the FBM fails, the device status is bad. If the
FBM device status is bad, the block sets the BAD status output to true, transmits an I/O BAD
alarm message, and sets the Bad I/O bits of the BLKSTA and ALMSTA outputs to true. This
indicates that the contact output parameters, CIN_1 through CIN_32, and the event outputs are
bad.
1213
B0193AX – Rev AA 66. EVENT – Event Block
Unacknowledge (UNACK) is a boolean output parameter which is set true, for notification pur-
poses, 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. The clearing of UNACK is normally via an
operator “acknowledge” pick on a default or user display, or via a user task.
Auto Operation
Auto/Manual selection applies to the entire group of inputs, not to individual inputs
In Auto, with the FBM device status being good, the block reads the value and point status bit for
each point of that FBM and updates the contact outputs, CIN_1 up to CIN_32. If the Invert
Option for a point is true, the block inverts the input before updating the contact output.
If the status of an FBM is bad, the block sets all points’ BAD status output to true, and it also sets
the Bad I/O bits of the BLKSTA and ALMSTA outputs to true. This indicates that the contact
outputs and any events are bad.
1214
66. EVENT – Event Block B0193AX – Rev AA
In Auto, with the FBM device status being good, the block provides time-stamped messages for
each event detected and recorded by the FBM. For a new event, the block:
♦ Transmits a time-stamped, EVENT message to a group of devices specified by param-
eter EVGRP. System printers or the Current Alarms display do not report EVENT
messages. Each EVENT message identifies the point (x) by the corresponding string
parameter ANM_x rather than the point number in PT_ID. The direction of change
is reported by either the string NM0_x or NM1_x. If the point has transitioned from
0 to 1 with IVO_x false, or from 1 to 0 with IVO_x true, NM1_x is used in the mes-
sage. Conversely, if it has transitioned from 1 to 0 with IVO_x false or from 0 to 1
with IVO_x true, then NM0_x is used.
♦ Sets the TRIP output parameter true for at least the duration of the TRP_DT param-
eter. Any new event occurring during a TRP_DT period restarts the TRP_DT time
delay.
♦ Updates the event output parameters (EVSYN, EV_IN, PT_ID, PT_POL,
REC_NO, TIMSTP).
♦ Transmits a time-stamped, EVENT TRIP alarm message to a group of alarm devices,
when the TRIP output goes from false to true or true to false, provided the trip alarm
option TAO is true. The identifying string TAT is used in this alarm message.
♦ The EVENT messages are distinct from the TRIP alarm messages.
Manual Operation
In Manual, an external task or program can set the event outputs and the contact outputs, CIN_1
through CIN_32, to simulate an event occurrence. You cannot generate an EVENT message
while in Manual.
Auto/Manual selection applies to the entire group of inputs, not to individual ones.
Bad Parameter
If the BAD parameter is true, or if the block is in Manual, the contact and event output parame-
ters are not updated with the FBM values. The last good value for each of these outputs is
retained, unless modified by an operator or application program.
Alarm Status
ALMSTA and BLKSTA are output parameters that can be accessed by application programs.
ALMSTA provides bit-mapped status indication of an event trip, bad I/O, and other block alarm
states. BLKSTA provides bit-mapped status indication of bad I/O, Manual/Auto, and other block
states.
Block Overruns
When the FBM is operating in the Sequence of Events (SOE) mode, it maintains a queue of
events (input state changes). The EVENT block (running in the CP) periodically ((based on its
Basic Processing Cycle (BPC)) polls the FBM to send to the CP the events at the head of the
queue. Each time the CP does this, it gets a maximum of 3 events (that's all the room there is in
the message). If the CP does not poll often enough the event queue eventually overflows.
1215
B0193AX – Rev AA 66. EVENT – Event Block
When the EVENT queue overflows, the FBM sends an event with the POINT_ID equal to an
error code and the POINT_POLARITY equal to the number of lost events. When the EVENT
block faceplate is displayed, and the CONFIG page is open, the interesting parameters are:
♦ EV_IN - the location in a circular buffer of the event queue head.
♦ REC_NO - the location in the same circular buffer of the event queue tail (location of
the last event)
♦ TIMSTP - the time-stamp of the event most recently fetched by the EVENT block
(milliseconds since midnight) when last (most recent) lost event occurred.
♦ PT_ID - the point ID of the most recent event, except that it shows “**” when the
FBM reports a lost event (lost event record flag).
♦ PT_POL - the polarity, 0 is down and 1 is up, of the most recent event except that it
shows the number of lost events when the FBM reports a lost event (lost record count
1-255, clamped at 255).
If the EVENT block’ BPC is fast enough, the event queue does not overflow and REC_NO fol-
lows EV_IN, trailing by a number in a range of up to 10. This indicates that the event queue tail
does not fall too far behind the queue head. These two numbers wrap to zero at a value of approx-
imately 128. If you observe a PT_ID of “**” or a PT_POL greater than 1, The EVENT block is
losing events. Observing the EV_IN and REC_NO numbers confirms this. You can change the
EVENT block PERIOD parameter to a faster BPC to allow the EVENT block to run more fre-
quently, reducing the number of messages held in the queue and reducing the block overload.
1216
67. EXC – Exception Sequence
Block
This chapter gives a general overview of the EXC (Exception Sequence Block), providing an I/O
diagram and describing its features, parameters and detailed operations.
Overview
The Exception Sequence (EXC) block provides sequential control for regulatory feedback applica-
tions at the equipment control level. Like Independent (IND) and Dependent (DEP) blocks,
EXC blocks can perform a series of activities. EXC blocks are usually used to perform corrective
action when off-normal process conditions are detected.
I/O Diagram
MA EXC
SUSPND
BLOCK
ACTIVE STMNO, SUBRNO
STEPMD SBXNO, STEPNO
9 Parameters OP_ERR
User Parameters ALMSTA, BLKSTA
Subroutines MSGNO
SBXs
BI (1–24) BO (1–16)
II (1–8) Main IO (1–5)
Statement
RI (1–15) Section RO (1–15)
(with steps)
Features
The features are:
♦ Defines a sequence of events with High Level Batch Language (HLBL) statements.
♦ Activates or deactivates other Sequence blocks.
♦ Activates or deactivates Monitor (MON) blocks.
♦ Activates or deactivates individual monitor cases of a MON block.
♦ Controls timers in Timer (TIM) blocks to time events.
♦ Accesses any shared variable and all parameters of any block present in the system.
1217
B0193AX – Rev AA 67. EXC – Exception Sequence Block
Parameters
Table 67-1. EXC Block Parameters
1218
67. EXC – Exception Sequence Block B0193AX – Rev AA
1219
B0193AX – Rev AA 67. EXC – Exception Sequence Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
ACTIVE Active shows the current Sequence block state. Writing to this parameter
changes the block state. When ACTIVE = 1, the block is active. When
ACTIVE = 0, the block is inactive.
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. For the EXC block, only the following unshaded bits are
used:
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
B9
1220
67. EXC – Exception Sequence Block B0193AX – Rev AA
Bit Number1
(0 to 31) Configured Alarm Option When True
0 Alarm Group 8 in Use
1 Alarm Group 7 in Use
7 Alarm Group 1 in Use
1. 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. For the EXC block, only the following bits are used:
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
OPER B5
STAL B6
B7
B8
B9
CRIT PRTYPE
INH
Bit Boolean
Number Connection
(0 to 31)* Name Description When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ALMSTA.B32–
PRTYPE for values used in the ALMSTA.B28
AIN block
5 to 7 CRIT_MSK Criticality; 5 = lowest priority, ALMSTA.B27–
1= highest ALMSTA.B25
26 STAL State Change Alarm ALMSTA.B6
27 OPER Sequence Operational Error ALMSTA.B5
Alarm
29 INH Alarm inhibit ALMSTA.B3
30 UNAK Unacknowledged ALMSTA.B2
BA0001 to BA0004
Boolean Array 1 to 4 are arrays of 16 elements each.
BI0001 to BI0024 Boolean Inputs 1 through 24 are user parameters that can be read in user-
defined monitor case expressions. You cannot assign a value to these
parameters by means of an HLBL statement in a monitor case. You can
optionally assign a label to these inputs to facilitate referencing.
1221
B0193AX – Rev AA 67. EXC – Exception Sequence Block
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the EXC block, only the following bits are used:
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
WLCK B12
B13
PAUS B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
SBX
ACT
ON
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
16 ACT Active/Inactive BLKSTA.B16
18 PAUS PAUS Paused BLKSTA.B14
19 SBX Executing SBX Statements BLKSTA.B13
20 WLCK Workstation Lock BLKSTA.B12
BO0001 to BO0016
Boolean Outputs 1 through 16, are user parameters, and are the evalua-
tion of monitor cases 1 through 16, when active. BO0001 to BO0016 can
be read as an inputs for other monitor cases. You can assign labels to
BO0001 to BO0016, to facilitate referencing.
CRIT Criticality is an integer output that indicates the priority, ranging from 1
to 5, of the block’s highest currently active alarm (1 is the highest priority).
An output of 0 indicates the absence of alarms.
CSPACE Code Space is the total number of bytes to be pre-allocated for the
sequence block and its associated sequence code.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
DEFINE to a true value, correct all configuration errors and reinstall the
block.
1222
67. EXC – Exception Sequence Block B0193AX – Rev AA
DELTI1 Change Delta for Input Range 1 is a real value that defines the minimum
percent of the input range that triggers change driven connections for
parameters in the range of RI1. The default value is 1.
Entering a 1 causes the Object Manager to recognize and respond to a
change of 1 percent of the full error range. If communication is within the
same CP that contains the block’s compound, change deltas have no
effect.
Refer to “Peer-to-Peer Connections of Real-Type Block Inputs” on
page 955 for details on how the I/A Series software affects the change delta
percentage during operation.
DISBX1 to DISBX5
Disable SBX 1 through 5 are boolean outputs. When true, DISX1, for
example, indicates that SBX 1 has been disabled. When the block is acti-
vated, SBX 1 assumes its enabled/disabled state as determined by its
HLBL definition. While the block is active, the SBX 1 enabled/ disabled
state can be changed by manipulating DISBX1, or by executing the
SET_SBXS statement.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the EXC block, the following list
specifies the possible values of ERCODE, and the significance of each
value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not
compatible with compound
PERIOD.
1223
B0193AX – Rev AA 67. EXC – Exception Sequence Block
Message Value
“W44 – INVALID High range value is less than or equal
ENGINEERING RANGE” to low range value.
“W46 – INVALID INPUT The source parameter specified in the
CONNECTION” input connection cannot be found in
the source block, or the source
parameter is not connectable, or an
invalid boolean extension connection
has been configured.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
FPNBUF Full Path Name Buffer contains the full path name of the external refer-
ence (for debugging use only).
HSCI1 High Scale for Input Range 1 is a real value that defines the upper limit of
the measurement ranges. EI1 defines the units. Make the range and units
consistent with the measurement source. A typical value is 100 (percent).
HSCO1 High Scale for Output Range 1 is a real value that defines the upper limit
of the ranges for Output 1. A typical value is 100 (percent). EO1 defines
the units. Make the range and units consistent with those of the output
destination.
IA0001 Integer Array 1 is an array of 16 long integer data stores. They are stan-
dard parameters which may be user labelled.
II0001 to II0008 Integer Inputs 1 through 8 are user parameters that can be read in user-
defined monitor case expressions. You cannot assign a value to these
parameters by means of an HLBL statement in a monitor case. You can
optionally assign a label to these inputs to facilitate referencing. The same
parameters are writable in IND, DEP, and EXC block types.
INHIB Inhibit is a boolean input. When true, it inhibits all block alarms; the
alarm handling and detection functions are determined by the INHOPT
setting. Alarms can also be inhibited based on the compound parameter
CINHIB.
1224
67. EXC – Exception Sequence Block B0193AX – Rev AA
INHOPT Inhibit Option specifies the following actions applying to all block alarms:
0= When an alarm is inhibited, disable alarm messages but do
not disable alarm detection.
1= When an alarm is inhibited, disable both alarm messages and
alarm detection. If an alarm condition already exists at the
time the alarm transitions into the inhibited state, clear the
alarm indicator.
2= Same as 0 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
3= Same as 1 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
INHSTA Inhibit Status contains packed long values that represent the actual inhibit
status of each alarm type configured in the block. For the EXC block, only
the following bits are used:
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
UNACK B2
B3
B4
B5
B6
B7
B8
B9
OPER
STAL
INH
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
26 STAL State Change Alarm INHSTA.B6
27 OPER Sequence Operational Error INHSTA.B5
Alarm
29 INH Inhibit Alarm INHSTA.B3
30 UNACK Unacknowledged INHSTA.B2
IO0001 to IO0005
Integer Outputs 1 through 5 are user parameters that you can reference in
the block’s sequence logic. You can optionally assign labels to these out-
puts to facilitate referencing.
1225
B0193AX – Rev AA 67. EXC – Exception Sequence Block
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
LSCI1 Low Scale for Input Range 1 is a real value that defines the lower limit of
the measurement ranges. A typical value is 0 (percent). EI1 contains the
text for the units. Make the range and units consistent with those of the
measurement source.
LSCO1 Low Scale for Output Range 1 is a real value that defines the lower limit of
the ranges for Output 1. A typical value is 0 (percent). EO1 contains the
text for the units. Make the range and units consistent with those of the
output destination.
MSGGR1 to MSGGR4
Message Groups 1 through 4 are integer inputs (1 through 8), that direct
alarm messages to one of eight groups of alarm devices.
MSGNO Message Number indicates the number of the last message assigned to a
user string parameter. It is incremented by one each time a message is
assigned, to show updates of SN00xx on the detailed displays. If the
parameter value reaches 2E31-1, the next message number is 0.
1226
67. EXC – Exception Sequence Block B0193AX – Rev AA
OP_ERR Operational Error shows the operational error number, if any, caused by
the last statement executed. An operational error occurs when the block
cannot recover from an error by itself. This can happen when:
♦ The error handler SBXs are not present
♦ The error handler SBXs are disabled
♦ An operational error occurs within an error handler.
When this happens, the block changes to manual mode, OP_ERR is set to
indicate the type of error that has occurred, and statement execution stops
until a request is made through STMRQ, MA, or ACTIVE. Refer to the
Integrated Control Configurator document (B0193AV) for a list of opera-
tional error numbers.
OP_GRP Operational Error Group is an integer input (1 through 8) that directs the
operational alarm message to one of eight groups of alarm devices. You
can change the group number at the workstation.
OP_PRI Operational Error Priority is an integer input, (1 to 5), that sets the prior-
ity level of the operational error alarm (highest priority is 1).
1227
B0193AX – Rev AA 67. EXC – Exception Sequence Block
PAUSED Paused shows when a temporary delay in DEP block execution occurs as a
result of active EXC blocks in the same compound.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 seconds, this period is treated internally as 0.6 seconds,
but the PERIOD parameter remains 1.
** If the BPC is 2.0 seconds, this period is treated internally as
6.0 seconds, but the PERIOD parameter remains 10.
*** If the BPC is 0.5 seconds, this period is treated internally as
0.5 seconds, but the PERIOD parameter remains 11.
**** If the BPC is not 2.0 seconds, this period is treated internally as
5.0 seconds, but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 seconds) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 seconds. Refer to the appropriate Integrated Control
Software Concepts document (B0700AG or B0193AW).
PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. The PRTYPE output of this block
includes the following alarm types:
0 = No active alarm
9 = State Alarm
RA0001 to RA0002
Real Array 1 and 2 each define 16 elements for sequence blocks.
1228
67. EXC – Exception Sequence Block B0193AX – Rev AA
RI0001 to RI0015
Real Inputs 1 through 15 are user parameters in all sequence control
blocks but they can only be read in user-defined monitor case expressions.
You cannot assign a value to these parameters by means of an HLBL state-
ment in a monitor case. You can optionally assign labels to these inputs to
facilitate referencing.
RI1 Range Input is an array of real values that specify the high and low engi-
neering scale and change delta of a particular real input. For a given block,
it also forms an association with a group of real input parameters that have
the same designated range and change delta.
RO0001 to RO0015
Real Outputs 1 through 15 are user parameters that you can reference in
the block’s sequence logic. You can optionally assign labels to these out-
puts to facilitate referencing.
RO1 Range Output is an array of real values that specify the high and low engi-
neering scale of a particular real output. For a given block, it also forms an
association with a group of real output parameters that have the same des-
ignated range.
RSTACT Restart Active specifies the desired value of the ACTIVE parameter at
block initialization, where:
♦ 0 sets ACTIVE to 0 (= false = Inactive) when the compound is
turned on or for a station reboot
♦ 1 sets ACTIVE to 1 (= true = Active) when the compound is
turned on or for a station reboot
♦ 2 sets ACTIVE to the value in the checkpoint file for a station
reboot only. Otherwise, ACTIVE remains unchanged.
RSTMA Restart Manual Auto specifies the desired value of the MA parameter at
block initialization, where:
0 sets MA to 0 (= false = Manual)
1 sets MA to 1 (= true = Auto)
2 leaves MA unchanged.
The block asserts this initial M/A state whenever:
♦ The compound in which it resides is turned on
♦ The Control Processor undergoes a restart operation
SBXNO SBX Number indicates the number of the SBX that is currently executing.
The SBX numbers are fixed (1 and 2 are error handlers, 3 to 5 are state
changes handlers). A value of 0 means no SBX is currently executing.
1229
B0193AX – Rev AA 67. EXC – Exception Sequence Block
SBXRQ SBX Request is a nonconfigurable, short integer (1 to 5). When the block
is in the SBX-Trace mode, SBXRQ selects the SBX to be traced. Activate
this function by selecting the EXEC SBX button in the ALL CODE dis-
play. The block ignores out of range values. After granting an SBX request,
the block resets SUBRNO and STMNO to 0. Use the NEXT STMT but-
ton to single-step through the selected SBX.
SC_IND State Change Indicator is a long integer value, that indicates the
current state of the state-change SBXs for the EXC block.
SN0001 to SN0010
Strings 1 through 10 are parameters that you can designate as the destina-
tion of a SENDMSG statement in the EXC sequence logic. The Object
Manager can then retrieve SN0001 to SN0010 for operator display pur-
poses.
STEPMD Step mode is a boolean input. When true, STEPMD indicates the block is
in the step (semi-automatic) mode. In step mode, statement execution
stops at the nearest step boundary, as dictated by the step-labels in the
block’s source code. If a block in Step mode is switched to Manual (MA is
set to false), STEPMD is set to false. If a block in Manual is switched to
Step mode, MA becomes true. In Step mode, the outputs are secured.
STEPNO Step Number indicates the number of the step currently executing.
STEPNO changes as the block crosses a step boundary in the main sec-
tion; it does not change when the block calls a subroutine or executes an
SBX.
STEPRQ Step Request is a nonconfigurable short integer input that specifies the
next HLBL step to be executed in the block’s main section. Execution
begins at the first statement in the step. Activate this function by selecting
the EXEC STEP button in the ALL CODE display. If you enter an out of
range value, the last statement of the block is executed and the IND block
deactivates. The block mode (Manual, Auto, Semi-Auto, or Subr-Trace)
determines the number of HLBL statements executed.
STMNO Statement Number indicates the number of the statement currently exe-
cuting. When the statement finishes execution, STMNO is set to the
number of the next statement dictated by execution flow.
1230
67. EXC – Exception Sequence Block B0193AX – Rev AA
SUBRNO Subroutine Number indicates the number of the subroutine currently exe-
cuting, if any. The subroutine number is determined by its position in the
block’s source file. A value of 0 means no subroutine is currently execut-
ing.
SUSPND Suspended is a boolean output that is set true when the SENDCONF
statement is executed. SENDCONF suspends statement execution until
the timeout value expires or until you set SUSPND to false by selecting
either SUSP ACK or NEXT STMT at the detailed displays.
TIMCNT Timing Counter is a decrementing real counter that indicates how many
seconds remain before expiration of the suspended period for a WAIT
statement or the timeout period for the WAITUNTIL or SENDCONF
statements.
TOPEVL Top of Evaluation Stack is an indexed specification of the top of the inter-
nal evaluation stack (data store for debugging use only).
TRACMD Trace Mode indicator shows whether the block is in Trace mode.
TRACMD Indication
0 Not in trace mode
1 Subr-Trace mode
2 SBX-Trace mode
TYPE When you enter “EXC” or select “EXC” from a configurator list, it creates
an identifying integer specifying this block type.
UNACK Unacknowledge is a boolean output that the block sets to True when it
detects an alarm. It is typically reset by operator action.
1231
B0193AX – Rev AA 67. EXC – Exception Sequence Block
Detailed Operation
An EXC block can be in the Active or Inactive state. When the block is Active and the compound
is on, the block is processed. When Inactive, the block is not processed. When an EXC block is
Active, any DEP blocks in the same compound are Paused. Other sequence control blocks (IND,
MON, EXC, and TIM) are unaffected.
When an EXC block is Active, it is capable of executing its HLBL statements in one of the follow-
ing modes:
♦ Auto
♦ Step (semiautomatic)
♦ Manual
♦ Subr-Trace
♦ SBX-Trace.
Once an EXC block is set Active, it starts executing its Sequence language statements the first
scheduled Basic Processing Cycle (BPC). Since Sequence block algorithms vary in length, a block
may become Inactive within one BPC or it may require several BPCs to execute completely.
Once all statements have been executed, the block deactivates itself unless a statement in the user
algorithm causes it to repeat.
If you program an endless loop in an EXC block, the block does not deactivate itself.
In Auto, the block attempts, each scan period, to process the number of statements specified by
the block’s BPCSTM parameter. The actual number may be less than BPCSTM when statement
execution requires suspension (such as WAIT or WAIT UNTIL, SENDCONF, or access to
remote parameters).
Step mode (also called Semiautomatic) operation is very similar to Auto mode operation except
that the block executes only those statements that belong to a particular Step. Suspension-causing
statements and the value of the BPCSTM parameter determine the maximum number of state-
ments that can be executed per BPC. The block does not deactivate itself automatically in the
Step mode.
You can divide the block’s main section into steps by defining step-labels in the block’s source file.
When in the step mode (STEPMD set to true), the block stops statement execution at the nearest
step boundary. After reaching that boundary, the block idles on the first statement of the next step
and awaits a request (step-, statement-, or next_stm request) to continue statement processing.
In the modes Active/Auto and Active/Step, the block can handle operational errors. Two standard
block exception handlers (SBXs) are supported for error handling.
SBX Number SBX Function
1 System error handler, OP_ERR = no user error
2 User error handler, OP_ERR = 2000..3000
If an operational error occurs, the block sets the parameter OP_ERR to indicate the cause of the
problem. If the corresponding error handling SBX is not present, or it is disabled, the block
switches to Manual and alarming takes place, provided the alarm option is set.
1232
67. EXC – Exception Sequence Block B0193AX – Rev AA
However, if the SBX is present and enabled, the value of OP_ERR is saved in the next process
scan, alarming is suppressed, no switch to Manual takes place, and the SBX statements are exe-
cuted.
Upon completion of the SBX, the block either executes the erroneous statement again, or resumes
statement execution at the statement following the erroneous one, depending on whether the last
executed SBX statement was “RETRY” or “ENDEXCEPTION”.
No additional error handling is possible while the block is executing an error handler SBX.
In the modes Active/Auto and Active/Step the block is capable of reacting to state changes which
are forced upon the block from outside. Three standard block exception handlers are supported
for state change handling. See the following table.
SBX Number SBX Function
3 Transition logic for switch to Inactive
4 Transition logic for switch to Manual
5 (NOT used in EXC blocks)
When the block mode changes from Active/Auto or Active/Step to Inactive or Manual, the state-
ments of the corresponding SBX are executed. During execution of these statements, the block
assumes an interim mode: To_Inactive or To_Manual.
If an operational error occurs during the execution of a To_Manual SBX, the EXC block is deac-
tivated.
All statements are supported within SBXs. Error handling is also possible while the block is exe-
cuting a state change SBX.
In the Auto and Step modes, the block secures its output parameters. The block algorithm is
responsible for updating the output parameters. External sources (applications and other blocks)
cannot write values to block output parameters.
You can alter the order of statement execution while the block is in the Auto state. You can specify
a new starting location by writing a statement number to the STMRQ parameter from a default
or user-defined display.
You can change the block Auto/Manual state from external sources such as: user-defined and
default displays, other blocks, and other applications.
If a statement is in execution when you request a state change, the statement’s execution is com-
pleted as if it had begun in the requested state. Then any following statements are executed as
appropriate for the requested state.
In Manual, the block executes the main section statements one at a time by writing to parameters
STEPRQ, STMRQ or NXTSTM. STEPRQ and STMRQ alter the order of execution. If more
than one are set at the same time, only a single request is granted. The priority in decreasing order
is: step, statement, next statement.
The parameter STMNO indicates the number of the statement currently executing. When the
statement finishes execution, STMNO is set to the number of the next statement dictated by exe-
cution flow. That statement is not executed unless requested.
A statement that requires several BPCs to execute, such as a WAIT statement, need only be
requested once to complete the statement’s execution.
1233
B0193AX – Rev AA 67. EXC – Exception Sequence Block
When the requested statement is a call-subroutine statement the request causes the execution of
all of the statements of that subroutine (and all of its nested subroutines, if any).
In the Manual state, the block does not secure its output parameters. External sources (other
blocks and applications) can write values to the block’s output parameters.
Sequential control block parameters can be updated by the block algorithm while the block is in
Manual.
The Subr-Trace and SBX-Trace modes enable you to single step through statements of subrou-
tines and SBXs. You can switch the block into one of the Trace modes only when the block is in
the Active/Manual state.
Once in the Subr-Trace mode, you “select” a subroutine by requesting a call-subroutine statement
in the block’s main section. The block is then idle before the first statement in the requested sub-
routine. You can then single-step through the subroutine statements by toggling the NXTSTM
parameter. Step- and statement-requests cause the execution of a single statement in the block’s
main section.
When you switch into the SBX-Trace mode, the block environment (that is, step, subroutine,
statement number) is saved. The block returns to this environment when you exit the SBX-Trace
mode.
Once in the SBX-Trace mode, you “select” an SBX by setting the SBXRQ parameter to a value of
1 to 4. SBX5 (a switch to Paused) applies only to the Dependent block. The block ignores out-of-
range values. When you select an SBX, the block idles at the first statement within that SBX. You
can then single-step through the SBX statements by toggling the NXTSTM parameter. The block
ignores step- and statement-requests while it is in the SBX-Trace mode.
In the Manual, Subr-Trace, and SBX-Trace modes, the block does not secure its output parame-
ters. External sources (other blocks and applications) can write values to the block’s outputs.
While the block is in Manual, the IND block algorithm can update user parameters after a step-,
statement-, or next_stm request.
The EXC block does not execute statements while it is Inactive. An EXC block goes to the Inac-
tive state when one of the following conditions occurs:
♦ The last statement of the block’s main section is executed.
♦ An EXIT statement is executed.
♦ Another Sequence block executes an ABORT statement.
♦ The ACTIVE parameter value is toggled to Inactive.
♦ The surrounding compound is switched to OFF.
Sequential control blocks are processed every scheduled Basic Processing Cycle (BPC) as defined
for the Control Processor in which they operate. The number of statements processed each BPC is
determined by the EXC block’s BPCSTM parameter.
The scheduled BPC is determined by the block parameters PHASE and PERIOD. The PHASE
parameter specifies the BPC in which a block should be processed relative to the other blocks in
the compound. PERIOD specifies how often a block should be processed. See the Integrated Con-
trol Concepts document.
All control blocks scheduled in any given BPC are processed in the following order:
1234
67. EXC – Exception Sequence Block B0193AX – Rev AA
1BPC
extension
Compound A Continuous MON/TIM EXC DEP/IND Continuous
Compound B Continuous MON/TIM EXC DEP/IND Continuous
Compound C Continuous MON/TIM EXC DEP/IND Continuous
1 2 3 4
If the block processor cannot process all blocks in a scheduled BPC, there is a Basic Processing
Cycle (BPC) overrun. The system produces an error message to indicate when an overrun occurs.
See the Integrated Control Configurator document for a definition of the HLBL syntax and seman-
tics and for sequence compiler related limits.
1235
B0193AX – Rev AA 67. EXC – Exception Sequence Block
1236
68. FBTUNE – Feedback Tuner
Block
This chapter gives a general overview of the FBTUNE (Feedback Tuner Block), including its
parameters and detailed operations.
Overview
The FBTUNE block is used to adaptively tune gain schedules for the proportional band PBAND,
the integral time INT, derivative time DERIV, dead time DTIME, and the relative gain on set-
point (SPLLAG) of the PIDA and DPIDA blocks. FBTUNE also sets the deviation alarm delay
DEVTIM and the filter time constant FILTER used to prevent high frequency instability in the
PITAU and PIDTAU deadtime controller modes. An FFTUNE block is also provided for selftun-
ing of feedforward gain schedules. The PIDA, DPIDA, and FFTUNE blocks are described else-
where in this manual. Selftuning of the PIDA and DPIDA block is implemented in extension
blocks, allowing selftuning to be added to or removed from an operating PIDA or DPIDA control
block without reinitializing or interrupting the PIDA or DPIDA.
Parameters
Table 68-1. FBTUNE Block Parameters
1237
B0193AX – Rev AA 68. FBTUNE – Feedback Tuner Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command. It wraps around from
32767 to -32768.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the FBTUNE block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
ON
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
20 WLCK Workstation Lock BLKSTA.B12
1238
68. FBTUNE – Feedback Tuner Block B0193AX – Rev AA
BMP Bump is required only for pretuning. Bump is the amplitude of the dou-
blet pulse imposed at the controller output that causes the measurement
to respond. BMP is expressed in percent of the output span and should be
large enough to create a maximum change in the measurement, larger
than 2.5 times THRESH. Then the pulse width is automatically deter-
mined to be slightly greater than the process deadtime.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
DEFINE to a true value, correct all configuration errors and reinstall the
block.
DFCT Derivative Factor is an input that controls the weight of the derivative
term; it multiplies the calculated derivative term by the derivative factor.
Setting DFCT to 0.0 eliminates the derivative term. Setting DFCT to 1.0
produces optimal controller tunings for a lag-delay process. A factor
greater than 1 signals Pretune to tune this factor automatically based on its
identification of the process delay and of primary and secondary lag times.
For processes requiring a large amount of derivative action (for example, a
double integral process), DFCT can be as large as 4.0.
DM Memory Derivative is one of the three parameters that support the PID
recall tuning feature, and is used to store a fallback DERIV setting.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause 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. The block
detailed display shows the ERCODE on the primary page, if it is not null.
For the FBTUNE block, the following list specifies the possible values of
ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PHASE does not exist for given block
PERIOD/PHASE PERIOD, or block PERIOD not compatible
COMBINATION” with compound PERIOD.
“W44 – INVALID High range value is less than or equal to low
ENGINEERING range value.
RANGE”
1239
B0193AX – Rev AA 68. FBTUNE – Feedback Tuner Block
Message Value
“W46 – INVALID The source parameter specified in the input
INPUT connection cannot be found in the source
CONNECTION” block, or the source parameter is not con-
nectable, or an invalid boolean extension
connection has been configured.
“W47 – INVALID A tuning block is connected to a PIDA block
PARAMETER containing a connected tuning constant.
CONNECTION”
“W48 – INVALID The configured value of a block option is
BLOCK illegal.
OPTION”
“W49 – INVALID An illegal block extension has been config-
BLOCK ured for FBTUNE blocks.
EXTENSION”
“W53 – INVALID A parameter value is not in the acceptable
PARAMETER VALUE” range.
“W55 – CONTROLLER An FBTUNE or FFTUNE block has an
DOES NOT EXIST” unspecified or unresolved extension connec-
tion to a PIDA controller block. When the
PIDA is installed, previously installed tuning
blocks waiting for that PIDA will initialize
automatically.
“W56 – INVALID An FBTUNE or FFTUNE block has an
CONTROLLER MODE extension connection to a PIDA block whose
” mode (MODOPT) is not tunable.
“W57 – An FBTUNE or FFTUNE block has an
TUNING_CONSTANT extension connection to a PIDA block that
LINKED” has a linked tuning constant.
“W58 – INSTALL A Database Installer error has occurred.
ERROR;
DELETE/UNDELETE
BLOCK”
IM Memory Integral is one of the three parameters that support the PID
recall tuning feature and is used to store a fallback INT setting.
ITMAX Maximum Integral Time, in minutes, is an input that limits the maximum
integral time and the maximum time for the response peak search. Default
= 200 minutes.
ITMIN Minimum Integral Time, in minutes, is an input that limits the minimum
integral time and the minimum time for the response peak search. Default
= 0 minutes.
1240
68. FBTUNE – Feedback Tuner Block B0193AX – Rev AA
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
OVR Overshoot, the target of the closed loop response, is the negative of the
ratio of the second to the first error peak. OVR has a range from 0.0 to
0.2. The default is 0.1. OVR is not used for PITAU or PIDTAU control
modes.
PBMIN The Minimum Proportional Band is an input (in percent) that limits the
proportional band. Pretune sets this value. Default and minimum value is
0.1%.
PERIOD The FBTUNE block executes with the PERIOD and PHASE of its associ-
ated PIDA or DPIDA block.
PHASE The FBTUNE block executes with the PERIOD and PHASE of its associ-
ated PIDA or DPIDA block.
1241
B0193AX – Rev AA 68. FBTUNE – Feedback Tuner Block
PIDRCL PID Recall is a boolean input request that causes the memory tuning val-
ues PM, IM, and DM to be copied into the working values PBAND,
INT, and DERIV. PIDRCL is honored only in the FB_HOLD mode.
PM Memory PBAND is one of the three parameters that support the PID
recall tuning feature and is used to store a fallback PBAND setting.
PROGLT The lower threshold of the PROG variable is an input. It is specified in the
engineering units of PROG. Default= 0.
PR_FL Process Factor is a configurable integer parameter that controls the type of
self-tuning adaptation. A 0 value invokes the fuzzy interpolation method
(which updates PR_TYP) for MODOPT = PI or PID. A value of 1 for
PR_FL invokes the algebraic tuning method based on the existing process
type PR_TYP and DFCT. PR_FL is automatically set to 1 from 0 if
DFCT is greater than 1 or a MODOPT greater than PID is chosen. A
PR_FL value of 2 suspends updating of the tuning parameters but allows
the appropriate stored tuning set to be activated at the start of each iso-
lated response, based on the value of PROG and the response direction.
Default = 1. The stored tuning sets can be remembered permanently by
checkpointing.
PR_TYP Process Type is a configurable, real parameter that specifies the process
type. It is determined by Pretune and updated in Self-tune if PR_FL is 0,
when the response is isolated and DFCT is not greater than 1. You can
insert a new value at any time. For a pure delay process, PR_TYP is -0.4.
For a lag equal to delay process, PR_TYP is 0. For an integral-delay (very
dominant lag) process, PR_TYP is 1. PR_TYP may be greater than 1 if
the process lag is negative (open-loop unstable). If there is a secondary lag
present, PR_TYP is usually between 0.3 and 1. Default = 0.
PTNREQ Pretune Request is a user-set short integer input that initiates the Pretune
function. The controller must be in Manual, and the process should be
reasonably stationary before setting PTNREQ to 1. The Pretune process is
aborted if the first measurement peak fails to exceed the THRESH value
by a factor of 2.5. This may happen with a very dominant lag process (lag
much larger than the effective deadtime), which may occur in processes
such as temperature loops. If Pretune is initiated by setting PTNREQ to
1242
68. FBTUNE – Feedback Tuner Block B0193AX – Rev AA
2, a small first peak will not abort the Pretune process. However to get a
reliable tuning, the THRESH value should be set to 2.5 times the normal
value in order that the first response peak be substantially larger than
noise. When Selftune starts THRESH should be returned to its normal
value, approximately equal to the peak-to-peak measurement noise. You
can abort Pretune by resetting PTNREQ to 0.
STNREQ Self-Tune Request is a boolean input that drives the self-tuning algorithm
into the self-tune operational mode. It can be initiated by either an opera-
tor request or by a connection-based signal. If STNREQ is set to 1, self-
tuning begins when both PTNREQ and STHREQ are 0. Resetting
STNREQ turns self tuning off. The active tuning constants remain active
but the adapted stored tuning sets are erased.
THRESH Threshold is an input that defines an absolute error threshold (as a percent
of full span) used to trigger a new peak search. It is intended to discrimi-
nate a significant new disturbance response from uncontrollable noise.
THRESH typically ranges from 1% to 30%. Default = 1%.
Detailed Operation
FBTUNE is an extender block for a PIDA or DPIDA block. FBTUNE can be connected or dis-
connected while the PIDA or DPIDA control block is running, without reinitializing or inter-
rupting the PIDA or DPIDA. This is done by configuring the BLKSTA parameter of the PIDA or
DPIDA block into FBTUNE’s PIDBLK parameter. If FBTUNE is connected to another PIDA or
DPIDA, it is automatically disconnected from the first. If another FBTUNE is already connected
to the PIDA or DPIDA, the second FBTUNE connection is not made and the block is declared
undefined.
Pretune
When PTNREQ is toggled on, Pretune applies a doublet pulse of amplitude equal to BMP (or
the distance to the nearest output limit, whichever is smaller).
The pulse duration is made slightly larger than the process delay (dead time). The width is deter-
mined by a MEAS change exceeding THRESH in the direction implied by PIDA’s INCOPT.
The first MEAS peak must be at least 2.5 times the THRESH value.
When DFCT is not greater than 1, measured variable values and times at peaks, zero crossings,
and output-switching instants are used to calculate the parameters of a gain-lag-delay process
model.
1243
B0193AX – Rev AA 68. FBTUNE – Feedback Tuner Block
When DFCT is greater than 1, these observations are used to calculate the parameters of a gain-
lag-lag-delay process model. DFCT is updated based on the result.
These process model parameters determine PR_TYP and together with derivative factor DFCT
are used to calculate PBAND, INT, DERIV, DTIME, and SPLLAG, using the algebraic tuning
method. Pretune also specifies values for ITMAX, ITMIN, PBMIN, and PBMAX.
When Pretune is completed, PTNREQ is reset. You can choose to have Pretune leave the control-
ler in Manual by having STNREQ 0. Otherwise when STNREQ is 1, the controller is automati-
cally placed in Auto and Selftuning is started.
Pretune is aborted if the PIDA is placed in Auto, receives a request to initialize or has a control
error. Pretune is aborted and the controller left in Manual at its original OUT value if the PIDA
bump size is zero, INCOPT is configured incorrectly, the measurement goes out of range, the first
measurement peak is less than 2.5 * THRESH, or the iterative identification or controller design
calculation fails to converge.
Pretune does not calculate controller tuning if the first measurement peak in percent of span is
not greater than 2.5 * THRESH. This makes the process deadtime a significant fraction of the
Pretune pulse width, necessary for a good identification. Pretune may not tune the PIDA, even
when the BMP is large and THRESH is small, if the process has very low gain.
Selftune
The FBTUNE block adaptively tunes gain schedules for the proportional band PBAND, integral
time INT, derivative time DERIV, dead time DTIME, and setpoint relative gain SPLLAG of the
PIDA or DPIDA block. It can also choose a non-zero value for FILTER, the time constant for a
deadtime controller (PITAU or PIDTAU) filter, when there is too much mismatch between pro-
cess and controller deadtimes. Toggling STNREQ to 1 turns Selftune on. Toggling STHREQ to
1 when Selftune is on causes selftuning to be suspended. If PIDRCL is set when selftuning is sus-
pended, the user-set memory tuning constants PM, IM, and DM, are made active and the previ-
ously adapted tuning sets are forgotten.
Each adaptation follows an error or output response, containing as many as four peaks, to a natu-
ral or deliberate disturbance. Either of two main methods for adaptation may be used depending
upon whether the peak pattern contains complete or incomplete information, MODOPT of the
PIDA, and the configured value of PR_FL and DFCT.
When the information is complete, MODOPT is PID or PI, DFCT is not greater than 1, and
PR_FL is 0, a fuzzy interpolation (performance feedback) method is used, using stored response
shape and controller tuning data for key process types. This method allows the PR_TYP to be
identified when more than two peaks are found. This method does not require Pretune to be run
first.
When the information is incomplete or when DFCT is greater than 1 and the response is oscilla-
tory, two parameters of a model are identified based on the peak heights and times. An algebraic
method is used to update the tuning, based on the existing values of PR_TYP and DFCT. If
MODOPT is NIPID, PI_TAU, PID_TAU, or DFCT is greater than 1, or PR_FL is 1, the alge-
braic method is used, based on model partial identification. Preferably, Pretune should be run first
to determine PR_TYP and DFCT.
When only one peak is found, the information is incomplete for model identification and special
“expert” tuning rules are used. These adjust the tuning in a direction to cause oscillations to occur
in a subsequent response. Several adaptations of this type may be required if the starting tuning is
grossly inappropriate.
1244
68. FBTUNE – Feedback Tuner Block B0193AX – Rev AA
Six sets of stored tuning constants are indexed according to the subrange (one of three) separated
by PROGLT and PROGUT of a user-selected variable (PROG) and the sign of the disturbance
response at the moment when its disturbance is detected. PROG, and the user set threshold
PROGUT and PROGLT, are expressed in the same units. When a new disturbance is detected,
the appropriate tuning set is inserted into the PIDA and later updated when the response is com-
pleted. This provides a form of adapted gain scheduling to better cope with process nonlinearity.
You should assign to PROG the set point or a measured load that best correlates with and antici-
pates the nonlinear recovery behavior.
If the process has a secondary lag, better performance can be achieved by choosing a DFCT value
between 1 and 4 before running Pretune. Then Pretune determines optimal values for both
DFCT and PR_TYP.
The adaptor state variable STATEB, a parameter belonging to and displayed with the PIDA
details, indicates the present state of the adaptor and provides diagnostic information. The possi-
ble states are:
♦ PRETUNE
♦ OFF
♦ HOLD
♦ QUIET
♦ PEAK_1
♦ PEAK_2
♦ PEAK_3
♦ PEAK_4
♦ WAIT
♦ SETTLE
If a tuning set, corresponding to the conditions at the start of a new response, has not been previ-
ously adapted, the existing tuning is used and updated.
If a continuing oscillation is marginally stable or unstable, the last successful tuning, if one is
available, is reinserted and the result of next adaptation evaluated. If the further oscillation contin-
ues to be marginally stable or unstable, the user-set fallback tuning parameters PM, IM, and DM
are inserted, and the retuning cycle continued. Failure of the selftuner to quench an oscillation
may be caused by a process nonlinearity such as a sticking control valve, an oscillating load, or an
inappropriate value of PR_TYP.
The fallback tunings PM, IM, and DM cause a deadtime controller (PITAU or PIDTAU) to
behave like a more robust PID controller. Fallback tunings for PITAU can be determined by run-
ning PRETUNE with PIDA’s MODOPT set to PI or PID. Fallback tunings for PIDTAU can be
determined by running PRETUNE with MODPT set to NIPID. However, the PIDTAU does
not behave as a standard non-interacting PID when DTIME is set to zero. Its tuning parameters
should be calculated from those appropriate for MODOPT NIPID.
1245
B0193AX – Rev AA 68. FBTUNE – Feedback Tuner Block
PIDTAU NIPID
Fallback Tunings Tunings
IM = DERIV
DM = INT
PM x IM = PBAND x INT
A STATEB value of PEAK_1 to PEAK_4 indicates the selftuning error peak search is underway.
The present adaptation may be corrupted if a deliberate load change is made while STATEB has
one of these values. During WAIT the error peak search is completed. The timer is waiting for the
output peak search to finish before calculating new tuning. The output peak search feature
enables a high gain controller to detect oscillations at the controller output before they appear on
the measurement. A value of SETTLE indicates that the previous response has not been settled
long enough, but the control error is not large enough to trigger a new peak search.
1246
69. FFTUNE – Feedforward Tuner
Block
This chapter gives a general overview of the FFTUNE (Feedforward Tuner Block), including
its parameters and detailed operations.
Overview
FFTUNE is used to adaptively tune the gain schedules of feedforward compensators for the PIDA
or DPIDA block. An FBTUNE block is also provided for feedback gain schedule selftuning. The
PIDA, DPIDA, and FBTUNE blocks are described elsewhere in this manual. Selftuning of the
PIDA and DPIDA blocks is implemented with extension blocks, allowing selftuning to be added
to or removed from an operating PIDA or DPIDA control block without reinitializing or inter-
rupting the PIDA or DPIDA.
Parameters
Table 69-1. FFTUNE Block Parameters
1247
B0193AX – Rev AA 69. FFTUNE – Feedforward Tuner Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command. It wraps around from
32767 to -32768.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the FFTUNE block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
FTNI
FTN
ON
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
16 FTNI Feedforward Tune Inactive BLKSTA.B16
17 FTN Feedforward Tune Active BLKSTA.B15
20 WLCK Workstation Lock BLKSTA.B12
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
DEFINE to a true value, correct all configuration errors and reinstall the
block.
1248
69. FFTUNE – Feedforward Tuner Block B0193AX – Rev AA
DELTI1 to DELTI4
Change Delta for Input Ranges 1 through 4 are a real values that define
the minimum percent of the input range that triggers change driven con-
nections for parameters in the range of RI1 through RI4. The default
value is 1.
Entering a 1 causes the Object Manager to recognize and respond to a
change of 1 percent of the full error range. If communication is within the
same CP that contains the block’s compound, change deltas have no
effect.
Refer to “Peer-to-Peer Connections of Real-Type Block Inputs” on
page 955 for details on how the I/A Series software affects the change delta
percentage during operation.
DTUN1 to DTUN4
Detune are real factors for loads 1 to 4.
EI1 to EI4 Engineering Units for Input Ranges 1 through 4, as defined by the param-
eters HSCI1 to HSCI4, LSCI1 to LSCI4, and DELTI1 to DELTI4, pro-
vide the engineering units text for the values defined by Input Ranges 1
through 4. “Deg F” or “pH” are typical entries.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause 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. The block
detailed display shows the ERCODE on the primary page, if it is not null.
For the FFTUNE block, the following list specifies the possible values of
ERCODE, and the significance of each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not
compatible with compound
PERIOD.
“W44 – INVALID High range value is less than or equal
ENGINEERING RANGE” to low range value.
“W46 – INVALID INPUT The source parameter specified in the
CONNECTION” input connection cannot be found in
the source block, or the source
parameter is not connectable, or an
invalid boolean extension connection
has been configured.
“W47 – INVALID PARAMETER A tuning block is connected to a
CONNECTION” PIDA block containing a connected
tuning constant.
1249
B0193AX – Rev AA 69. FFTUNE – Feedforward Tuner Block
Message Value
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W49 – INVALID BLOCK An illegal block extension has been
EXTENSION” configured for FFTUNE block.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W55 – CONTROLLER DOES An FFTUNE block has an unspeci-
NOT EXIST” fied or unresolved extension connec-
tion to a PIDA controller block.
When the PIDA is installed, previ-
ously installed tuning blocks waiting
for that PIDA will initialize automat-
ically.
“W56 – INVALID An FFTUNE block has an extension
CONTROLLER MODE” connection to a PIDA block whose
mode (MODOPT) is not tunable.
“W57 – TUNING_CONSTANT An FFTUNE block has an extension
LINKED” connection to a PIDA block that has
a linked tuning constant.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
HSCI1 to HSCI4 High Scale for Input Ranges 1 through 4 are real values that define the
upper limit of the measurement ranges. EI1 to EI4 define the units. Make
the range and units consistent with the measurement source. A typical
value is 100 (percent).
LOAD1 to LOAD4
Measured Load Numbers 1 through 4 are real inputs, whose effect on the
controlled variables are to be diminished by feedforward compensation. If
MULTIN or BIAS is linked in the associated PIDA or DPIDA block,
LOAD4 is ignored. Do not connect the MULTIN or BIAS signal to a
LOADx input, since this causes double compensation.
LOCKID Lock Identifier is a string identifying the workstation which has locked
access to the block via a successful setting of LOCKRQ. LOCKID has the
format LETTERBUG:DEVNAME, where LETTERBUG is the 6-char-
1250
69. FFTUNE – Feedforward Tuner Block B0193AX – Rev AA
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 honored (subject to the usual access rules) only 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
written to LOCKID.
LSCI1 to LSCI4 Low Scale for Input Ranges 1 through 4 are real values that define the
lower limit of the measurement ranges. A typical value is 0 (percent). EI1
to EI4 define the units. Make the range and units consistent with those of
the measurement source.
PERIOD The FFTUNE block executes with the PERIOD and PHASE of its associ-
ated PIDA or DPIDA block.
PHASE The FFTUNE block executes with the PERIOD and PHASE of its associ-
ated PIDA or DPIDA block.
1251
B0193AX – Rev AA 69. FFTUNE – Feedforward Tuner Block
RI1 to RI4 Range Input is an array of real values that specify the high and low engi-
neering scale and change delta of a particular real input. For a given block,
it also forms an association with a group of real input parameters that have
the same designated range and change delta.
THRESH Threshold is an input that defines an absolute error threshold (as a percent
of full span) used to trigger a new moment calculation. It is intended to
discriminate a significant new disturbance response from uncontrollable
noise. THRESH may range from 0% to 100%. Default = 1%.
Detailed Operation
FFTUNE is an extender block for a PIDA or DPIDA block. Therefore FFTUNE can be con-
nected or disconnected while the PIDA or DPIDA control block is running, without reinitializing
or interrupting the PIDA or DPIDA. This is done by configuring the BLKSTA parameter of the
PIDA or DPIDA block into PIDBLK. If FFTUNE is connected to another PIDA or DPIDA, it is
automatically disconnected from the first. If another FFTUNE is already connected to the PIDA
or DPIDA, the second FFTUNE connection is not made and the block is declared undefined.
The FFTUNE block contains and adaptively tunes the feedforward compensators for the PIDA
block. There may be as many as four measured loads, one of which may require multiplicative
compensation. Adaptation occurs when a natural or deliberate disturbance affects one or more of
these loads, provided the response to the disturbance is isolated. The response must begin and end
in the QUIET state, otherwise the adaptation update is aborted. This enables moment integrals,
used in model identification, to converge. The loads may be independent “external” measured
variables or partially dependent measured variables from interacting loops.
Six sets of stored tuning constants are indexed according to the subrange (one of three separated
by PROGLT and PROGUT) of a user-selected variable (PROG) and the sign of the disturbance
at the moment when its disturbance is detected. PROG, PROGUT, and PROGLT must be
expressed in the same units. When a new disturbance is detected, the appropriate tuning set is
inserted and later updated (if the response is isolated) when the response is completed. This pro-
vides a form of adapted gain scheduling to better cope with process nonlinearity. You should
assign to PROG the setpoint or a measured load that best correlates with the recovery nonlinear
behavior.
When a measured load change is sensed (by the change exceeding the user-specified threshold
THRESH), moment integration is initiated. If the peak control error exceeds the user set thresh-
old, the response is judged to be significant. It is confirmed if the FBTUNE feedback adaptor
state indicates that the search for the second peak has started (STATEB > 1). If the response is
confirmed, the state of the feedback adaptor determines the end of the moment integrations when
it returns to its QUIET state. Otherwise, the end is set as four times the expected closed-loop
response time. If the response has not settled in the allotted time or if it is not judged to be signif-
icant, the adaptation update is aborted.
The adaptor state variable STATEF indicates the present state of the adaptor and provides diag-
nostic information. The possible states are:
♦ OFF
1252
69. FFTUNE – Feedforward Tuner Block B0193AX – Rev AA
♦ HOLD
♦ QUIET
♦ UNMEAS
♦ MEAS
♦ SIGNIF
♦ CONFIRM
♦ WAIT
♦ SETTLE
A STATEF value of MEAS to SETTLE indicates the moment integration is underway. Both
STATEF and STATEB are parameters of the associated PIDA or DPIDA block. The present
adaptation may be corrupted if a deliberate setpoint or load change is made while STATEF has
one of these values.
Upon returning to QUIET, a projection algorithm is used to update the compensator parameters
based on the moment values for the just completed response. The projection algorithm finds the
smallest change in process-model parameters that match the zeroth- and first-order moment
observations exactly. Compensator parameters are calculated directly from the model parameters.
Each compensator consists of a gain and mean delay, realized with a second order Butterworth fil-
ter. If a negative value is calculated for the mean delay, a value of zero is used for the delay.
The gain compensation is reduced in proportion to the ratio of the negative time constant to the
closed-loop response time. This is done to avoid trying to compensate excess delay in the manipu-
lated path with a lead or gain compensator, when either would conflict with a well-tuned feed-
back controller’s action.
When the compensation is multiplicative (PIDA MULTIN) or absolute additive (PIDA BIAS),
only dynamic compensation is applied. The primary controller adapts the gain for MULTIN or
offset for BIAS. Retuning the gain compensations for LOADx additive feedforwards is performed
without bumping the process. LOADx additive compensation is performed by adding the deriva-
tive of the compensation into the primary controller’s integral-feedback path so that it is inte-
grated by the primary controller. Do not connect the MULTIN or BIAS signal to a LOADx input
of the FFTUNE. Double compensation would result.
1253
B0193AX – Rev AA 69. FFTUNE – Feedforward Tuner Block
1254
70. GDEV – General Device Block
This chapter gives a general overview of the GDEV (General Device Block), providing an I/O
diagram and describing its features, parameters and detailed operations.
Overview
The General Device (GDEV) block provides Open/Close control of motor or air operated valves
and Run/Stop control of 2-wire or 3-wire motor circuits.
The block supports a 2-wire configuration using a single sustained output, or a 3-wire configura-
tion using two pulsed outputs.
As an Open/Close valve controller, the block supports Open/Close control in the Manual or Auto
mode, as determined by the Manual/Auto state. In Manual, operator Open/Close request are
honored. In Auto, Open/Close requests from another block or task are honored.
As a motor controller, the block supports Run/Stop control in the Manual or Auto mode, as
determined by the Manual/Auto state. In Manual, operator Run/Stop requests are honored. In
Auto, Run/Stop requests from another block or task are honored. You define the output pulse
width.
Valve position is monitored by limit switches at the fully-open and fully-closed positions. Motor
status is monitored by limit switches at the fully-running and fully-stopped states.
Valve or motor status feedback input is used with a timeout alarm parameter. Valve or motor sta-
tus input originates from a CIN or MCIN block, or optionally from a Fieldbus Module (FBM).
When the timeout parameter is enabled, alarming occurs when the desired-state request for the
valve or motor does not match the sensed state within a user-specified time interval.
The Disable mode inhibits GDEV block operation to allow local control of field equipment,
while maintaining alarm detection and response, and limit switch updating. The Auto-Hold
mode allows the valve or motor state to be determined by the hold-state parameter. The Interlock
mode allows the valve or motor state to be determined by the pulse option and interlock-state
parameter.
The GDEV block can read the limit switch signals directly from an FBM, or it can read them
through input parameters. The block can drive the contact outputs directly to an FBM, or it can
drive them through output parameters. If reading the limit switch signals from an FBM and driv-
ing the contact outputs to an FBM, you must use the same FBM.
Duplicate output channel detection is intended to alert you to the fact that this block and another
block capable of digital outputs are connected to the same output point. This does not necessarily
constitute a conflict, since the other block may be in a compound which is not intended to run at
the same time as the compound containing this GDEV block, or the duplicate connection may be
desired as part of an elaborate control scheme. The blocks capable of driving digital outputs are
COUT, MCOUT, GDEV, MTR, VLV, MOVLV, and MDACT.
1255
B0193AX – Rev AA 70. GDEV – General Device Block
When GDEV undergoes one of the following actions, the entire data base is checked for duplicate
output channels:
♦ The block is installed.
♦ The OP_FBM parameter is modified.
♦ The IOM_ID or IOMIDR parameter is modified.
♦ A variable output point number (PNT_NO, CO1_PT, or CO2_PT) is modified.
The duplicate output channel check is also performed when the Control Processor is rebooted. It
is not performed when a compound is switched On or Off.
All blocks connected to the same output point receive the DUPLICATE OUTPUT
CHANNEL warning message, but are not set Undefined.
I/O Diagram
1256
70. GDEV – General Device Block B0193AX – Rev AA
Features
The features are:
♦ Manual/Auto mode for Open/Close or Run/Stop control of a device (for example,
motor or valve)
♦ Auto and Manual latch switch inputs (AUTSW and MANSW) that allow the block
to be switched to Auto or Manual
♦ Hold and Interlock control modes
♦ Disable mode for “local” control of the device
♦ Device state/desired state mismatch alarming
♦ Limit switch state comparison to desired state or an external feedback signal
♦ 2-wire (sustained outputs) or 3-wire (pulsed outputs) configuration
♦ Limit switch feedback inputs from FBM or block parameters
♦ Ignore limit switches
♦ Device output state control on transition to disabled mode and shutdown
♦ Failsafe support.
The options are:
♦ Limit switch 1 (AVLLM1) or limit switch 2 (AVLLM2) available or not available.
♦ Device state control (OP_FBM) outputs to FBM or block parameters.
♦ Individual inversion of the first (INVCO1) or second (INVCO2) device state control
outputs.
♦ Inputs from FBM (IP_FBM), a boolean input, when true, connects the DEVLM1
and DEVLM2 inputs to an FBM. When both limit switches are not available for use,
set IP_FBM to false.
♦ Initialize Manual/Auto (INITMA) specifies the desired state of the MA input during
initialization.
♦ Desired State Override (ZDSOVR) provides the option to specify bumpless mode
transitions when GDEV is configured with sustained outputs not directly connected
to an FBM. ZDSOVR also provides the option to shut down GDEV according to the
shutdown state specified by the shutdown option (SDWNOP).
♦ Manual If Failsafe (MANFS), when configured true, drives the block to the Manual
state if the block detects an incoming failsafe status.
♦ Shutdown Option (SDWNOP) specifies the action to the taken when a GDEV block
is shut down as a result of turning off the compound or disabling the block.
♦ Inhibit Option (INHOPT) specifies alarm inhibit options.
♦ Mode (MODE) parameter that contains the string pool index to the current opera-
tion mode descriptor.
♦ Pulse Option (PLSOPT) dictates whether the block is to control a 2-wire device
(PLSOPT = false) or a 3-wire device (PLSOPT = true). You must use the Control
Configurator to change PLSOPT. When PLSOPT is true, the block generates a posi-
tive going pulse at COUT_1 to control start action, and it generates a negative going
pulse at COUT_2 to control stop action. If PLSOPT is configured, ensure that the
1257
B0193AX – Rev AA 70. GDEV – General Device Block
FBM channels assigned to this block are not configured for pulse operation (see the
CO1_PT and CO2_PT parameters). When PLSOPT is false, the block generates a
sustained output at COUT_1 to control the device.
♦ Invert Limits (INVLMT) specifies that both limit switches be inverted in a GDEV
block before determining the actual state of the device.
Parameters
Table 70-1. GDEV Block Parameters
1258
70. GDEV – General Device Block B0193AX – Rev AA
1259
B0193AX – Rev AA 70. GDEV – General Device Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
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. For the GDEV block, only the following unshaded bits are
used:
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
B9
Bit Number1
(0 to 31) Configured Alarm Option When True
0 (Least Significant) Alarm Group 8 in Use
1 Alarm Group 7 in Use
7 Alarm Group 1 in Use
22 Bad I/O Alarm Configured
1.
Bit 0 is the least significant, low order bit.
1260
70. GDEV – General Device Block B0193AX – Rev AA
ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. For the GDEV block, only the following bits are used:
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
Bit Boolean
Number Connection
(0 to 31)* Name Description When True (B32 to B1)
0 to 4 (Least PTYP_MSK Priority Type: See parameter ALMSTA.B32-
Significant) PRTYPE for values used in ALMSTA.B28
the GDEV block
5 to 7 CRIT_MSK Criticality; 5 = lowest prior- ALMSTA.B27-
ity, 1= highest ALMSTA.B25
22 BAD Bad I/O Alarm ALMSTA.B10
30 UNAK Unacknowledged ALMSTA.B2
AMRTIN Alarm Regeneration Timer is a configurable integer that specifies the time
interval for an alarm condition to exist continuously, after which a new
unacknowledged alarm condition and its associated alarm message is gen-
erated.
ANM Alarm Name is a user-specified character string which you can use to iden-
tify the source of any alarm message associated with the respective block.
It serves as a point descriptor label.
AUTDSR Auto Desired State Request is a boolean input that switches the device
state between Open/Run (AUTDSR = 1) and Close/Stop (AUTDSR = 0),
when in Auto. For the 2-wire configuration with no inversion, the
COUT_1 output follows the AUTDSR input. For the 3-wire configura-
tion with no inversion, a positive transition at the AUTDSR input pro-
duces a positive pulse at the COUT_1 output to start the motor. A
negative transition produces a negative pulse at the COUT_2 output to
stop the motor.
AUTSW Auto Switch is a boolean input that, when true, overrides the MA and
INITMA parameters, and drives the block to the Auto state. If both
MANSW and AUTSW are true, MANSW has priority.
1261
B0193AX – Rev AA 70. GDEV – General Device Block
AVLLM1 to AVLLM2
Availability of Limit Switch 1 and 2 are boolean inputs that, when true,
specify that the appropriate limit switches are available for use. If you are
using these switches, set the parameter true.
BAD Bad is a boolean output parameter which is set true when the input to the
block is unacceptable in any way. The BAD bit of BLKSTA
(BLKSTA.BAD) is also set true whenever BAD is true.
BAG Bad Alarm Group is a short integer input that directs Bad alarm messages
to one of eight groups of alarm devices. You can change the group number
through the workstation.
BAP Bad Alarm Priority is an integer input, ranging from 1 to 5, that sets the
priority level of the Bad alarm (1 is the highest priority).
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional state. For the GDEV block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
DSR
FBM
BAD
HLD
LM2
LM1
ON
ILK
MA
FS
1262
70. GDEV – General Device Block B0193AX – Rev AA
CO1_PT Contact Output 1 Point is a string input that specifies the point number
on the FBM terminal board that connects to the Run Drive input of the
motor. Point number ranges for the applicable FBM types are:
FBM Type Point Number
241 9 to 16
242 1 to 16
9 9 to 16
14 25 to 32
17 11 to 14
CO2_PT Contact Output 2 Point is a string input that specifies, for a 3-wire config-
uration, the point number on the FBM terminal board that connects to
the Stop Drive input of the motor. CO2_PT is ignored in a 2-wire config-
uration. See the CO1_PT definition for the point number ranges.
COUT_1 Contact Out 1 is one of the block’s two boolean outputs. The block never
unsecures COUT_1. During normal 2-wire operation (DISABL = false),
the selected input, is written to COUT_1. During normal 3-wire opera-
tion (DISABL = false), a positive transition at the selected input pulses
this output for the time interval TPULSE (PLSTIM for GDEV).
COUT_1, in turn, is written to the addressed channel of the FBM when
OP_FBM is true. Refer to the MA and DISABL definitions for details on
how they affect COUT_1.
COUT_2 Contact Out 2 is the other of the block's two boolean outputs. The block
never unsecures COUT_2. COUT_2 operates only in the 3-wire configu-
ration. In normal 3-wire operation (DISABL = false), a negative transition
at the selected input, pulses this output for the time interval TPULSE
(PLSTIM for GDEV). COUT_2, in turn, is written to the addressed
channel of the FBM when OP_FBM is true. Refer to the MA and DIS-
ABL definitions for details on how they affect COUT_2.
CRIT Criticality is an integer output that indicates the priority, ranging from 1
to 5, of the block’s highest currently active alarm (1 is the highest priority).
An output of zero indicates the absence of alarms.
DEVLM1 Device Limit Switch 1 is a boolean input for reading the Closed/Stopped
limit switch. When DEVLM1 is true, the device is Closed/Stopped.
DEVLM2 Device Limit Switch 2 is a boolean input for reading the Opened/Run-
ning limit switch. When DEVLM2 is true, the device is Opened/Run-
ning.
1263
B0193AX – Rev AA 70. GDEV – General Device Block
DISABL Disable is a boolean input. When true, DISABL sets the output COUT to
false, and inhibits normal block operation in either Auto or Manual mode.
While DISABL is false (block enabled), the block accepts requests from
either the AUTOPN or MANOPN inputs. DISABL is independent of
MA, and has a higher priority.
DSRIND Device State Request Indicator is a boolean output that indicates, when
PLSOPT = 1, the actual device state request resulting from the block
mode selection (DSRIND = 0 = Close/Stop; DSRIND = 1 = Open/Run).
DSRTRK Desired State Request Track option, when set true, forces unlinked Man-
ual/Auto DSR parameters to track each other. DSRTRK also prevents the
setting of these parameters while the block is not in the parameter’s desig-
nated state. For example, in the GDEV block, AUTDSR cannot be set in
the Manual state, and MANDSR cannot be set in the Auto state. DSR-
TRK is a configurable boolean option that can be set at any time, regard-
less of the compound or block state. However, once DSRTRK is enabled,
it can be disabled only by performing a delete/undelete of the block.
DSRTRK also impacts the bumpless transfer logic (see “Bumpless Mode
Transfers” on page 1283). If a GDEV is configured with the pulse option
(PLSOPT=1) when DSRTRK is false, the bumpless mode transfer logic is
disabled.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the GDEV block, the following
list specifies the possible values of ERCODE, and the significance of each
value in this block:
1264
70. GDEV – General Device Block B0193AX – Rev AA
ERCODE Value
W43 Invalid PERIOD/PHASE combination
W46 Invalid input connection
W47 Invalid parameter connection
W52 PNT_NO out of range for the specified FBM or FBC
W54 Specified IOM_ID does not exist
W58 Install error, delete/undelete block
W59 Duplicate output channel
FS Failsafe is a boolean output that is set true when the block detects the
FBM going to the Failsafe state. While in this state, the block retains the
actual Failsafe value of the output point as it is read back from the FBM.
This value, depending on the ECB Failsafe option, is either the fallback or
the hold value.
HLD Hold is a boolean input. When true and while in Auto, HLD places the
block in the Auto-Hold mode. In this mode, the HLDDSR input deter-
mines the device state.
HLDDSR Hold Desired State Request is a long integer input that switches the device
state when in the Auto-Hold mode. HLDDSR determines the device state
as follows:
HLDDSR Device State
0 Close/Stop
1 Open/Run
<0, >1 Leave as is
IGNLM1 Ignore Limit Switch 1 is a boolean input. When true, IGNLM1 disables
mismatch alarming for the DEVLM1 input. You can change IGNLM1
through the workstation.
IGNLM2 Ignore Limit Switch 2 is a boolean input. When true, IGNLM2 disables
mismatch alarming for the DEVLM2 input. You can change IGNLM2
through the workstation.
INHALM Inhibit Alarm is a packed Boolean input value that specifies the alarm
inhibit requests for each alarm type configured in the block. The GDEV
block uses the following bits:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
1265
B0193AX – Rev AA 70. GDEV – General Device Block
INHIB Inhibit is a boolean input. When true, it inhibits all block alarms; the
alarm handling and detection functions are determined by the INHOPT
setting. Alarms can also be inhibited based on INHALM and the com-
pound parameter CINHIB.
INHOPT Inhibit Option specifies the following actions applying to all block alarms:
0= When an alarm is inhibited, disable alarm messages but do
not disable alarm detection.
1= When an alarm is inhibited, disable both alarm messages and
alarm detection. If an alarm condition already exists at the
time the alarm transitions into the inhibited state, clear the
alarm indicator.
2= Same as 0 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
3= Same as 1 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
INHSTA Inhibit Status contains packed long values that represent the actual inhibit
status of each alarm type configured in the block. For the GDEV block,
only the following bits are used:
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
UNACK B2
B3
B4
B5
B6
B7
B8
B9
BAD
INH
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
1266
70. GDEV – General Device Block B0193AX – Rev AA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
29 INH Inhibit Alarm INHSTA.B3
30 UNACK Unacknowledged INHSTA.B2
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
♦ The compound in which it resides is turned on.
♦ The INITMA parameter itself is modified via the control configu-
rator. (The block does not assert INITMA on ordinary
reconfiguration.)
INITMA is ignored if MA has an established linkage.
INITI Initialization In defines the source block and parameter that drives this
block into initialization. The source for this short integer input is the ini-
tialization output of a downstream block. With V4.2 or later software,
BCALCI contains the cascade initialization request data bit eliminating
the need to configure INITI connections in cascades. However, to pre-
serve backward compatibility, the INITI parameter has been maintained
for use in existing configurations. Existing configurations do not need to
reconfigure their cascades. The logic to set or reset the INITI short value is
maintained, but the setting of the handshaking bits, via the INITI to
INITO connection, is eliminated.
1267
B0193AX – Rev AA 70. GDEV – General Device Block
short value has been maintained, but the setting of the handshaking bits,
via the INITI to INITO connection, is eliminated.
INTDSR Interlock Desired State Request is a boolean input that switches the device
state between Open/Run and Close/Stop, when in Interlock mode.
Device state switching for INTDSR is similar to that of AUTDSR.
INTLCK Interlock is a boolean input. When true while in the Auto, Auto-Hold, or
Manual mode, INTLCK places the block in the Interlock mode. In Inter-
lock, if PLSOPT = 0 INTDSR input determines the device state, and if
PLSOPT = 1 DSRIND determines the device state.
INVCO1 Invert Option for COUT_1 is a boolean input. When true, INVCO1
inverts the COUT_1 output or the FBM output point CO1_PT.
INVCO2 Invert Option for COUT_2 is a boolean input. When true, INVCO2
inverts the COUT_2 output or the FBM output point CO2_PT.
INVLMT Invert Limits specifies that both limit switches be inverted in a GDEV
block before determining the actual state of the device.
IOM_ID Fieldbus Module Identifier is a configurable string that specifies the path-
name of the FBM or FBC to which the block is connected.
IOM_ID has the form CompoundName:BlockName, where Compound-
Name is the 1-12 character name of the local compound containing the
ECB, and BlockName is the 1-12 character block name of the ECB.
If the compound containing the ECB is the CPletterbug_ECB compound
where CPletterbug is the station letterbug of the CP, the CompoundName
may be omitted from the IOM_ID configuration. In this case, the 1-12
character ECB block name is sufficient.
IP_FBM Inputs from FBM is a boolean input. When true, IP_FBM connects the
DEVLM1 and DEVLM2 inputs to an FBM. If both limit switches are not
available for use, set IP_FBM to false. You must use the Integrated Con-
trol Configurator to change IP_FBM.
LM1_PT Limit Switch 1 Point Number is a string input that specifies the point
number on the FBM terminal board that connects to limit switch 1. If this
switch is not available, set LM1_PT to 0 and AVLLM1 to false. Point
number ranges for the applicable FBM types are:
FBM Type Point Number
207 1 to 16
241 1 to 8
1268
70. GDEV – General Device Block B0193AX – Rev AA
LM2_PT Limit Switch 2 Point Number is a string input that specifies the point
number on the FBM terminal board that connects to Limit Switch 2. If
this switch is not available, set LM2_PT to 0 and AVLLM2 to false. See
the LM1_PT definition above for the point number ranges.
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
MANDSR Manual Desired State Request is a boolean input that switches the device
state between Open/Run and Close/Stop, when in Manual. Device state
switching for MANDSR is similar to that of AUTDSR.
1269
B0193AX – Rev AA 70. GDEV – General Device Block
MANSW Manual Switch is a boolean input. When true, MANSW overrides the
MA and INITMA parameters and drives the block to the Manual state. If
both MANSW and AUTSW are true, MANSW has priority.
MMAIND Mismatch Indicator is a boolean output that is set true whenever the
sensed state of the valve (determined by MSTAT) does not match the
requested state within the timer interval, TSTP. The block generates an
alarm when it sets MMAIND true, if the INHIB input is false.
MODE Mode is a parameter that contains the string pool index to the current
operation mode descriptor.
MODE1 to MODE5
Mode 1 to Mode 5 are user-defined strings of up to 12 characters that
describe the device operating mode. The operating modes associated with
MODE1 to MODE5 are:
Parameter Mode
MODE1 Disable
MODE2 Interlock
MODE3 Manual
MODE4 Hold
MODE5 Auto
MODIND Mode Indicator is a long integer output (1 to 5) that indicates the current
device operating mode as follows:
1 = Disable
2 = Interlock
3 = Manual
4 = Auto-Hold
5 = Auto
OP_FBM Outputs to FBM is a boolean input. When true, OP_FBM connects the
COUT_1 and COUT_2 outputs to an FBM. You must use the Integrated
Control Configurator to change OP_FBM.
1270
70. GDEV – General Device Block B0193AX – Rev AA
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 seconds, this period is treated internally as 0.6 seconds,
but the PERIOD parameter remains 1.
** If the BPC is 2.0 seconds, this period is treated internally as
6.0 seconds, but the PERIOD parameter remains 10.
*** If the BPC is 0.5 seconds this period is treated internally as
0.5 seconds, but the PERIOD parameter remains 11.
**** If the BPC is not 2.0 seconds, this period is treated internally as
5.0 seconds, but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PLSOPT Pulse Option for a GDEV block is a boolean input that dictates whether
the block is to control a 2-wire device (PLSOPT = false) or a 3-wire device
(PLSOPT = true). You must use the Integrated Control Configurator to
change PLSOPT. When PLSOPT is true, the block generates a positive
going pulse at COUT_1 to control start action, and it generates a negative
going pulse at COUT_2 to control stop action. If PLSOPT is configured,
ensure that the FBM channels assigned to this block are not configured for
pulse operation (see the CO1_PT and CO2_PT parameters). When
1271
B0193AX – Rev AA 70. GDEV – General Device Block
PLSTIM Pulse Time sets the pulse duration (seconds) of the COUT_1 and
COUT_2 outputs. Enter a value consistent with the drive requirements of
the device. Because PLSTIM is related to the PERIOD parameter, set
PLSTIM to an even multiple of PERIOD. The minimum PLSTIM value
is equal to the PERIOD value. You must use the Integrated Control Con-
figurator to change PLSTIM.
SAG State Alarm Group designates the compound alarm group number (1 to
8) to which state alarm messages are assigned for destination routing.
SAP State Alarm Priority sets the alarm priority (1 to 5) for mismatch alarm
reporting.
SDWNOP Shutdown Option specifies the action to the taken when a GDEV block is
shut down as a result of turning off the compound or disabling the block:
0 = Stop the motor/Close the valve
1 = No change in sustained outputs/Shut off pulses
2 = Start the motor/Open the Valve
STAIND Status Indicator is a long integer output (1 to 12) that indicates the cur-
rent device status. The following table summarizes Device Status Condi-
tions:
DEVLM1
DEVLM2
STAIND
Desired
State
Status Device
String State
1 0 1 0 STAT1 0 state (Closed or Stopped)
2 1 0 1 STAT2 1 state (Opened or Running)
3 0 0 0 or 1 STAT3 Traveling to 0 state
4 1 0 or 1 0 STAT4 Traveling to 1 state
5 0 0 0 MM1 0 state mismatch
6 0 0 1 MM1 0 state mismatch, reverse
1272
70. GDEV – General Device Block B0193AX – Rev AA
DEVLM1
DEVLM2
STAIND
Desired
State
Status Device
String State
7 0 1 1 MM3 0 state mismatch, both
9 1 0 0 MM2 1 state mismatch
10 1 1 0 MM2 1 state mismatch, reverse
11 1 1 1 MM4 1 state mismatch, both
STATUS Status is a parameter that contains the string pool index to the current
device status.
TOC Time to Open or Close is the delay, in minutes, before the comparison for
mismatch is made. Configure a delay at least as great as the maximum
time required for the valve to go from one state to the other. To avoid
truncation, set TOC equal to an integral multiple of the PERIOD. TOC
is changed only by reconfiguring the block.
TTOTAL Timeout Length is an integer used by the block as a local value containing
the total number of block executions in the alarm timeout for output mis-
match.
TYPE When you enter “GDEV” or select “GDEV” from a configurator list, it
creates an identifying integer specifying this block type.
UNACK Unacknowledge is a boolean output that the block sets to True when it
detects an alarm. It is typically reset by operator action.
USERL1 User Long 1 is a long integer input that can be used for application-spe-
cific purposes associated with the device that the GDEV block controls.
Applications such as Batch Plant Management can use USERL1 when
they own the block.
USERL2 User Long 2 is a long integer input that can be used for application-spe-
cific purposes associated with the device that the GDEV block controls.
Applications such as Batch Plant Management can use USERL2 when
they own the block.
1273
B0193AX – Rev AA 70. GDEV – General Device Block
WTOTAL Pulse Width is an integer used by the block as a local value containing the
total number of block executions in the pulse width of a pulsed output.
ZACTIM Active State Time is a real output value that is the accumulation (in hours)
of the elapsed time the block has been in the Activated state.
ZCHNGE State Change Counter is an integer output that counts the number of
block transitions from the Deactivated state to the Activated state.
ZDSOVR Desired State Override is a short integer that is used only with sustained
outputs which are not directly connected to an FBM (FBM = 0 and
PLSOPT = 0). It has the following options:
I Detailed Operation
The GDEV block accepts commands from other blocks and ladder logic circuits to provide
Open/Close control of valves and Run/Stop control of 2-wire or 3-wire electric motors. This
block operates in the Manual/Automatic, Interlock (Fallback), or Position Feedback mode.
Figure 70-2 is a signal flow diagram for the GDEV block.
1274
70. GDEV – General Device Block B0193AX – Rev AA
The GDEV block accepts On/Off commands, called desired state requests (DSRs), from preced-
ing blocks. The block selects one of four DSRs – Auto, Manual, Interlock, or Hold – to control
the On/Off state of the block output(s). The block also accepts contact inputs, DEVLM1 and
DEVLM2, which indicate the actual On/Off state of the device.
The block compares the DSR with the actual state of the device. During transitions of the DSR
from On to Off, or Off to On, the block times the DSR versus DEVLM mismatch condition. If
the mismatch time exceeds a preset value, a mismatch alarm (MMAIND) is generated.
Block Initialization
During initialization, GDEV guarantees that no pulse is generated and that existing pulses are
reset in the FBM. Desired requests or DSRs (AUTDSR, MANDSR) are initialized as follows,
depending on whether they are linked or unlinked and the configuration of the GDEV:
♦ When the DSRs are linked and the GDEV is configured with the pulse option
(PLSOPT=1), the desired history initializes to the current DSR value.
♦ When DSRs are unlinked, and the GDEV is configured with the pulse option
(PLSOPT=1) both DSR and its history are initialized to the current limit switches. If
neither limit switch is available and DSR_RB is unlinked or if the limit switches are in
an indeterminate state, the DSR history initializes to the current DSR value.
♦ When the DSRs are unlinked, a GDEV configured with sustained outputs that are
not directly connected to an FBM (PLSOPT=0, OP_FBM=0) initializes as specified
in the ZDSOVR parameter description.
♦ When the DSRs are unlinked, a GDEV configured with sustained outputs that are
directly connected to an FBM (PLSOPT=0, OP_FBM=1) initializes to the outputs
1275
B0193AX – Rev AA 70. GDEV – General Device Block
read back from the FBM. The GDEV block initializes by editing block parameters
from the ICC, turning the compound on or rebooting.
By contrast, new pulses are generated on mode transitions under certain conditions. See “Block
Mode Control” on page 1279 for more information.
Manual/Auto Operation
The block can operate in the Manual, Auto, Auto-Hold, Interlock, or Disable modes.
In Manual, the block accepts operator-set Open/Run and Close/Stop commands to MANDSR.
In Auto, any block, task, or application program can send Open/Run or Close/Stop requests to
AUTDSR.
If PLSOPT = 1 (3-wire), DSRIND determines the device state. Unlinked MANDSR and
AUTDSR parameters are secured by the block and track the DSRIND parameter.
If PLSOPT = 0 (2-wire), INTDSR determines the device state. Unlinked MANDSR and
AUTDSR parameters are secured by the block and track the INTDSR parameter.
Unlinked desired state request (DSR) parameters may be changed as follows:
♦ MANDSR can be changed only when the block is in Manual.
♦ AUTDSR can be changed while the block is in Auto. If DSRTRK is set true,
AUTDSR can also be changed when the block is in Manual and the HLD input is
true (=1).
1276
70. GDEV – General Device Block B0193AX – Rev AA
If DSRTRK is set true, an unlinked MANDSR parameter is secured by the block and tracks the
AUTDSR parameter when the block is in Auto.
If DSRTRK is set true, an unlinked AUTDSR parameter is secured by the block and tracks the
MANDSR parameter, while the block is in Manual and the HLD input is false (= 0).
In Auto, an unlinked MANDSR parameter is secured by the block preventing any change to
MANDSR from an application program or Sequence logic and MANDSR tracks the AUTDSR
parameter. In the Manual state, with the HLD input false (= 0), an unlinked AUTDSR parameter
is secured by the block and tracks the MANDSR parameter.
The block sets all unlinked DSR parameters to the actual output state, on any block Manual-
Hold-Auto transition except for the Hold-to-Auto transition. This provides bumpless transfer
between Manual and Auto.
If the Pulse Option parameter is set (PLSOPT=1), DSRTRK recovers bumplessly (that is, without
generating a pulse) on the following mode transitions:
♦ From Auto to Hold, if the Hold DSR (HLDDSR) parameter is set to two
♦ From the Disable mode
♦ From Auto to Manual
♦ From Manual to Auto.
Mismatch Alarm
The GDEV block compares the limit switch inputs to the desired state to detect state mismatches.
If the actual state of the device does not match the desired state within the specified TOC time
(minutes), the block enters the mismatch alarm state, sets MMAIND true, and generates an alarm
message. For 3-wire configuration, TOC timing begins at the start of output pulse.
Figure 70-3 shows the normal device state transitions. Figure 70-4 shows the transitions to the
exception states.
1277
B0193AX – Rev AA 70. GDEV – General Device Block
1278
70. GDEV – General Device Block B0193AX – Rev AA
The limit switch parameters are DEVLM1 and DEVLM2. DEVLM1 determines the device
Closed/Stopped state. DEVLM2 determines the device Opened/Running state.
If both limit switches are true at the same time, or if they change position during a stable state, a
mismatch alarm occurs. If the switches recover from a mismatch state, the block generates a return
from mismatch message and sets MMAIND false. INVLMT determines whether or not the limit
switches are inverted before the device is tested.
If the desired state changes before the device reaches a stable state without a mismatch timeout,
the block restarts the TOC time to begin a new timeout. If the desired state changes while in the
mismatch state, the block generates a return from mismatch message and sets MMAIND false.
When DSR_RB is not connected to a block, the GDEV block compares the limit switch inputs
to AUTDSR, MANDSR, INTDSR or DSRIND, or HLDDSR, depending upon the operating
mode. When DSR_RB is connected to a block, the GDEV block compares the limit switch
inputs to DSR_RB, in all operating modes.
You can use Programmable Logic Blocks (PLBs) between the GDEV block and the physical out-
put contacts. In this case, you can connect the DSR_RB parameter to a PLB block, to provide the
GDEV block with an appropriate feedback of the desired state request.
To inhibit mismatch alarming for a faulty limit switch, set IGNLM1 or IGNLM2 true, as appro-
priate. The block simulates the faulty limit switch, DEVLM1 or DEVLM2, and does not gener-
ate mismatch alarms for the faulty switch. This does not inhibit alarming for the other limit
switch or a bad I/O status. You can also inhibit erroneous alarm messages for a bad limit switch by
setting INHIB true.
Unacknowledge (UNACK) is a boolean output parameter which is set true, for notification pur-
poses, 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. The clearing of UNACK is normally via an
operator “acknowledge” pick on a default or user display, or via a user task.
1279
B0193AX – Rev AA 70. GDEV – General Device Block
Disable Mode
Use DISABL to disable/enable block operation in Auto, Auto-Hold, Manual, or Interlock. You
can drive DISABL with a local field contact and use it as a permissive input for maintenance or
local control. If DISABL is true, the block:
♦ Continues to perform alarm detection, alarm message acknowledgment, and limit
switch updating
♦ Indicates the actual position of the upstream device
♦ Inhibits operation in the Auto, Auto-hold, Manual, or Interlock mode
♦ Sets COUT_1 and COUT_2 to different values depending on the value of the
SDWNOP option parameter. Table 70-3 below summarizes the possible combina-
tions, depending on the inversion settings.
NOTE
The values of COUT_1 and COUT_2 during shutdown are also controlled by the
SDWNOP option parameter.
If DISABL is false (block enabled), the status of the other mode control inputs determines the
block operating mode as shown in Table 70-2.
1280
70. GDEV – General Device Block B0193AX – Rev AA
Hold Mode
If HLD is true while in Auto, the block transfers to the Auto-Hold mode, in which HLDDSR
determines the device state as shown in Table 70-4 below.
In the Hold mode, an unlinked MANDSR parameter is secured by the block and tracks the
HLDDSR parameter.
In pulse mode (PLSOPT=1), DSRTRK ignores bumpless recovery on an Auto to Hold transition
when the HLDDSR parameter is 0 or 1.
Interlock Mode
The Interlock mode is typically entered after detecting a device failure, or special motor-control
circuit malfunction or condition. Interlock allows you to override normal Auto/Manual or Hold
modes, when these special conditions occur, without using additional control blocks and/or lad-
der logic circuits.
In typical applications, the mismatch timeout alarm, MMAIND, is connected to INTLCK.
If INTLCK is true while in Auto, Auto-Hold, or Manual, the block transfers to the Interlock
mode. In Interlock, if PLSOPT = 1 DSRIND determines the device state, and if PLSOPT = 0
INTDSR determines the device state. Interlock has three submodes:
♦ Interlock-Manual
♦ Interlock-Auto
♦ Interlock-Auto-Hold
In the Interlock mode, unlinked MANDSR and AUTDSR parameters are secured by the block
and track the INTDSR (PLSOPT = 0) or DSRIND (PLSOPT = 1) parameter.
A transition to the Interlock mode sets MA to false, that is, Manual.
When using PLB blocks between the GDEV block and the physical output contacts, you can
connect the DSR_RB input to a PLB block. In this case, you can use the PLB blocks to do the
interlocks. In Interlock for this case, the GDEV block compares DSR_RB to INTDSR or
DSRIND to detect a mismatch.
If the PLB block provides the appropriate feedback to DSR_RB, the GDEV block does not set
INTALM true for these interlocks.
FBM Input/Output
The GDEV block can read the limit switch signals directly from an FBM, or it can read them
through input parameters, DEVLM1 and DEVLM2. The block can drive the device contact out-
puts directly to an FBM, or it can drive them through output parameters, COUT_1 and
COUT_2. The block can use no more than one FBM for any required inputs and outputs. If
reading the limit switch signals directly from an FBM, it may be any one of the types containing
1281
B0193AX – Rev AA 70. GDEV – General Device Block
digital inputs, that is, the ECB must be type 5, 7, 9, 34, 36, 42, or 46. If driving the
contact outputs to an FBM, it may be any one of the types containing digital outputs, that is, the
ECB must be type 5, 9, 34, 36, 44, or 46. If using both inputs and outputs from an FBM, the
ECB must be type 5, 9, 34, 36, or 46.
At the beginning of an I/O Read cycle, the addressed FBM input and output channels are read
and the values are stored in the ECB for that FBM. When the block initializes, these values are
used to update the limit switch inputs and contact outputs.
To drive the contact outputs to an FBM, the GDEV block interfaces with discrete-type FBMs
that have either sustained or momentary configurations. For valve and motor control applica-
tions, configure the sustained option for FBM channels addressed by the GDEV block.
When the outputs go to an FBM (OP_FBM is true), you map COUT_1 and COUT_2 to phys-
ical I/O points by specifying the Letterbug ID of the FBM and the output point numbers. The
GDEV block writes the output values to the ECB every cycle, regardless of any differences in the
block’s inputs and outputs (if in Auto) or between the block’s outputs and the FBM readback val-
ues (if in Manual).
When the inputs come from an FBM (IP_FBM is true), you map DEVLM1 and DEVLM2 to
physical I/O points by specifying the Letterbug ID of the FBM and the input point numbers.
If limit switch 1 is not available, set LM1_PT to 0 and AVLLM1 to false. If limit switch 2 is not
available, set LM2_PT to 0 and AVLLM2 to false. If both limit switches are not available, set
IP_FBM, AVLLM1, and AVLLM2 to false.
Bad Alarms
If the FBM fails when IP_FBM and/or OP_FBM is true, the block enters the Bad alarm state and
sets BAD true. The same is true when the FBM has not failed, but one or both of the limit
switches supplied by the FBM (IP_FBM = 1) has bad status. COUT_1 and COUT_2 remain at
the last known driven state of the FBM contacts.
Bad has a higher priority than the Auto, Hold, Manual, Interlock, or Disable states. DISABL is
not honored, that is, setting DISABL true while the block state is Bad does not set COUT_1 and
COUT_2 to the Close/Stop state.
The block also sets the bad status bits for MMAIND, COUT_1, COUT_2, DEVLM1, and
DEVLM2, as appropriate.
When the FBM returns to normal, the block resets COUT_1 and COUT_2 for pulsed outputs,
or reads the field value of COUT_1 for sustained output, and sets MA to the value of INITMA.
When reading the limit switch signals from an FBM that is failing, but not driving the contact
outputs to this FBM, you can use the ignore limit switch option to resume device control. When
using this option in this configuration, the GDEV block ignores the BAD I/O status, simulates
the device limits, and generates the appropriate output at COUT_1 and COUT_2.
When the block detects that it is recovering from an FBM failure, it checks the appropriate chan-
nel bits in the FSAFE parameter in the ECB to determine if the failure was a Communications
Failure. If the associated channel bits are true in FSAFE, the block parameter FS sets this. If the
block is Auto and MANFS is false, FS is cleared in one block cycle. If MANFS is true, the block is
switched from Auto to Manual. If the block was either already in Manual or if it switches to Man-
ual, FS remains set true until the block switches to Auto or until the output parameter is written
to by the user.
1282
70. GDEV – General Device Block B0193AX – Rev AA
On the cycle that the block recovers from a failure or initializes, the block reads back the output
value from the FBM. This value is either the FBM Hold value or the Fallback value dependent
upon the configuration of the FBM failsafe mask and failsafe data.
Bad alarms can also be generated when limit switches are not provided by an FBM, that is,
IP_FBM = 0, provided one or both of the parameters DEVLM1 and DEVLIM2 have Bad status.
This only happens if the Bad limit switch input is available (AVLLM1 and/or AVLLM2 is true)
and is not ignored (IGNLM1 and/or IGNLM2 is false).
Open-Loop Indication
When INITO is true, it indicates that the GDEV block is in an open-loop condition. Programs
and upstream blocks can use INITO to sense when this block is open-loop. The open-loop condi-
tions are:
♦ Block initialization
♦ Block is in Disable operating mode
♦ Bad or out-of-service FBM alarm
♦ DSR to DSR_RB mismatch alarm.
1283
B0193AX – Rev AA 70. GDEV – General Device Block
Bumpless transfer logic occurs on all mode changes to auto or manual (except for AUTO-HOLD
to AUTO) if the GDEV is appropriately configured. If not configured for bumpless transfer then
DSRs remain unchanged during mode changes.
The following mode transfers are bumpless:
♦ Auto to Manual
♦ Manual to Auto
♦ Hold to Manual
♦ Interlock to Manual
♦ Interlock to Auto
♦ Disable to Auto
♦ Disable to Manual.
If a GDEV is configured with sustained outputs which are directly connected to an FBM
(PLSOPT=0, OP_FBM=0, DSRTRK = do not care) then, on mode changes to auto or manual,
the desired request is derived by reading back the actual contact output value. If CO1_PT is non-
zero, then the contact output specified by CO1_PT is read back. If CO1_PT is zero, then contact
CO2_PT is read back. The value of DSRTRK does not effect this form of bumpless transfer.
If a GDEV is configured with sustained outputs which are not directly connected to an FBM
(PLSOPT=0, OP_FBM=0, DSRTRK = do no care, and ZDSOVR=0) then, on mode changes to
auto or manual, the desired request is derived from the desired state request readback (DSR_RB)
(If not connected to another block, DSR_RB always tracks the current desired request
(DSRIND)). Bumpless logic is disabled by setting ZDSOVR to 2 to shut down GDEV according
to the shutdown state specified by the shutdown option (SDWNOP) when the block is initializ-
ing due to a reboot or turning on the compound.
If a GDEV is configured with pulse and desired track request options set (PLSOPT=1, DSRTRK
= 1) then, the desired request is derived from either the current position of the limit switches (if
they are in a determinant state) or DSR_RB. DSR_RB is used only if it is linked to another block
and if both limit switches are simulated (IGNLM1 and IGNLM2=1). DSRTRK must be set to
invoke this bumpless logic.
Bumpless logic does not occur if the corresponding desire requests (AUTDSR or MANDSR) are
connected to another block.
1284
70. GDEV – General Device Block B0193AX – Rev AA
returned. Ownership is given up by writing an empty string or a string containing only spaces to
OWNER.
Of course, it remains at all times possible to control the GDEV block, without owning it.
NOTE
The Initialize Option (ZINIOP) is not configurable from the Integrated Control
Configurator (ICC). To configure ZINIOP, you must use the setpars command in
the D\opt\fox\bin\tools folder of the I/A Series workstation. The command syntax
instructions are available on the screen.
1285
B0193AX – Rev AA 70. GDEV – General Device Block
1286
71. IIN – Integer Input Block
This chapter covers the Integer Input (IIN) block, its features, parameters and functions, and
application diagrams.
NOTE
In this chapter, CP270 Only indicates IIN features that are supported only on the
Field Control Processor 270 (FCP270) and Z-form Control Processor 270
(ZCP270) with I/A Series system software V8.4 or later.
Overview
The Integer Input (IIN) block is a Distributed Control Interface (DCI) block. (DCI blocks sup-
port connectivity of I/A Series control stations to various bus-resident devices via a general pur-
pose interface.) IIN can receive one integer value from an external device. The actual receipt and
processing of this value is subject to the conditions established by the Simulation Option and the
Auto/Manual mode of the IIN block.
Basic Operation
The IIN block is used in applications where the external device provides an integer data value to
the I/A Series system for use in a Display Manager, FoxView™ or InFusion View displays, or
connection to an Invensys control strategy. As part of the block’s input processing, the raw value
from the external device, in the form of signed or unsigned 8-bit, 16-bit, 24-bit, or 32-bit integer,
or single-precision float, is converted to 32-bit long integer data for use by the I/A Series system.
Parameter IIN contains the value, read from the external device, as specified by parameter Point
Number (PNT_NO). (The point number syntax varies with the fieldbus protocol and the FBM
used, as described in PNT_NO in Section .) IIN contains the PNT_NO value at all times,
whether the mode is Auto or Manual. In Auto, this value in IIN is copied to parameter LIN. In
Manual, it is not copied to LIN, and you may set the value of LIN.
Parameter TSTAMP contains the timestamp for each change in the value of LIN. The time is
read from the FBM or the connected field device (whenever it is available), or determined by the
CP.
1287
B0193AX – Rev AA 71. IIN – Integer Input Block
With I/A Series system software V8.4, the IIN block provides Bad I/O alarm detection and
reporting on the FCP270 and ZCP270. Alarming is not supported on other control processors.
Features
The IIN block provides the following features:
♦ Support for operator sets in Manual
♦ Support for data type conversion
♦ Input value scaled into I/A Series normalized raw count range before further
processing
♦ Input in I/A Series normalized raw count converted to engineering units
♦ Timestamping with each change in value or status
♦ Simulation option enables testing input to the control strategy without actual field
connections.
♦ Bad I/O alarm detection and reporting (CP270 only).
Parameters
Table 71-1. IIN Block Parameters
1288
71. IIN – Integer Input Block B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
ALMOPT Alarm Options contain packed long values representing the alarm types
(CP270 Only) that have been configured as options in the block, and the alarm groups
that are in use. Table 71-2 shows how the parameter is used by the IIN
block.
Bit Number1
(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
1289
B0193AX – Rev AA 71. IIN – Integer Input Block
Bit Number1
(0 to 31) Configured Alarm Option, When True
5 Alarm Group 3 in Use
6 Alarm Group 2 in Use
7 Alarm Group 1 in Use
22 Bad I/O Alarm Configured
1. 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
(CP270 Only) states. Table 71-3 shows the bits used by the IIN 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
Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type (see PRTYPE page 1296 ---
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 any of ALMSTA.B3
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
(CP270 Only) 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.
BAG Bad Alarm Group is a short integer input that directs Bad alarm messages
(CP270 Only) to one of eight groups of alarm devices. You can change the group number
through the workstation.
BAO Bad Alarm Option is a configurable option that enables alarm generation
(CP270 Only) for each state of IIN.BAD.
1290
71. IIN – Integer Input Block B0193AX – Rev AA
BAP Bad Alarm Priority is an integer input, ranging from 1 (highest priority) to
(CP270 Only) 5 (default), that sets the priority level of the Bad alarm.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the IIN block, only the following bits are used:
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
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DCIX B9
FBM
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
8 FBM Bad Status of ECB BLKSTA.B24
11 MA Manual = 0, Auto = 1 BLKSTA.B21
14 UDEF Block Undefined BLKSTA.B18
15 ON Block On BLKSTA.B17
23 DCIX Enhanced DCI block (CP270 Only) BLKSTA.B9
*Bit 0 is the least significant, low order bit.
CRIT Criticality is an integer output that indicates the priority of the block’s
(CP270 Only) highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. (See ERCODE for the list of all possible validation errors in this
block.) In that case, no further processing of the block occurs, including
further validation of remaining parameters. To return DEFINE to a True
value, you should correct all configuration errors and reinstall the block.
DEV_ID Device Identifier is a character array that specifies the 6-character identi-
fier of the connected device. It is configured in the ECB specified by the
IOM_ID parameter.
1291
B0193AX – Rev AA 71. IIN – Integer Input Block
ERCODE Error Code is a character data store which indicates the type of configura-
tion error which caused the block’s DEFINE parameter to be set False,
unless indicated otherwise (see meanings below). Validation of configured
parameters does not proceed past the first error encountered by the block
logic. Each nonzero value of ERCODE results in an explanatory message
at the block’s detail display. For the IIN block, the following list shows the
possible messages you may see:
1292
71. IIN – Integer Input Block B0193AX – Rev AA
IIN The Integer Input Value is the block input. It contains, at all times, the
actual value received from the field device.
INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
(CP270 Only) 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:
(CP270 Only) ♦ 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
(CP270 Only) inhibit status of each alarm type configured in the block. Table 71-4
shows how the parameter is used with the IIN 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
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.
INITMA Initialize Manual/Auto specifies the desired state of the MA input under
certain initialization conditions, namely:
1293
B0193AX – Rev AA 71. IIN – Integer Input Block
♦ The block has just been installed in the I/A Series station database.
♦ The I/A Series station is rebooted.
♦ The compound in which the block resides is turned on.
♦ The INITMA parameter is modified via a configuration editor.
INITMA is ignored if MA has an established linkage.
When INITMA is asserted, the value set into MA is:
♦ 0 (Manual) if INITMA = 0
♦ 1 (Auto) if INITMA = 1
♦ The MA value from the checkpoint file if INITMA = 2.
IOM_ID ECB Identifier is a configurable string that specifies the pathname of the
ECB201 for the device, for the purpose of connecting to (accessing) a field
parameter that resides in a field device hosted by a (parent) ECB200/202.
IOM_ID has the form CompoundName:BlockName, where Compound-
Name is the 1-12 character name of the local compound containing the
ECB, and BlockName is the 1-12 character block name of the ECB.
If the compound containing the ECB is the CPletterbug_ECB compound
where CPletterbug is the station letterbug of the CP, the CompoundName
may be omitted from the IOM_ID configuration. In this case, the 1-12
character ECB block name is sufficient.
LIN The Integer Input Value is the block output to be used in control strate-
gies. In the Manual mode, it contains operator sets. In the Auto mode, it is
the same as IIN.
LOCKID Lock Identifier is a string identifying the workstation that has locked
(CP270 Only) 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
(CP270 Only) 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.
1294
71. IIN – Integer Input Block B0193AX – Rev AA
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For CP stations, PERIOD values range
from 0 to 10, and 13, and map to the time lengths shown in the following
table. For Gateways and Integrators, PERIOD values range from 0 to 12
and map to the time lengths specified in the device specific user’s guide.
* If the BPC is 0.2 second, this period is treated internally as 0.6 second, but
the PERIOD parameter remains 1.
** If the BPC is 2.0 seconds, this period is treated internally as 6.0 seconds, but
the PERIOD parameter remains 10.
*** Not available for CP stations.
****Available in CP40, CP40B, CP60, FCP270, and ZCP270.
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, a block with
PERIOD of 3 (2.0 seconds) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the
1295
B0193AX – Rev AA 71. IIN – Integer Input Block
I/A Series station is 0.5 second. Refer to Integrated Control Software Con-
cepts (B0193AW) or Control Processor 270 (CP270) Integrated Control Soft-
ware Concepts (B0700AG).
PNT_NO Point Number identifies the address in the external device memory (or
external device data stream) to which the block input is directed. It is a
string whose syntax depends on the FBM and fieldbus protocol used:
♦ For the FBM223 Profibus interface, PNT_NO must be config-
ured to contain a Profibus data identifier. This information
identifies, to the FBM, the address of the input data unit from the
device. Refer to PROFIBUS-DP Communication Interface Module
(FBM223) User’s Guide (B0400FE) for further details.
♦ For the FBM222 Redundant Profibus interface, the PNT_NO
configuration string uses the FBM223 syntax with extensions for
PROFIBUS-PA status, custom status and other features. Refer to
InFusion Enterprise Control System: Implementing PROFIBUS-DP
Networks (B0750BE) for further details.
♦ For the HART interface (FBM214/214b/215/216/216b/218),
PNT_NO must be configured to contain a point address. This
information identifies, to the FBM, specific data in the HART
data stream that is to serve as the device data input to this block.
Refer to HART™ Communication Interface Modules User’s Guide
(B0400FF) for details.
♦ For the Modbus interface (FBM224), PNT_NO must be config-
ured to contain the address of a set of coils in a Modbus device.
Refer to Modbus Communication Interface Module (FBM224)
User’s Guide for details.
♦ For the FDSI (FBM230/231/232/23), PNT_NO contains a data
identifier to identify, to the FBM, specific data in the I/O data
stream and to specify the elements of the data. Refer to Field
Device System Integrators (FBM230/231/232/233) User’s Guide
(B0700AH) for more information.
♦ For the FBM228 Redundant FOUNDATION fieldbus interface, the
point number syntax specifies reads of H1 device function block
parameters using a client/server or publisher/subscriber connec-
tion, as described in Implementing FOUNDATION fieldbus on an
I/A Series System (B0700BA) and InFusion Enterprise Control Sys-
tem: Implementing FOUNDATION fieldbus (B0750BC).
PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
(CP270 Only) of the highest priority active alarm. For the IIN block:
♦ 0 = No alarm
♦ 8 = Bad I/O alarm.
1296
71. IIN – Integer Input Block B0193AX – Rev AA
and data values of IIN are not recovered from the field. IIN, which is nor-
mally secured, is released (provided it is unlinked) and becomes available
for entry of simulated values.
The basic actions of Auto and Manual modes are still observed when
SIMOPT is 1 (True). If the block is in Auto mode, the status and value of
IIN is copied to the status and value of LIN. If in Manual mode, IIN is
not copied to LIN.
TSTAMP The Time Stamp parameter of the block is updated every time there is a
change in value or status of LIN. In Auto mode, this means that the arbi-
trated field input value in IIN has changed. In Manual mode, it means
that a new manual value has been set into IIN. TSTAMP, which is
expressed in units of milliseconds past midnight, is read from the FBM or
connected field device, when it is available there, or if not, is computed by
the I/A Series control station.
TYPE When you enter IIN or select it from a configurator list, an identifying
integer is created specifying this block type. For this block, the value of
TYPE is 116.
UPDPER Update Period is a configurable non-settable long integer that specifies the
update period for certain types of client/server access to FOUNDATION
fieldbus H1 devices and PROFIBUS slave devices:
♦ For the FBM228, the parameter defines the update period for cli-
ent/server access to device block parameters, as described in
Implementing FOUNDATION fieldbus on an I/A Series System
(B0700BA) or Implementing FOUNDATION fieldbus (B0750BC).
The parameter is not used for publisher/subscriber connections.
♦ For the FBM222, the parameter defines the update period for acy-
clic communication between the FBM222 and the
PROFIBUS slave device, as described in Implementing PROFI-
BUS-DP Networks (B0750BE). The parameter is not used for
cyclic communications.
VALSTS Value Status is an output parameter of any DCI block that contains the
value status of a FOUNDATION fieldbus function block parameter value or
PROFIBUS-PA parameter provided by a DCI connection to a field
device. For other fieldbus types, VALSTS is meaningless.
Bits 0-1: Limits:
0 = Not limited
1 = High limited
1297
B0193AX – Rev AA 71. IIN – Integer Input Block
2 = Low limited
3 = High and Low limited
Bits 2-5: Substatus (definition depends on Quality)
Bits 6-7: Quality:
0 = Bad
1 = Uncertain
2-3 = Good
Note: Bit 0 is the least significant, low order bit.
Each time the IIN block is executed, VALSTS reports the status of the FF
or PROFIBUS_PA value from the information in the DCI connection.
This parameter is not supported by PROFIBUS-DP, HART, Modbus, or
FDSI fieldbus devices.
1298
71. IIN – Integer Input Block B0193AX – Rev AA
Functions
Detailed Diagram
IOM_ID
PNT_NO
AND LIN
Auto
IIN.OOS
AND LIN.BAD
Auto
LIN.OOS
CP270 Only:
Auto
OR BAD Alarm
AND
Manual BAO=1
AND
MANALM
Associated ECBs
The configured IOM_ID parameter of the IIN block specifies an ECB201 (the device ECB) to
connect to a field parameter that resides in a field device hosted by an ECB200 or ECB202 (for
redundant FBMs). The PARENT parameter of this ECB201 specifies the ECB200 or ECB202.
IOM_ID may also directly specify the parent ECB200 of a PROFIBUS FBM222 or FBM223 to
retrieve a parameter that resides in the FBM itself.
1299
B0193AX – Rev AA 71. IIN – Integer Input Block
DCI Connection
The IIN block establishes a DCI connection to its specified ECB in any of the following
instances:
♦ The I/A Series control station in which it resides has just been rebooted.
♦ The block has just been installed.
♦ A parameter of the block has been modified by the ICC or FoxCAE™ configurator.
♦ The block has been re-deployed after being modified in IACC or the InFusion Block
Configurator.
♦ The device or parent ECB specified by the IIN block has just been installed.
The DCI connection is added to a linked list of all the DCI connections, of any type, for all
blocks specifying the same ECB. This approach permits multiple DCI blocks, of differing data
types, to communicate with a single device at input/output scan time. It also allows multiple DCI
connections in the same DCI block to be established (for example, connections in redundant type
DCI blocks or for INI_PT connections in output type blocks).
The DCI connection is deleted (that is, the block is removed from the linked list for the ECB)
when the IIN block is deleted.
1300
71. IIN – Integer Input Block B0193AX – Rev AA
Simulation Option
When Simulation Option (SIMOPT) is configured true, there is no DCI connection established
for the block. The IIN parameter can be used to simulate the field data value and its status.
If IIN is linked, the parameter value and its Bad, Out-of-Service, and Error status bits can be
driven by the input connection. If IIN is unlinked, its value and status can be changed by an
application program using standard API/OM access mechanisms, or its value can be changed by
an operator via key actions available at the detailed display.
As noted under “Processing in Auto” and “Processing in Manual” (following), the auto/manual
switching function remains operational when the block is in the simulation mode.
Auto/Manual Arbitration
Parameters MA and INITMA are used to establish the control mode of the IIN block.
Processing in Auto
When the IIN block is in Auto, the status of IIN is copied to the status of LIN, and the value of
IIN is copied to the value of LIN. Both IIN and LIN have last-good-value functionality; if IIN is
Bad or Out-of-Service, its value is not updated from the field, and its value is not copied to LIN.
If simulation is active in Auto, the value set into IIN is copied to LIN exactly as if it had origi-
nated from the field.
Processing in Manual
When the IIN block is in Manual, neither the status nor the value of IIN is copied to LIN, and
values maybe set into LIN manually.
If simulation is active in Manual, the manual value set into LIN remains independent of the sim-
ulation value set into IIN.
1301
B0193AX – Rev AA 71. IIN – Integer Input Block
♦ An ECB201 is specified, and the ECB device status indicates that the DCI connection
is unresolved.
The IIN block is Bad (that is, the status of the IIN parameter is set Bad) if:
♦ The ECB status indicates that the field device has failed.
♦ The DCI connection status information indicates a bad value of the field device
parameter.
The IIN block is in Error (that is, the status of the IIN parameter is set to Error) if the status
information indicates an uncertain or questionable value for the field device parameter.
1302
71. IIN – Integer Input Block B0193AX – Rev AA
When the Bad alarm is inhibited or disabled, an appropriate Alarm Disable message is generated
and sent to all devices in the respective alarm group. If the Alarm is unacknowledged, an Alarm
Acknowledge message is also sent to these devices., and the ALMSTA.INHIB bit is set.
When the Bad alarm is uninhibited or enabled, an appropriate Alarm Enable message is generated
and sent to all devices in the respective alarm group. If all alarms are uninhibited, the
ALMSTA.INHIB bit also is cleared.
The Alarm Message Regeneration Time Interval (AMRTIN) parameter specifies the rate at which
alarm messages are generated for alarm conditions that have not been cleared. The interval is spec-
ified in seconds. The configured interval is rounded up to the closest value that is an even multi-
ple of the station BPC. A value of 0 disables alarm message regeneration. Refer to Control Processor
270 (CP270) Integrated Control Software Concepts (B0700AG) on alarm regeneration.
Time Stamp
The time stamp (TSTAMP) parameter of the block is updated every time there is a change in the
value of LIN. TSTAMP, which is expressed in units of milliseconds past midnight, is read from
the FBM when it is available there; otherwise, it is computed by the I/A Series control station.
NOTE
For a FOUNDATION fieldbus (FF) connection, a 4-byte ms since midnight times-
tamp is provided by the FF FBM and stored in the TSTAMP parameter.
1303
B0193AX – Rev AA 71. IIN – Integer Input Block
1304
72. IINR – Redundant Integer Input
Block
This chapter covers the Redundant Integer Input (IINR) block features, parameters and
functions, and application diagrams.
NOTE
The IINR is supported on the Field Control Processor 270 (FCP270) and the
Z-form Control Processor 270 (ZCP270) with I/A Series system software V8.4 or
later.
Overview
The Redundant Integer Input (IINR) block is a Distributed Control Interface (DCI) block that
runs on the FCP270 and ZCP270 (CP270). The IINR block is primarily used to support point
redundancy with FDSI devices; however, the block supports connectivity of the CP270 to various
other bus-resident devices via its general purpose interface.
The source of the value can be specified as either two or three redundant inputs. The redundant
inputs can either be in the same device or in different devices. The status of each of the redundant
inputs is evaluated before the block’s selection algorithm is invoked to determine which of the two
or three inputs is set into parameter LIN.
2 or 3
Redundant Input Processing To Upstream
External Inputs Block
Input from
Manual Set
Basic Operation
The IINR can receive one integer value from an external device. The source of the value may be
specified as either two or three redundant inputs. The redundant inputs may be in the same
device or different devices. The block’s selection algorithm is invoked to determine which one of
the two or three inputs gets assigned to parameter LIN. The actual receipt and processing of this
value is subject to the conditions established by the Selection Option and the Auto/Manual mode
of the block.
1305
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
In addition, the IINR block supports BAD alarming, including the alarm reprioritization feature
and the alarm message regeneration feature via the AMRTIN parameter. If the MANALM
parameter is set to 1, BAD alarming is enabled when the block is in the manual mode of opera-
tion.
Features
The IINR block provides the following features:
♦ Reads one integer input value from two or three redundant inputs
♦ Support for data type conversion
♦ Input value scaled into I/A Series normalized raw count range before further
processing
♦ Input in I/A Series normalized raw count converted to engineering units
♦ In Auto mode, copies its output to the LIN parameter
♦ In Manual mode, enables manual setting of the LIN parameter.
♦ Provides alarm detection and reporting for BAD alarms.
♦ Timestamping with each change in value or status
♦ Simulation option enables testing input to the control strategy without actual field
connections.
Parameters
Table 72-1. IINR Block Parameters
1306
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
ALMOPT Alarm Options contains packed long values representing the alarm types
that have been configured as options in the block, and the alarm groups
1307
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
that are in use. Table 72-2 shows how the parameter is used by the IINR
block.
Bit Number1
(0-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
13 Tertiary Alarm Option (set if BAO = 1)
14 Secondary Alarm Option (set if BAO = 1)
15 Primary Alarm Option (set if BAO = 1)
22 Bad I/O Alarm Configured (set if BAO = 1)
1. 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 72-3 shows the bits used by the IINR 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
B32
B10
B11
B12
B13
B14
B15
B16
PNT1 B17
PNT2 B18
PNT3 B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
UNAK B1
B3
B4
B5
B6
B7
B8
B9
CRIT PRTYPE
BAD
INH
INH
Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See “PRTYPE” on ---
page 1317 for values used in the
IINR block
5 to 7 CRIT_MSK Criticality: 1 (highest priority) to 5 ---
13 PNT3 Tertiary point is BAD ALMSTA.B19
1308
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
14 PNT2 Secondary point is BAD ALMSTA.B18
15 PNT1 Primary point is bad ALMSTA.B17
22 BAD Bad I/O Alarm (set when bits 13, 14, ALMSTA.B10
15 each = 1; cleared when bit 13 or
14 or 15 = 0)
29 INH Inhibit Alarm. This bit is set when ALMSTA.B3
any of the block’s alarms is inhibited
31 UNAK Unacknowledged ALMSTA.B1
*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.
BAO Bad Alarm Option is s configurable integer that enables (when BAO=1) or
disables (when BAO=0) alarm generation for each state change of the
IIN_x parameters.
BAP Bad Alarm Priority is a configurable, settable integer input used to specify
the alarm priority to be assigned to BAD alarms in the block. The range is
1 (the highest) to 5 (default).
1309
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the IINR block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
FBM3 B22
FBM2 B23
FBM1 B24
B25
B26
B27
B28
B29
PNT3 B30
PNT2 B31
PNT1 B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
MA
ON
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
0 PNT1 BAD Primary point is BAD BLKSTA.B32
1 PNT2 BAD Secondary point is BAD BLKSTA.B31
2 PNT3 BAD Tertiary point is BAD BLKSTA.B30
8 FBM1 Bad Status of primary ECB BLKSTA.B24
9 FBM2 Bad Status of secondary ECB BLKSTA.B23
10 FBM3 Bad Status of tertiary ECB BLKSTA.B22
11 MA Manual = 0, Auto = 1 BLKSTA.B21
14 UDEF Block Undefined BLKSTA.B18
15 ON 1 = Compound On BLKSTA.B17
0 = Compound Off
20 WLCK Workstation Locked BLKSTA.B12
* 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.
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 ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. (See ERCODE for the list of all possible validation errors in this
block.) In that case, no further processing of the block occurs, including
further validation of remaining parameters. To return DEFINE to a True
value, you should correct all configuration errors and reinstall the block.
1310
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
ERCODE Error Code is a character data store which indicates the type of configura-
tion error that caused the block’s DEFINE parameter to be set False,
unless indicated otherwise (see meanings below). Validation of configured
parameters does not proceed past the first error encountered by the block
logic. Each nonzero value of ERCODE results in an explanatory message
at the block’s detail display. For the IINR block, the following list shows
the messages you may see:
1311
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
II1_PT Primary integer input address specifies the source address in the external
device from which the block input is obtained. It is a 1 to 32 character
string whose syntax depends upon the type of the external device from
which the integer input is obtained.
The IIn_PT string syntax depends on the make and model of the external
device.
♦ For the FDSI (FBM230/231/232/23), IIn_PT contains a data
identifier to identify, to the FBM, specific data in the I/O data
stream and to specify the elements of the data. Refer to Field
Device System Integrators (FBM230/231/232/233) User’s Guide
(B0700AH) for more information.
♦ For the FBM223 Profibus interface, IIn_PT must be configured to
contain a Profibus data identifier. This information identifies, to
the FBM, the address of the input data unit from the device. Refer
to PROFIBUS-DP Communication Interface Module (FBM223)
User’s Guide (B0400FE) for further details.
♦ For the FBM222 Redundant Profibus interface, the IIn_PT con-
figuration string uses the FBM223 syntax with extensions for
PROFIBUS-PA status, custom status and other features. Refer to
InFusion Enterprise Control System: Implementing PROFIBUS-DP
Networks (B0750BE) for further details.
♦ For the HART interface (FBM214/214b/215/216/216b/218),
IIn_PT must be configured to contain a point address. This infor-
mation identifies, to the FBM, specific data in the HART data
stream that is to serve as the device data input to this block. Refer
to HART™ Communication Interface Modules User’s Guide
(B0400FF) for details.
♦ For the Modbus interface (FBM224), IIn_PT must be configured
to contain the address of a set of coils in a Modbus device. Refer to
Modbus Communication Interface Module (FBM224) User’s Guide
for details.
♦ For the FBM228, the point number syntax specifies reads of H1
device function block parameters using a client/server or pub-
lisher/subscriber connection, as described in Implementing
FOUNDATION fieldbus on an I/A Series System (B0700BA) and
1312
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
II2_PT Secondary integer input address specifies the source address in the external
device from which the block input is obtained, as described for II1_PT.
II3_PT Tertiary integer input address specifies the source address in the external
device from which the block input is obtained, as described for II1_PT.
IIN_1 Primary LONG integer output contains the integer value read from
address II1_PT in the device ECB specified by IOMID1.
IIN_2 Secondary LONG integer output contains the integer value read from
address II2_PT in the device ECB specified by IOMID2.
IIN_3 Tertiary LONG integer output contains the integer value read from
address II3_PT in the device ECB specified by IOMID3.
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 72-4
shows how the parameter is used with the IINR 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
BAD_1 B17
BAD_2 B18
BAD_3 B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
BAD
1313
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
Bit Boolean
Number* Description, Connection
(0 to 31) Name When True (B32 to B1)
13 BAD_3 Tertiary Point Bad Alarm Inhibited INHSTA.B19
(same as Bit 22)
14 BAD_2 Secondary Point Bad Alarm Inhibited INHSTA.B18
(same as Bit 22)
15 BAD_1 Primary Point Bad Alarm Inhibited INHSTA.B17
(same as Bit 22)
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
(0 < Compound.CINHIB <= BAP or
INHIB=1)
*Bit 0 is the least significant, low order bit.
INITMA Initialize Manual/Auto specifies the desired state of the MA input under
certain initialization conditions, namely:
♦ The block has just been installed into the I/A Series station
database.
♦ The I/A Series station is rebooted.
♦ The compound in which the block resides is turned on.
♦ The INITMA parameter is modified via the Integrated Control
Configurator.
INITMA is ignored if MA has an established linkage.
When INITMA is asserted, the value set into MA is:
♦ 0 (Manual) if INITMA = 0
♦ 1 (Auto) if INITMA = 1
♦ The MA value from the checkpoint file if INITMA = 2.
IOMID1 Primary ECB Identifier is a configurable string that specifies the path-
name of the ECB201 for the primary device, for the purpose of connect-
ing to (accessing) a field parameter that resides in the primary field device
hosted by a (parent) ECB200/202.
IOMID1 has the form CompoundName:BlockName, where Compound-
Name is the 1 to 12 character name of the local compound containing the
ECB, and BlockName is the 1 to 12 character block name of the ECB.
If the compound containing the ECB is the CPletterbug_ECB compound
where CPletterbug is the station letterbug of the CP, the CompoundName
may be omitted from the IOMID1 configuration. In this case, the 1 to 12
character ECB block name is sufficient.
1314
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
NOTE
In some cases involving acyclic communications, the ECB for an FBM222 is speci-
fied instead of an ECB for a connected PROFIBUS slave device, as described in
Implementing PROFIBUS-DP Networks (B0750BE).
NOTE
Once configured, IOMID1 may not be modified. A delete/undelete operation will
NOT allow IOMID1 to be changed. The block must be deleted and then re-
entered into the data base. IOMID1 may then be reconfigured.
IOMID2 Secondary ECB Identifier is a configurable string that specifies the path-
name of the ECB201 for the secondary device, for the purpose of connect-
ing to (accessing) a field parameter that resides in the secondary field
device hosted by a (parent) ECB200/202.
IOMID2 must be configured when dual or triple redundancy is specified.
For other details, see IOMID1 above.
IOMID3 Tertiary ECB Identifier is a configurable string that specifies the pathname
of the ECB201 for the tertiary device, for the purpose of connecting to
(accessing) a field parameter that resides in the tertiary field device hosted
by a (parent) ECB200/202.
IOMID3 must be configured when triple redundancy is specified. For
other details, see IOMID1 above.
LIN Integer Input Value is the block output of the selected value to be used by
the control strategy. In manual, LIN contains operator sets. In Auto, the
parameter is the same as IIN, the selected value.
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.
1315
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For CP270 stations, PERIOD values range
from 0 to 10, and 13, and map to the time lengths shown in the following
table.
* If the BPC is 0.2 second, this period is treated internally as 0.6 second, but
the PERIOD parameter remains 1.
** If the BPC is 2.0 seconds, this period is treated internally as 6.0 seconds, but
the PERIOD parameter remains 10.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the
I/A Series station is 0.5 sec. Refer to Control Processor 270 (CP270)
Integrated Control Software Concepts (B0700AG).
1316
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. For the IINR block:
♦ 0 = No alarm
♦ 8 = Bad I/O alarm
SELECT Selection Indicator shows which redundant IIN_x has been chosen by the
arbitration algorithm:
♦ 0 = none of the input values is selected
♦ 1 = primary input value is selected
♦ 2 = secondary input value is selected
♦ 3 = tertiary input value is selected.
TSTAMP The Time Stamp parameter of the block is updated every time there is a
change in value of LIN. In Auto mode, this means that the arbitrated field
input value in IIN has changed. In Manual mode, it means that a new
manual value has been set into LIN. TSTAMP, which is expressed in units
of milliseconds past midnight, is read from the FBM, when it is available
there, or if not, is computed by the CP270.
TYPE When you enter RINR or select it from a configurator list, an identifying
integer is created specifying this block type. For this block, the value of
TYPE is 59.
1317
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
♦ For the FBM228, the parameter defines the update period for cli-
ent/server access to device block parameters, as described in
Implementing FOUNDATION fieldbus on an I/A Series System
(B0700BA) or Implementing FOUNDATION fieldbus (B0750BC).
The parameter is not used for publisher/subscriber connections.
♦ For the FBM222, the parameter defines the update periods for
acyclic communication between the FBM222 and the
PROFIBUS slave device, as described in Implementing PROFI-
BUS-DP Networks (B0750BE). The parameter is not used for
cyclic communications.
VALSTS Value Status is an output parameter of any DCI block that contains the
value status of a FOUNDATION fieldbus function block parameter value or
PROFIBUS-PA parameter provided by a DCI connection to a field
device. For other fieldbus types, VALSTS is meaningless.
Bits 0-1: Limits:
0 = Not limited
1 = High limited
2 = Low limited
3 = High and Low limited
Bits 2-5: Substatus (definition depends on Quality)
Bits 6-7: Quality:
0 = Bad
1 = Uncertain
2-3 = Good
Note: Bit 0 is the least significant, low order bit.
Each time the IINR block is executed, VALSTS reports the status of the
FF or PROFIBUS-PA value from the information in the DCI connection.
1318
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
Functions
Detailed Diagram
IOMID1
II1_PT Simulated
Value IIN
IOMID2 AND
II2_PT 1 LIN
ECBOPT: AUTO
False = 1 ECB SIMOPT
True = 2 or 3 ECBs
0
IOMID3
II3_PT
1
ARBOPT
0
INVALID IIN
SELECT
IIN_1
AND LIN
IIN_2
AUTO
IIN_3
SELOPT
ECB Bad or
Out of Service
Block Initialization
The IINR block initializes when any of the following 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.
♦ Any of the ECBs connected to the block is installed or reconfigured.
When the IINR initializes, the ERCODE parameter and the alarm information retained by the
block are cleared:
♦ All alarm status parameters (ALMSTA, CRIT, PRTYPE, UNACK) are cleared.
♦ All alarm history variables are cleared.
1319
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
♦ An Alarm Disable message is issued to all devices in the bad alarm group. If the Bad
Alarm is unacknowledged, an Alarm Acknowledge message is also sent to these
devices.
Block Validation
When the IINR block initializes, the block validates the SELOPT parameter first. If SELOPT
does not equal FIRST GOOD VALUE (SELOPT=1) or LAST GOOD VALUE (SELOPT=0)
the block is marked undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE)
set to “W48 – INVALID BLOCK OPTION.”
If the block simulation option is not used (SIMOPT=0), the following block validation tests are
performed:
♦ If the IINR block is installed prior to the installation of any of the device ECBs, it is
be marked undefined (BLKSTA.UDEF=1) with the error code parameter (ERCODE)
set to “W54 - ECB DOES NOT EXIST.” In this case, the IINR block configuration
is e-validated automatically when any device ECB has been installed.
♦ If any device ECB is not a DCI type, the ECB the block will be undefined (BLK-
STA.UDEF=1) with ERCODE set to “W51 - INVALID HARDWARE/
SOFTWARE TYPE.”
♦ If the first character of any used IIn_PT is blank, the IIn_PT string is not sent to the
FBM, and the block is set undefined (BLKSTA.UDEF=1) with ERCODE set to
“W52 - INVALID I/O CHANNEL/GROUP NUMBER.”
♦ If the PERIOD/PHASE combination configured in the IINR block is inconsistent, or
if the PERIOD/PHASE combination conflicts with the compound PERIOD/PHASE
combination, the IINR block is undefined with ERCODE set to “W43 - INVALID
PERIOD/PHASE COMBINATION.”
If there are no configuration errors when the IINR 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, at which time the following
actions are taken:
♦ All history variables are cleared.
♦ The Auto/Manual parameter (MA) is initialized to Auto if INITMA=1 or to Manual
if INITMA=0. The corresponding BLKSTA.MA status bit is set or cleared
accordingly.
Associated ECBs
The configured parameters IOMID1, IOMID2, and IOMID3 of the IINR block specify one or
more ECB201s (the “Device ECBs”) to connect to field parameters that reside in field devices
hosted by one or more ECB200s/ECB202s (the “FBM ECBs”).
The PARENT parameter of each ECB201 specifies the associated FBM ECB hosting the field
device.
DCI Connections
Table 72-5 shows the DCI connections for all combinations of ECBOPT and ARBOPT:
1320
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
Simulation Option
When Simulation Option (SIMOPT) is configured true, there is no DCI connection established
for the block. The IIN parameter can be used to simulate the field data value and its status.
If IIN is linked, the parameter value and its Bad, Out-of-Service, and Error status bits can be
driven by the input connection. If IIN is unlinked, its value and status can be changed by an
application program using standard API/OM access mechanisms, or its value can be changed by
an operator via key actions available at the detailed display.
The statuses and data values of IIN_1, IIN_2, and IIN_3 are not recovered from the field if
SIMOPT is true.
1321
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
As noted in Section and Section , the Auto/Manual switching function remains operational when
the block is in simulation mode.
Auto/Manual Modes
The Auto/Manual mode selection arbitrates between inputs by the operator (Manual) and inputs
from the field (Auto.)
Parameters MA and INITMA are used to establish the control mode of the IINR block, in accor-
dance with the general rules defined in CP270 Integrated Control Software Concepts (B0700AG).
Operation in Auto
In Auto mode, the input data and status from the two or three redundant inputs are processed
and arbitrated as described in the previous sections. The Bad, Out-of- Service, and Error bits from
the status of IIN are copied to the corresponding status bits of LIN. If neither the Bad nor Out-
of-Service bits are set, the value of IIN is also copied to the value of LIN. If either of these bits is
set, the value of IIN is not copied to LIN, and LIN retains its last good value.
If simulation is active in Auto, the value set into IIN is copied to LIN exactly as if it had origi-
nated from the field.
Operation in Manual
In Manual mode, the input data and status from the two or three redundant inputs is processed
and arbitrated exactly as in the case of the Auto mode. Therefore the value and status of parameter
IIN continues to reflect the actual field inputs. However, neither the status nor the value of IIN is
copied to LIN, and LIN may be used for manual sets. The output of the IINR block as normally
used by the control strategy is therefore the LIN parameter, whether the block mode is Auto or
Manual.
If simulation is active in Manual, the manual value set into LIN remains independent of the sim-
ulation value set into IIN.
If MANALM=0, alarm information retained by the block will be cleared upon transitioning to
Manual mode of operation.
1322
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
The connection status information indicates disconnected, meaning in general that the parameter
is not connected or not defined.
The connection status information indicates that the connection is not yet resolved. The detail
display will show “W62 – UNRESOLVED CONNECTION” with ERCODE = 62.
An ECB201 is specified and the ECB device status indicates that the DCI connection is
unresolved.
The status of IIN_x is set to Bad if:
♦ The ECB status indicates that the field device has failed.
♦ The DCI connection status information indicates a bad value of the field device
parameter.
♦ The Control Processor loses communications with an FBM.
The status of IIN_x is set to Error if:
♦ The status information indicates an uncertain or questionable value of the field device
parameter.
Finally, if IIN_x is not Out-of-Service, the value of that field input is conditioned as described in
Section 8.6, and the result is set into the value of IIN_x. Otherwise the previous value (last good
value) of IIN_x is retained.
The statuses and values of the individual IIN_x are available in the three output parameters, and,
in addition, they are used as the inputs to the arbitration algorithm. See Section Arbitration
(Selection) Algorithm.
1323
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
Bad Alarming
Bad alarm detection is enabled when the bad alarm option (BAO) is set.
A Bad alarm message is generated for an input value when its status is bad (IIN_1.BAD,
IIN_2.BAD, IIN_3.BAD) independent of the status of the other inputs. The Bad alarm message
is sent to all devices in the bad alarm group specified by the BAG parameter. This message con-
tains text string identifying the input value (BAD1, BAD2, or BAD3), the descriptive text in the
BAT parameter, and the loop identifier in the LOOPID parameter.
When any input value becomes good, a corresponding return-to-normal message is generated and
sent to all devices in the bad alarm group. Bad alarm status information, however, is generated
only when all input values are bad.
When all input values are bad, the following parameters and bits are set:
♦ BAD bit in the alarm status parameter (ALMSTA.BAD)
♦ UNACK parameter and the corresponding ALMSTA.UNACK bit.
♦ CRIT parameter and its corresponding ALMSTA.CRIT are set to the BAP parameter
value
♦ PRTYPE parameter and its corresponding ALMSTA.PRTYPE field are set to the Bad
alarm type.
When all input values have returned to good status, CRIT, PRTYPE and their corresponding
fields in ALMSTA are cleared.
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).
1324
72. IINR – Redundant Integer Input Block B0193AX – Rev AA
♦ When all input values return to good status and 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 are supported using a combination of the compound CINHIB
parameter and the INHOPT and INHIB parameters in the IINR block, to allow the bad alarm
messages to be inhibited and/or the alarm detection to disabled dynamically.
When the Bad alarm is inhibited or disabled, an appropriate Alarm Disable message is generated
and sent to all devices in the respective alarm group. If the Alarm is unacknowledged, an Alarm
Acknowledge message is also sent to these devices., and the ALMSTA.INHIB bit is set.
When the Bad alarm is uninhibited or enabled, an appropriate Alarm Enable message is generated
and sent to all devices in the respective alarm group. If all alarms are uninhibited, the ALM-
STA.INHIB bit also is cleared.
The Alarm Message Regeneration Time Interval (AMRTIN) parameter specifies the rate at which
alarm messages are generated for alarm conditions that have not been cleared. The interval is spec-
ified in seconds. The configured interval is rounded up to the closest value that is an even multi-
ple of the station BPC. A value of 0 disables alarm message regeneration. Refer to CP270
Integrated Control Software Concepts (B0700AG) on alarm regeneration.
Time Stamping
The IINR block provides a time stamp in the TSTAMP parameter every time there has been a
change in the value of LIN or whenever the block is installed. The time is expressed in units of
milliseconds past midnight. TSTAMP is read from the FBM when it is available there, and, if not,
is computed by the CP270.
In Auto the TSTAMP parameter is updated when the arbitrated field input value in LIN has
changed. In Manual the TSTAMP parameter is updated when a new manual value has been set
into LIN.
NOTE
For a FOUNDATION fieldbus (FF) connection, a 4-byte ms since midnight times-
tamp is provided by the FF FBM and stored in the TSTAMP parameter.
Block Shutdown
The IINR block shuts down when any of the following events occurs:
♦ The compound containing the block is turned off.
♦ The compound containing the block is deleted.
♦ Any of the ECBs connected to the block is deleted.
♦ The IINR block itself is deleted.
When block shutdown occurs, the following actions will be taken:
♦ All alarm status information (ALMSTA, CRIT, PRTYPE, UNACK) is cleared.
♦ An Alarm Disable message will be issued to all devices in the bad alarm group. If the
Bad Alarm is unacknowledged, an Alarm Acknowledge message also will be sent to
these devices.
1325
B0193AX – Rev AA 72. IINR – Redundant Integer Input Block
1326
73. IND – Independent Sequence
Block
This chapter gives a general overview of the IND (Independent Sequence Block), providing an
I/O diagram and describing its features, parameters and detailed operations.
Overview
The Independent Sequence (IND) block provides sequential control for regulatory feedback
applications at the equipment control level. An IND block can be used to perform a series of
activities; for example: filling, mixing, and draining the contents of a tank.
I/O Diagram
IND
MA SUSPND
BLOCK
ACTIVE STMNO, SUBRNO
STEPMD Standard SBXNO, STEPNO
Parameters OP_ERR
User Parameters ALMSTA, BLKSTA
Subroutines MSGNO
SBXs
BI (1–24) BO (1–16)
Main
II (1–8) Statement IO (1–5)
RI (1–15) Section RO (1–15)
(with steps)
Features
The features are:
♦ Defines a sequence of events with High Level Batch Language (HLBL) statements.
♦ Activates or deactivates other Sequence blocks.
♦ Activates or deactivates Monitor (MON) blocks.
♦ Activates or deactivates individual monitor cases of a MON block.
♦ Controls timers in Timer (TIM) blocks to time events.
♦ Accesses any shared variable and all parameters of any block present in the system.
Since DEP blocks pause when any EXC blocks in the same compound are Active and
IND blocks do not, you may want to use IND blocks to supervise DEP blocks. For
example, an IND block can activate a DEP block to carry out a function, such as fill-
ing a tank.
1327
B0193AX – Rev AA 73. IND – Independent Sequence Block
If a MON block detects an off normal process condition and activates an EXC block
to take corrective action, the DEP block automatically pauses until the corrective
action is complete.
When the EXC block is done, the DEP block can finish executing. Then the supervis-
ing IND block can activate another DEP block responsible for the next cycle in the
process.
♦ The user-defined algorithm consists of:
♦ Local block variables to be used by the block’s algorithm. They cannot be accessed
from outside the block.
♦ Subroutines.
♦ Standard Block Exception Handlers (SBXs) that contain:
♦ Error handling logic to be executed in order to recover from an operational
error.
♦ “Transition” logic to be executed when the operational mode of the block
changes from Active/Auto or Active/Semi-Auto to another mode.
♦ The block’s main section, which may subdivided into steps.
The options are:
♦ Restart Manual Auto (RSTMA) specifies the desired value of the MA parameter at
block initialization.
♦ Restart Active (RSTACT) specifies the desired value of the ACTIVE parameter at
block initialization, where:
♦ RSTACT = 0: sets ACTIVE to false when the compound is turned on or for a
station reboot.
♦ RSTACT = 1: sets ACTIVE to true when the compound is turned on or for a
station reboot.
♦ RSTACT = 2: sets ACTIVE to the value in the checkpoint file for a station reboot
only. Otherwise, ACTIVE remains unchanged.
♦ Inhibit Option (INHOPT) allows you to specify alarm inhibit options.
♦ Operational Error Alarm Option (OP_OPT) enables or disables operational error
alarm messages and indications. You can change OP_OPT only by reconfiguring the
block.
Parameters
Table 73-1. IND Block Parameters
1328
73. IND – Independent Sequence Block B0193AX – Rev AA
1329
B0193AX – Rev AA 73. IND – Independent Sequence Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a SET command.
Note: Each time a block parameter is changed via HLBL code, parameter
MSGNO is incremented.
ACTIVE Active shows the current Sequence block state. Writing to this parameter
changes the block state. When ACTIVE = 1, the block is active. When
ACTIVE = 0, the block is inactive.
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. For the IND block, only the following unshaded bits are
used:
1330
73. IND – Independent Sequence Block B0193AX – Rev AA
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
B9
Bit Number1
(0 to 31) Configured Alarm Option When True
0 Alarm Group 8 in Use
1 Alarm Group 7 in Use
7 Alarm Group 1 in Use
1.
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. For the IND block, only the following bits are used:
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
OPER B5
STAL B6
B7
B8
B9
CRIT PRTYPE
INH
BA0001 to BA0004
Boolean Array 1 to 4 are arrays of 16 elements each.
1331
B0193AX – Rev AA 73. IND – Independent Sequence Block
BI0001 to BI0024 Boolean Inputs 1 through 24 are user parameters that can be read in user-
defined monitor case expressions. You cannot assign a value to these
parameters by means of an HLBL statement in a monitor case. You can
optionally assign a label to these inputs to facilitate referencing.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the IND block, only the following bits are used:
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
WLCK B12
B13
PAUS B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
SBX
ACT
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
11 MA Manual(= false)/Auto(= true) BLKSTA.B21
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
16 ACT Active/Inactive BLKSTA.B16
18 PAUS Paused BLKSTA.B14
19 SBX Executing SBX Statements BLKSTA.B13
20 WLCK Workstation Lock BLKSTA.B12
* Bit 0 is the least significant, low order bit.
BO0001 to BO0016
Boolean Outputs 1 through 16, are user parameters, and are the evalua-
tion of monitor cases 1 through 16, when active. BO0001 to BO0016 can
be read as an inputs for other monitor cases. You can assign labels to
BO0001 to BO0016, to facilitate referencing.
CRIT Criticality is an integer output that indicates the priority, ranging from 1
to 5, of the block’s highest currently active alarm (1 is the highest priority).
An output of 0 indicates the absence of alarms.
CSPACE Code Space is the total number of bytes to be pre-allocated for the
sequence block and its associated sequence code.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
1332
73. IND – Independent Sequence Block B0193AX – Rev AA
DELTI1 Change Delta for Input Range 1 is a real value that defines the minimum
percent of the input range that triggers change driven connections for
parameters in the range of RI1. The default value is 1.
Entering a 1 causes the Object Manager to recognize and respond to a
change of 1 percent of the full error range. If communication is within the
same CP that contains the block’s compound, change deltas have no
effect.
Refer to “Peer-to-Peer Connections of Real-Type Block Inputs” on
page 955 for details on how the I/A Series software affects the change delta
percentage during operation.
DISBX1 to DISBX5
Disable SBX 1 through 5 are boolean outputs. When true, DISX1, for
example, indicates that SBX 1 has been disabled. When the block is acti-
vated, SBX 1 assumes its enabled/disabled state as determined by its
HLBL definition. While the block is active, the SBX 1 enabled/disabled
state can be changed by manipulating DISBX1, or by executing the
SET_SBXS statement.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the IND block, the following list
specifies the possible values of ERCODE, and the significance of each
value in this block:
1333
B0193AX – Rev AA 73. IND – Independent Sequence Block
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W44 – INVALID High range value is less than or equal to
ENGINEERING RANGE” low range value.
“W46 – INVALID INPUT The source parameter specified in the
CONNECTION” input connection cannot be found in
the source block, or the source parame-
ter is not connectable, or an invalid
boolean extension connection has been
configured.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE
BLOCK”
FPNBUF Full Path Name Buffer contains the full path name of the external refer-
ence (for debugging use only).
HSCI1 High Scale for Input Range 1 is a real value that defines the upper limit of
the measurement ranges. EI1 defines the units. Make the range and units
consistent with the measurement source. A typical value is 100 (percent).
HSCO1 High Scale for Output Range 1 is a real value that defines the upper limit
of the ranges for Output 1. A typical value is 100 (percent). EO1 defines
the units. Make the range and units consistent with those of the output
destination.
IA0001 Integer Array 1 is an array of 16 long integer data stores. They are stan-
dard parameters which can be user labelled.
II0001 to II0008 Integer Inputs 1 through 8 are user parameters that can be read in user-
defined monitor case expressions. You cannot assign a value to these
parameters by means of an HLBL statement in a monitor case. You may
optionally assign a label to these inputs to facilitate referencing. The same
parameters are writable in IND, DEP, or EXC block types.
INHIB Inhibit is a boolean input. When true, it inhibits all block alarms; the
alarm handling and detection functions are determined by the INHOPT
1334
73. IND – Independent Sequence Block B0193AX – Rev AA
INHOPT Inhibit Option specifies the following actions applying to all block alarms:
0= When an alarm is inhibited, disable alarm messages but do
not disable alarm detection.
1= When an alarm is inhibited, disable both alarm messages and
alarm detection. If an alarm condition already exists at the
time the alarm transitions into the inhibited state, clear the
alarm indicator.
2= Same as 0 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
3= Same as 1 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
INHSTA Inhibit Status contains packed long values that represent the actual inhibit
status of each alarm type configured in the block. For the IND block, only
the following bits are used:
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
UNACK B2
B3
B4
B5
B6
B7
B8
B9
OPER
STAL
INH
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
26 STAL
State Change Alarm INHSTA.B6
27 OPER
Sequence Operational Error INHSTA.B5
Alarm
29 INH Inhibit Alarm INHSTA.B3
30 UNACK Unacknowledged INHSTA.B2
* Bit 0 is the least significant, low order bit.
IO0001 to IO0005
Integer Outputs 1 through 5 are user parameters that you can reference in
the block’s sequence logic. You can optionally assign labels to these out-
puts to facilitate referencing.
1335
B0193AX – Rev AA 73. IND – Independent Sequence Block
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
LSCI1 Low Scale for Input Range 1 is a real value that defines the lower limit of
the measurement ranges. A typical value is 0 (percent). EI1 defines the
units. Make the range and units consistent with those of the measurement
source.
LSCO1 Low Scale for Output Range 1 is a real value that defines the lower limit of
the ranges for Output 1. A typical value is 0 (percent). EO1 defines the
units. Make the range and units consistent with those of the output desti-
nation.
MSGGR1 to MSGGR4
Message Groups 1 through 4 are integer inputs (1 through 8), that direct
alarm messages to one of eight groups of alarm devices.
MSGNO Message Number indicates the number of the last message assigned to a
user string parameter via HLBL code. It is incremented by one each time a
message is assigned, to show updates of SN00xx on the detailed displays.
If the parameter value reaches 2E31-1, the next message number is 0.
Note: Each time a block parameter is changed via a SET command,
parameter ACHANGE is incremented.
1336
73. IND – Independent Sequence Block B0193AX – Rev AA
NXTSTM When set, NXTSTM plays the role of a statement request corresponding
to the next HLBL statement. As opposed to STMRQ, this parameter can
be used to execute the next statement within a subroutine, or SBX.
OF_ICM Offset to the IC Module is the number of bytes from the start of the block
to the ic module.
OP_ERR Operational Error shows the operational error number, if any, caused by
the last statement executed. An operational error occurs when the block
cannot recover from an error by itself. This can happen when:
♦ The error handler SBXs are not present.
♦ The error handler SBXs are disabled.
♦ An operational error occurs within an error handler.
When this happens, the block changes to manual mode, OP_ERR is set to
indicate the type of error that has occurred, and statement execution stops
until a request is made through STMRQ, MA, or ACTIVE. Refer to the
Integrated Control Configurator document (B0193AV) for a list of opera-
tional error numbers.
OP_GRP Operational Error Group is an integer input (1 through 8) that directs the
operational alarm message to one of eight groups of alarm devices. You
can change the group number at the workstation.
OP_PRI Operational Error Priority is an integer input, (1 to 5), that sets the prior-
ity level of the operational error alarm (highest priority is 1).
1337
B0193AX – Rev AA 73. IND – Independent Sequence Block
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 seconds, this period is treated internally as 0.6 seconds,
but the PERIOD parameter remains 1.
** If the BPC is 2.0 seconds, this period is treated internally as
6.0 seconds, but the PERIOD parameter remains 10.
*** If the BPC is 0.5 seconds, this period is treated internally as
0.5 seconds, but the PERIOD parameter remains 11.
**** If the BPC is not 2.0 seconds, this period is treated internally as
5.0 seconds, but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. The PRTYPE output of this block
includes the following alarm types:
0 = No active alarm
9 = State Alarm
RA0001 to RA0002
Real Array 1 and 2 each define 16 elements for sequence blocks.
RI0001 to RI0015
Real Inputs 1 through 15 are user parameters in all sequence control
blocks but they can only be read in user-defined monitor case expressions.
You cannot assign a value to these parameters by means of an HLBL state-
1338
73. IND – Independent Sequence Block B0193AX – Rev AA
ment in a monitor case. You can optionally assign labels to these inputs to
facilitate referencing.
RI1 Range Input is an array of real values that specify the high and low engi-
neering scale and change delta of a particular real input. For a given block,
it also forms an association with a group of real input parameters that have
the same designated range and change delta.
RO0001 to RO0015
Real Outputs 1 through 15 are user parameters that you can reference in
the block’s sequence logic. You can optionally assign labels to these out-
puts to facilitate referencing.
RO1 Range Output is an array of real values that specify the high and low engi-
neering scale of a particular real output. For a given block, it also forms an
association with a group of real output parameters that have the same des-
ignated range.
RSTACT Restart Active specifies the desired value of the ACTIVE parameter at
block initialization, where:
♦ 0 sets ACTIVE to 0 (= false = Inactive) when the compound is
turned on or for a station reboot
♦ 1 sets ACTIVE to 1 (= true = Active) when the compound is
turned on or for a station reboot
♦ 2 sets ACTIVE to the value in the checkpoint file for a station
reboot only. Otherwise, ACTIVE remains unchanged.
RSTMA Restart Manual Auto specifies the desired value of the MA parameter at
block initialization, where:
♦ 0 sets MA to 0 (= false = Manual)
♦ 1 sets MA to 1 (= true = Auto)
♦ 2 leaves MA unchanged.
The block asserts this initial M/A state whenever:
♦ The compound in which it resides is turned on.
♦ The Control Processor undergoes a restart operation.
SBXNO SBX Number indicates the number of the SBX that is currently executing.
The SBX numbers are fixed (1 and 2 are error handlers, 3 to 5 are state
changes handlers). A value of 0 means no SBX is currently executing.
SBXRQ SBX Request is a nonconfigurable, short integer (1 to 5). When the block
is in the SBX-Trace mode, SBXRQ selects the SBX to be traced. Activate
this function by selecting the EXEC SBX button in the ALL CODE dis-
play. The block ignores out of range values. After granting an SBX request,
the block resets SUBRNO and STMNO to 0. Use the NEXT STMT but-
ton to single-step through the selected SBX.
1339
B0193AX – Rev AA 73. IND – Independent Sequence Block
SC_IND State Change Indicator is a long integer value, that indicates the current
state of the state-change SBXs for the IND block.
SN0001 to SN0010
Strings 1 through 10 are parameters that you can designate as the destina-
tion of a SENDMSG statement in the IND sequence logic. The Object
Manager can then retrieve SN0001 to SN0010 for operator display pur-
poses.
STEPMD Step mode is a boolean input. When true, STEPMD indicates the block is
in the step (semi-automatic) mode. In step mode, statement execution
stops at the nearest step boundary, as dictated by the step-labels in the
block’s source code. If a block in Step mode is switched to Manual (MA is
set to false), STEPMD is set to false. If a block in Manual is switched to
Step mode, MA becomes true. In Step mode, the outputs are secured.
STEPNO Step Number indicates the number of the step currently executing.
STEPNO changes as the block crosses a step boundary in the main sec-
tion; it does not change when the block calls a subroutine or executes an
SBX.
STEPRQ Step Request is a nonconfigurable short integer input that specifies the
next HLBL step to be executed in the block’s main section. Execution
begins at the first statement in the step. Activate this function by selecting
the EXEC STEP button in the ALL CODE display. If you enter an out of
range value, the last statement of the block is executed and the IND block
deactivates. The block mode (Manual, Auto, Semi-Auto, or Subr-Trace)
determines the number of HLBL statements executed.
STMNO Statement Number indicates the number of the statement currently exe-
cuting. When the statement finishes execution, STMNO is set to the
number of the next statement dictated by execution flow.
SUBRNO Subroutine Number indicates the number of the subroutine currently exe-
cuting, if any. The subroutine number is determined by its position in the
block’s source file. A value of 0 means no subroutine is currently execut-
ing.
SUSPND Suspended is a boolean output that is set true when the SENDCONF
statement is executed. SENDCONF suspends statement execution until
the timeout value expires or until you set SUSPND to false by selecting
either SUSP ACK or NEXT STMT at the detailed displays.
1340
73. IND – Independent Sequence Block B0193AX – Rev AA
TIMCNT Timing Counter is a decrementing real counter that indicates how many
seconds remain before expiration of the suspended period for a WAIT
statement or the timeout period for the WAITUNTIL or SENDCONF
statements.
TOPEVL Top of Evaluation Stack is an indexed specification of the top of the inter-
nal evaluation stack (data store for debugging use only).
TRACMD Trace Mode indicator shows whether the block is in Trace mode.
TRACMD Indication
0 Not in trace mode
1 Subr-Trace mode
2 SBX-Trace mode
TYPE When you enter “IND” or select “IND” from a configurator list, it creates
an identifying integer specifying this block type.
UNACK Unacknowledge is a boolean output that the block sets to True when it
detects an alarm. It is typically reset by operator action.
Detailed Operation
An IND block can be in the Active or Inactive state. When the block is Active and the compound
is on, the block is processed. When Inactive, the block is not processed. The activity of EXC
blocks has no effect on IND blocks.
When an IND block is Active, it is capable of executing its HLBL statements in one of the follow-
ing modes:
♦ Auto
♦ Step (semiautomatic)
♦ Manual
1341
B0193AX – Rev AA 73. IND – Independent Sequence Block
♦ Subr-Trace
♦ SBX-Trace
Once an IND block is set Active, it starts executing its Sequence language statements the first
scheduled Basic Processing Cycle (BPC). Since Sequence block algorithms vary in length, a block
can become Inactive within one BPC or it may require several BPCs to execute completely.
Once all statements have been executed, the block deactivates itself unless a statement in the user
algorithm causes it to repeat.
If you program an endless loop in an IND block, the block does not deactivate itself.
In Auto, the block attempts, each scan period, to process the number of statements specified by
the block’s BPCSTM parameter. The actual number may be less than BPCSTM when statement
execution requires suspension (such as WAIT or WAIT UNTIL, SENDCONF, or access to
remote parameters).
Step mode (also called Semiautomatic) operation is very similar to Auto mode operation except
that the block executes only those statements that belong to a particular Step. Suspension-causing
statements and the value of the BPCSTM parameter determine the maximum number of state-
ments that can be executed per BPC. The block does not deactivate itself automatically in the
Step mode.
You can divide the block’s main section into steps by defining step-labels in the block’s source file.
When in the step mode (STEPMD set to true), the block stops statement execution at the nearest
step boundary. After reaching that boundary, the block idles on the first statement of the next step
and awaits a request (step-, statement-, or next_stm request) to continue statement processing.
In the modes Active/Auto and Active/Step, the block can handle operational errors. Two standard
block exception handlers (SBXs) are supported for error handling.
SBX Number SBX Function
1 System error handler, OP_ERR = no user error
2 User error handler, OP_ERR = 2000..3000
If an operational error occurs, the block sets the parameter OP_ERR to indicate the cause of the
problem. If the corresponding error handling SBX is not present, or it is disabled, the block
switches to Manual and alarming takes place, provided the alarm option is set.
However, if the SBX is present and enabled, the value of OP_ERR is saved in the next process
scan, alarming is suppressed, no switch to Manual takes place, and the SBX statements are exe-
cuted.
Upon completion of the SBX, the block either executes the erroneous statement again, or resumes
statement execution at the statement following the erroneous one, depending on whether the last
executed SBX statement was “RETRY” or “ENDEXCEPTION”.
No additional error handling is possible while the block is executing an error handler SBX.
In the modes Active/Auto and Active/Step the block is capable of reacting to state changes which
are forced upon the block from outside. Three standard block exception handlers are supported
for state change handling. See the following table.
SBX Number SBX Function
3 Transition logic for switch to Inactive
1342
73. IND – Independent Sequence Block B0193AX – Rev AA
When the block mode changes from Active/Auto or Active/Step to Inactive or Manual, the state-
ments of the corresponding SBX are executed. During execution of these statements, the block
assumes an interim mode: To_Inactive or To_Manual.
If an operational error occurs during the execution of a To_Manual SBX, the IND block is deac-
tivated.
All statements are supported within SBXs. Error handling is also possible while the block is exe-
cuting a state change SBX.
In the Auto and Step modes, the block secures its output parameters. The block algorithm is
responsible for updating the output parameters. External sources (applications and other blocks)
cannot write values to block output parameters.
You can alter the order of statement execution while the block is in the Auto state. You can specify
a new starting location by writing a statement number to the STMRQ parameter from a default
or user-defined display.
You can change the block Auto/Manual state from external sources such as: user-defined and
default displays, other blocks, and other applications.
If a statement is in execution when you request a state change, the statement’s execution is com-
pleted as if it had begun in the requested state. Then any following statements are executed as
appropriate for the requested state.
In Manual, the block executes the main section statements one at a time by writing to parameters
STEPRQ, STMRQ, or NXTSTM. STEPRQ and STMRQ alter the order of execution. If more
than one are set at the same time, only a single request is granted. The priority in decreasing order
is: step, statement, next statement.
The parameter STMNO indicates the number of the statement currently executing. When the
statement finishes execution, STMNO is set to the number of the next statement dictated by exe-
cution flow. That statement is not executed unless requested.
A statement that requires several BPCs to execute, such as a WAIT statement, need only be
requested once to complete the statement’s execution.
When the requested statement is a call-subroutine statement, the request causes the execution of
all of the statements of that subroutine (and all of its nested subroutines, if any).
In the Manual state, the block does not secure its output parameters. External sources (other
blocks and applications) can write values to the block’s output parameters.
Sequential control block parameters may be updated by the block algorithm while the block is in
Manual.
The Subr-Trace and SBX-Trace modes enable you to single step through statements of subrou-
tines and SBXs. You can switch the block into one of the Trace modes only when the block is in
the Active/Manual state.
Once in the Subr-Trace mode, you “select” a subroutine by requesting a call-subroutine statement
in the block’s main section. The block is then idle before the first statement in the requested sub-
routine. You can then single-step through the subroutine statements by toggling the NXTSTM
1343
B0193AX – Rev AA 73. IND – Independent Sequence Block
parameter. Step- and statement-request cause the execution of a single statement in the block’s
main section.
When you switch into the SBX-Trace mode, the block environment (that is, step, subroutine,
statement number) is saved. The block returns to this environment when you exit the SBX-Trace
mode.
Once in the SBX-Trace mode, you “select” an SBX by setting the SBXRQ parameter to a value of
1 to 4. SBX5 (a switch to Paused) applies only to the Dependent block. The block ignores out of
range values. When you select an SBX, the block idles at the first statement within that SBX. You
can then single-step through the SBX statements by toggling the NXTSTM parameter. The block
ignores step- and statement-requests while it is in the SBX-Trace mode.
In the Manual, Subr-Trace, and SBX-Trace modes, the block does not secure its output parame-
ters. External sources (other blocks and applications) can write values to the block’s outputs.
While the block is in Manual, the IND block algorithm can update user parameters after a step-,
statement-, or next_stm request.
The IND block does not execute statements while it is Inactive. An IND block goes to the Inac-
tive state when one of the following conditions occurs:
♦ The last statement of the block’s main section is executed.
♦ An EXIT statement is executed.
♦ Another Sequence block executes an ABORT statement.
♦ The ACTIVE parameter value is toggled to Inactive.
♦ The surrounding compound is switched to OFF.
Sequential control blocks are processed every scheduled Basic Processing Cycle (BPC) as defined
for the Control Processor in which they operate. The number of statements processed each BPC is
determined by the IND block’s BPCSTM parameter.
The scheduled BPC is determined by the block parameters PHASE and PERIOD. The PHASE
parameter specifies the BPC in which a block should be processed relative to the other blocks in
the compound. PERIOD specifies how often a block should be processed. See the Integrated Con-
trol Software Concepts document.
All control blocks scheduled in any given BPC are processed in the following order:
1BPC
extension
Compound A Continuous MON/TIM EXC DEP/IND Continuous
Compound B Continuous MON/TIM EXC DEP/IND Continuous
Compound C Continuous MON/TIM EXC DEP/IND Continuous
1 2 3 4
If the block processor cannot process all blocks in a scheduled BPC, there is a Basic Processing
Cycle (BPC) overrun.
See High Level Batch Language (HLBL) User’s Guide (B0400DF) for a definition of the HLBL
syntax and semantics and for sequence compiler related limits.
1344
74. IOUT – Integer Output Block
This chapter covers the Integer Output (IOUT) block, its features, parameters and functions,
and application diagrams.
NOTE
In this chapter, CP270 Only indicates IOUT features that are supported only on the
Field Control Processor 270 (FCP270) and Z-form Control Processor 270
(ZCP270) with I/A Series system software V8.4 or later.
Overview
The Integer Output (IOUT) block is a Distributed Control Interface (DCI) block. (DCI blocks
support connectivity of I/A Series control stations to various bus resident devices via a general
purpose interface.) IOUT can send one integer value to a field device. It also continuously reports
any changes made by the device. These reports are made to the value at the same address. In the
outbound direction, the block accepts an integer input from the control strategy or an operator
set and sends it to the device. In the inbound direction the block’s “confirmed output” structure
allows any change in value at the field device to be read back by the I/A Series block. Therefore,
the block logic permits changes to the value to be made at either end.
Cascade To Upstream
Processing Block
Requested
Inputs
from Input Selection Output Processing Output to
I/A Series External
Device
Readback Confirmed
from Read-Back Output
External Processing to I/A Series
Device System
Basic Operation
When in Auto, the IOUT block accepts an integer input from an upstream control strategy at the
Integer Input Value parameter (IIN). In Manual, it accepts a real value from an operator set, gen-
erally from an I/A Series Display Manager or FoxView display, at the request component of
1345
B0193AX – Rev AA 74. IOUT – Integer Output Block
parameter Integer Output (LOUT). It sends this value to the addresses of the data element speci-
fied in parameter Point Number (PNT_NO). The point number syntax depends on the FBM
used and the fieldbus protocol of the attached device.
As part of the block’s output processing, the 32-bit long integer data value from the I/A Series sys-
tem is converted to signed or unsigned 8-bit,16-bit, 24-bit, or 32-bit integer data, or single-preci-
sion float data, for use by the external device.
Output from IOUT is change driven when you configure parameter Secondary Timer (SECTIM)
as 0.0. The block only writes to the device when a change occurs in the value of IIN (Auto) or the
request component of LOUT (Manual). If SECTIM is nonzero, an output is also forced when no
change-driven output has occurred for SECTIM seconds.
The “confirmed” structure of parameter LOUT allows the value sent to the external device to be
entered into the “request component” (also known as the “shadow component”) of LOUT and
the value read back from the FBM to be reflected in the “confirmed component”. The value of
LOUT shown in displays, or made available for connection to the control strategy, is always the
confirmed component. This is the value which has been written successfully to the field device.
The value which was sent to the field device as the request component of LOUT is displayed at
parameter Integer Output Request (LOUTQ) to aid in diagnostic testing.
A change timer mechanism is used to keep the I/A Series end synchronized with the device end. If
a new I/A Series value is not accepted by the device within a pre-determined time, the I/A Series
control station re-initializes its inputs and its output value. The output value is retained for future
comparison against read-back values, but is not sent to the field device at this time.
The block uses parameters Initialization Output (INITO) and Back-Calculated Integer Output
(BKIO) to alert upstream blocks to various abnormal situations and for cascade handling.
To force the I/A Series station to Track during initialization procedures within the external device,
a specific signal for this purpose is made available to the IOUT block at a configured Initialization
Point Number (INI_PT) within the external device.
With I/A Series system software V8.4, the IOUT block provides Bad I/O alarm detection or
reporting on the FCP270 and ZCP270. Alarming is not supported on other control processors.
Features
The IOUT block provides the following features:
♦ Separate sources for inputs in Auto and Manual
♦ Output optionally written to device only when output value changes
♦ Optional periodic outputs added to change-driven outputs
♦ Displayed output values for both request and read-back values
♦ Change timer that assures closed loop operation in both directions
♦ Specific point reserved for Tracking notification from the external device
♦ Open cascade notification to upstream blocks
♦ Timestamps each change in value or status of the output
♦ Bad I/O alarm detection and reporting (CP270 Only).
1346
74. IOUT – Integer Output Block B0193AX – Rev AA
Parameters
Table 74-1. IOUT Block Parameters
1347
B0193AX – Rev AA 74. IOUT – Integer Output Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
ALMOPT Alarm Options contain packed long values representing the alarm types
(CP270 Only) that have been configured as options in the block, and the alarm groups
that are in use. Table 74-2 shows how the parameter is used by the AI
block.
Table 74-2. ALMOPT Parameter Format
Bit Number1
(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
1.
Bit 0 is the least significant, low order bit.
1348
74. IOUT – Integer Output Block B0193AX – Rev AA
ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
(CP270 Only) states. Table 74-3 shows the bits used by the IIN 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
Bit Boolean
Number Description, Connection
(0 to 31)* Name When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See PRTYPE on page 1357 ---
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 any of ALMSTA.B3
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
(CP270 Only) 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.
AUTSW Auto Switch forces the block mode to Auto. It is of higher priority than
configured, set, or linked values in MA, or the value of INITMA. It is of
lower priority than MANSW, however. If both MANSW and AUTSW are
True, the block mode is forced to Manual.
BAG Bad Alarm Group is a short integer input that directs Bad alarm messages
(CP270 Only) to one of eight groups of alarm devices. You can change the group number
through the workstation.
BAO Bad Alarm Option is a configurable option that enables alarm generation
(CP270 Only) for each state LOUT.BAD.
BAP Bad Alarm Priority is an integer input, ranging from 1 (highest priority) to
(CP270 Only) 5 (default), that sets the priority level of the Bad alarm.
1349
B0193AX – Rev AA 74. IOUT – Integer Output Block
BKIO Back Calculated Integer Output is set equal to the confirmed component
of LOUT while the cascade is initializing. Since its purpose is to provide
the upstream block with a back-calculated value, you should connect
BKIO to the BCALCI parameter of that block.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the IOUT block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
DCIX B9
MAO
FBM
HLD
TRK
MA
ON
FS
CRIT Criticality is an integer output that indicates the priority of the block’s
(CP270 Only) highest currently active alarm. The range is 1 (highest priority) to 5. An
output of 0 indicates the absence of alarms.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. (See ERCODE for the list of all possible validation errors in this
block.) In that case, no further processing of the block occurs, including
further validation of remaining parameters. To return DEFINE to a True
value, you should correct all configuration errors and reinstall the block.
1350
74. IOUT – Integer Output Block B0193AX – Rev AA
DEV_ID Device Identifier is a character array that specifies the 6-character identi-
fier of the connected device. It is configured in the ECB specified by the
IOM_ID parameter.
ERCODE Error Code is a character data store which indicates the type of configura-
tion error which caused the block’s DEFINE parameter to be set False,
unless indicated otherwise (see meanings below). Validation of configured
parameters does not proceed past the first error encountered by the block
logic. Each nonzero value of ERCODE results in an explanatory message
at the block’s detail display. For the IOUT block, the following list shows
the possible messages you may see:
EROPT Error Option specifies the conditions under which MEAS is considered to
have bad status. It is used in determining whether there has been a bad-to-
good transition of MEAS.
If EROPT = 1, MEAS is considered bad if its status word indicates Bad,
Out-of-Service, or Not On Scan. (If it is Not On Scan, then the source of
the connection has been deleted or is in a nonexistent compound, or there
has been a peer-to-peer failure.)
If EROPT = 2, MEAS is considered Bad in any of the above situations. It
is also considered Bad if the Error bit in the status of MEAS is True.
FSIOUT Fail-Safe Integer Output is the fail-safe value configured in the IOUT
block and downloaded into the FBM. It is used by the FBM, if the
FSOPTN is set in the IOUT block, to assert fail-safe action to the integer
output of the field device. The actions taken by the FBM (for example,
whether or not the FBM sends the fail-safe value to the field device) are
1351
B0193AX – Rev AA 74. IOUT – Integer Output Block
FSOPTN Fail-Safe Option is a configurable option that specifies the fail-safe condi-
tions and action to be taken by the CP and the FBM for the output point
in the IOUT block. Any combination of the following options may be
configured:
♦ Bit 0: 1 = assert fail-safe if input/measurement error. Note that
EROPT must be configured nonzero for this option to take effect.
♦ Bit 1: 1 = set/clear fail-safe when SETFS input is set/cleared.
♦ Bit 2: 1 = assert fail-safe if control station-to-FBM communication
is lost (FBM option). This option will be enabled only if fail-safe
is enabled at the FBM level via the FSENAB parameter in
ECB200 or ECB202.
♦ Bit 31: 1 = set the output BAD status if input/measurement error
(that is, input/measurement is BAD, OOS, or has a broken
connection).
♦ Bit 41: 1 = set/clear the output BAD status when the SETFS input
is set/cleared.
♦ Bit 51: 1 = set the output BAD status if control station-to-FBM
communication is lost (FBM option). This option will be enabled
only if fail-safe is enabled at the FBM level via the FSENAB
parameter in ECB200 or ECB202.
Notes:
♦ Bit 0 is the least significant, low-order bit.
♦ For FDSI FBMs, the actual fail-safe actions to be taken for each
option are specified in the Field Device System Integrator (FDSI)
User’s Guide (B0700AH).
♦ This parameter is currently not supported by Modbus FBM224.
IIN Integer Input Value is the value used as the input when the block is in
Auto mode. After limiting and inverse signal conditioning, this is the
value normally set into LOUT and sent to the external device.
INHIB Inhibit is a configurable, connectable and settable boolean that, when set,
(CP270 Only) suppresses all alarm message reporting. INHIB affects only alarm message
reporting; the alarm handling and detection functions are determined by
the INHOPT setting.
1. Bits3, 4 and 5 of FSOPTN only apply to FDSI FBMs. The FDSI FBM uses these options only
when interfacing to devices using protocols that support output point status.
1352
74. IOUT – Integer Output Block B0193AX – Rev AA
INHOPT Inhibit Option specifies the following actions applying to all block alarms:
(CP270 Only) ♦ 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
(CP270 Only) inhibit status of each alarm type configured in the block. Table 74-4
shows how the parameter is used with the IIN 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
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.
INITMA Initialize Manual/Auto specifies the desired state of the MA input under
certain initialization conditions, namely:
♦ The block has just been installed into the I/A Series station
database.
♦ The I/A Series station is rebooted.
♦ The compound in which the block resides is turned on.
♦ The INITMA parameter is modified via the Integrated Control
Configurator.
INITMA is ignored if MA has an established linkage.
When INITMA is asserted, the value set into MA is:
♦ 0 (Manual) if INITMA = 0
1353
B0193AX – Rev AA 74. IOUT – Integer Output Block
♦ 1 (Auto) if INITMA = 1
♦ The MA value from the checkpoint file if INITMA = 2.
INI_PT The Initialize Point Number is the address of an optional Boolean input
connection in the IOUT block. If INI_PT is used, the block output tracks
the read-back value when this input Boolean value is set. On a transition
of this input value to zero, if PRIBLK is used, the I/A Series cascade is ini-
tialized. The point number syntax is specific to the FBM and the fieldbus
protocol of the attached device. See “PNT_NO” on page 1356 for refer-
ences to the appropriate documentation.
IOM_ID ECB Identifier is a configurable string that specifies the pathname of the
ECB201 for the device, for the purpose of connecting to (accessing) a field
parameter that resides in a field device hosted by a (parent) ECB200/202.
IOM_ID has the form CompoundName:BlockName, where Compound-
Name is the 1-12 character name of the local compound containing the
ECB, and BlockName is the 1-12 character block name of the ECB.
If the compound containing the ECB is the CPletterbug_ECB compound
where CPletterbug is the station letterbug of the CP, the CompoundName
may be omitted from the IOM_ID configuration. In this case, the 1-12
character ECB block name is sufficient.
LOCKID Lock Identifier is a string identifying the workstation which 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 set command is entered into the LOCKID parameter
of the block. Thereafter, set requests to any of the block’s parameters are
honored (subject to the usual access rules) only from the workstation
whose identifier matches the contests 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 written to
LOCKID.
1354
74. IOUT – Integer Output Block B0193AX – Rev AA
LOUT Integer Output (actual) is the block output. LOUT has a “request compo-
nent” and a “confirmed component”. The request component is the value
sent to the external device. The confirmed component reflects the value
read back from the external device. Usage of these components is
described in Section .
LOUTQ Integer Output (request) contains the value which was sent to the external
device (as the request component of LOUT). It is used as an aid in diag-
nostic testing.
MANSW Manual Switch, when True, forces the block into Manual mode. It is of
higher priority than any other method of establishing the value MA, since
it overrides configured, set, or linked values. MANSW is also of higher
priority than AUTSW or INITMA.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For CP stations, PERIOD values range
from 0 to 10, and 13, and map to the time lengths shown in the following
table. For Gateways and Integrators, PERIOD values range from 0 to 12
and map to the time lengths specified in the device specific user’s guide.
1355
B0193AX – Rev AA 74. IOUT – Integer Output Block
* If the BPC is 0.2 second, this period is treated internally as 0.6 second, but
the PERIOD parameter remains 1.
** If the BPC is 2.0 seconds, this period is treated internally as 6.0 seconds, but
the PERIOD parameter remains 10.
*** Not available for CP stations.
****Available in CP40, CP40B, CP60, FCP270, and ZCP270.
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, a block with
PERIOD of 3 (2.0 seconds) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the
I/A Series station is 0.5 second. Refer to the appropriate Integrated Control
Software Concepts document (B0700AG or B0193AW).
PNT_NO Point Number identifies the address in the external device memory (or
external device data stream) to which the block output is directed. It is a
string whose syntax depends on the make and model of the external
device.
♦ For the FBM223 Profibus interface, PNT_NO must be config-
ured to contain a Profibus data identifier. This information
identifies, to the FBM, the address of the input data unit from the
device. Refer to PROFIBUS-DP Communication Interface Module
(FBM223) User’s Guide (B0400FE) for further details.
♦ For the FBM222 Redundant Profibus interface, the PNT_NO
configuration string uses the FBM223 syntax with extensions for
PROFIBUS-PA status, custom status and other features. Refer to
InFusion Enterprise Control System: Implementing PROFIBUS-DP
Networks (B0750BE) for further details.
♦ For the HART interface (FBM214/214b/215/216/216b/218),
PNT_NO must be configured to contain a point address. This
information identifies, to the FBM, specific data in the HART
data stream that is to serve as the device data input to this block.
Refer to HART™ Communication Interface Modules User’s Guide
(B0400FF) for details.
♦ For the Modbus interface (FBM224), PNT_NO must be config-
ured to contain the address of a set of coils in a Modbus device.
Refer to Modbus Communication Interface Module (FBM224)
User’s Guide for details.
♦ For the FDSI (FBM230/231/232/23), PNT_NO contains a data
identifier to identify, to the FBM, specific data in the I/O data
stream and to specify the elements of the data. Refer to Field
Device System Integrators (FBM230/231/232/233) User’s Guide
(B0700AH) for more information.
♦ For the FBM228, the point number syntax specifies writes to H1
device function block parameters using a client/server or pub-
lisher/subscriber connection, as described in Implementing
FOUNDATION fieldbus on an I/A Series System (B0700BA) and
1356
74. IOUT – Integer Output Block B0193AX – Rev AA
PRIBLK Primary Block indicates whether the IOUT block has a connection from
an upstream block (PRIBLK = 1) or not (PRIBLK = 0). Its value, together
with that of PRITIM, determines whether the IOUT block remains in
Hold for a fixed time delay, or ends the Hold after one cycle.
Use PRIBLK in a cascade situation when the source of the block's input
connection needs to be initialized.
Refer to “PRIBLK and PRITIM Functionality” on page 1363 for more
information on this parameter.
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
IOUT block. It is used only if the PRIBLK option is set.
Refer to “PRIBLK and PRITIM Functionality” on page 1363 for more
information on this parameter.
PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
(CP270 Only) of the highest priority active alarm. For the IIN block:
♦ 0 = No alarm
♦ 8 = Bad I/O alarm.
TSTAMP Time Stamp is a long integer output that represents the time, in millisec-
onds since midnight, of the most recent updated input/output in a DCI
block. This timestamp is supplied either by the FBM or by the I/A Series
control station, depending on the type of FBM. If supplied by the FBM,
1357
B0193AX – Rev AA 74. IOUT – Integer Output Block
TSTAMP indicates the time of the latest updated value in the FBM. If
supplied by the I/A Series control station, TSTAMP indicates the time of
the latest updated value in the I/A Series control station.
TYPE When you enter IOUT or select it from a configurator list, an identifying
integer is created specifying this block type. For this block, the value of
TYPE is 117.
UNACK Unacknowledged is a Boolean output parameter that is set True for notifi-
CP270 Only cation 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.
VALSTS Value Status is an output parameter of any DCI block that contains the
value status of a FOUNDATION fieldbus function block parameter value or
PROFIBUS-PA parameter provided by a DCI connection to a field
device. For other fieldbus types, VALSTS is meaningless.
Bits 0-1: Limits:
0 = Not limited
1 = High limited
2 = Low limited
3 = High and Low limited
Bits 2-5: Substatus (definition depends on Quality)
Bits 6-7: Quality:
0 = Bad
1 = Uncertain
2-3 = Good
Note: Bit 0 is the least significant, low order bit.
Each time the IOUT block is executed, VALSTS reports the status of the
FF or PROFIBUS_PA value from the information in the DCI connec-
tion.
1358
74. IOUT – Integer Output Block B0193AX – Rev AA
Functions
Detailed Diagram
Holding Output to
Tracking Field Device
Periodic Output AND
OR
AND
IIN Input
Selection Δ ECB Good
SET
FBM
MA AND Readback AND
Holding
OR Timer
Tracking
Expired
Reinitialize
IIN.ACK
INITCO Up to INITI**
PRIBLK Cascade
Open Cascade Processing BKIO
FBM Readback Up to
BKIO.Status BCALCI***
PRITIM
CP270 Only
AUTO BAD Alarming
OR AND
MANUAL
AND
MANALM BAO
1359
B0193AX – Rev AA 74. IOUT – Integer Output Block
Associated ECBs
The configured IOM_ID parameter of the IOUT block specifies an ECB201 (the device ECB) to
connect to a field parameter that resides in a field device hosted by an ECB200 or FBM202 (the
FBM ECB). The PARENT parameter of the ECB201 specifies the FBM ECB.
DCI Connections
The IOUT block establishes up to two DCI connections to its specified ECB in any of the follow-
ing instances:
♦ The I/A Series control station in which it resides has just been rebooted.
♦ The block has just been installed.
♦ A parameter of the block has been modified by the ICC or FoxCAE configurator.
♦ The device or parent ECB specified by the IOUT block has just been installed.
A DCI connection is added to a linked list of all the DCI connections, of any type, for all blocks
specifying the same ECB. This arrangement permits multiple DCI blocks, of differing data types,
to communicate with a single device at input/output scan time. It also allows multiple DCI con-
nections in the same DCI block to be established (for example, connections in redundant type
DCI blocks or for INI_PT connections in most output type blocks, such as this one).
The IOUT block always establishes a DCI connection for parameter PNT_NO. If parameter
INI_PT is configured with a non-default value, a second DCI connection is established for it.
These parameter connections are made by the FBM on a client/server basis at the frequency spec-
ified 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 communication
can significantly add to the load on the H1 segment.
The DCI connection or connections are deleted (that is, the linkages are removed from the linked
list) when the IOUT block is deleted.
1360
74. IOUT – Integer Output Block B0193AX – Rev AA
When the PIO maintenance task runs after the DCI connection has been made, (see “DCI Con-
nections” above), the PNT_NO string is passed to the FBM for parsing and validation. In DCI
blocks, point identification strings are not parsed by the I/A Series control station.
If the first character of PNT_NO is blank, the PNT_NO string is not sent to the FBM, and the
block is set undefined with ERCODE = 52. The detail display shows “W52 – INVALID I/O
CHANNEL/GROUP NUMBER”.
In each of the following cases, the block is also set undefined:
♦ If the FBM parsing algorithm finds that PNT_NO is invalid, the detail display shows
“W65 – INVALID POINT ADDRESS” with ERCODE = 65.
♦ If there is a duplicate connection to any point, the detail display shows “W66-
DUPLICATE CONNECTION” with ERCODE = 66.
♦ If there is no available memory in the FBM, or if the maximum number of connec-
tions have been allocated in the FBM, the detail display shows “W67 –
INSUFFICIENT FBM MEMORY/CONNECTIONS” with ERCODE = 67.
♦ If the device connection is invalid, the detail display shows “W68 – INVALID
DEVICE CONNECTION” with ERCODE = 68.
♦ If the point connection is invalid, the detail display shows “W69 – INVALID POINT
CONNECTION” with ERCODE = 69.
In the following case, the block remains defined:
♦ If the connection is not yet resolved, the detail display shows “W62 – UNRE-
SOLVED CONNECTION” with ERCODE = 62.
If INI_PT is used, the tests described by the six bullets above are repeated, but for INI_PT rather
than PNT_NO. The failure of any of these tests also causes the block to be set undefined.
Auto/Manual Arbitration
The Auto/Manual mode selection arbitrates between inputs by the operator (Manual) and inputs
from the control strategy (Auto). Changes in the point value made by the external device are
always detected by the block, regardless of its Auto/Manual state.
Parameters MA, INITMA, AUTSW, and MANSW are used to establish the control mode of the
IOUT block.
1361
B0193AX – Rev AA 74. IOUT – Integer Output Block
of LOUT_request differs from its value on the last cycle, the new value is sent to the external
device.
If SECTIM is positive, a new output is guaranteed at least every SECTIM seconds; that is, the
current value of LOUT_request is sent if there has been no output for that length of time. In any
case, LOUT_readback continues to monitor value changes from the external device in Manual.
For diagnostic purposes, the current value of LOUT_request is always made available as parame-
ter LOUTQ, and may be inspected as such via the OMA utility or an application program.
Simulation Option
When Simulation Option (SIMOPT) is configured true, there are no DCI connections estab-
lished for the block. The statuses of LOUT, LOUT_request, and BKIO are not updated, and
VALSTS (see “VALSTS” on page 1358) is forced to zero.
The simulation value is set into LOUT_request in the same way as in Manual mode. However, no
data is sent to the external device. The entered value is copied to LOUT, and, therefore, appears as
if it were an actual readback from the field device. It is, therefore, used as the block output value
by the control strategy. The entered value is also available as the LOUTQ value.
Change Timer
The purpose of the change timer is to facilitate monitoring by the block for an indication that the
most recent I/A Series change has been received by the external device. The block expects that the
device has received a new output value within that time.
The timer is initialized to the configured value of RBKTIM (in units of seconds) each time a
value is sent to the external device. Each cycle thereafter, the readback is tested for any change in
its value. If there is no change, the timer is simply decremented.
1362
74. IOUT – Integer Output Block B0193AX – Rev AA
If a change in the read-back value is detected within the RBKTIM period, the new value is
accepted and the change timer is cleared. If the change timer expires (that is, is decremented to
zero) before a read-back change is detected, it is assumed that the device value should not change
as a result of the I/A Series change, and that the unchanged read-back value is correct. Assuming
this read-back value differs from the current value of LOUT_request, the block then initializes to
the received read-back value. This value is set into both LOUT_request and IIN, and, therefore,
establishes the new baseline for input change detection.
Status of INI_PT
The initialization input is considered “on” if:
♦ The point value at INI_PT is true.
♦ The addressed device parameter is issuing an initialize request.
♦ The addressed device parameter is indicating a local override.
♦ The addressed device parameter is in fail-safe.
♦ The addressed device parameter is indicating open cascade.
Transitions of the INI_PT status are used to indicate the need for initialization (see “Initializa-
tion” following).
Initialization
The IOUT block initializes whenever the block is restarted, whenever there is a bad-to-good tran-
sition, or whenever the initialization input from the external device transitions from on to off.
The latter two conditions are defined below.
The definition of the expression “bad-to-good transition” is that the output LOUT has just recov-
ered from an Out-of-Service or Bad status (see Section ), or there is a true-to-false transition in the
status of INI_PT. (See Section ).
Initialization action consists of reading back the value from the external device and setting this
value into IIN and LOUT_request. The cascade is then opened to force an upstream initialization
(see “Cascade Processing” following).
If the block is in Auto and there has been a bad-to-good transition in the status of IIN, the read-
back value is set into IIN, the cascade is opened, and the upstream logic is forced to initialize. The
definition of “bad” for the status of IIN depends on EROPT.
1363
B0193AX – Rev AA 74. IOUT – Integer Output Block
Cascade Processing
When the cascade is opened, INITO, which may be connected to the INITI input of the block
immediately upstream from the IOUT block, is turned on. The status of BKIO, which should be
connected to the BCALCI input of the block immediately upstream (if the upstream block has a
BCALCI type of input), is set to indicate “open cascade”.
Although there may be no support for this upstream, the current read-back value from the exter-
nal device is set into the value of BKIO. The IOUT block then goes into a Hold, thereby disal-
lowing any output changes.
The upstream block (the block whose output is connected to IIN) is then commanded to run
immediately. This feature causes a “Run” flag in the header of the upstream block to be set, caus-
ing the compound processor to execute this block on the next BPC, without regard to its period
and phase.
If there is no support for cascade processing in the upstream block, PRIBLK should be configured
as 0. In this case the cascade is held open for one cycle, after which the Hold is released. If the
upstream block supports the PRIBLK feature, PRIBLK = 1 may be configured. In this case,
PRITIM must be configured with a nonzero value. The cascade is closed again after the PRITIM
delay has expired. (The IOUT block does not support the closed-loop ACK option for cascade
closure.)
When PRIBLK is true, the cascade is opened after the initialization conditions described under
“Initialization” above, and also when the IOUT block is shut down.
1364
74. IOUT – Integer Output Block B0193AX – Rev AA
♦ The connection status information indicates that the connection is not yet resolved.
The detail display shows “W62 – UNRESOLVED CONNECTION” with
ERCODE = 62.
♦ An ECB201 is specified, and the ECB device status indicates that the DCI connection
is unresolved.
The statuses of LOUT, LOUT_request, and BKIO are set to Bad if:
♦ The ECB status indicates that the field device has failed.
♦ The DCI connection status information indicates a bad value of the field device
parameter.
The statuses of LOUT and LOUT_request are set to Error if the status information indicates an
uncertain or questionable value of the field device parameter.
The statuses of LOUT and LOUT_request are set to Fail-safe if the status information indicates
that the addressed device parameter is in fail-safe.
As noted in Section , none of these four status bits is updated when SIMOPT is true.
Fail-Safe Functions
Fail-safe support is based on the following parameters:
♦ FSOPTN: This configured value specifies the condition(s) under which fail-safe is to
be asserted.
♦ FSIOUT: This configured value specifies the fail-safe value that is to be used by the
FBM when any condition specified in FSOPTN exists.
♦ SETFS: This boolean constitutes a command to assert fail-safe. It is only observed
when the appropriate FSOPTN so specifies.
The FSOPTN conditions are:
♦ Assert fail-safe when there is an input error at IN, as defined by EROPT (Bit 0)
♦ Assert fail-safe when the block parameter SETFS has been set True (Bit 1)
♦ Assert fail-safe, using the FSIOUT value, when communications between the
I/A Series control station and the FBM is lost (Bit 2). The block does not perform this
option; it is carried out by the FBM software. This option will be enabled only if fail-
safe is enabled at the FBM level via the FSENAB parameter in ECB200 or ECB202.
♦ Set the output BAD status if Input/Measurement Error (Bit 3). The block does not
perform this option; it is carried out by the FBM software.
♦ Set the output BAD status if SETFS is set (Bit 4). The block does not perform this
option; it is carried out by the FBM software.
♦ Set the output BAD status if CP_FBM communications failure (Bit 5). The block
does not perform this option; it is carried out by the FBM software. This option will
be enabled only if fail-safe is enabled at the FBM level via the FSENAB parameter in
ECB200 or ECB202.
FSOPTN is a bit map; thus, it allows combinations of conditions for fail-safe to be specified.
If any of the FSOPTN conditions exists, and LOUT is not Bad or Out-of-Service, the fail-safe
value is sent to the FBM when the IOUT block is shut down. This happens when turning off the
compound containing the IOUT block and when deleting the IOUT block or the compound
containing the IOUT block from the CP database. The actions taken by the FBM (for example,
1365
B0193AX – Rev AA 74. IOUT – Integer Output Block
whether or not the FBM sends the fail-safe value to the field device) are unique to the particular
FBM subsystem. Refer to the subsystem user guide for descriptions on how fail-safe functionality
is implemented for specific FBM types.
In addition, the FSIOUT value is sent to the external field device via the FBM when the CP is
rebooted. This action is independent of the FSOPTN configuration.
1366
74. IOUT – Integer Output Block B0193AX – Rev AA
The Alarm Message Regeneration Time Interval (AMRTIN) parameter specifies the rate at which
alarm messages are generated for alarm conditions that have not been cleared. The interval is spec-
ified in seconds. The configured interval is rounded up to the closest value that is an even multi-
ple of the station BPC. A value of 0 disables alarm message regeneration. Refer to CP270
Integrated Control Software Concepts (B0700AG) on alarm regeneration.
Time Stamp
The time stamp (TSTAMP) parameter of the block is updated every time there is a change in the
value of LOUT. TSTAMP, which is expressed in units of milliseconds past midnight, is read from
the FBM when it is available there; otherwise, it is computed by the I/A Series control station.
NOTE
For a FOUNDATION fieldbus (FF) connection, a 4-byte ms since midnight times-
tamp is provided by the FF FBM and stored in the TSTAMP parameter.
1367
B0193AX – Rev AA 74. IOUT – Integer Output Block
1368
75. LIM – Limiter Block
This chapter covers the LIM (Limiter Block), providing an I/O diagram and describing its
features, parameters and detailed operations.
Overview
The Limiter block, LIM, provides high and low absolute limiting and, if the option is configured,
a rate of change limiting for a single real input. The block also provides boolean indicators to
show which limiting functions are in effect, and a FOLLOW input which allows the block to
override rate of change limiting.
I/O Diagram
LIM
Manual/Auto
BLOCK
Features
The features are:
♦ Manual/Auto mode for disconnecting control schemes from the process, for simula-
tion and checkout purposes
♦ Output Limiting – High and Low Absolute, and Rate of Change.
The options are:
♦ ROCOPT, Rate of Change Option, provides rate of change limiting of the measure-
ment during auto operation.
♦ MCLOPT, manual output clamping.
♦ EROPT, error option, a short integer, if true specifies how the block responds to
MEAS when the MEAS parameter is in error.
♦ PROPT, Propagate Error Option gives you the option of propagating the ERROR sta-
tus bit from the MEAS input to the block’s OUT parameter.
1369
B0193AX – Rev AA 75. LIM – Limiter Block
♦ PRIBLK, Primary Block, when true enables a block in a cascaded configuration to ini-
tialize without bumping the process at initial start-up or when control is transferred
up to a primary block.
♦ INITMA, Initialize Manual/Auto, specifies the desired state of the MA input during
initialization.
Parameters
Table 75-1. LIM Block Parameters
1370
75. LIM – Limiter Block B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
BCALCI Back Calculation In is a real input that provides the initial value of the
output before the block enters the controlling state, so that the return to
controlling is bumpless. It is also the source of the output value when its
initialization bit, which puts the block into output tracking, is non-zero.
The source for this input is the back calculation output (BCALCO) of the
downstream block. With V4.2 and later software, BCALCI contains the
cascade initialization data bits which were formerly contained in the
INITI parameter. Therefore, BCALCI defines the source block and
parameter that drives this block into initialization, and INITI and INITO
are not required for cascade initialization.
BCALCO Back Calculation Output is a real output that is passed upstream for
bumpless initialization purposes. It is equal to the MEAS input of the
LIM block and is the value for the upstream block to write to avoid
bumping the process.
With V4.2 and later software, BCALCO contains the initialization output
which was formerly contained in the INITO parameter. The initialization
output data bit is set true when:
♦ the block is in manual or initializing
♦ the downstream block has passed an initialization request via the
BCALCI input of this block.
The block clears the initialization bit when none of those conditions exist.
If you expect an upstream block to initialize when this one is doing so, you
1371
B0193AX – Rev AA 75. LIM – Limiter Block
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the LIM block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
HOL
FOL
LOL
CTL
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
4 FOL Follow BLKSTA.B28
5 CTL Controlling BLKSTA.B27
11 MA Manual(= false)/Auto(= true) BLKSTA.B21
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
20 WLCK Workstation Lock BLKSTA.B12
27 LOL Low Output Limit (Clamped) BLKSTA.B5
28 HOL High Output Limit (Clamped) BLKSTA.B4
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
DEFINE to a true value, correct all configuration errors and reinstall the
block.
DELTI1 to DELTI2
Change Delta for Input Ranges 1 through 2 are a real values that define
the minimum percent of the input range that triggers change driven con-
nections for parameters in the range of RI1 through RI2. The default
value is 1.
Entering a 1 causes the Object Manager to recognize and respond to a
change of 1 percent of the full error range. If communication is within the
same CP that contains the block’s compound, change deltas have no
effect.
1372
75. LIM – Limiter Block B0193AX – Rev AA
DELTO1 Change delta for Output Range 1 is a configurable real value that defines
the minimum percent of the output range that triggers change-driven
connections for parameters in the range RO1. The default value is 1.0 per-
cent. If communication is within the same control station that contains
the block’s compound, DELTO1 has no effect.
EI1 to EI2 Engineering Units for Input Ranges 1 and 2 are 32-character strings that
provide the engineering units text for the values defined by the ranges for
input 1 and 2. The values configured for these text strings should be con-
sistent with the values used for HSCI1 and LSCI1, or HSCI2 and LSCI2.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the IND block, the following list
specifies the possible values of ERCODE, and the significance of each
value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W44 – INVALID High range value is less than or equal
ENGINEERING RANGE” to low range value.
“W46 – INVALID INPUT The source parameter specified in the
CONNECTION” input connection cannot be found in
the source block, or the source
parameter is not connectable, or an
invalid boolean extension connection
has been configured.
1373
B0193AX – Rev AA 75. LIM – Limiter Block
Message Value
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
-or-
“PRITIM = zero” is not allowed
(occurs when PRIBLK = 1).
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EROPT Error Option is a short integer. If PROPT is true, EROPT specifies how
the block responds to MEAS when the MEAS parameter is in error.
EROPT has a range of 0 to 2, where:
0= The block ignores the errors.
1= The block sets the ERROR bit in OUT if the MEAS parameter:
♦ has its BAD status bit set true;
♦ has its OOS status bit set true;
♦ is experiencing peer-to-peer path failure.
2= The block sets the ERROR bit in OUT if the MEAS parameter:
♦ has its BAD status bit set true;
♦ has its OOS status bit set true;
♦ has its ERROR status bit set true
♦ is experiencing peer-to-peer path failure.
FOLLOW Follow is a boolean input. When true, FOLLOW forces the block into the
Follow substate of Auto. In this substate, the output follows the input
MEAS.
HOLIM High Output Limit is a real input that establishes the maximum output
value, in OUT units. If the algorithm tries to drive the output to a higher
value, the output is clamped at the HOLIM value and the indicator
HOLIND is set true.
HOLIND High Output Limit Indicator is a boolean output that is set true whenever
the output is clamped at the high output limit, HOLIM.
HSCI1 to HSCI2 High Scale for Input Ranges 1 and 2 are configurable real values that
define the upper limit of input ranges RI1 and RI2. EI1 to EI2 define the
1374
75. LIM – Limiter Block B0193AX – Rev AA
units. Make the range and units consistent with the input source. The
default value is 100 (percent).
HSCO1 High Scale for Output Range 1 is a real value that defines the upper limit
of the ranges for Output 1. A typical value is 100 (percent). EO1 defines
the units. Make the range and units consistent with those of the output
destination.
INITI Initialization In defines the source block and parameter that drive this
block into initialization. The source for this short integer input is the ini-
tialization output of a downstream block. With V4.2 or later software,
BCALCI contains the cascade initialization request data bit eliminating
the need to configure INITI connections in cascades. However, to pre-
serve backward compatibility, the INITI parameter has been maintained
for use in existing configurations. Existing configurations do not need to
reconfigure their cascades. The logic to set or reset the INITI short value is
maintained, but the setting of the handshaking bits, via the INITI-INITO
connection, is eliminated.
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
♦ The compound in which it resides is turned on.
♦ The INITMA parameter itself is modified via the control configu-
rator. (The block does not assert INITMA on ordinary
reconfiguration.)
INITMA is ignored if MA has an established linkage.
1375
B0193AX – Rev AA 75. LIM – Limiter Block
KSCALE KSCALE is a conversion factor used to make the time units of the rate
parameters, which are in EI1 units per minute, dimensionally compatible
with the time units of the output, as defined by EO1.
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
LOLIM Low Output Limit is a real input that establishes the minimum output
value. If the algorithm tries to drive the output to a lower value, the out-
put is clamped at the LOLIM value and the indicator LOLIND is set true.
LOLIND Low Output Limit Indicator is a boolean output that is set true whenever
the output is clamped at the low output limit, LOLIM.
LSCI1 to LSCI2 Low Scale for Input Ranges 1 and 2 are configurable real values that define
the lower limit of input ranges RI1 and RI2. EI1 to EI2 define the units.
Make the range and units consistent with those of the input sources. The
default value is 0 (percent).
LSCO1 Low Scale for Output Range 1 is a real value that defines the lower limit of
the range for Output 1. A typical value is 0 (percent). EO1 defines the
1376
75. LIM – Limiter Block B0193AX – Rev AA
units. Make the range and units consistent with those of the output desti-
nation.
MCLOPT Manual Clamping Option allows you to invoke output clamping while
the block is in manual. You can alter this configurable boolean input at
the workstation.
MEAS Measurement is an input identifying the source of the block’s input, or the
controlled variable.
OUT Output, in Auto mode, is the result of the block algorithm applied to one
or more input variables. In Manual, OUT is unsecured, and can be set by
a user or by an external task.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
1377
B0193AX – Rev AA 75. LIM – Limiter Block
* If the BPC is 0.2 seconds, this period is treated internally as 0.6 seconds,
but the PERIOD parameter remains 1.
** If the BPC is 2.0 seconds, this period is treated internally as
6.0 seconds, but the PERIOD parameter remains 10.
*** If the BPC is 0.5 seconds, this period is treated internally as
0.5 seconds, but the PERIOD parameter remains 11.
**** If the BPC is not 2.0 seconds, this period is treated internally as
5.0 seconds, but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
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
LIM block. It is used only if the PRIBLK option is set. The cascade is
1378
75. LIM – Limiter Block B0193AX – Rev AA
PROPT Propagate Error Option is a boolean input. When true, PROPT sets the
ERROR Status bit of the output parameter if the input to the MEAS
parameter is in error while the block is in Auto. The input to the MEAS
parameter is in error when:
♦ Its BAD status bit is set true.
♦ Its OOS (Out-of-Service) status bit is set true.
♦ Its ERROR status bit is set true.
♦ It is experiencing peer-to-peer path failure.
If a transition to Manual occurs while the ERROR status is true, it
remains true until either a set command is written to that output or until
the block transfers to Auto with the error condition returned to normal.
PRSCAS Present Cascade State is a data store that indicates the cascade state. It has
the following possible values:
Value State Description
1 “INIT_U” Unconditional initialization of the primary
cascade is in progress.
2 “PRI_OPN” The primary cascade is open.
3 “INIT_C” Conditional initialization of the primary
cascade is in progress.
4 “PRI_CLS” The primary cascade is closed.
RI1 to RI2 Range Input is an array of real values that specify the high and low engi-
neering scale and change delta of a particular real input. For a given block,
it also forms an association with a group of real input parameters that have
the same designated range and change delta.
RO1 Range Output is an array of real values that specify the high and low engi-
neering scale of a particular real output. For a given block, it also forms an
association with a group of real output parameters that have the same des-
ignated range.
ROCIND The Rate of Change Alarm Indicator is a boolean output. It is set true
when the measurement experiences a rate of change greater than the rate
of change alarm limit (ROCLIM). The block sets ROCIND to false when
the rate of change falls below that limit.
ROCLIM Rate of Change Limit is the absolute value of the allowable change in
MEAS, when ROCOPT is true. When ROCLIM is exceeded, it generates
a Rate of Change Alarm. You can configure ROCLIM as a constant, or
connect it to a block to vary the rate limit.
1379
B0193AX – Rev AA 75. LIM – Limiter Block
TYPE When you enter “LIM” or select “LIM” from a configurator list, it creates
an identifying integer specifying this block type.
1380
75. LIM – Limiter Block B0193AX – Rev AA
Detailed Operation
At initialization, the block initializes the OUT value to the value of MEAS.
In Manual, all limiting is repressed. All boolean indicators are set to false. The output alarm level
integer, CRIT, is set to zero. All outputs, including the block output (OUT), are unsecured, and
open to manipulation by external tasks and programs. The output history is not maintained while
the block is in manual.
On a transition from Manual to Auto, rate limiting begins at the present state of the output. A
transition from Manual to Auto initializes the rate-of-change history to zero to avoid spurious rate
limiting of the input during the first block execution cycle in Auto. The block also prevents spuri-
ous rate limiting when the FOLLOW input changes state from true to false, while the block is in
Auto.
When the block is in Auto mode, it provides high and low absolute output limiting. If the rate-of-
change option (ROCOPT) is configured true, and the FOLLOW input is false, the block also
applies rate of change limiting to the measurement input.
Absolute limiting depends on the high and low absolute limits, HOLIM and LOLIM. If MEAS
exceeds HOLIM, the high output limit indicator, HOLIND, is set true. If MEAS falls below
LOLIM, the low output limit indicator, LOLIND, is set true. Both indicators are false if the out-
put, OUT, is not clamped at either limit. These indicators are boolean outputs that can be con-
nected into control schemes. Absolute limiting is always active when the block is in auto,
regardless of the state of the FOLLOW input.
The Manual clamping option (MCLOPT) offers output clamping in Manual mode. If MCLOPT
is set:
1. OUT is clamped when a) OUT parameter or either of its limits is changed by a SET-
VAL command, or b) the block is executed, to guarantee clamping when the limits are
connected.
2. Both HOLIND and LOLIND are secured when the block is switched to Manual
mode, to prevent them from being changed by you.
If MCLOPT is not set, both HOLIND and LOLIND are released and set to false when the block
is switched to Manual mode.
If ROCOPT is true, the block performs rate-of-change limiting before absolute limiting. How-
ever, when the output is being clamped, the rate-of-change indicator (ROCIND) is false and the
FOLLOW input has no effect; that is, OUT does not track an out-of-limits measurement input.
The low limit overrides the high limit if the high limit is set less than the low limit.
If ROCOPT is true, and if FOLLOW is false, then ROCLIM represents the maximum absolute
rate of change that the output can exhibit. Each execution cycle the absolute rate of change of the
MEAS input is computed and compared to ROCLIM. If the computed rate is less than
ROCLIM, then the output tracks the MEAS input. If the computed rate is greater than
ROCLIM then the output attempts to track the measurement, but its rate of change is limited to
the value of ROCLIM.
As soon as the measurement rate of change becomes less than the limit, the output continues to
change at the linear ROCLIM rate until it eventually tracks the measurement. A rate limit indica-
tor (ROCIND) is set true whenever the output is being rate-of-change limited.
You can specify the ROCLIM parameter in any engineering units per desired time units; that is,
EI2/time units. The block provides a scaling factor, KSCALE, that enables you to make the speci-
1381
B0193AX – Rev AA 75. LIM – Limiter Block
fied units per time of the ROCLIM parameter dimensionally compatible with the ratio of the
fixed units of the MEAS signal over the time interval of the block’s PERIOD.
Bumpless Initialization
When PRIBLK is set to true, the LIM block supports bumpless initialization. Connections to
upstream and downstream blocks are as follows:
BCALCI BCALCO
OUT MEAS
OUT MEAS
BCALCI BCALCO
The LIM block detects an open cascade under the following conditions:
♦ When LIM is in Manual mode.
♦ If EROPT is set, when the MEAS input is in error.
♦ When the cascade is open downstream, it is indicated by the BCALCO connection.
When this happens, the LIM output is initialized to the BCALCI input. If the request
is conditional, output initialization occurs only if the block is in Auto mode.
When the cascade is open, the LIM block sets a request for initialization in BCALCO. While the
block is open, the output is in HOLD mode. The cascade remains open until none of the open
cascade conditions listed above is true and acknowledgment is received from the upstream block
via the MEAS connection.
LIM also propagates the SPI/SPD/OLP supervisory status bits upstream via the BCALCO con-
nection, in a manner depending on whether the block is controlling or not. (LIM is controlling
when it is in Auto mode, has no error in the MEAS and BCALCI values and connections, and has
no initialization request.)
If the LIM block is not controlling, the OLP, SPI, and SPD bits are set.
If the LIM block is controlling, then:
♦ The OLP bit is cleared.
♦ The SPI bit is set if HOLIM or the downstream SPI is set. Otherwise, the SPI bit is
cleared.
♦ The SPD bit is set if LOLIM is or the downstream SPD is set. Otherwise, the SPD bit
is cleared.
The Failsafe status of the downstream block is also propagated to the upstream block, by the same
BCALCO connection.
Error Propagation
The EROPT option enables errors in the MEAS input to propagate to the block’s OUT parame-
ter, according to the following rules:
1382
75. LIM – Limiter Block B0193AX – Rev AA
1383
B0193AX – Rev AA 75. LIM – Limiter Block
1384
76. LLAG – Lead Lag Block
This chapter covers the LLAG (Lead Lag Block), providing an I/O diagram and describing its
features, parameters and detailed operations.
Overview
The Lead Lag (LLAG) Block dynamically compensates for changes in the measurement signal by
initially overreacting (Lead) to the input, or gradually changing the output (Lag), or both. The
output has steady state levels that vary with the input when the block is in the Lead/Lag mode. In
the Impulse mode, the block has a single steady state level that is dependent only on the BIAS
input.
I/O Diagram
Measurement
Output
Manual/Auto
Bias LLAG
Follow BLOCK
Lag Time Block Status
Lead Gain
Features
The features are:
♦ Manual/Auto mode for disconnecting control schemes from the process, for simula-
tion and checkout purposes.
♦ Adjustable Lead and Quadratic Lag filter terms. The quadratic can have complex or
real roots. (See the LAG2 parameter description on page 1389).
♦ Output Follow feature for start-up of a feedforward scheme.
♦ Output clamping.
The options are:
♦ Lead/Lag Option (LLOPT), an indexed input parameter that specifies the block’s
mode of operation when the block is in the Auto state. The index integer ranges from
0 to 3.
♦ Manual output clamping (MCLOPT).
♦ Error propagation (PROPT).
1385
B0193AX – Rev AA 76. LLAG – Lead Lag Block
Parameters
Table 76-1. LLAG Block Parameters
1386
76. LLAG – Lead Lag Block B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
BIAS Bias is a real input added to the controller or algorithm output, to achieve
OUT.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the LLAG block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
HOL
FOL
LOL
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
4 FOL Follow BLKSTA.B28
11 MA Manual(= false)/Auto(= true) BLKSTA.B21
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
20 WLCK Workstation Lock BLKSTA.B12
27 LOL Low Output Limit (Clamped) BLKSTA.B5
28 HOL High Output Limit (Clamped) BLKSTA.B4
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
DEFINE to a true value, correct all configuration errors and reinstall the
block.
DELTI1 to DELTI2
Change Delta for Input Range 1 or 2 is a real value that defines the mini-
mum percent of the input range that triggers change driven connections
for parameters in the range of RI1 or RI2. The default value is 1.
Entering a 1 causes the Object Manager to recognize and respond to a
change of 1 percent of the full error range. If communication is within the
1387
B0193AX – Rev AA 76. LLAG – Lead Lag Block
DELTO1 Change delta for Output Range 1 is a configurable real value that defines
the minimum percent of the output range that triggers change-driven
connections for parameters in the range RO1. The default value is 1.0 per-
cent. If communication is within the same control station that contains
the block’s compound, DELTO1 has no effect.
EI1 to EI2 Engineering Units for Input Ranges 1 and 2, defined by the parameters
HSCI1 to HSCI2, LSCI1 to LSCI2, and DELTI1 to DELTI2, provide
the engineering units text for the values defined by Input Ranges 1 and 2.
“Deg F” or “pH” are typical entries.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the LLAG block, the following
list specifies the possible values of ERCODE, and the significance of each
value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W44 – INVALID High range value is less than or equal
ENGINEERING RANGE” to low range value.
“W46 – INVALID INPUT The source parameter specified in the
CONNECTION” input connection cannot be found in
the source block, or the source
parameter is not connectable, or an
invalid boolean extension connection
has been configured.
1388
76. LLAG – Lead Lag Block B0193AX – Rev AA
Message Value
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE occurred.
BLOCK”
FOLLOW Follow is a boolean input. When true, FOLLOW forces the block into the
Follow substate of Auto. In this substate, the output follows the input
MEAS.
HOLIM High Output Limit is a real input that establishes the maximum output
value, in OUT units. If the algorithm tries to drive the output to a higher
value, the output is clamped at the HOLIM value and the indicator
HOLIND is set true.
HOLIND High Output Limit Indicator is a boolean output that is set true whenever
the output is clamped at the high output limit, HOLIM.
HSCI1 to HSCI2 High Scale for Input Ranges 1 and 2 are real values that define the upper
limit of the measurement range (RI1) and bias range (RI2). EI1 to EI2
define the units. Make the range and units consistent with the measure-
ment and bias sources. A typical value is 100 (percent).
HSCO1 High Scale for Output Range 1 is a real value that defines the upper limit
of the ranges for Output 1. A typical value is 100 (percent). EO1 defines
the units. Make the range and units consistent with those of the output
destination.
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
♦ The compound in which it resides is turned on.
♦ The INITMA parameter itself is modified via the control configu-
rator. (The block does not assert INITMA on ordinary
reconfiguration.)
INITMA is ignored if MA has an established linkage.
LAG2 Lag 2 is the quadratic lag time constant in a lead, quadratic-lag filter. It is
used in the following formula (x = input signal and y = output signal):
1389
B0193AX – Rev AA 76. LLAG – Lead Lag Block
LAGTIM Lag Time is a real input parameter that specifies the time constant of the
first order lag, in minutes.
LGAIN Lead Gain is a real input parameter that determines the instantaneous gain
in the output relative to a step change in the Measurement input.
LLOPT Lead/Lag Option is an indexed input parameter that specifies the block's
mode of operation when the block is in the Auto state. The index integers
range from 0 to 3 and map to the following modes of operation:
0 = Lead/Lag mode
1 = Positive-only Impulse mode
2 = Negative-only Impulse mode
3 = Bipolar Impulse mode
LLOPT cannot be adjusted except by reconfiguring the block.
LOCKID Lock Identifier is a string identifying the workstation which 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 may be set false by any workstation at any time, whereupon a
new LOCKRQ will be accepted, and a new ownership workstation identi-
fier written to LOCKID.
LOLIM Low Output Limit is a real input that establishes the minimum output
value. If the algorithm tries to drive the output to a lower value, the out-
put is clamped at the LOLIM value and the indicator LOLIND is set true.
LOLIND Low Output Limit Indicator is a boolean output that is set true whenever
the output is clamped at the low output limit, LOLIM.
LSCI1 to LSCI2 Low Scale for Input Ranges 1 and 2 are real values that define the lower
limit of the measurement range (RI1) and bias range (RI2). A typical value
is 0 (percent). EI1 to EI2 define the units. Make the range and units con-
sistent with those of the measurement and bias sources.
1390
76. LLAG – Lead Lag Block B0193AX – Rev AA
LSCO1 Low Scale for Output Range 1 is a real value that defines the lower limit of
the range for Output 1. A typical value is 0 (percent). EO1 defines the
units. Make the range and units consistent with those of the output desti-
nation.
MCLOPT Manual Clamping Option allows you to invoke output clamping while
the block is in manual. You can alter this configurable boolean input at
the workstation.
MEAS Measurement is an input identifying the source of the block’s input, or the
controlled variable.
OUT Output, in Auto mode, is the result of the block algorithm applied to one
or more input variables. In Manual, OUT is unsecured, and can be set by
a user or by an external task.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
1391
B0193AX – Rev AA 76. LLAG – Lead Lag Block
* If the BPC is 0.2 seconds, this period is treated internally as 0.6 seconds,
but the PERIOD parameter remains 1.
** If the BPC is 2.0 seconds, this period is treated internally as
6.0 seconds, but the PERIOD parameter remains 10.
*** If the BPC is 0.5 seconds, this period is treated internally as
0.5 seconds, but the PERIOD parameter remains 11.
**** If the BPC is not 2.0 seconds, this period is treated internally as
5.0 seconds, but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PROPT Propagate Error Option is a boolean input. When true, PROPT sets the
ERROR Status bit of the output parameter if the input to the MEAS
parameter is in error while the block is in Auto. The input to the MEAS
parameter is in error when:
♦ Its BAD status bit is set true.
♦ Its OOS (Out-of-Service) status bit is set true.
♦ Its ERROR status bit is set true.
♦ It is experiencing peer-to-peer path failure.
If a transition to Manual occurs while the ERROR status is true, it
remains true until either a set command is written to that output or until
the block transfers to Auto with the error condition returned to normal.
RI1 to RI2 Range Input is an array of real values that specify the high and low engi-
neering scale and change delta of a particular real input. For a given block,
it also forms an association with a group of real input parameters that have
the same designated range and change delta.
RO1 Range Output is an array of real values that specify the high and low engi-
neering scale of a particular real output. For a given block, it also forms an
association with a group of real output parameters that have the same des-
ignated range.
TYPE When you enter “LLAG” or select “LLAG” from the block type list under
Show, an identifying integer is created specifying this block type.
1392
76. LLAG – Lead Lag Block B0193AX – Rev AA
Detailed Operation
The LLAG block has two modes of operation, a Lead/Lag mode and an Impulse mode.
The Lead/Lag mode produces an instantaneous gain (Lead gain) or a first order lag in the output,
as a function of a step change in the input, MEAS. The steady state value is equal to MEAS.
When MEAS changes by an amount, delta, the block output follows, leads, or lags MEAS
depending on the LGAIN setting. For an LGAIN = 0, the output lags the measurement input
with a time constant equal to LAGTIM. For LGAIN = 1, the output follows the measurement.
For LGAIN > 0, the initial value of the output change equals LGAIN * change in MEAS and
decay to the MEAS value with a time constant equal to LAGTIM. See Figure 76-2.
The Lead/Lag function supports a Follow input. If set, the output is set to the value of the Mea-
surement, without any dynamics. Use this feature when starting up feedforward schemes.
The Impulse mode operates similar to the Lead/Lag mode except that the steady state value is
zero.
A BIAS input allows for adjusting the steady state value over the output range. BIAS is additive to
the output. Although normally used for the Impulse function, BIAS is active in the Lead/Lag
mode as well. BIAS has a default value of zero.
The Impulse function is available in three modes: bipolar transition, positive-only transition, and
negative-only transition. See Figure 76-2.
For the bipolar impulse mode, the initial value of the output = LGAIN * MEAS. The output
decays to the BIAS value with a time constant equal to LAGTIM.
For the positive-only impulse mode, the impulse function operates on positive MEAS transitions
only. The complement is true for the negative-only impulse option.
The Impulse function also supports the FOLLOW input. If set, the output follows the BIAS
input, without any dynamics.
The LLAG block supports user-specified ranges for the MEAS, BIAS, and OUT parameters. The
block clamps the calculated output to configurable High and Low output limits (HOLIM and
LOLIM). HOLIM and LOLIM are validated according to the following rules: If the lower limit
(LOLIM) is less than the low scale for output range (LSCO1), then it is set to LSCO1; if
HOLIM is less than LOLIM, it is set to LOLIM: if HOLIM is greater than HSCO1, it is set to
HSCO1.
When the OUT parameter is less than the lower output limit (LOLIM), a boolean low output
indicator (LOLIND) is set to true and the boolean high output indicator (HOLIND) is set to
false. Conversely, when OUT exceeds HOLIM, LOLIND is set to false and HOLIND is set to
true. Otherwise, when OUT is within the bounds, both indicators are set to false. The HOL and
LOL block status booleans are updated to reflect the HOLIND and LOLIND indicators.
The Manual clamping option (MCLOPT) offers output clamping in Manual mode. If MCLOPT
is set:
1. OUT is clamped when it exceeds either limits.
2. HOLIND and LOLIND are secured to prevent them from being changed by the user.
If MCLOPT is not set, both HOLIND and LOLIND are released and set to false when the block
is switched to Manual mode.
In Manual, the output can be written by other tasks. On a transition to Auto, the block clears any
dynamic history and drives the output to the Measurement.
1393
B0193AX – Rev AA 76. LLAG – Lead Lag Block
Non-Impulse Mode
MEAS
Tc=LGTIM
GAIN = 0 (FIRST ORDER LAG) Tc=LGTIM
GAIN = 1 (TRACK)
Tc=LGTIM
2
GAIN = 2 (LEAD LAG)
2
Tc=LGTIM
Impulse Operation
GAIN = 0
IMP (BIPOLAR IMPULSE)
GAIN = 1
1394
30. LOGIC – Logic Block
This chapter gives a general overview of LOGIC (Logic Block), providing an I/O diagram and
describing its features, parameters and detailed operations.
Overview
The Logic (LOGIC) block provides both logical functions and timer capability within one inte-
grated environment. This block lets you satisfy specialized control needs that cannot be met effi-
ciently with either the standard block set offering or the sequence control blocks.
The LOGIC block is modeled after the CALC block and can be used instead of CALC blocks in
most control block data base configurations where logic or timer functions are required, but
mathematical functions are not required. The LOGIC block is consistent with the CALC block
in the following ways:
♦ Programming procedures are identical.
♦ Instruction syntax is the same, for identical step functions.
The LOGIC block differs from the CALC block in the following ways:
♦ Fewer programming steps are supported.
♦ Fewer I/O parameters and internal memories are supported.
♦ Only a subset of CALC block functions/instructions is supported.
♦ An integer stack is used to store instruction operands and intermediate results.
♦ A second operand is supported in several instructions.
♦ Mathematical functions and parameters are not supported.
The specific differences in features between the LOGIC block and the CALC block are summa-
rized in the following table.
1395
B0193AX – Rev AA 30. LOGIC – Logic Block
Use the Integrated Control Configurator to configure the LOGIC block. The configuration pro-
cess allows you to specify the system path for all desired input connections and constant data val-
ues, and to program the block by entering a series of program steps. Each program step is
represented by a parameter string of up to 16 characters.
I/O Diagram
Manual/Auto
1396
30. LOGIC – Logic Block B0193AX – Rev AA
Features
♦ Operates with the standard block set, within the same compound processor
environment.
♦ Provides tight synchronization with the real-time execution of the other blocks.
♦ Provides 2 real inputs, 1 long integer input, 16 boolean inputs, 1 long integer output,
and 4 boolean outputs. Real inputs are provided only to support time constants for
the timer instructions (OSP, DON, DOFF) and indices for the GTI instruction.
♦ Provides 5 memory data storage registers that are preserved between execution cycles.
♦ Provides 15 programming steps.
♦ Checks correctness of all programming steps following installation, and undefines the
block if an error is detected.
♦ Provides the ability to detect runtime errors.
♦ Supports the standard block-level manual/auto capability for all of its outputs.
♦ Allows forward branching of program control. To keep from creating endless loops,
backward branching is not allowed.
♦ Lets you initialize all timers and memory registers.
Parameters
Table 76-2. LOGIC Block Parameters
1397
B0193AX – Rev AA 30. LOGIC – Logic Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
BI01 to BI16 Boolean Inputs 1 through 16 are configurator entries that identify the
upstream boolean outputs coming to the boolean inputs of the block.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the LOGIC block, only the following bits are used:
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
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
11 MA Manual(= false)/Auto(= true) BLKSTA.B21
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
BO01 to BO04 Boolean Outputs 1 through 4 are configurator entries that identify the
downstream boolean inputs coming to the boolean outputs of the block.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
DEFINE to a true value, correct all configuration errors and reinstall the
block.
1398
30. LOGIC – Logic Block B0193AX – Rev AA
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the LOGIC block, the following
list specifies the possible values of ERCODE, and the significance of each
value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not com-
patible with compound PERIOD.
“W45 – CONFIGURATION A parsing error has been detected in a
ERROR IN STEP nn” LOGIC block; nn identifies the step in
error.
“W46 – INVALID INPUT The source parameter specified in the
CONNECTION” input connection cannot be found in
the source block, or the source parame-
ter is not connectable, or an invalid
boolean extension connection has been
configured.
“W48 – INVALID BLOCK The configured value of a block option
OPTION” is illegal.
“W53 – INVALID A parameter value is not in the accept-
PARAMETER VALUE” able range.
“W58 – INSTALL ERROR; A Database Installer error has occurred.
DELETE/UNDELETE BLOCK”
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
♦ The compound in which it resides is turned on.
♦ The INITMA parameter itself is modified via the control configu-
rator. (The block does not assert INITMA on ordinary
reconfiguration.)
INITMA is ignored if MA has an established linkage.
1399
B0193AX – Rev AA 30. LOGIC – Logic Block
LI01 Long Integer Input 1 is the input to the block calculation. It can be con-
figured or linked to upstream blocks, or set when the block is unlinked.
LO01 Long Integer Output 1 is the output from the block calculation. It can be
linked to downstream blocks, or set when the block is in Manual.
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
M01 to M05 Memory elements 1 through 5 are memory registers. These provide tem-
porary storage for the result of any operation in the up-to-50-step CALC
block program. The values you configure are initial values for M01 to
M20. The CALC block program can overwrite this value with an STM
command.
1400
30. LOGIC – Logic Block B0193AX – Rev AA
current value of Owner. Once set to the null string, the value can then be
set as desired.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 seconds, this period is treated internally as 0.6 seconds,
but the PERIOD parameter remains 1.
** If the BPC is 2.0 seconds, this period is treated internally as
6.0 seconds, but the PERIOD parameter remains 10.
*** If the BPC is 0.5 seconds, this period is treated internally as
0.5 seconds, but the PERIOD parameter remains 11.
**** If the BPC is not 2.0 seconds, this period is treated internally as
5.0 seconds, but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
PERROR Program Error is a coded, integer output that indicates the type of instruc-
tion syntax error or program runtime error that occurred in the step speci-
fied by the STERR parameter. A nonzero value for PERROR indicates an
error. A positive value indicates an error occurred while executing the pro-
gram (runtime error). A negative value indicates a syntax error.
Errors Meaning
-1 invalid OP code
-2 invalid I/O ref
-3 operand index out of range
-4 GTO out of range
5 Stack overflow
6 Stack underflow
10 INDEX_ERROR
11 BIT_ERROR
1401
B0193AX – Rev AA 30. LOGIC – Logic Block
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 seconds. Refer to the appropriate Integrated Control
Software Concepts document (B0700AG or B0193AW).
RI01 to RI02 Real Inputs 1 and 2 are real inputs, which are supported only for timing
logic operations. Your configurator entry identifies the upstream output
that is coming to the inputs of this block to be included in the calculation.
STEP01 to STEP15
Steps 1 through 15 are string inputs of up to 16 characters. They are the
15 executable commands that make up the LOGIC block program.
STERR Step Error is an integer output that indicates which program step is exhib-
iting the error defined by PERROR.
TIMINI Timer Initialization option specifies whether an initial state change can be
generated by a DON, DOFF, FF, MRS, or OSP instruction in a block
when the block initializes.
0= Initial state change allowed for DOFF, DON, FF, MRS, and OSP.
1= Initial state change disallowed for DOFF, DON, and OSP.
Initial state change allowed for FF and MRS.
2= Initial state change disallowed for FF and MRS.
Initial state change allowed for DOFF, DON, and OSP.
3= Initial state change disallowed for DOFF, DON, FF, MRS, and
OSP.
TYPE When you enter “LOGIC” or select “LOGIC” from the block type list
under Show, an identifying integer is created specifying this block type.
1402
30. LOGIC – Logic Block B0193AX – Rev AA
Detailed Operation
The LOGIC block operates like most programmable pocket calculators. The block’s input/output
modularity and programming capacity provides a level of functionality that complements the
standard block set offering. You can distribute a set of LOGIC blocks, assigning a time period to
each block such that all calculations are synchronized with the operation of other blocks or com-
pounds.
The LOGIC block instruction set includes unary, diadic, and polyadic instructions. A unary
instruction operates directly on the accumulator value. A diadic instruction always requires two
operands to compute a result. A polyadic instruction is one that operates on n-operands. The
result of any of these instructions is placed in the accumulator, where it is available as an operand
to the next instruction.
Boolean Capability
The following boolean operations are supported:
♦ AND
♦ NAND
♦ NOR
♦ NOT (negation of accumulator value)
♦ NXOR (exclusive nor)
♦ OR (inclusive or)
♦ XOR (exclusive or)
These instructions, with the exception of NOT, can be either diadic with one or two explicit oper-
ands or polyadic and operate on multiple operands on the stack.
Timing Functions
The operands of the following instructions can specify a real value constant or reference either of
the real input parameter value records; for example, RI02. The numeric value used in either case is
assumed to be in units of seconds. The internal time values are rounded up to the nearest block
period during conversion. See Figure 76-4 for the following list of timing functions:
♦ Off-Delay Timer (DOFF operand)
♦ On-Delay Timer (DON operand)
♦ One-Shot Pulse (OSP operand)
1403
B0193AX – Rev AA 30. LOGIC – Logic Block
OSP
BI01
5 sec
BO04
DON
BI01
7 sec 7 sec
BO04
DOFF
BI01
8 sec 8 sec
BO04
Figure 76-4. OSP, DON, and DOFF Timing Diagrams
Logical Functions
The following higher-level logic functions are supported:
♦ Set-Reset Flip-Flop (FF)
♦ Master Reset/Set Flip-Flop (MRS)
The FF instruction emulates the function of a traditional set-reset flip-flop. If both the “set” input
and the “reset” input take on the same value, the previous state of the output is retained.
The MRS instruction provides the same functionality as the FF, except that the reset input has
priority over the set input. If both inputs take on a logical one value, the flip-flop will be forced to
reset. If both inputs take on a logical zero value, the previous state of the output is retained.
1404
30. LOGIC – Logic Block B0193AX – Rev AA
OUTPUTS:
♦ Clear Output Bad Status Bit (CBD operand)
♦ Write Accumulator to Output (OUT operand)
♦ Release (REL operand)
♦ Set Output Bad Status Bit (SBD operand)
♦ Secure (SEC operand)
Program Control
For the following conditional branch instructions, branch on the result of the accumulator and
branch to the step number in the operand. A step number less than the present program step or
greater than 15 terminates program.
♦ Branch if False (BIF operand)
♦ Branch if Block Initializing (BII)
♦ Branch if True (BIT operand)
♦ Terminate Program Execution (END)
♦ Terminate Program Execution at Intermediate Point (EXIT)
♦ Branch Indirect (GTI)
♦ Unconditional Branch to Step (GTO operand)
♦ No Operation (NOP)
♦ Set Boolean and Skip if Accumulator False (SSF)
♦ Set Boolean and Skip if Block Initializing (SSI)
♦ Set Boolean and Skip if Accumulator True (SST)
1405
B0193AX – Rev AA 30. LOGIC – Logic Block
Instruction Set
Table 76-3 below summarizes all the LOGIC block commands in alphabetical order. Detailed
descriptions for each instruction are supplied in succeeding paragraphs under the instruction type
designated in the rightmost column of the table.
1406
30. LOGIC – Logic Block B0193AX – Rev AA
NOTE
“NAN” is interchangeable with “NAND”. “NXO” is interchangeable with
“NXOR”.
Unary Instructions
A unary instruction operates directly on the contents of the accumulator (located at the top of the
stack). Unary instructions store the result of the operation into the accumulator, overwriting the
original accumulator value. The stack pointer remains unchanged.
NOT is the only Unary instruction.
NOT NOT reads the value (real, long integer, or boolean) in the accumulator
(zero value = False, nonzero value = True), logically negates the value, and
writes the result into the accumulator, overwriting the original value. You
can output the result to LO01, or BO01 to BO04.
Example (AC = accumulator):
Step Instruction
16... Assume AC has value of 0 after Step 16.
17 NOT AC has value of 1 after Step 17.
26... Assume AC has value of 127 after Step 26.
27 NOT AC has value of 0 after Step 27.
Diadic Instructions
A diadic instruction always requires two operands to compute a result. The two operands are
obtained from the two top locations of the stack, having typically been placed there by the two
instructions immediately preceding the diadic instruction.
The block decrements the stack pointer as the operation is being performed and stores the result
in the new accumulator location (the new top of the stack location determined by the decre-
1407
B0193AX – Rev AA 30. LOGIC – Logic Block
mented stack pointer), overwriting the first of the two operands. The second operand is also lost
because it now resides in an inaccessible register one location above the top of the stack.
Polyadic Instructions
A polyadic instruction operates on three or more of the operands on the stack (up to all operands
on the stack) when the instruction is executed.
The block decrements the stack pointer as the operation is being performed and stores the result
in the new accumulator location (the new top of the stack location determined by the decre-
mented stack pointer), overwriting the first operand. All other operands are also lost because they
now reside in inaccessible registers located above the top of the stack.
Since all stack values can be used in the execution of these instructions it is wise to clear the stack
(CST command) prior to the polyadic instruction, then write the commands that place the
desired values onto the stack.
The instructions: AND, NAND, NOR, NXOR, OR and XOR can be invoked as either type
Diadic or as type Polyadic, depending on the number of operands. These instructions are
described below.
AND
AND n
AND operand
AND operand1 operand2
where operand = BIxx, BOxx, Ixx, Oxx, Mxx, ~BIxx, ~BOxx, ~Ixx, ~Oxx,
or ~Mxx
NOTE
Ixx (xx = 1 through 32) refers to a specific bit of Long Input LI01. Specifically, I1
refers to the highest-order bit, and I32 refers to the lowest-order bit of LI 01. Simi-
larly for 0xx and Long Output LO01.
1408
30. LOGIC – Logic Block B0193AX – Rev AA
1409
B0193AX – Rev AA 30. LOGIC – Logic Block
Step Instruction
15 IN BI14 Puts BI14 into AC – assume value is True. The prior
values are pushed down one stack location.
16 NAND Performs the logical NAND function, and stores the
result, 1, into the AC, overwriting the True value
loaded in from BI01. The other values are inaccessible.
NOR
NOR n
NOR operand
NOR operand1 operand2
where operand = BIxx, BOxx, Ixx, Oxx, Mxx, ~BIxx, ~BOxx, ~Ixx, ~Oxx,
or ~Mxx
Performs a logical “nor” (not or) of the contents of the specified operands
and stack locations.
If blank is specified, all stack locations are NORed together, and the result
is written into the accumulator (the new top of stack location). This over-
writes the first operand and isolates the other operands from any further
access.
♦ If n is specified, the last n stack locations are NORed together,
removed from the stack, and the result stored in the accumulator.
♦ If n > number of stack values, the STACK_UNDERFLOW error
is set at runtime.
♦ If only one operand is specified, the operand is NORed with the
accumulator, and the result replaces the accumulator.
♦ If both operands are specified, the operands are NORed together
and the result is stored in the accumulator.
♦ If ~ is specified, the operand value is inverted prior to being used.
Example (AC = accumulator: 0 value = False, non-0 value = True):
Step Instruction
11 CST Clears the stack.
12 IN BI01 Puts BI01 into AC – assume value is True.
13 IN BI07 Puts BI07 into AC – assume value is False. The prior
value is pushed down one stack location.
14 IN BO03 Puts BO03 into AC – assume value is True. The prior
values are pushed down one stack location.
15 IN BI14 Puts BI14 into AC – assume value is True. The prior
values are pushed down one stack location.
16 NOR Performs the logical NOR function, and stores the
result, 0, into the AC, overwriting the True value
loaded in from BI01. The other values are inaccessible.
1410
30. LOGIC – Logic Block B0193AX – Rev AA
NXOR
NXOR n
NXOR operand
NXOR operand1 operand2
where operand = BIxx, BOxx, Ixx, Oxx, Mxx, ~BIxx, ~BOxx, ~Ixx, ~Oxx,
or ~Mxx
Performs a logical “nxor” (Exclusive NOR, or Negated Exclusive OR) of
the contents of the specified operands and stack locations. The Exclusive
NOR produces a True output for an even number of True inputs, a False
output for an odd number of True inputs, and a True output if all inputs
are False.
♦ If blank is specified, all stack locations are NXORed together, and
the result is written into the accumulator (the new top of stack
location). This overwrites the first operand and isolates the other
operands from any further access.
♦ If n is specified, the last n stack locations are NXORed together,
removed from the stack, and the result stored in the accumulator.
♦ If n > number of stack values, the STACK_UNDERFLOW error
is set at runtime.
♦ If only one operand is specified, the operand is NXORed with the
accumulator, and the result replaces the accumulator.
♦ If both operands are specified, the operands are NXORed together
and the result is stored in the accumulator.
♦ If ~ is specified, the operand value is inverted prior to being used.
Example (AC = accumulator: 0 value = False, non-0 value = True):
Step Instruction
11 CST Clears the stack.
12 IN BI01 Puts BI01 into AC – assume value is True.
13 IN BI07 Puts BI07 into AC – assume value is False. The prior
value is pushed down one stack location.
14 IN BO03 Puts BO03 into AC – assume value is True. The prior
values are pushed down one stack location.
15 IN BI14 Puts BI14 into AC – assume value is True. The prior
values are pushed down one stack location.
16 NXOR Performs the exclusive NOR function, and stores the
result, 0, into the AC, overwriting the True value
loaded in from BI01. The other values are inaccessible.
1411
B0193AX – Rev AA 30. LOGIC – Logic Block
OR
OR n
OR operand
OR operand1 operand2
where operand = BIxx, BOxx, Ixx, Oxx, Mxx, ~BIxx, ~BOxx, ~Ixx, ~Oxx,
or ~Mxx
Performs a logical “or” of the contents of the specified operands and stack
locations.
♦ If blank is specified, all stack locations are ORed together, and the
result is written into the accumulator (the new top of stack loca-
tion). This overwrites the first operand and isolates the other
operands from any further access.
♦ If n is specified, the last n stack locations are ORed together,
removed from the stack, and the result stored in the accumulator.
♦ If n > number of stack values, the STACK_UNDERFLOW error
is set at runtime.
♦ If only one operand is specified, the operand is ORed with the
accumulator, and the result replaces the accumulator.
♦ If both operands are specified, the operands are ORed together
and the result is stored in the accumulator.
♦ If ~ is specified, the operand value is inverted prior to being used.
Example (AC = accumulator: 0 value = False, non-0 value = True):
Step Instruction
11 CST Clears the stack.
12 IN BI01 Puts BI01 into AC – assume value is True.
13 IN BI07 Puts BI07 into AC – assume value is False. The prior
value is pushed down one stack location.
14 IN BO03 Puts BO03 into AC – assume value is True. The prior
values are pushed down one stack location.
15 IN BI14 Puts BI14 into AC – assume value is True. The prior
values are pushed down one stack location.
16 OR Performs the logical OR function, and stores the result,
1 (True), into the AC, overwriting the True value
loaded in from BI01. The other values are inaccessible.
XOR
XOR n
XOR operand
XOR operand1 operand2
where operand = BIxx, BOxx, Ixx, Oxx, Mxx, ~BIxx, ~BOxx, ~Ixx, ~Oxx,
or ~Mxx
Performs a logical “xor” (exclusive or) of the contents of the specified oper-
ands and stack locations. The exclusive OR produces a True output for an
odd number of True inputs, a False output for an even number of True
inputs, and a False output if all inputs are False.
1412
30. LOGIC – Logic Block B0193AX – Rev AA
BIF stp# BIF (Branch If False) branches to the step number designated by the oper-
and if the value in the accumulator equals zero.
BIInn BII (Branch If Block Initializing) branches to the step number designated
by the operand if the LOGIC block is initializing.
1413
B0193AX – Rev AA 30. LOGIC – Logic Block
BIT stp# BIT (Branch If True) branches to the step number designated by the oper-
and if the value in the accumulator is a non-zero value.
END END terminates the program. The END instruction is not required but
each program may have one, and only one, END statement and, if
present, it must be the very last statement in the program. Additional
END statements set the DEFINE flag to false. The block cannot run
while the DEFINE flag is false. Step number 15 does not have to be an
END statement. Step number 15 may be any legal instruction. If no END
statement exists in the LOGIC block program, all 15 steps will be exe-
cuted.
EXIT EXIT terminates the program at the current statement number. The
EXIT instruction eliminates the need for a GTO instruction pointing to
an END statement. You may use as many EXIT statements as you need.
GTO stp# GTO (Go To) branches unconditionally to the step number designated by
the operand.
NOP NOP (No Operation) performs no operation. The next step in the pro-
gram is executed.
1414
30. LOGIC – Logic Block B0193AX – Rev AA
CLM Mnn CLM Mnn clears a memory register. “nn” is a one or two digit number,
between 1 (or 01) and 5 (or 05), that specifies the specific memory register
to be cleared.
CST CST resets the stack pointer to the bottom of the stack and clears the bot-
tom stack element. Since the block implicitly executes a CST prior to exe-
cution, it is not required to start a program with a CST instruction.
It is, however, recommended that you issue the CST instruction just
before setting up operands for a polyadic instruction, since polyadic
instructions operate on all values currently pushed onto the stack.
DUP DUP (Duplicate Operands) copies the accumulator onto the stack.
1415
B0193AX – Rev AA 30. LOGIC – Logic Block
POP POP pops the last value (the most recently pushed) off the stack and dis-
cards it. The stack pointer decrements to point to the next value on the
stack.
An attempt to push the stack pointer below the bottom of the stack results
in the stack pointer being clamped to the first stack element with the pro-
gram error flag set and PERROR set to 6 (STACK_UNDERFLOW).
RCL (operand) RCL (Read and Clear Operand) loads the accumulator with the contents
of the specified operand and then sets the specified operand to zero. The
operand can specify a memory register Mnn, or a boolean input or output
(BInn, BOnn) or a bit value (Inn, Onn) or the inverse (~)of any of these.
If a linked input operand is specified the clear function does not set the
specified operand to zero. If an output operand is specified, the
specified operand is set to zero only when the block is in AUTO. If nn is
invalid, an OUT_OF_RNG error is written to the PERROR parameter. If
an inverted parameter (~) is specified, the inverted operand is loaded onto
the stack and the operand is then cleared (that is, it is set to 0).
STM Mnn STM Mnn stores the accumulator contents into a memory register. “nn” is
a one or two digit number, between 1 and 5 (or 01 and 05), that specifies
the specific memory register that is to receive the accumulator data. The
accumulator is unaffected.
If nn is invalid a OUT_OF_RNG Error Code is written to the
PERROR parameter.
1416
30. LOGIC – Logic Block B0193AX – Rev AA
This section describes the I/O reference instructions in the following order: CBD, IN, INB,
OUT, RBD, REL, RQE, RQL, SBD and SEC.
CBD BOnn CBD clears (sets to 0) the Bad status bit of the output parameter specified
by the operand.
INB or INB Mnn Loads the stack with the contents of the boolean input (BInn) whose
index (nn) is specified by the contents of the operand.
♦ If blank, the BI index is the stack value.
♦ If nn is invalid, OUT_OF_RNG error is set.
♦ If BI index < 1 or > 16, INDEX_ERROR error is set at runtime.
Example: INB M05 (loads BInn onto stack, where nn = contents of M05)
These two instructions write the same value from the accumulator to the
block parameter BO07 and LO01 (high-order bit).
1417
B0193AX – Rev AA 30. LOGIC – Logic Block
REL BOnn REL releases the block output specified by the operand. This allows the
output to be set via applications such as default displays, customer config-
ured displays and user written applications.
Use of invalid operands writes an INV_IO to the PERROR parameter
during block validation and the block will be undefined.
RQE BInn RQE (Read Quality Status and Error Bit) reads the quality status of a
specified input and sets the accumulator as follows:
If the input status is BAD, OOS, OFF_SCAN, or ERROR the accumula-
tor is set to 1.
Otherwise the accumulator is set to 0.
RQL BInn RQL (Read Quality Status) reads the quality status of a specified input
and sets the accumulator as follows:
If the input status is BAD, OOS, or OFF_SCAN the accumulator is set to
1.
Otherwise the accumulator is set to 0.
SBD BOnn SBD sets (to 1) the Bad status bit (Bad = True = 1) of the local value of the
output parameter specified by the operand.
SEC BOnn SEC secures the block output specified by the operand. This allows the
output to be set only by the LOGIC block algorithm.
1418
30. LOGIC – Logic Block B0193AX – Rev AA
Step Instruction
13 OUT BO04 Outputs AC contents – the results of the DOFF 8
instruction – to boolean output 04.
BI01
8 sec 8 sec
BO04
The operand fields of DOFF, DON and OSP are interpreted as follows:
n: time = 0.5 seconds if n=0
time = n seconds if n>0
RInn: time = contents of RInn:
in seconds if >0
in cycles if <0
1419
B0193AX – Rev AA 30. LOGIC – Logic Block
BI01
7 sec 7 sec
BO04
1420
30. LOGIC – Logic Block B0193AX – Rev AA
1421
B0193AX – Rev AA 30. LOGIC – Logic Block
BI01
5 sec
BO04
Error Conditions
Two types of errors are detected:
♦ Dynamic errors (or Runtime errors) – those detected while the block is running.
♦ Syntax errors – those detected when the block is installed.
An integer code stored in the output parameter PERROR indicates the type of the first error
detected.
The output parameter STERR indicates the number of the program step that contains the first
error.
Automatic updating of the parameters, PERROR and STERR, at a dedicated display on the
workstation enables you to monitor these parameters while in debugging phase of the LOGIC
program development.
1422
30. LOGIC – Logic Block B0193AX – Rev AA
Syntax errors are detected when the LOGIC block restarts, which happens when its compound
turns ON, when a configuration Modify/Add operation terminates with DONE, or when an
undelete operation is performed.
A nonzero value for PERROR indicates an error. A positive value indicates an error occurred
while executing the program (runtime error). A negative value indicates a syntax error.
Errors Meaning
-1 invalid OP code
-2 invalid I/O ref
-3 operand index out of range
-4 GTO out of range
5 Stack overflow
6 Stack underflow
10 INDEX_ERROR
11 BIT_ERROR
Programming Concepts
The LOGIC block operates in the same way as do most programmable pocket calculators. To
specify program operations and calculations, you type in a series of programming steps, which are
analogous to “keystrokes” on a calculator. A programming step can specify either an operand, an
instruction, or an instruction and its immediate operand. Each instruction performs a unique
operation over a set of one or more operands.
Program Entry
Use the Integrated Control configurator to enter the LOGIC block program. Program consists of
a series of string-type entries in parameters STEP01 through STEP15, each of which defines a
single programming step.
Blank steps can be inserted anywhere in a LOGIC block program prior to the END statement.
This makes it possible to modify the block program without reconfiguring each step in the pro-
gram.
When a blank step is found in the program, the LOGIC block logic skips to the next step without
altering the accumulator or the program stack.
The block requires programs to be entered through the Reverse Polish Notation (RPN) method.
In a simple example, you specify first the operands and then the instruction to be performed,
which terminates the operation. This convention, followed for both arithmetic and boolean oper-
ations, works especially well with those instructions that operate on more than two operands.
LOGIC block instructions use one of the following types of operands:
♦ Real constants – entered in a program step preceding the step containing the operator.
♦ Real variables (reserved parameter names from the LOGIC block I/O table) – entered
in a program step preceding the step containing the operator. The variable is read
through the IN instruction. Specify the corresponding reserved parameter mnemonic
name: BI01 to BI16, LI01, BO01 to BO04, or LO01.
♦ Boolean variables (reserved parameter names from the LOGIC block I/O table) –
entered in a program step preceding the step containing the operator.
1423
B0193AX – Rev AA 30. LOGIC – Logic Block
♦ Step number – entered in the same program step as a program control operator, sepa-
rated from it by a blank character.
♦ Memory register number – entered in the same program step as a memory referencing
operator, separated from it by a blank character.
♦ Delay time or duration – entered in the same program step as a timing operator, sepa-
rated from it by a blank character.
Boolean and Real variables are read through the IN instruction. As the value for the STEPnn
parameter you type the string: IN for the operation code, a blank or space character as a separator,
and the variable name as the operand.
Boolean Example
Step Instruction
STEP01 CST
STEP02 INBI1 Read Boolean input #1
STEP03 INBI2 Read Boolean input #2
STEP04 INBI3 Read Boolean input #3
STEP05 INBI4 Read Boolean input #4
STEP06 AND
STEP07 EXIT
The pending result is the logical “and” of inputs BI1 through BI4. This example illustrates a poly-
adic instruction, which is one that operates on two or more operands.
In this example, the results of the operations are internally stored in an accumulator register and
become available as operands for the next operation. This accumulator register is analogous to the
display register of a pocket calculator, which always displays either the current operand or the
results of the last operation.
Execution Sequence
You can consider the sequencing of programming steps to be under control of an internal pro-
gram counter that indicates the next program step to be processed. Instructions such as GTO that
affect program control directly reference the step number of the next step to be processed. Your
program can have up to 50 steps.
The LOGIC block supports both conditional and unconditional means of altering the control of
program execution. Unconditional transfer of control is supported only in a forward direction;
looping backwards is not allowed. Conditional transfer of control is dependent on the results of
arithmetic comparisons or logical conditions.
The following example demonstrates these concepts.
1424
30. LOGIC – Logic Block B0193AX – Rev AA
Branching Example
Program function: To select either of two inputs based on the status of a binary input.
BI06
BI05
Step Instruction
STEP01 CST Clear any pending results from stack
STEP02 IN BI01 Read binary input, to select an input
STEP03 BIT 06 Branch if binary input is true
STEP04 IN BI05 Binary is false, read input #5
STEP05 GTO 07 Go to output step
STEP06 IN BI06 Binary is true, read real input #6
STEP07 OUT BO01 Write selected input value to output
STEP08 END —
1425
B0193AX – Rev AA 30. LOGIC – Logic Block
1426
77. LONG – Long Integer Variable
Block
This chapter gives a general overview of LONG (Long Integer Variable Block), describing its
basic operations, features and parameters.
Overview
The Long Integer (LONG) Variable block provides data storage for a long integer value and its
configured engineering units (see Figure 77-1). The long integer value parameter is typically con-
nected to other blocks for use in a control strategy. You can make boolean extension connections
to the long integer value.
Basic Operation
The LONG block contains a long integer data variable parameter (VALUE) that can be set by an
application to store a value for use by other blocks. You configure the engineering units parameter
(EO1) for VALUE. The VALUE record contains a status field in which an application can set the
Bad and out-of-service (OOS) bits.
The LONG block has a Detail Display for viewing and setting parameters. LONG and other data
variable blocks appear on the Select display in the order they are configured, following all other
blocks in the compound.
The LONG block does not contain PERIOD and PHASE parameters because it is not executed
by the compound processor. Using the Control Configurator, any number of LONG blocks can
be inserted in the END DATA zone of any compound.
The LONG block is validated whenever:
♦ It is installed in the Control Processor (CP) database
♦ The CP undergoes a reboot operation
♦ The compound in which the block resides is turned on.
Block validation does not change any parameter values that have not been reconfigured, except for
a CP reboot, in which case it installs the parameter values in the checkpoint file. If you turn the
compound off and then on, the VALUE parameter value is unchanged.
1427
B0193AX – Rev AA 77. LONG – Long Integer Variable Block
Features
The LONG block provides the following features:
♦ Long integer data variable (VALUE) for storing a long integer value
♦ User-defined engineering units (EO1) for VALUE.
Parameters
Table 77-1. LONG Block Parameters
Parameter Definitions
DESCRP Descriptor is a user-defined string of up to 32 characters that describe the
variable (for example, HEAT TIME – SECONDS).
TYPE Type is a system-level mnemonic label indicating the block type. Enter
LONG or select LONG from the block type list under SHOW when con-
figuring the block.
VALUE Value is a long integer data variable that can be set by an application to
store data for use by other blocks.
1428
78. MAIN – Multiple Analog Input
Block
This chapter gives a general overview of MAIN (Multiple Analog Input Block), including its
basic operations, features, parameters, and functions, bad input and out-of-range processing,
manual mode, and alarming. It also provides an application diagram and appendixes on signal
conditioning and valid input connections.
Overview
The Multiple Analog Input Block (MAIN) receives input values from up to 8 points of a single
analog, pulse count, or Intelligent Field Device type of Fieldbus Module (FBM) or Fieldbus Card
(FBC), or from other blocks, and converts them into suitable form for use in an I/A Series control
strategy. The input to the block is the digitized data from the FBM’s or FBC’s Equipment Control
Block (ECB), and the outputs are values expressed in the specified engineering units for each
point. See Figure 78-1.
Charac- counts
terizer
(None)
Gain
Offset
Figure 78-1. MAIN Block Diagram
1429
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
Basic Operation
The MAIN block interfaces to an ECB which stores values from an FBM or FBC receiving analog
electrical signals, pulse inputs, or pulse rate inputs.
Each execution cycle, the MAIN block reads from the ECB the FBM or FBC operational status,
and the channel status and input data for the specified eight points.
After validation, the MAIN block converts the octet’s raw data values to floating point numbers in
engineering units, according to the configured Signal Conditioning Indexes, the High and Low
Scale of the engineering units ranges, and any specified units conversion or filtering options.
These outputs are presented to the control strategy as Points 1 to 8 (PNT_1 to PNT_8). The
original values as present in the ECB are preserved and made available as outputs Raw Counts 1
to 8 (RAWC_1 to RAWC_8).
The sequence of signal processing actions is, in the order of application: Signal Conditioning or
Characterization, Scaling for Unit Conversion, Clamping, and Filtering.
Features
♦ Independent processing of up to eight analog input channels on a single FBM or
FBC.
♦ Fieldbus Module option to permit configuration of MAIN blocks without FBM or
FBC connections (input from other blocks instead of from hardware).
♦ Processing of Pulse Rate and Pulse Count inputs.
♦ Acceptance of Hydrostatic Tank Gauge (HTG), Intelligent Field Device (IFD), and
Coriolis inputs.
♦ Connectability to Intelligent Field Device Window ECBs.
♦ Choice of Linear/Square Root, Thermocouple, RTD, or specially characterized signal
conditioning with independently selected Signal Conditioning Indexes for each
channel.
♦ External or FBM- or FBC-based temperature reference for thermocouple cold junc-
tion compensation.
♦ Output clamping between user-selectable output limits for each channel.
♦ Output gain and offset scaling.
♦ First order, second order, or two-sample-average filtering with independent selection
of type and time constant for each channel.
♦ Scaling, clamping, and filtering of the thermocouple cold junction reference channel.
♦ Manual mode availability for disconnecting control schemes from the process, for
simulation and checkout purposes.
♦ Raw Count output availability for troubleshooting purposes, including floating point
values from HTG, IFD, and Coriolis inputs.
♦ Independent bad input point and bad range handling for each channel.
♦ Last Good Value output retention on certain I/O failures.
1430
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
Parameters
Table 78-1. MAIN Block Parameters
1431
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
BAD Bad is a boolean output parameter which is set true when one or more of
the individual BAD_1 to BAD_8 outputs is true. BLKSTA.BAD is always
true when BAD is true.
BADOPT Bad and Out-of-Range Option is a short integer option that specifies the
conditions that set the BAD_x outputs true. Values:
0 = Bad Status (PNT_x.BAD) only
1 = Bad Status (PNT_x.BAD) or Low Out-of-Range (LOR_x)
2 = Bad Status (PNT_x.BAD) or High Out-of-Range (HOR_x)
3 = Bad Status (PNT._xBAD) or LOR_x or HOR_x.
1432
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
BADREF Bad Reference is a boolean output which is set true if an external thermo-
couple reference is in use and it has Bad status, or the FBM or FBC chan-
nel containing the reference has Bad status, or (in the case of the FBC02
and FBC02 Redundant) the value in Channel 33 is zero. Based on the
value of BADOPT, BADREF can also be set true due to an ohms value
outside the limits of the 100 ohm IEC table, or an out-of-range condition
of the reference after conversion to degrees C.
BAD_1 to BAD_8
Bad Points 1 to 8 are boolean output parameters which are set true when
their respective points have bad status for any reason. If BAD_x is true,
then PNT_x has Bad status as well. If BAD_x is true for any point, then
BLKSTA.BAD and BAD is also true
1433
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the MAIN block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
FBM
BAD
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
8 FBM FBM or FBC Failure BLKSTA.B24
11 MA Manual = 0, Auto = 1 BLKSTA.B21
12 BAD Bad I/O for at least one BLKSTA.B20
input point
14 UDEF Block Undefined BLKSTA.B18
15 ON Block ON BLKSTA.B17
20 WLCK Access Locked BLKSTA.B12
BSCALE Offset Scale is a real input which is used as the offset factor, in output
units, applied to the conditioned signal to rescale it for compatibility with
the output units. It is usually used to convert from Celsius to Fahrenheit
scales.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. (See ERCODE for the list of all possible validation errors in this
block.) In that case, 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.
DELTO1 to DELTO9
Change Deltas for Output Ranges 1 to 9 are presently unused.
1434
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
DEV_ID Device Identifier is a character array data store that indicates the 6-charac-
ter letterbug of the connected FBM or FBC. In the case of IFD inputs,
DEV_ID contains the letterbug of the parent FBM18, 43, 39, 44, or 46)
to which the instruments interface.
EO1_1 to EO1_9 Engineering Units for Output Ranges 1 to 9 provide the engineering units
text for the channels 1 to 9 output values. The values configured for these
text strings should be consistent with the values used for HSCOx and
LSCOx. EO1_9 provides this text for the thermocouple cold junction
compensation reference channel.
ERCODE Error Code is a string data store which indicates the type of configuration
error which caused the block’s DEFINE parameter to be set false. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. For the MAIN block, the following list specifies
the possible values of ERCODE and the significance of each value in this
block:
ERCODE Value
W44 – INVALID HSCO1_x less than or equal to
ENGINEERING RANGE LSCO1_x for any point x, including
a thermocouple reference point
W48 – INVALID BLOCK BADOPT out of range, or FLOP_x
OPTION out of range for any point x, or
FLOPTC out of range
W49 – INVALID BLOCK Invalid CHARC block extension
EXTENSION
W50 – INVALID SIGNAL Invalid SCI_x for any point x
CONDITIONING INDEX
W51 – INVALID HARDWARE/ Cluster I/O specified but type is not
SOFTWARE TYPE valid as a MAIN connection
W52 – INVALID I/O CHANNEL/ OCTNUM out of range for the
GROUP NUMBER specified FBM or FBC
W54 – ECB DOES NOT EXIST Specified IOM_ID does not exist
EXTBLK Extender Block is a long input that specifies the pathname to the BLKSTA
parameter of a CHARC block used as an extender block. The CHARC
block must be in the same CP and compound as the MAIN block.
FLOPTC Filter Option Thermocouple is an option parameter that specifies the type
of filtering that is applied to the thermocouple cold junction compensa-
tion value. See the definition of FLOP_1 to FLOP_8 for the allowable
values.
FLOP_1 to FLOP_8
Filter Options 1 to 8 are option parameters that specify the type of filter-
ing that is applied to each channel before it is set into the respective
PNT_x output. FLOP_x has the following values:
1435
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
0 = No Filtering
1 = First Order Lag Filtering
2 = Butterworth Filtering
3 = Two-Sample-Average Filtering
FTIMTC Filter Time Thermocouple is the time in minutes for the thermocouple
cold junction compensation value to reach a certain percentage of its ulti-
mate value after a step change to its input. See the definition of FTIM_1
to FTIM_8.
FTIM_1 to Filter Times 1 to 8 are inputs that represent the time in minutes for the
FTIM_8 respective output values to reach a certain percentage of their ultimate val-
ues after a step change to the input. For first order lag filtering this per-
centage is approximately 63 percent, and for Butterworth filtering it is
approximately 50 percent. Filter Time is not applicable to two-sample-
average filtering.
HORREF High Out-of-Range Reference indicates that the thermocouple cold junc-
tion reference value is above the limits of the 100 ohm IEC RTD conver-
sion table, or that the reference value has been clamped based on HSCO9
and OSV_9.
HOR_1 to High Out-of-Range Points 1 to 8 are boolean outputs that are set true, on
HOR_8 a point-by-point basis, if any one of the seven high out-of-range condi-
tions described in Section (Out-of-Range Conditions) applies to the
point.
HSCO1 to High Scales for Output Ranges 1 to 9 are real values that define the upper
HSCO9 range values for each of the block’s individual outputs. HSCO9 defines
the upper range value for the thermocouple cold junction compensation
reference channel.
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
♦ The compound in which it resides is turned on.
♦ The INITMA parameter itself is modified via the control configu-
rator. (The block does not assert INITMA on ordinary
reconfiguration.)
INITMA is ignored if MA has an established linkage.
1436
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
IOMOPT FBM Option is a short integer specifying whether an FBM or FBC con-
nection to the block exists, and, if not, whether signal conditioning is to
be applied to the alternate sources of the block inputs. Values:
0= The MAIN block obtains input values from the MEAS_1 to
MEAS_8 parameters and conditions them as specified by the val-
ues of SCI_1 through SCI_8 respectively.
1= The block obtains input values from the FBM or FBC input
points specified by IOM_ID and OCTNUM.
2= The block obtains input values from the MEAS_1 to MEAS_8
parameters. No signal conditioning is performed. The inputs are
subjected only to scaling for units conversion (via KSCALE and
BSCALE), clamping using the configured HSCOx, LSCOx, and
OSV_x parameters, and filtering, in that order.
IOM_ID Fieldbus Module Identifier is a configurable string that specifies the path-
name of the ECB for the FBM or FBC to which the block is connected.
IOM_ID has the form CompoundName:BlockName, where Compound-
Name is the 1-12 character name of the local compound containing the
ECB, and BlockName is the 1-12 character block name of the ECB. For
IFD inputs, the NAME parameter string of the parent ECB (12, 23, or
38R) must be used.
If the compound containing the ECB is the CPletterbug_ECB compound
where CPletterbug is the station letterbug of the CP, the CompoundName
may be omitted from the IOM_ID configuration. In this case, the 1-12
character ECB block name is sufficient. For IFD inputs, this is the letter-
bug of the parent FBM (18, 43, 39, 44, or 46).
KSCALE Gain Scale is a real input which is used as the gain factor applied to the
conditioned signal to rescale it for compatibility with the output units.
KSCALE and BSCALE are always applied after any signal conditioning or
characterization of the raw input. It is usually used to convert from Celsius
to Fahrenheit scales.
LASTGV Last Good Value is a boolean option. When true in the following situa-
tions, LASTGV causes the previous value of PNT_x to be retained, and
the value obtained this cycle to be ignored:
♦ Based on the value of the thermocouple cold junction compensa-
tion reference channel, HORREF or LORREF is true, and
BADOPT has specified that this direction out-of-range is to cause
BADREF to be true. The previous value of TC_REF is retained,
as well as that of every PNT_x in the octet.
♦ Based on signal conditioning actions, HOR_x or LOR_x has been
set, and BADOPT has specified that this is to cause BAD_x to be
set.
♦ Based on clamping actions, HOR_x or LOR_x has been set, and
BADOPT has specified that this is to cause BAD_x to be set. In
1437
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
LORREF Low Out-of-Range Reference indicates that the thermocouple cold junc-
tion reference value is below the limits of the 100 ohm IEC RTD conver-
sion table, or that the reference value has been clamped based on LSCO9
and OSV_9.
LOR_1 to LOR_8 Low Out-of-Range Points 1 to 8 are boolean outputs that are set true, on a
point-by-point basis, if any one of the seven low out-of-range conditions
described in Section (Out-of-Range Conditions) applies to the point.
LSCO1 to LSCO9 Low Scales for Output Ranges 1 to 9 are real values that define the lower
range values for each of the block’s individual outputs. LSCO9 defines the
lower range value for the thermocouple cold junction compensation refer-
ence channel.
MEAS_1 to Measurements 1 to 8 are values used as the sources of the inputs to block
MEAS_8 operations when IOMOPT indicates that no FBM or FBC is connected
(IOMOPT = 0 or 2). If an FBM or FBC is connected (IOMOPT = 1),
then MEAS_1 through MEAS_8 are treated as outputs, and the value of
PNT_x is copied to the value of MEAS_x.
1438
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
MTRF_1 to Meter Factor 1 to 8, real inputs, are scaling parameters used with pulse
MTRF_8 rate input signal conversion (SCI_x = 8) to translate input pulse rates in
Hertz to the desired engineering units of the process outputs. In most
applications they would be considered to have the dimension Flow Rate
per Hertz. Parameters MTRF_5 through MTRF_8 are presently unused.
OCTNUM Octet Number is an integer value, ranging from 1 to 4, that specifies the
group of eight inputs to the connected FBM or FBC to be used by the
MAIN block. The inputs need not be of the same type nor conditioned
identically.
OSV_1 to OSV_9 Output Span Variances 1 to 9 are configurable real inputs which define
the percentage by which the output clamp limits exceed the output ranges
defined by HSCO1 to HSCO9 and LSCO1 to LSCO9. OSV_9 defines
this percentage for the thermocouple cold junction compensation refer-
ence channel.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
* If the BPC is 0.2 seconds, this period is treated internally as 0.6 seconds,
but the PERIOD parameter remains 1.
1439
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PNT_1 to PNT_8 Points 1 to 8 are the block outputs. They represent the analog inputs after
all block operations have been performed.
PROPT Propagate Error Option is a boolean input which determines whether the
status of MEAS_x should be reflected in the Error bit of PNT_x status. If
the MAIN block is in Auto and no FBM or FBC is configured (IOMOPT
= 0 or 2), the true value of PROPT causes any one of the following condi-
tions to be reflected as an Error status of PNT_x:
♦ Bad status bit in MEAS_x
♦ OOS status bit in MEAS_x
♦ Error status bit in MEAS_x
♦ Any value in the OM field of the MEAS_x status except 1
(ON_SCAN). Any other value in this field indicates that the
source of the connection has been deleted or is in a nonexistent
compound, or there has been a peer-to-peer path failure.
RAWC_1 to Raw Counts 1 to 8 are the values read from the ECB into the block before
RAWC_8 any form of signal conditioning, characterization, scaling, clamping or fil-
tering is applied. They are of real data type although the ECB values may
be of integer or long integer type.
RO1_1 to RO1_9 Range Outputs 1 to 9 are real arrays consisting of the three parameters
HSCOx, LSCOx, and DELTOx respectively. The array members are con-
figured by their individual names; however, RO1_x and its members can
be accessed on an array basis by user tasks and displays.
SCI_1 to SCI_8 Signal Conditioning Indexes 1 to 8 are indexed input parameters that
determine how the raw count input for each point of the specified octet is
conditioned. It is an alternate to characterization and a predecessor to scal-
ing, clamping and filtering. (See “Appendix A – Signal Conditioning
Tables” on page 1462.)
1440
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
TC_RAW Thermocouple Raw Count is a real output indicating the value of the
thermocouple reference as present in the ECB, provided the status of that
point is good.
TYPE When you enter “MAIN” or select “MAIN” from a configurator list, an
identifying integer is created specifying this block type.
XREFIN External Reference Input is a real input used as the source of the cold
junction reference temperature for thermocouple SCIs when XREFOP is
configured true, or no FBM or FBC is configured. The block calculations
assume that XREFIN is in units of degrees Celsius.
ZERROP Zero Error Point is a status bit that indicates an out-of-range error (LOL
or LOR) in a DOWNSTREAM parameter (PNT.ERR) and also to indi-
cate an unconditional request for initialization in an UPSTREAM param-
eter (BCALCO.INITU). Normally, these usages are mutually exclusive
and there is no conflict. However, in some control applications where a
DOWNSTREAM parameter is used as part of an UPSTREAM connec-
tion, a High Out-of-Range (HOR) or Low Out-of-Range (LOR) condi-
tion can be misinterpreted as an unconditional initialization (INITU)
request. ZERROP is not configurable. To disable the setting of PNT.ERR
when out-of-range, you must use OMSET, OMA, or some other utility to
set ZERROP = 1.
ZERROP is a non-configurable boolean parameter with the following
meaning:
ZERROP = 0 set PNT.ERR when out of range (default setting, backward
compatible with previous version)
ZERROP = 1 do not set PNT.ERR when out of range
NOTE
PNT.ERR status can also be set when propagating (PROPT = 1) a simulated input
(IOMOPT = 0) and the measurement (MEAS) is BAD, OOS ERR, or Discon-
nected. This action is unaffected by the ZERROP option.
1441
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
Functions
Detailed Diagram
IOM_ID SCI_x
OCTNUM KSCALE HSCOx FLOP_x
XREFOP BSCALE LSCOx FTIM_x (M)
XREFIN OSV_x
FROM EXTBLK
ECB IOMOPT
o MA
1 PNT_x
Signal o o
Conditioning* Scaling Clamping Filtering
MEAS_x 0,2 (A)
output
units
HSCOx LSCOx Converted
OOR
RAWC_x
OR LOR_x, HOR_x
Raw Data
00R
Test
BAD_x
ECB Status
PNT_x.BAD
Channel
Status BADOPT BLKSTA.BAD
BAD
Bad
Reference
* See individual diagrams
1442
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
You specify the source FBM or FBC in the Fieldbus Module Identifier (IOM_ID) parameter, and
the group of eight points within the FBM or FBC by the Octet Number.
(OCTNUM) parameter. The following are the FBMs or FBCs and octet numbers providing gen-
eral analog input:
Electrical Valid
FBM ECB Functional Description Type Valid Points Octets
FBM201 ECB1 8 Analog In 0 to 20 mA Points 1 to 8 1
FBM204 ECB2 4 Analog In, 4 Analog Out 0 to 20 mA Points 1 to 8 1
FBM205 ECB2 As FBM04, Redundant 0 to 20 mA Points 1 to 8 1
FBM211 ECB1 16 Analog In 0 to 20 mA Points 1 to 16 2
FBM01 ECB1 8 Analog In 0 to 20 mA Points 1 to 8 1
FBM04 ECB2 4 Analog In, 4 Analog Out 0 to 20 mA Points 1 to 8 1
FBM05 ECB2 As FBM04, Redundant 0 to 20 mA Points 1 to 8 1
FBM06 ECB4 4 Pulse Rate In, 4 Analog Out 0 to 20 mA Points 5 to 8 1
FBM17 ECB9, 4 Analog In, 2 Analog Out, 0 to 10 V dc Points 1 to 6 1
33 to 36 4 Digital In, 4 Digital Out
FBM39 ECB23 4 IFD In, 4 Analog Out 0 to 20 mA Points 5 to 8 1
FBM44 ECB23 As FBM39, Dual Baud Rate 0 to 20 mA Points 5 to 8 1
FBM46 ECB49 As FBM44, Redundant 0 to 20 mA Points 5 to 8 1
FBC21 ECB41 16 Analog In 0 to 20 mA Points 1 to 16 1 to 2
FBC01 ECB41 32 Analog In 0 to 20 mA Points 1 to 32 1 to 4
FBC17 ECB41 32 Analog In 0 to 10 V dc Points 1 to 32 1 to 4
FBC04 ECB43 16 Analog Out 0 to 20 mA Points 1 to 16 1 to 2
1443
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
The following points in the above table are physical outputs rather than physical inputs. You can
use the readback values from these points as inputs to the MAIN block:
FBM204: Points 5 to 8
FBM205: Points 5 to 8
FBM237: Points 1 to 8
FBM04: Points 5 to 8
FBM05: Points 5 to 8
FBM06: Points 5 to 8
FBM17: Points 5 to 6
FBM37: Points 1 to 8
FBM39: Points 5 to 8
FBM44: Points 5 to 8
FBM46: Points 5 to 8
FBC04: Points 1 to 16
If FBM Option (IOMOPT) is not set to 1, then IOM_ID and OCTNUM are ignored. The
inputs are taken from other blocks, as described in Section .
General analog inputs are converted by the FBM or FBC from the electrical process input into a
form called “raw count,” which is an integer value between 0 and 64000. Based on the Signal
Conditioning Index (SCI_x) and the parameter Extender Block (EXTBLK) setting, a determina-
tion is made as to how the raw count for each point in the octet is to be conditioned.
If you wish the raw counts to be characterized by a CHARC block, you should link the Extender
Block (EXTBLK) parameter of the MAIN block to a CHARC block, and set the Extender Block
Option (EXTOPT) of that CHARC block to 1. All of the raw counts for the octet are then char-
acterized as described below, and the values of SCI_1 to SCI_8 are ignored. The characterizer out-
puts should be expressed in counts, with full scale equal to 64000.
If you wish to apply linear or square root signal conditioning to the raw counts, you should set
each SCI_x to one of the following values:
SCI = 0: No linearization; output = input
SCI = 1: Linear (0 to 64000). Analog Input 0 to 20 mA
SCI = 2: Linear (1600 to 64000). Analog Input 0 to 10 V dc
SCI = 3: Linear (12800 to 64000). Analog Input 4 to 20 mA
SCI = 4: Square root (0 to 64000). Analog Input 0 to 20 mA
SCI = 5: Square root (12800 to 64000), clamped. Analog Input 4 to 20 mA
SCI = 6: Square root, low cutoff (0 to 64000), clamp < 3/4%. Analog Input 0 to 20 mA
SCI = 7: Square root, low cutoff (12800 to 64000), clamp < 3/4%. Analog Input 4 to 20 mA
SCI = 9: Linear, low cutoff (1600 to 64000). Analog Input 0 to 10 V dc
SCI = 10: Linear, low cutoff (12800 to 64000). Analog Input 4 to 20 mA
SCI = 11: Square root, Intelligent Transmitter 2 (0 to 64000)
SCI = 12: Linear (14080 to 64000). Analog Input 2 to 10 V dc
SCI = 13: Square root, low cutoff (14080 to 64000). Analog Input 2 to 10 V dc
1444
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
1445
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
The raw value from the input is passed to the CHARC block specified, and the resulting output
from the characterizer is then scaled (if not already accomplished by the characterization),
clamped, and optionally filtered.
If the CHARC input is outside the characterizer end-points, and BADOPT indicates that an out-
of-range in that direction is to be considered Bad status and LASTGV is true, then the value of
PNT_x is not updated this cycle, and the filter for the channel is re-initialized if Filter Option
(FLOP_x) is non-zero.
Thermocouple Inputs
Cold oC oF
Linearization
Channel 9 Junction X +
Compensation 31.5.2.2
External
Block
horref, lorref hor, lor
Bad Reference
Channel Status
FBM Status
The following FBMs or FBCs and octet numbers provide thermocouple inputs:
FBM ECB Functional Description Electrical Type Valid Points Valid Octets
FBM202 ECB1 8 Analog In mV Points 1 to 8 1
FBM212 ECB1 14 Analog In mV Points 1 to 14 1 to 2
FBM02 ECB1 8 Analog In mV Points 1 to 8 1
FBM36 ECB1 8 Analog In mV Points 1 to 8 1
FBC02 ECB41 32 Analog In mV Points 1 to 32 1 to 4
FBC02 ECB41 32 Analog In, mV Points 1 to 32 1 to 4
Redundant Redundant
If IOMOPT is not set to 1, then IOM_ID and OCTNUM are ignored. The inputs are taken
from another block, as described in Section .
1446
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
A temperature input read from a thermocouple must be linearized before it can be used. The tem-
perature value must also be compensated for the thermocouple’s cold junction temperature. This
value can be obtained from Point 9 (FBM202, FBM02, and FBM36), Point 15 (FBM212), or
Point 33 (FBC02 and FBC02 Redundant), or it can be provided directly as a temperature value
by setting XREFOP true and providing the compensation temperature, in degrees Celsius, in the
XREFIN parameter. The engineering unit value obtained from signal conditioning is always in
degrees Celsius. KSCALE and BSCALE can be used to convert the engineering units from Celsius
to Fahrenheit. To do this, enter KSCALE = 1.8 and BSCALE = 32.0 (see Section ).
Thermocouple inputs are converted in the FBM or FBC from millivolts into raw counts in the
range 0 to 64000. This conversion is reversed by the CP when you specify a SCI_x value between
20 and 28 or you specify Special Thermocouple signal conversion.
When you apply thermocouple signal conditioning to the raw count, you should set the SCI_x
applicable to the input point to one of the values 20 to 28 as follows:
SCI = 20: Type B Thermocouple
SCI = 21: Type E Thermocouple
SCI = 23: Type J Thermocouple
SCI = 24: Type K Thermocouple
SCI = 25: Type N Thermocouple
SCI = 26: Type R Thermocouple
SCI = 27: Type S Thermocouple
SCI = 28: Type T Thermocouple
The SCI_x specifies which thermocouple curve is to be used for the input signal. Unlike the gen-
eral SCI values 0 through 11, where you must tell the system what engineering units are associ-
ated with the raw counts, with a thermocouple SCI the system knows what temperature range
goes with each SCI. The entire temperature range of the thermocouple is available to you, as it is
stated in “Appendix A – Signal Conditioning Tables” on page 1462. HSCOx and LSCOx are
only used to specify what portion of the range is to be used for display purposes.
Thermocouple Signal Conversion
Key Parameters: IOM_ID, OCTNUM, SCI_1 to SCI_8, XREFOP, XREFIN, KSCALE,
BSCALE
(The details of thermocouple signal conversions are listed in “Appendix A – Signal Conditioning
Tables” on page 1462.)
Cold junction compensation is now computed:
♦ The Point 9 value from the FBM202, FBM02, or FBM36, the Point 15 value for the
FBM 212, or the Point 33 value from the FBC02 or FBC02 Redundant is ordinarily
used for cold junction compensation of each point within the octet. It provides the
cold junction temperature from an RTD sensor within the FBM or FBC. It is con-
verted back from raw count to ohms in the CP. The raw count value is reported in
output parameter Thermocouple Raw Count (TC_RAW).
♦ The RTD conversion table for SCI 43 (100 ohm IEC) is used to convert the Point 9,
Point 15, or Point 33 value from ohms to degrees Celsius. If the ohms value exceeds
the highest or lowest ohms values in this table, it is clamped at those values, the High
Out-of-Range Reference (HORREF) or Low Out-of-Range Reference (LORREF)
block parameter is set true, and processing occurs as described in Section .
1447
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
1448
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
RTD Inputs
RAWC_1-RAWC_8
SC!_1-SCI_8 = 40-44
hor, lor
Channel Status
FBM Status
1449
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
value is outside the table limits, the input is clamped at the lowest or highest ohms value, and
LOR_x or HOR_x is set. Based on BADOPT and LASTGV, this clamped value is either used or
ignored, as described in Section .
As in the case of thermocouple inputs, HSCOx and LSCOx are not key parameters because the
signal conditioning understands what the engineering unit range is for a particular SCI. The
entered range is only used for display purposes, and for calculating percent of range for peer-to-
peer connections.
MTRF_1-MTRF_4
Inputs = 32 SCI_1-SCI_4 = 8
bit Raw Counts
Raw Count Hertz to
to Hertz Flow Rate
31.5.2.4 31.5.2.4
Channel Status
FBM Status
To apply pulse rate signal conditioning to the raw count value of the point, set SCI_x = 8. See the
definition of this SCI in “Appendix A – Signal Conditioning Tables” on page 1462.
The Pulse Constant defined in the appendix converts the raw count in the ECB4 into the units of
Hertz. You must set Meter Factor (MTRF_x) with the value necessary to convert Hertz into the
configured Engineering Units for Output Range 1 (EO1_x). Typically MTRF_x would be in
units of Flow Rate per Hertz.
For example, suppose a meter with an output factor of 50 pulses/gallon has a maximum flow rate
of 100 gallons/minute. Then:
♦ The maximum pulse rate is 5000 pulses per minute.
♦ 5000 pulses per minute = 83.3 pulses per second (Hertz).
♦ MTRF_x = 100/83.3 = 1.2 (Gallons/minute per hertz).
♦ EO1_x = GPM (Gallons Per Minute)
1450
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
You can apply pulse rate signal conditioning to the first four points of FBM06 and linear/square
root or characterizer signal conditioning to the last four points independently.
Pulse count inputs are transferred as is to the outputs PNT_1 to PNT_8. You cannot condition,
characterize, scale, clamp, or filter pulse count inputs. The entered values of SCI_1 to SCI_8 are
ignored.
RAWC_1-RAWC_8
Outputs
SCI = 0 KSCALE BSCALE Engineering
Units
X +
Inputs = Engineering Units
Channel Status
FBM Status
Figure 78-7. Intelligent Field Device Inputs Example
The following FBMs and octet numbers provide Intelligent Field Device inputs:
FBM ECB Functional Description Electrical Type Valid Points Valid Octets
FBM18 ECB12 8 IFD In IFD Points 1 to 24 1 to 3
FBM43 ECB12 8 IFD In IFD, Dual Points 1 to 24 1 to 3
Baud Rate
FBM39 ECB23 4 IFD In, 4 Analog Out IFD, 0 to Points 1 to 4, 1 to 3
20 mA 9 to 12, 17 to 20
FBM44 ECB 23 4 IFD In, 4 Analog Out IFD, Dual Points 1 to 4, 1 to 3
Baud Rate 9 to 12, 17 to 20
1451
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
FBM ECB Functional Description Electrical Type Valid Points Valid Octets
FBM46 ECB 38R 4 IFD In, 4 Analog Out IFD, Dual Points 1 to 4, 1 to 3
Baud Rate, 9 to 12, 17 to 20
Redundant
FBM23 ECB 13 24 Floating Point In HTG Points 1 to 24 1 to 3
FBM38 ECB 22 8 Floating Point In Coriolis Points 1 to 8 1
For FBM18, and 43, the primary measurements of the eight instruments are input on points 1 to
8 respectively (OCTNUM = 1), the first auxiliary measurements are on points 9 to 16 respec-
tively (OCTNUM = 2), and the second auxiliary measurements are on points 17 to 24 respec-
tively (OCTNUM = 3).
For FBM39, 44, and 46 the primary measurements of the four instruments are input on points
1 to 4 respectively (OCTNUM = 1), the first auxiliary measurements are on points 9 to 12
respectively (OCTNUM = 2), and the second auxiliary measurements are on points 17 to 20
respectively (OCTNUM = 3). Points 5 to 8 (OCTNUM = 1) contain the analog output readback
values and can be processed as described in Section .
You should configure the DEV_ID parameter of a parent ECB (12, 23, or 38R) with the letter-
bug of the associated FBM (18, 43, 39, 44, or 46). The DEV_ID of the MAIN block is a non-
configurable data store which always matches the DEV_ID of the parent ECB. The DEV_IDs of
the children ECB18s may be any 6-character arrays, and, after Release 4.0, are no longer required
to match the corresponding DEVNAM parameters.
The PARENT parameter of each child ECB18 is identical to the DEV_ID parameter of the par-
ent ECB (12, 23, or 38R) when the ECB is installed by the System Configurator/System Defini-
tion. If you install the children ECB18s manually via the Integrated Control Configurator, you
must set each PARENT parameter with the pathname to the NAME parameter of the parent
ECB (12, 23, or 38R). This pathname must be of the form
<local_compound_name>:<ecb_name> unless the parent is in the compound
<cp_letterbug>_ECB (the “ECB compound”), in which case the pathname <ecb_name> is also
acceptable. The DEV_ID of the parent is not accepted as the value of PARENT.
Intelligent Field Device inputs can also be read directly from child ECB18s by connecting the
Measurement 1 to 8 (MEAS_1 to MEAS_8) inputs of the MAIN block to certain ECB18 output
parameters. This method is described in Section .
The inputs from Intelligent Field Devices, HTG Interface Units, and Coriolis (Mass Flow) Trans-
mitters are floating point values which are normally expressed in the final output units specified
by EO1_x. However, you can apply characterization (see this topic in Section ), scaling (see
Section ), clamping (see Section ), and/or filtering (see Section ) if required by the application. If
you do not wish to apply characterization, you should set SCI_x to 0.
1452
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
In either case, you should set IOMOPT to 0 or 2. This causes the block inputs to be taken from
the Measurement 1 to 8 (MEAS_1 to MEAS_8) parameters, and the settings of IOM_ID,
DEV_ID, and OCTNUM are ignored.
In the process simulation application, you can connect any desired sources to MEAS_1 to
MEAS_8.
To take the block inputs from one or more Window ECBs, you should configure the source con-
nections to MEAS_1 to MEAS_8 in the format:
<compound_name>:<window_ecb_name>.<parameter>
where <compound_name> is the compound containing the Window ECB, <window_ecb_name>
is the NAME parameter of the Window ECB, and <parameter> is the measurement value to be
read.
The Window ECBs can be in any compound, and where there is a parent-child relationship (for
example, ECB12 and ECB18) the parent and child need not be in the same compound. If you are
reading inputs from several ECB18s, they need not have the same parent.
Each measurement in a Window ECB has two values:
♦ The “device value”, which is the actual measurement as reported by the instrument. It
is connectable but not settable.
♦ The “point value”, which is the device value after any desired bypassing, last good
value retention, or setting for simulation purposes. It is connectable and settable.
The measurements in an ECB18 or ECB22 follow the convention that the device values are
named IVALx, and the corresponding point values are named MEASx. The ECB13 has both
device and point values for each of its 24 measurements, but their names do not follow this con-
vention (See “Equipment Control Blocks” on page 793.)
If you set IOMOPT to 0, you can use any valid SCI_x values to condition the inputs, or use char-
acterization as described in Section If IOMOPT is set to 2, you may not use signal conditioning
or characterization, and the values of SCI_x and EXTBLK are ignored.
In either case (IOMOPT = 0, IOMOPT = 2) you can use scaling (see Section ), clamping (see
Section ) and/or filtering (see Section .)
Since the MEAS_x become inputs, the normal copying of the PNT_x outputs to the MEAS_x is
suspended.
1453
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
You do not ordinarily need to use scaling when linear/square root signal conditioning is applied,
since that already involves conversion into the final output units. (See Section and
“Appendix A – Signal Conditioning Tables” on page 1462.)
Similarly, if you use special thermocouple signal conditioning or characterization, you can define
the piecewise linear segments so as to accomplish final output unit conversion.
Pulse rate inputs should be converted into final output units by proper calculation of MTRF_1
through MTRF_8 (see Section ).
Inputs from Intelligent Field Devices are usually in final output units when received from the
devices themselves (see Section ).
Pulse count inputs cannot be scaled (see Section ).
To ignore the scaling function, leave KSCALE at the default value of 1 and leave BSCALE at the
default value of 0. The values of the scaling parameters KSCALE and BSCALE are applied uni-
formly to all implemented points within the octet.
Clamping
Key Parameters: HSCO1 to HSCO8, LSCO1 to LSCO8, OSV_1 to OSV_8, HOR_1 to
HOR_8, LOR_1 to LOR_8, LASTGV
Clamping keeps each linearized and converted value within that channel’s engineering units
range, as determined by HSCOx and LSCOx.
The scaled value for the channel is clamped as follows:
Compute the Low and High Clamp Values:
Low Clamp Value = LSCOx - ((OSV_x/100.0) * (HSCOx-LSCOx))
High Clamp Value = HSCOx + ((OSV_x/100.0) * (HSCOx-LSCOx))
If Scaled Value ≤ Low Clamp Value then:
Scaled Value = Low Clamp Value
Parameter Low Out-of-Range Point x (LOR_x) is set true
If BADOPT so specifies, parameter Bad Point x (BAD_x) is also set true.
If Scaled Value ≥ High Clamp Value then:
Scaled Value = High Clamp Value
Parameter High Out-of-Range Point x (HOR_x) is set true.
If BADOPT so specifies, parameter Bad Point x (BAD_x) is also set true.
Based on BADOPT, LASTGV, IOMOPT, and the SCI _x in use, the value is either used or
ignored, as described in Section .
Parameter OSV_x (Output Span Variance x) is provided to keep signals that are fluctuating right
at the high or low end of the range from continually setting and resetting the HOR_x or LOR_x
condition. There is not a traditional deadband effect however, since signals oscillating near the
high or low clamp value generate repeated HOR_x or LOR_x conditions.
The effect of clamping is shown in Figure 78-8.
1454
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
osv_x (units)
HSCOx
INPUT
LSCOx
osv_x (units)
osv_x (units)
HSCOx
HOR_x = 1
OUTPUT
LOR_x = 1
LSCOx
osv_x (units)
Filtering
Key Parameters: FLOP_1 to FLOP_8, FTIM_1 to FTIM_8
The clamped value of each channel in the octet is subjected to possible filtering, as the last signal
processing activity. Filtering introduces a lag to changes in the input signal, thus smoothing out
input changes or suppressing noise. Note that this feature should be used with caution to avoid
removing true process information.
NOTE
When an MAIN block is configured so that the MEAS_x parameters are connected
to blocks (as opposed to inputs from the field), filtering options have no effect when
the block is running in a CP40B. Regardless of how the filtering options are set, the
MAIN block running in a CP40B station does not filter the inputs if the MEAS
parameters are connected to another block.
If the block is in Auto and Filter Option x (FLOP_x) is non-zero, either first-order lag filtering
(FLOP_x = 1) or second-order Butterworth filtering (FLOP_x = 2) or two-sample-average filter-
ing (FLOP_x = 3) is applied. The lag that first or second-order filtering introduces has time con-
stant Filter Time x (FTIM_x). You can use it to attenuate measurement noise. However, if
FTIM_x is set too low, there is relatively insignificant filtering. If set too high, the lag may be large
enough to affect loop accuracy.
In addition, aliasing is minimized and resolution improved for all points in the octet by configur-
ing the RES parameter of the ECB so that the fieldbus integration time is equal to twice the block
period. (See the section “Fieldbus Integration Time” in Chapter 12 of the Integrated Control Soft-
ware Concepts [B0193AW] document.)
1455
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
OUTPUT
INPUT STEP
63% 100%
FTIM_x
1456
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
INPUT STEP
OUTPUT
FTIM_x
1457
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
Out-of-Range Conditions
Out-of-Range Due to Signal Conditioning
Key Parameters: HOR_1 to HOR_8, LOR_1 to LOR_8
Thermocouple Signal Conversion
If cold junction compensation is based on the FBM Point 9, FBM Point 15, or FBC Point 33
value, and the ohms value is outside of the limits of the SCI table 43 (100 ohms IEC), then
HOR_x or LOR_x is set true for every channel, depending on which limit was exceeded.
When the compensation reference has been converted to millivolts and added to the raw value
millivolts, the resulting sum is used to access the proper SCI table. If this sum is higher or lower
than the limits of the table, HOR_x or LOR_x is set true for the specific channel.
If the Special Thermocouple option is in use, when the sum of the reference value and raw value is
used to re-enter the characterizer, the entry is compared against the characterizer end-points. If
the entry value is outside the end-points, HOR_x or LOR_x is set true for the specific channel.
RTD Signal Conversion
When the raw value in ohms is higher or lower than the limits of the SCI table in use, parameters
HOR_x and LOR_x are handled as above.
Linear/Square Root Signal Conversion
The raw value is compared against the raw_low for this SCI_x as adjusted for the OSV_x in use.
If below this limit, LOR_x is set, and similarly for HOR_x if the upper limit is exceeded.
Characterizer Signal Conversion
The raw value is compared against the characterizer end-points. If the value is outside the end-
points, HOR_x and LOR_x are handled as above.
Out-of-Service Conditions
Key Parameters: PNT_1 to PNT_8, EXTBLK, MEAS
The out-of-service status of PNT_x is set true provided any one of the following conditions is
true:
♦ The FBM or FBC itself is out-of-service.
♦ The FBM is of HTG or IFD type and the connected point x is out-of-service, as indi-
cated by the status field of the point x.
♦ The EXTBLK parameter has out-of-service status, indicating an out-of-service
CHARC block.
When there is no connected FBM or FBC, the out-of-service status of PNT_x is always false.
1458
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
1459
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
LASTGV = 1
LASTGV = 0 BADOPT = 2
SCI_x = 0
IOMOPT = 1
osv_x (units)
HSCOx
Input Input
LSCOx
osv_x (units)
osv_x (units)
HSCOx
Output Output is the last
Output
good value read
HOR_x = 1 HOR_x =1 before Input went
out of range.
LSCOx
osv_x (units)
Manual Mode
When the MAIN block is in the Manual mode, it does not update the value of any PNT_x out-
put. All of the PNT_x outputs are released and become settable by you.
In Manual mode, the status bits (Bad, Out-of-Service, and Error) of the PNT_x outputs are not
updated, nor are any of the BAD_x parameters. The general BAD parameter is not updated. Since
they are not cleared, they retain their last values before the transition to Manual.
The PROPT parameter is inactive when the block is in Manual (that is, the Error bit of the
PNT_x status is not set based on various status bits of MEAS_x when no FBM or FBC is
connected).
Alarming
The MAIN block does not have internal facilities for alarming. You can use external alarm blocks
such as REALM for this purpose.
1460
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
Application Diagram
ECB1
OCTNUM
MAIN
Heated
Water
Steam HEAT
EXCHANGER Cold
Water
Heated
Water
Steam HEAT
EXCHANGER Cold
Water
Heated
Water
Steam
HEAT
EXCHANGER Cold
Water
IOM_ID = HE0101 KSCALE = 1.8 LSCO2 = 65.5
OCTNUM = 1 BSCALE = 32.0 HSCO2 = 200.0
SCI_1 = 42 LSCO1 =50.0 EO1_2 = Deg F.
SCI_2 = 41 HSCO1 = 210.0 LSCO3 = 65.5
SCI_3 = 41 EO1_1 = Deg F. HSCO3 = 200.0
EO1_3 = Deg F.
Figure 78-12. Typical MAIN Block Application
1461
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
1462
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
SCI = 0: No Linearization
Conditioned = Raw
SCI = 1: Linear (0 to 64000)
Analog Input 0 to 20mA
Conditioned = (Raw * (HSCOx-LSCOx) / 64000) + LSCOx
SCI = 2: Linear (1600 to 64000)
Analog Input 0 to 10 V dc
Conditioned = ((Raw-1600) * (HSCOx-LSCOx) / 62400) + LSCOx
SCI = 3: Linear (12800 to 64000)
Analog Input 4 to 20 mA
Conditioned = ((Raw-12800) * (HSCOx-LSCOx) / 51200) + LSCOx
SCI = 4: Square Root (0 to 64000)
Analog Input 0 to 20mA
Conditioned = (Sqrt (64000*Raw) * (HSCOx-LSCOx) / 64000) + LSCOx
SCI = 5: Square Root (12800 to 64000), Clamped
Analog Input 4 to 20 mA
If Raw ≤ 12800.0
Conditioned = LSCOx
Otherwise
Conditioned = (Sqrt (51200 * (Raw-12800)) * (HSCOx-LSCOx) / 51200) + LSCOx
SCI = 6: Square Root, Low Cutoff (0 to 64000), Clamped < 3/4%
Analog Input 0 to 20mA
If Raw ≤ 480
Conditioned = LSCOx
Otherwise
Conditioned = (Sqrt (64000*Raw) * (HSCOx-LSCOx) / 64000) + LSCOx
SCI = 7: Square Root, Low Cutoff (12800 to 64000), Clamped < 3/4%
Analog Input 4 to 20 mA
If Raw ≤ 13184
Conditioned = LSCOx
Otherwise
Conditioned = (Sqrt (51200 * (Raw-12800)) * (HSCOx-LSCOx) / 51200) + LSCOx
SCI = 8: Pulse Rate
Conditioned = Raw * MTRF * Pulse Constant
(Where Pulse Constant = 25000.0 / (65535.0*65535.0) = 0.582094373E-05 =
.00000582094373)
1463
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
1464
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
NOTE
x ranges from 1 through 8, depending on the point being conditioned.
1465
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
Hardware Type 201 202 203 204 205 206 207 211 212 213 217 241
Point
1 I I I I I I I I I I I I
2 I I I I I I I I I I I I
3 I I I I I I I I I I I I
4 I I I I I I I I I I I I
5 I I I O O I I I I I I I
6 I I I O O I I I I I I I
7 I I I O O I I I I I I I
8 I I I O O I I I I I I I
9 C I I I I O
10 I I I I O
11 I I I I O
12 I I I I O
13 I I I I O
14 I I I I O
15 I I C I O
16 I I I O
17 I
18 I
19 I
20 I
21 I
22 I
23 I
24 I
25 I
26 I
27 I
1466
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
Hardware Type 201 202 203 204 205 206 207 211 212 213 217 241
Point
28 I
29 I
30 I
31 I
32 I
Legend: I = Input
O = Readback from Output
C = Thermal Compensation Channel
Hardware
Type 1 2 3 4 5 6 17 18 22 23 33 36 37 38 39 43 44 46
Point
1 I I I I I I I I I I I I O I I I I I
2 I I I I I I I I O I I I O I I I I I
3 I I I I I I I I I I I O I I I I I
4 I I I I I I I I I I I O I I I I I
5 I I I O O O O I I I I O I O I O O
6 I I I O O O O I I I I O I O I O O
7 I I I O O O I I I I O I O I O O
8 I I I O O I I I I O I O I O O
9 C I C I I I
10 I I I I
11 I I I I
12 I I I I
13 I
14 I
15 I
16 I
17 I I I I
18 I I I I
19 I I I I
20 I I I I
21 I
22 I
23 I
1467
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
Hardware
Type 1 2 3 4 5 6 17 18 22 23 33 36 37 38 39 43 44 46
Point
24 I
25
26
27
28
29
30
31
32
33
Legend: I = Input
O = Readback from Output
C = Thermal Compensation Channel
Hardware Type 57 58 59 61 63 95
Point
1 I I I O I I
2 I I I O I I
3 I I I O I I
4 I I I O I I
5 I I I O I I
6 I I I O I I
7 I I I O I I
8 I I I O I I
9 I I I O I I
10 I I I O I I
11 I I I O I I
12 I I I O I I
13 I I I O I I
14 I I I O I I
15 I I I O I I
16 I I I O I I
17 I I I I
18 I I I I
19 I I I I
1468
78. MAIN – Multiple Analog Input Block B0193AX – Rev AA
Hardware Type 57 58 59 61 63 95
Point
20 I I I I
21 I I I I
22 I I I I
23 I I I I
24 I I I I
25 I I I I
26 I I I I
27 I I I I
28 I I I I
29 I I I I
30 I I I I
31 I I I I
32 I I I I
33 C C
Legend: I = Input
O = Readback from Output
C = Thermal Compensation Channel
NOTE
Hardware Type 57 is used for FBC21.
Hardware Type 58 is used for FBC01.
Hardware Type 59 is used for FBC17.
Hardware Type 61 is used for FBC04.
Hardware Type 63 is used for FBC02.
Hardware Type 95 is used for FBC02 Redundant.
1469
B0193AX – Rev AA 78. MAIN – Multiple Analog Input Block
1470
79. MATH – Mathematics Block
This chapter gives a general overview of MATH, or Mathematics Block, describes its basic
operations, features, parameters, and functions and provides instructions, error conditions,
programming concepts, and an application example.
Overview
The Mathematics (MATH) block provides mathematical programming capability and dual oper-
and efficiency in several mathematical instructions. Dual operands can reduce the length of a
CALC program which uses only single operands.
The configuration process allows you to program the block by entering a series of up to
20 programming steps. Each program step is represented by a parameter string of up to
16 characters.
Use the MATH block instead of the CALC, CALCA, or LOGIC block when mathematical func-
tions are required but engineering ranges and logic/timer functions are not. This conserves mem-
ory and reduces processor loading in the Control Processor.
Figure 79-2 shows the MATH block inputs and outputs (I/O).
Mathematical
8 Real Inputs Program 4 Real Outputs
(up to 20 steps;
configurable)
Program Error
Manual/Auto
Step Error
Figure 79-1. MATH Block I/O Diagram
The CALCA, CALC, MATH and LOGIC block features are summarized in Table 79-1.
1471
B0193AX – Rev AA 79. MATH – Mathematics Block
Basic Operation
The MATH block operates like most programmable pocket calculators. The block’s input/output
modularity and programming capacity provides a level of functionality that complements the
standard block set offering.
The program which you enter is executed once each time the MATH block executes. A single exe-
cution of the program is defined as a single consecutive execution of each program step in turn. It
is, however, possible to specify conditional execution of steps or groups of steps.
You can use the five internal memory registers (Mxx) to store:
♦ Data between block execution cycles
♦ Configured constants needed by various instructions
♦ Instruction arguments and/or results.
Every program step contains an opcode, which identifies the operation to be performed, and up to
two command line arguments. The command line arguments consist of the actual operands for
the step, the location of the operands, a specification of details that further refine the opcode, or
some combination of these factors. The syntax of each individual instruction is provided in
Section .
The MATH block can operate in the Auto or Manual mode. The operation of the block in Man-
ual is identical to the operation in Auto, except that any output parameters involved in the steps
are not modified by the block logic. They are released, and can be set only by you. Manual mode
is described in Section .
Features
♦ Provides 8 real inputs and 4 real outputs
♦ Provides 5 floating point memory data storage registers that are preserved between
execution cycles
♦ Uses a stack of 16 floating point values for storage of intermediate computational
results
1472
79. MATH – Mathematics Block B0193AX – Rev AA
Parameters
Table 79-2. MATH Block Parameters
1473
B0193AX – Rev AA 79. MATH – Mathematics Block
Parameter Definitions
ACHNGE A Change is a integer output that is incremented each time a settable
parameter is changed externally. It wraps around from 32767 to -32768.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the MATH block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
ON
MA
DEFINE Define is a boolean data store which when true indicates that the block
has no configuration errors. It is the inverse of UDEF in parameter BLK-
STA. When the block initializes, DEFINE is set to 0 (undefined) if the
block detects a parameter configuration error. To return DEFINE to a
true state, correct all configuration errors and re-install the block.
ERCODE Error Code is a string data store which indicates the type of configuration
error that 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. For the MATH block, the following is the only possible
1474
79. MATH – Mathematics Block B0193AX – Rev AA
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
♦ The compound in which it resides is turned on.
♦ The INITMA parameter itself is modified via the control configu-
rator. (The block does not assert INITMA on ordinary
reconfiguration.)
INITMA is ignored if MA has an established linkage.
LOCKID Lock Identifier is a string data store that identifies the workstation that has
exclusive write access to the block. LOCKID arbitrates write access to the
control block parameters by operator workstations on the network. Set
requests to any of the block’s parameters are only honored if the requesting
workstation’s identifier matches the contents of LOCKID.
The lock-request message sets LOCKRQ to true and sets LOCKID to the
identifier of the requesting workstation. The lock-release message clears
LOCKRQ and nulls LOCKID.
LOCKID has the format LETTERBUG:DEVNAME, where LETTER-
BUG is the 6-character letterbug of the workstation and DEVNAME is
the 6-character logical name of the Display Manager.
LOCKRQ Lock Request is a boolean data store that is set true or false by toggling the
LOCK U/L key on the Block Detail Display. An operator at any other
workstation can lock and unlock the block by toggling the LOCK U/L
key.
The lock-request message sets LOCKRQ true, sets LOCKID to the iden-
tifier of the requesting workstation, and sets the WLCK bit in the BLK-
STA parameter. Set requests to any of the block’s parameters are honored
only if the requesting workstation’s identifier matches the contents of
LOCKID.
The lock-release message resets LOCKRQ, nulls LOCKID, and resets the
WLCK bit.
NOTE
Do not set LOCKRQ with an application program.
1475
B0193AX – Rev AA 79. MATH – Mathematics Block
M01 to M05 Memory elements 1 through 5 are memory registers. They provide tempo-
rary storage for the result of any operation in the up-to-20-step MATH
block program. The values you configure are initial values for M01 to
M05. The MATH block program can overwrite this value with an STM
command.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
1476
79. MATH – Mathematics Block B0193AX – Rev AA
PERROR Program Error is a coded integer output that indicates the type of instruc-
tion syntax error or program runtime error that occurred in the step speci-
fied by the STERR parameter.
A non-zero value for PERROR indicates an error. A negative value gener-
ally indicates a syntax error, and a positive value generally indicates that an
error occurred while executing the program (that is, a runtime error). The
only exceptions to this convention are described in the CHN and PRO
instructions.
The syntax error codes for the PERROR parameter are:
Code Definition
-1 Invalid operation code
-2 Invalid operand type
-3 Out of range operand index
-4 Invalid go to step number
1477
B0193AX – Rev AA 79. MATH – Mathematics Block
PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. For a CP with a BPC of 0.5
s and a PERIOD of 2.0 s, the legal phase periods are 0, 1, 2, and 3. Refer
to the appropriate Integrated Control Software Concepts document
(B0700AG or B0193AW).
RI01 to RI08 Real Inputs 1 through 8 are inputs to the block calculations which can be
configured, linked to upstream blocks, or set when unlinked. The MATH
block does not have change delta parameters. When one of the RI01 to
RI08 parameters is the sink of a peer-to-peer connection, it will be
updated whenever the value at the source of the connection changes by
more than 0.0001 units.
RO01 to RO04 Real Outputs 1 through 4 are outputs from the block calculations. They
can be set when the block is in Manual.
STEP01 to STEP20
Steps 1 through 20 are string inputs of up to 16 characters. They are the
20 executable commands that make up the MATH block program.
STERR Step Error is an integer output that indicates which program step is exhib-
iting the error defined by PERROR.
TYPE Type is a system-level mnemonic label indicating the block type. Enter
MATH or select MATH from the block type list under Show when configur-
ing the block.
Functions
The MATH block provides 62 program instructions, consisting of the following general types:
♦ 23 arithmetic instructions that perform arithmetic, trigonometric, and logarithmic
calculations
♦ 12 Input/Output instructions that perform the input or output of data or status bits
♦ 1 Cascade instruction for downstream cascade acknowledgment
♦ 9 Memory and Stack Reference instructions for reading and writing the memory reg-
isters, or directly manipulating the stack
♦ 9 Program Control instructions for conditional and unconditional branching, and
program termination
♦ 8 Clear/Set instructions that provide for conditional or unconditional clearing or set-
ting of parameters, sometimes with simultaneous program control action.
Arithmetic Instructions
Most MATH block operations center about a 16-position push down stack of real data type val-
ues. The top position of this stack is referred to as the accumulator.
The arithmetic instructions operate on the accumulator value. Arithmetic operations do not con-
tribute rounding errors beyond one unit of the least significant decimal digit of a real, single pre-
cision, floating point value.
1478
79. MATH – Mathematics Block B0193AX – Rev AA
To minimize the number of arithmetic instructions, all arithmetic operations are performed in the
floating point domain. Integer arithmetic is not supported.
Data is always stored as a Real value (7 digit precision). The range of real values is 10-38 to 1038
for positive and negative numbers.
Each of the arithmetic operations utilize one or more inputs to the calculation, generically
referred to as operands. These inputs are obtained from various block parameters, the stack, and/or
the command line arguments of the instruction. Instructions using one input are designated
unary, those utilizing two inputs are designated dyadic, and those utilizing a variable number of
inputs are designated polyadic. Table 79-3 lists the arithmetic instructions.
1479
B0193AX – Rev AA 79. MATH – Mathematics Block
Cascade Instruction
The cascade instruction passes the initialization status of a MATH block real input parameter to
one of the real output parameters in order to propagate this status to a downstream block.
Table 79-5 lists the cascade instruction.
1480
79. MATH – Mathematics Block B0193AX – Rev AA
Clear/Set Instructions
Clear/set instructions allow you to clear or set a parameter value unconditionally, or set it condi-
tionally, depending on the accumulator value or the block initialization state. Table 79-8 lists the
clear/set instructions.
1481
B0193AX – Rev AA 79. MATH – Mathematics Block
Instructions
Instruction Processing
Auto Mode
During each block processing cycle while in Auto, the block executes each programmed step in
sequence, except for those steps bypassed because of branch conditions. When the program termi-
nates, block execution is complete and control is passed to the next block in the compound pro-
cessor list.
The program terminates when it reaches an END or EXIT statement or when it completes
Step 20, whichever occurs first.
Between instructions, the program stores intermediate results on a 16-position internal stack. You
can use stack values as arguments to subsequent instructions. The stack is cleared at the start of
each block execution cycle.
Manual Mode
In Manual, the block processes the program steps similar to the way it does in Auto, except that
output actions are ignored. When an instruction (for example, RCL) involves both writing to an
output and other actions, the block ignores writing to the output, but performs the other actions.
Figure 79-2 shows the actions performed by the instruction RCL RO01in Auto and Manual. The
read portion shown in Part 1 occurs unconditionally. The action of Part 2, which depends on the
Auto/Manual mode, then follows.
1482
79. MATH – Mathematics Block B0193AX – Rev AA
Part 1
Part 2 MA
MI
17.29 Clear O
Output
0.0 O O
A RO01
Instructions which modify memory registers M01 to M05 continue to execute normally while in
Manual. For example, if your program ramps a value in M01, the ramping continues while in
Manual.
Instruction Syntax
You enter the MATH block program through the Control Configurator. A program consists of a
series of string-type entries configured in parameters STEP01 through STEP20, each of which
defines a single program instruction.
Each MATH block instruction consists of a string of up to 16 alphanumeric characters, optionally
followed by a comment. The comments are ignored by the block logic, but you may find them
useful when writing, debugging, or reading a MATH program.
Rules
The following pseudo instructions show the generic instruction syntax:
operation; comment
operation number_of_stack_operands; comment
operation operand_1 operand_2; comment
operation operand_1; comment
As noted in Section , the instruction string comprises the opcode, followed by up to two com-
mand line arguments. Any comment must follow a semi-colon (;) character, and can contain any
alphanumeric or punctuation characters. No punctuation is allowed between arguments.
You can use blanks, including leading blanks, in the instruction, but they count as part of the 16-
character instruction string. You can use blanks:
♦ Before the opcode of a program step to indent the instruction
♦ Between the opcode and the first argument
♦ Between the first argument and the second argument
♦ Between the arguments and any comment you include.
1483
B0193AX – Rev AA 79. MATH – Mathematics Block
You can insert blank steps anywhere in a MATH block program prior to the END statement.
This makes it easier to make minor modifications in the block program without reconfiguring
each step in the program. When a blank step is found in the program, the block logic skips to the
next step without taking any action.
Constants
Some instructions allow a constant value as a command line argument. The instruction defini-
tions of Section use different letters to represent this constant, depending on the semantic mean-
ing of the constant, as follows:
s = step number
c = count of the number of stack values involved
n = integer value arithmetic operand
In all cases, the block expects the constant to be an integer. If you enter a non-integer value for the
constant, the block automatically truncates it to an integer before using it. There is no warning
message when this truncation occurs. Certain instructions permit a zero or negative integer value,
and this is indicated in the individual instruction descriptions. Truncation of negative real values
involves dropping the decimal portion and retaining the negative sign.
If your program requires the use of a constant operand of real type, you should store it in one of
the memory registers M01 to M05 at configuration time. For example, the instruction ADD RI01
M01 is valid, but ADD RI01 0.7 is invalid.
Instruction Operation
Unary arithmetic instructions operate on a single value (operand) stored in the accumulator,
which is located at the top of the stack. They store the result of the operation into the accumula-
tor, overwriting the original value. The stack pointer remains unchanged.
Diadic arithmetic instructions operate on two values. When there are no command line argu-
ments specified, they use the values at the top two locations of the stack; typically, the values are
pushed onto the stack by two instructions that immediately precede the diadic instruction. The
block decrements the stack pointer while performing the operation and stores the result in the
new accumulator location, overwriting the first of the two values. The second value is also lost
because it now resides in an inaccessible position one location above the top of the stack.
NOTE
The term first, when used in describing the location of stack operands, refers to the
one which has been pushed earlier. Since the stack “grows toward high memory”, an
earlier operand has a lower stack pointer value.
A polyadic arithmetic instruction operates on a variable number of operands, and all of them are
on the stack.
The detailed operation of each of the 62 instructions is specified in Section .
Stack Operation
If you specify a single operand (for example, RIxx) in the command line, the block pops the sec-
ond operand from the top of the stack and pushes the result onto the stack, overwriting the sec-
ond operand.
1484
79. MATH – Mathematics Block B0193AX – Rev AA
If you specify two operands (for example, RIxx and Mxx) in the command line, the block uses
them to perform the operation and pushes the result onto the stack.
Program Example 1 includes typical diadic instructions. Figure 79-3 shows the stack operation for
each program instruction.
Example 1:
STEP01 ADD RI01 RI02 Adds RI01 to RI02 and pushes the result (Sum1) onto stack.
STEP02 ADD RI03 RI04 Adds RI03 to RI04 and pushes the result (Sum2) onto stack.
STEP03 ADD Pops Sum2 and Sum1 from stack, performs addition, and
pushes the result (Sum3) onto stack.
STEP04 IN 4 Pushes constant “4” onto stack.
STEP05 DIV Pops “4” and Sum3 from stack, divides them, and pushes
Quotient onto stack.
S2 Sum2 S2 4
S1 Sum1 S1 Sum1 S1 Sum3 S1 Sum3 S1 Quotient
Stack
Registers
(up to 16)
LEGEND:
Stack Stack
Push Pop
When there are no command line arguments, the polyadic instructions operate on all values on
the stack. When the command line argument is a constant (c), they operate on the “c” operands at
the highest stack positions. These are the most recently-pushed values before the polyadic instruc-
tion is executed.
The block decrements the stack pointer as the operation is being performed and stores the result
in the new accumulator location (the new top of the stack location determined by the decre-
mented stack pointer), overwriting the first operand. All other operands are also lost because they
now reside in inaccessible registers located above the top of the stack. When fewer than all values
on the stack are used, those stack values remaining after the execution of the statement are not
lost.
1485
B0193AX – Rev AA 79. MATH – Mathematics Block
Program Example 2 includes a typical polyadic instruction (AVE). Figure 79-4 shows the stack
operation for each program instruction.
STEP01 IN RI01 Pushes RI01 value onto stack
STEP02 IN RI02 Pushes RI02 value onto stack
STEP03 IN RI03 Pushes RI03 value onto stack
STEP04 IN RI04 Pushes RI04 value onto stack
STEP05 AVE Pops Value4 to Value1 from stack, averages them, and
pushes Average onto stack
S4 Value4
S3 Value3 S3 Value3
S2 Value2 S2 Value2 S2 Value2
S1 Value1 S1 Value1 S1 Value1 S1 Value1 S1 Average
Stack
Registers
(up to 16)
LEGEND:
Stack Stack
Push Pop
1486
79. MATH – Mathematics Block B0193AX – Rev AA
♦ The opcode ADD with integer constant c as the only command line
argument. This pops the c quantity of values at the top of the
stack, adds them, and pushes the result onto the stack. The
popped values are lost.
♦ The opcode ADD with exactly one of the operands RIxx, ROxx, or
Mxx. This pops the value at the top of the stack, adds the specified
operand to it, and pushes the result onto the stack. The popped
value is lost.
NOTE
Note that when operands are enclosed in curly brackets, you must select exactly one
from the group.
♦ The opcode ADD with exactly one operand from the group {RIxx,
ROxx, Mxx} followed by exactly one operand from the group {n,
RIxx, ROxx, Mxx}, for example, ADD RO01 M02. This adds the
two specified operands and pushes the result onto the stack.
NOTE
Commas are not allowed between the two operands. Commas are never valid in
command lines, except within comment fields.
Following the syntax specifications, are the English-language meaning of the opcodes, for exam-
ple, (Add) and the description and examples for the instruction’s use.
The location of the stack pointer after the execution of an instruction is indicated by an italicized
expression such as the following: sptr(after) = sptr(before) + 1. This means that the stack pointer
after the instruction has executed is one higher than it was before. Since the stack grows toward
high memory, this means that a value has been pushed onto the stack by the instruction.
Similarly, the expression sptr(after) = sptr(before) - 1 means that one value has been popped off the
stack by the instruction. The polyadic instructions finish with the stack pointer in the first posi-
tion of the stack, which is referred to as stackbottom.
One instruction, CST, finishes with the stack pointer one position lower than stackbottom, with
the pointer waiting for the first push. After CST, sptr(after) = stackbottom -1.
Instruction Definitions
The MATH block instructions are defined below in alphabetical order.
NOTE
The examples show the program step number preceding the instruction, that is, in
the instruction 17 ABS, 17 is the step number.
1487
B0193AX – Rev AA 79. MATH – Mathematics Block
Example 2:
Accumulator = -0.5000
11 ACOS Compute arc cosine of accumulator
Accumulator = 2.0944 (2*Pi/3) radians; (2*Pi/3 radians =
120 degrees)
ADD
ADD c
ADD {RIxx, ROxx, Mxx}
ADD {RIxx, ROxx, Mxx} {n, RIxx, ROxx, Mxx}
(Add)
ADD reads the values from the top two stack locations, adds them, decre-
ments the stack pointer, and writes the sum into the new accumulator
location (the new top of stack location). This overwrites the first operand
and isolates the second operand from any further access. sptr(after) =
sptr(before) - 1.
ADD c reads the top c values from the stack, adds them, writes the sum
into the c’th position from the top of the stack, and sets the new top of the
stack (the accumulator) to this position. sptr(after) = sptr(before) - c + 1.
1488
79. MATH – Mathematics Block B0193AX – Rev AA
NOTE
Values of n outside of this range will cause the block to go undefined with a config-
uration error in the appropriate step.
ADD RIxx Mxx reads the values stored in RIxx and Mxx, adds them, and
stores the result on the stack. Similarly when ROxx or Mxx is the first
operand or RIxx or ROxx is the second operand. sptr(after) = sptr(before) +
1.
Example:
RI01 = 12.3485
M01 = 3.73182
12 ADD RI01 M01 Adds RI01 to M01 and pushes the result onto
the stack
Accumulator = 16.08032
ALN (Natural Antilog)
ALN reads the value in the accumulator, computes the natural antiloga-
rithm (base e) of the value, and writes the result to the accumulator, over-
writing the original contents. sptr(after) = sptr(before).
Example:
Accumulator = +0.69347
11 ALN Compute natural antilogarithm of accumulator
Accumulator = +2.0000
ALOG (Common Antilog)
ALOG reads the value in the accumulator, computes the base 10 antiloga-
rithm of the value, and writes it to the accumulator, overwriting the origi-
nal contents. sptr(after) = sptr(before).
1489
B0193AX – Rev AA 79. MATH – Mathematics Block
Example 1:
Accumulator = +1.30103
11 ALOG Compute common antilog of accumulator
Accumulator = +20.0000
Example 2:
Accumulator = -3.00000
11 ALOG Compute common antilog of accumulator
Accumulator = +0.00100
ASIN (Arc Sine)
ASIN reads the value (sine function value) in the accumulator and com-
putes the value, in radians, of the first or fourth quadrant angle that has
this sine value. It then stores the angle value into the accumulator, over-
writing the original sine value, which must have an absolute value equal to
or less than one. sptr(after) = sptr(before).
An attempt to ASIN a value > 1 or < -1 causes the instruction to be
skipped and writes a “2” (ASIN runtime error) to the PERROR
parameter.
Example 1:
Accumulator = 0.7071
11 ASIN Compute arc sine of accumulator
Accumulator = +.7853983 (Pi/4) radians; (Pi/4 radians =
45 degrees)
Example 2:
Accumulator = -0.5000
11 ASIN Compute arc sine of accumulator
Accumulator = -.5236 (-Pi/6) radians; (-Pi/6 radians =
-30 degrees)
ATAN (Arc Tangent)
ATAN reads the value (tangent function value) in the accumulator, com-
putes the value, in radians, of the first or fourth quadrant angle that has
this tangent value. It then stores the angle value into the accumulator,
overwriting the original tangent value. sptr(after) = sptr(before).
Example 1:
Accumulator = 1.000
11 ATAN Compute arc tangent of accumulator
Accumulator = +.7853983 (Pi/4) radians; (Pi/4 radians =
45 degrees)
1490
79. MATH – Mathematics Block B0193AX – Rev AA
Example 2:
Accumulator = -0.5000
11 ATAN Compute arc tangent of accumulator
Accumulator = -.4636476 radians
AVE
AVE c
AVE {RIxx, ROxx, Mxx}
AVE {RIxx, ROxx, Mxx} {n, RIxx, ROxx, Mxx}
(Average)
AVE reads all the values from the stack, computes the mean algebraic
value, decrements the stack pointer, and writes this value into the new
accumulator location (the new top of stack location). This overwrites the
first operand and isolates the other operands from any further access.
sptr(after) = stackbottom.
AVE c reads the top c values from the stack, computes the mean algebraic
value of the c topmost values on the stack, writes this value into the c’th
position from the top of the stack, and sets the new top of the stack (the
accumulator) to this position. sptr(after) = sptr(before) - c + 1.
If c exceeds the current number of stack operands, a “6” (stack underflow
runtime error) is written to the PERROR parameter.
AVE RIxx reads the value stored in RIxx (the MATH’s Real Input param-
eter xx), computes the mean algebraic value of the RIxx value and the
value that it pops from the stack, and then pushes the result onto the
stack. AVE ROxx and AVE Mxx do the same for the values stored at ROxx
and memory location xx, respectively. sptr(after) = sptr(before).
AVE RIxx Mxx reads the values stored in RIxx and Mxx, computes the
mean algebraic value of the RIxx and Mxx values, and stores the result on
the stack. Whenever both operands are specified, the mean algebraic value
of the first and second operand is computed. sptr(after) = sptr(before) + 1.
AVE RIxx n reads the value stored in RIxx and a specified integer con-
stant (n), computes the mean algebraic value of RIxx and “n”, and stores
the result on the stack. If the first operand is ROxx or Mxx, the operation
is similar. sptr(after) = sptr(before) + 1.
Example 1:
11 CST Clears the stack
RI01 = 12.3485
RI02 = 3,73182
RI03 = -2.0037
RI04 = -0.8369
12 IN RI01 Pushes RI01 onto stack
13 IN RI02 Pushes RI02 onto stack
14 IN RI03 Pushes RI03 onto stack
15 IN RI04 Pushes RI04 onto stack
1491
B0193AX – Rev AA 79. MATH – Mathematics Block
16 AVE Pops all the values from the stack, calculates the
mean algebraic value for them, and pushes the result
onto the stack, overwriting the RI01 value. The
other values are inaccessible.
Accumulator = 3.30993
Example 2:
RI01 = 12.3485
M01 = 3.73182
11 AVE RI01 M01 Calculates the mean algebraic value for RI01
and M01 and pushes the result onto the stack
Accumulator = 8.04016
BII s (Branch If Initializing)
BII s branches to the step number designated by s if the MATH block is
initializing this execution cycle. sptr(after) = sptr(before).
An attempt to branch to a step number ≤ current step number or > step
number containing the END statement (20 if there is no END step) writes a
“-4” (invalid goto syntax error) to the PERROR parameter.
BIN s (Branch If Negative)
BIN s branches to the step number designated by s if the value in the
accumulator (the current top of stack location) is less than 0.0. sptr(after)
= sptr(before).
An attempt to branch to a step number ≤ current step number or > step
number containing the END statement (20 if there is no END step) writes a
“-4” (invalid goto syntax error) to the PERROR parameter.
BIP s (Branch If Positive or Zero)
BIP s branches to the step number designated by s if the value in the
accumulator (the current top of stack location) is greater than or equal to
0.0. sptr(after) = sptr(before).
An attempt to branch to a step number ≤ current step number or > step
number containing the END statement (50 if there is no END step) writes a
“-4” (invalid goto syntax error) to the PERROR parameter.
BIZ s (Branch If Zero)
BIZ s branches to the step number designated by s if the value in the
accumulator (the current top of stack location) is 0.0. sptr(after) =
sptr(before).
An attempt to branch to a step number ≤ current step number or > step
number containing the END statement (20 if there is no END step) writes a
“-4” (invalid goto syntax error) to the PERROR parameter.
CBD ROxx (Clear Bad Status)
CBD clears the Bad status bit of the specified output parameter to false. Its
effect is identical in Auto or Manual mode. sptr(after) = sptr(before).
1492
79. MATH – Mathematics Block B0193AX – Rev AA
Example 2:
Accumulator = +.1086372
11 CHS Change sign of accumulator
Accumulator = -.1086372
CLA (Clear All Memory Registers)
CLA clears all five memory registers. sptr(after) = sptr(before).
1493
B0193AX – Rev AA 79. MATH – Mathematics Block
It is, however, recommended that you issue a CST instruction just before
setting up operands for a polyadic instruction, since polyadic instructions
operate on all values currently pushed onto the stack. sptr(after) = stackbot-
tom - 1.
DEC
DEC n
DEC {ROxx, Mxx}
(Decrement)
DEC with a blank operand reads the value in the accumulator, algebraically
decreases it by 1.0, and returns the results to the accumulator, overwriting
the original contents.
DEC n reads the value in the accumulator, algebraically decreases it by the
integer n, and returns the results to the accumulator.
DEC Mxx reads the value in memory location Mxx, algebraically decreases
it by 1.0, and returns the result to Mxx.
DEC ROxx reads the value stored at ROxx, algebraically decreases it by 1.0,
and returns the result to ROxx, but only if the block is in Auto. In Manual
the block skips this step.
The stack is unaffected when the operand is other than blank or n. In all
cases, sptr(after) = sptr(before).
Example 1:
RI01 = -5.23
10 IN RI01 Pushes RI01 onto top of stack (accumulator)
11 DEC 2 Decrement accumulator by 2
Accumulator = -7.23 (that is, -5.23 - 2.0)
Example 2:
M02 = 11.2
11 DEC M02 Decrement M02
M02 = 10.2
DIV
DIV {RIxx, ROxx, Mxx}
DIV {RIxx, ROxx, Mxx} {n, RIxx, ROxx, Mxx}
(Divide)
DIV reads the values from the top two stack locations, divides the second
operand (divisor) into the first operand (dividend), decrements the stack
pointer, and writes the quotient into the new accumulator location (the
new top of stack location). This overwrites the first operand and isolates
the second operand from any further access. sptr(after) = sptr(before) - 1.
DIV RIxx reads the value stored in RIxx (the MATH’s Real Input param-
eter xx) as the divisor, divides the value (the dividend) that it pops from
the stack, then pushes the result back onto the stack. DIV ROxx and DIV
Mxx do the same for the values stored at ROxx and memory location xx,
respectively. sptr(after) = sptr(before).
1494
79. MATH – Mathematics Block B0193AX – Rev AA
DIV RIxx Mxx reads the values stored in RIxx and Mxx, divides the RIxx
value by the Mxx value, and stores the result on the stack. Whenever both
operands are specified, the first operand is divided by the second operand.
sptr(after) = sptr(before) + 1.
DIV RIxx n reads the value stored in RIxx and a specified integer con-
stant n, divides the RIxx value by n, and stores the result on the stack. If
the first operand is ROxx or Mxx, the operation is similar. sptr(after) =
sptr(before) + 1.
The range of n is 0 to 127.
NOTE
Values of n outside of this range will cause the block to go undefined with a config-
uration error in the appropriate step.
1495
B0193AX – Rev AA 79. MATH – Mathematics Block
EXP with blank operand reads the values from the top two stack locations,
raises the first operand (base) to the power of the second operand (expo-
nent), decrements the stack pointer, and writes the result into the new
accumulator location (the new top of stack location). This overwrites the
first operand and isolates the second operand from any further access.
sptr(after) = sptr(before) - 1.
EXP RIxx reads the value stored in RIxx, raises the value that it pops from
the stack to the power of RIxx value, then pushes the result back onto the
stack. EXP ROxx and EXP Mxx do the same for the values stored at ROxx
and memory location xx, respectively. sptr(after) = sptr(before).
EXP RIxx ROxx reads the values stored in RIxx and ROxx, raises the RIxx
value to the power of ROxx value, and pushes the result on the stack. Sim-
ilarly for the cases where the first operand is of type ROxx or Mxx, or the
second operand is of type RIxx or Mxx. sptr(after) = sptr(before) + 1.
EXP RIxx n reads the value stored in RIxx and the specified integer con-
stant n, raises the RIxx value to the power of n, and pushes the result on
the stack. If the first operand is ROxx or Mxx, the operation is similar.
sptr(after) = sptr(before) + 1.
Whenever both operands are specified, the first operand is raised to the
power of the second operand.
An attempt to EXP a negative value (base less than 0) causes the value of
the specified exponent to be written to the stack location that would have
contained the final result, if the operation had been successful. A “9”
(EXP runtime error) is written to the PERROR parameter.
If the base is 0 and the exponent is less than or equal to 0, the result of the
operation is 0.0. PERROR is not set.
Example:
RI01 = 1.483
M01 = 3.10
12 EXP RI01 M01 Raises RI01 to the power of M01 and pushes the
result on the stack
Accumulator = +3.392638
GTI (Go To Indirect)
GTI Mxx
GTI branches to the step number contained in the accumulator. GTI Mxx
branches to the step number specified by the current contents of Mxx.
When the destination is in an operand of real data type (accumulator or
Mxx), the operand contents are truncated to an integer before use.
sptr(after) = sptr(before).
An attempt to branch to a step number ≤ current step number or > step
number containing the END statement (20 if there is no END step) writes a
“10” (index runtime error) to the PERROR parameter.
GTO s (Go To)
GTO s branches to the step number designated by s. sptr(after) =
sptr(before).
1496
79. MATH – Mathematics Block B0193AX – Rev AA
Example 2:
M02 = 11.2
11 INC M02 Increments M02 by 1
M02 = 12.2
INR (Input Indexed Real)
INR Mxx
INR with a blank operand reads the value in the accumulator, truncates it
to an integer, and uses the result as the index of the RIxx parameter to be
read. The value of RIxx is then pushed onto the stack.
INR Mxx reads the value in Mxx, truncates it to an integer, and uses the
result as the index of the RIxx parameter to be read. The value of RIxx is
then pushed onto the stack.
In all cases, sptr(after) = sptr(before) + 1.
1497
B0193AX – Rev AA 79. MATH – Mathematics Block
If the value of the index (the contents of the accumulator or Mxx) is less
than 1 or greater than 8, a “10” (index runtime error) is written to the
PERROR parameter.
Example 1:
M01 = 5.23
RI05 = 12.3485
10 INR M01 Reads M01, truncates it to 5, reads RI05, and
pushes it onto stack
Accumulator = 12.3485
INS {RIxx, (Input Status)
ROxx}
INS pushes the 16-bit status of the specified input or output parameter
onto the stack. The status value is not modified. sptr(after) = sptr(before) +
1.
The status integer is made up of the following fields:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number Boolean Connection
(0 to 15) Definition (B16 to B1)
0 to 4 DATA TYPE: B16 to B12
1 = character
2 = integer
3 = real
4 = string
5 = boolean
6 = long integer
7 (unused)
8 = short integer
9 = packed boolean
10 = packed long
5 to 7 OM Status: B11 to B9
0 = No Response
1 = On Scan
2 = Disconnect
3 = Deleted
4 = Nonconnect
5 (unused)
6 (unused)
7 = Not sent
8 Bad B8
9 Secure/Release B7
10 Acknowledge B6
11 Out of Service B5
1498
79. MATH – Mathematics Block B0193AX – Rev AA
Example of the status for a Real value that is On Scan with Bad status:
Bit 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
Boolean
B1
B2
B3
B4
B5
B6
B7
B8
B9
Status 0 0 0 0 0 0 0 1 0 0 1 0 0 0 1 1
Example:
RI01 Status value = 291
10 INS RI01 Reads RI01 Status value and pushes it onto stack
Accumulator = 291.
LACI Mxx (Load Accumulator Indirect)
LACI Mxx loads the accumulator with the contents of a memory register
indexed by the contents of the memory register specified by the Mxx oper-
and, where xx is an index from 01 to 05 (or 1 to 5). Neither memory reg-
ister is affected.
If Mxx does not contain an integer value, the truncated contents are used
as the index.
If the specified memory contents are less than 1 or greater than 5, a “10”
(index runtime error) is written to the PERROR parameter at runtime.
sptr(after) = sptr(before) + 1.
1499
B0193AX – Rev AA 79. MATH – Mathematics Block
Example 2:
Accumulator = +0.130570
11 LN Compute natural logarithm of accumulator
Accumulator = 2.035846
LOG (Common Logarithm)
LOG reads the value (which must be positive) in the accumulator, com-
putes the common (base 10) logarithm of the value, and writes the result
to the accumulator, overwriting the original contents. sptr(after) =
sptr(before).
An attempt to execute this instruction with a zero or negative value in the
accumulator causes the instruction to be skipped and writes a “7” (LOG
runtime error) to the PERROR parameter.
Example 1:
Accumulator = +2000.00
11 LOG Compute common logarithm of accumulator
Accumulator = +3.30103
Example 2:
Accumulator = +0.02000
11 LOG Compute common logarithm of accumulator
Accumulator = -1.69897
1500
79. MATH – Mathematics Block B0193AX – Rev AA
MAX
MAX c
MAX {RIxx, ROxx, Mxx}
MAX {RIxx, ROxx, Mxx} {n, RIxx, ROxx, Mxx}
(Maximum)
MAX reads all the values from the stack, selects the maximum algebraic
value, decrements the stack pointer, and writes this value into the new
accumulator location (the new top of stack location). This overwrites the
first operand and isolates other operands from any further access.
sptr(after) = stackbottom.
MAX c reads the top c values from the stack, selects the maximum alge-
braic value from the c topmost values on the stack, writes this value into
the c’th position from the top of the stack, and sets the new top of the
stack (the accumulator) to this position. sptr(after) = sptr(before) - c + 1.
If c exceeds the current number of stack operands, a “6” (stack underflow
runtime error) is written to the PERROR parameter.
MAX RIxx reads the value stored in RIxx (the MATH’s Real Input param-
eter xx), selects the maximum algebraic value from the RIxx value and the
value that it pops from the stack, and then, pushes the result onto the
stack. MAX ROxx and MAX Mxx do the same for the values stored at ROxx
and memory location xx, respectively. sptr(after) = sptr(before).
MAX RIxx Mxx reads the values stored in RIxx and Mxx, selects the maxi-
mum algebraic value from the RIxx and Mxx values, and stores the result
on the stack. Whenever both operands are specified, the
maximum algebraic value is selected from the first and second operands.
sptr(after) = sptr(before) + 1.
MAX RIxx n reads the value stored in RIxx and a specified integer con-
stant (n), selects the maximum algebraic value from RIxx and n, and stores
the result on the stack. If the first operand is ROxx or Mxx, the operation
is similar. sptr(after) = sptr(before) + 1.
Example 1:
11 CST Clears the stack
RI01 = 12.3485
RI02 = 3.73182
RI03 = -2.0037
RI04 = -0.8369
12 IN RI01 Pushes RI01 onto stack
13 IN RI02 Pushes RI02 onto stack
14 IN RI03 Pushes RI03 onto stack
15 IN RI04 Pushes RI04 onto stack
16 MAX Selects the maximum algebraic value (12.3485)
from the stack, collapses the stack, and pushes this
value onto the stack.
Accumulator = 12.3485
1501
B0193AX – Rev AA 79. MATH – Mathematics Block
Example 2:
RI01 = 12.3485
M01 = 3.73182
11 MAX RI01 M01 Selects the maximum algebraic value from RI01
and M01 and pushes the result onto stack.
Accumulator = 12.3485
MEDN (Median)
MEDN reads all the values from the stack, determines the median value,
decrements the stack pointer, and writes this value into the new accumula-
tor location (the new top of stack location). This overwrites the first oper-
and and isolates the other operands from any further access.
The stack values are first arranged conceptually in ascending order. Then
the median is the middle value if the number of operands is odd, or the
average of the two middle values if the number of operands is even.
sptr(after) = stackbottom.
Example:
11 CST Clears the stack
RI01 = 12.3485
RI02 = 3.73182
RI03 = -2.0037
RI04 = -0.8369
12 IN RI01 Pushes RI01 onto stack
13 IN RI02 Pushes RI02 onto stack
14 IN RI03 Pushes RI03 onto stack
15 IN RI04 Pushes RI04 onto stack
16 MEDN Computes the average of the two middle values
(3.73182 and -0.8369) on the stack, collapses the
stack, and pushes this value onto the stack
Accumulator = 1.44746
MIN
MIN c
MIN {RIxx, ROxx, Mxx}
MIN {RIxx, ROxx, Mxx} {n, RIxx, ROxx, Mxx}
(Minimum)
MIN reads all the values from the stack, selects the minimum algebraic
value, decrements the stack pointer, and writes this value into the new
accumulator location (the new top of stack location). This overwrites the
first operand and isolates the other operands from any further access.
sptr(after) = stackbottom.
MIN c reads the top c values from the stack, selects the minimum alge-
braic value from the c topmost values on the stack, writes this value into
the c’th position from the top of the stack, and sets the new top of the
stack (the accumulator) to this position. sptr(after) = sptr(before) - c + 1.
1502
79. MATH – Mathematics Block B0193AX – Rev AA
Example 2:
RI01 = 12.3485
M01 = 3.73182
11 MIN RI01 M01 Selects the minimum algebraic value from RI01
and M01 and pushes the result onto the stack
Accumulator = 3.73182
1503
B0193AX – Rev AA 79. MATH – Mathematics Block
MUL
MUL c
MUL {RIxx, ROxx, Mxx}
MUL {RIxx, ROxx, Mxx} {n, RIxx, ROxx, Mxx}
(Multiply)
MUL reads the values from the top two stack locations, multiplies them,
decrements the stack pointer, and writes the product into the new accu-
mulator location (the new top of stack location). This overwrites the first
operand and isolates the second operand from any further access.
sptr(after) = sptr(before) - 1.
MUL c reads the top c values from the stack, multiplies them, writes the
product into the c’th position from the top of the stack, and sets the new
top of the stack (the accumulator) to this position. sptr(after) = sptr(before)
- c + 1.
If c exceeds the current number of stack operands, a “6” (stack underflow
runtime error) is written to the PERROR parameter. The same action
occurs if MUL has no operand and there is only one value on the stack.
MUL RIxx reads the value stored in RIxx (the MATH’s Real Input param-
eter xx), multiplies it with the value that it pops from the stack, then
pushes the result back on the stack. MUL ROxx and MUL Mxx do the same
for the values stored at ROxx and memory location xx, respectively.
sptr(after) = sptr(before).
MUL RIxx Mxx reads the values stored in RIxx and Mxx, multiplies the
RIxx value by the Mxx value, and stores the result on the stack.
Whenever both operands are specified, the first operand is multiplied by
the second operand. sptr(after) = sptr(before).
MUL RIxx n reads the value stored in RIxx and a specified integer con-
stant (n), multiplies the RIxx value by n, and stores the result on the stack.
If the first operand is ROxx or Mxx, the operation is similar. sptr(after) =
sptr(before).
Example 1 – Calculate (RI01 * M01):
RI01 = 12.3485
M01 = 3.73182
12 MUL RI01 M01 Multiplies RI01 by M01 and pushes the result
onto stack
Accumulator = 46.08238
1504
79. MATH – Mathematics Block B0193AX – Rev AA
15 SUB RI03 RI04 Subtracts RI04 from RI03 and pushes the result
onto the stack
Accumulator = 3.72
16 MUL Pops the top two values from the stack,
multiplies them, and pushes the result
(16.08032 * 3.72 = 59.81879) onto the stack
Accumulator = 59.81879
17 OUT RO01 Writes the value (59.81879) in the accumulator
(top of the stack) to the RO01 parameter
NOP (No Operation)
NOP causes the step to be ignored. The program continues with the next
instruction. sptr(after) = sptr(before).
OUT {ROxx, Mxx} (Output)
OUT ROxx writes the accumulator contents to the ROxx output when the
block is in Auto. In Manual, this instruction is skipped without changing
the value of ROxx.
OUT Mxx writes the accumulator contents to memory location Mxx. This
operation is executed in Auto and Manual.
The contents or location of the accumulator is not altered. sptr(after) =
sptr(before).
Example:
Accumulator = 3.1416
OUT M02 Writes accumulator value to memory location M02
OUT RO02 Writes accumulator value to output RO02
M02 = 3.1416
RO02 = 3.1416
POP (Pop Stack)
POP removes the value at the top of the stack and discards it. The stack
pointer is decremented to point to the next value on the stack. sptr(after) =
sptr(before) - 1.
PRO ROxx (Propagate Downstream)
PRO ROxx allows you to propagate the cascade acknowledgment from a
specified RIxx input to the specified ROxx output. The RIxx input index
is loaded onto the stack by a prior instruction, and popped from the stack
when it is used. sptr(after) = sptr(before) - 1.
This instruction copies the PRIBLK initialization acknowledgment bit
(the Acknowledge status bit) from RIxx to ROxx.
If the popped index value for RIxx < 1 or > 8, a “-3” (out-of-range
syntax error value, treated as a runtime error) is written to the PERROR
parameter.
1505
B0193AX – Rev AA 79. MATH – Mathematics Block
Example:
11 IN 5 Pushes “5” onto the stack to specify that RI05 will be
used by the PRO instruction
12 PRO RO03 Propagates the PRIBLK initialization acknowledg-
ment bit in RI05 to real output RO03
RBD {RIxx, ROxx}
(Read Bad and OOS Bits)
RBD reads both the Out-of-Service and Bad status bits of the specified
parameter and writes the value 1 to the accumulator if either of the bits is
set. If neither bit is set, the value 0 is written to the accumulator. sptr(after)
= sptr(before) + 1.
RCL {RIxx, ROxx, Mxx}
(Read and Clear)
RCL RIxx pushes the contents of RIxx onto the stack. If RIxx is not
linked, this instruction then writes a 0.0 to RIxx; otherwise it does not
change RIxx.
RCL ROxx pushes the contents of ROxx onto the stack. If the MATH
block is in Auto, this instruction then writes a 0.0 to ROxx; otherwise it
does not change ROxx.
RCL Mxx pushes the contents of Mxx onto the stack and writes 0.0 to
Mxx.
In all cases, sptr(after) = sptr(before) + 1.
REL ROxx (Clear Secure Status)
REL ROxx clears the Secure status bit of the specified output parameter to
false, thereby releasing it and making it settable. Its effect is identical in
Auto or Manual. The effect of REL overrides that of MA. sptr(after) =
sptr(before).
RQE RIxx (Read Quality and Error Status)
RQE RIxx reads the Bad, Out-of-Service, and Error status bits and the
OM status field of the specified input. It writes the value 1 to the accumu-
lator if any of these three bits is set or if the OM status field does not have
the value “ON_SCAN”. In any other case, it writes the value 0 to the
accumulator. sptr(after) = sptr(before) + 1.
RQL RIxx (Read Quality Status)
RQL RIxx reads the Bad and Out-of-Service status bits and the OM status
field of the specified input. It writes the value 1 to the accumulator if
either of the two bits is set or if the OM status field does not have the
value “ON_SCAN”. In any other case, it writes the value 0 to the accu-
mulator. sptr(after) = sptr(before) + 1.
SBD ROxx (Set Bad Status)
SBD ROxx sets the Bad status bit of the specified output parameter to true.
Its effect is identical in Auto or Manual. sptr(after) = sptr(before).
1506
79. MATH – Mathematics Block B0193AX – Rev AA
1507
B0193AX – Rev AA 79. MATH – Mathematics Block
1508
79. MATH – Mathematics Block B0193AX – Rev AA
1509
B0193AX – Rev AA 79. MATH – Mathematics Block
SWP
SWP {ROxx, Mxx}
(Swap)
SWP with no operand swaps the contents of the last two stack locations.
The stack pointer is not moved.
SWP ROxx swaps the contents of the last position on the stack with that of
output ROxx. If the block is not in Auto, the value of ROxx is copied to
the stack, but the stack value is not copied to ROxx.
SWP Mxx swaps the contents of the last position on the stack with that of
memory location Mxx.
In all cases, sptr(after) = sptr(before).
TAN (Tangent)
TAN reads the value (value of the angle in radians) in the accumulator,
computes the tangent of the angle, and writes the result into the accumu-
lator, overwriting the original contents. sptr(after) = sptr(before).
Example:
Accumulator = +.7853983 (Pi/4) radians; (Pi/4 radians =
45 degrees)
11 TAN Compute tangent of accumulator
Accumulator = +1.0000
Error Conditions
For each instruction, the specified operation code (for example. ADD or RCL) and operands,
including the index ranges of the operands (xx), are validated when the MATH block is installed
or modified by the Control Configurator. An invalid operation code or operand causes the block
to be undefined. An error message indicating the type of syntax error and the step in error is sent
to the Control Configurator and displayed on the screen.
Two types of errors are detected by the MATH block:
♦ Syntax errors – those detected when the program is validated, as the block is installed
or modified.
♦ Runtime (dynamic) errors – those detected while the program is running. Note that
these errors do not cause the program to halt.
An integer code stored in the output parameter PERROR indicates the type of the first detected
error.
The output parameter STERR indicates the number of the program step that experienced the first
error.
Displaying the automatically-updated runtime values of PERROR and STERR at the display
interface will enable you to monitor these parameters while in the debugging phase of the MATH
program development.
Syntax errors are detected when the MATH block is installed or reconfigured, but not when the
compound is turned ON, or when the control processor is rebooted. This avoids control cycle
overruns that might occur if validation of complex MATH blocks were to be done during ordi-
1510
79. MATH – Mathematics Block B0193AX – Rev AA
nary block processing. Configuration errors generate screen messages that users can view and act
upon for correction while configuring the block, without interrupting the configuration session.
A non-zero value for PERROR indicates an error. A negative value generally indicates a syntax
error, and a positive value generally indicates that an error occurred while executing the program
(that is, a runtime error). The only exceptions to this convention are described in the CHN and
PRO instructions.
The syntax error codes for the PERROR parameter are listed in Table 79-9.
Code Definition
-1 Invalid operation code
-2 Invalid operand type
-3 Out of range operand index
-4 Invalid go to step number
The runtime error codes for the PERROR parameter are listed in Table 79-10.
Code Definition
1 SQRT error (accumulator < 0)
2 ASIN error (absolute value of accumulator > 1)
3 ACOS error (absolute value of accumulator > 1)
4 DIV error (divide by zero)
5 Stack overflow
6 Stack underflow
7 LOG error (accumulator ≤ 0)
8 LN error (accumulator ≤ 0)
9 EXP error (base < 0)
10 Index error
11 Bit error
Programming Concepts
The MATH block operates in the same way as do most programmable pocket calculators. To
specify program operations, you type in a series of programming steps, which are analogous to
“keystrokes” on a calculator. A programming step can contain zero, one, or two command line
arguments which serve to complete the specification of the action to be performed. Each instruc-
tion performs a unique operation over a set of one or more operands.
The block accepts programs entered through the Reverse Polish Notation (RPN) method, which
is more efficient than other methods of programming. In a simple example, you specify first the
operands and then the action to be performed, which terminates the operation. This convention
works especially well with those instructions that operate on more than two operands.
1511
B0193AX – Rev AA 79. MATH – Mathematics Block
Example 2 – Calculate the average of RI01 to RI04 [(RI01 + RI02 + RI03 + RI04) / 4]:
STEP01 CST Clears the stack
STEP02 IN RI01 Pushes RI01 onto stack
STEP03 IN RI02 Pushes RI02 onto stack
STEP04 IN RI03 Pushes RI03 onto stack
STEP05 IN RI04 Pushes RI04 onto stack
STEP06 AVE Reads all the values from the stack, calculates the mean algebraic value
for them, collapses the stack, and pushes the result onto the stack
Execution Sequence
You can consider the sequencing of program steps to be under control of an internal program
counter that indicates the next program step to be processed. Instructions such as GTO that affect
program control reference the step number of the next step to be processed. Transfer of control is
permissible only in a forward direction; looping backwards or to the same step is not allowed.
Your program can have up to 20 steps.
The MATH block supports both conditional and unconditional means of altering the control of
program execution. Conditional transfer of control is dependent on various tests of the accumula-
tor value, or on the block initialization status.
The following example demonstrates these concepts.
Branching Example:
1512
79. MATH – Mathematics Block B0193AX – Rev AA
RI01
Program Function
Select real input 1 if it Selector Logic
is positive; otherwise, in MATH Block RO01
select real input 2.
RI02
Example Program:
STEP01 IN RI01 Reads real input 1
STEP02 BIP 04 Branches if value is positive
STEP03 IN RI02 Reads Real Input 2
STEP04 OUT RO01 Writes selected real value to output
Arithmetic Chaining
An internal LIFO (last-in, first-out) stack preserves the results of prior, intermediate operations
required for calculation of the final result. You can chain arithmetic operations without using
memory registers to store and retrieve data. This approach greatly simplifies program entries and
minimizes the number of programming steps.
Stack Push Operation
If the first instruction of the chained group has two operands, the operands are processed accord-
ing to the operator (add, subtract, multiply, divide, or exponentiation), and the result is stored in
the first stack register (top of stack).
If the next instruction of the group is also an arithmetic instruction with two operands, as in the
example of this section, the next operands are processed according to the operator and the new
result is pushed onto the stack. The result of the previous arithmetic operation remains on the
stack.
Stack Pop Operation
If an arithmetic instruction has no command line arguments, as in the fourth step of the example,
both operands are popped from the stack. If it has one command line argument, as in the seventh
step of the example, the first of the two operands is obtained by popping it from the stack Any
stack pop retrieves the most recently pushed value from the stack to complete the current opera-
tion.
When instructions in the chain operate directly on the accumulator value, the stack pointer is not
moved.
The following equation is an example of arithmetic chaining:
RO01 = RI05 * SQRT [(RI01 * RI02) / ((RI03 * RI04) - 1)]
Figure 79-6 shows the operation sequence for an arithmetic chaining example. It shows the oper-
ations involved in the equation, working from the innermost parentheses outward. The actual
program steps that implement the procedures are shown below. Figure 79-7 shows the stack oper-
ations for this example.
1513
B0193AX – Rev AA 79. MATH – Mathematics Block
6 5 1 4 2 3
Prod1
Prod2
Diff
Quotient
Root
Prod3
Figure 79-6. Arithmetic Chaining Example, Operation Sequence
STEP01 MUL RI01 RI02 Multiplies RI01 by RI02 and pushes product Prod1 onto stack.
STEP02 MUL RI03 RI04 Multiplies RI03 by RI04 and pushes product Prod2 onto stack.
STEP03 IN 1 Pushes constant “1” onto stack.
STEP04 SUB Pops “1” and Prod2 from stack, performs subtraction, and pushes
difference Diff onto stack.
STEP05 DIV Pops Diff and Prod1 from stack, divides them, and pushes Quo-
tient onto stack.
STEP06 SQRT Pops Quotient from stack, performs square root, and pushes result
(Root) onto stack.
STEP07 MUL RI05 Pops Root from stack, multiplies it by RI05, and pushes product
Prod3 onto stack.
STEP08 OUT RO01 Writes Prod3 to Real Output 1. Prod3 remains in position 1 on the
stack.
STEP9 END
1514
79. MATH – Mathematics Block B0193AX – Rev AA
1 2 3 4 5
MUL MUL IN SUB DIV SQRT
STEP01 STEP02 STEP03 STEP04 STEP05 STEP06
S3 1
S2 Prod2 S2 Prod2 S2 Diff
S1 Prod1 S1 Prod1 S1 Prod1 S1 Prod1 S1 Quotient S1 Root
Stack
Registers
(up to 16)
6
MUL OUT LEGEND:
STEP07 STEP08
Stack Stack
[RO01] Push Pop
S1 Prod3
Application Example
Figure 79-8 shows an application example. The program for this example is shown below.
Program Function
Limit measurement input to
RI01 MATH Block RO01
downstream control block
Measurement Program
1515
B0193AX – Rev AA 79. MATH – Mathematics Block
1516
80. MCIN – Multiple Contact Input
Block
This chapter gives a general overview of the MCIN (Multiple Contact Input Block), describing
its basic operations, features, parameters, functions, bad input, out-of-service and error
conditions, and manual mode. It also provides an application diagram and a valid input
connections appendix.
Overview
The Multiple Contact Input Block (MCIN) provides the control strategy with input capability
for a group of up to 32 digital input or digital output points in any Fieldbus Module (FBM) or
Fieldbus Card (FBC) containing such points. The block supports 32 boolean type outputs and
one packed long output for connection of these inputs into control schemes.
BAD
FBM and Parameter
BAD
Channel Detection Bad
Status Point
Status
1517
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
Basic Operation
The MCIN block interfaces to an Equipment Control Block (ECB) which stores digital input or
output values from an FBM or FBC. Each execution cycle, the block presents the value of all of
the points of the specified FBM or FBC, including any installed expansion unit, at outputs Con-
tact Input 1 (CIN_1) through Contact Input 32 (CIN_32) and, in packed form, at output
Packed Contact Inputs (PAKCIN). When no FBM or FBC is configured, the block input is taken
from another block connected to the Inputs (INPUTS) parameter or from a block or blocks con-
nected to the Integer Input 1 (II01) and Integer Input 2 (II02) parameters. The MCIN block pro-
vides optional point inversion, bypassing, Binary Coded Decimal output, and Auto/Manual
capability.
Features
♦ Interfacing of the control scheme to up to 32 digital points in any FBMs or FBCs,
including digital output readback values.
♦ Fieldbus Module option to permit configuration of MCIN blocks without FBM or
FBC connections. (Inputs from other blocks instead of from hardware.)
♦ Manual mode availability for disconnecting control schemes from the process, for
simulation and checkout purposes.
♦ Point inversion option.
♦ Optional bypass of selected contact inputs.
♦ Availability of the contact states in packed long format via the PAKCIN parameter.
♦ Continuous FBM or FBC input monitoring during Manual mode via the PAK-
CIN output.
♦ Optional conversion of up to 28 output bits into a seven-digit analog BCD form via
Binary Coded Decimal Option (BCDOP).
♦ Bad FBM or FBC and bad input point detection and reporting regardless of the
Auto/Manual state of the block.
♦ Error propagation option available when inputs are obtained from other blocks.
Parameters
Table 80-1. MCIN Block Parameters
1518
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
BAD Bad is a boolean output parameter which is set true when the connected
FBM or FBC has bad status or any point within it is bad. BAD reports
these conditions whether the block is in Auto or Manual.
BCDOP Binary Coded Decimal Option causes the block to compute the real out-
put BCDOUT, provided it is in Auto, and any connected FBM or FBC is
not out-of-service.
1519
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
BCDOUT Binary Coded Decimal Output is the real equivalent of the BCD repre-
sentation of the group of outputs CIN_1 through CIN_32, where CIN_1
is considered the least significant bit and CIN_32 the most significant.
The least significant decimal digit is the value of the four-bit nibble
formed from CIN_1 through CIN_4.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the MCIN block, only the following bits are used:
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9
B10 8 7 6 5 4 3 2 1 0
B11
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
FBM
BAD
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
8 FBM FBM or FBC Failure BLKSTA.B24
11 MA Manual = 0, Auto = 1 BLKSTA.B21
12 BAD Bad I/O for at least one BLKSTA.B20
input point
14 UDEF Block Undefined BLKSTA.B18
15 ON Block ON BLKSTA.B17
20 WLCK Access Locked BLKSTA.B12
CIN_1 to CIN_32
Contact Inputs 1 to 32 are boolean outputs containing the values of the
input Points 1 through 32 respectively.
CINMSK Contact Input Mask contains packed boolean values that specify the con-
tact inputs to be bypassed.
1 2 3 31 32
BYPASSED POINT
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. (See ERCODE for the list of all possible validation errors in this
1520
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug of the connected FBM or FBC.
DPLOC Decimal Point Locator specifies the number of significant decimal digits
to the right of the decimal point in the binary coded decimal output
BCDOUT.
EO1 Engineering Units for Output Range 1 provides the engineering units text
for the BCDOUT output. The value configured for this text string should
be consistent with the values used for HSCO1 and LSCO1.
ERCODE Error Code is a string data store which indicates the type of configuration
error which caused the block’s DEFINE parameter to be set false. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. For the MCIN block, the following list specifies
the possible values of ERCODE and the significance of each value in this
block:
ERCODE Description
W48 - INVALID BLOCK BCDOP is true but NUMBIT is
OPTION not in the range 1 through 32 or
DPLOC is not in the range 0
through 8.
W51 - INVALID HARDWARE/ Cluster I/O specified but type is not
SOFTWARE TYPE digital input, digital output, or digi-
tal input/output; or FBM23 (HTG
Interface Unit) is specified and
BCDOP is true.
W52 - INVALID I/O CHANNEL/ Cluster I/O specified but GRP-
GROUP NUMBER NUM is not 1 for the 32-point
FBCs or in the range 1 to 2 for the
64-point FBCs.
W54 - ECB DOES NOT EXIST Specified IOM_ID does not exist
1521
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
GRPNUM Group Number is a configured string which must have the following
values:
♦ 1 if an FBC with 32 points is connected,
♦ 1 or 2 if an FBC with 64 points is connected.
It indicates which group of 32 points is served by this MCIN block. If
GRPNUM is set to 1, points 1 through 32 are connected to the block; if
GRPNUM is set to 2, points 33 through 64 are connected. GRPNUM is
ignored if an FBM is connected.
HSCO1 High Scale for Output Range 1 is a real value that defines the upper range
limit for the output BCDOUT, after the decimal point has been located
by use of DPLOC.
II01 to II02 Integer Inputs 1 to 2 are integers which contain the block’s input values
when there is no connected FBM or FBC and parameter INPUTS is
unlinked. II01 represents Points 1 through 16, and II02 represents Points
17 through 32. Within each group, the most significant bit of the integer
corresponds to the lowest numbered point.
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
♦ The compound in which it resides is turned on.
♦ The INITMA parameter itself is modified via the control configu-
rator. (The block does not assert INITMA on ordinary
reconfiguration.)
INITMA is ignored if MA has an established linkage.
INPUTS Inputs is a packed long integer which contains the block’s input values
when there is no connected FBM or FBC, and INPUTS is linked. When
there is a connected FBM or FBC, INPUTS contains the same value as
PAKCIN, except that bypassing is not honored.
1522
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
IOMOPT FBM Option is a short integer specifying the type of input connection to
the block and the order of the bits in parameter PACKIN:
0= The MCIN block obtains input values from either the INPUTS
parameter if it is linked, or the parameters II01 and II02 if not.
1= The block obtains its input values from the FBM, FBC or
Integrator specified by IOM_ID.
1523
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
IOM_ID Fieldbus Module Identifier is a configurable string that specifies the path-
name of the ECB for the FBM or FBC to which the block is connected.
IOM_ID has the form CompoundName:BlockName, where Compound-
Name is the 1-12 character name of the local compound containing the
ECB, and BlockName is the 1-12 character block name of the ECB. For
IFD inputs, the NAME parameter string of the parent ECB (12, 23, or
38R) must be used.
If the compound containing the ECB is the CPletterbug_ECB compound
where CPletterbug is the station letterbug of the CP, the CompoundName
may be omitted from the IOM_ID configuration. In this case, the 1-12
character ECB block name is sufficient. For IFD inputs, this is the letter-
bug of the parent FBM (18, 43, 39, 44, or 46).
IVO_1 to IVO_32 Invert Options 1 to 32 are boolean inputs providing optional inversion of
each input point. If IVO_1 is true, then input Point 1 is inverted before
being copied to output CIN_1, and so forth for IVO_2 through IVO_32.
LOCKID Lock Identifier is a string identifying the workstation which 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.
1524
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
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 honored (subject to the usual access rules) only 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
written to LOCKID.
LSCO1 Low Scale for Output Range 1 is a real value that defines the lower range
limit for the output BCDOUT, after the decimal point has been located
by use of DPLOC.
1525
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
PAKCIN Packed Contact Inputs is a long integer presenting the values of CIN_1
through CIN_32 in packed format. The most significant bit of PAKCIN
is equal to the value of CIN_1, the next most significant bit is equal to
CIN_2, and so forth.
BIT 31 (MSB) 24 23 16 15 8 07(LSB)
CIN_x 1 2 3 31 32
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
1526
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
PROPT Propagate Error Option is a boolean input which determines whether the
status of the input source (INPUTS, II01, and/or II02) should be
reflected in the error bits of PAKCIN and CIN_1 through CIN_32. If the
MCIN block is in Auto and no FBM or FBC is configured (IOMOPT =
0), the true value of PROPT causes any one of the following conditions in
the input source to be reflected as an error status of CIN_1 to CIN_32:
♦ Bad status bit in the input source.
♦ OOS status in the input source.
♦ Error status in the input source.
♦ Any value in the OM field of the input source except 1
(ON_SCAN). Any other value in this field indicates that the
source of the connection has been deleted or is in a non-existent
compound, or there has been a peer-to-peer path failure.
When INPUTS is unlinked, the input source for CIN_1 to CIN_16 is
II01, and the input source for CIN_17 to CIN_32 is II02; otherwise the
input source for all outputs is INPUTS. The PAKCIN error bit is based
on either INPUTS (when it is linked) or any of the above conditions in
the status field of either II01 or II02.
RO1 Range Output 1 is a real array consisting of the three parameters HSCO1,
LSCO1, and DELTO1. The array members are configured by their indi-
vidual names; however, RO1 and its members can be accessed on an array
basis by user tasks and displays.
SETNUM Set Number is an internal data store indicating the number of input octets
being processed by the MCIN block.
TYPE When you enter “MCIN” or select it from a configurator list, an identify-
ing integer is created specifying this block type.
1527
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
Functions
Detailed Diagram
NUMBIT DPLOC
BCD
BCDOP AND Computation BCDOUT
IOM_ID
CINMSK Bit = 0
GRPNUM
IVO_x
FROM (M)
IOMOPT
ECB o
1,2 MA
AND Point
Inversion o o CIN_x
0 (A)
INPUTS
II01/II02
PAKCIN
ECB OOS
AND PAKCIN.OOS
Auto
[IOMOPT = 1]
PROPT
AND PAKCIN.ERR
[IOMOPT = 0] INPUTS/II01/II02 Status
1528
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
Valid Output
Valid Input Points
FBM Electrical Type Points (Readbacks) GRPNUM
FBM207 Contact or dc In Points 1 to 16 None -
FBM217 Group-Isolated Contact In Points 1 to 32 None -
FBM219 Contact or dc In/Out Points 1 to 24 Points 25 to 32 -
FBM241 Contact or dc In/Out Points 1 to 8 Points 9 to 16 -
FBM07 Contact or dc In Points 1 to 16 None -
FBM08 120 V ac In Points 1 to 16 None -
FBM09 Contact or dc In; Output Switch Points 1 to 8 Points 9 to 16 -
with Internal or External Source
FBM10 120 V ac In; 120 V ac Points 1 to 8 Points 9 to 16 -
Output Switch
FBM11 240 V ac In; 240 V ac Points 1 to 8 Points 9 to 16 -
Output Switch
FBM12 Contact or dc In Expansion Points 17 to 32 None -
FBM13 120 V ac In Expansion Points 17 to 32 None -
FBM14 Contact or dc In; Points 17 to 24 Points 25 to 32 -
Output Switch with Internal or
External Source Expansion
FBM15 120 V ac In; 120 V ac Points 17 to 24 Points 25 to 32 -
Output Switch Expansion
FBM16 240 V ac In; 240 V ac Points 17 to 24 Points 25 to 32 -
Output Switch Expansion
FBM20 240 V ac In Points 1 to 16 None -
FBM21 240 V ac In Expansion Points 17 to 32 None -
FBM23 HTG Interface Unit Points 1 to 32 None -
FBM24 Contact or 125 V dc or Contact Points 1 to 16 None -
Externally Powered In
FBM25 Contact or 125 V dc or Contact Points 17 to 32 None -
Externally Powered In Expansion
FBM26 Contact or 125 V dc or Contact Points 1 to 8 Points 9 to 16 -
Externally Powered In; Externally
Powered Output Switch
1529
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
Valid Output
Valid Input Points
FBM Electrical Type Points (Readbacks) GRPNUM
FBM27 Contact or 125 V dc or Contact Points 17 to 24 Points 25 to 32 -
Externally Powered In; Externally
Powered Output Switch Expansion
FBM41 Contact or 60 V dc In/Out Points 1 to 8 Points 9 to 16 -
FBM42 Contact or 60 V dc In/Out Points 17 to 24 Points 25 to 32 -
Expansion
FBC07 Isolated Voltage or Non-Isolated Points 1 to 32 None 1
Contact In
FBC09 Isolated Contact or Relay Out None Points 1 to 32 1
FBC10 Configurable ac or dc In; Points 1 to 8, 17 Points 9 to 16, 25 1 or 2
Configurable ac, dc or Contact to 24, 33 to 40, to 32, 41 to 48,
Out and 49 to 56 and 57 to 64
FBC07 Isolated Voltage or Non-Isolated Points 1 to 32 None 1
Redundant Contact In, Redundant
FBC09 Isolated Contact or Relay Out, None Points 1 to 32 1
Redundant Redundant
FBC10 Configurable ac or dc In; Points 1 to 8, 17 Points 9 to 16, 25 1 or 2
Redundant Configurable ac, dc or Contact to 24, 33 to 40, to 32, 41 to 48,
Out, Redundant and 49 to 56 and 57 to 64
The points in the above table identified as valid output points are readback values from physical
outputs. You can use these values as inputs to the MCIN block.
Unless the FBM input point is to be bypassed, the value of each physical input point in the con-
nected FBM or FBC is copied to the corresponding boolean output in the range CIN_1 through
CIN_32. (Point 1 is copied to CIN_1, Point 2 to CIN_2, etc.). When there are only 16 input
points, CIN_17 through CIN_32 are always false.
When connected to an FBC with 64 points, one MCIN block must be used for each group of 32
points. The configured value of parameter Group Number (GRPNUM) indicates whether Points
1 to 32 or 33 to 64 are to be connected to the block. If GRPNUM is configured as 2, then
Point 33 is copied to CIN_1, Point 34 is copied to CIN_2, and so forth. GRPNUM is ignored
when an FBM rather than an FBC is connected.
Parameters Invert Option 1 (IVO_1) through Invert Option 32 (IVO_32) determine whether or
not the values of the input points are to be inverted before being copied to outputs CIN_1
through CIN_32. (IVO_1 governs the inversion of CIN_1, and so forth.) When there are only
16 input points, the values of IVO_17 through IVO_32 are ignored, and CIN_17 through
CIN_32 remain false even if any of the invert options IVO_17 through IVO_32 are true.
Bypassing is based on the bit-mapped value of Contact Input Mask (CINMSK); if the most sig-
nificant bit of CINMSK is true, Point 1 is bypassed, that is, CIN_1 is not updated from Point 1.
The bypassing of Point 2 is based on the next most significant bit of CINMSK, and so on.
1530
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
PAKCIN is a long integer output containing the values of CIN_1 through CIN_32 in packed
format, where the most significant bit of PAKCIN contains the value of CIN_1, and the least sig-
nificant bit contains the value of CIN_32. The correspondence between each boolean CIN_x and
its matching bit within PAKCIN is unconditional; if CIN_x is subject to inversion or bypass,
then its matching bit in PAKCIN is also. If CIN_17 through CIN_32 are false because there are
only 16 input points, then the two least significant bytes of PAKCIN are zero.
When there is a connected FBM or FBC, the value of parameter Inputs (INPUTS) is set equal to
the value of PAKCIN, with the following exception: INPUTS does not honor bypassing, and
always contains the actual value (inverted if so specified) of the physical input in the current exe-
cution cycle. This permits you to monitor any physical input for troubleshooting purposes, while
preventing the suspect point from affecting the control scheme.
Parameter Set Number (SETNUM) is a data store indicating the number of eight-bit octets being
processed. For the present family of FBMs and FBCs, SETNUM is always 2 or 4.
1531
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
weight 4 to the next highest-numbered CIN_x, and so forth. For example, in Nibble 3, which
consists of CIN_13 through CIN_16, the CIN positions have the following weights:
♦ CIN_13 has weight 1.
♦ CIN_14 has weight 2
♦ CIN_15 has weight 4
♦ CIN_16 has weight 8
If CIN_16 = 1, CIN_15 = 0, CIN_14 = 0 and CIN_13 = 1, then the resulting decimal digit cor-
responding to Nibble 3 is 9 (8 + 0 + 0 + 1).
The decimal digit in Nibble 0 (CIN_1 through CIN_4) forms the least significant decimal digit
of the BCD result, and so forth through Nibble 7 (CIN_29 through CIN_32).
NIBBLE 7 6 5 4 3 2 1 0
CIN_x 32 31 3 2 1
Parameter Number of Bits (NUMBIT) specifies the number of bits to be used in the conversion,
and must be between 1 and 32. If you set NUMBIT to 8, for example, only the two nibbles
CIN_1 through CIN_4 and CIN_5 through CIN_8 are converted. The result is a two-decimal-
digit value formed from these two nibbles.
You are not required to specify NUMBIT in multiples of four. If you specify NUMBIT = 10, for
example, the values of CIN_1 through CIN_4 forms the least significant decimal digit, that of
CIN_5 through CIN_8 the next most significant decimal digit, and that of the pair CIN_9 and
CIN_10 the most significant decimal digit. All bits outside the range specified by NUMBIT are
masked out, including partial nibbles when NUMBIT is not a multiple of four.
Parameter Decimal Point Locator (DPLOC) is then used to locate a decimal Point within the
value thus calculated. DPLOC indicates the number of decimal digits to the right of the decimal
point. If, for example, the BCD conversion has been applied to exactly three nibbles, and the
result is 729, then a value of two in DPLOC expresses the value as 7.29.
If any nibble within the NUMBIT mask has a binary weight above 9, the conversion is invalid. In
this case, BCDOUT is not computed and the Bad status bit of BCDOUT is set true. Otherwise
the Bad status bit of BCDOUT is false.
If BCDOUT is determined to have Bad status during any execution cycle, then BLKSTA.BAD
and the Bad (BAD) parameter are both set true on the next execution cycle, but not on the cur-
rent one.
The process of conversion of the CIN_x bits into a real value causes the maximum range of signif-
icance of a floating point number to be exceeded if more than 28 bits are converted (NUMBIT =
29 or higher). The effect of this is to lose the exact value of the least significant nibble (CIN_1
through CIN_4). This is not an error, but you should be aware of this if your control strategy
depends on retaining the exact bit configuration of all input points as part of the final BCDOUT
value.
The final result, after application of DPLOC, is clamped by High Scale for Output Range 1
(HSCO1) and Low Scale for Output Range 1 (LSCO1) and presented as real output BCDOUT.
There is no external indication that clamping has been applied.
1532
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
Out-of-Service Condition
The following actions are taken if an FBM or FBC is connected, the block is in Auto, and the
FBM or FBC is out-of-service:
♦ Each of the CIN_x outputs has the Out-of-Service status bit set.
♦ The Out-of-Service status bit of PAKCIN is set true.
♦ If BCDOP is true, then parameter BCDOUT has the Out-of-Service status bit set.
♦ The Out-of-Service status bits of bypassed CIN_x outputs are not updated for any
reason.
The following action is taken whether the block is in Auto or Manual:
♦ When an FBM or FBC is connected and it is out-of-service, the Out-of-Service status
bit of INPUTS is set true.
Error Condition
If the Propagate Error Option (PROPT) parameter is true, there is no FBM or FBC connection,
and the MCIN block is in Auto, the error status bits of PAKCIN and CIN_1 to CIN_32 are set
true or false based on the following conditions:
Case 1: If the inputs are being obtained from INPUTS (that is, INPUTS is linked), then the sta-
tus field of INPUTS is checked, and if any one of the following conditions is found there, the
error status bit of PAKCIN and the error status bit of each of CIN_1 through CIN_32 is set true:
♦ The bad status bit is set.
♦ The out-of-service status bit is set.
♦ The error status bit is set.
♦ The OM field of INPUTS status has any value except 1 (ON_SCAN).
1533
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
If none of these conditions is found, the error bits of PAKCIN and CIN_1 through CIN_32 are
set false.
Case 2: If the inputs are being obtained from II01 and II02 (that is, INPUTS is unlinked), then
the status fields of II01 and II02 are checked independently for the following conditions:
♦ The bad status bit is set.
♦ The out-of-service status bit is set.
♦ The error status bit is set.
♦ The OM field of II01 (or II02) status has any value except ON_SCAN.
If either the II01 or the II02 status field has one or more of these conditions, then the PAK-
CIN error bit is set true, otherwise it is set false.
The error status bits of CIN_1 through CIN_16 are set true if any of the four listed conditions is
found is the status field of II01, otherwise they are set false.
The error status bits of CIN_17 through CIN_32 are set true if any of the four listed conditions
is found is the status field of II02, otherwise they are set false.
In either Case 1 or Case 2, the bypass condition for any CIN_x (based on parameter CINMSK)
prevents the error status bit for that CIN_x from being changed.
If the block is in Manual, the error status bits of PAKCIN and CIN_1 through CIN_32 are not
changed by the above conditions. The values of the error status bits remain as they were when the
Manual mode was entered.
Manual Mode
When the MCIN block is in the Manual mode, it does not update the value of the CIN_x out-
puts. All of the CIN_x are released and become settable by the user.
Parameter PAKCIN is never settable, even in Manual mode, that is:
♦ When an FBM or FBC is connected, the PAKCIN parameter continues to reflect the
value of the physical inputs, regardless of the manual values set into the CIN_x.
♦ When there is no FBM or FBC connection, PAKCIN reflects the value of INPUTS.
In Manual mode, the status bits (Bad, Out-of-Service, and Error) of the CIN_x outputs are not
updated. Since they are not cleared, they retain their last values before the transition into Manual.
The BAD parameter is updated when in Manual, based on the conditions stated in Section .
When the block transitions from Manual to Auto mode, the value, Bad status bit, and Out-of-
Service status bit of PAKCIN are cleared to zero. The Bad and Out-of-Service status bit of every
CIN_x is also set false.
The PROPT parameter is inactive when the block is in Manual (that is, the Error bits of the
CIN_x statuses are not set based on various status bits of INPUTS or II01 and II02 when no
FBM or FBC is connected).
Parameter BCDOUT is released in Manual and can be set by you, regardless of the value of
BCDOP.
1534
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
Application Diagram
MCHOUT.Bx
COUT
MCHOUT.By
COUT
PATT
Flow
PAKINP Switch
Feedstock
PAKCIN Solenoid
Valve
MCIN
Output
Product
Solenoid
Flow Valve
Switch
Hardware
207
217
241
10
11
12
13
14
15
16
20
21
23
24
25
26
27
41
42
7
8
9
Type
Point
1 I I I I I I I I I I I I I
2 I I I I I I I I I I I I I
3 I I I I I I I I I I I I I
1535
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
Hardware
207
217
241
10
11
12
13
14
15
16
20
21
23
24
25
26
27
41
42
7
8
9
Type
Point
4 I I I I I I I I I I I I I
5 I I I I I I I I I I I I I
6 I I I I I I I I I I I I I
7 I I I I I I I I I I I I I
8 I I I I I I I I I I I I I
9 I I O I I O O O I I I O O
10 I I O I I O O O I I I O O
11 I I O I I O O O I I I O O
12 I I O I I O O O I I I O O
13 I I O I I O O O I I I O O
14 I I O I I O O O I I I O O
15 I I O I I O O O I I I O O
16 I I O I I O O O I I I O O
17 I I I I I I I I I I I
18 I I I I I I I I I I I
19 I I I I I I I I I I I
20 I I I I I I I I I I I
21 I I I I I I I I I I I
22 I I I I I I I I I I I
23 I I I I I I I I I I I
24 I I I I I I I I I I I
25 I I I O O O I I I O O
26 I I I O O O I I I O O
27 I I I O O O I I I O O
28 I I I O O O I I I O O
29 I I I O O O I I I O O
30 I I I O O O I I I O O
31 I I I O O O I I I O O
32 I I I O O O I I I O O
Legend: I = Input
O = Readback from Output
NOTE
Hardware Type 23 is used for HTG Interface Unit (HIU).
1536
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
Hardware
Type 60 62 86 92 94 97
Point
1 I O I I O I
2 I O I I O I
3 I O I I O I
4 I O I I O I
5 I O I I O I
6 I O I I O I
7 I O I I O I
8 I O I I O I
9 I O O I O I
10 I O O I O I
11 I O O I O I
12 I O O I O I
13 I O O I O I
14 I O O I O I
15 I O O I O I
16 I O O I O I
17 I O I I O I
18 I O I I O I
19 I O I I O I
20 I O I I O I
21 I O I I O I
22 I O I I O I
23 I O I I O I
24 I O I I O I
25 I O O I O I
26 I O O I O I
27 I O O I O I
28 I O O I O I
29 I O O I O I
30 I O O I O I
31 I O O I O I
32 I O O I O I
33 I O
34 I O
1537
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
Hardware
Type 60 62 86 92 94 97
Point
35 I O
36 I O
37 I O
38 I O
39 I O
40 I O
41 O O
42 O O
43 O O
44 O O
45 O O
46 O O
47 O O
48 O O
49 I O
50 I O
51 I O
52 I O
53 I O
54 I O
55 I O
56 I O
57 O O
58 O O
59 O O
60 O O
61 O O
62 O O
63 O O
64 O O
Legend: I = Input
O = Readback from Output
1538
80. MCIN – Multiple Contact Input Block B0193AX – Rev AA
NOTE
Hardware Type 60 is used for FBC07.
Hardware Type 62 is used for FBC09.
Hardware Type 86 is used for FBC10.
Hardware Type 92 is used for FBC07 Redundant.
Hardware Type 94 is used for FBC09 Redundant.
1539
B0193AX – Rev AA 80. MCIN – Multiple Contact Input Block
1540
81. MCOUT – Multiple Contact
Output Block
This chapter gives a general overview of the MCOUT (Multiple Contact Output Block), its
basic operations, features, parameters, and functions, describes bad input, out-of-service and
error conditions, failsafe state, and manual mode and provides an application diagram and a
valid output connections appendix.
Overview
The Multiple Contact Output Block (MCOUT) provides the control strategy with output capa-
bility for a group of either 8 or 16 digital outputs directed to any Fieldbus Module (FBM) or
Fieldbus Card (FBC) containing at least this number of digital output points. The block also sup-
ports Auto/Manual control and optional point inversion. Pulsed outputs and alarming are not
supported. See Figure 81-1.
Output Invert
Mask Options
Point
Inputs Masking Inversion Output
New Value
Output
Previous Value
FBM Status
Failsafe Bumpless
Initialization Output
Tracking Readback Value
FBM To
Option
FBM/FBC
1541
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
Basic Operation
The MCOUT block interfaces to an Equipment Control Block (ECB) which contains digital
output values for an FBM or FBC. Each execution cycle, the block writes the values of the input
parameters Inputs 1 to 16 (IN_1 to IN_16) to its outputs, Contact Outputs 1 to 16 (CO_1 to
CO_16). When an FBM or FBC is configured, the values of CO_1 to CO_16 also drive the con-
nected digital output points. For FBMs with only 8 output points, CO_9 to CO_16 are set to
zero, and are not transferred to the ECB.
The MCOUT block also provides optional per-point masking and inversion under control of
parameters Output Mask (OUTMSK) and Invert Options (INVOPT) respectively.
Bumpless initialization is provided on bad-to-good transitions of the connected FBM or FBC, or
transitions of any connected digital output point into Failsafe. Output readback values are used to
drive the outputs for one cycle, and the upstream blocks are notified via parameters Initialize Out
(INITO) and Failsafe (FS).
The block’s outputs are made available in packed boolean form at all times in parameter Packed
Outputs (PAKCRB).
Features
♦ Interfacing of the control scheme to multiple digital output points in any FBM or
FBC with at least 8 digital outputs
♦ Duplicate output channel cross-checking against other control blocks
♦ Fieldbus Module option to permit configuration of MCOUT blocks without FBM or
FBC connections
♦ Output inversion option on a per-point basis
♦ Bypass of selected outputs
♦ Flexible last good value functionality on a per-point basis
♦ Manual mode for disconnecting control schemes from the process, for simulation and
checkout purposes
♦ Failsafe support including Manual if Failsafe option
♦ Use of readback values for bumpless operation
♦ Initialization output parameter for proper coordination of cascaded schemes.
Parameters
Table 81-1. MCOUT Block Parameters
1542
81. MCOUT – Multiple Contact Output Block B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
BAD Bad is a boolean output parameter which is set true when the connected
FBM or FBC has bad status.
1543
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the MCOUT block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
FBM
TRK
MA
ON
FS
CO_1 to CO_16 Contact Outputs 1 to 16 are boolean outputs that contain the individual
values of the respective inputs IN_1 to IN_16 when the block is in Auto,
and manually entered values when the block is in Manual. If a connected
FBM or FBC is configured, the values of CO_1 to CO_16 are copied to
the ECB and output to the process. When the block is connected to an
FBM with only 8 outputs, CO_9 to CO_16 are set to zero.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing, other than those involved in duplicate output channel detection.
(See ERCODE for the list of all possible validation errors in this block.) In
that case, no further processing of the block occurs, including further vali-
dation of remaining parameters. To return DEFINE to a true value, cor-
rect all configuration errors and reinstall the block. If DEFINE = 0, the bit
BLKSTA.UDEF = 1.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug of the connected FBM or FBC.
1544
81. MCOUT – Multiple Contact Output Block B0193AX – Rev AA
ERCODE Error Code is a string data store which indicates the type of configuration
error which caused the block’s DEFINE parameter to be set false. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. (The duplicate output channel condition does
not cause the block’s DEFINE parameter to be set false.) The block
detailed display shows the ERCODE on the primary page, if it is not null.
For the MCOUT block, the following list specifies the possible values of
ERCODE and the significance of each value:
ERCODE Value
W51 The specified FBM or FBC may not be connected to a
MCOUT block
W52 An FBC has been specified but GRPNUM is not 1 or 2
W54 Specified IOM_ID does not exist
W59 Warning: This block and another block which drives
digital output points are connected to the same FBM or
FBC and point number. Both blocks receive the same
warning message.
EROP1 to EROP16
Error Option 1 to 16 are configured options which specify, on a per-point
basis, how the block responds to errors in the IN_1 to IN_16 parameters.
Each EROP value indicates which types of input errors cause its associated
IN to be ignored. When an input is ignored, the corresponding output
holds to its last good value. EROP1 to EROP16 have a range of 0 to 2. See
Section for an explanation of each value and the general conditions under
which the EROP parameters are used.
FS Failsafe is a boolean output which is set true when any of the connected
output points transitions into the Failsafe state. If the block is in Auto
when the transition occurs, FS remains true for one cycle, and then
returns to false. If in Manual, FS goes true on any transition into Failsafe,
and remains true while the block is in Manual. On the next transition into
Auto, FS is set false.
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
1545
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
INITO Initialize Output is set true when the block logic detects that any one of
the following conditions exists:
♦ A steady open loop situation.
♦ A transfer from open loop into closed loop operation.
♦ A transition into Failsafe at the FBM or FBC.
The block clears INITO when none of these conditions exists. You con-
nect this parameter to the INITI input of upstream blocks so that these
upstream blocks can sense when this block is open loop.
INVOPT Invert Option contains a packed boolean value whose bits specify whether
each individual input is to be inverted before being set into its correspond-
ing output. The most significant bit of INVOPT governs the inversion of
IN_1, and the least significant governs the inversion of IN_16. INVOPT
is ignored when the block is in Manual or readback values are being used.
IN_1 to IN_16 Inputs 1 to 16 are boolean inputs whose values are transferred to the block
outputs CO_1 to CO_16 respectively, and to any connected FBM or
FBC, when the block is in Auto and readback values are not being used.
1546
81. MCOUT – Multiple Contact Output Block B0193AX – Rev AA
IOM_ID Fieldbus Module Identifier is a configurable string that specifies the path-
name of the ECB for the FBM or FBC to which the block is connected.
IOM_ID has the form CompoundName:BlockName, where Compound-
Name is the 1-12 character name of the local compound containing the
ECB, and BlockName is the 1-12 character block name of the ECB. For
IFD inputs, the NAME parameter string of the parent ECB (12, 23, or
38R) must be used.
If the compound containing the ECB is the CPletterbug_ECB compound
where CPletterbug is the station letterbug of the CP, the CompoundName
may be omitted from the IOM_ID configuration. In this case, the 1-12
character ECB block name is sufficient. For IFD inputs, this is the letter-
bug of the parent FBM (18, 43, 39, 44, or 46).
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
1547
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
process. In Auto, the block secures the output, which makes it a depen-
dent variable that is determined by the substate of Auto. On a transition
to Manual, the output is held for reals but is cleared for booleans.
MANFS Manual if Failsafe is a configurable option which, when true, causes the
block to switch to the Manual mode when the connected point is reported
by the FBM or FBC to be in Failsafe state. MANFS has no effect when
MA is linked.
OUTMSK Output Mask contains a packed boolean value whose bits specify whether
each individual output is to be bypassed. A bypassed output is one which
is not changed when the block is in Auto. Bypassing is ignored in the
Manual mode.
PAKCRB Packed Outputs is a packed boolean output, whose least significant bit is
the value of the CO_16 output and whose most significant bit is the value
of the CO_1 output.PAKCRB is displayed in hexadecimal. For example, a
PAKCRB value of Hexadecimal 12 means that CO_12 and CO_15 are 1
(true) and all other CO_x outputs are 0 (false).
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
CO_10 IN_10
CO_11 IN_11
CO_12 IN_12
CO_13 IN_13
CO_14 IN_14
CO_15 IN_15
CO_16 IN_16
IN_1
IN_2
IN_3
IN_4
IN_5
IN_6
IN_7
IN_8
IN_9
CO_1
CO_2
CO_3
CO_4
CO_5
CO_6
CO_7
CO_8
CO_9
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
1548
81. MCOUT – Multiple Contact Output Block B0193AX – Rev AA
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PROPT Propagate Error Option is a boolean input which determines whether the
status of the IN_x is reflected in the error status bits of the CO_x. If the
block is in Auto, a true value of PROPT causes any one of the following
conditions in an IN_x status to result in an error status of its correspond-
ing CO_x:
♦ Bad status bit in the IN_x parameter.
♦ OOS status bit in the IN_x parameter.
♦ Error status bit in the IN_x parameter.
♦ Any value in the om field of the IN_x status except 1
(ON_SCAN). Any other value in this field indicates that the
source of the connection to IN_x has been deleted or is in a non-
existent compound, or there has been a peer-to-peer path failure.
Parameters EROP1 to EROP16 are used to control last good value func-
tionality when PROPT is true and the block is in Auto
SETNUM Number of Nibbles is a data store which indicates the number of four-bit
nibbles being processed. It is always 4 except when there is a connected
FBM without an expansion module, in which case it has the value 2.
TYPE When you enter “MCOUT” or select it from a configurator list, an iden-
tifying integer is created specifying this block type.
1549
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
Functions
Detailed Diagram
PROPT
OUTMSK EROPx INVOPT (M)
o
MA
Per-Point Per-Point Per-Point
IN_x Error o o o o CO_x
Bypassing Propagation Inversion
(A)
LAST GOOD VALUE o To
AND ECB
USE HOLD VALUE o IOMOPT
Auto AND
Transition Cycle
Open
Cascade INITO
Detection
1550
81. MCOUT – Multiple Contact Output Block B0193AX – Rev AA
Block Initialization
Key Parameters: SETNUM, CO_x, PAKCRB
The conditions under which the MCOUT block initializes are:
♦ The block is installed.
♦ Any parameter of the block is reconfigured by the Integrated Control Configurator.
♦ The compound in which the block resides is turned on.
♦ The control processor containing the block is rebooted.
Whenever the block initializes, the following actions are taken, prior to any other block process-
ing activity:
♦ Number of Nibbles (SETNUM), which indicates the number of 4-bit nibbles being
processed, is set to 4 if an FBC is connected, or if an FBM with an associated expan-
sion module is connected. (See Section ). If an FBM without an expansion module is
connected, SETNUM is set to 2. If there is no connected FBM or FBC, that is, FBM
Option (IOMOPT) = 0, SETNUM is always set to 4.
♦ Parameters CO_1 through CO_16 and PAKCRB are initialized to 0.
♦ If SETNUM is 2, then parameters CO_9 through CO_16 are set out-of-service.
♦ Block validation is performed (see Section ).
After block initialization, the block is processed normally on the remainder of this execution
cycle. Note, however, that the remaining processing activity on the first execution cycle follows
the rules for a one-cycle Hold mode as described in Section .
Block Validation
Key Parameters: ERCODE, IOM_ID, IOMOPT, GRPNUM
The MCOUT block’s parameters are validated in accordance with the rules listed below.
Whenever the block initializes (see Section ) and an FBM or FBC is connected, the following four
types of validation are carried out:
♦ The ECB named in parameter Fieldbus Module Identifier (IOM_ID) is searched for
in the database. If it cannot be located, Error Code (ERCODE) is set to the string
“W54 – ECB DOES NOT EXIST”.
♦ If cluster I/O is specified, the hardware type of the FBC is checked to determine
whether it corresponds to one of the allowable FBC types as shown in the table of
Section . If it is not allowable, ERCODE is set to the string “W51 – INVALID
HARDWARE/SOFTWARE TYPE”.
♦ If cluster I/O is specified, Group Number (GRPNUM) is verified as having the value
“1” or “2”. If GRPNUM has any other value, ERCODE is set to the string “W52 –
INVALID I/O CHANNEL/GROUP NUMBER”.
♦ If cluster I/O is not specified, the software type of the ECB is validated as being Type
5. (All of the FBMs listed in Section use Software Type 5 when utilized for standard
contact output functions). If this validation fails, ERCODE is set to the string “W51
– INVALID HARDWARE/SOFTWARE TYPE”.
1551
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
The following validation, which is called duplicate output channel detection, is intended to alert
you to the fact that this block and another block capable of digital outputs are connected to the
same output point or points. It is not automatically carried out every time the block is initialized,
since it is costly in terms of system resources. The following situations cause this check to be per-
formed:
♦ The control processor is rebooted.
♦ The MCOUT block is installed.
♦ An ECB connected to this block is installed or reconfigured.
♦ The IOMOPT parameter is modified.
♦ The IOM_ID parameter is modified.
♦ The GRPNUM parameter is modified.
The blocks capable of driving digital outputs are COUT, MCOUT, GDEV, MTR, VLV,
MOVLV, and MDACT. When duplicate output detection is performed for any block of one of
these types, the entire data base is checked for duplicate digital output channels. (Any digital out-
put block containing one of the parameters OP_FBM, CO1_PT, CO2_PT, or PNT_NO also is
validated when such parameter is modified.)
All blocks connected to the same output point have their ERCODE parameters set to the string
“W59 – DUPLICATE OUTPUT CHANNEL”, but none of the blocks are set Undefined. The
duplicate output does not necessarily constitute a conflict, since the other block may be in a com-
pound which is not intended to run at the same time as the compound containing this MCOUT
block, or the duplicate connection may be desired as part of an elaborate control scheme.
Output Processing
Key Parameters: IOM_ID, GRPNUM, IN_x, CO_x, PAKCRB, INVOPT, OUTMSK
You specify the destination FBM or FBC in the IOM_ID parameter. Since the FBCs with digital
outputs always have 32 output points, it is necessary to use parameter GRPNUM to specify
whether the first or second group of 16 outputs is to be driven. GRPNUM is ignored when an
FBM is connected. The following are the FBMs or FBCs and point numbers providing valid out-
put destinations for the MCOUT block:
1552
81. MCOUT – Multiple Contact Output Block B0193AX – Rev AA
NOTE
Points 33 to 64 of FBC10 and FBC10 Redundant can be used as inputs or outputs,
depending on how you configure the ECB parameter BUSMID in the Integrated
Control Configurator. The first 32 points (Points 1 to 32) are always inputs. Any
additional inputs within the range 33 to 64 must be lower than any outputs. The
value of BUSMID is the total number of inputs in the FBC, according to the fol-
lowing table.
If the block is in Auto, the value of each input IN_x is transferred to the corresponding output
CO_x, subject to the following three conditions:
♦ Point bypassing
♦ Point error options
♦ Point inversion.
1553
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
Point bypassing is based on the Output Mask (OUTMSK) parameter. Each bit of the OUTMSK
packed boolean value governs the bypassing of one CO_x output. The most significant bit of
OUTMSK, when true, causes CO_1 to be bypassed, and the least significant causes CO_16 to be
bypassed. A bypassed output cannot be changed in the Auto mode. Since OUTMSK is connect-
able and settable, a point can be locked into its current value at any time.
Point error options permit you to specify the conditions under which each input IN_x is consid-
ered to be in error. An input considered in error is not transferred to its corresponding output
CO_x while the block is in Auto. This is last good value functionality and is described in detail in
Section .
If neither bypassing nor last good value retention is to be applied to a point, and the block is in
Auto, the configured parameter Invert Option (INVOPT) is used to determine whether that
input point is to be inverted before it is set into its corresponding output. The most significant bit
of the packed boolean INVOPT, when true, causes IN_1 to be inverted before it is set into
CO_1, and the least significant bit of INVOPT governs the inversion of IN_16.
If an FBM or FBC is connected, the value in CO_1 is written to the lowest-numbered output
point as shown in the table above, CO_2 is written to the next highest, and so forth. For example,
if the connected FBM is an FBM09, then only the first 8 CO_x are used, and transmitted to
Points 9 through 16 respectively. (The values of CO_9 through CO_16 are set to zero when the
block is initialized, and never changed.)
As another example, if the connected FBM is type FBM09 with an FBM14 expansion module,
then CO_1 through CO_8 are written to Points 9 through 16 respectively, and CO_9 through
CO_16 are written to Points 25 through 32 respectively.
The association between output point numbers and the CO_x is shown in the following table:
FBM 9, 10,
FBM241, 11, 26 FBM242
9, 10, w/Expansion FBC9/9R FBC9/9R FBC10/10R FBC10/10R
FBM219 11, 26 Module GRPNUM1 GRPNUM2 GRPNUM1 GRPNUM2
CO_1 Point 25 Point 9 Point 9 Point 1 Point 17 Point 33 Point 49
CO_2 Point 26 Point 10 Point 10 Point 2 Point 18 Point 34 Point 50
... ... ... ... ... ... ... ...
CO_7 Point 31 Point 15 Point 15 Point 7 Point 23 Point 39 Point 55
CO_8 Point 32 Point 16 Point 16 Point 8 Point 24 Point 40 Point 56
CO_9 0 Point 25 Point 9 Point 25 Point 41 Point 57
CO_10 0 Point 26 Point 10 Point 26 Point 42 Point 58
... ... ... ... ... ... ...
CO_15 0 Point 31 Point 15 Point 31 Point 47 Point 63
CO_16 0 Point 32 Point 16 Point 32 Point 48 Point 64
Whenever data is copied from the CO_x outputs to an ECB, a flag is set in the ECB which causes
its contents to be written to the FBM or FBC at the next bus output cycle.
In Manual mode (see Section ) or during a Hold cycle (see Bumpless Operation in Section ) the
values of the CO_x are not derived from the inputs IN_x.
Regardless of the origin of the values in the CO_x, the contents of CO_1 through CO_16 are
always copied to the PAKCRB parameter, where they are made available to the control strategy in
packed boolean format, and displayed in the default display as a hexadecimal value. (Note that
PAKCRB does not usually contain readback data.)
1554
81. MCOUT – Multiple Contact Output Block B0193AX – Rev AA
The value of CO_1 is shown in the most significant bit of PAKCRB, and that of CO_16 in the
least significant bit. When only CO_1 through CO_8 are being used, the least significant 8 bits
of PAKCRB are zero.
1555
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
Out-of-Service Condition
Key Parameters: CO_x, PAKCRB, INITO
If there is a connected FBM or FBC, then the following are true whenever the FBM or FBC is
out-of-service:
♦ The out-of-service and secure status bits of every unmasked CO_x for all the CO_x
actually in use, based on the value of SETNUM
♦ The out-of-service status of INITO
♦ The out-of-service status of PAKCRB.
If only 8 points are in use (SETNUM = 2), then CO_9 to CO_16 remain out-of-service, as noted
in Section .
1556
81. MCOUT – Multiple Contact Output Block B0193AX – Rev AA
♦ EROPx = 1: The value of CO_x is not updated, and its value from the previous pro-
cessing cycle is used, whenever IN_x has bad or out-of-service status, or the om field
of IN_x status is not 1.
♦ EROPx = 2: The value of CO_x is not updated, and its value from the previous pro-
cessing cycle is used, whenever IN_x has bad, out-of-service, or error status, or the om
field of IN_x status is not 1.
The value of a bypassed point is automatically in a last good value state, except during Manual
mode, when last good value functionality is never in effect.
During a Hold cycle (see Section ) when an FBM or FBC is connected, the IN_x do not provide
the output values, and there is no last good value functionality.
Failsafe State
Key Parameters: FS, BLKSTA, MANFS, MA
Each execution cycle, the block inspects the ECB to determine whether any one of the connected
points has been reported in the Failsafe state by the FBM or FBC. If so, and if the block is in
Auto, the parameter FS is set true for one cycle, when the transition into Failsafe occurs. Thereaf-
ter FS is reset to false until another transition into Failsafe is detected.
If the block is in Manual when a transition into Failsafe is detected, FS is set true and remains true
for the duration of the Manual mode. If the block is then switched into Auto, FS is cleared to
false.
The status bit BLKSTA.FS is true whenever parameter FS is true.
If option Manual if Failsafe (MANFS) is true the block is forced into Manual when a transition
into Failsafe occurs, if it is not already in Manual. Thereafter it remains in Manual unless it is set
into Auto by a user task or display. MANFS is always ignored when parameter MA is linked.
Failsafe state processing is not performed when no FBM or FBC is connected.
The true state of FS is one of the conditions resulting in setting the one-cycle Hold state (see
Section ).
Manual Mode
Key Parameters: MA, CO_x, MANFS, INITO
When the MCOUT block is in the Manual mode, it does not update the value of the CO_x out-
puts. The CO_x are released and become settable by you.
When an FBM or FBC is connected, the manual value set into each CO_x is copied to the corre-
sponding output point. However, if the FBM or FBC has is out-of-service, then none of the
CO_x is settable.
When IOMOPT = 0, the values set into the CO_x are copied to the corresponding bits of
PAKCRB.
All other output parameters can be set during Manual mode, including CO_9 to CO_16 when
an FBM without expansion module is connected. However, note that these are set out-of-service
at initialization time.
Inversion, bypassing, and last good value retention are inactive in Manual mode.
1557
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
The cascade is considered open during Manual mode of the MCOUT block, whether or not there
is a connected FBM or FBC, and INITO is therefore kept true throughout the mode.
For a discussion of the MANFS parameter, see Section .
Application Diagram
IN_2
MCOUT
BO02 BO01 IN_1
Feedstock
CIN Solenoid
CIN
FBM241 Valve
or
CIN FBM09 oo
CIN
FLS001
Tank Full
Switch
FBM207
CIN or o
CIN o
FBM07 Tank Half
TFS001 Full Switch
CIN
CIN
Output
Product
Solenoid
Flow Valve
Switch
242
10
11
14
15
16
26
27
62
86
94
97
9
Hardware Type #
Point
1 O O O
2 O O O
3 O O O
1558
81. MCOUT – Multiple Contact Output Block B0193AX – Rev AA
241
242
10
11
14
15
16
26
27
62
86
94
97
9
Hardware Type #
Point
4 O O O
5 O O O
6 O O O
7 O O O
8 O O O
9 O O O O O O O O
10 O O O O O O O O
11 O O O O O O O O
12 O O O O O O O O
13 O O O O O O O O
14 O O O O O O O O
15 O O O O O O O O
16 O O O O O O O O
17 O O
18 O O
19 O O
20 O O
21 O O
22 O O
23 O O
24 O O
25 O O O O O O
26 O O O O O O
27 O O O O O O
28 O O O O O O
29 O O O O O O
30 O O O O O O
31 O O O O O O
32 O O O O O O
33 I/O I/O
34 I/O I/O
35 I/O I/O
36 I/O I/O
37 I/O I/O
38 I/O I/O
39 I/O I/O
40 I/O I/O
1559
B0193AX – Rev AA 81. MCOUT – Multiple Contact Output Block
241
242
10
11
14
15
16
26
27
62
86
94
97
9
Hardware Type #
Point
41 I/O I/O
42 I/O I/O
43 I/O I/O
44 I/O I/O
45 I/O I/O
46 I/O I/O
47 I/O I/O
48 I/O I/O
49 I/O I/O
50 I/O I/O
51 I/O I/O
52 I/O I/O
53 I/O I/O
54 I/O I/O
55 I/O I/O
56 I/O I/O
57 I/O I/O
58 I/O I/O
59 I/O I/O
60 I/O I/O
61 I/O I/O
62 I/O I/O
63 I/O I/O
64 I/O I/O
Legend: O = Output
I/O = Configurable as Input or Output
NOTE
Hardware Type 62 is used for FBC09.
Hardware Type 86 is used for FBC10.
Hardware Type 94 is used for FBC09 Redundant.
Hardware Type 97 is used for FBC10 Redundant.
1560
82. MDACT Motor Driven Actuator
Controller
This chapter covers the MDACT (Motor Driven Actuator Controller), providing an I/O
diagram and describing its features, parameters and detailed operations.
Overview
The Motor Driven Actuator Controller (MDACT) block, associated Equipment Control Blocks
(ECBs) and control algorithms located in the FBM17 Fieldbus Module provide a capability for
controlling processes through tri-state (for example, raise, lower, off ) devices. Two different algo-
rithms are provided.
The algorithms provide two digital outputs for controlling final-operator devices such as bi-direc-
tional, motor-driven actuators or dual-switch contactors.
When used with a bi-directional valve motor the feedback-lag algorithm acts as a PI controller.
The pulse-width-modulation (proportional-time) algorithm provides integral-only response with
a motor-driven valve.
The MDACT block and associated ECBs provide the user interface to the following control algo-
rithms located in the FBM17 Fieldbus Module:
♦ Feedback lag (FBM software type ECB34)
♦ Pulse width modulation (FBM software type ECB36).
Locating the control algorithms in the FBM17 instead of the Control Processor (CP) block pro-
vides control outputs with the faster response times required by some processes. All inputs and
outputs between the FBM17 and the process that are related to the MDACT controller are avail-
able to the CP block and control schemes as block parameters.
The pulse width modulation algorithm (ECB36) supports a local operator’s panel (Foxboro Deut-
schland) that has an Auto/Manual toggle key and keys for driving the increase and decrease digital
outputs in Manual.
1561
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
I/O Diagram
Features
The features are:
♦ Feedback-lag algorithm (FBM software type 34)
♦ Pulse-width-modulation algorithm (FBM software type 36)
♦ Manual/Auto control of the outputs, which can be initiated by a host process or
another block
♦ Auto and Manual latch switch inputs (AUTSW and MANSW) that allow the block
to be retained in Auto or Manual
♦ Local/Remote setpoint source selection
♦ Local and Remote latch switch inputs (LOCSW and REMSW) that allow the block
to be retained in local or Remote Setpoint
♦ Bad inputs detection, handling, and alarming
1562
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
1563
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
♦ INITMA, Initialize Manual/Auto, specifies the desired state of the MA input during
initialization.
♦ PRIBLK, Primary Block, enables a block in a cascaded configuration to initialize
without bumping the process, either at initial start-up or whenever control is trans-
ferred up to a primary block.
♦ MANFS, Manual If Failsafe, when configured true, drives the block to the Manual
state if the block detects an incoming failsafe status.
♦ BADOPT, Bad and Out-Of-Range Option, specifies the conditions that set the BAD
output true, when the block is in Auto, or in Manual with MANALM set true.
BADOPT values range from 0 to 3.
♦ Workstation lock (LOCKRQ) allows write access to the block parameters only by the
Display Manager (LOCKID) that owns the lock.
♦ Loop identifier (LOOPID) allows you to identify the loop or process unit that con-
tains the lock.
♦ OWNER allows the allocation of control blocks to applications.
♦ Panel Option (PNLOPT in ECB) allows connection of a local operator’s panel (Fox-
boro Deutschland) with status indicator lights, 0 to 100% meter display of the
measurement, Auto/Manual toggle key, and keys for driving the increase and decrease
digital outputs in Manual.
Parameters
Table 82-1. MDACT Block Parameters
1564
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
1565
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
1566
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
Parameter Definitions
ACHNGE A Change is a 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. The MDACT block
uses only the following bits:
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
B9
1567
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
ALMSTA Alarm Status is a 32-bit output that is bit-mapped to indicate the block’s
alarm states. The MDACT block uses only the following bits:
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
UNACK B2
B3
B4
B5
B6
B7
B8
B9
CRIT PRTYPE
OOR
HMA
HHA
HDA
BAD
LMA
LDA
LLA
INH
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
0 to 4 PRTYPE** Priority type (0 to 25)* ALMSTA.B32-
ALMSTA.B28
5 to 7 CRIT** Criticality (0 to 5)* ALMSTA.B27-
ALMSTA.B25
16 LMA Low measurement alarm ALMSTA.B16
17 HMA High measurement alarm ALMSTA.B15
20 LDA Low deviation alarm ALMSTA.B12
21 HDA High deviation alarm ALMSTA.B11
22 BAD Bad I/O alarm ALMSTA.B10
24 LLA Low-low absolute alarm ALMSTA.B8
25 HHA High-high absolute ALMSTA.B7
28 OOR Out-of-range alarm ALMSTA.B4
29 INH Inhibit alarm ALMSTA.B3
30 UNACK Unacknowledged alarm ALMSTA.B2
1568
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
AMRTIN Alarm Regeneration Timer is a configurable integer that specifies the time
interval for an alarm condition to exist continuously, after which a new
unacknowledged alarm condition and its associated alarm message is gen-
erated.
AUTSW Auto Switch is a boolean input. When true, it overrides the MA and
INITMA parameters, and drives the block to the Auto state. If both
MANSW and AUTSW are true, MANSW has priority.
BAD Bad is a boolean output parameter which is set true when the input to the
block is unacceptable in any way. The BAD bit of BLKSTA (BLK-
STA.BAD) is also set true whenever BAD is true.
BADACT Bad Action is a configurable integer input that specifies block action when
the BAD block status is true. BADACT values range from 0 to 2, and
indicate the following actions:
0= The block takes no action.
1= The block goes into Manual, overriding MANSW, AUTSW,
INITMA, and any connection to MA (MA is secured and set
to zero).
2= The block goes into the Hold state (HOLDMD is secured and
set to true).
BADOPT Bad and Out-of-Range Option is a configurable integer input that speci-
fies the conditions that set the BAD output true, when the block is in
Auto, or in Manual with MANALM set true. BADOPT values range from
0 to 3, and map to the following conditions:
0 = Bad_Status.
1 = Bad_Status or Low Out-of-Range.
2 = Bad_Status or High Out-of-Range.
3 = Bad_Status or Low Out-of-Range or High Out-of-Range.
Bad_Status is the OR output of the two inputs, ECB Status and Channel
Status, so that Bad_Status is true when either ECB Status or Channel Sta-
tus is true. Channel status is the OR output of the rate-of-change status,
measurement limits status, and other FBM data conversion checks. The
1569
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
ECB parameter ROC1 specifies the rate-of-change limit for the measure-
ment input. Block parameters MEASHL and MEASLL specify the mea-
surement limits.
To provide backward compatibility, BADOPT defaults to 3, and the High
(HOR) and Low (LOR) out-of-range conditions set the BAD output true
when the BADOPT parameter is defaulted.
Select BADOPT so that the sensor failure mode is included in the BAD
output. For instance, for current loops enter a 1 for BADOPT, since cur-
rent loops fail to zero current, which is a detectable failure mode. Con-
versely, do not use the high out-of-range test for bad detection, because a
high signal condition is a typical mode of transmitter operation (that is,
high flow), and does not constitute a failure mode. For thermocouples,
you might enter a value of 2, because they fail to the high end of the scale.
BAG Bad Alarm Group is a short integer input that directs BAD alarm messages
to one of eight groups of alarm devices. You can change the group number
through the workstation.
BAO Bad Alarm Option is a configurable boolean value. When configured true,
it enables alarm generation for each state change of the BAD parameter.
BAP Bad Alarm Priority is an integer input, ranging from 1 to 5, that sets the
priority level of the Bad alarm (1 is the highest priority).
BCALCO Back Calculation Output is a real output that is usually equal to the Mea-
surement input. It is the set point value that maintains the output value
when the block returns to normal mode after initializing or tracking. The
BCALCO data record contains the initialization and open cascade status
bits. You connect BCALCO to the BCALCI input of upstream block so
that the upstream block can sense when the MDACT block has initialized
or is open loop.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate various block oper-
ational states. For the MDACT block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
STRK B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
MAO
FBM
BAD
LRO
HLD
CTL
MO
MA
ON
DF
LR
FS
1570
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
Bit Boolean
Number1 Connection
(0 to 31) Name Description When True (B32 to B1)
5 CTL Controlling BLKSTA.B27
7 HLD Holding BLKSTA.B25
8 FBM FBM failure BLKSTA.B24
9 STRK Set point tracking BLKSTA.B23
10 LR Local = 0; Remote = 1 BLKSTA.B22
11 MA Manual = 0; Auto = 1 BLKSTA.B21
12 BAD Bad I/O BLKSTA.B20
14 UDEF Undefined BLKSTA.B18
15 ON Compound on BLKSTA.B17
20 WLCK Workstation lock BLKSTA.B12
22 DF Device fail BLKSTA.B10
23 MO Manual override (panel) BLKSTA.B9
24 FS Failsafe BLKSTA.B8
25 LRO Local/Remote override BLKSTA.B7
26 MAO Manual/Auto override BLKSTA.B6
1.
Bit 0 is the least significant, low order bit.
CEOPT Control Error Option is a short integer that specifies how the block
responds to the MEAS input when it is in error. To provide backward
compatibility, CEOPT defaults to 1. CEOPT has a range of 0 to 2 where:
0 = The block takes no implicit Hold action when it detects a control
error.
1 = The block goes to the Hold state if:
♦ MEASMD has its BAD status bit set true.
♦ MEASMD has its Out-of-Service status bit set true.
♦ CPMEAS experiences peer-to-peer path failure when CPCONT
is configured in the ECB.
2 = The block goes to the Hold state if:
♦ MEASMD meets any of the conditions described for CEOPT = 1.
♦ MEASMD has its ERROR status bit set true.
CEOPT does not affect the external logical input HOLDMD or the FBM
Point 9 Hold input. Either HOLD input, when true, still drives the block
into the Hold state whenever the block is in Auto.
CPMEAS CP Measurement is a real input that the algorithm uses in place of the
FBM measurement input, when it is in the CP control mode (that is, the
CP control option CPCONT in the ECB is configured true).
1571
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
DALOPT Deviation Alarm Option is a short integer input that enables High and
Low deviation alarming, or disables alarming altogether.
0 = No alarming.
1 = High and Low deviation alarming.
2 = High deviation alarming only.
3 = Low deviation alarming only.
You can change DALOPT only by reconfiguring the block.
DECMD Decrease Output (FBM Point 12) is a boolean output. When true,
DECMD drives the actuator in the decrease direction. In Auto, the algo-
rithm compares the MEAS input with the selected (local or remote) set-
point to switch DECMD on or off.
For the feedback-lag algorithm, DECMD switches on when the [deviation
+ feedback lag • proportional band] rises above the (dead-zone high limit
+ deadband). DECMD switches off when the above calculation falls below
the dead-zone high limit.
For the pulse-width-modulation algorithm, when the (measurement − set-
point) rises above the dead-zone high limit, DECMD switches on for a
time duration that is based on the amount of deviation and the propor-
tional band. DECMD continues to switch on as above for each REPTMD
time, until the [measurement-setpoint] falls below the dead-zone high
limit, for which case DECMD remains off and the pulse train stops.
In Manual, the output is settable, and you can use the MANDEC param-
eter to drive the actuator in the decrease direction.
DEFINE Define is a boolean data store which when true indicates that the block
has no configuration errors. It is the inverse of UDEF in parameter BLK-
STA. When the block initializes, DEFINE is set to 0 (undefined) if the
block detects a parameter configuration error. To return DEFINE to a
true state, correct all configuration errors and reinstall the block.
DELTI1 Change Delta for Input Range 1 is a real value that defines the minimum
percent of the input range that triggers change driven connections for
parameters in the range of RI1. The default value is 1.
Entering a 1 causes the Object Manager to recognize and respond to a
change of 1 percent of the full error range. If communication is within the
same CP that contains the block’s compound, change deltas have no
effect.
Refer to “Peer-to-Peer Connections of Real-Type Block Inputs” on
page 955 for details on how the I/A Series software affects the change delta
percentage during operation.
1572
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
DEVADB Deviation Alarm Deadband is a real input (range RI1) that applies to both
High and Low Deviation Alarm Limits.
DEVGRP Deviation Group is a short integer input that directs deviation alarm mes-
sages to one of eight groups of alarm devices.
DEVPRI Deviation Priority is a integer input (1 to 5) that sets the priority level of
the deviation alarm (1 is the highest priority).
DEV_ID Device Identifier is a 6-character array input that specifies the 6-character
letterbug identifier of the FBM.
EI1 Engineering Units for Input Range 1 is a 32-character strings that pro-
vides the engineering units text for the value defined by the range for
input 1. The value configured for this text string should be consistent with
the values used for HSCI1 and LSCI1.
ERCODE Error Code is a string data store that indicates the type of configuration
error that first caused the block to set the DEFINE parameter to false.
Validation of configuration errors does not proceed past the first error
encountered by the block logic.
ERROR Control Error is a real output that equals (Setpoint minus Measurement).
ERROR can be sourced to other blocks.
FS Failsafe is a boolean output that is set true when the block detects the
FBM going to the Failsafe state. While in this state, the block retains the
actual Failsafe value of the output points as they are read back from the
FBM. These values, depending on the ECB Failsafe option, are either the
fallback or the Hold value.
GAPDBM Gap Deadband for MDACT is a real value applied to both extremes of the
gap. GABDBM is only used with the ECB34 Pulse-Width Modulation
Algorithm. It is the deadband for each of the two switch elements. It has
the same units as MEASMD and SPT. Configure a value large enough to
prevent the outputs OUTDEC and OUTINC from chattering. You can
adjust this parameter at the workstation.
GAPMD Gap MDACT is a real input that defines a dead-zone region in which the
deviation [SPT − MEASMD], as modified by any feedback lag, may
traverse without activating either of the two boolean outputs (the gain of
the controller is zero). GAPMD is used in both the feedback-lag and
pulse-width-modulation algorithms.
The dead zone, that is, GAPMD, is always centered about the setpoint.
GAPMD has the same units as MEASMD and SPT.
1573
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
HDAIND High Deviation Alarm Indicator is a boolean output that is set true when
the measurement exceeds the set point by more than the deviation limit
HDALIM. When the measurement passes back through the DEVADB
deadband, the block sets HDAIND to false.
HDALIM High Deviation Alarm Limit is a real input that specifies the amount by
which the measurement must exceed the set point to initiate a high devia-
tion alarm and set the High Deviation Alarm Indicator, HDAIND, true.
HHAGRP High-High Alarm Group is a short integer input that directs High-High
Absolute Alarm messages to one of eight groups of alarm devices.
HHAIND High-High Alarm Indicator is a boolean output that is set true when the
measurement input (MEAS) is greater than the high-high absolute alarm
limit (HHALIM). HHAIND is reset to false when the MEAS value is less
than HHALIM minus a deadband.
HHALIM High-High Alarm Limit is a real input (range RI1) that defines the value
of the measurement input (MEAS) that triggers a High-High alarm.
HHAPRI High-High Alarm Priority is a integer input (1 to 5) that sets the priority
level of the high-high absolute alarm (1 is the highest priority).
HMLIM High Measurement Limit is a real input that specifies the high limit for
the Point 1 measurement.
HOLDMD Hold MDACT is a boolean input. When true, HOLDMD forces the
controller into the Hold state (substate of Auto), in which the outputs
INCMD and DECMD are held false. This holds the motor driven actua-
tor or other final operator at its current position. HOLDMD has higher
priority than MANINC and MANDEC in the FBM.
HORMD High Out-of-Range is a boolean output that indicates the high out-of-
range status of FBM range checking on the FBM measurement input to
the algorithm. HORMD is true when the measurement input is equal to
or greater than the abscissa of the last characterizer end-point, when the
1574
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
HSCI1 High Scale for Input Range 1 is a configurable real value that defines the
upper limit of input range RI1. EI1 define the units. Make the range and
units consistent with those of the input source. The default value is
100 (percent).
INCMD Increase Output (FBM Point 11) is a boolean output. When true,
INCMD drives the actuator in the increase direction. In Auto, the algo-
rithm compares the MEAS input with the selected (local or remote) set-
point to switch INCMD on or off.
For the feedback-lag algorithms, INCMD switches on when (deviation +
feedback lag proportional band) falls below the dead-zone low limit-dead-
band. INCMD switches off when the above calculation rises above the
dead-zone low limit.
For the pulse-width-modulation algorithm, when (measurement − set-
point) falls below the dead-zone low limit, INCMD switches on for a time
duration that is based on the amount of deviation and the proportional
band. INCMD continues to switch on as above for each REPTMD time,
until the (measurement − setpoint) rises above the dead-zone low limit,
for which case INCMD remains off and the pulse train stops.
In Manual, the output is settable, and you can use the MANINC parame-
ter to drive the actuator in the increase direction.
INDSPT Independent Setpoint is a real input the FBM uses for the fallback set-
point when it is in the communication fail mode. Specify this option by
setting the independent control option INDCON in the ECB to the
value 1.
INHALM Inhibit Alarm is a packed boolean input that specifies the alarm inhibit
requests for each alarm type configured in the block. For the MDACT
block, only the following bits are used:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Boolean
Number* Connection
(0 to 15) Description When True (B16 to B1)
0 Inhibit Low Absolute Alarm INHALM.B16
1 Inhibit High Absolute Alarm INHALM.B15
1575
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
Bit Boolean
Number* Connection
(0 to 15) Description When True (B16 to B1)
4 Inhibit Low Deviation Alarm INHALM.B12
5 Inhibit High Deviation Alarm INHALM.B11
6 Inhibit Bad I/O Alarm INHALM.B10
8 Inhibit Low-Low Absolute Alarm INHALM.B8
9 Inhibit High-High Absolute Alarm INHALM.B7
12 Inhibit Out-of-Range Alarm INHALM.B4
INHIB Inhibit is a boolean input. When true, it inhibits all block alarms; the
alarm handling and detection functions are determined by the INHOPT
setting. Alarms can also be inhibited based on INHALM and the com-
pound parameter CINHIB.
INHOPT Inhibit Option specifies the following actions applying to all block alarms:
0= When an alarm is inhibited, disable alarm messages but do
not disable alarm detection.
1= When an alarm is inhibited, disable both alarm messages and
alarm detection. If an alarm condition already exists at the
time the alarm transitions into the inhibited state, clear the
alarm indicator.
2= Same as 0 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
3= Same as 1 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
INHSTA Inhibit Status is a packed long boolean output that contains the actual
inhibit status of each alarm type configured in the block. For the MDACT
block, only the following bits are used:
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
UNACK B2
B3
B4
B5
B6
B7
B8
B9
OOR
HMA
HOA
HHA
HDA
LMA
BAD
LOA
LDA
LLA
INH
1576
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
16 LMA Low Absolute Alarm Inhibited INHSTA.B16
17 HMA High Absolute Alarm Inhibited INHSTA.B15
18 LOA Low Output Alarm INHSTA.B14
19 HOA High Output Alarm INHSTA.B13
20 LDA Low Deviation Alarm INHSTA.B12
21 HDA High Deviation Alarm INHSTA.B11
22 BAD Bad I/O Alarm Inhibited INHSTA.B10
24 LLA Low-Low Absolute Alarm INHSTA.B8
Inhibited
25 HHA High-High Absolute Alarm INHSTA.B7
Inhibited
28 OOR Out-of-Range Alarm Inhibited INHSTA.B4
29 INH Inhibit Alarm INHSTA.B3
30 UNACK Unacknowledged INHSTA.B2
INITLR Initialize Local/Remote is an integer input that specifies the desired state
of the LR input during initialization, where:
0= Local.
1= Remote.
2= No change, except if a reboot, use the LR state specified in the
checkpoint file.
INITMA Initialize Manual/Auto is a short integer input that specifies the desired
state of the MA input during initialization:
0= Manual.
1= Auto.
2= No change, except if a reboot, use the MA state specified in the
checkpoint file.
1577
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
IOM_ID Fieldbus Module Identifier is a configurable string input that specifies the
ECB34 or ECB36 for the FBM that contains the algorithm for this block.
It is the full pathname of the ECB, that is:
<LOCAL_COMPOUND_NAME>:<ECB_name>
<LOCAL_COMPOUND_NAME> and <ECB_NAME> can each be up
to 12 characters.
LAGMD Feedback Lag is a real output that acts as the integral time constant in a
feedback-lag algorithm. If the algorithm is controlling a bi-directional
valve motor, it acts as a PI controller with LAGMD as the integral time
constant. LAGMD ranges in value from -100.0 to +100.0.
LAGTMD Lag Time is a real input that specifies the process lag time for the
MDACT feedback-lag algorithm in minutes. It corresponds to the inte-
gral time constant.
LDAIND Low Deviation Alarm Indicator is a boolean output that is set true when
the measurement falls below the set point by more than the deviation
limit, LDALIM. When the measurement passes back through the
DEVADB deadband, the block sets LDAIND to false.
LDALIM Low Deviation Alarm Limit is a real input that defines how far the mea-
surement must fall below the set point to initiate a low deviation alarm
and set the Low Deviation Alarm Indicator LDAIND true.
1578
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
LIMDEC Limit Decrease is a boolean output that indicates the state of the decrease
limit switch. When LIMDEC is true, the actuator is at the decrease limit.
LIMINC Limit Increase is a boolean output that indicates the state of the increase
limit switch. When LIMINC is true, the actuator is at the increase limit.
LLAIND Low-Low Alarm Indicator is a boolean output that is set true when the
measurement (MEASMD) falls below the low-low absolute alarm limit
(LLALIM). LLAIND is reset to false when the value is greater than LLA-
LIM plus a deadband.
LLALIM Low-Low Alarm Limit is a real input that defines the value of the mea-
surement (MEASMD) that triggers a Low-Low Alarm.
LMLIM Low Measurement Limit is a real input that specifies the low limit for the
Point 1 measurement.
LOCKID Lock Identifier is a string data store that identifies the workstation that has
exclusive write access to the block. LOCKID arbitrates write access to the
control block parameters by operator workstations on the network. Set
requests to any of the block’s parameters are honored only if the requesting
workstation’s identifier matches the contents of LOCKID.
The lock-request message sets LOCKRQ to true and sets LOCKID to the
identifier of the requesting workstation. The lock-release message clears
LOCKRQ and nulls LOCKID.
LOCKID has the format LETTERBUG:DEVNAME, where LETTER-
BUG is the 6-character letterbug of the workstation and DEVNAME is
the 6-character logical name of the Display Manager.
LOCKRQ Lock Request is a boolean data store that is set true or false by toggling the
LOCK U/L key on the Block Detail Display. An operator at any other
workstation can lock and unlock the block by toggling the LOCK U/L
key.
The lock-request message sets LOCKRQ true, sets LOCKID to the iden-
tifier of the requesting workstation, and sets the WLCK bit in the BLK-
STA parameter. Set requests to any of the block’s parameters are y honored
only if the requesting workstation’s identifier matches the contents of
LOCKID.
The lock-release message resets LOCKRQ, nulls LOCKID, and resets the
WLCK bit.
NOTE
Do not set LOCKRQ with an application program.
1579
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
LOCSP Local Set Point Secure is a boolean input. When true, it provides lockout
of user write access to the LR parameter. If LOCSP is configured true, the
block secures LR when it initializes and maintains LR in the secured state.
The LOCSW and REMSW overrides have higher precedence, but LR
remains secured when they are no longer asserted.
LOCSW Local Switch is a boolean input. When true, it overrides the LR and
INITLR parameters and drives the block to the Local state. If both
LOCSW and REMSW are true, LOCSW has priority.
LORMD Low Out-of-Range is a boolean output that indicates the low out-of-range
status of FBM range checking on the FBM measurement input to the
algorithm. LORMD is true if the measurement input is equal to or less
than the abscissa of the first characterizer end-point, when the character-
izer enable option CHAREN in the ECB is true. LORMD is also true if
the measurement input is equal to or less than the low out-of-range value
LORVAL in the ECB, when CHAREN is false and the out-of-range
enable option OORENB in the ECB is true. LORMD is independent of
BAD.
LSCI1 Low Scale for Input Range 1 is a configurable real value that defines the
lower limit of input range RI1. EI1 defines the units. Make the range and
units consistent with those of the input sources. The default value is
0 (percent).
MA Manual /Auto is a boolean input that controls the block’s operating state:
0 = Manual
1 = Auto
In Manual, each MDACT block output is unsecured, which makes it set-
table by an external process (program or display). In Auto, the block
secures each output so that they cannot be set externally. When MA is tog-
gled, its status is displayed on the faceplate of the Block Detail Display.
1580
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
MANALM Manual Alarm Option is a configurable input which enables and disables
configured alarm options to function in Manual. Normally alarms are
processed only in the Auto mode.
0 = No alarming in Manual
1 = Full alarming in Manual
MANDEC Manual Decrease is a boolean input. When true, MANDEC causes the
FBM to drive the actuator in the decrease direction, provided it is in the
Manual mode. In the FBM, if both MANDEC and HOLDMD are true,
HOLDMD has priority. MANDEC is not accessible from the
Configurator.
MANINC Manual Increase is a boolean input. When true, MANINC causes the
FBM to drive the actuator in the increase direction, provided it is in the
Manual mode. In the FBM, if both MANINC and HOLDMD are true,
HOLDMD has priority. MANINC is not accessible from the
Configurator.
MANSW Manual Switch is a boolean input. When true, it overrides the MA and
INITMA parameters and drives the block to the Manual state. If both
MANSW and AUTSW are true, MANSW has priority.
MEASHI Measurement High Alarm Indicator is a boolean output that is set true
when the measurement exceeds the high alarm limit (MEASHL). When
the measurement passes back through the deadband, the block sets
MEASHI to false.
MEASHL Measurement High Alarm Limit is a real input that defines the value of
the measurement that initiates a high absolute alarm.
1581
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
MEASLI Measurement Low Alarm Indicator is a boolean output that is set true
when the measurement falls below the low alarm limit (MEASLL). When
the measurement passes back through the MEASDB deadband, the block
sets MEASLI to false.
MEASLL Measurement Low Alarm Limit is a real input that defines the value of the
measurement that initiates a low absolute alarm.
MEASPR Measurement Priority is a integer input (1 to 5), that sets the priority level
of the measurement alarm (1 is the highest priority).
MNDUTD Manual Decrease Duty Cycle is an integer input that specifies the duty
cycle for driving the actuator in the decrease direction when the FBM
with pulse-width-modulation algorithm is in Manual.
MNDUTH Manual Duty Cycle High is an integer input that specifies the upper range
limit of the duty cycle for driving the actuator, when the FBM with pulse-
width-modulation algorithm is in Manual.
MNDUTI Manual Increase Duty Cycle is an integer input that specifies the duty
cycle for driving the actuator in the increase direction, when the FBM
with pulse-width-modulation algorithm is in Manual.
MNDUTL Manual Duty Cycle Low is an integer input that specifies the lower range
limit of the duty cycle for driving the actuator, when the FBM with pulse-
width-modulation algorithm is in Manual.
MODEMD Mode of MDACT is a short integer data store that indicates the mode of
the MDACT algorithm:
1 = Feedback lag using FBM Point 1 measurement
3 = Pulse width modulation using FBM Point 1 measurement
5 = Feedback lag using CPMEAS measurement
7 = Pulse width modulation using CPMEAS measurement
1582
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
OWNER Owner is a string data store of up to 32 ASCII characters that are used to
allocate control blocks to applications. Attempts to set OWNER are only
successful if its present value is the null string, an all-blank string, or
identical to the value in the set request. Otherwise the request is rejected
with a LOCKED_ACCESS error. Any application can clear OWNER by
setting it to the null string, which is always accepted. Once set to the null
string, an application can then set the value as desired.
PBAND1 to PBAND2
Proportional Bands 1 and 2 are real inputs that determine, for any given
deviation, the INCMD or DECMD pulse width (pulse “on” time dura-
tion) for each repeat time, REPTMD in the MDACT pulse width modu-
lation algorithm. PBAND1 is used, by convention, as the single
proportional band for the feedback lag algorithm.
Pulse width modulation uses two proportional bands to compensate for
any actuator inertia difference between the increase and decrease direc-
tions. When the measurement is less than the setpoint, PBAND1 is used
to drive the actuator in the increase direction. When the measurement
exceeds the setpoint, PBAND2 is used to drive the actuator in the decrease
direction.
PBAND1 and PBAND2 default to 1000. Decreasing the PBAND1 or
PBAND2 value increases the pulse width and sensitivity for a given devia-
tion. Increasing either value decreases the pulse width and sensitivity for a
given deviation.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1583
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40 and CP40B.
PHASE Phase is an integer input that causes the block to execute at a specific BPC
within the time determined by the PERIOD. For a CP with a BPC of 0.5
s and a PERIOD of 2.0 s, the legal PHASE values are 0, 1, 2, and 3. Refer
to the appropriate Integrated Control Software Concepts document
(B0700AG or B0193AW).
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
MDACT block. It is used only if the PRIBLK option is set. The cascade is
closed automatically when the timer expires without requiring an explicit
acknowledge by the upstream block logic.
1584
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
PRSCAS Present Cascade State is a data store that indicates the cascade state. It has
the following possible values:
Value State Description
1 “INIT_U” Unconditional initialization of the primary
cascade is in progress.
2 “PRI_OPN” The primary cascade is open.
3 “INIT_C” Conditional initialization of the primary cas-
cade is in progress.
4 “PRI_CLS” The primary cascade is closed.
PRSCON Present Control state is a short integer data store that contains the sub-
states of Auto:
1 = Holding
3 = Controlling (not open loop)
PRTYPE Priority Type is an indexed short integer output that indicates the alarm
type of the highest priority active alarm. The PRTYPE outputs of this
block includes the following alarm types:
0 = No active alarm
1 = High absolute
2 = Low absolute
3 = High-high
4 = Low-low
5 = High deviation
6 = Low deviation
8 = Bad alarm
25 = Out-of-range
If there is more than one active alarm with highest priority, PRTYPE
reports the alarm type according to which occurs first as follows: Bad Out-
of-Range, High-High Absolute, Low-Low Absolute, High Absolute and
Low Absolute.
For example: if the Bad and High-High Absolute alarms both have prior-
ity 3 and the Out-of-Range alarm has priority 4, and all three alarms are
active, then CRIT = 3 and PRTYPE = 8.
1585
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
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
B9
Bit Boolean Connection
Number1 Definition Contents (B32 to B1)
30 Alarms Unacknowledged ALMSTA.UNA QALSTA.B2
29 Alarms Inhibited ALMSTA.INH QALSTA.B3
25 High-High Absolute Alarm ALMSTA.HHA QALSTA.B7
24 Low-Low Absolute Alarm ALMSTA.LLA QALSTA.B8
21 High Deviation Alarm ALMSTA.HDA QALSTA.B11
20 Low Deviation Alarm ALMSTA.LDA QALSTA.B12
17 High Absolute Alarm ALMSTA.HMA QALSTA.B15
16 Low Absolute Alarm ALMSTA.LMA QALSTA.B16
5 Manual BLKSTA.MA QALSTA.B27
2 Uncertain MEAS.ERR status QALSTA.B30
1 Out-of-Service MEAS.OOS status QALSTA.B31
0 Bad MEAS.BAD status QALSTA.B32
1.
Bit 0 is the least significant, low order bit.
RAWC Raw Count is a real output representing the FBM Point 1 measurement
input before any scaling or characterization is applied. It is of real data
type although the ECB value can be integer, or long integer.
REMSW Remote Switch is a boolean input. When true, it overrides the unlinked
LR and INITLR parameters, and drives the block to the Remote state. If
both LOCSW and REMSW are true, LOCSW has priority.
RI1 Range Input 1 is a data store array of real values that specify the high and
low engineering scale and change delta for the measurement (MEASMD),
and deadband (GAPDBM). For this block, it also forms an association
with a group of real input parameters that have the same designated range
and change delta.
REPTMD Repeat Time is a real input that establishes the periodic time interval, in
seconds, for switching “on” the algorithm output, INCMD or DECMD.
Within each time interval, the pulse width (percentage of “on” time) of
the appropriate output is directly proportional to the amount of deviation
that exists at the instant the time period begins, and inversely proportional
1586
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
to the proportional band. The block converts the entered REPTMD value
in seconds to a multiple of 25 ms. (Values are rounded upward).
RSP Remote Set Point is a real input that is the selected set point source when
LR is set to Remote. Typically RSP connects to an upstream block in a
cascade scheme. RSP and its source must be expressed in MEAS units
(RI1).
SPT Set Point is a real output that always represents the active controller set
point. Set point is the reference variable that is compared with the MEAS
input to produce the ERROR signal. SPT is implemented as a config-
urable output that determines its source from the Local/Remote set point
selector, LR.
When LR is true (Remote), SPT is nonsettable and assumes the Remote
set point (RSP) value. When LR is false (Local), SPT is an unsecured, and
thus settable, output and the SPT source is the user set value.
Configure the value you want the SPT to assume when it first goes to
Local. As an output, SPT can also source the set point value to other
blocks.
While settable by default, SPT is nonsettable while setpoint tracking is
active. (See STRKOP.)
STRKOP Setpoint Track Option is a short integer input. When active, STRKOP
enables the setpoint to track the measurement input under the following
conditions.
0 = no option enabled
1 = SPT parameter tracks the measurement when the following conditions
are met:
- There is no Control Error present in the MDACT block.
- The MDACT block is set to Manual.
- The MDACT block is using local setpoint.
2 = SPT parameter tracks the measurement when the following conditions
are met:
- The MDACT block is set to manual
- There is no Control Error present in the MDACT block.
SPT is nonsettable while setpoint tracking is active. You can change
STRKOP only by reconfiguring the block.
TYPE Type is a system-level mnemonic label indicating the block type. Enter
MDACT or select MDACT from the block type list under Show when con-
figuring the block.
UNACK Unacknowledge is a boolean output that the block sets to true when it
detects an alarm. It is typically reset by operator action.
1587
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
Detailed Operation
The MDACT control block and associated ECB, located in the CP database, provide the user
interface to the following algorithms located in an FBM17:
♦ Feedback lag (FBM software type 34)
♦ Pulse width modulation, (FBM software type 36).
The MDACT block can control bi-directional motor-driven valves, solenoid valves, and other
devices.
The MDACT and ECB blocks provide parameters to define the setpoint and tune the controller.
They also report the values of all variables exchanged between the FBM and the process, including
the controlled variables. The FBM does not handle alarm detection; the CP performs all alarm
detection and reporting.
During input and output scans, the ECB34 contains data exchanged between other I/O blocks
(AIN, AOUT, CIN, and COUT) in the CP and those I/O points of the FBM17 that are not used
by the MDACT controller.
The local operator’s panel option (PNLOPT) in ECB36 requires all FBM17 I/O channels that are
not used by the MDACT controller, that is, there are no spare channels available to you in this
configuration.
Duplicate output channel detection is intended to alert you to the fact that this block and another
block capable of digital outputs are connected to the same output point. This does not necessarily
constitute a conflict, since the other block may be in a compound which is not intended to run at
the same time as the compound containing this MDACT block.
When any digital I/O block undergoes one of the following actions, the entire data base is
checked for duplicate output channels:
♦ The block is installed.
♦ The IOMOPT (OP_FBM in the case of GDEV) parameter is modified.
♦ The IOM_ID or IOMIDR parameter is modified.
♦ A variable output point number (PNT_NO, CO1_PT, or CO2_PT) is modified, or,
in the case of MCOUT, the parameter GRPNUM is modified.
The duplicate output channel check is also performed when the Control Processor is rebooted. It
is not performed when a compound is switched On or Off.
All blocks connected to the same output point receive the DUPLICATE OUTPUT CHANNEL
warning message, but are not set Undefined.
The FBM17 I/O channel (point) assignments are listed in Table 82-2:
Table 82-2. FBM17 Channel Assignments
1588
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
NOTE
In the following text, assume that parameter names belong to the MDACT block,
unless they are identified as ECB parameters.
Applications
Figure 82-2 shows the MDACT block as a valve positioner for a furnace air damper, with feed-
back from a position sensor, for example, slide wire, in the actuator. This application uses the
MDACT pulse-width-modulation (Type 36) with the feedback signal connecting to the measure-
ment input, that is, FBM analog input Point 1. The PID controller sets the demand for valve
position via the remote setpoint (RSP) input.
1589
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
MEAS
SPT
PID
OUT
RSP
MDACT
(in CP)
SPT
FBM17
SPT
Pulse Width
MEASMD
Modulation
Algorithm
INCMD DECMD
(Increase) (Decrease)
Point 11 Point 12
Motor
Driven
Actuator
Position
Sensor
PT
Furnace
Air
Damper
Figure 82-3 shows the MDACT block as the secondary, steam-flow controller in a cascade control
loop for a heat exchanger. This application uses the MDACT feedback-lag algorithm (Type 34)
with the measurement input connecting to a flow transmitter. The primary, PID temperature
controller sets the demand for steam flow via the remote setpoint (RSP) input.
1590
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
MEAS
SPT
PID
OUT
RSP
MDACT
(in CP)
SPT
FBM17
SPT
MEASMD Feedback
Lag
Algorithm
INCMD DECMD
(Increase) (Decrease)
Point 11 Point 12
Motor
Driven
Actuator
FT TT
Steam Heat
Exchanger Heated water
Cold water
Figure 82-3. MDACT Controller Using Feedback-Lag Algorithm (Type 34)
Algorithm Selection
You can use either the feedback-lag or pulse-width-modulation algorithm to control a bi-direc-
tional valve motor.
For applications requiring combinations of proportional, integral, and derivative control action, a
PID block can be used to drive the MDACT block in a cascade arrangement with the algorithm
in the FBM acting as a controller (positioner).
If you are using the MDACT controller with an actuator without position feedback, the process
variable connects to the FBM measurement analog input channel and the setpoint sent by the
CP is the reference value for the process measurement.
1591
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
If the actuator provides position feedback (for example, through a slide-wire), then the position
transmitting element connects to the FBM measurement analog input channel, and the setpoint
represents the reference value for the position feedback.
If you select the feedback-lag algorithm which is not typical for position feedback, you may chose
to operate with or without feedback lag (FDBK = 0).
Feedback-Lag Algorithm
The feedback-lag algorithm provides two boolean output signals (INCMD and DECMD). Both
provide the logic to switch the signals on or off as a function of the deviation (MEASMD − SPT),
feedback lag, and proportional band.
In Auto, the algorithm compares the MEASMD input with the setpoint. When the (deviation +
feedback lag • proportional band) exceeds the (dead zone + deadband) the algorithm drives the
actuator in the decrease or increase direction by switching on one of two FBM digital outputs.
Point 12 (DECMD) is true for a negative deviation, or Point 11 (INCMD) is true for a positive
deviation. See Figure 82-4.
When using the limit switch inputs, FBM Points 7 and 8, the algorithm holds INCMD off when-
ever the increase limit switch is true, and it holds DECMD off whenever the decrease limit switch
is true. Setting the INVLIM option in the ECB to true inverts the assertion state of the limit
switches to provide increase-increase controller action. The limit switch states are available as
boolean outputs LIMINC and LIMDEC.
The FBM converts the process measurement on Point 1 to normalized raw count and then char-
acterizes the raw count using a 20-segment characterizer in the FBM. In the CP Control mode,
the FBM does not characterize CPMEAS.
For the feedback-lag algorithm, the LAGTMD parameter specifies the lag time of the process.
The feedback option, FDBK, in the ECB allows you to specify operation of the feedback-lag algo-
rithm with or without feedback lag.
GABDBM is applied to both extremes of the dead zone (± GAPMD) to provide a deadband for
each of two switch elements. This deadband prevents the boolean outputs, INCMD and
DECMD, from changing prematurely when the measurement is noisy. See Figure 82-4.
1592
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
70
60
50 . .
40 . . .
. . .
30 .. . .
. } Deadband = GAPDBM . . .
GAPMD 20 . . . . . .
10 .
. Dead Zone .
SPT 0 . . . . .
. .
-10 . . . . . .
. . . .
-GAPMD -20 . .
. } Deadband = GAPDBM .
-30 . . . . . .
-40 . . . . . .
-50 . . . .
1
INCMD
0
DECMD 0
Time
Figure 82-4. MDACT Feedback-Lag Algorithm
The dead zone and deadband define a region in which the deviation, as modified by the feedback-
lag term, can traverse without switching on either of two boolean outputs, that is, the gain of the
controller is zero.
INCMD goes on when the modified deviation falls below the (dead-zone low limit−deadband),
and it goes off when the modified deviation rises above the dead-zone low limit. DECMD goes on
when the modified deviation rises above the (dead-zone high limit + deadband), and it goes off
when the modified deviation falls below the dead-zone high limit.
1593
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
APPLICATION
Figure 82-5 is a block diagram of the feedback-lag algorithm.
Tv
E
Valve
P I or D
100 Lag
When used with a bi-directional motor-driven valve, the feedback-lag algorithm acts as a PI con-
troller, with the feedback lag as the Integral time constant; in this case, the true proportional band
is P(Tv/I), where Tv is the stroking time of the valve motor.
Pulse-Width-Modulation Algorithm
The pulse-width-modulation algorithm provides two boolean output signals (INCMD and
DECMD). Both have a fixed control period and the logic to turn an output “on” for a portion of
that control period. The algorithms control by varying the percentage of “on” time, that is, “duty
cycle,” within each control period. See Figure 82-6.
Deviation MEASMD
+100% PBAND = 100%
SPT
T = Period
-100%
Minimum Pulse Width
REPTMD t
1-
INCMD 0 - t
1-
DECMD 0 -
Figure 82-6. MDACT Pulse-Width-Modulation Algorithm (Timing Diagram)
The entire control period is called the repeat time, which is set when you enter a value for
REPTMD in units of seconds (with a minimum of 0.025 or 25 milliseconds). The percentage of
on time is inversely proportional to the proportional band value (PBAND1 or PBAND2) and
1594
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
directly proportional to the deviation (SPT − MEASMD) existing at the instant the
control period begins. Therefore, within each control period, the algorithms operate as linear pro-
portional-only controllers whose gain is adjusted by the proportional band setting.
The FBM converts the measurement input on Point 1 to normalized raw count and then charac-
terizes the raw count using a 20-segment characterizer in the FBM.
Each output operates independently, as a function of the sense of the deviation. INCMD is oper-
ational when the deviation is positive (measurement less than setpoint). DECMD is operational if
the deviation is negative (measurement greater than setpoint).
When using the limit switch inputs, FBM Points 7 and 8, the algorithm holds INCMD off when-
ever the increase limit switch is true, and it holds DECMD off whenever the decrease limit switch
is true. Setting the invert limit switch option, INVLIM, in the ECB to true inverts the assertion
state of the limit switches to provide increase-increase controller action. The limit switch states are
available as boolean outputs LIMINC and LIMDEC.
ALGORITHM OPERATION
Pulse width modulation uses two proportional bands to compensate for any actuator inertia dif-
ference between the increase and decrease directions. When the measurement is less than the set-
point, PBAND1 is used to drive the actuator in the increase direction. When the measurement
exceeds the setpoint, PBAND2 is used to drive the actuator in the decrease direction.
Use both boolean outputs, INCMD and DECMD, to control tri-state final operator devices such
as bi-directional motor-driven actuators and dual-switch contactors.
An adjustable band, ± GAPMD, centered about zero deviation, creates a dead-zone region. While
the deviation is in this region, both outputs are inoperative.
To prevent heating of the motor, set the minimum time, MINTIM, in the ECB to the required
minimum pulse width (in milliseconds) for the FBM outputs.
APPLICATION
For applications requiring combinations of proportional, integral, and derivative control action, a
PID block can be used to drive an MDACT block in a cascade arrangement using the pulse-
width-modulation algorithm as either a controller (positioner) or a signal converter.
Setpoint Control
The SPT parameter always represents the active controller setpoint. Since SPT is an output, it can
be sourced to other blocks.
The setpoint source selector input, LR (Local/Remote), together with the two overrides, LOCSW
and REMSW, determines the setpoint source at any time:
♦ When LR is switched to local (false), the block releases the SPT parameter, allowing
any user to input the desired controller setpoint value.
♦ When LR is switched to Remote (true) with the cascade loop closed, SPT is nonsetta-
ble and takes on the value and status of the remote setpoint input, RSP. RSP
establishes a link to a remote setpoint source. If RSP has no linkage when LR is true,
the block forces the LR parameter to local and secures it.
♦ The MDACT block also provides the LOCSW and REMSW parameters to drive the
setpoint state to Local or Remote.
1595
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
When the block restarts, the INITLR configured option specifies the value of the LR parameter,
unless LR is linked, or LOCSW or REMSW are set true.
LOCSP allows the block to secure the LR parameter when the block initializes and to maintain
that secured state.
When the block is switched to Remote mode, the setpoint status depends on the setpoint tracking
option (STRKOP):
♦ If STRKOP = 1 or 2, the SPT status copies the MEASMD status.
♦ If STRKOP = 0, the SPT status reflects the RSP status at the time the switch to
Remote occurred. The block maintains this status as long as it is in Remote, unless
you change the SPT value via data access. At that time the status is cleared.
The setpoint track option, STRKOP, forces the MDACT setpoint, SPT, to track the measure-
ment input, MEASMD. The block performs Setpoint tracking only if LR is switched to Local
and Manual. To prevent external manipulation, SPT is nonsettable while setpoint tracking is
active. While tracking, the setpoint status reflects the MEASMD status.
CP Control Mode
Setting the CP control option, CPCONT, in the ECB to true places the MDACT controller in
the CP Control mode. In this mode, the FBM logically disconnects the algorithm from the mea-
surement input, FBM Point 1, and connects it to an MDACT block input parameter, CPMEAS.
You can use the CP Control mode for those applications where the process measurement is not a
0 to 10 V dc signal. For example, if the measurement is a 0 to 20 mA signal, you can use an
FBM01 to read it and an AIN block to convert it to raw counts. With CPMEAS linked to the
AIN block output point, you can use the MDACT block to control the process. The FBM17 out-
puts remain under control of the MDACT algorithm.
If CPMEAS is disconnected while in the CP Control mode, the MDACT block goes to the Hold
state and sets HOLDMD true to issue a hold request to the FBM, which then drives the INCMD
and DECMD outputs to the off state.
Measurement Selection
In the FBM control mode, the measurement input, MEASMD, for the algorithm connects to
FBM analog input Point 1. In the CP Control mode, the FBM logically disconnects MEASMD
from FBM Point 1, and connects it to a block input parameter, CPMEAS.
In the FBM Control mode, the block sets the BAD status bit of MEASMD to true for the condi-
tions specified by the value of BADOPT. When the FBM is out-of-service (OOS), the block sets
the OOS status bit of MEASMD to true. If CEOPT is set to 1 or 2 and the MEASMD status is
BAD, the block indicates that the cascade is open. This also causes the controller to go to Hold
mode.
In the CP Control mode, the block copies the BAD and OOS status bits from CPMEAS to
MEASMD. If CEOPT is set to 1 or 2 and the CPMEAS status is in error (BAD, OOS, or Object
Manager Off-Scan), the block indicates that the cascade is open. This also causes the controller to
go to Hold mode.
Alarm Handling
Optionally, the MDACT block supports absolute, deviation, and Hi-Hi alarming of the measure-
ment. Configured alarming is always performed in Auto. Alarming is only performed in Manual
1596
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
if the MANALM option is configured true. The block logs, and generates, alarm messages if the
INHIB input is false.
The block supports BAD alarming when the BAO option is true. BAD alarming occurs when:
♦ FBM device status has errors.
♦ Channel status is bad.
♦ Measurement input, FBM Point 1, is bad as specified under the BADOPT
parameter description.
♦ If in CP Control mode, when CPMEAS is BAD.
The block supports deviation alarming of the measurement when the DALOPT option is not
equal to 0. Alarming can occur when the deviation, ERROR, exceeds either one of the limits,
HDALIM or LDALIM.
The block supports absolute alarming of the measurement when the MALOPT option is not
equal to 0. Alarming can occur when the measurement exceeds either one of the limits, MEASHL
or MEASLL.
Unacknowledge (UNACK) is a boolean output parameter which is set true, for notification pur-
poses, 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. The clearing of UNACK is normally via an
operator “acknowledge” pick on a default or user display, or via a user task.
Hold Mode
If the Hold input (FBM Point 9) or the HOLDMD parameter goes true while the FBM is in the
Auto mode, the FBM holds the process at the last controlled state by holding the outputs
INCMD and DECMD to off. When all error conditions are removed, the FBM resumes control-
ling the process via the algorithm. The Hold state is available as a CP block status bit.
In both the FBM and CP Control modes, the value of CEOPT determines when the MDACT
block goes to the Hold mode and sets HOLDMD to true to request the FBM to Hold.
HOLDMD can also be connected to another block.
1597
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
The FBM holds the INCMD and DECMD output off for the following conditions:
♦ FBM is not controlling the increase and decrease outputs, FBM Points 11 and 12.
♦ Hold input (FBM Point 9) is true.
♦ HOLDMD block parameter is true.
♦ Measurement is out-of-range and CEOPT is 1 or 2.
♦ Control error is detected in the MDACT block when in CP control mode.
♦ Measurement is BAD and BADACT=2.
♦ FBM is in Auto mode and the status of the measurement input is bad, that is:
♦ Point 1 is physically bad.
♦ Point 1 exceeds the rate-of-change limit defined by ECB parameter ROC1.
♦ Point 1 exceeds the measurement limits if MESLIM is set.
The FBM sets the Holding bit in the ECB for these conditions. The FBM also holds INCMD
and DECMD off in the following cases:
♦ FBM is in Manual mode and both MANINC and MANDEC are true.
♦ FBM is in Manual mode and both MANINC and LIMINC (FBM Point 7) are true.
♦ FBM is in Manual mode and both MANDEC and LIMDEC (FBM Point 8) are true.
1598
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
In Manual, the hold conditions described above have higher priority than MANINC and MAN-
DEC. When the Hold condition is true, the FBM considers MANINC and MANDEC as off
until it receives another Write Channel command from the CP. This avoids a possible bump in
the process when the Hold conditions are false before the next BPC in the CP.
When BADACT = 1 and MEASMD is BAD, the block goes to the Manual state. This condition
overrides MANSW, AUTSW, INITMA, and any connection on MA. When BADACT = 2, it
goes to Hold.
When the block restarts, the INITMA configured option specifies the value of the MA parameter,
unless MA has an established linkage, or MANSW or AUTSW are set true.
Characterization of Measurement
If the characterizer enable option, CHAREN, in the ECB is true, the FBM characterizes only the
FBM Point 1 measurement input. Characterization is not used in CP control mode, since
CPMEAS is assumed to be a conditioned signal.
The FBM converts the Point 1 measurement input to raw count and then converts the raw count
to normalized raw count. Then, a 20-segment characterizer in the FBM converts the normalized
raw count to characterized, normalized raw count. This is the value that the FBM uses as the mea-
surement input to the algorithm and that it sends up to the CP as MEASMD.
The characterizer can consist of less than 20 segments. The starting and ending points, STRPMD
and ENDPMD, in the ECB specify the beginning and ending abscissa points that the character-
izer is to use.
For example, if STRPMD is 4 and ENDPMD is 7, then the characterizer has three segments
which must be monotonically increasing:
X_4MD, Y_4MD to X_5MD, Y_5MD
X_5MD, Y_5MD to X_6MD, Y_6MD
X_6MD, Y_6MD to X_7MD, Y_7MD
In this example, the FBM considers as out-of-range those measurement values with normalized
raw counts less than X_4MD or greater than X_7MD provided CHAREN is true. The FBM uses
such values for solving the algorithm. The FBM determines their characterized values by extend-
ing the slope of the nearest segment and clamping the resulting calculated ordinates within the 0
to 64000 limits. The nearest segment is the last segment in the case of a high out-of-range value,
or it is the first segment in the case of a low out-of-range value.
1599
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
If the measurement limits option, MESLIM, in the ECB is true, and the FBM detects that the
Point 1 measurement input is outside of these limits, that channel status is set BAD. If the algo-
rithm is not running in the CP Control mode, the FBM then stops the algorithm and sets the
INCMD and DECMD outputs to off.
If the CHAREN option in the ECB is true, the FBM characterizes the measurement input before
comparing it to the limits.
1600
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
When the block detects that it is recovering from an FBM failure, it checks the appropriate chan-
nel bits in the FSAFE parameter in the ECB to determine if the failure was a Communications
Failure. If the associated channel bits are true in FSAFE, the block parameters FS are cleared. If
the block is Auto and MANFS is false, FS is cleared in one block cycle. If MANFS is true, the
block switches from Auto to Manual. If the block was either already in Manual or if it switches to
Manual, FS remains set true until the block switches to Auto or until the output parameter is
written to by you.
On the cycle that the block recovers from a failure or initializes, the block reads back the output
value from the FBM. This value is either the Hold value or the Fallback value dependent upon the
configuration of the FBM failsafe mask and failsafe data.
If INDCON is 2 and communications fail, the FBM uses the Point 2 input as the setpoint, if this
input passes the following checks:
♦ Rate-of-change check, if ROC2MD (ECB) is not zero.
♦ Measurement limits check using HMLIM and LMLIM limits, if MESLIM option
(ECB) is true.
♦ Range check using either the characterizer end-points if CHAREN option (ECB) is
true, or the HORVAL and LORVAL limits (ECB) if OORENB option (ECB) is true
and CHAREN is false.
If INDCON is 2 and any of the above checks on the Point 2 input fails, the FBM stops indepen-
dent control and sets the outputs to their Failsafe values.
ECB parameters FSMMMD, FSDMMD, FS5DMD and FS6DMD determine the Failsafe values
that the FBM assigns to the two analog and four digital outputs. These parameters are common
to other ECBs. For definitions of these parameters, refer to “Equipment Control Blocks” on
page 793.
Cascade Configuration
A typical cascade configuration using the MDACT block is shown below.
FBK MEASMD
BCALCI BCALCO
1601
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
Operator’s Panel
The FBM17 with ECB36 software supports a local operator’s panel (supplied by Foxboro Deut-
schland) with status indicator lights (LEDs), 0 to 100% meter display of the measurement,
Auto/Manual (A/M) toggle key, and keys for driving the increase and decrease outputs in Manual
(see Figure 82-8). These keys are momentary contacts. The FBM17 with ECB34 software does
not support a local operator’s panel.
When ECB36 parameter PNLOPT is configured true, you can use a local operator’s panel to
switch the controller algorithm in the FBM to Manual and then drive the controller digital out-
puts.
You enable the panel by setting PNLOPT to true. If PNLOPT is configured false, the FBM reads
and reports only the field device fail input. If ECB36 parameter INVDFI is set true, the FBM
inverts the device fail input.
If the panel is present, the FBM reads and processes the keys. The FBM monitors the A/M key for
up transitions to detect A/M transfer requests. If the controller is in manual, the FBM processes
the increase and decrease keys. While the increase or decrease output is active, the FBM rejects
write requests from the CP to change these outputs.
CP Failure
The CP fail output is set to light an LED on the panel when the:
♦ CP communications has timed out.
♦ Controller is not initialized for Auto control.
This LED indicates that the operator should use the panel to control the analog output. Opera-
tionally, it means that updated set points are not available for Auto control.
If the controller is not initialized, it is in Manual and the A/M toggle key is disabled.
If CP communication fails, the control algorithm is automatically switched to Manual if the fail-
safe option is appropriately set.
1602
82. MDACT Motor Driven Actuator Controller B0193AX – Rev AA
FBM17
Digital Output 1 Increase Output
FBM Fail
Analog Output 2
Auto
Digital Output 4
Manual
CP Fail
Digital Output 3
LED
Key
Increase
Analog Input 3
Decrease
Analog Input 4
Auto/Manual Toggle
Digital Input 3
1603
B0193AX – Rev AA 82. MDACT Motor Driven Actuator Controller
FBM Failure
The FBM fail analog output goes below zero volts which disables the panel keys and lights a panel
LED when the:
♦ FBM is powered up
♦ FBM is off-line
♦ FBM watchdog timer times out
♦ FBM software traps on a fault or error.
During normal operation of the controller software, this analog output is set to maximum voltage
(10.24 V dc).
1604
83. MEALM – Measurement Alarm
Block
This chapter describes the MEALM (Measurement Alarm Block), providing an I/O diagram
and describing its features, parameters and detailed operations.
Overview
The Measurement Alarm block (MEALM) serves as an alarm annunciator to activate the
I/A Series alarm mechanism when alarm conditions are detected by an external source such as
HTG. It supports Window-style ECBs. Other blocks that do not have alarm generation functions
(for example, Sequence Control type blocks) can also use the MEALM block.
The alarm block uses boolean input parameters as alarm indicators to trigger the alarm. The
alarm type (ALMTYP) for the MEALM block is a configurable parameter and it can assume one
of the following values:
1 – High/Low Absolute Alarms
2 – High-High/Low-Low Alarms
3 – Rate of Change Alarm
The block has a “BAD I/O” alarm option (BAO) to generate the alarm if the primary input to the
block (MESVAL) has the BAD status bit set. The block sets the BAD I/O indicator in ALMSTA
and the BAD boolean output indicator. BAD I/O alarm functions independently of ALMTYP.
An alarm inhibit features are handled according to common I/A Series rules.
1605
B0193AX – Rev AA 83. MEALM – Measurement Alarm Block
I/O Diagram
options: alarm names: misc:
ALMTYP INHOPT BAO HATXT LATXT BAT PNM MEASPR MEASGR BAP BAG
UNACK
HALMIN
RALMIN
BAD
LALMIN
PRTYPE
MESVAL
MEASHL CRIT
MEALM
MEASLL BLKSTA
MA
ALMSTA
EUI1
ALMOPT
INHIM
INHALM INHSTA
Features
The features are:
♦ Alarm message generation
♦ Alarm acknowledge support
♦ Bad input status detection and handling
♦ Alarm detection and/or alarm message inhibit (for all alarm types or individually)
♦ AUTO/MANUAL block operations.
The options are:
♦ The Bad I/O alarm option (BAO) generates a Bad I/O alarm when a primary input
status shows “BAD I\O”.
♦ The inhibit option (INHOPT) specifies actions to be taken when alarms are inhibited
in the block. If the option is configured to 0 (default), alarm messages are inhibited; if
it is configured to 1, alarm detection and message generation are inhibited; if it is con-
figured to 2 or 3, automatic acknowledgment is enabled.
♦ Alarm type (ALMTYP) selects the alarm type that generates a message.
1606
83. MEALM – Measurement Alarm Block B0193AX – Rev AA
Parameters
Table 83-1. MEALM Block Parameters
1607
B0193AX – Rev AA 83. MEALM – Measurement Alarm Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
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. For the MEALM block, only the following unshaded bits
are used
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
B9
Bit Number1
(0 to 31) Configured Alarm Option When True
0 Alarm Group 8 in Use
1 Alarm Group 7 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
1. Bit 0 is the least significant, low order bit.
1608
83. MEALM – Measurement Alarm Block B0193AX – Rev AA
ALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. For the MEALM block, only the following bits are used:
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
RATE B9
CRIT PRTYPE
HMA
HHA
BAD
LMA
LLA
INH
Bit Boolean
Number Connection
(0 to 31)* Name Description When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parameter ALMSTA.B32–
PRTYPE for values used in ALMSTA.B28
the MEALM block
5 to 7 CRIT_MSK Criticality; 5 = lowest ALMSTA.B27–
priority, 1= highest ALMSTA.B25
16 LMA Low Measurement Alarm ALMSTA.B16
17 HMA High Absolute Alarm ALMSTA.B15
22 BAD Input/Output Bad (BAD ALMSTA.B10
output of block)
23 RATE Rate of Change Alarm ALMSTA.B9
24 LLA Low-Low Absolute Alarm ALMSTA.B8
25 HHA High-High Absolute Alarm ALMSTA.B7
29 INH Alarm inhibit ALMSTA.B3
30 UNAK Unacknowledged ALMSTA.B2
ALMTYP Alarm Type is assigned to the generated alarm. It indicates the alarm type
for an alarm message via one of the following values:
0 – No Absolute or Rate of Change alarm messages
1 – High/Low Absolute alarm
2 – High-High/Low-Low Absolute alarm
3 – Rate of Change alarm.
AMRTIN Alarm Regeneration Timer is a configurable integer that specifies the time
interval for an alarm condition to exist continuously, after which a new
unacknowledged alarm condition and its associated alarm message is gen-
erated.
1609
B0193AX – Rev AA 83. MEALM – Measurement Alarm Block
BAD Bad is a boolean output parameter which is set true when the input to the
block is unacceptable in any way. The BAD bit of BLKSTA
(BLKSTA.BAD) is also set true whenever BAD is true.
BAG Bad Alarm Group is a short integer input that directs Bad alarm messages
to one of eight groups of alarm devices. You can change the group number
through the workstation.
BAO Bad Alarm Option is a configurable boolean which, when configured true,
enables alarm generation for each state change of the BAD parameter.
BAP Bad Alarm Priority is an integer input, ranging from 1 to 5, that sets the
priority level of the Bad alarm (1 is the highest priority).
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the MEALM block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
BAD
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
11 MA Manual(= false)/Auto(= true) BLKSTA.B21
12 BAD Bad I/O (I/O Blocks only - BLKSTA.B20
block in BAD state)
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
20 WLCK Workstation Lock BLKSTA.B12
CRIT Criticality is an integer output that indicates the priority, ranging from 1
to 5, of the block’s highest currently active alarm (1 is the highest priority).
An output of zero indicates the absence of alarms.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
1610
83. MEALM – Measurement Alarm Block B0193AX – Rev AA
DEFINE to a true value, correct all configuration errors and re-install the
block.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the MEALM block, the follow-
ing list specifies the possible values of ERCODE, and the significance of
each value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given block
PHASE COMBINATION” PERIOD, or block PERIOD not
compatible with compound
PERIOD.
“W44 – INVALID High range value is less than or equal
ENGINEERING RANGE” to low range value.
“W46 – INVALID INPUT The source parameter specified in the
CONNECTION” input connection cannot be found in
the source block, or the source
parameter is not connectable, or an
invalid boolean extension connection
has been configured.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
EUI1 Engineering units associated with MESVAL and its alarm limits.
HALMIN High Alarm condition is a boolean input, which triggers an alarm annun-
ciation as a result of 0-to-1 transition. It is designed for High-High/High
Absolute type of alarms.
ALMTYP indicates whether HALMIN is triggered for a High-High or
High Absolute alarm.
HATXT High Alarm Text is a string input containing the High alarm description
sent with the High or High-High alarm message.
ALMTYP indicates whether HATXT is assigned to a High-High or High
Absolute alarm.
1611
B0193AX – Rev AA 83. MEALM – Measurement Alarm Block
INHALM Inhibit Alarm contains packed boolean values that represent alarm inhibit
requests for each alarm type or point configured in the block. For the
MEALM block, only the following bits are used:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number* Boolean Connection
(0 to 15) Description 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
7 Inhibit Rate of Change Alarm INHALM.B9
8 Inhibit Low-Low Absolute INHALM.B8
Alarm
9 Inhibit High-High Absolute INHALM.B7
Alarm
INHIB Inhibit is a boolean input. When true, it inhibits all block alarms; the
alarm handling and detection functions are determined by the INHOPT
setting. Alarms can also be inhibited based on INHALM and the com-
pound parameter CINHIB.
INHOPT Inhibit Option specifies the following actions applying to all block alarms:
0= When an alarm is inhibited, disable alarm messages but do
not disable alarm detection.
1= When an alarm is inhibited, disable both alarm messages and
alarm detection. If an alarm condition already exists at the
time the alarm transitions into the inhibited state, clear the
alarm indicator.
2= Same as 0 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
3= Same as 1 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
1612
83. MEALM – Measurement Alarm Block B0193AX – Rev AA
INHSTA Inhibit Status contains packed long values that represent the actual inhibit
status of each alarm type configured in the block. For the MEALM block,
only the following bits are used:
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
UNACK B2
B3
B4
B5
B6
B7
B8
B9
RATE
OOR
HMA
HHA
BAD
LMA
LLA
INH
Bit Boolean
Number* Connection
(0 to 31) Name Description 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
23 RATE Rate of Change Alarm INHSTA.B9
24 LLA Low-Low Absolute Alarm INHSTA.B8
Inhibited
25 HHA High-High Absolute Alarm INHSTA.B7
Inhibited
29 INH Inhibit Alarm INHSTA.B3
30 UNACK Unacknowledged INHSTA.B2
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
♦ The compound in which it resides is turned on.
♦ The INITMA parameter itself is modified via the control configu-
rator. (The block does not assert INITMA on ordinary
reconfiguration.)
INITMA is ignored if MA has an established linkage.
1613
B0193AX – Rev AA 83. MEALM – Measurement Alarm Block
LALMIN Low Alarm Condition is a boolean input that triggers alarm annunciation
as a result of 0-to-1 transition. It is designed for the Low-Low/Low Abso-
lute type of alarms.
ALMTYP indicates whether LALMIN is triggered for a Low-Low or Low
Absolute alarm.
LATXT Low Alarm Text is a string, input containing the Low measurement alarm
description sent with the Low-Low or Low alarm message.
ALMTYP indicates whether LATXT is assigned to a Low-Low or Low
Absolute alarm.
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
MEASHL Measurement High Alarm Limit is a real input that defines the value of
the measurement that initiates a High-High or High absolute alarm.
ALMTYP indicates whether MEASHL holds the value of a High-High or
High absolute alarm limit.
1614
83. MEALM – Measurement Alarm Block B0193AX – Rev AA
MEASLL Measurement Low Alarm Limit is a real input that defines the value of the
measurement that initiates a Low-Low or Low absolute alarm.
ALMTYP indicates whether MEASLL holds the value of a Low-Low or
Low absolute alarm limit.
MEASPR Measurement Priority is an integer input (1 to 5), that sets the priority
level of the measurement alarm (1 is the highest priority).
MESVAL A process variable that is an input to the block, used to determine if a Bad
I/O alarm should be set.
1615
B0193AX – Rev AA 83. MEALM – Measurement Alarm Block
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the period time
lengths in the following table. (Integrator and Gateway blocks have differ-
ent period values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. The PRTYPE output of this block
includes the following alarm types:
0 = No active alarm
1 = High Absolute
2 = Low Absolute
3 = High-High Absolute
4 = Low-Low Absolute
7 = Rate of change alarm
8 = Bad I/O alarm
1616
83. MEALM – Measurement Alarm Block B0193AX – Rev AA
If there is more than one active alarm with highest priority, PRTYPE
reports the alarm type according to which occurs first as follows: Bad,
High-High Absolute, Low-Low Absolute, High Absolute and Low Abso-
lute.
For example: if the Bad and High-High Absolute alarms both have prior-
ity 3 and the Rate alarm has priority 4, and all three alarms are active, then
CRIT = 3 and PRTYPE = 8.
RALMIN Rate Alarm condition is a boolean input that triggers a rate of change
alarm annunciation as a result of a 0-to-1 transition.
TYPE When you enter “MEALM” or select “MEALM” from a configurator list,
it creates an identifying integer specifying this block type.
UNACK Unacknowledge is a boolean output that the block sets to True when it
detects an alarm. It is typically reset by operator action.
1617
B0193AX – Rev AA 83. MEALM – Measurement Alarm Block
Detailed Operation
After initialization and subsequent block scan periods, the MEALM block reads the alarm indica-
tor input parameters and the status of the parameters, and performs alarming and “BAD I/O”
alarming depending on INHALM, INHIB, INHOPT, and BAO. PRTYPE and CRIT reflect the
type and priority of the highest priority active alarm in the block.
To detect input transitions, the block uses internal alarm history for comparison. Initially, those
values are set to the “no alarm” state (zero value).
Block Validation
The validation logic includes the following verifications:
♦ ALMTYP is configured to 0, 1, 2, or 3.
♦ No connection is specified for RALMIN if ALMTYP is configured to 0, 1, or 2.
♦ No connection is specified for HALMIN and LALMIN if ALMTYP is configured to
0 or 3.
If the validation detects a problem, the block becomes undefined.
Block Initialization
The block executes a restart logic when its compound is switched from OFF to ON or when the
block is installed or modified within a compound that is already ON. The block clears its alarm
information. UNACK is reset by the high level logic (Compound Processor).
The station reboot operation forces initialization logic to run. All inputs not connected are reset.
1618
83. MEALM – Measurement Alarm Block B0193AX – Rev AA
Manual Operation
When the block is switched to MANUAL, no alarm detection logic is processed and the BAD
alarm indicator output is released. While the block is in MANUAL, you can change the indicator.
On transition from MANUAL to AUTO the block resets to zero the indicator and ALMSTA bits
and resumes its regular operation with the outputs secured.
Block Shutdown
When the compound is turned off, the block clears its alarm information.
Example
The following example demonstrates how to use MEALM, STALM, and MSG blocks in con-
junction with a Window ECB. Only the ECB parameters needed for the example are shown.
Alarm type can be configured as follows:
For the MEALM block:
♦ ALMTYP = 1 (High/Low Absolute).
♦ BAO (BAD I/O alarming) is configured to 1.
♦ BAP (Bad I/O alarm priority) is configured to 1.
The device message groups are configured as appropriate regarding the compound configuration.
All other block parameters are defaults. Connections are as shown in Figure 83-2.
1619
B0193AX – Rev AA 83. MEALM – Measurement Alarm Block
VAL1 MESVAL
BAD
TXT1 EUI1
MEALM
VALHI MEASHL ALMSTA
(H/L)ALMIN
VALLO MEASLL message
STAT1 (packed)
IN
BAD
IN_2
MSG message
IN_3
Figure 83-2. Application Example Using MEALM, STALM, and MSG Blocks
1620
84. MON – Monitor Block
This chapter describes the MON (Monitor Block), providing an I/O diagram and describing
its features, parameters and detailed operations.
Overview
A Monitor (MON) block provides the capability of monitoring process conditions. The MON
block contains up to 16 user-defined boolean expressions referred to as monitor cases. Monitor
cases can be defined such that when they are evaluated, either to True or to some BAD marked
value, the MON block activates a named sequence block, which can be an EXC, IND, or DEP
block, or even another MON block.
I/O Diagram
MON
MA TRIPPD
BLOCK
ACTIVE
TRIP01–16,
ACTPAT Standard TRIPAT
Parameters
CASERQ TRPCHG
User Parameters
TRPBAD CASENO
OP_ERR, CRIT
Up to 16
BI (1–24) user-defined ALMSTA, BLKSTA
II (1–8) monitor OP_IND
cases
RI (1–15) BO (1–16)
Features
The features are:
♦ Other DEP, IND, or EXC sequence blocks can explicitly activate or deactivate indi-
vidual monitor cases in the MON block, by means of the ACTCASES statement.
♦ There is a boolean output parameter associated with each monitor case (TRIP01-
TRIP16). When the expression of a monitor case is evaluated, the boolean result is
stored in the corresponding output parameter.
The options are:
♦ Restart Manual Auto (RSTMA) specifies the desired value of the MA parameter at
block initialization.
1621
B0193AX – Rev AA 84. MON – Monitor Block
♦ Restart Active (RSTACT) specifies the desired value of the ACTIVE parameter at
block initialization, where:
♦ RSTACT = 0: sets ACTIVE to false when the compound is turned on or for a
station reboot.
♦ RSTACT = 1: sets ACTIVE to true when the compound is turned on or for a
station reboot.
♦ RSTACT = 2: sets ACTIVE to the value in the checkpoint file for a station reboot
only. Otherwise, ACTIVE remains unchanged.
♦ Inhibit Option (INHOPT) allows you to specify alarm inhibit options.
♦ Operational Error Alarm Option (OP_OPT) enables or disables operational error
alarm messages and indications. You can change OP_OPT only by reconfiguring the
block.
♦ Trip on BAD value (TRPBAD) allows you to determine how monitor cases should be
evaluated when an input has its BAD bit set.
Parameters
Table 84-1. MON Block Parameters
1622
84. MON – Monitor Block B0193AX – Rev AA
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
ACTIVE Active shows the current Sequence block state (active/inactive). Writing to
this parameter changes the block state. When ACTIVE = 1, the block is
active. When ACTIVE = 0, the block is inactive.
1623
B0193AX – Rev AA 84. MON – Monitor Block
ACTPAT Active Pattern controls the states of the individual MON block cases. The
long integer value is interpreted as a bit pattern wherein each bit specifies
the activation or deactivation of one of the monitor cases (up to 16).
Activate Deactivate
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
Case 16
Case 15
Case 14
Case 13
Case 12
Case 11
Case 10
Case 16
Case 15
Case 14
Case 13
Case 12
Case 11
Case 10
Case 9
Case 8
Case 7
Case 6
Case 5
Case 4
Case 3
Case 2
Case 1
Case 9
Case 8
Case 7
Case 6
Case 5
Case 4
Case 3
Case 2
Case 1
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. For the MON block, only the following unshaded bits are
used
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
B9
Bit Number1
(0 to 31) Configured Alarm Option When True
0 Alarm Group 8 in Use
1 Alarm Group 7 in Use
7 Alarm Group 1 in Use
1.
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. For the MON block, only the following bits are used:
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
TRIP B1
UNAK B2
B3
B4
B5
B6
B7
B8
B9
CRIT PRTYPE
INH
1624
84. MON – Monitor Block B0193AX – Rev AA
Bit Boolean
Number Connection
(0 to 31)* Name Description When True (B32 to B1)
0 to 4 PTYP_MSKPriority Type: See parameter ALMSTA.B32–
PRTYPE for values used in ALMSTA.B28
the MON block
5 to 7 CRIT_MSK Criticality; 5 = lowest priority, ALMSTA.B27–
1= highest ALMSTA.B25
29 INH Alarm inhibit ALMSTA.B3
30 UNAK Unacknowledged ALMSTA.B2
31 TRIP Trip Alarm ALMSTA.B1
* Bit 0 is the least significant, low order bit.
ASBS01 to ASBS16
Activate Sequence Block is one of 16 parameters used by the MON block
to activate a remote sequencer block. It is connected to the block’s
ACTIVE parameter.
BI0001 to BI0024 Boolean Inputs 1 through 24 are user parameters that can be read in user-
defined monitor case expressions. You cannot assign a value to these
parameters by means of an HLBL statement in a monitor case. You can
optionally assign a label to these inputs to facilitate referencing.
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the MON block, only the following bits are used:
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
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
TRIP
ACT
ON
MA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
11 MA Manual(= false)/Auto(= true) BLKSTA.B21
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
16 ACT A pattern is Active BLKSTA.B16
17 TRIP Tripped BLKSTA.B15
20 WLCK Workstation Lock BLKSTA.B12
* Bit 0 is the least significant, low order bit.
1625
B0193AX – Rev AA 84. MON – Monitor Block
BO0001 to BO0016
Boolean Outputs 1 through 16, are user parameters, and are the evalua-
tion of monitor cases 1 through 16, when active. BO0001 to BO0016 can
be read as an inputs for other monitor cases. You may assign labels to
BO0001 to BO0016, to facilitate referencing.
CASENO Case Number, when the block is in Manual mode, indicates the number
of the monitor case statement currently being evaluated, or the next state-
ment to be evaluated. When the MON block is in Automatic mode, this
parameter shows the value 0. An out-of-range value written to this param-
eter is ignored, and the parameter is reset to 0.
CASERQ Case Request is a nonconfigurable, long integer input that executes a spec-
ified case on request when the block is in Manual mode. After the request
has been recognized, the parameter value is set to 0. When the MON
block is in Automatic mode, values written to CASERQ are ignored and
the parameter is reset to 0.
You can select a case for execution in Manual mode by writing the desired
value to the CASERQ parameter by means of an HLBL statement in
another DEP, IND, or EXC block.
CRIT Criticality is an integer output that indicates the priority, ranging from 1
to 5, of the block’s highest currently active alarm (1 is the highest priority).
An output of zero indicates the absence of alarms.
CSIZE Code Size is the actual size, in bytes, of the code space used by a sequence
block. This value is the size of the sequence block and its associated
sequence code.
CSPACE Code Space is the total number of bytes to be pre-allocated for the
sequence block and its associated sequence code.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
DEFINE to a true value, correct all configuration errors and re-install the
block.
DELTI1 Change Delta for Input Range 1 is a real value that defines the minimum
percent of the input range that triggers change driven connections for
parameters in the range of RI1. The default value is 1.
Entering a 1 causes the Object Manager to recognize and respond to a
change of 1 percent of the full error range. If communication is within the
same CP that contains the block’s compound, change deltas have no
effect.
Refer to “Peer-to-Peer Connections of Real-Type Block Inputs” on
page 955 for details on how the I/A Series software affects the change delta
percentage during operation.
1626
84. MON – Monitor Block B0193AX – Rev AA
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the MON block, the following
list specifies the possible values of ERCODE, and the significance of each
value in this block:
Message Value
“W43 – INVALID PERIOD/ PHASE does not exist for given
PHASE COMBINATION” block PERIOD, or block PERIOD
not compatible with compound
PERIOD.
“W44 – INVALID High range value is less than or equal
ENGINEERING RANGE” to low range value.
“W46 – INVALID INPUT The source parameter specified in
CONNECTION” the input connection cannot be
found in the source block, or the
source parameter is not connectable,
or an invalid boolean extension con-
nection has been configured.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W52 – INVALID I/O An I/O block is connected to an
CHANNEL/GROUP NUMBER” ECB when the specified point num-
ber is invalid or when the specified
group or octet number is invalid.
“W53 – INVALID PARAMETER A parameter value is not in the
VALUE” acceptable range.
“W58 – INSTALL ERROR; A Database Installer error has
DELETE/UNDELETE BLOCK” occurred.
HSCI1 High Scale for Input Range 1 is a real value that defines the upper limit of
the measurement ranges. EI1 defines the units. Make the range and units
consistent with the measurement source. A typical value is 100 (percent).
The MON block clamps out-of-range values.
1627
B0193AX – Rev AA 84. MON – Monitor Block
II0001 to II0008 Integer Inputs 1 through 8 are user parameters that can be read in user-
defined monitor case expressions. You cannot assign a value to these
parameters by means of an HLBL statement in a monitor case. You can
optionally assign a label to these inputs to facilitate referencing. The same
parameters are writable in IND, DEP, EXC block types.
INHIB Inhibit is a boolean input. When true, it inhibits all block alarms; the
alarm handling and detection functions are determined by the INHOPT
setting. Alarms can also be inhibited based on the compound parameter
CINHIB.
INHOPT Inhibit Option specifies the following actions applying to all block alarms:
0= When an alarm is inhibited, disable alarm messages but do
not disable alarm detection.
1= When an alarm is inhibited, disable both alarm messages and
alarm detection. If an alarm condition already exists at the
time the alarm transitions into the inhibited state, clear the
alarm indicator.
2= Same as 0 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
3= Same as 1 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
INHSTA Inhibit Status contains packed long values that represent the actual inhibit
status of each alarm type configured in the block. For the MON block,
only the following bits are used:
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
UNACK B2
B3
B4
B5
B6
B7
B8
B9
OPER
TRIP
INH
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
27 OPER Sequence Operational Error INHSTA.B5
Alarm
29 INH Inhibit Alarm INHSTA.B3
30 UNACK Unacknowledged INHSTA.B2
1628
84. MON – Monitor Block B0193AX – Rev AA
Bit Boolean
Number* Connection
(0 to 31) Name Description When True (B32 to B1)
31 TRIP Trip Alarm INHSTA.B1
LOCKID Lock Identifier is a string identifying the workstation which 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 honored (subject to the usual access rules) only 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
written to LOCKID.
LSCI1 Low Scale for Input Range 1 is a real value that defines the lower limit of
the measurement ranges. A typical value is 0 (percent). EI1 defines the
units. Make the range and units consistent with those of the measurement
source.
MANSUS Manual Suspend Case is an integer data store for debugging use only.
OF_ICM Offset to ICM is the number of bytes from the start of the block to the IC
module.
1629
B0193AX – Rev AA 84. MON – Monitor Block
OP_ERR Operational Error shows the operational error number, if any, caused by
the last monitor case evaluated. An operational error occurs when one of
the various internal checks of the MON block fails. When this happens,
the block changes to manual mode, OP_ERR is set to indicate the type of
error that has occurred, and case evaluation stops. OP_ERR is reset to 0
after a case request, a switch to Auto, a switch to Inactive, or a compound
switch to Off.
A complete list of sequence control printed error messages reported by
OP_ERR is provided in the Integrated Control Configurator (B0193AV)
document.
OP_GRP Operational Error Group is an integer input (1 through 8) that directs the
operational alarm message to one of eight groups of alarm devices. You
can change the group number at the workstation. The MON block
clamps out-of-range values.
OP_PRI Operational Error Priority is an integer input, (1 to 5), that sets the prior-
ity level of the operational error alarm (highest priority is 1). The MON
block clamps out-of-range values.
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than gateways, PERIOD
values range from 0 to 13 and map to the following period time lengths.
(Gateway blocks have different period values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
1630
84. MON – Monitor Block B0193AX – Rev AA
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0 sec.,
but the PERIOD parameter remains 12.
***** Available in CP40, CP40b, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PRTYPE Priority Type is an indexed output parameter that indicates the alarm type
of the highest priority active alarm. The PRTYPE output of this block
includes the following alarm types:
0 = No active alarm
20 = Event Trip
RI0001 to RI0015 Real Inputs 1 through 15 are user parameters in all sequence control
blocks but they can only be read in user-defined monitor case expressions.
You cannot assign a value to these parameters by means of an HLBL state-
ment in a monitor case. You can optionally assign labels to these inputs to
facilitate referencing.
RI1 Range Input is an array of real values that specify the high and low engi-
neering scale and change delta of a particular real input. For a given block,
it also forms an association with a group of real input parameters that have
the same designated range and change delta.
RSTACT Restart Active specifies the desired value of the ACTIVE parameter at
block initialization, where:
♦ 0 sets ACTIVE to 0 (= false = Inactive) when the compound is
turned on or for a station reboot
♦ 1 sets ACTIVE to 1 (= true = Active) when the compound is
turned on or for a station reboot
1631
B0193AX – Rev AA 84. MON – Monitor Block
RSTMA Restart Manual Auto specifies the desired value of the MA parameter at
block initialization, where:
0 sets MA to 0 (= false = Manual).
1 sets MA to 1 (= true = Auto).
2 leaves MA unchanged.
The block asserts this initial M/A state whenever:
♦ The compound in which it resides is turned on.
♦ The Control Processor undergoes a restart operation.
TOPEVL Top of Evaluation Stack is an indexed specification of the top of the inter-
nal evaluation stack (data store for debugging use only).
TRIP01 to 16 Trip01 through Trip16 are boolean values. Each parameter represents a
case of a MON block in the Tripped state.
TRIPAT Trip Pattern is an array of 16 boolean values containing the tripped states
of the block. If any of the 16 cases in the MON block is tripped, the cor-
responding boolean value in TRIPAT is set to true.
TRIPPD Tripped indicates whether any of the 16 cases in a MON block is tripped
(has activated another Sequence block). TRIPPD is true while any case is
tripped and false when no cases are tripped. A case remains tripped until
the block it has activated has become inactive.
TRPBAD Trip on BAD value option lets you determine how monitor cases should
be evaluated when an input has its BAD bit set. Two options are available:
TRPBAD Monitor Case Evaluates To:
true true OR is marked as BAD
false true AND is NOT marked as BAD
The BAD bit of the user input parameters can become true only through a
connection to a parameter of another control block. The MON block
itself never sets the BAD bit of its inputs.
The boolean output parameter of a monitor case is marked BAD when
one of the user input parameters used in the case expression is marked
BAD. This indicates that the case evaluation is based on one or more
unreliable inputs.
TRPCHG Tripped Change is incremented each time one of the cases in the MON
block changes to or from the tripped state.
TYPE When you enter “MON” or select “MON” from a configurator list, it cre-
ates an identifying integer specifying this block type.
1632
84. MON – Monitor Block B0193AX – Rev AA
UNACK Unacknowledge is a boolean output that the block sets to True when it
detects an alarm. It is typically reset by operator action.
VOLMON Volatile Monitor Case is an array of 32 integer data stores for debugging
use only.
Detailed Operation
A MON block can be in the Active or Inactive state.
When Inactive, the block is not processed. When Active, the block is processed. When an Active
MON block is processed, it is can evaluate its monitor cases either in Auto or in Manual.
Each of the monitor cases can individually be in the Active or Inactive state. When the case is
Active, it is evaluated each processing cycle in which the block is processed (subject to the mode of
operation in Auto and Manual); when Inactive it is not evaluated and cannot trip. The
Active/Inactive state of the cases is based upon the ACTPAT parameter.
ACTPAT is a long integer value which is interpreted as a bit pattern. Each bit of this pattern spec-
ifies whether a case is to be activated, deactivated, or left in its previous state. The 32 bits of ACT-
PAT are divided into two 16-bit fields, referred to in the following diagram as the Activate Pattern
(the two most significant bytes) and the Deactivate Pattern (the two least significant bytes). See
Figure 84-2. The least significant bit of the Deactivate Pattern, shown at the right of the diagram,
is referred to as Bit 0, and the most significant bit of the Activate Pattern, shown at the left of the
diagram, is referred to as Bit 31.
Each of the 16 bits within a pattern controls the behavior of one case. This case is determined by
adding one to the bit number, after first reducing each bit number in the Activate Pattern by 16.
For example, Bit 0 controls Case 1, Bit 1 controls Case 2, and Bit 15 controls Case 16. Bit 16 also
controls Case 1 (16-16 + 1 = 1), Bit 17 also controls Case 2 (17-16 + 1 = 2), and Bit 31 also con-
trols Case 16 (31-16 + 1 = 16). Therefore, two different bits, one in each 16-bit pattern, control
each case. The control of a case follows these rules:
♦ Bits set to 1 in the Activate Pattern determine which cases are to be activated. Each
such 1-bit causes activation of its corresponding controlled case. Every other bit in the
Activate Pattern should be set to 0; that is, a case which is to be deactivated or left in
its previous state has its controlling bit in the Activate Pattern set to 0.
♦ Bits set to 0 in the Deactivate Pattern determine which cases are to be deactivated.
Each such 0-bit causes deactivation of its corresponding controlled case. Every other
bit in the Deactivate Pattern should be set to 1; that is, a case which is to be activated
or left in its previous state has its controlling bit in the Deactivate Pattern set to 1.
♦ As a result, a case which is to be left in its previous state will have both of its control-
ling bits (one in each pattern) set to 0.
For example, to activate monitor Cases 3, 5, 7, and 15 and to deactivate monitor Cases 1, 10, 12,
and 16, without altering any other cases, the bit pattern of Figure 84-2 would be used.
In hexadecimal notation, the value of ACTPAT would be 0x405475FE.
1633
B0193AX – Rev AA 84. MON – Monitor Block
0 1 0 0 0 0 0 0 0 1 0 1 0 1 0 0 0 1 1 1 0 1 0 1 1 1 1 1 1 1 1 0
15 7 5 3 16 12 10 1
Figure 84-2. The ACTPAT Parameter
The same activation/deactivation of the MON block cases can be achieved by including an HLBL
statement ACTCASES in any sequence block. If, for example, the target block is MONBLOCK
in the compound MONCOMP, any sequence block can cause the above activation/deactivation
pattern by executing the following statement:
ACTCASES (:MONCOMP:MONBLOCK, “I-A-A-A--I-I--AI”)
In the literal string of the ACTCASES statement (“I-A-A-A--I-I--AI” in the example) the first or
left-hand character (“I” in the example) controls Case 1, the second (“-” in the example) controls
Case 2, and so on. The effect of each character value is as follows:
♦ If the character in the literal string specifies “A”, then the corresponding monitor case
is set to active.
♦ If the character in the literal string specifies “I”, then the corresponding monitor case
is set to inactive.
♦ If the character in the literal string specifies “-”, then the corresponding monitor case
is left unchanged.
♦ If there are less than 16 characters in the literal string, then it is considered that the
missing specifiers are at the right, corresponding to the highest-numbered cases. These
cases are left unchanged, that is, they are treated as if “-” had been specified.
In Auto, all of the monitor cases, as determined by the ACTPAT parameter, are evaluated each
scheduled BPC. The MON block does not deactivate itself.
In Manual, a request can be issued to evaluate a single monitor case, irrespective of the value of
ACTPAT. After the case has been processed completely (tripped and untripped), the standard
parameter CASENO is set to indicate the number of the next case. The next case is not evaluated
unless requested. You can select a case for execution from a detail display, the “EXEC CASE” but-
ton, or by writing the desired value to the CASERQ parameter by means of an HLBL statement
in another DEP, IND, or EXC block.
In the Auto state, the block’s output parameters are secured. This means that the block algorithm
is responsible for updating the output parameters. External sources (other blocks and applica-
tions) cannot write values to the output parameters.
In the Manual state, the block’s output parameters are not secured. External sources (other blocks
and applications) can write values to the block’s output parameters. Note that when a monitor
case is evaluated after a case request, the MON block is capable of updating an output parameter
while in manual mode.
An Active monitor can also be Tripped. The MON block is Tripped when any case within the
monitor trips (has activated another block).
1634
84. MON – Monitor Block B0193AX – Rev AA
When a case trips, the TRIPnn parameter, where nn = 01 to 16, associated with the individual
case is true. When any of the 16 cases in the MON block trip, the TRIPPD parameter is true.
The TRPCHG parameter is incremented each time a case changes to or from the tripped state.
A monitor case remains tripped until:
♦ the block activated by the case becomes Inactive,
♦ the monitor case is deactivated,
♦ the MON block is switched to Inactive,
♦ the surrounding Compound is switched to OFF.
As long as a specific monitor case is tripped, the boolean expression of that monitor case is not
evaluated. The other monitor cases in the MON block are still evaluated as long as they are active
and not tripped.
Only monitor cases in which a sequence block is specified can make a switch to the tripped state.
Monitor cases which merely consist of a boolean expression cannot trip. When a case trips, it has
activated a sequence block named in the case. If that sequence block resides in another station the
activation of that block may require several BPCs.
Whether a monitor case, in which a sequence block is specified, will trip is determined by:
♦ the boolean result of case evaluation,
♦ the BAD bit of the resulting boolean expression,
♦ the trip-on-bad (TRPBAD) option,
♦ the presence of the sequence block to be activated.
When a user input parameter is connected to a parameter of another control block, and that con-
trol block is capable of setting the BAD bit of its outputs, then it is possible that the BAD bit is set
in one of the user input parameters of a MON block. Whenever that happens, the MON block
sets any user output BAD if its corresponding monitor case involves the BAD input.
The MON block has two alternatives in reacting upon BAD bits. If the TRPBAD option is false
(default) an activation request to the designated sequence block is only issued if:
♦ the boolean expression evaluates to true, AND
♦ the BAD bit is NOT set for all of the user input parameters that are used in the evalu-
ated monitor case. In this case, the MON block reacts upon reliable values.
If the TRPBAD option is true, then an activation request is issued whenever and as soon as:
♦ the BAD bit is set in one of the user input parameters that are used in the evaluated
monitor case, OR
♦ the boolean expression evaluates to true. In this case, the MON block reacts upon the
unreliability of values.
Irrespective of the TRPBAD option, a monitor case finally becomes tripped whenever the activa-
tion of the named sequence block is successful. If the sequence block cannot be found the moni-
tor block raises an operational error (-45).
The fact that the sequence block is already active does not lead to an operational error. The error
return code (2) is ignored by the MON block.
1635
B0193AX – Rev AA 84. MON – Monitor Block
NOTE
If one or more cases are making a transition to Tripped (for example, the blocks to
be activated are remote), and you change a MON block from Automatic-to-Man-
ual, the block activation(s) is/are completed but the cases do not trip.
1BPC
Extension
Compound A Continuous MON/TIM EXC DEP/IND Continuous
Compound B Continuous MON/TIM EXC DEP/IND Continuous
Compound C Continuous MON/TIM EXC DEP/IND Continuous
1 2 3 4
When a MON block is processed, its entire algorithm is executed each scheduled BPC until deac-
tivated.
If the block processor cannot process all blocks in a scheduled BPC, there is a Basic Processing
Cycle (BPC) overrun.
1636
85. MOVLV – Motor Operated
Valve Block
This chapter describes the MOVLV (Motor Operated Valve Block), providing an I/O diagram
and describing its features, parameters and detailed operations.
Overview
The Motor Operated Valve block (MOVLV, Figure 85-1) provides open/close/stop control of a
motor operated valve and interfaces to a discrete type FBM (Fieldbus Module). The block sup-
ports a three-wire configuration using two pulse outputs. MOVLV supports both Manual and
Auto operational modes. The MOVLV block also supports mismatch timeout alarming of the
valve’s sensed limit positions.
Motor-operated valves require the use of two separate contacts., one for driving the valve open,
the other for closing. This is provided by the MOVLV block with its two pulsed contact outputs.
Pulse Time
Disable
AUTSW
Auto Close Auto COUT_1
Auto Open MA
Mismatch
Open/Close Time Time-Position
Timer
Comparison
Valve Status
Figure 85-1. MOVLV Block Diagram
Features
The features are:
♦ Manual/Auto mode for “remote” control of motor device
♦ Auto and Manual latch switch inputs (AUTSW and MANSW) that allow the block
to be switched to Auto or Manual
♦ Open loop indication to upstream blocks
♦ User-specifiable pulse output time width
♦ Disable input for “local” control of final operator device
♦ Bad input point detection and handling
♦ Alarm message Inhibit
1637
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
♦ Failsafe support.
The options are:
♦ Timed option (TOPT) provides an indication of a mismatch between the desired state
and the actual state of the valve.
♦ An FBM drive option (IOMOPT) for connecting COUT_1 and COUT_2 directly
to a configured FBM.
♦ State mismatch alarming (MMAIND).
♦ Initialize Manual/Auto (INITMA) specifies the desired state of the M/A input during
initialization.
♦ Manual If Failsafe (MANFS) when configured true, drives the block to the Manual
state if the block detects an incoming failsafe status.
♦ Inhibit Option (INHOPT) allows you to specify alarm inhibit options.
♦ Desired State Request Track option (DSRTRK), when set true, forces Manual/Auto
DSR parameters to track each other and prevents these parameters from being set
while the block is not in the parameter’s designated state.
Parameters
Table 85-1. MOVLV Block Parameters
1638
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
1639
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
Parameter Definitions
ACHNGE Alternate Change is an integer output which is incremented each time a
block parameter is changed via a Set command.
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. For the MOVLV block, only the following unshaded bits
are used
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
B9
Bit Number1
(0 to 31) Configured Alarm Option When True
0 Alarm Group 8 in Use
1 Alarm Group 7 in Use
7 Alarm Group 1 in Use
22 Bad I/O Alarm Configured
1. Bit 0 is the least significant, low order bit.
TALMSTA Alarm Status is a 32-bit output, bit-mapped to indicate the block’s alarm
states. For the MOVLV block, only the following bits are used:
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
Boolean
Bit Number Connection
(0 to 31)* Name Description When True (B32 to B1)
0 to 4 PTYP_MSK Priority Type: See parame- ALMSTA.B32–
ter PRTYPE for values ALMSTA.B28
used in the MOVLV block
5 to 7 CRIT_MSK Criticality; 5 = lowest pri- ALMSTA.B27–
ority, 1= highest ALMSTA.B25
1640
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
Boolean
Bit Number Connection
(0 to 31)* Name Description When True (B32 to B1)
22 BAD Input/Output Bad (BAD ALMSTA.B10
output of block)
29 INH Alarm inhibit ALMSTA.B3
30 UNAK Unacknowledged ALMSTA.B2
* Bit 0 is the least significant, low order bit.
AMRTIN Alarm Regeneration Timer is a configurable integer that specifies the time
interval for an alarm condition to exist continuously, after which a new
unacknowledged alarm condition and its associated alarm message is gen-
erated.
AUTCLS Auto Close is a Boolean input. While the block is in Auto, a positive tran-
sition at AUTCLS sets the COUT_2 output true. COUT_2 remains true
for a period of time, in minutes, configured by the TPULSE parameter.
While the block is in Auto, a negative transition at AUTCLS resets
COUT_2 output to false. Typically, AUTCLS comes from user programs
or blocks.
If DSRTRK is set true, an unlinked AUTCLS input tracks the MANCLS
input when the block is in Manual.
AUTOPN Auto Open is a Boolean input. While the block is in Auto, a positive tran-
sition at AUTOPN sets the COUT_1 output true. COUT_1 remains
true for a period of time, in minutes, configured by the TPULSE parame-
ter. While the block is in Auto, a negative transition at AUTOPN resets
COUT_1 output to false. Typically, AUTOPN comes from user programs
or blocks.
If DSRTRK is set true, an unlinked AUTOPN input tracks the MAN-
OPN input when the block is in Manual.
AUTSW Auto Switch is a Boolean input that, when true, overrides the MA and
INITMA parameters, and drives the block to the Auto state. If both
MANSW and AUTSW are true, MANSW has priority.
BAD Bad is a Boolean output which is set true when the input to the block is
unacceptable in any way. The BAD bit of BLKSTA (BLKSTA.BAD) is
also set true whenever BAD is true.
BAG Bad Alarm Group is an integer input that directs Bad alarm messages to
one of eight groups of alarm devices. You can change the group number
through the workstation.
1641
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
BAP Bad Alarm Priority is an integer input, ranging from 1 to 5, that sets the
priority level of the Bad alarm (1 is the highest priority).
BLKSTA Block Status is a 32-bit output, bit-mapped to indicate the block’s opera-
tional states. For the MOVLV block, only the following bits are used:
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9
B10 8 7 6 5 4 3 2 1 0
B11
WLCK B12
B13
B14
B15
B16
B17
UDEF B18
B19
B20
B21
B22
B23
B24
B25
B26
B27
B28
B29
B30
B31
B32
B1
B2
B3
B4
B5
B6
B7
B8
B9
BAD
DSB
ON
MA
Boolean
Bit Number* Connection
(0 to 31) Name Description When True (B32 to B1)
11 MA
Manual(= false)/ BLKSTA.B21
Auto(= true)
12 BAD Bad I/O BLKSTA.B20
14 UDEF Undefined BLKSTA.B18
15 ON Compound On BLKSTA.B17
20 WLCK Workstation Lock BLKSTA.B12
23 DSB Disabled BLKSTA.B9
* Bit 0 is the least significant, low order bit.
CLSLIM Close Limit is an input pointing to the program or block that monitors
the state of the Valve-Closed Limit Switch.
CO1_PT Contact Output 1 Point is a string input that specifies the point number
on the FBM terminal board that connects to the open drive input of
MOVLV block. Point number ranges for the applicable FBM types are:
FBM Type Point Number
9 9 to 16
14 25 to 32
17 11 to 14
CO2_PT Contact Output 2 Point is a string input that specifies the point number
on the FBM terminal board that connects to the close drive input of the
MOVLV block. See the CO1_PT definition for the point number ranges.
COUT_1 Contact Out 1 is one of the block's two Boolean outputs. The block
always secures COUT_1. During normal operation with DISABL = false,
1642
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
COUT_2 Contact Out 2 is the other of the block's two Boolean outputs. The block
always secures COUT_2. During normal operation with DISABL = false,
a positive transition at the AUTOPN/MANOPN (depending on
auto/manual mode) pulses COUT_2 for the time interval TPULSE.
COUT_2, in turn, is written to the addressed channel of the FBM when
IOMOPT is true. Refer to the MA and DISABL definitions for details on
how they affect COUT_2.
CRIT Criticality is an integer output that indicates the priority, ranging from 1
to 5, of the block’s highest currently active alarm (1 is the highest priority).
An output of zero indicates the absence of alarms.
DEFINE Define is a data store which indicates the presence or absence of configura-
tion errors. The default is 1 (no configuration errors). When the block ini-
tializes, DEFINE is set to 0 if any configured parameters fail validation
testing. In that case, no further processing of the block occurs. To return
DEFINE to a true value, correct all configuration errors and re-install the
block. DEFINE is the inverse of undefined (UDEF) in the BLKSTA
parameter.
DEV_ID Device Identifier is a character array that specifies the 6-character letter-
bug identifier of the connected FBM or FBC. DEV_ID differs from
IOM_ID in that it is of character array rather than string type, and does
not allow the use of the ECB NAME parameter or ECB pathname in
specifying the connected FBM or FBC.
DISABL Disable is a Boolean input. When true, DISABL sets the output
COUT_1 and COUT_2 to false, and inhibits normal block operation in
either Auto or Manual mode. While DISABL is false (block enabled), the
block accepts requests from either the AUTOPN or MANOPN inputs.
DISABL is independent of MA, and has a higher priority.
1643
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
DSRTRK Desired State Request Track option, when set true, forces unlinked Man-
ual/Auto DSR parameters to track each other. DSRTRK also prevents the
setting of these parameters while the block is not in the parameter's desig-
nated state. (For example, in the MOVLV block, AUTOPN cannot be set
in the Manual state, and MANOPN cannot be set in the Auto state.)
DSRTRK is a Boolean option that can be set at any time, regardless of the
compound or block state. However, once DSRTRK is enabled, it can be
disabled only by performing a delete/undelete of the block.
ERCODE Error Code is a string data store which indicates the type of configuration
error or warning encountered. The error situations cause the block’s
DEFINE parameter to be set false, but not the warning situations. Valida-
tion of configuration errors does not proceed past the first error encoun-
tered by the block logic. The block detailed display shows the ERCODE
on the primary page, if it is not null. For the MOVLV block, the following
list specifies the possible values of ERCODE, and the significance of each
value in this block:
Message Value
“W43 – INVALID PHASE does not exist for given
PERIOD/PHASE block PERIOD, or block PERIOD
COMBINATION” not compatible with compound
PERIOD.
“W46 – INVALID INPUT The source parameter specified in
CONNECTION” the input connection cannot be
found in the source block, or the
source parameter is not connectable,
or an invalid boolean extension con-
nection has been configured.
“W48 – INVALID BLOCK The configured value of a block
OPTION” option is illegal.
“W53 – INVALID A parameter value is not in the
PARAMETER VALUE” acceptable range.
“W58 – INSTALL A Database Installer error has
ERROR; occurred.
DELETE/UNDELETE
BLOCK”
FS Failsafe is a Boolean output that is set true when the block detects the
FBM going to the Failsafe state. While in this state, the block retains the
actual Failsafe value of the output point as it is read back from the FBM.
This value, depending on the ECB Failsafe option, is either the fallback or
the hold value.
1644
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
INHALM Inhibit Alarm contains packed Boolean values that represent alarm inhibit
requests for each alarm type or point configured in the block. For the
MOVLV block, only the following bits are used:
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
B10
B11
B12
B13
B14
B15
B16
B1
B2
B3
B4
B5
B6
B7
B8
B9
Bit Number* Boolean Connection
(0 to 15) Description When True (B16 to B1)
6 Inhibit Bad I/O Alarm INHALM.B10
10 Inhibit State Alarm INHALM.B6
* Bit 0 is the least significant, low order bit.
INHIB Inhibit is a Boolean input. When true, it inhibits all block alarms; the
alarm handling and detection functions are determined by the INHOPT
setting. Alarms can also be inhibited based on INHALM and the com-
pound parameter CINHIB.
INHOPT Inhibit Option specifies the following actions applying to all block alarms:
0= When an alarm is inhibited, disable alarm messages but do
not disable alarm detection.
1= When an alarm is inhibited, disable both alarm messages and
alarm detection. If an alarm condition already exists at the
time the alarm transitions into the inhibited state, clear the
alarm indicator.
2= Same as 0 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
3= Same as 1 for all inhibited alarms. For all uninhibited alarms,
automatically acknowledge “return-to-normal” messages.
“Into alarm” messages may be acknowledged by explicitly set-
ting UNACK false.
1645
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
INHSTA Inhibit Status contains packed long values that represent the actual inhibit
status of each alarm type configured in the block. For the MOVLV block,
only the following bits are used:
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
STATE B6
B7
B8
B9
BAD
Bit Boolean
Number1 Connection
(0 to 31) Name Description When True (B32 to B1)
22 BAD Bad Alarm INHSTA.B10
26 STATE Mismatch Alarm INHSTA.B6
1.
Bit 0 is the least significant, low order bit
INITMA Initialize Manual/Auto specifies the desired state of the MA input during
initialization, where:
0 = Manual
1 = Auto
2 = The MA state as specified in the checkpoint file.
The block asserts this initial M/A state whenever:
♦ It is installed into the Control Processor database.
♦ The Control Processor undergoes a reboot operation.
♦ The compound in which it resides is turned on.
♦ The INITMA parameter itself is modified via the control configu-
rator. (The block does not assert INITMA on ordinary
reconfiguration.)
INITMA is ignored if MA has an established linkage.
1646
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
IOMOPT Fieldbus Module Option is a short integer that specifies whether an FBM
connection to the block exists.
IOMOPT has a range of 0 to 1 for the MOVLV block, where:
0= The block outputs are not connected to an FBM. This option
may be used for simulation, or for connecting COUT_1 and
COUT_2 as inputs to other blocks.
1= The block outputs are connected to a discrete-type FBM speci-
fied by the IOM_ID, CO1_PT and CO2_PT.
IOM_ID Fieldbus Module Identifier is a configurable string that specifies the path-
name of the ECB for the FBM or FBC to which the block is connected.
IOM_ID has the form CompoundName:BlockName, where Compound-
Name is the 1-12 character name of the local compound containing the
ECB, and BlockName is the 1-12 character block name of the ECB. For
IFD inputs, the NAME parameter string of the parent ECB (12, 23, or
38R) must be used.
If the compound containing the ECB is the CPletterbug_ECB compound
where CPletterbug is the station letterbug of the CP, the CompoundName
may be omitted from the IOM_ID configuration. In this case, the 1-12
character ECB block name is sufficient. For IFD inputs, this is the letter-
bug of the parent FBM (18, 43, 39, 44, or 46).
LOCKID Lock Identifier is a string identifying the workstation which 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-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 honored (subject to the usual access rules) only 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
written to LOCKID.
1647
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
MANCLS Manual Close is a Boolean input. A positive transition at this input while
the block is in Manual sets the COUT_2 output true. COUT_2 remains
true for a period of time configured by the TPULSE parameter (in min-
utes). Typically, MANCLS begins with an operator request through the
workstation. If DSRTRK is true, an unlinked MANCLS input is secured,
and it tracks the AUTCLS input when the block is in Auto.
MANOPN Manual Open is a Boolean input. A positive transition at this input, while
the block is in Manual, sets the COUT_1 output true. COUT_1 remains
true for a period of time configured by the TPULSE parameter (in min-
utes). Typically, MANOPN begins with an operator request through the
workstation.
If DSRTRK is true, an unlinked MANOPN input is secured and it tracks
the AUTOPN input when the block is in Auto.
MANSW Manual Switch is a Boolean input. When true, MANSW overrides the
MA and INITMA parameters and drives the block to the Manual state. If
both MANSW and AUTSW are true, MANSW has priority.
MMAIND Mismatch Indicator is a Boolean output that is set true whenever the
sensed state of the valve (determined by CLSLIM and OPNLIM) does not
match the requested state within the timer interval, TOC. The block gen-
erates an alarm when it sets MMAIND true, if the INHIB input is false.
OPNLIM Open Limit is an input pointing to the program or block that monitors
the state of the Valve-Open Limit Switch.
1648
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
PERIOD Period is an indexed input that dictates the block’s execution time base
and allowable PHASE values. For stations other than Integrators and
Gateways, PERIOD values range from 0 to 13 and map to the following
period time lengths. (Integrator and Gateway blocks have different period
values than shown here.)
Period Length Period Length
0 0.1 sec 7 10 min
1 0.5 sec* 8 60 min
2 1.0 sec 9 0.2 sec
3 2.0 sec 10 5.0 sec**
4 10 sec 11 0.6 sec***
5 30 sec 12 6.0 sec****
6 1 min 13 0.05 sec*****
* If the BPC is 0.2 sec., this period is treated internally as 0.6 sec., but the
PERIOD parameter remains 1.
** If the BPC is 2.0 sec., this period is treated internally as 6.0 sec., but the
PERIOD parameter remains 10.
*** If the BPC is 0.5 sec., this period is treated internally as 0.5 sec., but
the PERIOD parameter remains 11.
**** If the BPC is not 2.0 sec., this period is treated internally as 5.0
*****Available in CP40, CP40B, and CP60.
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, a block with
PERIOD of 3 (2.0 sec) can execute within the first, second, third, or
fourth BPC of the 2-second time period, assuming the BPC of the Con-
trol Processor is 0.5 sec. Refer to the appropriate Integrated Control Soft-
ware Concepts document (B0700AG or B0193AW).
PRTYPE Priority Type is an indexed output that indicates the alarm type of the
highest priority active alarm. The PRTYPE output of this block includes
the following alarm types:
0 = No active alarm
8 = BAD Alarm
1649
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
RSMMOP Reset Mismatch Option is used to specify that the DSR input be reset
when a mismatch alarm occurs in an MOVLV block.
0 = No reset action.
1 = Reset DSR inputs if mismatch alarm occurs.
SAG State Alarm Group is short integer input that directs mismatch alarm mes-
sages to the corresponding group of alarm devices. You can change the
group number through the workstation.
SAP State Alarm Priority is an integer input that sets the alarm priority for the
mismatch alarm reporting (1 is the highest priority).
TOC Time to Open or Close is the delay, in minutes, before the comparison for
mismatch is made. Configure a delay at least as great as the maximum
time required for the valve to go from one state to the other. To avoid
truncation, set TOC equal to an integral multiple of the PERIOD.
TOPT Timeout Option is a Boolean input. When true, TOPT enables the mis-
match indicator and mismatch alarming. When TOPT is false, mismatch
alarming is disabled. You can change TOPT only by reconfiguring the
block.
TPULSE Time of Pulse sets the pulse duration of the two outputs, COUT_1 and
COUT_2, in minutes. Enter a value consistent with the drive require-
ments of the motor. Minimum value is 1 block scan period.
TTOTAL Timeout Length is an integer used by the MOVLV block as a local value
containing the total number of block executions in the alarm timeout for
output mismatch.
TYPE When you enter “MOVLV” or select “MOVLV” from a configurator list,
it creates an identifying integer specifying this block type.
UNACK Unacknowledge is a Boolean output that the block sets to True when it
detects an alarm. It is typically reset by operator action.
WTOTAL Pulse Width is an integer used by the MOVLV block as a local value con-
taining the total number of block executions in the pulse width of a pulsed
output.
1650
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
Functions
Detailed Diagram
TPULSE
IOM_ID
DISABL CO1_PT
AUTSW COUT_1
AUTCLS Auto
AUTOPN MA
IOM_ID
CO2_PT
MANCLS COUT_2
MANOPN Manual
MANSW
Time-Position MAIND
Comparison
Timer
TOC
OPNLIM
CLSLIM
TOPT
INHIB
IOMOPT AND COUT_x.OOS
ECB OOS
INITO.OOS
CRBK.OOS
COUT_x.SECURE
ECB Bad
OR BAD
Readback AND
Point Status COUT_x.BAD
Bad IOMOPT
INITO.BAD
CRBK.BAD
COUT_x.SECURE
Failsafe Bad
AND Alarming
BAO
Detection AND
Manual
OR FS
Auto AND
Transition Cycle Open INITO
Cascade
Detection
Detailed Operation
The MOVLV block provides open/close/stop control of a three-wire motor operated valve.
MOVLV supports a three-wire configuration with two pulsed outputs, COUT_1 and COUT_2
that interface with discrete-type FBMs with Sustained or Momentary configurations. For motor
control applications, you configure the Sustained option for the specific FBM channels addressed
by the block.
1651
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
The MOVLV block has an operator (Manual) mode and an external (Auto) mode. In Manual, the
block accepts operator-set Open and Close commands to the MANOPN and MANCLS parame-
ters. In Auto any block, task, or application program can send Open and Close requests to the
AUTOPN and AUTCLS parameters.
Unlinked desired state request (DSR) parameters can be changed as follows:
♦ MANOPN and MANCLS can be changed only when the block is in Manual, or if
DSRTRK is true, while the block is in Auto.
♦ AUTOPN and AUTCLS can be changed while the block is in Auto. AUTOPN can
also be changed while the block is in Manual, if DSRTRK is set true.
3 - wire
DISABL
AUTCLS + MANCLS
AUTOPN + MANOPN
COUT_1 TPULSE
COUT_2 TPULSE
A pulse on the output can be terminated by resetting the state change request (MANOPN,
MANCLS, AUTOPN, or AUTCLS) before the pulse time expires.
Limit switch feedback inputs can be used. Pulses are terminated immediately upon detection that
the limit switches match the desired state request. With the Timeout option (TOPT) enabled, the
block generates a mismatch alarm when the sensed Open/Close position of the valve does not
match the desired position within the time interval (TOC). Until expiration of the time interval,
alarm detection is completely disabled, and no alarm is generated if either limit switch becomes
set while the alarm timer is active.
If the selected Open and Close inputs go from false to true together, the block takes no output
action until one, or both inputs become false.
When an FBM is connected for outputs (that is, IOMOPT = 1), the value of COUT_1 is copied
to the output point specified by IOM_ID and CO1_PT, and the value of COUT_2 is copied to
the output point specified by IOM_ID and CO2_PT.
In normal operation, at startup, or on a transition from DISABL to normal, or from BAD to nor-
mal, the block produces no pulse, assuming that the appropriate input parameter has no connec-
tion with a parameter from another block.
1652
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
Output Processing
Key Parameters: COUT_1, COUT_2, IOM_ID, CO1_PT, CO2_PT
The block outputs, COUT_1 and COUT_2, are mapped to physical I/O points by specifying the
Letterbug ID of the discrete-type FBM and the output point numbers. You specify the destina-
tion FBM in the Fieldbus Module Identifier (IOM_ID) parameter, and the points within the
FBM by the CO1_PT and CO2_PT parameters. You can specify any output points provided
both outputs connect to the same FBM. Both field outputs must reside in the same FBM.
At the beginning of an I/O read cycle, the addressed FBM output channel is read and the value is
stored in the ECB for that FBM. When the block initializes, this value is used to update the input
parameter, assuming this parameter has no connection from other blocks.
COUT_1 drives the pulsed Open input, while COUT_2 drives the pulsed Close input. The time
duration of the pulse is determined by the time, TPULSE. The minimum value is one block scan
period. Local circuitry normally disables valve drive when the valve reaches either extreme.
The MOVLV block interfaces with discrete-type FBMs that have either sustained or momentary
configurations. The following are the FBMs and point numbers providing valid output destina-
tions for the MOVLV block:
1653
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
If DSRTRK is set true, the block, while in Auto, secures the unlinked MANOPN and MANCLS
parameter and has it track AUTOPN and AUTCLS. In Manual, with DSRTRK set true, the
unlinked AUTOPN and AUTCLS parameters are secured and track MANOPN and MANCLS,
respectively.
Disable Mode
Key Parameters: DISABL, COUT_1, COUT_2
If DISABL is true, the block:
♦ Continues to perform alarm detection, alarm message acknowledgment, and limit
switch updating
♦ Indicates the actual position of the upstream device
♦ Inhibits operation in the Auto or Manual mode
♦ Sets COUT_1 to false
♦ Sets COUT_2 to false.
You can drive DISABL with a local field contact and use it as a permissive input for maintenance
or local control.
When DISABL is false (block enabled), the block operates according to the MA status. In all
modes of operation, the block always secures the COUT_1 and COUT_2 outputs.
For bumpless transitions out of DISABL mode, the block initializes the MANOPN/AUTOPN
parameters to the state of the block’s Boolean outputs.
Alarming
Mismatch
Key Parameters: OPNLIM, CLSLIM, RSMMOP, AUTOPN, MANOPN, COUT_1, COUT_2
A mismatch indicator is set true, and a mismatch alarm is generated, if the actual state of the valve
does not match the requested state within the user-specified Time to Open or Close (TOC). The
open state is determined by the open limit switch (OPNLIM) feedback input and the closed state
by the close limit switch (CLSLIM) feedback input. A mismatch alarm also occurs if both limit
switches are true at the same time (invalid state).
The option parameter RSMMOP (Reset Mismatch Alarm Option), when true, causes the
AUTOPN or MANOPN parameter to be reset to its original state when a mismatch alarm
occurs. This allows you to retry the original request action, without having to toggle the request
parameter in the wrong direction, by creating a leading edge for the timeout to begin again.
Mismatch alarms are cleared, and return-to-normal messages are generated, when the alarm is
acknowledged by the operator, or the OPNLIM or CLSLIM input indicates that the field device
has changed state as requested.
If COUT_1 or COUT_2 change state (from OPEN to CLOSE, or CLOSE to OPEN) before the
valve reaches the first state, and before a mismatch timeout could occur, a new time count is
begun.
The open limit (OPNLIM) and the close limit switch (CLSLIM) feedback inputs are normally
connected from a CIN block. It either input goes bad, the block can be placed in Manual to dis-
able the block. In addition, alarm inhibit (INHIB) can be set true to inhibit erroneous alarms
until the bad OPNLIM or CLSLIM input is repaired.
1654
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
Bad FBM
Key Parameters: AUTO, MANUAL, DISABL
If the FBM becomes non-operational (BAD), the block enters the BAD state and the output
(COUT_1 and COUT_2) remains at the last known driven state of the FBM contact. BAD is a
higher priority state than the AUTO, MANUAL and DISABL states. No requests of the
AUTOPN, AOTCLS, MANOPN, and MANCLS inputs are processed, and the DISABL input is
not honored; that is, setting the DISABL input true while the block state is BAD does not set
COUT_1 and COUT_2 to false. On a transfer from BAD to normal, the ECB is read and this
value is stored in the controlling input parameter, assuming there is no connection to this param-
eter from other blocks.
Alarm Acknowledge
Key Parameter: UNACK
Unacknowledge (UNACK) is a Boolean output parameter which is set true, for notification pur-
poses, 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. The clearing of UNACK is normally via an
operator “acknowledge” pick on a default or user display, or via a user task.
Block Initialization
Key Parameter: INITO, MANOPN, AUTOPN, COUT_1, COUT_2
An Initialization Out parameter, INITO, provides a mechanism for indicating an open-loop con-
dition in the block. The block is open looped if:
♦ it is initializing
♦ the FBM is bad
♦ the block is in Manual
♦ or the mismatch alarm indicator is true
♦ the DISABL input is true.
Programs and upstream blocks can use INITO to sense when this block is open loop.
If the block is in I/O mode (IOMOPT = 1), COUT_1 and COUT_2 initialize to the current
contact output value read back from the device. This ensures that the valve state remains
unchanged across reinitializations.
Failsafe Action
Key Parameter: MANFS, FS
When the block detects that it is recovering from an FBM failure, it checks the appropriate chan-
nel bits in the FSAFE parameter in the ECB to determine if the failure was a Communications
Failure. If the associated channel bits are true in FSAFE, the block parameter FS is set true. If the
block is Auto and MANFS is false, FS is cleared in one block cycle. If MANFS is true, the block is
switched from Auto to Manual. If the block was either already in Manual or if it switches to Man-
ual, FS remains set true until the block switches to Auto or until the output parameter is written
to by you.
On the cycle that the block recovers from a failure or initializes, the block reads back the output
value from the FBM. This value is either the FBM Hold value or the Fallback value dependent
upon the configuration of the FBM failsafe mask and failsafe data.
1655
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
Validation Checks
Duplicate output channel detection alerts you to the fact that this block and another block capa-
ble of digital outputs are connected to the same output point. This does not necessarily constitute
a conflict, since the other block can be in a compound which is not scheduled to run at the same
time as the compound containing this MOVLV block, or the duplicate connection can be used as
part of an elaborate control scheme.
When the block undergoes one of the following actions, the entire data base is checked for dupli-
cate output channels:
♦ The block is installed.
♦ The IOMOPT parameter is modified.
♦ The IOM_ID parameter is modified.
♦ A variable output point number (CO1_PT or CO2_PT) is modified
The duplicate output channel check is also performed when the Control Processor is rebooted. It
is not performed when a compound is switched On or Off.
All blocks connected to the same output point receive the DUPLICATE OUTPUT CHANNEL
warning message, but are not set Undefined.
Application Example
A typical application example for the MOVLV block is shown in Figure 85-4. Connecting the
output to the FBM is optional. If you connect the output to an FBM, the output is sent to the
FBM (IOM_ID) and point number (CO1_PT or CO2_PT)) as specified.
The block operation can be disabled without turning off the compound. If the block DISABL is
TRUE, then block operation is suspended. Since DISABL is a connectable parameter, a field
switch can disable the block preventing indifferent device operation while maintenance is being
performed.
In this application, the valve opens when a low measurement alarm occurs in a PIDA block. The
AUTOPN input comes from a task (Process display, another block, etc.) external to the block,
and is repeated at the output (COUT_1 and COUT_2) when the block is in automatic. In
1656
85. MOVLV – Motor Operated Valve Block B0193AX – Rev AA
Figure 85-4, the AUTOPN input comes from:PIDA.MEASL1. The true AUTOPN parameter
corresponds to an open request. The MANOPN input is used when the block is in manual;
manipulated by the faceplate.
In automatic, the sources of AUTOPN and AUTCLS drive COUT _1 and COUT_2. In Man-
ual, MANOPN and MANCLS drive COUT _1 and COUT_2. TPULSE, expressed in minutes,
defines the pulse width of both outputs. Mismatch alarming is optional, enabled when TOPT
equals 1.
PIDA
MEASLI MEASHI
FBM**
Motor
1657
B0193AX – Rev AA 85. MOVLV – Motor Operated Valve Block
1658