Download as pdf or txt
Download as pdf or txt
You are on page 1of 272

Logic Functions Data Base Reference

BOOK 1:
System, I/O and Communications Functions for
2001P - MODCELL™ Logic Control Identity Module (Version 6)
2004P - MODCELL™ Advanced Control Identity Module (Version 3)
1800P - MOD 30ML™ Identity Module (Version 2)
MicroMod Automation, Inc.

The Company

MicroMod Automation is dedicated to improving customer efficiency by providing the most cost-effective, application-specific process
solutions available. We are a highly responsive, application-focused company with years of expertise in control systems design and
implementation.

We are committed to teamwork, high quality manufacturing, advanced technology and unrivaled service and support.

The quality, accuracy and performance of the Company's products result from over 100 years experience, combined with a continuous
program of innovative design and development to incorporate the latest technology.
Use of Instructions
Ì Warning. An instruction that draws attention to the risk of  Note. Clarification of an instruction or additional
injury or death. information.

q Caution. An instruction that draws attention to the risk of i Information. Further reference for more detailed
the product, process or surroundings. information or technical details.

Although Warning hazards are related to personal injury, and Caution hazards are associated with equipment or property damage, it
must be understood that operation of damaged equipment could, under certain operational conditions, result in degraded process
system performance leading to personal injury or death. Therefore, comply fully with all Warning and Caution notices.

Information in this manual is intended only to assist our customers in the efficient operation of our equipment. Use of this manual for
any other purpose is specifically prohibited and its contents are not to be reproduced in full or part without prior approval of MicroMod
Automation, Inc.

Licensing, Trademarks and Copyrights


MOD 30 and MOD 30ML are trademarks of MicroMod Automation, Inc.
MODBUS is a trademark of Modicon Inc.

Health and Safety


To ensure that our products are safe and without risk to health, the following points must be noted:

The relevant sections of these instructions must be read carefully before proceeding.
1. Warning Labels on containers and packages must be observed.
2. Installation, operation, maintenance and servicing must only be carried out by suitably trained personnel and in accordance with the information
given or injury or death could result.
3. Normal safety procedures must be taken to avoid the possibility of an accident occurring when operating in conditions of high
4. pressure and/or temperature.
5. Chemicals must be stored away from heat, protected from temperature extremes and powders kept dry. Normal safe handling procedures must be
used.
6. When disposing of chemicals, ensure that no two chemicals are mixed.

Safety advice concerning the use of the equipment described in this manual may be obtained from the Company address on the back
cover, together with servicing and spares information.

All software, including design, appearance, algorithms and source


codes, is copyrighted by MicroMod Automation, inc. and is owned by
MicroMod Automation or its suppliers.
Logic Functions - Book 1

CONTENTS

CONTENTS
Page
SECTION 1 - INTRODUCTION
1.1 GENERAL .......................................................................................................................................... 1-1
1.2 OVERVIEW OF INSTRUMENT SOFTWARE.................................................................................... 1-1
1.3 DATA BASE CONFIGURATION AND RUNTIME SUPPORT ........................................................... 1-1
1.4 RELATED DOCUMENTATION.......................................................................................................... 1-1
1.5 VERSION IDENTIFICATION ............................................................................................................. 1-2

SECTION 2 - DATABASE DESCRIPTION


2.1 GENERAL .......................................................................................................................................... 2-1
2.2 DATABASE STRUCTURE OVERVIEW ............................................................................................ 2-1
2.2.1 Blocks.......................................................................................................................................... 2-1
2.2.2 Loops .......................................................................................................................................... 2-3
2.2.3 Groups ........................................................................................................................................ 2-4
2.3 GLOBAL FEATURES......................................................................................................................... 2-4
2.3.1 Initial Data Values ....................................................................................................................... 2-4
2.3.2 Data Quality ................................................................................................................................ 2-5
2.3.3 Logical Source Pointer (LSP)...................................................................................................... 2-5
2.3.4 Data Types.................................................................................................................................. 2-6
2.4 GENERAL INSTRUMENT OPERATION ........................................................................................... 2-8
2.4.1 State Changes ............................................................................................................................ 2-8
2.4.2 Startup ...................................................................................................................................... 2-10
2.4.3 I/O Lock..................................................................................................................................... 2-10
2.4.4 LEDs ......................................................................................................................................... 2-11
2.4.5 Control contention..................................................................................................................... 2-11
2.5 SECURITY AND INTEGRITY FEATURES ...................................................................................... 2-11
2.5.1 End of configuration Checks ..................................................................................................... 2-11
2.5.2 Checksumming ......................................................................................................................... 2-11
2.5.3 Backup Memory ........................................................................................................................ 2-12
2.5.4 Power Fail Detection and Recovery.......................................................................................... 2-13
2.5.5 Numerical Error Handling.......................................................................................................... 2-13
2.6 DATABASE REFERENCE CONVENTIONS ................................................................................... 2-14

SECTION 3 - SYSTEM DATABASE PARAMETERS


3.1 SYSTEM BLOCKS ............................................................................................................................. 3-3
3.2 SPECIAL BLOCKS............................................................................................................................. 3-3
3.3 INTERFACE BLOCK (IF1) ................................................................................................................. 3-3
3.3.1 Interface Block Operation ........................................................................................................... 3-5
3.3.2 Interface Block Parameters......................................................................................................... 3-5
3.3.3 Interface Block Events .............................................................................................................. 3-27
3.4 SYSTEM EVENT BLOCK (SE1) ...................................................................................................... 3-29
3.4.1 System Event Block Operation ................................................................................................. 3-31
3.4.2 System Event Block Parameters............................................................................................... 3-32
3.4.3 Typical Block Connections for System Event Block .................................................................. 3-41
3.4.4 System Event Block Events ...................................................................................................... 3-41
3.4.5 Event Transitions ...................................................................................................................... 3-42
3.5 LOOP BLOCK (LP) .......................................................................................................................... 3-43
3.5.1 Loop Block Operation ............................................................................................................... 3-45
3.5.2 Loop Block Parameters............................................................................................................. 3-45
3.5.3 Typical Block Connections for Loop Block ................................................................................ 3-48
3.5.4 Loop Block Events .................................................................................................................... 3-48

i
Logic Functions - Book 1

CONTENTS

CONTENTS (Cont’d)
Page
3.6 CONFIGURED LIST BLOCK (CL)................................................................................................... 3-49
3.6.1 Configured List Block Operation............................................................................................... 3-49
3.6.2 Configured List Block Parameters ............................................................................................ 3-50
3.6.3 Typical Block Connections for Configured List Block ............................................................... 3-52
3.7 MODBUS LIST BLOCK (ML)........................................................................................................... 3-53
3.7.1 Modbus List Block Operation.................................................................................................... 3-54
3.7.2 Modbus List Block Parameters................................................................................................. 3-55
3.7.3 Typical Block Connections for Modbus List Block .................................................................... 3-56

SECTION 4 - COMMUNICATION MODULE DATABASE PARAMETERS


4.1 COMMUNICATION BLOCKS ............................................................................................................ 4-1
4.2 ICN COMMUNICATION BLOCK (ICN) ............................................................................................. 4-3
4.2.1 ICN Communication Block Capabilities ...................................................................................... 4-6
4.2.2 ICN Communication Block Parameters ...................................................................................... 4-6
4.2.3 Typical Block Connections for ICN Communication Block ....................................................... 4-16
4.2.4 ICN Communication Block Events............................................................................................ 4-16
4.3 MODCELL SERIAL COMMUNICATION BLOCK (MSC)................................................................. 4-17
4.3.1 Modcell Serial Communication Block Modbus Slave Capabilities ............................................ 4-20
4.3.2 Modcell Serial Communication Block Parameters.................................................................... 4-22
4.3.3 Typical Block Connections for Modcell Communication Block ................................................. 4-35
4.3.4 Modcell Serial Communication Block Events ........................................................................... 4-35
4.3.5 Using the Modcell Serial Communication Block ....................................................................... 4-36

SECTION 5 - INPUT/OUTPUT MODULE DATABASE PARAMETERS


5.1 INPUT/OUTPUT BLOCKS................................................................................................................. 5-1
5.2 DIGITAL INPUT MODULE BLOCK (DIM) ......................................................................................... 5-3
5.2.1 Digital Input Module Block Operation ......................................................................................... 5-5
5.2.2 Digital Input Module Block Parameters ...................................................................................... 5-6
5.2.3 Typical Block Connections for Digital Input Block....................................................................... 5-8
5.2.4 Digital Input Block Events ........................................................................................................... 5-8
5.3 DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM) ...................................................... 5-9
5.3.1 Digital Output Module Block Description (DOM) ...................................................................... 5-11
5.3.2 Dual Digital Output Module Block Description (DDOM) ........................................................... 5-13
5.3.3 Wide Digital Output Module Block Description (WDOM) .......................................................... 5-16
5.3.4 Digital Output Module Block Parameters.................................................................................. 5-18
5.3.5 Typical Block Connections for Digital Output Blocks ................................................................ 5-23
5.3.6 Digital Output Module Block Events ......................................................................................... 5-24
5.4 ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)..................................................... 5-25
5.4.1 General Operation .................................................................................................................... 5-26
5.4.2 Voltage/Current Input Module Block Description (VCIM) ......................................................... 5-27
5.4.3 Thermocouple Input Module Block Description (TIM) .............................................................. 5-30
5.4.4 Resistance Input Module Block Description (RIM) ................................................................... 5-33
5.4.5 Wide Resistance Input Module Block Description (WRIM)....................................................... 5-36
5.4.6 Analog Input Module Block Parameters ................................................................................... 5-39
5.4.7 Typical Block Connections for Analog Input Module Block....................................................... 5-46
5.4.8 Analog Input Module Block Events ........................................................................................... 5-46

ii
Logic Functions - Book 1

CONTENTS

CONTENTS (Cont’d)
Page
5.5 ANALOG OUTPUT MODULE BLOCK (AOM) ................................................................................. 5-47
5.5.1 Analog Output Module Block Capabilities ................................................................................. 5-50
5.5.2 Analog Output Module Block Parameters ................................................................................. 5-51
5.5.3 Typical Block Connections for Analog Output Module Block .................................................... 5-58
5.5.4 Analog Output Module Block Events......................................................................................... 5-58

SECTION 6 - REMOTE INPUT/OUTPUT MODULE DATABASE PARAMETERS


6.1 REMOTE INPUT/OUTPUT LIBRARY BLOCKS ................................................................................ 6-1
6.2 REMOTE I/O INTERFACE MODULE BLOCK (RIO) ......................................................................... 6-3
6.2.1 Remote I/O Interface Module Block Operation ........................................................................... 6-3
6.2.2 Remote I/O Interface Module Block Parameters ........................................................................ 6-5
6.2.3 Typical Block Connections for Remote I/O Interface Module Block.......................................... 6-10
6.2.4 Remote I/O Interface Module Block Events .............................................................................. 6-10
6.3 REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)..................................................................... 6-11
6.3.1 Remote Digital Input Module Block Operation .......................................................................... 6-12
6.3.2 Remote Digital Input Module Block Parameters ....................................................................... 6-14
6.3.3 Typical Block Connections for Remote Digital Input Module Block........................................... 6-20
6.3.4 Remote Digital Input Module Block Events ............................................................................... 6-20
6.4 REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)............................................................... 6-21
6.4.1 Remote Digital Output Module Block Operation ....................................................................... 6-21
6.4.2 Remote Digital Output Module Block Parameters..................................................................... 6-25
6.4.3 Typical Block Connections for Remote Digital Output Module Blocks ...................................... 6-32
6.4.4 Remote Digital Output Module Block Events ............................................................................ 6-32

SECTION 7 - INPUT FUNCTIONS DATABASE PARAMETERS


7.1 INPUT FUNCTIONS BLOCKS........................................................................................................... 7-1
7.2 ANALOG INPUT BLOCKS (VCI, TTI, TI, RI, RTI RTTI) .................................................................... 7-3
7.2.1 Voltage/Current Input Block Description (VCI)............................................................................ 7-4
7.2.2 Thermocouple Transmitter Input Block Description (TTI) ........................................................... 7-7
7.2.3 Thermocouple Input Block Description (TI)............................................................................... 7-10
7.2.4 Resistance Input Block Description (RI).................................................................................... 7-13
7.2.5 RTD Input Block Description (RTI)............................................................................................ 7-16
7.2.6 RTD Transmitter Input Block Description (RTTI) ...................................................................... 7-19
7.2.7 Analog Input Type Block Parameters........................................................................................ 7-22
7.2.8 Typical Block Connections for Analog Input Type Block........................................................... 7-27
7.2.9 Analog Input Type Block Events ............................................................................................... 7-28
7.3 DIGITAL INPUT BLOCK (DI) ........................................................................................................... 7-29
7.3.1 Digital Input Block Operation..................................................................................................... 7-30
7.3.2 Digital Input Block Parameters.................................................................................................. 7-30
7.3.3 Typical Block Connections for Digital Input Block ..................................................................... 7-32
7.3.4 Digital Input Block Events ......................................................................................................... 7-32

iii
Logic Functions - Book 1

CONTENTS

CONTENTS (Cont’d)
Page
APPENDIX A - SUMMARY OF VERSION DIFFERENCES

APPENDIX B - MODCELL MASTER CONFIGURATION


B.1 OVERVIEW ....................................................................................................................................... B-1
B.2 MODCELL SERIAL COMMUNICATION (MSC) Block Modifications ................................................ B-2
B.3 Expression (EX) Block Modifications ................................................................................................. B-2
B.3.1 Configuration Items .................................................................................................................... B-6
B.3.2 Read Coil Status......................................................................................................................... B-9
B.3.3 Read Input Status..................................................................................................................... B-11
B.3.4 Read Input Register.................................................................................................................. B-13
B.3.5 Read Holding Register ............................................................................................................. B-15
B.3.6 Write One or More Coils ........................................................................................................... B-17
B.3.7 Write One or More Registers.................................................................................................... B-19
B.4 EXAMPLES ..................................................................................................................................... B-21
B.4.1 Example 1................................................................................................................................. B-21
B.4.2 Example 2................................................................................................................................. B-23

APPENDIX C - BLOCK DATA

iv
Logic Functions - Book 1

CONTENTS

ILLUSTRATIONS
Figure Page
2-1. Data Base Structure ................................................................................................................................. 2-2
3-1. Interface Block, Overview......................................................................................................................... 3-3
3-2. Interface Block (IF), Execution Menu ....................................................................................................... 3-4
3-3. Interface Block (IF), Startup Menu............................................................................................................ 3-4
3-4. Interface Block (IF), Diagnostic Menu ...................................................................................................... 3-5
3-5. Interface Block, Typical Connections...................................................................................................... 3-26
3-6. System Event Block (SE), Block Diagram .............................................................................................. 3-29
3-7. System Event Block (SE), General Menu............................................................................................... 3-30
3-8. System Event Block (SE), Diagnostic Menu........................................................................................... 3-30
3-9. System Event Block (SE), Alarms Menu ................................................................................................ 3-31
3-10. System Event Block, Typical Connections ........................................................................................... 3-41
3-11. Loop Block, Functional Block Diagram ................................................................................................. 3-43
3-12. Loop Block (LP), General Menu ........................................................................................................... 3-44
3-13. Loop Block (LP), Diagnostic Menu ....................................................................................................... 3-44
3-15. Configured List Block (CL), Edit Display, page 2.................................................................................. 3-49
3-16. Typical Block Connections for Configured List Blocks.......................................................................... 3-52
3-17. Modbus List Block (ML), Edit Display, page 2 ...................................................................................... 3-54
3-18. Typical Block Connections for Modbus List Block ................................................................................ 3-56
4-1. ICN Communication Block, Functional Block Diagram............................................................................. 4-3
4-2. ICN Communication Block (ICN), General Menu ..................................................................................... 4-4
4-3. ICN Communication Block (ICN), Authorized Source Menu .................................................................... 4-4
4-4. ICN Communication Block (ICN), Diagnostics Menu ............................................................................... 4-5
4-5. ICN Communication Block, Typical Connections ................................................................................... 4-16
4-6. Modcell Serial Communication Block, Functional Block Diagram .......................................................... 4-18
4-7. Modcell Serial Communication (MSC), Edit Block Display, Page 1........................................................ 4-19
4-8. Modcell Serial Communication (MSC), Edit Block Display, Page 2........................................................ 4-19
4-9. Modcell Serial Communication Block, Typical Block Connections ......................................................... 4-35
5-1. Analog Input Module and Input Function Block Relationships.................................................................. 5-2
5-2. Digital Input Module Block, Functional Block Diagram ............................................................................. 5-3
5-3. Digital Input Module (DIM), General Menu ............................................................................................... 5-4
5-4. Digital Input Module (DIM), Diagnostic Menu ........................................................................................... 5-4
5-5. Digital Output Module Block, Functional Block Diagram ........................................................................ 5-10
5-6. Dual Digital Output Module Block, Functional Block Diagram ................................................................ 5-11
5-7. Digital Output Module (DOM), General Menu ........................................................................................ 5-11
5-8. Dual Digital Output Module (DDOM), Channel 1 Configuration Menu ................................................... 5-13
5-9. Digital Output Module (DOM), Diagnostic Menu .................................................................................... 5-14
5-10a. Wide Digital Output Module (WDOM), General Menu........................................................................ 5-16
5-10b. Wide Digital Output Module (WDOM), Diagnostic Menu.................................................................... 5-16
5-11. Digital Output Block, Typical Connections............................................................................................ 5-23
5-12. Analog Input/Output Type Module Phased Scan Cycle ....................................................................... 5-26
5-13. Voltage/Current Input Module Block, Functional Block Diagram ......................................................... 5-27
5-14. Voltage/Current Input Module Block (VCIM), General Menu................................................................ 5-28
5-15. Voltage/Current Input Module Block (VCIM), Diagnostic Menu............................................................ 5-28
5-16. Thermocouple Input Module Block, Functional Block Diagram ............................................................ 5-30
5-17. Thermocouple Input Module (TIM), General Menu .............................................................................. 5-31
5-18. Thermocouple Input Module (TIM), Diagnostic Menu .......................................................................... 5-31
5-19. Functional Block Diagram, Resistance Input Module Block ................................................................. 5-33
5-20. Resistance Input Module (RIM), General Menu ................................................................................... 5-34
5-21. Resistance Input Module (RIM), Diagnostic Menu ............................................................................... 5-34
5-22. Wide Resistance Input Module Block, Functional Block Diagram ........................................................ 5-36

v
Logic Functions - Book 1

CONTENTS

ILLUSTRATIONS (Cont’d)
Figure Page
5-23. Wide Resistance Input Module (WRIM), General Menu ...................................................................... 5-37
5-24. Wide Resistance Input Module (WRIM), Diagnostic Menu .................................................................. 5-37
5-25. Typical Block Connections for Analog Input Module Block .................................................................. 5-46
5-26. Analog Output Module Block, Functional Block Diagram (Part 1)........................................................ 5-47
5-27. Analog Output Module Block, Functional Block Diagram (Part 2)........................................................ 5-48
5-28. Analog Output Module (AOM), General Menu..................................................................................... 5-49
5-29. Analog Output Module (AOM), Restart/Failsafe Menu ........................................................................ 5-49
5-30. Analog Output Module (AOM), Diagnostic Menu ................................................................................. 5-50
5-31. Analog Output Module Block, Typical Connections ............................................................................. 5-58
6-1. Remote I/O Interface Module Block, Functional Block Diagram .............................................................. 6-3
6-2. Remote I/O Interface Module Block, General Menu ................................................................................ 6-4
6-3. Remote I/O Interface Module Block, Typical Connections..................................................................... 6-10
6-4. Remote Digital Input Module Block, Functional Block Diagram ............................................................. 6-12
6-5. Remote Digital Input Module Block, General Menu ............................................................................... 6-13
6-6. Remote Digital Input Module Block, Channel Configuration Menu ........................................................ 6-13
6-7. Remote Digital Input Block, Typical Connections .................................................................................. 6-20
6-8. Remote Digital Output Module Block, Functional Block Diagram .......................................................... 6-22
6-9. Remote Digital Output Module Block, General Menu ............................................................................ 6-23
6-10. Remote Digital Output Module Block, Channel Configuration Menu ................................................... 6-23
6-11. Remote Digital Output Module Block, Diagnostics Menu..................................................................... 6-24
6-12. Remote Digital Output Module Block, Typical Connections................................................................. 6-32
7-1. Voltage/Current Input Block (VCI), Functional Block Diagram................................................................ 7-4
7-2. Voltage/Current Input Block (VCI), General Menu................................................................................... 7-5
7-3. Voltage/Current Input Block (VCI), Diagnostics Menu ............................................................................. 7-5
7-4. Thermocouple Transmitter Input Block (TTI), Functional Block Diagram ................................................ 7-7
7-5. Thermocouple Transmitter Input Block (TTI), General Menu .................................................................. 7-8
7-6. Thermocouple Transmitter Input Block (TTI), Diagnostics Menu............................................................. 7-8
7-7. Thermocouple Input Block (TI), Functional Block Diagram.................................................................... 7-10
7-8. Thermocouple Input (TI), General Menu................................................................................................ 7-11
7-9. Thermocouple Input (TI), Diagnostics Menu .......................................................................................... 7-11
7-10. Resistance Input Block (RI), Functional Block Diagram....................................................................... 7-13
7-11. Resistance Input Block (RI), General Menu......................................................................................... 7-14
7-12. Resistance Input Block (RI), Diagnostics Menu ................................................................................... 7-14
7-13. RTD Input Block (RTI), Functional Block Diagram............................................................................... 7-16
7-14. RTD Input Block (RTI), General Menu................................................................................................. 7-17
7-15. RTD Input Block (RTI), Diagnostics Menu ........................................................................................... 7-17
7-16. RTD Transmitter Input Block (RTTI), Functional Block Diagram ......................................................... 7-19
7-17. RTD Transmitter Input Block (RTTI), General Menu ........................................................................... 7-20
7-18. RTD Transmitter Input Block (RTTI), Diagnostics Menu...................................................................... 7-20
7-19. Typical Block Connections for Analog Input Type Block ...................................................................... 7-27
7-20. Digital Input Block, Functional Block Diagram ..................................................................................... 7-29
7-21. Digital Input Block (DI), General Menu................................................................................................. 7-30
7-22. Digital Input Block, Typical Connections .............................................................................................. 7-32

vi
Logic Functions - Book 1

CONTENTS

TABLES
Table Page
2-. Data Types ................................................................................................................................................. 2-6
2-2. State Change Actions............................................................................................................................... 2-9

3-1. Interface Block Attributes, Valid Values, Mnemonics, and Data Types .................................................... 3-6
3-2. System Event Block Attributes, Valid Values, Mnemonics, and Data Types.......................................... 3-33
3-3. Event Transition Codes and Descriptions .............................................................................................. 3-42
3-4. Loop Block Attributes, Valid Values, Mnemonics, and Data Types ........................................................ 3-45
3-5. Configured List Block Attributes, Valid Values, Mnemonics, and Data Types........................................ 3-50
3-6. Modbus List Block Attributes, Valid Values, Mnemonics, and Data Types............................................. 3-55

4-1. ICN Communication Block Attributes, Valid Values, Mnemonics, and Data Types.................................. 4-7
4-2. Modcell Serial Communication Block Attributes, Valid Values, Mnemonics, and Data Types................ 4-23

5-1. Digital Input Module Block Attributes, Valid Values, Mnemonics, and Data Types .................................. 5-6
5-2. Digital Output Module Block Attributes, Valid Values, Mnemonics, and Data Types ............................. 5-12
5-3. Dual Digital Output Module Block Attributes, Valid Values, Mnemonics, and Data Types ..................... 5-14
5-4. Wide Digital Output Module Block Attributes, Valid Values, Mnemonics, and Data Types .................... 5-17
5-5. Voltage/Current Input Module Attributes, Valid Values, Mnemonics, and Data Types........................... 5-29
5-6. Thermocouple Input Module Attributes, Valid Values, Mnemonics, and Data Types ............................. 5-32
5-8. Resistance Input Module Attributes, Valid Values, Mnemonics, and Data Types .................................. 5-35
5-9. Wide Resistance Input Module Attributes, Valid Values, Mnemonics, and Data Types ......................... 5-38
5-10. Analog Output Module Block Attributes, Valid Values, Mnemonics, and Data Types .......................... 5-51

6-1. RIO Module Block Attributes, Valid Values, Mnemonics, and Data Types............................................... 6-5
6-2. RDIM Block Attributes, Valid Values, Mnemonics, and Data Types....................................................... 6-14
6-3. RDOM Block Attributes, Valid Values, Mnemonics, and Data Types ..................................................... 6-25

7-1. Voltage/Current Input Attributes, Valid Values, Mnemonics, and Data Types.......................................... 7-6
7-2. Thermocouple Transmitter Input Attributes, Valid Values, Mnemonics, and Data Types......................... 7-9
7-3. Thermocouple Input Block Attributes, Valid Values, Mnemonics, and Data Types ................................ 7-12
7-4. Resistance Input Attributes, Valid Values, Mnemonics, and Data Types ............................................... 7-15
7-5. RTD Input Attributes, Valid Values, Mnemonics, and Data Types ......................................................... 7-18
7-6. RTD Transmitter Input Block Attributes, Valid Values, Mnemonics, and Data Types ............................ 7-21
7-7. Digital Input Block Attributes, Valid Values, Mnemonics, and Data Types ............................................. 7-31

vii
Logic Functions - Book 1

CONTENTS

viii
Logic Functions - Book 1

INTRODUCTION

1
INTRODUCTION

1.1 GENERAL
This document is the first of two books that includes database reference information for
instruments with logic functionality. Also included is information on database organization and
database memory block structure. The user of this document should be familiar with the
architecture of the MODCELL or the MOD 30ML instrument, configuration capabilities, and
message handling capabilities using either the Instrument Communications Network (ICN) or
the Modbus Protocol. For users developing their own runtime interface, this document
includes attribute numbers and data value number information.

1.2 OVERVIEW OF INSTRUMENT SOFTWARE


Logic functionality provides intelligent data acquisition and manipulation for the highly modular
process I/O and communications modules on the instrument. User integration of analog and
discrete signal conditioning is provided on a point-by-point basis. This unique modularity
permits the product to be configured with just the functionality that is required for each
application. Logic control identity module functions support basic analog and digital I/O with
filtering and linearization, a system interface consistent with MOD 30 instruments, timers,
process alarms, supervisory message handling, evaluation of event equations and sequential
control capabilities.

1.3 DATABASE CONFIGURATION AND RUNTIME SUPPORT


PC based application builder software is used to configure the instrument database and uses
the Instrument Communication Network (ICN) or Modbus as a serial interface. The software is
a graphics based configuration tool. Users are presented with a work area and icons that
represent various activities that can be performed. This interface offers maximum flexibility in
defining instrument structures and configuring database parameters. After generating the
database, it can be written to disk and must be compiled before downloading to the
instrument. Once a database is downloaded to the instrument, it can be ported to other
instruments using an optional portable memory module. Runtime software packages can be
used to define and view the user interface to the instrument.

1.4 RELATED DOCUMENTATION


Additional information about this instrument and its logic configuration can be found in:
• IB-23G602 – Database Reference for Logic Functions - Book 2
• ViZapp.hlp – Help file for Visual Application Designer (Windows 95, NT)
• IB-23H141 – User’s Guide, MODCELL Application Builder (DOS)
• IB-23H120 – User’s Guide, PC-30 Interface Software for MOD 30 and MODCELL

1-1
Logic Functions - Book 1

INTRODUCTION

Additional information about instrument installation can be found in:


• IB-23C600 – Installation, MODCELL Multiloop Processor
• IB-23C601 – Installation, Remote I/O Modules
• IB-1800R-INS – Installation, MOD 30ML Multiloop Controller
• IB-1800R-M30 – Installation, MOD 30ML Replacement for MOD 30

Additional MODBUS connection information can be found in the following:


• IB-MODBUS-RTU – MODBUS™ RTU Communications Guide for use with MODCELL,
MOD 30ML and Commander Products

Additional ICN connection and loading information can be found in the following:
• IB-23A160 – Instrument Communications Network (ICN) Planning

Users developing Instrument Communication Network (ICN) interface software to this


instrument will also need the following:
• IB-23G001 – ICN Communication Link Programmers Manual

1.5 VERSION IDENTIFICATION


To verify the version level of the instrument, check the version number marked on the PROM
label of the identity module. The firmware version is a digit in the catalog number as follows:

Catalog Number Description for 2001P


BASE NUMBER 2001P MODCELL Logic Control Identity Module

UNUSED Z Unused Character

ELECTRICAL CODE 10 General Purpose

FUNCTION 1 Logic Control

FIRMWARE VERSION 01 Version 1


02 Version 2
03 Version 3
04 Version 4
05 Version 5
06 Version 6

MODEL A Design Level (256K PROMs)


B Design Level (512K PROMs)
C Design Level (512K Flash RAM)

Sample Number 2001PZ10106C (Product is serialized)

Version number identification for specific blocks is obtained through the database. See
Appendix A for a summary of version differences.

1-2
Logic Functions - Book 1

DATABASE DESCRIPTION

2
DATABASE DESCRIPTION

2.1 GENERAL
This section describes the structures and global features that support the instrument database
and it describes general instrument operation and how the database is protected.
Understanding the basic elements that support database creation and operation is
fundamental in knowing how the configuration will affect instrument performance. How
individual parameters affect the function of the instrument during database execution is
described in the next section. Since commonality exists in certain basic functions, this section
is used as a common reference point to describe these global features.

2.2 DATABASE STRUCTURE OVERVIEW


The user database is configurable and writable to make the instrument perform a variety of
executable functions. The basic logical element of the database is a function block. Function
blocks are grouped to form multiple process loops. The significance of a loop is that it is at
this level that control access by an external computer or console can be obtained. Loops in
turn are grouped into a set of loops that are scanned (executed) at the same rate. Up to five
different scan rates can be configured through the interface block. The instrument operates at
a fixed base rate (50 milliseconds) and each of the five groups can be configured at any
multiple of the base rate up to the maximum time value (about 1193 hours). Module blocks
define the physical interface to the database and serve as data handling blocks between the
process and the function blocks. Figure 2-1 shows the relationship between the basic
configurable elements of the instrument database.

2.2.1 Blocks
Blocks perform specific activities or algorithms based on their type. Each type of block within
the instrument is uniquely defined by an occurrence number (the number of the instance of a
block type in the database).

Blocks are comprised of attributes, which specify block input values or sources, block output
values calculated as a result of performing some specified activity, and other parameters
which affect the function of a block.

Features of blocks include:


• Data quality associated with pertinent block attributes (typically, block outputs).
• Selection of either a local data value or a Logical Source Pointer (LSP) connection to a
block attribute for any block input.
• Support of indirect input source connections (for example, a block may have specified as
its input an attribute of another block which in turn specifies an attribute from yet another
block as its input source).
• A block state attribute that allows certain blocks to be "turned off," or kept from executing
and updating its outputs.

2-1
Logic Functions - Book 1

DATABASE DESCRIPTION

*
Function Interface System
* Block Loop Block (IF1) Event Block
Execution Block #1 (SE1)
Order
*

*
Function Main Block
* Block Loop Execution
Execution Block #n Order
Order
*

*
Function
* Block Loop Configured
Execution Block #64 List (CL)
Order
*

* = Any of the following function blocks:


ICN CL (Configured List)
ML (Modbus List)
MSC DI (Digital Input)
VCI (Voltage/Current Input)
DIM TTI (Temperature Transmitter Input)
TI (Thermocouple Input)
DOM CJI (Cold Junction Input)
RI (Resistance Input)
DDOM RTI (RTD Input)
I/O Module RTTI (RTD Transmitter Input)
WDOM Block EX (Expression)
Selection IC (Input Communications)
VCIM (32 modules OC ( O u t p u t C o m m u n i c a t i o n s )
per LN (Linearization)
TIM MODCELL) PA (Process Alarm)
TM (Timer)
CJIM NM (Notification/Request Message)
SM (Supervisory Message)
RIM TOT(Totalizer)
PW (Piecewise Table)
WRIM DVC (Device Block)
SSEQ (Small Sequencer Block)
AOM LSEQ (Large Sequencer Block)
PID (Regulatory Control)
RIO** RSK (Ramp/Soak)
** Connects any of the following remote
module blocks: RDIM, RDOM

Figure 2-1. Database Structure

Types of Blocks
There are three basic categories of block types. They are:
• Environment blocks
Supports general instrument operation and do not directly perform the user defined
control functions. Of these, the interface and system event blocks (there can only be one
occurrence of each) are visible and always exist as part of any configuration. Other
service type blocks are transparent to the user.
• Module blocks
Specify the physical I/O complement of the instrument. The I/O configuration for the
instrument is flexible; there are 32 positions on one MODCELL for example, allowing
various combinations of I/O modules, and some limitations.

2-2
Logic Functions - Book 1

DATABASE DESCRIPTION

• Function blocks
Process input function blocks configure an interface between the instrument’s process
input module blocks and the control tasks. Algorithm function blocks define the user
configured control functions on the instrument. These building blocks include
expressions, linearization, notification messages, piecewise tables, process alarms, timers
and sequencers. Communication function blocks support the instrument communication
ports, and the transfer of data over them. The configured list block handles transfer of
data between groups, as well as transfer of data to the communication interfaces.

Block Parameters
Blocks are comprised of attributes, with each attribute containing a value of a specific type
such as floating point, discrete, state, and time (see Section 2.3.2 for data types). Some of
these attributes are internal to the block (not visible to the user through configuration), and
contain values processed during block execution; other attributes are accessible through
configuration. Some attributes are uniquely defined in the database and are therefore
addressable by name, coupled with the block type and occurrence number. This reference to
an attribute is called a Logical Source Pointer (LSP). Attributes can be input sources or
values, calculated output values, and parameters for specific execution of the block. For
example, the LSP to the Timer Block 1 time value would be constructed as TM1,TIME.

An input attribute provides data that is used by the block. Input data may be specified as a
local value, a remote pointer to a block attribute from which the input value is obtained, or
NONE, in which case this particular input is not used by this occurrence of the block. An
input, which specifies a block attribute as the source of its value, is referred to as a "logical
source pointer."

An output attribute contains a value produced as a result of the execution of the block. For
example, a block might produce a discrete value of TRUE or FALSE depending on the result
of a comparison of its inputs. This attribute can then be used as an input to another block.
Output attributes are always immediately followed by a data quality attribute. Data quality is
set to good if a valid output value has been produced. If an error occurred during the
execution of the block, or if block inputs had bad quality, the data quality attribute will be set to
a value indicating that the output value has bad quality. The quality attribute can be used by
other blocks, which use this block’s output as their input source, in order to determine whether
or not the value should be used.

Other attributes are configuration parameters which are not specifically inputs or outputs, but
effect the action taken by the block. For example, a block may have attributes to enable the
main function or sub functions, cause it to invert its normal output value, perform increment or
decrement operations, contain target or default values, and so forth.

2.2.2 Loops
All user configurable function blocks are placed into groups in the database preceded by loop
blocks. The reasons for this grouping of function blocks are:
• Control access of the instrument by computer or console sources is at this group level.
• All blocks in this group are executed at a rate specified for the loop block.
• Execution of this entire group can be turned off and on via an attribute in the loop block.

2-3
Logic Functions - Book 1

DATABASE DESCRIPTION

The loop block specifies which of the scan rates, specified in the interface block, are used
when executing the function blocks in the loop. All block groups having the same scan rate
are implicitly grouped. Within a group, loop blocks, and the function blocks following each
loop block, are executed in the order in which they are specified in the database.

2.2.3 Groups
A group is a collection of one or more loops, which runs at a specified rate. There are five
configurable group execution rates as specified in the interface block. Rates are allowed to be
a multiple of the base interval (50 milliseconds) from 50 milliseconds up to a maximum time of
about 1193 hours. A loop is specified to run at one of the specified rates by entering the
group number of the desired rate in the interface block into the scan group attribute of the loop
block. Loops are then implicitly grouped. Synchronization of data collection within a group is
not required; but it may be desirable for best results.

Groups are prioritized in order of their execution rates and group level; the group with the
shortest execution interval has the highest priority. If groups one and two have the same scan
rate, then group one (the lower number) has the higher priority. When a higher priority group
interrupts a lower priority group, the high priority group must run to completion before the
lower priority group can resume.

All groups must be able to run to completion within their specified execution interval. If a
group is rescheduled before it has completed, the instrument goes into an overrun situation.
When this happens, the base interval is increased by a fixed amount, and thus the execution
rate of the entire instrument is reduced. If overruns still occur, the base rate is continually
increased, until all groups can complete or until a maximum overrun base interval is reached.
If excessive idle time is present, the base interval is reduced until the original base value is
reached, or until overruns begin to occur again.

Groups run asynchronously with each other and with communications and process I/O.
Therefore, input source references from one group to another are double buffered to insure
the integrity and consistency of data within a group. When a block attribute is specified as an
input source for another block within the same group, the source attribute’s value is read
directly from the source block when the destination block is executed. When the source
attribute is from another group, the value is read from an input buffer which is filled with a
"snapshot" of data values from the output buffers of other groups when the this group begins.
Any outputs from this group, which are used as inputs by other groups, are placed into an
output buffer for this group. Data that comes from or goes to external communications, be it
the ICN or process I/O is also double buffered.

2.3 GLOBAL FEATURES

2.3.1 Initial Data Values


Some function blocks require that an initial data value be configured (e.g. Initial Data Value in
an analog input block, Initial Timer Value in a timer block, or Initial Result Value in an
expression block). This establishes the initial value for the data (or equivalent) field in the
block when the database is downloaded to the instrument. Generally, the initial data value is
replaced by new data as soon as the block is executed. In some cases, the initial data value
is retained and used. For instance, if the mode in an analog input module block is configured
to be auto, the initial data value will be written over by the analog process input when the

2-4
Logic Functions - Book 1

DATABASE DESCRIPTION

block is executed. However, if the input mode is configured to be manual, the initial data
value will be retained until it is written over by an operator through the status display, or until
input mode is changed to auto. If an input attribute is configured as NONE, then that attribute
is not part of the database and cannot be read.

2.3.2 Data Quality


Each block with a calculated output carries a quality attribute in the database directly following
any attribute which is calculated by the block algorithm (block outputs). Attributes which can
only be configured, changed by the operator, or obtained through source pointers do not carry
quality.

Most blocks deal with quality in a standard way. There is a "Bad Inputs Accepted" parameter
in every function block. When this attribute is set to YES, the block will not check quality on its
inputs and will not change the quality of its outputs; quality of outputs in this case will default to
GOOD. When the "Bad Inputs Accepted" parameter set to NO, the block will check all of its
inputs for quality prior to executing its algorithm. If any of those which have quality are found
’not good’, the block will not execute its algorithm but will mark its output quality(s) bad,
leaving output data at its previous value.

Individual blocks may deal with data quality in a more specific manner, by offering separate
checks and "actions on bad quality" for individual inputs or groups of inputs, and by offering
different actions on different grades of quality.

Quality information is provided to the operator either by pointing an alarm block at the desired
quality attribute or by making quality one of the conditions you can alarm on when you point
an alarm block at a variable.

2.3.3 Logical Source Pointer (LSP)


Information is passed between blocks in the database by means of software sources. Input
information is provided via software links (softwiring) to all function block characteristics, with
the exception of discrete input and analog input type blocks, which read data from their
process connections. Softwiring between database memory blocks allows complex
interconnections of raw and processed signals within and between instrument databases.

The current state or condition of any block is accessible to all other function blocks by
softwiring to the data in the block using the respective mnemonics. When other information in
a block is required, this too can be obtained by softwiring to the respective characteristic.
Softwiring is accomplished through the use of source codes. A logical source pointer (LSP) is
used to specify a field in one block as the data source for a field in another block. The LSP
code specifies the block type and occurrence number of the database block acting as the
source and the mnemonic for the field in the block (e.g. EX2,R is a LSP that identifies
Expression Block No. 2, Result Field). This LSP must be entered in a field of the block that is
receiving the data (the destination block).

As data in a function block is only referred to, and not physically used (as if it were similar to a
relay contact), there is no restriction to the amount of times or position in the logic
arrangement that reference is made, e. g., any LSP can be the source of data for as many
function block fields as necessary.

2-5
Logic Functions - Book 1

DATABASE DESCRIPTION

2.3.4 Data Types


Function blocks in the instrument database consist of parameters that have data types as
described in Table 2-1. Those data types with an asterisk are different in MOD 30
instruments.

Table 2-1. Data Types


Data Type Bytes Range Remarks
Count (C) 2 0 to 65535 Count is an unsigned two-byte integer, with a value range of 0 to
65535. A count type data item is stored in the database with
the most significant byte stored first (lowest address).
Discrete (D) 1 1 and 0 Used to represent two-state variables. Discrete inputs are
considered TRUE when current flows (ON) or the contact is
CLOSED. TRUE also turns a discrete output ON.
1 0
TRUE FALSE
CLOSED* OPEN*
SUPPRESS ENABLE
YES NO
AUTO MANUAL
ACTIVE CLEAR
DIRECT REVERSE
UP DOWN
BAD GOOD
* In the MOD 30 Controller, Math Unit, and Recorder OPEN=1
and CLSD=0.
Long State 1 0 L to 255 L Used to represent variables with up to 256 states. Long state
(L) values require the suffix "L".
Short State 1 0 S to 15 S Used to represent variables with up to 16 states. State values
(S) require the suffix "S". These values are typically represented as
an enumeration of mnemonics, for example, ACTIVE,
INACTIVE, PAUSED. Block state values are:
RUN (0), HOLD (1), OFF (2), DEBUG (3).
Date (DA) 3 00/00/00 to Dates are entered as either M,mm/dd/yy (US format) or
12/31/99 D,dd/mm/yy (European format). For example, M,3/1/91 = March
1, 1991. Ranges for days, months and years are:
Years: 0-99 (first byte, low address) where 90-99=1900
Months: 1-12 (second byte)
Days: 1-31 (third byte)
Time 3 0:0:0 to Time units are hours, minutes and quarter seconds. All three
255:59:239 units must be included in each time entry. Colons separate
units. The first byte (low address) is the number of hours, the
second byte is the number of minutes, and the third byte is the
number of quarter seconds.
Millisecond 4 00:00:00.000 The millisecond time data type is an unsigned four-byte integer
Time * (M) to value that is a count of milliseconds from 0 to 4294967295. This
1193:02:47.295 value is stored most significant byte first (low address). Value is
entered as hours:min:sec.ms. Resolution is 1 millisecond.

2-6
Logic Functions - Book 1

DATABASE DESCRIPTION

Data Type Bytes Range Remarks


Floating 4 ±1.18*E-35 to The floating-point data type is a four-byte data value in IEEE
Point * (F) ±3.4*E38 standard floating point format.
Logical 4 A logical source pointer uniquely identifies an attribute in the
Source (datab database. It is a four-byte value, with bit fields for the function
Pointers * ase) block type, block occurrence number, and attribute number for
the specific attribute. LSP's are used mainly in building lists and
2 in messages.
(ICN)
For ICN messages, LSP's are two byte values, with the
organization of the block type, occurrence and attribute fields
dependent on the block type. This format allows consistency
with the existing MOD 30 ICN architecture.
ASCII * (A) n “any text” A data item of type ascii consists of one byte, which contains the
(for up to 126 length of the ascii string, followed by the number of bytes
bytes) specified in this first byte. Each byte contains an ascii character.
For example, a field size may be configured to be 12 bytes but
the data may only have 6 ascii characters plus a byte count for a
total 7 bytes of data.
Continuous 2 –204.8% to A decimal point is always required to distinguish continuous data
204.8% from counts, even when nothing follows the decimal point. For
instance, 100. is recognized as a continuous value while 100 is
recognized as a count.

The continuous data type is a two byte signed (two's


compliment) value. Values of 0 to 16000 represent continuous
values from 0. Thus, the continuous data type has a range of -
204.8% to 204.8%. This data type is available for the purpose
of compatibility with MOD 30 instruments.
Hex * (H) n $00 to $FF A data item of type hex consists of one byte, which contains the
(for up to 126 length of the hex string, followed by the number of bytes
bytes) specified in this first byte (similar to ascii). Hexadecimal
numbers must be preceded by $ e.g. $00, $0AF7 etc.
MOD 30 1 Special Bit Array The MOD 30 Controller Mode data type is a special bit array
Controller data type. It is available as a data type only for the purpose of
Modes compatibility with the MOD 30 XL Controller.
Address 0: 0 = Autotune Mode
1 = Feed Forward
2 = FF Feedback
3 = Cascade
4 = Auto State
5 = Manual
6 = Direct Digital Control
7 = Output Track

2-7
Logic Functions - Book 1

DATABASE DESCRIPTION

2.4 GENERAL INSTRUMENT OPERATION

2.4.1 State Changes

Instrument States
The instrument may be in one of the following states:
UPLOAD Instrument was powered up with memory module switch in the
upload position and will do nothing beyond copying the main
database (if it is ’complete’ and its checksums verify) into the
memory module.
POR Power up restart in process.
DEFAULT The instrument does not have a valid user generated database
and is therefore running a default database to sustain
communications, etc.
BEING_CONFIGURED An external device has configuration control and is authorized to
download. The instrument is running the default database in
expectation of downloads to the main.
HOLD The instrument has a valid user database, but is running only
overhead blocks. (No loops).
LOCAL_HOLD The instrument has a valid user database and would be in RUN;
but, the Run/Service switch is in Service (hold) and only
overhead blocks are running.
RUN Instrument has a valid user database and is running all blocks.

Loop or Block States


Loops and blocks may be in one of the following states:
RUN A normal operation state that is the only state in which a loop or
block is executed. This state runs algorithms, sets qualities per
inputs and algorithm results, and manages diagnostics.
HOLD A non-executing run state that is provided to save execution
time when a particular loop or block is not required continuously.
Attributes can be read and written and quality remains as it was
in the previous state. When a value with bad quality is written,
the quality changes to good if the associated loop is also in run
or hold.
OFF A non-executing state where attributes can be read and written
and quality is set bad. If you switch a loop to OFF and then to
HOLD or DEBUG, all output qualities will be BAD.
DEBUG A non-executing state where attributes can be read and written
and quality remains as it was in the previous state. When a
value with bad quality is written, the quality changes to good.

Loop or block state transition actions are described in Table 2-2.

2-8
Logic Functions - Book 1

DATABASE DESCRIPTION

Table 2-2. State Change Actions


Loop or Loop or Loop State Action on Loop Transition or Block Transition
Block State Block State (block trans.)
Transition Transition or Block State
From To (loop trans.)
Run Hold Run or Hold Block Transitions:
Hold Run Change block state, report event.
Run Debug Loop Transitions:
Hold Debug Change loop state, report event.
Off Debug
Run Off Run or Hold Block Transitions:
Hold Off Change block state, report event and set block output
Debug Off qualities to BAD.
Loop Transitions:
Change loop state, report event and set output qualities of
all its blocks to BAD.
Off Run Run or Hold Block Transitions:
Off Hold Change block state, report event and call block’s
Debug Run initialization routine if required.
Debug Hold Loop Transitions:
Change loop state, report event and call initialization
routines for all it’s blocks if required.
Run Hold Off Block Transitions:
Hold Run Change block state, report event.
Run Debug Loop Transitions:
Hold Debug Change loop state, report event.
Off Debug
Off Run
Off Hold
Debug Run
Debug Hold
Run Off Off Block Transitions:
Hold Off Change block state, report event and set block output
Debug Off qualities to BAD.
Loop Transitions:
Change loop state, report event and set output qualities of
all its blocks to BAD.
Off Run Off Loop Transitions:
Off Hold Change loop state, report event and set output qualities of
Debug Run all it’s blocks that are in the OFF state to BAD.
Debug Hold
Run Hold Debug Block Transitions:
Hold Run Change block state, report event.
Run Debug Loop Transitions:
Hold Debug Change loop state, report event.
Off Debug
Off Run
Off Hold
Debug Run
Debug Hold
Run Off
Hold Off
Debug Off

2-9
Logic Functions - Book 1

DATABASE DESCRIPTION

2.4.2 Startup
The instrument supports startup logic with configurable power-down/restart duration periods
for warm and cold starts. The startup definitions are:

WARM Instrument was down for less than a configurable amount of time. Timers,
stack, PC, and so forth are reinitialized. The WARM START DURATION
defines the power-down/restart interval in the Interface block as a
millisecond time value of NONE (zero) to INFINITY (Times less than 1
second are not useful because of potential drift between the battery backed
and run time clocks). Warm start values are also used when the user
wishes to switch from the default database to the main database without
forcing cold start initialization of the main database. The option to download
the memory module on a warm start is also allowed.

COLD Instrument was down for a period of time longer than the warm start duration
but less than a configurable cold start duration. Function blocks are fully
initialized. The default value is INFINITY. If a memory module is present, it
will download to the instrument. The memory module could be write
protected with cold start values if the user wishes.

FROZEN Instrument was down longer than the configurable cold start duration. After
power-up, the instrument will go to the HOLD state and the operator must
issue a request for the instrument to go to RUN. Initialization is same as
cold start.

A shutdown (for example, spurious interrupt, watchdog, bad main checksum) information data
area is set aside at the beginning of the main battery backed RAM area, before the database.
Information in this area is used during power up to determine if the instrument previously
powered down normally, or shut down due to a fault termination condition. The information is
copied to the memory module as well.

If, during power up, the shutdown information indicates that the instrument previously
terminated with a fault condition, a diagnostic is set and the instrument runs the default
database (DEFAULT state). A second fault termination will not overwrite the shutdown
information and an operator message is required to clear the fault condition information, in
order that it is not cleared erroneously by a non-maskable interrupt (NMI)/power-up.

2.4.3 I/O Lock


The I/O lock feature allows output function block values not to be copied to the output module
block output value, and input module block values not be copied to the input function blocks
(field input values continue to be updated in the input module blocks). Output module block
values can be written to via messages. Data writes to output module blocks are accepted
when the block is in manual, or the instrument state is not run, or I/O lock is set. Data writes
to input module blocks are accepted only when the block is in manual.

2-10
Logic Functions - Book 1

DATABASE DESCRIPTION

2.4.4 LEDs
The LEDs on the main board are handled as follows:
both off =No power.
green off, red on =Initial Power-up condition, or Watchdog (not talking to I/O, default
state, etc.).
green on, red off =Normal; Running main database and talking to I/O.
green on, red on =Any instrument state other than RUN (eg. HOLD, UPLOAD, etc.). If
red LED stays on after power-up, fallback occurred and I/O
goes into failsafe.
green on, red flashing =Upload failure; Indicates failed attempt to upload main database to
instrument using switch on memory module.

2.4.5 Control contention


Control contention applies to write messages. Control is only given when a TAKE CONTROL
or OVERRIDE CONTROL message is issued. Control is then held by that source until: 1
minute expires since last write, or a RELEASE CONTROL message is received, or an
OVERRIDE CONTROL message is received.

2.5 SECURITY AND INTEGRITY FEATURES

2.5.1 End of configuration Checks


A downloaded database is checked and verified by the configurator. End of configuration
(EOC) checks on the instrument are therefore limited to checking the hardware I/O
configuration against what is specified in the database.

If it is determined at end of configuration time that the I/O configuration does not match what is
specified in the database, a diagnostic event is generated, and the instrument comes up in a
non-run state.

2.5.2 Checksumming
In an attempt to maintain integrity of both the main database memory and the portable backup
memory, checksums are generated for both memories. The main and backup memories are
divided into segments and a checksum value is maintained for each segment when the
database is created. The checksum value is the exclusive ’or’ (XOR) of all of the four-byte
words in the segment. The end of the segment is called the checksum boundary.

Checksums are stored in a table containing one entry per checksum boundary. When new
values are written to a database segment, the old values are XOR’ed out of the checksum
table entry for that segment, and the new values are XOR’ed in. The main memory checksum
table is used for this operation; the result is then copied to the backup memory checksum
table.

Checksum values are verified by checking one segment every 250 ms. First the main
memory segments are checked, then the portable ram segments are checked. If a checksum

2-11
Logic Functions - Book 1

DATABASE DESCRIPTION

error is detected, a diagnostic event will be generated, and the instrument will go to a default
state.

Checksum boundaries are every 512 bytes (128 four-byte words). When a byte is written to
memory, its address is shifted right 9 bits to produce the checksum boundary table index.

A single database write typically involves more than one byte at a time. When multibyte writes
cross checksum boundaries, the two checksum table entries are updated as required.

2.5.3 Backup Memory


The backup memory module is used to maintain a mirror image of the 64K instrument
database. A small part of this image is reserved for shutdown information and serves as a
valuable diagnostic tool.

UPLOAD From Main Database to Memory Module


The instrument attempts an upload to the memory module during power-up when the memory
module switches are set to read/write and module load. It then runs the default database with
instrument state equal to UPLOAD. LEDs will be green on, red on if successful, green on, red
flashing if unsuccessful. Diagnostics and system events may be read from instrument, but
instrument state cannot be changed until power is removed and module switch is placed in
NORMAL.

A command attribute (CMD) is provided in the Interface Block to allow a remote


operator/device to request an upload to the module. The instrument can be in any state as
the data transfer will use direct memory access with scan interrupts disabled. Diagnostics are
provided as above in case of failure.

Uploads are possible when the module is not switch or software write protected and the main
database is configured, version compatible, and has valid checksums.

DOWNLOAD From Memory Module to Main Database


If the module database is ’good’ (configured, version compatible, has valid checksums, no ICN
or comm port mismatch), the module switch is in ’normal’, the ’download on warm start’
attribute is YES and the instrument did not have a previous shutdown fault, the transfer will
occur at power up. The download on warm start attribute in the interface block allows a user
to (for instance) write protect a module with cold start values in it and have it download only on
cold start. It will default to YES in the configurator.

A command attribute (CMD) is provided in the interface block to allow a remote


operator/device to request a download from the module. Diagnostics are provided in case of
failure.

The user of the download from module command will be required to go through a protocol to
get configuration control before the command will be accepted. This will be done by setting
Next Instrument State (NXTISTAT) attribute to BEING CONFIGURED.

Shutdown Information
Instrument status information is saved in the memory module and database when the
instrument shuts down for any reason. Shutdown information can be interpreted to determine
the cause of unrecoverable errors.

2-12
Logic Functions - Book 1

DATABASE DESCRIPTION

If an instrument with a memory module shuts down (watchdogs for example) and cannot run
again, the shut down information in the memory module can still be read. To do this, write
protect the memory module, put the module on another instrument, and read the shutdown
information using the STATUS display. Failure to write protect the memory module will cause
the data to be written over by the instrument when it is powered up.

2.5.4 Power Fail Detection and Recovery


A power fail (low voltage or brownout) condition is detected by the hardware and will generate
a non-maskable interrupt to the processor. The processor will complete any crucial operations
that it may have been in the middle of when the power fail occurred.

In particular, a write in progress to the instrument database and to the backup memory
module (if present) will be completed, in order to insure the integrity of the database when
power is restored and the instrument comes back up and running. If a database write was in
progress, the instrument will return to complete the write after responding to the interrupt, and
then wait in an idle loop until a power on reset occurs or full power is restored.

If a brownout lasts for less than 50 milliseconds, the instrument will continue functioning
without any effect on the processing state. If a power failure is longer than 50 milliseconds,
the instrument will perform a complete power up sequence.

2.5.5 Numerical Error Handling


In general, numerical errors (division by 0, floating point overflow or underflow, etc) will result
in a diagnostic in the function block in which they occur.

In floating point calculations, division by 0 or floating point overflow will generate a maximum
positive or negative value (floating point infinity less one as defined by the IEEE 754-1985
standard). If infinity is a partial result of any equation, the final result will also be infinity (in the
expression block, a saturation may take place as in the equation A+1/2B where B goes to
infinity). Thus, the resulting output value of a block in which a floating-point error was
generated can be compared against limits and rejected as out of range.

Floating point underflow (for example, a very small number added to a large number, the
result being no change to the large number) can be detected by checking the equation values
prior to the calculation.

2-13
Logic Functions - Book 1

DATABASE DESCRIPTION

2.6 DATABASE REFERENCE CONVENTIONS


Database reference information includes attribute definition, block capabilities, and examples
of usage. The information is intended to aid the user in understanding and configuring the
instrument database. Also included is information on database organization and memory
block structures for users developing their own interface software.

Explanations for each attribute are given in the order presented in the block data table. The
block data table lists all valid attributes for the block. Attribute numbers (Attr column) can help
you find their descriptions; but, are only required for users developing their own interface.
Version attributes exist for future enhancement issues and are not explained further. The
following conventions are used in presenting the database reference information in the block
data tables.

• Configurable Attributes Shown in bold text


• Non-Configurable Attributes Shown in italicized text
• CWR Identifies if an attribute is Configurable, Writeable,
and/or Readable.

The functional block diagrams show basic input/output structures and signal logic flow for the
block (signal flow is left to right top to bottom). Attributes are shown as selectable signal flow
paths or as possible values to the specified attribute in the attribute box. When a logical
source pointer (LSP) is selected, the data source becomes a softwired connection in the
instrument. The following conventions are used in presenting the database block diagrams.

• Input Source Attributes Shown in solid boxes with shading lines


• Database Attributes Shown in solid boxes
• Internal functions Shown in dashed boxes
• Fixed Configuration Value Shown in dotted boxes

The softwiring diagrams show basic input/output softwiring structures for connecting the block
in the database or to a strategy configured in an operator’s terminal. The following
conventions are used in presenting the database softwiring diagrams.

• Internal Softwiring Shown in solid arrowhead lines (with circles when


showing LSP connections between block attributes)
• Operator Read/Write Attributes Shown in dashed arrowhead lines
• Special module/list connections Shown as a double solid lines
• Operator Dynamic Link Shown as a black box

2-14
Logic Functions - Book 1

SYSTEM BLOCKS

3
SYSTEM DATABASE PARAMETERS

3.1 SYSTEM BLOCKS

System blocks contain the overall instrument related information and functionality that does
not logically fall within any loop or function block. These blocks exist through the System
resource for instrument and loop Libraries. Only one interface and system event block is
supported as part of the instrument configuration. These blocks are automatically made
available with each instrument. Other system resources at the instrument level are the loop
compound, the configured list and Modbus list blocks.

IF Interface Block. Reference Section 3.3. The Interface Block is used to


specify up to five independent function block groupings for a database.
Loops are included in a group by specifying the desired group number in
each loop block. The group scan intervals set the rate at which each
group will be executed when the instrument is in the RUN state.

SE System Event Block. Reference Section 3.4. This block stores a


configurable number of time stamped event codes for the diagnostic
points and events reported by the database blocks. These codes are
translated into messages for operator display or logging.

LP CPD Loop Compound. The loop compound block is a list connected compound
that contains a Loop Block. Any function block placed in this compound
becomes part of the loop block scan group. To guarantee proper
execution, loop blocks must be assigned the same scan group number on
the interface block. Reference Section 3.5 for information on the loop
block. As a compound, this resource can be saved and loaded for use
elsewhere. Loop library resources are available within this compound.

CL Configured List. Reference Section 3.6. This block is used to define


database attributes to be collected as a foreground list for a ICN or MSC
module block, or as a Modbus list for a MSC module block or solely to
specify data to be included in interface files (TIF or MIF).

ML Modbus List. Reference Section 3.7. A Modbus List is used to specify


instrument data that is to be converted into pure Modbus data (a 2-byte
positive value). It is connected through a MSC block.

Algorithm (function) blocks (those blocks that execute the logic) cannot operate independently
in the instrument database. Groups of related function blocks must be organized into loops. To
create a loop, a loop compound is used.

3-1
Logic Functions - Book 1

SYSTEM BLOCKS

The execution order of the system blocks may be indicated by a number that the block
displays in its upper right corner. The system blocks in order are: the Interface block (IF1), the
System Event block (SE1), the configured list blocks (CL10, CL11, etc.), the Modbus list
blocks (ML1, ML2, etc.), and the loop blocks (LP1, LP2, etc.). Occurrence numbers are used
in consecutive order (e.g., LP1, then LP2, then LP3 etc.). Using higher occurrence numbers
out of order will use up memory space.

3.2 SPECIAL BLOCKS FOR APPLICATION BUILDER


Special Application Builder blocks are available at the instrument and loop levels. These
blocks allow you to build different types of compounds, or add description blocks to your
strategy. For a description of compounding in the Application Builder, see IB-23H141.

List Connected Compound


The state compound is a list connected compound and appears as a green oval. Any
connections made from this compound are made using the tag list menu of existing tag names
and attributes. Connections are made using a tag list to another block. The other block may be
in another compound. In this way, compounds may be connected together as shown below.

HEAT EMERGENCY
IDLE
CONVERSION
COOL

Direct Connected Compound


The direct connected compound (blue rectangle) allows you to develop a strategy group with
its own uniquely named inputs and outputs. Your direct connection list is created from within
the compound. Connections to the connection interface block (CIB) are presented as outputs.
Connections from the CIB are presented as inputs. Lists expand as the number of connections
increases. Connections are presented in the order they are created. Deleting a connection
also deletes it from the list.

Description Block
The description block allows you to place a description in your strategy any-where within an
instrument. Up to 30 characters are displayed. Additional characters are saved but not
displayed.

3-2
Logic Functions - Book 1

INTERFACE BLOCK

3.3 INTERFACE BLOCK (IF1)


The interface block is an environment block that contains the overall instrument related
information and functionality which does not logically fall within any loop or function block.
This includes startup/shutdown conditions, current instrument state, group scan rates and
measured execution times, clock and calendar, controlling source information for those blocks
not run under a loop, instrument tag, power line frequency, and so forth. It is responsible for
clearing the transition flags which get set by various instrument state transitions and handles
messages such as database download which cause such transitions. It maintains the
instrument clock/calendar, controls configuration access to the instrument and
console/computer write access to the high level (not under a loop) function blocks, and
performs periodic hardware checks (including database and EPROM checksums and ram
read/write tests). One interface block is supported as part of the instrument configuration. Up
to five independent function block groupings can be included in a database by specifying the
desired group number in each loop block. The group scan intervals set the rate at which each
group will be executed when the instrument is in the RUN state.
Available to the user as block outputs are the active and acknowledged status of the
diagnostics, database execution information, and general instrument status. An overview of
the block is shown in Figure 3-1. The menus which are used to configure the block are shown
in Figures 3-2, 3-3 and 3.4.
Warm Start Duration
Cold Start Duration
Run on I/O mismatch
Download on Warm Start
Power out duration Startup
Startup type Conditions
Power up initialization Computer status Interface Block
Runtime initialization Console status Status

Power Line Frequency


User Tag
Configurator Tag Basic
Database size Configuration
I/O Mismatch Information

Instrument State
Next Instrument State
Command General
Time of Day and quality Instrument Status Interface Block
Date and quality
Day and quality

Scan interval
Execution Time
Filtered Execution Time Database
Maximum Execution Time Execution
Comm Blocks Locked Attributes Run GOOD
I/O Blocks Locked Complete
Run completion cycles Input
BAD

Memory module is write protected


Memory mod. soft write protected
Instrument is overconfigured FALSE
Instrument powered up Quality Check
Instrument powered down Diagnostic
I/O board 1 communications error Information
Time and date not valid
Plus others
Bad Inputs
Accepted
(YES/NO)

Figure 3-1. Interface Block, Overview

3-3
Logic Functions - Book 1

INTERFACE BLOCK

Figure 3-2. Interface Block (IF), Execution Menu

Figure 3-3. Interface Block (IF), Startup Menu

3-4
Logic Functions - Book 1

INTERFACE BLOCK

Figure 3-4. Interface Block (IF), Diagnostic Menu

3.3.1 Interface Block Operation


The execution rates for each group task are specified in the interface block, and are allowed to
be some multiple of the base interval (50 ms). The interface block is along with the system
event block at a 50 ms scan task rate.

3.3.2 Interface Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 3-1. The following further
defines the Interface Block configuration parameters.

Block Type
IF This is the Interface Block type and one is always required.

Occurrence
1 There is only one ‘instance’ allowed of the interface block.

Interface Block Database Attributes


2 State (STATE).....................................................................................................................– – R
Not configurable in this block (always equal to RUN). This block is always executed (Normal
Operation). See Section 2.4.1, State Changes for additional information.

3-5
Logic Functions - Book 1

INTERFACE BLOCK

Table 3-1. Interface Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 000
Block Length BLKLEN ––R Count 001
State STATE RUN (0) ––R Short State 002
Bad Inputs Accepted BADINP NO (0), YES (1) CWR Discrete 003
Default Database Checksum DEFCKUAK NO (0), YES (1) – WR Discrete 004
Error Unacknowledged
Default Database Checksum DEFCKACT NO (0), YES (1) ––R Discrete 005
Error Active
Main Database Checksum MNCKUAK NO (0), YES (1) – WR Discrete 006
Error Unacknowledged
Main Database Checksum MNCKACT NO (0), YES (1) ––R Discrete 007
Error Active
Instrument is Unconfigured MUCFGUAK NO (0), YES (1) – WR Discrete 008
Unacknowledged
Instrument is Unconfigured MUCFGACT NO (0), YES (1) ––R Discrete 009
Active
Main Database Version Error MNVERUAK NO (0), YES (1) – WR Discrete 010
Unacknowledged
Main Database Version Error MNVERACT NO (0), YES (1) ––R Discrete 011
Active
Memory Module Checksum MDCKUAK NO (0), YES (1) – WR Discrete 012
Error Unacknowledged
Memory Module Checksum MDCKACT NO (0), YES (1) ––R Discrete 013
Error Active
Memory Module is MDUCFUAK NO (0), YES (1) – WR Discrete 014
Unconfigured
Unacknowledged
Memory Module is MDUCFACT NO (0), YES (1) ––R Discrete 015
Unconfigured Active
Memory Module Database MDVERUAK NO (0), YES (1) – WR Discrete 016
Version Error Unacknowledged
Memory Module Database MDVERACT NO (0), YES (1) ––R Discrete 017
Version Error Active
Memory module is write MDWPSUP ENABLE(0), SUPPRESS(1) CWR Discrete 018
protected
Memory Module is Write MDWPUAK NO (0), YES (1) – WR Discrete 019
Protected Unacknowledged
Memory Module is Write MDWPACT NO (0), YES (1) ––R Discrete 020
Protected Active
Memory module is soft write MDSWPSUP ENABLE(0), SUPPRESS(1) CWR Discrete 021
protected
Memory module is soft write MDSWPUAK NO (0), YES (1) – WR Discrete 022
protected Unacknowledged
Memory module is soft write MDSWPACT NO (0), YES (1) ––R Discrete 023
protected Active

3-6
Logic Functions - Book 1

INTERFACE BLOCK

Table 3-1. Interface Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Instrument is overconfigured OVRUNSUP ENABLE(0), SUPPRESS(1) CWR Discrete 024
Instrument is overconfigured OVRUNUAK NO (0), YES (1) – WR Discrete 025
Unacknowledged
Instrument is overconfigured OVRUNACT NO (0), YES (1) ––R Discrete 026
Active
Instrument powered up PWRUPSUP ENABLE(0), SUPPRESS(1) CWR Discrete 027
Instrument powered up PWRUPUAK NO (0), YES (1) – WR Discrete 028
Unacknowledged
Instrument powered up Active PWRUPACT NO (0), YES (1) ––R Discrete 029
Instrument powered down PWRDNSUP ENABLE(0), SUPPRESS(1) CWR Discrete 030
Instrument powered down PWRDNUAK NO (0), YES (1) – WR Discrete 031
Unacknowledged
Instrument powered down PWRDNACT NO (0), YES (1) ––R Discrete 032
Active
Communications Port COMPTUAK NO (0), YES (1) – WR Discrete 033
Mismatch Unacknowledged
Communications Port COMPTACT NO (0), YES (1) ––R Discrete 034
Mismatch Active
Instrument Shutdown Fault SHUTDUAK NO (0), YES (1) – WR Discrete 035
Unacknowledged
Instrument Shutdown Fault SHUTDACT NO (0), YES (1) ––R Discrete 036
Active
Module Shutdown Fault MSHUTUAK NO (0), YES (1) – WR Discrete 037
Unacknowledged
Module Shutdown Fault Active MSHUTACT NO (0), YES (1) ––R Discrete 038
Processor Watchdog Fault WDOGUAK NO (0), YES (1) – WR Discrete 039
Unacknowledged
Processor Watchdog Fault WDOGACT NO (0), YES (1) ––R Discrete 040
Active
Spurious Event Fault SPURUAK NO (0), YES (1) – WR Discrete 041
Unacknowledged
Spurious Event Fault Active SPURACT NO (0), YES (1) ––R Discrete 042
EPROM Checksum Fault EPCHKUAK NO (0), YES (1) – WR Discrete 043
Unacknowledged
EPROM Checksum Fault EPCHKACT NO (0), YES (1) ––R Discrete 044
Active
Bad RAM Fault BDRAMUAK NO (0), YES (1) – WR Discrete 045
Unacknowledged
Bad RAM Fault Active BDRAMACT NO (0), YES (1) ––R Discrete 046
I/O board 1 communications IO1CSUP ENABLE(0), SUPPRESS(1) CWR Discrete 047
error
I/O board 1 communications IO1CUAK NO (0), YES (1) – WR Discrete 048
error Unacknowledged

3-7
Logic Functions - Book 1

INTERFACE BLOCK

Table 3-1. Interface Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
I/O board 1 communications IO1CACT NO (0), YES (1) ––R Discrete 049
error Active
050/094 & 115/125 reserved
Bad Clock Chip BDCLKUAK NO (0), YES (1) – WR Discrete 095
Unacknowledged
Bad Clock Chip Active BDCLKACT NO (0), YES (1) ––R Discrete 096
Time and date not valid TIMNSSUP ENABLE(0), SUPPRESS(1) CWR Discrete 097
Time and date not valid TIMNSUAK NO (0), YES (1) – WR Discrete 098
Unacknowledged
Time and date not valid Active TIMNSACT NO (0), YES (1) ––R Discrete 099
I/O is Locked Unacknowledged IOLOKUAK NO (0), YES (1) – WR Discrete 100
I/O is Locked Active IOLOKACT NO (0), YES (1) ––R Discrete 101
Communication Blocks are CMLOKUAK NO (0), YES (1) – WR Discrete 102
Locked Unacknowledged
Communication Blocks are CMLOKACT NO (0), YES (1) ––R Discrete 103
Locked Active
DMA Unacknowledged DMAUAK NO (0), YES (1) – WR Discrete 104
DMA Active DMAACT NO (0), YES (1) ––R Discrete 105
I/O Overrun IOVRNSUP ENABLE(0), SUPPRESS(1) CWR Discrete 106
I/O Overrun Unacknowledged IOVRNUAK NO (0), YES (1) – WR Discrete 107
I/O Overrun Active IOVRNACT NO (0), YES (1) ––R Discrete 108
Comm Hdw Fault Unacked CMHWFUAK NO (0), YES (1) – WR Discrete 109
Comm Hdw Fault Active CMHWFACT NO (0), YES (1) ––R Discrete 110
EEPROM Fault Unacked EEPFUAK NO (0), YES (1) – WR Discrete 111
EEPROM Fault Active EEPFACT NO (0), YES (1) ––R Discrete 112
Mem Mod Dnld Fail Unacked MDDLFUAK NO (0), YES (1) – WR Discrete 113
Mem Mod Dnld Fail Active MDDLFACT NO (0), YES (1) ––R Discrete 114
Base Scan Time SCANTIME ––R Msec Time 126
Scan Idle Time IDLETIME ––R Msec Time 127
NOVRAM Clock Set error SNCLKERR Clock OK (0), ––R Short State 128
Bad Input Quality (7),
DMA Bus Error Source (8),
DMA Bus Error Dest (9)
NOVRAM Clock Read error RNCLKERR Clock OK (0), ––R Short State 129
Oscillator OFF (1)
Bad Year Data (2)
Bad Month Data (3)
Bad Day of Month Data (4)
Bad Day of Week Data (5)
Bad Time of Day Data (6)
Bad Input Quality (7),
DMA Bus Error Source (8),
DMA Bus Error Dest (9)
Clock Compare Error (10)

3-8
Logic Functions - Book 1

INTERFACE BLOCK

Table 3-1. Interface Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Select Module No Response SLNORSPS 0-65535 – WR Count 130
Select Module Checksum SLCHKSMS 0-65535 – WR Count 131
Errors
I/O Module No Response MDNORSPS 0-65535 – WR Count 132
I/O Module Checksum Errors MDCHKSMS 0-65535 – WR Count 133
Power Line Frequency FREQ 50 (0) or 60 (1) C–R Long State 134
User Tag USRTAG up to 27 ASCII characters CWR ASCII 135
Configurator Tag CFGTAG ASCII time stamp ––R ASCII 136
Database Size DBSIZE (number of bytes) ––R Floating Pt 137
I/O Mismatch IOMM NO (0), YES (1) ––R Discrete 138
Instrument State INSTATE Upload (0), Default (2), ––R Short State 139
Being Configured (3), Hold
(4), Local Hold (5), Run (6)
Next Instrument State NXTISTAT Default (2), Being Configured – WR Short State 140
(3), Hold (4), Run (6), Hold
Warm Start (7), Run Warm
Start (8)
Command CMD 1=Ack Shutdown Fault – WR Long State 141
2=Upload to Module
3=Download from Module
4=Set Module write Prot.
5=Clear Module write Prot.
6=Delete Main Database
7=Restore Main Database
8=Reset
9=Kill
10=Clear MTIMEs
Time of Day TIMEDAY Msec Time – WR Msec Time 142
Time of Day Quality TIMEDAYQ GOOD (0), BAD (1) ––R Discrete 143
Calendar Date DATE Year (0-99), Month (1-12), – WR Date 144
Day (1-31)
Calendar Date Quality DATEQ GOOD (0), BAD (1) ––R Discrete 145
Day of Week DAY 1=Sunday, 7=Saturday – WR Short State 146
Day of Week Quality DAYQ GOOD (0), BAD (1) ––R Discrete 147
Computer Status CPSTATUS 0=Free ––R Short State 148
1=Busy
2=Inactive
Console Status CNSTATUS 0=Free ––R Short State 149
1=Busy

3-9
Logic Functions - Book 1

INTERFACE BLOCK

Table 3-1. Interface Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Warm start duration WARMSDUR NONE, INFINITY, any time CWR Msec Time 150
greater than 1 second
Cold start duration COLDSDUR INFINITY, any time greater CWR Msec Time 151
than warm start duration
Run on I/O mismatch RUNMISMT NO (0), YES (1) CWR Discrete 152
Download on warm start DNLDWARM NO (0), YES (1) CWR Discrete 153
Power Out Duration POUTDUR Msec Time ––R Msec Time 154
Startup Type STARTYPE WARM (1), COLD (2), or ––R Short State 155
FROZEN (3)
Power Up Initialization PWRUP NO (0), YES (1) ––R Discrete 156
Runtime Initialization RUNINIT NO (0), YES (1) ––R Discrete 157
Lock ICN comm. blocks COMMLOCK NO (0), YES (1) CWR Discrete 158
Scan Group 1 Interval INT1 NONE, or h:mm:ss.sss C–R Msec Time 159
(msec/scan). Rounded to
multiple of base rate.
Scan Group 2 Interval INT2 NONE, or h:mm:ss.sss C–R Msec Time 160
Scan Group 3 Interval INT3 NONE, or h:mm:ss.sss C–R Msec Time 161
Scan Group 4 Interval INT4 NONE, or h:mm:ss.sss C–R Msec Time 162
Scan Group 5 Interval INT5 NONE, or h:mm:ss.sss C–R Msec Time 163
Scan 6 Interval (IF Block) INT6 NONE, or h:mm:ss.sss ––R Msec Time 164
Scan 7 Interval INT7 NONE, or h:mm:ss.sss ––R Msec Time 165
(Serial Comm Block)
Scan 8 Interval INT8 NONE, or h:mm:ss.sss ––R Msec Time 166
(Serial Comm Block)
Scan 9 Interval INT9 NONE, or h:mm:ss.sss ––R Msec Time 167
(Serial Comm Block)
Scan1 Execution Time XTIME1 Recent Scan Msec Time ––R Msec Time 168
Scan2 Execution Time XTIME2 Recent Scan Msec Time ––R Msec Time 169
Scan3 Execution Time XTIME3 Recent Scan Msec Time ––R Msec Time 170
Scan4 Execution Time XTIME4 Recent Scan Msec Time ––R Msec Time 171
Scan5 Execution Time XTIME5 Recent Scan Msec Time ––R Msec Time 172
Scan6 Execution Time XTIME6 Recent Scan Msec Time ––R Msec Time 173
Scan7 Execution Time XTIME7 Recent Scan Msec Time ––R Msec Time 174
Scan8 Execution Time XTIME8 Recent Scan Msec Time ––R Msec Time 175
Scan9 Execution Time XTIME9 Recent Scan Msec Time ––R Msec Time 176
Scan1 Filtered Execution Time FTIME1 Average Scan Msec Time ––R Msec Time 177
Scan2 Filtered Execution Time FTIME2 Average Scan Msec Time ––R Msec Time 178
Scan3 Filtered Execution Time FTIME3 Average Scan Msec Time ––R Msec Time 179
Scan4 Filtered Execution Time FTIME4 Average Scan Msec Time ––R Msec Time 180
Scan5 Filtered Execution Time FTIME5 Average Scan Msec Time ––R Msec Time 181
Scan6 Filtered Execution Time FTIME6 Average Scan Msec Time ––R Msec Time 182
Scan7 Filtered Execution Time FTIME7 Average Scan Msec Time ––R Msec Time 183
Scan8 Filtered Execution Time FTIME8 Average Scan Msec Time ––R Msec Time 184
Scan9 Filtered Execution Time FTIME9 Average Scan Msec Time ––R Msec Time 185

3-10
Logic Functions - Book 1

INTERFACE BLOCK

Table 3-1. Interface Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Scan1 Max. Execution Time MTIME1 Maximum Scan Msec Time – WR Msec Time 186
Scan2 Max. Execution Time MTIME2 Maximum Scan Msec Time – WR Msec Time 187
Scan3 Max. Execution Time MTIME3 Maximum Scan Msec Time – WR Msec Time 188
Scan4 Max. Execution Time MTIME4 Maximum Scan Msec Time – WR Msec Time 189
Scan5 Max. Execution Time MTIME5 Maximum Scan Msec Time – WR Msec Time 190
Scan6 Max. Execution Time MTIME6 Maximum Scan Msec Time – WR Msec Time 191
Scan7 Max. Execution Time MTIME7 Maximum Scan Msec Time – WR Msec Time 192
Scan8 Max. Execution Time MTIME8 Maximum Scan Msec Time – WR Msec Time 193
Scan9 Max. Execution Time MTIME9 Maximum Scan Msec Time – WR Msec Time 194
lock I/O blocks? IOLOCK NO (0), YES (1) CWR Discrete 195
Run completion cycles RCCYCLES 1 to 255 CWR Long State 196
Run complete input RUNCMPLT NONE, TRUE, FALSE, LSP CWR Discrete 197

3 Bad Inputs (BADINP) .........................................................................................................CWR


See Section 2.3.2, Data Quality for additional information.
ACCEPTED 1 Block runs without a check on input quality.
REJECTED 0 The only input, Run Complete, is treated as FALSE when the input
quality is BAD.

Diagnostic Attributes
4 Default Database Checksum Error Unacknowledged (DEFCKUAK)............................ – WR
The unacknowledged default database checksum error diagnostic indicates if the error is or is
not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

5 Default Database Checksum Error Active (DEFCKACT)................................................– – R


The instrument was shut down due to a checksum error in the default database.
YES 1 “DEFAULT DATABASE CHECKSUM ERROR” is active.
NO 0 Diagnostic error is not active.

6 Main Database Checksum Error Unacknowledged (MNCKUAK) ................................. – WR


The unacknowledged main database checksum error diagnostic indicates if the error is or is
not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

7 Main Database Checksum Error Active (MNCKACT) .....................................................– – R


The instrument was shut down due to a checksum error in the main database.
YES 1 “MAIN DATABASE CHECKSUM ERROR” is active.
NO 0 Diagnostic error is not active.

3-11
Logic Functions - Book 1

INTERFACE BLOCK

8 Instrument is Unconfigured Unacknowledged (MUCFGUAK) ......................................– WR


The unacknowledged instrument is unconfigured error diagnostic indicates if the error is or is
not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

9 Instrument is Unconfigured Active (MUCFGACT) ........................................................ – – R


There is no valid user database in the instruments main RAM.
YES 1 “INSTRUMENT IS UNCONFIGURED” is active.
NO 0 Diagnostic error is not active.

10 Main Database Version Error Unacknowledged (MNVERUAK) ....................................– WR


The unacknowledged “main database version error” diagnostic indicates if the error is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

11 Main Database Version Error Active (MNVERACT) ....................................................... – – R


A user database was rejected because the instrument does not have the hardware and/or
firmware resources to run it.
YES 1 “MAIN DATABASE VERSION ERROR” is active.
NO 0 Diagnostic error is not active.

12 Memory Module Checksum Error Unacknowledged (MDCKUAK)................................– WR


The unacknowledged “memory module checksum error” diagnostic indicates if the error is or
is not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

13 Memory Module Checksum Error Active (MDCKACT)................................................... – – R


The module database has been marked bad because a checksum error was found in it.
YES 1 “MEMORY MODULE CHECKSUM ERROR” is active.
NO 0 Diagnostic error is not active.

14 Memory Module is Unconfigured Unacknowledged (MDUCFUAK)..............................– WR


The unacknowledged memory module is unconfigured diagnostic indicates if the error is or is
not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

15 Memory Module is Unconfigured Active (MDUCFACT)................................................. – – R


A module database was not downloaded because no valid database was found in the module.
YES 1 “MEMORY MODULE IS UNCONFIGURED” is active.
NO 0 Diagnostic error is not active.

3-12
Logic Functions - Book 1

INTERFACE BLOCK

16 Memory Module Database Version Error Unacknowledged (MDVERUAK)................. – WR


The unacknowledged “memory module database version error” diagnostic indicates if the
error is or is not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

17 Memory Module Database Version Error Active (MDVERACT).....................................– – R


A module database was not downloaded because the instrument does not have the hardware
and/or firmware resources to run it.
YES 1 “MEMORY MODULE DATABASE VERSION ERROR” is active.
NO 0 Diagnostic error is not active.

18 Memory module is write protected (MDWPSUP) ............................................................CWR


The memory module is write protected diagnostic checks if the memory module is write
protected (the switch on the module is in the ‘read only’ position. The diagnostic can be
suppressed or enabled as follows:
SUPPRESS 1 Diagnostic error is suppressed.
ENABLE 0 Diagnostic error is enabled.

19 Memory Module is Write Protected Unacknowledged (MDWPUAK)............................ – WR


The unacknowledged “memory module is write protected” diagnostic indicates if the condition
is or is not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

20 Memory Module is Write Protected Active (MDWPACT)..............................................– – R


The memory module is write protected (the switch on the module is in the ‘read only’ position.
YES 1 “MEMORY MODULE IS WRITE PROTECTED” is active.
NO 0 Diagnostic error is not active.

21 Memory module is soft write protected (MDSWPSUP)..................................................CWR


The memory module is soft write protected diagnostic checks if the write protect bit in the
module RAM has been set by software. The diagnostic can be suppressed or enabled as
follows:
SUPPRESS 1 Diagnostic error is suppressed.
ENABLE 0 Diagnostic error is enabled.

22 Memory module is soft write protected Unacknowledged (MDSWPUAK) .................. – WR


The unacknowledged “memory module is soft write protected” diagnostic indicates if the
condition is or is not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

3-13
Logic Functions - Book 1

INTERFACE BLOCK

23 Memory module is soft write protected Active (MDSWPACT)...................................... – – R


The write protect bit in the module RAM has been set by software.
YES 1 “MEMORY MODULE IS SOFT WRITE PROTECTED” is active.
NO 0 Diagnostic error is not active.

24 Instrument is overconfigured (OVRUNSUP) .................................................................. CWR


The “instrument is overconfigured” diagnostic checks if the instrument is able to complete all
of its tasks at the intervals specified. The diagnostic can be suppressed or enabled as follows:
SUPPRESS 1 Diagnostic error is suppressed.
ENABLE 0 Diagnostic error is enabled.

25 Instrument is overconfigured Unacknowledged (OVRUNUAK)....................................– WR


The unacknowledged instrument is overconfigured diagnostic indicates if the condition is or is
not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

26 Instrument is overconfigured Active (OVRUNACT)....................................................... – – R


The instrument is unable to complete all of its tasks at the intervals specified. The scan
execution times should be examined to determine which tasks should be simplified or run at a
slower rate or items should be moved to another task. Note that when the instrument is
overconfigured, all tasks will run at a proportionally slower rate. This may be a temporary
condition if instrument is getting too many messages. You should not ignore this condition if it
is persistent.
YES 1 “INSTRUMENT IS OVERCONFIGURED” is active.
NO 0 Diagnostic error is not active.

27 Instrument powered up (PWRUPSUP) ............................................................................ CWR


The instrument powered up diagnostic checks if the instrument went through power up. The
diagnostic can be suppressed or enabled as follows:
SUPPRESS 1 Diagnostic error is suppressed.
ENABLE 0 Diagnostic error is enabled.

28 Instrument powered up Unacknowledged (PWRUPUAK) .............................................– WR


The unacknowledged instrument powered up diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

29 Instrument powered up Active (PWRUPACT) ................................................................ – – R


The instrument went through power up. A time stamp indicating the time power was restored
is entered in the event queue.
YES 1 “INSTRUMENT POWERED UP” is active.
NO 0 Diagnostic error is not active.

3-14
Logic Functions - Book 1

INTERFACE BLOCK

30 Instrument powered down (PWRDNSUP) .......................................................................CWR


The instrument powered down diagnostic checks if the instrument lost power. The diagnostic
can be suppressed or enabled as follows:
SUPPRESS 1 Diagnostic error is suppressed.
ENABLE 0 Diagnostic error is enabled.

31 Instrument powered down Unacknowledged (PWRDNUAK) ....................................... – WR


The unacknowledged instrument powered down diagnostic indicates if the condition is or is
not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

32 Instrument powered down Active (PWRDNACT)............................................................– – R


The instrument lost power. A time stamp indicating the time power was lost is entered in the
event queue.
YES 1 “INSTRUMENT POWERED DOWN” is active.
NO 0 Diagnostic error is not active.

33 Communications Port Mismatch Unacknowledged (COMPTUAK) .............................. – WR


The unacknowledged communications port mismatch diagnostic indicates if the condition is or
is not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

34 Communications Port Mismatch Active (COMPTACT) ..................................................– – R


Mismatch occurs when an ICN module (2030N) is installed but no matching ICN block was
found in the user database. Matching includes slot numbers and the module address switch
setting, if not 'ANY' in the ICN block. The same mismatch occurs if an RS232 module (2033N)
or an RS485 module (2034N) is installed but no matching MSC block was found in the user
database, slot numbers do not match, or the block address information does not match unless
'ANY' is configured in the MSC block.
YES 1 “COMMUNICATIONS PORT MISMATCH” is active.
NO 0 Diagnostic error is not active.

35 Instrument Shutdown Fault Unacknowledged (SHUTDUAK)....................................... – WR


The unacknowledged instrument shutdown fault diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

36 Instrument Shutdown Fault Active (SHUTDACT) ...........................................................– – R


When the instrument was last powered, an event occurred which caused it to shut down. It is
now locked in the DEFAULT state. The user should investigate the cause of the shutdown
and try running the instrument again, if desired, by writing ACK SHUTDOWN FAULT (value 1)
to the command attribute of the interface block. This acknowledges that the user has seen the
information relating to a previous shutdown fault and reinitializes the SHUTDOWN INFO area.
Until this is done, the instrument will not accept commands which could cause it to leave the
DEFAULT state. Information preserved at shutdown is stored in the non checksummed save

3-15
Logic Functions - Book 1

INTERFACE BLOCK

area in the battery backed up RAM and is examined through the configurator STATUS display
activity.
YES 1 “INSTRUMENT SHUTDOWN FAULT” is active.
NO 0 Diagnostic error is not active.

37 Module Shutdown Fault Unacknowledged (MSHUTUAK) .............................................– WR


The unacknowledged module shutdown fault diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

38 Module Shutdown Fault Active (MSHUTACT) ................................................................ – – R


When the memory module was last used, the instrument on which it was installed suffered a
shutdown fault. The shutdown information preserved in the module is stored in volatile RAM
and is examined through the configurator STATUS display activity. The battery backed up
RAM must be write protected to prevent this data from being overwritten when powered up for
examining on another instrument.
YES 1 “MODULE SHUTDOWN FAULT” is active.
NO 0 Diagnostic error is not active.

39 Processor Watchdog Fault Unacknowledged (WDOGUAK) .........................................– WR


The unacknowledged processor watchdog fault diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

40 Processor Watchdog Fault Active (WDOGACT) ............................................................ – – R


When the instrument was last powered, the processor got 'lost' and the watchdog timer shut
the instrument down. See INSTRUMENT SHUTDOWN FAULT.
YES 1 “PROCESSOR WATCHDOG FAULT” is active.
NO 0 Diagnostic error is not active.

41 Spurious Event Fault Unacknowledged (SPURUAK).....................................................– WR


The unacknowledged spurious event fault diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

42 Spurious Event Fault Active (SPURACT)........................................................................ – – R


When the instrument was last powered, the processor was interrupted by an unexpected
event (i.e. it had no handler to respond to the event) and the instrument therefore shut down.
See INSTRUMENT SHUTDOWN FAULT.
YES 1 “SPURIOUS EVENT FAULT” is active.
NO 0 Diagnostic error is not active.

3-16
Logic Functions - Book 1

INTERFACE BLOCK

43 EPROM Checksum Fault Unacknowledged (EPCHKUAK)............................................ – WR


The unacknowledged EPROM checksum fault diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

44 EPROM Checksum Fault Active (EPCHKACT)................................................................– – R


When the instrument was last powered, a checksum error was found in the identity module
EPROM and the instrument therefore shut down. See INSTRUMENT SHUTDOWN FAULT.
YES 1 “EPROM CHECKSUM FAULT” is active.
NO 0 Diagnostic error is not active.

45 Bad RAM Fault Unacknowledged (BDRAMUAK) ........................................................... – WR


The unacknowledged bad RAM fault diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

46 Bad RAM Fault Active (BDRAMACT)................................................................................– – R


When the instrument was last powered, one of the RAM chips failed the read/write test, and
the instrument therefore shut down. The error address is preserved at shutdown. See
INSTRUMENT SHUTDOWN FAULT.
YES 1 “BAD RAM FAULT” is active.
NO 0 Diagnostic error is not active.

47 I/O board 1 communications error (IO1CSUP) ...............................................................CWR


The I/O board 1 communications error diagnostic checks if an error (no response or bad
message checksum) occurred in trying to communicate with i/o board 1. The diagnostic can
be suppressed or enabled as follows:
SUPPRESS 1 Diagnostic error is suppressed.
ENABLE 0 Diagnostic error is enabled.

48 I/O board 1 communications error Unacknowledged (IO1CUAK)................................ – WR


The unacknowledged I/O board 1 communications error diagnostic indicates if the condition is
or is not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

49 I/O board 1 communications error Active (IO1CACT)....................................................– – R


An error (no response or bad message checksum) occurred in trying to communicate with i/o
board 1. There are wrap around counters for these errors at IF1,SLNORSPS and
IF1,SLCHKSMS.
YES 1 “I/O BOARD 1 COMMUNICATIONS ERROR” is active.
NO 0 Diagnostic error is not active.

3-17
Logic Functions - Book 1

INTERFACE BLOCK

95 Bad Clock Chip Unacknowledged (BDCLKUAK) ............................................................– WR


The unacknowledged bad clock chip diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

96 Bad Clock Chip Active (BDCLKACT) ............................................................................... – – R


The real time clock chip is not working correctly. Time and date information will not remain
current through a power outage.
YES 1 “BAD CLOCK CHIP” is active.
NO 0 Diagnostic error is not active.

97 Time and date not valid (TIMNSSUP) .............................................................................. CWR


The time and date not valid diagnostic checks if the time of day, calendar date, and day of
week need to be set. The diagnostic can be suppressed or enabled as follows:
SUPPRESS 1 Diagnostic error is suppressed.
ENABLE 0 Diagnostic error is enabled.

98 Time and date not valid Unacknowledged (TIMNSUAK) ...............................................– WR


The unacknowledged time and date not valid diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

99 Time and date not valid Active (TIMNSACT) .................................................................. – – R


The time of day, calendar date, and day of week need to be set.
YES 1 “TIME AND DATE NOT VALID” is active.
NO 0 Diagnostic error is not active.

100 I/O is Locked Unacknowledged (IOLOKUAK) .................................................................– WR


The unacknowledged I/O is locked diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

101 I/O is Locked Active (IOLOKACT) .................................................................................... – – R


The I/O lock active is set when Attribute 195, Lock I/O blocks? (IOLOCK) is YES.
YES 1 “I/O IS LOCKED” is active.
NO 0 Diagnostic error is not active.

102 Communication Blocks are Locked Unacknowledged (CMLOKUAK)..........................– WR


The unacknowledged communication blocks are locked diagnostic indicates if the condition is
or is not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

3-18
Logic Functions - Book 1

INTERFACE BLOCK

103 Communication Blocks are Locked Active (CMLOKACT) .............................................– – R


The communications blocks locked active is set when Attribute 158, Lock ICN
Communications Blocks? (COMMLOCK) is YES.
YES 1 “COMMUNICATION BLOCKS ARE LOCKED” is active.
NO 0 Diagnostic error is not active.

104 DMA Unacknowledged (DMAUAK) .................................................................................. – WR


The unacknowledged DMA transfer diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

105 DMA Active (DMAACT) ......................................................................................................– – R


The active DMA transfer diagnostic is set when an error occurs in a DMA transfer and the
instrument therefore shuts itself down. The diagnostic is readable when the instrument is
powered up again. See Instrument Shutdown Fault (#036).
YES 1 “DMA FAULT” is active.
NO 0 Diagnostic error is not active.
106 I/O Overrun (IOVRNSUP)...................................................................................................CWR
The I/O overrun diagnostic indicates that the instrument was unable to complete all of its I/O
communications and processing before the data was required by a user task. This error
always forces an INSTRUMENT IS OVERCONFIGURED diagnostic and all tasks will be
scanned at a slower rate so that all the I/O work is completed. The diagnostic can be
suppressed or enabled as follows:
SUPPRESS 1 Diagnostic error is suppressed.
ENABLE 0 Diagnostic error is enabled.

107 I/O Overrun Unacknowledged (IOVRNUAK)................................................................... – WR


The unacknowledged I/O overrun diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

108 I/O Overrun Active (IOVRNACT) .......................................................................................– – R


The instrument is unable to complete all I/O sampling at the intervals specified. The scan
execution times should be examined to determine which tasks should be simplified or run at a
slower rate. Note that when the instrument is overconfigured, all tasks will run at a
proportionally slower rate.
YES 1 “I/O OVERRUN” is active.
NO 0 Diagnostic error is not active.

109 Communication Hardware Fault Unacknowledged (CMHWFUAK) .............................. – WR


The unacknowledged communication hardware fault diagnostic indicates if the condition is or
is not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

3-19
Logic Functions - Book 1

INTERFACE BLOCK

110 Communication Hardware Fault Active (CMHWFACT) ................................................. – – R


When a communication module is inserted in slots 9 and 10 of a MOD 30ML (1800R) and the
built-in communication jumpers are set, a conflict of resources occurs since both require use
of communication port 1. The instrument will be placed in the DEFAULT state. No block will
be built for either case, leaving PC communication only available via communication module in
slot 7 & 8.
YES 1 “COMM HARDWARE FAULT” is active.
NO 0 Diagnostic error is not active.

111 EEPROM Fault Unacknowledged (EEPFUAK) ................................................................– WR


The unacknowledged EEPROM fault diagnostic indicates if the condition is or is not
acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

112 EEPROM Fault Active (EEPFACT) ................................................................................... – – R


The data stored in EEPROM of a MOD 30ML (1800R) could not be loaded into the instrument
database. Default values were loaded and are being used. The data values include the
calibration data for the built-in I/O and communication parameters for built-in communication
port.
YES 1 “EEPROM FAULT” is active.
NO 0 Diagnostic error is not active.

113 Memory Module Download Failed Unacknowledged (MDDLFUAK) .............................– WR


The unacknowledged memory module download failed diagnostic indicates if the condition is
or is not acknowledged. The status can be read or acknowledged as follows:
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

114 Memory Module Download Failed Active (MDDLFACT) ................................................ – – R


The memory module database was not downloaded. Another diagnostic will be present to
indicate why the download did not happen.
YES 1 “MEMORY MODULE DOWNLOAD FAILED ” is active.
NO 0 Diagnostic error is not active.

3-20
Logic Functions - Book 1

INTERFACE BLOCK

End of Diagnostic Attributes


126 Base Scan Time (SCANTIME) ...........................................................................................– – R
Average milliseconds of processor time between base scan ticks (00:00:00.050, unless
overconfigured).

127 Scan Idle Time (IDLETIME) ...............................................................................................– – R


Average milliseconds of unused processor time between base scan ticks.

128 NOVRAM Clock Set Error (SNCLKERR) ..........................................................................– – R


Error code associated with setting the novram clock and the diagnostic bad clock chip. Values
are:
Clock OK 0
Bad Input Quality 7
DMA Bus Error Source 8
DMA Bus Error Dest 9

129 NOVRAM Clock Read Error (RNCLKERR) .......................................................................– – R


Error code associated with setting the novram clock and the diagnostic bad clock chip. Values
are:
Clock OK 0
Oscillator OFF 1
Bad Year Data 2
Bad Month Data 3
Bad Day of Month Data 4
Bad Day of Week Data 5
Bad Time of Day Data 6
Bad Input Quality 7
DMA Bus Error Source 8
DMA Bus Error Dest 9
Clock Compare Error 10

130 Select Module No Response (SLNORSPS) .................................................................... – WR


Wrap around counter of ‘no response’ events for all select modules.

131 Select Module Checksum Errors (SLCHKSMS) ............................................................. – WR


Wrap around counter of checksum errors for all select modules.

132 I/O Module No Response (MDNORSPS) ......................................................................... – WR


Wrap around counter of ‘no response’ events for all intelligent i/o modules.

133 I/O Module Checksum Errors (MDCHKSMS).................................................................. – WR


Wrap around counter of checksum errors for all intelligent i/o modules.

3-21
Logic Functions - Book 1

INTERFACE BLOCK

Basic Configuration Attributes


134 Power Line Frequency (FREQ) ........................................................................................C – R
Power Line Frequency is used by certain I/O modules for proper noise rejection. The valid
values are:
50 0 The frequency of the ac input power to the instrument is 50 hertz.
60 1 The frequency of the ac input power to the instrument is 60 hertz.

135 User Tag (USRTAG) .......................................................................................................... CWR


A user tag with up to 27 configurable or readable ASCII characters that identifies the
instrument (25 can only be written). This is a standard ASCII data type, with the number of
valid characters stored in the first byte of the field. Field size is always 28 bytes.

136 Configurator Tag (CFGTAG) ............................................................................................ – – R


Up to 27 ASCII characters generated automatically as a time stamp by the configurator. This
is a standard ASCII data type, with the number of valid characters stored in the first byte of the
field. Field size is always 28 bytes.

137 Database Size (DBSIZE).................................................................................................... – – R


Size of the database in bytes.

138 I/O Mismatch (IOMM) ........................................................................................................ – – R


YES 1 An I/O mismatch exists in the database.
NO 0 No I/O mismatch exists in the database.

General Instrument Status Attributes


139 Instrument State (INSTATE) ............................................................................................. – – R
Identifies the current instrument state.
UPLOAD 0 Instrument was powered up with memory module switch in the
upload position and will do nothing beyond copying the main
database (if it is 'complete' and its checksums verify) into the
memory module.
DEFAULT 2 The instrument does not have a valid user generated database
and is therefore running a default database to sustain
communications, etc.
BEING CONFIGURED 3 An external device has configuration control and is authorized to
download. The instrument is running the default database in
expectation of downloads to the main.
HOLD 4 The instrument has a valid user database, but is running only
overhead blocks. (No loops).
LOCAL HOLD 5 Instrument has a valid user database and would be in RUN but
is prevented by the run_hold_switch and is running only
overhead blocks.
RUN 6 Instrument has a valid user database and is running all blocks.

3-22
Logic Functions - Book 1

INTERFACE BLOCK

140 Next Instrument State (NXTISTAT) ................................................................................ – W R


Under steady state conditions, next instrument state will be equal to instrument state. Writing
to it constitutes a command to go to a new state. Be aware that changing the instrument state
from RUN to DEFAULT or BEING CONFIGURED causes the instrument to stop sending
foreground data and communications will be lost to any runtime front end. Values accepted
are:
DEFAULT 2 See Instrument State.
BEING CONFIGURED 3 See Instrument State.
HOLD 4 See Instrument State.
RUN 6 See Instrument State.
HOLD WARM START 7 Used to switch from the default to the main database without
forcing cold start initialization of the main database.
RUN WARM START 8 Used to switch from the default to the main database without
forcing cold start initialization of the main database. The I/O
mismatch condition is ignored.

141 Command (CMD) .............................................................................................................. – WR


This provides a dummy location in the database to which commands can be addressed using
a long state variable. The value read from this location will always be 0. The following values,
when written to this location, will be interpreted as commands. The command is executed
when the instrument finds an appropriate processing point.
Ack Shutdown Fault 1 Acknowledges that the user has seen the information relating to
a previous shutdown fault and reinitializes the Shutdown Info
area by doing a reset. This puts the instrument in a state it
would have been in had there been no fault.
Upload to Module 2 Uploads database to memory module. Valid anytime.
Download from Module 3 Instrument must be in the Being Configured state before the
database can be downloaded from the memory module.
Set Write Protect 4 Sets a software write protect of the memory module.

Clear Write Protect 5 Clears software write protect and uploads to the memory
module. Valid even in upload, where a failed upload will be
completed and the red LED will stop flashing.
Delete Main Database 6 Marks the main database bad and sets the instrument state to
DEFAULT. Valid anytime.
Restore Main Database 7 Marks the main database good (in case delete main database
was issued by mistake). Note that the database will actually be
good only if it passes normal verification, e.g. when attempting
to go to the RUN instrument state. Valid anytime.
Reset 8 Completes tasks and then does a power-up.
Kill 9 Performs an immediate power-up.
Clear MTIMEs 10 Clear the maximum scan time for all scan groups.

142 Time of Day (TIMEDAY).................................................................................................... – WR


A millisecond time variable that gives the time of day in milliseconds (up to 86400000).

143 Time of Day Quality (TIMEDAYQ).....................................................................................– – R


Quality byte for time of day attribute.

3-23
Logic Functions - Book 1

INTERFACE BLOCK

144 Calendar Date (DATE) .......................................................................................................– WR


A three byte value where the first byte is the calendar year (0 to 99), the second is the
calendar month (1 to 12) where 1 = January and 12 = December, and the third is the calendar
day (1 to 31). Note that years 90 to 99 are assumed to be 1990 to 1999.

145 Calendar Date Quality (DATEQ)....................................................................................... – – R


Quality byte for date attribute.

146 Day of Week (DAY) ............................................................................................................– WR


A short state value for the day of the week where 1 = Sunday and 7 = Saturday.

147 Day of Week Quality (DAYQ) ............................................................................................ – – R


Quality byte for day of week attribute.

Interface Block Status Attributes


148 Computer Status (CPSTATUS) ........................................................................................ – – R
Used to indicate computer status of controlling source for all overhead blocks.
Free 0 Indicates no computer has control.
Busy 1 Indicates some computer has control.
Inactive 2 Indicates no computer can get control, since there are no authorized
computer sources.

149 Console Status (CNSTATUS) ........................................................................................... – – R


Used to indicate console status of controlling source for all overhead blocks.
Free 0 Indicates no console has control.
Busy 1 Indicates some console has control.

Startup Conditions Attributes


150 Warm start duration (WARMSDUR) ................................................................................. CWR
A power-down/restart interval less than this will result in a warm start. Times less than 1
second are not useful because of potential drift between the battery backed and run time
clocks. If the clock chip is bad, the instrument will assume a power out time less than warm
start duration (unless warm start duration is NONE), and will begin timing at the power down
time. Valid values are:
NONE (zero)
INFINITY
Any time greater than 1 second

151 Cold start duration (COLDSDUR) .................................................................................... CWR


The cold start duration can be INFINITY or any power-down/restart time less than infinity and
greater than the warm start duration.

152 Run on mismatch (RUNMISMT) ....................................................................................... CWR


YES 1 The instrument does not stop in HOLD when an i/o mismatch is
detected in attempting to go to RUN. This can occur at power up
when the database or i/o is 'new', so that previous state doesn't
apply, or when the instrument is in the default or being configured
state and the user issues a run command.

3-24
Logic Functions - Book 1

INTERFACE BLOCK

NO 0 The instrument does stop in HOLD when an i/o mismatch is detected


in attempting to go to RUN.

153 Download on warm start (DNLDWARM) ..........................................................................CWR


YES 1 The instrument will download from the (present and otherwise valid)
memory module on a warm, cold or frozen start.
NO 0 The instrument will download only on a cold or frozen start. This
allows a user to (for instance) write protect a module with cold start
values in it and have it download only on cold start.

154 Power Out Duration (POUTDUR) .....................................................................................– – R


Number of milliseconds between the most recent power down and the most recent power up.

155 Startup Type (STARTYPE) ................................................................................................– – R


If the power-down/restart interval was greater than the cold start duration, one of the following
startup types will occur:
WARM 1 See Section 2.4.2
COLD 2 See Section 2.4.2
FROZEN 3 See Section 2.4.2

156 Power Up Initialization (PWRUP) .....................................................................................– – R


YES indicates the instrument either lost power or was just powered up. The "YES" condition
will last through one complete execution of the slowest task.

157 Runtime Initialization (RUNINIT) ......................................................................................– – R


YES indicates the instrument has just entered the run state. The "YES" condition will last
through one complete execution of the slowest task.

Database Execution Attributes


158 Lock ICN Communications Blocks? (COMMLOCK) .......................................................CWR
If YES, output communication blocks will not fetch data from their source pointers (they will
continue to send out their current value), and input communication blocks will not refresh their
outputs from received messages. Input and output communication block outputs can be
written to by the operator.

159 Scan Group 1 Interval (INT1)............................................................................................. C – R


160 Scan Group 2 Interval (INT2)............................................................................................. C – R
161 Scan Group 3 Interval (INT3)............................................................................................. C – R
162 Scan Group 4 Interval (INT4)............................................................................................. C – R
163 Scan Group 5 Interval (INT5)............................................................................................. C – R
The first five scan group intervals correspond to user defined loops and function blocks. The
group with the fastest scan interval has the highest priority. If two groups have the same
interval, the lower numbered group (1) has the higher priority. These are configurable
attributes. The valid values are:
NONE
msec time value0:00:00.050 to 1193:02:47.295
All entries must be a multiple of 50 milliseconds (.050). Configurator
rounds entry to nearest multiple of base rate.

3-25
Logic Functions - Book 1

INTERFACE BLOCK

164 Scan 6 Interval (INT6)........................................................................................................ – – R


The Interface and System Event Block scan group interval is set at 50 milliseconds. This task
manages instrument states, services diagnostics and the event queue, services the I/O, and
provides self checking (checksums).

165 Scan 7 Interval (INT7)........................................................................................................ – – R


166 Scan 8 Interval (INT8)........................................................................................................ – – R
167 Scan 9 Interval (INT9)........................................................................................................ – – R
ICN and Serial Communications Block 50 millisecond scan intervals for the communication
ports in the order found in the database (one task per module).

168 Scan 1 Execution Time (XTIME1) .................................................................................... – – R


169 Scan 2 Execution Time (XTIME2) .................................................................................... – – R
170 Scan 3 Execution Time (XTIME3) .................................................................................... – – R
171 Scan 4 Execution Time (XTIME4) .................................................................................... – – R
172 Scan 5 Execution Time (XTIME5) .................................................................................... – – R
173 Scan 6 Execution Time (XTIME6) .................................................................................... – – R
174 Scan 7 Execution Time (XTIME7) .................................................................................... – – R
175 Scan 8 Execution Time (XTIME8) .................................................................................... – – R
176 Scan 9 Execution Time (XTIME9) .................................................................................... – – R
Recent msec scan time for the associated scan group. This value is the number of
milliseconds of processor time used by each task in its most recent execution.

177 Scan 1 Filtered Execution Time (FTIME1)....................................................................... – – R


178 Scan 2 Filtered Execution Time (FTIME2)....................................................................... – – R
179 Scan 3 Filtered Execution Time (FTIME3)....................................................................... – – R
180 Scan 4 Filtered Execution Time (FTIME4)....................................................................... – – R
181 Scan 5 Filtered Execution Time (FTIME5)....................................................................... – – R
182 Scan 6 Filtered Execution Time (FTIME6)....................................................................... – – R
183 Scan 7 Filtered Execution Time (FTIME7)....................................................................... – – R
184 Scan 8 Filtered Execution Time (FTIME8)....................................................................... – – R
185 Scan 9 Filtered Execution Time (FTIME9)....................................................................... – – R
Average msec scan time for the associated scan group (updates after group executes).

186 Scan 1 Maximum Execution Time (MTIME1) ..................................................................– WR


187 Scan 2 Maximum Execution Time (MTIME2) ..................................................................– WR
188 Scan 3 Maximum Execution Time (MTIME3) ..................................................................– WR
189 Scan 4 Maximum Execution Time (MTIME4) ..................................................................– WR
190 Scan 5 Maximum Execution Time (MTIME5) ..................................................................– WR
191 Scan 6 Maximum Execution Time (MTIME6) ..................................................................– WR
192 Scan 7 Maximum Execution Time (MTIME7) ..................................................................– WR
193 Scan 8 Maximum Execution Time (MTIME8) ..................................................................– WR
194 Scan 9 Maximum Execution Time (MTIME9) ..................................................................– WR
Maximum msec scan time for the associated scan group since entering the current instrument
state. Value can be reset by writing any value to it.

195 Lock I/O blocks? (IOLOCK) .............................................................................................. CWR


If YES, output function block values will not be copied to the output module block output value,
and input module block values will not be copied to the input function blocks. Field input
values will continue to be updated in the input module blocks and output module block values
can be written to by the operator.

3-26
Logic Functions - Book 1

INTERFACE BLOCK

196 Run completion cycles (RCCYCLES) ..............................................................................CWR


When leaving the RUN state, the instrument will wait up to ‘run completion cycles’ executions
(1 to 125) of the slowest user task for the run complete input to go TRUE. At that time it will
leave the run state regardless of the run complete input value.

197 Run complete input (RUNCMPLT) ...................................................................................CWR


Writable only if local data. When commanded to leave RUN, the instrument will wait (but only
up to ‘run completion cycles’ executions of the slowest user task) for this input to go TRUE
before changing states.

None No run complete input. Instrument will change state when commanded.

TRUE 1 Local input TRUE causes instrument to leave RUN when commanded.

FALSE 0 Local input FALSE causes instrument to wait ‘x’ run completion cycles before
leaving RUN when commanded.

LSP Logical source pointer determines TRUE or FALSE condition.

3.3.3 Typical Block Connections for Interface Block

Typical softwiring block structures used on softwiring diagrams are shown in Figure 3-5.

IF1
CMD Logical Source Pointer to
Logical Source Pointer from another Command another function block
function block
Instrument State
INSTATE
Operator indication of
User Tag Instrument State, Tag, and
USRTAG
Time of Day
Time of Day
TIMEDAY

Operator write access to change Tag and Time of Day

Figure 3-5. Interface Block, Typical Connections

3.3.3 Interface Block Events

The following event code errors (and their suggested text) must be acknowledged.
Informational events are not acknowledged. The order of values is not significant.

Event Codes (see referenced database attributes (in brackets) for descriptions)
4 DEFAULT DATABASE CHECKSUM ERROR (5)
5 MAIN DATABASE CHECKSUM ERROR (7)
6 INSTRUMENT IS UNCONFIGURED (9)
7 MAIN DATABASE VERSION ERROR (11)
8 MEMORY MODULE CHECKSUM ERROR (13)
9 MEMORY MODULE IS UNCONFIGURED (15)
10 MEMORY MODULE DATABASE VERSION ERROR (17)
11 MEMORY MODULE IS WRITE PROTECTED (20)
12 MEMORY MODULE IS SOFT WRITE PROTECTED (23)

3-27
Logic Functions - Book 1

INTERFACE BLOCK

13 INSTRUMENT IS OVERCONFIGURED (26)


14 INSTRUMENT POWERED UP (29)
15 INSTRUMENT POWERED DOWN (32)
16 COMMUNICATIONS PORT MISMATCH (34)
17 INSTRUMENT SHUTDOWN FAULT (36)
18 MODULE SHUTDOWN FAULT (38)
19 PROCESSOR WATCHDOG FAULT (40)
20 SPURIOUS EVENT FAULT (42)
21 EPROM CHECKSUM FAULT (44)
22 BAD RAM FAULT (46)
23 I/O BOARD 1 COMMUNICATIONS ERROR (49)
24 through 38 reserved
39 BAD CLOCK CHIP (96)
40 TIME AND DATE NOT VALID (99)
41 I/O IS LOCKED (101)
42 COMMUNICATION BLOCKS ARE LOCKED (103)
43 DMA FAULT (105)
44 I/O OVERRUN (108)
45 COMM HARDWARE FAULT (110)
46 EEPROM FAULT (112)
47 MEMORY MODULE DOWNLOAD FAILED (114)

Informational Events
128 DOWNLOAD FROM MEMORY MODULE
The memory module database was downloaded to main ram.
129 UPLOAD TO MEMORY MODULE
The user database was uploaded to the memory module.
130 DOWNLOAD FROM SYSTEM
A full or partial database download was received from the external system.
131 UPLOAD TO SYSTEM
A database was uploaded to the external system.
132 INSTRUMENT IN UPLOAD STATE
The instrument has entered the upload state and is now running the default database.
133 INSTRUMENT IN DEFAULT STATE
The instrument has entered the default state and is now running the default database.
134 INSTRUMENT BEING CONFIGURED
The instrument has entered the being configured state and is running the default database to
make the main database area available for downloading.
135 INSTRUMENT IN HOLD STATE
The instrument has entered the hold state and is now running only the i/o section of the user
database.
136 INSTRUMENT IN LOCAL HOLD STATE
The instrument has entered the local hold state and is now running only the i/o section of the
user database. It will enter the run state if the run/hold switch is moved to run.
137 INSTRUMENT IN RUN STATE
The instrument has entered the run state and is now running the full user database.
138 TIME STAMP CHANGED
Indicates that time of day, calendar date or day of week has been written to.

3-28
Logic Functions - Book 1

SYSTEM EVENT BLOCK

3.4 SYSTEM EVENT BLOCK (SE1)


The system event block is an environment block that supports general instrument
operation. One system event block is supported as part of the instrument configuration to
define diagnostic and system event acknowledgement and reporting capabilities. System
events are events that occur in the instrument, are reported by database blocks, and can
be stored into the system event queue. The different types of system events are:
Informational only, Process Alarms, Notification/Request Messages, Diagnostics and
Acknowledge Only Diagnostics. The system event queue stores a configurable number of
time stamped event codes for the diagnostic points and events reported by the database
blocks. These codes are translated into messages for operator display or logging by the
interface software.
Available to the user as block outputs are the active and inactive status of all diagnostic
points and count values for different diagnostic conditions and event queue entries. A
functional block diagram of the block is shown in Figure 3-6. The menus, which are used
to configure the block, are shown in Figure 3-7, Figure 3-8 and Figure 3-9.

General Events
Report
Diagnostic Events Events
PA and NM Events (Yes/No)

NONE
Global GOOD
Acknowledge Suppression
Input Event Queue
Discrete LSP Size (Diagnostic
BAD (0 to 1000) Groups or ALL)
(Yes/No)

NONE
Diagnostic GOOD
Acknowledge ANYACT
Input
Discrete LSP
ANYUNK
BAD
NUMACT

System Event NUMUNK


NONE
Process NUMABN
Alarm GOOD
Discrete LSP Acknowledge
Input DGCTR
BAD
QID

QENDID
NONE
Notif/Req GOOD
Discrete LSP Msg. Acknowledge
Input

BAD
Write Only
Commands

State
(RUN)
Clear Queue
Global Acknowledge
Quality Check Diagnostic Ack.
Process Alarm Ack.
Bad Inputs
Accepted Notif/Req Msg Ack.
(YES/NO)

Figure 3-6. System Event Block (SE), Block Diagram

3-29
Logic Functions - Book 1

SYSTEM EVENT BLOCK

Figure 3-7. System Event Block (SE), General Menu

Figure 3-8. System Event Block (SE), Diagnostic Menu

3-30
Logic Functions - Book 1

SYSTEM EVENT BLOCK

Figure 3-9. System Event Block (SE), Alarms Menu

3.4.1 System Event Block Operation


System events are handled in the following way:
• When an event is generated, an entry corresponding to that event is stored in the
circular buffer (the size of this system event queue is configurable), and the queue
entry ID (QID) attribute in the system event block is incremented.
• Whenever the QID attribute value changes, the interface software should request new
information from the circular buffer. The interface software may maintain a circular
buffer of its own size, with its own local rules about display and acknowledge.
• Most events, including those indicating hardware faults, are processed by database
blocks.
• Any block that generates a diagnostic event may have an attribute for suppression of
that event. In addition, attributes for suppression of groups of diagnostic events are
provided by the system event block. Some diagnostic errors in a database block have
counter attributes that are incremented with each occurrence of the error condition
even when the events are suppressed. These events have addressable attributes in
the block.
• Event entries are stored in the circular buffer at 10 bytes each, where each entry is
broken down as to block type, block occurrence, event code, event transition, date,
and time. See Section 3.4.4 for a listing of suggested text related to system event
codes and Section 3.4.5 for transitions. See the appropriate block type for event
codes and messages for that block. Each system event code (0 to 255) or diagnostic
event code (4 to 127) describes a particular event which is translated into a text
message or logged through the appropriate interface software.

3-31
Logic Functions - Book 1

SYSTEM EVENT BLOCK

• Example of events displayed by a user’s display (PC-30 device tag and header shown
for example only):
HH:MM:SS.mmm TAGxxxxx DDOM125 Remaining message = 47 characters total

DATE: Thu Apr 25/91


Device Block Transi-
TIME Tag /Occ. Event Code Message tion Msg
10:05:44.055 503TL ICN2 INVALID MESSAGE RECEIVED. uak-only
10:05:53.150 503TL ICN2 INVALID MESSAGE RECEIVED. acked
11:23:04.755 503TL IF1 INSTRUMENT BEING CONFIGURED.
11:23:12.410 503TL IF1 DOWNLOAD FROM SYSTEM.
11:24:49.237 503TL SE1 SYSTEM EVENT QUEUE CLEARED.
11:24:50.345 503TL IF1 INSTRUMENT IN RUN STATE.
15:03:25.673 503TL IC5 NOT RECEIVING DATA. act/uak
15:03:25.725 503TL IC23 NOT RECEIVING DATA. act/uak
15:03:25.763 503TL IC17 NOT RECEIVING DATA. act/uak
15:04:02.086 503TL SE1 ALL DIAGNOSTICS GLOBALLY ACKED.
15:04:02.130 503TL IC5 NOT RECEIVING DATA. acked
15:05:02.185 503TL IC23 NOT RECEIVING DATA. acked
15:05:02.238 503TL IC17 NOT RECEIVING DATA. acked
15:08:15.758 503TL IC5 NOT RECEIVING DATA. clr/ack
15:08:15.809 503TL IC23 NOT RECEIVING DATA. clr/ack
15:08:15.866 503TL IC17 NOT RECEIVING DATA. clr/ack

• The system event queue is cleared when a database is downloaded from the PC
configurator and when a database is downloaded from a write protected memory
module.
• The following Communication Link messages related to this block are supported by
the instrument:
READ EVENT QUEUE
READ DIAG STATUS
REFRESH DIAG STATUS
ALARM ACK
DIAGNOSTIC ACK

3.4.2 System Event Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 3-2. The following
further defines the System Event Block configuration parameters.

Block Type
SE This is the System Event Block type and is always present on the Main
Block Selection page.

Occurrence
1 There is only one ‘instance’ allowed of the system event block.

02 State (STATE) ..............................................................................................................– – R


Not configurable in this block (always equal to RUN). This block is always executed
(normal operation). See Section 2.4.1, State Changes for additional information.

03 Bad Inputs (BADINP)...................................................................................................CWR


See Section 2.3.2, Data Quality for additional information.

ACCEPTED 1 The four acknowledge inputs are used without regards to quality.
REJECTED 0 Block checks data quality on its inputs and will only use the data
pointed at if the data quality is good.

3-32
Logic Functions - Book 1

SYSTEM EVENT BLOCK

Table 3-2. System Event Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs BADINP Rejected (0), Accepted(1) CWR Discrete 03
All Groups Diag. Supp. SUPALL NO (0), YES (1) CWR Discrete 04
Group 1 Diag. Suppression SUPGP1 NO (0), YES (1) CWR Discrete 05
Group 2 Diag. Suppression SUPGP2 NO (0), YES (1) CWR Discrete 06
Group 3 Diag. Suppression SUPGP3 NO (0), YES (1) CWR Discrete 07
Group 4 Diag. Suppression SUPGP4 NO (0), YES (1) CWR Discrete 08
Group 5 Diag. Suppression SUPGP5 NO (0), YES (1) CWR Discrete 09
Group 6 Diag. Suppression SUPGP6 NO (0), YES (1) CWR Discrete 10
Group 7 Diag. Suppression SUPGP7 NO (0), YES (1) CWR Discrete 11
Report Event when Diag:
'Ack Only' goes unacked RAOU NO (0), YES (1) CWR Discrete 12
’Ack Only’ occurs while RAOAGN NO (0), YES (1) CWR Discrete 13
unacked
Goes active and unacked RDGAU NO (0), YES (1) CWR Discrete 14
Goes active while unacked RDGAWU NO (0), YES (1) CWR Discrete 15
Goes clear while unacked RDGCWU NO (0), YES (1) CWR Discrete 16
Goes clear while acked RDGCWA NO (0), YES (1) CWR Discrete 17
Cleared by suppression RDGCBYS NO (0), YES (1) CWR Discrete 18
Acknowledged RDGACK NO (0), YES (1) CWR Discrete 19
Globally acknowledged RDGGLAC NO (0), YES (1) CWR Discrete 20
K
Acked by suppression RDGABYS NO (0), YES (1) CWR Discrete 21
Suppressed RDGSUP NO (0), YES (1) CWR Discrete 22
Enabled RDGENA NO (0), YES (1) CWR Discrete 23
Report Event when Alarm:
Goes active and unacked RALAU NO (0), YES (1) CWR Discrete 24
Goes active but not RALANOT NO (0), YES (1) CWR Discrete 25
unacked U
Goes active while unacked RALAWU NO (0), YES (1) CWR Discrete 26
Goes clear while unacked RALCWU NO (0), YES (1) CWR Discrete 27
Goes clear while acked RALCWA NO (0), YES (1) CWR Discrete 28
Cleared by suppression RALCBYS NO (0), YES (1) CWR Discrete 29
Acknowledged RALACK NO (0), YES (1) CWR Discrete 30
Globally acknowledged RALGLACK NO (0), YES (1) CWR Discrete 31
Acked by suppression RALABYS NO (0), YES (1) CWR Discrete 32
Suppressed RALSUP NO (0), YES (1) CWR Discrete 33
Enabled RALENA NO (0), YES (1) CWR Discrete 34

3-33
Logic Functions - Book 1

SYSTEM EVENT BLOCK

Table 3-2. System Event Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
General Event Reporting
Informational Events RPTINF NO (0), YES (1) CWR Discrete 35
Block ‘State’ Chngs. RPTSTA NO (0), YES (1) CWR Discrete 36
Process Alarm Events RPTPA NO (0), YES (1) CWR Discrete 37
Notification Mesg Events RPTNM NO (0), YES (1) CWR Discrete 38
System Event Events RPTSE NO (0), YES (1) CWR Discrete 39
Global Acknowledge Cmd GLBACK FALSE (0), TRUE (1) – WR Discrete 40
Diagnostic Ack. Cmd DGACK FALSE (0), TRUE (1) – WR Discrete 41
Process Alarm Ack. Cmd PAACK FALSE (0), TRUE (1) – WR Discrete 42
Notif/Req Msg Ack. Cmd NMACK FALSE (0), TRUE (1) – WR Discrete 43
Clear Queue Command CLRQCMD FALSE (0), TRUE (1) – WR Discrete 44
Any Active Diagnostics ANYACT FALSE (0), TRUE (1) ––R Discrete 45
Any Unacked Diagnostics ANYUNK FALSE (0), TRUE (1) ––R Discrete 46
Number of Active Diags. NUMACT 0 to 65535 ––R Count 47
Number of Unacked Diags. NUMUNK 0 to 65535 ––R Count 48
Number of Abnormal Diags. NUMABN 0 to 65535 ––R Count 49
Diag. Transitions Counter DGCTR 0 to 65535 ––R Count 50
Queue Entry ID QID 0 to 65535 ––R Count 51
Event Queue Size EVQSIZ 0 to 1000 C–R Count 52
Queue End ID QENDID 0 to 65535 ––R Count 53
Global Acknowledge Input GLBINP NONE, Discrete LSP C–R Discrete 54
Diagnostic Ack. Input DGINP NONE, Discrete LSP C–R Discrete 55
Process Alarm Ack. Input PAINP NONE, Discrete LSP C–R Discrete 56
Notif/Req Msg Ack. Input NMINP NONE, Discrete LSP C–R Discrete 57

3-34
Logic Functions - Book 1

SYSTEM EVENT BLOCK

04 ALL Groups Diagnostic Suppression (SUPALL)......................................................CWR


05 Group 1 Diagnostic Suppression (SUPGP1) ............................................................CWR
06 Group 2 Diagnostic Suppression (SUPGP2) ............................................................CWR
07 Group 3 Diagnostic Suppression (SUPGP3) ............................................................CWR
08 Group 4 Diagnostic Suppression (SUPGP4) ............................................................CWR
09 Group 5 Diagnostic Suppression (SUPGP5) ............................................................CWR
10 Group 6 Diagnostic Suppression (SUPGP6) ............................................................CWR
11 Group 7 Diagnostic Suppression (SUPGP7) ............................................................CWR
Used to suppress the reporting of all diagnostic errors associated with a particular group
or groups 1 to 7 (if ALL Groups is selected). Diagnostic errors can be associated with a
group in various blocks throughout the database. If a block has a diagnostic error that
cannot be suppressed, then it cannot have group suppression. You can use the blank
space at the bottom of the System Event block form to record what blocks are in a
particular group.
YES 1 Diagnostic errors are suppressed. Diagnostics associated with
all groups (1-7) or individual group 1 through 7 are now
suppressed. This does not mean that a diagnostic’s suppression
attribute value has been changed.
NO 0 Diagnostic errors are not suppressed. Diagnostics associated
with all groups (1-7) or individual group 1 through 7 are now
unsuppressed. This does not mean that a diagnostic’s
suppression attribute value has been changed.

12 Report Diagnostic Event: ‘Ack only’ goes unacked (RAOU) ..................................CWR


Used to enable the reporting of the event.
YES 1 Report ‘Acknowledge Only’ diagnostic event to the system event
queue when the event goes unacknowledged.
NO 0 No reports are made.

13 Report Diagnostic Event: ‘Ack only’ occurs while unacked (RAOAGN) ...............CWR
Used to enable the reporting of the event.
YES 1 Report ‘Acknowledge Only’ diagnostic event to the system event
queue when the event occurs again while it is still
unacknowledged.
NO 0 No reports are made.

14 Report Diagnostic Event: Goes active and unacked (RDGAU) ..............................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event goes active and
unacknowledged to the system event queue.
NO 0 No reports are made.

15 Report Diagnostic Event: Goes active while unacked (RDGAWU) ........................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event goes active while it is still
unacknowledged to the system event queue.
NO 0 No reports are made.

3-35
Logic Functions - Book 1

SYSTEM EVENT BLOCK

16 Report Diagnostic Event: Diag goes clear while unacked (RDGCWU)..................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event goes clear while it is still
unacknowledged to the system event queue.
NO 0 No reports are made.

17 Report Diagnostic Event: Goes clear while acked (RDGCWA) ..............................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event goes clear while it is
acknowledged to the system event queue.
NO 0 No reports are made.

18 Report Diagnostic Event: Cleared by suppression (RDGCBYS) ............................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event goes clear by any method of
suppression to the system event queue.
NO 0 No reports are made.

19 Report Diagnostic Event: Acknowledged (RDGACK)..............................................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event is acknowledged by a single
acknowledge message to the system event queue.
NO 0 No reports are made.

20 Report Diagnostic Event: Globally acknowledged (RDGGLACK) ..........................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event is globally acknowledged to the
system event queue.
NO 0 No reports are made.

21 Report Diagnostic Event: Acked by suppression (RDGABYS) ..............................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event is acknowledged by any method
of suppression to the system event queue.
NO 0 No reports are made.

22 Report Diagnostic Event: Suppressed (RDGSUP)...................................................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event suppression attribute is set to
YES to the system event queue.
NO 0 No reports are made.

3-36
Logic Functions - Book 1

SYSTEM EVENT BLOCK

23 Report Diagnostic Event: Enabled (RDGENA) .........................................................CWR


Used to enable the reporting of the event.
YES 1 Report when a diagnostic event suppression attribute is set to
NO to the system event queue.
NO 0 No reports are made.

24 Report Alarm Event: Goes active and unacked (RALAU) .......................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm goes active and unacknowledged
to the system event queue.
NO 0 No reports are made.

25 Report Alarm Event: Goes active but not unacked (RALANOTU) ..........................CWR
Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm goes active but not
unacknowledged because it’s priority level is zero to the system
event queue.
NO 0 No reports are made.

26 Report Alarm Event: Goes active while unacked (RALAWU) .................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm goes active while it is still
unacknowledged to the system event queue.
NO 0 No reports are made.

27 Report Alarm Event: Goes clear while unacked (RALCWU) ...................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm goes clear while it is still
unacknowledged to the system event queue.
NO 0 No reports are made.

28 Report Alarm Event: Goes clear while acked (RALCWA)........................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm goes clear while it is
acknowledged to the system event queue.
NO 0 No reports are made.

29 Report Alarm Event: Cleared by suppression (RALCBYS) .....................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm is cleared by any method of
suppression to the system event queue.
NO 0 No reports are made.

3-37
Logic Functions - Book 1

SYSTEM EVENT BLOCK

30 Report Alarm Event: Acknowledged (RALACK) .......................................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm is acknowledged by a single
acknowledge message to the system event queue.
NO 0 No reports are made.

31 Report Alarm Event: Globally acknowledged (RALGLACK) ...................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm is globally acknowledged to the
system event queue.
NO 0 No reports are made.

32 Report Alarm Event: Acked by suppression (RALABYS)........................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm is acknowledged by any method
of suppression to the system event queue.
NO 0 No reports are made.

33 Report Alarm Event: Suppressed (RALSUP)............................................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm’s suppression attribute is set to
YES to the system event queue.
NO 0 No reports are made.

34 Report Alarm Event: Enabled (RALENA) ..................................................................CWR


Used to enable the reporting of the event.
YES 1 Report when a PA or NM alarm’s suppression attribute is set to
NO to the system event queue.
NO 0 No reports are made.

35 Report Informational Events (RPTINF) .....................................................................CWR


Used to enable reporting of informational events associated with all blocks.
YES 1 Report informational events to the event queue.
NO 0 No reports are made.

36 Report Block ‘State’ Changes (RPTSTA) ..................................................................CWR


Used to enable reporting of state changes associated with all blocks.
YES 1 Report block state transition to the event queue.
NO 0 No reports are made.

3-38
Logic Functions - Book 1

SYSTEM EVENT BLOCK

37 Report Process Alarm Events (RPTPA) ....................................................................CWR


Used to enable reporting of Process Alarm events.
YES 1 Report process alarm events to the event queue.
NO 0 No event reporting is made for ALL Process Alarms in the
database.

38 Report Notification Message Events (RPTNM) ........................................................CWR


Used to enable reporting of notification/request message events.
YES 1 Report notification/request message events to the event queue.
NO 0 No event reporting is made for ALL Notification/Request
Messages in the database.

39 Report System Event Events (RPTSE)......................................................................CWR


Used to enable reporting of system events.
YES 1 Report this block’s events to the event queue.
NO 0 No event reporting is made for the System Event block.

40 Global Acknowledge Command (GLBACK) ............................................................. – WR


Writing TRUE to this command causes all diagnostics, process alarms and notification/
request messages to be acknowledged. This is a one shot type command (value in
database remains FALSE).

41 Diagnostic Acknowledge Command (DGACK) ....................................................... – WR


Writing TRUE to this command causes all diagnostic alarms to be acknowledged. This is
a one shot type command (value in database remains FALSE).

42 Process Alarm Acknowledge Command (PAACK) ................................................. – WR


Writing TRUE to this command causes all process alarms to be acknowledged. This is a
one shot type command (value in database remains FALSE).

43 Notification/Request Message Acknowledge Command (NMACK) ...................... – WR


Writing TRUE to this command causes all notification/request messages to be
acknowledged. This is a one shot type command (value in database remains FALSE).

44 Clear Queue Command (CLRQCMD)........................................................................ – WR


Writing TRUE to this command causes the event queue to clear. This is a one shot type
command (value in database remains FALSE).

45 Any Active Diagnostics (ANYACT) ............................................................................– – R


The active diagnostics status output is a block output that is TRUE when there is any
active diagnostic alarm in the instrument; otherwise, it is FALSE (no active diagnostic
error).

46 Any Unacknowledged Diagnostics (ANYUNK).........................................................– – R


The unacknowledged diagnostic status output is a block output that is TRUE when there
is any unacknowledged diagnostic alarm in the instrument; otherwise, it is FALSE (no
unacknowledged diagnostics).

3-39
Logic Functions - Book 1

SYSTEM EVENT BLOCK

47 Number of Active Diagnostics (NUMACT) ................................................................– – R


A count output indicating the number of currently active diagnostic errors. This value is
incremented for each new alarm/clear alarm type diagnostic which becomes active, and is
decremented every time this type of diagnostic clears. Note that no change would be
detected by monitoring this value if an equal number of diagnostics became active and
clear coincidentally.

48 Number of Unacknowledged Diagnostics (NUMUNK).............................................– – R


A count output indicating the number of currently unacknowledged diagnostic errors. This
value is incremented for each diagnostic which becomes unacknowledged. It is
decremented every time an alarm is acknowledged. Note that no change would be
detected by monitoring this value if an equal number of diagnostics occurred and were
acknowledged coincidentally.

49 Number of Abnormal Diagnostics (NUMABN)..........................................................– – R


A count output indicating the number of diagnostic errors which are unacknowledged or
active.

50 Diagnostics Transition Counter (DGCTR) ................................................................– – R


This is a wrap around counter that is incremented on every change of status to any
diagnostic error in the instrument. The count value wraps around when the maximum of
65535 is reached.

51 Queue Entry ID (QID) ..................................................................................................– – R


This is a wrap around ID counter that is incremented whenever an entry is put into the
event queue. It is always the ID value of the most recent queue entry. Value $0000
indicates queue is empty. The ID value starts at 1 and is incremented up to the queue
end ID (QENDID) value and then wraps back to 1.
The system event queue can be cleared by a clear queue command from a user, or when
a database is downloaded from the PC configurator, or a when database is downloaded
from a write protected memory module.

52 Event Queue Size (EVQSIZ) ...................................................................................... C – R


Used to specify the maximum number of events that can be stored in the queue. When
this maximum is exceeded, the oldest events in the queue are overwritten by incoming
events.
value Enter a count value of 0 to 1000.

53 Queue End ID (QENDID) .............................................................................................– – R


This is the maximum value that queue entry id can have. It is derived by dividing 65535
by event queue size and multiplying the truncated result by event queue size.

3-40
Logic Functions - Book 1

SYSTEM EVENT BLOCK

54 Global Acknowledge Input (GLBINP) ....................................................................... C – R


55 Diagnostic Acknowledge Input (DGINP).................................................................. C – R
56 Process Alarm Acknowledge Input (PAINP)............................................................ C – R
57 Notification/Requests Message Acknowledge Input (NMINP)............................... C – R
These acknowledge inputs are edge triggered so that a value of 0 (FALSE) followed by a
value of 1 (TRUE) acknowledges the alarm. Global acknowledge indicates all
diagnostics, process alarms and notification/requests are acknowledged.
None No acknowledgement input connected.
LSP Discrete variable used to acknowledge all alarms and reset the
input (not operator writable).

3.4.3 Typical Block Connections for System Event Block


Typical softwiring block structures used on softwiring diagrams are shown in Figure 3-10.

SE1
Operator write access to Global Acknowledge Command
acknowledge alarm

Logical Source Pointer from Process Alarm Ack. Input


another function block QID
Count output to CL block
Queue Entry ID
RPTINF
Report Informational Events Operator indication
RPTSTA of condition (Y/N)
Report Block State Changes
RPTPA
Report PA Events
Operator write access to
change reporting conditions

Figure 3-10. System Event Block, Typical Connections

3.4.4 System Event Block Events


The event codes (and their suggested text messages) for the system event block are
given below. See database attributes for additional information.

Informational Event Codes and Descriptions


4 ALL DIAG, PA AND NM GLOBALLY ACKED.
5 ALL DIAGNOSTICS GLOBALLY ACKED.
6 ALL PROCESS ALARMS GLOBALLY ACKED.
7 ALL NOTIF/REQ MSGS GLOBALLY ACKED.
8 ALL GROUP DIAGNOSTICS SUPPRESSED
9 ALL GROUP DIAGNOSTICS ENABLED
10 GROUP 1 DIAGNOSTICS SUPPRESSED
11 GROUP 1 DIAGNOSTICS ENABLED
12 GROUP 2 DIAGNOSTICS SUPPRESSED
13 GROUP 2 DIAGNOSTICS ENABLED
14 GROUP 3 DIAGNOSTICS SUPPRESSED
15 GROUP 3 DIAGNOSTICS ENABLED
16 GROUP 4 DIAGNOSTICS SUPPRESSED
17 GROUP 4 DIAGNOSTICS ENABLED
18 GROUP 5 DIAGNOSTICS SUPPRESSED

3-41
Logic Functions - Book 1

SYSTEM EVENT BLOCK

19 GROUP 5 DIAGNOSTICS ENABLED


20 GROUP 6 DIAGNOSTICS SUPPRESSED
21 GROUP 6 DIAGNOSTICS ENABLED
22 GROUP 7 DIAGNOSTICS SUPPRESSED
23 GROUP 7 DIAGNOSTICS ENABLED
24 SYSTEM EVENT QUEUE CLEARED

3.4.5 Event Transitions


Events have transition codes (internal to communications) and text associated with them.
Table 3-3 lists the event transition codes and descriptions. These transition codes apply
to all events for all blocks.

Table 3-3. Event Transition Codes and Descriptions


Event Appended Description
Trans.Code Text
0 An informational event. No appended text required.
1 uak-only Indicates the acknowledge only diagnostic has occurred.
2 uak-only Indicates the acknowledge only diagnostic has occurred.
3 act/uak Indicates the event has gone active and unacknowledged.
4 act/ack Indicates the process alarm has gone active but not unacknowledged
because its priority level is zero.
5 act/uak Indicates the event has gone active while it was unacknowledged.
6 clr/uak Indicates the event has cleared while it was unacknowledged.
7 clr/ack Indicates the event has cleared after it was acknowledged.
8 clr-supp Indicates the event was cleared by one of the suppression methods.
9 acked Indicates the event was acknowledged by a single ack message.
10 glbl ack Indicates the event was acknowledged by one of the global ack
methods.
11 ack-supp Indicates the event was acknowledged by one of the suppression
methods.
12 supp Indicates the event’s suppression attribute has been set to YES.
13 enabled Indicates the event’s suppression attribute has been set to NO.

3-42
Logic Functions - Book 1

LOOP BLOCK

3.5 LOOP BLOCK (LP)


The loop block is an environment block that provides a ’master control’ function for those
function blocks found between it and the next loop block in the user database. This includes
’controlling source’ write access for consoles and computers and group control of function
block execution by either database logic or operator/computer command. See Section 2.2.2
for a further description of loops.

Available to the user as block outputs are the remote state error active/unacknowledged
status and quality data, the loop’s composite state, and the computer or console status. A
functional block diagram of the block is shown in Figure 3-11. The menus used to configure
the block are shown in Figure 3-12 and 3.13.

Scan Group
(1 to 5)
NONE
RUN
RUN
HOLD
OFF Loop Block
LSP HOLD CSTATE
GOOD
DEBUG OFF
RUN LSP
DEBUG
HOLD BAD
OFF
DEBUG Remote State State CPSTATUS
Input
CNSTATUS

Remote Error
State

LSP RSTU
LSP Quality
RSTA
Quality and
Bad Inputs
Accepted RSTUQ
Error Check
(YES/NO)
RSTAQ

Remote State
State Invalid or has Diagnostic
(RUN, HOLD, bad quality Suppression
OFF, DEBUG) (ENAB/SUPP) Group
(NONE, 1-7)

Figure 3-11. Loop Block, Functional Block Diagram

3-43
Logic Functions - Book 1

LOOP BLOCK

Figure 3-12. Loop Block (LP), General Menu

Figure 3-13. Loop Block (LP), Diagnostic Menu

3-44
Logic Functions - Book 1

LOOP BLOCK

3.5.1 Loop Block Operation


The actual behavior of the loop block is indicated by composite state, which is a composite of
state and remote state. The loop’s function blocks only get executed if composite state is
RUN. When state is RUN, composite state is equal to the remote state input, if present and
valid. When state is not RUN, composite state is equal to state and remote state is ignored.

The scan rate for the loop and its function blocks is determined by the scan interval configured
(in the interface block) for the group to which the loop block is assigned. Within a group, the
loops are executed in the order found in the database. When a loop block executes, if its
composite state is RUN, its function blocks whose states are also RUN are executed in the
order found in the database.

The loop block provides the following operator or computer control functions.
• TAKE CONTROL A request can be made to take control of a "LOOP" under which
a specified LSP exists. A check is made that no other source of
the same class (CONS/COMP) is currently controlling the
specified "LOOP". If the class is COMP, then a check is made
that the source is also authorized. Control access is defined in
the interface block.
• RELEASE CONTROL A request can be made to release control of a "LOOP" under
which a specified LSP exists. A check is made that the source is
currently controlling the specified "LOOP".
• OVERRIDE CONTROL A request can be made to demand control of a "LOOP" under
which a specified LSP exists. If class is COMP, then check is
made that the source is also authorized.

3.5.2 Loop Block Parameters

The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 3-4. The following further
defines the Loop Block configuration parameters.

Block Type
LP This is the Loop Block type and is present within a loop compound.

Table 3-4. Loop Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN – – R Count 01
State STATE RUN(0), HOLD(1), OFF(2), CWR Short State 02
DEBUG(3)
Bad Inputs BADINP Rejected (0), Accepted (1) CWR Discrete 03
Diagnostic Suppression SUPPGRP NONE, 1, 2, 3, 4, 5, 6, or 7 CWR Long State 04
Group
Remote State Invalid or has RSTS ENABLE (0), CWR Discrete 05
bad quality SUPPRESS (1)
Remote state error RSTU NO (0), YES (1) –WR Discrete 06
unacknowledged
Remote state error unack RSTUQ GOOD (0) ––R Discrete 07
quality
Remote state error Active RSTA NO (0), YES (1) –WR Discrete 08

3-45
Logic Functions - Book 1

LOOP BLOCK

Remote state error Active RSTAQ GOOD (0) ––R Discrete 09


quality
State value to use when REST RUN(0), HOLD(1), OFF(2), CWR Short State 10
remote state error occurs DEBUG(3)
Scan Group GROUP 1, 2, 3, 4, 5 C–R Short State 11
Composite State CSTATE RUN(0), HOLD(1), OFF(2), ––R Short State 12
DEBUG(3)
Console Status CNSTATUS FREE (0), BUSY (1) ––R Short State 13
Computer Status CPSTATUS FREE, BUSY, INACTIVE(2) ––R Short State 14
Remote State Input RSTATE NONE, RUN, HOLD, OFF, CWR Short State 15
DEBUG, or LSP (discrete,
short or long state)

2 State (STATE) .................................................................................................................... CWR


When state is RUN, the loop's behavior can be determined by the remote state variable, if
present. When state is not RUN, behavior is determined by state and remote state is ignored.
See Section 2.4.1, State Changes for additional information.
RUN 0 Normal Operation. Block is executed.
HOLD 1 Non-executing RUN. Block is not executed.
OFF 2 Block is not executed. Qualities will be BAD.
DEBUG 3 No fields are updated. All attributes are writable.

3 Bad Inputs (BADINP)......................................................................................................... CWR


See Section 2.3.2, Data Quality for additional information.
Rejected 0 Block checks the remote state input quality and if it has bad quality,
then composite state takes on the remote error state value.
Accepted 1 The remote state input is not checked for quality and output quality is
set to good.

4 Diagnostic Suppression Group (SUPPGRP) .................................................................. CWR


NONE, or one of the seven possible diagnostic groups (1, 2, 3, 4, 5, 6, or 7). Assign the
diagnostic points for this loop block to the group desired. The System Event block can
suppress the reporting of diagnostic errors associated with a particular group.

5 Remote State Invalid or has bad quality (RSTS)............................................................ CWR


Block checks the remote state input and if it has an invalid value, then composite state takes
on the remote error state value.
ENABLE 0 Report this diagnostic error.
SUPPRESS 1 Do not report this diagnostic error.

6 Remote state error unacknowledged (RSTU).................................................................– WR


If the remote state invalid or has bad quality diagnostic error check is enabled, this status
indicates if the diagnostic is or is not acknowledged. The status can be acknowledged or read
as follows.
NO 0 Diagnostic error is unacknowledged.
YES 1 Diagnostic error is acknowledged.

3-46
Logic Functions - Book 1

LOOP BLOCK

7 Remote state error unack quality (RSTUQ) ....................................................................– – R


The remote state error unacknowledged always has good quality.
GOOD 0 Quality is always good.

8 Remote state error Active (RSTA)................................................................................... – WR


If the remote state invalid or has bad quality diagnostic error check is enabled, this status
indicates if the diagnostic is or is not active. The status is writable only in debug and can be
read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

9 Remote state error Active quality (RSTAQ) ....................................................................– – R


The remote state error active always has good quality.
GOOD 0 Quality is always good.

10 State value to use when remote state error occurs (REST) ..........................................CWR
The remote error state is a composite of state and remote state, indicating loop's actual
behavior. If block state is RUN and remote state has an invalid value, or bad quality when bad
inputs are not accepted, then composite state takes on this value. Valid values are:
RUN 0
HOLD 1
OFF 2
DEBUG 3

11 Scan Group (GROUP)....................................................................................................... C – R


The scan group to which this loop block, and the function blocks between it and the next loop
block, are assigned. Group choices are: 1, 2, 3, 4, or 5.

12 Composite State (CSTATE)...............................................................................................– – R


Composite of local and remote state. Valid states are: RUN, HOLD, OFF, or DEBUG. The
loop's function blocks only get called if composite state is RUN. Otherwise, the loop block
manages the diagnostics for each of the function blocks in the loop.

13 Console Status (CNSTATUS)............................................................................................– – R


Used to indicate console status of controlling source for all blocks in the loop.
Free 0 Indicates no console has control.
Busy 1 Indicates some console has control.

14 Computer Status (CPSTATUS) .........................................................................................– – R


Used to indicate computer status of controlling source for all blocks in the loop.
Free 0 Indicates no computer has control.
Busy 1 Indicates some computer has control.
Inactive 2 Indicates no computer control, since there are no authorized
computer sources.

3-47
Logic Functions - Book 1

LOOP BLOCK

15 Remote State Input (RSTATE).......................................................................................... CWR


This is an input signal used to remotely change the block state. When state is RUN and
remote state is present, composite state (CSTATE) will take on the value of remote state.
Writable only if local data is configured.
NONE No remote state changes allowed. Composite state is the state value.
RUN 0 Local data for remote state input is RUN.
HOLD 1 Local data for remote state input is HOLD.
OFF 2 Local data for remote state input is OFF.
DEBUG 3 Local data for remote state input is DEBUG.
LSP Input data may be discrete, short or long state source variable. Data must be
valid (0, 1, 2, or 3) or a remote state error will occur.

3.5.3 Typical Block Connections for Loop Block


Typical softwiring block structures used on softwiring diagrams are shown in Figure 3-14.

EX1 LP1
AUX
Auxiliary Result Remote State Input

CSTATE Operator indication of


Composite State Loop Composite State.

Remote Error State

State

Operator write access to Loop State and


Remote Error State

Figure 3-14. Loop Block, Typical Connections

3.5.4 Loop Block Events


The event codes (and their suggested text messages) for the loop block are given below. See
the referenced database attributes (in brackets) for additional information. See the system
event block for event transition information.

0 BLOCK STATE SET TO RUN.


1 BLOCK STATE SET TO HOLD.
2 BLOCK STATE SET TO OFF.
3 BLOCK STATE SET TO DEBUG.
4 REMOTE STATE INPUT INVALID (5).

3-48
Logic Functions - Book 1

CONFIGURED LIST BLOCK

3.6 CONFIGURED LIST BLOCK (CL)


The configured list block is used to specify and/or collect data (up to 99 attributes or other
configured lists) that is of interest to an external system. The configured list data is included
in: an ICN or MSC foreground message; or as a Modbus list (no nested lists) for a MSC
module; or solely as a background list to be included in interface files (TIF or MIF). Execution
of a list block is distributed over all group scan periods and is therefore not loop block related
except for control access.

Configured list blocks 1 through 9 are reserved for use as input lists for groups. The
configurator places these blocks in the database as necessary to double buffer user data that
passes between groups. This process is transparent to the user except that CL10 is the first
user configured list block (as seen in reports and cross reference files).

The display, which is used to configure the configured list block, is shown in Figure 3-15. Up
to 99 attribute sources can be connected to one configured list block.

Figure 3-15. Configured List Block (CL), Edit Display, page 2

3.6.1 Configured List Block Operation


If the configured list block is being used to collect data, the data identified by the list is
collected into an input buffer as the various groups generate it. A snapshot of the data thus
buffered is then available (e.g. for placing in a foreground message through the ICN block) on
a demand basis. In addition to individual variables, another list may be included in a list block.
When this is the case, that data is collected only by the other list block and not duplicated in

3-49
Logic Functions - Book 1

CONFIGURED LIST BLOCK

this block. When the list data is demanded from this block, it will demand data from the other
block in the appropriate sequence. Configured list data is defined as foreground in the ICN
and MSC blocks (Foreground List attribute). All lists are made part of the Tagged Interface
File (TIF) or a comma delimited text Modcell Interface File (MIF).

When the configured list block is not being used to collect data (NO), no data is collected and
no database space is allocated to do so. This feature is used to identify variables that are not
part of ICN or MSC foreground data but are still needed for TIF or MIF generation. The TIF
file is used by PC-30 as a list of parameters available for device block building. The MIF file is
used by other device drivers as a list of parameters available for device block building. Any
attribute that is to be read or written from a computer display must be included in an interface
file.

3.6.2 Configured List Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 3-5. The following further
defines the configured list block configuration parameters.

Block Type
CL This is the configured list block type.

Input 1 through Input 99 .................................................................................................... C – –


For each input (1 to 99), connect any variable you wish to be placed in the list or leave input at
NONE.
LSP Connect any variable you wish to be placed in the list to one of the 99 inputs.
To include another list in this list, connect the "LISTOUT" connection
of the other list as an input to this list.
NONE No variable or list is defined for the input.

Table 3-5. Configured List Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1, 2 ––R Long State 00
Block Length BLKLEN ––R Count 01
Block State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
Collect Data COLLECT NO (0), YES (1) C–R Discrete 04
Packed Length PKDLEN ––R Count 05
Unpacked Length UNPKDLE ––R Count 06
N
List Signature LISTSIGN ––R Count 07
Collect Quality COLLQUAL NO (0), YES (1) C–R Discrete 08
Discrete Length DISCLEN ––R Count 09
Non Discrete Length NDISCLEN ––R Count 10

3-50
Logic Functions - Book 1

CONFIGURED LIST BLOCK

00 Version (VERSION)............................................................................................................– – R
Attributes 8, 9 and 10 were added for version 2 of this block.

01 Block Length (BLKLEN).....................................................................................................– – R


Number of data base bytes taken by the block.

02 State (STATE).....................................................................................................................– – R
This block is always RUN (block is executed). See Section 2.4.1, State Changes for
additional information on block states.

03 Bad Inputs Accepted (BADINP)...........................................................................................– – R


This block always collects data without a check on input quality and output quality is set to
good. See Section 2.3.2, Data Quality for additional information.

04 Collect Data (COLLECT)................................................................................................... C – R


Collect data is presently used by the configurator to determine if a configured list block is part
of the data collection process or is for non-foreground TIF file building only.
YES 1 Configured list data is collected. To put data in foreground, the list
must be part of a list specified in the ICN block.
NO 0 No data is collected and no database space is allocated by
configurator (block does not appear as part of the instrument
database). This feature is used to identify PC-30 system variables for
non-foreground Tagged Interface File (TIF) generation. The TIF file
resides at the PC for use with PC-30.

05 Packed Length (PKDLEN) ...................................................................................................– – R


The number of bytes of listed data, including any nested lists, in packed format.

06 Unpacked Length (UNPKDLEN) .........................................................................................– – R


The number of bytes of listed data, including any nested lists, in unpacked format.

07 List Signature (LISTSIGN) ...................................................................................................– – R


This is a number which uniquely identifies a particular set of LSPs in a particular order. Users
(of foreground for instance) can monitor this value to verify that the same data is being
collected.

08 Collect Quality (COLLQUAL)............................................................................................ C – R


Collect quality should only be used if the host system driver can deal with data quality.
YES 1 If Collect Data is also YES and the listed attribute has quality, then the
quality data is collected and stored.
NO 0 Default. No quality data is collected and stored.

09 Discrete Length (DISCLEN) ................................................................................................– – R


The number of bytes in the discrete area of the input buffer for this list.

10 Non Discrete Length (NDISCLEN) ......................................................................................– – R


The number of bytes in the non discrete area of the input buffer for this list.

3-51
Logic Functions - Book 1

CONFIGURED LIST BLOCK

3.6.3 Typical Block Connections for Configured List Block


Typical softwiring block structures used to connect a Configured List block are shown in
Figure 3-16. Connect foreground list data of a Configured List block to the FGLISTIN attribute
of the ICN or MSC block to specify foreground data (data updated every 0.25 seconds in the
link). Connect background list data of a Configured List block to the BGLISTIN attribute of the
ICN or MSC block to specify background data, which will not be in foreground but will be
included in any interface files that you build for this port at compile time.

CL10 ICN1
DI1 LISTOUT FGLISTIN
R
Result Input 1 BGLISTIN
Input 2 Operator indication
LN1 of data.
R Input 3
Result
Input 4
DISCLEN
CL11

LISTOUT
MSC1
CL12 FGLISTIN
LISTOUT BGLISTIN

Figure 3-16. Typical Block Connections for Configured List Blocks

3-52
Logic Functions - Book 1

MODBUS LIST BLOCK

3.7 MODBUS LIST BLOCK (ML)


The Modbus list block is used to specify and collect data, which is of interest to an external
system that, supports the Modbus message protocol. The list of attributes identifying data for
inclusion in Modbus Slave Communication block (MSC) single register read/write or single
register read only lists must be specified in Modbus List (ML) blocks. The data must be count,
discrete, short state, date, long state, floating point or millisecond time.

A Modbus List allows data (except ASCII and Hex) to be converted (a 2-byte positive value)
and mapped into a Modbus register memory area. Since the content of a Modbus register is a
2-byte (16 bit) positive binary value, the data is presented as follows:

Data Type Modbus Register 16 Bit Value


Discrete 0 or 1
Short State 0 to 15
Long State 0 to 255
Count 0 to 65535
Date bits 15 - 9 Year (0 - 99)
bits 8 - 5 Month (1 - 12)
bits 4 - 0 Day (1 - 31)
Floating Point Top and bottom of range required.
Floating point values that cannot be mapped within the
0 to 65535 range will be set to 0 or 65535 as
appropriate.
Millisecond Time Scaling factor required (1, 10, 100, 1000, 10000, or
100000). Note that a value of 65535 going out of
MODCELL indicates that the value is out of Count
range.

The following example shows Floating Point values converted to 16 bit Modbus register
values:

If a VCIM input is 1 to 5 volts and the VCI block output range is -100000.0 to +100000.0, then
it is mapped into a Modbus register value by configuring the Top of Range as 100000.0 and
the Bottom of Range as -100000.0.

Vin VCI, R Modbus Register Value


< -100000.0 0
1.0V -100000.0 0
2.0V -50000.0 16383
3.0V 0.0 32767
4.0V 50000.0 49151
5.0V 100000.0 65535
> 100000.0 65535

The following example shows millisecond time scaled to 16 bit Modbus register values:

The millisecond time data type is an unsigned four byte integer value, which is a count of
milliseconds from 0 to 4294967295. The scaling factor, which must be configured, will effect
the resolution of the time values. The scale factor indicates the number of milliseconds per
count. If a scale factor of 10 is configured, then each count is equal to 10 milliseconds as
described in the following table:

3-53
Logic Functions - Book 1

MODBUS LIST BLOCK

Millisecond Time Modbus Register Value Remarks


0 0
100 10
10000 1000
100000 10000
600000 60000 10 minutes worth
655350 65535 out of range indication
>655350 65535 out of range indication

The display that is used to configure the Modbus list block is shown in Figure 3-17. Up to 99
attributes can be defined through the configurator for one Modbus list block.

Figure 3-17. Modbus List Block (ML), Edit Display, page 2

3.7.1 Modbus List Block Operation


Execution of a Modbus List block is distributed over all group scan periods and is therefore not
loop block related. The data identified by the Modbus List is collected, as the various groups
in an input buffer generate it. Therefore, when the Modbus Slave Communication block
processes a Modbus Read message, it gets a consistent set of data from this list’s input
buffer. Data is always collected, regardless of quality.

3-54
Logic Functions - Book 1

MODBUS LIST BLOCK

3.7.2 Modbus List Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 3-6. The following further
defines the Modbus list block configuration parameters.

Block Type
ML This is the Modbus list block type.

Table 3-6. Modbus List Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
Block State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
List Signature LISTSIGN ––R Count 04

Input 1 through Input 99.....................................................................................................C – –


For each input (1 to 99), connect any attribute you wish to be placed in the list or leave input at
NONE. ASCII or Hex data types are not allowed. Nested lists are not allowed.
Input n Connect any attribute (not ASCII or Hex) you wish to be placed in the list.
NONE No variable is defined for the input.

Floating Point Ranges.......................................................................................................C – –


Applies to floating point data only. Enter range in floating point. The range is used for
converting the 4-byte floating point value to a Modbus 2-byte positive count value of 0 to
65535.
Bottom Indicates the 0 count value. Default is 0.0.
Top Indicates the 65535 count value. Default is 65535.0.

Msec Time Scale Factor....................................................................................................C – –


Scaling factor to convert the 4-byte msec-time values to a Modbus 2-byte positive count value
between 0 and 65535. Valid scale factor values are 1, 10, 100, 1000, 10000, and 100000.
The scale factor indicates the number of milliseconds per count. For example, if a scale factor
of 10 is configured, then each count is equal to 10 milliseconds.

02 State (STATE).....................................................................................................................– – R
This block is always RUN (block is executed). See Section 2.4.1, State Changes for
additional information on block states.

03 Bad Inputs Accepted (BADINP) ........................................................................................– – R


This block always collects data without a check on input quality. See Section 2.3.2, Data
Quality for additional information.

04 List Signature (LISTSIGN).................................................................................................– – R


This is a number that uniquely identifies a particular set of LSPs in a particular order. Users
can monitor this value to verify that the same data is being collected. If the same data is being
collected, this number should not change.

3-55
Logic Functions - Book 1

MODBUS LIST BLOCK

3.7.3 Typical Block Connections for Modbus List Block


Typical softwiring block structures used to connect a Modbus List block are shown in Figure 3-
18.

ML1
DI1 MSC1
LISTOUT
Result R SROIN1
Input 1
SRWIN1
Input 2
LN1

Result R
ML2
LISTOUT

Figure 3-18. Typical Block Connections for Modbus List Block

3-56
Logic Functions - Book 1

COMMUNICATION MODULE BLOCKS

4
COMMUNICATION MODULE DATABASE PARAMETERS

4.1 COMMUNICATION BLOCKS

Communication module blocks define a physical interface port and are not part of a loop scan
group. The ICN and MSC communication module blocks are available outside of loop
compounds only and are placed somewhere at the instrument level. One of these modules is
required to talk to other devices on the network. Configuration activities such as download a
database, import a database or general activities for reading and writing instrument status
information all passes through a communication module.

Communication modules are selected from the instrument level Communication Library. The
Communications module types are:

ICN Instrument Communication Network Module. This block links configured lists,
input and output communications blocks, notification message blocks and
supervisory message blocks to other devices on the ICN through the ICN
module. The 2030N ICN Communication module can be located in the
following slot pairs (ICN numbers based upon assigned occurrence in .CRF
file).
ICN1 31-32;

ICN2 28-29, 29-30;

ICN3 25-26, 26-27, 27-28

MSC Modcell Serial Communication Module. This block links Modbus lists to
Modbus devices through an RS232 or RS485 module. The MSC module can
be located in the following slots.

For the 2033N RS232 and the 2034N RS485 Communication modules, which require
two slots:
MSC1 31-32;

MSC2 28-29, 29-30;

MSC3 25-26, 26-27, 27-28

For the 2032N RS485 Communication module, which requires one slot:
MSC1 32;

MSC2 29, 30;

MSC3 26, 27, 28

4-1
Logic Functions - Book 1

COMMUNICATION MODULE BLOCKS

The baud rate, data bits, parity, and stop bits that match the device with which you are
communicating can be:

Comm Link Baud Data Stop Parity

Type Bits Bits

1720N 19200, 9600, 4800, 2400, 8 1, 2 None, Even, Odd


1200
ICN 1731N 19200, 9600 8 1 None
1733N 19200, 9600, 4800, 2400, 8 1 None
1200, 600, 300
Modbus None 38400,19200, 9600, 4800, 8 1,2 None, Even, Odd
2400, 1200, 600, 300,150

For the ICN module, these parameters are set at the link. For Modbus, the parameters are
configurable through the MSC block.

Production of Interface Files.


A Tagged Interface File (TIF) and a Modcell Interface File (MIF) may be produced for each
communications module (ICN or MSC) in the database. Since up to 3 such modules can
appear in the database, up to 3 TIF’s and up to 3 MIF’s can be produced. The production of
MIF files is not supported in Logic 1 - 4, Regulatory 1 - 3, or Batch 1.

4-2
Logic Functions - Book 1

ICN COMMUNICATION BLOCK

4.2 ICN COMMUNICATION BLOCK (ICN)


The ICN communication block is used to receive messages from other instruments on the
ICN, transmit responses to the processed messages and also transmit foreground data as
specified by the list designated by the user. The received messages, which pass validity
checks, are then either processed (eg. READ messages) or routed (eg. WRITE messages) to
the appropriate group for processing when that group becomes available.

One ICN communication block is required to support one 2030N ICN Communication module
(requires two slots). ICN1 is configured as port number one (slots 31-32) on the I/O Module
Block Selection display in the configurator, ICN2 is port two (slots 28-29 or 29-30), and ICN3
is port three (slots 25-26, 26-27, or 27-28). This block is used to define what configured list is
to be broadcast on the ICN and what diagnostic errors are to be reported.

Available to the user as block outputs are the ICN load, status of all diagnostic errors and
count values for the same diagnostic errors. A functional block diagram of the block is shown
in Figure 4-1. The menus used to configure the block are shown in Figure 4-2, Figure 4-3 and
Figure 4-4.

ANY
Authorized
NONE Computer
Sources (1-5)
Device, Address

Write Msg
1 Receive Buffer Control
2030N ICN and Message
2 Module Contention
Checker

Read Msg Router

Group
Transmit Buffer Processors
and Foreground
Data
Foreground
List
(NONE, CL#)

I/O Board Number


Error Checks MODULE MISSING OR INVALID
Selection
Slot Number Load BUS RESTART
RESTART FAILURE
INVALID MESSAGE
ICN Address MODMM
CHECK-SUM ERROR
FRAMING ERROR
Suppress ADDR NOISE ERROR
Diagnostic Errors OVERRUN ERROR
INVALID MESSAGE LENGTH
RECEIVE BUFFER FULL
Diagnostic Group TRANSMIT BUFFER FULL
Suppression Reset UNEXPECTED COMM MESSAGE
(NONE, 1-7) Error Counters ICN OVERLOAD
Counters
REQUEST BUFFER FULL

Figure 4-1. ICN Communication Block, Functional Block Diagram

4-3
Logic Functions - Book 1

LOOP BLOCK

Figure 4-2. ICN Communication Block (ICN), General Menu

Figure 4-3. ICN Communication Block (ICN), Authorized Source Menu

4-4
Logic Functions - Book 1

ICN COMMUNICATION BLOCK

Figure 4-4. ICN Communication Block (ICN), Diagnostics Menu

4-5
Logic Functions - Book 1

LOOP BLOCK

4.2.1 ICN Communication Block Capabilities


The ICN communication block is responsible for two main functions. The first is to handle all
messages received since its last execution. The second is to handle the reporting and
acknowledgment of diagnostics for the configured port. The ICN Block executes once every
50 msec. Messages received by the port driver are checked for proper reception and
definition. After passing those checks, the ICN Block’s responsibility is to route the message
so it may be processed at the appropriate time and by the appropriate process.

A write message follows these rules: If from a computer source, then source must be
authorized; if another source of the same type is in control, then it is NAK’d; if the source is in
control, the write is done and the control timer is reset; if there is no controlling source, only
the write is done.

4.2.2 ICN Communication Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 4-1. The following further
defines the ICN Communication Block configuration parameters.

Block Type
ICN This is the Instrument Communication Block type and is configured on the I/O
Block Selection page.

Occurrence
1 to 3 There may be up to three ‘instances’ allowed of the ICN communication block.

Source 1 ............................................................................................................................. C – –
Source 2 ............................................................................................................................. C – –
Source 3 ............................................................................................................................. C – –
Source 4 ............................................................................................................................. C – –
Source 5 ............................................................................................................................. C – –
The source information provides the instrument with a complete source address of a computer
assigned to the instrument.
ANY Entry made in Source 1 only. All computer sources are allowed.
Remaining source entries are ignored.
NONE No authorized computer write source is defined. Computer status is
inactive.
ICN Addr ICN Address switch setting (0 to 15) of ICN device (such as
MODCELL, SLU, or Communication Link)
Device Type The device type must match what is written to the communications
link by the device. Communications source can be:

SLU 0....Sequence and Logic Unit


PC30 1....PC-30 Workstation
M300 2....MOD 300 System
1180M 4....1180M
MODCELL 5....MODCELL type instrument
Other 6....All device types

Will this module include a termination resistor?


This configuration only question is used to determine module current load.

4-6
Logic Functions - Book 1

ICN COMMUNICATION BLOCK

Table 4-1. ICN Communication Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION ––R Long State 00
Block Length BLKLEN ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1, 2, 3, 4, 5, 6, or 7 CWR Long State 04
Module Missing or invalid MODMMS ENABLE(0), SUPPRESS(1) CWR Discrete 05
Module Missing Unacked MODMMU NO (0), YES (1) – WR Discrete 06
Module Missing Active MODMMA NO (0), YES (1) ––R Discrete 07
Access timeout RSTS ENABLE(0), SUPPRESS(1) CWR Discrete 08
Bus Restart Unacked RSTU NO (0), YES (1) – WR Discrete 09
Restart Failure FAILS ENABLE(0), SUPPRESS(1) CWR Discrete 10
Restart Failure Unacked FAILU NO (0), YES (1) – WR Discrete 11
Invalid message MSGS ENABLE(0), SUPPRESS(1) CWR Discrete 12
Invalid Message Unacked MSGU NO (0), YES (1) – WR Discrete 13
Message data invalid CRCS ENABLE(0), SUPPRESS(1) CWR Discrete 14
Check-Sum Error Unacked CRCU NO (0), YES (1) – WR Discrete 15
Framing error FRAMES ENABLE(0), SUPPRESS(1) CWR Discrete 16
Framing Error Unacked FRAMEU NO (0), YES (1) – WR Discrete 17
Noise error NOISES ENABLE(0), SUPPRESS(1) CWR Discrete 18
Noise Error Unacked NOISEU NO (0), YES (1) – WR Discrete 19
Overrun error ORUNS ENABLE(0), SUPPRESS(1) CWR Discrete 20
Overrun Error Unacked ORUNU NO (0), YES (1) – WR Discrete 21
Invalid message size LENS ENABLE(0), SUPPRESS(1) CWR Discrete 22
Invalid msg. Length Unacked LENU NO (0), YES (1) – WR Discrete 23
Too many messages received RFULLS ENABLE(0), SUPPRESS(1) CWR Discrete 24
for port
Receive Buffer Full Unacked RFULLU NO (0), YES (1) – WR Discrete 25
Too many messages to XFULLS ENABLE(0), SUPPRESS(1) CWR Discrete 26
transmit
Xmit. Buffer Full Unacked XFULLU NO (0), YES (1) – WR Discrete 27
Message received for UCOMMS ENABLE(0), SUPPRESS(1) CWR Discrete 28
unconfigured IC block
Unexp. Comm. Msg. Unacked UCOMMU NO (0), YES (1) – WR Discrete 29
ICN overload OLOADS ENABLE(0), SUPPRESS(1) CWR Discrete 30
ICN Overload Unacked OLOADU NO (0), YES (1) – WR Discrete 31
Too many messages received QFULLS ENABLE(0), SUPPRESS(1) CWR Discrete 32
for scan group
Req. Buffer Full Unacked QFULLU NO (0), YES (1) – WR Discrete 33

4-7
Logic Functions - Book 1

LOOP BLOCK

Table 4-1. ICN Communication Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Bus Restart Counter RSTC – WR Count 34
Restart Failure Counter FAILC – WR Count 35
Invalid Message Counter MSGC – WR Count 36
Check-Sum Error Counter CRCC – WR Count 37
Framing Error Counter FRAMEC – WR Count 38
Noise Error Counter NOISEC – WR Count 39
Overrun Error Counter ORUNC – WR Count 40
Invalid msg. Length Counter LENC – WR Count 41
Receive Buffer Full Counter RFULLC – WR Count 42
Xmit. Buffer Full Counter XFULLC – WR Count 43
Unexp. Comm. Msg. Counter UCOMMC – WR Count 44
ICN Overload Counter OLOADC – WR Count 45
Req. Buffer Full Counter QFULLC – WR Count 46
Foreground List FG NONE(0), CL10(10) to CLn CWR Count 47
ICN Load LOAD ––R Msec Time 48
Reset Diagnostic Ctrs RESET NO (0), YES (1) – WR Discrete 49
I/O Module Mismatch MODMM NO (0), YES (1) ––R Discrete 51
ICN Address ADDR ANY, 0 to 15 ––R Short State 52
Board number BOARD 1 ––R Long State 53
Slot number SLOT 32, 30, 29, 28, 27, 26 ––R Long State 54
Terminating Source TERM FALSE (0), TRUE (1) ––R Discrete 55

02 State (STATE) .................................................................................................................... – – R


Not configurable in this block (always equal to RUN). See Section 2.4.1, State Changes for
additional information. This block, when configured, is always executed in the RUN state
(Normal Operation).

03 Bad Inputs Accepted (BADINP) ....................................................................................... – – R


This attribute is not used with this block. The ICN communication block always runs without a
check on input quality. See Section 2.3.2, Data Quality for additional information.

04 Diagnostic Group (SUPPGRP)......................................................................................... CWR


The diagnostic errors reported by this block can be grouped for System Event block control of
their reporting.
NONE No group assigned.
1 to 7 The number of the diagnostic suppression group as controlled by the System
Event block.

4-8
Logic Functions - Book 1

ICN COMMUNICATION BLOCK

05 Module missing or invalid (MODMMS) ............................................................................CWR


This diagnostic compares each slot configured for an ICN communications module against the
content of the slot during a power-up or database download. If the slot is empty or the
installed module does not match the configuration, this diagnostic is generated.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear. Even though this I/O mismatch diagnostic is suppressed, the
actual I/O mismatch condition is still determined (see Attribute 51,
MODMM).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as MODULE
MISMATCH.

06 Module Missing Unacked (MODMMU) ............................................................................ – WR


If the module missing or invalid diagnostic is enabled, this status indicates if the diagnostic is
or is not unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

07 Module Missing Active (MODMMA)..................................................................................– – R


If the module missing or invalid diagnostic is enabled, this status indicates if the diagnostic is
or is not active. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

08 Access timeout (RSTS) .....................................................................................................CWR


This diagnostic (bus restart) checks if the access to transmit has been granted within the last
one second.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “ACCESS
TIMEOUT”. This indicates access to transmit has not been granted
for at least one second. Token ring broken, ICN restarted.

09 Bus Restart Unacked (RSTU) .......................................................................................... – WR


If the access timeout diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

10 Restart Failure (FAILS) ......................................................................................................CWR


This diagnostic checks if communications can be established.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “RESTART
FAILURE”. This indicates communications cannot be established.

4-9
Logic Functions - Book 1

LOOP BLOCK

11 Restart Failure Unacked (FAILU) .....................................................................................– WR


If the restart failure diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

12 Invalid message (MSGS) .................................................................................................. CWR


This diagnostic checks if the message code of a received message is valid or is supported by
the software.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “INVALID
MESSAGE”. This indicates the message code of a received
message was invalid or is not supported by the software.

13 Invalid Message Unacked (MSGU) ..................................................................................– WR


If the invalid message diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

14 Message data invalid (CRCS) .......................................................................................... CWR


This diagnostic checks if a received message can be processed using a Cyclical Redundancy
Check (CRC) check.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “MESSAGE
DATA INVALID”. This indicates a received message could not be
processed because it failed the CRC check.

15 Check-Sum Error Unacked (CRCU).................................................................................– WR


If the message data invalid diagnostic is enabled, this status indicates if the diagnostic is or is
not unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

16 Framing error (FRAMES) .................................................................................................. CWR


This diagnostic checks if a stop bit is received for a byte as detected by the 68032.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “FRAMING
ERROR”. This indicates no stop bit detected by the 68032 for a
received byte.

4-10
Logic Functions - Book 1

ICN COMMUNICATION BLOCK

17 Framing Error Unacked (FRAMEU) ................................................................................. – WR


If the framing error diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

18 Noise error (NOISES) ........................................................................................................CWR


This diagnostic checks if the three samples for a bit are identical. Diagnostic is detected by
the 68302.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “NOISE
ERROR”. This indicates the three samples for a bit were not
identical.

19 Noise Error Unacked (NOISEU)....................................................................................... – WR


If the noise error diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

20 Overrun error (ORUNS).....................................................................................................CWR


This diagnostic checks if the central processor can store a received byte by the time the next
byte is received. Diagnostic is detected by the 68302.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “OVERRUN
ERROR”. This indicates the central processor could not store a
received byte before the next byte was received.

21 Overrun Error Unacked (ORUNU) ................................................................................... – WR


If the overrun error diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

22 Invalid message size (LENS) ............................................................................................CWR


This diagnostic checks if the size of the message or its data field is valid.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “INVALID
MESSAGE SIZE”. This indicates the size of the message or its data
field is invalid.

4-11
Logic Functions - Book 1

LOOP BLOCK

23 Invalid msg. Length Unacked (LENU) .............................................................................– WR


If the invalid message size diagnostic is enabled, this status indicates if the diagnostic is or is
not unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

24 Too many messages received for port (RFULLS) .......................................................... CWR


This diagnostic checks if the receive buffer has room for the message being received.
Diagnostic is detected by the 68302.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “EXCESS
MESSAGES RECEIVED”. This indicates the receive buffer for this
port had no room for the message being received. A message is
"lost".

25 Receive Buffer Full Unacked (RFULLU) ..........................................................................– WR


If the too many messages for received for port diagnostic is enabled, this status indicates if the
diagnostic is or is not unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

26 Too many messages to transmit (XFULLS) .................................................................... CWR


This diagnostic checks if the buffer used for the messages to be transmitted has room for
another.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “EXCESS
MESSAGES TO TRANSMIT”. This indicates the buffer used for the
messages to be transmitted had no room for another. A message is
"lost".

27 Xmit. Buffer Full Unacked (XFULLU) ...............................................................................– WR


If the too many messages to transmit diagnostic is enabled, this status indicates if the
diagnostic is or is not unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

4-12
Logic Functions - Book 1

ICN COMMUNICATION BLOCK

28 Message received for unconfigured IC block (UCOMMS) .............................................CWR


This diagnostic checks if the occurrence for which an input communications message was
received is in the current configuration.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as
“UNEXPECTED COMM MESSAGE RECEIVED”. This indicates an
input communications message was received, but the occurrence for
which it was destined is not in the current configuration.

29 Unexp. Comm. Msg. Unacked (UCOMMU) ..................................................................... – WR


If the message received for unconfigured IC block diagnostic is enabled, this status indicates if
the diagnostic is or is not unacknowledged. The status can be acknowledged or read as
follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

30 ICN overload (OLOADS) ....................................................................................................CWR


This diagnostic checks if the time for each instrument on the ICN to transmit all messages
exceeds the recommended time of 250 msec.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as
“COMMUNICATION OVERLOAD”. This indicates the time for each
instrument on the ICN to transmit all messages exceeded the
recommended time of 250 msec.

31 ICN Overload Unacked (OLOADU) .................................................................................. – WR


If the ICN overload diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

32 Too many messages received for scan group (QFULLS)..............................................CWR


This diagnostic checks if a message is "lost" due to the maximum number of requests queued
for a group being reached.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “EXCESS
MESSAGES FOR TASK”. This indicates the maximum number of
requests queued for a group has been reached. A message is "lost".

4-13
Logic Functions - Book 1

LOOP BLOCK

33 Req. Buffer Full Unacked (QFULLU)................................................................................– WR


If the too many messages received for scan group diagnostic is enabled, this status indicates
if the diagnostic is or is not unacknowledged. The status can be acknowledged or read as
follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

34 Bus Restart Counter (RSTC)............................................................................................– WR


35 Restart Failure Counter (FAILC) ......................................................................................– WR
36 Invalid Message Counter (MSGC) ...................................................................................– WR
37 Check-Sum Error Counter (CRCC)..................................................................................– WR
38 Framing Error Counter (FRAMEC)...................................................................................– WR
39 Noise Error Counter (NOISEC) ........................................................................................– WR
40 Overrun Error Counter (ORUNC).....................................................................................– WR
41 Invalid msg. Length Counter (LENC) ..............................................................................– WR
42 Receive Buffer Full Counter (RFULLC) ...........................................................................– WR
43 Xmit. Buffer Full Counter (XFULLC) ................................................................................– WR
44 Unexp. Comm. Msg. Counter (UCOMMC).......................................................................– WR
45 ICN Overload Counter (OLOADC)....................................................................................– WR
46 Req. Buffer Full Counter (QFULLC).................................................................................– WR
Each of the above diagnostics has a counter which is a free running count (0 to 65535) of the
quantity of errors detected. The count is active even if the diagnostic is suppressed.

47 Foreground List (FG) ........................................................................................................ CWR


The configured list selected here is packed and broadcast once every bus cycle. A configured
list block with a maximum of 235 bytes of foreground data can be selected. With a minimum
foreground of eight bytes, a total of 243 bytes can be broadcast. The selected configured list
must have a buffer allocated (collect data set to YES). Data will be included in any interface
files built for the port at compilation time.
NONE 0 No foreground list.
CL10 10 The number of the configured List (CL) block that determines the
source of foreground data for the port served by this ICN module.
CLn n Same as CL10 (first user list) where n is the last connected list.

Background List
To allow a host PC access to background attributes, the Application Builder allows for a
connection from a configured list block (LISTOUT) to the BGLISTIN for this block. This data
will also be included in any interface files built for this port at compile time.

48 ICN Load (LOAD) ............................................................................................................... – – R


If this instrument is the lowest addressed instrument on the ICN, then this data represents the
time that was used to complete the transmission along the ring. The value should be less
than 0:0:0.250. The value will be zero if the instrument is not the lowest addressed instrument
on the ICN.

49 Reset Diagnostic Ctrs (RESET) .......................................................................................– WR


The reset diagnostic counters command will always read as NO. When YES is written, all
diagnostic counters will be set to zero (0).

4-14
Logic Functions - Book 1

ICN COMMUNICATION BLOCK

51 I/O Module Mismatch (MODMM).......................................................................................– – R


If the module missing or invalid diagnostic is suppressed, this status indicates if the diagnostic
is or is not active (unsuppressed form of I/O module mismatch active). The unsuppressed
mismatch condition is used to determine if there is an active mismatch condition when
switching the diagnostic from suppressed to enable. The status can be read as follows.
NO 0 Diagnostic error is active.
YES 1 Diagnostic error is not active.

52 ICN Address (ADDR) .........................................................................................................– – R


This value represents the actual switch setting (0 to 15) for this ICN communication module.

53 Board Number (BOARD) ...................................................................................................– – R


This is the board number that the physical module is configured for. Currently, the only valid
value is one.

54 Slot Number (SLOT) ..........................................................................................................– – R


This is the slot number that the physical module is configured for. The valid values are 32 for
occurrence one; 30 or 29 for occurrence two; and 28, 27, or 26 for occurrence three.

55 Terminating Source (TERM) .............................................................................................– – R


This value indicates if the Model A ICN module automatically terminated the ICN. Note that a
check is made each time the ICN is restarted. The Model A ICN module with the lowest
address automatically terminates unless there are MOD 30 instruments already terminated on
the network.
FALSE 0 ICN module is not terminated.
TRUE 1 ICN module is the terminating source for the ICN.

4-15
Logic Functions - Book 1

LOOP BLOCK

4.2.3 Typical Block Connections for ICN Communication Block


Typical softwiring block structures used on softwiring diagrams are shown in Figure 4-5.

Special configuration connection.


CL10

INPUT1

INPUT99 ICN1

FGLISTIN FG Operator indication of


LISTOUT Condition selected list
ICN Load LOAD and ICN load

Operator writeable attribute.

Figure 4-5. ICN Communication Block, Typical Connections

4.2.4 ICN Communication Block Events


The event codes (and their suggested text messages) for the ICN communication block are
given below. See the referenced data base attributes (in brackets) for additional information.
See the system event block for event transition information.

4 MODULE MISMATCH (5)


5 ACCESS TIMEOUT (8)
6 RESTART FAILURE (10)
7 INVALID MESSAGE (12)
8 MESSAGE DATA INVALID (14)
9 FRAMING ERROR (16)
10 NOISE ERROR (18)
11 OVERRUN ERROR (20)
12 INVALID MESSAGE SIZE (22)
13 EXCESS MESSAGES RECEIVED (24)
14 EXCESS MESSAGES TO TRANSMIT (26)
15 UNEXPECTED COMM MESSAGE RECEIVED (28)
16 COMMUNICATION OVERLOAD (30)
17 EXCESS MESSAGES FOR TASK (32)

4-16
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

4.3 MODCELL SERIAL COMMUNICATION BLOCK (MSC)


The Modcell Serial communication (MSC) block supports Modbus Slave, Extended Modbus
Slave or Modbus Master communications over either a point-to-point or point-to-multipoint
network. This block supports the Modbus Remote Terminal Unit (RTU) mode of transmission.
The ASCII mode is not supported.

A functional block diagram of the block is shown in Figure 4-6. The MSC block Application
Builder displays which are used to configure the block are shown in Figure 4-7 (page 1) and
Figure 4-8 (page 2). List connections are made to the MSC block.

Modbus Slave
Modbus Slave communications can only be used for reading and writing MODCELL attributes
as registers or coils. This is accomplished by attaching configured lists (CL) and Modbus lists
(ML) to the Discrete Read/Write Lists, Discrete Read Only Lists, Single Register Read/Write
Lists, Single Read Only Lists, Multiple Read/Write Lists and Multiple Read Only Lists. A
Modbus Reference File (MRF) is created for each MSC block in the database. The reference
file contains all configured lists and Modbus lists referenced in the MSC block. For each
referenced list, the file includes all of the points (or registers), LSPs, data types, and any range
or scale factors.

Extended Modbus Slave


The Extended Modbus protocol can be used to access everything within Modcell such as data
base downloading, reading diagnostics, reading the system event queue and reading and
writing attributes. Attaching a Configured List (CL) to this block’s Foreground List attribute will
allow Modcell data to be gathered and packed the same as used in the ICN communication
block. To take advantage of these features, the master’s communication driver must be
appropriately modified. Contact MicroMod Automation for Extended Modbus protocol info.

Modbus Master
This block can be used as a Modbus Master to any Modbus compatible devices. See
Appendix B, Modbus Master Configuration for details.

Communication Modules
One MSC block can support one RS485 (one or two slots) or one RS232 (two slots)
Communication module. Each MSC occurrence is associated with the port of the same
number. MSC1 is configured as port number one (slots 32 or 31-32) on the I/O Module Block
Selection display in the configurator; MSC2 is port two (slots 29 or 28-29, or 30 or 29-30); and
MSC3 is port three (slots 26 or 25-26, 27 or 26-27, or 28 or 27-28).

RS232 modules support point-to-point networks. RS485 modules support either point-to-point
or point-to-multipoint networks. The RS485 and the RS232 module with address switches
support Extended Modbus. When an RS485 communication bus is being used, the Modbus
Master is responsible for providing pull-up and pull-down resistors which will keep the bus in a
MARK/IDLE state when all the transmitters are tri-stated. Refer to IB-23C600, Issue 5 or later
for connection information.

4-17
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

PORTFUNC FG

WRTIMOUT WRACT

1 RS232 or Receive Buffer


RS485 Messages Router
and Message
2 Modules Checker Group
Processors

Transmit Modbus Lists Configured Lists


Buffer SRWLIST 1-5 DRWLIST 1-5
SROLIST 1-5 DROLIST 1-5
(NONE, ML#) MRWLIST 1-5
MROLIST 1-5
(NONE, CL#)

USEDEF
I/O Board Number
Selection
Slot Number ADDR

TARADDR
DATABITS
BAUDRATE
Error Checks

PARITY MODE
MODULE MISSING OR INVALID
STOPBITS MESSAGE CHECK ERROR
MODMM PARITY ERROR
COMMTYPE BREAK ERROR
FRAMING ERROR
NOISE ERROR
OVERRUN ERROR
Suppress INVALID MESSAGE ERROR
Diagnostic Errors RECEIVE BUFFER FULL
Reset Error
Counters SCAN BUFFER FULL
Counters DEFAULT COMM SWITCH SET
Diagnostic Group
Suppression
(NONE, 1-7)
CMD

Figure 4-6. Modcell Serial Communication Block, Functional Block Diagram

4-18
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

Figure 4-7. Modcell Serial Communication (MSC), Edit Block Display, Page 1

Figure 4-8. Modcell Serial Communication (MSC), Edit Block Display, Page 2

4-19
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

4.3.1 Modcell Serial Communication Block Modbus Slave Capabilities


The MSC block is responsible for reading and writing instrument attributes. The MSC block
executes once every 50 milliseconds. The Modbus memory types supported are:
Memory Location Memory Type
0XXXX Read/Write Discrete Points
1XXXX Read Only Discrete Points
30XXX Read Only Single Registers
31XXX Read Only Multiple Registers
40XXX Read/Write Single Registers
41XXX Read/Write Multiple Registers

A subset of the Modbus function codes are supported by MODCELL. The function codes
supported by MODCELL are listed in the following table along with the maximum number of
values the function can read or write. For more information on all Modbus function codes,
refer to the January 1985 version of the Gould Modbus Protocol Reference Guide.
Function Maximum Values
Code Description to Read/Write
01 Read discrete points from (00001 - 00099) 99 points
01 Read discrete points from (00101 - 00199) 99 points
01 Read discrete points from (00201 - 00299) 99 points
01 Read discrete points from (00301 - 00399) 99 points
01 Read discrete points from (00401 - 00499) 99 points

02 Read discrete points from (10001 - 10099) 99 points


02 Read discrete points from (10101 - 10199) 99 points
02 Read discrete points from (10201 - 10299) 99 points
02 Read discrete points from (10301 - 10399) 99 points
02 Read discrete points from (10401 - 10499) 99 points

03 Read registers from (40001 - 40099) 32 registers


03 Read registers from (40101 - 40199) 32 registers
03 Read registers from (40201 - 40299) 32 registers
03 Read registers from (40301 - 40399) 32 registers
03 Read registers from (40401 - 40499) 32 registers

03 Read registers from (41001 - 41999) 125 registers


03 Read registers from (42001 - 42999) 125 registers
03 Read registers from (43001 - 43999) 125 registers
03 Read registers from (44001 - 44999) 125 registers
03 Read registers from (45001 - 45999) 125 registers

04 Read registers from (30001 - 30099) 32 registers


04 Read registers from (30101 - 30199) 32 registers
04 Read registers from (30201 - 30299) 32 registers
04 Read registers from (30301 - 30399) 32 registers
04 Read registers from (30401 - 30499) 32 registers

04 Read registers from (31001 - 31999) 125 registers


04 Read registers from (32001 - 32999) 125 registers
04 Read registers from (33001 - 33999) 125 registers
04 Read registers from (34001 - 34999) 125 registers
04 Read registers from (35001 - 35999) 125 registers

4-20
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

Function Maximum Values


Code Description to Read/Write
05 Write one discrete point 1 attribute
06 Write one register 1 attribute
08 Loopback diagnostic test
(only "Return of query" supported).
15 Write multiple discretes 16 attributes
16 Write multiple registers 16 attributes

Modbus data types are bit (discrete) and word (count, 16 bit positive value). One Count
occupies one register. MODCELL data types can be mapped into the pure Modbus data
types of Discrete and Count. (MODCELL data types can also pass through without being
mapped, for those users who can already support these data types or who modify their
Modbus drivers. The multiple register read/write and multiple register read only lists are
intended for this purpose.) The following table describes how MODCELL data types are
mapped into Modbus data types. Refer to the Modbus List (ML) block for more detail on how
MODCELL data is mapped into pure Modbus data.

MODCELL Data Type Modbus Data Type Comments


Discrete Discrete
Discrete Count
Short State Count
Long State Count
Count Count
Date Count Packed in 16 bits
Date Date Takes 2 registers
ASCII ASCII Takes as many registers as needed
Hex Hex Takes as many registers as needed
Floating Point Count Top and bottom range required; values out
of range will be mapped to 0 or 65535 as
appropriate
Floating Point Floating Point Takes 2 registers
Msec-time Count Scaling factor required; value of 65535
from MODCELL indicates value out of
count range
Msec-time Msec-time Takes 2 registers

When a write message comes from the master to MODCELL, a response is immediately
returned by MODCELL to the master. This response indicates that MODCELL received the
message and that it will be processed internally by the MODCELL. It does not indicate that
the actual attribute or attributes have been changed. For example, if a write is made to the
output of a PID block and the output mode is AUTO, the write does not occur. Writes to the
Modbus network do not take control of the loop; they are one-shot writes. Note that on a
multiple write, all writes may not occur at the same time.

4-21
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

4.3.2 Modcell Serial Communication Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 4-2. The following further
defines the MSC block configuration parameters.

Block Type
MSC This is the Modcell Serial Communication Block type.

Occurrence
1 to 3 There may be up to three ‘instances’ allowed of the Modcell Serial communication
block.

Module location
Scrolled entry. Indicate the slot(s) that the module occupies. Make sure this is compatible with
the module type specified below. MSC modules can occupy 1 or 2 slots, and are associated
with a MODCELL port as follows:
PORT1 - slots 32, or 31-32
PORT2 - slots 29, 28-29, 30, or 29-30
PORT3 - slots 26, 25-26, 27, 26-27, 28, or 27-28

Wiring description
Keyed entry. Any text description.

02 State (STATE) .................................................................................................................... – – R


Not configurable in this block (always equal to RUN). See Section 2.4.1, State Changes for
additional information. This block, when configured, is always executed in the RUN state
(Normal Operation).

03 Bad Inputs Accepted (BADINP) ....................................................................................... – – R


This attribute is not used with this block. The MSC block always runs without a check on input
quality. See Section 2.3.2, Data Quality for additional information.

04 Diagnostic Group (SUPPGRP)......................................................................................... CWR


The diagnostic errors reported by this block can be grouped for System Event block control of
their reporting.
NONE No group assigned. Read as 0.
1 to 7 The number of the diagnostic suppression group as controlled by the
System Event block.

4-22
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

Table 4-2. Modcell Serial Communication Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1, 2 ––R Long State 00
Block Length BLKLEN ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1, 2, 3, 4, 5, 6, or 7 CWR Long State 04
Module missing or invalid MODMMS ENABLE(0), SUPPRESS(1) CWR Discrete 05
Module Missing Unacked MODMMU NO (0), YES (1) – WR Discrete 06
Module Missing Active MODMMA NO (0), YES (1) ––R Discrete 07
Message Check Error MSGCHKS ENABLE(0), SUPPRESS(1) CWR Discrete 08
Msg. Check Error Unacked MSGCHKU NO (0), YES (1) – WR Discrete 09
Parity Error PARS ENABLE(0), SUPPRESS(1) CWR Discrete 10
Parity Error Unacked PARU NO (0), YES (1) – WR Discrete 11
Break Error BRKS ENABLE(0), SUPPRESS(1) CWR Discrete 12
Break Error Unacked BRKU NO (0), YES (1) – WR Discrete 13
Framing error FRAMES ENABLE(0), SUPPRESS(1) CWR Discrete 14
Framing Error Unacked FRAMEU NO (0), YES (1) – WR Discrete 15
Noise error NOISES ENABLE(0), SUPPRESS(1) CWR Discrete 16
Noise Error Unacked NOISEU NO (0), YES (1) – WR Discrete 17
Overrun error ORUNS ENABLE(0), SUPPRESS(1) CWR Discrete 18
Overrun Error Unacked ORUNU NO (0), YES (1) – WR Discrete 19
Invalid Message Error INVMSGS ENABLE(0), SUPPRESS(1) CWR Discrete 20
Invalid Msg. Error Unacked INVMSGU NO (0), YES (1) – WR Discrete 21
Receive Buffer Full RFULLS ENABLE(0), SUPPRESS(1) CWR Discrete 22
Receive Buffer Full Unacked RFULLU NO (0), YES (1) – WR Discrete 23
Scan Buffer Full QFULLS ENABLE(0), SUPPRESS(1) CWR Discrete 24
Scan Buffer Full Unacked QFULLU NO (0), YES (1) – WR Discrete 25
Default comm switch set DEFCOMMS ENABLE(0), SUPPRESS(1) CWR Discrete 26
Default comm Unacked DEFCOMMU NO (0), YES (1) – WR Discrete 27
Default comm Active DEFCOMMA NO (0), YES (1) ––R Discrete 28
I/O Module Mismatch MODMM NO (0), YES (1) ––R Discrete 30
Board number BOARD 1 ––R Long State 31
Slot number SLOT 32, 30, 29, 28, 27, 26 ––R Long State 32
Message Check Counter MSGCHKC 0 to 65535 – WR Count 33
Parity Error Counter PARC 0 to 65535 – WR Count 34
Break Error Counter BRKC 0 to 65535 – WR Count 35
Framing Error Counter FRAMEC 0 to 65535 – WR Count 36
Noise Error Counter NOISEC 0 to 65535 – WR Count 37
Overrun Error Counter ORUNC 0 to 65535 – WR Count 38
Invalid Message Counter INVMSGC 0 to 65535 – WR Count 39

4-23
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

Table 4-2. Modcell Serial Communication Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Receive Buffer Full Counter RFULLC 0 to 65535 – WR Count 40
Scan Buffer Full Counter QFULLC 0 to 65535 – WR Count 41
Mode MODE Remote Terminal Unit (RTU) – – R Discrete 44
Modcell Serial Address ADDR 1 to 247 CWR Long State 45
Baud Rate BAUDRATE 150 (0), 300 (1), 600 (2), CWR Short State 46
1200 (3), 2400 (4),
4800 (5), 9600 (6),
19200 (7), 38400 (8)
Data Bits DATABITS 8 – – R Short State 47
Parity PARITY NONE(0), ODD(1), EVEN(2) CWR Short State 48
Stop Bits STOPBITS 1, 2 CWR Short State 49
Discrete RW List 1 DRWLIST1 NONE, CL10 to CL4096 C–R Count 50
Discrete RW List 2 DRWLIST2 NONE, CL10 to CL4096 C–R Count 51
Discrete RW List 3 DRWLIST3 NONE, CL10 to CL4096 C–R Count 52
Discrete RW List 4 DRWLIST4 NONE, CL10 to CL4096 C–R Count 53
Discrete RW List 5 DRWLIST5 NONE, CL10 to CL4096 C–R Count 54
Discrete RO List 1 DROLIST1 NONE, CL10 to CL4096 C–R Count 55
Discrete RO List 2 DROLIST2 NONE, CL10 to CL4096 C–R Count 56
Discrete RO List 3 DROLIST3 NONE, CL10 to CL4096 C–R Count 57
Discrete RO List 4 DROLIST4 NONE, CL10 to CL4096 C–R Count 58
Discrete RO List 5 DROLIST5 NONE, CL10 to CL4096 C–R Count 59
Single Reg. RW List 1 SRWLIST1 NONE, ML1 to ML4096 C–R Count 60
Single Reg. RW List 2 SRWLIST2 NONE, ML1 to ML4096 C–R Count 61
Single Reg. RW List 3 SRWLIST3 NONE, ML1 to ML4096 C–R Count 62
Single Reg. RW List 4 SRWLIST4 NONE, ML1 to ML4096 C–R Count 63
Single Reg. RW List 5 SRWLIST5 NONE, ML1 to ML4096 C–R Count 64
Single Reg. RO List 1 SROLIST1 NONE, ML1 to ML4096 C–R Count 65
Single Reg. RO List 2 SROLIST2 NONE, ML1 to ML4096 C–R Count 66
Single Reg. RO List 3 SROLIST3 NONE, ML1 to ML4096 C–R Count 67
Single Reg. RO List 4 SROLIST4 NONE, ML1 to ML4096 C–R Count 68
Single Reg. RO List 5 SROLIST5 NONE, ML1 to ML4096 C–R Count 69
Multiple Reg. RW List 1 MRWLIST1 NONE, CL10 to CL4096 C–R Count 70
Multiple Reg. RW List 2 MRWLIST2 NONE, CL10 to CL4096 C–R Count 71
Multiple Reg. RW List 3 MRWLIST3 NONE, CL10 to CL4096 C–R Count 72
Multiple Reg. RW List 4 MRWLIST4 NONE, CL10 to CL4096 C–R Count 73
Multiple Reg. RW List 5 MRWLIST5 NONE, CL10 to CL4096 C–R Count 74
Multiple Reg. RO List 1 MROLIST1 NONE, CL10 to CL4096 C–R Count 75
Multiple Reg. RO List 2 MROLIST2 NONE, CL10 to CL4096 C–R Count 76
Multiple Reg. RO List 3 MROLIST3 NONE, CL10 to CL4096 C–R Count 77
Multiple Reg. RO List 4 MROLIST4 NONE, CL10 to CL4096 C–R Count 78
Multiple Reg. RO List 5 MROLIST5 NONE, CL10 to CL4096 C–R Count 79

4-24
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

Table 4-2. Modcell Serial Communication Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
ModuleType COMMTYPE RS232 (0), C – R Short State 80
RS485 1 slot 2 wire (1)
RS232 with Address (5)
RS485 with Address (6)
Command CMD Reset Diag. Counters (1), – WR Long State 81
Initialize Serial Port (2)
Be a Master (251)
Be a Slave (252)
Reset Counters RESET NO (0), YES (1) – WR Discrete 82
Port Functionality PORTFUNC SLAVE (0), MASTER (1) CWR Short State 83
Target Address TARADDR ANY (0), 1 - 247 C – R Long State 84
Use Default Comm USEDEF NO (0), YES (1) ––R Discrete 85
Write Message Timeout WRTIMOUT 0 to 255 CWR Long State 86
Write Message Action WRACT Discard (0), Process (1) CWR Short State 87
Foreground List FG NONE, CL10-CL4096 C–R Count 88

05 Module missing or invalid (MODMMS) ............................................................................CWR


This diagnostic compares each slot configured for a MSC communications module against the
content of the slot during a power-up or database download. If the slot is empty or the
installed module does not match the configuration, this diagnostic is generated.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear. Even though the I/O mismatch diagnostic is suppressed, the
actual I/O mismatch condition is still determined (see Attribute 30,
MODMM).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as MODULE
MISMATCH.

06 Module Missing Unacked (MODMMU) ............................................................................ – WR


If the module missing or invalid diagnostic is enabled, this status indicates if the diagnostic is
or is not unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

07 Module Missing Active (MODMMA)..................................................................................– – R


If the module missing or invalid diagnostic is enabled, this status indicates if the diagnostic is
or is not active. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

4-25
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

08 Message Check Error (MSGCHKS).................................................................................. CWR


This diagnostic checks if a received message can be processed by doing a Cyclical
Redundancy Check (CRC).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “MESSAGE
CHECK ERROR.” This indicates that a received message could not
be processed because it failed the CRC check.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

09 Message Check Error Unacked (MSGCHKU) .................................................................– WR


If the message check diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

10 Parity Error (PARS) ........................................................................................................... CWR


This diagnostic checks for parity errors in received messages.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “PARITY
ERROR.” This indicates that a parity error was detected for a
received byte. The message is discarded.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

11 Parity Error Unacked (PARU) ...........................................................................................– WR


If the parity error diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

12 Break Error (BRKS) ........................................................................................................... CWR


This diagnostic checks for a break sequence in the received message as detected by the
68032.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “BREAK
ERROR.” This indicates that a break sequence was detected (a
character with zero value and framing error was received) by the
68032 for a received byte. The message is discarded.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

13 Break Error Unacked (BRKU) ...........................................................................................– WR


If the break error diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

4-26
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

14 Framing error (FRAMES)...................................................................................................CWR


This diagnostic checks if a stop bit is received for a byte as detected by the 68032.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “FRAMING
ERROR.” This indicates no stop bit detected by the 68032 for a
received byte.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

15 Framing Error Unacked (FRAMEU) ................................................................................. – WR


If the framing error diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

16 Noise error (NOISES) ........................................................................................................CWR


This diagnostic checks if the three samples for a bit are identical. Diagnostic is detected by
the 68302.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “NOISE
ERROR.” This indicates the three samples for a bit were not
identical.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

17 Noise Error Unacked (NOISEU)....................................................................................... – WR


If the noise error diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

18 Overrun error (ORUNS).....................................................................................................CWR


This diagnostic checks if the central processor can store a received byte by the time the next
byte is received. Diagnostic is detected by the 68302.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “OVERRUN
ERROR.” This indicates the central processor could not store a
received byte before the next byte was received.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

19 Overrun Error Unacked (ORUNU) ................................................................................... – WR


If the overrun error diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

4-27
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

20 Invalid message error (INVMSGS) .................................................................................. CWR


This diagnostic checks if the message length and size of a received message are valid or if a
global message is used correctly.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “INVALID
MESSAGE.” This indicates the message length was too large, the
message size was incorrect, or there was an illegal use of a global
message. The message is discarded.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

21 Invalid Message Unacked (INVMSGU) ............................................................................– WR


If the invalid message diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

22 Receive Buffer Full (RFULLS) .......................................................................................... CWR


This diagnostic checks if the receive buffer has room for the message being received.
Diagnostic is detected by the 68302.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “EXCESS
MESSAGES FOR PORT.” This indicates the receive buffer for this
port had no room for the message being received. A message is lost.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

23 Receive Buffer Full Unacked (RFULLU) ..........................................................................– WR


If the receive buffer full diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

24 Scan Buffer Full (QFULLS) ............................................................................................... CWR


This diagnostic checks if a message is "lost" due to the maximum number of requests queued
for a group being reached.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “EXCESS
MESSAGES FOR TASK.” This indicates the maximum number of
requests queued for a group has been reached. A message is lost.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

25 Scan Buffer Full Unacked (QFULLU)...............................................................................– WR


If the scan buffer full diagnostic is enabled, this status indicates if the diagnostic is or is not
unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

4-28
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

26 Default comm switch set (DEFCOMMS)..........................................................................CWR


This diagnostic checks if the default communication switch is set (yes) on the RS-232 or RS-
485 module.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as “DEFAULT
COMM SWITCH SET.” This indicates that the default communication
switch is set (yes) on the RS-232 or RS-485 module. Therefore, this
block is functioning as a SLAVE using 9600 baud, no parity and one
stop bit for its communication parameters.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

27 Default comm Unacked (DEFCOMMU) ........................................................................... – WR


If the default comm switch set diagnostic is enabled, this status indicates if the diagnostic is or
is not unacknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

28 Default comm Active (DEFCOMMA) ................................................................................– – R


If the default comm switch set diagnostic is enabled, this status indicates if the diagnostic is or
is not active. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

30 I/O Module Mismatch (MODMM).......................................................................................– – R


If the module missing or invalid diagnostic is suppressed, this status indicates if the diagnostic
is or is not active (unsuppressed form of I/O module mismatch active). The unsuppressed
mismatch condition is used to determine if there is an active mismatch condition when
switching the diagnostic from suppress to enable. The status can be read as follows.
NO 0 Diagnostic error is active.
YES 1 Diagnostic error is not active.

31 Board Number (BOARD) ...................................................................................................– – R


This is the board number that is configured for the physical module. Currently, the only valid
value is one.

32 Slot Number (SLOT) ..........................................................................................................– – R


This is the slot number that is configured for the physical module. The valid values are 32 for
occurrence one; 30 or 29 for occurrence two; and 28, 27, or 26 for occurrence three.

33 Message Check Counter (MSGCHKC) ............................................................................ – WR


34 Parity Error Counter (PARC)............................................................................................ – WR
35 Break Error Counter (BRKC)............................................................................................ – WR
36 Framing Error Counter (FRAMEC) .................................................................................. – WR
37 Noise Error Counter (NOISEC) ........................................................................................ – WR
38 Overrun Error Counter (ORUNC) .................................................................................... – WR
39 Invalid Message Counter (INVMSGC) ............................................................................. – WR
40 Receive Buffer Full Counter (RFULLC)........................................................................... – WR

4-29
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

41 Scan Buffer Full Counter (QFULLC) ..............................................................................– WR


Each of the above diagnostics has a counter which is a free running count (0 to 65535) of the
quantity of errors detected. The count is active even if the diagnostic is suppressed.

44 Mode (MODE)..................................................................................................................... – – R
The Modbus transmission mode of this block. Currently the only valid value is RTU. This
value is read as 0.

45 Modcell Serial Address (ADDR) ....................................................................................... CWR


This value represents the address (1 to 247) for this Modcell Serial communication module.
For those modules with an address switch, the instrument checks that the switch setting
matches the number entered here, or ANY tells instrument to accept any setting. Enter 1-247
(or ANY for modules with an address switch).

46 Baud Rate (BAUDRATE) ................................................................................................... CWR


This value represents the communications port data rate (baud rate). Valid values are:

150 0 Data rate is set to 150 baud.


300 1 Data rate is set to 300 baud.
600 2 Data rate is set to 600 baud.
1200 3 Data rate is set to 1200 baud.
2400 4 Data rate is set to 2400 baud.
4800 5 Data rate is set to 4800 baud.
9600 6 Data rate is set to 9600 baud.
19200 7 Data rate is set to 19200 baud.
38400 8 Data rate is set to 38400 baud.

47 Data Bits (DATABITS)........................................................................................................ – – R


This value represents the number of data bits in the communication data. Currently, the only
valid value is 8 (for RTU mode).

48 Parity (PARITY).................................................................................................................. CWR


This value specifies the parity bit representation.
NONE 0 No parity.
ODD 1 Odd parity.
EVEN 2 Even parity

49 Stop Bits (STOPBITS) ....................................................................................................... CWR


This value represents the number of stop bits in the data. Valid values are 1 and 2.

4-30
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

50-54 Discrete Read/Write List 1 - 5 (DRWLISTn) ................................................................... C – R


These values represent configured lists which make up the discrete read/write lists (1 through
5) for this Modbus port. List 1 has a memory range of (00001 - 00099); list 2 has a memory
range of (00101 - 00199); list 3 has a memory range of (00201 - 00299); list 4 has a memory
range of (00301 - 00399); and list 5 has a memory range of (00401 - 00499). The selected
configured list must be configured, have a buffer allocated, and every variable in the list must
be a discrete data type or NONE. Nested lists are not allowed.
NONE No configured list. Read as 0.
CL10 to CL4096 The number of the Configured List (CL) block that makes up the
discrete read/write list for this Modbus port. Read as the number of
the Configured List (10 to 4096).

55-59 Discrete Read Only List 1 - 5 (DROLISTn) ..................................................................... C – R


These values represent configured lists which make up the discrete read only lists (1 through
5) for this Modbus port. List 1 has a memory range of (10001 - 10099); list 2 has a memory
range of (10101 - 10199); list 3 has a memory range of (10201 - 10299); list 4 has a memory
range of (10301 - 10399); and list 5 has a memory range of (10401 - 10499). The selected
configured list must be configured, have a buffer allocated, and every variable in the list must
be a discrete data type or NONE. Nested lists are not allowed.
NONE No configured list. Read as 0.
CL10 to CL4096 The number of the Configured List (CL) block that makes up the
discrete read/write list for this Modbus port. Read as the number of
the Configured List (10 to 4096).

60-64 Single Register Read/Write List 1 - 5 (SRWLISTn)........................................................ C – R


These values represent Modbus lists which make up the single read/write register for the lists
(1 through 5) for this Modbus port. List 1 has a memory range of (40001 - 40099); list 2 has a
memory range of (40101 - 40199); list 3 has a memory range of (40201 - 40299); list 4 has a
memory range of (40301 - 40399); and list 5 has a memory range of (40401 - 40499). The
Modbus list block specified must be configured.
NONE No Modbus list. Read as 0.
ML1 to ML4096 The number of the Modbus List (ML) block that makes up the single
read/write register list for this Modbus port. Read as the number of
the Modbus List (1 to 4096).

65-69 Single Register Read Only List 1 - 5 (SROLISTn) ......................................................... C – R


These values represent Modbus lists which make up the single read only register for the lists
(1 through 5) for this Modbus port. List 1 has a memory range of (30001 - 30099); list 2 has a
memory range of (30101 - 30199); list 3 has a memory range of (30201 - 30299); list 4 has a
memory range of (30301 - 30399); and list 5 has a memory range of (30401 - 30499). The
Modbus list block specified must be configured.
NONE No Modbus list. Read as 0.
ML1 to ML4096 The number of the Modbus List (ML) block that makes up the single
read only register list for this Modbus port. Read as the number of
the Modbus List (1 to 4096).

4-31
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

70-74 Multiple Register Read/Write List 1 - 5 (MRWLISTn).....................................................C – R


These values represent configured lists which make up the multiple read/write register for the
lists (1 through 5) for this Modbus port. List 1 has a memory range of (41001 - 41999); list 2
has a memory range of (42001 - 42999); list 3 has a memory range of (43001 - 43999); list 4
has a memory range of (44001 - 44999); and list 5 has a memory range of (45001 - 45999).
The selected configured list must be configured, have a buffer allocated, and not have any
nested lists.
NONE No configured list. Read as 0.
CL10 to CL4096 The number of the Configured List (CL) block that makes up the
multiple read/write register list for this Modbus port. Read as the
number of the Configured List (10 to 4096).

74-79 Multiple Register Read Only List 1 - 5 (MROLISTn) ......................................................C – R


These values represent configured lists which make up the multiple read only register for the
lists (1 through 5) for this Modbus port. List 1 has a memory range of (31001 - 31999); list 2
has a memory range of (32001 - 32999); list 3 has a memory range of (33001 - 33999); list 4
has a memory range of (34001 - 34999); and list 5 has a memory range of (35001 - 35999).
The selected configured list must be configured, have a buffer allocated, and not have any
nested lists.
NONE No configured list. Read as 0.
CL10 to CL4096 The number of the Configured List (CL) block that makes up the
multiple read only register list for this Modbus port. Read as the
number of the Configured List (10 to 4096).

80 Module Type (COMMTYPE) ..............................................................................................C – R


This value represents the type of hardware used for communications. The modules with
address switches require a corresponding MSC block for the instrument to run and prevent a
port mismatch (if no data base is present, a default MSC block is created with a default
communication setup of 9600 baud, no parity, 1 stop bit and slave functionality). Valid
hardware types are:
RS232 (2031N) 0 RS232 communications.
RS485 (2032N) 1 Single slot RS485 communications.
RS232 (2033N) 5 Double slot RS232 communications with Address.
RS485 (2034N) 6 Double slot RS485 communications with Address.

81 Command (CMD) ...............................................................................................................– WR


This field provides a dummy location in the database to which commands can be addressed
using a long state variable. The value read from this location is always 0. The following
values, when written to this location are interpreted as commands:
1 RESET DIAG. COUNTERS - resets all the diagnostic counters to 0.
2 INITIALIZE SERIAL PORT - re-initializes the serial port associated
with this block. Version 2 of this block requires that this value be
written after a communication parameter is changed with a write
message to the database.
251 BE A MODBUS MASTER - re-initializes the serial port associated
with this block to be a Modbus Master.
252 BE A MODBUS SLAVE - re-initializes the serial port associated with
this block to be a Modbus Slave.

4-32
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

82 Reset Counters (RESET).................................................................................................. – WR


The reset counters command will always read as NO. When YES is written, all diagnostic
counters will be set to zero (0).

83 Port Functionality (PORTFUNC) ......................................................................................CWR


Value indicates if the port is functioning as a slave or a master.
0 SLAVE
1 MASTER

84 Target Address (TARADDR) ............................................................................................ C – R


Value indicates the address configured for the slave unit. The value must match the switch
address as follows.
0 ANY For modules with address switches, this configured value must have
an address set on the communication module switch of 1 to 247 or a
port mismatch will be reported (cannot have 0 or greater than 247).
Address switches are read only at power up. This value is not
allowed for the RS232 or RS485 single slot 2-wire modules because
they do not have address switches.
1 - 247 For modules with address switches, this configured value must be
equal to the address set on the communication module switches or a
port mismatch will be reported.

NOTE: Every device on the network should be given a unique address (even a master). This
is important when the use defaults switch is YES or the instrument is not RUN or HOLD
because the MSC block will always be a slave device under these conditions (block will only
function as a Master if the instrument state is RUN or HOLD).

85 Use Default Comm (USEDEF)...........................................................................................– – R


Value indicates the setting of the COMM DEFAULTS switch setting (read only at power up).
NO 0 The data base communication parameters are used.
YES 1 The communication parameters are 9600 baud, no parity, 1 stop bit
and the port functionality is slave. Data base values are left
unchanged. This switch allows you to communicate with the module
when there is a valid database but you do not know what the
database is and what the communication parameters are.

86 Write Message Timeout (WRTIMOUT) .............................................................................CWR


Value (0 to 255) indicates the amount of time (in 50 millisecond units) that can elapse before
the write message timeout action is taken. This applies to the following messages:
WRITE_ATTRIBUTE,
SEQ_WRITE_ATTRIBUTE,
TAKE_CONTROL,
RELEASE_CONTROL AND
OVERRIDE_CONTROL
These messages cannot be processed until the scan task they are directed to is idle. If the
value is zero, an ACK is returned immediately, the Write Message Action attribute is not used
and the message will be processed when it can but it may or may not be accepted.

4-33
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

87 Write Message Action (WRACT) ...................................................................................... CWR


This value indicates the action that will be taken if a message times out.
NO 0 Discard message and return NAK code “TIME EXPIRED MSG
DISCARDED”
YES 1 Return NAK code “TIME EXPIRED MSG PROCESSED”. The
message will be processed when it can but it may or may not be
accepted.

88 Foreground List (FG) ........................................................................................................C – R


Connect a Configured List block (LISTOUT) to the FGLISTIN connection of this block to
specify foreground data (FG value = occurrence number of the CL block). This data will also
be included in any interface files you build for this port at compile time. In Logic Controller
versions 1 - 4, Regulatory Controller versions 1 - 3, and Batch Controller version 1, foreground
data can't exceed 246 bytes (when packed). In all other MODCELL versions, foreground data
can't exceed 2400 bytes (when packed).
NONE 0 Indicates there is no list attached.
10-4096 Occurrence number of the configured list block

Background List
To allow a host PC access to background attributes, the Application Builder allows for a
connection from a configured list block (LISTOUT) to the BGLISTIN for this block. This data
will also be included in any interface files built for this port at compile time.

4-34
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

4.3.3 Typical Block Connections for Modcell Communication Block


Typical softwiring block structures used to connect an MSC block are shown in Figure 4-9.

MSC1 Operator indication


ML1 of data.
LISTOUT SROIN1

SRWIN1
ML2
Command
LISTOUT

INPUT1

Operator indication
CL10 MSC1 of data.

LISTOUT FGLISTIN

BGLISTIN
CL12
Command
LISTOUT
INPUT1

Figure 4-9. Modcell Serial Communication Block, Typical Block Connections

4.3.4 Modcell Serial Communication Block Events


The event codes (and their suggested text messages) for the Modcell Serial communication
block are given below. See the referenced data base attributes (in brackets) for additional
information. See the system event block for event transition information.

4 MODULE MISMATCH (5)


5 MESSAGE CHECK ERROR (8)
6 PARITY ERROR (10)
7 BREAK ERROR (12)
8 FRAMING ERROR (14)
9 NOISE ERROR (16)
10 OVERRUN ERROR (18)
11 INVALID MESSAGE (20)
12 EXCESS MESSAGES FOR PORT (22)
13 EXCESS MESSAGES FOR TASK (24)
14 DEFAULT COMM SWITCH SET (26)

4-35
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

4.3.5 Using the Modcell Serial Communication Block


A Modbus Reference File, similar to the following file, is created for each MSC block that
exists in the database. Notice that an entry of NONE within a list block uses one register
location (point) and that some data types in the Multiple Register Read/Write and Read only
lists use more than one register location.

Occurrence number of the MSC2 CLs specified in Discrete


configured list specified in Read/Write or Read Only lists
DISCRETE READ/WRITE LIST 1
the MSC Edit Block Display CL10 must be configured and have
(page 2) for Discrete a buffer allocated. Nested
Read/Write Memory, List 1. POINT LSP DATA TYPE lists are not allowed.
00001 D0M1,RSC DISCRETE
00002 NONE
00003 D0M3,RSC DISCRETE
Listing of all LSPs that 00004 D0M4,RSC DISCRETE All LSPs in the specified CL
00005 NONE must be of Discrete data type
were configured in the 00006 NONE
specified CL, including 00007 D0M7,RSC DISCRETE or NONE.
their data types and point 00008 D0M8,RSC DISCRETE
locations. 00009 NONE
00010 NONE
DISCRETE READ/WRITE LIST 2
No CLs were specified for NO LIST SPECIFIED
DISCRETE READ/WRITE LIST 3
Discrete Read/Write NO LIST SPECIFIED
Memory Lists 2 through 5. DISCRETE READ/WRITE LIST 4
NO LIST SPECIFIED
DISCRETE READ/WRITE LIST 5
NO LIST SPECIFIED
Occurrence number of the
configured list specified in
DISCRETE READ ONLY LIST 1
the MSC Edit Block Display CL11
(page 2) for Discrete Read
Only Memory, List 1. POINT LSP DATA TYPE
10001 EX2,I1 DISCRETE
10002 EX2,I2 DISCRETE
10003 EX2,I3 DISCRETE
10004 EX2,I4 DISCRETE
10005 EX2,I5 DISCRETE
10006 EX2,I6 DISCRETE
10007 EX2,I7 DISCRETE
10008 EX2,I8 DISCRETE
Each entry of NONE in a 10009 EX2,I9 DISCRETE
specified CL (or ML) uses 10010 EX2,I10 DISCRETE
one point location 10011 NONE
(register). 10012 NONE

DISCRETE READ ONLY LIST 2


NO LIST SPECIFIED
DISCRETE READ ONLY LIST 3
NO LIST SPECIFIED
DISCRETE READ ONLY LIST 4
NO LIST SPECIFIED
DISCRETE READ ONLY LIST 5
NO LIST SPECIFIED

4-36
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

Occurrence number of MLs specified in Single Register


the Modbus list Read/Write or Read Only lists must be
SINGLE REGISTER READ/WRITE LIST 1 configured.
specified in the MSC ML1
Edit Block Display
(page 2) for Single REGISTER LSP DATA TYPE RANGE OR SCALE FACTOR
Register Read/Write 40001 EX1,I1 FLOAT PT -100.000000, 100.000000
40002 EX1,I2 MSEC TIME 1
Memory, List 1. 40003 EX1,I3 COUNT
40004 EX1,I4 DISCRETE Range and Scale Factors are
40005 EX1,I5 LONG STATE listed as configured in the
40006 EX1,I6 SHORT STATE specified ML.
40007 EX1,I7 DATE
40008 EX1,I8 FLOAT PT 0.000000, 65535.000000
40009 EX1,I9 MSEC TIME 10000
40010 EX1,I11 DISCRETE
40011 EX1,I12 LONG STATE
40012 EX1,I13 SHORT STATE
40013 EX1,I14 DATE
40014 EX1,I15 FLOAT PT 65535.000000, 0.000000
40015 EX1,I16 MSEC TIME 100000

SINGLE REGISTER READ/WRITE LIST 2


NO LIST SPECIFIED
SINGLE REGISTER READ/WRITE LIST 3
NO LIST SPECIFIED
SINGLE REGISTER READ/WRITE LIST 4
NO LIST SPECIFIED
Occurrence number of SINGLE REGISTER READ/WRITE LIST 5
the Modbus list NO LIST SPECIFIED
specified in the MSC
Edit Block Display
SINGLE REGISTER READ ONLY LIST 1
(page 2) for Single ML2
Register Read Only
Memory, List 1. REGISTER LSP DATA TYPE RANGE OR SCALE FACTOR
30001 EX8,I1 FLOAT PT -100.000000, 100.000000
30002 EX8,I2 MSEC TIME 1
30003 NONE
30004 EX8,I4 DISCRETE
30005 EX8,I5 LONG STATE
30006 EX8,I6 SHORT STATE
30007 EX8,I7 DATE
30008 EX8,I8 FLOAT PT 0.000000, 65535.000000
30009 EX8,I9 MSEC TIME 10000
30010 EX8,I10 COUNT
SINGLE REGISTER READ ONLY LIST 2
NO LIST SPECIFIED
SINGLE REGISTER READ ONLY LIST 3
NO LIST SPECIFIED
SINGLE REGISTER READ ONLY LIST 4
NO LIST SPECIFIED
SINGLE REGISTER READ ONLY LIST 5
NO LIST SPECIFIED

4-37
Logic Functions - Book 1

MODCELL SERIAL COMMUNICATION BLOCK

Occurrence number of
the configured list MULTIPLE REGISTER READ/WRITE LIST 1 CLs specified in Multiple
CL13 Register Read/Write or Read
specified in the MSC
Edit Block Display Only lists must be
REGISTER LSP DATA TYPE
(page 3) for Multiple 41001 EX3,I1 FLOAT PT configured and have a buffer
Register Read/Write 41003 EX3,I2 COUNT allocated. Nested lists are
41004 EX3,I3 MSEC TIME not allowed.
Memory, List 1. 41006 EX3,I4 DISCRETE
41007 EX3,I5 DATE
41009 EX3,I6 ASCII (SIZE 12) ASCII data of field size
Some data types use 41015 EX3,I7 LONG STATE 12 uses 6 registers.
more than one register 41016 EX3,I8 HEX (SIZE 9)
location. ASCII and Hex 41021 EX3,I9 SHORT STATE
41022 EX3,I10 FLOAT PT Hex data of field size 9
data can use any 41024 EX3,I11 ASCII (SIZE 13) uses 5 registers.
number of registers 41031 NONE
depending on their field 41032 NONE ASCII data of field size
size. MULTIPLE REGISTER READ/WRITE LIST 2 13 uses 7 registers.
NO LIST SPECIFIED
MULTIPLE REGISTER READ/WRITE LIST 3
NO LIST SPECIFIED
MULTIPLE REGISTER READ/WRITE LIST 4
NO LIST SPECIFIED
MULTIPLE REGISTER READ/WRITE LIST 5
NO LIST SPECIFIED
Occurrence number
of the configured list MULTIPLE REGISTER READ ONLY LIST 1
specified in the MSC CL14
Edit Block Display
(page 3) for Multiple REGISTER LSP DATA TYPE
31001 EX5,I1 FLOAT PT
Register Read Only 31003 EX5,I2 COUNT
Memory, List 1. 31004 EX5,I3 MSEC TIME
31006 EX5,I4 DISCRETE
31007 EX5,I5 DATE
31009 EX5,I6 ASCII (SIZE 12)
31015 EX5,I7 LONG STATE
31016 EX5,I8 HEX (SIZE 9)
31021 EX5,I9 SHORT STATE
31022 EX5,I10 FLOAT PT
31024 EX5,I11 COUNT

MULTIPLE REGISTER READ ONLY LIST 2


NO LIST SPECIFIED
MULTIPLE REGISTER READ ONLY LIST 3
NO LIST SPECIFIED
MULTIPLE REGISTER READ ONLY LIST 4
NO LIST SPECIFIED
MULTIPLE REGISTER READ ONLY LIST 5
NO LIST SPECIFIED

4-38
Logic Functions - Book 1

INPUT/OUTPUT MODULE BLOCKS

5
INPUT/OUTPUT MODULE DATABASE PARAMETERS

5.1 INPUT/OUTPUT MODULE BLOCKS


Input/Output module blocks define a physical input or output connection point and are not part
of a loop scan group. The I/O module blocks are available inside or outside of loop
compounds. One of these modules is required to get a field signal into the instrument. Local
I/O modules are selected from the Input/Output Library at the instrument or loop level. The
different types and their associated hardware modules are:

DIM Digital Input Module. Reference Section 5.2. This block links MODOUT for
the following modules to a DI block (MODIN).
2004A Solid State Relay Input,
2006A Unconditioned Digital Input

DOM Digital Output Module. Reference Section 5.3. This block has a discrete
attribute INPUT link for the following modules.
2005A Solid State Relay Output,
2007A Unconditioned Digital Output

WDOM Wide Digital Output Module. Reference Section 5.3. This block has a discrete
attribute INPUT link for the following module.
2011A Mechanical Relay Output – Single Form C Type (two slots)

DDOM Dual Digital Output Module. Reference Section 5.3. This block has two
discrete attribute INPUT links for the following module.
2011A Mechanical Relay Output – Dual SPST Type (two slots)

VCIM VCIM Voltage/Current Input Module. Reference Section 5.4. This block links

MODOUT for the following modules to a VCI, TTI or RTTI block (MODIN).
2001A Voltage Input Module,
2002A Current Input Module,
2012A Current Input with 2-Wire Transmitter Power

TIM TIM Thermocouple Input Module. Reference Section 5.4. This block links

MODOUT for the following module to a TI block (MODIN).


2013A Thermocouple Input with Upscale Burnout Detection

RIM RIM Resistance Input Module. Reference Section 5.4. This block links

MODOUT for the following module to a RI or RTI block (MODIN) or a TIM


block (CJCIN).
2009A RTD Input (2 Wire)

WRIM WRIM Wide Resistance Input Module. Reference Section 5.4. This block is

like RIM block except it links the following module.


2009A RTD Input (3 Wire)

5-1
Logic Functions - Book 1

INPUT/OUTPUT MODULE BLOCKS

AOM Analog Output Module. Reference Section 5.5. This block has a floating pt.
attribute INPUT link for the following module.
2003A Current Output

In general, a digital or analog input or output module may be used in any location. However,
wiring considerations and power considerations, as described in the appropriate installation
book, may require separation of signal types into specific locations. The relationship between
the module blocks and the function blocks is shown in Figure 5-1.

INPUT MODULE TYPES INPUT MODULE BLOCKS INPUT FUNCTION BLOCKS

2001A Voltage Input Voltage Input


Voltage/Current Block (VCI) Engineering
2002A Current Input Input Module Block Units
2012A Current Input with (VCIM)
2-Wire Transmitter Power
Temperature
Transmitter Input Degrees
Block (TTI)

RTD Transmitter
Input Block (RTTI) Degrees
Thermocouple
2013A Thermocouple Input Input Module
Block (TIM)
Thermocouple
Input Block (TI) Degrees

Resistance Input Engineering


Block (RI) Units

RTD Input
2009A RTD Input, 2 Wire Module Blocks
2009A RTD Input, 3 Wire (RIM, WRIM) RTD Input Block
(RTI) Degrees

Figure 5-1. Analog Input Module and Input Function Block Relationships

5-2
Logic Functions - Book 1

DIGITAL INPUT MODULE BLOCK (DIM)

5.2 DIGITAL INPUT MODULE BLOCK (DIM)


The digital input module block serves as the data handling block for the digital input module.
A digital input module conditions a field signal and processes the signal through an on-board
select circuit which passes all digital data between the modules and the module blocks at the
base scan rate of 50 milliseconds. Input filtering and power-up conditions are determined by
the digital input function block (DI). The digital input module block identifies a single point
connection to one of the following digital input modules:

DIM 2004A Solid State Relay Input


2006A Unconditioned Digital Input

Block outputs are the data, data quality, and active and unacknowledged status of the block’s
diagnostic error. A functional block diagram of a digital input module block is shown in Figure
5-2. The displays used to configure the Digital Input Module block are shown in Figures 5-3
and 5-4.

Input Module
• Solid State Relay Input
• Unconditioned Digital Input

Discrete Value
Manual
GOOD Lock Result
1 Field Auto
Result
2 Unlock
BAD

Manual
Board Number GOOD
I/O Result
Selection Auto Quality
Slot Number Lock
Unlock
FRQ

I/O Mismatch I/O Lock Mode


(SUPP/ENAB) (from IF Block)
Error Check
I/O Comm. Error
MODMMU
Diagnostic
Group MODMMA
(NONE, 1 - 7)
MODMM

Figure 5-2. Digital Input Module Block, Functional Block Diagram

5-3
Logic Functions - Book 1

DIGITAL INPUT MODULE BLOCK (DIM)

Figure 5-3. Digital Input Module (DIM), General Menu

Figure 5-4. Digital Input Module (DIM), Diagnostic Menu

5-4
Logic Functions - Book 1

DIGITAL INPUT MODULE BLOCK (DIM)

5.2.1 Digital Input Module Block Operation


The Digital Input Module block is a data repository for the instrument. One module block
services one module and as many other digital input function blocks as required can be
connected. All digital inputs are buffered in one of five possible task state tables. Process
input and output routines use these tables to pass data between the module blocks which run
at the base scan rate (50 msec) and the process algorithm blocks which run at the scan group
interval configured for the task.

For inputs, all valid data for a single instrument (up to 32 digital input modules) is read and
stored in these blocks every base scan cycle. The process input algorithm block (DI)
connected to the module block will filter the data according to the parameters found the DI
block’s configuration.

Digital input module blocks generate a diagnostic error based upon the unsuppressed I/O
mismatch condition. Events are reported for setting the block to auto or manual, the I/O
mismatch, or state changes.

During a warm or cold start condition, a pre-run read of the module value is performed to
initialize the field result, result, conditioning and I/O task buffer values. If no I/O
communications error is encountered these values are forward initialized and their qualities
marked GOOD, otherwise the previous values are held and their qualities marked BAD. If the
mode is MANUAL, the pre-run read value gets loaded into the field result, the result remains
at its previous value and its quality marked GOOD.

5-5
Logic Functions - Book 1

DIGITAL INPUT MODULE BLOCK (DIM)

5.2.2 Digital Input Module Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 5-1. The following further
defines the Digital Input/Output Module Block configuration parameters.

Block Type
DIM This is the Digital Input Module Block type.

Occurrence
1 to 32 There may be up to 32 ‘instances’ allowed of the DIM block type.

Table 5-1. Digital Input Module Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION ––R Long State 00
Block Length BLKLEN ––R Count 01
Block State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1 to 7 CWR Long State 04
I/O Mismatch MODMMS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO (0), YES (1) – WR Discrete 06
Active I/O Mismatch MODMMA NO (0), YES (1) ––R Discrete 07
I/O Module Mismatch MODMM 0, 1 ––R Discrete 08
Board number BOARD 1 ––R Long State 09
Slot number SLOT 1 through 32 ––R Long State 10
Mode MODE MANUAL (0), AUTO (1) CWR Discrete 11
Field Result FR FALSE (0), TRUE (1) ––R Discrete 12
Field Result Quality FRQ GOOD (0) or BAD (1) ––R Discrete 13
Initial Result Value (Result) R FALSE (0), TRUE (1) CWR Discrete 14
Result Quality RQ GOOD (0) or BAD (1) – WR Discrete 15

02 Block State (STATE).......................................................................................................... – – R


Not configurable in this block (always equal to RUN). See Section 2.4.1, Block States for
additional information. This block, when configured, is always executed in the RUN state
(Normal Operation).

03 Bad Inputs Accepted (BADINP) ....................................................................................... – – R


This attribute is not used with this block. The DIM Module block always runs without a check
on input quality. See Section 2.3.2, Data Quality for additional information.

04 Diagnostic Group (SUPPGRP)......................................................................................... CWR


The diagnostic errors reported by this block can be grouped for System Event block control of
their reporting.
NONE No group assigned.
1 to 7 Defines the diagnostic group number for the diagnostic suppression group
controlled by the System Event block.

5-6
Logic Functions - Book 1

DIGITAL INPUT MODULE BLOCK (DIM)

05 I/O Mismatch (MODMMS) ..................................................................................................CWR


The I/O mismatch diagnostic compares each slot configured for a digital input module against
the contents of the slot during a power-up or database download. If the slot contains an
intelligent module (analog input, analog output, ICN, MSC or RIO), this diagnostic is
generated.

NOTE: This diagnostic cannot distinguish between an empty slot and a digital I/O
module or between different types of digital I/O modules.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear. Even though the I/O mismatch diagnostic is suppressed, the
actual I/O mismatch condition is still determined (see Attribute 08,
MODMM).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as I/O
MISMATCH.

06 Unacked I/O Mismatch (MODMMU)................................................................................. – WR


If the I/O mismatch diagnostic error is enabled, the unacknowledged I/O mismatch diagnostic
status indicates if the diagnostic is or is not acknowledged. The status can be acknowledged
or read as follows.
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

07 Active I/O Mismatch (MODMMA) ......................................................................................– – R


If the I/O mismatch diagnostic error is enabled, the active I/O mismatch diagnostic status
indicates if the error is active. The status can be read as follows.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

08 I/O Module Mismatch (MODMM).......................................................................................– – R


Even though the I/O mismatch diagnostic may be suppressed and its value not stored with the
active I/O mismatch attribute, the actual I/O mismatch condition can still be determined by this
attribute (value is unsuppressed). This attribute is used to determine if there is an I/O
mismatch when changing the I/O mismatch diagnostic from suppressed to enabled.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

09 Board Number (BOARD) ...................................................................................................– – R


This is the board number that the physical module is configured for. Currently, the only valid
value is 1.

10 Slot Number (SLOT) ..........................................................................................................– – R


This is the slot number that the physical module is configured for. Valid values are 1 to 32.

5-7
Logic Functions - Book 1

DIGITAL INPUT MODULE BLOCK (DIM)

11 Mode (MODE)..................................................................................................................... CWR


The mode of the block is determined by configuring and/or writing this attribute. Changing
mode is an informational event.
AUTO 1 The block input is processed using the input module data.
MAN 0 The block input is the manual data form of the result.

12 Field Result (FR) ............................................................................................................... – – R


This is the actual field input value to the instrument.

13 Field Result Quality (FRQ) ............................................................................................... – – R


This data quality field will go BAD if any of the blocks diagnostic errors becomes active.

14 Initial Result Value (R) ...................................................................................................... CWR


This is the field input value to the instrument when an input block is in auto. When the block is
in manual or the I/O is locked, this is the last value written to the result. The result may only
be written if the mode is manual or the I/O is locked.

15 Result Quality (RQ) ...........................................................................................................– WR


This data quality field will go BAD if any of the blocks diagnostic errors becomes active while
the block is in auto. When the block is in manual or the I/O is locked, this is the last value
written to the result quality.

5.2.3 Typical Block Connections for Digital Input Block


Typical softwiring block structures used on softwiring diagrams are shown in Figure 5-4.

Slot 1 DIM1
1
2
Field Result Softwiring connection to
R Digital Input Block (DI).
Result
RQ Operator indication of
Result Quality data quality and block
MODE mode.
Mode

Operator write access to set mode.


Figure 5-4. Digital Input Block, Typical Connections

5.2.4 Digital Input Block Events


The event codes (and their suggested text messages) for the digital input module block are
given below. See data base attributes for additional information. See the system event block
for event transitions.

4 BLOCK MODE SET TO AUTO


5 BLOCK MODE SET TO MANUAL
6 I/O MISMATCH

5-8
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

5.3 DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)


Digital output module blocks serve as the data handling blocks for the digital output modules.
The output module blocks have their data processed through an on-board select circuit that
passes all digital data between the module blocks and the modules at the base scan rate of 50
milliseconds. The digital output module block receives a read back value from the select
circuit for the module it is connected to. The valid output module types are:

DOM 2005A Solid State Relay Output


2007A Unconditioned Digital Output
DDOM 2011A Mechanical Relay Output (Dual SPST relay)
WDOM 2011A Mechanical Relay Output (Single Form C relay)

The digital output module blocks are data repositories for the instrument. All outputs are
buffered in one of five possible task state tables. Process input and output routines use these
tables to pass data between the module blocks which run at the base scan rate (50 msec) and
the process algorithm blocks which run at the configured scan group interval. All valid output
data for a single instrument (up to 32 digital output modules) is written by the output module
blocks every base scan cycle.

Digital output blocks can generate diagnostic errors based upon the following possible
conditions:
• I/0 mismatch
• Digital output module error

Available to the user as block outputs are the result, read back, track status, quality for the
same, and active and unacknowledged status of the block’s diagnostic errors. A functional
block diagram of a digital output module block is shown in Figure 5-5. This diagram is for the
DOM or WDO block and is typical of one channel of the DDOM block as shown in Figure 5-6.

5-9
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

PART 1 Bad
Track Track
Lock OR Status
Not Run
Manual

I/O Lock Instrument State


(from IF Block) Mode (from IF Block)

FALSE
GOOD
TRUE Input
Unlock
LSP Auto
BAD
Normal
Lock
See PART 2
Bad Inputs Manual
Accepted Initialize
(YES/NO)
Quality Check
LSP Quality
Auto

I/O Board Number


Selection Bad Initialize
AND
Slot Number

RQ
Module Error RBQ
(SUPP/ENAB)
Error Check MODMM (init flag)
Diagnostic MODMMA
Group
(NONE, 1 - 7) MODMMU
I/O Mismatch
(SUPP/ENAB) DOMERRA

DOMERRU

PART 2

Module Error
DIRECT REVERSE
AND

See PART 1 Digital Output Module


Scaled Result Result • Solid State Relay Output
Action • Unconditioned Digital Output
PREVIOUS • SPST Relay Output 1 or 2
Scaled Readback Readback • Form C Relay Output

PRESET

FALSE
Failsafe
Output Value
FS HOLD (from Select
Output to Preset
Output Circuit)
Use on TRUE
Restart Value (T/F)

Figure 5-5. Digital Output Module Block, Functional Block Diagram

5-10
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

Channel 1 MODMM
(Same as Digital I/O Board Number
Input Output Module MODMMA
Selection
signal flow) Slot Number MODMMU
Error Check
RQ1
DDOM1 Diagnostic
Module Error RBQ1
Group
Module (SUPP/ENAB) (NONE, 1 - 7)
Error DDOERRA1

Dual Digital DDOERRU1


Output Module
Module RQ2
Error DDOM2
Module Error RBQ2
(SUPP/ENAB) I/O Mismatch DDOERRA2
(SUPP/ENAB)
DDOERRU2

Channel 2
Input (Same as Digital
Output Module
signal flow)

Figure 5-6. Dual Digital Output Module Block, Functional Block Diagram

5.3.1 Digital Output Module Block Description (DOM)


The digital output module block is configured using the general menu shown in Figure 5-7 and
the diagnostics menu. The mnemonics, valid values, and data types for all fields that may be
selected for display and/or be used in making softwiring connections are listed in Table 5-2.

Figure 5-7. Digital Output Module (DOM), General Menu

5-11
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

Table 5-2. Digital Output Module Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs BADINP Rejected (0), Accepted (1) CWR Discrete 03
Diagnostic Group SUPPGRP NONE, 1 to 7 CWR Long State 04
I/O mismatch MODMMS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO (0), YES (1) – WR Discrete 06
Active I/O Mismatch MODMMA NO (0), YES (1) ––R Discrete 07
DOM module error DOMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 08
Unacked DO Module Error DOMERRU NO (0), YES (1) – WR Discrete 09
Active DO Module Error DOMERRA NO (0), YES (1) ––R Discrete 10
I/O Module Mismatch MODMM FALSE (0), TRUE (1) ––R Discrete 11
Board Number BOARD 1 ––R Long State 12
Slot Number SLOT 1 to 32 ––R Long State 13
Action ACTION REVERSE (0), DIRECT (1) CWR Discrete 14
Mode MODE MANUAL (0), AUTO (1) CWR Discrete 15
Output to use on restart RESTART PREVIOUS (0), PRESET (1) CWR Discrete 16
Preset Output Value PRESET FALSE (0), TRUE (1) CWR Discrete 17
Failsafe Output Value FSOUT FALSE (0), TRUE (1), CWR Short State 18
FS HOLD (2)
Track Status TRKSTAT NO TRACK (0), TRACK (1) – WR Discrete 19
Track Status Quality TRKQ GOOD (0), BAD (1) – WR Discrete 20
Initial Scaled Result Value RSC FALSE (0), TRUE (1) CWR Discrete 21
Scaled Readback RBSC FALSE (0), TRUE (1) ––R Discrete 22
Input INPUT LSP, FALSE (0), TRUE (1) CWR Discrete 23
Readback RB FALSE (0), TRUE (1) ––R Discrete 24
Readback Quality RBQ GOOD (0), BAD (1) ––R Discrete 25
Result R FALSE (0), TRUE (1) ––R Discrete 26
Result Quality RQ GOOD (0), BAD (1) – WR Discrete 27

5-12
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

5.3.2 Dual Digital Output Module Block Description (DDOM)


The channel 1 display used to configure the dual digital output module block is shown in
Figure 5-8 and the diagnostic properties display in Figure 5-9. The mnemonics, valid values,
and data types for all fields that may be selected for display and/or be used in making
softwiring connections are listed in Table 5-3.

NOTE: Channel 1 is the higher numbered module slot position and Channel 2 is the lower
numbered module slot position. For example, Channel 1 is associated with slot 6
when a DDOM module is located in slots 5 and 6. The configuration menus are
otherwise identical.

Figure 5-8. Dual Digital Output Module (DDOM), Channel 1 Configuration Menu

5-13
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

Figure 5-9. Digital Output Module (DOM), Diagnostic Menu

Table 5-3. Dual Digital Output Module Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs BADINP1 Rejected (0), Accepted (1) CWR Discrete 03
Diagnostic Group SUPPGRP NONE, 1 to 7 CWR Long State 04
I/O Mismatch MODMMS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO (0), YES (1) – WR Discrete 06
Active I/O Mismatch MODMMA NO (0), YES (1) ––R Discrete 07
DDOM1 module error DDOERRS1 ENABLE (0), SUPPRESS (1) CWR Discrete 08
Unacked DO Module Error DDOERRU1 NO (0), YES (1) – WR Discrete 09
Active DO Module Error DDOERRA1 NO (0), YES (1) ––R Discrete 10
DDOM2 module error DDOERRS2 ENABLE (0), SUPPRESS (1) CWR Discrete 11
Unacked DO Module Error DDOERRU2 NO (0), YES (1) – WR Discrete 12
Active DO Module Error DDOERRA2 NO (0), YES (1) ––R Discrete 13
I/O Module Mismatch MODMM FALSE (0), TRUE (1) ––R Discrete 14
Board Number BOARD 1 ––R Long State 15
Slot Number SLOT 1 to 32 ––R Long State 16

5-14
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

Table 5-3. Dual Digital Output Module Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Action ACTION1 REVERSE (0), DIRECT (1) CWR Discrete 17
Mode MODE1 MANUAL (0), AUTO (1) CWR Discrete 18
Output to use on restart RESTART1 PREVIOUS (0), PRESET (1) CWR Discrete 19
Preset Output Value PRESET1 FALSE (0), TRUE (1) CWR Discrete 20
Failsafe Output Value FSOUT1 FALSE (0), TRUE (1), CWR Short State 21
FS HOLD (2)
Track Status TRKSTAT1 NO TRACK (0), TRACK (1) – WR Discrete 22
Track Status Quality TRKQ1 GOOD (0), BAD (1) – WR Discrete 23
Initial Scaled Result Value RSC1 FALSE (0), TRUE (1) CWR Discrete 24
Scaled Readback RBSC1 FALSE (0), TRUE (1) ––R Discrete 25
Bad Inputs Accepted BADINP2 YES (1) CWR Discrete 26
Action ACTION2 REVERSE (0), DIRECT (1) CWR Discrete 27
Mode MODE2 MANUAL (0), AUTO (1) CWR Discrete 28
Output to use on restart RESTART2 PREVIOUS (0), PRESET (1) CWR Discrete 29
Preset Output Value PRESET2 FALSE (0), TRUE (1) CWR Discrete 30
Failsafe Output Value FSOUT2 FALSE (0), TRUE (1), CWR Short State 31
FS HOLD (2)
Track Status TRKSTAT2 NO TRACK (0), TRACK (1) – WR Discrete 32
Track Status Quality TRKQ2 GOOD (0), BAD (1) – WR Discrete 33
Initial Scaled Result Value RSC2 FALSE (0), TRUE (1) CWR Discrete 34
Scaled Readback RBSC2 FALSE (0), TRUE (1) ––R Discrete 35
Input 1 INPUT1 LSP, FALSE (0), TRUE (1) CWR Discrete 36
Input 2 INPUT2 LSP, FALSE (0), TRUE (1) CWR Discrete 37
Readback RB1 FALSE (0), TRUE (1) ––R Discrete 38
Readback Quality RBQ1 GOOD (0), BAD (1) ––R Discrete 39
Result R1 FALSE (0), TRUE (1) ––R Discrete 40
Result Quality RQ1 GOOD (0), BAD (1) – WR Discrete 41
Readback RB2 FALSE (0), TRUE (1) ––R Discrete 42
Readback Quality RBQ2 GOOD (0), BAD (1) ––R Discrete 43
Result R2 FALSE (0), TRUE (1) ––R Discrete 44
Result Quality RQ2 GOOD (0), BAD (1) – WR Discrete 45

5-15
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

5.3.3 Wide Digital Output Module Block Description (WDOM)


The menus used to configure the wide digital output module block are shown in Figure 5-10.
The mnemonics, valid values, and data types for all fields that may be selected for display and
/ or be used in making softwiring connections are listed in Table 5-4.

Figure 5-10a. Wide Digital Output Module (WDOM), General Menu

Figure 5-10b. Wide Digital Output Module (WDOM), Diagnostic Menu

5-16
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

Table 5-4. Wide Digital Output Module Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs BADINP Rejected (0), Accepted (1) CWR Discrete 03
Diagnostic Group SUPPGRP NONE, 1 to 7 CWR Long State 04
I/O mismatch MODMMS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO (0), YES (1) – WR Discrete 06
Active I/O Mismatch MODMMA NO (0), YES (1) ––R Discrete 07
WDOM Module Error WDOMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 08
Unacked DO Module Error WDOMERRU NO (0), YES (1) – WR Discrete 09
Active DO Module Error WDOMERRA NO (0), YES (1) ––R Discrete 10
I/O Module Mismatch MODMM FALSE (0), TRUE (1) ––R Discrete 11
Board Number BOARD 1 ––R Long State 12
Slot Number SLOT 1 to 32 ––R Long State 13
Action ACTION REVERSE (0), DIRECT (1) CWR Discrete 14
Mode MODE MANUAL (0), AUTO (1) CWR Discrete 15
Output to use on restart RESTART PREVIOUS (0), PRESET (1) CWR Discrete 16
Preset Output Value PRESET FALSE (0), TRUE (1) CWR Discrete 17
Failsafe Output Value FSOUT FALSE (0), TRUE (1), CWR Short State 18
FS HOLD (2)
Track Status TRKSTAT NO TRACK (0), TRACK (1) – WR Discrete 19
Track Status Quality TRKQ GOOD (0), BAD (1) – WR Discrete 20
Initial Scaled Result Value RSC FALSE (0), TRUE (1) CWR Discrete 21
Scaled Readback RBSC FALSE (0), TRUE (1) ––R Discrete 22
Input INPUT LSP, FALSE (0), TRUE (1) CWR Discrete 23
Readback RB FALSE (0), TRUE (1) ––R Discrete 24
Readback Quality RBQ GOOD (0), BAD (1) ––R Discrete 25
Result R FALSE (0), TRUE (1) ––R Discrete 26
Result Quality RQ GOOD (0), BAD (1) – WR Discrete 27

5-17
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

5.3.4 Digital Output Module Block Parameters


The following further defines the Digital Input/Output Module Block configuration parameters.

Block Type
DOM This is the Digital Output Module Block type. It connects one 2005A
Solid State Relay Output or one 2007A Unconditioned Digital Output.

DDOM This is the Dual Digital Output Module Block type. It connects one 2011A
Mechanical Relay Output (Dual SPST relay).

WDOM This is the Wide Digital Output Module Block type. It connects one 2011A
Mechanical Relay Output (Single Form C relay).

Occurrence
1 to 32 There may be up to 32 ‘instances’ allowed of the digital output module
block types.

DOM 02 State (STATE) .................................................................................................................... – – R


DDOM 02 State (STATE) .................................................................................................................... – – R
WDOM 02 State (STATE) .................................................................................................................... – – R
Not configurable in this block (always equal to RUN). See Section 2.4.1, State Changes for
additional information. This block, when configured, is always executed in the RUN state
(Normal Operation).

DOM 03 Bad Inputs (BADINP)......................................................................................................... CWR


DDOM 03 Bad Inputs (BADINP1)....................................................................................................... CWR
DDOM 26 Bad Inputs (BADINP2)....................................................................................................... CWR
WDOM 03 Bad Inputs (BADINP)......................................................................................................... CWR
The digital output module blocks can run with a check on input quality. See Section 2.3.2,
Data Quality for additional information.
Accepted 1 Input data quality is not checked.
Rejected 0 Input data quality is checked. If input data quality is bad, the input will
not be used, the previous result will be sent to the output module, the
result quality will be marked BAD, and track status will be set to
TRACK.

DOM 04 Diagnostic Group (SUPPGRP)......................................................................................... CWR


DDOM 04 Diagnostic Group (SUPPGRP)......................................................................................... CWR
WDOM 04 Diagnostic Group (SUPPGRP)......................................................................................... CWR
The diagnostic errors reported by this block can be grouped for System Event block control of
their reporting.
NONE No group assigned.
1 to 7 Defines the diagnostic group number for the diagnostic suppression group
controlled by the System Event block.

5-18
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

DOM 05 I/O Mismatch (MODMMS) ..................................................................................................CWR


DDOM 05 I/O Mismatch (MODMMS) ..................................................................................................CWR
WDOM 05 I/O Mismatch (MODMMS) ..................................................................................................CWR
The I/O mismatch diagnostic compares each slot configured for a digital output module
against the contents of the slot during a power-up or database download. If the slot contains
an intelligent module (analog input, analog output, ICN, MSC or RIO), this diagnostic is
generated.
NOTE: This diagnostic cannot distinguish between an empty slot and a digital I/O
module or between different types of digital I/O modules.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear. Even though the I/O mismatch diagnostic is suppressed, the
actual I/O mismatch condition is still determined (see Attribute 11 or
14, MODMM).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as I/O
MISMATCH.

DOM 06 Unacked I/O Mismatch (MODMMU)................................................................................. – WR


DDOM 06 Unacked I/O Mismatch (MODMMU)................................................................................. – WR
WDOM 06 Unacked I/O Mismatch (MODMMU)................................................................................. – WR
If the I/O mismatch diagnostic error is enabled, the unacknowledged I/O mismatch diagnostic
status indicates if the diagnostic is or is not acknowledged. The status can be acknowledged
or read as follows.
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

DOM 07 Active I/O Mismatch (MODMMA) ......................................................................................– – R


DDOM 07 Active I/O Mismatch (MODMMA) ......................................................................................– – R
WDOM 07 Active I/O Mismatch (MODMMA) ......................................................................................– – R
If the I/O mismatch diagnostic error is enabled, the active I/O mismatch diagnostic status
indicates if the error is active even after acknowledgement. The status can be read as follows.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

DOM 08 DOM module error (DOMERRS) .......................................................................................CWR


DDOM 08 DDOM1 module error (DDOERRS1) .................................................................................CWR
DDOM 11 DDOM2 module error (DDOERRS2) .................................................................................CWR
WDOM 08 WDOM module error (WDOMERRS) ................................................................................CWR
This diagnostic checks to see if the module readback value is the same as the previous result
value. Also, this diagnostic is generated when the select circuit, which is used to
communicate with the module blocks, has a diagnostic error. In this case, all modules would
report this diagnostic. The diagnostic can be suppressed or enabled as follows.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.

5-19
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

DOM 09 Unacked DOM Module Error (DOMERRU) ......................................................................– WR


DDOM 09 Unacked DDOM1 Module Error (DDOERRU1) ................................................................– WR
DDOM 12 Unacked DDOM2 Module Error (DDOERRU2) ................................................................– WR
WDOM 09 Unacked WDOM Module Error (WDOMERRU) ...............................................................– WR
If this diagnostic error is enabled, the unacknowledged DO module diagnostic status indicates
if the diagnostic is or is not acknowledged. The status can be acknowledged or read as
follows.
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

DOM 10 Active DOM Module Error (DOMERRA)........................................................................... – – R


DDOM 10 Active DDOM1 Module Error (DDOERRA1) .................................................................... – – R
DDOM 13 Active DDOM2 Module Error (DDOERRA2) .................................................................... – – R
WDOM 10 Active WDOM Module Error (WDOMERRA) .................................................................... – – R
If this diagnostic error is enabled, the active DO module diagnostic status indicates if the error
is active even after acknowledgement. The status can be read as follows.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

DOM 11 I/O Module Mismatch (MODMM) ...................................................................................... – – R


DDOM 14 I/O Module Mismatch (MODMM) ...................................................................................... – – R
WDOM 11 I/O Module Mismatch (MODMM) ...................................................................................... – – R
Even though the I/O mismatch diagnostic may be suppressed and its value not stored with the
active I/O mismatch attribute, the actual I/O mismatch condition can still be determined by this
attribute (value is unsuppressed). This attribute is used to determine if there is an I/O
mismatch when changing the I/O mismatch diagnostic from suppressed to enabled.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

DOM 12 Board Number (BOARD) ................................................................................................... – – R


DDOM 15 Board Number (BOARD) ................................................................................................... – – R
WDOM 12 Board Number (BOARD) ................................................................................................... – – R
This is the board number that the physical module is configured for. Currently, the only valid
value is one.

DOM 13 Slot Number (SLOT) .......................................................................................................... – – R


DDOM 16 Slot Number (SLOT) .......................................................................................................... – – R
WDOM 13 Slot Number (SLOT) .......................................................................................................... – – R
This is the first slot number that the physical module is configured for. The valid values are 1
to 32 for DOM modules and 1 to 13, 15, 17, or 19 to 31 for DDOM and WDOM modules.

DOM 14 Action (ACTION) ................................................................................................................ CWR


DDOM 17 Action (ACTION1) .............................................................................................................. CWR
DDOM 27 Action (ACTION2) .............................................................................................................. CWR
WDOM 14 Action (ACTION) ................................................................................................................ CWR
The action is applied to the result before being sent to the output module and it is applied to
the output again to get the readback value.
REVERSE 0 The result is inverted before being sent to the output module.
DIRECT 1 The result is sent to the output module without change.

5-20
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

DOM 15 Mode (MODE) .....................................................................................................................CWR


DDOM 18 Mode (MODE1) ...................................................................................................................CWR
DDOM 28 Mode (MODE2) ...................................................................................................................CWR
WDOM 15 Mode (MODE) .....................................................................................................................CWR
The mode of the block is determined by configuring and/or writing this attribute. Switching
mode is a reportable event.
MAN 0 The block output is the result value, which may be written by the user.
The readback value is updated with the module value.
AUTO 1 The block output is processed using the input data.

DOM 16 Output to use on restart (RESTART) ...............................................................................CWR


DDOM 19 Output to use on restart (RESTART1) .............................................................................CWR
DDOM 29 Output to use on restart (RESTART2) .............................................................................CWR
WDOM 16 Output to use on restart (RESTART) ...............................................................................CWR
If a cold or frozen start up is occurring, the result will be set depending upon the selection
made here. If this block looses communication with the select circuit, a failsafe condition
results.
PREVIOUS 0 The result existing in the database prior to a failsafe output condition.
PRESET 1 A set value for failsafe output conditions (see preset output value).

DOM 17 Preset Output Value (PRESET) ........................................................................................CWR


DDOM 20 Preset Output Value (PRESET1) ......................................................................................CWR
DDOM 30 Preset Output Value (PRESET2) ......................................................................................CWR
WDOM 17 Preset Output Value (PRESET) ........................................................................................CWR
This is configurable discrete value when preset is selected as the output to use on restart.
FALSE 0 Preset output value is low.
TRUE 1 Preset output value is high.

DOM 18 Failsafe Output Value (FSOUT) ........................................................................................CWR


DDOM 21 Failsafe Output Value (FSOUT1) ......................................................................................CWR
DDOM 31 Failsafe Output Value (FSOUT2) ......................................................................................CWR
WDOM 18 Failsafe Output Value (FSOUT) ........................................................................................CWR
The failsafe output values are stored in the select circuit and are used to determine the output
sent to the module when a failsafe condition occurs. A write to the failsafe output value
causes the value to be downloaded to the module.
FALSE 0 Failsafe output value is low.
TRUE 1 Failsafe output value is high.
FS HOLD 2 Failsafe output value is last result value.

DOM 19 Track Status (TRKSTAT) .................................................................................................. – WR


DDOM 22 Track Status (TRKSTAT1) ................................................................................................ – WR
DDOM 32 Track Status (TRKSTAT2) ................................................................................................ – WR
WDOM 19 Track Status (TRKSTAT) .................................................................................................. – WR
Track status is set to track whenever the path from the input to the result is broken. This
occurs when the data quality is bad, or the I/O lock is locked, or when the mode is manual or
the instrument state is not run.
NO TRACK 0 Data quality is good, I/O lock is unlocked, mode is auto and
instrument state is run.
TRACK 1 Data quality is bad, or I/O lock is locked or mode is manual, or
instrument state is not run.

5-21
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

DOM 20 Track Status Quality (TRKQ)............................................................................................– WR


DDOM 23 Track Status Quality (TRKQ1)..........................................................................................– WR
DDOM 33 Track Status Quality (TRKQ2)..........................................................................................– WR
WDOM 20 Track Status Quality (TRKQ)............................................................................................– WR
This data quality field is not changed by any internal logic and will always be GOOD unless
written otherwise.

DOM 21 Initial Scaled Result Value (RSC) .................................................................................... CWR


DDOM 24 Initial Scaled Result Value (RSC1) .................................................................................. CWR
DDOM 34 Initial Scaled Result Value (RSC2) .................................................................................. CWR
WDOM 21 Initial Scaled Result Value (RSC) .................................................................................... CWR
This is the scaled result of the block evaluation. The result is writeable when the block is in
manual, the I/O locked, or the instrument state is not run (as during download of the
configuration, which establishes the initial result value). Any write to the scaled result will
cause the result quality to be set GOOD.
FALSE 0 Result before action is applied is open.
TRUE 1 Result before action is applied is closed.

DOM 22 Scaled Readback (RB) ...................................................................................................... – – R


DDOM 25 Scaled Readback (RB1) .................................................................................................... – – R
DDOM 35 Scaled Readback (RB2) .................................................................................................... – – R
WDOM 22 Scaled Readback (RB) ...................................................................................................... – – R
The value sent to the output module is read back from the select circuit every base scan cycle,
action is applied, and the value is stored as the scaled readback value.

DOM 23 Input (INPUT) ..................................................................................................................... CWR


DDOM 36 Input 1 (INPUT1) ................................................................................................................ CWR
DDOM 37 Input 2 (INPUT2) ................................................................................................................ CWR
WDOM 23 Input (INPUT) ..................................................................................................................... CWR
This is the input to the block used to determine the output. The input can be local data or a
logical source pointer. When the input is local data, it can be written.
FALSE 0 Local input value is low.
TRUE 1 Local input value is high.
LSP Local input is a discrete logical source pointer.

DOM 24 Readback (RB)................................................................................................................... – – R


DDOM 38 Readback (RB1)................................................................................................................. – – R
DDOM 42 Readback (RB2)................................................................................................................. – – R
WDOM 24 Readback (RB)................................................................................................................... – – R
The value sent to the output module is read back from the select circuit every base scan cycle
and the value is stored as the readback value.

DOM 25 Readback Quality (RBQ)................................................................................................... – – R


DDOM 39 Readback Quality (RBQ1)................................................................................................. – – R
DDOM 43 Readback Quality (RBQ2)................................................................................................. – – R
WDOM 25 Readback Quality (RBQ)................................................................................................... – – R
Readback quality is set BAD if a digital output module error occurs.

5-22
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

DOM 26 Result (R)............................................................................................................................– – R


DDOM 40 Result (R1)..........................................................................................................................– – R
DDOM 44 Result (R2)..........................................................................................................................– – R
WDOM 26 Result (R)............................................................................................................................– – R
This is the result of the block evaluation after action is applied.
FALSE 0 Result sent to output module (after action is applied) is open.
TRUE 1 Result sent to output module (after action is applied) is closed.

DOM 27 Result Quality (RQ)........................................................................................................... – WR


DDOM 41 Result Quality (RQ1)......................................................................................................... – WR
DDOM 45 Result Quality (RQ2)......................................................................................................... – WR
WDOM 27 Result Quality (RQ)........................................................................................................... – WR
The result quality is set BAD when the input status is bad and bad inputs are not accepted, or
if the restart or readback value cannot be read after a warm start. Any write to the result
causes the result quality to be set GOOD. The result quality is writeable in manual, when the
I/O is locked, or the instrument state is not run.

5.3.5 Typical Block Connections for Digital Output Blocks


Typical softwiring block structures used on softwiring diagrams are shown in Figure 5-11.

Slot 8
DO1
R 1
TM1 Result
HILIM 2
High Limit Input
MODE Operator indication of
Mode result and block mode.
Action

Operator write access to set mode and action.

Figure 5-11. Digital Output Block, Typical Connections

5-23
Logic Functions - Book 1

DIGITAL OUTPUT MODULE BLOCKS (DOM, DDOM, WDOM)

5.3.6 Digital Output Module Block Events


The event codes (and their suggested text messages) for the digital output module blocks are
given below. See the referenced data base attributes (in brackets) for additional information.
See the system event block for event transitions.

DOM and WDOM Block Events


4 BLOCK MODE SET TO AUTO
5 BLOCK MODE SET TO MANUAL
6 I/O MISMATCH (5)
7 DO_MODULE_ERROR or WDO_MODULE_ERROR (8)

DDOM Block Events


4 BLOCK MODE_1 SET TO AUTO
5 BLOCK MODE_1 SET TO MANUAL
6 BLOCK MODE_2 SET TO AUTO
7 BLOCK MODE_2 SET TO MANUAL
8 I/O MISMATCH (5)
9 DDO_1_MODULE_ERROR (8)
10 DDO_2_MODULE_ERROR (11)

5-24
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

5.4 ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)


The analog input module blocks serve as the data handling blocks for the analog input
modules. Analog input modules condition the field signals and convert these signals to digital
data in 100 milliseconds. The digital data is requested and processed through an on-board
select circuit which passes the field data between the modules and the blocks using a three
phased 150 millisecond scan cycle for the board. The analog input blocks (VCI, TTI, TI, RI,
RTI and RTTI) are used to determine input filtering, action, normalization, linearization, and
scaling. The relationship between the module blocks and the input function is shown in Figure
5-1. The specific analog input module block types are:
• VCIM Voltage/Current Input Module Block
• TIM Thermocouple Input Module Block
• RIM Resistance Input Module Block (2 Wire)
• WRIM Wide Resistance Input Module Block (3 Wire)

This section describes the analog input module block types and the relationship of their
configuration parameters to the block’s function. All parameters for these blocks are
described in one listing since many of the parameters are the same.

5-25
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

5.4.1 General Operation


These blocks are data repositories for the instrument. One module block services one module
and as many other analog input function blocks as required can receive signals from these
blocks. All input values are buffered in one of five possible state tables. Process input and
output routines use these tables to pass data between the module blocks which get data every
150 milliseconds and the analog input function blocks which run at the configured scan group
interval.

For analog inputs, all valid data for a single instrument (up to 32 analog input modules) is read
and stored in these blocks in a three phased scan cycle. This cycle is shown in Figure 5-12.
The analog input function block connected to the module block latches the data according to
the parameters found in the analog input block’s configuration.

Activity Transfer Analog I/O Data (Modules 1, 4, 7, ... 31) (buffers to module block)
Broadcast ‘Get Data’ (Modules 1, 4, 7, ... 31 perform 100 ms A/D conversion)
Read Analog I/O Data (Modules 2, 5, ... 32)
Write Analog Output Data (Modules 1, 4, 7, ... 31)
Transfer Analog I/O Data (Modules 2, 5, ... 32) (buffers to module block)
Broadcast ‘Get Data’ (Modules 2, 5, ... 32 perform 100 ms A/D conversion)
Read Analog I/O Data (Modules 3, ... 30)
Write Analog Output Data (Modules 2, 5, ... 32)
Transfer Analog I/O Data (Modules 3, ... 30) (buffers to module block)
Broadcast ‘Get Data’ (Modules 3, ... 30 perform 100 ms A/D conversion)
Read Analog I/O Data (Modules 1, 4, 7, ... 31)
Write Analog Output Data (Modules 3, ... 30)
Repeat scan cycle

milliseconds 0 50 100 150

Figure 5-12. Analog Input/Output Type Module Phased Scan Cycle

Analog input module blocks can generate diagnostic errors based upon the
following possible conditions:
• Module mismatch error
• Module communications error
• Module status Error

5-26
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

5.4.2 Voltage/Current Input Module Block Description (VCIM)


This block is used to input a count value from a voltage or current input module. It also
performs filtering for the connected voltage/current input or thermocouple transmitter input
block. A functional block diagram of a VCIM block is shown in Figure 5-13. The menus used
to configure the block are shown in Figures 5-14 and 5-15. The mnemonics, valid values, and
data types for all fields that may be selected for display and/or be used in making softwiring
connections are listed in Table 5-5.

VOLTS

MILLIVOLTS
Input Type
CURRENT
CURRENT Signal Range
2-WIRE Top

GOOD Signal Range


Bottom
Volt/Millivolt Selection
EXTERR
BAD
Linearization
Type

Extended Error
Input Module
• Voltage Input Manual
• Current Input
• Current Input GOOD Lock Result
2-Wire Xmtr Pwr. Auto
FR Unlock
BAD

Manual
GOOD
Result
Status Register Lock Quality
Auto
Quality Check Unlock
FRQ
Communications
Error Condition
I/O Lock
(from IF Mode
Board Number Block)

Slot Number
I/O
Selection
Module ID
MODMM

MODMMA
I/O VCIM
Communi- Module Error COMMERRA
cations Error
VCIMERRA
Error Checks
MODMMU

Diagnostic COMMERRU
I/O Mismatch
Group
VCIMERRU

Figure 5-13. Voltage/Current Input Module Block, Functional Block Diagram

5-27
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

Figure 5-14. Voltage/Current Input Module Block (VCIM), General Menu

Figure 5-15. Voltage/Current Input Module Block (VCIM), Diagnostic Menu

5-28
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

Table 5-5. Voltage/Current Input Module Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
Block State STATE RUN (1) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1 to 7 CWR Long State 04
I/O mismatch MODMMS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO (0), YES (1) – WR Discrete 06
Active I/O Mismatch MODMMA NO (0), YES (1) – WR Discrete 07
I/O communications error COMMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 08
Unacked comm. error COMMERRU NO (0), YES (1) – WR Discrete 09
Active comm. error COMMERRA NO (0), YES (1) – WR Discrete 10
V/I module error VCIMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 11
Unacked Input Module Error VCIMERRU NO (0), YES (1) – WR Discrete 12
Active Input Module Error VCIMERRA NO (0), YES (1) – WR Discrete 13
I/O Module Mismatch MODMM FALSE (0), TRUE (1) ––R Discrete 14
Board number BOARD 1 through 8 ––R Long State 15
Slot number SLOT 1 through 32 ––R Long State 16
Module id MODID FE0000 = Voltage ––R Hex 17
FE0100 = Current (passive)
FE0400 = Current (active)
Extended Error Code EXTERR 0 to 65535 – WR Count 18
Mode MODE AUTO (1), MAN (0) CWR Discrete 19
Input Type INTYPE VOLTS (0), MILLIVOLTS (1), C – R Short State 20
CURRENT (2),
CURRENT 2WIRE (3)
Not used. See Appendix A 21
Signal Range - Top SIGHI value in input units CWR Floating Pt 22
Signal Range - Bottom SIGLO value in input units CWR Floating Pt 23
Initial result (Result) R value CWR Floating Pt 24
Result Quality RQ GOOD (0), BAD (1) – WR Discrete 25
Field Result FR value ––R Floating Pt 26
Field Result Quality FRQ GOOD (0), BAD (1) ––R Discrete 27
Linearization Type TYPE NONE (0), B (1), E (2), J (3), K CWR Long State 28
(4), N (5), R (6), S (7), T(8),
Platinum, 0.003850 (24),
Platinum, 0.003923 (25),
Platinum, 0.003902 (26),
Platinum, 0.003911 (27),
Nickel, 0.006720 (28)

5-29
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

5.4.3 Thermocouple Input Module Block Description (TIM)


This block is used to input a count value from a voltage or thermocouple input module. It also
performs filtering for the connected thermocouple input block. A functional block diagram of a
thermocouple input module block is shown in Figure 5-16. The menus used to configure the
block are shown in Figures 5-17 and 5-18. The mnemonics, valid values, and data types for
all fields that may be selected for display and/or be used in making softwiring connections are
listed in Table 5-6.

MODOUT
Cold Junction
Floating Point value Compensation
GOOD

EXTERR
BAD
Thermocouple
Type

Extended Error

Input Module
- Thermocouple Input Manual
- Millivolt Input Lock
GOOD Auto Result
FR
Unlock
BAD

Manual
GOOD
Lock Result
Status Register Quality
Auto
Quality Check Unlock
FRQ
Communications
Error Condition
I/O Lock
(from IF Block) Mode
Board Number

I/O Selection Slot Number

Module ID
MODMM
MODMMA
I/O TC Module
Communica- Error COMMERRA
tions Error
TIMERRU
Error Checks
MODMMU

Diagnostic I/O COMMERRU


Group Mismatch
TIMERRA

Figure 5-16. Thermocouple Input Module Block, Functional Block Diagram

5-30
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

Figure 5-17. Thermocouple Input Module (TIM), General Menu

Figure 5-18. Thermocouple Input Module (TIM), Diagnostic Menu

5-31
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

Table 5-6. Thermocouple Input Module Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION ––R Long State 00
Block Length BLKLEN ––R Count 01
Block State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1 to 7 CWR Long State 04
I/O mismatch MODMMS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO (0), YES (1) – WR Discrete 06
Active I/O Mismatch MODMMA NO (0), YES (1) – WR Discrete 07
I/O communications error COMMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 08
Unacked comm. error COMMERRU NO (0), YES (1) – WR Discrete 09
Active comm. error COMMERRA NO (0), YES (1) – WR Discrete 10
TIM module error TIMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 11
Unacked Input Module Error TIMERRU NO (0), YES (1) – WR Discrete 12
Active Input Module Error TIMERRA NO (0), YES (1) – WR Discrete 13
I/O Module Mismatch MODMM FALSE (0), TRUE (1) ––R Discrete 14
Board number BOARD 1 through 8 ––R Long State 15
Slot number SLOT 1 through 32 ––R Long State 16
Module id MODID FE0200 ––R Hex 17
Extended Error Code EXTERR 0 to 65535 – WR Count 18
Mode MODE AUTO (1), MAN (0) CWR Discrete 19
Thermocouple Type TCTYPE B (1), E (2), J (3), K (4), N (5), CWR Short State 20
R (6), S (7), T (8)
Cold Junction Comp. CJCLOC NONE, CWR Floating Pt 21
MODOUT connection from
RIM, WRIM, or value with suffix
of C, F, K, or R
Initial Result (Result) R value CWR Floating Pt 22
Result Quality RQ GOOD (0), BAD (1) – WR Discrete 23
Field Result FR value ––R Floating Pt 24
Field Result Quality FRQ GOOD (0), BAD (1) ––R Discrete 25

5-32
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

5.4.4 Resistance Input Module Block Description (RIM)


This block is used to input a count value from a resistance input module. It also performs
filtering for the connected resistance input block. A functional block diagram of a resistance
input module block is shown in Figure 5-19. The menus used to configure the block are
shown in Figures 5-20 and 5-21. The mnemonics, valid values, and data types for all fields
that may be selected for display and/or be used in making softwiring connections are listed in
Table 5-8.

RTD
Input Type
NON-RTD
Signal Range
Apply Only to Top
Non-RTD Input
Types
Signal Range
GOOD Bottom

EXTERR
BAD
RTD Type
Apply Only to
Extended Error RTD Input Types
Input Module Nominal
Resistance Input Resistance
FR

Manual
+ GOOD Lock Result
Auto
Sum Unlock
-
BAD

Leadwire
Resistance
Manual
GOOD
Lock Result
Status Register Auto Quality
Unlock
Quality Check
FRQ
Communications
Error Condition
I/O Lock
(from IF Block) Mode
Board Number

I/O Selection Slot Number

Module ID
MODMM
MODMMA
I/O
Communica- RIM
Module Error COMMERRA
tions Error
Error Checks RIMERRA

MODMMU

Diagnostic COMMERRU
Group I/O Mismatch
RIMERRU

Figure 5-19. Functional Block Diagram, Resistance Input Module Block

5-33
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

Figure 5-20. Resistance Input Module (RIM), General Menu

Figure 5-21. Resistance Input Module (RIM), Diagnostic Menu

5-34
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

Table 5-8. Resistance Input Module Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
Block State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1 to 7 CWR Long State 04
I/O mismatch MODMMS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO (0), YES (1) – WR Discrete 06
Active I/O Mismatch MODMMA NO (0), YES (1) – WR Discrete 07
I/O communications error COMMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 08
Unacked comm. error COMMERRU NO (0), YES (1) – WR Discrete 09
Active comm. error COMMERRA NO (0), YES (1) – WR Discrete 10
RIM module error RIMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 11
Unacked Input Module Error RIMERRU NO (0), YES (1) – WR Discrete 12
Active Input Module Error RIMERRA NO (0), YES (1) – WR Discrete 13
I/O Module Mismatch MODMM FALSE (0), TRUE (1) ––R Discrete 14
Board number BOARD 1 through 8 ––R Long State 15
Slot number SLOT 1 through 32 ––R Long State 16
Module id MODID FE0600 ––R Hex 17
Extended Error Code EXTERR 0 to 65535 – WR Count 18
Input Type INTYPE RTD (0), NON-RTD (1) C–R Short State 19
Mode MODE MANUAL (0), AUTO (1) CWR Discrete 20
RTD Material, Alpha RTDTYPE Platinum,0.003850 (24) CWR Long State 21
Platinum,0.003923 (25)
Platinum,0.003902 (26)
Platinum,0.003911 (27)
Nickel,0.006270 (28)
Signal Range - Top SIGHI positive 100% value in ohms CWR Floating Pt 22
Signal Range - Bottom SIGLO positive 0% value in ohms CWR Floating Pt 23
Nominal Resistance NOMRES positive value in ohms CWR Floating Pt 24
Leadwire Resistance LWRES value (not less than –4.0) in CWR Floating Pt 25
ohms
Initial Result Value (Result) R positive value in ohms CWR Floating Pt 26
Result Quality RQ GOOD (0), BAD (1) – WR Discrete 27
Field Result FR value ––R Floating Pt 28
Field Result Quality FRQ GOOD (0), BAD (1) ––R Discrete 29

5-35
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

5.4.5 Wide Resistance Input Module Block Description (WRIM)


This block is used to input a count value from a resistance input module. It also performs
filtering for the connected resistance input block. A functional block diagram of a wide
resistance input module block is shown in Figure 5-22. The menus used to configure the
block are shown in Figures 5-23 and 5-24. The mnemonics, valid values, and data types for
all fields that may be selected for display and/or be used in making softwiring connections are
listed in Table 5-9.

RTD

Input Type
NON-RTD
Signal Range
Top
Apply Only to
Non-RTD Input Types
Signal Range
GOOD Bottom

EXTERR
BAD
RTD Type
Apply Only to
RTD Input Types
Nominal
Resistance

Extended Error Manual


Input Module Lock
Resistance Input Result
GOOD Auto
FR
Unlock

BAD

Manual
GOOD
Result
Status Register Quality
Lock Auto
Quality Check Unlock
FRQ
Communications
Error Condition
I/O Lock Mode
(from IF Block)
Board Number

I/O Selection Slot Number

Module ID MODMM

MODMMA
I/O WRIM Module
Communica- Error COMMERRA
tions Error
Error Checks WRIMERRA

MODMMU
COMMERRU
Diagnostic I/O Mismatch
Group WRIMERRU

Figure 5-22. Wide Resistance Input Module Block, Functional Block Diagram

5-36
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

Figure 5-23. Wide Resistance Input Module (WRIM), General Menu

Figure 5-24. Wide Resistance Input Module (WRIM), Diagnostic Menu

5-37
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

Table 5-9. Wide Resistance Input Module Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
Block State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1 to 7 CWR Long State 04
I/O mismatch MODMMS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO (0), YES (1) – WR Discrete 06
Active I/O Mismatch MODMMA NO (0), YES (1) – WR Discrete 07
I/O communications error COMMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 08
Unacked comm. error COMMERRU NO (0), YES (1) – WR Discrete 09
Active comm. error COMMERRA NO (0), YES (1) – WR Discrete 10
WRIM module error WRIMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 11
Unacked Input Module Error WRIMERRU NO (0), YES (1) – WR Discrete 12
Active Input Module Error WRIMERRA NO (0), YES (1) – WR Discrete 13
I/O Module Mismatch MODMM FALSE (0), TRUE (1) ––R Discrete 14
Board number BOARD 1 through 8 ––R Long State 15
Slot number SLOT 1 through 32 ––R Long State 16
Module id MODID FE0500 ––R Hex 17
Extended Error Code EXTERR 0 to 65535 – WR Count 18
Input Type INTYPE RTD (0), NON-RTD (1) C–R Short State 19
Mode MODE MANUAL (0), AUTO (1) CWR Discrete 20
RTD Material, Alpha RTDTYPE Platinum,0.003850 (24) CWR Long State 21
Platinum,0.003923 (25)
Platinum,0.003902 (26)
Platinum,0.003911 (27)
Nickel,0.006270 (28)
Signal Range - Top SIGHI positive 100% value in ohms CWR Floating Pt 22
Signal Range - Bottom SIGLO positive 0% value in ohms CWR Floating Pt 23
Nominal Resistance NOMRES positive value in ohms CWR Floating Pt 24
Initial Result Value (Result) R positive value in ohms CWR Floating Pt 25
Result Quality RQ GOOD (0), BAD (1) – WR Discrete 26
Field Result FR value ––R Floating Pt 27
Field Result Quality FRQ GOOD (0), BAD (1) ––R Discrete 28

5-38
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

5.4.6 Analog Input Module Block Parameters


The following further defines the configuration parameters and attributes for the VCIM, TIM,
RIM, and WRIM blocks.

Block Type
The valid block types are:
VCIM Voltage/Current Input Module Block
TIM Thermocouple Input Module Block
RIM Resistance Input Module Block
WRIM Wide Resistance Input Module Block

Occurrence
1 to 32 There may be up to 32 ‘instances’ allowed of the VCIM, TIM, and RIM
module block types.
1 to 16 There may be up to 16 ‘instances’ allowed of the WRIM module block
type.

02 Block State (STATE) ..........................................................................................................– – R


Not configurable in this block (always equal to RUN). See Section 2.4.1, State Changes for
additional information. This block is always executed in the RUN state (Normal Operation).

03 Bad Inputs Accepted (BADINP) ........................................................................................– – R


This attribute is present but not used with this block. These blocks run without a check on
input quality. See Section 2.3.2, Data Quality for additional information.

04 Diagnostic Group (SUPPGRP) .........................................................................................CWR


The diagnostic errors reported by this block can be grouped for System Event block control of
their reporting.
NONE No group assigned.
1 to 7 Defines the diagnostic group number for the diagnostic suppression group
controlled by the System Event block.

05 I/O mismatch (MODMMS)..................................................................................................CWR


The I/O mismatch diagnostic compares each slot configured for an analog input module
against the content of the slot during a power-up or database download. If the slot is empty or
the installed module does not match the configuration, this diagnostic is generated.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear. Even though the I/O mismatch diagnostic is suppressed, the
actual I/O mismatch condition is still determined (see Attribute 14,
MODMM).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as I/O
MISMATCH.

5-39
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

06 Unacked I/O Mismatch (MODMMU) .................................................................................– WR


If the I/O mismatch diagnostic error is enabled, the unacknowledged I/O mismatch diagnostic
status indicates if the diagnostic is or is not acknowledged. The status can be acknowledged
or read as follows.
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

07 Active I/O Mismatch (MODMMA)......................................................................................– WR


The active I/O mismatch diagnostic status indicates if the error is active even after
acknowledgement. The status can be read as follows.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

08 I/O communications error (COMMERRS) ....................................................................... CWR


The I/O communications error diagnostic checks the status of communications between the
input module and this block and looks for checksum errors. This diagnostic is also generated
when the select circuit, which is used to communicate with the module, has a diagnostic error.
In this case, all modules would report a communications error diagnostic. Error counters are
stored in the interface block as one of four different error types. The diagnostic can be
suppressed or enabled as follows.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.

09 Unacked communications error (COMMERRU) .............................................................– WR


If the communications error diagnostic is enabled, the unacknowledged diagnostic status
indicates if the diagnostic is or is not acknowledged. The status can be acknowledged or read
as follows.
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

10 Active communications error (COMMERRA) .................................................................– WR


The active communications error diagnostic status indicates if the error is active even after
acknowledgement. The status can be read as follows.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

VCIM 11 VCIM module error (VCIMERRS)...................................................................................... CWR


TIM 11 TIM module error (TIMERRS) ........................................................................................... CWR
RIM 11 RIM module error (RIMERRS) .......................................................................................... CWR
WRIM 11 WRIM module error (WRIMERRS).................................................................................... CWR
The module error diagnostic is a status indication for the extended error (EXTERR attribute
18) code. The diagnostic can be suppressed or enabled as follows.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.

5-40
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

VCIM 12 Unacked Input Module Error (VCIMERRU)..................................................................... – WR


TIM 12 Unacked Input Module Error (TIMERRU) ....................................................................... – WR
RIM 12 Unacked Input Module Error (RIMERRU) ....................................................................... – WR
WRIM 12 Unacked Input Module Error (WRIMERRU).................................................................... – WR
If the module error diagnostic is enabled, this unacknowledged status indicates if the
diagnostic is or is not acknowledged. The status can be acknowledged or read as follows.
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

VCIM 13 Active Input Module Error (VCIMERRA) ......................................................................... – WR


TIM 13 Active Input Module Error (TIMERRA) ............................................................................ – WR
RIM 13 Active Input Module Error (RIMERRA)............................................................................ – WR
WRIM 13 Active Input Module Error (WRIMERRA) ........................................................................ – WR
If the module error diagnostic is enabled, the active status indicates if the error is active even
after acknowledgement. The status can be read as follows.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

14 I/O Module Mismatch (MODMM).......................................................................................– – R


Even though the I/O mismatch diagnostic may be suppressed and its value not stored with the
active I/O mismatch attribute, the actual I/O mismatch condition is still determined. This
unsuppressed I/O mismatch is used to determine if an I/O mismatch exists when changing the
I/O mismatch diagnostic from suppressed to enabled.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

15 Board number (BOARD)....................................................................................................– – R


This is the board number that the physical module is configured for. Currently, the only valid
value is 1.

16 Slot number (SLOT)...........................................................................................................– – R


This is the slot number that the physical module is configured for. Valid values are 1 to 32 for
the VCIM, TIM, and RIM and 1 to 16 for the WRIM.

17 Module id (MODID) ............................................................................................................– – R


The module id is read as part of the initialization process. This value is compared with the
configured block type to determine if there is a module mismatch.

5-41
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

18 Extended Error Code (EXTERR) ......................................................................................– WR


The extended error code is a bitmapped two byte (16 bit) error code from the module that is
presented as a count value. The count value must be converted to binary to decode the
following bit mapped error pattern:

Bit Extended Errors (Lower Byte) Bit Status Errors (Upper Byte)
0 UART Timeout 8 VRAM (0=Low, 1=High)
1 Checksum Error 9 Calibration Data (0=Low, 1=High)
2 REG__ Range Error 10 Line Frequency Status (0=60Hz, 1=50Hz)
3 EPROM Error 11 Calculation Status (0=No Calc., 1=Calc.)
4 Calibration Error 12 *Module Error Status (0=No Error, =Error)
5 UART Error 13 Done Status (0=Not Complete, 1=Comp.)
6 A/D Converter Error 14 Under Range (0=Not Under, 1=Under)
7 Reserved 15 Over Range (0= Not Over, 1=Over)

* Lower bits 0-7 define module error status when = 1.

VCIM 19 Mode (MODE)..................................................................................................................... CWR


TIM 19 Mode (MODE)..................................................................................................................... CWR
RIM 20 Mode (MODE)..................................................................................................................... CWR
WRIM 20 Mode (MODE)..................................................................................................................... CWR
The mode of the block is determined by configuring and/or writing this attribute. Switching
mode is a reportable event. The manual mode causes the result quality to be good. If a cold
junction input module were to go bad, switching to manual would prevent bad data quality
from appearing on all thermocouple inputs that use the correction.
MAN 0 The block input is the previous result or the last written result.
AUTO 1 The block input is processed using the input module data.

RIM 19 Input Type (INTYPE) .........................................................................................................C – R


WRIM 19 Input Type (INTYPE) .........................................................................................................C – R
For RIM and WRIM block types only. The input type parameter further identifies the
resistance input module block as applying to one of the following.
RTD 0 Standard RTD linearization used.
NON-RTD 1 Resistance input or RTD not supported by software linearization
(piecewise table required).

VCIM 20 Input Type (INTYPE) .........................................................................................................C – R


For VCIM block types only. The input type parameter further identifies the voltage/current
input module block as applying to one of the following.
VOLTS 0 Input module is a 2001A Voltage Input Module. The input
range is set to ±10V dc by this selection.
MILLIVOLTS 1 Input module is a 2001A Voltage Input Module. The input
range is set to ±100mV dc by this selection. If the input is
from a temperature transmitter, configure thermocouple to
identify type.
PASSIVE CURRENT 2 Input module is a 2002A Current Input Module.
ACTIVE CURRENT 3 Input module is a 2012A Current Input Module with 2-wire
transmitter power.

5-42
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

TIM 20 Thermocouple Type (TCTYPE).........................................................................................CWR


The linearization specified here is performed in the TTI or TI function blocks.

B 1 Input linearization is for a B type thermocouple.


E 2 Input linearization is for a E type thermocouple.
J 3 Input linearization is for a J type thermocouple.
K 4 Input linearization is for a K type thermocouple.
N 5 Input linearization is for a N type thermocouple.
R 6 Input linearization is for a R type thermocouple.
S 7 Input linearization is for a S type thermocouple.
T 8 Input linearization is for a T type thermocouple.

VCIM 28 Linearization Type (TYPE) ................................................................................................CWR


The linearization specified here is performed in the TTI or TI function blocks.

NONE 0 Set at none when millivolt input is not from a


temperature transmitter.
B 1 Input linearization is for a B type thermocouple.
E 2 Input linearization is for a E type thermocouple.
J 3 Input linearization is for a J type thermocouple.
K 4 Input linearization is for a K type thermocouple.
N 5 Input linearization is for a N type thermocouple.
R 6 Input linearization is for a R type thermocouple.
S 7 Input linearization is for a S type thermocouple.
T 8 Input linearization is for a T type thermocouple.
Platinum,0.003850 24 Input linearization is for a RTD
Platinum,0.003923 25 Input linearization is for a RTD
Platinum,0.003902 26 Input linearization is for a RTD
Platinum,0.003911 27 Input linearization is for a RTD
Nickel,0.006720 28 Input linearization is for a RTD

RIM 21 RTD Material, Alpha (RTDTYPE) ......................................................................................CWR


WRIM 21 RTD Material, Alpha (RTDTYPE) ......................................................................................CWR
The valid RTD material type and alpha numbers are listed below with state values and the
resistance-ratio minimum and maximum values and their corresponding temperature values.
Refer to standard RTD reference tables for resistance vs. temperature values. Alpha,
sometimes called the Temperature Coefficient of Resistance (TCR), is a value associated with
each RTD type. It is usually defined as the RTD's resistance change over the range 0°C to
100°C, divided by the resistance at 0°C, divided by 100°C.

Material, Alpha State Resistance- Resistance- °C Min °C Standard


(ohm/ohm/°C) Value Ratio Min Ratio Max Max
Platinum, 0.003850 24 0.184932 3.902622 –200 850 DIN 43760
Platinum, 0.003923 25 0.169831 3.178206 –200 600 SAMA RC21-4
Platinum, 0.003902 26 0.170709 3.326295 –200 650 Burns
Platinum, 0.003911 27 0.172604 4.036970 –200 879 Minco
Nickel, 0.006720 28 0.555000 3.169250 –80 260 Minco

5-43
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

TIM 21 Cold Junction Compensation (CJCLOC) ........................................................................ CWR


For TIM block types only. The cold junction compensation parameter is either a module
source (MODOUT) or local data. Connect the module (MODOUT) to be used as a cold
junction source or enter the floating point equivalent for the junction temperature in the
required degree units (C, F, K, or R). For example, if the junction temperature is 86°F, enter
86F. This attribute is only readable/writeable if it is a local value. If the destination TI block
has a local cold junction input configured, it is used. Otherwise, this value is used.
NONE No cold junction source or value is configured.
RIM.MODOUT Connection to be used as a cold junction temperature source.
WRIM.MODOUT Connection to be used as a cold junction temperature source.
valueC Floating point equivalent for the junction temperature in Celsius.
valueF Floating point equivalent for the junction temperature in Fahrenheit.
valueK Floating point equivalent for the junction temperature in Kelvin.
valueR Floating point equivalent for the junction temperature in Rankine.

VCIM 22 Signal Range - Top (SIGHI) .............................................................................................. CWR


RIM 22 Signal Range - Top (SIGHI) .............................................................................................. CWR
WRIM 22 Signal Range - Top (SIGHI) .............................................................................................. CWR
For VCIM block types and non-RTD inputs only. The signal range top represents the 100%
output value in units specified by input type. Also the signal range must be within the limits of
the module according to input type (VOLTS signal range must be within approximately ±13.1).
The signal range value is used to normalize the floating point count input after filtering and
action is applied. If the actual transmitter signal range is 1 to 5 volts, enter 5 for signal range
top and 1 for the bottom. The normalized input can then be linearized and engineering units
applied.

VCIM 23 Signal Range - Bottom (SIGLO) ....................................................................................... CWR


RIM 23 Signal Range - Bottom (SIGLO) ....................................................................................... CWR
WRIM 23 Signal Range - Bottom (SIGLO) ....................................................................................... CWR
For VCIM block types and non-RTD inputs only. The signal range bottom represents the 0%
output value in units specified by input type. Also the signal range must be within the limits of
the module according to input type (VOLTS signal range must be within approximately ±13.1).

RIM 24 Nominal Resistance (NOMRES)....................................................................................... CWR


WRIM 24 Nominal Resistance (NOMRES)....................................................................................... CWR
Nominal RTD resistance is the resistance produced by the RTD in ohms at zero degrees
Celsius. Value can be any non-negative floating point number. The range on a 2 wire RTD is
0 to 4000 ohms. The range on a 3 wire RTD is 0 to 400 ohms.

RIM 25 Leadwire Resistance (LWRES) ........................................................................................ CWR


Leadwire resistance in ohms. Value can be any floating point number not less than –4.0.
Values that cause the sum of the leadwire resistance and the field result to exceed 50,000
counts will cause an overrange error.

5-44
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

VCIM 24 Initial result (Result) (R).....................................................................................................CWR


TIM 22 Initial Result (Result) (R) ....................................................................................................CWR
RIM 26 Initial result (Result) (R).....................................................................................................CWR
WRIM 25 Initial result (Result) (R).....................................................................................................CWR
The initial result is entered in the units specified by the input type during configuration (ohms
for resistance input). This is the actual field result floating point value to the instrument when
an input block is in auto. This is a writeable floating point data value when the module block is
in manual or the I/O is locked.

Writeable data is entered as a floating point representation of a count value for VCIM and TIM
modules. The signal equivalents for the floating point values are:

Floating millivolts
Pt. ValueVolts (and TC) milliamps* milliamps**
32767.0 +13.1 +131 overrange overrange
27500.0 +11.0 +110 44.00 27.50
25000.0 +10.0 +100 40.00 25.00
12500.0 +5.0 +50 20.00 12.50
5000.0 +2.0 +20 8.00 5.00
2500.0 +1.0 +10 4.00 2.50
0.0 0.0 0 0.00 0.00
–2500.0 –1.0 –10 4.00 N/A
–5000.0 –2.0 –20 8.00 N/A
–12500.0 –5.0 –50 20.00 N/A
–25000.0–10.0 –100 40.00 N/A
–27500.0–11.0 –110 44.00 N/A
–32768.0–13.1 –131 overrange N/A

* Passive current input module.


**Active current input module source.

Writeable data is entered as a floating point representation of a count value for RIM and
WRIM modules. The signal equivalents for the floating point values are scaled between 0 and
50,000 using 0.08 ohms per count for RIM and 0.008 ohms per count for WRIM. Some
sample values are:

Floating Pt. Value RIM WRIM


50000.0 4000 400
25000.0 2000 200
6250.0 500 50
3125.0 250 25
0.0 0 0

VCIM 25 Result Quality (RQ)........................................................................................................... – WR


TIM 23 Result Quality (RQ)........................................................................................................... – WR
RIM 27 Result Quality (RQ)........................................................................................................... – WR
WRIM 26 Result Quality (RQ)........................................................................................................... – WR
This data quality field will go BAD if any of the blocks diagnostic errors becomes active while
the block is in auto.

5-45
Logic Functions - Book 1

ANALOG INPUT MODULE BLOCKS (VCIM, TIM, RIM, WRIM)

VCIM 26 Field Result (FR) ............................................................................................................... – – R


TIM 24 Field Result (FR) ............................................................................................................... – – R
RIM 28 Field Result (FR) ............................................................................................................... – – R
WRIM 27 Field Result (FR) ............................................................................................................... – – R
This is the actual field input value to the instrument. A resistance input module count of
±25,000 is converted to the field result of 0 to 50,000.

VCIM 27 Field Result Quality (FRQ) ............................................................................................... – – R


TIM 25 Field Result Quality (FRQ) ............................................................................................... – – R
RIM 29 Field Result Quality (FRQ) ............................................................................................... – – R
WRIM 28 Field Result Quality (FRQ) ............................................................................................... – – R
The field result data quality will go bad if any of the blocks diagnostic errors becomes active.

5.4.7 Typical Block Connections for Analog Input Module Block


Typical softwiring block structures used on softwiring diagrams are shown in Figure 5-25.

Slot 1 VCIM1
1
Field Result Softwiring connection to
2
R Voltage/Current Input Block (VCI).
Result
RQ Operator indication of
Result Quality data quality and block
MODE mode.
Mode

Operator write access to set


mode and manual data.

Slot 2 TIM1
1
Field Result
2
CJCIN

Result R Softwiring connection


RIM1
to another block.
MODOUT

Figure 5-25. Typical Block Connections for Analog Input Module Block

5.4.8 Analog Input Module Block Events


The event codes (and their suggested text messages) for the analog input module block types
are given below. See the referenced data base attributes (in brackets) for additional
information. See the system event block for a description of event transitions.

4 BLOCK MODE SET TO AUTO


5 BLOCK MODE SET TO MANUAL
6 I/O MISMATCH (5)
7 I/O COMMUNICATIONS ERROR (8)
8 VI MODULE ERROR (11) or
8 TI MODULE ERROR (11) or
8 RIM MODULE ERROR (11) or
8 WRIM MODULE ERROR (11)

5-46
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

5.5 ANALOG OUTPUT MODULE BLOCK (AOM)


The analog output module block serves as the data handling block for the current output
module. This block is used to output an analog value to, and receive a readback value from
the current output module. The current output module converts a digital count value to a 4-
20mA field signal and converts it back to counts for readback in 100 milliseconds. The
module’s output value is checked against the previous value and becomes a raw input value.
Analog outputs are processed through an on-board select circuit which passes the data
between the blocks and the modules using a three phased 150 millisecond scan cycle for the
board (all modules are read every 150 milliseconds). The analog output module block
determines output scaling, tracking and failure conditions.

Available to the user as block outputs are the result, scaled result, readback, and track status
and the data quality for each as well as the active and unacknowledged status of the block’s
diagnostic errors. A functional block diagram of a analog output block is shown in Figure 5-26
(part 1) and Figure 5-27 (part 2). The menus used to configure the Analog Output Module
block are shown in Figure 5-28 through 5-30.

PART 1
Bad
TRACK
Lock OR Track
Status
Not Run
Manual

I/O Lock Instrument State


Mode (from IF Block)
(from IF Block)

FP Value
GOOD
Input Unlock
LSP
Auto See PART 2
BAD Normal
Lock
Manual
GOOD Initialize

LSP Data Quality

Auto

Bad Inputs RQ
Manual
Accepted GOOD
(YES/NO) Quality Check
Auto

Bad
Initialize
AND
TRUE
(init flag) Sheet 1 of 2

Figure 5-26. Analog Output Module Block, Functional Block Diagram (Part 1)

5-47
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

PART 2

Input Input Output Output


Scaled Range Range Range Range
Result Bottom Top Bottom Top

Result
Normaliza- Action
tion (DIR/REV) Scaling
Out of
Tolerance
In Tolerance

Analog Output Module


Normal - Current Output
Scaled
Readback
Initialize
See PART 1
Out of
Initialize Tolerance
In Tolerance
Readback

PREVIOUS
Initialize HOLD
Restart Preset
Value
PRESET
PRESET

Failsafe
Output to use Preset
on Restart RBQ Value
EXTERR
Output to use
MODMM on Failsafe

MODMMA
Module Status
COMMERRA

AOMERRA Error Check Module ID


MODMMU
Board Number
COMMERRU
I/O Selection
Slot Number
AOMERRU

Diagnostic I/O AO Module AO Module


Group Mismatch Comm. Error Error

Sheet 2 of 2

Figure 5-27. Analog Output Module Block, Functional Block Diagram (Part 2)

5-48
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

Figure 5-28. Analog Output Module (AOM), General Menu

Figure 5-29. Analog Output Module (AOM), Restart/Failsafe Menu

5-49
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

Figure 5-30. Analog Output Module (AOM), Diagnostic Menu

5.5.1 Analog Output Module Block Capabilities


The Analog Output Module block is a data repository for the instrument. One module block
services one module. All values are buffered in one of five possible task state tables. Process
output routines use these tables to pass data between the analog output module blocks, which
are updated every 150 milliseconds for the board, and the process algorithm blocks which run
at the configured scan group interval.

For outputs, all valid data for a single instrument (all 32 analog output module locations) is
written, read, compared and stored in the blocks in a three phased scan cycle (see Figure 5-
12 in Section 5.4). The input connected to the module block is scaled and latched according
to the parameters found the analog output module block’s configuration. This data is then
sent to the output module on the next scan cycle.

Analog output blocks can generate diagnostic errors based upon the following possible
conditions:
• I/0 mismatch
• AO module communications error
• AO module error (used to determine when to get readback and extended error code)

The analog output module handles the digital to analog conversion of an input 2 byte count
value to a milliamp output signal. The signal range of the output module is 0 to 25 milliamps.
The output milliamp signal values for input count values are: 25 mA = 31250 (131.25% of
range), 20 mA = 25000 (100%), 4 mA = 5000 (0%), 0 mA = 0 (-25%). The floating point value
range for a 4 to 20 mA output is (25000 - 5000 = 20000), which provides between 14 and 15
bit resolution over this range or 8 µA/Cnt.

5-50
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

5.5.2 Analog Output Module Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 5-10. The following further
defines the analog output module block configuration parameters.

Table 5-10. Analog Output Module Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION ––R Long State 00
Block Length BLKLEN ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs BADINP Rejected (0), Accepted (1) CWR Discrete 03
Diagnostic Group SUPPGRP NONE, 1 to 7 CWR Long State 04
I/O Mismatch MODMMS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO (0), YES (1) – WR Discrete 06
Active I/O Mismatch MODMMA NO (0), YES (1) ––R Discrete 07
AO module comm. error COMMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 08
Unacked AO comm. Error COMMERRU NO (0), YES (1) – WR Discrete 09
Active AO comm. Error COMMERRA NO (0), YES (1) ––R Discrete 10
AO module Error AOMERRS ENABLE (0), SUPPRESS (1) CWR Discrete 11
Unacked AO module Error AOMERRU NO (0), YES (1) – WR Discrete 12
Active AO module Error AOMERRA NO (0), YES (1) ––R Discrete 13
I/O Mismatch MODMM FALSE (0), TRUE (1) ––R Discrete 14
Board Number BOARD 1 ––R Long State 15
Slot Number SLOT 1 to 32 ––R Long State 16
Module ID MODID FD0500 ––R Hex 17
Extended Error EXTERR 0 to 65535 – WR Count 18
Mode MODE MANUAL (0), AUTO (1) CWR Discrete 19
Action ACTION REVERSE (0), DIRECT (1) CWR Discrete 20
Input Range, Top INHI Floating Pt Value, E.U. CWR Floating Pt 21
Input Range, Bottom INLO Floating Pt Value, E.U. CWR Floating Pt 22
Output Range, Top OUTHI Floating Pt Value, Sig. Rng. CWR Floating Pt 23
Output Range, Bottom OUTLO Floating Pt Value, Sig. Rng. CWR Floating Pt 24
Output to use on restart RESTART PREVIOUS (0), PRESET (1) CWR Discrete 25
Output to use on failsafe FSACT HOLD (0), PRESET (1) CWR Discrete 26
Restart preset value PRESET Floating Pt Value, E.U. CWR Floating Pt 27
Failsafe preset value FSOUT Floating Pt Value, E.U. CWR Floating Pt 28
Track status TRKSTAT NO TRACK (0), TRACK (1) – WR Discrete 29
Track status data quality TRKQ GOOD (0), BAD (1) – WR Discrete 30
Scaled result RSC Floating Pt Value, E.U. – WR Floating Pt 31
Scaled readback RBSC Floating Pt Value, E.U. ––R Floating Pt 32
Local Input INPUT LSP or Floating Pt Value, E.U. CWR Floating Pt 33
Readback RB Floating Pt Value, Sig. Rng. ––R Floating Pt 34
Readback Quality RBQ GOOD (0), BAD (1) ––R Discrete 35
Initial result (Result) R Floating Pt Value, Sig. Rng. C–R Floating Pt 36
Result Quality RQ GOOD (0), BAD (1) – WR Discrete 37

5-51
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

Block Type
AOM This is the Analog Output Module Block type.

Occurrence
1 to 32 There may be up to 32 ‘instances’ allowed of the AOM block type.

02 State (STATE) .................................................................................................................... – – R


Not configurable in this block (always equal to RUN). See Section 2.4.1, State Changes for
additional information. This block, when configured, is always executed in the RUN state
(Normal Operation).

03 Bad Inputs (BADINP)......................................................................................................... CWR


See Section 2.3.2, Data Quality for additional information.
Accepted 1 Block runs its algorithm without a check on input quality and output
quality is set to good.
Rejected 0 Block checks data quality on its inputs and will only run its algorithm if
its input is good (no action will be taken on the value). The result will
be held at the previous value and the result quality will be set bad and
the track status is set to TRACK.

04 Diagnostic Group (SUPPGRP)......................................................................................... CWR


The diagnostic errors reported by this block can be grouped for System Event block control of
their reporting.
NONE No group assigned.
1 to 7 Defines the diagnostic group number for the diagnostic suppression group
controlled by the System Event block.

05 I/O Mismatch (MODMMS) ................................................................................................. CWR


The I/O mismatch diagnostic compares each slot configured for an analog output module
against the content of the slot during a power-up or data base download. If the slot is empty
or the installed module does not match the configuration, this diagnostic is generated.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear. Even though the I/O mismatch diagnostic is suppressed, the
actual I/O mismatch condition is still determined (see Attribute 14,
MODMM).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as I/O
MISMATCH.

06 Unacked I/O Mismatch (MODMMU) .................................................................................– WR


If the I/O mismatch diagnostic error is enabled, the unacknowledged I/O mismatch diagnostic
status indicates if the diagnostic is or is not acknowledged. The status can be acknowledged
or read as follows.
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

07 Active I/O Mismatch (MODMMA)...................................................................................... – – R


If the I/O mismatch diagnostic error is enabled, the active I/O mismatch diagnostic status
indicates if the error is active even after acknowledgement. The status can be read as follows.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

5-52
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

08 AO module communications error (COMMERRS) .........................................................CWR


The AO module communications error diagnostic checks the status of communications
between the module and this block and looks for checksum errors. This diagnostic is also
generated when the select circuit, which is used to communicate with the module, has a
diagnostic error. In this case, all modules would report a communications error diagnostic.
The diagnostic can be suppressed or enabled as follows.
SUPPRESS Diagnostic error is suppressed. Acknowledgement status remains clear.
ENABLE Diagnostic error is not suppressed and errors are reported to the System
Event block.

09 Unacked AO communications Error (COMMERRU)...................................................... – WR


If the AO module communications error diagnostic is enabled, this unacknowledged diagnostic
status indicates if the diagnostic is or is not acknowledged. The status can be acknowledged
or read as follows.
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

10 Active AO communications Error (COMMERRA) ...........................................................– – R


If the AO module communications error diagnostic is enabled, this active diagnostic status
indicates if the error is active even after acknowledgement. The status can be read as follows.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

11 AO module Error (AOMERRS) ..........................................................................................CWR


The module error diagnostic is a status indication for the extended error code. The diagnostic
can be suppressed or enabled as follows.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.

12 Unacked AO module Error (AOMERRU)......................................................................... – WR


If the unacked module error diagnostic error is enabled, this unacknowledged status indicates
if the diagnostic is or is not acknowledged. The status can be acknowledged or read as
follows.
YES 1 Diagnostic error is unacknowledged.
NO 0 Diagnostic error is acknowledged.

13 Active AO module Error (AOMERRA) ..............................................................................– – R


If the active module error diagnostic error is enabled, the active status indicates if the error is
active even after acknowledgement. The status can be read as follows.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

5-53
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

14 I/O Mismatch (MODMM) .................................................................................................... – – R


Even though the I/O mismatch diagnostic may be suppressed and its value not stored with the
active I/O mismatch attribute, the actual I/O mismatch condition can still be determined by this
attribute (value is unsuppressed). This attribute is used to determine if their is an I/O
mismatch when changing the I/O mismatch diagnostic from suppressed to enabled.
YES 1 Diagnostic error is active.
NO 0 Diagnostic error is not active.

15 Board Number (BOARD) ................................................................................................... – – R


This is the board number that the physical module is configured for. Currently, the only valid
value is 1.

16 Slot Number (SLOT) .......................................................................................................... – – R


This is the slot number that the physical module is configured for. Valid values are 1 to 32.

17 Module ID (MODID) ........................................................................................................... – – R


The module id is read as part of the initialization process. This value is compared with the
configured block type to determine if their is a module mismatch.

18 Extended Error (EXTERR) ................................................................................................– WR


The extended error code is a bitmapped two byte (16 bit) error code from the module that is
presented as a count value. The count value must be converted to binary to decode the
following bit mapped error pattern (1=error condition):

Bit Extended Errors (Lower Byte) Bit Status Errors (Upper Byte)
0 Failsafe Timeout Condition 8 Unused
1 Host Comm. Checksum Error 9 Output Mode (0=Standard, 1=Calibration)
2 Host Comm. Range Error 10 Readback Out of Range
3 EEPROM Comm. Error 11 Readback Invalid
4 EEPROM Calib. Data Error 12 Global Error
5 Host Comm. Invalid Cmd Error 13 Unused
6 Config. Checksum Error 14 Readback Value is Zero
7 Timeout Restart 15 Unused

19 Mode (MODE)..................................................................................................................... CWR


The mode of the block is determined by configuring and/or writing this attribute. Switching
mode is a reportable event.
MAN 0 The block output is the result value, which may be written by the user.
The readback value is updated with the module value.
AUTO 1 The block output is processed using the input data.

20 Action (ACTION) ................................................................................................................ CWR


The action applied to the normalized result before it is scaled and put into the result for this
block is determined by configuring and/or writing this attribute.
DIRECT 1 The analog output for the block is not reversed. The direct
calculation is: normalized result = normalized result.
REVERSE 0 The analog output for the block is reversed. The reverse calculation
is: normalized result = 1 – normalized result.

5-54
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

21 Input Range, Top (INHI) ....................................................................................................CWR


User scaled high floating point engineering units value for input normalization. The default is
100.0. The input range top must match the actual input engineering units high value. The
normalization calculation is: (RSC – INLO) / (INHI – INLO). The normalized result must
always be a value between 0 and 1.

22 Input Range, Bottom (INLO) .............................................................................................CWR


User scaled low floating point engineering units value for input normalization. The default is
0.0. The input range bottom must match the actual input engineering units low value.

23 Output Range, Top (OUTHI) .............................................................................................CWR


User scaled high floating point milliamp value for output scaling (corresponds to top of input
range. The default is 20.0. When the high is 20.0 and the low is 4.0, the output is scaled for
the normal operating range of the current output module. The scaling calculation is:
(normalized result with action * (OUTHI – OUTLO) + OUTLO). The scaled signal value is then
converted to an equivalent floating point count value. The floating point count equivalents for
signal values are:

Count Value milliamps


0.0 0.00
5000.0 4.00
25000.0 20.00
32767.0 26.21
32768.0 N/A
40535.0 N/A
60535.0 N/A
65535.0 N/A

24 Output Range, Bottom (OUTLO) ......................................................................................CWR


User scaled low floating point milliamp value for output scaling (corresponds to bottom of input
range. The default is 4.0. When the high is 20.0 and the low is 4.0, the output is scaled for
the normal operating range of the current output module.

25 Output to use on restart (RESTART) ...............................................................................CWR


If a cold or frozen start up is occurring, the result will be set depending upon the selection
made here. If this block looses communication with the select circuit, a failsafe condition
results.
PREVIOUS 0 The result existing in the data base prior to a failsafe output condition.
PRESET 1 A set value for failsafe output conditions (see preset output value).

5-55
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

26 Output to use on failsafe (FSACT)................................................................................... CWR


A failsafe condition results when this block looses communication with the select circuit. A
write to the failsafe action attribute causes the failsafe configuration to be downloaded to the
module.
HOLD 0 Failsafe output value is last result value.
PRESET 1 Failsafe output value is the failsafe preset value.

27 Restart preset value (PRESET) ........................................................................................ CWR


A floating point value, in engineering units, used as the restart output when preset is selected.
This value is sent to the module at successful configuration.

28 Failsafe preset value (FSOUT) ......................................................................................... CWR


A floating point value, in engineering units, used as the failsafe output when preset is selected.
A write to the failsafe output attribute causes the failsafe value (signal range units equivalent)
to be downloaded to the module.

29 Track status (TRKSTAT) ...................................................................................................– WR


Track status is set to track whenever the path from the input to the result is broken. This
occurs when the data quality is bad, or the I/O lock is locked, or when the mode is manual, or
the instrument state is not run.
NO TRACK 0 Data quality is good, I/O lock is unlocked, mode is auto and
instrument state is run.
TRACK 1 Data quality is bad, or I/O lock is locked, or mode is manual, or
instrument state is not run.

30 Track status data quality (TRKQ) ....................................................................................– WR


This data quality field is not changed by any internal logic and will always be GOOD unless
written otherwise.

31 Scaled result (RSC)...........................................................................................................– WR


This is the stored input value in engineering units. This value is normalized, action applied,
converted to a signal range and written to the result. Writes to the scaled result can only be
done while instrument state is not run, I/O lock is set or mode is manual.

32 Scaled readback (RBSC) .................................................................................................. – – R


This is the scaled result value when the module value is in tolerance or this is the engineering
units value for readback when the module value is out of tolerance.

5-56
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

33 Input (INPUT)......................................................................................................................CWR
The local engineering units value input can be written when the input source is local and the
block is in auto; otherwise, this value is the input source value and can not be written. When
the instrument state is not run, i/o lock is set or mode is manual, the scaled result (RSC) can
be written.
LSP The block input is a floating point logical source pointer.
value The block input is a local floating point value.

34 Readback (RB) ...................................................................................................................– – R


This is the value read as a result of a write to the analog output module when the output
module block is in auto, or it is the failsafe output value during a failsafe condition. When the
block is in manual, this is the last written result.

35 Readback Quality (RBQ) ...................................................................................................– – R


Readback quality is set BAD if an analog output module error occurs.

36 Initial result (Result) (R).................................................................................................... C – R


This is the actual output value in floating point counts (see output range top) from the
instrument that is written to the current output module when the block is in auto. The initial
result is established during download of the configuration.
37 Result Quality (RQ)........................................................................................................... – WR
The result quality is set BAD when the input status is bad and bad inputs are not accepted, or
if the restart or readback value cannot be read after a warm start. Any write to the result
causes the result quality to be set GOOD. The result quality is writable in manual, when the
I/O is locked, or the instrument state is not run.

5-57
Logic Functions - Book 1

ANALOG OUTPUT MODULE BLOCK (AOM)

5.5.3 Typical Block Connections for Analog Output Module Block


Typical softwiring block structures used on softwiring diagrams are shown in Figure 5-31.

Slot 8
AOM1
R 1
LN1 Result
HILIM INPUT 2
Result Input
MODE Operator indication of
Mode input value, output value
RSC and mode.
Scaled Result

Operator write access to set mode and scaled result.

Figure 5-31. Analog Output Module Block, Typical Connections

5.5.4 Analog Output Module Block Events


The event codes (and their suggested text messages) for the analog output module block are
given below. See the referenced data base attributes (in brackets) for additional information.
See the system event block for event transitions.

4 BLOCK MODE SET TO AUTO


5 BLOCK MODE SET TO MANUAL
6 I/O MISMATCH (5)
7 AO COMMUNICATIONS ERROR (8)
8 AO MODULE ERROR (11)

5-58
Logic Functions - Book 1

REMOTE INPUT/OUTPUT BLOCKS

6
REMOTE INPUT/OUTPUT MODULE DATA BASE PARAMETERS

6.1 REMOTE INPUT/OUTPUT LIBRARY BLOCKS


Remote Input/Output module blocks define a physical input or output connection point and are
not part of a loop scan group. The Remote I/O module blocks are available inside or outside
of loop compounds. One of these modules is required to get a remote field signal into the
instrument. Remote I/O modules are selected from the Remote Input/Output Library at the
instrument or loop level. The different types and their associated hardware modules are:

RIO Remote I/O Communication Module. Reference Section 6.2. This module
plugs into the multiloop processor board and serves as the interface between
MODCELL and a CS31 bus. The MODCELL database must have one RIO
block for each RIO module on the MODCELL board. The RIO module uses
CS31 bus address 0.

A connection is required from MODOUT of this block to MODIN of each


remote I/O block in the database that uses this block as the interface to a
CS31 bus. For each of the following, indicate that a particular channel is
used by marking the check box to the left of the channel number. Enter the
bus address of the remote CS31 module providing the inputs or outputs.

RDIM Remote Digital Input Module. Reference Section 6.3. This block represents
one or more digital input channels at an address (1-31) on a CS31 remote I/O
bus. Connect MODOUT of the RIO block to MODIN of this block. Modules
with remote digital inputs are:
ICSI 08 D1 (8 non-isolated 24Vdc input channels)
ICSI 08 E1 (8 isolated 24Vdc input channels)
ICSI 08 E3 (8 isolated 120Vac input channels)
ICSI 16 D1 (16 non-isolated 24Vdc input channels)
ICSI 16 E1 (16 isolated 24Vdc input channels)
ICSK 20 F1 (12 non-isolated 24VDC input channels)
ICSC 08 L1 (8 channels for 24VDC input)

RDOM Remote Digital Output Module. Reference Section 6.4. This block
represents one or more digital output channels at an address (1-31) on a
CS31 remote I/O bus. Connect MODOUT of the RIO block to MODIN of this
block. Modules with remote digital outputs are:
ICSO 08 R1 (8 relay output channels 2A)
ICSO 08 Y1 (8 transistor output channels 24Vdc 2A)
ICSK 20 F1 (8 isolated relay output channels)
ICSC 08 L1 (8 channels for 24VDC 500mA transistor output)

6-1
Logic Functions - Book 1

REMOTE INPUT/OUTPUT BLOCKS

6-2
Logic Functions - Book 1

REMOTE I/O INTERFACE MODULE BLOCK

6.2 REMOTE I/O INTERFACE MODULE BLOCK (RIO)


The RIO block is the data handling block for a Remote I/O Interface Module installed in the
instrument. The RIO module serves as the interface between the instrument and a CS-31
Remote I/O Network (CS-31 Bus). The instrument database must have one RIO block for
each installed interface module. A functional block diagram of a RIO block is shown in Figure
6-1. The menu used to configure the block is shown in Figure 6-2.

Remote I/O 1 GOOD


Modules
2 I/O Interface MODOUT
BAD Function
I/O Values

(RIO) I/O Mismatch


(SUPP/ENAB)
MODMMS

Remote I/O Bus Error MODMMU / A


(SUPP/ENAB)
BUSERRU / A
I/O Communication Error
(SUPP/ENAB) BUSERRS
Error Check
Database Checksum Error COMMERRU / A
(SUPP/ENAB) BUSERRCT
COMMERRS
(RIO) Module Error
(SUPP/ENAB) DBASERRU / A

DBASERRS
Diagnostic Group
(NONE, 1 - 7)
MODMM

EXTERR

Figure 6-1. Remote I/O Interface Module Block, Functional Block Diagram

6.2.1 Remote I/O Interface Module Block Operation


The interface block performs the functions required to transfer data representing field input or
output signals between the instrument and the remote modules connected to the CS-31 bus.
The bus input data is read and the output data is written as follows:
• Inputs
The RIO module reads all remote discrete values from its bus connected remote input
modules. The interface routine unpacks these input data values and stores them in the
appropriate remote input module block database. The data is updated during each 50ms
base scan cycle. The input quality status is determined by diagnostics that check the
success or failure of the read operation.
• Outputs
The RIO module receives all remote output values as written from its connected digital
output module blocks. It distributes these outputs to its bus connected remote output
modules. The data is updated during each 50ms base scan cycle.

6-3
Logic Functions - Book 1

REMOTE I/O INTERFACE MODULE BLOCK

The remote I/O interface module block generates a diagnostic error based upon the following:
• Unsuppressed I/O mismatch condition
• CS-31 bus communications error
• I/O communications error
• CS-31 database checksum error
• Remote module error.

Events are reported for each of these diagnostic errors.

Figure 6-2. Remote I/O Interface Module Block, General Menu

6-4
Logic Functions - Book 1

REMOTE I/O INTERFACE MODULE BLOCK

6.2.2 Remote I/O Interface Module Block Parameters


The mnemonics, valid values, and data types for all attributes that can be selected for display
and/or be used in making softwiring connections are listed in Table 6-1. A description of each
attribute is provided in the attribute list that follows the table.

Table 6-1. RIO Module Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES(1) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1, 2, 3, 4, 5, 6 or 7 CWR Long State 04
I/O Mismatch MODMMS ENABLE(0), SUPPRESS(1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO(0), YES(1) – WR Discrete 06
Active I/O Mismatch MODMMA NO(0), YES(1) – WR Discrete 07
I/O Communication Error BUSERRS ENABLE(0), SUPPRESS(1) CWR Discrete 08
Unacknowledged I/O BUSERRU NO(0), YES(1) – WR Discrete 09
Communication Error
Active I/O Communication Error BUSERRA NO(0), YES(1) – WR Discrete 10
Remote I/O Bus COMMERRS ENABLE(0), SUPPRESS(1) CWR Discrete 11
Communication Error
Unacknowledged Remote I/O COMMERRU NO(0), YES(1) – WR Discrete 12
Bus Communication Error
Active Remote I/O Bus COMMERRA NO(0), YES(1) – WR Discrete 13
Communication Error
Database Checksum Error DBASERRS ENABLE(0), SUPPRESS(1) CWR Discrete 14
Unacknowledged Database DBASERRU NO(0), YES(1) – WR Discrete 15
Checksum Error
Active Database Checksum DBASERRA NO(0), YES(1) – WR Discrete 16
Error
Module Error EXTERRS ENABLE(0), SUPPRESS(1) CWR Discrete 17
Unacknowledged Remote EXTERRU NO(0), YES(1) – WR Discrete 18
Module Error
Active Remote Module Error EXTERRA NO(0), YES(1) – WR Discrete 19
I/O Module Mismatch MODMM NO(0), YES(1) ––R Discrete 20
Slots SLOT 1, 2, ... 31 C–R Long State 21
Module Identification MODID FB0000 ––R Hex 22
Extended Error EXTERR 0 Not Supported – WR Long State 23
Bus Error Counter BUSERRCT – WR Count 30

6-5
Logic Functions - Book 1

REMOTE I/O INTERFACE MODULE BLOCK

00 Version (VERSION) ........................................................................................................... – – R


Version number of RIO block. Presently 1.

01 Block Length (BLKLEN) .................................................................................................... – – R


Number of database bytes used.

02 State (STATE) .................................................................................................................... – – R


Not configurable in this block (always equal to RUN). See Section 2.4.1, State Changes for
additional information. This block, when configured, is always executed in the RUN state
(Normal Operation).

03 Bad Inputs Accepted (BADINP) ....................................................................................... – – R


This block does not check on input quality. This attribute is set at YES (1) and is not
configurable.

04 Diagnostic Group (SUPPGRP)......................................................................................... CWR


The diagnostic errors reported by this block can be grouped for System Event block control of
their reporting.
NONE No group assigned.
1 to 7 Defines the diagnostic group number for the diagnostic suppression group
controlled by the System Event block.

05 I/O Mismatch (MODMMS) ................................................................................................. CWR


The I/O mismatch diagnostic compares each slot configured for a RIO module against the
content of the slot during a power-up or data base download. If the slot is empty or the
installed module does not match the configuration, this diagnostic is generated.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear. Even though the I/O mismatch diagnostic is suppressed, the
actual I/O mismatch condition is still determined (see Attribute 20,
MODMM).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as I/O
MISMATCH.

06 Unacknowledged I/O Mismatch (MODMMU)...................................................................– WR


If the I/O mismatch error diagnostic is enabled, the unacknowledged I/O mismatch diagnostic
status indicates if the diagnostic is or is not acknowledged. The status can be acknowledged
or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

07 Active I/O Mismatch (MODMMA)......................................................................................– WR


If the I/O mismatch error diagnostic is enabled, the active I/O mismatch diagnostic status
indicates if the error is active even after acknowledgement. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

6-6
Logic Functions - Book 1

REMOTE I/O INTERFACE MODULE BLOCK

08 I/O Communication Error (BUSERRS) .............................................................................CWR


This diagnostic indicates that an error occurred in communication between the RIO module
and the instrument. This diagnostic can be suppressed or enabled as follows:
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

09 Unacknowledged I/O Communication Error (BUSERRU) ............................................. – WR


If the I/O communications error diagnostic is enabled, the unacknowledged diagnostic status
indicates if the diagnostic is or is not acknowledged. The status can be acknowledged or read
as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

10 Active I/O Communication Error (BUSERRA) ................................................................ – WR


The active I/O communications error diagnostic status indicates if the error is active even after
acknowledgement. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

11 Remote I/O Bus Communication Error (COMMERRS)...................................................CWR


This diagnostic indicates errors in communication or loss of communication between the RIO
interface module and the CS-31 bus. This diagnostic can be suppressed or enabled as
follows:
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

12 Unacknowledged Remote I/O Bus Communication Error (COMMERRU)................... – WR


If the remote I/O bus communications error diagnostic is enabled, the unacknowledged status
indicates if the diagnostic is or is not acknowledged. The status can be acknowledged or read
as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

13 Active Remote I/O Bus Communication Error (COMMERRA) ...................................... – WR


If the remote I/O bus communications error diagnostic is enabled, the active status indicates if
the error is active even after acknowledgement. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

6-7
Logic Functions - Book 1

REMOTE I/O INTERFACE MODULE BLOCK

14 Database Checksum Error (DBASERRS) ........................................................................ CWR


This diagnostic indicates that the remote I/O database stored in the interface module has been
declared bad due to a checksum error. This diagnostic can be suppressed or enabled as
follows:
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

15 Unacknowledged Database Checksum Error (DBASERRU) .........................................– WR


If the database checksum error diagnostic is enabled, the unacknowledged diagnostic status
indicates if the diagnostic is or is not acknowledged. The status can be acknowledged or read
as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

16 Active Database Checksum Error (DBASERRA) ............................................................– WR


If the database checksum error diagnostic is enabled, the active status indicates if the error is
active even after acknowledgement. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

17 Module Error (EXTERRS) ................................................................................................. CWR


The module error diagnostic checks for RIO module errors. Errors are stored in the block
database as EXTERR (see attribute 23). This diagnostic can be suppressed or enabled as
follows.
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

18 Unacknowledged Remote Module Error (EXTERRU) ....................................................– WR


If this remote module error diagnostic is enabled, the unacknowledged status indicates if the
diagnostic is or is not acknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

19 Active Remote Module Error (EXTERRA) .......................................................................– WR


If this diagnostic error is enabled, the active status indicates if the error is active even after
acknowledgement. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

6-8
Logic Functions - Book 1

REMOTE I/O INTERFACE MODULE BLOCK

20 I/O Module Mismatch (MODMM).......................................................................................– – R


Even though the I/O mismatch diagnostic may be suppressed and its value not stored with the
active I/O mismatch attribute, the actual I/O mismatch condition can still be determined by this
attribute (value is unsuppressed). This attribute is used to determine if there is an I/O
mismatch when changing the I/O mismatch diagnostic from suppressed to enabled.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active

21 Slots (SLOT) ...................................................................................................................... C – R


The slot (module location) number of the Remote I/O Interface Module is read as the lower of
the two slot numbers (1=1-2). Two numbers are displayed for configuration purposes (1-2, 2-
3, 3-4... through 31-32) because the module is double wide (note that locations 14-15F and
18-19F indicate they are valid only for the flush mount form of the Modcell processor).

22 Module Identification (MODID) ........................................................................................– – R.


The RIO module identification number, in hex, as read from the module. Currently only
FB0000.

23 Extended Error (EXTERR) ............................................................................................... – WR


The error code as read from the RIO module. Presently not supported.

30 Bus Error Counter (BUSERRCT) ..................................................................................... – WR


Wrap-around counter which provides a free running count (0 to 65535) of the quantity of CS-
31 bus communication errors. (Errors in communication between the RIO module and the
instrument are counted in Interface Block Attributes 132 - MDNORSPS and 133-
MDCHKSMS.)

6-9
Logic Functions - Book 1

REMOTE I/O INTERFACE MODULE BLOCK

6.2.3 Typical Block Connections for Remote I/O Interface Module Block
Typical RIO block connections are shown in Figure 6-3. The application builder software
provides special connections to simplify the database configuration procedure required to
transfer data between the interface block and its associated remote I/O module blocks. A
single softwiring connection is made between the special MODOUT source on the RIO block
and a special MODIN destination on each remote input and output module block. All data is
transferred through this connection in a form that is acceptable to both the interface block and
the I/O module blocks.

RIO1
RDIM1
MODIN

RDOM1
MODIN
MODOUT
RDIM2
MODIN

RDOM2
MODIN

Extended Error CL10


INPUT1

Figure 6-3. Remote I/O Interface Module Block, Typical Connections

6.2.4 Remote I/O Interface Module Block Events


The remote I/O interface module block event codes and their suggested run time display
messages are given below. See the referenced data base attributes (in brackets) for
additional information. See Section 3.4.5 System Event Transitions for a description of
event transitions.

4 I/O MISMATCH (Attribute No. 05)


5 CS-31 BUS COMMUNICATION ERROR (Attribute No.11)
6 I/O COMMUNICATIONS ERROR (Attribute No.08)
7 CS-31 DATABASE CHECKSUM ERROR (Attribute No.14)
8 MODULE EXTENDED ERROR (Attribute No.17)

6-10
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

6.3 REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)


The remote digital input module block is used to input as many as 16 digital inputs from a
remote digital input module connected to a CS-31 remote I/O network. The RDIM block is
valid for use with the following remote modules:

Module No. Type Description


ICSI 08 D1 Input 8 Non-isolated 24VDC input channels
ICSI 08 E1 Input 8 Isolated 24VDC input channels
ICSI 08 E3 Input 8 Isolated 120VDC input channels
ICSI 08 E4 Input 8 Isolated 230VDC input channels
ICSI 16 D1 Input 16 Non-isolated 24VDC input channels
ICSI 16 E1 Input 16 Isolated 24VDC input channels
ICSK 20 F1 Input/Output 12 non-isolated 24VDC input channels and 8
isolated relay output channels
ICSC 08 L1 Input/Output 8 user-configurable channels for 24VDC input
or 24VDC 500mA transistor output

The RDIM block receives the inputs from the CS-31 bus via a Remote I/O Interface (RIO)
Module installed in the instrument. The instrument database must have one RDIM block for
each remote digital input module on the CS-31 bus. The RDIM can be connected using the
RIO block MODOUT to this blocks MODIN connection.

Block outputs are the data, data quality, and active and unacknowledged status of the block’s
diagnostic error. A functional block diagram of an RDIM block is shown in Figure 6-4. Two of
the menus used to configure the block are shown in Figure 6-5 and Figure 6-6.

6-11
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

6.3.1 Remote Digital Input Module Block Operation


The RDIM block is a data repository for the input data from a remote digital input module.
This data is received via a remote I/O interface module, and is updated during each 50ms
base scan cycle. One RDIM block services one remote digital input module, and as many
digital input function (DI) blocks as required can be connected using the MODOUT to MODIN
connection. All remote digital inputs are buffered in one of five possible task state tables.
Process input and output routines use these tables to pass data between the module blocks
which run at the 50ms base scan rate and the DI blocks which run at the scan group interval
configured for the task. Each DI function block connected to the RDIM block filters the data
from one input channel according to the configuration of the DI block parameters
Remote digital input module blocks generate a diagnostic error based upon an unsuppressed
I/O mismatch condition or remote module error. Events are reported for switching the block
mode to auto or manual, and for the diagnostic errors.
During a warm or cold start condition, a pre-run read of the value of each channel in use is
performed to initialize the field result, result, conditioning and I/O task buffer values. If no I/O
communications error is encountered these values are forward initialized and their qualities
marked GOOD, otherwise the previous values are held and their qualities marked BAD. If the
mode is MANUAL, the pre-run read value gets loaded into the field result, the result remains
at its previous value and its quality marked GOOD.

Channels 0-15.

RIO Module

Channel
INUSE

Manual
OFF Lock R0
GOOD Auto
FR0
ON Unlock

BAD PKDR
Repeat for
Digital Input
Channels 1-15 Manual
GOOD
Lock R0Q
Auto
BUSADDR Unlock
FR0Q
PKDRQ
(Remote) I/O Mismatch
(SUPP/ENAB) I/O Lock
(from IF Block) MODE
Quality &
(Remote) Module Error Error Check
(SUPP/ENAB)
MODMMU
Diagnostic Group
(NONE, 1 - 7) MODMMA

MODMM
PKDERRS
EXTERRA
EXTERR0
EXTERRU

Figure 6-4. Remote Digital Input Module Block, Functional Block Diagram

6-12
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

Figure 6-5. Remote Digital Input Module Block, General Menu

Figure 6-6. Remote Digital Input Module Block, Channel Configuration Menu

6-13
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

6.3.2 Remote Digital Input Module Block Parameters


The mnemonics, valid values, and data types for all attributes that can be selected for display
and/or be used in making softwiring connections are listed in Table 6-2. A description of each
attribute is provided in the attribute list that follows the table.

Table 6-2. RDIM Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN No. of database bytes used ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP YES (1) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1, 2, 3, 4, 5, 6 or 7 CWR Long State 04
I/O Mismatch MODMMS ENABLE(0), SUPPRESS(1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO(0), YES(1) – WR Discrete 06
Active I/O Mismatch MODMMA NO(0), YES(1) – WR Discrete 07
(Remote) Module Error EXTERRS ENABLE(0), SUPPRESS(1) CWR Discrete 08
Unacknowledged Remote EXTERRU NO(0), YES(1) – WR Discrete 09
Module Error
Active Remote Module Error EXTERRA NO(0), YES(1) – WR Discrete 10
I/O Module Mismatch MODMM NO(0), YES(1) ––R Discrete 11
Slot number SLOT 1 to 32 C–R Long State 12
Remote I/O Bus Address BUSADDR 1 to 31 C–R Long State 13
Channel INUSE 0 to 15 C–R Count 14
Extended Error: Channel 0 to EXTERR0 0 No Error – WR Long State 15
Channel 15 to Internal error in remote unit to
EXTERR15 Cut wire (open circuit) 30
Overload
Overload + open circuit
Short circuit
Short Circuit+open circuit
Overload + short circuit
Short circuit + overload + open
circuit
Remote unit not present
No remote I/O present
Mode: Channel 0 to MODE0 MANUAL(0), AUTO(1) CWR Discrete 31
Channel 15 to to
MODE15 46
Packed Result PKDR FALSE(0), TRUE(1) C WR Count 60
Packed Result Quality PKDRQ GOOD(0), BAD(1) – WR Count 61

6-14
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

Table 6-2. RDIM Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Field Result, Channel 0 FR0 FALSE(0), TRUE(1) ––R Discrete 62
Field Result Quality, Ch 0 FR0Q GOOD(0), BAD(1) ––R Discrete 63
Initial Result, Channel 0 R0 FALSE(0), TRUE(1) CWR Discrete 64
Result Quality,Ch 0 R0Q GOOD(0), BAD(1) – WR Discrete 65
Field Result, Channel 1 FR1 FALSE(0), TRUE(1) ––R Discrete 66
Field Result Quality, Ch 1 FR1Q GOOD(0), BAD(1) ––R Discrete 67
Initial Result, Channel 1 R1 FALSE(0), TRUE(1) CWR Discrete 68
Result Quality,Ch 1 R1Q GOOD(0), BAD(1) – WR Discrete 69
Field Result, Channel 2 FR2 FALSE(0), TRUE(1) ––R Discrete 70
Field Result Quality, Ch 2 FR2Q GOOD(0), BAD(1) ––R Discrete 71
Initial Result, Channel 2 R2 FALSE(0), TRUE(1) CWR Discrete 72
Result Quality,Ch 2 R2Q GOOD(0), BAD(1) – WR Discrete 73
Field Result, Channel 3 FR3 FALSE(0), TRUE(1) ––R Discrete 74
Field Result Quality, Ch 3 FR3Q GOOD(0), BAD(1) ––R Discrete 75
Initial Result, Channel 3 R3 FALSE(0), TRUE(1) CWR Discrete 76
Result Quality,Ch 3 R3Q GOOD(0), BAD(1) – WR Discrete 77
Field Result, Channel 4 FR4 FALSE(0), TRUE(1) ––R Discrete 78
Field Result Quality, Ch 4 FR4Q GOOD(0), BAD(1) ––R Discrete 79
Initial Result, Channel 4 R4 FALSE(0), TRUE(1) CWR Discrete 80
Result Quality,Ch 4 R4Q GOOD(0), BAD(1) – WR Discrete 81
Field Result, Channel 5 FR5 FALSE(0), TRUE(1) ––R Discrete 82
Field Result Quality, Ch 5 FR5Q GOOD(0), BAD(1) ––R Discrete 83
Initial Result, Channel 5 R5 FALSE(0), TRUE(1) CWR Discrete 84
Result Quality,Ch 5 R5Q GOOD(0), BAD(1) – WR Discrete 85
Field Result, Channel 6 FR6 FALSE(0), TRUE(1) ––R Discrete 86
Field Result Quality, Ch 6 FR6Q GOOD(0), BAD(1) ––R Discrete 87
Initial Result, Channel 6 R6 FALSE(0), TRUE(1) CWR Discrete 88
Result Quality,Ch 6 R6Q GOOD(0), BAD(1) – WR Discrete 89
Field Result, Channel 7 FR7 FALSE(0), TRUE(1) ––R Discrete 90
Field Result Quality, Ch 7 FR7Q GOOD(0), BAD(1) ––R Discrete 91
Initial Result, Channel 7 R7 FALSE(0), TRUE(1) CWR Discrete 92
Result Quality,Ch 7 R7Q GOOD(0), BAD(1) – WR Discrete 93
Field Result, Channel 8 FR8 FALSE(0), TRUE(1) ––R Discrete 94
Field Result Quality, Ch 8 FR8Q GOOD(0), BAD(1) ––R Discrete 95
Initial Result, Channel 8 R8 FALSE(0), TRUE(1) CWR Discrete 96
Result Quality,Ch 8 R8Q GOOD(0), BAD(1) – WR Discrete 97
Field Result, Channel 9 FR9 FALSE(0), TRUE(1) ––R Discrete 98
Field Result Quality, Ch 9 FR9Q GOOD(0), BAD(1) ––R Discrete 99
Initial Result, Channel 9 R9 FALSE(0), TRUE(1) CWR Discrete 100
Result Quality,Ch 9 R9Q GOOD(0), BAD(1) – WR Discrete 101

6-15
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

Table 6-2. RDIM Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Field Result, Channel 10 FR10 FALSE(0), TRUE(1) ––R Discrete 102
Field Result Quality, Ch 10 FR10Q GOOD(0), BAD(1) ––R Discrete 103
Initial Result, Channel 10 R10 FALSE(0), TRUE(1) CWR Discrete 104
Result Quality,Ch 10 R10Q GOOD(0), BAD(1) – WR Discrete 105
Field Result, Channel 11 FR11 FALSE(0), TRUE(1) ––R Discrete 106
Field Result Quality, Ch 11 FR11Q GOOD(0), BAD(1) ––R Discrete 107
Initial Result, Channel 11 R11 FALSE(0), TRUE(1) CWR Discrete 108
Result Quality,Ch 11 R11Q GOOD(0), BAD(1) – WR Discrete 109
Field Result, Channel 12 FR12 FALSE(0), TRUE(1) ––R Discrete 110
Field Result Quality, Ch 12 FR12Q GOOD(0), BAD(1) ––R Discrete 111
Initial Result, Channel 12 R12 FALSE(0), TRUE(1) CWR Discrete 112
Result Quality,Ch 12 R12Q GOOD(0), BAD(1) – WR Discrete 113
Field Result, Channel 13 FR13 FALSE(0), TRUE(1) ––R Discrete 114
Field Result Quality, Ch 13 FR13Q GOOD(0), BAD(1) ––R Discrete 115
Initial Result, Channel 13 R13 FALSE(0), TRUE(1) CWR Discrete 116
Result Quality,Ch 13 R13Q GOOD(0), BAD(1) – WR Discrete 117
Field Result, Channel 14 FR14 FALSE(0), TRUE(1) ––R Discrete 118
Field Result Quality, Ch 14 FR14Q GOOD(0), BAD(1) ––R Discrete 119
Initial Result, Channel 14 R14 FALSE(0), TRUE(1) CWR Discrete 120
Result Quality,Ch 14 R14Q GOOD(0), BAD(1) – WR Discrete 121
Field Result, Channel 15 FR15 FALSE(0), TRUE(1) ––R Discrete 122
Field Result Quality, Ch 15 FR15Q GOOD(0), BAD(1) ––R Discrete 123
Initial Result, Channel 15 R15 FALSE(0), TRUE(1) CWR Discrete 124
Result Quality,Ch 15 R15Q GOOD(0), BAD(1) – WR Discrete 125
Packed Extended Errors PKDERRS ––R Count 126

6-16
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

00 Version (VERSION) ––R


Version number of RDIM block. Presently 1.

01 Block Length (BLKLEN).....................................................................................................– – R


Number of database bytes used.

02 State (STATE).....................................................................................................................– – R
Not configurable in this block (always equal to RUN). See Section 2.4.1, State Changes for
additional information. This block, when configured, is always executed in the RUN state
(Normal Operation).

03 Bad Inputs Accepted (BADINP) ........................................................................................– – R


This block does not check on input quality. This attribute is set at YES (1) and is not
configurable.

04 Diagnostic Group (SUPPGRP) .........................................................................................CWR


The diagnostic errors reported by this block can be grouped for System Event block control of
their reporting.
NONE No group assigned.
1 to 7 Defines the diagnostic group number for the diagnostic suppression group
controlled by the System Event block.

05 I/O Mismatch (MODMMS) ..................................................................................................CWR


The I/O mismatch diagnostic compares each CS-31 bus address configured for a remote
digital I/O module against the content of the address during a power-up or data base
download. If the address is not used or the installed module does not match the configuration,
this diagnostic is generated.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear. Even though the I/O mismatch diagnostic is suppressed, the
actual I/O mismatch condition is still determined (see Attribute 11,
MODMM).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as I/O
MISMATCH

06 Unacknowledged I/O Mismatch (MODMMU) .................................................................. – WR


If the I/O mismatch diagnostic error is enabled, the unacknowledged I/O mismatch diagnostic
status indicates if the diagnostic is or is not acknowledged. The status can be acknowledged
or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

07 Active I/O Mismatch (MODMMA) ..................................................................................... – WR


If the I/O mismatch diagnostic error is enabled, the active I/O mismatch diagnostic status
indicates if the error is active even after acknowledgement. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

6-17
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

08 Module Error (EXTERRS) ......CWR


This remote module error diagnostic checks for remote I/O module errors. Reported error
codes are stored in the block database as extended errors (EXTERR, attributes 15-30). The
diagnostic can be suppressed or enabled as follows:
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

09 Unacknowledged Remote Module Error (EXTERRU) ....................................................– WR


If this extended diagnostic error is enabled, the unacknowledged status indicates if the
diagnostic is or is not acknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

10 Active Remote Module Error (EXTERRA) .......................................................................– WR


If this extended diagnostic error is enabled, the active status indicates if the error is active
even after acknowledgement. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

11 I/O Module Mismatch (MODMM) ...................................................................................... – – R


Even though the I/O mismatch diagnostic may be suppressed and its value not stored with the
active I/O mismatch attribute, the actual I/O mismatch condition can still be determined by this
attribute (value is unsuppressed). This attribute is used to determine if there is an I/O
mismatch when changing the I/O mismatch diagnostic from suppressed to enabled.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

12 Slot Number (SLOT) ..........................................................................................................C – R


The slot (module location) number of the Remote I/O Interface Module to which this Remote
Digital Input block is connected. This number is assigned using the I/O Graphic in the
application builder program. Because the I/O interface module occupies two slots, the higher
numbered slot is always used.

13 Remote I/O Bus Address (BUSADDR).............................................................................C – R


The CS-31 Remote I/O Network address of the remote I/O module that provides the digital
inputs. Valid addresses are 1 through 31

14 Channel (INUSE)................................................................................................................C – R
This attribute is read as 16 bits indicating which channels are in use and thus represent active
digital inputs from the remote digital input module. Channel 0 is the least significant bit, and
the status of each channel is identified as follows:
NOT IN USE 0 Value when leaving the in use box blank for specific channel.
IN USE 1 Value when marking the in use box for specific channel.

6-18
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

15 - 30 Extended Error, Channel 0 (EXTERR0) through Channel 15 (EXTERR15) – WR


The last error code as read from the remote module (whether active or not). See packed
extended errors PKDERRS attribute 126. Codes are as follows:
0 No Error
1 Internal error in remote unit
2 Cut wire (open circuit)
4 Overload + open circuit
6 Overload + open circuit
8 Short circuit
10 Short Circuit +open circuit
12 Overload + short circuit
14 Short circuit + overload + open circuit
15 Remote module not present
16 No remote I/O present

31 - 46 Mode, Channel 0 (MODE0) through Channel 15 (MODE15)..............................................CWR


The mode of the block is determined by configuring and/or writing this attribute. Switching
mode is a reportable block event.
MAN 0 The result can be user written and is not updated with the field result
value. The field result is updated with the input from the remote
module.
AUTO 1 The block input is processed using the field result data from the
remote input module.

60 Packed Results (PKDR).....................................................................................................CWR


The results of block evaluation expressed as packed bits. Each of the 16 channels is
represented by one bit but only the bits for channels in use are meaningful (see attribute 14).
The results are writeable when I/O is locked or the instrument state is not run, Results can
also be written when at least one channel is in manual; only the channels in manual are
changed in this case. The channel 0 result is the least significant bit and the results are
indicated as follows:
FALSE 0
TRUE 1

61 Packed Results Quality (PKDRQ).................................................................................... – WR


The quality bits corresponding to the packed results, attribute 60. Quality is writeable under
the same conditions as described for attribute 60. The channel 0 result quality is the least
significant bit and quality is indicated as follows:
GOOD 0
BAD 1

62, 66... 122 Field Result,Channel 0 (FR0) through Channel 15 (FR15)................................................– – R


This is the actual field input value to the remote module.

63, 67... 123 Field Result Quality Channel 0 (FR0Q) through Channel 15 (FR15Q).............................– – R
This data quality attribute is marked BAD (1) if any diagnostic error in the block becomes
active.

6-19
Logic Functions - Book 1

REMOTE DIGITAL INPUT MODULE BLOCK (RDIM)

64, 68...124 Initial Result Channel 0 (R0) through Channel 15 (R15) CWR
The initial result is the value used for each channel when the block is initially downloaded.
This value is overwritten when the block first executes. Subsequent values are the result of
block evaluation after action is applied. This value is writeable only when the block mode is
manual, when I/O is locked, or the instrument state is not run.

65, 69...125 Result Quality Channel 0 (R0Q) through Channel 15 (R15Q) ..........................................– WR
This data quality field will go BAD if any of the blocks diagnostic errors becomes active while
the block is in auto. When the block is in manual or the I/O is locked, this is the last value
written to the result quality. Any write to the result causes the result quality to be set GOOD.
The result quality is writeable in manual, when the I/O is locked, or the instrument state is not
run.

126 Packed Extended Errors (PKDERRS).............................................................................. – – R


Packed bits (channel 0 is LSB) indicating which channels have active extended errors. (The
last error reported since power-up is always preserved in EXTERR0-15, whether active or
not).

6.3.3 Typical Block Connections for Remote Digital Input Module Block
Typical RDIM block connections are shown in Figure 6-7. The application builder software
provides special connections to simplify the database configuration procedure required to
make data transfer connections between the remote digital input block and its associated
blocks. A single softwiring connection between the special MODOUT source and the special
MODIN destination provides for data transfer in a form that is acceptable to all of the
connected blocks.

RIO1 RDIM1 DI1


R
MODOUT MODIN Result
MODOUT0 MODIN

DI16
MODOUT15 MODIN
Mode Channel 0 MODE0
Operator indication of
Extended Error 0 attributes (through CL block).
Operator write access to set mode. EXTERR0

Figure 6-7. Remote Digital Input Block, Typical Connections

6.3.4 Remote Digital Input Module Block Events


The remote digital input module block event codes and their suggested run time display
messages are given below. See the referenced data base attributes (in brackets) for
additional information. See the Section 3.4.5 for event transitions.
4 CHANNEL 0 MODE SET TO AUTO
5 CHANNEL 0 MODE SET TO MANUAL


34 CHANNEL 15 MODE SET TO AUTO
35 CHANNEL 15 MODE SET TO MANUAL
36 I/O MISMATCH (Attribute 05)
37 MODULE EXTENDED ERROR (Attribute 08)

6-20
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

6.4 REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)


The remote digital output module blocks serve as the data handling blocks for the remote
digital output modules. Each block can output as many as 16 discrete values to a remote
digital output module. The RDOM block is valid for use with the following remote modules:

Module No. Type Description


ICSO O8 R1 Output 8 relay output channels 2A
ICSO O8 Y1 Output 8 transistor output channels 24VDC 2A

ICSK 20 F1 Input/Output 12 non-isolated 24VDC input channels and 8 isolated relay


output channels

ICSC 08 L1 Input/Output 8 user-configurable channels for 24VDC input or 24VDC


500mA transistor output

The RDOM block provides its outputs to the CS-31 bus via a Remote I/O Interface (RIO)
Module installed in the instrument. The instrument database must have one RDOM block for
each remote digital output module on the CS-31 bus. The RDOM can be connected using the
RIO block MODOUT to this blocks MODIN connection.

Block outputs are the data, data quality, and active and unacknowledged status of the block’s
diagnostic error. A functional block diagram of a RDOM block is shown in Figure 6-8. The
displays, which are used to configure this block, are shown in Figures 6-9, 6-10, and 6-11.

6.4.1 Remote Digital Output Module Block Operation


The RDOM blocks are data repositories for the instrument. All remote digital output values
are buffered in one of five possible task state tables. Process input and output routines use
these tables to pass data between the module blocks which run at the 50ms base scan rate
and the process algorithm blocks which run at the configured scan group interval. All valid
remote output values are written to the interface module during each 50ms base scan cycle.
The interface module then distributes the values to the bus connected remote digital output
modules.

Remote digital output module blocks generate a diagnostic error based upon an
unsuppressed I/O mismatch condition or remote module error. Events are reported for
switching the block mode to auto or manual, and for the diagnostic errors.

During a warm start condition, a pre-run read is performed to determine if the module is
performing a power restart. If power is restarted, the result is sent to the module, result quality
is marked bad and track status is set to track. If power is not restarted, the result is initialized
to the previous value, result quality is marked good, and track status is set to track.

During a cold or frozen start condition, the result is set depending on the configuration of the
Restart Output attribute (False, True, or Previous) where previous indicates the previous
database value.

6-21
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

Bad Track
OR TRKSTA0
Lock

Manual

I/O Lock
(from IF Block) MODE0
DIRECT REVERSE

FALSE
GOOD ACTION0
TRUE Input (I0) Unlock
LSP Auto
BAD
Lock Normal

Bad Inputs Manual


Accepted
(NO) Initialize
LSP Quality Quality Check

Auto
TRKQ0

BUSADDR R0Q Bad Initialize


AND
SLOT PKDRQ

(init flag)
(Remote) I/O Mismatch EXTERRU
(SUPP/ENAB)
Error Check
EXTERRA
(Remote) Module Error
(SUPP/ENAB) MODMMU

Diagnostic Group MODMMA


(NONE, 1 - 7)
MODMM

PREVIOUS Channel
INUSE EXTERR0

FALSE
PKDERRS
TRUE
OFF

R0
RIO Module
RESTART0 ON

FALSE
PKDR
PREVIOUS FSOUT0
Repeat for Digital Output Channels 1-15
TRUE
Channels 0-15.

Figure 6-8. Remote Digital Output Module Block, Functional Block Diagram

6-22
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

Figure 6-9. Remote Digital Output Module Block, General Menu

Figure 6-10. Remote Digital Output Module Block, Channel Configuration Menu

6-23
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

Figure 6-11. Remote Digital Output Module Block, Diagnostics Menu

6-24
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

6.4.2 Remote Digital Output Module Block Parameters


The mnemonics, valid values, and data types for all attributes that can be selected for display
and/or be used in making softwiring connections are listed in Table 6-3. A description of each
attribute is provided in the attribute list that follows the table.
Table 6-3. RDOM Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 ––R Long State 00
Block Length BLKLEN ––R Count 01
State STATE RUN (0) ––R Short State 02
Bad Inputs Accepted BADINP NO(0) ––R Discrete 03
Diagnostic Group SUPPGRP NONE, 1, 2, 3, 4, 5, 6 or 7 CWR Long State 04
I/O Mismatch MODMMS ENABLE(0), SUPPRESS(1) CWR Discrete 05
Unacked I/O Mismatch MODMMU NO(0), YES(1) – WR Discrete 06
Active I/O Mismatch MODMMA NO(0), YES(1) – WR Discrete 07
(Remote) Module Error EXTERRS ENABLE(0), SUPPRESS(1) CWR Discrete 08
Unacked Remote Module Error EXTERRU NO(0), YES(1) – WR Discrete 09
Active Remote Module Error EXTERRA NO(0), YES(1) – WR Discrete 10
I/O Module Mismatch MODMM NO(0), YES(1) ––R Discrete 11
Slot number SLOT 1 through 32 C–R Long State 12
Remote I/O Bus Address BUSADDR 1 to 31 C–R Long State 13
Channel INUSE 0 to 15 C–R Count 14
Bad Inputs: Channel 0 to BADINP0 REJECTED(0), ACCEPTED(1) CWR Discrete 15
Channel 15 to to
BADINP15 30
Extended Error: Channel 0 to EXTERR0 0 No Error – WR Long State 31
Channel 15 to Internal error in remote unit to
EXTERR15 Cut wire (open circuit) 46
Overload
Overload + open circuit
Short circuit
Short Circuit +open circuit
Overload + short circuit
Short circuit + overload + open
circuit
Remote unit not present
No remote I/O present
Mode: Channel 0 to MODE0 MANUAL(0), AUTO(1) CWR Discrete 47
Channel 15 to to
MODE15 62
Action: Channel 0 to ACTION0 REVERSE(0), DIRECT(1) CWR Discrete 63
Channel 15 to to
ACTION15 78
Restart Output RSOUT0 FALSE(0), TRUE(1) CWR Short State 79
to to
RSOUT15 94

6-25
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

Table 6-3. RDOM Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
CPU Failsafe Output FSOUT0 FALSE(0) CWR Short State 95
to TRUE(1) to
FSOUT15 PREVIOUS(3) 110
Track Status, Channel 0 TRKSTA0 NO TRACK(0), TRACK(1) – WR Discrete 111
Track Status Quality, Ch 0 TRKQ0 GOOD(0), BAD(1) – WR Discrete 112
Track Status, Channel 1 TRKSTA1 NO TRACK(0), TRACK(1) – WR Discrete 113
Track Status Quality, Ch 1 TRKQ1 GOOD(0), BAD(1) – WR Discrete 114
Track Status, Channel 2 TRKSTA2 NO TRACK(0), TRACK(1) – WR Discrete 115
Track Status Quality, Ch 2 TRKQ2 GOOD(0), BAD(1) – WR Discrete 116
Track Status, Channel 3 TRKSTA3 NO TRACK(0), TRACK(1) – WR Discrete 117
Track Status Quality, Ch 3 TRKQ3 GOOD(0), BAD(1) – WR Discrete 118
Track Status, Channel 4 TRKSTA4 NO TRACK(0), TRACK(1) – WR Discrete 119
Track Status Quality, Ch 4 TRKQ4 GOOD(0), BAD(1) – WR Discrete 120
Track Status, Channel 5 TRKSTA5 NO TRACK(0), TRACK(1) – WR Discrete 121
Track Status Quality, Ch 5 TRKQ5 GOOD(0), BAD(1) – WR Discrete 122
Track Status, Channel 6 TRKSTA6 NO TRACK(0), TRACK(1) – WR Discrete 123
Track Status Quality, Ch 5 TRKQ6 GOOD(0), BAD(1) – WR Discrete 124
Track Status, Channel 7 TRKSTA7 NO TRACK(0), TRACK(1) – WR Discrete 125
Track Status Quality, Ch 7 TRKQ7 GOOD(0), BAD(1) – WR Discrete 126
Track Status, Channel 8 TRKSTA8 NO TRACK(0), TRACK(1) – WR Discrete 127
Track Status Quality, Ch 8 TRKQ8 GOOD(0), BAD(1) – WR Discrete 128
Track Status, Channel 9 TRKSTA9 NO TRACK(0), TRACK(1) – WR Discrete 129
Track Status Quality, Ch 9 TRKQ9 GOOD(0), BAD(1) – WR Discrete 130
Track Status, Channel 10 TRKSTA10 NO TRACK(0), TRACK(1) – WR Discrete 131
Track Status Quality, Ch 10 TRKQ10 GOOD(0), BAD(1) – WR Discrete 132
Track Status, Channel 11 TRKSTA11 NO TRACK(0), TRACK(1) – WR Discrete 133
Track Status Quality, Ch 11 TRKQ11 GOOD(0), BAD(1) – WR Discrete 134
Track Status, Channel 12 TRKSTA12 NO TRACK(0), TRACK(1) – WR Discrete 135
Track Status Quality, Ch 12 TRKQ12 GOOD(0), BAD(1) – WR Discrete 136
Track Status, Channel 13 TRKSTA13 NO TRACK(0), TRACK(1) – WR Discrete 137
Track Status Quality, Ch 13 TRKQ13 GOOD(0), BAD(1) – WR Discrete 138
Track Status, Channel 14 TRKSTA14 NO TRACK(0), TRACK(1) – WR Discrete 139
Track Status Quality, Ch 14 TRKQ14 GOOD(0), BAD(1) – WR Discrete 140
Track Status, Channel 15 TRKSTA15 NO TRACK(0), TRACK(1) – WR Discrete 141
Track Status Quality, Ch 15 TRKQ15 GOOD(0), BAD(1) – WR Discrete 142
Input Value: Channel 0 to I0 LSP, FALSE(0), TRUE(1) CWR Discrete 170
Channel 15 to to
I15 185
Packed Results PKDR FALSE(0), TRUE(1) C WR Count 210
Packed Results Quality PKDRQ GOOD(0), BAD(1) – WR Count 211

6-26
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

Table 6-3. RDOM Block Attributes, Valid Values, Mnemonics, and Data Types (Cont’d)
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Initial Result, Channel 0 R0 FALSE(0), TRUE(1) CWR Discrete 212
Result Quality, Ch 0 R0Q GOOD(0), BAD(1) – WR Discrete 213
Initial Result, Channel 1 R1 FALSE(0), TRUE(1) CWR Discrete 214
Result Quality, Ch 1 R1Q GOOD(0), BAD(1) – WR Discrete 215
Initial Result, Channel 2 R2 FALSE(0), TRUE(1) CWR Discrete 216
Result Quality, Ch 2 R2Q GOOD(0), BAD(1) – WR Discrete 217
Initial Result, Channel 3 R3 FALSE(0), TRUE(1) CWR Discrete 218
Result Quality, Ch 3 R3Q Good(0), Bad(1) – WR Discrete 219
Initial Result, Channel 4 R4 FALSE(0), TRUE(1) CWR Discrete 220
Result Quality, Ch 4 R4Q GOOD(0), BAD(1) – WR Discrete 221
Initial Result, Channel 5 R5 FALSE(0), TRUE(1) CWR Discrete 222
Result Quality, Ch 5 R5Q GOOD(0), BAD(1) – WR Discrete 223
Initial Result, Channel 6 R6 FALSE(0), TRUE(1) CWR Discrete 224
Result Quality, Ch 6 R6Q GOOD(0), BAD(1) – WR Discrete 225
Initial Result, Channel 7 R7 FALSE(0), TRUE(1) CWR Discrete 226
Result Quality, Ch 7 R7Q GOOD(0), BAD(1) – WR Discrete 227
Initial Result, Channel 8 R8 FALSE(0), TRUE(1) CWR Discrete 228
Result Quality, Ch 8 R8Q GOOD(0), BAD(1) – WR Discrete 229
Initial Result, Channel 9 R9 FALSE(0), TRUE(1) CWR Discrete 230
Result Quality, Ch 9 R9Q GOOD(0), BAD(1) – WR Discrete 231
Initial Result, Channel 10 R10 FALSE(0), TRUE(1) CWR Discrete 232
Result Quality, Ch 10 R10Q GOOD(0), BAD(1) – WR Discrete 233
Initial Result, Channel 11 R11 FALSE(0), TRUE(1) CWR Discrete 234
Result Quality, Ch 11 R11Q GOOD(0), BAD(1) – WR Discrete 235
Initial Result, Channel 12 R12 FALSE(0), TRUE(1) CWR Discrete 236
Result Quality, Ch 12 R12Q GOOD(0), BAD(1) – WR Discrete 237
Initial Result, Channel 13 R13 FALSE(0), TRUE(1) CWR Discrete 238
Result Quality, Ch 13 R13Q GOOD(0), BAD(1) – WR Discrete 239
Initial Result, Channel 14 R14 FALSE(0), TRUE(1) CWR Discrete 240
Result Quality, Ch 14 R14Q GOOD(0), BAD(1) – WR Discrete 241
Initial Result, Channel 15 R15 FALSE(0), TRUE(1) CWR Discrete 242
Result Quality, Ch 15 R15Q GOOD(0), BAD(1) – WR Discrete 243
Packed Extended Errors PKDERRS ––R Count 244

00 Version (VERSION)............................................................................................................– – R
Version number of RDIM block. Presently 1.

01 Block Length (BLKLEN).....................................................................................................– – R


Number of database bytes used.

02 State (STATE).....................................................................................................................– – R
Not configurable in this block (always equal to RUN). See Section 2.4.1, State Changes for
additional information. This block, when configured, is always executed in the RUN state
(Normal Operation).

6-27
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

03 Bad Inputs Accepted (BADINP) ....................................................................................... – – R


This attribute is present but is not used in this block. See attributes 15 through 30.

04 Diagnostic Group (SUPPGRP)......................................................................................... CWR


The diagnostic errors reported by this block can be grouped for System Event block control of
their reporting.
NONE No group assigned.
1 to 7 Defines the diagnostic group number for the diagnostic suppression group
controlled by the System Event block.

05 I/O Mismatch (MODMMS) ................................................................................................. CWR


The I/O mismatch diagnostic compares each CS-31 bus address configured for a remote
digital I/O module against the content of the address during a power-up or data base
download. If the address is not used or the installed module does not match the configuration,
this diagnostic is generated.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear. Even though the I/O mismatch diagnostic is suppressed, the
actual I/O mismatch condition is still determined (see Attribute 11,
MODMM).
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block. The error message is reported as I/O
MISMATCH

06 Unacknowledged I/O Mismatch (MODMMU)...................................................................– WR


If the I/O mismatch diagnostic error is enabled, the unacknowledged I/O mismatch diagnostic
status indicates if the diagnostic is or is not acknowledged. The status can be acknowledged
or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

07 Active I/O Mismatch (MODMMA)......................................................................................– WR


If the I/O mismatch diagnostic error is enabled, the active I/O mismatch diagnostic status
indicates if the error is active even after acknowledgement. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

08 Module Error (EXTERRS) ................................................................................................. CWR


This remote module error diagnostic checks for remote I/O module errors. Reported error
codes are stored in the block database as extended errors (EXTERR, attributes 31-46). The
diagnostic can be suppressed or enabled as follows:
ENABLE 0 Diagnostic error is not suppressed and errors are reported to the
System Event block.
SUPPRESS 1 Diagnostic error is suppressed. Acknowledgement status remains
clear.

6-28
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

09 Unacknowledged Remote Module Error (EXTERRU).................................................... – WR


If this extended diagnostic error is enabled, the unacknowledged status indicates if the
diagnostic is or is not acknowledged. The status can be acknowledged or read as follows.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

10 Active Remote Module Error (EXTERRA)....................................................................... – WR


If this extended diagnostic error is enabled, the active status indicates if the error is active
even after acknowledgement. The status can be read as follows.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

11 I/O Module Mismatch (MODMM).......................................................................................– – R


Even though the I/O mismatch diagnostic may be suppressed and its value not stored with the
active I/O mismatch attribute, the actual I/O mismatch condition can still be determined by this
attribute (value is unsuppressed). This attribute is used to determine if there is an I/O
mismatch when changing the I/O mismatch diagnostic from suppressed to enabled.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

12 Slot Number (SLOT) ......................................................................................................... C – R


The slot (module location) number of the Remote I/O Interface Module to which this Remote
Digital Output block is connected. This number is assigned using the I/O Graphic in the
application builder program. Because the I/O interface module occupies two slots, the higher
numbered slot is always used.

13 Remote I/O Bus Address (BUSADDR) ............................................................................ C – R


The CS-31 Remote I/O Network address of the remote I/O module that provides the digital
outputs. Valid addresses are 1 through 31

14 Channel (INUSE) ............................................................................................................... C – R


This attribute is read as 16 bits indicating which channels are in use and thus represent active
digital outputs to the remote digital output module. Channel 0 is the least significant bit, and
the status of each channel is identified as follows:
NOT IN USE 0 Value when leaving the in use box blank for specific channel.
IN USE 1 Value when marking the in use box for specific channel.

15 - 30 Bad Inputs, Channel 0 (BADINP0) through Channel 15 (BADINP15) ...............................CWR


This block can run with a check on input quality. See Section 2.3.2, Data Quality for
additional information.
REJECTED 0 Input data quality is checked. If the quality is bad, the input is not
used, the previous result is sent to the output module, the result
quality is marked BAD, and track status is set to TRACK.
ACCEPTED 1 Input data quality is not checked.

6-29
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

31-46 Extended Error, Channel 0 (EXTERR0) through Channel 15 (EXTERR15) .....................– WR


The last error code as read from the remote module (whether active or not). See packed
extended errors PKDERRS attribute 244. Codes are as follows:
0 No Error
1 Internal error in remote unit
2 Cut wire (open circuit)
4 Overload + open circuit
6 Overload + open circuit
8 Short circuit
10 Short Circuit +open circuit
12 Overload + short circuit
14 Short circuit + overload + open circuit
15 Remote module not present
16 No remote I/O present

47 - 62 Mode, Channel 0 (MODE0) through Channel 15 (MODE15) ............................................. CWR


The mode of the block is determined by configuring and/or writing this attribute. Switching
mode is a reportable block event.
MAN 0 The block output is the result value, which can be written by the user.
AUTO 1 The block output is processed using the input data.

63 - 78 Action, Channel 0 (ACTION0) through Channel 15 (ACTION15)...................................... CWR


The action is applied to the result before being sent to the remote output module.
REVERSE 0 The result is inverted before being sent to the output module.
DIRECT 1 The result is sent to the output module without change.

79 - 94 Restart Output, Channel 0 (RSOUT0) through Channel 15 (RSOUT15).......................... CWR


If a cold or frozen start up is occurring, the result will be set depending upon the selection
made here.
FALSE 0
TRUE 1

95 - 110 CPU Failsafe Output,Channel 0 (FSOUT0) through Channel 15 (FSOUT15) .................. CWR
This is the output value used when communication between the instrument CPU and the
remote I/O interface module is lost. A write to the failsafe output value causes the value to be
downloaded to the module.
FALSE 0 Failsafe output value is low.
TRUE 1 Failsafe output value is high.
PREVIOUS 3 The last value output by the RIO module.

6-30
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

111, 113.. 141 Track Status,Channel 0 (TRKSTA0) through Channel 15 (TRKSTA15)........................... – WR


Track status is set to track whenever the path from the input to the result is broken. This
occurs when the data quality is bad, the I/O lock is locked, or when the mode is manual.
NO TRACK 0 Data quality is good, I/O lock is unlocked and mode is auto.
TRACK 1 Data quality is bad, I/O lock is locked or mode is manual.

112 ,114.. 142 Track Status Quality,Channel 0 (TRKQ0) through Channel 15 (TRKQ15)...................... – WR
This data quality field is not changed by any internal logic and is always be GOOD unless
written otherwise.

170 - 185 Input Value, Channel 0 (I0) through Channel 15 (I15) CWR
This is the input to each block channel used to determine the output of the channel. The input
type can be configured as either local or remote.
Input Type - Local
Value is local discrete data. This value can be written when the block is in auto.
FALSE 0
TRUE 1
Input Type - Remote
Value is obtained from a connection to any discrete logical source pointer.

210 Packed Results (PKDR).....................................................................................................CWR


The results of block evaluation expressed as packed bits. Each of the 16 channels is
represented by one bit but only the bits for channels in use are meaningful (see attribute 14).
The results are writeable when I/O is locked or the instrument state is not run, Results can
also be written when at least one channel is in manual; only the channels in manual are
changed in this case. The channel 0 result is the least significant bit and the results are
indicated as follows:
FALSE 0
TRUE 1

211 Packed Results Quality (PKDRQ) ...................................................................................... – WR


The quality bits corresponding to the packed results, attribute 210. Quality is writeable under
the same conditions as described for attribute 210. The channel 0 result quality is the least
significant bit and quality is indicated as follows:
GOOD 0
BAD 1

212, 214...242 Initial Result,Channel 0 (R0) through Channel 15 (R15) ...................................................CWR


The initial result is the value used for each channel when the block is initially downloaded.
This value is overwritten when the block first executes. Subsequent values are the result of
block evaluation after action is applied. This value is writeable only when the block mode is
manual, when I/O is locked, or the instrument state is not run.
FALSE 0 Result sent to output module (after action is applied) is open.
TRUE 1 Result sent to output module (after action is applied) is closed.

6-31
Logic Functions - Book 1

REMOTE DIGITAL OUTPUT MODULE BLOCK (RDOM)

213,215...243 Result Quality,Channel 0 (R0Q) through Channel 15 (R15Q) ..........................................– WR


The result quality is set BAD when the input status is bad and bad inputs are not accepted, or
if the restart value cannot be read after a warm start. Any write to the result causes the result
quality to be set GOOD. The result quality is writeable in manual, when the I/O is locked, or
the instrument state is not run.

244 Packed Extended Errors (PKDERRS).............................................................................. – – R


Packed bits (channel 0 is LSB) indicating which channels have active extended errors. (The
last error reported since power-up is always preserved in EXTERR0-15, whether active or
not).

6.4.3 Typical Block Connections for Remote Digital Output Module Blocks
Typical RDOM block connections are shown in Figure 6-12. The application builder software
provides special connections to simplify the database configuration procedure required to
make data transfer connections between the remote digital output block and its associated
blocks. A single softwiring connection between the special MODOUT source and the special
MODIN destination provides for data transfer in a form that is acceptable to all of the
connected blocks.

RDOM1 RIO1

TM1 MODIN MODOUT


HILIM
High Limit Input Value Channel 0 (I0)
LOLIM
Low Limit Input Value Channel 1 (I1)

PID1
TS
Track Status Input Value Channel 15 (I15)
MODE0
Mode Channel 0 Operator indication of
EXTERR0 attributes (through CL
Extended Error 0 block).
Operator write access to set mode.

Figure 6-12. Remote Digital Output Module Block, Typical Connections

6.4.4 Remote Digital Output Module Block Events


The remote digital output module block event codes and their suggested run time display
messages are given below. See the referenced data base attributes (in brackets) for
additional information. See Section 3.4.5 for event transitions.

4 CHANNEL 0 MODE SET TO AUTO


5 CHANNEL 0 MODE SET TO MANUAL



34 CHANNEL 15 MODE SET TO AUTO
35 CHANNEL 15 MODE SET TO MANUAL
36 I/O MISMATCH (Attribute 05)
37 MODULE EXTENDED ERROR (Attribute 08)

6-32
Logic Functions - Book 1

INPUT FUNCTIONS BLOCKS

7
INPUT FUNCTIONS DATABASE PARAMETERS

7.1 INPUT FUNCTIONS LIBRARY BLOCKS


Function blocks (algorithm blocks that execute the logic) cannot operate independently in the
instrument database. Groups of related function blocks must be organized into loops. Input
function blocks are selected from the Input Functions library and placed in a loop compound.
The input function block types are:

DI Digital Input Block. Reference IB-23G600 Section 7.3. This block links a
Digital Input Module (DIM) block to a loop.

VCI Voltage/Current Input Block. Reference IB-23G600 Section 7.2. This block
links a Voltage/Current Module (VCIM) block to a loop.

TI Thermocouple Input Block. Reference IB-23G600 Section 7.2. This block


links a Thermocouple Module (TIM) block to a loop. It also gets a
compensation input from a RIM, WRIM, or CJIM module.

TTI Thermocouple Transmitter Input Block. Reference IB-23G600 Section 7.2.


This block links a Voltage/Current Module (VCIM) block to a loop.

RI Resistance Input Block. Reference IB-23G600 Section 7.2. This block links a
Resistance Input Module (RIM) or a Wide Resistance Input Module (WRIM)
block to a loop.

RTI RTD Input Block. Reference IB-23G600 Section 7.2. This block links a RTD
input from a Resistance Input Module (RIM) or a Wide Resistance Input
Module (WRIM) block to a loop.

RTTI RTD Transmitter Input Block. Reference IB-23G600 Section 7.2. This block
links a Voltage/Current Module (VCIM) block to a loop.

7-1
Logic Functions - Book 1

INPUT FUNCTIONS BLOCKS

7-2
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

7.2 ANALOG INPUT BLOCKS (VCI, TTI, TI, RI, RTI RTTI)
The analog input blocks (VCI, TTI, TI, RI, RTI and RTTI) provide an input link from a physical
analog input module (VCIM, TIM, RIM, WRIM, RAIM) to a loop. The relationship between
these blocks is discussed in Sections 5 and 6. Functions performed by these blocks include
input filtering, action, normalization, linearization, and scaling. The types of analog input block
are:
• VCI Voltage Input Block
• TTI Temperature Transmitter Input Block
• TI Thermocouple Input Block
• RI Resistance Input Block
• RTI RTD Input Block
• RTTI RTD Transmitter Input Block

An input block is a loop function block that provides a logical input link to an input module (one
physical input point). As many input blocks as required can be connected to a module block
source. The input value is buffered in the task state table for the loop. Process input and
output routines use these tables to pass data between the module blocks and the process
algorithm blocks which run at the scan group interval configured for the task. The local
modules described in Section 5.4, Analog Input Module Blocks VCIM, TIM, RIM, WRIM are
updated every 150 milliseconds.

An input block uses the Input Module pointer specified during configuration to set the
connection between the block and the module. This connection is fixed by configuration and
can not be changed through the database.

This section describes the analog input block types and the relationship of their configuration
parameters to the block’s function. All parameters for these blocks are described in one listing
since many of the parameters are the same.

7-3
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

7.2.1 Voltage/Current Input Block Description (VCI)


This block is used to input a volt/current module’s value and translate it to a user specified
scaled value. It receives its input from a VCIM or RAIM block. A functional block diagram of a
voltage/current input block is shown in Figure 7-1. The menus used to configure the block are
shown in Figures 7-2 and 7-3. The mnemonics, valid values, and data types for all fields that
may be selected for display and/or be used in making softwiring connections are listed in
Table 7-1. Section 7.2.8 further defines the input block configuration parameters.

Signal Range - Top


Input Module No. Signal Range - Bottom SQUARE ROOT
Module Type SQUARE
MOD SQ
LINEAR
MOD SQRT

Input Module
Floating Point Count Action Linearization Type
Filter Normalization
(DIR/REV)

Filter Time
(minutes) Output Range
Top
Output Scaling
NONE
Output Range
Bottom
AUTO Filter Type

USER

Range Check

Diagnostic Calculation
Group Error Quality Limit Quality Limit
(NONE, 1-7) (ENAB/SUPP) - Top - Bottom

State BAD GOOD


(RUN, HOLD,
OFF, DEBUG)

CERRA
Quality and
Bad Inputs Error Check CERRAQ
Result
Accepted CERRU
(YES/NO)
CERRUQ
Set Quality
Bad on
Input Module Result Quality Calculation
Error (Y/N)

Result Quality

Figure 7-1. Voltage/Current Input Block (VCI), Functional Block Diagram

7-4
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Figure 7-2. Voltage/Current Input Block (VCI), General Menu

Figure 7-3. Voltage/Current Input Block (VCI), Diagnostics Menu

7-5
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Table 7-1. Voltage/Current Input Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 – – R Long State 00
Block Length BLKLEN – – R Count 01
State STATE RUN(0), HOLD(1), OFF(2), CWR Short State 02
DEBUG(3)
Bad Inputs Accepted BADINP NO (0), YES (1) CWR Discrete 03
Diagnostic Group Supp. SUPPGRP NONE, 1, 2, 3, 4, 5, 6, 7 CWR Long State 04
Calculation Error CERRS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Calc. Error Unacked CERRU NO (0), YES (1) – WR Discrete 06
Calc. Error Unacked Quality CERRUQ NO (0), YES (1) – WR Discrete 07
Calc. Error Active CERRA NO (0), YES (1) – WR Discrete 08
Calc. Error Active Quality CERRAQ NO (0), YES (1) – WR Discrete 09
Set quality bad on calc err? SETQBAD NO (0), YES (1) CWR Discrete 10
Action ACTION REVERSE (0), DIRECT (1) CWR Discrete 11
Linearization Type LINTYPE LINEAR(17), SQR(20), CWR Long State 12
SQRT(21), MOD_SQR(22),
MODSQRT(23)
Filter Type FILTYPE NONE(0), AUTO(1), USER(2) CWR Short State 13
Filter Time FILTIME 0 to 1000 (minutes) CWR Floating Pt 14
Output Range - Top OUTHI value (in scaled units) CWR Floating Pt 15
Output Range - Bottom OUTLO value (in scaled units) CWR Floating Pt 16
Quality Limit - Top QUALHI value (in scaled units) CWR Floating Pt 17
Quality Limit - Bottom QUALLO value (in scaled units) CWR Floating Pt 18
Initial Value (Result) R value (in scaled units) CWR Floating Pt 19
Result Data Quality RQ GOOD (0), BAD (1) – WR Discrete 20

7-6
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

7.2.2 Thermocouple Transmitter Input Block Description (TTI)


This block is used to input a thermocouple transmitter’s value and translate it to a scaled
temperature. It receives its input from a voltage/current module block only. A functional block
diagram of a thermocouple transmitter input block is shown in Figure 7-4. The menus used to
configure the block are shown in Figure 7-5 and 7-6. The mnemonics, valid values, and data
types for all fields that may be selected for display and/or be used in making softwiring
connections are listed in Table 7-2. Section 7.2.8 further defines the input block configuration
parameters.

Signal Range - Top


Input Module Signal Range - Bottom
FAHRENHEIT KELVIN
No. Module Type
Thermocouple Type
CELSIUS RANKINE

Input Module
Floating Point Count Normalization Action
Filter and Temperature Scale
(DIR/REV)
Linearization

Filter Time Transmitter Transmitter


(minutes) Range Top Range Bottom

Output Calibrate Sum


NONE - Zero

AUTO Filter Type


Output Calibrate
- Span Mult
USER

Range Check

Diagnostic Calculation
Group Error Quality Limit Quality Limit
(NONE, 1-7) (ENAB/SUPP) - Top - Bottom

State BAD GOOD


(RUN, HOLD,
OFF, DEBUG)

CERRA
Quality and
Bad Inputs Error Check CERRAQ
Result
Accepted CERRU
(YES/NO)
CERRUQ
Set Quality
Input Module Result Quality Bad on
Calculation
Error (Y/N)

Result Quality

Figure 7-4. Thermocouple Transmitter Input Block (TTI), Functional Block Diagram

7-7
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Figure 7-5. Thermocouple Transmitter Input Block (TTI), General Menu

Figure 7-6. Thermocouple Transmitter Input Block (TTI), Diagnostics Menu

7-8
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Table 7-2. Thermocouple Transmitter Input Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 – – R Long State 00
Block Length BLKLEN – – R Count 01
State STATE RUN(0), HOLD(1), OFF(2), CWR Short State 02
DEBUG(3)
Bad Inputs Accepted BADINP NO (0), YES (1) CWR Discrete 03
Diagnostic Group Supp. SUPPGRP NONE, 1, 2, 3, 4, 5, 6, 7 CWR Long State 04
Calculation Error CERRS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Calc. Error Unacked CERRU NO (0), YES (1) – WR Discrete 06
Calc. Error Unacked Quality CERRUQ NO (0), YES (1) – WR Discrete 07
Calc. Error Active CERRA NO (0), YES (1) – WR Discrete 08
Calc. Error Active Quality CERRAQ NO (0), YES (1) – WR Discrete 09
Set quality bad on SETQBAD NO (0), YES (1) CWR Discrete 10
calculation error?
Action ACTION REVERSE (0), DIRECT (1) CWR Discrete 11
Temperature Scale SCLTYPE FAHRENHEIT(0),CELSIUS(1), CWR Short State 12
RANKINE(2), KELVIN(3)
Filter Type FILTYPE NONE(0), AUTO(1), USER(2) CWR Short State 13
Filter Time FILTIME 0 to 1000 (minutes) CWR Floating Pt 14
Transmitter Range - Top TRANSHI value (in microvolts) CWR Floating Pt 15
Transmitter Range - Bottom TRANSLO value (in microvolts) CWR Floating Pt 16
Output Calibrate - Zero ZERO value (in temperature units) CWR Floating Pt 17
Output Calibrate - Span SPAN value (multiplier) CWR Floating Pt 18
Quality Limit - Top QUALHI value (in temperature units) CWR Floating Pt 19
Quality Limit - Bottom QUALLO value (in temperature units) CWR Floating Pt 20
Initial Value (Result) R value (in temperature units) CWR Floating Pt 21
Result Data Quality RQ GOOD (0), BAD (1) – WR Discrete 22

7-9
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

7.2.3 Thermocouple Input Block Description (TI)


This block is used to input a thermocouple value, compensate it and translate it to a scaled
temperature. It’s input is from a thermocouple module and it’s compensation input from a
RIM, or WRIM block or a floating point value specified in the thermocouple module block or
through the local CJC input. A functional block diagram of a thermocouple input block is
shown in Figure 7-7. The menus used to configure the block re shown in Figure 7-8 and 7-9.
The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 7-3. Section 7.2.8 further
defines the input block configuration parameters.
Thermocouple Type
FAHRENHEIT KELVIN
Input Module
No. Scaled Counts CELSIUS RANKINE

Input Module
Floating Point Count Microvolt Temperature
Filter Calculation Linearization Scale

Filter Time
(minutes)
NONE +
Sum
AUTO Filter Type
+
USER Output
Sum Calibrate
RIM, WRIM, CJIM or Local - Zero
Floating Point Count Deg C Inverse
Filter Calculation Linearization
Output
NONE Mult Calibrate
- Span
Cold Junction
Value Compensation
Input
LSP Range Check

Diagnostic Calculation
Group Error Quality Limit Quality Limit
(NONE, 1-7) (ENAB/SUPP) - Top - Bottom

State BAD GOOD


(RUN, HOLD,
OFF, DEBUG)

CERRA
Quality and
Bad Inputs Error Check CERRAQ
Result
Accepted CERRU
(YES/NO)
CERRUQ
Set Quality
Input Module Result Quality Bad on
Calculation
Error (Y/N)

Result Quality

Figure 7-7. Thermocouple Input Block (TI), Functional Block Diagram

7-10
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Figure 7-8. Thermocouple Input (TI), General Menu

Figure 7-9. Thermocouple Input (TI), Diagnostics Menu

7-11
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Table 7-3. Thermocouple Input Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 – – R Long State 00
Block Length BLKLEN – – R Count 01
State STATE RUN(0), HOLD(1), OFF(2), CWR Short State 02
DEBUG(3)
Bad Inputs Accepted BADINP NO (0), YES (1) CWR Discrete 03
Diagnostic Group Supp. SUPPGRP NONE, 1, 2, 3, 4, 5, 6, 7 CWR Long State 04
Calculation Error CERRS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Calc. Error Unacked CERRU NO (0), YES (1) – WR Discrete 06
Calc. Error Unacked Quality CERRUQ NO (0), YES (1) – WR Discrete 07
Calc. Error Active CERRA NO (0), YES (1) – WR Discrete 08
Calc. Error Active Quality CERRAQ NO (0), YES (1) – WR Discrete 09
Set quality bad on calc err? SETQBAD NO (0), YES (1) CWR Discrete 10
Temperature Scale SCLTYPE FAHRENHEIT(0),CELSIUS(1), CWR Short State 11
RANKINE(2), KELVIN(3)
Filter Type FILTYPE NONE(0), AUTO(1), USER(2) CWR Short State 12
Filter Time FILTIME 0 to 1000 (minutes) CWR Floating Pt 13
Output Calibrate - Zero ZERO value (in temperature units) CWR Floating Pt 14
Output Calibrate - Span SPAN value (multiplier) CWR Floating Pt 15
Quality Limit - Top QUALHI value (in temperature units) CWR Floating Pt 16
Quality Limit - Bottom QUALLO value (in temperature units) CWR Floating Pt 17
Initial Value (Result) R value (in temperature units) CWR Floating Pt 18
Result Data Quality RQ GOOD (0), BAD (1) – WR Discrete 19
Cold Junction Comp. Input CJCINP NONE, value, LSP CWR Floating Pt 20

7-12
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

7.2.4 Resistance Input Block Description (RI)


This block is used to input a resistance module’s value and translate it to a user specified
scaled value. It receives its input from a RIM or WRIM block only. A functional block diagram
of a resistance input block is shown in Figure 7-10. The menus used to configure the block
are shown in Figures 7-11 and 7-12. The mnemonics, valid values, and data types for all
fields that may be selected for display and/or be used in making softwiring connections are
listed in Table 7-4. Section 7.2.8 further defines the input block configuration parameters.

Signal Range - Top


Input Module No. Signal Range - Bottom

Input Module
Floating Point Count Action
Filter Normalization
(DIR/REV)

Filter Time
(minutes) Output Range
Top
Output Scaling
NONE
Output Range
Bottom
AUTO Filter Type

USER

Range Check

Diagnostic Calculation
Group Error Quality Limit Quality Limit
(NONE, 1-7) (ENAB/SUPP) - Top - Bottom

State BAD GOOD


(RUN, HOLD,
OFF, DEBUG)

CERRA
Quality and
Bad Inputs Error Check CERRAQ
Result
Accepted CERRU
(YES/NO)
CERRUQ
Set Quality
Input Module Result Quality Bad on
Calculation
Error (Y/N)

Result Quality

Figure 7-10. Resistance Input Block (RI), Functional Block Diagram

7-13
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Figure 7-11. Resistance Input Block (RI), General Menu

Figure 7-12. Resistance Input Block (RI), Diagnostics Menu

7-14
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Table 7-4. Resistance Input Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 – – R Long State 00
Block Length BLKLEN – – R Count 01
State STATE RUN(0), HOLD(1), OFF(2), CWR Short State 02
DEBUG(3)
Bad Inputs Accepted BADINP NO (0), YES (1) CWR Discrete 03
Diagnostic Group Supp. SUPPGRP NONE, 1, 2, 3, 4, 5, 6, 7 CWR Long State 04
Calculation Error CERRS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Calc. Error Unacked CERRU NO (0), YES (1) – WR Discrete 06
Calc. Error Unacked Quality CERRUQ GOOD (0), BAD (1) – WR Discrete 07
Calc. Error Active CERRA NO (0), YES (1) – WR Discrete 08
Calc. Error Active Quality CERRAQ GOOD (0), BAD (1) – WR Discrete 09
Set quality bad on calc err? SETQBAD NO (0), YES (1) CWR Discrete 10
Action ACTION REVERSE (0), DIRECT (1) CWR Discrete 11
Filter Type FILTYPE NONE(0), AUTO(1), USER(2) CWR Short State 12
Filter Time FILTIME 0 to 1000 (minutes) CWR Floating Pt 13
Output Range - Top OUTHI value (in scaled units) CWR Floating Pt 14
Output Range - Bottom OUTLO value (in scaled units) CWR Floating Pt 15
Quality Limit - Top QUALHI value (in scaled units) CWR Floating Pt 16
Quality Limit - Bottom QUALLO value (in scaled units) CWR Floating Pt 17
Initial Value (Result) R value (in scaled units) CWR Floating Pt 18
Result Data Quality RQ GOOD (0), BAD (1) – WR Discrete 19

7-15
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

7.2.5 RTD Input Block Description (RTI)


This block is used to input a RTD value and translate it to a scaled temperature. It receives its
input from a RIM or WRIM module block only. A functional block diagram of a RTD input
block is shown in Figure 7-13. Menus used to configure the block re shown in Figure 7-14
and Figure 7-15. The mnemonics, valid values, and data types for all fields that may be
selected for display and/or be used in making softwiring connections are listed in Table 7-5.
Section 7.2.8 further defines the input block configuration parameters.

RTD Type
Input Module Nominal Resistance FAHRENHEIT KELVIN
No.

CELSIUS RANKINE

Input Module
Floating Point Count RTD Temperature Scale
Filter Linearization

Filter Time
(minutes)

Output Calibrate Sum


NONE - Zero

AUTO Filter Type


Output Calibrate
- Span Mult
USER

Range Check

Diagnostic Calculation
Group Error Quality Limit Quality Limit
(NONE, 1-7) (ENAB/SUPP) - Top - Bottom

State BAD GOOD


(RUN, HOLD,
OFF, DEBUG)

CERRA
Quality and
Bad Inputs Error Check CERRAQ
Result
Accepted CERRU
(YES/NO)
CERRUQ
Set Quality
Input Module Result Quality Bad on
Calculation
Error (Y/N)

Result Quality

Figure 7-13. RTD Input Block (RTI), Functional Block Diagram

7-16
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Figure 7-14. RTD Input Block (RTI), General Menu

Figure 7-15. RTD Input Block (RTI), Diagnostics Menu

7-17
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Table 7-5. RTD Input Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 – – R Long State 00
Block Length BLKLEN – – R Count 01
State STATE RUN(0), HOLD(1), OFF(2), CWR Short State 02
DEBUG(3)
Bad Inputs Accepted BADINP NO (0), YES (1) CWR Discrete 03
Diagnostic Group Supp. SUPPGRP NONE, 1, 2, 3, 4, 5, 6, 7 CWR Long State 04
Calculation Error CERRS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Calc. Error Unacked CERRU NO (0), YES (1) – WR Discrete 06
Calc. Error Unacked Quality CERRUQ GOOD (0), BAD (1) – WR Discrete 07
Calc. Error Active CERRA NO (0), YES (1) – WR Discrete 08
Calc. Error Active Quality CERRAQ GOOD (0), BAD (1) – WR Discrete 09
Set quality bad on SETQBAD NO (0), YES (1) CWR Discrete 10
calculation error?
Temperature Scale SCLTYPE FAHRENHEIT(0),CELSIUS(1), CWR Short State 11
RANKINE(2), KELVIN(3)
Filter Type FILTYPE NONE(0), AUTO(1), USER(2) CWR Short State 12
Filter Time FILTIME 0 to 1000 (minutes) CWR Floating Pt 13
Output Calibrate - Zero ZERO value (in temperature units) CWR Floating Pt 14
Output Calibrate - Span SPAN value (multiplier) CWR Floating Pt 15
Quality Limit - Top QUALHI value (in temperature units) CWR Floating Pt 16
Quality Limit - Bottom QUALLO value (in temperature units) CWR Floating Pt 17
Initial Value (Result) R value (in temperature units) CWR Floating Pt 18
Result Data Quality RQ GOOD (0), BAD (1) – WR Discrete 19

7-18
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

7.2.6 RTD Transmitter Input Block Description (RTTI)


This block is used to input a RTD transmitter value and translate it to a scaled temperature. It
receives its input from a VCIM module block only. A functional block diagram of a RTD
transmitter input block is shown in Figure 7-16. The menus used to configure the block are
shown in Figure 7-17 and 7-18. The mnemonics, valid values, and data types for all fields that
may be selected for display and/or be used in making softwiring connections are listed in
Table 7-6. Section 7.2.8 further defines the input block configuration parameters.

RTD Type
Input Module Signal Range - Top
No. FAHRENHEIT KELVIN
Signal Range - Bottom

CELSIUS RANKINE

Input Module
Floating Point
Count RTD
Filter Normali- Action Resistance Temperature Scale
zation (DIR/REV) Calculation Lineariza-
tion

Filter Time
(minutes) Transmitter Transmitter
Range Top Range Bottom

NONE Output Calibrate Sum


- Zero
AUTO Filter Type
Output Calibrate
- Span Mult
USER

Range Check

Diagnostic Calculation
Group Error Quality Limit Quality Limit
(NONE, 1-7) (ENAB/SUPP) - Top - Bottom

State BAD GOOD


(RUN, HOLD,
OFF, DEBUG)

CERRA
Quality and
Bad Inputs Error Check CERRAQ
Result
Accepted CERRU
(YES/NO)
CERRUQ
Set Quality
Bad on
Input Module Result Quality Calculation
Error (Y/N)

Result Quality

Figure 7-16. RTD Transmitter Input Block (RTTI), Functional Block Diagram

7-19
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Figure 7-17. RTD Transmitter Input Block (RTTI), General Menu

Figure 7-18. RTD Transmitter Input Block (RTTI), Diagnostics Menu

7-20
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

Table 7-6. RTD Transmitter Input Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 – – R Long State 00
Block Length BLKLEN – – R Count 01
State STATE RUN(0), HOLD(1), OFF(2), CWR Short State 02
DEBUG(3)
Bad Inputs Accepted BADINP NO (0), YES (1) CWR Discrete 03
Diagnostic Group Supp. SUPPGRP NONE, 1, 2, 3, 4, 5, 6, 7 CWR Long State 04
Calculation Error CERRS ENABLE (0), SUPPRESS (1) CWR Discrete 05
Calc. Error Unacked CERRU NO (0), YES (1) – WR Discrete 06
Calc. Error Unacked Quality CERRUQ GOOD (0), BAD (1) – WR Discrete 07
Calc. Error Active CERRA NO (0), YES (1) – WR Discrete 08
Calc. Error Active Quality CERRAQ GOOD (0), BAD (1) – WR Discrete 09
Set quality bad on calc err? SETQBAD NO (0), YES (1) CWR Discrete 10
Action ACTION REVERSE (0), DIRECT (1) CWR Discrete 11
Temperature Scale SCLTYPE FAHRENHEIT(0),CELSIUS(1), CWR Short State 12
RANKINE(2), KELVIN(3)
Filter Type FILTYPE NONE(0), AUTO(1), USER(2) CWR Short State 13
Filter Time FILTIME 0 to 1000 (minutes) CWR Floating Pt 14
Transmitter Range - Top TRANSHI value (in temperature units) CWR Floating Pt 15
Transmitter Range - Bottom TRANSLO value (in temperature units) CWR Floating Pt 16
Output Calibrate - Zero ZERO value (in temperature units) CWR Floating Pt 17
Output Calibrate - Span SPAN value (multiplier) CWR Floating Pt 18
Quality Limit - Top QUALHI value (in temperature units) CWR Floating Pt 19
Quality Limit - Bottom QUALLO value (in temperature units) CWR Floating Pt 20
Initial Value (Result) R value (in temperature units) CWR Floating Pt 21
Result Data Quality RQ GOOD (0), BAD (1) – WR Discrete 22

7-21
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

7.2.7 Analog Input Type Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Sections 7.2.1 to 7.2.7. The
following further defines the configuration parameters for the VCI, TTI, TI, RI, RTI, and RTTI
blocks.

Block Type
The following are valid analog input block types. The block type field, on the edit block
display, identifies the block being edited.
VCI Voltage/Current Input Block
TTI Thermocouple Transmitter Input Block
TI Thermocouple Input Block
RI Resistance Input Block
RTI RTD Input Block
RTTI RTD Transmitter Input Block

Occurrence
1 to 4096 Distinguishes a particular ‘instance’ of the block. The next logical
block number is automatically assigned to the block on the Function
Block Selection Page.

Input Module ...................................................................................................................... C – –


Identifies the entry in the I/O module block selection page for the physical input point from
which this block gets its input. The VCI and TTI block types always get their input from a
VCIM module and the TI block gets its input from a TIM module. The RI and RTI block types
always get their input from a RIM or WRIM module, RTTI gets its input from a VCIM module.
Enter the occurrence number for the appropriate module.

02 State (STATE) .................................................................................................................... CWR


All block state changes are reported as events. See Section 2.4.1, State Changes for
additional information.
RUN 0 Normal Operation. Block is executed.
HOLD 1 Block is not executed. Qualities retain previous values.
OFF 2 Block is not executed. Qualities will be BAD.
DEBUG 3 Block is not executed. No fields are updated. All attributes are
writeable.

03 Bad Inputs Accepted (BADINP) ....................................................................................... CWR


See Section 2.3.2, Data Quality for additional information.
YES 1 Block runs its algorithm without a check on input quality and output
quality is set to good.
NO 0 Block checks data quality on its inputs and will only update the result
if its input is good. If the input is BAD, the result is held at the
previous value and the result quality is set BAD.

7-22
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

04 Diagnostic Group Supp. (SUPPGRP) ..............................................................................CWR


The diagnostic error reported by this block can be grouped for System Event block control of
its reporting. The selections are:
NONE No group assigned.
1 to 7 Defines the diagnostic group number for the diagnostic suppression group
controlled by the System Event block.

05 Diagnostic Error (CERRS) ................................................................................................CWR


When a calculation error (calculation overflow or divide by zero) is detected, the block
completes the calculation using some reasonable value (+ or - maximum value for overflows
and divide by zero), reports the diagnostic error as “CALCULATION ERROR”, and sets the
output quality bad if Set quality bad on calculation error? is YES. The diagnostic error will
clear and the quality will be set back to good when a subsequent execution of the block
performs a successful calculation.
ENABLED 0 Calculation error is enabled.
SUPPRESSED 1 Calculation error is suppressed.

06 Calc. Error Unacked (CERRU) ......................................................................................... – WR


If the calculation error diagnostic is enabled, the unacknowledged status indicates if the
diagnostic is or is not acknowledged. Only writeable in DEBUG.
NO 0 Diagnostic error is acknowledged.
YES 1 Diagnostic error is unacknowledged.

07 Calc. Error Unacked Quality (CERRUQ) ......................................................................... – WR


If the calculation error diagnostic is enabled, this status indicates if the quality of the
unacknowledged diagnostic is GOOD or BAD. Only writeable in DEBUG.
OOD 0 Quality when the loop block is RUN or HOLD.
BAD 1 Quality when the loop block is OFF.

08 Calc. Error Active (CERRA) ............................................................................................. – WR


If the calculation error diagnostic is enabled, the active status indicates if the diagnostic is
active even after acknowledgement. Only writeable in DEBUG.
NO 0 Diagnostic error is not active.
YES 1 Diagnostic error is active.

09 Calc. Error Active Quality (CERRAQ) ............................................................................. – WR


If the calculation error diagnostic is enabled, this status indicates if the quality of the active
diagnostic is GOOD or BAD. Only writeable in DEBUG.
GOOD 0 Quality when the loop block is RUN or HOLD.
BAD 1 Quality when the loop block is OFF.

10 Set quality bad on calculation error? (SETQBAD) .........................................................CWR


The result quality can be affected by a calculation error as follows.
NO 0 Result quality is not affected by a calculation error.
YES 1 Quality is set BAD when a calculation error occurs.

7-23
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

VCI 11 Action (ACTION) ................................................................................................................ CWR


TTI 11 Action (ACTION) ................................................................................................................ CWR
RI 11 Action (ACTION) ................................................................................................................ CWR
RTTI 11 Action (ACTION) ................................................................................................................ CWR
The action applied to the VI, TTI, RI or RTTI input before it is put into the result for the block is
determined by configuring and/or writing this attribute.
REVERSE 0 The input for the block is reversed. The reverse calculation is: Count
= 1 – Normalized Count
DIRECT 1 The input for the block is not reversed. The direct calculation is:
Count = Normalized Count
VCI 12 Linearization Type (LINTYPE) .......................................................................................... CWR
For VCI blocks only. The linearization type is used to select the linearization to be applied to
the VCI normalized input before it is put into the result. The linearization types are:
LINEAR 17 See Linear description in Section 8.5.1 for description.
SQUARE 20 See Square description in Section 8.5.1 for description.
SQR ROOT 21 See Square Root description in Section 8.5.1 for description.
MOD_SQR 22 See Modified Square description in Section 8.5.1 for description.
MOD SQRT 23 See Modified Square Root description in Section 8.5.1 for
description.

TTI 12 Temperature Scale (SCLTYPE) ........................................................................................ CWR


TI 11 Temperature Scale (SCLTYPE) ........................................................................................ CWR
RTI 11 Temperature Scale (SCLTYPE) ........................................................................................ CWR
RTTI 12 Temperature Scale (SCLTYPE) ........................................................................................ CWR
The temperature scale is used to select the scale to be applied to the TTI, TI, RTI, or RTTI
input before it is put into the result. The temperature scale types are:
FAHRENHEIT 0 Degrees Fahrenheit = (C° x 9/5) + 32
CELSIUS 1 Degrees Celsius (Thermocouple linearization tables are used for the
conversion to degrees C.)
RANKINE 2 Degrees Rankine = (C° x 9/5) +491.67
KELVIN 3 Degrees Kelvin = C°+273.15

VCI 13 Filter Type (FILTYPE) ........................................................................................................ CWR


TTI 13 Filter Type (FILTYPE) ........................................................................................................ CWR
TI 12 Filter Type (FILTYPE) ........................................................................................................ CWR
RI 12 Filter Type (FILTYPE) ........................................................................................................ CWR
RTI 12 Filter Type (FILTYPE) ........................................................................................................ CWR
RTTI 13 Filter Type (FILTYPE) ........................................................................................................ CWR
Since analog input type modules are sampled using a phased scan cycle and the analog input
block may be in a task running at some multiple of the base rate, a filter may be applied to the
sampled input value.
NONE 0 No filter is applied. Last sampled value is the input value.
AUTO 1 Auto uses the task rate this block is running in as the basis for filter
time in the filter calculation. The calculation executes at the base
sample rate (150 milliseconds). If the task rate were 600

7-24
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

milliseconds, four samples would be filtered using the following first


order filter calculation:

Value = Previous value + (0.15 / (0.15 + FILTIME)) *


(sampled value - Previous value)
where 150 milliseconds is the base sample rate for
analog inputs and FILTIME is the filter time =
0.150 / 0.150 + (INTn/2) and INTn is one of
the Group Scan Intervals from Interface
Block
USER 2 User allows a filter time to be configured (FILTIME) into the filter
calculation.

VCI 14 Filter Time (FILTIME) .........................................................................................................CWR


TTI 14 Filter Time (FILTIME) .........................................................................................................CWR
TI 13 Filter Time (FILTIME) .........................................................................................................CWR
RI 13 Filter Time (FILTIME) .........................................................................................................CWR
RTI 13 Filter Time (FILTIME) .........................................................................................................CWR
RTTI 14 Filter Time (FILTIME) .........................................................................................................CWR
The filter time attribute specifies a value equal to time in minutes for the filter. This value is
either the user (USER) input value or a calculated (AUTO) value based on the task scan rate.

value Any floating point value in minutes


where
0.0 = no filtering (last sampled value is the input value)
1.0 = a 1 minute
1000.0 = 1000 minutes (maximum value)

Note that exceptionally large values tend to maintain the previous value whereas very small
values tend to maintain the most recent sampled value.

VCI 15 Output Range - Top (OUTHI) ............................................................................................CWR


RI 14 Output Range - Top (OUTHI) ............................................................................................CWR
User scaled high floating point value for VCI and RI blocks. Represents the 100%
output value in engineering units.

VCI 16 Output Range - Bottom (OUTLO) ....................................................................................CWR


RI 15 Output Range - Bottom (OUTLO) ....................................................................................CWR
User scaled low floating point value for VCI and RI blocks. Represents the 0%
output value in engineering units.

TTI 15 Transmitter Range - Top (TRANSHI)................................................................................CWR


RTTI 15 Transmitter Range - Top (TRANSHI)................................................................................CWR
Transmitter top of range for TTI and RTTI blocks. TTI blocks are specified in result units of
microvolts (see transmitter tables for temperature equivalents of microvolts). RTTI blocks are
specified as a temperature value where the scale is determined by the Temperature Scale
attribute.

7-25
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

TTI 16 Transmitter Range - Bottom (TRANSLO) ........................................................................ CWR


RTTI 16 Transmitter Range - Bottom (TRANSLO) ........................................................................ CWR
Transmitter bottom of range for TTI and RTTI blocks. Specified in result units as described for
Top of Range.

TTI 17 Output Calibrate - Zero (ZERO) ....................................................................................... CWR


TI 14 Output Calibrate - Zero (ZERO) ....................................................................................... CWR
RTI 14 Output Calibrate - Zero (ZERO) ....................................................................................... CWR
RTTI 17 Output Calibrate - Zero (ZERO) ....................................................................................... CWR
Zero calibration value for TTI, TI, RTI, and RTTI blocks. Specified in result units.

TTI 18 Output Calibrate - Span (SPAN)....................................................................................... CWR


TI 15 Output Calibrate - Span (SPAN)....................................................................................... CWR
RTI 15 Output Calibrate - Span (SPAN)....................................................................................... CWR
RTTI 18 Output Calibrate - Span (SPAN)....................................................................................... CWR
Span calibration value for TTI, TI, RTI, and RTTI blocks. Multiplier with 1.0 nominal.

VCI 17 Quality Limit - Top (QUALHI)............................................................................................ CWR


TTI 19 Quality Limit - Top (QUALHI)............................................................................................ CWR
TI 16 Quality Limit - Top (QUALHI)............................................................................................ CWR
RI 16 Quality Limit - Top (QUALHI)............................................................................................ CWR
RTI 16 Quality Limit - Top (QUALHI)............................................................................................ CWR
RTTI 19 Quality Limit - Top (QUALHI)............................................................................................ CWR
Sets result quality BAD if result exceeds this engineering units value. The top quality limit
must be greater than or equal to the bottom quality limit.

VCI 18 Quality Limit - Bottom (QUALLO) .................................................................................... CWR


TTI 20 Quality Limit - Bottom (QUALLO) .................................................................................... CWR
TI 17 Quality Limit - Bottom (QUALLO) .................................................................................... CWR
RI 17 Quality Limit - Bottom (QUALLO) .................................................................................... CWR
RTI 17 Quality Limit - Bottom (QUALLO) .................................................................................... CWR
RTTI 20 Quality Limit - Bottom (QUALLO) .................................................................................... CWR
Sets result quality BAD if result is less than this engineering units value. The bottom quality
limit must be less than or equal to the top quality limit.

VCI 19 Initial Value (Result) (R).................................................................................................... CWR


TTI 21 Initial Value (Result) (R).................................................................................................... CWR
TI 18 Initial Value (Result) (R).................................................................................................... CWR
RI 18 Initial Value (Result) (R).................................................................................................... CWR
RTI 18 Initial Value (Result) (R).................................................................................................... CWR
RTTI 21 Initial Value (Result) (R).................................................................................................... CWR
This is the output of the input block. This output is the result of an input module producing a
digital count of the analog signal and the input block filtering, normalizing, linearizing, and
converting the input count value to an engineering units value for VCI and RI blocks or to a
temperature value in the specified Temperature Scale units for TTI, TI, RTI, and RTTI blocks.

7-26
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

VCI 20 Result Data Quality (RQ).................................................................................................. – WR


TTI 22 Result Data Quality (RQ).................................................................................................. – WR
TI 19 Result Data Quality (RQ).................................................................................................. – WR
RI 19 Result Data Quality (RQ).................................................................................................. – WR
RTI 9 Result Data Quality (RQ).................................................................................................. – WR
RTTI 22 Result Data Quality (RQ).................................................................................................. – WR
The quality attribute indicates quality of the input data. A bad quality is generated as a result
of conversion errors in the hardware, or if the converted value is over or under range.
GOOD 0 No conversion errors or over or under range conditions have been
reported.
BAD 1 The data quality field will go BAD if any of the blocks inputs becomes
bad while the block is in auto.

TI 20 Cold Junction Compensation Input (CJCINP) ................................................................CWR


The Cold Junction Compensation Input field is used for cold junction compensation if a local or
LSP floating point temperature input value is configured.
NONE No local CJC input is applied. If the cold junction compensation field
in the connected TIM block is not NONE, it is used. Otherwise, both
fields are NONE, and no cold junction compensation takes place.
value A floating point value in the units specified by the Temperature Scale
attribute (C, F, K, R).
LSP A logical source pointer to a floating point value in the units specified
by the Temperature Scale attribute (C, F, K, R).

7.2.8 Typical Block Connections for Analog Input Type Block


Typical softwiring block structures used on softwiring diagrams are shown in Figure 7-19.

VCIM1 VCI1

MODOUT MODIN
R Softwiring connection to other
Result function block (result quality is
RQ automatically connected).
CL11 Result Data Quality
ACTION Operator indication
I1 Action
of input action.
I2 Filter Time

Operator write access to input


action and filter time.

Figure 7-19. Typical Block Connections for Analog Input Type Block

7-27
Logic Functions - Book 1

ANALOG INPUT BLOCKS (VCI, TII, TI, RI, RTI, RTTI)

7.2.9 Analog Input Type Block Events


The event codes (and their suggested text messages) for the analog input type blocks are
given below. See data base attribute descriptions for additional information. See the system
event block for a description of event transitions.

0 BLOCK STATE SET TO RUN


1 BLOCK STATE SET TO HOLD
2 BLOCK STATE SET TO OFF
3 BLOCK STATE SET TO DEBUG
4 CALCULATION ERROR

7-28
Logic Functions - Book 1

DIGITAL INPUT BLOCK

7.3 DIGITAL INPUT BLOCK (DI)


The digital input block provides an input link from a physical digital input module (DIM or
RDIM) to a loop. A digital input module conditions a field signal and processes the signal
through an on-board select circuit which passes all digital data between the modules and the
module blocks at the base scan rate of 50 milliseconds. Functions performed by the digital
input function block (DI) include input filtering parameters and action.

Block outputs are the data and data quality. A functional block diagram of a digital input block
is shown in Figure 7-20. The menu used to configure the Digital Input block is shown in
Figure 7-21.

Input Module Discrete Value GOOD


Conditioning
No.
Action Result
(DIR / REV)
BAD

Number of
Millisecond Filter Time
(0 to 65500)

ANY

TRUE
Latch Type
FALSE
TRANS.
Bad Inputs
Accepted
(YES/NO)

Block State
RUN, HOLD,
OFF, DEBUG)

Input Module Status


Quality Check Result Quality

Figure 7-20. Digital Input Block, Functional Block Diagram

7-29
Logic Functions - Book 1

DIGITAL INPUT BLOCK

Figure 7-21. Digital Input Block (DI), General Menu

7.3.1 Digital Input Block Operation


The digital input block is a loop function block that provides a logical input link to an input
module (one physical input point). As many input blocks as required can be connected to a
module block source. The input value is buffered in the group state table for the loop.
Process input and output routines use these tables to pass data between the module blocks
and the function blocks which run at the configured scan group interval.

An input block uses the Input Module pointer specified during configuration to set the
connection between the block and the module. This connection is fixed by configuration and
can not be changed through the database.

7.3.2 Digital Input Block Parameters


The mnemonics, valid values, and data types for all fields that may be selected for display
and/or be used in making softwiring connections are listed in Table 7-8. The following further
defines the digital input block configuration parameters.

Block Type
DI This is the digital input block type.

Occurrence
1 to 4096 There may be up to 4096 ‘instances’ allowed of the DI block type.

7-30
Logic Functions - Book 1

DIGITAL INPUT BLOCK

Input Module ......................................................................................................................C – –


DIM1 A Digital Input Module (DIM) is the only valid input module type as
connected through MODIN. Occurrence numbers may be from 1 to
32.

Table 7-7. Digital Input Block Attributes, Valid Values, Mnemonics, and Data Types
Field Name / Attribute Mnemonic Valid Values CWR Data Type Attr
Version VERSION 1 – – R Long State 00
Block Length BLKLEN – – R Count 01
Block State STATE RUN(0), HOLD(1), OFF(2), CWR Short State 02
DEBUG(3)
Bad Inputs Accepted BADINP NO (0), YES (1) CWR Discrete 03
Filter type FILTYPE NONE (for future use) CWR Short State 04
Filter Time FILTIME 0 to 65500 (milliseconds) CWR Count 05
Latch Value LATCH ANY(0), FALSE(1), TRUE(2), CWR Short State 06
TRANS.(3)
Action ACTION REVERSE (0), DIRECT (1) CWR Discrete 07
Initial Result Value R FALSE (0), TRUE (1) CWR Discrete 08
Result Quality RQ GOOD (0), BAD (1) – WR Discrete 09

02 State (STATE).....................................................................................................................CWR
All block state changes are reported as events. See Section 2.4.1, State Changes for
additional information.
RUN 0 Normal Operation. Block is executed.
HOLD 1 Block is not executed. Qualities retain previous values.
OFF 2 Block is not executed. Qualities will be BAD.
DEBUG 3 Block is not executed. No fields are updated. All attributes are
writeable.

03 Bad Inputs Accepted (BADINP) ........................................................................................CWR


See Section 2.3.2, Data Quality for additional information.
YES 1 Block runs its algorithm without a check on input quality and output
quality is set to good.
NO 0 Block checks data quality on its inputs and only updates the result if
its input is good. If the input quality is BAD, the result is held at the
previous value and the result quality is set bad.

05 Filter Time (FILTIME) .........................................................................................................CWR


The filter time attribute allows an input signal to stabilize before it is considered valid. An input
value state must remain consistent for the total number of milliseconds specified (0 to 65500
rounded up to the next base scan cycle) before it is accepted as an input value.

06 Latch Value (LATCH) .........................................................................................................CWR


Since physical digital inputs are sampled at a 50 millisecond rate and the digital input block
may be in a loop running at a slower rate, input latching may be applied to the sampled input
value to ‘synchronize’ the conditioning values with the conditioning. The latch value of the
block is determined by configuring and/or writing this attribute.
ANY 0 If ANY is specified, no input latching is applied.

7-31
Logic Functions - Book 1

DIGITAL INPUT BLOCK

FALSE 1 If a FALSE latch is specified, a transition to FALSE by the input is


latched until the value is read by the task.
TRUE 2 If a TRUE latch type is specified, a transition to TRUE by the input is
latched until the value is read by the task.
TRANS. 3 TRANSITION latch will latch either transition. The transition latch
type applies to the input signal before the input action is applied.

07 Action (ACTION) ................................................................................................................ CWR


The action of the block is determined by configuring and/or writing this attribute. Action is
applied to the input before it is put into the result.
REVERSE 0 The input for the block is complemented before it is stored in the input
value attribute (R).
DIRECT 1 The input for the block is not reversed.

08 Initial Result Value (R) ...................................................................................................... CWR


This is the block output value after conditioning and action are applied. During startup, this is
the initial data value.

09 Result Quality (RQ) ...........................................................................................................– WR


This data quality field will go BAD if any of the blocks quality check becomes active.

7.3.3 Typical Block Connections for Digital Input Block


Typical softwiring block structures used on softwiring diagrams are shown in Figure 7-22.

DIM1 DI1

MODOUT MODIN
R
Softwiring connection to
Result another block (quality
RQ connection is linked to result).
CL11 Result Quality
ACTION
I1 Operator indication
Action of block action.
I2 Filter Time

Operator write access to set action filter time.

Figure 7-22. Digital Input Block, Typical Connections

7.3.4 Digital Input Block Events


The event codes (and their suggested text messages) for the digital input block are given
below. See database attributes descriptions for additional information. See the system event
block for a description of event transitions.

0 BLOCK STATE SET TO RUN


1 BLOCK STATE SET TO HOLD
2 BLOCK STATE SET TO OFF
3 BLOCK STATE SET TO DEBUG

7-32
Logic Functions - Book 1

APPENDIX A - VERSION DIFFERENCES

APPENDIX A
SUMMARY OF VERSION DIFFERENCES

A.1 GENERAL

This document is written to reflect the latest model and version of the instrument. The
summary provided below notes the differences between the current instrument and the
previous versions. Current functionality is: Logic 6, Advanced 3, MOD 30ML 2.

At present, upgrades are possible using the configurator. When an upgrade is done, any
blocks in the original database, which have later versions at the selected upgrade level, will be
upgraded to those later versions. This process will normally be irreversible, and the database
cannot be downgraded to its original level. A downgrade is possible if the database has only
those functions available in the earlier version.

The configurator tags each database it produces with the declared instrument version and the
minimum instrument version, which is the lowest instrument version capable of running the
database. The configurator determines, at the start of download, whether or not the target
instrument is capable of running the database and allows or disables the download
accordingly. The instrument itself makes a similar check when an attempt is made to
download from a memory module. The configurator will create a database based on the
declared instrument version when a database is uploaded.

A.2 LOGIC 5, ADVANCED 2, MOD 30ML 1 FUNCTIONALITY


These instrument versions do not include the following:
• PW Version 2 Piecewise support for attributes 4, 5, 6, 101 through 160 and 201
through 260. These attributes support tuneable X, Y values and recipe data
(table can be used as a data source other than linearization).
• EX Expression Block attributes 70 through 95, which add Inputs 21 through 46.
• TOT Totalizer Block
• RSK Ramp/Soak Block
• PAD Process Alarm Display Block, Version 2 supports a trip condition of DEVIATION.

A.3 LOGIC 4, REGULATORY 3, BATCH 1 FUNCTIONALITY


These instrument versions do not include the following remote I/O module blocks:
• RIO Remote I/O Interface Module Block
• RDIM Remote Digital Input Module Block
• RDOM Remote Digital Output Module Block

In addition, the Version 1 Configured List Block does not support attributes 8, 9 and
10.

A-1
Logic Functions - Book 1

APPENDIX A - VERSION DIFFERENCES

A.4 LOGIC 3, REGULATORY 2, BATCH 1 FUNCTIONALITY


These instrument versions have a Version 1 MSC Block (renamed from Modbus Slave to
Modcell Serial with version 2 of the block). The version 1 block does not include attributes 26
to 28 and 83 to 88 and does not include event code 14. This functionality is used to support
communication modules with the address switch and support Extended Modbus, Modbus
master (see Appendix B) and slave communications.

A.5 LOGIC 2, REGULATORY 1 FUNCTIONALITY


These instrument versions do not include the following I/O module and function blocks:
• NM Notification/Request Message Block
• SM Supervisory Message Block
• ML Modbus List Block
• MSC Modbus Slave Communication Block

In addition, the Version 1 Expression Block does not include the following operators:

** Raise to the power


ABS Absolute value
EXP Exponential
NLOG Natural Log
LOG Log (base 10)
INT Integer
IF, THEN, and ELSE Conditional Operators

A.6 LOGIC 1 FUNCTIONALITY


The Version 1 instrument does not include the following I/O module and function blocks:
• RIM Resistance Input Module
• WRIM Wide Resistance Input Module
• RI Resistance Input Block
• RTI RTD Input Block
• RTTI RTD Transmitter Input Block

In addition, configuration choices for RTD type linearizations are not included in the following
Version 1 blocks (the version attribute for these blocks changed to version 2):
• LN Linearization Block (Linearization Type attribute does not include options for
platinum and nickel RTD sensors)
• VCIM Voltage/Current Input Module (was Thermocouple Type short state attribute 21,
TCTYPE, and is now Linearization Type long state attribute 28, TYPE)
• TIM Thermocouple Input Module (Cold Junction Compensation attribute does not
include options for NONE, RIM and WRIM)
• TI Thermocouple Input Block (Cold Junction Compensation Input attribute does not
exist)

A-2
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

APPENDIX B
MODBUS MASTER CONFIGURATION

B.1 OVERVIEW
Modbus Master communication functionality was introduced on the MODCELL Multiloop
Processor firmware (version 3.1 logic controller, version 2.1 regulatory controller) without
adding any new function blocks. This has been accomplished by adding new code and making
changes to the existing firmware in the MODCELL Serial Communication (MSC) (formerly
known as the Modbus Slave Communication) and Expression (EX) blocks. The attributes for
these blocks have not been changed in any way that required changes in the Application
Builder version 1 (the 1706S version 5.0B may be used as a configuration tool when at this
version level). Extended Modbus, requires the Application Builder version 2 or later software.

A MODBUS configuration requires a MSC block that is to be used as a MASTER and EX


blocks that are used to control reading and writing of data to any number of Modbus Slave
devices. The following MODBUS features are available:

RTU mode of transmission

Function codes:
1 Read Coil Status
2 Read Input Status
3 Read Holding Registers
4 Read Input Registers
5 Force Coil*
6 Preset Single Register*
15 Force Multiple Coils*
16 Preset Multiple Registers*
* Supports Global Writes.

Communication Parameters:
Slave Addr 1 to 247
Parity None, Odd, Even
Stop Bit 1 or 2
Baud Rate 150 to 38.4K

Communication Type:
RS232 2 Slot
RS485 1 Slot 2 Wire
RS485 2 Slot 2 Wire
RS485 2 Slot 4 Wire

When an RS485 communication bus is being used, the Modbus Master is responsible for
providing pull-up and pull-down resistors which will keep the bus in a MARK/IDLE state when
all the transmitters are tri-stated. Modbus Network installation instructions can be found in
IB-23C600 Issue 5 or later.

B-1
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.2 MODCELL SERIAL COMMUNICATION (MSC) BLOCK MODIFICATIONS


Configure an MSC block to be used as a MASTER. If the MSC block is version 2, just
configure the Port Functionality attribute to be Master using the Application Builder or ViZapp
Port Functionality configuration entry. This can also be done by writing the value 251 to the
MSC Command attribute from the status page after the database is downloaded into the
instrument (MSCx,CMD 251). This will allow the initialization required for the MSC block to be
a MASTER. To return the MSC block to a SLAVE simply write the value 252 to the MSC
Command attribute (MSCx,CMD 252). This will allow the initialization required for the MSC
block to be a SLAVE. These procedures only need to be done one time. Since a port can
easily be changed between MASTER and SLAVE you could have your logic configuration
transfer master control between multiple Modcell Multiloop Processors. When the MSC block
is a MASTER the List items in the MSC block are ignored.

B.3 EXPRESSION (EX) BLOCK MODIFICATIONS


Expression blocks can be configured to read data from Modbus Slave devices or write data to
Modbus Slave devices. This is done by configuring the EX block INPUT1 as an ASCII string
(UPPER CASE LETTERS) as follows:

CFG,MM,PORTz Modbus Master EX block used for configuration items. There must
be one of these blocks configured for each port used as a modbus master. See
section B.3.1

RCS,MM,PORTz Modbus Master EX block used to read the Coil Status (Discrete
Read/Write memory) area 00001 to 09999. See section B.3.2

RIS,MM,PORTz Modbus Master EX block used to read the Input Status (Discrete
Read Only memory) area 10001 to 19999. See section B.3.3

RIR,MM,PORTz Modbus Master EX block used to read the Input Register (Read Only
memory) area 30001 to 39999. See section B.3.4

RHR,MM,PORTz Modbus Master EX block used to read the Holding Register


(Read/Write memory) area 40001 to 49999. See section B.3.5

WRC,MM,PORTz Modbus Master EX block used to write one or more Coils


(Discretes) in memory area 00001 to 09999. See section B.3.6

WRR,MM,PORTz Modbus Master EX block used to write one or more Registers


(attributes) in memory area 40001 to 49999. See section B.3.7

Where z indicates which MSC port the EX block is associated with.


The value 1 indicates MSC1 which is connected to serial port 1.
The value 2 indicates MSC2 which is connected to serial port 2.
The value 3 indicates MSC3 which is connected to serial port 3.

The BAD INPUTS ACCEPTED attribute in the EX block is used as follows:

NO If the quality of any INPUT LSP used by the EX modbus master is bad, the
message will not be sent.

YES INPUT LSP qualities are not checked.

B-2
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

The Expression in the Expression block can still be used. The Modbus Master code will
execute first and then the expression will be evaluated.

When an Expression block is used for a Modbus Master interface it’s message handler routine
will not allow writes to attributes that are configuration parameters for the Modbus Master
function.

The EX block and the LOOP block it is under must both be in the RUN state for Modbus
Master message transactions to occur.

Messages are processed as follows:

Modbus is a half duplex protocol. Therefore, except for a global write message, the
master will send a message and wait for a response message or until a specified
timeout occurs.

If a global write message has been sent the driver will wait at least 100 msec plus the
configured INTER MESSAGE DELAY time before sending the next message.

Messages are queued up in the order that they are triggered by Modbus Master EX
blocks.

The MSC block executes every 50 msec. When it executes, if it is currently


transmitting a message or waiting for a response, it will do nothing. Otherwise, if a
response has been received it will mark it appropriately so the Modbus Master EX
block can process it when it executes. If the INTER MESSAGE DELAY is configured
for 0 and there is another message in the queue it will be sent. Else, the MSC block
will wait until the INTER MESSAGE DELAY is satisfied and there is a message in the
queue to be sent.

If no response is received from a slave for the NUMBER OF RETRIES configured the
driver will timeout all messages in the queue destined for this slave’s address. This
eliminates wasting time on a slave that is not on the bus.

MODBUS MASTER Read EX blocks will copy data read from a slave device into it’s
INPUT attribute storage locations when the EX block executes.

MODBUS MASTER Write EX blocks will copy the data from it’s INPUTS into the
message to be sent to the slave device when the EX block executes.

B-3
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

Modcell datatype to register mapping table:

The following table describes how many registers the Modcell data types use and how the
data is expected to be organized. See MODCELL Logic Controller Data Base Reference
Manual IB-23G600 Section 2.3.4 for further Data Type description.

MODCELL Data Type Remarks


Discrete Takes 1 register. Valid values are 0 and 1
Short State Takes 1 register. Valid values are 0 to 15
Long State Takes 1 register. Valid values are 0 to 255
Count Takes 1 register. Valid values are 0 to 65535
Date Takes 2 registers.
1st reg. bits 15-8 0
1st reg. bits 7-0 Year (0-99)
2nd reg. bits 15-8 Month (1-12)
2nd reg. bits 7-0 Day (1-31)
Floating Point Takes 2 registers.
32 bit data value in IEEE single precision floating point format
Millisecond Time Takes 2 registers.
32 bit unsigned integer with 1 millisecond resolution
ASCII Takes as many registers as needed.
The entry for input 1 must be all UPPER CASE (ASCII is case
sensetive)
Hex Takes as many registers as needed.

B-4
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

Message STATUS INFO values and descriptions:

Value Description
0 Valid response message received.

*1 Illegal MFC

*2 Illegal Data Addr

*3 Illegal Data Value

*4 Failure in associated device

*5 Acknowledge

*6 Busy, rejected message

*7 Nak-Negative Acknowledgment

*8 Memory parity error

241 At least one of the attributes that was read was out of it’s data type range.
For instance a value of 300 was read and the data type is long state
which allows 0 through 255. The input value will be set to it’s minimum
value or maximum value or left unchanged per CFG item OUT OF
RANGE VALUE READ.

242 Response message invalid; it was not the expected response to the
message that was sent.

243 Response message CRC error..

244 Response message communication error; such as: parity, framing,


overrun or break.

245 No response message from slave.

246 SLAVE ADDR or STARTING REGISTER NUMBER invalid. The message


was not sent.

247 This modbus master function of the EX block has just initialized.

248 Modbus Master Configuration error in this block, therefore this block will
not execute as a MASTER.

249 Out of RAM memory, therefore this block will not execute as a MASTER.

250 There is no Modbus Master EX block configured as CFG,MM,PORTz for


this port, therefore this block will not execute as a MASTER.

* These are standard Modbus protocol exception codes.

B-5
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.3.1 Configuration Items


There must be one of these expression blocks configured per modbus port. If there is not one
configured, the other Modbus Master EX blocks for this port will not execute as a MASTER.

The configuration of a Modbus Master EX block used to hold some configuration parameters
is defined as:

INPUT1 CFG,MM,PORTz Local ASCII CFG ONLY


Not writeable through message handler.

INPUT2 CFG ERROR OCCUR NUM Local Count


Not writeable through message handler.

Value 0 indicates there are no EX blocks used for modbus master with a
configuration error.

Value 65534 indicates there is more than one of these EX blocks configured
for this modbus master port; therefore, this one is not used.

Value 65535 indicates the port that this EX block is configured for is not a
modbus master port.

Else, this is the occurrence number of the first Ex block found with a
configuration error.

INPUT3 OUT OF RAM OCCUR NUM Local Count


Not writeable through message handler.

Value 0 indicates there are no EX blocks used for modbus master that did not
get ram allocated to it.

Value 65534 indicates there is more than one of these EX blocks configured
for this modbus master port; therefore, this one is not used.

Value 65535 indicates the port that this EX block is configured for is not a
modbus master port.

Else, this is the occurrence number of the first Ex block that there was not
enough ram to allocate for it.

INPUT4 RAM SPACE REMAINING Local Count


Not writeable through message handler.

Value 65534 indicates there is more than one of these EX blocks configured
for this modbus master port; therefore, this one is not used.

Value 65535 indicates the port that this EX block is configured for is not a
modbus master port.

Else, this is the number of ram bytes remaining which can be used for EX
modbus master blocks. There are a total of 3000 bytes available.

B-6
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

INPUT5 NUM OF MM EX BLKS CFGD OK Local Count


Not writeable through message handler.

This value indicates the number of Modbus Master EX blocks that are
configured with no errors and have ram space allocated.

Value 65534 indicates there is more than one of these EX blocks configured
for this modbus master port; therefore, this one is not used.

Value 65535 indicates the port that this EX block is configured for is not a
modbus master port.

INPUT6 RESPONSE TIMEOUT Local Long State


This parameter specifies the amount of time (in 50 ms units) that the driver
waits for a response message from the slave device. Valid values are 2
through 255. If there are more than one of these EX blocks in the database
the lowest occurrence number EX block will be used.

Determine the maximum time the various slave devices take to respond to a
message (a Modcell Multiloop Processor will respond within 100 milliseconds
and a Modcell 2050R will respond within 250 miliseconds). Next, determine
the RIR (Read Input Register) or RHR (Read Holding Register) message that
requests the largest number of registers for each of the different slave
devices. Now use the following formula to calculate the response timeout for
each slave device (use the largest value plus some additional slop time).

BAUDRATE BUS TIME PER CHARACTER (12 bits maximum)


38400 0.312 milliseconds
19200 0.625 milliseconds
9600 1.250 milliseconds
4800 2.500 milliseconds
2400 5.000 milliseconds
1200 10.000 milliseconds
600 20.000 milliseconds
300 40.000 milliseconds
150 80.000 milliseconds

OVERHEAD = 8.5 Characters (addr, mfc, byte cnt, 2 crc, 3.5 char idle for
EOM)
TOTAL # CHARACTERS = (Number Registers Requested x 2) +
OVERHEAD
BUS TIME = TOTAL # CHARACTERS x BUS TIME PER CHARACTER
TOTAL RESPONSE TIME = BUS TIME + Respone Time of Slave Device +
Slop
RESPONSE TIMEOUT VALUE = TOTAL RESPONSE TIME / 50

INPUT7 NUMBER OF RETRIES Local Long State


This parameter specifies the number of times a message should be re-sent to
a slave following an invalid or no response message from the slave. Valid
values are 0 through 255.

B-7
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

If no response is received from a slave all other messages that are currently
queued up for that slave address will be marked as no response and removed
from the queue. This will help wasting too much time on a slave device that is
no longer functioning.

If there are more than one of these EX blocks in the database the lowest
occurrence number EX block will be used.

INPUT8 INTER MESSAGE DELAY Local Long State


This parameter specifies the amount of time (in 50 ms units) that the driver
waits after a previous transaction has completed before sending another
message. Valid values are 0 through 255.

If there are more than one of these EX blocks in the database the lowest
occurrence number EX block will be used.

INPUT9 OUT OF RANGE VALUE READ Local Long State


This parameter specifies what should be done with an attribute’s value when
the register value that is read from a slave is out of the attribute’s data type
range. For instance a value of 300 was read and the data type is long state
which allows 0 through 255.

If there are more than one of these EX blocks in the database the lowest
occurrence number EX block will be used.

Valid values are 0, 1 or 2.


Value 0 indicates the input value should be left unchanged.
Value 1 indicates the input value should be set to minimum.
Value 2 indicates the input value should be set to maximum.

Data Type Minimum Value Maximum Value


DISCRETE 0 1
SHORT STATE 0 15
LONG STATE 0 255
DATE JAN 1, 1990 DEC 31, 2089
ASCII & HEX Significant Significant length set to field size - 1.
length set to 0 Extra bytes are truncated.

INPUT10 SINGLE WRITE FUNCTION CODE Local Long State


This parameter specifies which Modbus function code should be used when
writing 1 coil or register. Valid value are 0 and 1.

Value 0 indicates the Modbus code 5 (force single coil) or Modbus code 6
(preset single register) should be used.

Value 1 indicates the Modbus code 15 (force multiple coils) or Modbus code
16 (preset multiple registers) should be used.

If there are more than one of these EX blocks in the database the lowest
occurrence number EX block will be used.

B-8
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.3.2 Read Coil Status


The configuration of a Modbus Master EX block used to read the Coil Status (Discrete
Read/Write memory) area 00001 to 09999 is defined as:

INPUT1 RCS,MM,PORTz Local ASCII CFG ONLY


Not writeable through message handler.

INPUT2 NUMBER READ ATTRIBUTES Local Count CFG ONLY


Not writeable through message handler.

This value is the number of attribute values that should be read and stored at
this block’s INPUT11 through INPUTn. Valid values are 1 through 2000.

INPUT3 STATUS INFO Local Long State


Not writeable through message handler.

See Message STATUS INFO values and descriptions above.

INPUT4 MESSAGE QUALITY Local Discrete


Not writeable through message handler.

GOOD (0) if a valid response message was received.


BAD (1) if a valid response message was not received.

INPUT5 MESSAGE ACTIVE Local Discrete


Not writeable through message handler.

Specifies whether the message transaction has been completed. The value
will be set to 1 (TRUE) when the message is triggered and remains set until
the transaction is complete or until failure is determined.

INPUT6 RESERVED Local Long State


Not writeable through message handler.

IF REFRESH STATE = 0
Previous send input value. Used in detecting low->high trip transaction.

ELSE IF REFRESH STATE = 255


This value is not used.

ELSE IF REFRESH STATE = 1 through 254


This value will get set equal to the REFRESH STATE value and decrement
by 1 each time this block executes. When it gets to 0 the read message is
sent to the slave. This value will remain at 0 until a response message is
received or the message times out. It will then repeat the cycle again.

B-9
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

INPUT7 REFRESH STATE Local Long State


Support for the value of 255 was added in the release of Logic Controller
version 5 and Advanced Controller version 2.

IF REFRESH STATE = 0
Value 0 indicates the SEND INPUT is used and INPUT8 (SEND INPUT) must
be configured. The value 0 can only be written through the message handler
if the SEND INPUT is present.

ELSE IF REFRESH STATE = 255


If the SEND INPUT value is NONE or is TRUE, this message is sent to the
slave device.

ELSE IF REFRESH STATE = 1 through 254


This is how many times this block should execute before this message is sent
to the slave device. SEND INPUT value is not used.

INPUT8 SEND INPUT LSP, Local Data or NONE Discrete

IF REFRESH STATE = 0
This input must be present. This signal is used to trigger this EX block’s
message. Signal is edge trigged, 0 (FALSE) to 1 (TRUE). Send input triggers
are ignored while this message transaction is ACTIVE.

ELSE IF REFRESH STATE = 255


If this value is NONE or is TRUE, this message is sent to the slave device.

ELSE IF REFRESH STATE = 1 through 254


This value is not used.

INPUT9 SLAVE ADDR LSP or Local Data Long State


Values can be 1 to 247.

INPUT10 STARTING COIL NUMBER LSP or Local Data Count


Values can be: 1 - 9999 Modbus function code 1

INPUT11 through INPUTn Local Discrete only


This is where the data read from the slave device is stored.

INPUT11 will contain the value from the STARTING COIL NUMBER,
INPUT12 will contain the value from the next coil etc.

B-10
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.3.3 Read Input Status


The configuration of a Modbus Master EX block used to read the Input Status (Discrete Read
Only memory) area 10001 to 19999 is defined as:

INPUT1 RIS,MM,PORTz Local ASCII CFG ONLY


Not writeable through message handler.

INPUT2 NUMBER READ ATTRIBUTES Local Count CFG ONLY


Not writeable through message handler.

This value is the number of attribute values that should be read and stored at
this block’s INPUT11 through INPUTn. Valid values are 1 through 2000.

INPUT3 STATUS INFO Local Long State


Not writeable through message handler.

See Message STATUS INFO values and descriptions above.

INPUT4 MESSAGE QUALITY Local Discrete


Not writeable through message handler.

GOOD (0) if a valid response message was received.


BAD (1) if a valid response message was not received.

INPUT5 MESSAGE ACTIVE Local Discrete


Not writeable through message handler.

Specifies whether the message transaction has been completed. The value
will be set to 1 (TRUE) when the message is triggered and remains set until
the transaction is complete or until failure is determined.

INPUT6 RESERVED Local Long State


Not writeable through message handler.

IF REFRESH STATE = 0
Previous send input value. Used in detecting low->high trip transaction.

ELSE IF REFRESH STATE = 255


This value is not used.

ELSE IF REFRESH STATE = 1 through 254


This value will get set equal to the REFRESH STATE value and decrement
by 1 each time this block executes. When it gets to 0 the read message is
sent to the slave. This value will remain at 0 until a response message is
received or the message times out. It will then repeat the cycle again.

B-11
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

INPUT7 REFRESH STATE Local Long State


Support for the value of 255 was added in the release of Logic Controller
version 5 and Advanced Controller version 2.

IF REFRESH STATE = 0
Value 0 indicates the SEND INPUT is used and INPUT8 (SEND INPUT) must
be configured. The value 0 can only be written through the message handler
if the SEND INPUT is present.

ELSE IF REFRESH STATE = 255


If the SEND INPUT value is NONE or is TRUE, this message is sent to the
slave device.

ELSE IF REFRESH STATE = 1 through 254


This is how many times this block should execute before this message is sent
to the slave device. SEND INPUT value is not used.

INPUT8 SEND INPUT LSP, Local Data or NONE Discrete

IF REFRESH STATE = 0
This input must be present. This signal is used to trigger this EX block’s
message. Signal is edge trigged, 0 (FALSE) to 1 (TRUE). Send input triggers
are ignored while this message transaction is ACTIVE.

ELSE IF REFRESH STATE = 255


If this value is NONE or is TRUE, this message is sent to the slave device.

ELSE IF REFRESH STATE = 1 through 254


This value is not used.

INPUT9 SLAVE ADDR LSP or Local Data Long State


Values can be 1 to 247.

INPUT10 STARTING COIL NUMBER LSP or Local Data Count


Values can be: 1 - 9999 Modbus function code 2

INPUT11 through INPUTn Local Discrete only


This is where the data read from the slave device is stored.

INPUT11 will contain the value from the STARTING COIL NUMBER,
INPUT12 will contain the value from the next coil etc.

B-12
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.3.4 Read Input Register


The configuration of a Modbus Master EX block used to read the Input Register (Read Only
memory) area 30001 to 39999 is defined as:

INPUT1 RIR,MM,PORTz Local ASCII CFG ONLY


Not writeable through message handler.

INPUT2 NUMBER READ ATTRIBUTES Local Count CFG ONLY


Not writeable through message handler.

This value is the number of attribute values that should be read and stored at
this block’s INPUT11 through INPUTn. The minimum value is 1. The
maximum value is dependent on the number of attributes that can be read
from 125 registers.

INPUT3 STATUS INFO Local Long State


Not writeable through message handler.

See Message STATUS INFO values and descriptions above.

INPUT4 MESSAGE QUALITY Local Discrete


Not writeable through message handler.

GOOD (0) if a valid response message was received.


BAD (1) if a valid response message was not received.

INPUT5 MESSAGE ACTIVE Local Discrete


Not writeable through message handler.

Specifies whether the message transaction has been completed. The value
will be set to 1 (TRUE) when the message is triggered and remains set until
the transaction is complete or until failure is determined.

INPUT6 RESERVED Local Long State


Not writeable through message handler.

IF REFRESH STATE = 0
Previous send input value. Used in detecting low->high trip transaction.

ELSE IF REFRESH STATE = 255


This value is not used.

ELSE IF REFRESH STATE = 1 through 254


This value will get set equal to the REFRESH STATE value and decrement
by 1 each time this block executes. When it gets to 0 the read message is
sent to the slave. This value will remain at 0 until a response message is
received or the message times out. It will then repeat the cycle again.

B-13
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

INPUT7 REFRESH STATE Local Long State


Support for the value of 255 was added in the release of Logic Controller
version 5 and Advanced Controller version 2.

IF REFRESH STATE = 0
Value 0 indicates the SEND INPUT is used and INPUT8 (SEND INPUT) must
be configured. The value 0 can only be written through the message handler
if the SEND INPUT is present.

ELSE IF REFRESH STATE = 255


If the SEND INPUT value is NONE or is TRUE, this message is sent to the
slave device.

ELSE IF REFRESH STATE = 1 through 254


This is how many times this block should execute before this message is sent
to the slave device. SEND INPUT value is not used.

INPUT8 SEND INPUT LSP, Local Data or NONE Discrete

IF REFRESH STATE = 0
This input must be present. This signal is used to trigger this EX block’s
message. Signal is edge trigged, 0 (FALSE) to 1 (TRUE). Send input triggers
are ignored while this message transaction is ACTIVE.

ELSE IF REFRESH STATE = 255


If this value is NONE or is TRUE, this message is sent to the slave device.

ELSE IF REFRESH STATE = 1 through 254


This value is not used.

INPUT9 SLAVE ADDR LSP or Local Data Long State


Values can be 1 to 247.

INPUT10 STARTING REGISTER NUMBER LSP or Local Data Count


Values can be: 1 - 9999 Modbus function code 4

INPUT11 through INPUTn Local Data Any Data Type


except momentary discrete
This is where the data read from the slave device is stored.

INPUT11 will contain the value from the STARTING REGISTER NUMBER.
Depending on the data type the data may be contained in multiple registers.
See Modcell datatype to register mapping table above.

B-14
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.3.5 Read Holding Register


The configuration of a Modbus Master EX block used to read the Holding Register
(Read/Write memory) area 40001 to 49999 is defined as:

INPUT1 RHR,MM,PORTz Local ASCII CFG ONLY


Not writeable through message handler.

INPUT2 NUMBER READ ATTRIBUTES Local Count CFG ONLY


Not writeable through message handler.

This value is the number of attribute values that should be read and stored at
this block’s INPUT11 through INPUTn. The minimum value is 1. The
maximum value is dependent on the number of attributes that can be read
from 125 registers.

INPUT3 STATUS INFO Local Long State


Not writeable through message handler.

See Message STATUS INFO values and descriptions above.

INPUT4 MESSAGE QUALITY Local Discrete


Not writeable through message handler.

GOOD (0) if a valid response message was received.


BAD (1) if a valid response message was not received.

INPUT5 MESSAGE ACTIVE Local Discrete


Not writeable through message handler.

Specifies whether the message transaction has been completed. The value
will be set to 1 (TRUE) when the message is triggered and remains set until
the transaction is complete or until failure is determined.

INPUT6 RESERVED Local Long State


Not writeable through message handler.

IF REFRESH STATE = 0
Previous send input value. Used in detecting low->high trip transaction.

ELSE IF REFRESH STATE = 255


This value is not used.

ELSE IF REFRESH STATE = 1 through 254


This value will get set equal to the REFRESH STATE value and decrement
by 1 each time this block executes. When it gets to 0 the read message is
sent to the slave. This value will remain at 0 until a response message is
received or the message times out. It will then repeat the cycle again.

B-15
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

INPUT7 REFRESH STATE Local Long State


Support for the value of 255 was added in the release of Logic Controller
version 5 and Advanced Controller version 2.

IF REFRESH STATE = 0
Value 0 indicates the SEND INPUT is used and INPUT8 (SEND INPUT) must
be configured. The value 0 can only be written through the message handler
if the SEND INPUT is present.

ELSE IF REFRESH STATE = 255


If the SEND INPUT value is NONE or is TRUE, this message is sent to the
slave device.

ELSE IF REFRESH STATE = 1 through 254


This is how many times this block should execute before this message is sent
to the slave device. SEND INPUT value is not used.

INPUT8 SEND INPUT LSP, Local Data or NONE Discrete

IF REFRESH STATE = 0
This input must be present. This signal is used to trigger this EX block’s
message. Signal is edge trigged, 0 (FALSE) to 1 (TRUE). Send input triggers
are ignored while this message transaction is ACTIVE.

ELSE IF REFRESH STATE = 255


If this value is NONE or is TRUE, this message is sent to the slave device.

ELSE IF REFRESH STATE = 1 through 254


This value is not used.

INPUT9 SLAVE ADDR LSP or Local Data Long State


Values can be 1 to 247.

INPUT10 STARTING REGISTER NUMBER LSP or Local Data Count


Values can be: 1 - 9999 Modbus function code 3

INPUT11 through INPUTn Local Data Any Data Type


except momentary discrete
This is where the data read from the slave device is stored.

INPUT11 will contain the value from the STARTING REGISTER NUMBER.
Depending on the data type the data may be contained in multiple registers.
See Modcell datatype to register mapping table above.

B-16
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.3.6 Write One or More Coils


The configuration of a Modbus Master EX block used to write one or more Coils (Discretes) in
memory area 00001 to 09999 is defined as:

INPUT1 WRC,MM,PORTz Local ASCII CFG ONLY


Not writeable through message handler.

INPUT2 NUMBER WRITE ATTRIBUTES Local Count CFG ONLY


Not writeable through message handler.

This value is the number of attribute values that should be written. The values
to be written are stored at this block’s INPUT11 through INPUTn. Valid values
are 1 through 2000.

INPUT3 STATUS INFO Local Long State


Not writeable through message handler.

See Message STATUS INFO values and descriptions above.

INPUT4 MESSAGE QUALITY Local Discrete


Not writeable through message handler.

GOOD (0) if a valid response message was received.


BAD (1) if a valid response message was not received.

INPUT5 MESSAGE ACTIVE Local Discrete


Not writeable through message handler.

Specifies whether the message transaction has been completed. The value
will be set to 1 (TRUE) when the message is triggered and remains set until
the transaction is complete or until failure is determined.

INPUT6 RESERVED Local Long State


Not writeable through message handler.

IF REFRESH STATE = 0
Previous send input value. Used in detecting low->high trip transaction.

ELSE IF REFRESH STATE = 255


This value is not used.

ELSE IF REFRESH STATE = 1 through 254


This value will get set equal to the REFRESH STATE value and decrement
by 1 each time this block executes. When it gets to 0 the read message is
sent to the slave. This value will remain at 0 until a response message is
received or the message times out. It will then repeat the cycle again.

B-17
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

INPUT7 REFRESH STATE Local Long State


Support for the value of 255 was added in the release of Logic Controller
version 5 and Advanced Controller version 2.

IF REFRESH STATE = 0
Value 0 indicates the SEND INPUT is used and INPUT8 (SEND INPUT) must
be configured. The value 0 can only be written through the message handler
if the SEND INPUT is present.

ELSE IF REFRESH STATE = 255


If the SEND INPUT value is NONE or is TRUE, this message is sent to the
slave device.

ELSE IF REFRESH STATE = 1 through 254


This is how many times this block should execute before this message is sent
to the slave device. SEND INPUT value is not used.

INPUT8 SEND INPUT LSP, Local Data or NONE Discrete

IF REFRESH STATE = 0
This input must be present. This signal is used to trigger this EX block’s
message. Signal is edge trigged, 0 (FALSE) to 1 (TRUE). Send input triggers
are ignored while this message transaction is ACTIVE.

ELSE IF REFRESH STATE = 255


If this value is NONE or is TRUE, this message is sent to the slave device.

ELSE IF REFRESH STATE = 1 through 254


This value is not used.

INPUT9 SLAVE ADDR LSP or Local Data Long State


Values can be 0 to 247. Global addr 0 is supported.

INPUT10 STARTING COIL NUMBER LSP or Local Data Count


Values can be: 1 - 9999

Modbus function code 5 or 15 as required.

INPUT11 through INPUTn DATA LSP or Local Data Discrete only


This is the data which will be written to the slave device.

INPUT11 will contain the value for the STARTING COIL NUMBER, INPUT12
will contain the value for the next coil etc.

If one discrete attribute is to be written the Modbus function code 5 or 15 is


used per CFG item SINGLE WRITE FUNCTION CODE. If more than one
discrete attribute is to be written the Modbus function code 15 is used.

B-18
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.3.7 Write One or More Registers


The configuration of a Modbus Master EX block used to write one or more attributes in
memory area 40001 to 49999 is defined as:

INPUT1 WRR,MM,PORTz Local ASCII CFG ONLY


Not writeable through message handler.

This value is the number of attribute values that should be written. The values
to be written are stored at this block’s INPUT11 through INPUTn. The
minimum value is 1. The maximum value is dependent on the number of
attributes that can fit in 127 registers.

INPUT2 NUMBER WRITE ATTRIBUTES Local Count CFG ONLY


Not writeable through message handler.

Indicates the number of write attributes in this expression block.

INPUT3 STATUS INFO Local Long State


Not writeable through message handler.

See Message STATUS INFO values and descriptions above.

INPUT4 MESSAGE QUALITY Local Discrete


Not writeable through message handler.

GOOD (0) if a valid response message was received.


BAD (1) if a valid response message was not received.

INPUT5 MESSAGE ACTIVE Local Discrete


Not writeable through message handler.

Specifies whether the message transaction has been completed. The value
will be set to 1 (TRUE) when the message is triggered and remains set until
the transaction is complete or until failure is determined.

INPUT6 RESERVED Local Long State


Not writeable through message handler.

IF REFRESH STATE = 0
Previous send input value. Used in detecting low->high trip transaction.

ELSE IF REFRESH STATE = 255


This value is not used.

ELSE IF REFRESH STATE = 1 through 254


This value will get set equal to the REFRESH STATE value and decrement
by 1 each time this block executes. When it gets to 0 the read message is
sent to the slave. This value will remain at 0 until a response message is
received or the message times out. It will then repeat the cycle again.

B-19
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

INPUT7 REFRESH STATE Local Long State


Support for the value of 255 was added in the release of Logic Controller
version 5 and Advanced Controller version 2.

IF REFRESH STATE = 0
Value 0 indicates the SEND INPUT is used and INPUT8 (SEND INPUT) must
be configured. The value 0 can only be written through the message handler
if the SEND INPUT is present.

ELSE IF REFRESH STATE = 255


If the SEND INPUT value is NONE or is TRUE, this message is sent to the
slave device.

ELSE IF REFRESH STATE = 1 through 254


This is how many times this block should execute before this message is sent
to the slave device. SEND INPUT value is not used.

INPUT8 SEND INPUT LSP, Local Data or NONE Discrete

IF REFRESH STATE = 0
This input must be present. This signal is used to trigger this EX block’s
message. Signal is edge trigged, 0 (FALSE) to 1 (TRUE). Send input triggers
are ignored while this message transaction is ACTIVE.

ELSE IF REFRESH STATE = 255


If this value is NONE or is TRUE, this message is sent to the slave device.

ELSE IF REFRESH STATE = 1 through 254


This value is not used.

INPUT9 SLAVE ADDR LSP or Local Data Long State


Values can be 0 to 247. Global addr 0 is supported.

INPUT10 STARTING REGISTER NUMBER LSP or Local Data Count


Values can be: 1 - 9999
Modbus function code 6 or 16 as required.

INPUT11 through INPUTn DATA LSP or Local Data Any Data Type
except momentary discrete
This is the data which will be written to the slave device. See Modcell
datatype to register mapping table above.
INPUT11 will contain the value for the STARTING REGISTER NUMBER.
Depending on the data type the data may be put into multiple registers. See
Modcell datatype to register mapping table above.
If the data fits in 1 register Modbus function code 6 or 16 is used per CFG
item SINGLE WRITE FUNCTION CODE. If more than 1 register is to be
written the Modbus function code 16 is used.

B-20
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.4 EXAMPLES

B.4.1 Example 1

NOTE: The entry for input 1 must be all UPPER CASE (ASCII is case sensetive).

EX1

Input Data Type Value


I1 ASCII CFG,MM,PORT1
I2 Count 0
I3 Count 0
I4 Count 0
I5 Count 0
I6 Long State 20 ( response timeout = 1 second )
I7 Long State 1 ( number of retries = 1 )
I8 Long State 0 ( inter msg delay = zero )
I9 Long State 1 ( out of range value = minimum )
I10 Long State 0 ( use single write mfc )

EX2
Read 10 Holding Registers from slave address 1 starting with register number 1 and store as
Count data in the MODCELL Multiloop Processor database.

Input Data Type Value


I1 ASCII RHR,MM,PORT1
I2 Count 10 ( num read attributes = 10 )
I3 Long State 0
I4 Discrete False
I5 Discrete False
I6 Long State 0
I7 Long State 20 ( if group scan interval is 100
msec this msg is sent every 2 seconds)
I8 (not used)
I9 Long State 1 ( slave addr = 1 )
I10 Count 1 ( starting reg num = 1 )
I11 Count 0 ( stored data from reg num 40001 )
I12 Count 0 ( stored data from reg num 40002 )
I13 Count 0 ( stored data from reg num 40003 )
I14 Count 0 ( stored data from reg num 40004 )
I15 Count 0 ( stored data from reg num 40005 )
I16 Count 0 ( stored data from reg num 40006 )
I17 Count 0 ( stored data from reg num 40007 )
I18 Count 0 ( stored data from reg num 40008 )
I19 Count 0 ( stored data from reg num 40009 )
I20 Count 0 ( stored data from reg num 40010 )

EX3
Write 8 Discrete Values to slave address 3 starting with coil 1.

Input Data Type Value


I1 ASCII WRC,MM,PORT1
I2 Count 8 ( num write attributes = 8 )
I3 Long State 0
I4 Discrete False
I5 Discrete False
I6 Long State 0
I7 Long State 0
I8 ( triggered by discrete LSP EX3,R)
I9 Long State 3 ( slave addr = 3 )
I10 Count 1 ( starting coil num = 1 )

B-21
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

I11 ( LSP DIM1,R written to coil 00001)


I12 ( LSP DIM2,R written to coil 00002)
I13 ( LSP DIM3,R written to coil 00003)
I14 ( LSP DIM4,R written to coil 00004)
I15 ( LSP DIM5,R written to coil 00005)
I16 ( LSP DIM6,R written to coil 00006)
I17 ( LSP DIM7,R written to coil 00007)
I18 ( LSP DIM8,R written to coil 00008)

EX4
Read 10 Discrete (coils) from slave address 4 starting with coil 21 and store as discrete data in the
MODCELL Multiloop Processor database.

Input Data Type Value


I1 ASCII RCS,MM,PORT1
I2 Count 10 ( num read attributes = 10 )
I3 Long State 0
I4 Discrete False
I5 Discrete False
I6 Long State 0
I7 Long State 30 ( if group scan interval is 100
msec this msg is sent every 3 seconds)
I8 (not used)
I9 Long State 4 ( slave addr = 4 )
I10 Count 21 ( starting coil num = 21 )
I11 Discrete False ( stored data from coil num 00021 )
I12 Discrete False ( stored data from coil num 00022 )
I13 Discrete False ( stored data from coil num 00023 )
I14 Discrete False ( stored data from coil num 00024 )
I15 Discrete False ( stored data from coil num 00025 )
I16 Discrete False ( stored data from coil num 00026 )
I17 Discrete False ( stored data from coil num 00027 )
I18 Discrete False ( stored data from coil num 00028 )
I19 Discrete False ( stored data from coil num 00029 )
I20 Discrete False ( stored data from coil num 00030 )

EX5
Write 1 Count Value to slave address 4, Register 12

Input Data Type Value


I1 ASCII WRR,MM,PORT1
I2 Count 1 ( num write attributes = 1 )
I3 Long State 0
I4 Discrete False
I5 Discrete False
I6 Long State 0
I7 Long State 0
I8 ( triggered by discrete LSP EX5,R)
I9 Long State 4 ( slave addr = 4 )
I10 Count 12 ( starting reg num = 12 )
I11 Count 0 ( count written to register 40012 )

B-22
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

B.4.2 Example 2

NOTE: The entry for input 1 must be all UPPER CASE (ASCII is case sensetive).

EX1

Input Data Type Value


I1 ASCII CFG,MM,PORT1
I2 Count 0
I3 Count 0
I4 Count 0
I5 Count 0
I6 Long State 20 ( response timeout = 1 second )
I7 Long State 1 ( number of retries = 1 )
I8 Long State 0 ( inter msg delay = zero )
I9 Long State 1 ( out of range value = minimum )
I10 Long State 0 ( use single write mfc )

EX2
Read 10 Floating Point values from 20 Holding Registers in slave address 2 starting with register
number 1001 and store as Floating Point data in the MODCELL Multiloop Processor database.

Input Data Type Value


I1 ASCII RHR,MM,PORT1
I2 Count 10 ( num read attributes = 10 )
I3 Long State 0
I4 Discrete False
I5 Discrete False
I6 Long State 0
I7 Long State 0
I8 (triggered by discrete LSP EX2,R )
I9 Long State 2 (slave addr = 2 )
I10 Count 1001 (starting reg num = 1001 )
I11 Floating Point 0 (stored data from reg num 41001-2)
I12 Floating Point 0 (stored data from reg num 41003-4)
I13 Floating Point 0 (stored data from reg num 41005-6)
I14 Floating Point 0 (stored data from reg num 41007-8)
I15 Floating Point 0 (stored data from reg num 41009-10)
I16 Floating Point 0 (stored data from reg num 41011-12)
I17 Floating Point 0 (stored data from reg num 41013-14)
I18 Floating Point 0 (stored data from reg num 41015-16)
I19 Floating Point 0 (stored data from reg num 41017-18)
I20 Floating Point 0 (stored data from reg num 41019-20)

EX3
Write 9 different data types to slave address 3 starting with register number 1001.

Input Data Type Value


I1 ASCII WRR,MM,PORT1
I2 Count 9 ( num write attributes = 9 )
I3 Long State 0
I4 Discrete False
I5 Discrete False
I6 Long State 0
I7 Long State 0
I8 (triggered by discrete LSP EX3,R )
I9 Long State 3 (slave addr = 3 )
I10 Count 1001 (starting reg num = 1001 )
I11 Discrete true (written to reg num 41001)
I12 Short State 3 (written to reg num 41002)
I13 Long State 150 (written to reg num 41003)

B-23
Logic Functions - Book 1

APPENDIX B - MODBUS MASTER CONFIGURATION

I14 Count 2000 (written to reg num 41004)


I15 Date M,03/22/94 (written to reg num 41005-6)
I16 Floating Point 99230.0 (written to reg num 41007-8)
I17 Millisecond Time 11:23:45.000 (written to reg num 41009-10)
I18 ASCII This is Recipe 7 (written to reg num 41011-19)
I19 Hex 01030507090B0D0F (written to reg num 41020-24)

B-24
Logic Functions - Book 1

APPENDIX C - BLOCK DATA

APPENDIX C
BLOCK DATA

C.1 GENERAL
This block data is provided to aid users needing to interpret the address of a database
attribute. A full description of the LSP (Logical Source Pointer) four byte address is given in
IB-23G001, Programmers Guide for ICN Communication Link.
Table C-1. Block Data
Block Name Block Code Block Type Max. No.
Interface 01 IF 1
System Event 02 SE 1
ICN Module 03 ICN 3
Omega Clock 04 OMC 1
Event Sequence 05 ES 1
Loop 06 LP 64
Configured List 07 CL 4096
Notification Message 09 NM 4096
Timer 10 TM 4096
Totalizer 11 TOT 4096
Linearization 12 LN 4096
Piecewise Table 13 PW 4096
Process Alarm 14 PA 4096
Expression 15 EX 4096
Input Communication 16 IC 32
Output Communication 17 OC 32
Digital Input 18 DI 4096
Voltage Current Input 19 VCI 4096
Cold Junction Input 20 CJI 4096
Thermocouple Input 21 TI 4096
TC Transmitter Input 22 TTI 4096
Digital Input Module 23 DIM 32
Digital Output Module 24 DOM 32
Dual Digital Output Module 25 DDOM 16
Wide Digital Output Module 26 WDOM 16
Voltage/Current Input Module 27 VCIM 32
Cold Junction Input Module 28 CJIM 32
Thermocouple Input Module 29 TIM 32

C-1
Logic Functions - Book 1

APPENDIX C - BLOCK DATA

Table C-1. Block Data (Cont’d)


Block Name Block Code Block Type Max. No.
Analog Output Module 30 AOM 32
RTD Input 31 RTI 4096
Resistance Input Module 32 RIM 32
RTD Transmitter Input 33 RTTI 4096
Wide Resistance Input Module 34 WRIM 16
PID Control 35 PID 4096
Resistance Input 36 RI 4096
Modbus Slave Communication 37 MSC 3
Modbus List 38 ML 4096
Supervisory Message 39 SM 4096
Sequence 40 SEQ 4096
CS31 Interface Module 41 RIO 16
Remote Digital Input Module 42 RDIM 31
Remote Digital Output Module 43 RDOM 31
Onboard Analog Input 48 AIN 2
Onboard Analog Output 49 AOUT 2
Display 50 DISP 4096
Display Interface 51 DIF 1
Process Alarm Display 52 PAD 4096
Tuning List 53 TL 4096
State Table 54 ST 1
Template 55 TMPL 1
Ramp/Soak 56 RSK 4096

C-2
The Company’s policy is one of continuous product improvement and the right
is reserved to modify the information contained herein without notice, or to
make engineering refinements that may not be reflected in this bulletin.
Micromod Automation assumes no responsibility for errors that may appear in
this manual.
© 2004 MicroMod Automation, Inc. Printed in USA

IB-23G600, Issue 10 3/2005

MicroMod Automation, Inc.


75 Town Center Drive
Rochester, NY USA 14623
Tel. 585-321-9200
Fax 585-321-9291
www.micromodautomation.com

You might also like