You are on page 1of 426

Composer ™

for Harmony

Function Code Application Manual


Volume 2 (Function Codes 177 to 247)
Preface

Function codes are the base of controlling the Symphony


Enterprise Management and Control System. Function codes
are control algorithms that reside in active controllers.
Advanced PID loops, batch control, math functions, and more
are all possible with function codes. In addition to control
schemes, function codes define control elements such as M/A
stations and device drivers in consoles and stand-alone con-
trollers.

The system engineer designs the module configuration using


software such as module configuration tools (Composer, SCAD
or WCAD) or C utilities program (CUP). The configuration is
then downloaded by using a configuration device such as an
engineering workstation or a human system interface.

This instruction lists all the available function codes and


explains the specifications and outputs of each code. To use
this instruction, the system engineer or technician must know
how to configure Symphony systems.

WBPEEUI210504C1
List of Effective Pages

Total number of pages in this instruction is 381, consisting of the following:

Page No. Change Date Page No. Change Date


Preface Original 219-1 through 219-8 Original
List of Effective Pages Original 220-1 through 220-7 Original
iii through xii Original 221-1 through 221-10 5 August 2003
1 through 11 Original 222-1 through 222-26 5 August 2003
177-1 through 177-19 Original 223-1 through 223-6 Original
178-1 through 178-5 Original 224-1 through 224-6 Original
179-1 through 179-10 Original 225-1 through 225-5 Original
226-1 through 226-9 Original
184-1 through 184-6 Original
227-1 through 227-8 5 August 2003
185-1 through 185-5 Original
228-1 through 228-5 5 August 2003
186-1 through 186-5 Original
229-1 through 229-10 Original
187-1 through 187-5 Original
241-1 through 241-2 Original
188-1 through 188-5 Original
242-1 through 242-3 Original
190-1 through 190-2 Original
243-1 through 243-2 Original
191-1 through 191-2 Original
244-1 through 244-2 Original
192-1 through 192-2 Original
245-1 through 245-3 Original
193-1 through 193-3 Original
246-1 through 246-2 Original
194-1 through 194-12 Original
247-1 through 247-15 Original
198-1 Original
A-1 through A-15 Original
199-1 Original
B-1 through B-15 Original
202-1 through 202-9 Original
C-1 through C-15 Original
210-1 through 210-6 Original
D-1 through D-12 Original
211-1 through 211-27 Original
E-1 through E-3 Original
212-1 through 212-5 Original
F-1 through F-7 Original
215-1 through 215-8 Original
G-1 through G-2 Original
216-1 through 216-6 Original
H-1 Original
217-1 through 217-7 Original
218-1 through 218-8 Original

WBPEEUI210504C1
Table of Contents

Volume 2
Section 1 Introduction ..................................................................................................... 1
Purpose ...................................................................................................................... 1
Instruction Content..................................................................................................... 1
Reference Documents ................................................................................................. 3
System Overview ......................................................................................................... 4
Configuration Devices ................................................................................................. 4
Function Code Theory ................................................................................................. 4
Block Addresses ...................................................................................................... 6
Specifications .......................................................................................................... 9
Linking Function Blocks Together ......................................................................... 10

Function Codes
Data Acquisition Analog ...................................................................................... 177-1
Data Acquisition Analog Input/Loop ................................................................... 178-1
Enhanced Trend ................................................................................................. 179-1
Factory Instrumentation Protocol Handler ........................................................... 184-1
Digital Input Subscriber ...................................................................................... 185-1
Analog Input Subscriber ..................................................................................... 186-1
Analog Output Subscriber ................................................................................... 187-1
Digital Output Subscriber ................................................................................... 188-1
User Defined Function Declaration ...................................................................... 190-1
User Defined Function One ................................................................................. 191-1
User Defined Function Two ................................................................................. 192-1
User Defined Data Import ................................................................................... 193-1
User Defined Data Export ................................................................................... 194-1
Auxiliary Real User Defined Function .................................................................. 198-1
Auxiliary Digital User Defined Function ............................................................... 199-1
Remote Transfer Module Executive Block (INIIT12) .............................................. 202-1
Sequence of Events Slave .................................................................................... 210-1
Data Acquisition Digital ...................................................................................... 211-1
Data Acquisition Digital Input/Loop .................................................................... 212-1
Enhanced Analog Slave Definition ....................................................................... 215-1
Enhanced Analog Input Definition ....................................................................... 216-1
Enhanced Calibration Command ........................................................................ 217-1
Phase Execution ................................................................................................. 218-1
Common Sequence ............................................................................................. 219-1
Batch Historian ................................................................................................... 220-1
I/O Device Definition .......................................................................................... 221-1

WBPEEUI210504C1 iii
Table of Contents (continued)

Volume 2 (continued)
Function Codes (continued)
Analog In/Channel ..............................................................................................222-1
Analog Out/Channel ...........................................................................................223-1
Digital In/Channel ..............................................................................................224-1
Digital Out/Channel ............................................................................................225-1
Test Status ..........................................................................................................226-1
Gateway ..............................................................................................................227-1
Foreign Device Definition .....................................................................................228-1
Pulse In/Channel ................................................................................................229-1
DSOE Data Interface ...........................................................................................241-1
DSOE Digital Event Interface ...............................................................................242-1
Executive Block (INSEM01) ..................................................................................243-1
Addressing Interface Definition ............................................................................244-1
Input Channel Interface .......................................................................................245-1
Trigger Definition .................................................................................................246-1
Condition Monitoring ...........................................................................................247-1

Appendix A List of Function Codes ........................................................................... A-1


Introduction ............................................................................................................ A-1
Cross Reference - Numerical.................................................................................... A-2
Cross Reference - Alphabetical................................................................................. A-5
Cross Reference - Categorization.............................................................................. A-7

Appendix B Harmony Bridge Controller (BRC-100) ................................................. B-1


Memory Utilization and Execution Times ................................................................. B-1
Memory Usage Equations ........................................................................................ B-8
Function Blocks - BRC-100 ..................................................................................... B-9
Module Status Information - BRC-100 ................................................................... B-11

Appendix C Harmony Area Controller (HAC) ............................................................ C-1


Memory Utilization and Execution Times ................................................................. C-1
Memory Usage Equations ........................................................................................ C-8
Function Blocks - HAC ............................................................................................ C-9
Module Status Information - HAC .......................................................................... C-11

iv WBPEEUI210504C1
Table of Contents (continued)

Volume 2 (continued)
Appendix D Multi-Function Processors
(IMMFP11/12) ................................................................................................................ D-1
Memory Utilization and Execution Times..................................................................D-1
Memory Usage Equations.........................................................................................D-7
Function Blocks - IMMFP11/12 ...............................................................................D-8
Module Status Information - IMMFP11/12 ...............................................................D-9

Appendix E Sequence of Events Monitor


(INSEM01) ..................................................................................................................... E-1
Memory Utilization...................................................................................................E-1
Module Status Information .....................................................................................E-1

Appendix F Communication Modules ........................................................................F-1


Introduction............................................................................................................. F-1
INICT03 and INICT12 Cnet to Computer Transfer Modules....................................... F-1
INIIT03 Local Transfer Module ................................................................................. F-3
INNPM11 and INNPM12 Network Processing Modules .............................................. F-5
Cnet Mode............................................................................................................ F-5
Plant Loop Mode................................................................................................... F-6

Appendix G Point Quality Definition .......................................................................... G-1


General Description .................................................................................................G-1
Individual Analog Inputs ..........................................................................................G-1
Group Analog Inputs................................................................................................G-1
Group Analog Outputs .............................................................................................G-1
Digital I/O ...............................................................................................................G-1
Peer-to-Peer and Module Bus I/O.............................................................................G-2

Appendix H Console Engineering Unit Descriptions ............................................... H-1


Engineering Unit Descriptions Tables.......................................................................H-1

WBPEEUI210504C1 v
Table of Contents (continued)

Volume 1
Section 1 Introduction ..................................................................................................... 1
Purpose .......................................................................................................................1
Instruction Content .....................................................................................................1
Reference Documents ..................................................................................................3
System Overview .........................................................................................................4
Configuration Devices..................................................................................................4
Function Code Theory .................................................................................................4
Block Addresses ......................................................................................................6
Specifications ..........................................................................................................9
Linking Function Blocks Together.......................................................................... 10

Function Codes
Introduction ............................................................................................................1-1
Function Generator .................................................................................................1-1
Manual Set Constant (Signal Generator) ..................................................................2-1
Lead/Lag .................................................................................................................3-1
Pulse Positioner .......................................................................................................4-1
Pulse Rate ...............................................................................................................5-1
High/Low Limiter ....................................................................................................6-1
Square Root ............................................................................................................7-1
Rate Limiter ............................................................................................................8-1
Analog Transfer .......................................................................................................9-1
High Select ............................................................................................................10-1
Low Select .............................................................................................................11-1
High/Low Compare ...............................................................................................12-1
Integer Transfer .....................................................................................................13-1
Summer (4-Input) ..................................................................................................14-1
Summer (2-Input) ..................................................................................................15-1
Multiply .................................................................................................................16-1
Divide ....................................................................................................................17-1
PID Error Input .....................................................................................................18-1
PID (PV and SP) .....................................................................................................19-1
Adapt ....................................................................................................................24-1
Analog Input (Periodic Sample) ..............................................................................25-1
Analog Input/Loop ................................................................................................26-1
Analog Exception Report ........................................................................................30-1
Test Quality ...........................................................................................................31-1
Trip .......................................................................................................................32-1

vi WBPEEUI210504C1
Table of Contents (continued)

Volume 1 (continued)
Function Codes (continued)
Not ....................................................................................................................... 33-1
Memory ................................................................................................................ 34-1
Timer .................................................................................................................... 35-1
Qualified OR (8-Input) ........................................................................................... 36-1
AND (2-Input) ....................................................................................................... 37-1
AND (4-Input) ....................................................................................................... 38-1
OR (2-Input) .......................................................................................................... 39-1
OR (4-Input) .......................................................................................................... 40-1
Digital Input (Periodic Sample) .............................................................................. 41-1
Digital Input/Loop ................................................................................................ 42-1
Digital Exception Report ....................................................................................... 45-1
Manual Set Switch ................................................................................................ 50-1
Manual Set Constant ............................................................................................ 51-1
Manual Set Integer ................................................................................................ 52-1
Hydraulic Servo .................................................................................................... 55-1
Node Statistics Block ............................................................................................ 57-1
Time Delay (Analog) .............................................................................................. 58-1
Digital Transfer ..................................................................................................... 59-1
Blink ..................................................................................................................... 61-1
Remote Control Memory ........................................................................................ 62-1
Analog Input List (Periodic Sample) ....................................................................... 63-1
Digital Input List (Periodic Sample) ....................................................................... 64-1
Digital Sum With Gain .......................................................................................... 65-1
Analog Trend ........................................................................................................ 66-1
Remote Manual Set Constant ................................................................................ 68-1
Test Alarm ............................................................................................................ 69-1
Control Interface Slave .......................................................................................... 79-1
Control Station ..................................................................................................... 80-1
Executive .............................................................................................................. 81-1
Segment Control ................................................................................................... 82-1
Digital Output Group ............................................................................................ 83-1
Digital Input Group ............................................................................................... 84-1
Up/Down Counter ................................................................................................ 85-1
Elapsed Timer ....................................................................................................... 86-1
Last Block ............................................................................................................. 89-1
Extended Executive ............................................................................................... 90-1
BASIC Configuration (BRC-100) ............................................................................ 91-1
Invoke BASIC ........................................................................................................ 92-1

WBPEEUI210504C1 vii
Table of Contents (continued)

Volume 1 (continued)
Function Codes (continued)
BASIC Real Output ................................................................................................93-1
BASIC Boolean Output ..........................................................................................94-1
Module Status Monitor ..........................................................................................95-1
Redundant Analog Input .......................................................................................96-1
Redundant Digital Input ........................................................................................97-1
Slave Select ...........................................................................................................98-1
Sequence of Events Log .........................................................................................99-1
Digital Output Readback Check ...........................................................................100-1
Exclusive OR .......................................................................................................101-1
Pulse Input/Period ..............................................................................................102-1
Pulse Input/Frequency ........................................................................................103-1
Pulse Input/Totalization ......................................................................................104-1
Pulse Input/Duration ..........................................................................................109-1
Rung (5-Input) .....................................................................................................110-1
Rung (10-Input) ...................................................................................................111-1
Rung (20-Input) ...................................................................................................112-1
BCD Input ...........................................................................................................114-1
BCD Output ........................................................................................................115-1
Jump/Master Control Relay ................................................................................116-1
Boolean Recipe Table ...........................................................................................117-1
Real Recipe Table ................................................................................................118-1
Boolean Signal Multiplexer ..................................................................................119-1
Real Signal Multiplexer ........................................................................................120-1
Analog Input/Cnet ..............................................................................................121-1
Digital Input/Cnet ...............................................................................................122-1
Device Driver .......................................................................................................123-1
Sequence Monitor ................................................................................................124-1
Device Monitor ....................................................................................................125-1
Real Signal Demultiplexer ....................................................................................126-1
Slave Default Definition .......................................................................................128-1
Multistate Device Driver ......................................................................................129-1
Analog Input/Slave ..............................................................................................132-1
Smart Field Device Definition ..............................................................................133-1
Multi-Sequence Monitor ......................................................................................134-1
Sequence Manager ..............................................................................................135-1
Remote Motor Control ..........................................................................................136-1
C and BASIC Program Real Output With Quality .................................................137-1
C or BASIC Program Boolean Output With Quality ..............................................138-1

viii WBPEEUI210504C1
Table of Contents (continued)

Volume 1 (continued)
Function Codes (continued)
Passive Station Interface ..................................................................................... 139-1
Restore ............................................................................................................... 140-1
Sequence Master ................................................................................................. 141-1
Sequence Slave ................................................................................................... 142-1
Invoke C ............................................................................................................. 143-1
C Allocation ........................................................................................................ 144-1
Frequency Counter/Slave ................................................................................... 145-1
Remote I/O Interface ........................................................................................... 146-1
Remote I/O Definition ......................................................................................... 147-1
Batch Sequence .................................................................................................. 148-1
Analog Output/Slave .......................................................................................... 149-1
Hydraulic Servo Slave ......................................................................................... 150-1
Text Selector ....................................................................................................... 151-1
Model Parameter Estimator ................................................................................. 152-1
ISC Parameter Converter ..................................................................................... 153-1
Adaptive Parameter Scheduler ............................................................................ 154-1
Regression .......................................................................................................... 155-1
Advanced PID Controller ..................................................................................... 156-1
General Digital Controller ................................................................................... 157-1
Inferential Smith Controller ................................................................................. 160-1
Sequence Generator ............................................................................................ 161-1
Digital Segment Buffer ........................................................................................ 162-1
Analog Segment Buffer ........................................................................................ 163-1
Moving Average ................................................................................................... 165-1
Integrator ............................................................................................................ 166-1
Polynomial .......................................................................................................... 167-1
Interpolator ......................................................................................................... 168-1
Matrix Addition ................................................................................................... 169-1
Matrix Multiplication ........................................................................................... 170-1
Trigonometric ...................................................................................................... 171-1
Exponential ........................................................................................................ 172-1
Power .................................................................................................................. 173-1
Logarithm ........................................................................................................... 174-1

WBPEEUI210504C1 ix
Table of Contents (continued)

Volume 1 (continued)
Appendix A List of Function Codes ........................................................................... A-1
Introduction ............................................................................................................ A-1
Cross Reference - Numerical.................................................................................... A-2
Cross Reference - Alphabetical................................................................................. A-5
Cross Reference - Categorization.............................................................................. A-7

Appendix B Harmony Bridge Controller (BRC-100) ................................................. B-1


Memory Utilization and Execution Times ................................................................. B-1
Memory Usage Equations ........................................................................................ B-8
Function Blocks - BRC-100 ..................................................................................... B-9
Module Status Information - BRC-100 ................................................................... B-11

Appendix C Harmony Area Controller (HAC) ............................................................ C-1


Memory Utilization and Execution Times ................................................................. C-1
Memory Usage Equations ........................................................................................ C-8
Function Blocks - HAC ............................................................................................ C-9
Module Status Information - HAC .......................................................................... C-11

Appendix D Multi-Function Processors


(IMMFP11/12) ................................................................................................................ D-1
Memory Utilization and Execution Times ................................................................. D-1
Memory Usage Equations ........................................................................................ D-7
Function Blocks - IMMFP11/12............................................................................... D-8
Module Status Information - IMMFP11/12 .............................................................. D-9

Appendix E Sequence of Events Monitor


(INSEM01) ..................................................................................................................... E-1
Memory Utilization .................................................................................................. E-1
Module Status Information .................................................................................... E-1

x WBPEEUI210504C1
Table of Contents (continued)

Volume 1 (continued)
Appendix F Communication Modules ........................................................................F-1
Introduction............................................................................................................. F-1
INICT03 and INICT12 Cnet to Computer Transfer Modules....................................... F-1
INIIT03 Local Transfer Module ................................................................................. F-3
INNPM11 and INNPM12 Network Processing Modules .............................................. F-5
Cnet Mode............................................................................................................ F-5
Plant Loop Mode................................................................................................... F-6

Appendix G Point Quality Definition .......................................................................... G-1


General Description .................................................................................................G-1
Individual Analog Inputs ..........................................................................................G-1
Group Analog Inputs................................................................................................G-1
Group Analog Outputs .............................................................................................G-1
Digital I/O ...............................................................................................................G-1
Peer-to-Peer and Module Bus I/O.............................................................................G-2

Appendix H Console Engineering Unit Descriptions ............................................... H-1


Engineering Unit Descriptions Tables.......................................................................H-1

List of Figures

Volume 2
No. Title Page

1. Symphony System Architecture ................................................................... 5


2. Function Code 7, Square Root...................................................................... 6
3. Function Code 80, Station ........................................................................... 7
4. Function Code 7 with a Block Address of 100............................................... 7
5. Function Code 80 with a Block Address of 105............................................. 8
6. Linking Function Blocks Together .............................................................. 10
177-1. Level Detection Alarms........................................................................ 177-13
177-2. Module Access to Status ..................................................................... 177-16

WBPEEUI210504C1 xi
List of Figures (continued)

Volume 2 (continued)
No. Title Page

177-3. Data Acquisition Analog Example ........................................................177-17


177-4. Normal, Variable and Deviation Alarms ...............................................177-19
178-1. Module Access to Status........................................................................178-4
179-1. Sample and Average Analog Trend with Reset........................................179-9
179-2. Sampling and Average and Sum Digital Trend .......................................179-9
179-3. Minimum and Maximum of Control Station .........................................179-10
184-1. FIP Input/Output Subscriber Variable Types .........................................184-5
184-2. Linking FIP Function Codes...................................................................184-6
194-1. Application Program Control Example ...................................................194-6
194-2. Application Program Control with HSI Access ........................................194-7
194-3. Application Program Control with HSI Access and Echo.........................194-8
194-4. Block Control Example ..........................................................................194-9
194-5. Block Control with HSI Access.............................................................194-10
194-6. Symphony Configuration Example.......................................................194-12
202-1. Timing Diagram of Enable Signals in Half Duplex Mode.........................202-5
202-2. Redundant IINIT02 with Control of External Equipment
in Half Duplex Operation .......................................................................202-5
202-3. Dual Channel in Full Duplex Operation .................................................202-7
211-1. Functions Executed within the DADIG Block .........................................211-4
211-2. Input Selection Logic .............................................................................211-5
211-3. Input Conditioning Logic .......................................................................211-9
211-5. Input Pulse Greater than Reference Match Time ..................................211-10
211-4. Pulse Mode Input and Output..............................................................211-10
211-6. Input Pulse Less than Reference Match Time.......................................211-11
211-7. Input Pulse Less than Maximum Pulse Width ......................................211-11
211-8. Input Pulse Greater than Maximum Pulse Width .................................211-12
211-9. Digital Filter Mode Input and Output...................................................211-13
211-10. Alarm Processing Logic........................................................................211-15
211-11. Digital State Alarm Mode Input and Alarm ..........................................211-17
211-12. Deadbanding Alarm Mode Input and Alarm .........................................211-18
211-13. Timed Out Alarm Mode Input and Alarm (S10 less than ta)..................211-18
211-14. Match Time Greater than Condition Time (S10 greater than ta)............211-19
211-15. Alarm Filter Mode Input and Alarm .....................................................211-20
211-16. Return Alarm and De-Alarm Logic .......................................................211-21
211-17. Alarm Suppression Logic .....................................................................211-21
215-1. Local Cold Junction Compensation........................................................215-4
215-2. Remote Cold Junction Compensation ....................................................215-7
218-1. PHASEX Function Block Configuration..................................................218-8

xii WBPEEUI210504C1
List of Figures (continued)

Volume 2 (continued)
No. Title Page

219-1. Example Production Train .................................................................... 219-5


219-2. Typical Batch Sequence Control ............................................................ 219-8
220-1. Example of BHIST Function Block Configuration................................... 220-6
222-1. Internal Cold Junction Compensation of Thermocouples..................... 222-12
222-2. External Cold Junction Compensation of Thermocouples .................... 222-18
222-3. User Defined Input.............................................................................. 222-24
226-1. Test Status Connection for Function Code 221...................................... 226-4
227-1. Function Codes Used with FC227 for S800 I/O ..................................... 227-8
229-1. Basic Frequency/Totalization Configuration........................................ 229-10

Volume 1
No. Title Page

1. Symphony System Architecture ................................................................... 5


2. Function Code 7, Square Root...................................................................... 6
3. Function Code 80, Station ........................................................................... 7
4. Function Code 7 with a Block Address of 100............................................... 7
5. Function Code 80 with a Block Address of 105............................................. 8
6. Linking Function Blocks Together .............................................................. 10
1-1. Graph of Input Versus Output .................................................................. 1-2
1-2. Sectioned Input-Output Graph.................................................................. 1-3
1-3. Programming Set Point or Bias.................................................................. 1-5
1-4. Noise Filter ............................................................................................... 1-5
1-5. Obtain an Adaptive Gain for a Nonlinear Process ...................................... 1-5
1-6. Greater Curve Resolution - Two Function Generators................................ 1-6
1-7. Greater Curve Resolution - Four Function Generators............................... 1-6
2-1. Scaler Configuration ................................................................................. 2-1
2-2. Set Point Configuration ............................................................................. 2-2
3-1. Lag Filter .................................................................................................. 3-3
3-3. Lag to Delay Decreases in Air Flow on a Load Decrease ............................. 3-4
3-4. Lead/Lag to Compensate for Drum Level Shrink and Swell ....................... 3-4
3-2. Lead Filter ................................................................................................ 3-4
4-1. PULPOS Controlling a Pulse Valve Positioner............................................. 4-4
4-2. CIO-100 Configuration.............................................................................. 4-6

WBPEEUI210504C1 xiii
List of Figures (continued)

Volume 1 (continued)
No. Title Page

5-1. Count Total Pounds of Flow.......................................................................5-4


6-1. Limit a Bias Range ....................................................................................6-2
6-2. Limiting Input to a Divider.........................................................................6-2
7-1. Converting a Pressure Signal to a Flow Rate ..............................................7-3
7-2. Converting a Nonlinear Pressure Input to a Linear Flow Output.................7-3
8-1. Limit the Rate of Change of the Set Point ...................................................8-2
9-1. Analog Transfer Function Used as a Memory Function ..............................9-2
9-2. Manual to Auto Transfer Switch ................................................................9-3
10-1. Memorize a High Value Over a Period of Time ..........................................10-2
11-1. Memorize a Low Value Over a Period of Time ...........................................11-2
12-2. Monitor the Relationship Between Two Signals ........................................12-2
12-1. Signal Monitor.........................................................................................12-2
13-1. Dynamic Adaptive Control Strategy .........................................................13-2
15-1. Scaler......................................................................................................15-2
18-1. Scaling the Output ..................................................................................18-2
18-2. Application ..............................................................................................18-4
19-1. PID (PV and SP) .......................................................................................19-4
19-2. PID Control with Deviation ......................................................................19-5
24-1. Creation of a Sliding Limiter or Index.......................................................24-3
24-2. Achieve Variable Controller Proportional Constant ...................................24-3
24-3. Select One of Two Input Values................................................................24-3
25-1. Acquire an Analog Signal from Another Module (BRC-100 only) ...............25-3
25-2. Acquire an Analog Signal from Another Module (HAC only) ......................25-4
26-1. Acquire an Analog Value from Another Node ............................................26-2
30-1. Analog Exception Report Input with Alarm and Exception Reports...........30-4
31-1. Test the Quality of Analog and Digital Inputs...........................................31-2
34-1. Regulatory Control ..................................................................................34-2
35-1. Output Shapes Obtained in the Three Timing Modes ...............................35-2
36-1. Signal Regulation Based on the Number of Pumps Operational................36-2
41-1. Acquire a Digital Signal from Another Module (BRC-100 only) .................41-2
41-2. Acquire a Digital Signal from Another Module (HAC only) ........................41-3
42-1. Configuration Required to Test Point Quality ...........................................42-2
45-1. Example Digital Exception Report Configuration......................................45-3
52-1. Dynamically Modify an Integer Parameter ................................................52-2
58-1. Fixed Time Delay Example.......................................................................58-3
58-2. Variable Time Delay.................................................................................58-4
58-3. First Order Simulated Response to Typical Time Delay ............................58-5
58-4. Response Simulation Configuration .........................................................58-5

xiv WBPEEUI210504C1
List of Figures (continued)

Volume 1 (continued)
No. Title Page

59-1. Safety Configuration ............................................................................... 59-2


61-1. Alarm Indication ..................................................................................... 61-2
62-1. Internal Logic of RCM Block .................................................................... 62-3
62-2. Logic and Circuitry of RCM Block Used for Motor Control........................ 62-5
65-1. Determine Flow Rates From a Digital Indication of Pump Status ............. 65-2
66-1. Configuration for Trending an Analog Point............................................. 66-3
66-2. Configuration for Trending a Digital Point ............................................... 66-3
68-1. Configuration for Operator Intervention .................................................. 68-2
80-1. Single Input, Single Output Control Loop with Auto Bypass .................. 80-13
80-2. Single Input, Single Output Control Loop with Auto Bypass .................. 80-14
80-3. Single Input, Single Output Control Loop without Auto Bypass ............. 80-15
85-1. Up/Down Counter Maintenance Requirement Alert................................. 85-4
86-1. Determining Average Power Consumption Over Time .............................. 86-5
90-1. Configuration Required for PC View Time-Synchronization...................... 90-6
91-1. Typical BASIC Configuration ................................................................... 91-3
92-1. Typical BASIC Configuration ................................................................... 92-2
93-1. Typical BASIC Configuration ................................................................... 93-2
95-1. Example Bit Values ................................................................................. 95-4
95-2. Equivalent Circuit................................................................................... 95-5
96-1. Choosing Between Redundant Analog Inputs .......................................... 96-3
97-1. Choose Between Redundant Digital Signals Based on Module Quality ..... 97-2
98-1. Transfer Control When Analog Inputs Go Bad ......................................... 98-3
98-2. Controlling an Analog Output ................................................................. 98-4
100-1. Internal Logic........................................................................................ 100-2
110-1. Four-Input Logic Rung.......................................................................... 110-4
110-2. AND-OR Logic Representation of Ladder Rung in 110-1 ........................ 110-4
114-1. Binary Coding of Inputs ........................................................................ 114-2
115-1. Real to BCD Conversion Format............................................................ 115-2
115-2. Binary Conversion ................................................................................ 115-3
116-1. Jump/MCR Block Used in Ladder Program ........................................... 116-3
123-1. Sample Batch Application ..................................................................... 123-8
123-2. Partitioning of Sample Control System .................................................. 123-9
123-3. Control Devices Associated with Example Batch Reactor ..................... 123-10
123-4. Logic Diagram for Example Batch Reactor........................................... 123-12
123-5. Auxiliary Logic for Step 1 in Example .................................................. 123-15
123-6. Auxiliary Logic for Steps 2 and 3 ......................................................... 123-17
123-7. Auxiliary Logic for Steps 4 and 5 ......................................................... 123-18
123-8. Auxiliary Logic for Steps 6 and 7 ......................................................... 123-18

WBPEEUI210504C1 xv
List of Figures (continued)

Volume 1 (continued)
No. Title Page

123-9. Auxiliary Logic for Step 8.....................................................................123-19


123-10. Recipe Tables for Example Process ......................................................123-19
123-11. Fixed-Sequence Batch Control Example with Online Editing................123-22
124-1. Sequence Monitor Block Used in a Batch Operation...............................124-4
125-1. Controlling Multiple Field Devices..........................................................125-4
126-1. Output Values in the BCD Mode ............................................................126-3
126-2. Recipe Selection ....................................................................................126-4
129-1. Relationship Between Feedback Inputs and Feedback Masks.................129-4
129-2. Four-Digit Feedback Mask ....................................................................129-4
129-3. Auto/Manual Status Monitored with Test Alarm Block ..........................129-5
129-4. Sample Faceplate ................................................................................129-12
129-5. Controlling a Variable Speed Motor ......................................................129-12
132-1. Linking Optional Smart Transmitters ....................................................132-5
133-1. FC 132 and FC 133 Example .................................................................133-9
133-2. Smart Field Device Definition Example ................................................133-10
133-3. Type AVS Positioner Application Example ............................................133-11
133-4. Flowmeter Application Example ...........................................................133-12
134-1. Multiple Sequence and Auxiliary Logic Connections...............................134-4
135-1. Sample Configuration Using Sequence Manager Block...........................135-4
135-2. Parallel Addition through Common Headers ..........................................135-7
135-3. Parallel Addition of A and B ...................................................................135-8
135-4. Simultaneous Addition of A and B .........................................................135-9
135-5. Control Common Header A ..................................................................135-10
135-6. Logic to Add A to K1 through Common Header ....................................135-10
135-7. Request Prioritizing Example ...............................................................135-11
135-8. Request Priority Logic ..........................................................................135-12
136-1. Basic Logic of Remote Motor Control Block ............................................136-2
139-1. Passive Station Interface Example .........................................................139-5
140-1. Using the Restore Block.........................................................................140-9
141-1. Parallel Sequence Master to Slave..........................................................141-4
141-2. Using Sequence Master Block in Batch ..................................................141-5
143-1. Watchdog Timer Configuration ..............................................................143-2
143-2. Entry in C Utility Program .....................................................................143-3
146-1. Remote I/O Interface Example...............................................................146-3
146-2. Remote I/O Interface Configuration .......................................................146-5
147-1. Remote I/O Definition Example .............................................................147-5
148-1. Batch Sequence Example ......................................................................148-7
149-1. Linking Analog Output Blocks ...............................................................149-4

xvi WBPEEUI210504C1
List of Figures (continued)

Volume 1 (continued)
No. Title Page

153-1. Basic Self-Tuning Configuration............................................................ 153-7


154-1. Adaptive Parameter Scheduler Example ................................................ 154-5
155-1. Contours of Equal m Plotted in the p – q Plane.................................... 155-12
155-2. Effect of Data Storage Technique ........................................................ 155-14
156-1. Advanced PID Output Example ............................................................. 156-8
156-2. Classical Controller............................................................................. 156-12
156-3. Classical Controller - Detail ................................................................ 156-12
156-4. Noninteracting Controller.................................................................... 156-14
156-5. Noninteracting Controller - Detail ....................................................... 156-15
156-7. Manual Reset PID Controller - Detail................................................... 156-17
156-6. Manual Reset PID Controller ............................................................... 156-17
156-8. Single Input/Single Output Control Loop ............................................ 156-19
157-1. Internal Logic........................................................................................ 157-6
160-1. Process Model Parameters..................................................................... 160-3
160-2. External Reference for Cascade Control ................................................ 160-5
160-3. ISC Structure........................................................................................ 160-7
160-4. Using the ISC with the M/A Station ...................................................... 160-8
161-1. Controlling a Batch Process .................................................................. 161-3
161-2. Series and Parallel to Provide 24 Steps for 16 Outputs .......................... 161-4
161-3. Series and Parallel to Provide Automatic Timed Stepping ...................... 161-6
168-1. Five-by-Five Array Used by Interpolation Block ..................................... 168-3
168-2. Approximation of Curve Using Interpolator............................................ 168-6
168-3. Approximation of Curve Using Function Generator................................ 168-6
169-1. Matrix Addition ..................................................................................... 169-2
170-1. Internal Operation of Matrix Multiplication Block.................................. 170-3

WBPEEUI210504C1 xvii
List of Tables

Volume 2
No. Title Page

1. Reference Documents ...................................................................................3


2. Block Addresses in a BRC-100 Controller .....................................................8
177-1. Quality State Override Bit Map ..............................................................177-3
177-2. 16 Bit Map ............................................................................................177-5
177-3. 16 Bit Binary Number ...........................................................................177-5
177-4. Bit Map .................................................................................................177-9
177-5. Alarm Thresholds ................................................................................177-12
177-6. Output N Bit Map................................................................................177-15
177-7. Output N+1 Bit Map ............................................................................177-16
178-1. Status Bits at Current Block Address ....................................................178-2
178-2. Extended Status Bit Map.......................................................................178-3
178-3. Example DAANG Settings ......................................................................178-5
185-1. Input Group Identification .....................................................................185-3
186-1. Input Group Identification .....................................................................186-3
187-1. Output Group Identification ..................................................................187-3
188-1. Output Group Identification ..................................................................188-3
194-1. Input Control Specification <S2> ...........................................................194-2
194-2. Data Export Function Block Operation ..................................................194-3
194-3. Input Status Specification <S3>.............................................................194-3
194-4. Block Status Output N+1 ......................................................................194-4
202-1. Settings for Figure 202-2 Configuration .................................................202-6
202-2. Settings for Figure 202-3 Configuration .................................................202-7
211-1. S1 Status Bit Map .................................................................................211-5
211-2. Valid Combinations for S1 .....................................................................211-6
211-3. Permit Input Bit Map.............................................................................211-7
211-4. Selected Input Bit Map ..........................................................................211-8
211-5. Bits 0 and 1 Valid Combinations for S6 .................................................211-9
211-6. Mode Time Parameters ........................................................................211-13
211-7. Alarm Mode Control Bit Map ...............................................................211-14
211-8. Time Parameters for Alarm Modes .......................................................211-20
211-9. S14 Bit Map ........................................................................................211-22
211-10. Valid Combination for S14...................................................................211-22
211-11. Extended Status Bit Map.....................................................................211-25
212-1. Decoded Extended Status Bit Map.........................................................212-3
215-1. Function Code 216 at Block Address 90 ................................................215-5
215-2. Function Code 215 at Block Address 100 ..............................................215-5
215-3. Function Code 216 at Block Address 110 ..............................................215-5
215-4. Function Code 216 at Block Address 125 ..............................................215-6

xviii WBPEEUI210504C1
List of Tables (continued)

Volume 2 (continued)
No. Title Page

215-5. Function Code 216 at Block Address 175 .............................................. 215-7


215-6. Function Code 216 at Block Address 202 .............................................. 215-8
215-7. Function Code 215 at Block Address 250 .............................................. 215-8
218-1. PHASEX Run-Time Fault Codes ............................................................ 218-5
219-1. Function Code 219 Specification Settings for Figure 219-2.................... 219-7
221-1. Analog Input Block ............................................................................... 221-6
221-2. Analog Output Block............................................................................. 221-7
221-3. Control Input/Output ........................................................................... 221-7
221-4. Digital Input Block................................................................................ 221-8
221-5. Digital Input/Output Block................................................................... 221-9
221-6. Digital Output Block ........................................................................... 221-10
222-1. Function Code 221 at Block Address 1000 .......................................... 222-12
222-2. Function Code 222 at Block Address 2001 .......................................... 222-13
222-3. Function Code 222 at Block Address 2002 .......................................... 222-14
222-4. Function Code 222 at Block Address 2003 .......................................... 222-15
222-5. Function Code 222 at Block Address 2004 .......................................... 222-15
222-6. Function Code 222 at Block Address 2017 .......................................... 222-16
222-7. Function Code 7 at Block Address 2100.............................................. 222-17
222-8. Function Code 221 at Block Address 1000 .......................................... 222-19
222-9. Function Code 222 at Block Address 2001 .......................................... 222-19
222-10. Function Code 221 at Block Address 1100 .......................................... 222-20
222-11. Function Code 222 at Block Address 2101 .......................................... 222-20
222-12. Function Code 222 at Block Address 2116 .......................................... 222-21
222-13. Function Code 222 at Block Address 2017 .......................................... 222-22
222-14. Function Code 221 at Block Address 1000 .......................................... 222-24
222-15. Function Code 222 at Block Address 2001 .......................................... 222-25
222-16. Function Code 1 at Block Address 2500.............................................. 222-25
226-1. Function Code 221 Status Conditions ................................................... 226-3
226-2. Function Codes 222 and 223 Status Conditions.................................... 226-5
226-3. Function Codes 224 and 225 Status Conditions.................................... 226-5
226-4. Function Code 227 Status Conditions ................................................... 226-6
226-5. Function Code 228 Status Conditions ................................................... 226-8
226-6. Function Code 229 Status Conditions ................................................... 226-8
227-1. Harmony Communication Block Configuration Parameters (S2) ............ 227-7
245-1. Information Format for Specifications S3 through S18 .......................... 245-2
247-1. Truth for Dual Voting Settings .............................................................. 247-7
A-1. Numerical Listing...................................................................................... A-2
A-2. Alphabetical Listing .................................................................................. A-5

WBPEEUI210504C1 xix
List of Tables (continued)

Volume 2 (continued)
No. Title Page

A-3. Adapt ....................................................................................................... A-8


A-4. Advanced Functions ................................................................................. A-8
A-5. BASIC Language....................................................................................... A-8
A-6. Batch Functions ....................................................................................... A-8
A-7. Batch Language........................................................................................ A-9
A-8. C Language .............................................................................................. A-9
A-9. Communications ...................................................................................... A-9
A-10. Computing ............................................................................................... A-9
A-11. Controlway/Module Bus and Peer-to-Peer Network I/O .......................... A-10
A-12. Control Function Blocks ......................................................................... A-10
A-13. Exception Report .................................................................................... A-10
A-14. Executive ............................................................................................... A-11
A-15. Factory Instrumentation Protocol ........................................................... A-11
A-16. Field I/O ................................................................................................ A-11
A-17. Harmony I/O.......................................................................................... A-11
A-18. BRC-100 Harmony Controller ................................................................. A-12
A-19. Ladder Logic........................................................................................... A-12
A-20. Logic ...................................................................................................... A-12
A-21. I/O Expander Bus .................................................................................. A-13
A-22. Restore................................................................................................... A-13
A-23. Sequence Command ............................................................................... A-13
A-24. Sequence of Events................................................................................. A-13
A-25. Signal Select........................................................................................... A-14
A-26. Signal Status.......................................................................................... A-14
A-27. Station ................................................................................................... A-14
A-28. Text Selector........................................................................................... A-14
A-29. Trend ..................................................................................................... A-14
A-30. Trip ........................................................................................................ A-14
A-31. User Defined Function............................................................................ A-15
B-1. BRC-100 Memory Utilization and Execution Times ................................... B-1
B-2. FC221 Execution Times............................................................................ B-8
B-3. BRC-100 Module .................................................................................... B-10
B-4. Bit Description - BRC-100 ...................................................................... B-11
B-5. Byte Description - BRC-100.................................................................... B-12
C-1. HAC Memory Utilization and Execution Times .......................................... C-1
C-2. FC221 Execution Times............................................................................ C-8
C-3. Harmony Area Controller .......................................................................... C-9
C-4. Bit Description - HAC ............................................................................. C-11

xx WBPEEUI210504C1
List of Tables (continued)

Volume 2 (continued)
No. Title Page

C-5. Byte Description - HAC ...........................................................................C-11


D-1. Module Memory Utilization and Execution Times ......................................D-1
D-2. Function Blocks for the IMMFP11/12 Multi-Function Processors ..............D-8
D-3. Bit Description - IMMFP11/12 ................................................................D-10
D-4. Byte Description - IMMFP11/12..............................................................D-10
E-1. Available Module Configuration Memory ...................................................E-1
E-2. Module Memory Utilization for Function Codes .........................................E-1
E-3. Bit Description - INSEM01 ........................................................................E-1
E-4. Byte Description - INSEM01......................................................................E-2
F-1. INICT03 and INICT12 Status Bytes ........................................................... F-1
F-2. INICT03 and INICT12 Status Bits.............................................................. F-2
F-3. INIIT03 Status Bytes ................................................................................. F-3
F-4. INIIT03 Status Bits ................................................................................... F-4
F-5. INNPM12 (Cnet Mode) and INNPM11 Status Bytes .................................... F-5
F-6. INNPM12 (Cnet Mode) and INNPM11 Status Bits....................................... F-5
F-7. INNPM12 Status Bytes (Plant Loop Mode).................................................. F-7
F-8. INNPM12 Status Bits (Plant Loop Mode) .................................................... F-7
H-1. Human System Interface (Conductor VMS/NT)..........................................H-1

Volume 1
No. Title Page

1. Reference Documents .................................................................................. 3


2. Block Addresses in a BRC-100 Controller..................................................... 8
24-1. Conversions Performed by the Adapt Block ............................................. 24-2
34-1. Power Up or Controller Reset Truth Table................................................ 34-1
34-2. Normal Operation Truth Table ................................................................ 34-2
37-1. 2-Input AND Truth Table ........................................................................ 37-1
38-1. 4-Input AND Truth Table ........................................................................ 38-1
39-1. 2-Input OR Truth Table .......................................................................... 39-1
40-1. 4-Input OR Truth Table .......................................................................... 40-1
55-1. Module Status Bit Map ........................................................................... 55-5
55-2. LVDT Status ........................................................................................... 55-7
55-3. Position Feedback Options .................................................................... 55-10

WBPEEUI210504C1 xxi
List of Tables (continued)

Volume 1 (continued)
No. Title Page

61-1. Truth for Output Values ..........................................................................61-1


62-1. RCM Input to Output Relationship ..........................................................62-1
69-1. Outputs from Test Alarm Block ...............................................................69-2
80-1. Track Behavior of the Station Block .........................................................80-6
82-1. Total Segment Checkpoint Utilization ......................................................82-5
90-1. Available PC View Tag Names ..................................................................90-6
101-1. Exclusive OR Truth Table ......................................................................101-1
114-1. BCD to Real Conversion Format ............................................................114-1
115-1. Module Output Capacity........................................................................115-2
123-1. Override Permissive/State Specifications ...............................................123-2
123-2. Recipe Contents ..................................................................................123-20
126-1. Integer Mode Input to Output Relationship ............................................126-2
126-2. Each Group of Outputs Represents Two Real Digits...............................126-3
126-3. Sample Outputs of a Real Signal Demultiplexer Block ...........................126-4
129-1. Truth for Selection of Output Masks in Auto Mode.................................129-4
133-1. Specification S3 Engineering Units ........................................................133-4
140-1. Save Action ...........................................................................................140-3
140-2. BRC-100 and IMMFP11/12 Additional NVRAM
and Checkpoint Utilization Byte Size .....................................................140-4
140-3. HAC Additional NVRAM and Checkpoint Utilization Byte Size ................140-6
141-1. Output Descriptions ..............................................................................141-4
147-1. Function Blocks Supported by Remote I/O Definition Block ..................147-3
147-2. RMP Shared Memory Usage ...................................................................147-4
148-1. BSEQ Run-Time Fault Codes.................................................................148-4
151-1. HSI Color Codes ....................................................................................151-2
161-1. Definition of Step Inputs for Sequence Generator Blocks .......................161-6
168-1. Interpolator Block Determines Steam Properties ....................................168-5
A-1. Numerical Listing ..................................................................................... A-2
A-2. Alphabetical Listing .................................................................................. A-5
A-3. Adapt ....................................................................................................... A-8
A-4. Advanced Functions ................................................................................. A-8
A-5. BASIC Language....................................................................................... A-8
A-6. Batch Functions ....................................................................................... A-8
A-7. Batch Language........................................................................................ A-9
A-8. C Language .............................................................................................. A-9
A-9. Communications ...................................................................................... A-9
A-10. Computing ............................................................................................... A-9
A-11. Controlway/Module Bus and Peer-to-Peer Network I/O .......................... A-10

xxii WBPEEUI210504C1
List of Tables (continued)

Volume 1 (continued)
No. Title Page

A-12. Control Function Blocks ......................................................................... A-10


A-13. Exception Report .................................................................................... A-10
A-14. Executive ................................................................................................ A-11
A-15. Factory Instrumentation Protocol ............................................................ A-11
A-16. Field I/O ................................................................................................. A-11
A-17. Harmony I/O .......................................................................................... A-11
A-18. BRC-100 Harmony Controller ................................................................. A-12
A-19. Ladder Logic ........................................................................................... A-12
A-20. Logic ....................................................................................................... A-12
A-21. I/O Expander Bus .................................................................................. A-13
A-22. Restore ................................................................................................... A-13
A-23. Sequence Command ............................................................................... A-13
A-24. Sequence of Events ................................................................................. A-13
A-25. Signal Select ........................................................................................... A-14
A-26. Signal Status .......................................................................................... A-14
A-27. Station.................................................................................................... A-14
A-28. Text Selector ........................................................................................... A-14
A-29. Trend...................................................................................................... A-14
A-30. Trip......................................................................................................... A-14
A-31. User Defined Function ............................................................................ A-15
B-1. BRC-100 Memory Utilization and Execution Times....................................B-1
B-2. FC221 Execution Times ............................................................................B-8
B-3. BRC-100 Module.....................................................................................B-10
B-4. Bit Description - BRC-100.......................................................................B-11
B-5. Byte Description - BRC-100 ....................................................................B-12
C-1. HAC Memory Utilization and Execution Times...........................................C-1
C-2. FC221 Execution Times ............................................................................C-8
C-3. Harmony Area Controller ..........................................................................C-9
C-4. Bit Description - HAC..............................................................................C-11
C-5. Byte Description - HAC ...........................................................................C-11
D-1. Module Memory Utilization and Execution Times ......................................D-1
D-2. Function Blocks for the IMMFP11/12 Multi-Function Processors ..............D-8
D-3. Bit Description - IMMFP11/12 ................................................................D-10
D-4. Byte Description - IMMFP11/12..............................................................D-10
E-1. Available Module Configuration Memory ...................................................E-1
E-2. Module Memory Utilization for Function Codes .........................................E-1
E-3. Bit Description - INSEM01 ........................................................................E-1
E-4. Byte Description - INSEM01......................................................................E-2

WBPEEUI210504C1 xxiii
List of Tables (continued)

Volume 1 (continued)
No. Title Page

F-1. INICT03 and INICT12 Status Bytes ............................................................F-1


F-2. INICT03 and INICT12 Status Bits ..............................................................F-2
F-3. INIIT03 Status Bytes .................................................................................F-3
F-4. INIIT03 Status Bits ....................................................................................F-4
F-5. INNPM12 (Cnet Mode) and INNPM11 Status Bytes .....................................F-5
F-6. INNPM12 (Cnet Mode) and INNPM11 Status Bits .......................................F-5
F-7. INNPM12 Status Bytes (Plant Loop Mode) ..................................................F-7
F-8. INNPM12 Status Bits (Plant Loop Mode) ....................................................F-7
H-1. Human System Interface (Conductor VMS/NT) H-1

xxiv WBPEEUI210504C1
Safety Summary

SPECIFIC The control system must be carefully evaluated to establish


WARNINGS default values that will prevent personal injury and/or prop-
erty damage in the case of module failure. (p. 79-1, 83-1,
221-1, 223-1, 225-1)

WBPEEUI210504C1 xxv
Trademarks and Registrations

Registrations and trademarks used in this document include:


™ BATCH 90 Trademark of ABB.
™ Composer Trademark of ABB.
® INFI 90 Registered trademark of ABB.
™ Symphony Trademark of ABB.

xxvi WBPEEUI210504C1
Introduction Section 1

Purpose
Unlike application dependent systems that force the employ-
ment of specific control steps, Symphony systems offer a large
library of over 200 versatile function codes resident in active
controllers. These powerful algorithms may be used in
sequences or nested within on-board function blocks (address-
able memory locations) to deliver widely varied control strate-
gies without special programming knowledge. Customized
function codes may be created with special user definable
function code software.

Symphony system function codes are compatible with a variety


of other configuration techniques. Function codes exist for
BASIC, Batch 90™, Ladder and C Language execution.

Instruction Content
The function code application manual provides descriptions of
each function code. To use this instruction and function
codes, a knowledge of Symphony configuration techniques is
required.
Introduction The introduction provides an overview of function code usage.
Function Codes Each function code has its own section. For example, find
function code 1 on pages 1-1 through 1-10, function code 2 on
pages 2-1 and 2-2, etc. Function code sections use the follow-
ing format:

A brief description of the operations of the function code.

Outputs - provides a brief, comprehensive description of the


block output. The table shows the block number (Blk), the
data type (Type), and a description of the block output
(Description).

Specifications - provides a brief, comprehensive description of


the specifications in the function code.

WBPEEUI210504C0 1
Instruction Content

• Spec lists the specification number. For example, specifica-


tion one is S1, specification two is S2, etc.

• Tune shows if the specification is tunable (Y for yes and N


for no). Tunable means that the value of the specification
can be changed with the module in execute mode.

• Default is the original value of the specification before cus-


tom configuration.

• Type shows if the specification is a boolean (B), integer (I)


or real (R) value.

Boolean (B) data is either a logic 0 or logic 1.

Integer (I) data is a whole number.

Real (R) data is a floating point decimal number which may


be a whole number or a decimal fraction.

• Range lists the allowable span of specification values.

• Description provides a brief explanation of the


specification.

Explanation (Specifications and Outputs) - the more compli-


cated function codes require greater explanation than the gen-
eral description, output table, and specification table provide.
The explanation section provides a thorough description of the
function code operation.

Applications - to aid in understanding the function code, the


applications section provides useful examples.
Appendices Appendices A through H provide additional information:
A through H
• Appendix A lists the function codes in three ways: numeri-
cally, alphabetically, and by category.

• Appendix B lists the module memory utilization and execu-


tion times for each function code, the module function
blocks, and the module status for the BRC-100 controller.

• Appendix C lists the module memory utilization and execu-


tion times for each function code, the module function
blocks, and the module status for the HAC controller.

• Appendix D lists the module memory utilization and exe-


cution times for each function code, the module function

2 WBPEEUI210504C0
Reference Documents

blocks, and the module status for the IMMFP11/12 con-


trollers.

• Appendix E lists the module memory utilization for each


function code, the module function blocks, and the module
status for the INSEM01 Cnet to Computer Communica-
tions and Sequence of Events Monitor.

• Appendix F describes the status bytes and their descrip-


tions for the following communication modules:

INICT03 Cnet to Computer Transfer Module.

INICT12 Cnet to Computer Transfer Module.

INIIT03 Local Transfer Module.

INNPM11 Network Processing Module.

INNPM12 Network Processing Module.

• Appendix G defines point quality.

• Appendix H lists the available engineering units.

Reference Documents
Table 1 lists documents referenced in this manual.

Table 1. Reference Documents

Number Description
A-G0000-953-01-B Self Tuning Control
I-E93-906-6A0 MFC BASIC Programming Language Reference
I-E96-309 Digital I/O Slave Module (IMDSM05)
I-E96-703 C Utility Program
I-E96-705 Ladder Programming (SLAD)
S800 I/O Modules
WBPEEUI240751?? Harmony Input/Output System, I/O and Auxiliary Blocks
WBPEEUI240758?? IMASI13 Isolated Analog Input Module
WBPEEUI240771?? IMHSS03 Hydraulic Servo
WBPEEUI240772?? IMDSM04 Pulse Input Module
WBPEEUI250023?? IOR-800 Gateway

WBPEEUI210504C0 3
System Overview

Table 1. Reference Documents (continued)

Number Description
WBPEEUI330251?? Batch Data Manager
WBPEEUI330252?? Batch 90 and User Defined Function (UDF) Programming Language Ref-
erence

System Overview
A Symphony system can be as small as a single Harmony con-
trol unit (HCU) or as complex as a system such as the one
shown in Figure 1. Function codes reside in the active control-
lers (e.g., BRC-100 controller). Configuring function codes in a
module is like programming a computer. The function codes
are added, deleted, modified and tuned in the module by using
a configuration device.

Configuration Devices
Symphony offers a broad range of configuration interface
devices. Configuring function blocks is straightforward by
using a building block approach. Some of the various tools
used to add, delete, modify, or monitor function blocks are:

• Composer tools.

• Conductor consoles.

• Additional software:
Process Information Web Server.
C Utilities Program (CUP).
Ladder Logic (SLAD).
Batch Language.
Expert System Language.
Relational Database.

Function Code Theory


Controllers may be configured to perform algorithms or dis-
play values by arranging a group of functions in a certain
order. These functions are implemented in a module by assign-
ing a function code to a function block through a human sys-
tem interface device. Each function has a unique function
code number. Appendix A lists the available function codes.

4 WBPEEUI210504C0
Function Code Theory

P ER F O R M E R
LE VE L
P RO C ES S IN FO R M ATIO N
A PP LIC ATIO N W EB S ERV ER

E XT ER N A L E XT ER N A L E XT ER N A L E XT ER N A L
D E VIC E D E VIC E D E VIC E D E VIC E

• • • • • •

O P E R ATIO N S N E TW O R K

O P E R ATIO N S
LE VE L C O N D U C TO R
VMS

E XT ER N A L N E TW O R K
D E VIC E C O U PLE R
CO MPOSER

A PP LIC ATIO N S C O N D U C TO R
P RO G R A M M IN G NT
G ATE W AY

C O N TRO L N ET W O R K

P RO C ES S
LE VE L

HARM ONY
A R EA
C O N TRO L LER
HCU
P EE R -TO -PE E R N ET W O R K

LOCAL HNET
RM U

R E M OTE H N E T

R E PE ATE R
I/O
M O U N T IN G
B LO C K
U N IT (R M U )

RMU I/O B LO C K S

R E M OT E C A B IN ET
M A N UAL/AU TO P O RTAB LE TO O L S
S TATIO N S TE R M IN A L
HCU T 02 0 22 B

Figure 1. Symphony System Architecture

Each active module has a memory for storing the configuration


information entered in the form of function blocks. This
memory is nonvolatile random access memory (NVRAM). The

WBPEEUI210504C0 5
Function Code Theory

information stored in the NVRAM is retained if power to the


module is interrupted. In addition to NVRAM in a module,
there is random access memory (RAM) which is a scratch pad
for module calculation. The function blocks stored in the
NVRAM work similarly to an application program on a
computer.

Each function entered requires space in NVRAM and RAM in


the module. The amount of space used by the function code
depends upon which function code is used and its application.
Refer to the applicable appendix to find the amount of RAM
and NVRAM available for a specific module.

NOTE: Take care to assure that the memory required by all planned module
functions does not exceed the available NVRAM and RAM memory of the con-
trollers.

Block Addresses
Function codes are referenced by block addresses (N). Some
functions have only one block address (e.g., function code 7,
the square root) while other function codes require several
consecutive block numbers (e.g., function code 80, the sta-
tion). Figure 2 shows the square root function code, and Fig-
ure 3 shows the station function code.

S1 (7 )
N

Figure 2. Function Code 7,


Square Root

The N represents the block address. The address can be any


valid configurable block address in the module. For example,
when using a BRC-100 controller, the available configurable
block addresses (N) are 30 through 9,998 (blocks zero through
29 and block 9999 contain fixed blocks). Each block address
must be a unique number within a module.

Figure 4 shows function code 7, the square root with a block


address of 100. Figure 5 shows the function code 80, a station
with a block address of 105.

6 WBPEEUI210504C0
Function Code Theory

M /A
M FC /P
S1 (80)
PV SP
S2 N+1
SP O
S3 N
A A
S4 N+2
TR C /R
S5 N+4
TS C
S 18 N+3
MI C -F
S 19 N+5
AX
S 20
C /R
S 21
LX
S 22
CX
S 24
HAA
S 25
L AA
S 26
H DA
S 27
L DA
S 28
AO
S 29
TRS2
S 30
TRPV T

Figure 3. Function Code 80,


Station

S1 (7)
100

T 02 03 1 A

Figure 4. Function Code 7


with a Block Address of 100

The block address number is also referred to as the block out-


put. The block output value is dependent upon the specifica-
tion inputs and settings.

Controllers contain some fixed blocks. For example, the fixed


blocks in a BRC-100 Harmony Bridge Controller are the
executive block, the segment control block, the extended exec-
utive block, and the last block. Table 2 shows the available
block numbers for a BRC-100 controller.

WBPEEUI210504C0 7
Function Code Theory

M /A
M FC/P
S1 (80)
PV SP
S2 106
SP O
S3 105
A A
S4 107
TR C /R
S5 109
TS C
S 18 108
MI C -F
S 19 110
AX
S 20
C /R
S 21
LX
S 22
CX
S 24
HAA
S 25
LAA
S 26
H DA
S 27
LDA
S 28
AO
S 29
TRS2
S 30
TRPV T

T 02 03 2 A

Figure 5. Function Code 80


with a Block Address of 105

Table 2. Block Addresses in a BRC-100 Controller

Function Function Code Block


Block Description
Code Description Address
81 Executive block 0 Logic 0
Selects the output mode of 1 Logic 1
the light emitting diodes 2 0 or 0.0
(LED) on the front panel of
3 -100.0
the master module. The
LEDs can display the status 4 -1.0
of the master module or an 5 0.0
internal memory location.
6 1.0
7 100.0
8 -9.2 E18
9 9.2 E18
10 Startup in progress flag: 0 = no, 1 = yes
11 Memory display value
12 System free time in percent
13 Revision level
14 Reserved

8 WBPEEUI210504C0
Function Code Theory

Table 2. Block Addresses in a BRC-100 Controller (continued)

Function Function Code Block


Block Description
Code Description Address
82 Segment control block 15 Elapsed time of previous cycle in units set
by S1
Groups subsequent blocks 16 Elapsed time current cycle in units set by
into a scan cycle executed at S1
a specified rate and priority. 17 Processor utilization in percent
18 Check point overrun count number (number
of cycles over that specified in S4)
19 Cycle time overrun in units set by S1
90 Extended executive block 20 Hours, time of day
Defines variables that affect 21 Minutes, time of day
the controllers operation. 22 Seconds, time of day
Sets system operation char-
acteristics for the module. 23 Time/date/synchronization flag:
0 = time/date invalid
1 = time/date valid
24 Year (0 to 99)
25 Month (1 to 12)
26 Day (1 to 31)
27 Day of week (1 to 7, Sunday = 1)
28 Reserved
29 Reserved
30 - 9998 User configurable blocks
89 Last block 9999 Last block in the module

Specifications
The S represents the specification number. There are two types
of specifications. One type of specification is a block address
input to the function block. The second type of specification
affects the internal operation of the function block. In
Figure 4, specification one (S1) is the block address of the
input. The square root also has S2. Specification S2 is the gain
value in engineering units. In a square root function code, S2
can be set to any real number.

Angle brackets around a block address input specification ref-


erence the block input value to the function block, not the
block number. For example, Figure 6, block 105 (the station)

WBPEEUI210504C0 9
Function Code Theory

has an S1 input of block 80 (the square root). Specification S1


is actually set to 80 (block 80). The value out of block 80 into
S1 of block 105 is zero to 100 percent. This is identified by
angle brackets around S1.

Block 105, S1 is set to block address 80 to provide an input


signal of <S1> equals zero to 100 percent.

Linking Function Blocks Together


Figure 6 shows function blocks linked together to complete a
simple loop. In this example, the input is from a flow transmit-
ter that provides a nonlinear flow signal with a range of zero to
100 percent. The square root with a gain (S2) of ten provides
the station process variable (PV) input with a linear flow sig-
nal. The control output of the station could be used to control
a valve or other device.

M /A
M FC/P
FT S2 (7 ) S1 (8 0 )
0 -1 0 0 %
√ 80 S2
PV SP
108 O UTPUT
SP O
S3 105 CO NTROL
A A
S2 = 10 S4 107
TR C /R
S5
TS C
S18 108
0 -1 0 0 % MI C -F
1 0 X √ < S 1> S19 110
AX
S20
C /R
S21
LX
S22
CX
S24
HAA
S25
LA A
S26
HAd
S27
LDA
S28
AO
S29
TR S2
S30 T
TR PV

T 01 57 4 A

Figure 6. Linking Function Blocks Together

There are an infinite number of configuration possibilities.


Function code blocks may be grouped together in a configura-
tion for customized control. After completing the desired con-
figuration, either download the configuration to the module
(e.g., when using computer aided design (CAD)) or put the
module into execute mode (e.g., when using Composer). After
the desired configuration has been entered into the module (by

10 WBPEEUI210504C0
Function Code Theory

downloading with Composer), the module may be placed in an


online mode (execute) to control the process. For more infor-
mation on configuring controllers, refer to the appropriate con-
figuration device instruction.

WBPEEUI210504C0 11
WBPEEUI210504C0
Data Acquisition Analog
Function Code 177

DAA N G The data acquisition analog (DAANG) function code provides a


(1 7 7 )
S7
N /A RV number of unique data selection, conditioning and monitoring
S8 N
S9
Q UA L ST
N+1 functions. These include support for enhanced alarm manage-
IN -S EL
S10
RV
ment capabilities at the module level of a Symphony system.
S11 CHAR
S12
CV The default specifications allow single level alarming and
S14 IN -P M T exception reporting of the real input.
S15 X -R P T
S16 A LM -S U P
S17 VHA
Outputs
S18 V LA
S19 DEV Blk Type Description
N R Current value, quality/status
N+1 R Current extended status

Specifications

Spec Tune Default Type Range Description


S1 N 100.000 R Full Engineering unit high display reference
S2 N 0.000 R Full Engineering unit center display reference
S3 N 0.000 R Full Engineering unit low display reference
S4 N 9.2 E18 R Full Engineering unit high constraint limit
S5 N -9.2 E18 R Full Engineering unit low constraint limit
S6 N 0 I 0 - 255 Engineering unit identifier
S7 N 5 I Note 1 Spare real input
S8 N 5 I Note 1 Block address of quality state override
S9 N 5 I Note 1 Block address of input select control
S10 N 5 I Note 1 Block address of real value input
S11 N 2 I Note 1 Block address of input shaping algorithm
S12 N 5 I Note 1 Block address of calculated value input
S13 N 0.000 R Full Engineering unit selected inserted value
S14 N 0 I Note 1 Block address of permit input selection
S15 N 0 I Note 1 Block address of request exception report
S16 N 0 I Note 1 Block address of activate alarm suppression
S17 N 5 I Note 1 Block address of variable high 1 alarm limit
S18 N 5 I Note 1 Block address of variable low 1 alarm limit

WBPEEUI210504C0 177 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S19 N 5 I Note 1 Block address of deviation alarm reference value
S20 Y 0.000 R Full Alarm control
S21 Y 2 2.000 R Full Engineering unit high alarm deadband
S22 Y 2 0.000 R Full Engineering unit high 3 alarm difference
S23 Y2 0.000 R Full Engineering unit high 2 alarm difference
S24 Y2 9.2 E18 R Full Engineering unit high 1 fixed alarm value
S25 Y 2 -9.2 E18 R Full Engineering unit low 1 fixed alarm value
S26 Y 2 0.000 R Full Engineering unit low 2 alarm difference
S27 Y2 0.000 R Full Engineering unit low 3 alarm difference
S28 Y2 2.000 R Full Engineering unit low alarm deadband
S29 Y 2 9.2 E18 R Full Engineering unit deviation alarm limit
S30 Y 2.000 R Full Engineering unit significant change to force
exception report
S31 Y 100.000 R Full Period for time based alarms in seconds
S32 Y 9.2 E18 R Full Engineering unit high rate of change
S33 Y 0.000 R Full Engineering unit low rate of change
S34 Y 2.000 R Full Time sequence alarm count
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. Specification is tunable but not adaptable. Adapted specification values are invalid.

Explanation
Specifications
S1 Engineering units high display reference. A numeric or graphi-
cal display element can use this value as the maximum posi-
tive reference of the monitored value.
S2 Engineering units center display reference. This specification
allows bidirectional bar chart elements on consoles by defining
a positive and negative segment for the display (i.e., upward
movement when the input is greater than S2 and downward
movement when the input is less than S2). Specifications S2
and S3 define the lower segment. Specifications S1 and S2
define the upper segment. To disable the center display refer-
ence, set S2 equal to S3.

177 - 2 WBPEEUI210504C0
S3 Engineering units low display reference. Numerical or graphi-
cal display elements use this value as the maximum negative
reference of the monitored value.
S4 Engineering units high constraint limit. The input select con-
trol <S9> enables this limit. Enabled constraint limits cause
the selected input value to report as less than or equal to the
high constraint limit. The input will be constrained when it
exceeds this configured value. When the real (constrained)
input is selected (by a value of 4.0 or 5.0 at <S9>), the con-
straining action is the resultant value of the input character-
ization algorithm defined by <S11> (if used).

NOTE: S4 must be greater than S5.


S5 Engineering units low constraint limit. The input select control
<S9> enables this limit. An enabled constraint limit makes the
selected input value always greater than or equal to this low
limit. The input is constrained when below this configured
value. When the real (constrained) input is selected (by a value
of 4.0 or 5.0 at <S9>), the constraining action is the resultant
value of the input characterization algorithm defined by
<S11>.

NOTE: S4 must be greater than S5.


S6 Engineering unit identifier. It is used by display systems to
select an engineering unit descriptor.
S7 Spare real input.
S8 Block address of the quality state override. It allows an exter-
nal source to override the quality and status of the reported
value. The override value converts to a truncated integer and
the bits are shown in Table 177-1.

Table 177-1. Quality State Override Bit Map

Bit Binary Value Attribute


All 0 Generate quality state internally (default)
0 1 Force good quality
1 2 Force calculated mode
2 4 Force manual mode
3 8 Limited
4 16 Suspect or out of range

WBPEEUI210504C0 177 - 3
Table 177-1. Quality State Override Bit Map (continued)

Bit Binary Value Attribute


5 32 Hardware failure or bad quality
6 64 E-STOP
7 - 15 – Reserved for future use

The quality state override does not affect the processing of the
DAANG function code. The override state specified is logically
ORed with the internally derived state. This permits the selec-
tive use of the internal functions or special external functions.

NOTE: If an external function generates any of these control bits, the internal
features that correspond to the defined functions must be inhibited. This pre-
vents a possible conflict between the externally driven status and the internal
status.

Quality is normally derived from the selected input unless:

• Bit zero is set to logic 1. This forces the quality to be good


regardless of the actual input quality state. Bit five over-
rides bit zero if both are set.

• Bit five is set to logic 1. This forces the quality to be bad


regardless of the actual input quality state. Bit five over-
rides bit zero if both are set.

A real <S10> or calculated <S12> input with bad quality from


any block (except one containing function code 178) sets the
hardware failure bit in the DAANG exception report (status
and extended status fields). Normally, the quality associated
with an exception report (alarm field) is set by the communica-
tion system to indicate a communication failure. Therefore, the
quality state in the exception report alarm field is actually the
communication status for function code 177 exception reports
and is never set by the function code 177 itself. Neither bad
input quality or overridden/forced bad quality will affect this
bit.

In the DAANG function code the hardware failure bit in the


exception report extended status field, exception report status
field, and extended status output N+1 is set to propagate the
bad quality of the input. The state of the hardware failure bit
sets the quality of the block output N.

177 - 4 WBPEEUI210504C0
S9 Block address of the input control. This specification gives an
external source the ability to control the input selection when
enabled by the permit input selection <S14>. The real input
value is converted into a truncated integer and the bits are
mapped as in Tables 177-2 and 177-3.

Table 177-2. 16 Bit Map

Bit Binary Value Attribute


All 0 Real, unconstrained, on scan (default)
0 1 Select input:
0 = <S13>
1= calculated <S12>
1 2 Custom enable select:
0 = real <S10>
1 = select input from bit 0
2 4 Constrain input high/low limit:
0 = disabled
1 = enabled
3 8 Spare
4 16 Spare
5 32 Spare
6 64 Spare
7 128 Report mode:
0 = on scan, on report
1 = off scan, no report
8- 15 – Spare

Table 177-3. 16 Bit Binary Number

Input Select Bit


Mode
Value Pattern
0 or 1 Bit 0 = X Real value <S10> input (unconstrained)
Bit 1 = 0
Bit 2 = 0
2 Bit 0 = 0 Selected value <S13> input (unconstrained)
Bit 1 = 1
Bit 2 = 0
3 Bit 0 = 1 Calculated value <S12> input (unconstrained)
Bit 1 = 1
Bit 2 = 0

WBPEEUI210504C0 177 - 5
Table 177-3. 16 Bit Binary Number (continued)

Input Select Bit


Mode
Value Pattern
4 or 5 Bit 0 = X Real input value <S10> constrained between
Bit 1 = 0 <S4> and <S5>
Bit 2 = 1
6 Bit 0 = 0 Selected input value <S13> constrained
Bit 1 = 1 between <S4> and <S5>
Bit 2 = 1
7 Bit 0 = 1 Calculated input value <S12> constrained
Bit 1 = 1 between <S4> and <S5>
Bit 2 = 1
≥128 Bit 0 = X No report, no exception reports generated
Bit 1 = X (normal processing at the module level)
Bit 2 = X
Bit 7 = 1

When a transition takes place on bit zero or one, the new input
source and status are selected. The console can also select the
input source. A transition on the input control bit cancels any
pending console request.

Input select and console requests are disabled during module


startup. The block maintains the saved mode and initializes
the input select during startup to prevent a transition being
detected when startup is complete. When adding the block to a
module configuration, the default mode is input select equals
real value, on report, unconstrained (<S9> equals zero).

The constrain input high/low limit (bit two) controls limiting


for the selected input. Specification S4 defines the upper con-
straint limit and S5 defines the lower constraint limit.

The report mode (bit seven) controls the exception reporting


mode. No report disables exception report updates. Enabling
no report causes one exception report to generate which shows
that no report is enabled. The block continues to execute and
its outputs update, but no exception reports generate.

The console can control the exception reporting mode. When a


point is no report, the console can issue a force exception
report update command to cause the point to update. This fea-
ture allows updating of the point value without putting it back
on report. The block outputs (local block outputs N and N+1)

177 - 6 WBPEEUI210504C0
continue to update when a new exception report normally gen-
erates. The current report mode of an input is stored in
NVRAM and is stored upon a reset or mode change. All report
mode change requests (logic and console) are locked out dur-
ing module startup.
S10 Block address of the real input value. The real input value can
be the block output value of any block in the module
addressed by this vector. It is selected when <S9> equals zero,
one, four or five. The console can also select this input value in
auto mode. Changes to the selected mode are disabled when
the block addressed by S14 equals zero.
S11 Block address of the input shaping algorithm. This function
allows additional linearization on the real input value for
unique characterization or scaling. This specification can point
to either a function generator (function code 1) or polynomial
(function code 167) block. Multiple blocks can point to the
same function generator or polynomial block. This permits a
single block to provide common input characterization or scal-
ing data for many DAANG inputs. When either <S9> equals
zero, one, four or five, or a console command selects the real
input, <S10> will be the input value to the function code con-
figured at the block addressed by this specification. The out-
put of the algorithm is the actual real input value. The case of
<S11> equals two disables this feature and causes <S10> to be
used as received.
S12 Block address of the calculated value. The calculated value is
an alternate input value selected when <S9> equals three or
seven. The console can select the calculated input from auto
mode. Changes to the selected mode are disabled when the
block addressed by S14 equals zero.
S13 Engineering units selected inserted value. The selected
inserted value is an alternate input value selected when <S9>
equals two or six. The console can ramp or set this value after
selecting manual mode. Changes to the selected mode are dis-
abled when the block addressed by S14 equals zero.
S14 Block address of the permit input selection. When the input
value of this block is a logic 1, changes at the <S9> input or
the console commands will change the input select mode. If
the input is logic 0, then requests for input select mode
changes are ignored.

WBPEEUI210504C0 177 - 7
S15 Block address of the send exception report request. When
there is a zero to one transition on this block address, an
exception report of the current data and status is generated.
This input can link to a timer that expires on the scan period
for the implementation of a fixed scan type system. When the
point is off scan this input effectively disables. The console can
force an exception report update that reports the current value
even when the point is off scan. The point remains off scan
after sending one update if it was previously off report.
S16 Block address of the activate alarm suppression. Alarm sup-
pression functions specified in S20 enable when this input
equals logic 1. The console also can control alarm suppres-
sion.

High alarms suppressed:

High alarm and level.


High deviation.
High rate.

Low alarms suppressed:

Low alarm and level.


Low deviation.
Low rate.

The current alarm suppression state (on/off) is stored in


NVRAM upon a reset or mode change. All alarm suppression
requests (console and logic) lock during module initialization.
S17 and S18 Block addresses of the variable high one and low one alarms
respectively. These inputs are active only when variable mode
alarms are selected with the alarm control S20. Effectively,
these dynamic values substitute for the high one alarm value
S24 and low one alarm value S26 when using this feature.
S19 Block address of the deviation alarm reference. This specifica-
tion combined with the deviation alarm limit S29 determines
when the monitored input value has a high or low deviation
alarm.

High deviation alarm limit = <S19> + S29


Low deviation alarm limit = <S19> - S29
S20 Alarm control. The input value converts to a truncated integer
and the bit map as in Table 177-4.

177 - 8 WBPEEUI210504C0
Table 177-4. Bit Map

Bit Binary Value Attribute


0 1 High alarm mode:
0 = fixed level alarms; alarms based on H1 = S24
1 = variable level alarms; alarms based on H1 = <S17>
1 2 Low alarm mode:
0 = fixed level alarms; alarms based on L1 = S25
1 = variable level alarms; alarms based on L1 = <S18>
2 4 Multilevel alarming enable:
0 = one high level alarm, one low level alarm
1 = three high level alarms, three low level alarms
3 8 Low alarm suppression select:
0 = do not suppress low level alarms
1 = suppress low level alarms during enabled alarm suppression
(enabled through <S16> or console command 3)
4 16 High alarm suppression select:
0 = do not suppress high level alarms
1 = suppress high level alarms during enabled alarm suppression
(enabled through <S16> or console command 3)
5 32 De-alarm enable
6 64 Return alarm enable
7 128 Rate of change alarm enable
8 256 Digital alarm filter enable
9 512 Alarm suppression indication mode select:
0 = alarm suppression indication in extended status (bit 1)
indicates enabled alarm suppression (through <S16> or a
console command 3) and selected (through S20 bit 3 or 4)
1 = alarms are currently suppressed
10 - 15 – Spare

Bit zero selects the mode for the high one alarm level. Logic 0
selects the fixed value of S24 and logic 1 selects the dynamic
input of the block addressed by S17.

Bit one selects the mode for the low one alarm level. Logic 0
selects the fixed value of S25 and logic 1 selects the dynamic
input of the block addressed by S18.

Bit two selects single level high one and low one alarms when
false (logic 0). Bit two selects multilevel high three, high two,
high one, low one, low two, and low three when true (logic 1).

WBPEEUI210504C0 177 - 9
Bit three and bit four control alarm suppression for all low or
all high alarms based on the logic state of <S16>.

Bits five and six enable the de-alarm and return alarm func-
tions.

The de-alarm and return alarm control the alarms:

• High/low level.
• high/low deviation.
• High/low rate.

De-alarm (bit five) suppresses alarms when the timer expires.


The timer resets any time the input value exits the alarm state.
The alarms must remain present for the entire timer period
(S31) before they can be de-alarmed. The alarms remain sup-
pressed until the input value exits the alarm state. The
de-alarm, when active, is identical to alarm suppression when
both the high and low alarm suppression is selected by S20,
bits three and four and enabled by <S16>.

Return alarm (bit six) causes the console to reinstate the


alarm by changing the state of the return alarm bit in the
extended status output and exception report if an alarm state
is still present since the last alarm report. Until the input
value exits the alarm state, the timer automatically starts after
each return alarm message and a new return alarm issues
after each S31 time period.

If both the de-alarm and return alarm bits are selected, the
return alarm function overrides the de-alarm function. Specifi-
cation S31 defines the time period (in seconds) to de-alarm or
return alarm the input.

Bit seven enables the rate of change alarm feature. Specifica-


tion S31 defines the sample time interval (specified in sec-
onds). The rate of change is the absolute (EU) value of the
difference between the previous sampled input value and the
current sampled input value. The configured time interval
(S31) defines the sampling time between the two values. The
previous input value initializes during startup to the current
selected input value. Refer to S32 and S33 for details.

Bit eight enables the digital alarm count filter. The time period
in S31 (specified in seconds) defines the sequential count time
interval. The value in S34 defines the number of transitions
that activate the alarm count filter. Refer to S34 for details.

177 - 10 WBPEEUI210504C0
Bit nine allows mode configuration of the alarm suppression
indication at the extended status output (N+1, bit one). When
this bit is logic 0, the alarm suppression indication sets when
alarm suppression is selected (through S20, bits three and
four) and enabled (through <S16>). When this bit equals
logic 1, the alarm suppression indication is set when an alarm
is suppressed.
S21 High alarm deadband. This is the deadband compensation
value, in engineering units, that subtracts from each high
alarm threshold value to determine the value at which the
existing alarm level will be reduced.
S22 High three alarm difference. With multilevel alarming selected,
this value adds to S23. The result adds to the value used for
high one level to determine the high three alarm threshold
value. If the monitored variable becomes greater than this
value, a high three alarm state exists.
S23 High two alarm difference. With multilevel alarming selected,
this value adds to the value used for high one level to deter-
mine the high two alarm threshold value. If the monitored
variable becomes greater than this value, a high two alarm
state exists.
S24 High one fixed alarm value. When fixed alarm levels are
selected, and the monitored input value becomes greater than
this value, a high one alarm status exists.
S25 Low one fixed alarm value. When fixed alarm levels are
selected, and the monitored input value becomes less than
this value, a low one alarm status exists.
S26 Low two alarm difference. With multilevel alarming selected,
this value subtracts from the value used for low one alarm
level to determine the low two alarm threshold value. If the
monitored variable becomes less than this value, a low two
alarm state exists.
S27 Low three alarm difference. With multilevel alarming selected,
this value adds to the value of S26. The resultant total sub-
tracts from the value used for the low one alarm level to deter-
mine the low three alarm threshold value. If the monitored
variable becomes less than this value, a low three alarm state
exists.

WBPEEUI210504C0 177 - 11
S28 Low alarm deadband. This is the deadband compensation
value that adds to each low alarm threshold value to deter-
mine the value at which the existing alarm level will be
reduced. Table 177-5 shows alarm thresholds.

Table 177-5. Alarm Thresholds

Alarm Level Thresholds Level Return from Alarm Thresholds


High 1 (F or V) +S23 + HIGH 3 High 1 (F or V) +S23 +S22 –
S22 S21
High 1 (F or V) +S23 HIGH High 1 (F or V) +S23 – S21
High 1 (F or V) HIGH 1 High 1 (F or V) – S21
Low 1 (F or V) LOW 1 Low 1 (F or V) +S28
Low 1 (F or V) – S26 LOW 2 Low 1 (F or V) – S26 +S28
Low 1 (F or V) – S26 – S27 LOW 3 Low 1 (F or V) – S26 – S27 +S28

Figure 177-1 shows relationships of S21, S22, S23, S26, S27


and S28 to actual alarm thresholds when using <S17> and
<S18>.

The striped line in Figure 177-1 illustrates the monitored vari-


able. The arrowhead shows the relative movement of this
dynamic variable away from the quiescent (left side) and in the
direction of nominal (right side).

High Alarm Values:

<S17> (variable high alarm value) = 600


S24 (fixed high alarm value) = 600
S23 (high 2 alarm delta) = 100
S22 (high 3 alarm delta) = 50
S21 (high alarm deadband) = 5

Low Alarm Values:

<S18> (variable low alarm value) = 400


S25 (fixed low alarm value) = 400
S26 (low 2 alarm delta) = 100
S27 (low 3 alarm delta) = 50
S28 (low alarm deadband) = 10
S29 Deviation alarm limit. The high deviation alarm is violated
when the selected input <S10>, <S11> or <S12> as selected by
<S9> is greater than or equal to the sum of the deviation alarm
reference <S19> and the deviation alarm limit S29.

177 - 12 WBPEEUI210504C0
The low deviation alarm is violated when the selected input
<S10>, <S11> or <S12> as selected by <S9> is less than or
equal to the difference between the deviation alarm reference
<S19> and the deviation alarm limit S29.

(1 0 0 0 ) P.V. P.V.
H IG H D IS P L AY R EF.
S1 1000

(9 5 0 ) 950
H IG H C O N S TR A IN T
S4

S 2 1 = 5 (H IG H D EA D B A N D )

(6 0 0 + 10 0 + 5 0 ) 750 745 (6 0 0 + 10 0 + 5 0 – 5 )
H IG H 3
S 24 + S 23 + S22 S 24 + S 23 + S22 – S 21

(6 0 0 + 10 0 ) 700 (6 0 0 + 10 0 – 5 )
H IG H 2 695
S 24 + S23 S 24 + S 23 – S 21

(6 0 0 ) 600 (6 0 0 – 5 )
H IG H 1 595
FIX E D S2 4 S 24 – S21
[VAR IA B L E] S 1 7

S2 500 500

410 (4 0 0 + 10 )
(4 0 0 ) 400
LOW 1 S 25 + S 28
FIX E D S2 5
[VAR IA B L E] S 1 8

310 (4 0 0 – 1 0 0 + 1 0 )
(4 0 0 – 1 0 0 ) 300
LOW 2 S 25 + S 26 +S 28
S 25 + S26
260 (4 0 0 – 1 0 0 – 5 0 + 1 0 )
(4 0 0 – 1 0 0 – 5 0 ) 250
LOW 3 S 25 + S 26 +S 27 + S28
S 2 5 – S 2 6 – S2 7

S 2 8 = 1 0 (L O W D E A D BA N D )

(5 0 ) 50
L O W C O N ST R AIN T
S5

S3 0 .0
L O W D IS P LAY R E F.
T 01 8 71 A

Figure 177-1. Level Detection Alarms

Deviation Alarm Levels:

High deviation = <S19> +S29


Low deviation = <S19> – S29

WBPEEUI210504C0 177 - 13
Deviation Deadband Levels:

High deviation deadband = <S19> +S29 – S21


Low deviation deadband = <S19> – S29 +S28
S30 Significant change in engineering units input. A new exception
report generates when the selected input change is greater
than the level defined by this input, and the exception report
minimum time has been exceeded (as defined by the segment
control block).
S31 Period for time based alarms. This time period is in seconds.
Refer to S20.
S32 and S33 Define the rate of change in engineering units. Specification
S20 enables this function. Specification S31 determines the
time period to sample input. The rate of change is the absolute
value of the difference between the previous sampled input
value and the current sampled input value. The configured
time interval defines the sampling time between the two val-
ues. The previous input value initializes during startup to the
current selected input value.

A high rate of change is present when the absolute value of the


difference between the new sample value and the previous
sample value is greater than the high rate of change S32.

A low rate of change is present when the absolute value of the


difference between the new sample value and the previous
sample value is less than the low rate of change S33.
S34 Alarm count limit for the time sequence alarm filter. Specifica-
tion S20 enables this alarm function. The time period defined
by S31 is the time interval. This feature, when enabled by S20,
maintains an alarm level if the monitored variable is moving
into and out of that alarm level X times (defined by S34) during
period Y (defined by S31).

Each crossing of an individual alarm level increments an inter-


nal counter in the function code. This counter resets to zero at
the end of the time specified in S31. When the counter value is
equal to or greater than the value of S34, the existing alarm
level maintains through the next count period. This filtered
alarm level maintains as long as the internal sequential count
per time period (S31) equals or exceeds (S34), or the monitor
variable is in violation of the posted alarm threshold.

177 - 14 WBPEEUI210504C0
The filtered alarm level cancels if any other alarm level is vio-
lated or if a time period (S31) occurs without (S34) alarm level
crossings.

NOTE: Normal deadband action is included in the determination of return from


each alarm level violation used by the time sequence alarm filter.

The hold state automatically cancels when the next alarm level
is violated or exited. The internal alarm state is used before
performing alarm suppression. Thus, alarm suppression does
not affect the processing of the sequential alarm count limit.

Outputs
N Current value and status. The current value and status output
provides the current output value and the status bits. Table
177-6 shows the status bits for output N.

Table 177-6. Output N Bit Map

Bit Attribute
7 Quality: 1 = bad 0 = good
6 High alarm: 1 = yes 0 = no
5 Low alarm : 1 = yes 0 = no
4-3 Alarm level: 00 = normal 10 = unused
01 = level 2 11 = level 3
2-0 Reserved for future use

Refer to Figure 177-2 for an example of the module access to


status. The test quality block (function code 31) can retrieve
the quality status bit. The quality state is bad when the
hardware failure status is bad. The test alarm block (function
code 69) can retrieve the alarm status (bits three through six).
Set S2 (function code 69) to zero to test the high and low
alarms. Set S2 (function code 69) to one to test the alarm level.
N+1 Current extended status. Figure 177-2 shows an example of
the module access to status. The extended status output con-
verts to a real output as an integer. Table 177-7 shows the bit
map for output N+1.

WBPEEUI210504C0 177 - 15
Applications
Figure 177-3 illustrates a typical application using the data
acquisition analog block. In this application, the value of the
S20 block is 24 decimal (18 hex).

S1
S2 (31) G O O D /B A D
S3 T ST Q
N Q UA LITY
S4

T STALM
(69)
H H IG H A LA R M
N
DAA N G L LO W A LAR M
N+1
S7 (177 )
N /A RV
S8 N
Q UA L ST
S9 N+1 T STALM
IN -S E L (69)
S 10 H LE VE L 2 AL A R M
RV N
S 11 L LE VE L 3 AL A R M
CHAR N+1
S 12 CV
S 14 IN -P M T
S 15
RDEMUX
X -R P T S1 (126)
S 16 1 TIM E IN ALA R M TO G G LE
A LM -S U P N
S 17 2 A L AR M S SU PP R E SS E D
VHA N+1
S 18 3 VAR IA B L E A LA R M S AC TIV E
V LA N+2
S 19 4 LO W R ATE ALA R M
DEV N+3
5 H IG H R ATE A L AR M
N+4
6 LO W D E V IATIO N A LA R M
N+5
7 H IG H D EV IATIO N A LAR M
N+6
8 N O R EP O R T
N+7

RDEMUX
S1 (1 26)
1 Q UA LITY OV ER R ID E
N
2 C A LC U LAT ED VALU E
N+1
3 AU TO (1) M AN UA L (0)
N+2
4 C O N ST R AIN E D
N+3
5 OU T OF RANG E
N+4
6 H A R DW A R E FA ILU R E
N+5
7 E -S TO P
N+6
8 R E SE RV ED (ALW AY S = 1)
N+7
T 01 87 2 A

Figure 177-2. Module Access to Status

Table 177-7. Output N+1 Bit Map

Bit Binary Value Attribute


0 1 Return alarm (bit toggles)
1 2 Alarm suppression (refer to S20, bit 9)
2 4 Variable alarm
3 8 Low rate alarm

177 - 16 WBPEEUI210504C0
Table 177-7. Output N+1 Bit Map (continued)

Bit Binary Value Attribute


4 16 High rate alarm
5 32 Low deviation alarm
6 64 High deviation alarm
7 128 No report
8 256 Quality overridden
9 512 Calculated. Modes:
Auto/real - real input selected <S10>
Auto/calculated - calculated input <S12>
Manual - custom specified value <S13>
10 1024 Auto/manual: 1 = auto, 0 = manual. Modes:
Auto/real - real input selected <S10>
Auto/calculated - calculated input <S12>
Manual - custom specified value <S13>
11 2048 Constrained
12 4096 Out of range
13 8192 Hardware failure
14 16384 E-STOP
15 32768 Reserved (always = 1)
16 - 23 – Reserved for future use

S1
S2 DAA N G
(3 1 ) S1
S3 T ST Q S7 (1 7 7 )
N S2 N /A RV
S4 (6 5 ) S8 N
S3 DSUM Q UA L ST
N S9 N+1
S4 IN -S E L
S10 RV
H //L S 5 = 32 S11
S1 (1 2 ) S 6 = 16 CHAR
H S12
N CV
L S14
N+1 1 IN -P M T
1 S15
H IG H = 5 0 0 °C X -R P T
S16
AI/B A LM -S U P
(2 5 ) S17
R E AC TO R O U TLE T TE M PE R ATU R E (FR O M A M M ) VHA
N S18
V LA
S19
DEV
S1 (1 6 7 )
1.0 6
PO LY
N

R E AC TO R S H U T D OW N
T 01 8 74 A

Figure 177-3. Data Acquisition Analog Example

WBPEEUI210504C0 177 - 17
This configuration:

• Monitors the reactor outlet temperature from the analog


master module. If this temperature is greater than 500
degrees Celsius it is suspect/out of range.

• Allows operator (console) selection of the polynomial char-


acterization.

• Suppresses all alarms when the reactor is in shutdown


mode.

Figure 177-4 shows the data acquisition analog block used in


normal, variable and deviation alarm situations.

177 - 18 WBPEEUI210504C0
N O R M A L AL AR M IN G
(S IN G LE OR M U LT ILE V EL )
DAA N G
S7 (1 7 7 )
N /A RV
S8 N
Q UA L ST
S9 N+1
IN -S E L
VAR IA B L E TO BE R E PO RT E D S 10
RV
S 11
CHAR
S 12
CV
S 14
IN -P M T
S 15
X -R P T
S 16
A LM -S U P
S 17
VHA
S 18
V LA
S 19
DEV

VA R IAB LE A LAR M IN G
DAA N G
S7 (1 7 7 )
N /A RV
S8 N
Q UA L ST
S9 N+1
IN -S E L
VAR IA B L E TO BE R E PO RT E D S 10
RV
S 11
CHAR
S 12
CV
S 14
IN -P M T
S 15
X -R P T
S 16 A LM -S U P
VAR IA B L E H IG H L EV E L A L A R M VA LU E S 17
VHA
VAR IA B L E L O W L E V EL A L AR M VAL U E S 18 V LA
S 19 DEV

D E VIAT IO N ALA R M
DAA N G
S7 (1 7 7 )
N /A RV
S8 N
Q UA L ST
S9 N+1
IN -S E L
VAR IA B L E TO BE R E PO RT E D S 10 RV
S 11 CHAR
S 12 CV
S 14 IN -P M T
S 15 X -R P T
S 16 A LM -S U P
S 17 VHA
S 18 V LA
D E V A L A R M R E F VAL U E S 19 DEV

T 01 87 3 A

Figure 177-4. Normal, Variable and Deviation Alarms

WBPEEUI210504C0 177 - 19
WBPEEUI210504C0
Data Acquisition
Analog Input/Loop Function Code 178

DAA N G I/L The data acquisition analog input/loop function code provides
(178)
a way to import data from the data acquisition analog block
N
NHL
N+1
(function code 177) on Symphony systems.
NLL
N+2
EST NOTE: If a module utilizes an imported analog value from the loop in several
N+3
instances in its configuration, the function blocks that utilize that analog value
must be connected to only one DAANG I/L block. You cannot import exception
reports from the same (control network, node, module and block) address to
more than one destination within a single module configuration.

Outputs

Blk Type Description


N R Current value, quality/status
N+1 R Next highest limit
N+2 R Next lowest limit
N+3 R Extended status

Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 31 Source module address
S2 N 0 I Note 1 Source block number
S3 N 0 I 1 - 250 Source node address
S4 N 0 I 1 - 250 Source loop number
S5 N 0 I Full Spare integer input
S6 N 0.000 R Full Spare real input
S7 N 0 I 0 or 1 Spare boolean input
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

Explanation
Specifications
S1 Source module address. This is the module bus address of the
module containing the monitored DAANG block.

WBPEEUI210504C0 178 - 1
S2 Source block number. This is the block number of the moni-
tored DAANG block.
S3 Source HCU address. This is the HCU address where the mod-
ule containing the monitored DAANG block resides.
S4 Source loop number. This is the loop number where the HCU
containing the monitored DAANG block resides.
S5 through S7 Spare inputs.

Outputs
N Current value and quality/status: the current value, quality
and status of the monitored DAANG block addressed by S1,
S2, S3 and S4. Table 178-1 shows the status bits at this block
address.

Table 178-1. Status Bits at Current Block Address

Bit Attribute
7 Quality: 1 = bad 0 = good
6 High alarm: 1 = yes 0 = no
5 Low alarm: 1 = yes 0 = no
4-3 Alarm level: 00 = normal 10 = level 2
01 = unused 11 = level 3
2-0 Reserved for future use

The test quality block (function code 31) can retrieve the qual-
ity status bit. The quality bit is bad when the communication
status or the hardware failure status is bad.

The test alarm block (function code 69) can retrieve the alarm
status bits. Setting S2 (function code 69) to zero tests the high
and low alarms. Setting S2 (function code 69) to one tests the
alarm level.
N+1 Next highest limit. This value is the next highest value limit
that results in alarm activity by the DAANG block (function
code 177) being monitored.
N+2 Next lowest limit. This output value is the next lowest value
limit that will result in alarm activity by the DAANG block
(function code 177) being monitored.

178 - 2 WBPEEUI210504C0
N+3 Extended status. The extended status converts into a real out-
put as an integer with the bit map shown in Table 178-2.

Table 178-2. Extended Status Bit Map

Binary
Bit Attribute
Weighted Value
0 1 Return alarm (toggled bit)
1 2 Alarms suppressed
2 4 Variable alarms
3 8 Low rate alarm
4 16 High rate alarm
5 32 Low deviation alarm
6 64 High deviation alarm
7 128 No report
8 256 Quality overridden
9 512 Calculated mode:
Auto/real - real input selected <S10>
Auto/calculated - calculated input <S12>
Manual - custom specified value <S13>
10 1024 Auto/manual:
0 = manual
1 = auto
11 2048 Constrained
12 4096 Out of range
13 8192 Hardware failure
14 16384 E-STOP
15 32768 Exception report received
16 - 23 — Reserved

The exception report received (bit 15) initializes to zero on


entry to execute mode and sets upon the first exception report.
The bit remains set until the module is reset or a mode change
occurs. Refer to Figure 178-1 for an example of the module
access to status.

WBPEEUI210504C0 178 - 3
S1
S2
(3 1) G O O D /B A D
S3 T ST Q Q UA L ITY
N
S4

T S TALM
(6 9)
DAA N G I/L H H IG H A L A R M
(1 78 ) N
L L O W A L AR M
N N+1
NHL
N+1
NLL
N+2 T S TALM
EST
N+3 (6 9)
H L E VE L 2 AL A R M
N
L L E VE L 3 AL A R M
N+1

RDEMUX
S1 (1 26 )
1 TIM E IN ALA R M TO G G L E
N
2 A L AR M S S U PP R E SS E D
N+1
3 VAR IA B L E A L A R M S AC TIV E
N+2
4 L O W R ATE A LA R M
N+3
5 H IG H R AT E A L AR M
N+4
6 L O W D E V IAT IO N A L AR M
N+5
7 H IG H D EV IATIO N A L A R M
N+6
8 N O R EP O R T
N+7

RDEMUX
S1 (1 26 )
1 Q UA L ITY OV ER R ID E
N
2 C A L C U L AT ED VA LU E
N+1
3 AU TO (1)/M AN UA L (0 )
N+2
4 C O N ST R AIN E D
N+3
5 O U T O F R AN G E
N+4
6 H A R DW A R E FA ILU R E
N+5
7 E -S TO P
N+6
8 R E SE RV ED (ALW AY S = 1)
N+7
T 01 8 75 A

Figure 178-1. Module Access to Status

Applications
Assume that the monitored DAANG function code is (also
shown in Table 178-3):

High constraint limit = 900


High 3 alarm limit = 800
High 2 alarm limit = 700
High 1 alarm limit = 600
Nominal = 500
Low 1 alarm limit = 400
Low 2 alarm limit = 300

178 - 4 WBPEEUI210504C0
Low 3 alarm limit = 200
Low constraint limit = 100

NOTE: Constraints active, multilevel alarming and auto mode.

Table 178-3. Example DAANG Settings

Monitored Referenced DAANG I/L Outputs


Real Value DAANGs Output N
Input of Reported N N+1 N+2 N+3 Quality
DAANG Value
950 900 900 900 900 35,840 High 3 alarm
850 850 850 900 800 33,792 High 3 alarm
750 750 750 800 700 33,792 High 2 alarm
650 650 650 700 600 33,792 High 1 alarm
500 500 500 600 400 33,792 Good
350 350 350 400 300 33,792 Low 1 alarm
250 250 250 300 200 33,792 Low 2 alarm
150 150 150 200 100 33,792 Low 3 alarm
50 100 100 100 100 35,840 Low 3 alarm
NOTES:
1. Output N+3 = 33,792 (32,768 +1024). Exception report received since module startup and DAANG is monitoring the real
input.
2. Output N+3 = 35,840 (32,768 +2048 +1024). Exception report received since module startup, constrained input, and
DAANG is monitoring the real input.

WBPEEUI210504C0 178 - 5
WBPEEUI210504C0
Enhanced Trend
Function Code 179

ET R E N D The enhanced trend definition function code is part of the


(1 7 9 )
S1 Symphony distributed trending package. This function code
S15 N
RESET
N+1 collects, compresses and stores trend data. A compression
algorithm increases the amount of historical data retained by
the block for a given amount of module memory utilization.
Trend data may be collected from various exception reporting
blocks, identified by S2.

Collected data can be retrieved from the block on demand by


any number of collection devices for archiving and display. The
enhanced trend block issues special trend exception reports
and notifies collection devices when a significant amount of
new trend data is recorded in the trend buffer.

The amount of historical data retained by the block varies


depending on:

• The size of the block trend buffer.


• The rate of change of the input value.
• The types of data to be collected.

Function code 179 gives the following enhancements over the


analog trend function code 66:

• Ability to trend more types of inputs.


• Record status and alarm information with values.
• Faster data collection rates available.
• More significant digits on stored values.
• Uses data compression algorithm to reduce storage needs.
• Finer resolution on time associated with recorded values.

Outputs

Blk Type Description


N B Value is always 0. Quality is bad when the Harmony con-
troller has not been time synchronized.
N+1 R Approximate number of minutes of historical data currently
saved in the block's buffer.

WBPEEUI210504C0 179 - 1
Specifications

Spec Tune Default Type Range Description


S1 N 0 I Note 1 Block address of input
S2 N 0 I 0-9 Input block type:
0 = function code 30 8 = function code 177
1 = function code 45 9 = function code 211
2 = function code 62 10 = function code 222
3 = function code 68 11 = function code 223
4 = function code 80 12 = function code 224
5 = function code 123 13 = function code 225
6 = function code 129 14 = function code 229
7 = function code 136
S3 N 1 I 1 - 63 Trending mode:
1 = sampling 8 = average
2 = minimum 16 = sum
4 = maximum 32 = range (max.-min.)
S4 N 50 I 20 - 65535 Buffer size (no. of events)
S5 N 40.000 R 0 - 100 Buffer threshold (%)
S6 Y 15.000 R Full Input sampling time (secs)
S7 Y 1.000 R 0 - 100 Significant change (%)
S8 N 1200.000 R Full Maximum elapsed time for event recording (secs)
S9 Y 1.000 R Full Statistical time base period
S10 N 2 I 0-3 Statistical time base units:
0 = seconds 2 = hours
1 = minutes 3 = days
S11 N 7200.000 R Full Maximum elapsed time for exception reporting
(secs)
S12 Y 100.000 R 0 - 100 GOOD/SUSPECT threshold
S13 Y 1.000 R Full Summation conversion divisor
S14 N 1 I Full Summation modifier
S15 N 0 I Note 1 Block address of statistical time base reset signal
S16 N 0 I Full Spare parameter
S17 N 0 I Full Spare parameter
S18 N 0 I Full Spare parameter
S19 N 0.000 R Full Spare parameter
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

179 - 2 WBPEEUI210504C0
Explanation
Specifications
S1 (Block address of input) Block address of exception report
block to be the source of trend data.

NOTES:
1. When addressing a multiple output block, use the lowest block number
(N).

2. Selecting a value of zero disables all sampling and statistical trending for
the function code 179 block.
S2 (Input block type) Identifies type of input to be trended.

0 = function code 30, analog exception report


1 = function code 45, digital exception report
2 = function code 62, remote control memory
3 = function code 68, remote manual set constant
4 = function code 80, control station
5 = function code 123, device driver
6 = function code 129, multi state device driver
7 = function code 136, remote motor control
8 = function code 177, data acquisition analog
9 = function code 211, data acquisition digital
10=function code 222, analog in/channel
11=function code 223, analog out/channel
12=function code 224, digital in/channel
13=function code 225, digital out/channel
14=function code 229, pulse in/channel

NOTE: The block addressed in <S1> must match the input block type in S2 or
a configuration error will result.
S3 (T rending mode) Selects any combination of available trend-
ing point types. None are exclusive; any or all may be selected
simultaneously.

Specification S6 selects sample collection speed, while S9 and


S10 select the statistical time base period.

1 = Sampling - current value.

2 = Minimum - minimum value collected over the statisti-


cal time period (S9 and S10).

WBPEEUI210504C0 179 - 3
4 = Maximum - maximum value collected over the statisti-
cal time period (S9 and S10).

8 = Average - (arithmetic mean) - average value collected


over the statistical time period (S9 and S10).

16 = Sum - total values collected over the statistical time


period (S9 and S10).

32 = Range - value of maximum minus minimum samples


collected over the trending interval (statistical).
Example: The exception report selected is to be trended in the Sampling (one) and
Range (32) modes.
1 +32 = 33
S3 = 33
S3 = sum of desired modes

NOTES:
1. When any statistical mode is selected, the statistical calculations are not
cumulative from one statistical time period to the next.

2. When sampling mode is selected, status and alarm information is


recorded, as well as a value for each input block type.

The types of trend data available for display or analysis


depends on the capabilities of the device used to collect, dis-
play, or analyze the data recorded by the enhanced trend
block. Consult the user's manual for the specific device used
for a description of the data available and the procedures for
configuring that device.

When trending a digital signal using average, trend value rep-


resents percent of time ON or OFF (duty cycle) (zero to 100
percent).
S4 (Buffer size) Specifies the minimum number of events that
may be recorded by setting an amount of module memory
aside for the trend data buffer.

Increasing the trend buffer size will:

• Increase the amount of historical data saved by the block.


• Decrease polling frequency from the collecting devices.
• Increase the module's RAM utilization.

An event is one of the following:

179 - 4 WBPEEUI210504C0
• Significant change in sample or periodic statistical value.
(Refer to the explanation for specification S7).

• Status or quality change.

• Change in a tunable parameter of function code 179.

The maximum allowable value for S4 depends on the setting of


S2.

Function Maximum Value


S2 Setting Type of Value
Code of S4 Permitted
0 30 Analog 5461
1 45 Digital 6553
2 62 RCM 6553
3 68 REMSET 5461
4 80 Station 2621
5 123 DDRIVE 6553
6 129 MSDVDR 6553
7 136 RMC 6553
8 17 DAANG 2621
9 211 DADIG 6553
10 222 IOC/AIN 5461
11 223 IOC/AOUT 5461
12 224 IOC/DIN 6553
13 225 IOC/DOUT 6553
14 229 IOC/PIN 5461

S5 (Buffer fill threshold) The percent of buffer space filled with


new events before informing collecting devices of a significant
amount of new available trend data.

NOTE: The effect of this parameter is highly dependent upon system dynamics
and should not be changed without careful analysis. Decreasing the threshold
causes the collection devices to retrieve data more frequently, resulting in an
increased load on the system. Increasing the threshold causes the collection
devices to retrieve data less frequently and could result in lost data. It is recom-
mended that S5 be left at the default 40% value to guarantee enough collection
time to account for process upsets. In any case, S5 should not be set greater
than 80%.

WBPEEUI210504C0 179 - 5
S6 (Input sampling time, in seconds; only used if sampling is
selected in S3) The period of monitoring the value and status
of the sampling input.

NOTE: Selecting a value of zero disables the sampling mode.


S7 (Significant change; in percent of span) Determines if the
result of the statistical computations of the current period
deviate by a specific percentage from the result of the previous
period. The block projects an expected value by observing the
trend of previous values. When the actual input value differs
from this expected value by more than the specified amount, a
new value is recorded. The enhanced trend block uses this
value along with the span values defined in the exception
reporting block that is referenced by S1 to calculate its abso-
lute significant span values. The significant change values
defined in these exception reporting blocks do not affect the
enhanced trend compression algorithm.

Specification S7 also affects the compression algorithm for


storage of statistical computations (minimum, maximum,
sum, range, and average). However, S7 does not affect calcula-
tion of statistical values.
S8 (Maximum recording time) Maximum interval between consec-
utive recorded values in the trend buffer for one point. The
maximum recording time specification insures that both sam-
ple and statistical trend values will be recorded if none have
been recorded for this specific amount of time. Statistical val-
ues will not compress if this time is less than the statistical
period (S9 and S10). They will be stored after the end of each
statistical period. Likewise, if this time is less than the input
sampling time (S6), the input sampling compression algorithm
will be effectively disabled. This forces input samples to be
recorded at the end of every input sample period. This is useful
in applications that require data that is recorded at fixed time
intervals.
S9 (Statistical time base period; only used if S3>1) Determines
the period of the statistical computation when the trending
mode in S3 is set for one of the statistical functions. The sta-
tistical time base units are set by S10. For example: If S9

179 - 6 WBPEEUI210504C0
equals five and S10 equals one, then the period of the statisti-
cal function set by S3 is five minutes.

NOTE: Use the smallest number possible (i.e., S9 = 1 and S10 = 2 for one hour
rather than S9 = 3,600 and S10 = 0 which equals one hour in seconds).

When the period set by S9 and S10 equals one hour (S9 equals
one, S10 equals two) or one day (S9 equals one, S10 equals
three), the statistical computation period synchronizes to real
time. The statistical function is calculated on the hour or on a
daily (at midnight) basis. All other statistical periods are
elapsed time and are not synchronized to real time.

A reset on S15 disables real time synchronization. When a


reset on S15 occurs, real time synchronization is disabled and
the statistical period begins on an hourly or daily basis from
the time of the reset. To enable real time synchronization, tune
S9 to another value then return it to a value of one (i.e., tune
S9 to three, then tune S9 to one). If S9 equals zero, the statis-
tical mode trending function is disabled.
S10 (Statistical time base units) Shows the time unit associated
with S9.

0 = seconds
1 = minutes
2 = hours
3 = days
S11 (Maximum reporting time; in seconds) Maximum interval
between trend exception reports. Gives an exception report if
no other criteria has prompted one. This notifies collection
devices to collect trend data.
S12 (Good/suspect threshold) Minimum percentage of input val-
ues during a statistical period that must be good quality to
receive a GOOD summary value. If at least one good value is
observed, but the percentage of good values is less than this
parameter value, the quality of the summary will be SUSPECT.
If no GOOD values are observed, the summary value will be
BAD.
S13 (Summation conversion divisor; used only if summation is
selected in S3) Value used to compute the sum over the period
set by S9 and S10. Summation conversion divisor is a divisor
into the accumulated sum and may be used to adjust for dif-
ferences in the units of a value. Summation computation is

WBPEEUI210504C0 179 - 7
calculated by adding the current sampled input value to the
total every segment cycle time.
Example: Target segment cycle time equals 0.25 second:

1 value collected every 0.25 second =


4 values added to sum every 1 second =
240 values added to sum every 1 minute

If the source point value is in units of gallons per minute, a


conversion divisor of 240 would adjust the sum to have units
of gallons.

NOTES:
1. If a value of zero is selected for the summation conversion divisor, a value
of 1.0 will be used instead.

2. The target segment cycle time is set in the executive block, function code
82. A value of zero entered for the target segment cycle time disables the sum-
mation statistic.

For digital inputs, the sum might show the number of segment
cycle times during which the input was a one. In such a case,
the conversion factor might be used to convert the sum to
units of run time.
S14 (Summation modifier; only used if sum is selected in S3, and
S2 = 1, 2, 5, 6, or 7) Specifies the type of summation function
for digital inputs.

0 = count number of samples when input was zero


1 = count number of samples when input was one
2 = count changes from zero to one
3 = count changes from one to zero
4 = count all state changes
S15 (Block address of statistical time base reset signal) Resets
the periodic function timer based on S9 and S10 when the ref-
erenced block shows a transition of 0 to 1. The current
statistical period immediately ends and a new one starts. This
allows configuration control over periodic trend functions.
Example: Hourly statistics for a trended point are typically configured to be synchro-
nized to real-time (refer to S9), but may be synchronized to process events
(such as an operation startup) by using this input.

S16 through S18 Spare integer.


S19 Spare real.

179 - 8 WBPEEUI210504C0
Applications
To trend analog values, the user configures the analog excep-
tion reports and enhanced trend blocks for each point trended.
Figure 179-1 illustrates a configuration of a sampling (once a
minute) and average (once an hour) trend of an analog point
with manual reset. The significant change allowance (S7) is set
to a higher value than default. This will decrease the amount
of recorded values. The human system interface (HSI) may
then be configured to collect data from the enhanced trend
block for display or archiving via special enhanced trend data
poll messages and replies.

ET R E N D
S1 (3 0 ) S1 (1 7 9 )
AO/L
200 S 15 300
RESET
301
S1 = 200 S 1 0 = D E FAU LT
M AN UAL
S2 = 0 S 1 1 = D E FAU LT
R E SE T
S3 = 9 S 1 2 = D E FAU LT
S4 = D E FAU LT S 1 3 = D E FAU LT
S5 (6 8 ) S5 = D E FAU LT S 1 4 = D E FAU LT
S6 R EM SE T 250 S6 = 60 S 15 = 250
S7 = 2 .0 S 1 6 = D E FAU LT
S8 = D E FAU LT S 1 7 = D E FAU LT
S9 = D E FAU LT S 1 8 = D E FAU LT
S 1 9 = D E FAU LT
T 01 87 6 A

Figure 179-1. Sample and Average Analog Trend with Reset

Figure 179-2 represents a sampling and average (hourly) and


sum trend of a device driver. The sum trend is configured to
count changes from zero to one. The enhanced trend block
gathers all data from the device driver including state of con-
trol output, all feedback inputs, and other status indicators
such as feedback status and status override.

D D R IV E ET R E N D
S1 (1 2 3) S1 (17 9 )
CI O
S2 N S 15 3 00
FB1 ST RESET
S3 N+1 S01
FB2
S5 S1 = 200 S 10 = D E FAU LT
OP S2 = 5 S 11 = D E FAU LT
S6
OS S3 = 25 S 12 = D E FAU LT
S4 = D E FAU LT S 13 = D E FAU LT
S5 = D E FAU LT S 14 =2
S6 = D E FAU LT S 15 = D E FAU LT
S7 = D E FAU LT S 16 = D E FAU LT
S8 = D E FAU LT S 17 = D E FAU LT
S9 = D E FAU LT S 18 = D E FAU LT
S 19 = D E FAU LT
T 01 8 77 A

Figure 179-2. Sampling and Average and Sum Digital Trend

WBPEEUI210504C0 179 - 9
The average will give the duty cycle of the device (percent of the
period during which the device was ON) and the sum will show
the number of times the device turned ON during the period
(cycled from OFF to ON).

When the enhanced trend is used for sampling, minimum and


maximum trending of a control station (function code 80), any
or all points associated with the control station may be dis-
played. These points include process variable (PV), set point
(SP), control output (CO), ratio index value (RI), and all station
status indicators such as auto/manual, bypass, etc.

Figure 179-3 is a sample (every five seconds) trend of a control


station with a reset from the start of a batch process. An
increased buffer size (S4) allows for retention of more data.

M /A
M F C /P ETR E N D
S1 (80 ) S1 (1 79 )
PV SP
S2 201 S 15 3 00
SP O RESET
S3 200 3 01
A A
S4 202 S1 = 20 0 S10 = D E FAU LT
TR C /R S2 = 4 S11 = D E FAU LT
S5 203
TS C S3 = 7 S12 = D E FAU LT
S18 204 S4 = 15 0 S13 = D E FAU LT
MI C -F
S19 205 S5 = D E FAU LT S14 = D E FAU LT
AX S6 = 5 S15 = 25 0
S20
C /R S7 = D E FAU LT S16 = D E FAU LT
S21 S8 = D E FAU LT S17 = D E FAU LT
LX
S22 S9 = D E FAU LT S18 = D E FAU LT
CX
S24 S19 = D E FAU LT
HAA
S25
L AA
S26
H DA
S27
L DA
S28
AO
S29
TRS2
S30 T
TRPV

S TA RT O F
B AT C H PR O C E S S
2 50 T 01 87 8 A

Figure 179-3. Minimum and Maximum of Control Station

179 - 10 WBPEEUI210504C0
Factory Instrumentation
Protocol Handler Function Code 184

F IP The factory instrumentation protocol (FIP) handler function


SH code provides an interface between a primary and a redundant
S3 (1 8 4 )
S4
A I# P ST
N FIP module. Function code 184 is used with the IMFBM02
D I# S ST
S5 AO #
N+1 WorldFIP Server Module. The FIP handler function code man-
S6 DO# ages the redundant operation by determining that a valid fail-
S7
S8
BA ure has occurred before switching to the secondary module.
TD
The input specifications contain the starting block address for
all configured subscriber blocks. The status of both the pri-
mary and secondary FIP modules are outputs from the block.

NOTES:
1. For more information on factory instrumentation protocol, refer to the FIP
Application Description C46-602 which is written by the French Commission
AFNOR, and the INFBA01 Programming Reference Manual.

2. If configuring function code 184 for an Ethernet device interface slave


(IMEDI01), refer to the IMEDI01 instruction for details and explanations of this
function code.

Outputs

Blk Type Description


N B Primary module status: 0 = good
1 = bad
N+1 B Secondary module status: 0 = good
1 = bad

Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 63 Primary module address
S2 N 0 I 0 - 63 Secondary module address
S3 N 2 I Note 1 Block address of analog input subscriber block
S4 N 2 I Note 1 Block address of digital input subscriber block
S5 N 2 I Note 1 Block address of analog output subscriber block
S6 N 2 I Note 1 Block address of digital output subscriber block
S7 N 2 I Note 1 Reserved
S8 N 0 I Note 1 Reserved

WBPEEUI210504C0 184 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S9 N 0 I 0-1 Continue on secondary module error:
0 = trip primary module
1 = continue to operate
S10 N 0 I 0 - 60000 Synchronization ID2
S11 N 0 I 0 - 60000 Reserved
S12 N 0 I 0 - 60000 Reserved
S13 N 0 I 0 - 100 Number of synchronization subsystem2
S14 Y 0.000 R Full Timer control3
S15 Y 1.0 R 0.0 - 255.0 Field bus segment number or WorldFIP field bus
segment number. Refer to S15 explanation.
S16 Y 0.000 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. For most applications, the default value shown will suffice for the specification.
3. Refer to S14 explanation for field bus communications speeds.

Explanation
Specifications
S1 Address of the primary FIP module.
S2 Address of the secondary FIP module.
S3 Block address of the first analog input subscriber (function
code 186).
S4 Block address of the first digital input subscriber (function
code 185).
S5 Block address of the first analog output subscriber (function
code 187).
S6 Block address of the first digital output subscriber (function
code 188).
S7 and S8 Reserved.
S9 Sets the module operating status upon a module failure.

0 = trip primary module


1 = continue operation

184 - 2 WBPEEUI210504C0
S10 For most applications, the default specification value will suf-
fice. Specification S10 is the synchronization ID. The synchro-
nization ID is the FIP identifier of the synchronization variable
that the FIP handler configures to synchronize the MFP mod-
ule and the associated variables. At present, the MFP module
does not synchronize its segment executions to this variable.
S11 and S12 Reserved.
S13 For most applications, the default specification value will suf-
fice. Specification S13 is the number of the synchronization
subsystem. This is the number of the subsystem that the cur-
rent FIP handler manages. When S13 is zero, the current FIP
handler manages the primary system and synchronizes the
module. This refers to the synchronization clock on the dual
port RAM register of the other I/O modules (I/O modules
count the milliseconds and reset the clock on every synchroni-
zation). Any number above zero means the current FIP handler
manages a subsystem and does no synchronization.
S14 Specifies several parameters dealing with the physical timing
of the IMFBM02 module and bus arbitration capability. This
specification is set as follows:

S14 = TXCKL + RP + IEC + BA

where:

TXCKL Bus speed


0 = 31.25 kbits/sec
1 = 1 Mbit/sec
2 = 22.5 Mbits/sec
RP RT Time × 4
RTTime Return time of the WorldFIP station in bit-time
(time duration of one bit) in the range of zero to 63
Example At 1 Mbit/sec, the bit-time equals 1 µsec. Therefore, if RTTime = 8, the actual
return time is 8 µsec. At 32 kbits/sec, the bit-time equals 31.25 µsec. In this
example, RTTime = 8 means an actual return time of 250 µsec.

The return time (also known as turnaround time) is the length


of time the WorldFIP station will wait before responding to
transactions received on the WorldFIP field bus. In addition, it
is also the amount of time the WorldFIP station will wait for
other WorldFIP stations to respond to transactions it initiates.

WBPEEUI210504C0 184 - 3
The setting for this return time parameter is dependent on sev-
eral physical link criteria such as the length and media type
(twisted pair, coaxial, fiber optic, etc.) of the field bus segment.
The setting for this parameter must correspond to the maxi-
mum return time setting for this field bus segment. The maxi-
mum return time setting for the field bus segment is
determined by the maximum turnaround time of the slowest
device on the field bus segment.

The IEC physical layer standard specifies a minimum return


time of four bit-times and maximum return time of 32
bit-times. Intermediate settings between these two ranges
must be in four bit-time increments.

The physical layer parameter (IEC/FIP) specifies the choice


between the IEC or FIP physical layer standard.

where:

IEC/FIP Physical layer


0 = IEC (WorldFIP)
32768 = FIP

The bus arbiter occupation parameter specifies the number of


kilobytes (within the range of one to 54) of RAM to reserve in
the IMFBM02 module for the bus arbitration program. If BA
(bus arbiter occupation x 256) is set to zero, then the bus arbi-
tration function of the IMFBM02 is disabled.
S15 WorldFIP field bus segment number for the IMFBM02 World-
FIP Server Module. This number is used to uniquely identify a
specific WorldFIP field bus segment among several that may be
connected together via WorldFIP field bus bridge devices.

FIP Variable Input/Output Types


FIP variables may consist of one value or an array of values.
The various types mentioned in S4 of function codes 185 and
186 and S12 of function codes 187 and 188 actually refer to
the format of the values within a FIP variable.

The FIP input and output subscriber blocks are used to inter-
face the Harmony controller with these FIP variables. Up to
four FIP subscriber blocks of the same type may be associated
with a single FIP variable. For FIP variables that contain an
array of values, the maximum number of values for that array

184 - 4 WBPEEUI210504C0
is 32. The individual elements of a FIP variable are associated
to a particular subscriber block using the group number found
in S3. The number of elements specified in S3 of the sub-
scriber block is used to identify the number of values or ele-
ments within the FIP variable. The input/output type
describes the format of the elements of the FIP variable. For
most of the types, one block output is associated with each
element of the FIP variable. The exception to this rule is for the
digital types in which eight block outputs or inputs are associ-
ated with one element that has packed within it, eight values.
FIP variables can also have a check byte associated with each
element. The check byte is used to associate a quality flag with
the data contained within the element.

Refer to Figure 184-1 for a list of the various input/output


types and their formats.

M A X IM U M
E LEM E N T F U N C T IO N S PE C
N U M B ER O F DATA EL E M EN T F O R M AT
TYPE C O D ES VAL U E
E L EM E N TS
V V V V V V V V W H E N U SIN G T H E D IG ITA L E L E M E N T T Y P E , U P TO E IG H T
D IG ITAL 18 5 , 1 88 0 4
7 6 5 4 3 2 1 0 B O O L E A N VA LU E S A R E E N C O D E D W IT H IN E AC H E LE M EN T.
W H E N S E T T IN G TH E VA L U E FO R T H E E LE M EN T S P E C IN S 3 ,
D IG ITAL Q Q Q Q Q Q Q Q V V V V V V V V U S E TH E N U M BE R O F B O O L E A N VA LU E S F O R TH IS S P E C.
W IT H 18 5 , 1 88 1 4 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 Q = L O G IC 0 = B A D Q UA LIT Y
CHECK Q = L O G IC 1 = G O O D Q UA LIT Y
(TH IS IS O P PO S IT E O F TH E IN F I 9 0 O P E N
B O O L EA N 18 5 , 1 88 2 32 0 V C O N V E N T IO N O F Q = L O G IC 0 = G O O D Q UA L IT Y
Q = L O G IC 1 = B A D Q UA L IT Y )
T H E S U B S C R IB E R B LO C KS IN V E RT Q
B O O L EA N TO C O N F O R M TO T H E IN FI 90 O P E N S TA N DA R D
W IT H 18 5 , 1 88 4 16 Q 0 0 V V = LO G IC 0 = FA LS E O R O F F
CHECK V = LO G IC 1 = TR U E O R O N

A N AL O G msb lsb
R E AL 18 6 , 1 87 0 32 S IN G L E PR E C IS IO N IE E E 4 8 8 F L O AT IN G P O IN T

A N AL O G
msb lsb
R E AL W IT H 18 6 , 1 87 1 16 Q 0 S IN G LE P R E C IS IO N IE E E 4 88 FL O ATIN G P O IN T
CHECK

A N AL O G msb lsb
18 6 , 1 87 2 32 2 B YT E S IG N E D IN T E G E R W H E N F U N C T IO N C O D E 1 87 C O N V E RT S
IN TE G E R A N A N A LO G IN P U T VA LU E TO A TW O
A N AL O G B Y T E S IG N E D IN T EG E R , IT W IL L S E T T H E
msb lsb Q B IT TO B A D (LO G IC 0 ) IF T H E R E IS A N
IN TE G E R 18 6 , 1 87 3 32 Q 0 2 B YT E S IG N E D IN TE G E R OV E R F LO W IN T H E C AL C U L AT IO N . T H E
W IT H S IG N E D IN TE G E R VA L U E S H AV E A VAL ID
CHECK R A N G E O F -32 76 8 TO 3 27 6 7.

PAC KE D msb 1 BYTE lsb


18 6 , 1 87 4 32 UNSIGNED INTEGER F U N C T IO N C O D E 12 6 (R E A L S IG N A L D E M U LT IP LE X E R )
B O O L EA N C A N B E U S E D TO D E C O D E A N Y PAC K E D B O O L E A N
VA L U E S F R O M T H E AN AL O G R E A L O U T PU T S O F
PAC KE D F U N C T IO N C O D E 18 7.
msb 1 BYTE lsb
B O O L EA N 18 6 , 1 87 5 32 Q 0 UNSIGNED INTEGER T H E R E IS O N LY O N E Q BIT A S S O C IAT E D W IT H A LL O F T H E
W IT H O N E B Y T E U N S IG N E D IN T E G E R VA LU E S O F A F IP VA R IA B L E
CHECK W IT H O N E O R M O R E PAC K E D B O O L E A N E L E M E N T S.
T 01 3 27 A

Figure 184-1. FIP Input/Output Subscriber Variable Types

Application
Figure 184-2 shows the FIP handler block linked to other FIP
I/O blocks (function codes 185 through 188).

WBPEEUI210504C0 184 - 5
F IP
SH
S3 (1 8 4 )
A I# P ST
S4 N
D I# S ST
S5 N+1
AO #
S6
DO#
F IP F IP F IP F IP S7
BA
AI DI AO DO S8
TD
S1 (1 8 6) S1 (1 8 5 ) S4 (1 87 ) S4 (1 8 8 )
NEXT NEXT
N N S5 S5
N+1 N+1 S6 S6
REAL D IG ITA L
REAL N+2 D IG ITA L N+2 S7 VA L U E S S7 VA L U E S
VA L U E S N+3 VA L U E S N+3 S8 F RO M S8 F RO M
TO TO OT H E R OT H E R
OT H E R N+4 OT H E R N+4 S9 BLOCKS S9
BLOCKS
BLOCKS N+5 BLOCKS N+5 S10 S 10
N+6 N+6 S11 S 11
N+7 N+7 S1 S1
NEXT NEXT

F IP F IP F IP F IP
AI DI AO DO
S1 (1 8 6 ) S1 (1 8 5) S4 (1 87 ) S4 (1 8 8)
NEXT NEXT
N N S5 S5
N+1 N+1 S6 S6
REAL D IG ITA L
REAL N+2 D IG ITA L N+2 S7 VA L U E S S7 VA L U E S
VA L U E S N+3 VA L U E S N+3 S8 F RO M S8 F RO M
TO TO OT H E R OT H E R
OT H E R N+4 OT H E R N+4 S9 BLOCKS S9 BLOCKS
BLOCKS N+5 BLOCKS N+5 S10 S10
N+6 N+6 S11 S11
N+7 N+7 S1 S1
NEXT NEXT

F IP F IP F IP F IP
AI DI AO DO
S1 (1 86 ) S1 (1 8 5) S4 (1 87 ) S4 (1 8 8)
NEXT NEXT
N N S5 S5
N+1 N+1 S6 S6
REAL D IG ITA L
REAL N+2 D IG ITA L N+2 S7 VA L U E S S7 VA L U E S
VA L U E S N+3 VA L U E S N+3 S8 F RO M S8 F RO M
TO TO OT H E R OT H E R
OT H E R N+4 OT H E R N+4 S9 BLOCKS S9 BLOCKS
BLOCKS N+5 BLOCKS N+5 S10 S10
N+6 N+6 S11 S11
N+7 N+7 S1 S1
NEXT NEXT
L IN K E D L IS T O F L IN K E D L IS T O F
A N A LO G IN PU T D IG ITA L IN P U T L IN K E D L IS T O F L IN K E D L IS T O F
S U B S C R IB ER S S U B S C R IB ER S
A N A LO G O U T P U T D IG ITA L O U TP U T
S U B S C R IB ER S S U B S C R IB ER S T 01 7 15 A

Figure 184-2. Linking FIP Function Codes

184 - 6 WBPEEUI210504C0
Digital Input Subscriber
Function Code 185

F IP The digital input subscriber acquires a group of digital values


DI from a factory instrumentation protocol (FIP) device. Each dig-
S1 (1 8 5 )
NEXT
N ital input subscriber can handle up to eight digital inputs. Up
N+1 to four digital input subscribers may be linked together allow-
N+2
ing one FIP identifier to reference up to 32 inputs. Link all FIP
N+3
N+4 identifiers configured as digital input subscribers together.
N+5 Each block specifies the next block address in the link.
N+6
N+7 The digital input subscriber has eight outputs corresponding
to the eight digital values acquired with quality.

NOTES:
1. For more information on factory instrumentation protocol, refer to the FIP
Application Description C46-602 which is written by the French Commission
AFNOR, and the INFBA01 Programming Reference Manual.

2. If configuring function code 185 for an Ethernet device interface slave


(IMEDI01), refer to the IMEDI01 instruction for details of this function code.

Outputs

Blk Type Description


N B First digital input with quality
N+1 B Second digital input with quality
N+2 B Third digital input with quality
N+3 B Fourth digital input with quality
N+4 B Fifth digital input with quality
N+5 B Sixth digital input with quality
N+6 B Seventh digital input with quality
N+7 B Eighth digital input with quality

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 1 Block address of next digital input subscriber block
S2 N 0.000 R 0 - 60000 FIP variable identifier2
S3 N 0 I 01 - 38 Group number (X) and number of elements (Y):
X = 0, 1, 2 or 3
Y = 1 through 8

WBPEEUI210504C0 185 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S3 N 0 I 01 - 38 X Y Total
(cont.) 0 1-8 8
1 1-8 16
2 1-8 24
3 1-8 32
S4 N 0 I 0-3 Input type:
0 = digital
1 = digital with check
2 = boolean
3 = boolean with check
S5 N 0.000 R Full Asynchronous promptitude period in msecs3
S6 N 0.000 R Full Synchronous promptitude period in msecs3
S7 N 00 I 0 or 1 Aperiodic and periodic variable:
0 = aperiodic variable
1 = periodic variable
S8 N 00 I 00, 01, 10 Asynchronous and synchronous refresh
or 11 evaluation:
00 = asynchronous and synchronous refresh
disabled
01 = synchronous refresh enabled
10 = asynchronous refresh enabled
11 = partial refresh (asynchronous refresh and
synchronous refresh enabled)
S9 Y 0.000 R Full Spare
S10 Y 0.000 R Full Spare
S11 Y 0.000 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. Refer to S2 under Specifications for additional information.
3. For most applications, the default value shown will suffice for the specification.

Explanation
Specifications
S1 Block address of the next digital input subscriber block.
S2 FIP variable identifier. All data transfer function codes refer to
a FIP variable identifier. This is a 16-bit value (unsigned inte-
ger) and defines the variable (read or written from the control-

185 - 2 WBPEEUI210504C0
ler module) for the application layer of the FIP identifier
implemented in the I/O module.

For most WorldFIP applications, FIP variable identifiers are


shown in a hexadecimal format. Refer to the following example
of converting hexadecimal values to decimal values.
Example A hex number can be expressed as:

(H0 × 1) + (H1 × 16) + (H2 × 162) + (H3 × 163) …,

where H0 is the least significant hex digit and H1 is the next sig-
nificant, and so on.
Example If the variable identifier was 3AE0, to convert the hex number 3AE0 to deci-
mal:

The least significant hex digit is 0. The next digit is E or 14. The next digit is A
or 10. The next digit is 3 or 3. Referring to the preceding equation, the deci-
mal number is:

(0 × 160) +(14 × 161) +(10 × 162) +(3 × 163) =


0 +224 +2560 +12288 = 15072

S3 Input group. Digital input secondary module subscribers han-


dle up to four groups of eight inputs. The input group is identi-
fied as shown in Table 185-1.

Table 185-1. Input Group Identification

Group Number Number of Elements Total Elements


0 1-8 8
1 1-8 16
2 1-8 24
3 1-8 32

S4 Function type.

0 = digital
1 = digital with check
2 = boolean
3 = boolean with check

NOTE: Refer to FIP Variable Input/Output Types in function code 184 for the
format of each of these function types.
S5 Asynchronous promptitude period. The asynchronous promp-
titude period is used to measure how promptly the FIP variable

WBPEEUI210504C0 185 - 3
is being updated by the field bus relative to the last time that
is was updated. The asynchronous promptitude evaluation is
disabled if this specification is zero.
S6 Synchronous promptitude period. The synchronous prompti-
tude period is similar to the asynchronous promptitude
period. The difference between the two is that the synchronous
promptitude is used to measure how promptly the FIP variable
is being updated relative to a synchronization variable pro-
duced on the field bus. (Refer to S10 of function code 184.) The
synchronous promptitude evaluation is disabled if this specifi-
cation is zero.
S7 Periodic and aperiodic variable setting. Periodic variables are
produced and consumed on a periodic basis by devices on the
field bus. Periodic variables are typically used for process val-
ues that are updated regularly, for example, temperature and
pressure values.

Aperiodic variables are produced and consumed on the field


bus only when requested by either the producer or a consumer
of the variable. Aperiodic variables are typically used for status
and alarm information, or in some cases, infrequently sampled
process data such as chromatograph and pH meter readings.
The use of aperiodic variables instead of periodic variables,
where appropriate, allows for a more efficient use of the field
bus.

Function code 185 always reads the latest consumed values


regardless of this setting. However, this specification must be
set appropriately for the FIP I/O module to treat the variable
as either periodic or aperiodic.
S8 Refresh evaluation setting. The refresh evaluation setting
determines how the FIP I/O module is to interpret the refresh
status flag contained with the FIP variable that is being con-
sumed.

Refer to S16 of function code 188 for definitions of asynchro-


nous refreshment, synchronous refreshment and partial
refreshment.

The FIP I/O module will not consume FIP variables with bad
refresh status.

185 - 4 WBPEEUI210504C0
Applications
Refer to function code 184 for an example and application of
FIP function codes 184 through 188.

WBPEEUI210504C0 185 - 5
WBPEEUI210504C0
Analog Input Subscriber
Function Code 186

F IP The analog input subscriber acquires a group of real analog


AI values from a factory instrumentation protocol (FIP) device.
S1 (1 8 6 )
NEXT
N Each analog input subscriber can handle up to eight analog
N+1 inputs. Up to four analog input subscribers may be linked
N+2
together, allowing one FIP identifier to reference up to 32
N+3
N+4 inputs. Link all FIP identifiers configured as analog input sub-
N+5 scribers together with each block specifying the next block
N+6
address in the link.
N+7

The analog input subscriber has eight outputs with quality


that correspond to the eight analog values acquired.

NOTES:
1. For more information on factory instrumentation protocol, refer to the FIP
Application Description C46-602 which is written by the French Commission
AFNOR, and the INFBA01 Programming Reference Manual.

2. If configuring function code 186 for an Ethernet device interface slave


(IMEDI01), refer to the IMEDI01 instruction for details and explanations of this
function code.

Outputs

Blk Type Description


N R First analog input with quality
N+1 R Second analog input with quality
N+2 R Third analog input with quality
N+3 R Fourth analog input with quality
N+4 R Fifth analog input with quality
N+5 R Sixth analog input with quality
N+6 R Seventh analog input with quality
N+7 R Eighth analog input with quality

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 1 Block address of next analog input subscriber
block
S2 N 0.000 R 0 - 60000 FIP variable identifier2

WBPEEUI210504C0 186 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S3 N 0 I 01 - 38 Group number (X) and number of elements (Y):
X = 0, 1, 2 or 3
Y = 1 through 8
X Y Total
0 1-8 8
1 1-8 16
2 1-8 24
3 1-8 32
S4 N 0 I 0-5 Input type:
0 = analog real
1 = analog real with check
2 = analog integer
3 = analog integer with check
4 = packed boolean
5 = packed boolean with check
S5 N 0.000 R Full Asynchronous promptitude period in msecs3
S6 N 0.000 R Full Synchronous promptitude period in msecs3
S7 N 00 I 0 or 1 Aperiodic and periodic variable:
0 = aperiodic variable
1 = periodic variable
S8 N 00 I 00, 01, 10 Asynchronous and synchronous refresh
or 11 evaluation3:
00 = asynchronous and synchronous refresh
disabled
01 = synchronous refresh enabled
10 = asynchronous refresh enabled
11 = partial refresh (asynchronous refresh and
synchronous refresh enabled)
S9 Y 0.000 R Full Spare
S10 Y 0.000 R Full Spare
S11 Y 0.000 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. Refer to S2 under Specifications for additional information.
3. For most applications, the default value shown will suffice for this specification.

Explanation
Specifications
S1 Block address of the next analog input subscriber block.

186 - 2 WBPEEUI210504C0
S2 FIP variable identifier. All data transfer function codes refer to
a FIP variable identifier. This is a 16-bit value (unsigned inte-
ger) and defines the variable (read or written from the Har-
mony controller) for the application layer of the FIP identifier
implemented in the FIP module.

For most WorldFIP applications, FIP variable identifiers are


shown in a hexadecimal format. Refer to the following example
of converting hexadecimal values to decimal values.
Example The hex system is a base 16 system. Therefore, a hex number can be
expressed as:

(H0 × 1) +(H1 × 16) +(H2 × 162) +(H3 × 163) …,

where H0 is the least significant hex digit and H1 is the next sig-
nificant, and so on.
Example If the variable identifier was 3AE0, to convert the hex number 3AE0 to deci-
mal:

The least significant hex digit is 0. The next digit is E or 14. The next digit is A
or 10. The next digit is 3 or 3. Referring to the preceding equation, the deci-
mal number is:

(0 × 160) +(14 × 161) +(10 × 162) +(3 × 163) =


0 +224 +2560 +12288 = 15072

S3 Input group. Analog input I/O module subscribers handle up


to four groups of eight inputs. The input group is identified as
shown in Table 186-1.

Table 186-1. Input Group Identification

Group Number Number of Elements Total Elements


0 1-8 8
1 1-8 16
2 1-8 24
3 1-8 32

S4 Function type.

0 = analog real
1 = analog real with check
2 = analog integer
3 = analog integer with check

WBPEEUI210504C0 186 - 3
4 = packed boolean
5 = packed boolean with check

NOTE: Refer to FIP Variable Input/Output Types in function code 184 for the
format of each of these function types.
S5 Asynchronous promptitude period. The asynchronous promp-
titude period is used to measure how promptly the FIP variable
is being updated by the field bus relative to the last time that
is was updated. The asynchronous promptitude evaluation is
disabled if this specification is zero.
S6 Synchronous promptitude period. The synchronous prompti-
tude period is similar to the asynchronous promptitude
period. The difference between the two is that the synchronous
promptitude is used to measure how promptly the FIP variable
is being updated relative to a synchronization variable pro-
duced on the field bus. (Refer to S10 of function code 184.) The
synchronous promptitude evaluation is disabled if this specifi-
cation is zero.
S7 Periodic and aperiodic variable setting.

Periodic variables are produced and consumed on a periodic


basis by devices on the field bus. Periodic variables are typi-
cally used for process values that are updated regularly, for
example, temperature and pressure values.

Aperiodic variables are produced and consumed on the field


bus only when requested by either the producer or a consumer
of the variable. Aperiodic variables are typically used for status
and alarm information, or in some cases, infrequently sampled
process data such as chromatograph and pH meter readings.
The use of aperiodic variables instead of periodic variables,
where appropriate, allows for a more efficient use of the field
bus.

Function code 186 always reads the latest consumed values


regardless of this setting. However, this specification must be
set appropriately for the FIP I/O module to treat the variable
as either periodic or aperiodic.
S8 Refresh evaluation setting.

The refresh evaluation setting determines how the FIP I/O


module is to interpret the refresh status flag contained with
the FIP variable that is being consumed.

186 - 4 WBPEEUI210504C0
Refer to S16 of function code 187 for definitions of asynchro-
nous refreshment, synchronous refreshment and partial
refreshment.

The FIP I/O module will not consume FIP variables with bad
refresh status.

Applications
Refer to FIP handler (function code 184) for an example and
application of FIP function codes 184 through 188.

WBPEEUI210504C0 186 - 5
WBPEEUI210504C0
Analog Output Subscriber
Function Code 187

F IP The analog output subscriber function code sends a group of


AO real block outputs to a factory instrumentation protocol (FIP)
S4 (1 8 7 )
S5
device. Each analog output subscriber can handle a maximum
S6 of eight analog outputs. Four of these blocks with the same FIP
S7 identifier number may be linked together. This allows one FIP
S8
S9
identifier to reference a total of 32 inputs. All FIP identifiers
S10 configured as analog output subscribers are linked together
S11 with each block specifying the next block address in the link.
S1
NEXT
The analog output subscriber function code has one output
corresponding to the quality of the communication between
the FIP and the Harmony controller.

NOTES:
1. For more information on factory instrumentation protocol, refer to the FIP
Application Description C46-602 which is written by the French Commission
AFNOR, and the INFBA01 Programming Reference Manual.

2. If configuring function code 187 for an Ethernet device interface slave


(IMEDI01), refer to the IMEDI01 instruction for details and explanations of this
function code.

Outputs

Blk Type Description


N B Quality of output

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 1 Block address of next analog output subscriber
block
S2 N 0.000 R 0 - 60000 FIP variable identifier2
S3 N 0 I Note 1 Group number (X) and number of elements (Y):
X Y Total
0 1-8 8
1 1-8 16
2 1-8 24
3 1-8 32
S4 N 2 I Note 1 Block address of output 1

WBPEEUI210504C0 187 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S5 N 2 I Note 1 Block address of output 2
S6 N 2 I Note 1 Block address of output 3
S7 N 2 I Note 1 Block address of output 4
S8 N 2 I Note 1 Block address of output 5
S9 N 2 I Note 1 Block address of output 6
S10 N 2 I Note 1 Block address of output 7
S11 N 2 I Note 1 Block address of output 8
S12 N 0 I 0-5 Output type:
0 = analog real
1 = analog real with check
2 = analog integer
3 = analog integer with check
4 = packed boolean
5 = packed boolean with check
S13 N 0.000 R Full Asynchronous refresh period in msecs
S14 N 0.000 R Full Synchronous refresh period in msecs3
S15 N 0 I 0 or 1 Aperiodic and periodic variable:
0 = aperiodic variable
1 = periodic variable
S16 N 0 I 00, 01, 10 Asynchronous and synchronous refresh setting3:
or 11 00 = asynchronous and synchronous refresh
disabled
01 = synchronous refresh enabled
10 = asynchronous refresh enabled
11 = partial refresh (asynchronous refresh and
synchronous refresh enabled)
S17 Y 0.000 R Full Spare
S18 Y 0.000 R Full Spare
S19 Y 0.000 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. Refer to S2 under Specifications for additional information.
3. For most applications, the default value shown will suffice for the specification.

Explanation
Specifications
S1 Block address of the next analog output module block.

187 - 2 WBPEEUI210504C0
S2 FIP variable identifier. All data transfer function codes refer to
a FIP variable identifier. This is a 16-bit value (unsigned inte-
ger) and defines the variable (read or written from the Har-
mony controller) for the application layer of the FIP identifier
implemented in the FIP module.

For most WorldFIP applications, FIP variable identifiers are


shown in a hexadecimal format. Refer to the following example
of converting hexadecimal values to decimal values.
Example The hex system is a base 16 system. Therefore, a hex number can be
expressed as:

(H0 × 1) +(H1 × 16) +(H2 × 162) +(H3 × 163) …,

where H0 is the least significant hex digit and H1 is the next sig-
nificant, and so on.
Example If the variable identifier was 3AE0, to convert the hex number 3AE0 to deci-
mal:

The least significant hex digit is 0. The next digit is E or 14. The next digit is A
or 10. The next digit is 3 or 3. Referring to the preceding equation, the deci-
mal number is:

(0 × 160) +(14 × 161) +(10 × 162) +(3 × 163) =


0 +224 +2560 +12288 = 15072

S3 Output group. Analog output module subscribers handle up to


four groups of eight outputs. The output group is identified as
shown in Table 187-1.

Table 187-1. Output Group Identification

Group Number Number of Elements Total Elements


0 1-8 8
1 1-8 16
2 1-8 24
3 1-8 32

S4 through S11 Block addresses of outputs one through eight.


S12 Function type.

0 = analog real
1 = analog real with check
2 = analog integer

WBPEEUI210504C0 187 - 3
3 = analog integer with check
4 = packed boolean
5 = packed boolean with check

NOTE: Refer to FIP Variable Input/Output Types in function code 184 for the
format of each of these function types.
S13 Asynchronous refresh period. The asynchronous refresh
period measures how well the FIP module is producing the FIP
variable data on the field bus relative to when the Harmony
controller refreshes the data. If the FIP variable is not pro-
duced on the field bus within the refresh period, then the
refresh status flag associated with this FIP variable is reset to
indicate that the data is old. Other FIP field devices that con-
sume this variable can evaluate the refresh status flag to
determine if the FIP variable data is valid or not. This specifi-
cation must be set to a value that is equal to or slightly larger
than a multiple of the segment cycle time (S2 of function code
82) of the segment in which this block resides.
S14 Synchronous refresh period. The synchronous refresh period
is similar to the asynchronous refresh period. The difference
between the two is that the synchronous refresh period is used
to measure how well the FIP module is producing the FIP vari-
able on the field bus relative to a synchronization variable pro-
duced on the field bus (refer to S10 of function code 184).
S15 Periodic and aperiodic variable setting.

Periodic variables are produced and consumed on a periodic


basis by devices on the field bus. Periodic variables are typi-
cally used for process values that are updated regularly, for
example, temperature and pressure values.

Aperiodic variables are produced and consumed on the field


bus only when requested by either the producer or a consumer
of the variable. Aperiodic variables are typically used for status
and alarm information, or in some cases, infrequently sampled
process data such as chromatograph and pH meter readings.
The use of aperiodic variables instead of periodic variables,
where appropriate, allows for a more efficient use of the field
bus.

When aperiodic is selected, function code 187 will produce the


variable on the field bus only when one of the input values

187 - 4 WBPEEUI210504C0
<S4> through <S11> has changed since the last time the vari-
able was produced.
S16 Refresh setting. This setting determines how the refresh status
for this produced FIP variable is to be determined.

Asynchronous refreshment - refresh status is set to good if the


FIP module produces the FIP variable on the field bus within
the asynchronous refresh period (S13) of when the Harmony
controller refreshes the FIP variable data. Set bad otherwise.

Synchronous refreshment - refresh status is set to good if the


FIP module produces the FIP variable on the field bus within
the synchronous refresh period (S14) of when the synchroniza-
tion variable (S10 of function code 184) is received. Set bad
otherwise.

Partial refreshment - combination of both asynchronous and


synchronous refreshment. For the refresh status to be set
good:

• The FIP module must produce the FIP variable on the field
bus within the asynchronous refresh period of when the
Harmony controller has refreshed the data of the FIP vari-
able.

and

• It must also have produced it within the synchronous


refresh period (S14) of when the synchronization variable
(S10 of function code 184) has been received.

Set bad otherwise.

Applications
Refer to FIP handler (function code 184) for an example and
application of FIP function codes 184 through 188.

WBPEEUI210504C0 187 - 5
WBPEEUI210504C0
Digital Output Subscriber
Function Code 188

F IP The digital output subscriber function code sends a group of


DO digital block outputs to a factory instrumentation protocol
S4 (1 8 8 )
S5
(FIP) device. Each digital output subscriber can handle a max-
S6 imum of eight digital outputs. Four of these blocks with the
S7 same FIP identifier number may be linked together. This allows
S8
S9
one FIP identifier to reference a total of 32 inputs. All FIP iden-
S10 tifiers configured as digital output subscribers are linked
S11 together with each block specifying the next block address in
S1
NEXT the link.

The digital output subscriber function code has one output


corresponding to the quality of the communication between
the FIP and Harmony controllers.

NOTES:
1. For more information on factory instrumentation protocol, refer to the FIP
Application Description C46-602 which is written by the French Commission
AFNOR, and the INFBA01 Programming Reference Manual.

2. If configuring function code 188 for an Ethernet device interface slave


(IMEDI01), refer to the IMEDI01 instruction for details and explanations of this
function code.

Outputs

Blk Type Description


N B Quality of output

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 1 Block address of next digital output subscriber
block
S2 N 0.000 R 0 - 60000 FIP variable identifier2
S3 N 0 I Note 1 Group number (X) and number of elements (Y):
X Y Total
0 1-8 8
1 1-8 16
2 1-8 24
3 1-8 32
S4 N 0 I Note 1 Block address of output 1

WBPEEUI210504C0 188 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S5 N 0 I Note 1 Block address of output 2
S6 N 0 I Note 1 Block address of output 3
S7 N 0 I Note 1 Block address of output 4
S8 N 0 I Note 1 Block address of output 5
S9 N 0 I Note 1 Block address of output 6
S10 N 0 I Note 1 Block address of output 7
S11 N 0 I Note 1 Block address of output 8
S12 N 0 I 0-3 Output type:
0 = digital
1 = digital with check
2 = boolean
3 = boolean with check
S13 N 0.000 R Full Asynchronous refresh period in msecs
S14 N 0.000 R Full Synchronous refresh period in msecs
S15 N 0 I 0 or 1 Aperiodic and periodic variable:
0 = aperiodic variable
1 = periodic variable
S16 N 0 I 00, 01, 10 Asynchronous and synchronous refresh setting3:
or 11 00 = asynchronous and synchronous refresh
disabled
01 = synchronous refresh enabled
10 = asynchronous refresh enabled
11 = partial refresh (asynchronous refresh and
synchronous refresh enabled)
S17 Y 0.000 R Full Spare
S18 Y 0.000 R Full Spare
S19 Y 0.000 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
1. Refer to S2 under Specifications for additional information.
2. For most applications, the default value shown will suffice for the specification.

Explanation
Specifications
S1 Block address of the next digital output I/O module block.

188 - 2 WBPEEUI210504C0
S2 FIP variable identifier. All data transfer function codes refer to
a FIP variable identifier. This is a 16-bit value (unsigned inte-
ger) and defines the variable (read or written from the Har-
mony controller) for the application layer of the FIP identifier
implemented in the FIP module.

For most WorldFIP applications, FIP variable identifiers are


shown in a hexadecimal format. Refer to the following example
of converting hexadecimal values to decimal values.
Example The hex system is a base 16 system. Therefore, a hex number can be
expressed as:

(H0 × 1) +(H1 × 16) +(H2 × 162) +(H3 × 163) …,

where H0 is the least significant hex digit and H1 is the next sig-
nificant, and so on.
Example If the variable identifier was 3AE0, to convert the hex number 3AE0 to deci-
mal:

The least significant hex digit is 0. The next digit is E or 14. The next digit is A
or 10. The next digit is 3 or 3. Referring to the preceding equation, the deci-
mal number is:

(0 × 160) +(14 × 161) +(10 × 162) +(3 × 163) =


0 +224 +2560 +12288 = 15072

S3 Output group. Digital output I/O module subscribers handle


up to four groups of eight outputs. The output group is identi-
fied as shown in Table 188-1.

Table 188-1. Output Group Identification

Group Number Number of Elements Total Elements


0 1-8 8
1 1-8 16
2 1-8 24
3 1-8 32

S4 through S11 Block addresses of outputs one through eight.


S12 Function type.

0 = digital
1 = digital with check

WBPEEUI210504C0 188 - 3
2 = boolean
3 = boolean with check

NOTE: Refer to FIP Variable Input/Output Types in function code 184 for the
format of each of these function types.
S13 Asynchronous refresh period. The asynchronous refresh
period measures how well the FIP module is producing the FIP
variable data on the field bus relative to when the Harmony
controller refreshes the data. If the FIP variable is not pro-
duced on the field bus within the refresh period, then the
refresh status flag associated with this FIP variable is reset to
indicate that the data is old. Other FIP field devices that con-
sume this variable can evaluate the refresh status flag to
determine if the FIP variable data is valid or not. This specifi-
cation must be set to a value that is equal to or slightly larger
than a multiple of the segment cycle time (S2 of function
code 82) of the segment in which this block resides.
S14 Synchronous refresh period. The synchronous refresh period
is similar to the asynchronous refresh period. The difference
between the two is that the synchronous refresh period is used
to measure how well the FIP module is producing the FIP vari-
able on the field bus relative to a synchronization variable pro-
duced on the field bus (refer to S10 of function code 184).
S15 Periodic and aperiodic variable setting.

Periodic variables are produced and consumed on a periodic


basis by devices on the field bus. Periodic variables are typi-
cally used for process values that are updated regularly, for
example, temperature and pressure values.

Aperiodic variables are produced and consumed on the field


bus only when requested by either the producer or a consumer
of the variable. Aperiodic variables are typically used for status
and alarm information, or in some cases, infrequently sampled
process data such as chromatograph and pH meter readings.
The use of aperiodic variables instead of periodic variables,
where appropriate, allows for a more efficient use of the field
bus.

When aperiodic is selected, function code 188 will produce the


variable on the field bus only when one of the input values
<S4> through <S11> has changed since the last time the vari-
able was produced.

188 - 4 WBPEEUI210504C0
S16 Refresh setting. This setting determines how the refresh status
for this produced FIP variable is to be determined.

Asynchronous refreshment - refresh status is set to good if


the FIP module produces the FIP variable on the field bus
within the asynchronous refresh period (S13) of when the Har-
mony controller refreshes the FIP variable data. Set bad other-
wise.

Synchronous refreshment - refresh status is set to good if the


FIP module produces the FIP variable on the field bus within
the synchronous refresh period (S14) of when the synchroniza-
tion variable (S10 of function code 184) is received. Set bad
otherwise.

Partial refreshment - combination of both asynchronous and


synchronous refreshment. For the refresh status to be set
good:

• The FIP module must produce the FIP variable on the field
bus within the asynchronous refresh period of when the
Harmony controller has refreshed the data of the FIP vari-
able.

and

• It must also have produced it within the synchronous


refresh period (S14) of when the synchronization variable
(S10 of function code 184) has been received.

Set bad otherwise.

Applications
Refer to FIP handler (function code 184) for an example and
application of FIP function codes 184 through 188.

WBPEEUI210504C0 188 - 5
WBPEEUI210504C0
User Defined Function
Declaration Function Code 190
The user defined function declaration function code declares a
(1 9 0 )
UDFDEC user defined function (UDF). The UDF declaration selects the
N
program that belongs to the UDF block. This block specifies
the amount of RAM allocated for the executable copy of the
UDF program.

The UDF blocks (function codes 191 and 192) reference S3


through S6 for internal processing.

For more information regarding user defined functions, refer


to the Batch 90 and User Defined Function (UDF)
Programming Language Reference product instruction.

Outputs

Blk Type Description


N R Reserved for future use

Specifications

Spec Tune Default Type Range Description


S1 N 0.000 R Full UDF program ID
S2 N 1 I 1 - 6553 UDF program size in 10 byte increments
S3 Y 0.000 R Full Tunable real parameter
S4 Y 0.000 R Full Tunable real parameter
S5 Y 0.000 R Full Tunable real parameter
S6 Y 0.000 R Full Tunable real parameter
S7 Y 0.000 R Full Spare parameter
S8 Y 0.000 R Full Spare parameter

Explanation
The UDF declaration block declares a user defined function.
This block performs the following:

• Selects the UDF program that belongs to the block. A Har-


mony controller may have many UDF programs in its file
system. Each of these UDF programs will have a different

WBPEEUI210504C0 190 - 1
program ID number. Specification S1 specifies the ID of the
particular program that belongs to this block.

• Specifies RAM allocation for the executable copy of the pro-


gram. The copy of the UDF program in the file system is
not in executable form. This copy must be in a UDF decla-
ration block before it can execute. Specification S2 speci-
fies the amount of RAM allocated for the program in
increments of ten bytes.

• Function code 190 does not execute the UDF program. A


UDF block (function code 191 or 192 depending on which
one the UDF program specifies) performs execution. A UDF
program is declared once (function code 190) but may be
executed by many UDF blocks. UDF blocks execute inde-
pendently. Each block has its own inputs, outputs, param-
eters and local data.

• Specifications S3 through S6 (function code 190) are


parameters that the UDF program references. If several
UDF blocks share a program, they also share these param-
eters.

190 - 2 WBPEEUI210504C0
User Defined Function One
Function Code 191

UDF1 The user defined function one function code executes a user
(1 9 1 )
S1 defined function (UDF). The UDF1 block has inputs, parame-
S2 N
S3 N+1 ters, outputs and program data. Specification S16 allocates
S4 the program data space.
S5
S6 The number of inputs, parameters and outputs can be
S7
expanded by use of auxiliary UDF blocks (function codes 198
S8
S15 and 199). Specification S15 links to the first auxiliary UDF
S17 block.

Specification S17 links the UDF one block to a UDF declara-


tion block (function code 190).

For more information regarding user defined functions, refer


to the Batch 90 and User Defined Function (UDF)
Programming Language Reference product instruction.

Outputs

Blk Type Description


N R Real output
N+1 R Real output

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 1 Block address of any input
S2 N 2 I Note 1 Block address of any input
S3 N 2 I Note 1 Block address of any input
S4 N 2 I Note 1 Block address of any input
S5 N 2 I Note 1 Block address of any input
S6 N 2 I Note 1 Block address of any input
S7 N 2 I Note 1 Block address of any input
S8 N 2 I Note 1 Block address of any input
S9 Y 0.000 R Full Tunable real parameter
S10 Y 0.000 R Full Tunable real parameter
S11 Y 0.000 R Full Tunable real parameter
S12 Y 0.000 R Full Tunable real parameter

WBPEEUI210504C0 191 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S13 Y 0.000 R Full Tunable real parameter
S14 Y 0.000 R Full Tunable real parameter
S15 N 2 I Note 1 Block address of first auxiliary UDF
S16 N 128 I 0 - 65535 Size of data (bytes)
S17 N 2 I Note 1 Block address of UDF declaration
S18 Y 0.000 R Full Spare
S19 Y 0.000 R Full Spare
S20 Y 0.000 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

191 - 2 WBPEEUI210504C0
User Defined Function Two
Function Code 192

UDF2 The user defined function two function code executes a user
(1 9 2 )
S1 defined function (UDF). The UDF2 block has inputs, parame-
S2 N
S3 N+1 ters, outputs and program data. Specification S24 allocates
S4 N+2 the program data space.
S5 N+3
S6 N+4 The number of inputs, parameters and outputs can be
S7 N+5
S8 N+6
expanded by use of auxiliary UDF blocks (function codes 198
S9 N+7 and 199). Specification S23 links to the first auxiliary UDF
S10 N+8 block.
S11 N+9
S12
Specification S25 links the UDF2 block to a UDF declaration
S13
S14 block (function code 190).
S15
S16 For more information regarding user defined functions, refer
S17 to the Batch 90 and User Defined Function (UDF)
S18
S23
Programming Language Reference product instruction.
S25
Outputs

Blk Type Description


N B Boolean output
N+1 B Boolean output
N+2 B Boolean output
N+3 B Boolean output
N+4 B Boolean output
N+5 B Boolean output
N+6 B Boolean output
N+7 B Boolean output
N+8 R Real output
N+9 R Real output

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 1 Block address of any input
S2 N 2 I Note 1 Block address of any input
S3 N 2 I Note 1 Block address of any input
S4 N 2 I Note 1 Block address of any input

WBPEEUI210504C0 192 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S5 N 2 I Note 1 Block address of any input
S6 N 2 I Note 1 Block address of any input
S7 N 2 I Note 1 Block address of any input
S8 N 2 I Note 1 Block address of any input
S9 N 2 I Note 1 Block address of any input
S10 N 2 I Note 1 Block address of any input
S11 N 2 I Note 1 Block address of any input
S12 N 2 I Note 1 Block address of any input
S13 N 2 I Note 1 Block address of any input
S14 N 2 I Note 1 Block address of any input
S15 N 2 I Note 1 Block address of any input
S16 N 2 I Note 1 Block address of any input
S17 N 2 I Note 1 Block address of any input
S18 N 2 I Note 1 Block address of any input
S19 Y 0.000 R Full Tunable real parameter
S20 Y 0.000 R Full Tunable real parameter
S21 Y 0.000 R Full Tunable real parameter
S22 Y 0.000 R Full Tunable real parameter
S23 N 2 I Note 1 Block address of first auxiliary UDF
S24 N 128 I 32 - 65535 Size of data (bytes)
S25 N 2 I Note 1 Block address of UDF declaration
S26 Y 0.000 R Full Spare
S27 Y 0.000 R Full Spare
S28 Y 0.000 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

192 - 2 WBPEEUI210504C0
User Defined Data Import
Function Code 193
DATA IM PT The user defined data import function code acquires user data
(1 9 3 )
N input from another module in a different node via the Cnet
ST
communication network. The user data can then be read by
user defined function (UDF), batch or C language programs
within the module, or it can be exported by a user defined data
export (function code 194) block.

For more information refer to the C Utility Program product


instruction, the Batch 90 and User Defined Function (UDF)
Programming Language Reference instruction.

NOTES:
1. This function code can import user defined data from a source module in
another node or from a block within the same module. This function code can-
not import user defined data from another module within the same node. To
import user defined data locally, import a file rather than using this function
code.

2. A module cannot utilize more than one user defined data import (function
code 193) block to import data from the same user defined data export block
(function code 194) that is in a module in a different Cnet node. This restriction
does not apply to user defined data import blocks that import from user defined
data export blocks which reside within the same module.

Outputs

Blk Type Description


N User User defined data and status with quality
defined
N+1 R Block status

Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 31 Source module address
S2 N 0 I Note 1 Source block number
S3 N 0 I 0 - 250 Source node address
S4 N 0 I 0 - 250 Source loop number
S5 N 0 I 0 - 80 Maximum user data length

WBPEEUI210504C0 193 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S6 N 0 I 0 - 255 Engineering units
S7 Y 0 I 0 or 1 Startup control and force quality control:
0 = block quality on startup is bad
1 = block quality on startup is good
S8 N 0 R Full Spare
S9 N 0 I Full Spare
S10 Y 0 R Full Spare
S11 Y 0 I Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

Explanation
The defined specifications of function code 193 include the
source module address, block number, node address, loop
address, maximum data length, engineering units and startup
control. The module, block, node and loop specifications must
reference a user defined data export function block (function
code 194). The maximum data length specification sets the
maximum allowable user data length. If an input to the block
exceeds this length, truncation occurs and the count fields
(included in the user data block output) will be set. The engi-
neering units specification can be used to describe the content
of the user data (e.g., ASCII strings). The startup control speci-
fication can be used to force the block to output good quality
on startup. The specifications, except for startup control, are
not tunable.

Specifications
S1 Source module address.
S2 Source block number.
S3 Source node address.
S4 Source loop number.
S5 Defines the maximum user data length. The maximum user
data length is a nontunable integer specification. If an input to

193 - 2 WBPEEUI210504C0
the block exceeds this length, truncation occurs and the count
fields (included in output block N) are set.
S6 Defines the engineering units.
S7 Defines the startup control. The startup control can be used to
force the block to output good quality on startup.

0 = block quality on startup is bad


1 = block quality on startup is good
S8 - S11 Spare.

Outputs
N Contains the user data and its alarm with quality status. The
maximum output data length is 82 bytes (80 bytes of data plus
two count bytes). Updates to this user data from the source
user data export function block occur on an exception report
basis.
N+1 Block status output multiplexed as a real value. Refer to func-
tion code 194, block output N+1 for more information.

Applications
Refer to Application Programs in function code 194.

WBPEEUI210504C0 193 - 3
WBPEEUI210504C0
User Defined Data Export
Function Code 194

DATA The user defined data export function code outputs user data
EX PT via an exception report. A batch program, user defined func-
S1 (1 9 4 )
S2
ID tion (UDF), C language program executing in the Harmony
IC ST
S3 IS
controller or a human system interface (HSI) command deter-
mines the user defined data output (output block N).

For more information refer to the C Utility Program product


instruction, the Batch 90 and User Defined Function (UDF)
Programming Language Reference instruction.

Outputs

Blk Type Description


N User User defined data and status with quality
defined
N+1 R Block status

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 1 Block address of input data
S2 N 2 I Note 1 Block address of input control
S3 N 2 I Note 1 Block address of input status
S4 N 0 I 0 - 80 Maximum user data length
S5 N 0 I 0 - 255 Engineering units
S6 Y 0 I 0 or 1 Start-up control and force quality control:
0 = block quality on startup is bad
1 = block quality on startup is good
S7 Y 0 R Full Return alarm time-out period (secs)
S8 N 0 R Full Spare
S9 N 0 I Full Spare
S10 Y 0 R Full Spare
S11 Y 0 I Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

WBPEEUI210504C0 194 - 1
Explanation
The defined specifications of function code 194 include the
input data block, input control block, input status block, max-
imum data length, engineering units, startup control and
return alarm time-out period. The specifications, except for the
startup control and return alarm time period, are not tunable.

Specifications
S1 Block address of the input data. The default value of block
address two indicates that the block is application program
driven. When S1 is set to two, the user defined data export
block expects to interface to a C language, UDF or batch pro-
gram and ignores any block inputs.

When S1 is set to any block other than two, the block must be
another valid user data block output (e.g., user data import
function code 193).
S2 Block address of the input control. The input control parame-
ter is formed by setting the corresponding bits of a real block
output. This block number must reference the output of a
valid real block. Table 194-1 lists the bits of the input control.

NOTE: When S1 is set to two, S2 is driven by a C language, UDF or batch


program.

Table 194-1. Input Control Specification <S2>

Bit Control Description


0 Auto/manual This field controls block output updates. A level transition from 0 to 1 or 1 to 0
toggles the mode of the block between auto and manual (Table 194-2).
1 Data When is enabled, any updates to the block output via HSI command
interlock messages are inhibited (Table 194-2).
2 Mode When enabled, attempts to change the block mode by toggling the auto/
interlock manual are ignored.

S3 Block address of the input status. The input status parameter


is formed by setting the corresponding bits or a real block out-
put. This block number must reference the output of a valid
real block. Table 194-3 lists the bits of the input status.

NOTE: When S1 is set to two, S3 is driven by a C language, UDF or batch


program.

194 - 2 WBPEEUI210504C0
Table 194-2. Data Export Function Block Operation

Input Lock
Mode Operation
Source Status
Application Auto Locked The application program controls the output of the user defined
program data export block not allowing any input from the HSI.
Unlocke The application program controls the output of the user defined
d data export block allowing input from the HSI. The application pro-
gram may or may not update the output of the block based on the
input from the HSI. It depends on how the program is written.
Man- Unlocke Both the application program and the HSI control the output of the
ual d user defined data export block. A text string received from the HSI
can be read by the application program. The text string received
from the HSI becomes the output of the block unless the program
updates the output with a new text string.
Function Auto Locked Another function block controls the output of the user defined data
block export block not allowing any input from the HSI.
Man- Unlocke The HSI controls the output of the block. A text string received
ual d from the HSI becomes the output of the block.

Table 194-3. Input Status Specification <S3>

Bit Status Description


0 Quality This field sets the quality of the output:
0 = good quality
1 = bad quality
1 Quality This field sets the quality override:
override 0 = normal
1 = quality override
2/3 — Not used
4/5 Alarm This field sets 2 alarm bits providing 4 levels of alarm input:
level 0/0 = no alarm
0/1 = specific alarm level 1
1/0 = specific alarm level 2
1/1 = specific alarm level 3
6/7 — Not used
8 New When the new packet flag is enabled, the block generates a new exception report
packet with a new sequence number even though the data may not be new. The new
flag packet flag of the exception report is set to indicate this operation.

S4 Defines the maximum user data length. The maximum user


data length is a nontunable integer specification. If an input to
the block exceeds this length, truncation occurs and the count
fields (included in output block N) are set.

WBPEEUI210504C0 194 - 3
S5 Defines the engineering units.
S6 Defines the startup control. The startup control can be used to
force the block to output good quality on startup.

0 = block quality on startup is bad


1 = block quality on startup is good
S7 Defines the return alarm time-out period in seconds. If S7 is
set to zero seconds, return alarming is disabled. If S7 is not
zero, return alarming occurs each time that this time period
expires. When return alarming occurs, the return alarm sta-
tus bit of the block output is toggled and a new exception
report is generated.
S8 through S11 Spare.

Outputs
N User data block output with quality. The maximum output
data length is 80 bytes plus two count bytes. This output is
exception reported when significant change occurs. Significant
change is a difference in a memory block comparison function
between the current output and the new output or a change in
any of the status fields.

Output N also includes a sequence number. This sequence


number is maintained at the system level by the harmony con-
troller to assist in multiple user data packet management and
user data packet identification.
N+1 Block status output. The real value can be demultiplexed to
bits using function code 126. Table 194-4 lists the bits.

Table 194-4. Block Status Output N+1

Bit Description Bit Description


0 Packet restart 7 Quality override
1 Data interlock 8 Auto/manual
2 New packet indicator 9 Red tag status
3 Not used 10 Echo
4 Mode interlock 11/12 Not used
5 Return alarm (toggle) 13/14 Alarm level
6 Suppress alarms 15 Quality

194 - 4 WBPEEUI210504C0
Exception Report Data
Application programs such as C language, UDF or Batch 90
can read various types of data from the user defined data
export function code:

• Alarm level.
• Auto/manual state.
• Configured block size (number of user data bytes).
• Current byte count.
• Data interlock state.
• Echo indicator.
• Enable new specifications flag.
• Exception report time stamp (four bytes).
• Inhibit time stamp flag.
• Mode interlock.
• Original byte count.
• New packet data.
• New packet indicator.
• Packet sequence number.
• Packet restart.
• Quality.
• Quality override flag.
• Red tag state.
• Return alarm state.
• Suppress alarm flag.

The userdata_xr_read() function provides the ability to read


this data.

Application programs such as C language, UDF or Batch 90


can write various exception report data to the user defined
data export function code:

• Quality.
• Alarm level.
• Auto/manual state.
• Quality override.
• New packet indicator (force exception report).
• Data interlock state.
• Exception report time stamp (four bytes).
• Packet data.
• Mode interlock.

The userdata_xr_write() function provides the ability to write


this data.

WBPEEUI210504C0 194 - 5
Application Programs
The input block address and input control block address pro-
vide inputs that allow control of the data flow in the user data
export function code. The inputs that control this flow include
the input block address, auto/manual and data interlock.
Figures 194-1 through 194-5 show five operating modes of the
block that can be realized from a combination of these three
inputs.

The first example (Fig. 194-1) is an application program con-


trol. This example allows application programs such as C lan-
guage or batch to write directly to the user data block output.
The application program sets auto mode and enables the data
interlock. The module denies HSI write access to this block.
The application program is the only process that updates the
block. The data of the block is exception reported if the appli-
cation program changes or updates the block data or any of
the write block status fields (e.g., alarm level).

C O N FIG U R ATIO N

A PP L IC ATIO N
C O N TRO L
DATA
EX PT
(1 94) AU TO M O D E
S1 ID DATA IN TE R LO C K
S2 IC ST E N AB LE D
S3 IS

S PE C IFIC ATIO N S
S ET TO D E FAU LT
S ET TIN G S

A PP LIC ATIO N
APP LIC ATIO N

U S ER D ATA _X R _W R IT E

B LO C K E XC E P TIO N
O U TPU T R E PO RT

T 01 92 6 A

Figure 194-1. Application Program Control Example

Figure 194-2 shows an application program control with HSI


access example. Application programs write directly to the
user data block output. The application program sets auto

194 - 6 WBPEEUI210504C0
C O N FIG U R ATIO N

A PP LIC ATIO N
C O N TRO L
DATA
EX PT
(1 94) AU TO M O D E
S1 ID DATA IN TE R LO C K
S2 IC ST D IS AB LE D
S3 IS

S PE C IFIC ATIO N S
S ET TO D E FAU LT
S ET TIN G S

A PP LIC ATIO N

U S ER D ATA_ X R _R E AD
APP LIC ATION

U S ER D ATA_X R _ W R IT E

B LO C K B LO C K E XC E P TIO N
DATA O U TPU T R E PO RT

C O N SO LE
M E SS AG E
T 01 9 27 A

Figure 194-2. Application Program Control with HSI Access

mode and disables the data interlock. HSI text string data is
accepted by the Harmony controller. The received HSI com-
mand information can be read by the application program but
it will not update to the block output unless it is explicitly writ-
ten there by the application program. The data of the block are
exception reported if the application program changes/
updates the block data or any of the writable block status
fields.

Figure 194-3 shows an application program control with HSI


access and echo example. The application program sets auto
mode and disables the data interlock. When auto/manual is
manual mode and the Harmony controller receives new user
data from the HSI, this information is placed in the block out-
put and is echoed back to the HSI. The exception report desig-
nates echoed information by setting an echo field. Application
programs can read the information sent from the HSI and
write to the block output. The exception report contains the
information from the last process, either HSI or application
program, which updated the block prior to its execution cycle.

WBPEEUI210504C0 194 - 7
The data of the block are exception reported if the application
program changes/updates the block data or any of the writ-
able block status fields.

C O N FIG U R ATIO N

A PP LIC ATIO N
C O N TRO L
DATA
EX PT
(1 94) AU TO M O D E
S1 ID DATA IN TE R LO C K
S2 IC ST D IS AB LE D
S3 IS

S PE C IFIC ATIO N S
S ET TO D E FAU LT
S ET TIN G S

A PP LIC ATIO N

U S ER D ATA_ X R _R E AD
APP LIC ATION

U S ER D ATA_X R _ W R IT E

B LO C K B LO C K E XC E P TIO N
DATA O U TPU T R E PO RT

C O N SO LE
M E SS AG E
T 01 9 28 A

Figure 194-3. Application Program Control with HSI Access and Echo

Figure 194-4 shows a block control example. A user defined


data import block output is the input. This input indicates to
the user defined data export block that it is under block con-
trol. HSI write access is not allowed since data interlock is
enabled. This block exception reports its information when sig-
nificant change of its output occurs.

Figure 194-5 shows a block control with HSI access example.


Information that is received from the HSI is placed in the block
output. The input block address must reference a valid user
data output block number. Accomplish this by pointing the
block at itself (set S1 to block output N). This block exception
reports its information when a significant change of its output
occurs.

194 - 8 WBPEEUI210504C0
C O N FIG U R ATIO N

B L O C K C O N T RO L
DATA
DATA IM P T E X PT
(1 9 3 ) S1 (1 9 4 )
ID
N S2
ST IC ST
S3 IS

S1 (3 5 ) AU T O
T D -D IG
N

S 2 = 0 (P U L S E O U TP U T ) S1
S 3 = 0 .0 0 0
S2 (6 5 )
S3 DSUM
N
S4
LOCK
1
1 S5 = 1 .0 0 0
S6 = 2 .0 0 0
S7 = 0 .0 0 0
S8 = 0 .0 0 0

U S ER -D E F IN E D
DATA IM P O RT
F U N C T IO N C O D E

AP P LIC ATIO N

BLOCK E XC E P TIO N
O U T PU T R E PO RT

T 01 92 9 A

Figure 194-4. Block Control Example

HSI - Text String Element


The text string element allows the operator to interact with an
application program running in a module. The user defined
data export function code in a module provides an interface
between the HSI and the program. At the HSI, a TEXTSTR tag
referencing a data export block in the module allows an opera-
tor at the HSI to interact with the function block. The data
export function block can also be driven by another function
block rather than directly by an application program.

The text string functionality provides, for example, a means to


prompt or question an operator and have the operator respond
to the prompt or question in some manner. The response may
be to make some type of selection, acknowledge an event or
provide an answer to a question. It can also be used to simply

WBPEEUI210504C0 194 - 9
C O N FIG U R ATIO N

B L O C K C O N T RO L
DATA
M A N UAL S 1
E X PT
0 S1 (1 9 4 )
0 UNLOC K S2 ID
(6 5 ) S2
S3 DSUM IC ST
N S3
S4 IS

S5 = 1 .0 0 0
S6 = 2 .0 0 0
S7 = 0 .0 0 0
S8 = 0 .0 0 0

AP P LIC ATIO N

BLOCK BLOCK E XC E P T IO N
DATA O U T PU T R E PO RT

C O N SO L E
M E SS AG E
T 01 9 30 A

Figure 194-5. Block Control with HSI Access

allow the operator, through descriptive text, to monitor and


verify the progress of a process routine.

The capabilities provided by the text string function are not


limited to the uses previously described. A batch program or C
language program executing in the module determines the
operations performed through the text string block and text
string element.

C Language Program
This example demonstrates how two C language programs,
running on two modules, residing in separate HCU modules,
can exchange data using function codes 193 and 194. The
data that are exchanged are an array of 16 floats (64 bytes in
size), which is exported from the module at 1-2-4, block
address 200. These data are then imported by the module at
1-3-4, block address 200.

The export module contains a function code 194 at block


address 200, and its C language program is as follows:
#include <xr_bufs.h>

194 - 10 WBPEEUI210504C0
float matrix[4][4]; /* array of 16 floats to export */
struct userdata_xr_buf xr; /* buffer for FC194 */
void main(void)
{
long int status;
short int row, col;
/* setup array of floats to some arbitrary values */
for(row=0; row<4; row++)
{
for(col=0; col<4; col++)
{
matrix[row][col] = row * col / 50;
}
}
/* setup FC194 buffer */
xr.data = (char *) matrix; /* point to floats */
xr.mask = DATA | QUALITY; /* set data and quality */
xr.quality = GOOD_QUALITY /* set quality good */
/* call export function at block 200 */
status = userdata_xr_write(200, &xr, sizeof(matrix));
/* program continues here... */
}

The import module contains a function code 193 at block


address 200, and its C program is:
#include <xr_bufs.h>
float matrix[4][4]; /* array of 16 floats to import */
struct userdata_xr_buf xr; /* buffer for FC193 */
void main(void)
{
long int status;
short int row, col;
/* setup FC193 buffer */
xr.data = (char *) matrix; /* point to floats */
xr.mask = READ_FROM_BLOCK_OUTPUT; /* set to read
FC193 */
/* call import function at block 200 */
status = userdata_xr_read(200, &xr, sizeof(matrix));
/* if return ok (64 bytes read), print values */
if (status == 64)
{
for(row=0; row<4; row++)
{
for(col=0; col<4; col++)
{

WBPEEUI210504C0 194 - 11
printf("Value (%d,%d): %f\n",
row, col, matrix[row][col]);
}
}
}
else
{
printf("Import error: %d\n", status);
}
}

The Symphony configuration for this example is shown in Fig-


ure 194-6.

SO U R C E BR C -10 0
AD D R ES S: 1-2-4
BL O C K 100 : F C 14 3
BL O C K 200 : F C 19 4

H AC F O R H C U 2

C O N T RO L N E TW O R K

H AC F O R H C U 3

IM P O RT BR C -100
AD D R ES S: 1-3-4
BL O C K 100 : F C 14 3
BL O C K 200 : F C 19 3 (IM P O RT IN G F R O M 1-2-4, BL O C K 200 )

T 02 02 1 A

Figure 194-6. Symphony Configuration Example

194 - 12 WBPEEUI210504C0
Auxiliary Real User Defined
Function Function Code 198

AU X The auxiliary real user defined function block defines addi-


R E AL tional real outputs, tunable parameters and inputs for a user
UDF
S1 (1 9 8 ) defined function block (function codes 191 and 192).
S2 N
S3 N+1 For more information regarding user defined functions, refer
S4 N+2 to the User Defined Function (UDF) Programming Lan-
S9 N+3
guage product instruction and the UDF - User Defined Func-
tion Configuration Language application guide.

Outputs

Blk Type Description


N R Real output
N+1 R Real output
N+2 R Real output
N+3 R Real output

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 1 Block address of any input
S2 N 2 I Note 1 Block address of any input
S3 N 2 I Note 1 Block address of any input
S4 N 2 I Note 1 Block address of any input
S5 Y 0.000 R Full Tunable real parameter
S6 Y 0.000 R Full Tunable real parameter
S7 Y 0.000 R Full Tunable real parameter
S8 Y 0.000 R Full Tunable real parameter
S9 N 0 I Note 1 Block address of next auxiliary UDF (0 ends link)
S10 Y 0.000 R Full Spare
S11 Y 0.000 R Full Spare
S12 Y 0.000 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

WBPEEUI210504C0 198 - 1
WBPEEUI210504C0
Auxiliary Digital User Defined
Function Function Code 199

AU X The auxiliary digital user defined function block defines addi-


D IG tional digital outputs, tunable parameters and inputs for a
UDF
S1 (1 9 9 ) user defined function block (function codes 191 and 192).
S2 N
S3 N+1 For more information regarding user defined functions, refer
S4 N+2 to the Batch 90 and User Defined Function (UDF)
S9 N+3
Programming Language Reference product instruction.

Outputs

Blk Type Description


N B Boolean output
N+1 B Boolean output
N+2 B Boolean output
N+3 B Boolean output

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 1 Block address of any input
S2 N 2 I Note 1 Block address of any input
S3 N 2 I Note 1 Block address of any input
S4 N 2 I Note 1 Block address of any input
S5 Y 0.000 R Full Tunable real parameter
S6 Y 0.000 R Full Tunable real parameter
S7 Y 0.000 R Full Tunable real parameter
S8 Y 0.000 R Full Tunable real parameter
S9 N 0 I Note 1 Block address of next auxiliary UDF (0 ends link)
S10 Y 0.000 R Full Spare
S11 Y 0.000 R Full Spare
S12 Y 0.000 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

WBPEEUI210504C0 199 - 1
WBPEEUI210504C0
Remote Transfer Module
Executive Block (INIIT12) Function Code 202

EX EC The remote transfer module executive (EXEC IIT) block func-


IIT tion code defines how the INIIT12 remote transfer module
(2 02 )
P0 ST
1 operates. It has a fixed block address of one (within the
P1 ST
S PA R E
2 INIIT12 module).
3
S PA R E
4
S PA R E Outputs
5
S PA R E
6
Blk Type Description
1 B Port 1 communication status:
0 = good
1 - with no alarm = error warning
1 - with alarm = port failed
2 B Port 2 communication status:
0 = good
1 - with no alarm = error warning
1 - with alarm = port failed
3 I Spare
4 I Spare
5 I Spare
6 I Spare

Specifications

Spec Tune Default Type Range Description


S1 N 0 I Full Port 1 transmission start delay after transmitter turned
on (msecs)
S2 N 0 I Full Port 1 transmitter turn off delay after transmission sent
(msecs)
S3 N 0 I Full Port 2 transmission start delay after transmitter turned
on (msecs)
S4 N 0 I Full Port 2 transmitter turn off delay after transmission sent
(msecs)
S5 N 200 I Full Port 1 maximum transmission duration (in msecs, half
duplex only)
S6 N 200 I Full Port 2 maximum transmission duration (in msecs, half
duplex only)
S7 N 60 I Full Port 1 communication status watchdog timer (secs)
S8 N 60 I Full Port 2 communication status watchdog timer (secs)

WBPEEUI210504C0 202 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S9 Y 12 I 1 - 12 Port 1 baud rate:
1 = 110 5 = 600 9 = 4,800
2 = 134.5 6 = 1,200 10 = 1,800
3 = 150 7 = 2,000 11 = 9,600
4 = 300 8 = 2,400 12 = 19,200
NOTE: The default baud rate can be selected by
switch settings in INIIT12 firmware revisions B.1 and
later.
S10 N 12 I 1 - 12 Port 2 baud rate. Same settings as S9.
S11 N 0 I 0-3 Port 1 data characteristics:
0 = 8 data bits, 1 stop bit, no parity
1 = 8 data bits, 1 stop bit, even parity
2 = 8 data bits, 1 stop bit, odd parity
3 = 8 data bits, 2 stop bits, no parity
S12 N 0 I 0-3 Port 2 data characteristics. Same settings as S11.
NOTE: Not used if port 2 enabled as diagnostic port
S13 N 0 I 0-1 Port 1 duplex mode:
0 = full duplex
1 = half duplex
S14 N 0 I 0-1 Port 2 duplex mode:
0 = full duplex
1 = half duplex
NOTE: Not used if port 2 enabled as diagnostic port
S15 N 1 I 0-4 Port 2 mode:
0 = port 2 not used or diagnostic port
1 = standby for port 1 (port 1 preferred)
2 = alternate to port 1 (either port acceptable)
3 = both ports used (one port is acceptable)
4 = both ports required (one port not
acceptable)
S16 N 10 I 0 - 100 Percent error rate used to calculate serial channel sta-
tus for the executive block digital outputs. Specification
S16 is used in conjunction with S7, S8, and S15 to
determine if a communication equipment failure has
occurred. Communication equipment failure may lead
to the action selected in S17.

202 - 2 WBPEEUI210504C0
Specifications (continued)

Spec Tune Default Type Range Description


S17 N 0 I 0-3 Action on communication equipment failure:
0 = no backup equipment available
1 = switch state of D03 (select alternate
equipment)
2 = switch to redundant module
S18 N 0 I 0-3 Exception reporting rate (time between scans):
0 = 2.00 secs
1 = 1.00 sec
2 = 0.50 sec
3 = 0.25 sec

Applications
Serial Data Channel Operation
Function code 202 is the executive block that contains the
specifications for serial data channel operation. The serial data
channels can operate in either half duplex or full duplex mode.
The RS-232-C serial ports are individually configurable.

Half Duplex Operation


Half duplex is the operation of a communication circuit in
which each end alternates as sender and receiver. At any
instant, electrical information flows in only one direction. The
direction of transmission (i.e., local to remote or remote to
local) alternates on the serial link. Therefore, the modem car-
rier and the transceiver transmitter section need to be enabled
before data can be transmitted. Additionally, the transmitter
needs to be disabled prior to shutting down the modem carrier
after the data transmission. Finally, the primary IIT module
may need to switch the antenna to the active transceiver. The
INIIR01 Remote Interface requires a digital output I/O module,
cabling, and a termination unit to switch external equipment
in the half duplex mode. The executive block provides specifi-
cations to control external communication equipment.

NOTE: The digital I/O module, cabling and termination unit are optional parts of
the IIR. The interface requires these optional parts for operation in half duplex
mode when switching external equipment is required and in applications using
redundant external communication equipment (Fig. 202-1).

WBPEEUI210504C0 202 - 3
S9 through S14 The executive block enables the IIT module to handle various
types of communication equipment. Setting S13 (channel one)
or S14 (channel two) to one enables half duplex mode. Specifi-
cations S9, S10, S11 and S12 select the transmission rate
(baud), type of parity (odd or even), and number of stop bits.

The IIT module uses the request to send (RTS) signal to control
the modem carrier. Most modems have, or may be configured
to have, a carrier turn-on delay. A carrier turn-on delay pro-
vides an additional delay between the receipt of the RTS signal
and the activation of the clear to send (CTS) signal. The IIT
module must receive the CTS signal from the modem before it
starts to transmit data.
S1 through S6 The RTS output of the serial port keys the modem carrier. A
digital I/O module output keys the transmitter carrier. The
digital output enables the transmitter carrier to be keyed ON
prior to the data transmission, and keyed OFF prior to turning
off the modem carrier. Specifications S1, S2, S3 and S4 set
delays. Specifications S1 and S3 decide the carrier turn-on
delay. Specifications S2 and S4 set the delay between dropping
the transmitter carrier and dropping the modem carrier. Spec-
ifications S5 and S6 allow setting limits on the duration of the
transmission. These specifications insure that each side of the
INIIR01 Remote Interface has an opportunity to originate a
message of its own. Figure 202-1 shows the timing of external
equipment enable signals for half duplex operation.

Figure 202-2 illustrates redundant INIIT12 modules with con-


trol of external equipment in half duplex operation. Table
202-1 lists the possible specification settings for the EXEC IIT
block for the configuration in Figure 202-2.

Full Duplex Operation


S9 through S14 Full duplex is the operation of a communication circuit in
which each end of the serial link can simultaneously send and
receive. There is no need to alternate the direction of transmis-
sion as in half duplex mode. Setting S13 (channel one) or S14
(channel two) to zero enables full duplex mode. Specifications
S9, S10, S11 and S12 select the baud rate, type of parity and
number of stop bits.

Figure 202-3 illustrates the INIIT12 module using dual chan-


nel, full duplex operation. Table 202-2 lists possible

202 - 4 WBPEEUI210504C0
TIM IN G AT LO C A L IN IIT 12
S1 TR A N S M IT S2 S1 R E C EIV E S2
D E L AY M E SS AG E D E L AY D E L AY M E SS AG E D E L AY
Tx Tx TxT xTx Tx R x R xR x R xR x R x
0 TIM E
RT S A S SE RT ED (D TE M O D E ) RT S IN H IB ITE D (D T E M O D E)
S ET D O 4 R E SE T D O 4

TR A N S M ITTE R EN AB L ED

M O D E M C A R R IER E N A BL E D

TIM IN G AT R EM OTE IN IIT 12


R E C EIV E TR A N S M IT
S2 S1 S2
M E SS AG E M E SS AG E
D E L AY D E L AY D E L AY
R x R xR x R xR x R x Tx Tx TxT xTx Tx
0 TIM E
RT S A S SE RT ED (D TE M O D E ) RT S IN H IB ITE D (D T E M O D E)
S ET D O 4 R E SE T D O 4

TR A N S M ITTE R EN AB LED

M O D E M C A R R IER E N A BL E D
T 02 3 43 A

NOTE: To assure proper timing, function code 202 specifications related to serial channel operation (S1 through S14) must be set
the same in both local and remote IIT modules.

Figure 202-1. Timing Diagram of Enable Signals in Half Duplex Mode

P R IM ARY S EC O N DA RY

IN N IS 01 IN IIT12 IM D S O 14 IN N IS 01 IN IIT12 IM D S O 1 4

A N TE N N A
S EL E C T
S W IT C H

N K TU 01

N K TU 01 N K TU 01 DO3
K EY S EC O N DA RY
N T D I01 DO4 TR A N S C EIV E R

DO3
N K TU 01 K EY P R IM ARY
N T D I01 DO4
TR A N S C EIV E R

R S -2 32-C
N T M P 01 MODEM

T 02 34 4 A

Figure 202-2. Redundant IINIT02 with Control of External Equipment in Half Duplex Operation

WBPEEUI210504C0 202 - 5
Table 202-1. Settings for Figure 202-2 Configuration

Spec Value Description


S1 10 Port 1 transmission start delay after transmitter is turned on (msecs). Value varies
according to transmitter used.
S2 10 Port 1 transmitter turn off delay after transmission is sent (msecs). Value varies
according to transmitter used.
S3 0 Port 2 is not used in this example.
S4 0 Port 2 is not used in this example.
S5 200 Port 1 maximum transmission duration (msecs). 200 msecs is a compromise
between maximum throughput (high value) and minimum response time (low
value).
S6 200 Port 2 is not used in this example.
S7 60 Port 1 communication status watchdog timer (secs). 60 secs is a compromise
between rapid failover to the backup module, and protection against momentary
interruptions leading to failover.
S8 60 Port 2 is not used in this example.
S9 6 Port 1 baud rate (1200). Must match the modem baud rate.
S10 0 Port 2 is not used in this example.
S11 2 Port 1 data characteristics (8 data bits, 1 stop bit, odd parity). Must match the
modem capabilities.
S12 0 Port 2 is not used in this example.
S13 1 Port 1 is set to half duplex mode.
S14 0 Port 2 is not used in this example.
S15 0 Port 2 is not used in this example. Setting S15 to 0 insures that the unused port 2 is
not reported as failed by block output 2 (executive block output for port 2 status).
S16 10 Percent error rate used to calculate serial channel status for the channel 1 execu-
tive block digital output. Specification S16 is also used in conjunction with S7 to set
the serial channel 1 status bit in the module status. Specification S16 is also used
in conjunction with S7 and S15 to determine if a communication equipment failure
has occurred. Communication equipment failure may lead to the action selected in
S17.
S17 3 Action on communication equipment failure. Action 3 specifies that the primary and
secondary IIT modules swap states when a communication failure occurs. In this
example, this action brings the secondary IIT module to primary. The new primary
IIT module uses the secondary transceiver. The secondary transceiver connects to
the antenna if the equipment select output (SW4, pole 3) is set differently on the
two IIT modules.
S18 2 Exception reporting rate. The database is scanned for exceptions reported across
the serial link or the Cnet loop every half second.

202 - 6 WBPEEUI210504C0
specification settings for the remote transfer module executive
block for this configuration.

IN IIT 12 IN N IS 01

N K TU 0 1

CHANNEL 1
MODEM T R AN S C EIVER

N T M P 01 R S -2 3 2 -C

CHANNEL 2
MODEM T R AN S C EIVER

T 02 3 45 A

Figure 202-3. Dual Channel in Full Duplex Operation

Table 202-2. Settings for Figure 202-3 Configuration

Spec Value Description


S1 0 Not used in full duplex mode.
S2 0 Not used in full duplex mode.
S3 0 Not used in full duplex mode.
S4 0 Not used in full duplex mode.
S5 200 Not used in full duplex mode.
S6 200 Not used in full duplex mode.
S7 60 Port 1 communication status watchdog timer (secs). 60 secs is a compromise
between rapid reporting of channel failure, and filtering out momentary commu-
nication problems.
S8 60 Port 2 communication status watchdog timer (secs). 60 secs is a compromise
between rapid reporting of channel failure, and filtering out momentary commu-
nication problems.

WBPEEUI210504C0 202 - 7
Table 202-2. Settings for Figure 202-3 Configuration (continued)

Spec Value Description


S9 12 Port 1 baud rate (19.2K). Must match modem baud rate.
S10 12 Port 2 baud rate (19.2K). Must match modem baud rate.
S11 0 Port 1 data characteristics (8 data bits, 1 stop bit, no parity). Must match the
modem capabilities.
S12 0 Port 2 data characteristics (8 data bits, 1 stop bit, no parity). Must match the
modem capabilities.
S13 0 Port 1 is set to full duplex mode.
S14 0 Port 2 is set to full duplex mode.
S15 3 Port 2 mode is set to 3 which indicates that both port 1 and port 2 are used for
data communications and that failure of a single channel does not cause the
communication failure action (S17).
S16 10 Percent error rate used to calculate serial channel status for the executive block
digital outputs. Specification S16 is used in conjunction with S7, S8 and S15 to
determine if a communication equipment failure has occurred. Communication
equipment failure may lead to the action selected in S17.
S17 0 Action on communication equipment failure. Action specifies that no backup
module or equipment exists on communication failure. The module resets itself
and attempts to establish communication.
S18 2 Exception reporting rate. The database is scanned for exceptions reported
across the serial link or the Cnet loop every half second.

Serial Line Quality Management


S16 The INIIT12 module continuously monitors the quality of the
serial links. Specification S16 is the percent error rate used to
decide the status of serial channels. Specification S16 is used
in conjunction with S7 and S8 to determine that a serial chan-
nel has failed. When the percentage of messages with errors
exceeds this value for a number of seconds exceeding the S7
value for channel one or the S8 value for channel two, then the
channel is considered unusable (failed). When a channel is
considered unusable, a channel failure bit is set in the module
status, and depending on the setting of S15, the action
selected in S17 may be performed.

Specification S16 is also used in the calculations for serial


channel quality reported in the INIIT12 executive block digital
outputs. These digital outputs are updated every second. If the
percentage of messages with errors on a serial channel
exceeds the S16 value (high error rate threshold), then the

202 - 8 WBPEEUI210504C0
digital block output for that channel will be one with alarm. If
the percentage of messages with errors on a serial channel
exceeds one fifth of the S16 value (low error rate threshold),
then the digital block output for that channel will be one with
no alarm. Otherwise, the digital block output for that channel
will be zero with no alarm.
S7 and S8 A serial channel is unusable when it fails for a period of time
longer than the communication status watchdog timer. Speci-
fications S7 (channel one) or S8 (channel two) sets the commu-
nication watchdog timer. When a channel is considered
unusable, the serial channel status bit in the module status is
set, and the action selected by S17 can be invoked.
S15 and S17 Select the action taken by the IIT module when one or both
serial channels are unusable. S15 determines the role of serial
port two and sets the necessary conditions for communication
equipment failure. Depending on the setting of S15, either a
single channel failure or a dual channel failure constitutes
communication equipment failure. For example, there is a
communication equipment failure when:

1. S15 option is 1, 2 or 3 and both channels fail.

or

2. S15 option is 0 or 4 and one channel fails.

If a communication equipment failure occurs, the primary


module will carry out the action selected in S17. The module
resets itself if the S17 option is zero. If S17 option is one, and
the (optional) digital output I/O module is installed, then digi-
tal output three will be toggled. If S17 option is two, and a
backup module is available, then the primary INIIT12 module
goes into secondary mode and the secondary module goes into
primary mode. The primary INIIT12 module continuously
attempts to establish communication on failed serial ports. If
SW4 pole four is set to one enabling port two to be used as a
diagnostic port, then the INIIT12 module will act as if the S15
option is zero.

WBPEEUI210504C0 202 - 9
WBPEEUI210504C0
Sequence of Events Slave
Function Code 210

SO E /S The sequence of events slave function code (SOE/S) provides


(2 1 0 )
S39
SNR E LF the ability to define up to 32 digital inputs and time-stamp
S40 N
S41
SUR
N+1 those inputs in sequence of events order with a resolution of
N /A
N+2 one millisecond. The digital inputs are accessible via human
N+3
system interfaces (HSIs). Only one SOE/S function code can
N+4
N+5 be defined in a module. Two IMDSI12 or IMDSI22 modules
N+6 provide the inputs.
N+7
N+8 NOTE: This function code is supported only on the BRC-100 and the
N+9
N+10
IMMFP11/12 controllers.
N+11
N+12 The SOE/S function code is similar to the sequence of events
N+13 log (SOELOG, function code 99). Like the SOELOG block, the
N+14
N+15
SOE/S block logs data. Advantages to using the SOE/S block
N+16 over the SOELOG block are:
N+17
N+18 1. The SOE/S block does not require the sequential events
N+19
recorder. The SOE/S block only requires two IMDSI02 digital
N+20
N+21 input slave modules and one master module.
N+22
N+23 2. The SOE/S block provides a means to use parallel inputs.
N+24
N+25 Function code 99, the SOELOG block, should be used when
N+26
N+27
more than 32 inputs are required.
N+28
N+29 NOTE: CPU utilization is time critical, causing an increase in CPU overhead.
N+30
N+31 Outputs
N+32
N+33 Blk Type Description
N+34
CST
N+35 N B Events logged flag:
0 = no
1 = yes
N+1 B Current value and quality of input 1
N+2 B Current value and quality of input 2
N+3 B Current value and quality of input 3
N+4 B Current value and quality of input 4
N+5 B Current value and quality of input 5
N+6 B Current value and quality of input 6
N+7 B Current value and quality of input 7

WBPEEUI210504C0 210 - 1
Outputs (continued)

Blk Type Description


N+8 B Current value and quality of input 8
N+9 B Current value and quality of input 9
N+10 B Current value and quality of input 10
N+11 B Current value and quality of input 11
N+12 B Current value and quality of input 12
N+13 B Current value and quality of input 13
N+14 B Current value and quality of input 14
N+15 B Current value and quality of input 15
N+16 B Current value and quality of input 16
N+17 B Current value and quality of input 17
N+18 B Current value and quality of input 18
N+19 B Current value and quality of input 19
N+20 B Current value and quality of input 20
N+21 B Current value and quality of input 21
N+22 B Current value and quality of input 22
N+23 B Current value and quality of input 23
N+24 B Current value and quality of input 24
N+25 B Current value and quality of input 25
N+26 B Current value and quality of input 26
N+27 B Current value and quality of input 27
N+28 B Current value and quality of input 28
N+29 B Current value and quality of input 29
N+30 B Current value and quality of input 30
N+31 B Current value and quality of input 31
N+32 B Current value and quality of input 32
N+33 B First I/O module status:
0 = good
1 = bad
N+34 B Second I/O module status:
0 = good
1 = bad
N+35 R Composite sequence of events status:
0.0 = no error
1.0 = sequence buffer overflow
2.0 = time sync processed

210 - 2 WBPEEUI210504C0
Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 63 First expander bus module address
S2 N 0 I 0 - 63 Second expander bus module address
S3 N 4 I 1 - 32 Sequence buffer size (kbytes)
S4 N 256 I 1 - 3500 Event buffer size (no. of events)
S5 N 180 I 1 - 32767 Age of event data before discarded from buffer (in secs)
S6 N 0 I 0 - 63 Input 1 qualifier
S7 N 0 I 0 - 63 Input 2 qualifier
S8 N 0 I 0 - 63 Input 3 qualifier
S9 N 0 I 0 - 63 Input 4 qualifier
S10 N 0 I 0 - 63 Input 5 qualifier
S11 N 0 I 0 - 63 Input 6 qualifier
S12 N 0 I 0 - 63 Input 7 qualifier
S13 N 0 I 0 - 63 Input 8 qualifier
S14 N 0 I 0 - 63 Input 9 qualifier
S15 N 0 I 0 - 63 Input 10 qualifier
S16 N 0 I 0 - 63 Input 11 qualifier
S17 N 0 I 0 - 63 Input 12 qualifier
S18 N 0 I 0 - 63 Input 13 qualifier
S19 N 0 I 0 - 63 Input 14 qualifier
S20 N 0 I 0 - 63 Input 15 qualifier
S21 N 0 I 0 - 63 Input 16 qualifier
S22 N 0 I 0 - 63 Input 17 qualifier
S23 N 0 I 0 - 63 Input 18 qualifier
S24 N 0 I 0 - 63 Input 19 qualifier
S25 N 0 I 0 - 63 Input 20 qualifier
S26 N 0 I 0 - 63 Input 21 qualifier
S27 N 0 I 0 - 63 Input 22 qualifier
S28 N 0 I 0 - 63 Input 23 qualifier
S29 N 0 I 0 - 63 Input 24 qualifier
S30 N 0 I 0 - 63 Input 25 qualifier
S31 N 0 I 0 - 63 Input 26 qualifier
S32 N 0 I 0 - 63 Input 27 qualifier
S33 N 0 I 0 - 63 Input 28 qualifier

WBPEEUI210504C0 210 - 3
Specifications (continued)

Spec Tune Default Type Range Description


S34 N 0 I 0 - 63 Input 29 qualifier
S35 N 0 I 0 - 63 Input 30 qualifier
S36 N 0 I 0 - 63 Input 31 qualifier
S37 N 0 I 0 - 63 Input 32 qualifier
S38 N 4 I 2 - 16 Debounce time (msecs)
S39 N 5 I Note 1 Block address of snapshot request
S40 N 0 I Note 1 Block address of summary request
S41 N 0 I Note 1 Spare boolean input
S42 Y 0.000 R Full Spare parameter
S43 N 0 I Full Spare parameter
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

Explanation
Outputs
N Shows the current state of the event buffer. A one indicates
event data is present in the event buffer. A zero indicates that
all event data is out of the event buffer.
N+1 through N+32 Show the current value and quality of the digital inputs on the
sequence of events module. A bad quality signal occurs when
the expander bus module does not respond.

Inputs one through 16 are associated with the I/O module


specified by S1 and inputs 17 through 32 are associated with
the I/O module specified by S2.

The input qualifier (S6 through S37) defines the alarm state
for each block output for each associated input.
N+33 and N+34 The I/O module status outputs are logic 0 when the I/O mod-
ules respond, and logic 1 when the modules do not respond.
Output N+33 corresponds to the module specified by S1 and
output N+34 corresponds to the module specified by S2.

0.0 = no error
1.0 = sequence buffer overflow
2.0 = time sync processed

210 - 4 WBPEEUI210504C0
N+35 Provides the SOE/S block internal status bits. The bits com-
bine to an integer value, then convert to a real number.

Specifications
S1 Expander bus module address of the digital input module
associated with the inputs one through 16 (S6 through S21).
Valid addresses are zero through 63.
S2 Expander bus module address of the digital input module
associated with the inputs 17 through 32 (S22 through S37).
Valid addresses are zero through 63. If the second module is
not used, S2 must be set the same as S1.
S3 Sequence buffer size in one kilobyte increments. The buffer
saves the one millisecond input data for processing by the
function code. The function code converts the input data to
event data when it runs in its configured segment. Therefore,
the minimum size of this buffer directly relates to the maxi-
mum scan period for the segment. Calculate the minimum
buffer size as follows:

[ ( period in secs × 1000 × 8 ) + 1024 ]


Size = ----------------------------------------------------------------------------------------------
1024

NOTE: The real value can be truncated to give the integer value.
S4 Number of events that will fit in the buffer. Calculate the event
buffer size as follows:
Size = 9 × (S3 +1)

S5 Maximum age in seconds of the event data in the buffer. After


data has been in the buffer this length of time, it is removed
from the event buffer.

Specifications S4 and S5 are closely related to the HSI configu-


ration. These parameters control the amount of data that the
HSI can receive when a trip occurs. Once the maximum age
(S5) is reached, the data is erased. Therefore, the HSI must be
configured to provide a data transfer rate that is fast enough to
remove the event data from the buffer before the maximum age
(S5) is reached.
S6 through S37 Describe the input point. The quality state of the input is bad
when the expander bus module is not responding.

WBPEEUI210504C0 210 - 5
Value Description
0 Undefined point
1 Normally open (NO) point, off-scan
2 Normally closed (NC) point, off-scan
3 NO point, on-scan
4 NC point, on-scan
NOTE: NO point alarm level = logic 1 and NC point alarm level = logic 0.

S38 Time period that an input must remain in a steady state before
it can be considered a valid state change, specified in millisec-
onds. The configured debounce time qualifies all 32 inputs.
S39 Snapshot time. A constant real input value inhibits this func-
tion. When the integer portion of the real input changes, a
snapshot of the defined on-scan points is generated. The cur-
rent value and alarm state reports for each point that is
on-scan. Practical inputs to S39 may be the system time or a
pushbutton.
S40 Block address of the summary request. The transition of the
block input from logic 0 to logic 1 initiates a summary of the
32 inputs. All points in alarm or off-scan are reported.
S41, S42 and S43 Spare.

210 - 6 WBPEEUI210504C0
Data Acquisition Digital
Function Code 211

DAD IG The data acquisition digital (DADIG) function code and the
(2 1 1 )
S1 IN -S E L DADIG I/L (function code 212) pair are used for boolean data
S2
S3
IN -P M T ST acquisition functions. The DADIG and DADIG I/L function
P R I-IN
S4 A LT-IN
codes complement the data acquisition analog (DAANG) and
S13 S U P -IN the data acquisition analog I/L (DAANG I/L) function codes by
S14
S15
Q UA L -OV providing the function of the DAANG block for boolean signals.
LT C H -E N
S16 X R -R E Q
The DADIG function code pair provides a means to accomplish
S19 S PA R E a number of unique data acquisitions, alarm detections and
management functions related to boolean logic signals imple-
mented in Symphony systems.

The DADIG function codes support a range of features on a


human system interface (HSI). Commands are accepted from
HSIs and alarm information is supplied to HSIs through
exception reports. The DADIG I/L function code provides a
means of importing data from the DADIG block in Symphony
systems.

Outputs

Blk Type Description


N B Reported logic state
N+1 R Extended status

Specifications

Spec Tune Default1 Type Range Description


S1 N 5 I Note 2 Block address of input select
S23 N 0 I Note 2 Block address of permit input select
S3 N 0 I Note 2 Block address of primary input
S4 N 0 I Note 2 Block address of alternate input
S5 N 0 B 0 or 1 Custom inserted value
S63 Y 0.000 R Full Input conditioning mode control
S7 Y 0.000 R Full Input conditioning time reference (secs)
S8 Y 0.000 R Full Input conditioning digital filter count reference
3
S9 Y 0.000 R Full Alarm mode control
S10 Y 0.000 R Full Alarm time reference (secs)

WBPEEUI210504C0 211 - 1
Specifications (continued)

Spec Tune Default1 Type Range Description


S11 Y 0.000 R Full Alarm digital filter transition count reference
S12 Y 0.000 R Full Return alarm/de-alarm time period reference (secs)
S13 N 0 I Note 2 Block address of alarm suppress enable
S14 2 N 5 I Note 2 Block address of quality override input
S15 N 0 I Note 2 Block address of alarm state latch enable
S16 N 0 I Note 2 Block address of exception report request
S17 N 0 I 0 - 255 Type code
S18 Y 0.000 R Full Spare
S19 N 0 I Note 2 Spare block input
S20 Y 0 I Full Spare
NOTES:
1. Values reported for specifications that have been adapted will be invalid.
2. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
3. The addressed block's output value is converted to a hexadecimal value.

Explanation
The DADIG block has two block outputs. The first output is
the reported logic state and propagates one of three possible
input signals. A tunable specification selects which input is
routed to the output and processed for alarm detection. The
second output is the extended status (internal quality, status,
state and mode) of the function code. The DADIG block allows
this quality state to be overridden through a block input.

The DADIG block supports exception reporting. Exception


reports provide HSIs with alarm and function code status
information through exception reports. Additional capabilities
such as suppression and forced requests of exception reports
are available through block inputs and tunable specifications.

An option allows the input to be conditioned using one of four


input conditioning modes. This option provides the ability to
select the conditioned input or the unconditioned input to be
the input for the alarm.

The DADIG block supports a number of alarm detection


modes. These alarm detection modes allow the selection of
various parameters to determine an alarm output. The input
state or a transition to be interpreted as an alarm can be

211 - 2 WBPEEUI210504C0
specified. Several timing parameters, such as the length of
time the input has to remain at the alarm state before the
block generates an alarm, fixed duration of the alarm, maxi-
mum duration of the alarm and de-alarm/return alarm time
are programmable. The DADIG also provides digital alarm fil-
tering capabilities and the ability to suppress alarms.

The DADIG block provides a latch option. Changes to the


reported logic state and extended status can be latched and
held based on the occurrence of an alarm. If time-stamping is
enabled, the time value will also be latched when the outputs
are latched.

The DADIG function code accepts commands from a HSI as


well as from input signals. HSI commands are accepted for
input selection, enabling and disabling exception reporting,
forcing exception reports, setting the extended status alarm
latch, and for enabling and suppressing alarms.

The DADIG function code retains information in NVRAM after


a reset, mode change or power interruption such as:

• Selected input.
• Exception report enable and disable state.
• Alarm suppression indication.

Figure 211-1 shows how the functions execute within the


DADIG block. The process is executed by the function block in
this order:

1. Get the control information from the block input or HSI


command.

2. Retrieve the selected input value.

3. Execute the input conditioning, if enabled.

4. Execute the alarm processing using the raw input or the


conditioned input, if enabled.

5. Process return alarm or process de-alarm, if enabled.

6. Suppress alarms, if alarm suppression is enabled.

7. Process quality override states.

8. Execute extended status alarm latch processing, if


enabled.

WBPEEUI210504C0 211 - 3
9. Update the block output value and status.

10. Execute exception report processing, if enabled.

P R IM ARY
A LTE R N ATE IN P U T IN P U T A LAR M Q UA LITY LATC H E XC E P TIO N R LS
U S ER S ELE C T C O N D ITIO N IN G P RO C ES S IN G OV E R R ID E P RO C ES S IN G R E PO RTIN G ES

S ELE C T
P ER M IS S IVE

C O N TRO L
TIM E
CO UNT

C O N TRO L
TIM E
CO UNT
R E /D E TIM E
S U PP R E S S

OV E R R ID E

E N AB LE

R E Q U E ST
CO DE T 01 9 37 A

Figure 211-1. Functions Executed within the DADIG Block

Specifications
S1 Block address of the input select control. The input select con-
trol determines which of the three possible inputs to the
DADIG block will be output. The last valid selection is saved in
NVRAM and is stored on a reset or mode change. All change
requests (logic and HSI) are locked out during module startup.
Figure 211-2 shows the input selection logic.

Care should be exercised to properly control the permit input


select <S2> to enable or disable changes. The input select
parameter can be altered by either module configured logic
(output of addressed block) or command messages from a HSI
or computer. The input select tracks the last valid selection
value from either source when <S2> is true. The value of <S1>
is converted to a hexadecimal number and the bits are mapped
as shown in Table 211-1.

To program <S1>, add the values listed in the binary weighted


value column of Table 211-1 to the resulting sum and enter
this value for <S1>. For example, if the custom inserted input
is selected and the block is in no report mode, S1 would be set
to 2+128 or 130.

211 - 4 WBPEEUI210504C0
P R IM ARY

A LTE R N ATE

C U S TO M

P ER M IT IN P U T S E L EC T

IN P U T S EL E C T

C O N SO L E IN P U T S E L EC T
T 01 9 38 A

Figure 211-2. Input Selection Logic

Table 211-1. S1 Status Bit Map

Bit Binary Value Attribute


0-1 Refer to 0 0 Select primary input value <S3>
Table 1 1 Select primary input value <S3>
211-2
2 2 Select custom inserted input value S5
1+2 3 Select alternate input value <S4>
2 4 Spare
3 8 Spare
4 16 Spare
5 32 Spare
6 64 Spare
7 128 Exception reporting mode:
0 = report mode
1 = no report mode
8 - 15 – Spare

The bit column is separated by function and some functions


use multiple bits. Only one attribute option can be selected for
that function. For example, only one attribute can be selected
for bits zero and one (only one block input can be selected).
Table 211-2 lists the valid combinations for <S1>.

When the harmony controller is in execute mode and a transi-


tion takes place on the input select (bits zero and one), the new
input value and status are selected. The three input states can

WBPEEUI210504C0 211 - 5
Table 211-2. Valid Combinations for S1

Binary Value Result


0 or 1 Primary input selected, on report mode (default)
2 Custom inserted state selected, on report mode
3 Alternate input selected, on report mode
4 - 127 Not valid
128, 129 Primary input selected, no report mode
130 Custom inserted state selected, no report mode
131 Alternate input selected, no report mode
≥132 Not valid

also be selected from the HSI. A new transition on the input


control cancels any pending HSI request. Input selects (bits
zero and one) and HSI requests are ignored during module
startup.

The DADIG block mode (selected input, no report state, and


alarm suppression indication state) is defined during module
startup based on the saved mode. The saved mode is initialized
to primary input selected, report mode, alarm suppression
false, when the block is added. After startup (the module is put
in execute mode), the mode updates when <S1> changes or a
HSI command is received. However, changes to <S1> and HSI
commands will be ignored during module startup. This pre-
vents a transition of the block modes when startup is com-
plete. Therefore, any changes to <S1> during configuration
mode will have no effect on the block modes.

NOTE: The state of <S1> may not agree with the mode. For example, when
changes are made in configure mode, <S1> will not agree with the block's
mode in execute mode. Also, a HSI command can change the block's mode.
Thus, <S1> may not agree with the block's mode.

The report/no report bit (bit seven) is reported once when it is


set through an exception report. It then disables exception
report updates after being sent. The HSI can also request a
point to be in report or no report mode. A force exception
report update command can be issued by the HSI to cause a
point to be updated even when it is set for no report. This fea-
ture allows the point value to be updated without putting it
back in report mode. The block outputs (N and N+1) for a block
in no report continue to update. The current report/no report

211 - 6 WBPEEUI210504C0
state of the input is saved in NVRAM as part of the blocks
mode and is stored on a reset or mode change. All report/no
report requests (logic and HSI) are locked out during module
startup.
S2 Block address of the permit input select. When the output of
the block addressed by this specification is a logic 1, change of
input selection from either configured module logic to <S1>
bits zero and one or the HSI commands will change the
selected input source. When <S2> equals zero, requests for
input select mode changes from any source are ignored (locked
out). The lock prevents changes in the selected input after
startup testing when using the DADIG block for a control func-
tion. Table 211-3 shows the permit input bit map.

Table 211-3. Permit Input Bit Map

<S2> Function
0 Disable/lock input selection
1 Allow input to be selected from HSI or <S1>

S3 Block address of the primary input to be monitored by the


DADIG block. The reported logic level (N) will equal this level
when the input select control is in select primary input mode
(<S1> equals zero or 128) and a boolean argument (zero or
one) is present at the block addressed by <S3>.
S4 Block address of the alternate input to be monitored by the
DADIG block. The reported logic level (N) will equal this level
when the input select control is in a select alternate input
mode (<S1> equals three or 131) and a boolean argument (zero
or one) is present at the block addressed by this specification.
S5 Custom inserted input. The reported logic level (N) will equal
this level when the input select control is in a select custom
input mode (<S1> equals two or 130) and a boolean argument
(zero or one) has been input to this specification.
S6 Input conditioning mode control value. This specification
defines the type of conditioning performed on the selected
input. This real input value is converted into a hexadecimal
number and the bits are mapped as shown in Table 211-4.
Figure 211-3 shows the input conditioning logic.

To program this specification, the values listed in the binary


weighted value column of the desired functions are added and

WBPEEUI210504C0 211 - 7
Table 211-4. Selected Input Bit Map

Binary
Bit Attribute
Value
0 1 Input reference state. The specified input conditioning criteria will be applied to the
input when the selected input enters the state defined by bit 0.
1-3 — 2 Pulsed mode; generate an output pulse of the state defined by bit 0 for the
time period specified by S7 when selected input goes into the state defined by
bit 0.
4 Timed out mode; generate an output pulse of the state defined by bit 0 if the
selected input goes into the state defined by bit 0 for a time period greater than
or equal to the time defined by S7.
6 Timing mode; generate an output pulse of the state defined by bit zero for
maximum time period defined by S7 if the selected input goes into the state
defined by bit 0.
8 Input digital filter; generate and maintain a pulse of the state defined by bit 0 if
the selected input transitions into and out of the state defined by bit 0 a num-
ber of times greater than or equal to S8 over a time period less than or equal to
the value defined by S7.
4 - 15 — Spare.

the resulting sum is the value to be entered. For example, if


the input reference state is a one and the desired mode is the
timing mode, the value entered for this specification would be
6+1 or 7.

The bit column is separated by function and some functions


use multiple bits. Only one attribute option can be selected for
those functions. For example, only one attribute can be
selected for bits one through three. Only one input condition-
ing mode can be selected. Table 211-5 lists the valid combina-
tions for S6.

Pulse Mode
In pulse mode, an output pulse of the input reference state
(S6, bit zero) occurs for a specified amount of time (S7) when
the selected input matches the input reference state (S6, bit
zero). After the time specified by S7, the output pulse is
negated for a minimum of one scan cycle before the next pulse
will be generated. The output pulse duration S7 and the input
reference state (S6, bit zero) are tunable values. Figure 211-4
shows the output and the input when operating in pulse
mode.

211 - 8 WBPEEUI210504C0
0

IN P U T 1 P U LSE
MODE

TIM E D O U T
3 MODE
O U TPU T

4
TIM IN G
MODE

IN P U T
C O N D ITIO N IN G D IG ITAL
M ODE
C O N TRO L FILT ER
S TATE R EF ER E N C E MODE

TIM E R EF ER E N C E
C O U N T R E FE R EN C E
T 01 9 39 A

Figure 211-3. Input Conditioning Logic

Table 211-5. Bits 0 and 1 Valid Combinations for S6

Value Result
0 Input conditioning disabled (default)
1 Not valid
2 Pulse mode, logic 0 reference
3 Pulse mode, logic 1 reference
4 Timed out mode, logic 0 reference
5 Timed out mode, logic 1 reference
6 Timing mode, logic 0 reference
7 Timing mode, logic 1 reference
8 Digital filter mode, logic 0 reference
9 Digital filter mode, logic 1 reference
≥10 Not valid

In pulse mode, the output pulse duration S7 is independent of


how long the input stays in the reference state. Each pulse is
also negated for a minimum of one scan cycle (time ts) before
being asserted. The input is not sampled again until after
S7 +ts (pulse two is ignored). At the end of this time period, the
input is sampled again and another pulse generated when the

WBPEEUI210504C0 211 - 9
1 2 3 4
R E FE R EN C E
STATE

IN P U T

ts ts
S7 S7 S7

O U T PU T T 01 94 0 A

Figure 211-4. Pulse Mode Input and Output

input matches the input reference state. Pulse three generates


a pulse and pulse four generates multiple output pulses.

Timed Out Mode


In the timed out mode, an output pulse of the input reference
state (S6, bit zero) occurs when the selected input matches the
input reference state (S6, bit zero) for a specified amount of
time specified by S7. The pulse remains asserted until the
input goes out of the input reference state (S6, bit zero). The
input reference state (S6, bit zero) and reference match time
S7 are tunable values. Figure 211-5 shows the input and the
output when operating in timed out mode.

R E FE R EN C E
STAT E

IN P U T
ta
S7

O U T PU T
S7 < t a
T 01 9 41 A

Figure 211-5. Input Pulse Greater than Reference Match Time

211 - 10 WBPEEUI210504C0
When the reference match time S7 is longer than the input
pulse duration (time ts), the output will not be asserted. Figure
211-6 shows the input and the unasserted output.

R E FE R EN C E
STAT E

IN P U T
ta

S7

O U T PU T
S7 > t a T 01 9 42 A

Figure 211-6. Input Pulse Less than Reference Match Time

Timing Mode
In the timing mode, an output pulse of input reference state
(S6, bit zero) occurs for a specified maximum period of time S7
when the selected input matches the input reference state (S6,
bit zero). The input reference state and maximum pulse dura-
tion are tunable values. If the maximum pulse duration is
defined as longer than the input pulse exists (time ts), the out-
put pulse remains until the input is recognized to no longer
match the input reference state (output tracks the input). Fig-
ure 211-7 shows the output tracking the input.

R E FE R EN C E
STATE

IN P U T
ta
S7

R E FE R EN C E
STAT E

O U TPU T
S7 > t a T 01 9 43 A

Figure 211-7. Input Pulse Less than Maximum Pulse Width

WBPEEUI210504C0 211 - 11
If the input pulse duration is longer than the specified period
of time S7, the output negates after the specified time period.
Figure 211-8 shows the negated output.

R E FE R EN C E
STAT E

IN P U T
ta
S7

R E FE R EN C E
STAT E

O U T PU T
S7 < t a T 01 9 44 A

Figure 211-8. Input Pulse Greater than Maximum Pulse Width

Digital Filter Mode


In the digital filter mode, the output pulse is either held or
tracks the input. An output pulse is generated and held if the
selected input goes into and out of the input reference state
(S6, bit zero) a specified number of times S8 within a given
time period S7. The filtered pulse is held for the next time
period as long as the number of input pulses is greater than or
equal to the count S8 during the time period.

If the selected input does not go into and out of the input refer-
ence state the specified number of times over the time period,
the output pulse is released and the output tracks the input.
The input reference state (S6, bit zero), the number of input
transitions or digital filter transition count reference S8, and
the filter period S7 are tunable values. Figure 211-9 illustrates
the digital filter mode.

In Figure 211-9, the input initially enters the input reference


state (S6, bit zero) at t0. This marks the start of the filter
period. At time t1, S8 transitions have occurred which cause
the output pulse to be generated and held. At time t2, the filter
period S7 has ended and S8 or greater transitions have not
occurred so the output is released to track the input.

The input conditioning mode is tunable and can be changed


during operation. If the mode is changed when the selected

211 - 12 WBPEEUI210504C0
1 2 S 8 -1 S8 1 2 3 4 1
R E F E R EN C E
S TAT E

IN P U T

S7

t0 t1 t2

R E F E R EN C E
S TAT E

O U T PU T
T R AC K H O LD T R AC K
T 01 9 45 A

Figure 211-9. Digital Filter Mode Input and Output

input is at the reference state (REF), an edge (transition into


REF state) will be detected. The result at the output when the
mode is changed is dependent upon which mode is currently
enabled and which mode is being transitioned. Changing from
pulse mode to timing mode or from timing mode to pulse
mode, a pulse of up to twice the specified time period S7 may
occur.
S7 Input conditioning time reference. This defines the time
parameter, in seconds, used by the input conditioning mode
selected by S6. The parameter this value defines is dependent
on the mode of operation. Table 211-6 shows which time
parameter is associated with each mode.

Table 211-6. Mode Time Parameters

Mode Time Parameter


Pulse mode Output pulse duration
Timed out mode Input reference match time
Timing mode Maximum output pulse duration
Filter mode Filter period

S8 Input conditioning digital filter count reference. This defines


the number of input transitions into the specified reference
state (S6, bit zero) that are required over the specified time
period S7 in order to force and hold the output at the specified
state (S6, bit zero).

WBPEEUI210504C0 211 - 13
S9 Alarm mode control value. This defines the type of alarm pro-
cessing to be accomplished by the DADIG. This real input
value is converted to a hexadecimal number and the bits are
mapped as shown in Table 211-7. Figure 211-10 shows the
alarm processing logic.

Table 211-7. Alarm Mode Control Bit Map

Binary
Bit Attribute
Value
0 1 Alarm reference state. When an alarm is enabled, the select alarm criteria will be
applied to the input when the selected input enters the state defined by this bit.
0 = alarm reference is logic 0
1 = alarm reference is logic 1
1 2 Input reference select. When alarm is enabled, this input selects whether alarm will
use the raw selected input signal as a reference or the conditioned selected input.
0 = use unconditioned, raw input
2 = use conditioned input
2-4 4 Standard digital alarm mode; alarm when selected input goes into alarm state
(refer to bit 0)
8 Deadbanding alarm mode; alarm for maximum time period defined by S10 when-
ever selected input goes into alarm state (refer to bit 0)
12 Timed out alarm mode; alarm if selected input goes into alarm state (refer to bit 0)
for greater than or equal to the time period defined by S10
16 Alarm digital filter; generate and hold an alarm if selected input transitions into and
out of the alarm state (refer to bit 0) greater than or equal to the number of times
defined by S11 over a time period less than or equal to the value defined by S10
5 32 Enable alarm suppression when <S13> = 1. This option is valid only when an
alarm is enabled (S9 bits 2 - 4 = 4, 8, 12, or 16)
6 64 Enable de-alarm after <S12> time-out. This option is valid only when an alarm is
enabled (S9 bits 2 - 4 = 4, 8, 12, or 16)
7 128 Enable return alarm after <S12> time-out. This option is valid only when an alarm
is enabled (S9 bits 2 - 4 = 4, 8, 12, or 16)
8 256 Select mode of the alarm suppression indication in extended status block output
N+1 (refer to ES bit 12)
0 = alarm suppression indication set when alarms are selected through <S9>
and enabled through <S13> or a HSI command
1 = alarm suppression indication set when an alarm is being suppressed. This
option is valid only when an alarm is enabled (S9, bits 2 - 4 = 4, 8, 12, or
16) and alarm suppression is selected (through S9, bit 5)
9 - 15 — Spare

211 - 14 WBPEEUI210504C0
R AW IN P U T 0

1
S TA N DAR D
M ODE
C O N D ITIO N E D
2
IN P U T
D E AD BA N D IN G
3 M ODE
A L AR M

4 TIM E D O U T
M ODE
IN P U T
IN P U T S EL E C T
C O N D ITIO N IN G
C O N TRO L M ODE D IG ITAL F ILTE R
M ODE
S TATE R EF ER E N C E

TIM E R EF ER EN C E
C O U N T R E FE R EN C E T 01 9 46 A

Figure 211-10. Alarm Processing Logic

Bit 0 - Alarm Reference State


This bit defines the state of the input to be considered the
alarm state. When the input is at this level and alarm is
enabled, alarm processing activates.

0 = input logic 0 is alarm state


1 = input logic 1 is alarm state

Bit 1 - Input Reference State


An alarm can use the raw input for alarm processing or the
output of the input conditioning stage. This bit selects which
signal is to be used.

0 = use raw input


1 = use conditioned input

Bits 2 through 4 - Alarm Mode


Bits two through four define the alarm mode that is enabled.

Bit 5 - Alarm Suppression Select


This bit selects alarm suppression. When alarm suppression is
selected with this bit and enabled through <S13> or a HSI
command, and an alarm is enabled, alarm indications in the

WBPEEUI210504C0 211 - 15
extended status output (N+1) and exception reports will be
suppressed (forced to zero).

0 = do not suppress alarms


1 = alarm suppression selected

Bit 6 - De-Alarm Enable


This bit enables de-alarm. When an alarm mode is enabled,
de-alarm is enabled, and an alarm condition is detected, the
alarm indication is in the extended status output (N+1) and
exception reports will be de-alarmed or suppressed after a
period of time specified by S12. When the alarm indication is
suppressed due to a de-alarm condition, the alarm suppres-
sion indication in the extended status output and exception
reports will be true.

0 = do not de-alarm
1 = de-alarm enabled

Bit 7 - Return Alarm Enable


Bit seven enables the return alarm function. When an alarm is
enabled, an alarm exists, and return alarm is enabled, the
return alarm indication in the extended status output (N+1)
and exception report will change states a fixed period of time
(S12) after the alarm indication was first generated. Addition-
ally, as long as the alarm condition exists and this function is
enabled, the return alarm indication continues to change to
the opposite state every time period specified by S12.

0 = do not return alarm


1 = return alarm enabled

Bit 8 - Alarm Suppression Indication Mode


This bit determines the mode of the alarm suppression indica-
tion in the extended status output N+1 and exception reports.

0 = alarm suppression indication will be true when alarm


suppression is selected through S9, bit five and enabled
through <S13> or a HSI command

1 = alarm suppression indication will be true only when an


alarm is currently being suppressed

NOTE: De-alarm also uses the alarm suppression indication in the extended
status output.

211 - 16 WBPEEUI210504C0
Bits 9 through 15
Reserved. To program this specification, the values listed in
the binary weighted value column of the desired functions are
added and the resulting sum is the value to be entered. For
example, to get the desired functions:

alarm reference state = 0


input reference = raw unconditioned input (0)
alarm mode = deadbanding mode (8)
alarm suppression disabled = 0
de-alarm enabled = 64
return alarm disabled = 0
S9 = 0+0+8+0+64=72
S9 = 72

The bit column in Table 211-7 is separated by function and


some functions use multiple bits. Only one attribute option
can be selected for those functions. For example, only one
attribute and one alarm mode can be selected for bits two
through four.

Digital State Alarm Mode


In the digital state alarm mode, an alarm state occurs when-
ever the input matches the alarm reference state (S9, bit zero).
The alarm condition lasts until the input no longer matches
the alarm reference state (S9, bit zero). In this mode, the alarm
tracks the input as shown in Figure 211-11.

1 2 3 4 5
R E FE R EN C E
STAT E

IN P U T

1 2 3 4 5
AS SE RT ED
STAT E

AL AR M T 01 94 7 A

Figure 211-11. Digital State Alarm Mode Input and Alarm

Deadbanding Alarm Mode


In the deadbanding alarm mode, an alarm state occurs for a
specified amount of time specified by S10 whenever the

WBPEEUI210504C0 211 - 17
selected input goes into the alarm reference state (S9, bit zero).
At the end of the time specified by S10, the alarm state is not
negated until the selected input no longer matches the alarm
reference state (S9, bit zero). The alarm duration S10 and
alarm reference (S9, bit zero) are tunable values.
Figure 211-12 shows the alarm state and input when operat-
ing in the deadbanding alarm mode.

1 2 3 4 REFERENCE
S TAT E

IN P U T

S 10 S10 S 10

ASSERTED
S TAT E

A LA R M T 01 94 8A

Figure 211-12. Deadbanding Alarm Mode Input and Alarm

Timed Out Alarm Mode


In the timed out alarm mode, an alarm state occurs when the
selected input matches the alarm reference state (S9, bit zero)
for the amount of time specified by S10. The alarm remains
asserted until the input goes out of the alarm state. The alarm
reference and reference match time specified by S10 are tun-
able values. Figure 211-13 shows the timed out alarm mode
input and alarm.

R E FE R EN C E
STAT E

IN P U T

ta
S1 0

AS SE RT ED
STAT E

O U T PU T
S1 0 < ta T 01 9 49 A

Figure 211-13. Timed Out Alarm Mode Input and Alarm (S10 less than ta)

211 - 18 WBPEEUI210504C0
If the input reference match time S10 is longer than the alarm
condition time ta, the alarm is not asserted. Figure 211-14
shows this input and alarm state.

R E FE R EN C E
STAT E

IN P U T

ta

S1 0

O U T PU T
S1 0 > t a T 01 9 43 A

Figure 211-14. Match Time Greater than Condition Time (S10 greater than ta)

Digital Alarm Filter Mode


In the digital alarm filter mode, the alarm is either held or
tracks the input. The alarm is generated and held if the
selected input goes into and out of the alarm state (S9, bit
zero) a number of times specified by S11 within a given time
period specified by S10. The filtered alarm is held for the next
time period S10 as long as the number of alarm pulses is
greater than or equal to the count S11 during the time period
S10. If the selected input does not go into and out of the alarm
state the number of times specified by S10 over the period
specified by S11, the alarm is released to track the input. Both
the number of alarm transitions S11 and the filter period S10
are tunable values. Figure 211-15 shows the alarm filter mode
input and alarm.

In Figure 211-15, the input initially enters the alarm condition


at t0 which marks the start of the filter period. At time t1, S11
transitions have occurred that cause the alarm to generate
and hold. At time t2, the filter period has ended and S11 or
greater transitions have not occurred so the alarm is released
to track the input. If, at or before time t2, S11 transitions had
occurred, the alarm indication would have been held for
another S10 period of time.

The alarm mode is tunable and can be changed during opera-


tion. If the mode is changed when the selected input is at the

WBPEEUI210504C0 211 - 19
1 2 S 1 1-1 S11 1 2 3 4 1
R E F E R EN C E
S TAT E

IN P U T

S10
S EC S
t0 t1 t2

A SS E RTE D
S TATE

A L AR M
TR AC K H O LD TR AC K
T 01 9 51 A

Figure 211-15. Alarm Filter Mode Input and Alarm

reference state (REF), an edge (transition into REF state) will


be detected. The result at the alarm output when the mode is
changed is dependent upon what mode is currently enabled
and which mode is being transitioned.
S10 Time period for alarm modes. The specific parameter this
value defines depends on the alarm mode. Table 211-8 shows
the time parameters for the different alarm modes.
S11 Number of times the selected input must go into and out of the
alarm state (S9, bit zero) when digital alarm filtering is enabled
(S9, bits two through four equal four) in order for the alarm to
be generated and held.

Table 211-8. Time Parameters for Alarm Modes

Mode Time Parameter


Standard digital mode No time parameter used
Deadbanding mode Alarm duration (secs)
Timed out mode Alarm state reference match time (secs)
Filter mode Filter period (secs)

S12 De-alarm time (in seconds) when de-alarm is enabled. If an


alarm lasts the amount of time defined in S12, the alarm will
be suppressed.

When return alarm is enabled (S9, bit seven), S12 is the


return alarm time (in seconds). If an alarm exists for the time

211 - 20 WBPEEUI210504C0
defined by S12, the alarm is returned. Figure 211-16 shows
the return alarm and de-alarm logic.

A LAR M

A L AR M

D E -A LAR M R E TU R N
R E TU R N A LAR M
A LAR M

D E -A LAR M
E N AB LE
A L AR M
C O N TRO L
R E TU R N A LAR M
E N AB LE

D E -A LAR M /R E TU R N A LA R M T IM E T 01 9 52 A

Figure 211-16. Return Alarm and De-Alarm Logic

S13 Block address of the alarm suppress enable. Figure 211-17


shows the alarm suppression logic.

1 = alarm suppression allowed through <S9>


0 = alarm not suppressed through <S9>

A LAR M
A LAR M
N O A LA R M
(S U P PR E S S ED )

A L AR M
C O N TRO L A L AR M S U P PR E S S/U N -SU P P R E SS

U N -S U P P R ES S

C O N SO LE A L A R M S U P PR ES S EN A B L E

A L AR M S U P PR E S S E N A BL E T 01 9 53 A

Figure 211-17. Alarm Suppression Logic

WBPEEUI210504C0 211 - 21
S14 Block address of the quality state override input. This input
allows an external source to override the quality and status of
the reported logic state and indications displayed in the
extended status. The input is converted to a hexadecimal
number and the bits are mapped as shown in Table 211-9.
Table 211-10 shows valid combinations for S14.

Table 211-9. S14 Bit Map

Bit Binary Value Attribute


0 1 Force good quality
1 2 Force alternate input selected mode
2 4 Force custom inserted input selected mode
3 8 Output suspect
4 16 Hardware failure, bad quality
5 32 E-STOP
6 - 15 — Spare

Table 211-10. Valid Combination for S14

Value Result Value Result


0 Quality override disabled, default 14 - 15 Not valid
1 Force good quality 16 Force bad quality
2 Force alternate input selected mode 17 Not valid
3 Force good quality, alternate input selected 18 Force alternate input selected mode, bad
mode quality
4 Force custom inserted input selected mode 19 Not valid
5 Force good quality, custom inserted input 20 Force custom inserted input selected mode,
selected mode bad quality
6-7 Not valid 21 - 23 Not valid
8 Force suspect quality 24 Force suspect quality, bad quality
9 Force good quality, suspect quality 25 Not valid
10 Force alternate input selected mode, suspect 26 Force alternate input selected mode, suspect
quality quality, bad quality
11 Force good quality, alternate input selected 27 Not valid
mode, suspect quality
12 Force custom inserted input selected mode, 28 Force custom inserted input selected mode,
suspect quality suspect quality, bad quality
13 Force good quality, custom inserted input 29 - 31 Not valid
selected mode, suspect quality

211 - 22 WBPEEUI210504C0
Table 211-10. Valid Combination for S14 (continued)

Value Result Value Result


32 Force bad quality, E-STOP 46 - 47 Not valid
33 Force good quality, E-STOP 48 Force bad quality, E-STOP
34 Force alternate input selected mode, 49 Not valid
E-STOP
35 Force good quality, alternate input selected 50 Force alternate input selected mode, bad
mode, E-STOP quality, E-STOP
36 Force custom inserted input selected mode, 51 Not valid
E-STOP
37 Force good quality, custom inserted input 52 Force custom inserted input selected mode,
selected mode, E-STOP bad quality, E-STOP
38 - 39 Not valid 53 - 55 Not valid
40 Force suspect quality, E-STOP 56 Force suspect quality, bad quality, E-STOP
41 Force good quality, suspect quality, E-STOP 57 Not valid
42 Force alternate input selected mode, suspect 58 Force alternate input selected mode, suspect
quality, E-STOP quality, bad quality, E-STOP
43 Force good quality, alternate input selected 59 Not valid
mode, suspect quality, E-STOP
44 Force custom inserted input selected mode, 60 Force custom inserted input selected mode,
suspect quality, E-STOP suspect quality, bad quality, E-STOP
45 Force good quality, custom inserted input ≥61 Not valid
selected mode, suspect quality, E-STOP

The quality state override does not affect the processing of the
DADIG function code. The override state specified is logically
ORed with the internally derived state. This permits the
selected use of the internal function or special external
function.

NOTE: If an external function generates any of these control bits, the internal
features that correspond to the defined function must be inhibited. This pre-
vents a conflict between the externally driven status and the internal status.

Quality is normally derived from the selected input with the


exception of two conditions.

1. Bit zero is set to a logic 1. This forces the quality to be good


regardless of the actual input quality state. Bit four overrides
bit zero if both are set.

2. Bit four is set to a logic 1. This forces the quality to be bad


regardless of the actual input state. Bit four overrides bit zero
if both are set.

WBPEEUI210504C0 211 - 23
S15 Block address of the alarm state latch enable. When <S15>
equals one, any occurrence of an alarm causes the reported
logic state output N and the extended status output N+1 to
latch. These values do not change at the block outputs or
within the exception report until either <S15> equals zero or a
HSI sends a reset latch command. If time-stamping is enabled,
the time-stamp value in the exception report will also be
latched. While the values are latched, a flag is set in the
extended status and the exception report to indicate to any
receiver (e.g., HSI, function block) that the values are latched
and require a reset. When the output value of the block
addressed by this specification is logic 0, the reported logic
state and the extended status outputs reflect the current value
of the internal reported logic state and extended status.

0 = disable alarm state latch; reported logic state output N


and extended status output N+1 reflect current internal
states

1 = latch reported logic state and extended status upon an


alarm
S16 Block address of the exception report request. When <S16>
goes from zero to one, the exception report data is updated and
sent. When in no report mode, <S16> is disabled. The HSI can
force an exception report update that reports the current value
even when the point is set for no report. The point remains in
no report mode after sending one update if it was previously in
no report mode.

0 = generate exception reports according to normal crite-


ria; alarm conditions

1 = force an exception report


S17 Custom ID type code. The data in S17 goes in the exception
report enable reply and will be sent to a HSI when the HSI
establishes and connects a route to this point.
S18 and S19 Spare.

Outputs
N Primary input <S3>, the alternate input <S4>, or the custom
inserted value S5 depending on the input select control <S1>.

211 - 24 WBPEEUI210504C0
N+1 Current selected input, alarm, and processing status of the
DADIG function block. This extended status converts into indi-
vidual logic levels by configuration of real demultiplexers
(function code 126). Table 211-11 is a bit map of the extended
status.

Bits 3 and 4
Bits three and four indicate which of the three possible inputs
the input select block <S1> has selected to be output at the
reported logic state output N.

Bit 5
Bit five is the permit input select <S2> input.

Table 211-11. Extended Status Bit Map

Binary
Bit Attribute
Value
0 1 Spare
1 2 Spare
2 4 Spare
3-4 0 00 Primary input selected <S3>
8 01 Primary input selected <S3>
16 10 Custom inserted input selected S5
8+16 11 Alternate input selected <S4>
5 32 Permit input select enabled
6 64 Quality overridden
7 128 Reported logic state and extended status latched
8 256 Output value
9 512 E-STOP
10 1024 No report mode enabled
11 2048 Output suspect
12 4096 Alarm suppression indication
13 8192 Return alarm (toggled)
14 16384 Alarm state
15 32768 Bad quality

Bit 6
Bit six is the quality override. It indicates that the quality over-
ride input <S14> is overriding the quality.

WBPEEUI210504C0 211 - 25
Bit 7
Bit seven shows when the outputs are latched through the
alarm state latch (enabled through <S15>).

Bit 8
Bit eight is the state of the reported logic output N.

Bit 9
Bit nine is the executed stop (E-STOP).

Bit 10
Bit ten is the no report field. This indicates when the input
select <S1> places the block in no report mode.

Bit 11
Bit 11 is the output suspect quality. The quality override block
<S14> sets the output suspect quality.

Bit 12
This field is the monitored DADIG block alarm suppression
indication. This bit can be set by two of the monitored DADIG
block functions (on alarm suppression and by de-alarm).

1. For alarm suppression, this bit can operate in one of two


modes selected by the DADIG's alarm mode control <S9>, bit
eight.

• If bit eight of DADIG <S9> equals zero, this indication will


be set when alarm suppression is selected and enabled.

Alarm suppression is selected through the DADIG alarm


mode control <S9>. Alarm suppression is enabled through
either the DADIG alarm suppression enable block input
<S13> or a HSI command sent to the DADIG block.

• If bit eight of DADIG <S9> equals one, this indication will


be set when the alarm suppression function is suppressing
an alarm.

2. For de-alarm, this bit will be set when an alarm is being


de-alarmed.

Bit 13
Bit 13 is the return alarm indication. This shows when an
alarm has been returned. This bit toggles to the opposite state
to indicate an alarm has been returned. The alarm mode con-
trol S9 enables return alarm. Return alarm uses the return
alarm and de-alarm time period reference S12.

211 - 26 WBPEEUI210504C0
Bit 14
Bit 14 is the alarm field. The alarm field is set when an alarm
indication exists and alarm is enabled through the alarm
mode control <S9>.

Bit 15
Bit 15 is the quality field. The quality field indicates when the
block is bad quality. Quality reflects the quality of the selected
input <S3>, <S4> or S5. Quality can be forced bad (set), or
forced good (cleared) through the quality override block input
<S14>.

WBPEEUI210504C0 211 - 27
WBPEEUI210504C0
Data Acquisition
Digital Input/Loop Function Code 212
DAD IG I/L The data acquisition digital (DADIG function code 211) and the
(2 12 )

ST
data acquisition digital input/loop (DADIG I/L function code
212) function code pair is for digital data acquisition of bool-
ean signal functions. The DADIG and DADIG I/L function
codes complement the data acquisition analog (DAANG) and
the data acquisition analog input/loop (DAANG I/L) function
codes by providing the functions of the data acquisition analog
block for boolean signals. The DADIG function code pair pro-
vides a means to accomplish a number of unique data acquisi-
tion, alarm detection and management functions related to
boolean logic signals implemented in Symphony systems.

The DADIG function codes support a range of features on the


Conductor VMS series human system interface (HSI). Com-
mands are accepted from HSIs and alarm information is sup-
plied to HSIs through exception reports. The DADIG I/L
function code provides a means of importing data from the
DADIG block in Symphony systems.

NOTE: If a module utilizes an imported digital value from the control network in
several instances in its configuration, the function blocks that utilize that digital
value must be connected to only one DAANG I/L block. Exception reports from
the same (control network, HCU, module and block) address cannot be
imported to more than one destination within a single module configuration.

Outputs

Blk Type Description


N B Source reported logic level
N+1 R Source extended status

Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 31 Source module address
S2 N 0 I Note 1 Source DADIG block number
S3 N 0 I 0 - 250 Cnet node address
S4 N 0 I 0 - 250 Source loop number
S5 N 0 I 0 - 255 Spare integer input

WBPEEUI210504C0 212 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S6 N 0.000 R Full Spare real input
S7 N 0 I Note 1 Spare boolean input
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

Explanation
The DADIG I/L provides the ability to access the DADIG out-
puts from an Cnet communication highway. The DADIG I/L
outputs the two DADIG block outputs (reported logic level and
extended status).

Specifications
S1 Module address of the harmony controller containing the mon-
itored DADIG block.
S2 Block number of the monitored DADIG block.
S3 Harmony control unit (HCU) address of the module containing
the monitored DADIG block.
S4 Loop number of the Harmony control unit containing the mon-
itored DADIG block.
S5, S6 and S7 Spare.

Outputs
N Boolean output equal to output N of the monitored DADIG
(function code 211) block specified by S1, S2, S3 and S4.
N+1 Real value containing the numeric representation of the
extended status of the monitored DADIG (function code 211)
block specified by S1, S2, S3 and S4 currently in use.

The extended status and alarm detection modes may be con-


verted into individual logic level by configuration of real
demultiplexers (function code 126). Table 212-1 is a decoded
extended status bit map.

Bits 0 through 2
Unused.

212 - 2 WBPEEUI210504C0
Table 212-1. Decoded Extended Status Bit Map

Binary
Bit Attribute
Value
0 1 Spare
1 2 Spare
2 4 Spare
3-4 0 00 Primary input selected, <S3>
8 01 Primary input selected, <S3>
16 10 Custom inserted input selected, <S5>
8+16 11 Alternate input selected, <S4>
5 32 Permit input select enabled
6 64 Quality is being overridden
7 128 Reported logic state and extended status are latched
8 256 Output value
9 512 E-STOP
10 1024 No report mode enabled
11 2048 Output suspect
12 4096 Alarm suppression indication
13 8192 Return alarm (toggled)
14 16384 Alarm state
15 32768 Hardware failure/bad quality

Bits 3 through 4
The mode field indicates which of the three possible DADIG
(function code 211) inputs are currently selected through the
DADIG input select block input <S1> to be routed to the
DADIG reported logic state output N.

Bit 5
The permit input selection field indicates the state of the mon-
itored DADIG blocks permit input select input <S2>.

Bit 6
The quality overridden field indicates when the monitored
DADIG blocks quality is being overridden through the DADIG
quality override block input <S14>.

Bit 7
When the monitored DADIG block alarm state latch function is

WBPEEUI210504C0 212 - 3
enabled through the DADIG alarm state latch enable input
<S15>, this field indicates when the outputs are latched.

Bit 8
This field contains the state of the DADIG blocks reported logic
output N.

Bit 9
The E-STOP field indicates when the monitored DADIG block
is execute stopped through a HSI or when the E-STOP state is
being forced through the DADIG quality override block input
<S14>.

Bit 10
The no report field indicates when the monitored DADIG block
has been placed in no report mode through the DADIG block
input select <S1> or through a HSI command.

Bit 11
The output suspect quality indication is set through the moni-
tored DADIG block quality override block input <S14>.

Bit 12
This field is the monitored DADIG block alarm suppression
indication. This bit can be set by two of the monitored DADIG
block functions (on alarm suppression and by de-alarm).

1. For alarm suppression, this bit can operate in one of two


modes selected by the DADIG alarm mode control <S9>, bit 8.

• If bit eight of DADIG <S9> equals zero, this indication will


be set when alarm suppression is selected and enabled.

Alarm suppression is selected through the DADIG alarm


mode control <S9>. Alarm suppression is enabled through
either the DADIG alarm suppression enable block input
<S13> or a HSI command sent to the DADIG block.

• If bit eight of DADIG <S9> equals one, this indication will


be set when the alarm suppression function is suppressing
an alarm.

2. For de-alarm, this bit will be set when an alarm is being


de-alarmed.

Bit 13
The return alarm indication toggles each time the monitored
DADIG blocks alarm is returned. Return alarm is enabled

212 - 4 WBPEEUI210504C0
through the DADIG alarm mode control <S9> and uses the
return alarm/de-alarm time period reference <S12>.

Bit 14
The alarm field is set when the alarm is selected through the
DADIG blocks alarm mode control <S9> and an alarm condi-
tion exists at the monitored DADIG block.

Bit 15
The quality indication is set to indicate when the DADIG block
is bad quality. Quality reflects the quality of the selected
DADIG block input <S3>, <S4> or <S5> and can be forced bad
(set), or forced good (cleared) through the DADIG quality over-
ride block input <S14>. This field also will be set if an error
exists in the link between the DADIG I/L and DADIG blocks.

WBPEEUI210504C0 212 - 5
WBPEEUI210504C0
Enhanced Analog Slave
Definition Function Code 215

EA SD The enhanced analog slave definition function code (EASD)


S3 (2 1 5 ) defines an IMASI13 universal analog slave module to a Har-
C JI C JR
S2 A IB ST mony controller. For more information, refer to the IMASI13
CT
Isolated Analog Input Module instruction. This block defines
common specifications for IMASI13 modules. Individual input
function code 216 blocks are linked to this block to define
channels available on the IMASI13 module.

Outputs

Blk Type Description


N R Cold junction reference temperature in ° C
N+1 B I/O module status: 0 = good, 1 = bad
N+2 R Input scan cycle time (secs)

Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 63 I/O module address
S2 N 2 I Note 1 Block address of first enhanced analog input
definition (function code 216)
S3 N 5 I Note 1 Block address of cold junction reference input
S4 N 0 I 0 or 1 I/O module failure action:
0 = trip control module
1 = continue operation
S5 N 0 I 0 or 1 Normal mode rejection type:
0 = 60 Hz
1 = 50 Hz
S6 N 0.000 R Full Length (in ft) of termination device cable
S7 N 0 I Full Spare
S8 N 0 I Full Spare
S9 N 0.000 R Full Spare
S10 N 0.000 R Full Spare
NOTE:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

WBPEEUI210504C0 215 - 1
Explanation
Specifications
S1 I/O module expander bus address of the IMASI13 module.
S2 Points to the block address of the first enhanced analog input
definition (function code 216) function block. Each function
code 216 configures one of the channels on the IMASI13 mod-
ule.

NOTE: Block addresses and channel numbers can be linked in any order.
S3 Contains the block address of the cold junction reference tem-
perature. The value specified by the block address must be in
degrees Celsius. This is used for compensation of thermocou-
ple inputs. Specification S3 normally refers to the address of
the function code 215 output block N which directs the
IMASI13 module to use the local cold junction reference avail-
able on the termination device. Figure 215-1 is an example of
local cold junction compensation.

NOTE: Specification S3 normally refers to EASD blocks. It can reference any


function code.

Specification S3 can also refer to the address of the block out-


put used for remote cold junction reference. Figure 215-2 is an
example of remote cold junction compensation.
S4 Identifies the action to be taken in the event of a failure of the
IMASI13 module.

0 = trip control module


1 = continue operation
S5 Identifies the dominant noise frequency rejected during the
analog to digital conversion operation.

0 = 60 hertz
1 = 50 hertz
S6 Length of the cable (in feet) between the termination device
and the I/O module. The I/O module uses this to compensate
the measured input value for the effects of resistance in the
cable.

215 - 2 WBPEEUI210504C0
Outputs
N Temperature in degrees Celsius of the cold junction reference
for thermocouple inputs as measured by the built in RTDs on
the termination device of the IMASI13 module.
N+1 Indicates if a failure of the IMASI13 module is detected.

0 = good
1 = failed I/O module
N+2 Represents the amount of time between successive updates of
an individual channel input value and quality. This is the total
scan time of all points defined for the I/O module.

Applications
Figure 215-1 is a typical example of local cold junction com-
pensation. Tables 215-1, 215-2, 215-3 and 215-4 explain the
specification settings for the blocks used in Figure 215-1.

Remote cold junction reference inputs automatically use the


on-board cold junction reference for thermocouple compensa-
tion. Figure 215-2 shows a typical example of remote cold
junction compensation. Tables 215-5, 215-6 and 215-7 list the
specification values and descriptions for Figure
215-2.

WBPEEUI210504C0 215 - 3
T E R M IN AT IO N
D E V IC E
(T H E IM A S I1 3 R E Q U IR E S E IT H E R O N E
N TA I06 T E R M IN AT IO N U N IT O R T W O
N IA I0 5 T E R M IN AT IO N M O D U LE S ) IM A S I1 3
TYPE E
T H E R M O C O U P L E 20 Ω +
30 Ω AI 1
– AI 1
C
AI 2
-10 0 0Ω +
+
TO 0Ω AI 3
– – AI 2
+100 m V
C AI 4

+ AI 5
– AI 3 CABLE
AI 6
(10 F T )
C
AI 7

AI 8
(S E E
IN T H IS E X A M P L E N OT E )
AI 9
IN P U T C H A N N E LS
3 THRO UG H 15 EASD
AI 10 S3 (21 5)
ARE NOT U SED C JI C JR
S2 100
AI 11 A IB ST
101
CT
AI 12 102
+
– AI 15 AI 13 S1 =1 I/O M O D U LE A D R
S4 =1 FA ILU R E A C T IO N (0 = T R IP, 1 = C O N T IN U E )
C AI 14 S5 =0 N O R M A L M O D E R E JE C T IO N T Y P E
(0 = 60 H z, 1 = 50 H z)
-0 .09 4 TO + 1 V 7Ω +
+ AI 15 S6 = 1 0.0 T U C A B LE LE N G T H (ft)
7Ω S7 = 0 S PA R E
– – AI 16 S8 = 0 S PA R E
AI 16 S9 = 0 .0 S PA R E
C
S10 = 0 .0 S PA R E

O F F -PAG E
C O N N E C TO R
TO C O N T R O L
L O G IC
S2 (2 16 )
E A ID
11 0
S2 (2 1 6)
E A ID
90 S1 = 1 I/O M O D U L E A D R
S3 = 1 I/O M O D U L E IN P U T C H A N N E L N O .
S4 = 3 IN P U T S IG N A L T Y P E
S1 = 1 S L AV E A D R S5 = 0 E U C O N V E R S IO N T Y P E (0 = °C , 1 = °F )
S3 = 2 S L AV E IN P U T C H A N N E L N U M S6 = 0 .0 E U Z E R O O F IN P U T
S4 = 60 IN P U T S IG N A L T Y P E S7 = 0 .0 E U S PA N O F IN P U T
S5 = 0 E U C O N V E R S IO N T Y P E (0 = °C, 1 = °F ) S8 = 0 .0 IN P U T S IG N A L R A N G E LO W LIM IT
S6 = -10 0.0 E U Z E RO O F IN P U T S9 = 0 .0 IN P U T S IG N A L R A N G E H IG H L IM IT
S7 = 2 00 .0 E U S PA N O F IN P U T S10 = 5 0.0 L E A DW IR E R E S IS TA N C E (W )
S8 = 0 .0 IN P U T S IG N A L R A N G E L O W L IM IT S11 = 22 A /D C O N V E R S IO N R E S O L U T IO N (N O. O F B IT S )
S9 = 0 .0 IN P U T S IG N A L R A N G E H IG H LIM IT S12 = 0 S PA R E
S 10 = 0 L E A DW IR E R E S IS TA N C E (W ) S13 = 0 S PA R E
S14 = 0 .0 S PA R E
O F F -PAG E
S 11 = 20 A /D C O N V E R S IO N R E S O L U T IO N (N U M B IT S ) C O N N E C TO R
S 12 = 0 S PA R E S15 = 0 .0 S PA R E
S 13 = 0 S PA R E TO C O N T R O L
S 14 = 0 .0 S PA R E L O G IC
S 15 = 0 .0 S PA R E

O F F -PAG E
C O N N E C TO R
TO C O N T R O L
L O G IC
S2 (2 16 )
E A ID
12 5

S1 = 1 I/O M O D U L E A D R
S3 = 16 I/O M O D U L E IN P U T C H A N N E L N O .
S4 = 99 IN P U T S IG N A L T Y P E
S5 = 0 E U C O N V E R S IO N T Y P E (0 = °C , 1 = °F )
S6 = 1 0.0 E U Z E R O O F IN P U T
S7 = 9 0.0 E U S PA N O F IN P U T
S8 = -0.0 94 IN P U T S IG N A L R A N G E L O W L IM IT
S9 = 1 .0 IN P U T S IG N A L R A N G E H IG H L IM IT
S 10 = 1 4.0 LE A DW IR E R E S IS TA N C E (W )
N O T E : C O N N E C T IO N S TO F C 2 1 6’S F O R P O IN T S 3-1 5 S 11 = 18 A /D C O N V E R S IO N R E S O LU T IO N (N O . O F B IT S )
S 12 = 0 S PA R E
N O T U S E D. (T Y P IC A LLY A F C 21 6 IS R E S E RV E D F O R S 13 = 0 S PA R E
E AC H P O IN T A N D LIN K E D IN T H E C H A IN E V E N IF S 14 = 0 .0 S PA R E
N O T U S E D.) S 15 = 0 .0 S PA R E T 0 41 80 A

Figure 215-1. Local Cold Junction Compensation

215 - 4 WBPEEUI210504C0
Table 215-1. Function Code 216 at Block Address 90

Spec Value Description


S1 1 I/O module address 1, set on the IMASI13
S2 125 Points to the block address of the next function code 216 in the link (the default
value of 2 signifies the final function code 216 in the link)
S3 2 IMASI13 module input channel number 2
S4 60 Channel 2 (refer to S3) is configured to be connected to a -100 mV to +100 mV
input source
S5 0 Not used when S4 is configured as a voltage or current input type
S6 -100 The zero in engineering units is a value of -100.0
S7 200 The span in engineering units is a value of 200
S8 0 Only used when S4 is configured as a custom voltage input type
S9 0 Only used when S4 is configured as a custom voltage input type
S10 0 The wire from the millivolt source input to the IMASI13 termination device has a
resistance of 0 Ω or the resistance is considered negligible
S11 20 Conversion resolution is 20 bits

Table 215-2. Function Code 215 at Block Address 100

Spec Value Description


S1 1 I/O module address 1, set on the IMASI13
S2 110 Points to the block address of the first function code 216 in the link
S3 100 Points to block output N of this function code 215. This is the cold junction reference
temperature in ° C measured at the termination device of this IMASI13
S4 1 Continue to operate control module on an I/O module failure
S5 0 Rejects ambient 60 Hz interference (set this specification to the line voltage
frequency used in the country of operation)
S6 10 The cable from the IMASI13 to the termination device is 10 ft in length

Table 215-3. Function Code 216 at Block Address 110

Spec Value Description


S1 1 I/O module address 1, set on the IMASI13
S2 90 Points to the block address of the next function code 216 in the link (the default
value of 2 signifies the final function code 216 in the link)
S3 1 IMASI13 module input channel number 1
S4 3 Channel 1 (refer to S3) is configured to be connected to a type E thermocouple
S5 0 The output of channel one is displayed in ° C
S6 0 Not used when S4 is configured as thermocouple input type

WBPEEUI210504C0 215 - 5
Table 215-3. Function Code 216 at Block Address 110 (continued)

Spec Value Description


S7 0 Not used when S4 is configured as thermocouple input type
S8 0 Not used when S4 is configured as thermocouple input type
S9 0 Not used when S4 is configured as thermocouple input type
S10 50 The wire from the thermocouple to the IMASI13 termination device has a resis-
tance of 50 Ω
S11 22 Conversion resolution is 22 bits

Table 215-4. Function Code 216 at Block Address 125

Spec Value Description


S1 1 I/O module address 1, set on the IMASI13
S2 2 Points to the block address of the next function code 216 in the link (the default
value of 2 signifies the final function code 216 in the link)
S3 16 IMASI13 input channel number 16
S4 99 Channel 16 (refer to S3) is configured to be connected to a custom defined
voltage input source
S5 0 Not used when S4 is configured as a voltage or current input type
S6 10 The zero in engineering units is a value of 10
S7 90 The span in engineering units is a value of 90
S8 -0.094 The low range of the input voltage is -0.094 V
S9 1.0 The high range of the input voltage is 1 V
S10 14 The wire from the millivolt source input to the IMASI13 termination device has a
resistance of 14 Ω
S11 18 Conversion resolution is 18 bits

215 - 6 WBPEEUI210504C0
EASD
S3 (215)
C JI C JR
S2 250
A IB ST
251
CT
252
S1 =6 I/O M O D U LE A D R
R E M OT E S4 =1 FA ILU R E AC T IO N
T E R M IN A L B LO C K T E R M IN AT IO N (0 = T R IP M F P, 1 = C O N T IN U E )
D E V IC E S5 = 0 N O R M A L M O D E R E JE C T IO N T Y P E
TYPE J (0 = 6 0 H z, 1 = 50 H z)
(T H E IM A S I13 R E Q U IR E S S 6 = 6.0 T U C A B LE LE N G T H (ft)
T H E R M O C O U P LE E IT H E R O N E N TA I0 6 S7 = 0 S PA R E
T E R M IN AT IO N U N IT O R S8 = 0 S PA R E
T W O N IA I05 T E R M IN AT IO N S 9 = 0.0 S PA R E
6Ω 6Ω P LA IN W IR E M ODULES) IM A S I1 3 S 10 = 0.0 S PA R E
O F F -PAG E
8Ω C O N N E C TO R
+ TO C O N T R O L
8Ω AI 1 AI 1
– LO G IC
S2 (216)
C AI 2 E A ID 1 75
+ AI 3
– AI 2
S1 = 6 I/O M O D U LE A D R
C AI 4
S3 = 1 I/O M O D U LE IN P U T C H A N N E L N O.
AI 5 S4 = 4 IN P U T S IG N A L T Y P E
+ S5 = 1 E U C O N V E R S IO N T Y P E (0 = °C, 1 = °F )
– AI 3 AI 6 S6 = 0.0 E U Z E R O O F IN P U T
C C A B LE S7 = 0.0 E U S PA N O F IN P U T
(1 0 F T ) AI 7 S8 = 0.0 IN P U T S IG N A L R A N G E LO W LIM IT
S9 = 0.0 IN P U T S IG N A L R A N G E H IG H LIM IT
AI 8 S 10 = 28.0 LE A DW IR E R E S IS TA N C E (W )
S 11 = 24 A /D C O N V E R S IO N R E S O LU T IO N (N O. B IT S )
IN T H IS E X A M P LE AI 9 S 12 = 0 S PA R E
IN P U T C H A N N E LS
S 13 = 0 S PA R E
3 T H R O U G H 15 A I 10
S 14 = 0.0 S PA R E
A R E N OT U S E D
A I 11 S 15 = 0.0 S PA R E

A I 12 C O N N E C T IO N S TO F C 216s F O R P O IN T S 2-15 N OT U S E D.
+ (T Y P IC A LLY A F C 216 IS R E S E RV E D F O R E AC H P O IN T
A I 13 A N D LIN K E D IN T H E C H A IN E V E N IF N OT U S E D.)
– A I 15
C A I 14
O F F -PAG E
7Ω C O N N E C TO R
+ A I 15
7Ω TO C O N T R O L
– A I 16
A I 16 LO G IC
C S2 (216)
E A ID 162
TYPE T
T H E R M O C O U P LE
S1 = 6 I/O M O D U LE A D R
S3 = 16 I/O M O D U LE IN P U T C H A N N E L N O.
S4 = 106 IN P U T S IG N A L
S5 = 0 E U C O N V E R S IO N T Y P E (0 = °C, 1 = °F )
S6 = 0.0 E U Z E R O O F IN P U T
S7 = 0.0 E U S PA N O F IN P U T
S8 = 0.0 IN P U T S IG N A L R A N G E LO W LIM IT
S9 = 0.0 IN P U T S IG N A L R A N G E H IG H LIM IT
S 10 = 14 LE A DW IR E R E S IS TA N C E (W )
S 11 = 16 A /D C O N V E R S IO N R E S O LU T IO N (N O. B IT S )
S 12 = 0 S PA R E
S 13 = 0 S PA R E
S 14 = 0.0 S PA R E
S 15 = 0.0 S PA R E T 04181A

Figure 215-2. Remote Cold Junction Compensation

Table 215-5. Function Code 216 at Block Address 175

Spec Value Description


S1 6 I/O module address 6, set on the IMASI13
S2 162 Points to the block address of the next function code 216 in the link (the default
value of 2 signifies the final function code 216 in the link)
S3 1 IMASI13 input channel number 1
S4 4 Channel 1 (refer to S3) is configured to be connected to a type J thermocouple
S5 1 The output of channel 1 is displayed in ° F

WBPEEUI210504C0 215 - 7
Table 215-5. Function Code 216 at Block Address 175 (continued)

Spec Value Description


S6 - S9 0 Not used when S4 is configured as a thermocouple input type
S10 28 The wire from the millivolt source input to the IMASI13 termination device has a
resistance of 28 Ω
S11 24 Conversion resolution is 24 bits

Table 215-6. Function Code 216 at Block Address 202

Spec Value Description


S1 6 I/O module address 6, set on the IMASI13
S2 2 Points to the block address of the next function code 216 in the link (the default
value of 2 signifies the final function code 216 in the link)
S3 16 IMASI13 module input channel number 16
S4 106 Channel 5 (refer to S3) is configured to be connected to a type T thermocouple
In this example, this thermocouple measures the ambient temperature of the
remote termination device where the type J thermocouple (at block address 201)
is terminated.
When an input type (S4) is specified to be a value greater than 100, this thermo-
couple uses the on-board cold junction reference for compensation and its out-
put value is filtered which acts to slow its response time.
S5 0 The output must be in ° C when using this channel as a remote cold junction
reference
S6 - S9 0 Not used when S4 is configured as a thermocouple input type
S10 14 The wire from the millivolt source input to the IMASI13 termination device has a
resistance of 14 Ω
S11 16 Conversion resolution is 16 bits

Table 215-7. Function Code 215 at Block Address 250

Spec Value Description


S1 6 I/O module address 6, set on the IMASI13
S2 175 Points to the block address of the first function code 216 in the link
S3 162 Points to block output address of the sensor (a type T thermocouple) used as the
cold junction reference at the remote thermocouple termination device
S4 1 Continue to operate control module on an I/O module failure
S5 0 Rejects ambient 60 Hz interference (set this specification to the line voltage fre-
quency used in the country of operation)
S6 6 The cable from the IMASI13 to the termination device is 6 ft in length

215 - 8 WBPEEUI210504C0
Enhanced Analog Input
Definition Function Code 216
The enhanced analog input definition (EAID) function code
(2 1 6 )
S2
EA ID specifies an input to an IMASI13 Isolated Analog Input Mod-
ule. This must be configured in the same segment as the
enhanced analog module definition (function code 215) which
references it. For more information, refer to the IMASI13 Iso-
lated Analog Input Module instruction.

The EAID function code reads a single analog input from an


IMASI13 module. Up to 16 EAID blocks may be configured per
module.

To calibrate an IMASI13 module, it is necessary to install one


function code 216 for each input channel.

Outputs

Blk Type Description


N R Analog input value and quality (specified in engineering units)

Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 63 I/O module address
S2 N 2 I Note 1 Block address of next EAID block
S3 N 1 I 1 - 16 Module input channel number
S4 N 1 I Full Input signal type:
0 = invalid (do not use)
x01 = type S thermocouple
x02 = type R thermocouple
x03 = type E thermocouple
x04 = type J thermocouple
x05 = type K thermocouple
x06 = type T thermocouple
x07 = Chinese type E thermocouple
x08 = Chinese type S thermocouple
x09 = type L thermocouple
x10 = type U thermocouple
x11 = type N (14 AWG) thermocouple
x12 = type N (28 AWG) thermocouple
x13 = type B thermocouple (firmware
revision C_0 and above)

WBPEEUI210504C0 216 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S4 N 1 I Full x20 = U.S. laboratory standard 100 Ω platinum
(cont.) RTD (TCR = 0.003926)
x21 = U.S. industrial standard 100 Ω platinum
RTD (TCR = 0.003911)
x22 = European standard 100 Ω platinum RTD
(TCR = 0.003850)
x23 = 120 Ω chemically pure nickel RTD
(TCR = 0.00672)
x24 = 10 Ω copper RTD (TCR = 0.00427)
x25 = Chinese 53 Ω copper RTD
x40 = +1 V to +5 V, 4 mA to 20 mA (Do not use
for IMASI13)
x41 = -10 V to +10 V
x42 = 0 V to +10 V
x43 = 0 V to +5 V
x44 = +1V to +5V (IMASI13 only)
x60 = -100 mV to +100 mV
x61 = 0 mV to +100 mV
x99 = user specified voltage range (min. -10 V,
max. +10 V)
where:
x = 0; normal input. Specification S3 of function
code 215 will be used as the cold junction refer-
ence for thermocouple inputs.
x = 1; this input is a remote cold junction reference
and may be used as the cold junction reference for
other thermocouple inputs. When x = 1:
1. A moving average filter will be applied to block
output N. This slows the response time of the
input channel.
2. If the input type is a thermocouple, S3 of func-
tion code 215 will be ignored and the on-board
cold junction reference of the IMASI13 module
will be used to compensate this thermocouple
input (if the thermocouples used as remote cold
junction references are terminated directly on the
IMASI13 module termination unit).
S5 N 0 I 0 or 1 Engineering unit conversion type:
0 = °C
1 = °F
S6 Y 0.000 R Full Engineering unit zero for input

216 - 2 WBPEEUI210504C0
Specifications (continued)

Spec Tune Default Type Range Description


S7 Y 0.000 R Full Engineering unit span for input
S8 N 0.000 R Full Custom range low limit (in V)
S9 N 0.000 R Full Custom range high limit (in V)
S10 N 0.000 R Full Lead wire resistance (in Ω)
S11 N 16 I 16 - 24 A/D conversion resolution. Set to 24 for IMASI13.
S12 N 0 I Full Spare
S13 N 0 I Full Spare
S14 N 0.000 R Full Spare
S15 N 0.000 R Full Spare
NOTE:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

Explanation
Specifications
S1 Expander bus address of the IMASI13 module.
S2 Block address of the next EAID block describing one of the
channels on the module. A value of two indicates this is the
end of the link list.

NOTE: Block addresses and channel numbers can be linked in any order.
S3 Number of the input channel on the module described by the
EAID block.
S4 Defines the input signal type of the input from the IMASI13
module.

If an input signal that specifies a defined range (e.g., +1 volt to


+5 volts) goes five percent outside of its range, the input signal
is marked as bad quality with a status out of range.

For calibration of the IMASI13 module, the calibration type


defined in S4 of function code 217 must be consistent with the
input signal type defined in S4 of function code 216. Consider
the following examples.
Example 1 If calibrating a channel for millivolts or thermocouples, then S4 of function
code 217 must be set to 0 and S4 of function code 216 must be set to any

WBPEEUI210504C0 216 - 3
one of the millivolt or thermocouple input types. In this case, S4 of function
code 216 must be within the following:

x01 ≥ S4 < x20


or
x60 ≥ S4 < x99

Example 2 If calibrating a channel for high level voltage, then S4 of function code 217
must be set to 1 and S4 of function code 216 must be set to one of the high
level voltage ranges (4 to 20 mA is considered high level input type). In this
case, function code 216 should be within the following:

x40 ≥ S4 < 60
or
S4 = x99

Example 3 If calibrating a channel for RTD mode, then S4 of function code 217 must be
set to 2 and S4 of function code 216 must be set to any one of the RTD types.
In this case, S4 of function code 216 should be within the following range:

x20 ≥ S4 < x40

S5 Defines the type of temperature unit conversion to be per-


formed on the input signal. If S4 indicates other than a ther-
mocouple or RTD type, then S5 is ignored, and S6 and S7 are
used to convert to engineering units.
S6 Defines the low value (zero) of the input in engineering units.
This value corresponds to the input signal range identified in
S4. This specification is ignored if the input type (S4) is a ther-
mocouple or RTD.
S7 Defines the span of the input in engineering units. The span
plus the zero yields the output of the block at full signal range.
This specification is ignored if the input type (S4) is a thermo-
couple or RTD.
S8 Ignored unless the input signal type (S4) indicates a custom
voltage range. In that case, this specification defines the lower
limit of the range in volts.
S9 Ignored unless the input signal type (S4) indicates a custom
specified voltage range. In that case, this specification defines
the upper limit of the range in volts.
S10 Resistance (in ohms) of the field input lead wire from the input
to the termination device. This value corrects the value of the
input signal. For millivolt and thermocouple inputs, lead wire
resistance is the sum of the resistance in both the plus and

216 - 4 WBPEEUI210504C0
minus leads. For three-wire RTD inputs, lead wire resistance
is the resistance in any one of the three leads (the resistance of
each wire must be equal). This value is ignored for high level
input types.
S11 Resolution of the analog to digital conversion for each indepen-
dent channel. This specification specifies the resolution as the
number of bits in the binary representation of the raw input
value when it is scanned by the input module. The resolution
should be set to 24 bits for the IMASI13 module. This will set
the conversion time to 180 msecs for all 16 channels.

Outputs
Output N Analog input value:

• High level input - reading (in engineering units based on


S6 and S7) automatically adjusted for drift, and input
channel nonlinearities.

• RTD input - reading (in degrees as specified in S5) auto-


matically adjusted for drift, lead wire resistance and input
channel nonlinearities.

• Thermocouple input - reading (in degrees as specified in


S5) automatically adjusted for drift, lead wire resistance,
cold junction temperature and input channel nonlineari-
ties.

• Millivolt input - reading (in engineering units based on S6


and S7) automatically adjusted for drift, lead wire resis-
tance and input channel nonlinearities.
Quality of Output N Marked bad if one of the following conditions exist:

• Input reading is out of range.


• Channel hardware has failed.
• Open circuit.
• Input channel has not been calibrated.
• Input channel is disabled.
• Input channel has not been properly configured.

A thermocouple channel indicates bad quality if the cold junc-


tion reference chosen for compensation shows bad quality.

WBPEEUI210504C0 216 - 5
Applications
Refer to the applications section of function code 215.

216 - 6 WBPEEUI210504C0
Enhanced Calibration
Command Function Code 217

EC C The enhanced calibration command function code (ECC) per-


V
(2 1 7 ) mits calibration and diagnostic testing of the IMASI13 univer-
N
C H -S T
N+1 sal analog input module.
G
N+2
O
N+3 The operator initiates, guides and terminates a calibration or
C O M -S T
N+4 diagnostic sequence with this enhanced calibration command
function code. Commands are entered by tuning this block.
The status of the command may be determined by examining
S1 after the tune operation is completed. If S1 is zero after
tuning function code 217, an error has occurred.

Before beginning calibration, each channel must be configured


with one function code 216, and the calibration type defined in
S4 of function code 217 must be consistent with the input sig-
nal defined in S4 of function code 216.

A detailed description of any command errors is provided as an


output (N+4) to this function block. This output reflects the
status of the most recently issued calibration command.

Errors encountered during calibration of a particular channel


are also reported as an output (N+1) to this function block.
This output reflects the status for the channel referenced in
the most recent command. For more information, refer to the
IMASI13 Isolated Analog Input Module instruction.

Outputs

Blk Type Description


N R Uncorrected value of input signal
N+1 R Channel calibration status
N+2 R Custom gain adjustment
N+3 R Custom offset adjustment
N+4 R Calibration command status

WBPEEUI210504C0 217 - 1
Specifications

Spec Tune Default Type Range Description


S1 Y 0 I 0 - 255 Calibration operation code
S2 Y 0 I Note 1 Block address of function code 215 used to config-
ure input module
S3 Y 0 I Full Input module channel number
S4 Y 0 I 0-2 Calibration type:
0 = low level (millivolt, thermocouple)
1 = high level
2 = RTD
S5 Y 0.000 R Full Calibration parameter 1
S6 Y 0.000 R Full Calibration parameter 2
S7 N 0 I Full Spare
S8 N 0.000 R Full Spare
NOTE:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

Explanation
Specifications
S1 Tuned to the proper command code for the calibration opera-
tion to be performed. Specification S1 is returned as a zero in
the event of a calibration command error, and must be
changed before sending another calibration command to the
module. Specification S1 is unchanged if calibration command
processing is successful.

1. Disable point - removes a channel from normal input scan


processing. A point must be disabled before performing a point
calibration command to prevent calibration related data from
being interpreted as process data by the rest of the system.
Calibration should only be performed using precision voltage
or resistance sources applied at the terminal blocks. In addi-
tion, before a point can be successfully disabled, the point
must first be configured with a function code 216.

2. Perform point calibration using external reference - the


precision voltage or resistance source must be connected prior
to issuing this command. Before a successful point calibration
can be implemented, the calibration type defined in S4 of func-
tion code 217 must be consistent with the input signal type

217 - 2 WBPEEUI210504C0
defined in S4 of function code 216. Refer to the specific exam-
ples under the S4 explanations in this function code. Also refer
to the calibration section of the IMASI13 product instruction.

3. Enable point - terminates the field calibration sequence for


an input channel type. A point must be enabled before normal
input processing can occur. Selected gain and offset values will
be reset to 1.0 and 0.0, respectively, if a successful calibration
has been performed.

4. Point escape - resets (clears) calibration point information


for a particular channel in the middle of a calibration
sequence. It clears only the point data. This allows a restart of
a calibration procedure for the specified channel. The point
escape command does not enable the channel.

5. Set custom gain and offset adjustment - allows a linear


adjustment factor to be entered. This will be applied to the
input signal after all drift and nonlinearity corrections, but
before conversion to engineering units. This value is applied to
low level, high level and resistance values.

6. Reset custom gain and offset adjustment - cancels any


previously entered custom gain and offset adjustment for the
specified input channel type. After issuing this command, the
gain for the input channel type is one and the offset is zero.

7. Display uncorrected point data (percent of positive full


scale) - performs no operation other than to update the uncor-
rected output data value for the specified input channel (block
output N of function code 217).

8. Update point data - causes a new scan of the specified


input channel to be performed and the output data value of
the block to be updated with the new uncorrected value.

9. Input module escape command - performs point escape


command to all 16 channels and cold junction reference on
the IMASI13 module.

10. Expander bus test command - performs single test of


expander bus between the module and the secondary input
module. The test verifies transmission, reception and data
integrity of messages passed between the module and the sec-
ondary input module (intended as an additional diagnostic for
the input module bus interface). This operation can be

WBPEEUI210504C0 217 - 3
performed with a local or remotely configured IMASI13 mod-
ule. This test can be performed on-line.

11. Restore factory calibration command - overwrites the field


calibration data in NVRAM with the original factory calibration
parameters. This command also resets any values entered by
the set custom gain and offset command.
S2 Identifies the block address of the EASD block (function code
215) that identifies which input module is referred to by the
command specified in S1.
S3 Identifies the module input channel number of the applicable
command specified in S1.
S4 Identifies the type of calibration performed.

0 = low level (millivolt, thermocouple)


1 = high level
2 = RTD

For calibration of the IMASI01 or IMASI13 module, the calibra-


tion type defined in S4 of function code 217 must be consis-
tent with the input signal type defined in S4 of function code
216. Consider the following examples.
Example 1 If calibrating a channel for millivolts or thermocouples, then S4 of function
code 217 must be set to 0 and S4 of function code 216 must be set to any
one of the millivolt or thermocouple input types. In this case, S4 of function
code 216 must be within the following:

x01 ≥ S4 < x20


or
x60 ≥ S4 < x99

Example 2 If calibrating a channel for high level voltage, then S4 of function code 217
must be set to 1 and S4 of function code 216 must be set to one of the high
level voltage ranges (4 to 20 mA is considered high level input type). In this
case, function code 216 should be within the following:

x40 ≥ S4 < 60
or
S4 = x99

Example 3 If calibrating a channel for RTD mode, then S4 of function code 217 must be
set to 2 and S4 of function code 216 must be set to any one of the RTD types.
In this case, S4 of function code 216 should be within the following range:

x20 ≥ S4 < x40

217 - 4 WBPEEUI210504C0
S5 Used for channel input type calibration and changing the cus-
tom gain and offset value. Calibration parameter one provides
a real value dependent upon the type of command S1 specifies.

When S1 equals two, point calibration, this parameter speci-


fies the true value of the signal applied to the input channel
during the calibration operation. Enter an S5 value for each
calibration point. Up to 11 points may be identified for adjust-
ment of input channel nonlinearities, resulting in ten linear
segments for correction. These calibration points may be
applied in any order. The units for the point value are deter-
mined by the type of calibration operation specified in S4.

For example,

Low level = -100 millivolts to +100 millivolts

High level = -10 volts to +10 volts

RTD = 5 ohms to 500 ohms

When S1 equals five, specified gain and offset applications, S5


specifies the gain and S6 specifies the offset. When the
IMASI13 module is shipped, the default value for gain is set to
one and the default value for offset is set to zero. This com-
mand (S1 equals five) sets both the gain and offset parameters
simultaneously each time it is entered.

The gain, or slope, is the linear correction to be applied. Both


gain and offset adjustments are changed at one time.
S6 Used to specify an offset for the custom gain and offset com-
mand (S1 equals five). It provides a real value dependent upon
the type of command specified in S1.

This parameter specifies the offset of the linear correction to be


performed. The units for the offset value are determined by the
type of calibration operation specified in S4. For example:

Low level = -100 millivolts to +100 millivolts

High level = -10 volts to +10 volts

RTD = 5 ohms to 500 ohms

WBPEEUI210504C0 217 - 5
Outputs
N Uncorrected value of the input signal. This output gives the
value of the input signal without any of the calibration, drift,
lead wire, or cold junction compensations applied. The raw
digitized value is converted to a range of -100 to +100.
N+1 Channel calibration status. This output gives the detailed sta-
tus of the last calibration operation performed on the specified
channel.

0 = channel calibration command was successful

1 = channel reference error; the channel reference for the


specified input type has malfunctioned

2 = out of range error; the input source applied to the


IMASI13 module termination device is not connected prop-
erly or is outside of the range specified

3 = channel not calibrated error; applies when attempting


to set or reset the custom gain and offset of an uncali-
brated channel type

4 = NVRAM error

5 = analog to digital converter error

6 = point not on curve error; polarity of the input source


may be incorrect or the value specified by S5 does not cor-
respond with the input signal measured

NOTE: Even though this error has occurred, the IMASI13 module will still cali-
brate to these points. At least two point calibration commands must be issued
to observe the point not on curve error.
N+2 Selected gain adjustment. This output gives the value of the
specified gain adjustment. The default value is one.
N+3 Selected offset adjustment. This output gives the value of the
selected specified offset adjustment. The default value is zero.

The units for this value are ohms for an RTD input and volts
for high level and millivolt inputs.
N+4 Represents the status of the most recently issued calibration
command. Output information is organized in the format
shown.

217 - 6 WBPEEUI210504C0
Each decimal digit represents one type of status.

0 = command parameters were specified correctly

1 = S1 command code not valid; verify that there is a func-


tion code 216 configured for the point which is being cali-
brated

2 = S2 does not reference a valid IMASI13 module function


code 215 block

3 = S3 channel number not valid

4 = S4 calibration type invalid or not same as type already


in progress; verify that calibration type (function code 217,
S4) is consistent with configured signal type (function code
216, S4)

5 = S5 calibration point out of range for type of input spec-


ified by S4

10 = point not disabled

20 = point already disabled

30 = calibration point count error must be more than one


to enable point or less than 12 when performing point cali-
brations

40 = factory calibration data is lost; input module cannot


perform field calibration

50 = restore factory calibration operation failed due to an


NVRAM error.

100 = error occurred during channel calibration; refer to


N+1

1000 = input module not responding

2000 = expander bus test failed

9999 = calibration command currently processing

WBPEEUI210504C0 217 - 7
WBPEEUI210504C0
Phase Execution
Function Code 218

PHASEX The phase execution (PHASEX) function code provides the exe-
(2 18 )
S1 LEAD
B LO C K S TAT E N
cution environment for a Batch 90 program that is interfaced
S2 PHASE
S3
S PA R E ID N +1 to the Symphony batch management software. A Batch 90 pro-
S PA R E F LT
S4 CODE
S PA R E A B O R T
N +2 gram is comprised of all the phases that can be run on a spe-
N +3
S5
A B O R T AQ RD
S TAT N +4
cific class of equipment. The program is created, compiled and
S PA R E
N +5 downloaded to the controller using the Batch Data Manager
S PA R E
S PA R E
N +6 option of Composer. Recipes define the order in which the
N +7
Batch 90 phases are executed (the procedure) and the specific
formulation values such as target flow rates, temperatures
and times.

In this batch execution model, recipes are created and run


using the Symphony batch management software. The batch
manager sends the phase name and formulation data of the
active phase in the recipe to the PHASEX function block and
issues a start command. The PHASEX block executes the
phase logic. The batch manager monitors the state of the
PHASEX block and then automatically transitions to the next
phase defined in the recipe when the complete state is detected
for the phase.

PHASEX blocks can be linked to allow the simultaneous exe-


cution of parallel phases. A single PHASEX block and its asso-
ciated Batch 90 program is used to control an equipment
module. Linked PHASEX blocks and their associated Batch 90
programs are used to control a unit.

Outputs

Blk Type Description


N R Current state (enumerated value)
N+1 E90 string Current phase ID
N+2 R Fault code
N+3 B Abort
N+4 B Acquired status
N+5 R Spare
N+6 R Spare
N+7 B Spare

WBPEEUI210504C0 218 - 1
Specifications

Spec Tune Default Type Description


S1 N 5 R Lead PHASEX block
S2 N 2 R Spare input
S3 N 0 B Spare input
S4 Y 0 B Spare input
S5 N 0 B Block address of abort phase trigger
S6 N 0 R Spare parameter
S7 Y 0 R Spare parameter
S8 Y 0 R Spare parameter
S9 Y 0.0 R Batch program ID number
S10 Y 1 I Debug operation
S11 N 1.0 R RAM allocation for program object file (1k byte increments)
S12 N 1000 R RAM allocation for phase data (1 byte increments)

Explanation
Specifications
S1 (Lead PHASEX block) Block number of the lead PHASEX
block. Several PHASEX blocks associated with the same equip-
ment unit should reference the same lead PHASEX block. The
lead PHASEX block must have this input connected to block 5.
Other PHASEX blocks should connect this input to the first
output of the lead PHASEX block.
S2 through S4 Spare inputs.
S5 (Abort phase trigger) A zero to one transition transfers to the
abort phase. Once started, the abort phase must run to com-
pletion. Once the abort phase is completed, the state changes
from aborting to aborted. The aborted state can not be cleared
until this input is reset to zero. The abort input acts in parallel
with the batch manager command to abort. Only the lead
PHASEX block can have this input connected. Any linked
PHASEX block that is not the lead must leave this
specification at default value. Otherwise, it will cause a con-
troller configuration error.

0 = released
1 = abort

218 - 2 WBPEEUI210504C0
S6 through S8 Spare parameters.
S9 (Batch program ID number) Defines the ID number of the
batch program that the PHASEX block will execute. The pro-
gram ID number is specified in the batch program by the com-
piler directive #PROGRAMID. Only the lead PHASEX block will
use this specification.
S10 (Debug operation) Sets the debugger state:

1 = phase executes normally.

1000 = debug stop (A transition to 1000 causes a debug


stop command to be issued). This freezes execution at the
current statement of the active logic section.

1001 = debug go (A transition to 1001 causes a debug go


command to be issued). This resumes execution of the
active logic section from the statement number the phase
was frozen on (debug stopped).

9000 = debug stop at start. Causes the phase being acti-


vated to begin execution in the debug stopped state.
S11 (RAM allocation for program object file) Value indicates RAM
allocation in one-kilobyte increments. This specification can
not be changed during online configuration. The range is
determined by the amount of RAM in the controller. The mini-
mum amount of memory required to run the program is given
at the end of the Batch 90 program’s list file. The minimum
RAM required to allocate in the controller is also the size of the
program .OBJ file. Only the lead PHASEX block will use this
specification.
S12 (RAM allocation for data table) Value indicates RAM allocation
in one-byte increments. This specification value can not be
changed during online configuration. The range is determined
by the amount of RAM in the controller. The minimum amount
of memory required to run the program is given at the end of
the Batch 90 program’s list file. This memory is used to store
run-time data (batch data, unit data, parameter values) as well
as the phase data message. All linked PHASEX blocks should
have the same value of S12.

WBPEEUI210504C0 218 - 3
Outputs
N Current state of the PHASEX block. The state is represented
by the following values:

0 = idle
1 = running
2 = complete
3 = pausing
4 = paused
5 = holding
6 = held
7 = restarting
8 = stopping
9 = stopped
10 = aborting
11 = aborted
N+1 Phase ID of the running phase or the previous phase run (if
state is complete).
N+2 Fault code:

0 = none
positive = user defined faults
negative = system detected run-time faults
N+3 Execution has been aborted

0 = not aborting or aborted


1 = PHASEX block is in aborting or aborted state
N+4 PHASEX block is acquired. Set by the acquire command and
reset by the release command.

0 = available
1 = acquired
N+5 Spare float output.
N+6 Spare float output.
N+7 Spare Boolean output.

Run-Time Fault Codes


The PHASEX function block executes a series of diagnostic
tests that detect errors that cannot be detected by the

218 - 4 WBPEEUI210504C0
compiler. The fault codes can be seen using the batch debug-
ger or by viewing the PHASEX block output (N+2). The errors
are detectable only while the controller is in execution and are,
therefore, called run-time errors. Most of the PHASEX fault
codes are common with the BSEQ block (function code 148)
fault codes. Table 218-1 lists the possible error codes and an
explanation of each.

Table 218-1. PHASEX Run-Time Fault Codes

Fault Codes Explanation


Any positive Assigned (any positive number) by the user in the batch language program to
number indicate what type of fault has occurred. There is no limit to the number of fault
codes the user may assign.
-3.0 Stack System fault caused by a problem in the PHASEX firmware or the compiler.
overflow Contact ABB technical support.
-4.0 Error reading No batch program exists in the NVRAM memory that matches the number indi-
object file cated in specification S9 of the PHASEX function block. Normally this means
that the batch object file has not been downloaded to the controller, or specifi-
cation S9 of the PHASEX function block references an undefined program
number.
-5.0 Object file Batch program size exceeds the amount of controller memory allocated by
exceeds memory specification S11 of the PHASEX function block. Correct this problem by
allocation increasing specification S11.
-6.0 Phase data Phase data message and the program data can not fit in the memory allocated
message exceeds by specification S12 of the PHASEX function block. Correct this problem by
memory allocation increasing specification S12.
-7.0 Phase data Amount of data used by a phase exceeds the amount of memory allocated by
size exceeds specification S12 of the PHASEX function block. To correct, increase the value
memory allocation of specification S12 in the PHASEX function block.
Fault data - The block number of the lead PHASEX function block with the
problem.
-8.0 Illegal phase The phase data message contains the name of a phase which does not exist
name in phase in the program. This situation can happen when a batch program is edited so
data message that a phase subroutine is removed, but the corresponding recipes are not
changed. To correct, add the undefined phase subroutine or remove the called
(undefined) phase subroutine from the recipe.
Fault data:
0 = no phase data message was received.
>0 = the position of the invalid phase in the phase data message. For a sin-
gle phase, this is one. For a sequence of phases, this is the position of the
phase in the sequence.
-9.0 Batch The batch directory file does not exist or is unreadable. Format controller and
directory error reload necessary programs, recipes, and data files.

WBPEEUI210504C0 218 - 5
Table 218-1. PHASEX Run-Time Fault Codes (continued)

Fault Codes Explanation


-10.0 Recipe error The phase data message could not be parsed (i.e., it has an incorrect struc-
ture). Contact ABB technical support.
-12.0 Illegal Parameter data type conflict between the recipe and the batch program. To
parameter type correct, recompile the batch program and/or fix the recipe. Then download the
recompiled batch program and rerun the phase.
Fault data - Indicates the position of the invalid parameter in the phase data
message. The position has two components: the phase position and the
parameter position. For example, a fault data value of 1.2 indicates phase
position one and parameter position two.
-13.0 ESTOP/ Abort phase was triggered by the specification 5 input of the PHASEX function
Aborting from block. The fault is triggered when the abort phase is activated. Clear the fault
block input by issuing a reset when the PHASEX function block is in the aborted state.
-16.0 Bad function In the batch data declaration sections of the batch language, the program is
block reference trying to reference a function block that does not exist or one whose type does
not match the function code type in the declaration. The batch debugger will
provide the function block number within the batch data section that is making
the reference. To correct, change the function block number to a valid one,
erase the reference from the program, or correct the type to match the function
block in the controller.
-17.0 Array error Array subscript is out of bounds. Normal logic is suspended and execution of
fault logic begins. The statement number of the statement that caused the
fault.
-18.0 BCODE Batch program was compiled using firmware that does not match the firmware
revision mismatch in the controller. Recompile the batch program with the compiler that matches
the firmware within the controller.
-20.0 Invalid num- Recipe contains the wrong number of phase parameters compared to the tar-
ber of parameters get program. Normally, the recipe must be corrected. Otherwise, correct the
in phase data program.
-21.0 Invalid Attempted execution of a new program that differs from the previous one
online program because of a change in the batch data area or the local declaration section of
change the active phase subroutine. Such online changes are not permitted.
-25.0 Bad block Recipe used contains a reference to an incorrect or nonexistent block. Correct
reference in the block number in the recipe.
phase data
Fault data - Indicates the position of the invalid parameter in the phase data
message. The position has two components: the phase position and the
parameter position. For example, a fault data value of 1.2 indicates phase
position one and parameter position two.

218 - 6 WBPEEUI210504C0
Table 218-1. PHASEX Run-Time Fault Codes (continued)

Fault Codes Explanation


-27.0 Bad block Function block declaration in the unit data file does not match the controller
reference in Unit configuration. Either the function block address or the function code type is in
Data error. Resolve any discrepancies and recompile the unit data file against the
batch program.
-28.0 Bad CSEQ CSEQ reference in the unit data file does not match the program. Resolve any
reference in Unit discrepancies and recompile the unit data file against the batch program.
Data
-29.0 Unit Data Unit data file does not match the batch program structurally. (The number or
does not match the type of the declarations does not match). Resolve any discrepancies and
B90 program recompile the unit data file against the batch program.
-30.0 Error No unit data file exists (or is unreadable) in the NVRAM memory that matches
reading UNIT.DEF the number indicated by specification S9 of the PHASEX function block. Nor-
file mally this means that the unit data object file has not been downloaded to the
controller.
-32.0 String String position specified in the program is negative or larger than the maximum
subscript error size of the string. This error occurs during program execution and transfers the
program to fault logic.
-35.0 Illegal Recipe parameter name does not match the parameter name of the selected
parameter name phase in the program file. Check the recipe and program file and edit the
names to match.
Fault data - Indicates the position of the invalid parameter in the phase data
message. The position has two components: the phase position and the
parameter position. For example, a fault data value of 1.2 indicates phase
position one and parameter position two.
-36.0 Abort phase Batch program file does not contain a phase named Abort. Edit the batch pro-
not defined gram to contain the Abort phase, recompile the program, and then download it.
-37.0 Phase data Phase data as received by the PHASEX function block is out of order. Send
receipt error the phase data again.
-38.0 Program not The command was rejected because the program was inactive. Activate (ini-
active tialize or acquire) the program and issue the command again.

PHASEX Function Block Configuration Example


Figure 218-1 shows an example PHASEX function block con-
figuration.

Some important guidelines to remember about PHASEX pro-


gramming are:

• The lead PHASEX function block must have a lower num-


ber than the links.

WBPEEUI210504C0 218 - 7
PHASEX
S1 LEAD
(2 18 )
B L O C K S TAT E 4010
S2 PHASE
S PA R E ID
S3 4011
S PA R E F LT
CODE 4012
S4
S PA R E A B O R T
S5 4013
O N /O F F A B O R T ASQTAT
RD
4014
S PA R E
4015
S PA R E
ABORT 4016
S PA R E
IN P U T 4017 PHASEX PHASEX
S1 LEAD
(2 18 ) S1 LEAD
(2 1 8 )
S9 = 2 5 .0
B L O C K S TAT E 4020 B L O C K S TAT E 40 3 0
S10 = 1 S2 PHASE S2 PHASE
S PA R E ID S PA R E ID
S11 = 7 .0 S3 4021 S3 40 3 1
S PA R E F LT S PA R E F LT
S12 = 500 CODE 4022 CODE 40 3 2
S4 S4
S PA R E A B O R T S PA R E A B O R T
S5 4023 S5 40 3 3
A B O R T AQ RD
S TAT A B O R T AQ RD
S TAT
4024 40 3 4
S PA R E S PA R E
4025 40 3 5
S PA R E S PA R E
4026 40 3 6
S PA R E S PA R E
4027 40 3 7
S9 = 0 .0 S9 = 0 .0
S10 = 1 S10 = 1
S11 = 1 .0 S11 = 1 .0
S12 = 250 S12 = 250

PHASEX PHASEX
S1 LEAD
(2 18 ) S1 LEAD
(2 1 8 )
B L O C K S TAT E 4040 B L O C K S TAT E 40 5 0
S2 PHASE S2 PHASE
S PA R E ID S PA R E ID
S3 4041 S3 40 5 1
S PA R E F LT S PA R E F LT
CODE 4042 CODE 40 5 2
S4 S4
S PA R E A B O R T S PA R E A B O R T
S5 4043 S5 40 5 3
A B O R T AQ RD
S TAT A B O R T AQ RD
S TAT
4044 40 5 4
S PA R E S PA R E
4045 40 5 5
S PA R E S PA R E
4046 40 5 6
S PA R E S PA R E
4047 40 5 7
S9 = 0 .0 S9 = 0 .0
S10 = 1 S10 = 1
S11 = 1 .0 S11 = 1 .0
S12 = 250 S12 = 250
T03215A

Figure 218-1. PHASEX Function Block Configuration

• The lead and all linked PHASEX function blocks must be in


the same controller segment.

• It is recommended that no blocks be placed between lead


and linked function blocks.

• unitname_P1 is always the name of the tag used by the lead


PHASEX block. Linked blocks are named unitname_P2
through P32.

218 - 8 WBPEEUI210504C0
Common Sequence
Function Code 219

C SE Q The common sequence (CSEQ) function block serves as the


(2 1 9 )
S1
BS C# interface between the connected batch sequence (BSEQ) func-
S2 N
S3
CM B#
N+1 tion block and other (remote) batch sequences.
R E S RV L#
S4 N+2
OWN RSTS
S5
N /A OSTS
N+3 Outputs
S6 N+4
N /A N /A
N+5
S7
N /A N /A Blk Type Description
S8 N+6
N /A N /A
S9 N+7 N R CSEQ campaign number
N /A N /A
S10 N+8
N /A N /A
N+9 N+1 R CSEQ batch number
N+2 R CSEQ lot number
N+3 R CSEQ reservation status
N+4 R CSEQ ownership status
N+5 R Spare
N+6 R Spare
N+7 R Spare
N+8 R Spare
N+9 B Spare

Specifications

Spec Tune Default Type Range Description


S1 N 30 I Note 1 Block address of batch sequence block
S2 N 1 I Note 1 Block address of control mode select (boolean):
0 = operator (manual)
1 = remote (automatic)
S3 N 6 I Note 1 Block address of reserve allow input:
0.0 = reserve not permitted
1.0 = reserve permitted
S4 N 6 I Note 1 Block address of ownership allow input:
-1.0 = ownership not permitted, queue is off and flush
0.0 = ownership not permitted, queue is on
1.0 = ownership permitted, queue is on
2.0 = ownership permitted, queue is off
S5 N 2 I Note 1 Spare real input
S6 N 2 I Note 1 Spare real input
S7 N 2 I Note 1 Spare real input

WBPEEUI210504C0 219 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S8 N 2 I Note 1 Spare boolean input
S9 N 2 I Note 1 Spare boolean input
S10 N 2 I Note 1 Spare boolean input
S11 Y 1 R 0 - 9.2 E18 Status update minimum time (in secs)
S12 Y 120 R 0 - 9.2 E18 Status update maximum time (in secs)
S13 N 1 I Full Maximum number of program connections
S14 Y 0 I Full Spare parameter
S15 Y 0 I Full Spare parameter
S16 Y 0 R Full Spare parameter
S17 Y 0 R Full Spare parameter
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

Explanation
The following explanations describe each specification and
provide details of how the CSEQ block interfaces with the
BSEQ and batch historian (BHIST) function blocks.

Specifications
S1 Links the CSEQ block to a BSEQ block. The CSEQ block must
be connected to the first output (N) of the BSEQ block.
S2 Selects the control mode of the CSEQ block.

0 = operator mode (manual batch sequence control)


1 = remote mode (automatic batch sequence control)

In the operator mode, the batch sequence recipe, phase and


run/hold inputs control execution of the batch program.

Remote mode disables the batch sequence recipe, phase and


run/hold inputs and control of program execution is available
to other programs connected to the CSEQ block. Remote mode
disables the campaign, batch and lot number inputs to the
BHIST block. The campaign, batch, and lot numbers are
passed to the BHIST from the CSEQ block.

219 - 2 WBPEEUI210504C0
S3 Reserve allow input. The reserve allow input determines if the
CSEQ block may be reserved. Programs connected to the
CSEQ block may request to reserve the common sequence.
The act of reservation restricts future access to ownership
(remote program control) of the common sequence.

0.0 = reserve not permitted, delete current reservation


1.0 = reserve permitted
S4 Ownership allow block input. The CSEQ block may be owned
by only one program at a time. Specification S4 determines if a
CSEQ block may be owned. Program requests for ownership
that cannot be granted may be deferred to the ownership
queue for later execution. This input also determines the sta-
tus of the ownership queue.

-1.0 = ownership not permitted, ownership queue closed


and cleared

0.0 = ownership not permitted, ownership queue open

1.0 = ownership permitted, ownership queue open

2.0 = ownership permitted, ownership queue closed


S5 through S7 Spare real input.
S8 through S10 Spare boolean input.
S11 Minimum time (in seconds) between status updates. Thus,
S11 determines the maximum rate the CSEQ block reports
status data to connected programs. This specification can limit
the bus and loop traffic generated by rapidly changing CSEQ
status data.
S12 Defines the maximum time (in seconds) between updates. In
the event that CSEQ status data is unchanging, S12 deter-
mines the rate the CSEQ block checks the connection status
of connected programs.
S13 Defines the maximum number of program connections that
may be supported by the CSEQ block at once.
S14 through S17 Spare parameters.

WBPEEUI210504C0 219 - 3
Function Block Outputs
N (CSEQ campaign number) Shows the current campaign num-
ber of the BSEQ block.
N+1 (CSEQ batch number) Shows the current batch number of the
BSEQ block.
N+2 (CSEQ lot number) Shows the current lot number of the BSEQ
block.
N+3 (CSEQ reservation status) Shows if the CSEQ block is
reserved and which production variables (campaign, batch or
lot) of ownership requesting programs must match the reser-
vation. The value of N+3 is a three-digit integer:
X X X – Where the range is 000 through 111
lot number match required
batch number match required
campaign number match required
0 = no
1 = yes

Examples:

000 = CSEQ block not reserved


100 = campaign number must match
011 = batch and lot numbers must match
111 = campaign, batch and lot numbers must match
N+4 (CSEQ ownership status) Shows if a remote program owns the
CSEQ block.

0.0 = CSEQ block not owned


1.0 = CSEQ block owned
N+5 through N+9 Spare outputs.

Application
The primary objective of the CSEQ block is to reduce the num-
ber of function codes required to implement batch manage-
ment or unit management program structures. In a common
sequence configuration, the CSEQ block provides the interface
between two BSEQ blocks. This interface serves as a
communication path established by one batch sequence (cli-
ent) connecting to a second batch sequence (server).

219 - 4 WBPEEUI210504C0
In order for a client program to gain control of a CSEQ block
(server program), the client program must acquire ownership
of the server. The client program that has acquired ownership
of the CSEQ block (server) may perform the following opera-
tions on the server via the CSEQ block:

• Select the recipe and phase and start or restart the


program.

• Select the program to execute.

• Put the program into hold logic.

• Send command-variables to the CSEQ block.

• Unacquire (release ownership of) the CSEQ block.

In this manner, the client to server relationship between pro-


grams, with the client potentially controlling the server pro-
gram execution, is possible with the use of CSEQ blocks. One
program may be the owner (client) of a second program or
CSEQ (server) block, and be a server or common sequence to a
third program. Figure 219-1 shows an example of a production
train that illustrates this point.

U N IT 1 U N IT 2 U N IT 3
P RO G R A M X P RO G R A M Y P RO G R A M Z
B SE Q B L O C K B SE Q B LO C K B SE Q B LO C K
C S EQ B LO C K C S E Q B LO C K C S E Q B LO C K
P RO G R A M X : P RO G R A M Y : P RO G R A M Z :
C L IE N T TO U N IT 2 C L IE N T TO U N IT 3 C L IE N T TO N E X T U N IT
S E RV E R T O S E RV E R T O S E RV E R T O
P R E V IO U S U N IT U N IT 1 U N IT 2
T 01 9 56 A

Figure 219-1. Example Production Train

In Figure 219-1, the BSEQ block performs its usual role of


executing the batch program. The CSEQ block provides the
interface by which the program may be shared and controlled
by other batch programs.

In the operator mode, the BSEQ block controls execution of


the batch program normally. Recipe, phase and run/hold
inputs to the BSEQ block control program execution. In this
mode the BHIST block buffers data for batch records by batch
and lot numbers selected by the BHIST inputs.

WBPEEUI210504C0 219 - 5
The remote mode disables the BSEQ block recipe, phase and
run/hold inputs and the BHIST block campaign, batch and lot
number inputs. The CSEQ block gains control of these inputs
in the remote mode. Once a connected program acquires own-
ership of the CSEQ block, the program that owns the CSEQ
block controls these inputs to the BSEQ and BHIST blocks.

NOTE: The E-STOP (executed stop) and operator acknowledge inputs to the
BSEQ remain enabled in both modes. The operator can suspend batch
sequence execution despite the CSEQ mode.

All connected programs receive status information from the


CSEQ block. Specifications S11 and S12 control the rate of
transmission. The CSEQ block can only have one owner at a
time and only the owner can send commands to the CSEQ
block. The CSEQ block can be reserved with production ID
numbers (campaign, batch and lot). This restricts future own-
ership of the CSEQ block to programs belonging to related pro-
duction runs.

Before a program can communicate with a CSEQ block it must


establish a connection to the CSEQ block. The CSEQ block
has a configurable limit (S13) on the number of connections it
can support at once. When a program is no longer interested
in a CSEQ block, it may unconnect from the CSEQ block.
Thus, making the connection slot available to other programs.
While a CSEQ block is connected, the following data is avail-
able to all connected programs:

• Connection status.
• Reservation status.
• Ownership status.
• Control mode.
• Program status (inactive, running, holding).
• Recipe number.
• Phase number.
• Fault code.
• Campaign, batch and lot numbers.
• Eight status variables.

Table 219-1 provides a description of the specification settings


for that CSEQ block in Figure 219-2. Figure 219-2 is an exam-
ple of a common sequence. Once there is a connection between
the BSEQ block and the S1 input of the CSEQ block, no other
connection to function blocks is required.

219 - 6 WBPEEUI210504C0
Table 219-1. Function Code 219 Specification Settings for Figure 219-2

Spec Value Description


S1 N Block address N of the BSEQ links the CSEQ to the batch unit controlled by the
BSEQ and its associated programs.
S2 N+1 The TSTALM block provides the boolean signal determined by the mode of the
BSEQ control pushbutton.
S3 5 Default value (BLK ADDR 5 = 0.0) determines that reservation of this CSEQ is
not permitted. This application does not use the RESERVE feature of the
CSEQ structure.
S4 6 Default value (BLK ADDR 6 = 1.0) determines that ownership of the CSEQ is
permitted and the acquire request queue is enabled. Thus, if the CSEQ is not
owned, acquire requests are granted; if it is owned, requests will be stored.
S5 - S10 — Spare inputs. Use default values.
S11 1 Default value of 1.0 limits the maximum rate at which the CSEQ generates
exception reports to no more than one message per second. This puts a limit to
the amount of loop and bus traffic that the CSEQ may inject to the system.
S12 60 Default value of 60.0, in the event of unchanging common sequence status
data, determines the rate at which the CSEQ sends a message to verify the
CONNECTION status of all connected programs.
S13 2 With a value of 2 selected, the CSEQ can support 2 connected programs
(e.g., current owner, next owner).
S14 - S17 — Spare parameters. Use default values.

WBPEEUI210504C0 219 - 7
R E C IPE
S5
(6 8)
S6 R EM SET
N

P H AS E
S5
(6 8)
S6 R EM SET
N
B SE Q
BSE Q (1 48 )
S1
C O N T RO L PB R# R#
S2 N
M S DV D R PH# PH#
S1 (3 4) S3 N +1
S1 (3 3) S1 (1 29 ) S RU N RU N
NOT I1 1 N S4 N +2
N S2 N S1 AC K F LT
I2 2 (3 9) S2 S5 N +3
S3 N +1 S2 OR R ESP H
F1 3 N S6 N +4
S4 N +2 DB BC
F2 ST S3 S7 N +5
S5 N +3 I N /A R
F3 N +6
S6 FC
F4 N +7
S1 (3 5) S 25 CS#
T D -D IG 0 N +8
N

AC K N OW L E D G E
PB
RCM (6 2)
S1 S
S2 N
P
S3
R
S4 O
S5 I
S6 F
S7
A

B H IS T
S 12 (2 20 )
BSEQ S TS
S 13 N
C A M PA IG N C# S TS 1
S 14 N +1
B# S TS 2
S5 S 15 N +2
(6 8) L# S TS 3
S6 R EM SE T S 16 N +3
N C HK S TS 4
S 17 N +4
S PA R E S TS 5
S 18 N +5
S PA R E S TS 6
B AT C H N +6
S TS 7
N +7
S5 S TS 8
T S TA L M C S EQ (6 8) N +8
(6 9) B S E Q C O N T RO LM O D E S1 (2 19 ) S6 R EM SE T N
C#
H BS C# N +9
N (1 = R E M OT E , 0 = O P E R ATO R ) S2 N B#
L CM B# N +10
N +1 S3 N +1 L#
R E S RV L# N +11
S4 N +2 L OT E#
N +12
OWN RSTS
S5 N +3 S PA R E
N /A OSTS S5 N +13
S6 N +4 (6 8)
N /A N /A S6 R EM SE T
S7 N +5 N
N /A N /A
S8 N +6
N /A N /A
S9 N +7
N /A N /A
S 10 N +8
N /A N /A
N +9

B SE Q C O N TR O L P U S H BU T TO N N OT E S :
1 . IN M A N UA L M O D E , T H E O P E R ATO R S E L E C T S B S E Q C O N T R O L
B S E Q TAG BSEQ DESC TEXT S TATU S B Y P U TT IN G T H E M S D D EIT H E R IN R U N , H O LD O R E -S TO P.

O U T P U T S TAT E 3 RU N RU N N IN G F B IN P U T 1 2 . IN AU TO M O D E , T H E C S E Q E N A B LE S R E M O TE P R O G R A M S TO
O U T P U T S TAT E 2 E -S TO P FAU LT F B IN P U T 2 C O N T R O L T H E B S EQ R EC IP E , P H A SE A N D RU N /H O L D IN P U TS .
O U T P U T S TAT E 1 HOLD H O L D IN G F B IN P U T 3
D E FAU LT S TAT E AU TO DONE F B IN P U T 4

M O D E : AU TO /M A N UA L MSDD M ODE
T 01 9 57 A

Figure 219-2. Typical Batch Sequence Control

219 - 8 WBPEEUI210504C0
Batch Historian
Function Code 220

BH IST The batch historian (BHIST) function code supports the batch
(2 2 0 )
S12
BSEQ STS historian feature of Batch 90. This function block resides
S13 N
S14
C# S T S1
N+1 within the module and is part of the overall function code con-
B# S T S2
S15
L# S T S3
N+2 figuration. It links to the batch sequence block (BSEQ, func-
N+3
S16
CHK S T S4 tion code 148) and provides a buffer between a Batch 90
S17 N+4
S18
S PA R E S T S5
N+5 program and the batch historian and queues that information
S PA R E S T S6
S T S7
N+6 into the BHIST block. When a new event is added to the block,
N+7
S T S8 the BHIST block generates an exception report telling the his-
N+8
C#
N+9 torian that more data needs to be stored. The batch historian
B#
L#
N + 10 then polls the information from the BHIST block and stores it
N + 11
E# to disk. Each BHIST block can output data to up to eight his-
N + 12
S PA R E
N + 13 torians. For detailed information on the batch historian, refer
to the Batch Data Manager instruction.

Outputs

Blk Type Description


N B Summary status:
0 = not all bad
1 = all bad
N+1 R Status of historian 1:
-1 = not expected
0 = good
1 = bad
N+2 R Status of historian 2:
-1 = not expected
0 = good
1 = bad
N+3 R Status of historian 3:
-1 = not expected
0 = good
1 = bad
N+4 R Status of historian 4:
-1 = not expected
0 = good
1 = bad
N+5 R Status of historian 5:
-1 = not expected
0 = good
1 = bad

WBPEEUI210504C0 220 - 1
Outputs (continued)

Blk Type Description


N+6 R Status of historian 6:
-1 = not expected
0 = good
1 = bad
N+7 R Status of historian 7:
-1 = not expected
0 = good
1 = bad
N+8 R Status of historian 8:
-1 = not expected
0 = good
1 = bad
N+9 R Campaign number
N+10 R Batch number
N+11 R Lot number
N+12 R Event number
N+13 R Spare

Specifications

Spec Tune Default Type Range Description


S1 Y 0 I 0-1 Historian 1 expected; 0 = no, 1 = yes
S2 Y 0 I 0-1 Historian 2 expected; 0 = no, 1 = yes
S3 Y 0 I 0-1 Historian 3 expected; 0 = no, 1 = yes
S4 Y 0 I 0-1 Historian 4 expected; 0 = no, 1 = yes
S5 Y 0 I 0-1 Historian 5 expected; 0 = no, 1 = yes
S6 Y 0 I 0-1 Historian 6 expected; 0 = no, 1 = yes
S7 Y 0 I 0-1 Historian 7 expected; 0 = no, 1 = yes
S8 Y 0 I 0-1 Historian 8 expected; 0 = no, 1 = yes
S9 Y 0 I -1 - 2 Error action:
-1 = disabled (always start immediately)2
0 = always start (after start event read or failed)
1 = start if any historian is good
2 = start only if all historians are good
S10 Y 120 I Full Time-out time (secs)
S11 N 300 I Full Buffer size (bytes)
S12 N 2 I Note 1 Block address of BSEQ block

220 - 2 WBPEEUI210504C0
Specifications (continued)

Spec Tune Default Type Range Description


S13 N 2 I Note 1 Block address of campaign number input
S14 N 2 I Note 1 Block address of batch number input
S15 N 2 I Note 1 Block address of lot number input
S16 N 2 I Note 1 Block address of check ID input
S17 N 2 I Note 1 Block address of spare input
S18 N 2 I Note 1 Block address of spare input
S19 Y 0 I Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. Available in firmware revision G_0 or later.

Explanation
Specifications
S1 through S8 Identify the historian expected. Up to eight batch historians
can monitor the BHIST block. Each historian has an option
page for specifying the historian number (one through eight).
All specifications that match a historian number specified on
the option page should be set to one. For example, if historians
one and four are used and specified on the option page, S1
and S4 must be set to one, S2, S3, S5 and S8 must be set to
zero.
S9 Determines how the Batch 90 program will respond to batch
historian status on a start/restart transition. Specification S9
has no effect if an active batch historian goes off-line while the
batch program is running.

A start event is defined as a hold-to-run transition following a


batch-complete state, or initial start. The start event is
affected by S9 as follows:

-1 = The program always starts without regards to any his-


torian status. The start event is placed in the historian
buffer, and the program starts immediately. Note that if the
historian buffer becomes full before the historian reads the
start event, the event will be lost.

0 = The program always starts, but only after the start


event is read from the buffer by all expected historians, or

WBPEEUI210504C0 220 - 3
all expected historians are marked bad (i.e., the historian
time out time, S10, expires). Note that the program start
will be delayed by the time required for all good historians
to read the event, or the historian time out time, whichever
is less. During the delay output N+7 of the BSEQ block will
indicate a fault code -23.

1 = The program starts only if at least one expected histori-


ans is good, but only after the start event is read from the
buffer by all good historians. Note that the program start
will be delayed by the time required for all good historians
to read the event from the buffer. During the delay output
N+7 of the BSEQ block will indicate a fault code -23. If the
historian time out time, S10, expires before all expected
historians read the event, the program will start only if at
least one historian read the start event, otherwise, it will
not start, and output N+7 of the BSEQ block will indicate
fault code -24.

2 = The program starts only if all expected historians are


good, but only after the start event is read from the buffer
by all expected historians. Note that the program start will
be delayed by the time required for all expected historians
to read the event from the buffer. During the delay output
N+7 of the BSEQ block will indicate a fault code -23. If the
historian time out time, S10, expires before all expected
historians read the event, the program will not start, and
output N+7 of the BSEQ block will indicate fault code -24.

A re-start event is defined as a hold-to-run transition following


a holding state. The re-start event is affected by S9 only as fol-
lows:

-1 = The program always re-starts regardless of any histo-


rian activity. The re-start event is placed in the historian
buffer, and the program re-starts immediately. Note that if
the historian buffer becomes full before the historian reads
the re-start event, the event will be lost.

0,1, or 2 = The program always re-starts, but only after the


re-start event is read from the buffer by all good historians,
or historian time out time, S10, expires. Note that the pro-
gram re-start will be delayed by the time required for all
good historians to read the event, or the historian time out
time, whichever is less. During the delay output N+7 of the
BSEQ block will indicate a fault code -23.

220 - 4 WBPEEUI210504C0
S10 Determines how long the BHIST function block waits for
acknowledgment before marking a batch historian bad. Bad
historians that resume taking events from the BHIST block are
marked good. If a historian is bad on a hold to run transition,
the batch program will not start running until the time set in
S10 expires (unless S9 is set to -1, in which case the program
will start immediately). Note that once a historian is flagged as
bad (i.e., its corresponding output N+1 through N+8 is set to
one), a new time-out period is not granted so long as the status
is marked bad, regardless of the BSEQ hold/run state (i.e., the
timing period only applies to a good historian before flagging it
as bad).
S11 Sets the amount of RAM, in one byte increments, that is used
for holding the event and watch events before data is overwrit-
ten. The average event is 20 bytes. The send message to the
historian is 100 bytes. Under normal operation, the historian
will typically poll the event data from the BHIST block at a
maximum of every 20 seconds.
S12 Connected to the lowest block address (N) of the batch
sequence function block (BSEQ) controlling the batch program
(Fig. 220-1).
S13 Connected to the function block that defines the batch cam-
paign number. Campaign number can be used by the common
sequence function block (CSEQ).
S14 Connected to the function block that defines the batch num-
ber. Batch number specifies the batch file name of the BSEQ
data saved in the batch historian.
S15 Connected to the function block that defines the batch lot
number. Lot number specifies the lot file name of the BSEQ
data saved in the batch historian. On a complete to run transi-
tion, both the batch and lot numbers are locked in. They can-
not be changed until the program completes.

NOTE: Alphanumeric campaign, batch, and batch lot IDs are supported by
connecting S13, S14, and S15 respectively to the N+1 ST output of a DATA
EXPT (function code 194) or DATA IMPT (function code) function block. The
batch program must include the #ALPHA compiler directive in order to support
alphanumeric recipe IDs.
S16 Checks the historian function block to verify that the current
batch and lot number (identified by S14 and S15) are unique.

WBPEEUI210504C0 220 - 5
If <S16> equals zero, it does not check for unique batch and
lot numbers. If <S16> equals one, it checks for unique batch
and lot files.
S17, S18 and S19 Reserved for future use.

R E AC TO R K A BATC H SE Q U E N C E
K A-R EC IP E L O G IC BAT C H ID = 1

S5 BS EQ
(6 8 ) S1 (1 4 8 )
S6 R E M SE T R# R#
300
309 S2
PH# PH#
S3 301
RU N RU N
K A-PH A S E S4 302
AC K F LT
S5 303
S5 ESP H
(6 8 ) S6 304 S1 (3 3 )
S6 R E M SE T DB BC
305
NOT
310 S7 N
N /A R
S1 (3 3 ) 306
NOT FC
307
312
K A-STAR T CS#
308
S1
RCM (6 2 ) TH IS B AT C H SE Q U E N C E
S B L O C K C O N T RO L S
S2 311
P R E AC TO R A
S1 (3 5 ) S3
T D -D IG R
313 S4
O
S5
I
S6
F
S7
A TH IS B AT C H H ISTO R IA N BL O C K
B EL O W C O L L E C TS H ISTO R IC A L
DATA G E N E R AT ED B Y R EAC TO R A
A N D SE N D S IT TO T H E
B AT C H H ISTO R IA N
BH IST
S12 (2 2 0 )
BSEQ STS
S13 360
C# STS1
B AT C H N U M BE R S14 361
FO R R EAC TO R A B# STS2
S15 362
L# STS3
S5 S16 363
(6 8 ) CHK STS4
S6 R E M SE T S17 364
374 S PA R E S T S 5
S18 365
S PA R E S T S 6
366
STS7
367
STS8
L OT N U M BE R 368
FO R R EAC TO R A C#
369
B#
S5 370
(6 8 ) L#
S6 R E M SE T E#
371
375
372
S PA R E
373

T 01 9 58 A

Figure 220-1. Example of BHIST Function Block Configuration

220 - 6 WBPEEUI210504C0
Outputs
N Shows the overall status of the historians communicating with
the BHIST block. If this output is zero, at least one batch his-
torian is marked good. If this output is one, all expected batch
historians are bad.
N+1 through Indicate the status of historians one through eight. If any of
N+8 these outputs are zero, that batch historian is active and oper-
ating correctly. If any of these outputs are one, the batch his-
torian is expected, but it is not emptying the buffer within the
time set by specification S10.
N+9 through Indicate which campaign (N+9), batch (N+10) and lot (N+11)
N+11 numbers were locked in on a complete to run transition. Typi-
cally these outputs are used to track remote manual set con-
stants so that the operator can see the actual numbers being
used.
N+12 Exception report output. The event number is zero until the
batch program begins executing. This output increments by
one every time a new item is inserted into the BHIST block
event queue.

WBPEEUI210504C0 220 - 7
WBPEEUI210504C0
I/O Device Definition
Function Code 221

IO D /D E F The I/O device definition function code supports multichannel


S2
C H 01 Harmony I/O blocks. Each Harmony I/O block incorporates a
S3
S4
C H 02
specific combination of channel data types (digital input, digi-
C H 03
S5
C H 04
tal output, analog input, and analog output). Function code
S6
C H 05 221 is used to make appropriate assignments of function
S7
S8
C H 06
codes 222 through 225 to Harmony I/O block channels. Defi-
C H 07
S9
C H 08
nition of this function code is required for all Harmony I/O
S 10
C H 09 blocks. Application tables in this section provide usage exam-
S 11
S 12
C H 10
ples.
C H 11
S 13
C H 12
S 14
C H 13
NOTES:
S 15
C H 14 1. Function code 221 tunable specifications are not adaptable.
S 16
C H 15
S 17
S 18
C H 16 2. This function code is used to support Harmony I/O blocks only.
C H 17
S 19
S 20
C H 18
3. All HSOE points (HSOE enabled with S10=1 of FC224) must be con-
C H 19
S 21
C H 20
strained to the first sixteen channels (S2 through S17) of the associated I/O
S 22
S 23
C H 21 device definition (FC221).
C H 22
S 24
C H 23
S 25 Outputs
C H 24
S 26
P E R M IT
S 29
C JR
Blk Type Description
S 31
S PA R E
S 33 N B Primary I/O block status with quality
S PA R E
(2 21 ) P R IM A RY N+1 B Backup I/O block status with quality
N S TAT U S
BACKUP
N +1 S TAT U S N+2 B Channel in override/simulation with quality
OV R /S IM
N +2
S PA R E N+3 B Spare output with quality
N +3
R E S E RV E D
N +4 N+4 R4 Reserved output with quality

The control system must be carefully evaluated to estab-


WARNING lish default values that will prevent personal injury and/or
property damage in the case of I/O block failure.

Specifications

Spec Tune Default Type Range Description


S1 N NULL String 0 - 32 32-character device label
S2 N 2 I Note 1 Block address of channel 1
S3 N 2 I Note 1 Block address of channel 2

WBPEEUI210504C1 221 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S4 N 2 I Note 1 Block address of channel 3
S5 N 2 I Note 1 Block address of channel 4
S6 N 2 I Note 1 Block address of channel 5
S7 N 2 I Note 1 Block address of channel 6
S8 N 2 I Note 1 Block address of channel 7
S9 N 2 I Note 1 Block address of channel 8
S10 N 2 I Note 1 Block address of channel 9
S11 N 2 I Note 1 Block address of channel 10
S12 N 2 I Note 1 Block address of channel 11
S13 N 2 I Note 1 Block address of channel 12
S14 N 2 I Note 1 Block address of channel 13
S15 N 2 I Note 1 Block address of channel 14
S16 N 2 I Note 1 Block address of channel 15
S17 N 2 I Note 1 Block address of channel 16
S18 N 2 I Note 1 Block address of channel 17
S19 N 2 I Note 1 Block address of channel 18
S20 N 2 I Note 1 Block address of channel 19
S21 N 2 I Note 1 Block address of channel 20
S22 N 2 I Note 1 Block address of channel 21
S23 N 2 I Note 1 Block address of channel 22
S24 N 2 I Note 1 Block address of channel 23
S25 N 2 I Note 1 Block address of channel 24
S26 N 0 I Note 1 Block address of override/status error inhibit/simula-
tion permit
S272 Y 0 B 0 or 1 Device status error inhibit
S28 N 0 B 0 or 1 Redundant I/O block expected
S29 N 2 I Note 1 Block address of cold junction reference
S30 Y NULL String 0 - 32 32-character user scratch area
S31 N 2 I Note 1 Reserved for future use
S32 N 0 I Full Reserved for future use
S33 N 0 I Note 1 Block address of next SOE device definition
S34 N 0 I Full Spare

221 - 2 WBPEEUI210504C1
Specifications (continued)

Spec Tune Default Type Range Description


S35 N 0.0 R Full Spare
S36 Y 0.0 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. The specification value active state is permitted to operate only when S26 of the device definition is enabled.

Explanation
Specifications
S1 (Device label) Device label of string data type used as a logical
address of the Harmony I/O block. This label must match the
device label configured in the Harmony I/O block. The device
label can be up to 32 characters long. For proper operation,
the label cannot be null.
S2 through S25 (Block addresses of channels) Link the I/O device definition
function code 221 to the channel function codes (function
codes 222 through 225). The channel function codes actually
process the data for each I/O point at the I/O block level. The
function codes that are supported are analog in/channel func-
tion code 222, analog out/channel function code 223, digital
in/channel function code 224, and digital out/channel func-
tion code 225. The relative order in the list of channels helps to
specify the physical channel in the Harmony I/O block. Each
channel function code must match the type of the physical
channel on a particular Harmony I/O block. The default value
indicates that the I/O channel is not used.
S26 (Block address of override/status error inhibit/simulation
permit) Links to a function block which will provide a boolean
indication as to whether a particular feature is permitted. If
the value from the attached boolean output is zero, no over-
ride, status error inhibit, or simulation is permitted on any
channel. If the value from the attached boolean output is one,
override, status error inhibit, or simulation of any channel is
permitted. This specification has no effect on the BRC-100
Harmony simulation block (SIM-100) simulation operation.
S27 (Device status error inhibit) If set to one, this specification
inhibits all device or channel errors of this Harmony I/O block
from being included in the BRC-100 controller status. The

WBPEEUI210504C1 221 - 3
default value causes all block and channel errors to be
included in the BRC-100 controller status if not otherwise
inhibited at the channel level.
S28 (Redundant I/O block expected) If this specification is set to
one, a redundant I/O block is always expected. If a redundant
I/O block is not found (function code 221 output N+1 = 1 and
has bad quality), the BRC-100 controller generates a block
problem report. If set to a 0 then no redundant device is
expected, but may exist.
S29 (Block address of cold junction reference) Links a point which
may be used as the cold junction reference (CJR) temperature
in degrees Centigrade for thermocouple analog inputs. The
default value indicates that no point is referenced as a cold
junction reference.
S30 (User scratch area) Provides a 32 character storage space for
user string data. The space must be defined before the config-
uration is executed. Existing characters can be changed in the
online mode, but the controller must be placed in the configu-
ration mode to change the amount of characters in the field.
S31 Reserved for future use.
S32 Reserved for future use.
S33 (Block address of the next HSOE device definition) Block
address of the next I/O device definition. This specification is
only required when the inputs used by the I/O device defini-
tion are being used as part of a Harmony sequence of events
system.
S34 through S36 Spare.

Outputs
The I/O device definition function code 221 has the following
block outputs: primary I/O block status, backup I/O block
status, channel was put in override or simulation flag, and two
spares. The I/O block status outputs are the error summary of
the I/O block’s overall operational status (i.e., Harmony net-
work, redundancy, power, and configuration status) and error
summary of all configured channels.

221 - 4 WBPEEUI210504C1
N Primary I/O block status (0 = good, 1 = bad). Quality is set bad
when function code 221 cannot communicate with the primary
I/O block (N).
N+1 Backup I/O block status (0 = good, 1 = bad). Quality is set bad
when function code 221 cannot communicate with the backup
I/O block (N+1).
N+2 Channel in override/simulation (0 = no, 1 = yes). One or more
of the I/O block channels are in either override or simulation
mode. Quality is always set to good.
N+3 Spare output with quality always set good.
N+4 Reserved output with quality always set good.

NOTE: Can be referenced by Control Station (function code 80) for a


non-bypass station application using a SAC station connected to a control I/O
(CIO) block. Refer to the explanation of S28 of function code 80 for more infor-
mation.

Application
Tables 221-1 through 221-6 show how function codes 221
through 225 are used in operation with the following Harmony
I/O blocks:

Analog input blocks: AIN-120, AIN-200, AIN-220, AIN-300


Analog output block: AOT-150
Control I/O block: CIO-100
Digital input block: DIN-400
Digital I/O block: DIO-400
Digital output blocks: DOT-100, DOT-120

Specifications S2 through S25 contain the block address of the


applicable channel function code. Function code 221 specifica-
tions for any unused channels should be set to 2.

WBPEEUI210504C1 221 - 5
Table 221-1. Analog Input Block

Specification Channel No. Physical Channel Applicable Channel Function Code


S2 1 Analog input 1 Analog in/channel (function code 222)
S3 2 Analog input 2
S4 3 Analog input 3
S5 4 Analog input 4
S6 5 Analog input 5
S7 6 Analog input 6
S8 7 Analog input 7
S9 8 Analog input 8 Analog in/channel (function code 222)
S10 9 Analog input 9
S11 10 Analog input 10
S12 11 Analog input 11
S13 12 Analog input 12
S14 13 Analog input 13
S15 14 Analog input 14
S16 15 Analog input 15
S17 16 Analog input 16
S18 Internal cold junction reference (AIN-200 and AIN-220 only)
S19 through S25 15 through 24 Unused Not applicable

221 - 6 WBPEEUI210504C1
Table 221-2. Analog Output Block

Physical
Specification Channel No. Applicable Channel Function Code
Channel
S2 1 Analog output 1 Analog out/channel (function code 223)
S3 2 Analog output 2
S4 3 Analog output 3
S5 4 Analog output 4
S6 5 Analog output 5
S7 6 Analog output 6
S8 7 Analog output 7
S9 8 Analog output 8
S10 9 Analog output 9
S11 10 Analog output 10
S12 11 Analog output 11
S13 12 Analog output 12
S14 13 Analog output 13
S15 14 Analog output 14
S16 15 Analog output 15
S17 16 Analog output 16
S18 through S25 15 through 24 Unused Not applicable

Table 221-3. Control Input/Output

Specification Channel No. Physical Channel Applicable Channel Function Code


S2 1 Analog input 1 Analog in/channel (function code 222)
S3 2 Analog input 2
S4 3 Analog input 3
S5 4 Analog input 4
S6 5 Analog output 1 Analog out/channel (function code 223)
S7 6 Analog output 2
S8 7 Digital input 1 Digital in/channel (function code 224)
S9 8 Digital input 2
S10 9 Digital input 3
S11 10 Digital input 4

WBPEEUI210504C1 221 - 7
Table 221-3. Control Input/Output (continued)

Specification Channel No. Physical Channel Applicable Channel Function Code


S12 11 Digital output 1 Digital out/channel (function code 225)
S13 12 Digital output 2
S14 13 Digital output 3
S15 14 Digital output 4
S16 through S25 15 through 24 Unused Not applicable

Table 221-4. Digital Input Block

Specification Channel No. Physical Channel Applicable Channel Function Code


S2 1 Digital input 1 Digital in/channel (function code 224)
S3 2 Digital input 2
S4 3 Digital input 3
S5 4 Digital input 4
S6 5 Digital input 5
S7 6 Digital input 6
S8 7 Digital input 7
S9 8 Digital input 8
S10 9 Digital input 9
S11 10 Digital input 10
S12 11 Digital input 11
S13 12 Digital input 12
S14 13 Digital input 13
S15 14 Digital input 14
S16 15 Digital input 15
S17 16 Digital input 16
S18 17 Digital input 17
S19 18 Digital input 18
S20 19 Digital input 19
S21 20 Digital input 20
S22 21 Digital input 21
S23 22 Digital input 22
S24 23 Digital input 23
S25 24 Digital input 24

221 - 8 WBPEEUI210504C1
Table 221-5. Digital Input/Output Block

Specification Channel No. Physical Channel Applicable Channel Function Code


S2 1 Digital input 1 Digital in/channel (function code 224)
S3 2 Digital input 2
S4 3 Digital input 3
S5 4 Digital input 4
S6 5 Digital input 5
S7 6 Digital input 6
S8 7 Digital input 7
S9 8 Digital input 8
S10 9 Digital input 9
S11 10 Digital input 10
S12 11 Digital input 11
S13 12 Digital input 12
S14 13 Digital input 13
S15 14 Digital input 14
S16 15 Digital input 15
S17 16 Digital input 16
S18 17 Digital output 1 Digital out/channel (function code 225)
S19 18 Digital output 2
S20 19 Digital output 3
S21 20 Digital output 4
S22 21 Digital output 5
S23 22 Digital output 6
S24 23 Digital output 7
S25 24 Digital output 8

WBPEEUI210504C1 221 - 9
Table 221-6. Digital Output Block

Specification Channel No. Physical Channel Applicable Channel Function Code


S2 1 Digital output 1 Digital out/channel (function code 225)
S3 2 Digital output 2
S4 3 Digital output 3
S5 4 Digital output 4
S6 5 Digital output 5
S7 6 Digital output 6
S8 7 Digital output 7
S9 8 Digital output 8
S10 9 Digital output 9
S11 10 Digital output 10
S12 11 Digital output 11
S13 12 Digital output 12
S14 13 Digital output 13
S15 14 Digital output 14
S16 15 Digital output 15
S17 16 Digital output 16
S18 through S25 17 through 24 Unused Not applicable

221 - 10 WBPEEUI210504C1
Analog In/Channel
Function Code 222

IO C /A IN The exception reporting analog in/channel function code pro-


S9 SHPG vides addressing, startup, run-time, override, and failure mode
S18 (2 2 2)
S25
S IM AI specifications for an individual or redundant pair of analog
NEXT
input channels on a Harmony I/O block or an S800 I/O mod-
ule. The analog in/channel function code must reside in the
same segment as the I/O device definition function code 221
or foreign device definition function code 228 to which it is
mapped. This function is required for all configured analog
input block channels.

NOTES:
1. This function code is used to support Harmony I/O blocks and S800 I/O
modules only. Refer to the IOR-800 Gateway instruction for specific differ-
ences between Harmony I/O and S800 I/O.

2. Function code 222 tunable specifications are not adaptable.

3. The block address for the cold junction reference is specified in the I/O
device function code 221. Filtered thermocouples must utilize the on-board ref-
erence.

Outputs

Blk Type Description


N R4 Analog input value (in specified EUs) with quality.

Specifications

Spec Tune Default Type Range Description


S1 N NULL String 0 - 32 32-character channel label
S2 N 0 I Note 2 Input type
S3 N 0.0 R Full Engineering units low value
S4 N 100.0 R Full Engineering units high value
S5 N 0 I 0 - 255 Engineering units identifier
S6 Y 100.0 R Full Engineering units high alarm
S7 Y 0.0 R Full Engineering units low alarm
S8 Y 0.0 R Full Engineering units significant change
S9 N 2 I Note 1 Block address of input shaping algorithm
S10 N 0 B 0 or 1 Engineering unit conversion/shaping algorithm precedence

WBPEEUI210504C1 222 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S11 N 0.0 R Full Lead wire resistance
S12 N 0 I 0 - 16 A/D conversion resolution
S13 N 0.0 R Full Custom range low limit (in volts)
S14 N 0.0 R Full Custom range high limit (in volts)
S15 N 0 B 0 or 1 Normal input/undefined
S16 Y 0.0 R Full Override value
3
S17 Y 0 B 0 or 1 Override enable
S18 N 2 I Note 1 Block address of simulation value
S193 Y 0 I 0 or 1 Simulation enable
3
S20 Y 0 B 0 or 1 Status error inhibit
S21 Y 9.2 E18 R Full Redundant input deviation limit
S22 N 0.0 R Full Length of termination unit cable
S23 N NULL String 0 - 32 Foreign device configuration parameters
S24 N 0 I Full Reserved for future use
S25 N 2 I Note 1 Block address of the next element of the foreign device
S26 N 0 I Full Spare
S27 N 0.0 R Full Spare
S28 Y 0.0 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. Refer to the S2 explanation.
3. The specification value active state is permitted to operate only when S26 of the device definition function code 221 or S11 of
the Gateway function code 227 is enabled.

Explanation
Specifications
S1 (Channel label) Optional channel identifier. It is not required
to be configured and can be null. The channel label can be up
to 32 characters long.
S2 (Input Type) Specified as a four digit number of the following
format:
FCSS

222 - 2 WBPEEUI210504C1
where:

F Filtered input: 1 = yes, 0 = no. A filtered input is com-


puted as seven-eighths of the previous filtered value
plus one-eighth of the current input value. A filtered
input normally is used for cold junction reference
compensation of thermocouple inputs.
A filtered thermocouple automatically uses the value
of the I/O device internal cold junction reference for
its own compensation. Thus, the internal cold junc-
tion reference must be configured as a function code
222 block with an input type (S2) of 1900. The engi-
neering units (S5) of a filtered thermocouple must be
configured for degrees Celsius.

Nonfiltered thermocouples automatically use the


value of the I/O device’s external cold junction refer-
ence (S29 of function code 221 or the fixed junction
temperature (FJT) parameter of S2 of function code
228) for thermocouple compensation. When used with
function code 221, the internal cold junction reference
normally is configured as the external cold junction
reference.
C Input class as listed in following paragraphs.
SS Subclass as described in following paragraphs.

NOTE: Refer to the Harmony Input/Output System, I/O and Auxiliary


Blocks instruction for information regarding Harmony I/O block support of dif-
ferent analog input classes. Refer to the S800 I/O Modules instruction for infor-
mation regarding S800 I/O module support of different analog input types.

High Level (Class 0):

F000 = 4 mA to 20 mA
F001 = +1 V to +5 V
F002 = -10 V to +10 V
F003 = 0 V to +10 V
F004 = 0 V to +5 V
F005 = 0 V to +1 V
F006 = 0 mA to 20 mA
F007 = -20 mA to +20 mA
F008 = -5 V to +5 V
F009 = 2 V to 10 V

WBPEEUI210504C1 222 - 3
Thermocouple (Class 1):

F101 = type S thermocouple


F102 = type R thermocouple
F103 = type E thermocouple
F104 = type J thermocouple
F105 = type K thermocouple
F106 = type T thermocouple
F107 = Chinese type E thermocouple
F108 = Chinese type S thermocouple
F109 = type L thermocouple
F110 = type U thermocouple
F111 = type N (14 AWG) thermocouple
F112 = type N (28 AWG) thermocouple
F113 = type B thermocouple
F114 = type C thermocouple

RTD (Class 2):

F200 = US Lab standard 100 ohm platinum RTD


(TCR=0.003926)
F201 = US Ind standard 100 ohm platinum RTD
(TCR=0.003911)
F202 = European standard 100 ohm platinum (80 °C)
RTD (TCR=0.003850)
F203 = 120 ohm chemically pure nickel RTD
(TCR=0.00672)
F204 = 10 ohm copper RTD (TCR=0.00427)
F205 = Chinese 53 ohm copper RTD (r100/r0=1.425)
F206 = European Std. 100 ohm platinum (250 °C) RTD
(TCR=0.003850)
F207 = European Std. 100 ohm platinum (850 °C) RTD
(TCR=0.003850)
F208 = 100 ohm nickel RTD (TCR=0.00618)
F209 = 400 ohm resistor

Low level (Class 3):

F300 = -100 mV to +100 mV


F301 = 0 mV to +100 mV
F302 = -30 mV to +75 mV

222 - 4 WBPEEUI210504C1
User defined (Class 4):

F400 = input voltage range defined by specifications S13


and S14.

Smart field device/foreign device (Class 5):

0500 = smart I/O or foreign device channel

Internal cold junction reference (Class 9):

1900 = internal cold junction reference

CIO-100
AIN-120
AIN-200
AIN-220
AIN-300
Input

AI801
AI810
AI820
AI830
AI835
AI890
Type Description
(S2)
0 4 to 20 mA • • • • • • •
1 1 to 5 V • • • • •
2 -10 10 V • • • •
3 0 to 10 V • • • • •
4 0 to 5 V • • • •
5 0 to 1 V • • •
6 0 to 20 mA • • • •
7 -20 to 20 mA •
8 -5 to 5 V •
9 2 to 10 V • •
101 Type S thermocouple • • •
102 Type R thermocouple • • •
103 Type E thermocouple • • •
104 Type J thermocouple • • •
105 Type K thermocouple • • •
106 Type T thermocouple • • •
107 Chinese type E thermocouple • •
108 Chinese type S thermocouple • •
109 Type L thermocouple • •
110 Type U thermocouple • •
111 Type N (14 AWG) thermocouple • • •
112 Type N (28 AWG) thermocouple • •
113 Type B thermocouple • • •
114 Type C thermocouple •

WBPEEUI210504C1 222 - 5
CIO-100
AIN-120
AIN-200
AIN-220
AIN-300
Input

AI801
AI810
AI820
AI830
AI835
AI890
Type Description
(S2)
200 US Lab Std. 100 Ohm platinum RTD •
201 US Ind Std. 100 Ohm platinum RTD •
202 Euro Std. 100 Ohm platinum (80°C) RTD • •
203 120 Ohm nickel RTD •
204 10 Ohm copper RTD • •
205 Chinese 53 Ohm copper RTD •
206 Euro Std. 100 Ohm platinum (250°C) RTD •
207 Euro Std. 100 Ohm platinum (850°C) RTD •
208 100 Ohm nickel RTD •
209 400 Ohm resistor •
300 -100 to 100 mV •
301 0 to 100 mV •
302 -30 to 75 mV •
400 User defined voltage • • • • • •
500 Smart field device analog input
900 Internal cold junction reference • •
1. AIN-220 channel 17 only. 1 2
2. AI835 channel 8 only.

S3 (Engineering units low value) Defines the low limit of the


input’s range engineering units. This specification is ignored
for input classes 1, 2, 5, and 9.
S4 (Engineering units high value) Defines the high limit of the
input’s range engineering units. This specification is ignored
for input classes 1, 2, 5, and 9.
S5 (Engineering unit identifier) Identifies the engineering units
associated with the input value and specifies the temperature
conversion to be applied to thermocouple and RTD inputs.

NOTE: Thermocouples and RTDs (input classes 1 and 2) must specify either
degrees Fahrenheit (3) or degrees Celsius (4). Filtered thermocouples and
internal cold junction references (input classes 1 and 9) must specify degrees
Celsius (4) for Harmony I/O subsystems.
S6 (Engineering units high alarm) An alarm will be generated
when the input equals or exceeds this high limit.

222 - 6 WBPEEUI210504C1
S7 (Engineering units low alarm) An alarm will be generated
when the input equals or is less than this low limit.
S8 (Engineering units significant change) Change in input
allowed before the changed value is reported to a console or
open access system.

A change in input value by the amount specified in S8 will


cause an exception report to be generated as long as the mini-
mum exception reporting time has been reached (S7 of func-
tion code 82).
S9 (Block address of input shaping algorithm) Allows additional
characterization of the real input value. The available shaping
algorithms are function code 1 (function generator), function
code 7 (square root), and function code 167 (polynomial). The
shaping algorithm tunable specifications cannot be adapted
when used by function code 222. S9 must be set to the default
value if function code 222 is configured as an element of a for-
eign device definition function code 228.
S10 (Engineering unit conversion/shaping algorithm precedence)
Specifies which will be performed first: shaping on the raw
data or conversion to engineering unit. The default is 0, which
specifies that shaping is done first. This specification is not
applicable if S9 is set to its default value. If no shaping algo-
rithm exists, shaping is ignored.

0 = Perform shaping to raw data before engineering unit


conversion is done.
1 = Perform engineering unit conversion to raw data before
shaping is applied.

For example, a FC222 block is configured for a 4 to 20mA


input range (S2=0), an engineering units range of zero to 100%
(S3=0, S4=100), and the square root (FC7) shaping algorithm,
and has a raw input value of 16 mA. Selecting shape before EU
conversion (S10=0) produces a block output value of 0%:
(SQRT(16 mA)-4 mA) * (100%-0%) / (20 mA-4 mA)+0%=0%+0%=0%

Selecting EU conversion before shaping (S10=1) produces a


block output value of 8.66%:
SQRT((16 mA-4 mA)*(100%-0%) / (20 mA -4 mA)+0%)=SQRT(75%)=8.66%

WBPEEUI210504C1 222 - 7
This specification is I/O subsystem dependent. S800 RTD and
thermocouple modules must use a setting of 1 if a shaping
algorithm is specified in S9.
S11 (Lead wire resistance) Resistance of the field input lead wire
from the input to the termination device in ohms. This specifi-
cation is ignored for input classes 0, 4, 5, and 9 and for S800
modules.
S12 (A/D conversion resolution) Specifies the relative resolution of
the analog-to-digital conversion. The higher the value, the
higher the resolution. A higher value may increase A/D con-
version time or slow the responsiveness of the input.

This specification is block type dependent:

AIN-200, AIN-220, AIN-300 blocks: Specifies the number of


input samples to which a moving average is applied in order to
generate the input value.

AIN-120, CIO-100 blocks: Has no effect.

S800 modules: Has no effect.


S13 (User defined range low limit (volts)) Specifies the low limit of
the input range in volts of the user defined input class (input
class 4). This specification is ignored for all other input
classes.
S14 (User defined range high limit (in volts)) Specifies the high
limit of the input range in volts of the user defined input class
(input class 4). This specification is ignored for all other input
classes.
S15 (Normal input/undefined) A value of 0 selects normal input
from standard I/O. A value of 1 puts the channel into an
undefined state which will not affect the channel status. Spec-
ifications S17 and S19 take precedence over S15 when
S15 = 0, but not when S15 = 1.

0 = normal
1 = undefined
S16 (Override value) The channel input value is overridden with
this value if override enable (S17) is set to 1.
S17 (Override enable) A value of 0 disables override for this chan-
nel. A value of 1 enables override in this channel. Override if

222 - 8 WBPEEUI210504C1
enabled will take precedence over normal input and simula-
tion. Specification S26 of the I/O device definition function
code 221 must reference a boolean output that is set to a 1 to
permit this operation; otherwise, it is ignored.

0 = disabled
1 = enabled
S18 (Block address of simulation value) The channel input value
is simulated with this block input when simulation is enabled
(S19 = 1).
S19 (Simulation enable) A value of 0 disables simulation for this
channel. A value of 1 enables simulation for this channel and
receives its input from S18. Simulation has precedence over
S15 normal input, but not S17 override. Specification S26 of
the I/O device definition function code 221 must reference a
boolean output that is set to a 1 to permit this operation; oth-
erwise, it is ignored.

0 = disabled
1 = enabled
S20 (Status error inhibit) Inhibits this channel’s I/O error contri-
bution to BRC-100 controller status. Specification S26 of the
I/O device definition function code 221 or specification S5 of
the foreign device function code 228 must reference a Boolean
output with a value of 1 to permit this operation. Otherwise, it
is ignored.

0 = no
1 = yes
S21 (Redundant input deviation limit) In NORMAL mode (S15=0,
S17=0, S19=0), the redundant input deviation limit specifies
the maximum deviation permitted between redundant analog
input channels. This only applies when both inputs are of good
quality. When the redundant inputs are outside the deviation
limit, they will both be considered in error (function block out-
put quality set to BAD, SUSP flag set in the exception report
and the LIO error bit set in the BRC-100 controller status).

In OVERRIDE mode (S15=0, S17=1, S19=X), the redundant


input deviation limit assumes the meaning of override value
deviation limit and thus specifies the maximum deviation
permitted between the primary analog input channel and the
override value (S16). If the actual input value and the override

WBPEEUI210504C1 222 - 9
value are outside the limit, the state of the input channel is
considered suspect (SUSP set in the exception report but no
LIO error set in the BRC-100 controller status) since a bump
in the block output value will occur upon exiting the OVER-
RIDE mode.

In SIMULATION mode (S15=0, S17=0, S19=1), the redundant


input deviation limit assumes the meaning of simulated value
deviation limit and thus specifies the maximum deviation per-
mitted between the primary analog input channel and the sim-
ulated value (<S18>). If the actual input value and the
simulated value are outside the limit, the state of the input
channel is considered suspect (SUSP set in the exception
report but no LIO error set in the BRC-100 controller status)
since a bump in the function block output value will occur
upon exiting the SIMULATION mode.
S22 Length of Termination Unit Cable (feet) Specifies the length in
feet of the termination unit cable from the marshaling cabinet
to the I/O device terminals. This is used to compute the effect
of the termination unit cable on thermocouple, RTD, and
internal cold junction reference inputs (input classes 1, 2, and
9). This specification is ignored for all other input classes and
for S800 modules.
S23 (Foreign device configuration parameters) A string data type
containing configuration information specific to the analog
input channel of a foreign device. For example: FILTER=1500
specifies a filter period of 1.5 seconds for all modules except
the AI830 and the AI835. For the AI830 and the AI835 mod-
ules, FILTER=1500 specifies a filter period of 15 seconds.

Parameter Meaning
FILTER=nnnnn Input filter time constant for S800 modules. The
string nnnnn represents a number between zero
and 65535. A value of zero disables filtering. Units
are in milliseconds, except for the AI830 and AI835
modules. The AI830 and AI835 units are in tens of
milliseconds.

S24 Reserved for future use.


S25 (Block address of next element of the foreign device) This
specification is the link to the next element of the foreign
device definition function code 228. The default value indicates

222 - 10 WBPEEUI210504C1
that this block is the last element. S25 must be set to the
default value if function code 222 is configured as a channel of
an I/O device definition function code 221.
S26 through S28 Spare.

Outputs
The analog in/channel function code has one block output.
N Input value with quality.

Applications
• Refer to the function code 80 description for examples of
using function code 222 in hard station control loop con-
figurations.

• Refer to the function code 221 description for information


on assigning function code 222 to Harmony I/O block
channels.

• Refer to the function code 227 description for an example


of assigning function code 222 to foreign device definition
I/O channels.

Figure 222-1 illustrates an example of internal cold junction


reference compensation for the thermocouple inputs of an
AIN-220 Harmony I/O block. This example also illustrates the
use of the shaping algorithm. Only one square-root (function
code 7) block needs to be configured to shape both block num-
ber 2002 and 2003. In this example, the 4 to 20 mA inputs
represent a pressure of zero to 200 inches of water (IN H2O).
The shaping algorithm is used to convert the pressure from
inches of water to the rate of flow in 0 to 50,000 pounds per
hour. Tables 222-1 through 222-7 describe the specification
settings for the blocks used in Figure 222-1.

NOTE: Alternate and more convenient settings for function code 222 at block
address 2002 and function code 7 at block address 2100 can be used and give
the same results:
Function code 222 at block address 2002, specification S3 = 0.
Function code 222 at block address 2002, specification S4 = 1.0
Function code 7 at block address 2100, specification S2 = 50,000.

Figure 222-2 illustrates an example of external cold junction


reference compensation for the thermocouple inputs of the

WBPEEUI210504C1 222 - 11
OFF-PAGE
CONNECTOR
TO CONTROL
LOGIC
LEAD WIRES ARE TERMINATED
ON THE AI 220 TERMINAL STRIP. OFF-PAGE
CONNECTOR
A TERMINATION DEVICE IS TO CONTROL
NOT REQUIRED LOGIC

OFF-PAGE
AI 220 CONNECTOR
TO CONTROL
6 + LOGIC
TYPE J
THERMOCOUPLE
CH1 IOC/AIN
- S9 IOD/DEF
6 SHPG
S18 SIM
(222) S2
+ AI CH01
+ 4 TO 20 mA S25 2001 S3
CH2 SPARE CH02
- S4
- CH03
S5 CH04
+ S6
+ 4 TO 20 mA IOC/AIN CH05
CH3 S7
- S1 (7) S9 CH06
- SHPG S8
2100 S18 (222) CH07
SIM AI S9
+ S25 2002 CH08
SPARE S10
CH4 CH09
- S11
CH10
S12
CH11
IOC/AIN S13 CH12
CH5
S9 SHPG
S14 CH13
IN THIS EXAMPLE, S18 (222) S15
SIM AI CH14
CHANNELS S25 2003 S16
5 THROUGH 16 SPARE CH15
S17
ARE NOT USED CH16
S18
CH17
CH16
S19
CH18
IOC/AIN S20
CH19
S9
RTD CH17 SHPG S21 CH20
S18 (222)
SIM AI S22
2004 CH21
THE AI 220 HAS A S25 S23
SPARE CH22
BUILT-IN RTD THAT S24
PROVIDES AN CH23
INTERNAL CJR S25 CH24
S26
IOC/AIN PERMIT
S9 S29
CJR
SHPG
S18 (222) S31
SIM AI SPARE
2017 S33
S25 SPARE
SPARE (221) PRIMARY
1000 STATUS
BACKUP
STATUS
1001
OVR/SIM
1002
SPARE

RESERVED

T00898A

Figure 222-1. Internal Cold Junction Compensation of Thermocouples

Table 222-1. Function Code 221 at Block Address 1000

Spec Value Description


S1 “AIN-220” Sets the device label to AIN-220.
S2 2001 Points to the block address of the function code 222 for channel 1 of the
AIN-220 block.
S3 2002 Points to the block address of the function code 222 for channel 2 of the
AIN-220 block.

222 - 12 WBPEEUI210504C1
Table 222-1. Function Code 221 at Block Address 1000 (continued)

Spec Value Description


S4 2003 Points to the block address of the function code 222 for channel 3 of the
AIN-220 block.
S5 2004 Points to the block address of the function code 222 for channel 4 of the
AIN-220 block.
S6 - S17 2 Indicates the channel is not configured.
S18 2017 Points to the block address of the function code 222 for channel 17. Chan-
nel 17 on the AIN-220 block is the internal cold junction reference tempera-
ture of the AIN-220 input terminals.
S19 - S25 2 Channel is not provided by the AIN-220 block.
S26 0 No override, status error inhibit, or simulation permitted.
S27 0 I/O block status errors not inhibited.
S28 0 No redundant block expected.
S29 2017 Points to the block address of the cold junction reference temperature,
which in this example is actually the internal cold junction reference of the
block. The CJR temperature is used to calculate the thermocouple compen-
sation for the temperature at the input terminals of the AIN-220 block.

Table 222-2. Function Code 222 at Block Address 2001

Spec Value Description


S1 “temperature” Sets the channel label to temperature.
S2 0104 Sets the input type to a nonfiltered Type J thermocouple.
S3 0.0 Engineering units low value is ignored by this input class.
S4 100.0 Engineering units high value is ignored by this input class.
S5 3 Sets the engineering units identifier to degrees Fahrenheit.
S6 200.0 Sets the engineering units high alarm value to 200° F.
S7 34.0 Sets the engineering units low alarm value to 34° F.
S8 2.0 Sets the engineering units significant change to 2.0° F.
S9 2 Indicates that a shaping algorithm is not applied to the value.
S10 0 Ignored since there is no shaping algorithm.
S11 12.0 The lead wire from the thermocouple to the terminals of the AIN-220
block has a resistance of 12 Ω (= 6 Ω + 6 Ω).
S12 8 The AIN-220 will average the last eight input samples to increase the
accuracy of the value.
S13 0.0 Custom range low limit is ignored by this input class.
S14 0.0 Custom range high limit is ignored by this input class.

WBPEEUI210504C1 222 - 13
Table 222-2. Function Code 222 at Block Address 2001 (continued)

Spec Value Description


S15 0 This is a normal input.
S16 0.0 Override value is ignored.
S17 0 Override enable is ignored.
S18 2 There is no simulation value.
S19 0 Simulation is not enabled.
S20 0 Status errors are not inhibited.
S21 0.0 A redundant block is not configured.
S22 0.0 A TU cable does not connect the input to the block.

Table 222-3. Function Code 222 at Block Address 2002

Spec Value Description


S1 “inflow” Sets the channel label to inflow.
S2 0000 Sets the input type for a nonfiltered, 4 to 20 mA current source.
S3 0.0 Sets the engineering units low value to 0.0 in. H2O.
S4 200.0 Sets the engineering units high value to 200.0 in. H2O.
S5 11 Sets the engineering units identifier to pounds per hour (lb/hr).
S6 40000.0 Sets the engineering units high alarm value to 40,000 lb/hr.
S7 1000.0 Sets the engineering units low alarm value to 1000 lb/hr.
S8 50.0 Sets the engineering units significant change to 50 lb/hr.
S9 2100 Points to the block address of the shaping algorithm. The shaping algorithm con-
verts the input pressure in inches of water to the rate of flow in pounds per hour.
S10 1 Shape the input value after conversion to engineering units.
S11 0.0 The lead wire resistance is ignored for the high level input class.
S12 8 The AIN-220 averages the last eight input samples to increase the accuracy of
the value.
S13 0.0 Custom range low limit is ignored by this input class.
S14 0.0 Custom range high limit is ignored by this input class.
S15 0 This is a normal input.
S16 0.0 Override value is ignored.
S17 0 Override enable is ignored.
S18 2 There is no simulation value.
S19 0 Simulation is not enabled.
S20 0 Status errors are not inhibited.

222 - 14 WBPEEUI210504C1
Table 222-3. Function Code 222 at Block Address 2002 (continued)

Spec Value Description


S21 0.0 A redundant block is not configured.
S22 0.0 A TU cable does not connect the input to the block.

Table 222-4. Function Code 222 at Block Address 2003

Spec Value Description


S1 “outflow” Sets the channel label to outflow.
S2 0000 Sets the input type for a nonfiltered, 4 to 20 mA current source.
S3 0.0 Sets the engineering units low value to 0.0 in. H2O.
S4 200.0 Sets the engineering units high value to 200.0 in. H2O.
S5 11 Sets the engineering units identifier to pounds per hour (lb/hr).
S6 35000.0 Sets the engineering units high alarm value to 35,000 lb/hr.
S7 500.0 Sets the engineering units low alarm value to 500 lb/hr.
S8 20.0 Sets the engineering units significant change to 20 lb/hr.
S9 2100 Points to the block address of the shaping algorithm. The shaping algorithm con-
verts the pressure in inches of water to the rate of flow in pounds per hour.
S10 1 Shape the input value after conversion to engineering units.
S11 0.0 The lead wire resistance is ignored for the High Level input class.
S12 8 The AIN-220 averages the last eight input samples to increase the accuracy of
the value.
S13 0.0 Custom range low limit is ignored by this input class.
S14 0.0 Custom range high limit is ignored by this input class.
S15 0 This is a normal input.
S16 0.0 Override value is ignored.
S17 0 Override enable is ignored.
S18 2 There is no simulation value.
S19 0 Simulation is not enabled.
S20 0 Status errors are not inhibited.
S21 0.0 A redundant block is not configured.
S22 0.0 A TU cable does not connect the input to the block.

Table 222-5. Function Code 222 at Block Address 2004

Spec Value Description


S1 “undefined” Sets the channel label to undefined.
S2 0000 Default input type (nonfiltered, 4 to 20 mA current source.)

WBPEEUI210504C1 222 - 15
Table 222-5. Function Code 222 at Block Address 2004 (continued)

Spec Value Description


S3 0.0 Default engineering units low value.
S4 100.0 Default engineering units high value.
S5 0 Default engineering units identifier.
S6 100.0 Default engineering units high alarm value.
S7 0.0 Default engineering units low alarm value.
S8 0.0 Default engineering units significant change value.
S9 2 Default block address of the shaping algorithm (none).
S10 0 Default EU conversion/shaping precedence.
S11 0.0 Default lead wire resistance.
S12 0 Default A/D conversion accuracy.
S13 0.0 Default custom range low limit value.
S14 0.0 Default custom range high limit value.
S15 1 This is an undefined input. This function code 222 is used to
reserve this function code block for future use.
S16 0.0 Default override value.
S17 0 Default override enable value.
S18 2 Default block address of simulation value.
S19 0 Default simulation enable value.
S20 0 Default status error inhibit value.
S21 0.0 Default redundant input deviation limit value.
S22 0.0 Default TU cable length value.

Table 222-6. Function Code 222 at Block Address 2017

Spec Value Description


S1 “internal CJR” Sets the channel label to internal CJR.
S2 1900 Sets the input type for a filtered internal CJR.
S3 0.0 Engineering units low value is ignored by this input class.
S4 100.0 Engineering units high value is ignored by this input class.
S5 4 Sets the engineering units identifier to degrees Centigrade. The inter-
nal CJR temperature must be in degrees Centigrade.
S6 70.0 Sets the engineering units high alarm value to 70° C.
S7 0.0 Sets the engineering units low alarm value to 0° C.
S8 10.0 Sets the engineering units significant change value to 10° C.
S9 2 Shaping algorithm is ignored by this class.

222 - 16 WBPEEUI210504C1
Table 222-6. Function Code 222 at Block Address 2017 (continued)

Spec Value Description


S10 0 Shaping is ignored by this input class.
S11 0.0 The lead wire resistance is ignored for the this input class.
S12 8 The AIN-220 will average the last eight input samples to increase the
accuracy of the value.
S13 0.0 Custom range low limit is ignored for this input class.
S14 0.0 Custom range high limit is ignored for this input class.
S15 0 This is a normal input.
S16 0.0 Override value is ignored.
S17 0 Override enable is ignored.
S18 2 There is no simulation value.
S19 0 Simulation is not enabled.
S20 0 Status errors are not inhibited.
S21 0.0 A redundant block is not configured.
S22 0.0 A TU cable does not connect the input to the block.

Table 222-7. Function Code 7 at Block Address 2100

Spec Value Description


S1 6 The block address of the input is ignored in this application.
S2 3535.534 Constant required to convert the square-root of the pressure in inches
of water to the flow in pounds per hour.

AIN-200 Harmony I/O block. This example employs a remote


terminal block and termination devices: a thermocouple (block
2116) is used as an external cold junction reference to com-
pensate for the temperature of the remote terminal block, and
the termination device’s internal cold junction reference (block
2117) is used to compensate the thermocouple (block 2116) for
the temperature of the termination device. Tables 222-8
through 222-13 describe the specification settings for the
blocks used in Figure 222-2.

Figure 222-3 illustrates an example of a user-defined input


that requires shaping before conversion to engineering units:
The user-defined input has an input range of -1 V to +3.0 V,
which represents 0 PSIA to 200 PSIA; however, the transducer
is nonlinear and requires a function generator block (function

WBPEEUI210504C1 222 - 17
REMOTE
TERMINAL TERMINATION OFF-PAGE
BLOCK DEVICE AIN-200 CONNECTOR
TO CONTROL
20 Ω 8Ω + LOGIC
TYPE E CH1 CH1 IOC/AIN
THERMOCOUPLE
- S9 IOD/DEF
30 Ω 8Ω SHPG
S18 SIM
(222) S2
+ AI CH01
S25 2001
CH2 CH2 SPARE
-

+ TU CABLE
CH3 (10 FT)
-

IN THIS EXAMPLE,
CHANNELS S26
PERMIT
2 THROUGH 17 S29
CJR
ARE NOT USED S31
SPARE
S33
SPARE
(221)
+ PRIMARY
STATUS
1000
CH16 BACKUP
- STATUS
1001
OVR/SIM
1002
RTD CH17 CH17 SPARE

RESERVED

TERMINATION
OFF-PAGE
DEVICE AIN-200 CONNECTOR
TO CONTROL
20 Ω 8Ω + LOGIC
TYPE K
THERMOCOUPLE
CH1 CH1 IOC/AIN
- S9 IOD/DEF
20 Ω 8Ω SHPG
S18 SIM
(222) S2
+ AI CH01
S25 2101
CH2 CH2 SPARE
-

+
CH3
-

S17
CH16
S18
TU CABLE CH17
(20 FT) S19
IN THIS EXAMPLE, CH18
CHANNELS S20
CH19
2 THROUGH 15 S21 CH20
ARE NOT USED S22
CH21
S23 CH22
S24
CH23
S25 CH24
+ S26
CH15 PERMIT
S29
- CJR
S31
SPARE
7Ω + S33
SPARE
TYPE T (221)
CH16 CH15 PRIMARY
THERMOCOUPLE
- IOC/AIN 1100 STATUS
7Ω BACKUP
S9 STATUS
SHPG 1101
S18 SIM
(222) OVR/SIM
CH16 AI 1102
S25 2116 SPARE
SPARE
THE TYPE T THERMOCOUPLE
ATTACHED TO THE RESERVED
REMOTE TERMINAL BLOCK
PROVIDES THE EXTERNAL CJR RTD CH17 CH17 IOC/AIN
S9 SHPG
S18 SIM
(222)
THE TERMINATION DEVICE HAS AI
A BUILT-IN RTD THAT PROVIDES S25 2117
SPARE
THE INTERNAL CJR
T00899B

Figure 222-2. External Cold Junction Compensation of Thermocouples

222 - 18 WBPEEUI210504C1
Table 222-8. Function Code 221 at Block Address 1000

Spec Value Description


S1 “AIN-200 #1” Sets the device label to AIN-200 #1.
S2 2001 Points to the block address of the function code 222 for channel 1 of the
first AIN-200 block.
S3 - S18 2 Indicates the channel is not configured.
S19 - S25 2 Channel is not provided by the AIN-200 block.
S26 0 No override, status error inhibit, or simulation permitted.
S27 0 I/O block status errors not inhibited.
S28 0 No redundant block expected.
S29 2116 Points to the block address of the external cold junction reference tem-
perature. The CJR temperature, provided by channel 16 of the second
AIN-200 block, is the temperature of the remote terminal block.

Table 222-9. Function Code 222 at Block Address 2001

Spec Value Description


S1 “input temperature” Sets the channel label to input temperature.
S2 0103 Sets the input type to a nonfiltered Type E thermocouple.
S3 0.0 Engineering units low value is ignored by this input class.
S4 100.0 Engineering units high value is ignored by this input class.
S5 4 Sets the engineering units identifier to degrees Centigrade.
S6 1000.0 Sets the engineering units high alarm value to 1000° C.
S7 500.0 Sets the engineering units low alarm value to 500° C.
S8 5.0 Sets the engineering units significant change to 5.0° C.
S9 2 Indicates that a shaping algorithm is not applied to the value.
S10 0 Ignored since there is no shaping algorithm.
S11 66.0 The wire from the thermocouple to the termination device has a
resistance of 66 Ω (= 20 Ω + 30 Ω + 8 Ω + 8 Ω.)
S12 2 The AIN-200 block will average the last two input samples to
increase the accuracy of the value.
S13 0.0 Custom range low limit is ignored by this input class.
S14 0.0 Custom range high limit is ignored by this input class.
S15 0 This is a normal input.
S16 0.0 Override value is ignored.
S17 0 Override enable is ignored.
S18 2 There is no simulation value.

WBPEEUI210504C1 222 - 19
Table 222-9. Function Code 222 at Block Address 2001 (continued)

Spec Value Description


S19 0 Simulation is not enabled.
S20 0 Status errors are not inhibited.
S21 0.0 A redundant device is not configured.
S22 10.0 The TU cable length is 10 feet.

Table 222-10. Function Code 221 at Block Address 1100

Spec Value Description


S1 “AIN-200 #2” Sets the device label to AIN-200 #2.
S2 2101 Points to the block address of function code 222 for channel 1 of the sec-
ond AIN-200 block.
S3 - S16 2 Indicates the channel is not configured.
S17 2116 Points to the block address of function code 222 for channel 16 of the
second AIN-200 block, which is the temperature of the remote terminal
block. This channel is defined by its input type (S2 of FC 222) as a CJR,
and thus requires the configuration of channel 17, the internal CJR.
S18 2117 Points to the block address of function code 222 for channel 17 of the
second AIN-200 block. Channel 17 on the AIN-200 block is the internal
cold junction reference; it provides the temperature of the termination
device.
S19 - S25 2 Channel is not provided by the AIN-200 block.
S26 0 No override, status error inhibit, or simulation permitted.
S27 0 I/O block status errors not inhibited.
S28 0 No redundant block expected.
S29 2116 Points to the block address of the cold junction reference temperature.
The CJR for the second AIN-200 block is the value of the thermocouple
connected to channel 16; channel 17, the internal CJR, automatically
provides thermocouple compensation for channel 16.

Table 222-11. Function Code 222 at Block Address 2101

Spec Value Description


S1 “output temperature” Sets the channel label to output temperature.
S2 0105 Sets the input type to a nonfiltered Type K thermocouple.
S3 0.0 Engineering units low value is ignored by this input class.
S4 100.0 Engineering units high value is ignored by this input class.
S5 4 Sets the engineering units identifier to degrees Centigrade.
S6 1000.0 Sets the engineering units high alarm value to 1000° C.

222 - 20 WBPEEUI210504C1
Table 222-11. Function Code 222 at Block Address 2101 (continued)

Spec Value Description


S7 500.0 Sets the engineering units low alarm value to 500° C.
S8 10.0 Sets the engineering units significant change to 10.0° C.
S9 2 Indicates that a shaping algorithm is not applied to the value.
S10 0 Ignored since there is no shaping algorithm.
S11 56.0 The wire from the thermocouple to the termination device has a
resistance of 56 Ω (= 20 Ω + 20 Ω + 8 Ω + 8 Ω.)
S12 2 The AIN-200 averages the last two input samples to increase the
accuracy of the value.
S13 0.0 Custom range low limit is ignored by this input class.
S14 0.0 Custom range high limit is ignored by this input class.
S15 0 This is a normal input.
S16 0.0 Override value is ignored.
S17 0 Override enable is ignored.
S18 2 There is no simulation value.
S19 0 Simulation is not enabled.
S20 0 Status errors are not inhibited.
S21 0.0 A redundant block is not configured.
S22 20.0 The TU cable length is 20 feet.

Table 222-12. Function Code 222 at Block Address 2116

Spec Value Description


S1 “external CJR” Sets the channel label to external CJR.
S2 1106 Sets the input type for a filtered, Type T thermocouple. Setting the filter
option (one in the thousands digit) indicates that this thermocouple is to
be used as an external CJR, and thus requires the setting of the engi-
neering units (S5) to degrees Centigrade (4), and the configuration of the
internal CJR channel of the I/O block (channel 17 of the AIN-200).
S3 0.0 Engineering units low value is ignored by this input class.
S4 100.0 Engineering units high value is ignored by this input class.
S5 4 Sets the engineering units identifier to degrees Centigrade. The CJR tem-
perature must be in degrees Centigrade.
S6 70.0 Sets the engineering units high alarm value to 70° C.
S7 0.0 Sets the engineering units low alarm value to 0° C.
S8 10.0 Sets the engineering units significant change value to 10° C.
S9 2 Indicates that a shaping algorithm is not applied to the value.

WBPEEUI210504C1 222 - 21
Table 222-12. Function Code 222 at Block Address 2116 (continued)

Spec Value Description


S10 0 Ignored since there is no shaping algorithm.
S11 14.0 The wire from the thermocouple to the terminals of the AIN-200 block has
a resistance of 14 Ω (= 7 Ω + 7 Ω.)
S12 16 The AIN-200 block will average the last 16 input samples to increase the
accuracy of the value.
S13 0.0 Custom range low limit is ignored by this input class.
S14 0.0 Custom range high limit is ignored by this input class.
S15 0 This is a normal input.
S16 0.0 Override value is ignored.
S17 0 Override enable is ignored.
S18 2 There is no simulation value.
S19 0 Simulation is not enabled.
S20 0 Status errors are not inhibited.
S21 0.0 A redundant block is not configured.
S22 20.0 The TU cable length is 20 feet.

Table 222-13. Function Code 222 at Block Address 2017

Spec Value Description


S1 “internal CJR” Sets the channel label to internal CJR.
S2 1900 Sets the input type for a filtered internal CJR.
S3 0.0 Engineering units low value is ignored by this input class.
S4 100.0 Engineering units high value is ignored by this input class.
S5 4 Sets the engineering units identifier to degrees Centigrade. The
internal CJR temperature must be in degrees Centigrade.
S6 70.0 Sets the engineering units high alarm value to 70° C.
S7 0.0 Sets the engineering units low alarm value to 0° C.
S8 10.0 Sets the engineering units significant change value to 10° C.
S9 2 Shaping algorithm is ignored by this class.
S10 0 Shaping is ignored by this input class.
S11 0.0 The lead wire resistance is ignored for the this input class.
S12 16 The AIN-200 block will average the last 16 input samples to
increase the accuracy of the value.
S13 0.0 Custom range low limit is ignored for this input class.
S14 0.0 Custom range high limit is ignored for this input class.

222 - 22 WBPEEUI210504C1
Table 222-13. Function Code 222 at Block Address 2017 (continued)

Spec Value Description


S15 0 This is a normal input.
S16 0.0 Override value is ignored.
S17 0 Override enable is ignored.
S18 2 There is no simulation value.
S19 0 Simulation is not enabled.
S20 0 Status errors are not inhibited.
S21 0.0 A redundant block is not configured.
S22 20.0 The TU cable length is 20 feet.

code 1) to correct the input value before conversion to engi-


neering units.

Tables 222-14 through 222-16 describe the specification set-


tings for the blocks used in Figure 222-3.

WBPEEUI210504C1 222 - 23
LEAD WIRES ARE TERMINATED
ON THE AI 100 TERMINAL STRIP.
A TERMINATION DEVICE IS
NOT REQUIRED.
OFF-PAGE
AI 100 CONNECTOR
TO CONTROL
LOGIC
+
+ CH1 IOC/AIN
-
- S9 IOD/DEF
SHPG
TRANSDUCER:
S18 SIM
(222) S2
-1 V TO +3.0 V + AI CH01
S25 2001
CH2 SPARE
IN THIS EXAMPLE, -
CHANNELS
2 THROUGH 16
ARE NOT USED
+
CH16
-

S26
PERMIT
S29
S1 (1) CJR
F(X) S31
2500 SPARE
S33
SPARE
(221)
PRIMARY
STATUS
1000
BACKUP
STATUS
1001
OVR/SIM
1002
SPARE

RESERVED

3.0 V

2.2 V

1.4 V
OUTPUT = F(X)
0.6 V

-0.2 V

-1.0 V -0.2 V 0.6 V 1.4 V 2.2 V 3.0 V


INPUT = X
T00900A

Figure 222-3. User Defined Input

Table 222-14. Function Code 221 at Block Address 1000

Spec Value Description


S1 “AIN-120” Sets the device label to AIN-120
S2 2001 Points to the block address of the function code 222 for channel 1 of the
AIN-120 device.
S3 - S17 2 Indicates the channel is not configured.
S18 - S25 2 Channel is not provided by the AIN-120 block.
S26 0 No override, status error inhibit, or simulation permitted.
S27 0 I/O block status errors not inhibited.

222 - 24 WBPEEUI210504C1
Table 222-14. Function Code 221 at Block Address 1000 (continued)

Spec Value Description


S28 0 No redundant block expected.
S29 2 Indicates that the external CJR is not configured.

Table 222-15. Function Code 222 at Block Address 2001

Spec Value Description


S1 “user-defined” Sets the channel label to user-defined.
S2 0400 Sets the input type to a nonfiltered, user-defined voltage.
S3 0.0 Sets the engineering units low value to 0.0 psia.
S4 200.0 Sets the engineering units high value to 200 psia.
S5 5 Sets the engineering units identifier to psia.
S6 29.4 Sets the engineering units high alarm value to 29.4 psia.
S7 14.7 Sets the engineering units low alarm value to 14.7 psia.
S8 2.5 Sets the engineering units significant change to 2.5 psia.
S9 2500 Points to the block address of the shaping algorithm.
S10 0 Applies the shaping algorithm function code before engineering units
conversion is applied.
S11 0.0 Lead wire resistance is ignored for this input class.
S12 0 A/D conversion accuracy is ignored by the AIN-120 block.
S13 -1.0 Sets the custom range low limit to -1.0 volts.
S14 3.0 Sets the custom range high limit to 3.0 volts.
S15 0 This is a normal input.
S16 0.0 Override value is ignored.
S17 0 Override enable is ignored.
S18 2 There is no simulation value.
S19 0 Simulation is not enabled.
S20 0 Status errors are not inhibited.
S21 0.0 A redundant block is not configured.
S22 0.0 Termination cable length is ignored by this input class.

Table 222-16. Function Code 1 at Block Address 2500

Spec Value Description


S1 5 The block address of the input is ignored in this application.
S2 -1.0 Input coordinate 1.

WBPEEUI210504C1 222 - 25
Table 222-16. Function Code 1 at Block Address 2500 (continued)

Spec Value Description


S3 -1.0 Output coordinate 1.
S4 -0.6 Input coordinate 2.
S5 -0.2 Output coordinate 2.
S6 0.0 Input coordinate 3.
S7 0.4 Output coordinate 3.
S8 2.0 Input coordinate 4.
S9 1.6 Output coordinate 4.
S10 2.6 Input coordinate 5.
S11 2.2 Output coordinate 5.
S12 3.0 Input coordinate 6.
S13 3.0 Output coordinate 6.

222 - 26 WBPEEUI210504C1
Analog Out/Channel
Function Code 223

IO C /AO U T The exception reporting analog out/channel function code pro-


S2
AO vides addressing, startup, run-time, and failure mode specifi-
S14 (22 3)
S21
S IM AO cations for an individual or redundant pair of analog output
NEXT
channels on a Harmony I/O block or an S800 I/O module. The
analog out/channel function code must reside in the same
segment as the I/O device definition function code 221 or for-
eign device function code 228 to which it is mapped. This func-
tion is required for all configured analog output I/O block
channels.

The control system must be carefully evaluated to establish


WARNING default values that will prevent personal injury and/or property
damage in the case of I/O block or S800 I/O module failure.

NOTES:
1. This function code is used to support Harmony I/O blocks and S800 I/O
modules only. Refer to the IOR-800 Gateway instruction for specific differ-
ences between Harmony I/O and S800 I/O.

2. Function code 223 tunable specifications are not adaptable.

Outputs

Blk Type Description


N R4 Output value (in specified EUs) with quality.

Specifications

Spec Tune Default Type Range Description


S1 N NULL String 0 - 32 32-character channel label
S2 N 5 I Note 1 Block address of value to output
S3 N 0.0 R Full Engineering units low value
S4 N 100.0 R Full Engineering units high value
S5 N 0 I 0 - 255 Engineering units identifier
S6 N 0 I 0, 1, or 2 Default state on stall
S7 Y 100.0 R Full Engineering units high alarm
S8 Y 0.0 R Full Engineering units low alarm

WBPEEUI210504C0 223 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S9 Y 0.0 R Full Engineering units significant change
S10 N 0 I 0 to 16 A/D conversion resolution
S11 N 0 B 0 or 1 Normal input/undefined
S12 Y 0.0 R Full Override value
S132 Y 0 B 0 or 1 Override enable
S14 N 2 I Full Block address of simulation value
2
S15 Y 0 I 0 or 1 Simulation enable
2
S16 Y 0 B 0 or 1 Status error inhibit
S17 Y 9.2 E18 R Full Output deviation limit
S18 N NULL String 0 - 32 Foreign device configuration parameters
S19 N 0 I Full Reserved for future use
S20 Y 0 R Full Spare
S21 N 2 I Note 1 Block address of the next element of the foreign device
S22 N 0 I Full Spare
S23 N 0.0 R Full Spare
S24 Y 0.0 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. The specification value active state is permitted to operate only when S26 of the device definition function code 221 or S11 of
the gateway function code 227 is enabled.

Explanation
Specifications
S1 (Channel label) Optional channel identifier. It is not required
to be configured and can be null. The channel label can be up
to 32 characters long.
S2 Block address on the BRC-100 controller of the analog value to
be output.
S3 (Engineering units low value) Defines the low limit of the out-
put channel’s range engineering units. Does not necessarily
indicate a 0 (zero) value.
S4 (Engineering units high value (low + span)) Output of the
block at full signal range.

223 - 2 WBPEEUI210504C0
S5 (Engineering units identifier) Identifies the engineering units
to be associated to the value when it is displayed on a console.
S6 (Default state on stall) Field outputs enter the configured
default state when a loss of communications with the BRC-100
controller occurs.

0 = 0% - channel output to go to 0%
1 = 100% - channel output to go to 100%
2 = hold - channel output to stay at current value
S7 (Engineering units high alarm) An alarm will be generated
when the input equals or exceeds this high limit.
S8 (Engineering units low alarm) An alarm will be generated
when the input becomes equal or less than this low limit.
S9 (Engineering units significant change) Change in input
allowed before the changed value is reported to a console or
open access system.
S10 (A/D conversion resolution) Specifies the relative resolution of
the analog-to-digital conversion. The higher the value, the
higher the resolution. A higher value may increase the A/D
conversion time or slow the responsiveness of the output.

NOTE: This specification is not used by any of the current analog output or
control input/output blocks and should be left at its default value.
S11 (Normal output/undefined) A value of 0 selects normal output
to standard I/O. A value of 1 puts the channel into an unde-
fined state which will not affect the channel status. Specifica-
tions S13 and S15 take precedence over S11 when S11 = 0,
but not when S11 = 1.

0 = normal
1 = undefined
S12 (Override value) Channel output value is overridden with this
value if override enable (S13) is set to 1.
S13 (Override enable) A value of 0 disables override for this chan-
nel. A value of 1 enables override in this channel. Override, if
enabled, will take precedence over normal output and
simulation. Specification S26 of the I/O device definition
function code 221 must be referenced to a boolean output that
is set to a 1 to permit this operation; otherwise, it is ignored.

WBPEEUI210504C0 223 - 3
0 = disabled
1 = enabled
S14 (Block address of simulation value) Channel output value is
simulated with this block input when simulation is enabled
and S15 is set to 1.
S15 (Simulation enable) A value of 0 disables simulation for this
channel. A value of 1 enables simulation for this channel and
receives its input from specification 14. Simulation has prece-
dence over S11 normal output, but not specification S13 over-
ride. Specification S26 of the I/O device definition function
code 221 must be referenced to a boolean output that is set to
a 1 to permit this operation; otherwise, it is ignored.

0 = disabled
1 = enabled

NOTE: The field output channel on the I/O block is not affected by the simula-
tion value. When simulation is enabled, the I/O block physical channels will be
held at their last known nonsimulated value.
S16 (Status error inhibit) Inhibits this channel’s I/O error contri-
bution to BRC-100 controller status. Specification S26 of func-
tion code 221 or specification S5 of the foreign device function
code 228 must reference a block output with a Boolean value
of 1 to permit this operation. Otherwise, it is ignored.

0 = no
1 = yes
S17 (Output deviation limit) In NORMAL mode (S11=0, S13=0,
S15=0), the output deviation limit specifies the maximum devi-
ation permitted between redundant analog output channels.
This only applies when both outputs are of good quality. When
the redundant output read back values are outside the limit,
the output channel will be considered in error (function block
output quality set to BAD, SUSP flag set in the exception
report, and an LIO error set in the BRC-100 controller status).

In OVERRIDE mode (S11=0, S13=1, S15=X) or in SIMULATION


mode (S11=0, S13=0, S15=1), the output deviation limit
assumes the meaning of output demand value deviation limit
and thus specifies the maximum deviation permitted between
primary output read back value and the output demand value
(<S2>). If the read back value and the output demand value
are outside the limit, the state of the output channel is

223 - 4 WBPEEUI210504C0
considered suspect (SUSP flag set in the exception report but
no LIO error set in the BRC-100 controller status) since a
bump both in the field output and in the function block output
value will occur upon exiting the OVERRIDE or SIMULATION
mode.

NOTE: This operates differently if used with a CIO-100 block with an


auto-bypass enabled IISAC01 control station. Refer to function code 80 for
more information.
S18 (Foreign device configuration parameters) A string data type
containing configuration information specific to the analog
output channel of a foreign device. The format is:
parameter name=value
The configuration parameters can be up to 32 characters long,
and a parameter value can range from zero to 255. No spaces
are allowed within an individual parameter specification, and a
blank character must separate each successive parameter
specification. For example: RANGE=16 specifies an output
range of 4 to 20 mA for a channel of the S800 I/O analog out-
put module. The parameters are module specific.

S800 Module Types


RANGE Signal Range
AO801 AO810 AO820
0 0...20 mA X X X
1 -20...20 mA X
2 0...10 V X
3 -10...10 V X
1
16 4...20 mA X X X
18 2...10 V X
NOTE:
1. Default

Refer to the S23 specification of FC222 to configure informa-


tion specific to the analog input channel of a foreign device.
S19 Reserved for future use.
S20 Spare.
S21 (Block address of next element of the foreign device) This
specification is the link to the next element of the foreign
device definition function code 228. The default value indicates
that this block is the last element. S21 must be set to the

WBPEEUI210504C0 223 - 5
default value if function code 223 is configured as a channel of
an I/O device definition function code 221.
S22 through S24 Spare.

Outputs
The analog out/channel function code 223 has one block
output.
N Block output value with quality.

Applications
• Refer to function code 80 for examples of using function
code 223 in a hardstation control loop configuration.

• Refer to function code 221 for information on assigning


function code 223 to Harmony I/O block channels.

• Refer to function code 227 for an example of assigning


function code 223 to foreign device definition I/O chan-
nels.

223 - 6 WBPEEUI210504C0
Digital In/Channel
Function Code 224
The exception reporting digital in/channel function code pro-
IO C /D IN
S7 S IM DI
(2 24 ) vides addressing, startup, run-time, Harmony sequence of
S 17 NEXT events (HSOE), and failure mode specifications for an individ-
ual or redundant pair of digital input channels on a Harmony
I/O block or an S800 I/O module. The digital in/channel func-
tion code must reside in the same segment as the I/O device
definition function code 221 or foreign device function code
228 to which it is mapped. This function is required for all
configured digital input I/O block channels.

NOTES:
1. This function code is used to support Harmony I/O blocks and S800 I/O
modules only. Refer to the IOR-800 Gateway instruction for specific differ-
ences between Harmony I/O and S800 I/O.

2. Function code 224 tunable specifications are not adaptable.

3. All HSOE points (HSOE enabled with S10=1) must be constrained to the
first sixteen channels (configured in S2 through S17) of the associated I/O
device definition function code 221, or the first sixteen channels of the associ-
ated foreign device definition function code 228 (first channel configured in S4).

Outputs

Blk Type Description


N B Input value with quality

Specifications

Spec Tune Default Type Range Description


S1 N NULL String 0 - 32 32-character channel label
S2 Y 2 I 0, 1, or 2 Alarm state
S3 Y 0004 I 0000 to 0xxx = debounce period in msec
0255
S4 N 0 B 0 or 1 Normal input/undefined
S5 Y 0 B 0 or 1 Override value
S62 Y 0 B 0 or 1 Override enable
S7 N 2 I Note 1 Block address of simulation value
2
S8 Y 0 I 0 or 1 Simulation enable

WBPEEUI210504C0 224 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S92 Y 0 B 0 or 1 Status error inhibit
S10 N 0 B 0 or 1 HSOE enable
S11 N 5 I 5 - 50 HSOE buffer size
S12 N 0 I 0 - 255 HSOE maximum events
S13 N 0 I 0 - 60 HSOE event time interval
S14 N 0 I 0 - 60 HSOE off-scan time interval
S15 N NULL String 0 - 32 Foreign device configuration parameters.
S16 N 0 I Full Reserved for future use
S17 N 2 I Note 1 Block address of the next element of the foreign device
S18 N 0 I Full Spare
S19 N 0.0 R Full Spare
S20 Y 0.0 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. The specification value active state is permitted to operate only when S26 of the device definition function code 221 or S11 of
the gateway function code 227 is enabled.

Explanation
Specifications
S1 (Channel label) Optional channel identifier. It is not required
to be configured and can be null. The channel label can be up
to 32 characters long.
S2 (Alarm state) Non-normal state.

0 = logic 0 alarm
1 = logic 1 alarm
2 = no alarm
S3 (Debounce period) Time allowed for stabilization of contacts (in
milliseconds). The valid range is 0000 - 0255, with 0000
meaning no debounce. Not used for foreign device definition
(function code 228) channels except by modules DI830, DI831,
and DI885.
S4 (Normal input/undefined) A value of 0 selects normal input
from standard I/O. A value of 1 puts the channel into an
undefined state which will not affect the channel status.

224 - 2 WBPEEUI210504C0
Specifications S6 and S8 take precedence when S4 = 0, but
not when S4 = 1.

0 = normal
1 = undefined
S5 (Override value) The channel input value is overridden with
this value if override enable (S6) is set to 1.
S6 (Override enable) A value of 0 disables override for this chan-
nel. A value of 1 enables override in this channel. Override, if
enabled, will take precedence over normal input and simula-
tion. Specification S26 of the I/O device definition function
code (FC 221) must reference a boolean output that is set to a
1 to permit this operation. Otherwise, it is ignored.

0 = disabled
1 = enabled

NOTE: A channel for which override is enabled will still be displayed on the
HSOE log if the channel is HSOE enabled (S10=1).
S7 (Block address of simulation value) The channel input value
is simulated with this block input when simulation is enabled
(S8 = 1).
S8 (Simulation enable) A value of 0 disables simulation for this
channel. A value of 1 enables simulation for this channel and
receives its input from S7. Simulation has precedence over
specification S4 normal input, but not S6 override. Specifica-
tion S26 of the I/O device definition function code 221 must
reference a boolean output that is set to a 1 to permit this
operation. Otherwise, it is ignored.

0 = disabled
1 = enabled

NOTE: A channel for which simulation is enabled will be displayed on the


HSOE log if the channel is HSOE enabled (S10=1).
S9 (Status error inhibit) Inhibits this channel’s I/O error contri-
bution to the BRC-100 controller status. Specification S26 of
function code 221 or specification S5 of the foreign device
function code 228 must reference a Boolean output with a
value of 1 to permit this operation. Otherwise, it is ignored.

0 = no
1 = yes

WBPEEUI210504C0 224 - 3
S10 (HSOE enable) Sequence-of-events (0 = No, 1 = Yes). Enables
sequence of events processing and allocates buffer space.

NOTE: The only way to eliminate a point from an HSOE log is to disable
HSOE.
S11 (HSOE buffer size) Number of events that will fit in buffer (5 -
50). Sequence-of-events queue size = 8 × (S11 + 1). The maxi-
mum number of event records that is possible to store before a
buffer overflow occurs.
S12 (HSOE maximum events) Maximum events (0 - 255). The max-
imum number of digital input events that are recorded within
the specified time interval (spec 13). Used for filtering in
sequence of events. A value of 0 disables this feature.
S13 (HSOE event time interval) Event time interval (0 - 60). The
time period (in seconds) in which events would be limited.
Used for filtering in sequence of events. A value of 0 disables
this feature.
S14 (HSOE off-scan time interval) Off-scan time interval (0 - 60 in
seconds). This value specifies the time interval the digital input
will be off-scan with respect to the events history buffer. Used
for filtering in sequence of events. A value of 0 disables this
feature.
S15 (Foreign device configuration parameters) A string data type
containing configuration information specific to the digital
input channel of a foreign device. The configuration parame-
ters can be up to 32 characters long. No spaces are allowed
within an individual parameter specification, and a blank
character must separate each successive parameter specifica-
tion. For example: NORM=1 specifies the normal position for a
channel of the S800 digital input module. The parameters are
module specific. They are valid only for sequence of events
(SOE) supporting S800 modules (DI830, DI831, DI885).

NOTE: To avoid configuration mismatch module problem reports, enter a blank


string in specification S15 for DI810 applications. The DI810 does not support
the SOE function.
S16 Reserved for future use.
S17 (Block address of next element of the foreign device) Link to
the next element of the foreign device definition function code
228. The default value indicates that this block is the last ele-

224 - 4 WBPEEUI210504C0
Parameter Meaning
NORM=(0...1) Normal position. NORM=0 (default) or NORM=1. Specifies the normal sig-
nal input value. This specification is used in first event determination. For
example, if the parameter NORM=0 is specified, and the S800 module is
powered-up or reset and the SOE channel’s input state is a 1, an initial SOE
event will be reported. However, if the parameter NORM=1 is specified and
the S800 module is powered-up or reset and the SOE channel’ input state is
a 1, an initial SOE event will not be reported. This parameter applies only to
the first event reported by the module. All subsequent input state changes
will be reported by the module.

ment. S17 must be set to the default value if function code 224
is configured as a channel of an I/O device definition function
code 221.
S18 through S20 Spare

NOTE: S12, S13, and S14 act as an event filter to prevent a chattering digital
input from filling a block (or controller) event history buffer. The specifications
will temporarily place the digital input channel off-scan after the maximum
number of events occur (S12) for the specified time interval (S13). The input
channel would be placed back on-scan after the off-scan time interval (S14)
had elapsed. This feature allows the channel to discard subsequent events
when an excessive number of events occur during a defined time interval.
Example: The maximum events specification (S12) is set to four, the event time interval
(S13) is set to one second, and the off-scan time interval (S14) is set to one,
and the digital input detected twenty events within one second. Only the first
four events would be entered into the event history buffer, the remaining
events would be discarded, and the scan would be restarted after one sec-
ond.

Outputs
The digital in/channel (function code 224) has one block out-
put.
N Boolean input value with quality.

Application
• Refer to function code 221 for information on assigning
function code 224 to Harmony I/O block channels.

• Refer to function code 227 for an example of assigning


function code 224 to foreign device definition I/O chan-
nels.

WBPEEUI210504C0 224 - 5
The following notes apply to the function code operation in
NORMAL, OVERRIDE, and SIMULATION modes:

In NORMAL mode (S4=0, S6=0, S8=0) with both inputs having


quality good but the states do not match, the input channel
will be considered in error (SUSP set in the exception report
and an LIO error set in the BRC-100 controller status).

In OVERRIDE mode (S4=0, S6=1, S8=X), the primary input


state and override state (S6) are compared, and if they do not
match, the input channel is considered suspect (SUSP flag set
in the exception report, but no LIO error set in the Harmony
controller status) since a bump in the block output value will
occur upon exiting the OVERRIDE mode.

In SIMULATION mode (S4=0, S6-0, S8=1), the primary input


state and the simulated state (<S7>) are compared and if they
do not match, will cause a suspect condition for this channel
(SUSP flag set in the exception report, but no LIO error set in
the Harmony controller status).

224 - 6 WBPEEUI210504C0
Digital Out/Channel
Function Code 225

IO C /D O U T The exception reporting digital out/channel function code pro-


S2 DO vides addressing, startup, run-time, and failure mode specifi-
S9 (22 5)
S15
S IM DO cations for an individual or redundant pair of digital output
NEXT
channels on a Harmony I/O block or an S800 I/O module. The
digital out/channel function code must reside in the same seg-
ment as the I/O device definition function code 221 or foreign
device function code 228 to which it is mapped. This function
is required for all configured digital output I/O block channels.

The control system must be carefully evaluated to establish


WARNING default values that will prevent personal injury and/or property
damage in the case of I/O block or S800 I/O module failure.

NOTES:
1. This function code is used to support Harmony I/O blocks and S800 I/O
modules only. Refer to the IOR-800 Gateway instruction for specific differ-
ences between Harmony I/O and S800 I/O.

2. Function code 225 tunable specifications are not adaptable.

Outputs

Blk Type Description


N B Output value with quality

Specifications

Spec Tune Default Type Range Description


S1 N NULL String 0 - 32 32-character channel label
S2 N 0 I Note 1 Block address of value to be output
S3 Y 2 I 0, 1, or 2 Alarm state, non-normal state
S4 N 0 I 0, 1, or 2 Default state on stall
S5 N 0 B 0 or 1 Readback enable
S6 N 0 B 0 or 1 Normal output/undefined
S7 Y 0 B 0 or 1 Override value
2
S8 Y 0 B 0 or 1 Override enable
S9 N 2 I Note 1 Block address of simulation value

WBPEEUI210504C0 225 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S102 Y 0 I 0 or 1 Simulation enable
S112 Y 0 B 0 or 1 Status error inhibit
S12 N NULL String 0 - 32 Foreign device configuration parameters
S13 N 0 I Full Reserved for future use
S14 N 0 B 0 or 1 Spare
S15 N 2 I Note 1 Block address of the next element of the foreign device
S16 N 0 I Full Spare
S17 N 0.0 R Full Spare
S18 Y 0.0 R Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC
2. The specification value active state is permitted to operate only when S26 of the device definition function code 221 or S11 of
the gateway function code 227 is enabled.

Explanation
Specifications
S1 (Channel label) Optional channel identifier. It is not required
to be configured and can be null. The channel label can be up
to 32 characters long.
S2 (Block address of value to be output) Block address on the
BRC-100 controller of the value to be output.
S3 (Alarm state, non-normal state) This specification is tunable
but not adaptable.

0 = logic 0 alarm
1 = logic 1 alarm
2 = no alarm
S4 (Default state on stall) The state that the field outputs enter
when a loss of communications with the BRC-100 controller
occurs.

0=0
1=1
2 = Hold

225 - 2 WBPEEUI210504C0
S5 (Readback enable) The output channels can have optional
readback hardware present. This specification must match the
hardware configuration with respect to whether this option is
enabled.

0 = disable readback
1 = enable readback

This option must always be enabled for foreign device defini-


tion (function code 228) channels.
S6 (Normal output/undefined) A value of 0 selects normal output
(S2) to standard I/O. A value of 1 puts the channel into an
undefined state which will not affect the channel status.
Specifications S8 and S10 take precedence when S6 = 0, but
not when specification S6 = 1.

0 = normal
1 = undefined
S7 (Override value) The channel output value is overridden with
this value if override enable (S8) is set to 1.
S8 (Override enable) A value of 0 disables override for this chan-
nel. A value of 1 enables override in this channel. Override, if
enabled, will take precedence over normal output (S6) and
simulation (S10). Specification S26 of the I/O device definition
function code 221 must reference a boolean output that is set
to a 1 to permit this operation; otherwise, it is ignored.

0 = disabled
1 = enabled
S9 (Block address of simulation value) The channel output value
is simulated with this block input when simulation is enabled
(S10 = 1).
S10 (Simulation enable) A value of 0 disables simulation for this
channel. A value of 1 enables simulation for this channel and
receives its input from S9. Simulation has precedence over S6
normal output, but not S8 override. Specification S26 of the I/
O device definition function code 221 must reference a boolean
output that is set to a 1 to permit this operation; otherwise, it
is ignored.

WBPEEUI210504C0 225 - 3
0 = disabled
1 = enabled

NOTE: The field output channel on the I/O block is not affected by the simula-
tion value. When simulation is enabled, the I/O block physical channels will be
held at their last known non-simulated value.
S11 (Status error inhibit) Inhibits this channel I/O error contribu-
tion to Harmony controller status. Specification S26 of the I/O
device definition function code 221 or specification S5 of the
foreign device function code 228 must reference a Boolean out-
put that is set to a 1 to permit this operation. Otherwise, it is
ignored.

0 = no
1 = yes
S12 (Foreign device configuration parameters) A string data type
containing configuration information specific to the digital out-
put channel of a foreign device. The configuration parameters
can be up to 32 characters long. No spaces are allowed within
an individual parameter specification, and a blank character
must separate each successive parameter specification. Pres-
ently there are no configuration parameters defined, and
therefore this field should be left blank.
S13 Reserved for future use.
S14 Spare.
S15 (Block address of next element of the foreign device) Link to
the next element of the foreign device definition function code
228. The default value indicates that this block is the last ele-
ment. S15 must be set to the default value if function code 225
is configured as a channel of an I/O device definition function
code 221.
S16 through S18 Spare.

Output
The digital out/channel function code has one output.
N Boolean block output value, with quality.

225 - 4 WBPEEUI210504C0
Applications
• Refer to function code 221 for information on assigning
function code 225 to Harmony I/O block channels.

• Refer to function code 227 for an example of assigning


function code 225 to foreign device definition I/O chan-
nels.

The following notes apply to the function code operation in


NORMAL, OVERRIDE, and SIMULATION modes:

In NORMAL mode (S6=0, S8=0, S10=0) with both outputs hav-


ing quality good but the states do not match, the output chan-
nel will be considered in error (SUSP set in the exception
report and the LIO error bit set in the Harmony controller sta-
tus).

In OVERRIDE mode (S6=0, S8=1, S10=X) or in SIMULATION


mode (S4=0, S5=0, S8=1), the primary readback state and the
output demand state (<S2>) are compared and if they do not
match, will cause a suspect condition for this channel (SUSP
flag set in the exception report but no LIO error set in the Har-
mony controller status) since a bump both in the field output
and in the block output value will occur upon exiting the
OVERRIDE or SIMULATION mode.

WBPEEUI210504C0 225 - 5
WBPEEUI210504C0
Test Status
Function Code 226
The test status function code identifies and monitors specific
S1 TEST (22 6 ) status conditions of the Harmony function codes that are not
S TAT U S N
available as block outputs. The test status function code is
able to monitor more than a single status condition simulta-
neously. The multiple status conditions are monitored in a log-
ical OR fashion, with the expected result being that if any of
the monitored status conditions would transfer to a true state,
the output of the test status function code would indicate a
single true status (logic 1) output. Otherwise, the output of the
block is a false status (logic 0) output.

The output of the test status function code can be used for
control logic and exception reporting functions.

Outputs

Block Type Description


N B Result of status conditions 1 through 4:
0 = false
1 = true

Specifications

Spec Tune Default Type Range Description


S1 N 2 I Note 3 Block address of Harmony I/O function code
to test.
S2 Y1 Null E90 string2 0-4 Status condition 1
1 string2
S3 Y Null E90 0-4 Status condition 2
S4 Y1 Null E90 string2 0-4 Status condition 3
1 string2
S5 Y Null E90 0-4 Status condition 4
1
S6 Y 0 I Full Spare
1
S7 Y 0 I Full Spare
S8 Y1 0 I Full Spare
1
S9 Y 0 I Full Spare

WBPEEUI210504C0 226 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S10 Y1 Null E90 string2 0-32 Spare
NOTES:
1. These specifications are tunable, but not adaptable.
2. The E90 string type cannot be tuned to a string that is longer than the length of the originally configured string. Thus, this
specification cannot be tuned if it is configured with the default null string.
3. Maximum values are:9,998 for the BRC-100 and BRC-200
31,998 for the HAC

Explanation
Specifications
S1 Block address of the Harmony I/O function code to be tested.
The test status function block must reside in the same control-
ler segment as the block to be tested.
S2 Specifies the first status condition to test on the block speci-
fied by specification S1. Each Harmony I/O function code has
a list of valid status conditions that can be tested. The status
condition is specified as a string of characters which must be
valid for the function code. (The null string represents a logic
zero). Refer to the following in this section:

• FC 221 Status Conditions


• FC 222 and FC 223 Status Conditions
• FC 224 and FC 225 Status Conditions
• FC 227 Status Conditions
• FC 228 Status Conditions
• FC 229 Status Conditions
S3 Specifies the second status condition to test on the block spec-
ified by specification S1. Refer to the preceding explanation for
specification S2.
S4 Specifies the third status condition to test on the block speci-
fied by specification S1. Refer to the preceding explanation for
specification S2.
S5 Specifies the fourth status condition to test on the block speci-
fied by specification S1. Refer to the preceding explanation for
specification S2.
S6 through S9 Spare integer parameters.
S10 Spare E90 string parameter.

226 - 2 WBPEEUI210504C0
FC 221 Status Conditions
Harmony I/O device definition (function code 221) blocks can
be tested for the status conditions shown in Table 226-1. The
terms primary or backup refer to the current logical state of a
device and do not represent the physical position of the device
in a redundant termination base. If redundant devices are not
installed (i.e., no backup device exists), all status conditions
applied to the backup device evaluate to a logic zero.

Table 226-1. Function Code 221 Status Conditions

Primary Backup
Status Condition
Device String Device String
PAFP BAFP Auxiliary field power failure.
PCHK BCHK Checkpoint complete. This status condition is always FALSE.
PERR BERR Device has an error.
PEST BEST Communication established with device. If this status condition is
FALSE, all other status conditions for the device evaluate to
FALSE.
PFPW BFPW Field power failure.
PFTX BFTX First time in execute.
PHAR BHAR Hnet A relay failure.
PHBR BHBR Hnet B relay failure.
PHNA BHNA Hnet A failure.
PHNB BHNB Hnet B failure.
PLIO BLIO Local I/O error.
PNVF BNVF Nonvolatile memory failure.
PPWA BPWA Input power A failure.
PPWB BPWB Input power B failure.
PRDA BRDA Redundancy link A failure.
PRDB BRDB Redundancy link B failure.
PRDD BRDD Redundant device detected.
PRDF BRDF Redundant device failed.
PSOA BSOA Status output alarm.
PSTA not applicable Station error.

Figure 226-1 illustrates the connection made to function code


221 to test for status conditions.

WBPEEUI210504C0 226 - 3
FC 222 and FC 223 Status Conditions
Harmony I/O analog in/channel (function code 222) and ana-
log out/channel (function code 223) function code blocks can
be tested for the status conditions shown in Table 226-2. The
status conditions apply only to the primary channel of a
redundant pair.

IO D /D E F
S2
C H01
S3
C H02
S4
C H03
S5
C H04
S6
C H05
S7
C H06
S8
C H07
S9
C H08
S 10
C H09
S 11
C H10
S 12
C H11
S 13
C H12
S 14
C H13
S 15
C H14
S 16
C H15
S 17
C H16
S 18
C H17
S 19
C H18
S 20
C H19
S 21
C H20
S 22
C H21
S 23
C H22
S 24
C H23
S 25
C H24
S 26
P E R M IT
S 29
C JR
S 31
S PA R E
S 33
S PA R E
(221) P R IM A RY
S TAT U S
B AC K U P
S TAT U S
S1 TEST (226) OV R /S IM
S TAT U S N S PA R E
R E S E RV E D
T03551A

Figure 226-1. Test Status Connection for Function Code 221

226 - 4 WBPEEUI210504C0
Table 226-2. Function Codes 222 and 223 Status Conditions

String Status Condition


ALRM Alarm state.
BADQ Bad quality.
CALI Calibration error.
CONF Configuration error.
HALM High alarm.
HDEV High deviation alarm.
INHB Status errors are inhibited.
LALM Low alarm.
LDEV Low deviation alarm.
OPEN Open circuit.
OVER Value is over range.
OVRD Output value overridden.
PRPQ Propagated quality.
RANG Range error (open/short/over/under).
RBAK Readback channel is bad.
REFR Reference is bad.
SHRT Short circuit.
SIML Simulation mode enabled.
SUSQ Suspect quality.
UNDR Value is under range.

FC 224 and FC 225 Status Conditions


Harmony I/O digital in/channel (function code 224) and digi-
tal out/channel (function code 225) function code blocks can
be tested for the status conditions shown in Table 226-3. The
status conditions apply only to the primary channel of a
redundant pair.

Table 226-3. Function Codes 224 and 225 Status Conditions

String Status Condition


ALRM Alarm state.
BADQ Bad quality.
CONF Configuration error.
INHB Status errors are inhibited.

WBPEEUI210504C0 226 - 5
Table 226-3. Function Codes 224 and 225 Status Conditions (continued)

String Status Condition


OVRD Output value overridden.
PRPQ Propagated quality.
RBAK Readback channel is bad.
SIML Simulation mode enabled.
SUSQ Suspect quality.

FC 227 Status Conditions


Gateway (function code 227) blocks can be tested for the sta-
tus conditions shown in Table 226-4. The term primary or
backup refers to the current logical state of a device and does
not represent the physical position of the device in a redun-
dant termination base. If redundant devices are not installed
(i.e., no backup device exists), all status conditions applied to
the backup device evaluate to a logic zero.

Table 226-4. Function Code 227 Status Conditions

Primary Backup
Status Condition
Device String Device String
P1BZ (not applicable) Communication port 1 is busy.
P1CE (not applicable) Communication port 1 has a configuration error.
P1ER B1ER Communication port 1 has an error.
P1FB (not applicable) Communication port 1 has a function block configuration.
P1FF (not applicable) Communication port 1 has a field bus foundation configuration.
P1NO B1NO Communication port 1 is inoperative.
P1U1 (not applicable) Communication port 1 parameters 1 have been updated.
P1U2 (not applicable) Communication port 1 parameters 2 have been updated.
P2BZ (not applicable) Communication port 2 is busy.
P2CE (not applicable) Communication port 2 has a configuration error.
P2ER B2ER Communication port 2 has an error.
P2FB (not applicable) Communication port 2 has a function block configuration.
P2FF (not applicable) Communication port 2 has a field bus foundation configuration.
P2NO B2NO Communication port 2 is inoperative.
P2U1 (not applicable) Communication port 2 parameters 1 have been updated.
P2U2 (not applicable) Communication port 2 parameters 2 have been updated.
P3BZ (not applicable) Communication port 3 is busy.

226 - 6 WBPEEUI210504C0
Table 226-4. Function Code 227 Status Conditions (continued)

Primary Backup
Status Condition
Device String Device String
P3CE (not applicable) Communication port 3 has a configuration error.
P3ER B3ER Communication port 3 has an error.
P3FB (not applicable) Communication port 3 has a function block configuration.
P3FF (not applicable) Communication port 3 has a field bus foundation configuration.
P3NO B3NO Communication port 3 is inoperative.
P3U1 (not applicable) Communication port 3 parameters 1 have been updated.
P3U2 (not applicable) Communication port 3 parameters 2 have been updated.
P4BZ (not applicable) Communication port 4 is busy.
P4CE (not applicable) Communication port 4 has a configuration error.
P4ER B4ER Communication port 4 has an error.
P4FB (not applicable) Communication port 4 has a function block configuration.
P4FF (not applicable) Communication port 4 has a field bus foundation configuration.
P4NO B4NO Communication port 4 is inoperative.
P4U1 (not applicable) Communication port 4 parameters 1 have been updated.
P4U2 (not applicable) Communication port 4 parameters 2 have been updated.
PAFP BAFP Auxiliary field power failure.
PCHK BCHK Checkpoint complete. This status condition is always FALSE.
PERR BERR Device has an error.
PEST BEST Communication established with device. If this status condition
is FALSE, all other status conditions for the device evaluate to
FALSE.
PFPW BFPW Field power failure.
PFTX BFTX First time in execute.
PHAR BHAR Hnet A relay failure.
PHBR BHBR Hnet B relay failure.
PHNA BHNA Hnet A failure.
PHNB BHNB Hnet B failure.
PLIO BLIO Local I/O error.
PNVF BNVF Nonvolatile memory failure.
PPWA BPWA Input power A failure.
PPWB BPWB Input power B failure.
PRDA BRDA Redundancy link A failure.
PRDB BRDB Redundancy link B failure.

WBPEEUI210504C0 226 - 7
Table 226-4. Function Code 227 Status Conditions (continued)

Primary Backup
Status Condition
Device String Device String
PRDD BRDD Redundant device detected.
PRDF BRDF Redundant device failed.
PSOA BSOA Status output alarm.

FC 228 Status Conditions


Foreign device definition (function code 228) function code
blocks can be tested for the status conditions shown in Table
226-5. The status conditions apply only to the primary device
of a redundant pair.

Table 226-5. Function Code 228 Status Conditions

String Status Conditions


ERRS Foreign device has an error.
INOP Foreign device is inoperative.

FC 229 Status Conditions


Pulse In/Channel (function code 229) function code blocks
can be tested for the status conditions shown in Table 226-6.
The status conditions apply only to the primary channel of a
redundant pair.

Table 226-6. Function Code 229 Status Conditions

String Status Condition


ALRM Alarm state.
BADQ Bad quality.
CONF Configuration error.
HALM High alarm.
HDEV High deviation alarm.
INHB Status errors are inhibited.
LALM Low alarm.
LDEV Low deviation alarm.
OVER Value is over range.
OVRD Output value overridden.
POWR Transducer field power failure.

226 - 8 WBPEEUI210504C0
Table 226-6. Function Code 229 Status Conditions

String Status Condition


PRPQ Propagated quality.
RANG Range error (over/under range).
RBAK Readback channel is bad.
SIML Simulation mode enabled.
SUSQ Suspect quality.
UNDR Value is under range.

WBPEEUI210504C0 226 - 9
WBPEEUI210504C0
Gateway
Function Code 227

G AT E W AY The gateway function code supports Harmony communication


(2 2 7)
S3
P1 P R IM A RY
S TAT U S
block devices. A Harmony communication block device can
S5 N
S7
P2 B AC K U P
S TAT U S
incorporate up to four communication ports, each of which
P3 N+1
S9
P4
P1
S TAT U S N+2
provides a communication network for foreign devices. Func-
P2
S 11
P E R M IT S TAT U S N+3 tion code 227 is used to make appropriate assignments of
S 16 P3
NEXT S TAT U S
N+4 function code 228 to Harmony communication block commu-
P4
S TAT U S
N+5 nication ports and specify their communication parameters.
S PA R E
N+6 Definition of this function code is required for all Harmony
S PA R E
N+7 communication block devices.

NOTES:
1. Function code 227 tunable specifications are not adaptable.

2. This function code is supported only by the BRC-100 and the BRC-200
controllers.

3. Function code 227 must reside in the same segment as the foreign device
definition function code 228 to which it is mapped.

Outputs

Blk Type Description


N B Primary communication block status with quality
N+1 B Backup communication block status with quality
N+2 B Communication port 1 status with quality
N+3 B Communication port 2 status with quality
N+4 B Communication port 3 status with quality
N+5 B Communication port 4 status with quality
N+6 B Spare output with quality
N+7 R4 Reserved output with quality

Specifications

Spec Tune Default Type Range Description


S1 N NULL String 0-32 32-character device label
S2 N NULL String 0-255 Harmony communication block configuration
parameters
S3 N 2 I Note 1 Block address of first foreign device definition for
communication port 1

WBPEEUI210504C1 227 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S4 N NULL String 0-255 Communication port 1 configuration parameters
S5 N 2 I Note 1 Block address of first foreign device definition for
communication port 2
S6 N NULL String 0-255 Communication port 2 configuration parameters
S7 N 2 I Note 1 Block address of first foreign device definition for
communication port 3
S8 N NULL String 0-255 Communication port 3 configuration parameters
S9 N 2 I Note 1 Block address of first foreign device definition for
communication port 4
S10 N NULL String 0-255 Communication port 4 configuration parameters
S11 N 2 I Note 1 Block address of override / status error inhibit /
simulation permit
S122 Y 0 B 0 or 1 Device status error inhibit
S13 N 0 B 0 or 1 Redundant gateway expected
S15 N 0 I 0-32,767 NVM buffer size
S16 N 2 I Note 1 Block address of the next HSOE gateway func-
tion code 227 or device definition function code
221.
S17 N 2 I Note 1 Spare
S18 N 0.0 R Full Spare
S19 Y NULL String 0-255 Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100 and BRC-200;
31,998 for the HAC
2. The specification value active state is permitted to operate only when S11 of the gateway is enabled.

Explanation
Specifications
S1 (Device label) Device label of string data type used as a logical
address of the Harmony communication block. This label must
match the device label configured in the Harmony communica-
tion block. The device label can be up to 32 characters long.
For proper operation, the label cannot be null.
S2 (Harmony communication block configuration parameters) A
string data type containing configuration information specific
to the Harmony communication block. Refer to Gateway and

227 - 2 WBPEEUI210504C1
Communication Port Configuration Parameters in this section
for a description of the string format to be used.
S3 (Block address of first foreign device definition for communi-
cation port 1) Links the gateway function code 227 to the first
foreign device definition function code 228 in the list of func-
tion codes 228 for communication port 1 of the Harmony com-
munication block. The default value indicates that the
communication port is not configured.
S4 (Communication port 1 configuration parameters) A string
data type containing configuration information specific to the
communication port 1 of the Harmony communication block.
Refer to Gateway and Communication Port Configuration
Parameters for a description of the string format to be used.
S5 (Block address of first foreign device definition for communi-
cation port 2) Links the gateway function code 227 to the first
foreign device definition function code 228 in the list of func-
tion codes 228 for communication port 2 of the Harmony com-
munication block. The default value indicates that the
communication port is not configured.
S6 (Communication port 2 configuration parameters) A string
data type containing configuration information specific to the
communication port 2 of the Harmony communication block.
Refer to Gateway and Communication Port Configuration
Parameters for a description of the string format to be used.
S7 (Block address of first foreign device definition for communi-
cation port 3) Links the gateway function code 227 to the first
foreign device definition function code 228 in the list of func-
tion codes 228 for communication port 3 of the Harmony com-
munication block. The default value indicates that the
communication port is not configured.
S8 (Communication port 3 configuration parameters) A string
data type containing configuration information specific to the
communication port 3 of the Harmony communication block.
Refer to Gateway and Communication Port Configuration
Parameters for a description of the string format to be used.
S9 (Block address of first foreign device definition for communi-
cation port 4) Links the gateway function code 227 to the first
foreign device definition function code 228 in the list of func-
tion codes 228 for communication port 4 of the Harmony com-

WBPEEUI210504C1 227 - 3
munication block. The default value indicates that the
communication port is not configured.
S10 (Communication port 4 configuration parameters) A string
data type containing configuration information specific to the
communication port 4 of the Harmony communication
block.Refer to Gateway and Communication Port Configura-
tion Parameters for a description of the string format to be
used.
S11 (Block address of override / status error inhibit / simulation
permit) Links to a function block which will provide a Boolean
indication as to whether a particular feature is permitted. If
the value from the attached Boolean output is zero, no over-
ride, status error inhibit, or simulation is permitted on any for-
eign device or channel of that foreign device. If the value from
the attached Boolean output is one, override, status error
inhibit, or simulation is permitted on any associated function
block.
S12 (Device status error inhibit) If set to one, inhibits all status
errors originating from the Harmony communication block
from being included in the controller's status. The default
value causes all Harmony communication block, foreign
device, and channel errors to be included in the controller's
status if not otherwise inhibited at the foreign device or chan-
nel level.
S13 (Redundant module expected) If set to one, a redundant mod-
ule is always expected. If a redundant module is not found
(function code 227 output N+1 = 1 and has BAD quality), the
controller generates a module problem report. If set to zero,
then no redundant module is expected, but may exist.
S15 (NVM buffer size) Specifies the minimum number of two-byte
words to reserve for storage of uploaded Harmony communica-
tion block foreign configuration data received from the foreign
side of the gateway (e.g., Foundation Fieldbus LAS files). This
foreign configuration data is downloaded to the Harmony com-
munication block upon the replacement of the Harmony com-
munication block. The default value prevents the upload of the
foreign configuration data. The IOR-800 module does not have
foreign configuration data to store in the NVM buffer.
S16 (Block address of the next HSOE gateway function code 227
or device definition function code 221) This specification is

227 - 4 WBPEEUI210504C1
required only when the digital inputs (function code 224) asso-
ciated with the foreign device definition function code 228 are
being used as part of a Harmony sequence of events (HSOE)
system.
S17 through S19 Spare.

Outputs
The communication block status outputs (N, N+1) are the
error summary of the communication block's overall operation
status (i.e., Harmony network, redundancy, power, configura-
tion status, and communication ports status) and error sum-
mary of all configured foreign devices and their channels.
N Primary communication block status (0 = good, 1 = bad). Qual-
ity is set bad when function code 227 cannot communicate
with the primary communication block.
N+1 Backup communication block status (0 = good, 1 = bad). Qual-
ity is set bad when function code 227 cannot communicate
with the backup communication block.
N+2 Communication port 1 status (0 = good, 1 = bad). Quality is set
bad when the communication port 1 is inoperative.
N+3 Communication port 2 status (0 = good, 1 = bad). Quality is set
bad when the communication port 2 is inoperative.
N+4 Communication port 3 status (0 = good, 1 = bad). Quality is set
bad when the communication port 3 is inoperative.
N+5 Communication port #4 status (0 = good, 1 = bad). Quality is
set bad when the communication port 4 is inoperative.
N+6 Spare output with quality always set good.
N+7 Reserved output with quality always set good.

Gateway and Communication Port Configuration Parameters


NOTE: There are no configuration parameters defined at this time. The follow-
ing description is for demonstration purposes only and does not describe an
actual Harmony communication block (HCB) device. Refer to the product
instruction document of the HCB device for information regarding the configu-
ration parameters for the device and its communication ports.

WBPEEUI210504C1 227 - 5
The following format is used to specify Harmony communica-
tion block configuration parameters (S2) and communication
port configuration parameters (S4, S6, S8, & S10) within a
string data-type specification.

Pxx=string

where:

P Parameter identifier.
xx One or two digit decimal parameter number.
string One or two ASCII characters, not to exceed 255
characters.
Examples P1=1
P3=100
P12=5

The following rules pertain to parameter declarations:

• A configuration parameter string must not exceed 255


characters in length.

• All characters within the string must use ASCII codes.

• Each parameter specified must begin with the letter P fol-


lowed immediately by a one or two digit parameter number.

• The parameter number must be followed immediately by


the equal/assignment (=) symbol.

• The parameter value must immediately follow the assign-


ment (=) symbol.

• A space (Hex 20) character must be used to delimit each


parameter declaration.

• Case is not significant.

• The ASCII space character is not permitted within the


string portion of the parameter declaration unless the
entire string is enclosed within single quotes.
Example P1='TCP IP'

Table 227-1 describes the possible parameter string values


that can be used for S2 if the parameter identifier and number
are P1.

227 - 6 WBPEEUI210504C1
Table 227-1. Harmony Communication Block Configuration Parameters (S2)

Parameter Values Default Description


P1 0=EXEC 0 Powerup mode. This is the mode the Harmony com-
1=CFG munication block configuration parameters will enter
2=HOLD last mode following a powerup/module reset.

Application
Figure 227-1 illustrates how foreign device definition function
code 228 and channel function codes 222 through 225 are
used in operation with the gateway function code 227.

WBPEEUI210504C1 227 - 7
Figure 227-1. Function Codes Used with FC227 for S800 I/O

227 - 8 WBPEEUI210504C1
Foreign Device Definition
Function Code 228

FDD
The foreign device definition function code is required for all
S3
NEXT (2 28 ) foreign devices. Function code 228 is used to make appropri-
S4 S TAT U S

S6
F IR S T N ate assignments of function codes 222, 223, 224, 225, and
S PA R E
229 to foreign device channels. Each foreign device incorpo-
S PA R E
N+1 rates a specific combination of channel data types (digital
input, digital output, analog input, analog output, and pulse
input).

NOTES:
1. Function code 228 tunable specifications are not adaptable.

2. All HSOE points (HSOE enabled with S10=1 of function code 224) must
be constrained to the first sixteen channels of the associated foreign device
definition function code 228.

3. This function code is supported only by the BRC-100 and the BRC-200
controllers.

4. Function code 228 must reside in the same segment as the gateway func-
tion code 227 to which it is mapped.

Outputs

Blk Type Description


N B Primary communication block status with quality.
N+1 R4 Reserved output with quality

Specifications

Spec Tune Default Type Range Description


S1 N NULL String 0-32 32-character device label
S2 N NULL String 0-255 Foreign device configuration parameters
S3 N 2 I Note 1 Block address of the next foreign device
S4 N 2 I Note 1 Block address of first channel
2
S5 Y 0 B 0 or 1 Device status error inhibit
S6 N 2 I Note 1 Spare
S7 Y NULL String 0-255 Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100 and BRC-200;
2. The specification value active state is permitted to operate only when S11 of the gateway function code 227 is enabled.

WBPEEUI210504C1 228 - 1
Explanation
Specifications
S1 (Device label) Device label of string data type used as a logical
address of the foreign device. This label must match the device
label configured in the foreign device. The device label can be
up to 32 characters long. For proper operation, the label can-
not be null and cannot be a duplicate of any other foreign
device or channel label configured for the same communica-
tion port of its gateway function code 227.

For S800 I/O modules, the device label specifies the Module-
bus address. The Modulebus address consists of a cluster
number (1 to 7) and a module position (1 to 12) with a single
delimiter character in between. A valid delimiter can be any
non-numeric character. For example, the label 1.12 specifies
cluster number 1, module position 12. The module address
must start at the beginning of the label. Any text then can fol-
low the address as long as it is delimited from the address. For
example, 3.1: Cluster #3, Module #1 is a valid label for the
S800 module at cluster number 3, module position 1.
S2 (Foreign device configuration parameters) A string data type
containing configuration information specific to the foreign
device. The configuration parameters can be up to 255 charac-
ters long. No spaces are allowed within an individual parame-
ter specification, and a blank character must separate each
successive parameter specification. For example, TYPE=AI835
GRID=50 FJT=12.34 specifies an AI835 analog input module
with a power grid frequency of 50 Hz and a fixed junction tem-
perature of 12.34 degrees Celsius. The parameters are module
specific.

NOTE: The debounce/filter parameter is not determined by this specification


for S800 modules DI830, DI831, and DI885. It is instead determined by specifi-
cation 3 of function code 224.

228 - 2 WBPEEUI210504C1
S2 Parameter Meaning Specifications S800 Modules
TYPE S800 I/O module type. AI801, AI810, AI820, AI801, AI810, AI820,
AI830, AI835, AI890, AI830, AI835, AI890,
AO801, AO810, AO801, AO810,
AO820, DI801, DI810, AO820, DI801,
DI811, DI814, DI820, DI810, DI811, DI814,
DI821, DI830, DI831, DI820, DI821, DI830,
DI885, DO801, DI831, DI885,
DO810, DO814, DO801, DO810,
DO815, DO820, DO814, DO815,
DO821, DP820 DO820, DO821,
DP820
TIMEOUT Communication time-out (ms). 0, 10241 AO8XX
TIMEOUT Communication time-out (ms). 0, 2561, 512, 1024 DO8XX
1,
FILTER Filter time (ms). 2 4, 8, 16 DI8XX
(except DI830,
DI831, DI885)
GRID Power grid frequency (Hz). 16, 50, 601 AI830, AI835
(Selecting 16 specifies
16 2/3 Hz).
FJT Fixed junction temperature (deg Celsius). Any AI835
SENSOR Sensor type. 01, 1, 2, 3, 4, 5, 6, 7, 8, DI8XX
9, 10, 11, 12, 13, 14, (except DI830)
15
Refer to following
table.
PSMODE Sensor power supply type. 0, 1, 2, 3, 4, 51, 6, 7, 8, DI8XX
9, 10, 11, 12, 13, 14, (except DI830)
15
Refer to following
table.
NOTE:
1. Default if parameter not specified.

Group 1 Group 2
Specification (Channels 1 - 8) (Channels 9 - 16)
SENSOR PSMODE SENSOR PSMODE
0 Type 1 48V external Type 1 48V external
1 Type 1 48V external Type 2 24V external
2 Type 1 48V external Type 3 24V internal
3 Type 1 48V external Type 4 Spare
4 Type 2 24V external Type 1 48V external
5 Type 2 24V external Type 2 24V external
6 Type 2 24V external Type 3 24V internal
7 Type 2 24V external Type 4 Spare

WBPEEUI210504C1 228 - 3
Group 1 Group 2
Specification (Channels 1 - 8) (Channels 9 - 16)
SENSOR PSMODE SENSOR PSMODE
8 Type 3 24V internal Type 1 48V external
9 Type 3 24V internal Type 3 24V external
10 Type 3 24V internal Type 3 24V internal
11 Type 3 24V internal Type 4 Spare
12 Type 4 Spare Type 1 48V external
13 Type 4 Spare Type 2 24V external
14 Type 4 Spare Type 3 24V internal
15 Type 4 Spare Type 4 Spare

S3 (Block address of the next foreign device) Links the foreign


device function code 228 to the next foreign device definition
function code 228 in the list of foreign devices for the commu-
nication port of the gateway function code 227. The default
value indicates the end of the list.
S4 (Block address of the first channel) Links the foreign device
function code 228 to the first channel function code 222, 223,
224, 225, or 229 of the foreign device. The default value
indicates that there are no channels configured for this foreign
device.

For S800 I/O modules, the channel function code blocks are
assigned to the channels of the S800 module in the order that
they are specified in the linked list. That is, the first channel
function code block in the linked list is assigned to the first
channel of the module, the second channel function code
block to the second channel, and so on up to the last used
channel of the module. In order to skip an unused channel of a
module, configure a channel function code block with its Nor-
mal/Undefined specification set to undefined.
S5 (Device status error inhibit) If set to one, inhibits all status
errors originating from the foreign device from being included
in the gateway function code 227 status. The default value
causes all foreign device and channel errors to be included in
the gateway's status if not otherwise inhibited at the channel
level.
S6 through S7 Spare.

228 - 4 WBPEEUI210504C1
Outputs
N Foreign device status (0 = good, 1 = bad). Quality is set bad
when function code 228 cannot communicate with the foreign
device. The foreign device status output is the error summary
of all of its configured channels.
N+1 Reserved output with quality always set good.

Application
Refer to the function code 227 description for an example of
assigning function code 228 to a gateway function code 227
and the I/O channel function codes 222 through 225.

WBPEEUI210504C1 228 - 5
WBPEEUI210504C1
Pulse In/Channel
Function Code 229
The exception reporting pulse in/channel function code pro-
IO C /P IN
S 13
RESET
(22 9) vides addressing, startup, run-time, and failure mode specifi-
S 14
HOLD
N cations for an individual or redundant pair of pulse input
S 18
S IM channels on a Harmony I/O block or S800 incremental pulse
S 25
NEXT
S 26 module. The pulse in/channel function code must reside in
FDPC
S 32
S PA R E
the same segment foreign device definition function code 228
to which it is mapped. This function is required for all config-
ured pulse input I/O block channels.

NOTES:
1. Function code 229 tunable specifications are not adaptable.

2. Pulse input channels are supported only by the IOR-800 with DP820. The
DP820 is an incremental pulse counter I/O module.

Outputs

Blk Type Description


N R Pulse input value (in specified EUs) with quality.

Specifications

Spec Tune Default Type Range Description


S1 N NULL String 0-32 32-character channel label
S2 N 101 I xy0, xy1, Filtering/conversion type:
xy2, xy3, Conversion type
xy4, xy5, xy0 - Period
or xy6 xy1 - Frequency
xy2 - Duration (Not supported by DP820.)
x=0 or 1
xy3 - Totalize up
and y=0
xy4 - Totalize down
xy5 - Totalize up with reset on high alarm limit
(Resets to start value + overrun when high alarm is
exceeded.)
xy6 - Totalize down with reset on low alarm limit
(Resets to start value + overrun when low alarm is
exceeded.)
y - Rising/falling edge level. For DP820, it is set to zero.
Pulse trigger level:
x0z - Low to high
x1z - High to low
Filtering
0yz - Filtering disabled
1yz - Filtering enabled

WBPEEUI210504C0 229 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S3 N 0.0 R Full Engineering units low value
S4 N 100.0 R Full Engineering units high value
S5 N 0 I 0 - 255 Engineering units identifier
S6 Y 100.0 R Full Engineering units high alarm
S7 Y 0.0 R Full Engineering units low alarm
S8 Y 0.0 R Full Engineering units significant change
S9 Y -5.0 R Full Engineering units alarm dead-band. Prevents alarm chat-
tering. Supersedes S10 in function code 82 when set to a
positive value.
S104 N 0.0 R Full Expected channel low value.
Expected low frequency value (Hertz) (S2=x0) or
Expected low period value (Seconds) (S2=x1) or
Expected low duration value (Counts) (S2=x2)
Expected low count limit (Counts) (S2=x3/4/5/6)
S114 N 5000.0 R Full Expected channel high value.
Expected high frequency value (Hertz) (S2=x0) or
Expected high period value (Seconds) (S2=x1) or
Expected high duration value (Counts) (S2=x2)
Expected high count limit (Counts) (S2=x3/4/5/6)
S12 N 0 R Full Engineering units start value.
S13 N 2 I Note 1 Block address of Reset.
0 - Continue
1 - Reset to start value
S14 N 2 I Note 1 Block address of Hold.
0 - Continue
1 - Hold accumulated value
S15 N 0 B 0 or 1 Normal input/undefined.
S16 Y 0.0 R Full Override value.
S173 Y 0 B 0 or 1 Override enable.
S18 N 2 I Note 1 Block address of simulation value.
S193 Y 0 I 0 or 1 Simulation enable.
3
S20 Y 0 B 0 or 1 Status error inhibit.
S21 Y 9.2E18 R Full Redundant input deviation limit.
S22 Y 0.0 R Full Reserved for future use.
S23 N Null String 0-32 32-character channel configuration parameter.
(None defined at this time. Reserved for future use.)
S24 N 0 I Full Reserved for future use.
5
S25 N 2 I Note 1 Block address of next element of the foreign device.
S26 N 2 I Full Spare
S27 N 0.0 R Full Spare

229 - 2 WBPEEUI210504C0
Specifications (continued)

Spec Tune Default Type Range Description


S28 Y 0.0 R Full Spare
S29 Y 0.0 R Full Spare
S30 Y 0.0 R Full Spare
S31 N 0 I Full Spare
S32 N 2 I Full Spare
NOTES:
1. Maximum values are: 9,998 for the BRC-100 and BRC-200.
2. Specification value active state is permitted to operate only when S11 of the gateway function code 227 is enabled.
3. The frequency/period/duration range and offset are calculated from the S10 and S11. Greater specified range settings allow
for greater/lesser frequency, period, and duration measurements at the trade-off of lesser/greater precision of measurement. The
range and offset values specified are translated and used by pulse input hardware to program its hardware specific measurement
ranges and offsets.
4. Links to the next element of the foreign device definition (228) function block.

Explanation
Specifications
S1 (Channel label) Optional channel identifier. It is not required
to be configured and can be null. The channel label can be up
to 32 characters long.
S2 (Conversion type) The conversion type is specified as a three
digit number of the following format:

FLT

where:

F Filtering (1=yes, 0=no)

Filtering enables pulse input hardware signal filtering. It is


typically enabled, but may be disabled for low voltage/current
type pulse input applications in order to allow for higher fre-
quency pulse input signals where special EMI protection is
provided for the inputs. It is recommended to be set.

L Pulse trigger level (0=low to high transitions,


1=high to low transitions)

Pulse trigger level selection is not supported by the DP820


S800 module. Set to zero.

WBPEEUI210504C0 229 - 3
T Type.

0 = Period. Same functionality as function code 102.

1 = Frequency. Same functionality as function code 103.

2 = Duration. Same functionality as function code 109. (Not


supported by DP820).

3 = Totalize up. Same functionality as function code 104 with


S5=0 and S8=0.

4 = Totalize down. Same functionality as function code 104


with S5=1 and S8=0.

5 = Totalize Up with reset on high alarm limit. (Same function-


ality as function code 104 with S5=0 and S8=1). Resets to start
value plus overrun when high alarm is exceeded.

6 = Totalize Down with reset on low alarm limit. (Same func-


tionality as function code 104 with S5=1 and S8=1). Resets to
start value plus overrun when low alarm is exceeded.

• In Period mode, the DP820 measures the time between


consecutive pulses. The total measurement range is 5
microseconds (filtered) or 6.67 microseconds (unfiltered) to
2.5 seconds with High and Low alarms. Positive pulses can
be measured. The time measured is the time between the
rising edge of a pulse to the rising edge of the next pulse
(rising edge detection). The resolution of the period mea-
surement depends on the application and is guaranteed to
be have a maximum absolute frequency error of 1.64
parts/million. If no pulses are detected, then the last mea-
sured value is held until a loss of signal time period
expires. The DP820 reads the frequency directly and then
converts it to period.

• In Frequency mode, the DP820 counts the number of input


pulses or cycles that occur in a fixed preset time period on
a channel. The total measurement range is 0.25 Hz to 200
kilohertz (filtered) or 1500 kilohertz (unfiltered) with High
and Low alarms. The DP820 reads the value and provides
it to the controller when the controller requests an update
(S2 of function code 82 – target period of segment). The
resolution of the frequency measurement depends on the

229 - 4 WBPEEUI210504C0
application and is guaranteed to have a maximum abso-
lute frequency error of 1.64 parts/million. If no pulses are
detected, then the last measured value is held until a loss
of signal time period expires.

NOTE: For Period and Frequency modes, the DP820 supports a fixed 4.3 sec-
ond loss of signal detection period. If no incoming pulses are detected during
the 4.3 second time span, the overflow status is set. If there are other problems
with the input (such as a frequency period not being able to be determined), the
transducer power failure (POWR) status will be generated to HSIs so that a ref-
erence error condition will be indicated.

• In Totalize mode, the DP820 counts the total number of


pulses of a digital input up to its expected channel high
value (S11) with hold and reset flags or until the controller
resets the counter. The controller can selectively read a
channel or read and reset a channel.
S3 (Engineering units low value) Defines the low limit of the
input’s range in engineering units.
S4 (Engineering units low value) Defines the high limit of the
input’s range in engineering units.
S5 (Engineering unit identifier) identifies the engineering units
associated with the input value.
S6 (Engineering units high alarm) An alarm will be generated
when the input equals or exceeds this high limit.
S7 (Engineering units low alarm) An alarm will be generated
when the input equals or is less than this low limit.
S8 (Engineering units significant change) The change in input
allowed before the changed value is reported to a console or
open access system.
S9 (Engineering units alarm dead-band) Alarm deadband for the
high/low alarm. Alarm deadbands prevent excessive alarm
exception reports when values are hovering around the alarm
limit. Supersedes specification S10 of function code 82 for this
function code 229 block when set to a positive value.
S10 (Expected channel low value) The expected low limit of the
pulse input channel physical channel as expressed in units
(Hertz, Seconds, or Counts) appropriate to the Conversion
Mode (S2).

WBPEEUI210504C0 229 - 5
S11 (Expected channel high value) The expected high limit of the
pulse input channel physical channel as expressed in units
(Hertz, Seconds, or Counts) appropriate to the conversion
mode (S2).

Specifications S10 and S11 define the expected field input sig-
nal range of the channel and are utilized in the calculation of
the final engineering unit value as follows:

Engineering unit output = ((channel value - S10) * (S4-S3) /


(S11-S10)) + S3

S10 and S11 are also utilized by the pulse-input hardware to


configure the optimal frequency/period/duration measure-
ment range to achieve the maximum resolution in the mea-
surement.

Conversion Mode Expected Channel Hardware Measured Pulse Input Range Functionality
S2 S10 S11
0 – Period Expected low frequency value (Hz) Expected high pulse frequency (Hz)
1 – Frequency Expected low period value (Secs) Expected high pulse period (Secs)
2 – Duration Expected low duration value (Secs) Expected high pulse duration (Secs)
3 through 6 – Expected low count limit value Expected high count limit value
Totalize
NOTES:
To utilize the pulse in/channel to produce absolute totalization counts, the S10 and S11 specifications can be set to the same
values as the S3 and S4 specifications respectively.
To utilize the pulse in/channel to produce an unbounded maximum totalization count, set both S11 and S4 to the maximum pos-
sible floating point value.

S12 (Engineering Unit Start value) Defines the initial totalization


count value on startup and function code reset (<S13>=1). The
value of the count is equal to specification S12 plus the alarm
overrun after an alarm if the conversion mode (S2) is set to 5
or 6.

NOTE: Alarm overrun is the current total count reset to the difference between
the counter and the alarm limit. This allows the pulse in / channel function code
(229) to correctly detect the next alarm without losing track of the true counts.
S13 (Block address of reset) Block address of the reset flag that is
applicable only to the totalization conversion modes 3 through
6 in S2.

0 = Continue totalization (normal).

229 - 6 WBPEEUI210504C0
1 = Reset totalization count to start value (S12).
S14 (Block address of hold) Specification S14 is the block address
of the accumulated total hold flag and is applicable only for the
totalization conversion modes 3 through 6 in S2.

0 = Continue totalization (normal).

1 = Hold accumulated total.

NOTE: The reset and hold inputs function in the NORMAL operating mode only
and do not supersede OVERRIDE,UNDEFINED, or SIMULATION mode opera-
tion.
S15 (Normal input/undefined) A value of 0 selects normal input
from standard I/O. A value of 1 puts the channel into an
undefined state which will not affect the channel status. Spec-
ifications S17 and S19 take precedence over S15 when S15 =
0, but not when S15 = 1.

0 = Normal

1 = Undefined
S16 (Override value) The channel input value is over-ridden with
this value if the override enable (S17) is set to 1.
S17 (Override enable) A value of 0 disables override for this chan-
nel. A value of 1 enables override in this channel. If enabled,
override will take precedence over normal input and simula-
tion. Specification S11 of the foreign device definition (function
code 228) must reference a boolean output that is set to 1 to
permit this operation.

0 = Disabled

1 = Enabled
S18 (Block address of simulation value) The channel input value
is simulated with this block input when simulation is enabled
(S19 = 1).
S19 (Simulation enable) A value of 0 disables simulation for this
channel. A value of 1 enables simulation for this channel and
receives its input from S18. Simulation has precedence over
S15 normal input, but not S17 override. Specifications S11 of
the foreign device definition function code 228 must reference

WBPEEUI210504C0 229 - 7
a boolean output set to a 1 to permit this operation. Other-
wise, it is ignored.

0 = Disabled

1 = Enabled
S20 (Status error inhibit) Inhibits this channel’s I/O error contri-
bution to BRC-100 controller status. Specification S11 of the
foreign device definition function code 228 must reference a
Boolean output with a value of 1 to permit this operation. Oth-
erwise, it is ignored.

0 = No

1 = Yes
S21 (Redundant input deviation limit) In NORMAL mode
(S15=0,S17=0,S19=0), the redundant input deviation limit
specifies the maximum deviation permitted between redun-
dant pulse input channels. This only applies when both inputs
are good quality. When the redundant inputs are outside the
deviation limit, they will both be considered in error (function
block output quality set to BAD, SUSP flag set in the exception
report, and the LIO error bit set in the BRC-100 controller sta-
tus).

In OVERRIDE mode (S15=0,S17=1,S19=X), the redundant


input deviation limit assumes the meaning of the override
value deviation limit and thus specifies the maximum devia-
tion permitted between the primary pulse input channel and
the override value (S16). The pulse input channel value is first
converted as specified in S2 before being compared against the
override value. If the converted pulse input channel value and
the override value are outside the limit, the state of the input
channel is considered suspect (SUSP set in the exception
report, but no LIO error set in the BRC-100 controller status)
since a bump in the block output value will occur upon exiting
the OVERRIDE mode.

In SIMULATION mode (S15=0,S17=0,S19=1), the redundant


input deviation limit assumes the meaning of the simulated
value deviation limit and thus specifies the maximum devia-
tion permitted between the primary pulse input channel and
the simulated value (<S18>). The pulse input channel value is
first converted as specified in S2 before being compared
against the simulated value. If the converted pulse input chan-

229 - 8 WBPEEUI210504C0
Application

nel value and the simulated value are outside the limit, the
state of the input channel is considered suspect (SUSP set in
the exception report, but no LIO error is set in the BRC-100
controller status) since a bump in the block output value will
occur upon exiting the SIMULATION mode.
S22 Reserved.
S23 (Foreign device configuration parameters) A string data type
containing configuration information specific to the pulse
input channel of a foreign device. Presently there are no con-
figuration parameters required for configuration of the S800
DP820 Pulse Input module, and therefore this field should be
left blank.
S24 Reserved.
S25 (Block address of next element of the foreign device) This
specification is the link to the next element of the foreign
device definition function code 228. The default value indicates
that this block is the last element.
S26 through S32 Spare.

Outputs
N Pulse input value (in specified EUs) with quality and alarm.

Application
The design of the foreign device (function code 228) and chan-
nel (function codes 222/225/229) layout used in the function
code layer is shown in Figure 229-1). The DP820 accepts
RS422, 5V, 12V, 24V and 13 mA transducer signal levels. Only
the input to the channel A input needs to be configured; the B
input is tied to ground. The ST and DI inputs are also tied low.
The DO output does not need to be physically configured.

WBPEEUI210504C0 229 - 9
Application

IO C /P IN IO C /P IN FDD G AT E W AY
S 13 (229) S 13 (229) S3 S3
RESET RESET NEXT P1
S 14 N S 14 N S4 S5
HO LD H O LD F IR S T P2
S 18 S 18 S6 S7
S IM S IM S PA R E P3
S 25 S 25 (228) S9
NEXT NEXT P4
S TAT U S S 11
S 26 S 26 N P E R M IT
FDPC FDPC
S PA R E S 16
S 32 S 32 N+1 NEXT
S PA R E S PA R E
D P 820 (227) P R IM A RY
PI 2 PI 1 N S TAT U S
A A B AC K U P
N + 1 S TAT U S
P 1 S TAT U S
N+2
P 2 S TAT U S
N+3
P 3 S TAT U S
N+4
P 4 S TAT U S
N+5
S PA R E
N+6
S PA R E
N+7
IO R -800
T 04 9 94 A

Figure 229-1. Basic Frequency/Totalization Configuration

229 - 10 WBPEEUI210504C0
DSOE Data Interface
Function Code 241

(2 4 1 )
The DSOE data interface block provides interface to Harmony
S3 D SO E block sequence of events data (HSOE) or the INSEM01
SE M -M F P
Sequence of Events module to access the time-stamped data
(DSOE) produced by the IMSET01 Distributed Sequence of
Events Time module and the IMSED01 Distributed Sequence
of Events Digital Module.

NOTE: This function code is supported by the HAC, BRC-100, and IMMFP11/
12 controllers.

This function code is required for both the controller and


INSEM01 module to configure a distributed sequence of events
system.

Outputs

Blk Type Description


N B Events logged flag (with quality and alarm):
0 = no
1 = yes
N+1 B Module status:
0 = good
1 = bad

Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 63 Address of IMSET01 module
S2 N 100 I 1 - 32767 Number of events that will fit in buffer:
buffer size = 12 (S2 + 1)
S3 N 2 I Note 1 Block address of first digital event interface
(function code 242), I/O device definition (func-
tion code 221), or gateway (function code 227).
S4 N 0 I Full Spare
S5 Y 0.0 R Full Spare
NOTE:
1. Maximum values are: 9,998 for the BRC-100, IMMFP11/12
31,998 for the HAC

WBPEEUI210504C0 241 - 1
Explanation
Specifications
S1 Expander bus address configured by means of dipswitches on
the IMSET01 module. This specification is not used by the
HAC controller and must be left at the default value.
S2 Maximum number of event records, produced by a Harmony
I/O block or any of the IMSED01 or IMSET01 modules con-
nected to the controller, that is possible to store before a buffer
overflow occurs.
S3 Block address of first digital event interface (function code
242), I/O device definition (function code 221), or gateway
(function code 227).

When using a Harmony rack DSOE, function codes 241 and


242 form a linked list that describes the IMSED01/IMSET01
configuration for the controller. Function code 241 must be at
the head of the list. This specification is used to point to the
first IMSED01/IMSET01 descriptor (function code 242).

When using a Harmony block HSOE, function codes 241 and


221 form a linked list. Function code 241 must be at the head
of the list. This specification is used to point to the first I/O
device definition (function code 221).

When using a gateway with HSOE, function codes 241 and


227 form a linked list. Function code 241 must be at the head
of the list. This specification is used to point to the first gate-
way (function code 227). Specification S3 linkage to the gate-
way (function code 227) is supported only in the BRC-100 and
BRC-200 controllers.
S4 and S5 Spare.

241 - 2 WBPEEUI210504C0
DSOE Digital Event Interface
Function Code 242

DSO E The digital event interface block provides the parameters


(2 4 2 )
S2 needed to control the IMSET01 distributed sequence of events
N
N+1 time module and the IMSED01 distributed sequence of events
N+2 digital module.
N+3
N+4 NOTE: This function code is supported by the BRC-100, IMMFP11/12 and
N+5
N+6
HAC controllers.
N+7
N+8 This function code is required for both the BRC-100 controller
N+9 and the INSEM01 distributed sequence of events module to
N+10
N+11
configure a distributed sequence of events system.
N+12
N+13 Outputs
N+14
N+15 Blk Type Description
N+16
N B Output 1 with quality
N+1 B Output 2 with quality
N+2 B Output 3 with quality
N+3 B Output 4 with quality
N+4 B Output 5 with quality
N+5 B Output 6 with quality
N+6 B Output 7 with quality
N+7 B Output 8 with quality
N+8 B Output 9 with quality
N+9 B Output 10 with quality
N+10 B Output 11 with quality
N+11 B Output 12 with quality
N+12 B Output 13 with quality
N+13 B Output 14 with quality
N+14 B Output 15 with quality
N+15 B Output 16 with quality
N+16 B Module status:
0 = good
1 = bad

WBPEEUI210504C0 242 - 1
Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 63 Address of SET/SED input module
S2 N 2 I Note 1 Block address of next digital event interface (func-
tion code 242)
S3 Y 10 I Full Debounce filter time value (in msecs)
S4 Y 0 I Full Input scan mask
0 = channel in-scan
1 = channel out-of-scan
S5 Y 50 I 0 - 8192 Channel 00 TON
S6 Y 50 I 0 - 8192 Channel 00 TOFF
S7 Y 50 I 0 - 8192 Channel 01 TON
S8 Y 50 I 0 - 8192 Channel 01 TOFF
S9 Y 50 I 0 - 8192 Channel 02 TON
S10 Y 50 I 0 - 8192 Channel 02 TOFF
S11 Y 50 I 0 - 8192 Channel 03 TON
S12 Y 50 I 0 - 8192 Channel 03 TOFF
S13 Y 50 I 0 - 8192 Channel 04 TON
S14 Y 50 I 0 - 8192 Channel 04 TOFF
S15 Y 50 I 0 - 8192 Channel 05 TON
S16 Y 50 I 0 - 8192 Channel 05 TOFF
S17 Y 50 I 0 - 8192 Channel 06 TON
S18 Y 50 I 0 - 8192 Channel 06 TOFF
S19 Y 50 I 0 - 8192 Channel 07 TON
S20 Y 50 I 0 - 8192 Channel 07 TOFF
S21 Y 50 I 0 - 8192 Channel 08 TON
S22 Y 50 I 0 - 8192 Channel 08 TOFF
S23 Y 50 I 0 - 8192 Channel 09 TON
S24 Y 50 I 0 - 8192 Channel 09 TOFF
S25 Y 50 I 0 - 8192 Channel 10 TON
S26 Y 50 I 0 - 8192 Channel 10 TOFF
S27 Y 50 I 0 - 8192 Channel 11 TON
S28 Y 50 I 0 - 8192 Channel 11 TOFF
S29 Y 50 I 0 - 8192 Channel 12 TON
S30 Y 50 I 0 - 8192 Channel 12 TOFF
S31 Y 50 I 0 - 8192 Channel 13 TON

242 - 2 WBPEEUI210504C0
Specifications (continued)

Spec Tune Default Type Range Description


S32 Y 50 I 0 - 8192 Channel 13 TOFF
S33 Y 50 I 0 - 8192 Channel 14 TON
S34 Y 50 I 0 - 8192 Channel 14 TOFF
S35 Y 50 I 0 - 8192 Channel 15 TON
S36 Y 50 I 0 - 8192 Channel 15 TOFF
S37 Y 0 I Full Spare
S38 Y 0.0 R Full Spare
NOTE:
1. Maximum values are: 9,998 for the BRC-100, IIMMFP11/12
31,998 for the HAC

Explanation
Specifications
S1 Bus address configured through dipswitches on the SET/SED
board.

NOTE: For the SET board of a single BRC-100 controller, function codes 241
and 242 are configured for the same I/O module board.
S2 Block address for the next digital event interface (function
code 242). Function codes 241 and 242 form a linked list that
describes the SET/SED configuration for the BRC-100 control-
ler.
S3 Time interval (in milliseconds) used on the SET/SED board to
tell the valid state transitions and noise spikes apart.
S4 16-bit mask that describes the desired configuration for the
input channels on the I/O module board.

0 = channel in-scan
1 = channel out-of-scan
S5 through S36 Channels 00 TON through 15 TOFF are time values that are
subtracted from the registered transition time values to get the
correct time-stamp for the transition. The values depend on
the physical characteristics of the transducer used.
S37 and S38 Spare.

WBPEEUI210504C0 242 - 3
WBPEEUI210504C0
Executive Block (INSEM01)
Function Code 243
The executive block for the INSEM01 sequence of events mod-
ule defines several variables that affect module behavior while
executing a sequence of events.

This function code is required to configure a distributed


sequence of events system.

Outputs

Blk Type Description


0 None No usable outputs

Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 5000 Maximum number of pre-trigger events
S2 N 0 I 0 - 5000 Maximum number of post-trigger events
S3 N 0.0 R 0 - 86400 Length of post-trigger period (in secs)
S4 N 0.0 R 0 - 86400 Longest time interval between two consecutive
events (in secs)
S5 N 20 I 0 - 60 Maximum delay in receiving events from Harmony
controller (in secs)
S6 N 180 I 0 - 32767 Age of event data before discarded from buffer
(in secs)
S7 N 2 I 0 - 9998 Block number of first addressing interface definition
function code 244

Explanation
Specifications
S1 Maximum number of events that can be recorded before trig-
ger.
S2 Maximum number of events that can be recorded after trigger.
When this limit is reached, the sequence will be closed.
S3 Maximum time interval that can elapse between the trigger
event and the last post-trigger event. When this interval
expires, the sequence will be closed.

WBPEEUI210504C0 243 - 1
S4 Maximum time interval in seconds that can pass between two
consecutive events belonging to the same sequence. From the
last valid event received, the sequence will be closed when this
time interval expires.
S5 Maximum latency time in seconds while receiving events from
remote Harmony controllers.
S6 Age of events data in seconds before discarded from the buffer.
This is the maximum interval time an event can spend in the
output queue towards the human system interface (HSI) wait-
ing for a request for final presentation. After this period, the
event is discarded from the queue to prevent overflow and
buffer lock.
S7 Block address of the first addressing interface definition func-
tion code 244. Function codes 243, 244 and 245 form a linked
list with sublists that describe the configuration for the
sequence of events system. Executive block zero is the head of
the main list.

243 - 2 WBPEEUI210504C0
Addressing Interface Definition
Function Code 244
The Harmony controller to SEM addressing interface definition
function code is configured in the INSEM01 sequence of events
module, and defines the physical addressing for data interface
function code 241.

Specifications S1 through S4 define the Harmony rack module


address for the point. Specification S5 is a pointer to the next
controller to SEM function block. Specification S6 is a pointer
to the first SED to SEM interface block configured that refers
to the controller specified by the first four specifications.

Outputs

Blk Type Description


0 None No usable outputs

Specifications

Spec Tune Default Type Range Description


S1 N 1 I 0 - 250 Loop number
S2 N 1 I 0 - 250 Node number
S3 N 0 I 0 - 31 Module number
S4 N 2 I 0 - 9998 Block number of executive block (INSEM01) function
code 241
S5 N 2 I 0 - 9998 Block number of next addressing interface definition
function code 244
S6 N 2 I 0 - 9998 Block number of first input channel interface function
code 245

Explanation
Specifications
S1 through S4 Standard Harmony rack module address for a point that, in
this case, identifies the function code 241 block on the control-
ler that is the exception report source for the event data poll.
S5 Block address of the next addressing interface function block.
Function codes 243, 244 and 245 form a linked list with

WBPEEUI210504C0 244 - 1
sublists that describe the configuration for the sequence of
events system.
S6 Block address of the first SED to SEM input channel interface.
Each function code 244 block is the head of the sublist that
describes the configuration for a particular controller in the
system.

244 - 2 WBPEEUI210504C0
Input Channel Interface
Function Code 245
The SED to SEM input channel interface function code defines
the characteristics for each one of the 16 input channels of a
specified IMSED01 sequence of events digital module or
IMSET01 sequence of events time module.

Outputs

Blk Type Description


0 None No usable outputs

Specifications

Spec Tune Default Type Range Description


S1 N 0 I 0 - 63 Expander bus address
S2 N 2 I 0 - 9998 Block number of the next input interface function
code 245
S3 N 0 I 0 - 127 Characteristics of channel 0 input
S4 N 0 I 0 - 127 Characteristics of channel 1 input
S5 N 0 I 0 - 127 Characteristics of channel 2 input
S6 N 0 I 0 - 127 Characteristics of channel 3 input
S7 N 0 I 0 - 127 Characteristics of channel 4 input
S8 N 0 I 0 - 127 Characteristics of channel 5 input
S9 N 0 I 0 - 127 Characteristics of channel 6 input
S10 N 0 I 0 - 127 Characteristics of channel 7 input
S11 N 0 I 0 - 127 Characteristics of channel 8 input
S12 N 0 I 0 - 127 Characteristics of channel 9 input
S13 N 0 I 0 - 127 Characteristics of channel 10 input
S14 N 0 I 0 - 127 Characteristics of channel 11 input
S15 N 0 I 0 - 127 Characteristics of channel 12 input
S16 N 0 I 0 - 127 Characteristics of channel 13 input
S17 N 0 I 0 - 127 Characteristics of channel 14 input
S18 N 0 I 0 - 127 Characteristics of channel 15 input

WBPEEUI210504C0 245 - 1
Explanation
Specifications
S1 Expander bus address configured using dipswitches located
on the SET/SED board.
S2 Block address of the next input channel interface function
code 245. Each function code 245 block is linked with the sub-
sequent one in the sublist that describes the configuration for
a particular controller in the system.
S3 through S18 Identify the following characteristics:

• If this point has a simple trigger associated.

• If it does, it tells if the trigger is significant to the zero to


one transition, the one to zero transition, or both.

• If this point is a recordable event.

• If it is, it tells if the trigger is significant to the zero to one


transition, the one to zero transition, or both.

• If this point has an associated alarm.

• If it does, it tells if the alarm is associated to the zero state,


the one state, or both.

• If this point is configured in the system or not.

Specification information for S3 through S18 is shown in Table


245-1.

Table 245-1. Information Format for Specifications S3 through S18

Point
Description
6 5 4 3 2 1 0
0 0 No simple trigger associated to the point
0 1 Simple trigger on the transition, 0 to 1
1 0 Simple trigger on the transition, 1 to 0
1 1 Simple trigger on both transitions

245 - 2 WBPEEUI210504C0
Table 245-1. Information Format for Specifications S3 through S18 (continued)

Point
Description
6 5 4 3 2 1 0
0 0 This is not a recordable event
0 1 Recordable event on the transition, 0 to 1
1 0 Recordable event on the transition, 1 to 0
1 1 Recordable event on both transitions
0 0 state is not an alarm state
1 0 state is an alarm state
0 1 state is not an alarm state
1 1 state is an alarm state
0 Point is not configured in the system
1 Point is configured in the system

WBPEEUI210504C0 245 - 3
WBPEEUI210504C0
Trigger Definition
Function Code 246
The distributed sequence of events trigger definition function
code describes a single trigger in the sequence of events. It
accepts 32 operations or operands.

Outputs

Blk Type Description


0 None No usable outputs

Specifications

Spec Tune Default Type Range Description


S1 N -1 I -126 - 16000 Operation/operand 1
S2 N -1 I -126 - 16000 Operation/operand 2
S3 N -1 I -126 - 16000 Operation/operand 3
S4 N -1 I -126 - 16000 Operation/operand 4
S5 N -1 I -126 - 16000 Operation/operand 5
S6 N -1 I -126 - 16000 Operation/operand 6
S7 N -1 I -126 - 16000 Operation/operand 7
S8 N -1 I -126 - 16000 Operation/operand 8
S9 N -1 I -126 - 16000 Operation/operand 9
S10 N -1 I -126 - 16000 Operation/operand 10
S11 N -1 I -126 - 16000 Operation/operand 11
S12 N -1 I -126 - 16000 Operation/operand 12
S13 N -1 I -126 - 16000 Operation/operand 13
S14 N -1 I -126 - 16000 Operation/operand 14
S15 N -1 I -126 - 16000 Operation/operand 15
S16 N -1 I -126 - 16000 Operation/operand 16
S17 N -1 I -126 - 16000 Operation/operand 17
S18 N -1 I -126 - 16000 Operation/operand 18
S19 N -1 I -126 - 16000 Operation/operand 19
S20 N -1 I -126 - 16000 Operation/operand 20
S21 N -1 I -126 - 16000 Operation/operand 21
S22 N -1 I -126 - 16000 Operation/operand 22

WBPEEUI210504C0 246 - 1
Specifications (continued)

Spec Tune Default Type Range Description


S23 N -1 I -126 - 16000 Operation/operand 23
S24 N -1 I -126 - 16000 Operation/operand 24
S25 N -1 I -126 - 16000 Operation/operand 25
S26 N -1 I -126 - 16000 Operation/operand 26
S27 N -1 I -126 - 16000 Operation/operand 27
S28 N -1 I -126 - 16000 Operation/operand 28
S29 N -1 I -126 - 16000 Operation/operand 29
S30 N -1 I -126 - 16000 Operation/operand 30
S31 N -1 I -126 - 16000 Operation/operand 31
S32 N -1 I -126 - 16000 Operation/operand 32

Explanation
Specifications
S1 through S32 Operations/operands one through 32. Each specification can
describe an operation, an operand or the end of this trigger.

Legal operation values are:

-126: not (~).


-38: and (&).
-94: xor (^).
-124: or (|).
-1: end of trigger.

Legal operand indexes are:

1 through 16,000.

246 - 2 WBPEEUI210504C0
Condition Monitoring
Function Code 247

CMM The CMM function code reads up to 13 inputs (ten analogs,


(247 )
S2 NX EU
N
two digitals, and one module status) from a single channel on
S9
S 10
AEN GV
N+1 the condition monitoring module. Each channel requires a
DEN SPD
S 11 ASET
N+2 CMM function code. Each channel can be configured indepen-
S 12 N+3
DSET
N+4
dently of the other channels for vibration, eccentricity, thrust
S 16
S 17
SET
N+5 (rotor) position, differential expansion, case expansion, or dual
FLO
S 18 FHI
N+6
probe. If multiple channels of the module are being configured,
S 19 N+7
S 20
CAP
N+8 these function codes must reside in the same module segment.
RU P
S 21 N+9
RDN ALR
S 22 EVC DNGR
N+10 This function block has thirteen outputs. The first three are
S 23 H ID ST
N+11
analog inputs from the module and are available for each
S 24 N+12
S 25
H IA channel type. Block outputs N+3 to N+9 are input from the
LOA
S 26 LO D
module for vibration measurements only and are not used by
S 27 A D LY all of the channel types. The outputs N+10 and N+11 are
S 28
S 29
D D LY alarm indicators from the module. The last output, N+12, is
SRD
S 43 N /A
the status of the module. Use function code 226 for extended
S 44 N /A status information. For more information, refer to the respec-
S 45
S 46
N /A
tive product instruction.
N /A
S 47 COR
NOTE: This function code is supported only by the BRC-100 controller.

Outputs

Blk Type Description


N R Output in engineering units, quality.
N+1 R Average (DC/gap) voltage.
N+2 R Speed.
N+3 R First order vibration in EU (vibration only).
N+4 R First order phase angle (degrees) (vibration only).
N+5 R Second order vibration in EU (vibration only).
N+6 R Second order phase angle (degrees) (vibration only).
N+7 R Third order vibration in EU (vibration only).
N+8 R Third order phase angle (degrees) (vibration only).
N+9 R Not first order vibration (not 1X) (vibration only).
N+10 B Alert: 0 = OK; 1 = alarm
N+11 B Danger: 0 = OK; 1 = alarm
N+12 B Module Status: 0 = good; 1 = bad

WBPEEUI210504C0 247 - 1
Specifications

Spec Tune Default Type Range Description


S1 N 0 I2 0-63 Module address
S2 N 2 I2 0-9998 Block address of next CMM channel
S3 N 1 I2 1-6 Module channel input number
S4 N 0 I2 0-9 Channel type:
0 = vibration
1 = eccentricity
2 = thrust (rotor) position
3 = differential expansion
4 = case expansion
5 = dual probe (relative)
6 = dual probe (seismic)
7 = dual probe (absolute)
8 = SMAX (vibration only)
9 = complementary position
S5 N 0 I2 0-7 Probe type:
0 = eddy current probe
1 = DC-LVDT
2 = accelerometer
3 = velocity pickup
4 = piezoelectric velocity probe
6 = ramped eddy current probe
7 = ramped complementary eddy current probe
S6 Y1 0 I2 0-3 Integration: (vibration/dual probe only)
0 = none
1 = velocity to displacement
2 = acceleration to velocity
3 = acceleration to displacement
S7 Y1 0 I2 0-33 Block output select
Block N
x0 = peak-to-peak
x1 = peak
x2 = RMS
x3 = average
Block N+1
0x = dynamic
1x = min
2x = max
3x = average
S8 N 0 I2 0-1 English/metric EU
0 = English (g's, in/s, mils)
1 = Metric (g's, mm/s, microns)

247 - 2 WBPEEUI210504C0
Specifications (continued)

Spec Tune Default Type Range Description


S9 N 0 I2 0-9998 Block address of alert enable (Boolean input)
0 = disable alert output
1 = enable alert output
S10 N 0 I2 0-9998 Block address of danger enable (Boolean input)
0 = disable danger output
1 = enable danger output
S11 N 0 I2 0-9998 Block address of set alert relay (Boolean input)
0 = normal operation
1 = set alert relay
S12 N 0 I2 0-9998 Block address of set danger relay (Boolean input)
0 = normal operation
1 = set danger relay
S13 N 0 I2 0-1 Normal alert relay state:
0 = normally de-energized
1 = normally energized
S14 N 0 I2 0-1 Normal danger relay state:
0 = normally de-energized
1 = normally energized
S15 N 0 I2 0-1 Vote enable
0 = disable
1 = dual voting enable (channels 1&2 or 3&4)
S16 N 0 I2 0-9998 Block address of set null position voltage (Boolean
input)
0 to 1 transition sets S49
Otherwise, S49 remains unchanged
S17 N 8 I2 0-9998 Block address of filter low cutoff frequency (real input)
S18 N 9 I2 0-9998 Block address of filter high cutoff frequency (real
input)
S19 N 0 I2 0-9998 Block address of waveform capture (Boolean input).
The zero to one transition captures the most recent
waveform.
S20 N 0 I2 0-9998 Block address of run-up capture (Boolean input)
0 = do not capture data
1 = capture run-up data
S21 N 0 I2 0-9998 Block address of run-down capture (Boolean input)
0 = do not capture data
1 = capture run-down data
S22 N 0 I2 0-9998 Block address of event active (Boolean input)
0 = no event
1 = event occurred (save data)

WBPEEUI210504C0 247 - 3
Specifications (continued)

Spec Tune Default Type Range Description


S23 N 9 I2 0-9998 Block address of engineering unit high danger level
(real Input)
S24 N 9 I2 0-9998 Block address of engineering unit high alert level (real
Input)
S25 N 8 I2 0-9998 Block address of engineering unit low alert level (real
Input)
S26 N 8 I2 0-9998 Block address of engineering unit low danger level
(real Input)
S27 N 5 I2 0-9998 Block address of alert delay (seconds) (real Input)
S28 N 5 I2 0-9998 Block address of danger delay (seconds) (real Input)
S29 N 0 I2 0-9998 Block address of shaft rotational direction (Boolean
input)
0 = clockwise
1 = counterclockwise
S30 N 0 I2 -360 to Angular position of probe (vibration/dual probe/eccen)
360 Ramp angle (differential expansion)
S31 N 0 I2 -360 to Angular position of event marker probe (vib./DP/ecc)
360
S32 N 0 I2 Full Point ID
S33 N 0 I2 0-255 IP address one
S34 N 0 I2 0-255 IP address two
S35 N 0 I2 0-255 IP address three
S36 N 0 I2 0-255 IP address four
S37 N 255 I2 0-255 Sub-net mask one
S38 N 255 I2 0-255 Sub-net mask two
S39 N 255 I2 0-255 Sub-net mask three
S40 N 0 I2 0-255 Sub-net mask four
1
S41 Y 0 I2 Full Spare integer parameter
S42 N 0 I2 Full Spare integer parameter
S43 N 0 I2 0-9998 Spare block address (Boolean input)
S44 N 0 I2 0-9998 Spare block address (Boolean input)
S45 N 5 I2 0-9998 Spare block address (real input)
S46 N 5 I2 0-9998 Spare block address (real input)
S47 N 5 I2 0-9998 Block address of non-linear correction (real input)
S48 N 200.0 R4 Full Probe sensitivity (millivolts/EU)

247 - 4 WBPEEUI210504C0
Specifications (continued)

Spec Tune Default Type Range Description


S49 Y1 0.000 R4 Full Null position in engineering units
S50 Y1 0.0 R4 Full Null position voltage (used for channel types 2-4 only)
S51 N 9.2 E 18 R4 Full High probe failure voltage
S52 N -9.2 E 18 R4 Full High probe failure voltage
S53 N 0.000 R4 Full Spare real parameter
1
S54 Y 0.000 R4 Full Spare real parameter
1
S55 Y 0.000 R4 Full Spare real parameter
NOTE:
1. Specification is tunable, but not adaptable.

Explanation
Specifications
S1 Address of the module.
S2 Address of the next CMM input block that defines the next
channel on the module. If the function code is defining the last
channel on the module, use the default value.
S3 Number of the input channel on the CMM module. The valid
range is encoded on the module. Channels five and six are
pseudo-channels that do not have actual probes connected,
but are calculated. (Refer to the specification S4 explanation).
S4 Type of signal to which the block is interfacing.

0 = vibration
1 = eccentricity
2 = thrust (rotor) position
3 = differential expansion
4 = case expansion
5 = dual probe (relative, channels one or three only)
6 = dual probe (seismic, channels two or four only)
7 = dual probe (absolute, channels five or six only)
8 = SMAX (vibration, channels five or six only)
9 = complementary position (channels five or six only)

For absolute vibration, channel five uses the relative and seis-
mic probes from channels one and two, whereas channel six
uses the probes from channels three and four.

WBPEEUI210504C0 247 - 5
For SMAX vibration, channel five uses the X and Y probes from
channels one and two, whereas channel six uses the probes
from channels three and four.

Complementary position determines rotor position or differen-


tial expansion of two complementary probes. Channel five uses
channels one and two, whereas channel six uses channels
three and four.
S5 Probe type used for the input channel.

0 = eddy current probe


1 = DC-LVDT
2 = accelerometer
3 = velocity pickup
4 = piezoelectric velocity probe
5 = complementary mode eddy current probe
6 = ramp mode eddy current probe
7 = ramped complementary eddy current probe
S6 Type of integration used on the input signal. Valid for vibration
and dual probes only.

0 = none
1 = velocity to displacement
2 = acceleration to velocity
3 = acceleration to displacement
S7 Type of signal reported for the input channel. The unit's digit is
used for block N. The ten's digit is used for block N+1.

0x = dynamic x0 = peak-to-peak
1x = minimum x1 = peak
2x = maximum x2 = RMS
3x = average x3 = average

S8 Engineering unit used for integration of the signal as defined


by S6.

0 = English (g, inch/s, mils)


1 = Metric (g, mm/s, microns)
S9 Block address of the enable alert flag.

0 = disable alert output


1 = enable alert output

247 - 6 WBPEEUI210504C0
S10 Block address of the enable danger flag.

0 = disable danger output


1 = enable danger output
S11 Block address of set alert relay.

0 = normal operation (alert condition determined by


CMM11)
1 = set alert relay active (based on S13)
S12 Block address of set danger relay.

0 = normal operation (danger condition determined by


CMM11)
1 = set danger relay active (based on S14)
S13 Alert Relay normal state.

0 = normally de-energized
1 = normally energized
S14 Danger relay normal state.

0 = normally de-energized
1 = normally energized
S15 Enables voting.

0 = disable
1 = dual voting enable (channels 1&2 or 3&4)

Dual voting incorporates AND logic, where the danger condi-


tion must be present in both channels for the danger condition
to be true. Refer to Table 247-1 for the actual settings of dual
voting.

Table 247-1. Truth Table for Dual Voting Settings

Channel 2
Channel 1
Normal Alert Danger Failed
Normal No alarm Alert Alert Alert
Alert Alert Alert Alert Alert
Danger Alert Alert Alert and danger Alert and danger
Failed Alert Alert Alert and danger Alert

WBPEEUI210504C0 247 - 7
S16 Block address of the signal used to set the null position voltage
for thrust position, differential expansion, and case expansion
channels. The transition from zero to one of this block stores
the average DC voltage presently being read by the probe into
S50 (null position voltage).

The zero to one transition sets the null position voltage stored
in S50. Otherwise, S50 remains unchanged.
S17 Address of the block that defines the low cutoff frequency of
the digital filter.
S18 Address of the block that defines the high cutoff frequency of
the digital filter.
S19 Block address of the waveform capture flag (used with diag-
nostic software). This initiates the module to collect the most
recent time waveform.
S20 Block address of the run-up capture flag (used with diagnostic
software). This initiates the module to start collecting run-up
data.
S21 Block address of the rundown capture flag (used with diagnos-
tic software). This initiates the module to start collecting run-
down data.
S22 Block address of the event capture flag (used with diagnostic
software). This indicates that an event occurred for the module
to save the event data.
S23 Block address of the high danger level limit of the input in
engineering units. When the monitored input value of block
output N is higher than this value, the danger output is set
active and block output N+11 is set to logic level 1 after the
time period specified in the alarm delay S28. The Alert output
is set active (if enabled), and block output N+10 is set to logic
level one instantly.
S24 Block address of the high alert level limit of the input in engi-
neering units. When the monitored input value of block output
N is higher than this value, the alert output is set active, and
block output N+10 is set to logic level one after the time period
specified in the alarm delay S27.
S25 Block address of the low alert level limit of the input in engi-
neering units. When the monitored input value of block output

247 - 8 WBPEEUI210504C0
N is lower than this value, the alert output is set active, and
block output N+10 is set to logic level one after the time period
specified in the alarm delay S27.
S26 Block address of the low danger level limit of the input in engi-
neering units. When the monitored input value of block output
N is lower than this value, the danger output is set active, and
block output N+11 is set to logic level one after the time period
specified in the alarm delay S28. The alert output is set active
(if enabled), and block output N+10 is set to logic level one
instantly.
S27 Block address of the amount of time (in seconds) the input
value must exceed the alert set point before reporting an alert
condition. Both the relay output and the block output (N+10)
are delayed in unison.
S28 Block address of the amount of time (in seconds) the input
value must exceed the danger set point before reporting a dan-
ger condition. Both the relay output and the block output
(N+11) are delayed in unison.
S29 Block address of shaft rotation direction. Typically viewed from
the driver end.

0 = clockwise
1 = counterclockwise
S30 Angular position (in degrees) of the probe or the ramp angle for
differential expansion. Typically, the angular position is with
reference to vertical or the once-per-revolution pulse (event
marker). The ramp angle is used when S5 is set to five or six
(ramp mode input) to calculate both axial and radial displace-
ment.
S31 Angular position (in degrees) of the event marker. Typically,
this is with reference to vertical.
S32 Point identification. Used only with the Ethernet™ link to
uniquely identify the point.
S33 IP address one. Used only with the Ethernet link to identify the
IP address of the card.
S34 IP address two. Used only with the Ethernet link to identify the
IP address of the card.

WBPEEUI210504C0 247 - 9
S35 IP address three. Used only with the Ethernet link to identify
the IP address of the card.
S36 IP address four. Used only with the Ethernet link to identify
the IP address of the card.
S37 Sub-net mask one. Used only with the Ethernet link for mask-
ing the IP address of the card.
S38 Sub-net mask two. Used only with the Ethernet link for mask-
ing the IP address of the card.
S39 Sub-net mask three. Used only with the Ethernet link for
masking the IP address of the card.
S40 Sub-net mask four. Used only with the Ethernet link for mask-
ing the IP address of the card.
S41 and S42 Spare integer parameters.
S43 and S44 Spare boolean block inputs.
S45 and S46 Spare real block input.
S47 Block address of non-linear correction. If used, this is typically
an input from an F(x) block and is used to correct for non-lin-
ear probes. The module uses the output of the F(x) block for
the internal calculations. The module ignores this value when
the default block five is used.
S48 Sensitivity of the probe defined in S5 in millivolts/EU. EU can
be mils, microns, mm, inch/sec., mm/sec., g, etc. When using
accelerometer inputs, the engineering units for this specifica-
tion must be entered in g's regardless of the setting of S8.
When using velocity pickup inputs, the engineering units for
this specification must be entered in inch/sec. for S8 = zero, or
mm/sec. for S8 = one. (This is only true if the probe is to be
integrated).

NOTE: The value can be negative under certain conditions depending on


probe mounting and direction of movement. For example, in complementary
mode situations one probe's sensitivity will be positive, and the other negative.
Also, for dual probe situations the seismic measurement will be added to the
relative if the sensitivity is positive and subtracted if negative.
S49 Null position in engineering units. The user determines the
null position as a starting position of the device. It is set at
some known position that can be physically measured, often

247 - 10 WBPEEUI210504C0
when the machine is not running. This is the value of the
block output N when the voltage of the probe is equal to the
value in S50.
S50 Manually entered null position voltage in volts. Used on the
thrust position, differential expansion, and case expansion
channels. When tuned or during startup, this specification
sets the null position voltage for the channel. This value can
also be modified by setting the block for S16 from a logic zero
to a logic one. Then the average DC voltage presently being
read from the probe (the value of block N+1) will be stored in
this location.
S51 High threshold voltage for the probe. The analog inputs will go
to bad quality whenever the voltage input is more positive than
this value.
S52 Low threshold voltage for the probe. The analog inputs will go
to bad quality whenever the voltage input is more negative
than this value.
S53 through S55 Spare real parameters.

Outputs
N Analog input value and quality as determined by S4. Status
bits Quality, High Alarm, Low Alarm will be used.

• Vibration (selected by S6 & S7) in engineering units.


• Thrust position in engineering units.
• Eccentricity in engineering units.
• Differential expansion in engineering units.
• Case expansion in engineering units.
• Channel 1 or 3: relative vibration in engineering units.
• Channel 2 or 4: Seismic vibration in engineering units.
• Channel 5: Absolute vibration of channels 1 and 2.
• Channel 6: Absolute vibration of channels 3 and 4.
• Channel 5: SMAX vibration of channels 1 and 2.
• Channel 6: SMAX vibration of channels 3 and 4.
• Channel 5: Complementary position of channels 1 and 2.
• Channel 6: Complementary position of channels 3 and 4.
N+1 Analog input value and quality. DC offset or gap voltage in
volts as determined by S7.
N+2 Analog input value and quality. Speed in RPM.

WBPEEUI210504C0 247 - 11
N+3 Analog input value and quality. First order vibration in engi-
neering units (vibration only).
N+4 Analog input value and quality. Phase angle of the first order
vibration in degrees (vibration only).
N+5 Analog input value and quality. Second order vibration in engi-
neering units (vibration only).
N+6 Analog input value and quality. Phase angle of the second
order vibration in degrees (vibration only).
N+7 Analog input value and quality. Third order vibration in engi-
neering units (vibration only).
N+8 Analog input value and quality. Phase angle of the third order
vibration in degrees (vibration only).
N+9 Analog input value and quality. Not first order vibration (not
1X) in engineering units (vibration only).
N+10 First level alarm status (alert) and quality:

0 = Level of output N is less than S24 and greater than S25


(where applicable).

1 = Level of output N is greater than S24 or less than S25


(where applicable) for a period greater than S27, or N+11 is
active.
N+11 Second level alarm status (danger) and quality:

0 = Level of output N is less than S23 and greater than S26


(where applicable).

1 = Level of output N is greater than S23 or less than S26


(where applicable) for a period greater than S28.

N+12 Module communication status without quality:

0 = good
1 = bad

This output is set to zero when the controller receives the


properly formatted status message from a CMM module. This
output is set to one when either no module replies, or a mod-
ule replies with an improperly formatted message.

247 - 12 WBPEEUI210504C0
Status Conditions
There are two types of status condition flags: configuration
and operational.

Configuration
HALT (Critical Error, Channel is Disabled) The critical errors will
disable the channel until the error is corrected. The other valid
channels will operate normally.
IPAD (Invalid IP Address) Occurs whenever different IP addresses
are identified for the same module, or if the IP address does
not conform to conventions. Although the module will execute,
there will not be any Ethernet activity, or the module will use
the first valid IP address.
PROB (Invalid Probe Type) Occurs whenever the selected probe type
is invalid for the selected type. The module will execute valid
channels. However, the invalid channel will not operate.
PTID (Duplicate Point ID) Occurs when the same non-zero point ID
is identified for more than one channel. The module will oper-
ate normally. However, there may be confusion in the Ethernet
interface.
TYPE (Invalid Channel Type) Occurs whenever the selected type
(relative, seismic, absolute, SMAX, complementary, or dual
voting) is invalid or there is a mismatch for that channel (e.g.,
an improper use of channels five and six). The module will
execute valid channels. However, the invalid channel will not
operate.
WARN (Non-critical Error, Channel is Running) Although the
non-critical errors will allow continued operation of the chan-
nel, there may be a deviation from expected results.

Operational
ALHI (High Alert) Set when the overall block output exceeds the
high alert set point after the specified delay.
ALLO (Low Alert) Set when the overall block output exceeds the low
alert set point after the specified delay.
ALSP (Alert Set Point Exceeded) Occurs when the value exceeds the
alert set point, although the delay period may not have

WBPEEUI210504C0 247 - 13
expired, or the alert is disabled and the relay may not be active
for that channel. It remains set until the condition no longer
exists.
BUFF (Time Waveform Buffer Full) Condition clears when the data is
off-loaded via the Ethernet link or when the module loses
power. In the latter case, the data is lost.
CALI (Module is Calibrating) Occurs when the module is calibrat-
ing.
CONF (Configuration Error)
CTWF (Capturing Time Waveform) Occurs while the module is col-
lecting time waveform data. This condition clears when the
data is complete.
DNHI (High Danger) Set when the overall block output exceeds the
high danger set point after the specified delay.
DNLO (Low Danger) Set when the overall block output exceeds the
low danger set point after the specified delay.
DNSP (Danger Set Point Exceeded) Occurs when the value exceeds
the danger set point, although the delay period may not have
expired or the danger is disabled, and the relay may not be
active for that channel. It remains set until the condition no
longer exists.
DVSA (Dual Voting Status - Alert) This condition is described in
Table 247-1.
DVSD (Dual Voting Status - Danger) This condition is described in
Table 247-1.
ETHF (Ethernet Failure) Occurs whenever the CMM11 detects a fail-
ure with the Ethernet interface. This may occur from an inter-
nal hardware failure or an external problem with the Ethernet.
EVLG (Collecting Event Log Data) This condition clears when the
data is off-loaded via the Ethernet link or when the module
loses power, in which case, the data is lost.
EVST (Event Mark Status) Exists when there is no event marker
input detected.
FLHI (Probe Failure - Over-range) Occurs when the input of the
probe exceeds the high failure limit.

247 - 14 WBPEEUI210504C0
FLLO (Probe Failure - Under-range) Occurs when the input of the
probe exceeds the low failure limit.
FLOP (Open Circuit Detection) Occurs when the module detects an
open circuit condition.
FLSH (Short Circuit Detection) Occurs when the module detects a
short circuit condition.
MERR (CMM11 Module Error) Occurs whenever the CMM11 detects a
circuit failure on the module.
RNDN (Collecting Run-down Data) This condition clears when the
data is off-loaded via the Ethernet link or when the module
loses power, in which case the data is lost.
RNUP (Collecting Run-up Data) This condition clears when the data
is off-loaded via the Ethernet link or when the module loses
power, in which case the data is lost.
STRT (Module is in Startup Mode) Exists when the module starts
up.
SUSP (Suspect Quality) Occurs when the quality of the values is
within normal operating conditions, but the quality is suspect.
This can occur when one of two complementary probes fails or
goes out of range. It can also occur when the probe is near its
limit.
TUFL (Termination Unit Failure) Occurs whenever the termination
unit loses power, a circuit fails, or the termination unit cable
disconnects.
ZRSP (Zero speed indication) Occurs when the module no longer is
receiving once-per-revolution pulses. There must be pulses
present which then gradually cease before this status acti-
vates. A sudden loss-of-signal will not set this condition.

WBPEEUI210504C0 247 - 15
WBPEEUI210504C0
List of Function Codes
Appendix A

Introduction
Appendix A contains cross references for all the function
codes. Table A-1 lists the function codes numerically along
with a description of each code.

Table A-2 is an alphabetical listing of the function codes by


function code description and is followed by the function code
number.

Tables A-3 through A-45 categorize the function codes by


functionality. Note that in these tables function codes may be
listed in multiple categories.

WBPEEUI210504C0 A-1
Cross Reference - Numerical

Cross Reference - Numerical


Table A-1. Numerical Listing

Function Function
Description Description
Code Code
1 Function generator 16 Multiply
2 Manual set constant (signal 17 Divide
generator)
3 Lead/lag 18 PID error input
4 Pulse positioner 19 PID (PV and SP)
5 Pulse rate 24 Adapt
6 High/low limiter 25 Analog input (same PCU node)
7 Square root 26 Analog input/loop
8 Rate limiter 30 Analog exception report
9 Analog transfer 31 Test quality
10 High select 32 Trip
11 Low select 33 Not
12 High/low compare 34 Memory
13 Integer transfer 35 Timer
14 Summer (4-input) 36 Qualified OR (8-input)
15 Summer (2-input) 37 AND (2-input)
38 AND (4-input) 91 BASIC configuration (BRC-100)
39 OR (2-input) 92 Invoke BASIC
40 OR (4-input) 93 BASIC real output
41 Digital input (periodic sample) 94 BASIC boolean output
42 Digital input/loop 95 Module status monitor
45 Digital exception report 96 Redundant analog input
50 Manual set switch 97 Redundant digital input
51 Manual set constant 98 Slave select
52 Manual set integer 99 Sequence of events log
55 Hydraulic servo 100 Digital output readback check
57 Reserved for future use 101 Exclusive OR
58 Time delay (analog) 102 Pulse input/period
59 Digital transfer 103 Pulse input/frequency
61 Blink 104 Pulse input/totalization
62 Remote control memory 109 Pulse input/duration

A-2 WBPEEUI210504C0
Cross Reference - Numerical

Table A-1. Numerical Listing (continued)

Function Function
Description Description
Code Code
63 Analog input list (periodic sample) 110 Rung (5-input)
64 Digital input list (periodic sample) 111 Rung (10-input)
65 Digital sum with gain 112 Rung (20-input)
66 Analog trend 114 BCD input
68 Remote manual set constant 115 BCD output
69 Test alarm 116 Jump/master control relay
79 Control interface slave 117 Boolean recipe table
80 Control station 118 Real recipe table
81 Executive 119 Boolean signal multiplexer
82 Segment control 120 Real signal multiplexer
83 Digital output group 121 Analog input/Cnet
84 Digital input group 122 Digital input/Cnet
85 Up/down counter 123 Device driver
86 Elapsed timer 124 Sequence monitor
89 Last block 125 Device monitor
90 Extended executive 126 Real signal demultiplexer
128 Slave default definition 161 Sequence generator
129 Multistate device driver 162 Digital segment buffer
132 Analog input/slave 163 Analog segment buffer
133 Smart field device definition 165 Moving average
134 Multi-sequence monitor 166 Integrator
135 Sequence manager 167 Polynomial
136 Remote motor control 168 Interpolator
137 C and BASIC program real output 169 Matrix addition
with quality
138 C or BASIC program boolean output 170 Matrix multiplication
with quality
139 Passive station interface 171 Trigonometric
140 Restore 172 Exponential
141 Sequence master 173 Power
142 Sequence slave 174 Logarithm
143 Invoke C 177 Data acquisition analog
144 C allocation 178 Data acquisition analog input/loop

WBPEEUI210504C0 A-3
Cross Reference - Numerical

Table A-1. Numerical Listing (continued)

Function Function
Description Description
Code Code
145 Frequency counter/slave 179 Enhanced trend
146 Remote I/O interface 184 Factory instrumentation protocol
handler
147 Remote I/O definition 185 Digital input subscriber
148 Batch sequence 186 Analog input subscriber
149 Analog output/slave 187 Analog output subscriber
150 Hydraulic servo slave 188 Digital output subscriber
151 Text selector 190 User defined function declaration
152 Model parameter estimator 191 User defined function one
153 ISC parameter converter 192 User defined function two
154 Adaptive parameter scheduler 193 User defined data import
155 Regression 194 User defined data export
156 Advanced PID controller 198 Auxiliary real user defined function
157 General digital controller 199 Auxiliary digital user defined function
160 Inferential smith controller 202 Remote transfer module executive
block (INIIT02)
210 Sequence of events slave 223 Analog out/channel
211 Data acquisition digital 224 Digital in/channel
212 Data acquisition digital input/loop 225 Digital out/channel
215 Enhanced analog slave definition 226 Test status
216 Enhanced analog input definition 241 DSOE data interface
217 Enhanced calibration command 242 DSOE digital event interface
218 Phase execution 243 Executive block (INSEM01)
219 Common sequence 244 Addressing interface definition
220 Batch historian 245 Input channel interface
221 I/O Device definition 246 Trigger definition
222 Analog in/channel

A-4 WBPEEUI210504C0
Cross Reference - Alphabetical

Cross Reference - Alphabetical


Table A-2. Alphabetical Listing

Function Function
Description Description
Code Code
Adapt 24 Analog segment buffer 163
Adaptive parameter scheduler 154 Analog transfer 9
Addressing interface definition 244 Analog trend 66
Advanced PID controller 156 AND (2-input) 37
Analog exception report 30 AND (4-input) 38
Analog in/channel 222 Auxiliary digital user defined 199
function
Analog input/Cnet 121 Auxiliary real user defined function 198
Analog input list (same PCU) 63 BASIC boolean output 94
Analog input/loop 26 BASIC configuration (BRC-100) 91
Analog input (same PCU node) 25 BASIC real output 93
Analog input/slave 132 Batch historian 220
Analog input subscriber 186 Batch sequence 148
Analog out/channel 223 BCD input 114
Analog output/slave 149 BCD output 115
Analog output subscriber 187 Blink 61
Boolean recipe table 117 DSOE data interface 241
Boolean signal multiplexer 119 DSOE digital event interface 242
C allocation 144 Elapsed timer 86
C and BASIC program real output 137 Enhanced analog input definition 216
with quality
Common sequence 219 Enhanced analog slave definition 215
Control interface slave 79 Enhanced calibration command 217
Control station 80 Enhanced trend 179
C or BASIC program boolean out- 138 Exclusive OR 101
put with quality
Data acquisition analog 177 Executive 81
Data acquisition analog input/loop 178 Executive block (INSEM01) 243
Data acquisition digital 211 Exponential 172
Data acquisition digital input/loop 212 Extended executive 90

WBPEEUI210504C0 A-5
Cross Reference - Alphabetical

Table A-2. Alphabetical Listing (continued)

Function Function
Description Description
Code Code
Device driver 123 Factory instrumentation protocol 184
handler
Device monitor 125 Frequency counter/slave 145
Digital exception report 45 Function generator 1
Digital in/channel 224 General digital controller 157
Digital input (periodic sample) 41 High/low compare 12
Digital input group 84 High/low limiter 6
Digital input/Cnet 122 High select 10
Digital input list (periodic sample) 64 Hydraulic servo 55
Digital input/loop 42 Hydraulic servo slave 150
Digital input subscriber 185 Inferential smith controller 160
Digital out/channel 225 Input channel interface 245
Digital output group 83 Integer transfer 13
Digital output readback check 100 Integrator 166
Digital output subscriber 188 Interpolator 168
Digital segment buffer 162 Invoke BASIC 92
Digital sum with gain 65 Invoke C 143
Digital transfer 59 I/O device definition 221
Divide 17 ISC parameter converter 153
Jump/master control relay 116 Qualified OR (8-input) 36
Last block 89 Rate limiter 8
Lead/lag 3 Real recipe table 118
Logarithm 174 Real signal demultiplexer 126
Low select 11 Real signal multiplexer 120
Manual set constant 51 Redundant analog input 96
Manual set constant 2 Redundant digital input 97
(signal generator)
Manual set integer 52 Regression 155
Manual set switch 50 Remote control memory 62
Matrix addition 169 Remote I/O definition 147
Matrix multiplication 170 Remote I/O interface 146
Memory 34 Remote manual set constant 68
Model parameter estimator 152 Remote motor control 136

A-6 WBPEEUI210504C0
Cross Reference - Categorization

Table A-2. Alphabetical Listing (continued)

Function Function
Description Description
Code Code
Module status monitor 95 Remote transfer module executive 202
block (INIIT02)
Moving average 165 Restore 140
Multiply 16 Rung (5-input) 110
Not 33 Rung (10-input) 111
OR (4-input) 40 Rung (20-input) 112
OR (2-input) 39 Segment control 82
Passive station interface 139 Segment control (IMCOM04) 164
Phasex 218 Sequence generator 161
PID error input 18 Sequence manager 135
PID (PV and SP) 19 Sequence master 141
Polynomial 167 Sequence monitor 124
Power 173 Sequence of events log 99
Pulse input/duration 109 Sequence of events slave 210
Pulse input/frequency 103 Sequence slave 142
Pulse input/period 102 Slave default definition 128
Pulse input/totalization 104 Slave select 98
Pulse positioner 4 Smart field device definition 133
Pulse rate 5 Square root 7
Summer (2-input) 15 Trigger definition 246
Summer (4-input) 14 Trip 32
Test alarm 69 Up/down counter 85
Test quality 31 User defined data export 194
Test status 226 User defined data import 193
Text selector 151 User defined function declaration 190
Time delay (analog) 58 User defined function one 191
Timer 35 User defined function two 192
Trigonometric 171

Cross Reference - Categorization


Function codes may be listed in multiple categories.

WBPEEUI210504C0 A-7
Cross Reference - Categorization

Table A-3. Adapt

Function Code Description


24 Adapt

Table A-4. Advanced Functions

Function Function
Description Description
Code Code
152 Model parameter estimator 167 Polynomial
153 ISC parameter converter 168 Interpolator
154 Adaptive parameter scheduler 169 Matrix addition
157 General digital controller 170 Matrix multiplication
160 Inferential smith controller 171 Trigonometric
162 Digital segment buffer 172 Exponential
163 Analog segment buffer 173 Power
165 Moving average 174 Logarithm
166 Integrator

Table A-5. BASIC Language

Function Function
Description Description
Code Code
91 BASIC configuration (BRC-100) 94 BASIC boolean output
92 Invoke BASIC 137 C and BASIC program real output
with quality
93 BASIC real output 138 C or BASIC program boolean output
with quality

Table A-6. Batch Functions

Function Function
Description Description
Code Code
117 Boolean recipe table 129 Multistate device driver
118 Real recipe table 134 Multi-sequence monitor
119 Boolean signal multiplexer 135 Sequence manager
120 Real signal multiplexer 141 Sequence master
123 Device driver 142 Sequence slave
124 Sequence monitor 161 Sequence generator

A-8 WBPEEUI210504C0
Cross Reference - Categorization

Table A-6. Batch Functions (continued)

Function Function
Description Description
Code Code
125 Device monitor 218 Phase execution
126 Real signal demultiplexer

Table A-7. Batch Language

Function Function
Description Description
Code Code
93 BASIC real output 148 Batch sequence
94 BASIC boolean output 219 Common sequence
137 C and BASIC program real output 220 Batch historian
with quality
138 C or BASIC program boolean output
with quality

Table A-8. C Language

Function Function
Description Description
Code Code
93 BASIC real output 138 C or BASIC program boolean output
with quality
94 BASIC boolean output 143 Invoke C
137 C and BASIC program real output 144 C allocation
with quality

Table A-9. Communications

Function
Description
Code
202 Remote transfer module executive block (INIIT02)

Table A-10. Computing

Function Function
Description Description
Code Code
1 Function generator 17 Divide
2 Manual set constant 51 Manual set constant
(signal generator)
3 Lead/lag 52 Manual set integer
5 Pulse rate 58 Time delay (analog)

WBPEEUI210504C0 A-9
Cross Reference - Categorization

Table A-10. Computing

Function Function
Description Description
Code Code
6 High/low limiter 65 Digital sum with gain
7 Square root 155 Regression
8 Rate limiter 171 Trigonometric
14 Summer (4-input) 172 Exponential
15 Summer (2-input) 173 Power
16 Multiply 174 Logarithm

Table A-11. Controlway/Module Bus and Peer-to-Peer Network I/O

Function Function
Description Description
Code Code
25 Analog input (periodic sample) 64 Digital input list (periodic sample)
41 Digital input (periodic sample) 95 Module status monitor
63 Analog input list (periodic sample)

Table A-12. Control Function Blocks

Function Function
Description Description
Code Code
4 Pulse positioner 24 Adapt
18 PID error input 156 Advanced PID controller
19 PID (PV and SP) 160 Inferential smith controller

Table A-13. Exception Report

Function Function
Description Description
Code Code
26 Analog input/loop 123 Device driver
30 Analog exception report 129 Multistate device driver
42 Digital input/loop 136 Remote motor control
62 Remote control memory 193 User defined data import
68 Remote manual set constant 194 User defined data export
80 Control station 211 Data acquisition digital
121 Analog input/Cnet 212 Data acquisition digital input/loop
122 Digital input/Cnet

A - 10 WBPEEUI210504C0
Cross Reference - Categorization

Table A-14. Executive

Function Function
Description Description
Code Code
57 Node statistics block 89 Last block
81 Executive 90 Extended executive
82 Segment control

Table A-15. Factory Instrumentation Protocol

Function Function
Description Description
Code Code
184 Factory instrumentation protocol 187 Analog output subscriber
handler
185 Digital input subscriber 188 Digital output subscriber
186 Analog input subscriber

Table A-16. Field I/O

Function Function
Description Description
Code Code
55 Hydraulic servo 128 Slave default definition
79 Control interface slave 132 Analog input/slave
83 Digital output group 133 Smart field device definition
84 Digital input group 145 Frequency counter/slave
96 Redundant analog input 146 Remote I/O interface
97 Redundant digital input 147 Remote I/O definition
102 Pulse input/period 149 Analog output/slave
103 Pulse input/frequency 150 Hydraulic servo slave
104 Pulse input/totalization 210 Sequence of events slave
109 Pulse input/duration 215 Enhanced analog slave definition
114 BCD input 216 Enhanced analog input definition
115 BCD output 217 Enhanced calibration command

Table A-17. Harmony I/O

Function Function
Description Description
Code Code
221 I/O device definition 224 Digital in/channel

WBPEEUI210504C0 A - 11
Cross Reference - Categorization

Table A-17. Harmony I/O

Function Function
Description Description
Code Code
222 Analog in/channel 225 Digital out/channel
223 Analog out/channel 226 Test status

Table A-18. BRC-100 Harmony Controller

Function Function
Description Description
Code Code
80 Control station 89 Last block
81 Executive 90 Extended executive
82 Segment control

Table A-19. Ladder Logic

Function Function
Description Description
Code Code
110 Rung (5-input) 112 Rung (20-input)
111 Rung (10-input) 116 Jump/master control relay

Table A-20. Logic

Function Function
Description Description
Code Code
33 Not 61 Blink
34 Memory 85 Up/down counter
35 Timer 86 Elapsed timer
36 Qualified OR (8-input) 101 Exclusive OR
37 AND (2-input) 110 Rung (5-input)
38 AND (4-input) 111 Rung (10-input)
39 OR (2-input) 112 Rung (20-input)
40 OR (4-input) 123 Device driver
50 Manual set switch 129 Multistate device driver
59 Digital transfer

A - 12 WBPEEUI210504C0
Cross Reference - Categorization

Table A-21. I/O Expander Bus

Function Function
Description Description
Code Code
55 Hydraulic Servo 147 Remote I/O definition
79 Control interface slave 150 Hydraulic servo slave
83 Digital output group 184 Factory instrumentation protocol
handler
84 Digital input group 185 Digital input subscriber
102 Pulse input/period 186 Analog input subscriber
103 Pulse input/frequency 187 Analog output subscriber
104 Pulse input/totalization 188 Digital output subscriber
109 Pulse input/duration 210 Sequence of events slave
114 BCD input 215 Enhanced analog slave definition
115 BCD output 216 Enhanced analog input definition
132 Analog input/slave 217 Enhanced calibration command
140 Restore1 241 DSOE data interface
145 Frequency counter/slave 242 DSOE digital event interface
146 Remote I/O interface
NOTE: 1. Restore uses expander bus only if a timer input is specified (S6 not equal to 000).

Table A-22. Restore

Function Code Description


140 Restore

Table A-23. Sequence Command

Function Code Description


82 Segment control
90 Extended executive

Table A-24. Sequence of Events

Function Function
Description Description
Code Code
99 Sequence of events log 243 Executive block (INSEM01)
210 Sequence of events slave 244 Addressing interface definition
241 DSOE data interface SEM to BRC 245 Input channel interface
242 DSOE digital event interface 246 Trigger definition

WBPEEUI210504C0 A - 13
Cross Reference - Categorization

Table A-25. Signal Select

Function Function
Description Description
Code Code
9 Analog transfer 59 Digital transfer
10 High select 162 Digital segment buffer
11 Low select 163 Analog segment buffer
13 Integer transfer

Table A-26. Signal Status

Function Function
Description Description
Code Code
12 High/low compare 98 Slave select
31 Test quality 100 Digital output readback check
69 Test alarm

Table A-27. Station

Function Function
Description Description
Code Code
62 Remote control memory 123 Device driver
68 Remote manual set constant 129 Multistate device driver
80 Control station 136 Remote motor control
87 DLS interface 139 Passive station interface
88 Digital logic station

Table A-28. Text Selector

Function Code Description


151 Text selector

Table A-29. Trend

Function Code Description


66 Analog trend
179 Enhanced trend

Table A-30. Trip

Function Code Description


32 Trip

A - 14 WBPEEUI210504C0
Cross Reference - Categorization

Table A-31. User Defined Function

Function Function
Description Description
Code Code
190 User defined function declaration 194 User defined data export
191 User defined function one 198 Auxiliary real user defined function
192 User defined function two 199 Auxiliary digital user defined function
193 User defined data import

WBPEEUI210504C0 A - 15
WBPEEUI210504C0
Harmony Bridge Controller
(BRC-100) Appendix B

Memory Utilization and Execution Times


This section lists the module memory requirements for each
function code. Two quantities are given for the BRC-100 mem-
ory utilization. The first value is the number of bytes of nonvol-
atile random access memory (NVRAM). The second quantity is
the number of bytes of random access memory (RAM). The
BRC-100 module has a total configuration memory of 424,128
bytes of NVRAM and 1,572,192 bytes of RAM.

This section also lists the function code execution times (in
microseconds) for the BRC-100 module.

NOTE: Except where otherwise noted, execution times are given for worst
case conditions.

Table B-1 shows the BRC-100 memory requirements and the


execution time for each function code.

NOTE: Refer to Memory Usage Equations in this section for the equations
listed in Table B-1.

Table B-1. BRC-100 Memory Utilization and Execution Times

Execution
Function NVRAM RAM
Description Times
Code (Bytes) (Bytes)
(in µsecs)
1 Function generator 46 92 17
2 Manual set constant 26 40 7
3 Lead/lag 26 72 60
4 Pulse positioner 26 88 27
5 Pulse rate 26 72 49
6 High/low limiter 26 48 16
7 Square root 26 48 70
8 Rate limiter 26 64 49
9 Analog transfer 26 76 68
10 High select 26 52 21
11 Low select 26 52 21

WBPEEUI210504C0 B-1
Memory Utilization and Execution Times

Table B-1. BRC-100 Memory Utilization and Execution Times (continued)

Execution
Function NVRAM RAM
Description Times
Code (Bytes) (Bytes)
(in µsecs)
12 High/low compare 26 48 16
13 Integer transfer 26 44 9
14 Four input summer 26 52 26
15 Two input summer 26 52 36
16 Multiply 26 48 29
17 Divide 26 48 33
18 PID error input 34 108 213
19 PID process variable and set point 36 116 230
24 Adapt 26 50 12
25 Analog input (periodic sample) 26 102 12
26 Analog input/loop 26 54 14
30 Analog exception report 26 102 38
31 Test quality 26 52 18
32 Trip 26 36 8
33 Not 26 36 8
34 Memory 26 46 10
35 Timer 26 58 27
36 Qualified OR (eight input) 26 68 24
37 AND (two input) 26 40 8
38 AND (four input) 26 48 11
39 OR (two input) 26 40 8
40 OR (four input) 26 48 11
41 Digital input (periodic sample) 26 90 13
42 Digital input/loop 26 42 12
45 Digital exception report 26 66 26
50 Manual set switch 26 36 7
51 Manual set constant (nontunable) 26 40 7
52 Manual set integer 26 36 7
55 Hydraulic servo 60 404 2,363
58 Time delay (analog) 26 Equation 1 56
59 Digital transfer 26 44 9

B-2 WBPEEUI210504C0
Memory Utilization and Execution Times

Table B-1. BRC-100 Memory Utilization and Execution Times (continued)

Execution
Function NVRAM RAM
Description Times
Code (Bytes) (Bytes)
(in µsecs)
61 Blink 26 48 40
62 Remote control memory 28 96 40
63 Analog input list (periodic sample) 28 286 40
64 Digital input list (periodic sample) 28 190 39
65 Digital sum with gain (four input) 28 68 33
66 Analog trend
Normal mode (slow) 26 196 41
Fast mode 26 700 26
68 Remote manual set constant (REMSET) 26 128 33
69 Test alarm 26 44 13
79 Control interface slave
First FC 79 block in segment 48 328 15,710
Additional FC 79 blocks in segment 48 328 1,054
80 Control station 84 366 118
81 Executive block 26 224 0
82 Segment control 64 284 0
83 Digital output group 32 90 134
84 Digital input group 26 114 133
85 Up/down counter 26 76 26
86 Elapsed timer 26 84 35
89 Last block 26 48 0
90 Extended executive 52 152 0
91 BASIC configuration Equation 2 Equation 3 5
92 Invoke BASIC 26 46 Program
dependent
93 BASIC real output 26 64 4
94 BASIC boolean output 26 72 4
95 Module status monitor 26 108 22
96 Redundant analog input 26 106 44
97 Redundant digital input 26 58 23
98 Slave select 26 84 26
99 Sequence of events log 26 Equation 4 97
100 Digital output readback check 40 144 77

WBPEEUI210504C0 B-3
Memory Utilization and Execution Times

Table B-1. BRC-100 Memory Utilization and Execution Times (continued)

Execution
Function NVRAM RAM
Description Times
Code (Bytes) (Bytes)
(in µsecs)
101 Exclusive OR 26 40 8
102 Pulse input/period 26 100 162
103 Pulse input/frequency 26 100 170
104 Pulse input/totalization 26 130 203
109 Pulse input/duration 26 100 160
110 Five input rung 26 74 20
111 Ten input rung 38 104 30
112 Twenty input rung 68 164 49
114 BCD input 26 72 113
115 BCD output 26 72 150
116 Jump/master control relay 26 52 6
117 Boolean recipe table 28 68 24
118 Real recipe table 48 102 24
119 Boolean signal multiplexer 32 86 21
120 Real signal multiplexer 32 90 21
121 Analog input/Cnet 26 82 17
122 Digital input/Cnet 26 50 12
123 Device driver 30 118 33
124 Sequence monitor 80 162 15
125 Device monitor 40 102 77
126 Real signal demultiplexer 26 92 45
128 Slave default definition 44 72 4
129 Multistate device driver 60 168 40
132 Analog input/slave 54 340 346
133 Smart field device definition 36 144 14
134 Multi-sequence monitor 96 268 13
135 Sequence manager 82 208 66
136 Remote motor control 52 186 54
137 BASIC real output/quality 26 80 4
138 BASIC boolean output/quality 26 64 4
139 Passive station interface 44 146 37

B-4 WBPEEUI210504C0
Memory Utilization and Execution Times

Table B-1. BRC-100 Memory Utilization and Execution Times (continued)

Execution
Function NVRAM RAM
Description Times
Code (Bytes) (Bytes)
(in µsecs)
140 Restore
Restore largest NVM utilization Equation 19 88 5,141
(FC 165 with S2 = 249)
Smallest NVM utilization (FC 33) Equation 19 88 123
141 Sequence master 80 142 33
142 Sequence slave 74 104 7
143 Invoke C 28 108 Program
dependent
144 C allocation Equation 5 Equation 6 5
145 Frequency counter/slave 30 120 62
146 Remote I/O interface 68 340 2,015
147 Remote I/O definition 144 480 27
148 Batch sequence 36 Equation 7 Program
dependent
149 Analog output/slave
First FC 149 in segment 82 318 16,414
Second FC 149 in segment 82 318 16,414
(same ASO as first)
Additional FC 149s in segment 82 318 1,298
150 Hydraulic servo slave 32 168 164
151 Text selector 46 152 20
152 Model parameter estimator 28 352 16
153 Inferential smith controller parameter converter 42 196 73
154 Adaptive parameter scheduler 36 224 38
155 Regression 68 Equation 8 28
156 Advanced PID controller 58 190 309
157 General digital controller 68 Equation 9 46
160 Smith predictor 36 342 146
161 Sequence generator 74 212 32
162 Digital segment buffer 26 78 22
163 Analog segment buffer 26 94 23
165 Moving average 26 Equation 10 96
166 Integrator 28 92 64

WBPEEUI210504C0 B-5
Memory Utilization and Execution Times

Table B-1. BRC-100 Memory Utilization and Execution Times (continued)

Execution
Function NVRAM RAM
Description Times
Code (Bytes) (Bytes)
(in µsecs)
167 Polynomial
Most complicated 58 108 216
All zero 58 108 81
168 Interpolator 98 196 167
169 Matrix addition 44 172 86
170 Matrix multiplication 44 172 624
171 Trigonometric
Sine 26 48 149
Secant 26 48 161
172 Exponential 26 44 136
173 Power 26 48 228
174 Logarithm 26 50 152
177 Data acquisition analog 104 398 118
178 Data acquisition analog input/loop 26 134 30
179 Enhanced trend
Normal sampling 52 Equation 11 98
Normal and statistical sampling 52 Equation 11 188
184 Factory instrumentation protocol handler 42 1,342 3,123
185 Digital input subscriber 32 220 88
186 Analog input subscriber 32 252 468
187 Analog output subscriber 48 232 835
188 Digital output subscriber 48 208 91
190 User defined function declaration 30 Equation 12 5
191 User defined function one 56 Equation 13 Program
dependent
192 User defined function two 70 Equation 14 Program
dependent
193 User defined data import 48 Equation 15 32
194 User defined data export 48 Equation 16 55
198 Auxiliary real user defined function 38 150 5
199 Auxiliary digital user defined function 38 134 5
210 Sequence of events slave 100 572 338
211 Data acquisition digital 62 310 123
212 Data acquisition digital input/loop 26 110 20

B-6 WBPEEUI210504C0
Memory Utilization and Execution Times

Table B-1. BRC-100 Memory Utilization and Execution Times (continued)

Execution
Function NVRAM RAM
Description Times
Code (Bytes) (Bytes)
(in µsecs)
215 Enhanced analog slave definition 30 206 766
216 Enhanced analog input definition 42 114 299
217 Enhanced calibration command 26 178 12
218 Phase execution 44 Equation 25 Program
dependent
219 Common sequence 46 Equation 17 Program
dependent
220 Batch historian 46 Equation 18 Program
dependent
221 I/O device definition Equation 20 1124 Note 1
222 Analog in/channel Equation 21 298 3002
223 Analog out/channel Equation 22 298 3602
224 Digital in/channel Equation 23 298 1602
225 Digital out/channel Equation 24 298 1602
226 Test status Equation 26 130 70
227 Gateway Equation 27 19,982 69,0003
228 Foreign device definition Equation 28 372 70
229 Pulse In/Channel Equation 29 452 430
241 DSOE data interface SEM to MFP
No SED resynch function performed 26 284 105
SED resynch performed once every second 26 284 470
242 DSOE digital event interface
No data available on SED I/O module 84 338 77
Data available on SED I/O module 84 338 795
247 Condition monitoring 133 544 Note 4
NOTES:
1. Time dependent on the I/O block type configured and on the presence or absence of redundant blocks. Refer to Table B-2.
2. With exception reports enabled.
3. Time for the maximum configuration.
4. Time dependent on the turbine instrumentation module type. Refer to the applicable product instruction manual.

WBPEEUI210504C0 B-7
Memory Usage Equations

Table B-2. FC221 Execution Times

Non-Redundant
Redundant Blocks
I/O Block Blocks
(µsecs)
(µsecs)
AIN-120 1900 3600
AOT-120 3400 6800
CIO-100 2900 N/A
DIO-400 3000 6000
DOT-120 3000 6000

Memory Usage Equations


1. 78 + [8 x (S5)]

2. 38 + [1024 x (S5)]

3. 4994 + 1024 [(S3) + (S4) + (S5)]

4. 96 + [9 x (S2)]

5. 12 + [1024 x (S2)]

6. 36 + [1024 x (S1)]

7. 826 + [1024 x (S11)] + [2048 x (S12)]

8. 338 + [40 x (S7)]

9. 228 + [8 x (S21 + S22)]

10. 98 + [8 x (S2]

11. a + [b x (S4)] + [c x (n{S3})],

where:

n{S3} = Number of modes selected for S3


if S2 = 0 or 3, then a = 396, b = 24, and c = 16
if S2 = 1, 2, 5, 6, 7 or 9, then a = 380, b = 20, and c = 8
if S2 = 4 or 8, then a = 456, b = 50, and c = 64

12. 78 + [10 x (S2)]

13. 520 + [2 x (S16)]

14. 604 + [2 x (S24)]

B-8 WBPEEUI210504C0
Function Blocks - BRC-100

15. 256 + [3 x (S5)]

16. 256 + [5 x (S4)]

17. 424 + [222 x (S13)]

18. 666 + [2 x (S11)]

19. 40 + N,

where:

N = Applicable function code size from Table 140-2.


NVRAM is set to 46 when N is less than six.

20. 90 + Size of string data in S1 + Size of string data in S30.

21. 92 + Size of string data in S1.

22. 78 + Size of string data in S1.

23. 52 + Size of string data in S1.

24. 48 + Size of string data in S1.

25. 1450 + [1024 x (S11)] + [2 x (S12)]

26. 27 + Size of string data in S2 + S3 + S4 + S5 + S10.

27. 208 + Size of string data in S1 + Size of string data in S2


+ Size of string data in S4 + Size of string data in S6
+ Size of string data in S8 + Size of string data in S10
+ Size of string data in S19 + S15
+ [18 if 0 < (S15) <= 16,374,
else 36 if 16,374 < (S15) <= 32,748,
else 54 if 32,748 < (S15)]

28. 48 + Size of string data in S1 + Size of string data in S2


+ Size of string data in S7

29. 108 + Size of string data in S1 + Size of string data in S23

Function Blocks - BRC-100


Table B-3 contains function code block number information
for the BRC-100 module.

WBPEEUI210504C0 B-9
Function Blocks - BRC-100

Table B-3. BRC-100 Module

Block No. Definition Function Code


0 Logic 0 81
1 Logic 1
2 0 or 0.0
3 -100.0
4 -1.0
5 0.0
6 1.0
7 100.0
8 -9.2 E18
9 9.2 E18
10 Startup flag (0 = no, 1 = yes)
11 Memory display value 81 (continued)
12 System free time in percent
13 Revision level
14 Reserved
15 Task 1 elapsed time since previous cycle 82
16 Task 1 elapsed time current cycle (sec/min)
17 Task 1 processor utilization
18 Task 1 check point overrun count
19 Task 1 cycle time overrun (sec/min)
20 Hours, time of day 90
21 Minutes, time of day
22 Seconds, time of day
23 No time synchronization flag:
0 = time of day invalid
1 = time of day valid
24 Year (0 to 99)
25 Month (1 to 12)
26 Day (1 to 31)
27 Day of week (1 to 7, Sunday = 1) 90
28 Reserved
29 Reserved

B - 10 WBPEEUI210504C0
Module Status Information - BRC-100

Table B-3. BRC-100 Module (continued)

Block No. Definition Function Code


301 Configurable blocks Any allowed
function code -
refer to Table B-1
9999 Loop type: 89
0.0 = Plant Loop
1.0 = Cnet
3.0 = Cnet with time-stamping
NOTE:
1. The highest configurable block number is 9998 for the BRC-100.

Module Status Information - BRC-100


Tables B-4 and B-5 explain Harmony bridge controller status
bytes.

Table B-4. Bit Description - BRC-100

Bit
Byte
7 6 5 4 3 2 1 0
1 ES MODE TYPE
2 FTX BAC RIO LIO CFG NVF NVI DSS
3 Error code
4 Error code descriptor (1)
5 Error code descriptor (2)
6 ETYPE
7 CWA CWB R1F R2F Reserved Reserved HnetA HnetB
8 SIME SIMR SIMT SIMM Reserved
9 RA RB Reserved
10 PRI CFC Reserved CHK RID RDEXP OCE RDDET
11 Reserved Reserved Reserved SOA RNO Reserved Reserved Reserved
12-13 Reserved
14 Module nomenclature
15 Revision letter (ASCII)
16 Revision number (ASCII)

WBPEEUI210504C0 B - 11
Module Status Information - BRC-100

Table B-5. Byte Description - BRC-100

Field Size
Byte Field Description
or Value
1 ES 80 Error summary: 0 = good, 1 = errors
MODE 60 Module mode: 00 = configure, 10 = error, 11 = execute
TYPE 1F Module type code: (15)16 = Enhanced status
2 FTX 80 First time in execute: 0 = no, 1 = yes
BAC 40 Backup status: 0 = good, 1 = bad
RIO 20 Summary remote input status: 0 = good, 1 = bad
LIO 10 Summary local input status: 0 = good, 1 = bad
CFG 08 Online configuration changes being made
NVF 04 Summary NVRAM failure status: 0 = good, 1 = fail
NVI 02 Summary NVRAM initialized state: 0 = no, 1 = yes
DSS 01 Digital station status: 0 = good, 1 = bad

B - 12 WBPEEUI210504C0
Module Status Information - BRC-100

Table B-5. Byte Description - BRC-100 (continued)

Field Size
Byte Field Description
or Value
3-5 Error 3 4 5
Note 1 Code
NVRAM error:
01 01 — Write failure
02 — Checksum failure
03 — Bad data
FF — Reset during write
02 (1) (2) Analog input reference error:
(1), (2) = block number of control interface I/O module block
03 (1) (2) Missing I/O module or expander board:
(1), (2) = block number of I/O module or station
05 (1) (2) Configuration error – undefined block:
(1), (2) = block number making reference
06 (1) (2) Configuration error – input data type is incorrect:
(1), (2) = block number making reference
08 (1) (2) Trip block activated:
(1), (2) = block number of trip block
0F — — Primary module has failed and the redundant module configuration is
not current
10 — — Primary module has failed and the dynamic RAM data in the redundant
module is not current
09 — — Segment violation - priority set the same in two segments or more than
eight segments defined.
11 — — NVRAM write failure error
1E (1) (2) Duplicate device definition label – multiple function code 221 function
blocks contain the same device label.
(1), (2) = block number making reference.
20 — — Program format error - inconsistent format table
21 (1) (2) File system error:
(1), (2) = file number
22 (1) (2) Invoke C error:
(1), (2) = block number making reference
24 (1) (2) C program stack overflow:
(1), (2) = block number making reference
28 (1) (2) User defined function (UDF) reference is invalid:
(1), (2) = block number making reference
29 (1) (2) UDF block cannot read program file:
(1), (2) = block number making reference
2A (1) (2) Not enough memory for UDF:
(1), (2) = block number making reference

WBPEEUI210504C0 B - 13
Module Status Information - BRC-100

Table B-5. Byte Description - BRC-100 (continued)

Field Size
Byte Field Description
or Value
3-5 Error 2B (1) (2) Missing UDF declaration:
(cont) Code (1), (2) = block number making reference
2C (1) (2) Wrong UDF type:
(1), (2) = block number making reference
2D (1) (2) Missing UDF auxiliary block:
(1), (2) = block number making reference
2E (1) (2) UDF compiler and firmware are incompatible:
(1), (2) = block number making reference
2F (1) (2) BASIC program error:
(1), (2) = line number of error
6 ETYPE 1F Enhanced module type = (24)16
7 CWA 80 Controlway bus A failure: 0 = good, 1 = fail
CWB 40 Controlway bus B failure: 0 = good, 1 = fail
R1F 20 Redundancy link channel 1 failure: 0 = good, 1 = fail
R2F 10 Redundancy link channel 2 failure: 0 = good, 1 = fail
HnetA 02 Harmony net channel A failure: 0 = good, 1 = fail
HnetB 01 Harmony net channel B failure: 0 = good, 1 = fail
8 SIME 80 Simulation enabled: 0 = normal operation, 1 = simulation active
SIMR 40 Simulation running/frozen: 0 = simulation frozen, 1= simulation running
SIMT 20 Simulation time rate: 0 = real time, 1 = slow/fast time
SIMM 10 Simulation mode: 0=INFI 90®/USM0x, 1=Harmony/SIM-100
9 RA 80 Harmony net channel A relay fault: 0 = good, 1 = fail
RB 40 Harmony net channel B relay fault: 0 = good, 1 = fail
10 PRI 80 Module is primary versus backup; set to 1 in the primary module.
CFC 40 Configuration current (latched until backup is reset). Set when LED 7 is
enabled (1 = on or blinking) on the backup module.
CHK 10 Backup has completed checkpointing (latched until backup is reset).
Always set to 0 on the primary module. Follows LED 8 (1 = on or blink-
ing) on the backup module.
RID 08 Redundancy ID. Follows setting of redundancy ID pole on the
dipswitch.
RDEXP 04 Redundancy expected. Always set to 1 on the backup module. Follows
state of function code 90, specification S3, ones digit on the primary
module.
OCE 02 Online configuration is enabled. Follows setting of online configuration
enable pole on dipswitch.
RDDET 01 Redundancy detected (latched until module is reset or it changes from
backup to primary or primary to backup). Set to 1 when a properly con-
figured redundant module is detected.

B - 14 WBPEEUI210504C0
Module Status Information - BRC-100

Table B-5. Byte Description - BRC-100 (continued)

Field Size
Byte Field Description
or Value
11 SOA 10 Status output alarm. Indicates the status of the system +24 volt power
and the I/O block’s power (logic and field power for a single cabinet).
0 = OK, 1 = alarm.
RNO 08 Redundancy NVM overrun (latched indication). Set to 1 in primary
module if NVM checkpoint overruns have occurred. NVM checkpoint
overruns cause the primary module to reset the backup module.
12-13 — 00 Reserved
14 — FF Module nomenclature:(05)16 = BRC-100
15 — FF Revision letter (in ASCII code), for example, (46)16 = F, (47)16 = G
16 — FF Revision number (in ASCII code), for example, (30)16 = 0
NOTE:
1. Byte 3 is displayed on the front panel LEDs when the module is in ERROR mode.

WBPEEUI210504C0 B - 15
WBPEEUI210504C0
Harmony Area Controller (HAC)
Appendix C

Memory Utilization and Execution Times


This section lists the module memory requirements for each
function code. Three quantities are given for the HAC memory
utilization:

• The number of bytes of nonvolatile random access memory


(NVRAM). The Harmony area controller has a total configu-
ration memory of 2,097,150 bytes of NVRAM.

• The number of bytes of random access memory (RAM). The


Harmony area controller has a total configuration memory
of 6,291,392 bytes of RAM.

• The checkpoint buffer RAM contained on the process I/O


(PIO) board inside the HAC enclosure. This area is physi-
cally separate from the main memory board, and it can
have an impact on the size of a configuration. The check-
point buffer RAM has a total configuration memory of
2,070,000 bytes.

This section also lists the function code execution times (in
microseconds) for the Harmony area controller.

NOTE: Except where otherwise noted, execution times are given for worst
case conditions.

Table C-1 shows the HAC memory requirements and the exe-
cution time for each function code.

Table C-1. HAC Memory Utilization and Execution Times

Checkpoint Execution
Function NVRAM RAM
Description Buffer RAM Times
Code (Bytes) (Bytes)
(Bytes) (in µsecs)
1 Function generator 46 96 12 9
2 Manual set constant 12 44 12 4
3 Lead/lag 18 66 22 30
4 Pulse positioner 24 84 24 14
5 Pulse rate 16 70 18 25

WBPEEUI210504C0 C-1
Memory Utilization and Execution Times

Table C-1. HAC Memory Utilization and Execution Times (continued)

Checkpoint Execution
Function NVRAM RAM
Description Buffer RAM Times
Code (Bytes) (Bytes)
(Bytes) (in µsecs)
6 High/low limiter 16 52 12 8
7 Square root 14 52 12 35
8 Rate limiter 18 62 18 25
9 Analog transfer 20 70 22 34
10 High select 16 56 12 11
11 Low select 16 56 12 11
12 High/low compare 16 52 12 8
13 Integer transfer 14 50 10 5
14 Four input summer 16 56 12 13
15 Two input summer 18 56 12 18
16 Multiply 14 52 12 15
17 Divide 14 52 12 17
18 PID error input 34 98 26 107
19 PID process variable and set point 36 102 30 115
24 Adapt 12 54 12 6
25 Analog input (peer-to-peer) 12 79 34 20
26 Analog input/loop 12 66 20 7
30 Analog exception report 26 120 40 19
31 Test quality 16 58 10 9
32 Trip 12 42 10 4
33 Not 12 42 10 4
34 Memory 14 52 10 5
35 Timer 14 56 18 14
36 Qualified OR (eight input) 26 74 10 12
37 AND (two input) 12 46 10 4
38 AND (four input) 16 54 10 6
39 OR (two input) 12 46 10 4
40 OR (four input) 16 54 10 6
41 Digital input/bus (peer-to-peer) 12 78 33 20
42 Digital input/loop 12 60 14 6
45 Digital exception report 12 88 32 13

C-2 WBPEEUI210504C0
Memory Utilization and Execution Times

Table C-1. HAC Memory Utilization and Execution Times (continued)

Checkpoint Execution
Function NVRAM RAM
Description Buffer RAM Times
Code (Bytes) (Bytes)
(Bytes) (in µsecs)
50 Manual set switch 8 40 10 4
51 Manual set constant (nontunable) 12 36 8 4
52 Manual set integer 12 36 8 4
55 Hydraulic servo 60 332 88 1,182
57 Terminating executive 42 Equation 1 Equation 2 0
58 Time delay (analog) 18 Equation 3 22 28
59 Digital transfer 14 50 10 5
61 Blink 12 50 14 20
62 Remote control memory 28 104 22 20
63 Analog input list (peer-to-peer) 28 185 110 20
64 Digital input list (peer-to-peer) 28 137 62 20
65 Digital sum with gain (four input) 28 72 12 17
66 Analog trend
Normal mode (slow) 12 376 340 21
Fast mode 12 376 340 13
68 Remote manual set constant 22 122 36 17
(REMSET)
69 Test alarm 12 48 12 7
79 Control interface slave
First FC 79 block in segment 48 276 68 7,855
Other FC 79 blocks in segment 48 276 68 527
80 Control station 84 316 80 59
81 Executive block 12 179 66 0
82 Segment control 66 260 56 0
83 Digital output group 32 96 10 67
84 Digital input group 16 88 42 67
85 Up/down counter 24 74 18 13
86 Elapsed timer 20 76 24 18
90 Extended executive 52 107 58 0
95 Module status monitor 22 80 30 11
96 Redundant analog input 22 88 34 22
97 Redundant digital input 14 58 16 12
98 Slave select 26 86 14 13

WBPEEUI210504C0 C-3
Memory Utilization and Execution Times

Table C-1. HAC Memory Utilization and Execution Times (continued)

Checkpoint Execution
Function NVRAM RAM
Description Buffer RAM Times
Code (Bytes) (Bytes)
(Bytes) (in µsecs)
100 Digital output readback check 40 134 26 39
101 Exclusive OR 12 46 10 4
102 Pulse input/period 24 96 20 81
103 Pulse input/frequency 24 96 20 85
104 Pulse input/totalization 26 114 32 102
109 Pulse input/duration 24 96 20 80
110 Five input rung 24 76 14 10
111 Ten input rung 38 106 14 15
112 Twenty input rung 68 166 14 25
114 BCD input 20 70 18 57
115 BCD output 22 76 12 75
116 Jump/master control relay 12 58 10 3
117 Boolean recipe table 28 74 10 12
118 Real recipe table 48 106 12 12
119 Boolean signal multiplexer 32 92 10 11
120 Real signal multiplexer 32 94 12 11
121 Analog input/Cnet 22 90 22 9
122 Digital input/Cnet 20 66 14 6
123 Device driver 30 116 32 17
124 Sequence monitor 80 158 20 8
125 Device monitor 40 106 12 39
126 Real signal demultiplexer 12 84 24 23
128 Slave default definition 44 90 22 2
129 Multistate device driver 60 160 38 20
132 Analog input/slave 54 308 48 173
133 Smart field device definition 36 164 20 7
134 Multi-sequence monitor 96 248 36 7
135 Sequence manager 82 192 32 33
136 Remote motor control 52 166 50 27
137 BASIC real output/quality 12 62 32 2
138 BASIC boolean output/quality 12 54 24 2

C-4 WBPEEUI210504C0
Memory Utilization and Execution Times

Table C-1. HAC Memory Utilization and Execution Times (continued)

Checkpoint Execution
Function NVRAM RAM
Description Buffer RAM Times
Code (Bytes) (Bytes)
(Bytes) (in µsecs)
139 Passive station interface 44 130 32 19
140 Restore Refer to
Largest NVM utilization formula in 92 12 2,571
(FC 165 with S2 = 249) Function
Smallest NVM utilization (FC 33) Code 140. 92 12 62
141 Sequence master 80 134 24 17
142 Sequence slave 74 110 10 4
143 Invoke C 28 102 22 Program
dependent
144 C allocation Equation 4 Equation 5 Equation 6 3
145 Frequency counter/slave 30 114 22 31
146 Remote I/O interface 68 290 54 1,008
147 Remote I/O definition 144 426 74 14
148 Batch sequence 36 Equation 7 Equation 8 Program
dependent
149 Analog output/slave
First FC 149 in segment 82 282 52 8,207
Second FC 149 in segment 82 282 52 8,207
(same ASO as first)
Additional FC 149s in segment 82 282 52 649
150 Hydraulic servo slave 32 148 42 82
151 Text selector 46 156 26 10
152 Model parameter estimator 28 342 26 8
153 Inferential smith controller 42 182 30 37
parameter converter
154 Adaptive parameter scheduler 36 212 28 19
155 Regression 68 Equation 9 Equation 10 14
156 Advanced PID controller 58 158 48 155
157 General digital controller 68 Equation 11 Equation 12 23
160 Smith predictor 36 236 122 73
161 Sequence generator 74 182 46 16
162 Digital segment buffer 16 70 24 11
163 Analog segment buffer 16 78 32 12
165 Moving average 16 Equation 13 Equation 14 48

WBPEEUI210504C0 C-5
Memory Utilization and Execution Times

Table C-1. HAC Memory Utilization and Execution Times (continued)

Checkpoint Execution
Function NVRAM RAM
Description Buffer RAM Times
Code (Bytes) (Bytes)
(Bytes) (in µsecs)
166 Integrator 28 84 24 32
167 Polynomial
Most complicated 68 112 12 108
All zero 68 112 12 41
168 Interpolator 98 198 14 84
169 Matrix addition 44 144 44 43
170 Matrix multiplication 44 144 44 312
171 Trigonometric
Sine 14 52 12 75
Secant 14 52 12 81
172 Exponential 12 48 12 68
173 Power 14 52 12 114
174 Logarithm 14 54 14 76
177 Data acquisition analog 104 334 94 59
178 Data acquisition analog input/loop 20 124 52 15
179 Enhanced trend FDB + FOB
Normal sampling 52 memory Equation 15 49
Normal and statistical sampling 52 usage Equation 15 94
184 Factory instrumentation protocol 42 1274 84 1,562
handler
185 Digital input subscriber 32 178 60 44
186 Analog input subscriber 32 194 76 234
187 Analog output subscriber 48 214 32 418
188 Digital output subscriber 48 190 32 46
190 User defined function declaration 30 Equation 16 12 3
191 User defined function one 56 440 + S16 96 + S16 Program
dependent
192 User defined function two 70 508 + S24 112 + S24 Program
dependent
193 User defined data import 48 Equation 19 72 + S5 16
194 User defined data export 48 Equation 20 62 + S4 28
198 Aux. real user defined function 38 142 24 3
199 Aux. digital user defined function 38 134 16 3
211 Data acquisition digital 62 260 84 62

C-6 WBPEEUI210504C0
Memory Utilization and Execution Times

Table C-1. HAC Memory Utilization and Execution Times (continued)

Checkpoint Execution
Function NVRAM RAM
Description Buffer RAM Times
Code (Bytes) (Bytes)
(Bytes) (in µsecs)
212 Data acquisition digital input/loop 20 106 34 10
215 Enhanced analog slave definition 30 196 26 383
216 Enhanced analog input definition 42 114 16 150
217 Enhanced calibration command 24 154 40 6
218 Phase execution 43 Equation 22 308 + S12 Program
dependent
219 Common sequence 46 Equation 17 Equation 18 Program
dependent
220 Batch historian 46 476 + S11 226 + S11 Program
dependent
221 I/O device definition Equation 966 50 Note 1
23
222 Analog in/channel Equation 298 64 702
24
223 Analog out/channel Equation 298 64 852
25
224 Digital in/channel Equation 298 64 502
26
225 Digital out/channel Equation 298 64 502
27
226 Test status Equation 144 16 52
21
227 Gateway TBD TBD TBD TBD
228 Foreign device definition TBD TBD TBD TBD
241 DSOE interface SEM to MFP
No SED resynch performed 18 315 30 53
SED resynch performed (1/sec.) 18 315 30 235
242 DSOE digital event interface
No data on SED I/O module 84 246 96 39
Data on SED I/O module 84 246 96 398
247 Condition monitoring TBD TBD TBD TBD
NOTES:
1. Time dependent on the I/O block type configured and on the presence or absence of redundant blocks. Refer to Table C-2.
2. With exception reports enabled.

WBPEEUI210504C0 C-7
Memory Usage Equations

Table C-2. FC221 Execution Times

Non-Redundant
Redundant Blocks
I/O Block Blocks
(µsecs)
(µsecs)
AIN-120 1500 2800
AOT-120 2500 5000
CIO-100 2500 N/A
DIO-400 2400 4300
DOT-120 2300 4200

Memory Usage Equations


1. 485 + S2 + [16 x (S8)]

2. 400,174 + [16 x (S8)]

3. 72 + [8 x (S5)]

4. 12 + [1024 x (S2)]

5. 42 + [1024 x (S1)]

6. 10 + [1024 x (S1)]

7. 676 + [1024 x (S11 + S12)]

8. 248 + [1024 x (S12)]

9. 294 + [20 x (S7)]

10. 60 + [20 x (S7)]

11. 144 + [8 x (S21 + S22)]

12. 60 + [4 x (S21 + S22)]

13. 79 + [4 x (S2)]

14. 34 + [4 x (S2)]

15. a + [b x (S4)] + [c x (n{S3})],

where:

n{S3} = Number of modes selected for S3


if S2 = 0, 10, or 11, then a = 106, b = 12, and c = 8

C-8 WBPEEUI210504C0
Function Blocks - HAC

if S2 = 1, 2, 5, 6, 7, 9, 12, or 13, then a = 100, b = 10,


and c = 4
if S2 = 4 or 8, then a = 128, b = 25, and c = 32

16. 82 + [10 x (S2)]

17. 490 + [292 x (S13)]

18. 378 + [142 x (S13)]

19. 214 + [2 x (S5)]

20. 202 + [4 x (S4)]

21. 27 + Size of string data in S2 + S3 + S4 + S5 + S10.

22. 1458 + [1024 x (S11)] + [2 x (S12)]

23. 90 + Size of string data in S1 + Size of string data in S30.

24. 92 + Size of string data in S1.

25. 78 + Size of string data in S1.

26. 52 + Size of string data in S1.

27. 48 + Size of string data in S1.

Function Blocks - HAC


Table C-3 contains function code block number information
for the Harmony area controller.

Table C-3. Harmony Area Controller

Block No. Definition Function Code


0 Logic 0 81
1 Logic 1
2 0 or 0.0
3 -100.0
4 -1.0
5 0.0
6 1.0

WBPEEUI210504C0 C-9
Function Blocks - HAC

Table C-3. Harmony Area Controller (continued)

Block No. Definition Function Code


7 100.0 81
8 -9.2 E18
9 9.2 E18
10 Startup flag (0 = no, 1 = yes)
11 Memory display value
12 System free time in percent
13 Revision level
14 Reserved
15 Task 1 elapsed time since previous cycle 82
16 Task 1 elapsed time current cycle (sec/min)
17 Task 1 processor utilization
18 Task 1 check point overrun count
19 Task 1 cycle time overrun (sec/min)
20 Hours, time of day 90
21 Minutes, time of day
22 Seconds, time of day
23 No time synchronization flag:
0 = time of day invalid
1 = time of day valid
24 Year (0 to 99)
25 Month (1 to 12)
26 Day (1 to 31)
27 Day of week (1 to 7, Sunday = 1)
28 Reserved
29 Reserved
301 Configurable blocks Any allowed
function code -
refer to Table C-1
31999 Reserved 57
NOTE:
1. The highest configurable block number is 31,998 for the HAC.

C - 10 WBPEEUI210504C0
Module Status Information - HAC

Module Status Information - HAC


Tables C-4 and C-5 explain Harmony area controller module
status bytes.

Table C-4. Bit Description - HAC

Bit
Byte
7 6 5 4 3 2 1 0
1 ES MODE TYPE
2 FTX RDF RIO LIO CFG NVF NVI STA
3 Error code
4 Error code descriptor byte 1
5 Error code descriptor byte 2
6 ETYPE
7 CHnetA CHnetB RDA RDB PER COM IOHnetA IOHnetB
8 SIME Reserved Reserved SIMES Reserved
9 IOHnetRA IOHnetRB Reserved MOV NDT1 NDT2 NDC1 NDC2
10 PRI CFC Reserved CHK RID RDEXP OCE RDDET
11 PA PB PS SOA RNO NOL FDNL BFM
12 NODES RER1 RER2 TER1 TER2 RID1 RID2 RCF
14 Hardware nomenclature (hex)
15 Firmware revision letter (ASCII)
16 Firmware revision number (ASCII)

Table C-5. Byte Description - HAC

Field Size
Byte Field Description
or Value
1 ES 80 Error summary: 0 = good, 1 = errors
MODE 60 Module mode: 00 = configure, 10 = error, 11 = execute
TYPE 1F Module type=0x15 enhanced status (ETYPE).
2 FTX 80 First time in execute: 0 = no, 1 = yes
RDF 40 Redundant failure status:
0 = good; no error or not configured for redundancy.
1 = bad; primary halted, backup controller module expected and
not present or halted.
RIO 20 Summary remote I/O status: 0=good, 1=bad.
Physical I/O that is not available over local I/O expander bus and Hnet, but
available via some other communications channel.

WBPEEUI210504C0 C - 11
Module Status Information - HAC

Table C-5. Byte Description - HAC (continued)

Field Size
Byte Field Description
or Value
2 LIO 10 Summary local I/O status: 0 = good, 1 = bad.
(cont) Physical I/O that is available over local I/O expander bus and Hnet.
CFG 08 Online configuration:
0 = no change to configuration.
1 = backup module configuration changed.
NVF 04 NVRAM status: 0=good, 1=bad.
NVI 02 NVRAM initialized (default configuration): 0=no, 1=yes.
STA 01 Station error status: 0=good, 1=bad (no response).
Bad indicates station offline due to loss of station link communication.
3-5 Error 3 4 2 52
Code
Note 1 NVRAM error:
01 01 — Write failure
02 — Checksum failure
03 — Bad data
FF — Reset during write
02 (1) (2) Analog input reference error:
(1), (2) = block number of control I/O module function block
03 (1) (2) Missing rack I/O module:
(1), (2) = block number of I/O module or station
04 — — Checkpoint buffer allocation error – configuration is too large to fit in available
checkpoint memory.
05 (1) (2) Configuration error – undefined block:
(1), (2) = block number making reference
06 (1) (2) Configuration error – input data type is incorrect. Specification S8 for func-
tion code 57 was set too low.
(1), (2) = block number making reference
08 (1) (2) Trip block activated:
(1), (2) = block number of trip block
09 — — Segment violation - priority set the same in two segments, or more than eight
segments defined.
0F — — Primary module has failed, and the redundant module configuration is not
current.
10 — — Primary module has failed, and the dynamic RAM data in the redundant
module is not current.
11 — — NVRAM write failure error.
1C — — Network I/O hardware is offline. Online configuration test cannot be com-
pleted.
1E (1) (2) Duplicate device definition label – multiple function code 221 function blocks
contain the same device label.
(1), (2) = block number making reference.

C - 12 WBPEEUI210504C0
Module Status Information - HAC

Table C-5. Byte Description - HAC (continued)

Field Size
Byte Field Description
or Value
3-5 Error 3 42 52
Code
(cont) 1F (1) — Software licensing error. (1) equals:
01 - License key not valid.
02 - Function block license exceeded.
03 - C license not available.
04 - Batch 90/UDF license not available.
20 — — Program format error - inconsistent format table.
21 (1) (2) File system error:
(1), (2) = file number
22 (1) (2) Invoke C error:
(1), (2) = block number making reference.
24 (1) (2) C program stack overflow:
(1), (2) = block number making reference
28 (1) (2) User defined function (UDF) reference is invalid:
(1), (2) = block number making reference
29 (1) (2) UDF block cannot read program file:
(1), (2) = block number making reference
2A (1) (2) Not enough memory for UDF:
(1), (2) = block number making reference
2B (1) (2) Missing UDF declaration:
(1), (2) = block number making reference
2C (1) (2) Wrong UDF type:
(1), (2) = block number making reference
2D (1) (2) Missing UDF auxiliary block:
(1), (2) = block number making reference
2E (1) (2) UDF compiler and firmware are incompatible:
(1), (2) = block number making reference
6 ETYPE 1F Enhanced module type = 0x24 (module address 2 & 3).
7 CHnetA 80 Controller peer-to-peer Hnet channel/relay A failure: 0 = good, 1 = fail
CHnetB 40 Controller peer-to-peer Hnet channel/relay B failure: 0 = good, 1 = fail
RDA 20 Redundancy link channel 1 failure: 0 = good, 1 = fail
RDB 10 Redundancy link channel 2 failure: 0 = good, 1 = fail
PER 08 Peripheral failure: 0 = good, 1 = fail
COM 40 I/O Hnet communication established: 0=no, 1 = yes
IOHnetA 02 I/O Hnet channel A failure: 0 = good, 1 = fail
IOHnetB 01 I/O Hnet channel B failure: 0 = good, 1 = fail

WBPEEUI210504C0 C - 13
Module Status Information - HAC

Table C-5. Byte Description - HAC (continued)

Field Size
Byte Field Description
or Value
8 SIME 80 Simulation enabled: 0 = no, 1 = yes. This field is set for both INFI 90 OPEN
and Symphony simulation.
SIMES 10 Hnet I/O block simulation enabled: 0 = no, 1 = yes. This field, in addition to
the SIME field, is set when Symphony simulation is enabled.
9 IOHnetRA 80 I/O Hnet channel A relay fault: 0 = good, 1 = fail
IOHnetRB 40 I/O Hnet channel B relay fault: 0 = good, 1 = fail
MOV 10 Module memory overflow: 0 = no, 1 = yes
NDT1 08 Network I/O board drive transistor/relay one failure: 0 = no, 1 = yes
NDT2 04 Network I/O board drive transistor/relay two failure: 0 = no, 1 = yes
NCD1 02 Network I/O board channel one failure: 0 = no, 1 = yes
NCD2 01 Network I/O board channel two failure: 0 = no, 1 = yes
10 PRI 80 Primary/backup status: 0 = backup module, 1 = primary module
CFC 40 Configuration current (latched until backup is reset):
0 = configuration initialization not complete.
1 = all configuration initialization complete.
CHK 10 Backup has completed check pointing (latched until backup is reset).
0 = no, always set to 0 on the primary module.
1 = yes
RID 08 Redundancy ID. Indicates position on the backplane:
0 = left position, 1 = right position
RDEXP 04 Redundant module expected.
0 = no.
1 = yes, always set to 1 on the backup module.
Follows state of function code 90, specification S3 on the primary module.
OCE 02 Online configuration is enabled: 0 = no, 1 = yes.
RDDET 01 Redundant module detected: 0 = no, 1 = yes.
Latched until module is reset or it changes from backup to primary or primary
to backup.

C - 14 WBPEEUI210504C0
Module Status Information - HAC

Table C-5. Byte Description - HAC (continued)

Field Size
Byte Field Description
or Value
11 PA 80 24 VDC logic power input A status: 0 = good, 1 = bad
PB 40 24 VDC logic power input B status: 0 = good, 1 = bad
PS 20 Internal power system non-fatal error: 0 = good, 1 = bad.
Status display on the HAC must be checked for further information on the
cause of the PS flag being set.
SOA 10 Status output alarm: 0 = good; 1 = bad.
Indicates the status of the system +24 volt power and the I/O block’s power
(logic and field power) for a single cabinet.
RNO 08 Redundancy NVM overrun (latched indication):
0 = no.
1 = yes, set to 1 in primary module if NVM checkpoint overruns
have occurred.
NVM checkpoint overruns cause the primary module to reset the backup
module.
NOL 04 Network I/O board offline: 0 = no, 1 = yes.
FDNL 02 Firmware download in progress: 0 = no, 1 = yes
BFM 01 Backup firmware mismatch:
0 = no.
1 = yes, backup has determined the primary firmware revision is different
from its own.
12 NODES3 80 Nodes offline: 0 = no, 1 = yes
RER1 40 Receive errors on loop channel 1: 0 = no, 1 = yes
RER2 20 Receive errors on loop channel 2: 0 = no, 1 = yes
TER1 10 Transmit errors on loop channel 1: 0 = no, 1 = yes
TER2 08 Transmit errors on loop channel 2: 0 = no, 1 = yes
RID1 04 Receiver idle on loop channel 1: 0 = no, 1 = yes
RID2 02 Receiver idle on loop channel 2: 0 = no, 1 = yes
RCF 01 Local Cnet loop communication failure: 0 = no, 1 = yes
14 — FF Module nomenclature: 0x08 = HAC
15 — FF Revision letter (in ASCII code). For example, 0x41 = A
16 — FF Revision number (in ASCII code). For example, 0x30 = 0
NOTES:
1. The error description corresponding to byte 3 is displayed on the front panel LCD display when the module is in ERROR mode.
2. All block numbers are encoded in hexadecimal, with (1) equaling the most significant digits and (2) equaling the least signifi-
cant digits. Example: (1) = 4E, (2) = 20 is block number 20,000.
3. Active only when the controller is in execute mode.

WBPEEUI210504C0 C - 15
WBPEEUI210504C0
Multi-Function Processors Appendix D
(IMMFP11/12)
Memory Utilization and Execution Times
This appendix lists the module memory requirements and exe-
cution times for each available function code for the
IMMFP11/12 multi-function processors. Two quantities are
given for these modules. The first value is the number of bytes
of nonvolatile random access memory (NVRAM). The second
quantity is the number of bytes of random access memory
(RAM). The IMMFP11 has a total configuration memory of
62,656 bytes of NVRAM and 163,248 bytes of RAM. The
IMMFP12 has a total configuration memory of 194,752 bytes
of NVRAM and 347,568 bytes of RAM.

Table D-1 shows the module memory requirements and exe-


cution times for each function code.

NOTES:
1. Except where otherwise noted, execution times are given for worst case
conditions.

2. Refer to Memory Usage Equations in this section for the equations listed
in Table D-1.

Table D-1. Module Memory Utilization and Execution Times

Execution
Function NVRAM
Description RAM Bytes Times
Code Bytes
(in µsecs)
1 Function generator 46 88 38
2 Manual set constant 12 40 17
3 Lead/lag 18 72 193
4 Pulse positioner 24 88 105
5 Pulse rate 16 72 220
6 High/low limiter 16 48 39
7 Square root 12 44 183
8 Rate limiter 18 64 126
9 Analog transfer 20 76 204
10 High select 16 52 49

WBPEEUI210504C0 D-1
Memory Utilization and Execution Times

Table D-1. Module Memory Utilization and Execution Times (continued)

Execution
Function NVRAM
Description RAM Bytes Times
Code Bytes
(in µsecs)
11 Low select 16 52 49
12 High/low compare 16 48 36
13 Integer transfer 14 44 22
14 Four input summer 16 52 72
15 Two input summer 18 52 96
16 Multiply 14 48 84
17 Divide 14 48 104
18 PID error input 34 108 658
19 PID process variable and set point 36 116 752
24 Adapt 12 50 28
25 Analog input (same PCU node) 12 100 38
26 Analog input/loop 12 54 42
30 Analog exception report 26 102 120
31 Test quality 16 52 43
32 Trip 12 36 17
33 Not 12 3 19
34 Memory 14 46 23
35 Timer 14 58 54
36 Qualified OR (eight input) 26 68 60
37 AND (two input) 12 40 20
38 AND (four input) 16 48 27
39 OR (two input) 12 40 20
40 OR (four input) 16 48 27
41 Digital input/bus 12 88 38
42 Digital input/loop 12 42 33
45 Digital exception report 12 66 80
50 Manual set switch 12 36 16
51 Manual set constant (nontunable) 12 40 17
52 Manual set integer 12 36 17
55 Hydraulic servo 60 404 3,552
58 Time delay (analog) 18 Equation 1 141

D-2 WBPEEUI210504C0
Memory Utilization and Execution Times

Table D-1. Module Memory Utilization and Execution Times (continued)

Execution
Function NVRAM
Description RAM Bytes Times
Code Bytes
(in µsecs)
59 Digital transfer 14 44 22
61 Blink 12 48 102
62 Remote control memory 28 96 91
63 Analog input list 28 286 167
64 Digital input list (module bus) 28 190 159
65 Digital sum with gain (four input) 28 68 89
66 Analog trend
Normal mode 12 196 112
Fast mode 12 700 70
68 Remote manual set constant (REMSET) 22 128 75
69 Test alarm 12 44 29
79 Control interface slave
First FC 79 block in segment 48 328 16,302
Additional FC 79 blocks in segment 48 328 2,724
80 Control station 84 366 350
81 Executive block (MFP) 22 140 0
82 Segment control 64 260 0
83 Digital output group 32 90 275
84 Digital input group 16 114 295
85 Up/down counter 24 76 64
86 Elapsed timer 20 84 66
89 Last block 12 40 0
90 Extended executive (MFP) 52 152 0
91 BASIC configuration Equation 2 Equation 3 15
92 Invoke BASIC 22 46 Program
dependent
93 BASIC real output 12 64 15
94 BASIC boolean output 12 72 15
95 Module status monitor 22 108 161
96 Redundant analog input 22 106 105
97 Redundant digital input 14 58 56
98 Slave select 26 84 58
99 Sequence of events log 14 Equation 4 364

WBPEEUI210504C0 D-3
Memory Utilization and Execution Times

Table D-1. Module Memory Utilization and Execution Times (continued)

Execution
Function NVRAM
Description RAM Bytes Times
Code Bytes
(in µsecs)
100 Digital output readback check 40 144 185
101 Exclusive OR 12 40 20
102 Pulse input/period 24 100 372
103 Pulse input/frequency 24 100 449
104 Pulse input/totalization 26 130 612
109 Pulse input/duration 24 100 379
110 Five input rung 24 74 45
111 Ten input rung 38 104 66
112 Twenty input rung 68 164 108
114 BCD input 20 72 300
115 BCD output 22 7 380
116 Jump/master control relay 12 52 17
117 Boolean recipe table 28 68 55
118 Real recipe table 48 102 56
119 Boolean signal multiplexer 32 86 48
120 Real signal multiplexer 32 90 49
121 Analog input/Cnet 22 82 80
122 Digital input/Cnet 20 50 80
123 Device driver 30 118 110
124 Sequence monitor 80 162 45
125 Device monitor 40 102 359
126 Real signal demultiplexer 12 92 122
128 Slave default definition 44 72 15
129 Multistate device driver 60 168 137
132 Analog input/slave 54 340 1,065
133 Smart field device definition 36 144 60
134 Multi-sequence monitor 96 268 48
135 Sequence manager 82 208 192
136 Remote motor control 52 186 136
137 BASIC real output/quality 12 80 15
138 BASIC boolean output/quality 12 64 15

D-4 WBPEEUI210504C0
Memory Utilization and Execution Times

Table D-1. Module Memory Utilization and Execution Times (continued)

Execution
Function NVRAM
Description RAM Bytes Times
Code Bytes
(in µsecs)
139 Passive station interface 44 146 160
140 Restore
Largest NVM utilization Equation 5 88 30,650
(FC 165 with S2 = 249)
Smallest NVM utilization (FC 33) Equation 5 88 635
141 Sequence master 80 142 120
142 Sequence slave 74 104 15
143 Invoke C 28 108 Program
dependent
144 C allocation Equation 6 Equation 7 17
145 Frequency counter/slave 30 120 122
146 Remote I/O interface 68 340 2,917
147 Remote I/O definition 144 480 243
148 Batch sequence 36 Equation 8 Program
dependent
149 Analog output/slave
First FC 149 in segment 82 318 18,494
Second FC 149 in segment 82 318 18,494
(same ASO as first)
Additional FC 149s in segment 82 318 3,071
150 Hydraulic servo slave 32 168 447
151 Text selector 46 152 47
152 Model parameter estimator 28 352 58
153 Inferential smith controller parameter 42 168 284
converter
154 Adaptive parameter scheduler 36 224 128
155 Regression 68 Equation 9 105
156 Advanced PID controller 58 190 900
157 General digital controller 68 Equation 10 138
160 Smith predictor 36 342 530
161 Sequence generator 74 212 78
162 Digital segment buffer 16 78 54
163 Analog segment buffer 16 94 56
165 Moving average 16 Equation 11 240

WBPEEUI210504C0 D-5
Memory Utilization and Execution Times

Table D-1. Module Memory Utilization and Execution Times (continued)

Execution
Function NVRAM
Description RAM Bytes Times
Code Bytes
(in µsecs)
166 Integrator 28 92 168
167 Polynomial
Most complicated 58 104 655
All zero 58 104 193
168 Interpolator 98 196 488
169 Matrix addition 44 172 230
170 Matrix multiplication 44 172 1,800
171 Trigonometric
Sine 14 48 510
Secant 14 48 555
172 Exponential 12 44 400
173 Power 14 48 850
174 Logarithm 14 50 480
177 Data acquisition analog 104 398 384
178 Data acquisition analog input/loop 20 134 118
179 Enhanced trend
Normal sampling 52 Equation 12 360
Normal and statistical sampling 52 Equation 12 734
184 Factory instrumentation protocol handler 42 1,342 5,222
185 Digital input subscriber 32 220 262
186 Analog input subscriber 32 252 1,009
187 Analog output subscriber 48 232 1,790
188 Digital output subscriber 48 208 241
190 User defined function declaration 30 Equation 13 16
191 User defined function one 56 Equation 14 Program
dependent
192 User defined function two 70 Equation 15 Program
dependent
193 User defined data import 48 Equation 16 100
194 User defined data export 48 Equation 17 175
198 Auxiliary real user defined function 38 150 16
199 Auxiliary digital user defined function 38 134 16
210 Sequence of events slave 100 572 1,320
211 Data acquisition digital 62 310 448

D-6 WBPEEUI210504C0
Memory Usage Equations

Table D-1. Module Memory Utilization and Execution Times (continued)

Execution
Function NVRAM
Description RAM Bytes Times
Code Bytes
(in µsecs)
212 Data acquisition digital input/loop 20 110 70
215 Enhanced analog slave definition 30 206 1,670
216 Enhanced analog input definition 42 114 584
217 Enhanced calibration command 24 178 33
219 Common sequence 46 Equation 18 Program
dependent
220 Batch historian 46 Equation 19 Program
dependent
241 DSOE data interface SEM to MFP
No SED resynch function performed 18 284 360
SED resynch performed once every 18 284 900
second
242 DSOE digital event interface
No data available on SED I/O module 84 338 300
Data available on SED I/O module 84 338 1,600

Memory Usage Equations


1. 78 + [8 x (S5)]

2. 38 + [1024 x (S5)]

3. 4994 + 1024 [(S3) + (S4) + (S5)]

4. 96 + [9 x (S2)]

5. Refer to function code 140, module memory utilization

6. 12 + [1024 x (S2)]

7. 36 + [1024 x (S1)]

8. 826 + [1024 x (S11)] + [2048 x (S12)]

9. 338 + [40 x (S7)]

10. 228 + [8 x (S21 + S22)]

11. 98 + [8 x (S2)]

12. a + [b x (S4)] + [c x (n{S3})],

WBPEEUI210504C0 D-7
Function Blocks - IMMFP11/12

where

n{S3} = Number of modes selected by S3


if S2 = 0 or 3, then a = 396, b = 24, and c = 16
if S2 = 1, 2, 5, 6, 7 or 9, then a = 380, b = 20, and c = 8
if S2 = 4 or 8, then a = 456, b = 50, and c = 64

13. 74 + [10 x (S2)]

14. 520 + [2 x (S16)]

15. 256 + [3 x (S5)]

16. 604 + [2 x (S24)]

17. 256 + [5 x (S4)]

18. 424 + [222 x (S13)]

19. 666 + [2 x (S11)]

Function Blocks - IMMFP11/12


Table D-2 contains function code block number information
for the IMMFP11/12.

Table D-2. Function Blocks for the IMMFP11/12 Multi-Function Processors

Block No. Definition Function Code


0 Logic 0 81
1 Logic 1
2 0 or 0.0
3 -100.0
4 -1.0
5 0.0
6 1.0
7 100.0
8 -9.2 E18
9 9.2 E18
10 Start-up flag (0 = no, 1 = yes)
11 Memory display value
12 System free time in percent

D-8 WBPEEUI210504C0
Module Status Information - IMMFP11/12

Table D-2. Function Blocks for the IMMFP11/12 Multi-Function Processors

Block No. Definition Function Code


13 Revision level 81
14 Reserved
15 Task 1 elapsed time since previous cycle 82
16 Task 1 elapsed time current cycle (sec/min)
17 Task 1 processor utilization
18 Task 1 check point overrun count
19 Task 1 cycle time overrun (sec/min)
20 Hours, time of day 90
21 Minutes, time of day
22 Seconds, time of day
23 No time synchronization flag:
0 = time of day invalid
1 = time of day valid
24 Year (0 to 99)
25 Month (1 to 12)
26 Day (1 to 31)
27 Day of week (1 to 7, Sunday = 1)
28 Reserved
29 Reserved
1
30 Configurable blocks Note 2
Note 3 Loop type: 89
0.0 = Plant Loop
1.0 = Cnet
3.0 = Cnet with time-stamping
NOTES:
1. The highest configurable block number is 9998 for IMMFP11/12.
2. Any allowed function code - refer to Table D-1.
3. The Block number is 9998 for IMMFP11/12.

Module Status Information - IMMFP11/12


Table D-3 and D-4 explain IMMFP11/12 Multi-Function Pro-
cessor module status bytes.

WBPEEUI210504C0 D-9
Module Status Information - IMMFP11/12

Table D-3. Bit Description - IMMFP11/12

Bit
Byte
7 6 5 4 3 2 1 0
1 ES MODE TYPE
2 FTX BAC RIO LIO CFG NVF NVI DSS
3 Error code
4 Error code descriptor (1)
5 Error code descriptor (2)
6 ETYPE
7 CWA CWB Reserved Reserved Reserved Reserved Reserved Reserved
8 SIME SIMR SIMT Reserved
9 Reserved Reserved Reserved
10 PRI CFC Reserved CHK RID RDEXP OCE RDDET
11 Reserved Reserved Reserved Reserved RNO Reserved Reserved Reserved
12-13 Reserved
14 Module nomenclature
15 Revision letter (ASCII)
16 Revision number (ASCII)

Table D-4. Byte Description - IMMFP11/12

Field Size or
Byte Field Description
Value
1 ES 80 Error summary: 0 = good, 1 = errors
MODE 60 Module mode: 00 = configure, 10 = error, 11 = execute
TYPE 1F Module type code: (15)16 = Enhanced status
2 FTX 80 First time in execute: 0 = no, 1 = yes
BAC 40 Backup status: 0 = good, 1 = bad
RIO 20 Summary remote input status: 0 = good, 1 = bad
LIO 10 Summary local input status: 0 = good, 1 = bad
CFG 08 On-line configuration changes being made
NVF 04 Summary NVRAM failure status: 0 = good, 1 = fail
NVI 02 Summary NVRAM initialized state: 0 = no, 1 = yes
DSS 01 Digital station status: 0 = good, 1 = bad
3-5 Error Code 3 4 5
Note 1 NVRAM error:
01 01 — Write failure
02 — Checksum failure
03 — Bad data
FF — Reset during write

D - 10 WBPEEUI210504C0
Module Status Information - IMMFP11/12

Table D-4. Byte Description - IMMFP11/12 (continued)

Field Size or
Byte Field Description
Value
3-5 Error Code 3 4 5
Note 1 02 (1) (2) Analog input reference error:
(cont)
(1), (2) = block number of control interface I/O module block
03 (1) (2) Missing I/O module or expander board:
(1), (2) = block number of I/O module or station
05 (1)( 2) Configuration error – undefined block:
(1), (2) = block number making reference
06 (1) (2) Configuration error – input data type is incorrect:
(1), (2) = block number making reference
08 (1) (2) Trip block activated:
(1), (2) = block number of trip block
09 — — Segment violation - priority set the same in two segments, or
more than eight segments defined.
0F — — Primary module has failed and the redundant module configura-
tion is not current
10 — — Primary module has failed and the dynamic RAM data in the
redundant module is not current
11 — — NVRAM write failure error
20 — — Program format error - inconsistent format table
21 (1) (2) File system error:
(1), (2) = file number
22 (1) (2) Invoke C error:
(1), (2) = block number making reference
24 (1) (2) C program stack overflow:
(1), (2) = block number making reference
28 (1) (2) User defined function (UDF) reference is invalid:
(1), (2) = block number making reference
29 (1) (2) UDF block cannot read program file:
(1), (2) = block number making reference
2A (1) (2) Not enough memory for UDF:
(1), (2) = block number making reference
2B (1) (2) Missing UDF declaration:
(1), (2) = block number making reference
2C (1) (2) Wrong UDF type:
(1), (2) = block number making reference
2D (1) (2) Missing UDF auxiliary block:
(1), (2) = block number making reference
2E (1) (2) UDF compiler and firmware are incompatible:
(1), (2) = block number making reference

WBPEEUI210504C0 D - 11
Module Status Information - IMMFP11/12

Table D-4. Byte Description - IMMFP11/12 (continued)

Field Size or
Byte Field Description
Value
3-5 Error Code 3 4 5
(cont)
2F (1) (2) BASIC program error:
(1), (2) = line number of error
6 ETYPE 1F Enhanced module type = (24)16 = IMMFP11/12
7 CWA 80 Controlway bus A failure: 0 = good, 1 = fail
CWB 40 Controlway bus B failure: 0 = good, 1 = fail
8 SIME 80 Simulation enabled: 0 = normal operation, 1 = simulation active
SIMR 40 Simulation running/frozen: 0 = simulation frozen, 1= simulation
running
SIMT 20 Simulation time rate: 0 = real time, 1 = slow/fast time
10 PRI 80 Module is primary versus backup; set to 1 in the primary module.
CFC 40 Configuration current (latched until backup is reset). Set when
LED 7 is enabled (1 = on or blinking) on the backup module.
CHK 10 Backup has completed checkpointing (latched until backup is
reset). Always set to 0 on the primary module. Follows LED 8
(1 = on or blinking) on the backup module.
RID 08 Redundancy ID. Follows setting of redundancy ID pole on the
dipswitch.
RDEXP 04 Redundancy expected. Always set to 1 on the backup module.
Follows state of function code 90, specification S3, ones digit on
the primary module.
OCE 02 On-line configuration is enabled. Follows setting of on-line config-
uration enable pole on dipswitch.
RDDET 01 Redundancy detected (latched until module is reset or it changes
from backup to primary or primary to backup). Set to 1 when a
properly configured redundant module is detected.
11 RNO 08 Redundancy NVM overrun (latched indication). Set to 1 in pri-
mary module if NVM checkpoint overruns have occurred. NVM
checkpoint overruns cause the primary module to reset the
backup module.
12-13 — 00 Reserved
14 — FF Module nomenclature: (01)16 = IMMFP11, (02)16 = IMMFP12
15 — FF Revision letter (in ASCII code), for example, (46)16 = F, (47)16 = G
16 — FF Revision number (in ASCII code), for example, (30)16 = 0
NOTE:
1. Byte 3 is displayed on the front panel LEDs when the module is in ERROR mode.

D - 12 WBPEEUI210504C0
Sequence of Events Monitor Appendix E
(INSEM01)
Memory Utilization
This appendix lists the module memory requirements for each
available function code for the INSEM01 Cnet to computer
communications and sequence of events monitor. Two quanti-
ties are given for the module. The first value is the number of
bytes of nonvolatile random access memory (NVRAM). The sec-
ond quantity is the number of bytes of random access memory
(RAM).

Table E-1 lists the configuration memory available the module.


Table E-2 shows the module memory requirements for each
function code. Tables E-3 and E-4 explain module status.

Table E-1. Available Module Configuration Memory

NVRAM
Module RAM Bytes
Bytes
INSEM01 65,536 262,144

Table E-2. Module Memory Utilization for Function Codes

Function NVRAM RAM


Description
Code Bytes Bytes
243 Executive block (INSEM01) 24 50
244 Addressing interface definition 20 50
245 Input channel interface 28 52
246 Trigger definition 72 92

Module Status Information


Table E-3. Bit Description - INSEM01

Bit
Byte
7 6 5 4 3 2 1 0
1 ES MODE TYPE
2 FTX RIO LIO CFM ERM
3 CSP MOV LOP SDF NODE TYPE

WBPEEUI210504C0 E-1
Module Status Information

Table E-3. Bit Description - INSEM01 (continued)

Bit
Byte
7 6 5 4 3 2 1 0
4 NSF LR1 LR2 LT1 LT2 RI1 RI2 RCF
5 HOST
6 ETYPE
7-8 Reserved
9 NDT1 NDT2 NCD1 NCD2
10 - 13 Reserved
14 Module nomenclature
15 Revision letter (ASCII)
16 Revision number (ASCII)

Table E-4. Byte Description - INSEM01

Field Size
Byte Field Description
or Value
1 ES 80 Error summary: 0 = good, 1 = errors
MODE 60 Module mode: 00 = configure, 01 = fail, 10 = error, 11 = exe-
cute
TYPE 1F Module type code: (15)16 = enhanced status
2 FTX 80 First time in execute: 0 = no, 1 = yes
RIO 20 Summary remote input status: 0 = good, 1 = bad
LIO 10 Summary local input status: 0 = good, 1 = bad
CFM 08 Module in configure mode (MODE = 00): 0 = no, 1 = yes
ERM 01 Module in error mode (MODE = 10): 0 = no, 1 = yes
3 CSP 80 Communication status problem: 0 = no, 1 = yes
MOV 40 Memory overflow: 0 = good, 1 = bad
LOP 10 Off-line bridge for remote loop: 0 = no, 1 = yes
SDF 01 Security device failure
NODE 07 Node type: 0 = computer interface, 1 = operator interface unit
TYPE or management command system, 2 = operator interface unit

E-2 WBPEEUI210504C0
Module Status Information

Table E-4. Byte Description - INSEM01 (continued)

Field Size
Byte Field Description
or Value
4 NSF 80 Node environment status flag: 0 = good, 1 = bad
LR1 40 Cnet 1 receive error: 0 = no, 1 = yes
LR2 20 Cnet 2 receive error: 0 = no, 1 = yes
LT1 10 Cnet 1 transmit error: 0 = no, 1 = yes
LT2 08 Cnet 2 transmit error: 0 = no, 1 = yes
RI1 04 Receiver idle on channel 1 of central loop: 0 = no, 1 = yes
RI2 02 Receiver idle on channel 2 of central loop: 0 = no, 1 = yes
RCF 01 Ring communication failure: 0 = no, 1 = yes
5 HOST FF Value set by the computer (when non-zero, ES = 1)
6 ETYPE 20 Enhanced module type (2A)16 = INSEM01
7-8 — 00 Reserved
9 NDT1 01 NIS loop relay drive transistor 1 failure
NDT2 01 NIS loop relay drive transistor 2 failure
NCD1 01 NIS receive channel 1 disable
NCD2 01 NIS receive channel 2 disable
10 - 13 — — Reserved
14 — FF Module nomenclature (01)16 = INSEM01
15 — FF Revision letter (in ASCII code), for example, (45)16 = E
16 — FF Revision number (in ASCII code), for example, (30)16 = 0

WBPEEUI210504C0 E-3
WBPEEUI210504C0
Communication Modules Appendix F

Introduction
This appendix describes the status bytes and their descrip-
tions for the following communication modules:

• INICT03 Cnet to Computer Transfer Module.


• INICT12 Cnet to Computer Transfer Module.
• INIIT03 Local Transfer Module.
• INNPM11 Network Processing Module.
• INNPM12 Network Processing Module.

INICT03 and INICT12 Cnet to Computer Transfer Modules


Table F-1 lists the fields that make up the INICT03 and
INICT12 module status report. Table F-2 describes each field
within the module status record.

Table F-1. INICT03 and INICT12 Status Bytes

Bit
Byte
7 6 5 4 3 2 1 0
1 ES MODE TYPE
2 FTX RIO LIO CFM ERM
3 PCUs MOV RINGs SDF NODE TYPE
(CSP) (LOP)
4 NSF RER1 RER2 TER1 TER2 RI1 RI2 RCF
(LR1) (LR2) (LT1) (LT2)
5 HOST
6 ETYPE
7-8 Reserved
9 NDT1 NDT2 NCD1 NCD2
10 - 12 Reserved
13 Module type
14 Module nomenclature
15 Revision letter (ASCII)
16 Revision number (ASCII)

WBPEEUI210504C0 F-1
INICT03 and INICT12 Cnet to Computer Transfer Modules

Table F-2. INICT03 and INICT12 Status Bits

Field Size
Byte Field Description
or Value
1 ES 80 Error summary: 0 = good, 1 = errors
MODE 60 Module mode: 00 = configure, 01 = fail, 10 = error, 11 = execute
TYPE 1F Module type code: (15)16 = enhanced status
2 FTX 80 First time in execute: 0 = no, 1 = yes
RIO 20 Summary remote input status: 0 = good, 1 = bad
LIO 10 Summary local input status: 0 = good, 1 = bad
CFM 08 Module in configure mode (MODE = 00): 0 = no, 1 = yes
ERM 01 Module in error mode (MODE = 10): 0 = no, 1 = yes
3 PCUs 80 Communication status problem: 0 = no, 1 = yes
(CSP)
MOV 40 Memory overflow: 0 = good, 1 = bad
RINGs 10 Offline bridge for remote loop: 0 = no, 1 = yes
(LOP)
SDF 01 Security device failure
NODE 07 Node type: 0 = computer interface, 1 = operator interface unit or
TYPE management command system, 2 = operator interface unit
4 NSF 80 Node environment status flag: 0 = good, 1 = bad
RER1 40 Cnet 1 receive error: 0 = no, 1 = yes
(LR1)
RER2 20 Cnet 2 receive error: 0 = no, 1 = yes
(LR2)
TER1 10 Cnet 1 transmit error: 0 = no, 1 = yes
(LT1)
TER2 08 Cnet 2 transmit error: 0 = no, 1 = yes
(LT2)
RI1 04 Receiver idle on channel 1: 0 = no, 1 = yes
RI2 02 Receiver idle on channel 2: 0 = no, 1 = yes
RCF 01 Ring communication failure: 0 = no, 1 = yes
5 HOST FF Value set by the computer (when non-zero, ES = 1)
6 ETYPE 20 Enhanced module type (20)16 = INICT12 or INICT03
7-8 — 00 Reserved

F-2 WBPEEUI210504C0
INIIT03 Local Transfer Module

Table F-2. INICT03 and INICT12 Status Bits (continued)

Field Size
Byte Field Description
or Value
9 NDT1 01 NIS loop relay drive transistor 1 failure
NDT2 01 NIS loop relay drive transistor 2 failure
NCD1 01 NIS receive channel 1 disable
NCD2 01 NIS receive channel 2 disable
10 - 12 — — Reserved
13 — FF Module type: 1=SSM, 2=MCP
14 — FF Module nomenclature: (0C)16 = INICT12, (03)16 = INICT03
15 — FF Revision letter (in ASCII code). For example, (45)16 = E
16 — FF Revision number (in ASCII code). For example, (30)16 = 0

INIIT03 Local Transfer Module


Table F-3 lists the fields that make up the INIIT03 module sta-
tus report. Table F-4 describes each field within the module
status record.

Table F-3. INIIT03 Status Bytes

Bit
Byte
7 6 5 4 3 2 1 0
1 ES MODE TYPE
2 SIO CIO NVI
3 PCUs MOV NODS BKCFG BKSTS RINGs PSI
41 NSFC RER1C RER2C TER1C TER2C RID1C RID2C RCFC
51 NSFS RER1S RER2S TER1S TER2S RID1S RID2S RCFS
6 ETYPE
7 - 13 Reserved
14 Module nomenclature
15 Revision letter (ASCII)
16 Revision number (ASCII)
NOTE: 1. The last letter of the codes (S or C) in bytes 4 and 5 indicates if the status applies to the satellite ring or the central ring.

WBPEEUI210504C0 F-3
INIIT03 Local Transfer Module

Table F-4. INIIT03 Status Bits

Field
Byte Field Size or Description
Value
1 ES 80 Error summary: 0 = good, 1 = errors
MODE 60 Module mode: 01 = fail, 11 = execute
TYPE 1F Module type code: (15)16 = INIIT03
2 SIO 20 I/O status for data sourced by satellite ring PCUs:
0 = good, 1 = bad
CIO 10 I/O status for data sourced by central ring PCUs:
0 = good, 1 = bad
NVI 02 Default configuration: 0 = blocks configured, 1 = no blocks
configured (INIPT01 only)
3 PCUs 80 Nodes off-line: 0 = no, 1 = yes
MOV 40 Memory overflow: 0 = no, 1 = yes
BKCFG 10 Redundant configuration: 0 = no, 1 = yes
BKSTS 08 Secondary failed: 0 = no, 1 = yes
RINGs 04 Rings off-line: 0 = on-line, 1 = off-line bridge for remote rings
PSI 01 Primary/secondary indicator: 0 = primary, 1 = secondary
4 - 51 NSF 80 Node environment status flag: 0 = good, 1 = bad
RER1 40 Receive errors on channel 1: 0 = no, 1 = yes
RER2 20 Receive errors on channel 2: 0 = no, 1 = yes
TER1 10 Transmit errors on channel 1: 0 = good, 1 = errors
TER2 08 Transmit errors on channel 2: 0 = good, 1 = errors
RID1 04 Receiver idle of channel 1: 0 = no, 1 = yes
RID2 02 Receiver idle of channel 2: 0 = no, 1 = yes
RCF 01 Ring communication failure (INIIT03 only)
6 ETYPE FF Extended module type: (23)16 = INIIT03
7 - 13 — 00 Reserved
14 — FF Module nomenclature: (03)16 = INIIT03
15 — FF Revision letter (in ASCII code), for example, (42)16 = B
16 — FF Revision number (in ASCII code), for example, (31)16 = 1
NOTE:
1. The last letter of the codes (S or C) in bytes 4 and 5 indicates if the status applies to the satellite ring or the central ring.

F-4 WBPEEUI210504C0
INNPM11 and INNPM12 Network Processing Modules

INNPM11 and INNPM12 Network Processing Modules


The INNPM12 presents two different status summaries
depending on its mode of operation (i.e., Cnet or Plant Loop
mode) set with switch SW3. (The INNPM11 operates only in the
Cnet mode.) The INNPM12 module in Cnet mode and the
INNPM11 module have 16-byte module status records. When
in Plant Loop mode, the INNPM12 module has a five-byte mod-
ule status record.

Cnet Mode
Table F-5 lists the fields that make up the status report for the
INNPM12 module in Cnet mode and the INNPM11 module.
Table F-6 describes each field within the module status record.

Table F-5. INNPM12 (Cnet Mode) and INNPM11 Status Bytes

Bit
Byte
7 6 5 4 3 2 1 0
1 ES MODE TYPE
2 Reserved
3 CSP MOV BKCFG BKSTS PSI
4 NSF LR1 LR2 LT1 LT2 RI1 RI2 RCF
5 Reserved
6 ETYPE
7 CWA CWB
8 Reserved
9 NDT1 NDT2 NCD1 NCD2
10 - 13 Reserved
14 Module nomenclature
15 Revision letter (ASCII)
16 Revision number (ASCII)

Table F-6. INNPM12 (Cnet Mode) and INNPM11 Status Bits

Field Size
Byte Field Description
or Value
1 ES 80 Error summary: 0 = good, 1 = errors.
MODE 60 Module mode: 10 = error, 11 = execute.
TYPE 1F Module type: 0x15 = enhanced status (ETYPE).

WBPEEUI210504C0 F-5
INNPM11 and INNPM12 Network Processing Modules

Table F-6. INNPM12 (Cnet Mode) and INNPM11 Status Bits (continued)

Field Size
Byte Field Description
or Value
2 — 00 Reserved
3 CSP 80 Communication status problem: 0 = no, 1 = yes
MOV 40 Memory overflow: 0 = good, 1 = bad
BKCFG 10 Redundant configuration: 0 = no, 1 = yes
BKSTS 08 Backup failed: 0 = no, 1 = yes
PSI 00 Primary/backup indicator: 0 = primary, 1 = backup
4 NSF 80 Node environment status flag: 0 = good, 1 = bad
LR1 40 Cnet 1 receive error: 0 = no, 1 = yes
LR2 20 Cnet 2 receive error: 0 = no, 1 = yes
LT1 10 Cnet 1 transmit error: 0 = no, 1 = yes
LT2 08 Cnet 2 transmit error: 0 = no, 1 = yes
RI1 04 Receiver idle on channel 1: 0 = no, 1 = yes
RI2 02 Receiver idle on channel 2: 0 = no, 1 = yes
RCF 01 Loop communication failure: 0 = no, 1 = yes
5 — 00 Reserved
6 ETYPE 20 Enhanced module type: 0x25 = INNPM12 or INNPM11
7 CWA 80 Controlway channel A failure: 0 = no, 1 = yes
CWB 40 Controlway channel B failure: 0 = no, 1 = yes
8 — 00 Reserved
9 NDT1 80 NIS loop relay drive transistor 1 failure: 0 = no, 1 = yes
NDT2 40 NIS loop relay drive transistor 2 failure: 0 = no, 1 = yes
NCD1 08 NIS receive channel 1 disable: 0 = no, 1 = yes
NCD2 04 NIS receive channel 2 disable: 0 = no, 1 = yes
10 - 13 — — Reserved
14 — FF Module nomenclature: 0x01 = INNPM12 or INNPM11
15 — FF Revision letter (in ASCII code). For example, 0x41 = A
16 — FF Revision number (in ASCII code). For example, 0x30 = 0

Plant Loop Mode


Table F-7 lists the fields that make up the INNPM12 module
status report when in Plant Loop mode. Table F-8 describes
each field within the module status record.

F-6 WBPEEUI210504C0
INNPM11 and INNPM12 Network Processing Modules

Table F-7. INNPM12 Status Bytes (Plant Loop Mode)

Bit
Byte
7 6 5 4 3 2 1 0
1 ES MODE TYPE
2 Reserved
3 CSP MOV NSF BKCFG BKSTS PSI
4 LR1 LR2 LT1 LT2
5 Reserved

Table F-8. INNPM12 Status Bits (Plant Loop Mode)

Field Size
Byte Field Description
or Value
1 ES 80 Error summary: 0 = good, 1 = errors
MODE 60 Module mode: 10 = error, 11 = execute
TYPE 1F Module type: 0x08 = INNPM12 (Plant Loop mode)
2 — 00 Reserved
3 CSP 80 Communication status problem: 0 = no, 1 = yes
MOV 40 Memory overflow: 0 = good, 1 = bad
NSF 20 Node environment status flag: 0 = good, 1 = bad
BKCFG 10 Redundant configuration: 0 = no, 1 = yes
BKSTS 08 Backup failed: 0 = no, 1 = yes
PSI 01 Primary/backup indicator: 0 = primary, 1 = backup
4 LR1 40 Plant Loop 1 receive error: 0 = no, 1 = yes
LR2 20 Plant Loop 2 receive error; 0 = no, 1 = yes
LT1 10 Plant Loop 1 transmit error: 0 = no, 1 = yes
LT2 08 Plant Loop 2 transmit error: 0 = no, 1 = yes
5 — 00 Reserved

WBPEEUI210504C0 F-7
WBPEEUI210504C0
Point Quality Definition
Appendix G

General Description
This appendix defines the point quality flag states for analog I/
O, digital I/O, and module bus I/O.

NOTE: The control module can be configured to trip or continue operation


upon the loss of an I/O module.

Individual Analog Inputs


Each analog input is compared to a low value of -0.75 VDC
and a high value of 5.25 VDC. If the input goes outside either
limit, the value is held to the limit and the point quality flag
indicates bad.

Group Analog Inputs


If an I/O module is not connected, all points in the group will
have their point quality flag set to bad.

Group Analog Outputs


All outputs are read back by feedback input circuitry. If the
feedback voltage signal does not match the requested software
output value, the point quality is set to bad for that output.

Digital I/O
If the I/O definition block is configured to use an I/O module,
but the I/O module is not installed, the point quality flag for
the associated module I/O group will be set to bad, and the
control module generates a problem report.

WBPEEUI210504C0 G-1
Peer-to-Peer and Module Bus I/O

Peer-to-Peer and Module Bus I/O


If input data cannot be read for a period of 2.0 seconds (S2 of
FC 90 = 0.250 sec.), the flag will be set to bad. A new attempt
will be made to read the data at least every 20 seconds.

NOTE: After the point quality flag is set to indicate bad quality, the receiving
module retains and uses the last good value that was obtained.

The Harmony controllers utilize a configurable retry period for


determining bad quality. The base retry period is configured in
the extended executive (function code 90) base periodic sample
I/O period S2. This specification (S2) also determines the time
resolution for all periodic sample I/O pole periods configured
in the module. This includes the segment control (function
code 82) periodic sample I/O period S13. All periodic sample I/
O periods should be configured in multiples of function code
90, S2. To determine the typical time required to mark a peri-
odic sample I/O point bad, multiply function code 90, S2 by
eight.
Example: function code 90, S2 = 0.250 sec.

0.250 sec. × 8.000 = 2.000 sec.

A point will not continue to retry at the function code 90, S2


period after being marked bad. The bad point retry is only per-
formed once every 20 seconds.

G-2 WBPEEUI210504C0
Console Engineering Unit
Descriptions Appendix H

Engineering Unit Descriptions Tables

Table H-1. Human System Interface (Conductor VMS/NT)

Code Description Code Description


0 and 1 Blank 9 CFS
2 % 10 CFM
3 DEG F 11 LB/HR
4 DEG C 12 GAL
5 PSIA 13 AMPS
6 PSIG 14 IN HG
7 IN H2O 15 KLB/HR
8 GMP 16 - 255 Configurable

WBPEEUI210504C0 H-1
WBPEEUI210504C0
WBPEEUI210504C1_V2 Litho in U.S.A. Aug 2003
Copyright © 2003 by ABB. All Rights Reserved
® Registered Trademark of ABB.
™ Trademark of ABB.

http://www.abb.com/control

Automation Technology Products Automation Technology Products Automation Technology Products


Wickliffe, Ohio, USA Västerås, Sweden Mannheim, Germany
www.abb.com/processautomation www.abb.com/processautomation www.abb.de/processautomation
email: industrialitsolutions@us.abb.com email: processautomation@se.abb.com email: marketing.control-products@de.abb.com

You might also like