K01 000 04 PDF
K01 000 04 PDF
K01 000 04 PDF
6
Block Library LL984
10/2006
33002261.04
2
Table of Contents
Safety Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Chapter 1 Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Parameter Assignment of Instuctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3
Chapter 4 Formatting Messages for ASCII READ/WRIT Operations . . . 59
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Formatting Messages for ASCII READ/WRIT Operations . . . . . . . . . . . . . . . . . . 60
Format Specifiers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Special Set-up Considerations for Control/Monitor Signals Format. . . . . . . . . . . 64
4
Chapter 13 BLKM: Block Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
5
Chapter 21 DCTR: Down Counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Short Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
6
Chapter 28 EMTH-ADDDP: Double Precision Addition . . . . . . . . . . . . . . 159
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Parameter Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
7
Chapter 35 EMTH-CHSIN: Changing the Sign of a
Floating Point Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Short Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
8
Chapter 42 EMTH-COS: Floating Point Cosine of an Angle
(in Radians) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Parameter Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
9
Chapter 49 EMTH-LNFP: Floating Point Natural Logarithm . . . . . . . . . . 243
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Short Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
10
Chapter 56 EMTH-POW: Raising a Floating Point Number to an
Integer Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Parameter Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
11
Chapter 63 EMTH-SUBFP: Floating Point Subtraction . . . . . . . . . . . . . . 299
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Short Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
12
Chapter 69 FOUT: First Out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Parameter Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
13
Chapter 76 IE: Interrupt Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Short Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
14
Chapter 84 MAP 3: MAP Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Parameter Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
15
SY/MAX-specific Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
TCP/IP Ethernet Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
CTE Error Codes for SY/MAX and TCP/IP Ethernet . . . . . . . . . . . . . . . . . . . . . 494
16
Chapter 97 PCFL-AIN: Analog Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Parameter Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
17
Chapter 105 PCFL-KPID: Comprehensive ISA Non Interacting PID . . . . . 571
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
Short Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
18
Chapter 113 PCFL-PID: PID Algorithms . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Parameter Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
19
Chapter 120 PEER: PEER Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Short Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
20
Chapter 128 SCIF: Sequential Control Interfaces . . . . . . . . . . . . . . . . . . . . 683
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Parameter Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
21
Chapter 134 SU16: Subtract 16 Bit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Short Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
22
Chapter 142 TBLK: Table to Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
At a Glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Short Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Parameter Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
23
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
24
Safety Information
§
Important Information
NOTICE Read these instructions carefully, and look at the equipment to become familiar with
the device before trying to install, operate, or maintain it. The following special
messages may appear throughout this documentation or on the equipment to warn
of potential hazards or to call attention to information that clarifies or simplifies a
procedure.
The addition of this symbol to a Danger or Warning safety label indicates
that an electrical hazard exists, which will result in personal injury if the
instructions are not followed.
This is the safety alert symbol. It is used to alert you to potential personal
injury hazards. Obey all safety messages that follow this symbol to avoid
possible injury or death.
DANGER
DANGER indicates an imminently hazardous situation, which, if not avoided, will
result in death, serious injury, or equipment damage.
WARNING
WARNING indicates a potentially hazardous situation, which, if not avoided, can result
in death, serious injury, or equipment damage.
CAUTION
CAUTION indicates a potentially hazardous situation, which, if not avoided, can result
in injury or equipment damage.
33002261 25
Safety Information
PLEASE NOTE Electrical equipment should be serviced only by qualified personnel. No responsi-
bility is assumed by Schneider Electric for any consequences arising out of the use
of this material. This document is not intended as an instruction manual for untrained
persons.
© 2005 Schneider Electric. All Rights Reserved.
26 33002261
About the Book
At a Glance
Document Scope This documentation will help you configure the LL984-instructions from Concept.
Validity Note This documentation is valid for Concept 2.6 under Microsoft Windows 98, Microsoft
Windows 2000, Microsoft Windows XP and Microsoft Windows NT 4.x.
Note: For additional up-to-date notes, please refer to the file README of Concept.
Related You can download these technical publications and other technical information from
Documents our website at www.telemecanique.com
User Comments We welcome your comments about this document. You can reach us by e-mail at
[email protected]
33002261 27
About the Book
28 33002261
General Information
I
Introduction
At a Glance In this part you will find general information about the instruction groups and the use
of instructions.
33002261 29
General Information
30 33002261
Instructions
1
Parameter Assignment of Instructions
General Programming for electrical controls involves a user who implements Operational
Coded instructions in the form of visual objects organized in a recognizable ladder
form. The program objects designed, at the user level, is converted to computer
usable OP codes during the download process. the Op codes are decoded in the
CPU and acted upon by the controllers firmware functions to implement the desired
control.
Each instruction is composed of an operation, nodes required for the operation and
in- and outputs.
33002261 31
Instructions
bottom node
Nodes, In- and The nodes and in- and outputs determines what the operation will be executed with.
Outputs
32 33002261
Instruction Groups
2
At a Glance
Introduction In this chapter you will find an overwiew of the instruction groups and their
accompanying instructions.
33002261 33
Instruction Groups
Instruction Groups
34 33002261
Instruction Groups
ASCII Functions
PLCs that support ASCII messaging use instructions called READ and WRIT to
handle the sending of messages to display devices and the receiving of messages
from input devices. These instructions provide the routines necessary for
communication between the ASCII message table in the PLC’s system memory and
an interface module at the Remote I/O drops.
Further information you will find in the chapter Formatting Messages for ASCII
READ/WRIT Operations, p. 59.
Counters and The table shows the counters and timers instructions:
Timers
Instruction Meaning Available at PLC family
Instructions
Quantum Compact Momentum Atrium
UCTR Counts up from 0 to a yes yes yes no
preset value
DCTR Counts down from a yes yes yes no
preset value to 0
T1.0 Timer that increments in yes yes yes no
seconds
T0.1 Timer that increments in yes yes yes no
tenths of a second
T.01 Timer that increments in yes yes yes no
hundredths of a second
T1MS Timer that increments in yes yes yes no
one millisecond (CPU 242
02 only)
33002261 35
Instruction Groups
Fast I/O The following instructions are designed for a variety of functions known generally as
Instructions fast I/O updating:
Instruction Meaning Available at PLC family
Quantum Compact Momentum Atrium
BMDI Block move with interrupts yes yes no no
disabled
ID Disable interrupt yes yes no no
IE Enable interrupt yes yes no no
IMIO Immediate I/O instruction yes yes no no
IMOD Interrupt module yes no no no
instruction
ITMR Interval timer interrupt no yes no no
Further information you will find in the chapter Interrupt Handling, p. 67.
Note: The Fast I/O Instructions are only available after configuring a CPU without
extension.
36 33002261
Instruction Groups
Loadable DX
33002261 37
Instruction Groups
Math Instructions
Math Two groups of instructions that support basic math operations are available. The first
Instructions group comprises four integer-based instructions: ADD, SUB, MUL and DIV.
The second group contains five comparable instructions, AD16, SU16, TEST, MU16
and DV16, that support signed and unsigned 16-bit math calculations and
comparisons.
Three additional instructions, ITOF, FTOI and BCD, are provided to convert the
formats of numerical values (from integer to floating point, floating point to integer,
binary to BCD and BCD to binary). Conversion operations are usful in expanded
math.
Integer Based This part of the group provides the following instructions:
Instructions
Instruction Meaning Available at PLC family
Quantum Compact Momentum Atrium
ADD Addition yes yes yes no
DIV Division yes yes yes no
MUL Multiplication yes yes yes no
SUB Subtraction yes yes yes no
38 33002261
Instruction Groups
33002261 39
Instruction Groups
Matrix Instructions
Matrix A matrix is a sequence of data bits formed by consecutive 16-bit words or registers
Instructions derived from tables. DX matrix functions operate on bit patterns within tables.
Just as with move instructions, the minimum table length is 1 and the maximum table
length depends on the type of instruction you use and on the size of the CPU (24-
bit) in your PLC.
Groups of 16 discretes can also be placed in tables. The reference number used is
the first discrete in the group, and the other 15 are implied. The number of the first
discrete must be of the first of 16 type 000001, 100001, 000017, 100017, 000033,
100033, ... , etc..
This group provides the following instructions:
Instruction Meaning Available at PLC family
Quantum Compact Momentum Atrium
AND Logical AND yes yes yes no
BROT Bit rotate yes yes yes no
CMPR Compare register yes yes yes no
COMP Complement a matrix yes yes yes no
MBIT Modify bit yes yes yes no
NBIT Bit control yes yes no no
NCBT Normally open bit yes yes no no
NOBT Normally closed bit yes yes no no
OR Logical OR yes yes yes no
RBIT Reset bit yes yes no no
SBIT Set bit yes yes no no
SENS Sense yes yes yes no
XOR Exclusive OR yes yes yes no
40 33002261
Instruction Groups
Miscellaneous
33002261 41
Instruction Groups
Move Instructions
42 33002261
Instruction Groups
Skips/Specials
The SKP instruction is a standard instruction in all PLCs. It should be used with
caution.
DANGER
Inputs and outputs that normally effect control may be unintentionally
skipped (or not skipped).
SKP is a dangerous instruction that should be used carefully. If inputs and outputs
that normally effect control are unintentionally skipped (or not skipped), the result
can create hazardous conditions for personnel and application equipment.
Failure to follow this instruction will result in death or serious injury.
33002261 43
Instruction Groups
Special Instructions
Special These instructions are used in special situations to measure statistical events on the
Instructions overall logic system or create special loop control situations.
This group provides the following instructions:
Instruction Meaning Available at PLC family
Quantum Compact Momentum Atrium
DIOH Distributed I/O health yes no no no
PCFL Process control function yes yes no no
library
PID2 Proportional integral yes yes yes no
derivative
STAT Status yes yes yes no
Coils, Contacts Coils, Contacts and Interconnects are availabel at all PLC families:
and l Normal coil
Interconnects l Memory-retentive, or latched, coil
l Normally open (N.O.) contact
l Normally closed (N.C.) contact
l Positive transitional (P.T.) contact
l Negative transitional (N.T.) contact
l Horizontal Short
l Vertical Short
44 33002261
Closed Loop Control / Analog
Values
3
At a Glance
Introduction In this chapter you will find general information about configuring closed loop control
and using analog values.
33002261 45
Closed Loop Control / Analog Values
General An analog closed loop control system is one in which the deviation from an ideal
process condition is measured, analyzed and adjusted in an attempt to obtain and
maintain zero error in the process condition. Provided with the Enhanced Instruction
Set is a proportional-integral-derivative function block called PID2, which allows you
to establish closed loop (or negative feedback) control in ladder logic.
Definition of Set The desired (zero error) control point, which you will define in the PID2 block, is
Point and called the set point (SP). The conditional measurement taken against SP is called
Process Variable the process variable (PV). The difference between the SP and the PV is the
deviation or error (E). E is fed into a control calculation that produces a manipulated
variable (Mv) used to adjust the process so that PV = SP (and, therefore, E = 0).
Control
End Device
PV
Process
Process
Transmitter
Mv _
(Output) PV (Input)
Control
E
Calculation +
SP
46 33002261
Closed Loop Control / Analog Values
PCFL Subfunctions
General The PCFL instruction gives you access to a library of process control functions
utilizing analog values.
PCFL operations fall into three major categories:
l Advanced Calculations
l Signal Processing
l Regulatory Control
Advanced Advanced calculations are used for general mathematical purposes and are not
Calculations limited to process control applications. With advanced calculations, you can create
custom signal processing algorithms, derive states of the controlled process, derive
statistical measures of the process, etc.
Simple math routines have already been offered in the EMTH instruction. The
calculation capability included in PCFL is a textual equation calculator for writing
custom equations instead of programming a series of math operations one by one.
Signal Signal processing functions are used to manipulate process and derived process
Processing signals. They can do this in a variety of ways; they linearize, filter, delay and
otherwise modify a signal. This category would include functions such as an Analog
Input/Output, Limiters, Lead/Lag and Ramp generators.
33002261 47
Closed Loop Control / Analog Values
with
48 33002261
Closed Loop Control / Analog Values
YP = KP × XD Proportional bit ON
YP = 0
YI = 0
DXD = XD – X_1
( TD1 × YD ) + ( TD × KP × DXD ) Derivative bit ON
YD = -------------------------------------------------------------------------------------
∆t + TD1
YD = 0
33002261 49
Closed Loop Control / Analog Values
a)
PROPORTIONAL
GAIN
SET POINT
SP 0
b)
1
+ 1 1 = INTEGRAL ON
_ 0
- GAIN
0
1
1
0 c)
CONTROL
INPUT 1 1 = DERIVATIVE ON
X(n) 0
0 = base Derivative on XD
1 = PROPORTION ON 1 = base Derivative on X
a)
DERVATIVE
Contributions
TD
c)
SUMMING
JUNCTION
MODE SELECT
50 33002261
Closed Loop Control / Analog Values
A PID Example
Description This example illustrates how a typical PID loop could be configured using PCFL
function PID. The calculation begins with the AIN function, which takes raw input
simulated to cause the output to run between approximately 20 and 22 when the
engineering unit scale is set to 0 ... 100.
LL984 Ladder Diagram
T0.1
# 14 # 39 # 14 #8 # 44 #9
The process variable over time should look something like this:
Process Variable Value
22
20
Time
33002261 51
Closed Loop Control / Analog Values
Main PID Ladder The AIN output is block moved to the LKUP function, which is used to scale the input
Logic signal. We do this because the input sensor is not likely to produce highly linear
readings; the result is an ideal linear signal:
7 Points Defined
In Look Up table
100 *
80 *
60 *
Linearized Signal
50 *
40 Actual Input
*
20
0 * Input
20 40 50 60 80 100
The look-up table output is block moved to the PID function. RAMP is used to control
the rise (or fall) of the set point for the PID controller with regard to the rate of ramp
and the solution interval. In this example, the set point is established in another logic
section to simulate a remote setting. The MODE function is placed after the RAMP
so that we can switch between the RAMP-generated set point or a manual value.
52 33002261
Closed Loop Control / Analog Values
Simulated The PID function is actually controlling the process simulated by this logic (value in
Process 400100: 878(Dec)):
T0.1
The process simulator is comprised of two LLAG functions that act as a filter and
input to a DELAY queue that is also a PCFL function block. This arrangement is the
equivalent of a second-order process with dead time.
The solution intervals for the LLAG filters do not affect the process dynamics and
were chosen to give fast updates. The solution interval for the DELAY queue is set
at 1000 ms with a delay of 5 intervals,i.e. 5 s. The LLAG filters each have lead terms
of 4 s and lag terms of 10 s. The gain for each is 1.0.
In process control terms the transfer function can be expressed as:
–5S
( 4S + 1 ) ( 4S + 1 )e
Gp(S) = -----------------------------------------------------
( 10S + 1 ) ( 10S + 1 )
The AOUT function is used only to convert the simulated process output control
value into a range of 0 ... 4 095, which simulates a field device. This integer signal
is used as the process input in the first network.
33002261 53
Closed Loop Control / Analog Values
PID Parameters The PID controller is tuned to control this process at 20.0, using the Ziegler-Nichols
tuning method. The resulting controller gain is 2.16, equivalent to a proportional
band of 46.3%.
The integral time is set at 12.5 s/repeat (4.8 repeats/ min). The derivative time is
initially 3 s, then reduced to 0.3 s to de-emphasize the derivative effect.
An AOUT function is used after the PID. It conditions the PID control output by
scaling the signal back to an integer for use as the control value.
The entire control loop is preceded by a 0.1 s timer. The target solution interval for
the entire loop is 1 s, and the full solve is 1 s. However, the nontime-dependent
functions that are used (AIN, LKUP, MODE, and AOUT) do not need to be solved
every scan. To reduce the scan time impact, these functions are scheduled to solve
less frequently. The example has a loop solve every 3 s, reducing the average scan
time dramatically.
54 33002261
Closed Loop Control / Analog Values
Description Here is a simplified P&I diagram for an inlet separator in a gas processing plant.
There is a two-phase inlet stream: liquid and gas.
Vent
Blowdown
Inlet Vent
Plant
Inlet
FCV
Inlet Block
LT
1
LSH
Gas
1
LC PV-1
1
LSL
1
LV
I/P FC
1
Condensate
33002261 55
Closed Loop Control / Analog Values
Ladder Logic The level is controlled by device LC-1, a Quantum controller connected to an analog
Diagram input module; I/P-1 is connected to an analog output module. We can implement the
control loop with the following 984 ladder logic:
300001 400102
#0 #0
SUB SUB
400113 400500
400100
000101
000102
400200
PID2
000103
# 30
The first SUB block is used to move the analog input from LT-1 to the PID2 analog
input register, 40113. The second SUB block is used to move the PID2 output Mv to
the I/O mapped output I/P-1. Coil 00101 is used to change the loop from AUTO to
MANUAL mode, if desired. For AUTO mode, it should be ON.
56 33002261
Closed Loop Control / Analog Values
Register Content Specify the set point in mm for input scaling (E.U.). The full input range will be 0 ...
4000 mm (for 0 ... 4095 raw analog). Specify the register content of the top node in
the PID2 block as follows:
Register Content Content Comments
Numeric Meaning
400100 Scaled PV (mm) PID2 writes this
400101 2000 Scaled SP (mm) Set to 2000 mm (half full) initially
400102 0000 Loop output (0 ... 4095 PID2 writes this; keep it set to 0 to be
safe
400103 3500 Alarm High Set Point (mm) If the level rises above 3500 mm,
coil 000102 goes ON
400104 1000 Alarm Low Set Point (mm) If the level drops below 1000 mm,
coil 000103 goes ON
400105 0100 PB (%) The actual value depends on the
process dynamics
400106 0500 Integral constant (5.00 The actual value depends on the
repeats/min) process dynamics
400107 0000 Rate time constant (per min) Setting this to 0 turns off the
derivative mode
400108 0000 Bias (0 ... 4095) This is set to 0, since we have an
integral term
400109 4095 High windup limit (0 ... 4095) Normally set to the maximum
400110 0000 Low windup limit (0 ... 4095) Normally set to the minimum
400111 4000 High engineering range (mm) The scaled value of the process
variable when the raw input is at
4095
400112 0000 Low engineering range (mm) The scaled value of the process
variable when the raw input is at 0
400113 Raw analog measure A copy of the input from the analog
(0 ... 4095) input module register (300001)
copied by the first SUB
400114 0000 Offset to loop counter register Zero disables this feature.
Normally, this is not used
400115 0000 Max loops solved per scan See register 400114
33002261 57
Closed Loop Control / Analog Values
The values in the registers in the 400200 destination block are all set by the PID2
block.
58 33002261
Formatting Messages for ASCII
READ/WRIT Operations
4
At a Glance
Introduction In this chapter you will find general information about formatting messages for ASCII
READ/WRIT operations.
33002261 59
Formatting Messages for ASCII READ/WRIT Operations
General The ASCII messages used in the READ and WRIT instructions can be created via
your panel software using the format specifiers described below. Format specifiers
are character symbols that indicate:
l The ASCII characters used in the message
l Register content displayed in ASCII character format
l Register content displayed in hexadecimal format
l Register content displayed in integer format
l Subroutine calls to execute other message formats
60 33002261
Formatting Messages for ASCII READ/WRIT Operations
Format Specifiers
Format Specifier Space indicator, e.g., 14X indicates 14 spaces left open from the point where the
X specifier occurs.
Field width None (defaults to 1)
Prefix 1 ... 99 spaces
Input format Inputs specified number of spaces
Output format Outputs specified number of spaces
33002261 61
Formatting Messages for ASCII READ/WRIT Operations
Format Specifier Repeat contents of the parentheses, e.g., 2 (4X, I5) says repeat 4X, I5 two
( ) times
Field width None
Prefix 1 ... 255
Input format Repeat format specifiers in parentheses the number of times
specified by the prefix
Output format Repeat format specifiers in parentheses the number of times
specified by the prefix
Format Specifier Alphanumeric, e.g., A27 specifies 27 alphanumeric characters, no suffix allowed
A
Field width None (defaults to 1)
Prefix 1 ... 99
Input format Accepts any 8-bit character except reserved delimiters such as CR,
LF, ESC, BKSPC, DEL.
Output format Outputs any 8-bit character
62 33002261
Formatting Messages for ASCII READ/WRIT Operations
33002261 63
Formatting Messages for ASCII READ/WRIT Operations
General To control and monitor the signals used in the messaging communication, specify
code 1002 in the first register of the control block (the register displayed in the top
node). Via this format, you can control the RTS and CTS lines on the port used for
messaging.
Note: In this format, only the local port can be used for messaging, i.e., a parent
PLC cannot monitor or control the signals on a child port. Therefore, the port
number specified in the fifth implied node of the control block must always be 1.
The first three registers in the data block (the displayed register and the first and
second implied registers in the middle node) have predetermined content:
Register Content
Displayed Stores the control mask word
First implied Stores the control data word
Second implied Stores the status word
These three data block registers are required for this format, and therefore the
allowable range for the length value (specified in the bottom node) is 3 ... 255.
Bit Function
1 1 = port can be taken
0 = port cannot be taken
2 - 15 Not used
16 1 = control RTS
0 = do not control RTS
64 33002261
Formatting Messages for ASCII READ/WRIT Operations
Bit Function
1 1 = take port
0 = return port
2 - 15 Not used
16 1 = activate RTS
0 = deactivate RTS
Bit Function
1 1 = port taken
2 1 = port ACTIVE as Modbus slave
3 - 13 Not used
14 1 = DSR ON
15 1 = CTS ON
16 1 = RTS ON
33002261 65
Formatting Messages for ASCII READ/WRIT Operations
66 33002261
Interrupt Handling
5
Interrupt Handling
Interrupt-related The interrupt-related instructions operate with minimum processing overhead. The
Performance performance of interrupt-related instructions is especially critical. Using a interval
timer interrupt (ITMR) instruction adds about 6% to the scan time of the scheduled
ladder logic, this increase does not include the time required to execute the interrupt
handler subroutine associated with the interrupt.
Interrupt Latency The following table shows the minimum and maximum interrupt latency times you
Time can expect:
ITMR overhead No work to do 60 ms/ms
Response time Minimum 98 ms
Maximum during logic solve and 400 ms
Modbus command reception
Total overhead (not counting normal logic solve time) 155 ms
Interrupt The PLC uses the following rules to choose which interrupt handler to execute in the
Priorities event that multiple interrupts are received simultaneously:
l An interrupt generated by an interrupt module has a higher priority than an
interrupt generated by a timer.
l Interrupts from modules in lower slots of the local backplane have priority over
interrupts from modules in the higher slots.
If the PLC is executing an interrupt handler subroutine when a higher priority
interrupt is received, the current interrupt handler is completed before the new
interrupt handler is begun.
33002261 67
Interrupt Handling
Instructions that The following (nonreenterant) ladder logic instructions cannot be used inside an
Cannot Be Used interrupt handler subroutine:
in an Interrupt l MSTR
Handler l READ / WRIT
l PCFL / EMTH
l T1.0, T0.1, T.01 and T1MS timers (will not set error bit 2, timer results invalid)
l Equation Networks
l User loadables (will not set error bit 2)
If any of these instructions are placed in an interrupt handler, the subroutine will be
aborted, the error output on the ITMR or IMOD instruction that generated the
interrupt will go ON, and bit 2 in the status register will be set.
Interrupt with Three interrupt mask/unmask control instructions are available to help protect data
BMDI/ID/IE in both the normal (scheduled) ladder logic and the (unscheduled) interrupt handling
subroutine logic. These are the Interrupt Disable (ID) instruction, the Interrupt
Enable (IE) instruction, and the Block Move with Interrupts Disabled (BMDI)
instruction.
An interrupt that is executed in the timeframe after an ID instruction has been solved
and before the next IE instruction has been solved is buffered. The execution of a
buffered interrupt takes place at the time the IE instruction is solved. If two or more
interrupts of the same type occur between the ID ... IE solve, the mask interrupt
overrun error bit is set, and the subroutine initiated by the interrupts is executed only
one time
The BMDI instruction can be used to mask both a timer-generated and local I/O-
generated interrupts, perform a single block data move, then unmask the interrupts.
It allows for the exchange of a block of data either within the subroutine or at one or
more places in the scheduled logic program.
BMDI instructions can be used to reduce the time between the disable and enable
of interrupts. For example, BMDI instructions can be used to protect the data used
by the interrupt handler when the data is updated or read by Modbus, Modbus Plus,
Peer Cop or Distributed I/O (DIO).
68 33002261
Subroutine Handling
33002261 69
Subroutine Handling
Subroutine Handling
JSR / LAB The example below shows a series of three user logic networks, the last of which is
Method used for an up-counting subroutine. Segment 32 has been removed from the order-
of-solve table in the segment scheduler:
Scheduled Logic Flow
Segment 001
Network 00001
Subroutine Segment
Segment 032
Network 00001
00010
SUB 00001
40999 JSR
00001
Segment 002
Network 00001
When input 100001 to the JSR block in network 2 of segment 1 transitions from OFF
to ON, the logic scan jumps to subroutine #1 in network 1 of segment 32.
The subroutine will internally loop on itself ten times, counted by the ADD block. The
first nine loops end with the JSR block in the subroutine (network 1 of segment 32)
sending the scan back to the LAB block. Upon completion of the tenth loop, the RET
block sends the logic scan back to the scheduled logic at the JSR node in network
2 of segment 1.
70 33002261
Installation of DX Loadables
7
Installation of DX Loadables
How to install the The DX loadable instructions are only available if you have installed them. With the
DX Loadables installation of the Concept software, DX loadables are located on your hard disk.
Now you have to unpack and install the loadables you want to use as follows:
Step Action
1 With the menu command Project → Configurator you open the
configurator
2 With Configure → Loadables... you open the dialog box Loadables
3 Press the command button Unpack... to open the standard Windows dialog
box Unpack Loadable File where the multifile loadables (DX loadables) can
be selected. Select the loadable file you need, click the button OK and it is
inserted into the list box Available:.
4 Now press the command button Install=> to install the loadable selected in
the list box Available:. The installed loadable will be displayed in the list box
Installed: .
5 Press the command button Edit... to open the dialog box Loadable
Instruction Configuration . Change the opcode if necessary or accept
the default. You can assign an opcode to the loadable in the list box Opcode in
order to enable user program access through this code. An opcode that is
already assigned to a loadable, will be identified by a *. Click the button OK.
6 Click the button OK in the dialog box Loadables .
33002261 71
Installation of DX Loadables
72 33002261
Coils, Contacts and Interconnects
8
At a Glance
Introduction In this chapter you will find information about Coils, Contacts and Interconnects
(Shorts.)
33002261 73
Coils, Contacts and Interconnects
Coils
Definition of A coil is a discrete output that is turned ON and OFF by power flow in the logic
Coils program. A single coil is tied to a 0x reference in the PLC’s state RAM. Because
output values are updated in state RAM by the PLC, a coil may be used internally in
the logic program or externally via the I/O map to a discrete output unit in the control
system. When a coil is ON, it either passes power to a discrete output circuit or
changes the state of an internal relay contact in state RAM.
There are two types of coils:
l A normal coil
l A memory-retentive, or latched, coil
74 33002261
Coils, Contacts and Interconnects
????
WARNING
Forcing of Coils
When a discrete input (1x) is disabled, signals from its associated input field device
have no control over its ON/OFF state. When a discrete output (0x) is disabled, the
PLC’s logic scan has no control over the ON/OFF state of the output. When a
discrete input or output has been disabled, you can change its current ON/OFF
state with the Force command.
There is an important exception when you disable coils. Data move and data
matrix instructions that use coils in their destination node recognize the current
ON/OFF state of all coils in that node, whether they are disabled or not. If you are
expecting a disabled coil to remain disabled in such an instruction, you may cause
unexpected or undesirable effects in your application.
When a coil or relay contact has been disabled, you can change its state using the
Force ON or Force OFF command. If a coil or relay is enabled, it cannot be forced.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
Retentive Coil If a retentive (latched) coil is energized when the PLC loses power, the coil will come
back up in the same state for one scan when the PLC’s power is restored.
To define a discrete reference for the coil, select it in the editor and click to open a
dialog box called Retentative coil (latch).
Symbol
L
????
33002261 75
Coils, Contacts and Interconnects
Contacts
Definition of Contacts are used to pass or inhibit power flow in a ladder logic program. They are
Contacts discrete, i.e., each consumes one I/O point in ladder logic. A single contact can be
tied to a 0x or 1x reference number in the PLC’s state RAM, in which case each
contact consumes one node in a ladder network.
Four kinds of contacts are available:
l Normally open (N.O.) contacts
l Normally closed (N.C.) contacts
l Positive transitional (P.T.) contacts
l Negative transitional (N.T.) contacts
????
????
Contact Pos A positive transitional (PT) contact passes power for only one scan as it transitions
Trans from OFF to ON.
To define a discrete reference for the PT contact, select it in the editor and click to
open a dialog called Positive transition contact.
Symbol
????
76 33002261
Coils, Contacts and Interconnects
Contact Neg A negative transitional (NT) contact passes power for only one scan as it transitions
Trans from ON to OFF.
To define a discrete reference for the NT contact, select it in the editor and click to
open a dialog called Contact negative transition .
Symbol
????
33002261 77
Coils, Contacts and Interconnects
Interconnects (Shorts)
Definition of Shorts are simply straight-line connections between contacts and/or instructions in
Interconnects a ladder logic network. Shorts may be inserted horizontally or vertically in a network.
(Shorts) Two kinds of shorts are available:
l Horizontal Short
l Vertical Short
Horizontal Short A short is a straight-line connection between contacts and/or nodes in an instruction
through which power flow can be controlled.
A horizontal short is used to extend logic out across a row in a network without
breaking the power flow. Each horizontal short consumes one node in the network,
and uses a word of memory in the PLC.
Symbol
Vertical Short A vertical short connects contacts or nodes in an instruction positioned one above
the other in a column. Vertical shorts can also connect inputs or outputs in an
instruction to create either-or conditions. When two contacts are connected by a
vertical short, power is passed when one or both contacts receive power.
The vertical short is unique in two ways:
l It can coexist in a network node with another element or nodal value
l It does not consume any PLC memory
Symbol
78 33002261
Instruction Descriptions
II
At a Glance
33002261 79
Instruction Descriptions
80 33002261
Instruction Descriptions
33002261 81
Instruction Descriptions
82 33002261
Instruction Descriptions
33002261 83
Instruction Descriptions
84 33002261
AD16: Ad 16 Bit
9
At a Glance
33002261 85
AD16: Ad 16 Bit
Short Description
Function The AD16 instruction performs signed or unsigned 16-bit addition on value 1 (its top
Description node) and value 2 (its middle node), then posts the sum in a 4x holding register in
the bottom node.
Representation
value 1
value 2
AD16
sum
86 33002261
ADD: Addition
10
At a Glance
33002261 87
ADD: Addition
Short Description
Function The ADD instruction adds unsigned value 1 (its top node) to unsigned value 2 (its
Description middle node) and stores the sum in a holding register in the bottom node.
Representation
value 1
value 2
ADD
sum
88 33002261
AND: Logical And
11
At a Glance
33002261 89
AND: Logical And
Short Description
Function The AND instruction performs a Boolean AND operation on the bit patterns in the
Description source and destination matrices.
The ANDed bit pattern is then posted in the destination matrix, overwriting its
previous contents:
0 1 1 0
source
destination
bits AND AND AND AND bits
0 0 0 0 1 1 1 0
WARNING
Overriding of any disabled coils within the destination matrix without
enabling them.
AND will override any disabled coils within the destination matrix without enabling
them.This can cause personal injury if a coil has disabled an operation for
maintenance or repair because the coil’s state can be changed by the AND
operation.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
90 33002261
AND: Logical And
Representation
destination
matrix
AND
length
Parameter Description
Matrix Length The integer entered in the bottom node specifies the matrix length, i.e. the number
(Bottom Node) of registers or 16-bit words in the two matrices. The matrix length can be in the range
1 ... 100. A length of 2 indicates that 32 bits in each matrix will be ANDed.
33002261 91
AND: Logical And
92 33002261
BCD: Binary to Binary Code
12
At a Glance
33002261 93
BCD: Binary to Binary Code
Short Description
Function The BCD instruction can be used to convert a binary value to a binary coded decimal
Description (BCD) value or a BCD value to a binary value. The type of conversion to be
performed is controlled by the state of the bottom input.
Representation
source
register
destination
register
BCD
#1
94 33002261
BLKM: Block Move
13
At a Glance
33002261 95
BLKM: Block Move
Short Description
Function The BLKM (block move) instruction copies the entire contents of a source table to a
Description destination table in one scan.
WARNING
Overriding of any disabled coils within a destination table without enabling
them.
BLKM will override any disabled coils within a destination table without enabling
them. This can cause injury if a coil has been disabled for repair or maintenance
because the coil’s state can change as a result of the BLKM instruction.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
96 33002261
BLKM: Block Move
Representation
source
table
destination
table
BLKM
table
length
33002261 97
BLKM: Block Move
98 33002261
BLKT: Block to Table
14
At a Glance
33002261 99
BLKT: Block to Table
Short Description
Function The BLKT (block-to-table) instruction combines the functions of R→T and BLKM in
Description a single instruction. In one scan, it can copy data from a source block to a destination
block in a table. The source block is of a fixed length. The block within the table is of
the same length, but the overall length of the table is limited only by the number of
registers in your system configuration.
WARNING
All the 4x registers in your PLC can be corrupted with data copied from the
source block.
BLKT is a powerful instruction that can corrupt all the 4x registers in your PLC with
data copied from the source block. You should use external logic in conjunction
with the middle or bottom input to confine the value in the pointer to a safe range.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
100 33002261
BLKT: Block to Table
Representation
source
block
pointer
BLKT
block length
33002261 101
BLKT: Block to Table
Parameter Description
Middle and The middle and bottom input can be used to control the pointer so that source data
Bottom Input is not copied into registers that are needed for other purposes in the logic program.
When the middle input is ON, the value in the pointer register is frozen while the
BLKT operation continues. This causes new data being copied to the destination to
overwrite the block data copied on the previous scan.
When the bottom input is ON, the value in the pointer register is reset to zero. This
causes the BLKT operation to copy source data into the first block of registers in the
destination table.
Pointer The 4x register entered in the middle node is the pointer to the destination table. The
(Middle Node) first register in the destination table is the next contiguous register after the pointer,
e.g. if the pointer register is 400107, then the first register in the destination table is
400108.
Note: The destination table is segmented into a series of register blocks, each of
which is the same length as the source block. Therefore, the size of the destination
table is a multiple of the length of the source block, but its overall size is not
specifically defined in the instruction. If left uncontrolled, the destination table could
consume all the 4x registers available in the PLC configuration.
The value stored in the pointer register indicates where in the destination table the
source data will begin to be copied. This value specifies the block number within the
destination table.
102 33002261
BMDI: Block Move with Interrupts
Disabled
15
At a Glance
33002261 103
BMDI: Block Move with Interrupts Disabled
Short Description
Function
Description
Note: This instruction is only available after configuring a CPU without extension.
The BMDI instruction masks the interrupt, initiates a block move (BLKM) operation,
then unmasks the interrupts.
Further Information you will find in the chapter "Interrupt Handling, p. 67".
Representation
source
table
destination
table
BMDI
table
length
104 33002261
BROT: Bit Rotate
16
At a Glance
33002261 105
BROT: Bit Rotate
Short Description
Function The BROT (bit rotate) instruction shifts the bit pattern in a source matrix, then posts
Description the shifted bit pattern in a destination matrix. The bit pattern shifts left or right by one
position per scan.
WARNING
Overriding of any disabled coils within a destination matrix without enabling
them.
BROT will override any disabled coils within a destination matrix without enabling
them. This can cause injury if a coil has been disabled for repair or maintenance if
BROT unexpectedly changes the coil’s state.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
106 33002261
BROT: Bit Rotate
Representation
source
matrix
destination
matrix
BROT
length
33002261 107
BROT: Bit Rotate
Parameter Description
Matrix Length The integer value entered in the bottom node specifies the matrix length, i.e. the
(Bottom Node) number of registers or 16-bit words in each of the two matrices. The source matrix
and destination matrix have the same length. The matrix length can range from
1 ... 100, e.g. a matrix length of 100 indicates 1600 bit locations.
Result of the The middle output indicates the sense of the bit that exits the source matrix (the
Shift (Middle leftmost or rightmost bit) as a result of the shift.
Output)
108 33002261
CHS: Configure Hot Standby
17
At a Glance
33002261 109
CHS: Configure Hot Standby
Short Description
Function
Description
Note: This instruction is only available, if you have unpacked and installed the DX
Loadables; further information in the chapter "Installation of DX Loadables, p. 71".
The logic in the CHS loadable is the engine that drives the Hot Standby capability in
a Quantum PLC system. Unlike the HSBY instruction, the use of the CHS instruction
in the ladder logic program is optional. However, the loadable software itself must
be installed in the Quantum PLC in order for a Hot Standby system to be
implemented.
110 33002261
CHS: Configure Hot Standby
Representation
command
register
nontransfer
area
CHS
length
33002261 111
CHS: Configure Hot Standby
Detailed Description
Hot Standby Program the CHS instruction in network 1, segment 1 of your ladder logic program
System and unconditionally connect the top input to the power rail via a horizontal short (as
Configuration via the HSBY instruction is programmed in a 984 Hot Standby system).
the CHS This method is particularly useful if you are porting Hot Standby code from a 984
Instruction application to a Quantum application. The structure of the CHS instruction is almost
exactly the same as the HSBY instruction. You simply remove the HSBY instruction
from the 984 ladder logic and replace it with a CHS instruction in the Quantum logic.
If you are using the CHS instruction in ladder logic, the only difference between it
and the HSBY instruction is the use of the bottom output. This output senses
whether or not method 2 has been used. If the Hot Standby configuration extension
screens have been used to define the Hot Standby configuration, the configuration
parameters in the screens will override any different parameters defined by the CHS
instruction at system startup.
For detailes discussion of the issues related to the configuration extension
capabilities of a Quantum Hot Standby system, refer to the Modicon Quantum Hot
Standby System Planning and Installation Guide.
Parameter When the CHS instruction is inserted in ladder logic to control the Hot Standby
Description configuration parameters, its top input must be connected directly to the power rail
Execute Hot by a horizontal short. No control logic, such as contacts, should be placed between
Standby the rail and the input to the top node.
(Top Input)
WARNING
Erratic behavior in the Hot Standby system
Although it is legal to enable and disable the nontransfer area while the Hot
Standby system is running, we strongly discourage this practice. It can lead to
erratic behavior in the Hot Standby system.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
112 33002261
CHS: Configure Hot Standby
Parameter The 4x register entered in the top node is the Hot Standby command register; eight
Description bits in this register are used to configure and control Hot Standby system
Command parameters:
Register Usage of command word:
(Top Node)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1-5 Not used
6 0 = swap Modbus port 3 address during switchover
1 = no swap
7 0 = swap Modbus port 2 address during switchover
1 = no swap
8 0 = swap Modbus port 1 address during switchover
1 = no swap
9 - 11 Not used
12 0 = allow exec upgrade only after application stops
1 = allow the upgrade without stopping the application
13 0 = force standby offline if there is a logic mismatch
1 = do not force
14 0 = controller B is in OFFLINE mode
1 = controller B is in RUN
15 0 = controller A is in OFFLINE mode
1 = controller A is in RUN
16 0 = disable keyswitch override
1 = enable the override
Note: The Hot Standby command register must be outside of the nontransfer area
of state RAM.
33002261 113
CHS: Configure Hot Standby
Parameter The 4x register entered in the middle node is the first register in the nontransfer area
Description of state RAM. The nontransfer area must contain at least four registers, the first
Nontransfer Area three of which have a predefined usage:
(Middle Node)
Register Content
Displayed and first implied Reverse transfer registers for passing information from the
standby to the primary PLC
Second implied CHS Status Register, p. 114
Bit Function
1 1 = the top output is ON (indicating Hot Standby system is active)
2 1 = the middle output is ON (indicating an error condition)
3 - 10 Not used
11 0 = PLC switch is set to A
1 = PLC switch is set to B
12 0 = PLC logic is matched
1 = there is a logic mismatch
13 - 14 The 2 bit value is:
l 0 1 if the other PLC is in OFFLINE mode
l 1 0 if other PLC is running in primary mode
l 1 1 if other PLC is running in standby mode
15 - 16 The 2 bit value is:
l 0 1 if this PLC is in OFFLINE mode
l 1 0 if this PLC is running in primary mode
l 1 1 if this PLC is running in standby mode
114 33002261
CKSM: Check Sum
18
At a Glance
33002261 115
CKSM: Check Sum
Short Description
Function Several PLCs that do not support Modbus Plus come with a standard checksum
Description (CKSM) instruction. CKSM has the same opcode as the MSTR instruction and is not
provided in executive firmware for PLCs that support Modbus Plus.
Representation
source
result/
count
CKSM
length
116 33002261
CKSM: Check Sum
Parameter Description
Inputs The states of the inputs indicate the type of checksum calculation to be performed:
CKSM Calculation Top Input Middle Input Bottom Input
Straight Check ON OFF ON
Binary Addition Check ON ON ON
CRC-16 ON ON OFF
LRC ON OFF OFF
Result / Count The 4x register entered in the middle node is the first of two contiguous 4x registers:
(Middle Node)
Register Content
Displayed Stores the result of the checksum calculation
First implied Posts a value that specifies the number of registers selected from
the source table as input to the calculation. The value posted in the
implied register must be ≤ length of source table.
33002261 117
CKSM: Check Sum
118 33002261
CMPR: Compare Register
19
At a Glance
33002261 119
CMPR: Compare Register
Short Description
Function The CMPR instruction compares the bit pattern in matrix a against the bit pattern in
Description matrix b for miscompares. In a single scan, the two matrices are compared bit
position by bit position until a miscompare is found or the end of the matrices is
reached (without miscompares).
Representation
matrix a
pointer
register
CMPR
length
120 33002261
CMPR: Compare Register
Parameter Description
Pointer Register The pointer register entered in the middle node must be a 4x holding register. It is
(Middle Node) the pointer to matrix b, the other matrix to be compared. The first register in matrix
b is the next contiguous 4x register following the pointer register.
The value stored inside the pointer register increments with each bit position in the
two matrices that is being compared. As bit position 1 in matrix a and matrix b is
compared, the pointer register contains a value of 1; as bit position 2 in the matrices
are compared, the pointer value increments to 2; etc.
When the outputs signal a miscompare, you can check the accumulated count in the
pointer register to determine the bit position in the matrices of the miscompare.
Matrix Length The integer value entered in the bottom node specifies a length of the two matrices,
(Bottom Node) i.e. the number of registers or 16-bit words in each matrix. (Matrix a and matrix b
have the same length.) The matrix length can range from 1 ... 100, i.e. a length of 2
indicates that matrix a and matrix b contain 32 bits.
33002261 121
CMPR: Compare Register
122 33002261
COMP: Complement a Matrix
20
At a Glance
33002261 123
COMP: Complement a Matrix
Short Description
Function The COMP instruction complements the bit pattern, i.e. changes all 0’s to 1’s and all
Description 1’s to 0’s, of a source matrix, then copies the complemented bit pattern into a
destination matrix. The entire COMP operation is accomplished in one scan.
WARNING
Overriding of any disabled coils in the destination matrix without enabling
them.
COMP will override any disabled coils in the destination matrix without enabling
them. This can cause injury if a coil has been disabled for repair or maintenance
because the coil’s state can be changed by the COMP operation.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
124 33002261
COMP: Complement a Matrix
Representation
source
destination
COMP
length
Parameter Description
Matrix Length The integer value entered in the bottom node specifies a matrix length, i.e. the
(Bottom Node) number of registers or 16-bit words in the matrices. Matrix length can range from
1 ... 100. A length of 2 indicates that 32 bits in each matrix will be complemented.
33002261 125
COMP: Complement a Matrix
126 33002261
DCTR: Down Counter
21
At a Glance
33002261 127
DCTR: Down Counter
Short Description
Function The DCTR instruction counts control input transitions from OFF to ON down from a
Description counter preset value to zero.
Representation
counter
preset
DCTR
accumulated
count
128 33002261
DIOH: Distributed I/O Health
22
At a Glance
33002261 129
DIOH: Distributed I/O Health
Short Description
Function The DIOH instruction lets you retrieve health data from a specified group of drops
Description on the distributed I/O network. It accesses the DIO health status table, where health
data for modules in up to 189 distributed drops is stored.
Representation
source
destination
DIOH
length
(1 ... 192)
130 33002261
DIOH: Distributed I/O Health
Parameter Description
Source Value The source value entered in the top node is a four-digit constant in the form xxyy,
(Top Node) where:
Digits Meaning
xx Decimal value in the range 00 ... 16, indicating the slot number in which the
relevant DIO processor resides. The value 00 can always be used to indicate the
Modbus Plus ports on the PLC, regardless of the slot in which it resides.
yy Decimal value in the range 1 ... 64, indicating the drop number on the appropriate
token ring
For example, if you are interested in retrieving drop status starting at distributed drop
#1 on a network being handled by a DIO processor in slot 3, enter 0301 in the top
node.
Length of The integer value entered in the bottom node specifies the length, i.e. the number of
Destination 4x registers, in the destination table. The length is in the range 1 ... 64.
Table
(Bottom Node)
Note: If you specify a length that excedes the number of drops available, the
instruction will return status information only for the drops available. For example,
if you specify the 63rd drop number (yy) in the top node register and then request
a length of 5, the instruction will give you only two registers (the 63rd and 64th drop
status words) in the destination table.
33002261 131
DIOH: Distributed I/O Health
132 33002261
DIV: Divide
23
At a Glance
33002261 133
DIV: Divide
Short Description
Function The DIV instruction divides unsigned value 1 (its top node) by unsigned value 2 (its
Description middle node) and posts the quotient and remainder in two contiguous holding
registers in the bottom node.
134 33002261
DIV: Divide
Representation
value 1
value 2
DIV
result/
remainder
33002261 135
DIV: Divide
Example
Quotient of The state of the middle input indicates whether the remainder will be expressed as
Instruction DIV a decimal or as a fraction. For example, if value 1 = 8 and value 2 = 3, the decimal
remainder (middle input ON) is 6666; the fractional remainder (middle input OFF) is
2.
136 33002261
DLOG: Data Logging for PCMCIA
Read/Write Support
24
At a Glance
33002261 137
DLOG: Data Logging for PCMCIA Read/Write Support
Short Description
Function
Description
Note: This instruction is only available with the PLC family TSX Compact.
Note: The DLOG instruction will only operate with PCMCIA linear flash cards that
use AMD flash devices.
138 33002261
DLOG: Data Logging for PCMCIA Read/Write Support
Representation
control
block
data
area
DLOG
length
33002261 139
DLOG: Data Logging for PCMCIA Read/Write Support
Parameter Description
Control Block The 4x register entered in the top node is the first of five contiguous registers in the
(Top Node) DLOG control block.
The control block defines the function of the DLOG command, the PCMCIA flash
card window and offset, a return status word, and a data word count value.
Register Function Content
Displayed Error Status Displays DLOG errors in HEX values
First implied Operation Type 1 = Write to PCMCIA Card
2 = Read to PCMCIA Card
3 = Erase One Block
4 = Erase Entire Card Content
Second Window This register identifies a particular block (PCMCIA
implied (Block Identifier) memory window) located on the PCMCIA card
(1 block=128k bytes)
The number of blocks are dependent on the memory
size of the PCMCIA card. (e.g.. 0 ... 31 Max. for a 4Meg
PCMCIA card).
Third implied Offset Particular range of bytes located within a particular
(Byte Address block on the PCMCIA card.
within the Block) Range: 1 ... 128k bytes
Fourth implied Count Number of 4x registers to be written or read to the
PCMCIA card. Range: 0 ... 100.
140 33002261
DLOG: Data Logging for PCMCIA Read/Write Support
Data Area The 4x register entered in the middle node is the first register in a contiguous block
(Middle Node) of 4x word registers, that the DLOG instruction will use for the source or destination
of the operation specified in the top node’s control block.
Operation State Ram Function
Reference
Write 4x Source Address
Read 4x Destination Address
Erase Block none None
Erase Card none None
Length The integer value entered in the bottom node is the length of the data area, i.e., the
(Bottom Node) maximum number of words (registers) allowed in a transfer to/from the PCMCIA
flash card. The length can range from 0 ... 100.
Error Codes The displayed register of the control block contains the following DLOG errors in
Hex-code.
Hex Error Codes DLOG
Error Code in Hex Content
1 The count parameter of the control block > the DLOG block length
during a WRITE operation (01)
2 PCMCIA card operation failed when intially started (write/read/
erase)
3 PCMCIA card operation failed during execution (write/read/erase)
33002261 141
DLOG: Data Logging for PCMCIA Read/Write Support
142 33002261
DRUM: DRUM Sequencer
25
At a Glance
33002261 143
DRUM: DRUM Sequencer
Short Description
Function
Description
Note: This instruction is only available, if you have unpacked and installed the DX
Loadables; further information in the chapter "Installation of DX Loadables, p. 71".
144 33002261
DRUM: DRUM Sequencer
Representation
step
pointer
step data
table
DRUM
length
33002261 145
DRUM: DRUM Sequencer
Parameter Description
Step Pointer The 4x register entered in the top node stores the current step number. The value
(Top Node) in this register is referenced by the DRUM instruction each time it is solved. If the
middle input to the block is ON, the contents of the register in the top node are
incremented to the next step in the sequence before the block is solved.
146 33002261
DRUM: DRUM Sequencer
Step Data Table The 4x register entered in the middle node is the first register in a table of step data
(Middle Node) information.
The first six registers in the step data table hold constant and variable data required
to solve the block:
Register Name Content
Displayed masked output data Loaded by DRUM each time the block is solved;
contains the contents of the current step data
register masked with the outputmask register
First implied current step data Loaded by DRUM each time the block is solved;
contains data from the step pointer, causes the
block logic to automatically calculate register
offsets when accessing step data in the step
data table
Second implied output mask Loaded by user before using the block, DRUM
will not alter output mask contents during logic
solve; contains a mask to be applied to the data
for each sequencer step
Third implied machine ID number Identifies DRUM/ICMP blocks belonging to a
specific machine configuration; value range: 0
... 9 999 (0 = block not configured); all blocks
belonging to same machine configuration have
the same machine ID number
Fourth implied profile ID number Identifies profile data currently loaded to the
sequencer; value range: 0... 9 999 (0 = block not
configured); all blocks with the same machine
ID number must have the same profile ID
number
Fifth implied steps used Loaded by user before using the block, DRUM
will not alter steps used contents during logic
solve; contains between 1 ... 999 for 24 bit
CPUs, specifying the actual number of steps to
be solved; the number must be greater or less
than the table length in the bottom node
The remaining registers contain data for each step in the sequence.
Length The integer value entered in the bottom node is the length, i.e., the number of
(Bottom Node) application-specific registers used in the step data table. The length can range from
1 ... 999 in a 24-bit CPU.
The total number of registers required in the step data table is the length + 6. The
length must be greater or equal to the value placed in the steps used register in the
middle node.
33002261 147
DRUM: DRUM Sequencer
148 33002261
DV16: Divide 16 Bit
26
At a Glance
33002261 149
DV16: Divide 16 Bit
Short Description
Function The DV16 instruction performs a signed or unsigned division on the 16-bit values in
Description the top and middle nodes (value 1 / value 2), then posts the quotient and remainder
in two contiguous 4x holding registers in the bottom node.
Representation
value 1
value 2
DV16
quotient
150 33002261
DV16: Divide 16 Bit
Example
Quotient of The state of the middle input indicates whether the remainder will be expressed as
Instruction DV16 a decimal or as a fraction. For example, if value 1 = 8 and value 2 = 3, the decimal
remainder (middle input OFF) is 6666; the fractional remainder (middle input ON) is
2.
33002261 151
DV16: Divide 16 Bit
152 33002261
EMTH: Extended Math
27
At a Glance
33002261 153
EMTH: Extended Math
Short Description
Function This instruction accesses a library of double-precision math, square root and
Description logarithm calculations and floating point (FP) arithmetic functions.
The EMTH instruction allows you to select from a library of 38 extended math
functions. Each of the functions has an alphabetical indicator of variable
subfunctions that can be selected from a pulldown menu in your panel software and
appears in the bottom node. EMTH control inputs and outputs are function-
dependent.
154 33002261
EMTH: Extended Math
Representation
middle
Middle Input Middle Output
node
Bottom Input EMTH Bottom Output
subfunction
33002261 155
EMTH: Extended Math
Parameter Description
Inputs, Outputs The implementation of inputs to and outputs from the block depends on the EMTH
and Bottom Node subfunction you select. An alphabetical indicator of variable subfunctions appears in
the bottom node identifing the EMTH function you have chosen from the library.
You will find the EMTH subfunctions in the following tables:
l Double Precision Math
l Integer Math
l Floating Point Math
156 33002261
EMTH: Extended Math
Subfunctions for Floating Point Math (See Floating Point EMTH Functions, p. 158 )
Floating Point
EMTH Function Subfunction Active Inputs Active Outputs
Math
Integer-to-FP conversion CNVIF Top Top
Integer + FP ADDIF Top Top
Integer - FP SUBIF Top Top
Integer x FP MULIF Top Top
Integer / FP DIVIF Top Top
FP - Integer SUBFI Top Top
FP / Integer DIVFI Top Top
Integer-FP comparison CMPIF Top Top
FP-to-Integer conversion CNVFI Top Top and Middle
Addition ADDFP Top Top
Subtraction SUBFP Top Top
Multiplication MULFP Top Top
Division DIVFP Top Top
Comparison CMPFP Top Top, Middle and Bottom
Square root SQRFP Top Top
Change sign CHSIN Top Top
Load Value of p PI Top Top
Sine in radians SINE Top Top
Cosine in radians COS Top Top
Tangent in radians TAN Top Top
Arcsine in radians ARSIN Top Top
Arccosine in radians ARCOS Top Top
Arctangent in radians ARTAN Top Top
Radians to degrees CNVRD Top Top
Degrees to radians CNVDR Top Top
FP to an integer power POW Top Top
Exponential function EXP Top Top
Natural log LNFP Top Top
Common log LOGFP Top Top
Report errors ERLOG Top Top and Middle
33002261 157
EMTH: Extended Math
Use of Floating To make use of the floating point (FP) capability, the four-digit integer values used
Point Functions in standard math instructions must be converted to the IEEE floating point format.
All calculations are then performed in FP format and the results must be converted
back to integer format.
The IEEE EMTH floating point functions require values in 32-bit IEEE floating point format.
Floating Point Each value has two registers assigned to it, the eight most significant bits
Standard representing the exponent and the other 23 bits (plus one assumed bit) representing
the mantissa and the sign of the value.
Dealing with Standard integer math calculations do not handle negative numbers explicitly. The
Negative only way to identify negative values is by noting that the SUB function block has
Floating Point turned the bottom output ON.
Numbers If such a negative number is being converted to floating point, perform the Integer-
to-FP conversion (EMTH subfunction CNVIF), then use the Change Sign function
(EMTH subfunction CHSIN) to make it negative prior to any other FP calculations.
158 33002261
EMTH-ADDDP: Double Precision
Addition
28
At a Glance
33002261 159
EMTH-ADDDP: Double Precision Addition
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Double Precision Math (See Subfunctions for Double Precision Math, p. 156)".
Representation
operand 1
operand 2
and sum
EMTH
ADDDP
160 33002261
EMTH-ADDDP: Double Precision Addition
Parameter Description
Operand 1 The first of two contiguous 4x registers is entered in the top node. The second 4x
(Top Node) register is implied. Operand 1 is stored here.
Register Content
Displayed Register stores the low-order half of operand 1
Range 0 000 ... 9 999, for a combined double precision value in the
range 0 ... 99 999 999
First implied Register stores the high-order half of operand 1
Range 0 000 ... 9 999, for a combined double precision value in the
range 0 ... 99 999 999
Operand 2 and The first of six contiguous 4x registers is entered in the middle node. The remaining
Sum five registers are implied:
(Middle Node)
Register Content
Displayed Register stores the low-order half of operand 2, respectively, for a
combined double precision value in the range 0 ... 99 999 999
First implied Register stores the high-order half of operand 2, respectively, for a
combined double precision value in the range 0 ... 99 999 999
Second implied The value stored in this register indicates whether an overflow
condition exists (a value of 1 = overflow)
Third implied Register stores the low-order half of the double precision sum.
Fourth implied Register stores the high-order half of the double precision sum.
Fifth implied Register is not used in the calculation but must exist in state RAM
33002261 161
EMTH-ADDDP: Double Precision Addition
162 33002261
EMTH-ADDFP: Floating Point
Addition
29
At a Glance
33002261 163
EMTH-ADDFP: Floating Point Addition
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value 1
val.ue 2
and sum
EMTH
ADDFP
164 33002261
EMTH-ADDFP: Floating Point Addition
Parameter Description
Floating Point The first of two contiguous 4x registers is entered in the top node. The second
Value 1 (Top register is implied.
Node)
Register Content
Displayed Registers store the FP value 1.
First implied
Floating Point The first of four contiguous 4x registers is entered in the middle node. The remaining
Value 2 and Sum three registers are implied
(Middle Node)
Register Content
Displayed Registers store the FP value 2.
First implied
Second implied Registers store the sum of the addition in FP format (See The IEEE
Third implied Floating Point Standard, p. 158).
33002261 165
EMTH-ADDFP: Floating Point Addition
166 33002261
EMTH-ADDIF: Integer + Floating
Point Addition
30
At a Glance
33002261 167
EMTH-ADDIF: Integer + Floating Point Addition
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
integer
FP and
sum
EMTH
ADDIF
168 33002261
EMTH-ADDIF: Integer + Floating Point Addition
Parameter Description
Integer Value The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied.
Register Content
Displayed The double precision integer value to be added to the FP value is
First implied stored here.
FP Value and The first of four contiguous 4x registers is entered in the middle node. The remaining
Sum three registers are implied
(Middle Node)
Register Content
Displayed Registers store the FP value to be added in the operation.
First implied
Second implied The sum is posted here in FP format (See The IEEE Floating Point
Third implied Standard, p. 158).
33002261 169
EMTH-ADDIF: Integer + Floating Point Addition
170 33002261
EMTH-ANLOG: Base 10
Antilogarithm
31
At a Glance
33002261 171
EMTH-ANLOG: Base 10 Antilogarithm
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Integer Math (See Subfunctions for Integer Math, p. 156)".
Representation
source
result
EMTH
ANLOG
172 33002261
EMTH-ANLOG: Base 10 Antilogarithm
Parameter Description
Source Value The top node is a single 4x holding register or 3x input register. The source value,
(Top Node) i.e. the value on which the antilog calculation will be performed, is stored here in the
fixed decimal format 1.234. It must be in the range 0 ... 7 999, representing a source
value up to a maximum of 7.999.
Result The first of two contiguous 4x registers is entered in the middle node. The second
(Middle Node) register is implied. The result of the antilog calculation is posted here in the fixed
decimal format 12345678:
Register Content
Displayed Most significant bits
First implied Least significant bits
The largest antilog value that can be calculated is 99770006 (9977 posted in the
displayed register and 0006 posted in the implied register).
33002261 173
EMTH-ANLOG: Base 10 Antilogarithm
174 33002261
EMTH-ARCOS: Floating Point Arc
Cosine of an Angle (in Radians)
32
At a Glance
33002261 175
EMTH-ARCOS: Floating Point Arc Cosine of an Angle (in Radians)
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
arc cosine
of value
EMTH
ARCOS
176 33002261
EMTH-ARCOS: Floating Point Arc Cosine of an Angle (in Radians)
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied.
Register Content
Displayed An FP value indicating the cosine of an angle between 0 ... p radians
First implied is stored here.
This value must be in the range of -1.0 ... +1.0;
Arc Cosine of The first of four contiguous 4x registers is entered in the middle node. The remaining
Value three registers are implied
(Middle Node)
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The arc cosine in radians of the FP value in the top node is posted
Third implied here.
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 177
EMTH-ARCOS: Floating Point Arc Cosine of an Angle (in Radians)
178 33002261
EMTH-ARSIN: Floating Point
Arcsine of an Angle (in Radians)
33
At a Glance
33002261 179
EMTH-ARSIN: Floating Point Arcsine of an Angle (in Radians)
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
arcsine of
value
EMTH
ARSIN
180 33002261
EMTH-ARSIN: Floating Point Arcsine of an Angle (in Radians)
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied.
Register Content
Displayed An FP value indicating the sine of an angle between -π/2 ... π/2
First implied radians is stored here. This value (the sine of an angle) must be in
the range of -1.0 ... +1.0;
Arcsine of Value The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The arcsine of the value in the top node is posted here in FP format
Third implied (See The IEEE Floating Point Standard, p. 158).
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 181
EMTH-ARSIN: Floating Point Arcsine of an Angle (in Radians)
182 33002261
EMTH-ARTAN: Floating Point Arc
Tangent of an Angle (in Radians)
34
At a Glance
33002261 183
EMTH-ARTAN: Floating Point Arc Tangent of an Angle (in Radians)
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
arc tangent
of value
EMTH
ARTAN
184 33002261
EMTH-ARTAN: Floating Point Arc Tangent of an Angle (in Radians)
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied.
Register Content
Displayed An FP value indicating the tangent of an angle between -π/2 ... π/2
First implied radians is stored here. Any valid FP value is allowed.;
Arc Tangent of The first of four contiguous 4x registers is entered in the middle node. The remaining
Value three registers are implied
(Middle Node)
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The arc tangent in radians of the FP value in the top node is posted
Third implied here.
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 185
EMTH-ARTAN: Floating Point Arc Tangent of an Angle (in Radians)
186 33002261
EMTH-CHSIN: Changing the Sign
of a Floating Point Number
35
At a Glance
33002261 187
EMTH-CHSIN: Changing the Sign of a Floating Point Number
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
-(value)
EMTH
CHSIN
188 33002261
EMTH-CHSIN: Changing the Sign of a Floating Point Number
Parameter Description
Floating Point The first of two contiguous 4x registers is entered in the top node. The second
Value (Top Node) register is implied.
Register Content
Displayed The FP value whose sign will be changed is stored here.
First implied
Floating Point The first of four contiguous 4x registers is entered in the middle node. The remaining
Value with three registers are implied
changed sign
Register Content
(Middle Node)
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The top node FP value with changed sign is posted here.
Third implied
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 189
EMTH-CHSIN: Changing the Sign of a Floating Point Number
190 33002261
EMTH-CMPFP: Floating Point
Comparison
36
At a Glance
33002261 191
EMTH-CMPFP: Floating Point Comparison
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value 1
value 2
EMTH
CMPFP
192 33002261
EMTH-CMPFP: Floating Point Comparison
Parameter Description
Value 1 The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied:
Register Content
Displayed The first FP value (value 1) to be compared is stored here.
First implied
Value 2 The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied:
Register Content
Displayed The second FP value (value 2) to be compared is stored here.
First implied
Second implied Registers are not used but their allocation in state RAM is required.
Third implied
Middle and When EMTH function CMPFP compares its two FP values, the combined states of
Bottom Output the middle and the bottom output indicate their relationship:
Middle Output Bottom Output Relationship
ON OFF value 1 > value 2
OFF ON value 1 < value 2
ON ON value 1 = value 2
33002261 193
EMTH-CMPFP: Floating Point Comparison
194 33002261
EMTH-CMPIF: Integer-Floating
Point Comparison
37
At a Glance
33002261 195
EMTH-CMPIF: Integer-Floating Point Comparison
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
integer
FP
EMTH
CMPIF
196 33002261
EMTH-CMPIF: Integer-Floating Point Comparison
Parameter Description
Integer Value The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied:
Register Content
Displayed The double precision integer value to be compared is stored here.
First implied
Floating Point The first of four contiguous 4x registers is entered in the middle node. The remaining
Value (Middle three registers are implied:
Node)
Register Content
Displayed The FP value to be compared is stored here.
First implied
Second implied Registers are not used but their allocation in state RAM is required.
Third implied
Middle and When EMTH function CMPIF compares its integer and FP values, the combined
Bottom Output states of the middle and the bottom output indicate their relationship:
Middle Output Bottom Output Relationship
ON OFF integer > FP
OFF ON integer < FP
ON ON integer = FP
33002261 197
EMTH-CMPIF: Integer-Floating Point Comparison
198 33002261
EMTH-CNVDR: Floating Point
Conversion of Degrees to Radians
38
At a Glance
33002261 199
EMTH-CNVDR: Floating Point Conversion of Degrees to Radians
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
result
EMTH
CNVDR
200 33002261
EMTH-CNVDR: Floating Point Conversion of Degrees to Radians
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied:
Register Content
Displayed The value in FP format (See The IEEE Floating Point Standard,
First implied p. 158) of an angle in degrees is stored here.
Result in The first of four contiguous 4x registers is entered in the middle node. The remaining
Radians three registers are implied:
(Middle Node)
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The converted result in FP format (See The IEEE Floating Point
Third implied Standard, p. 158) of the top-node value (in radians) is posted here.
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 201
EMTH-CNVDR: Floating Point Conversion of Degrees to Radians
202 33002261
EMTH-CNVFI: Floating Point to
Integer Conversion
39
At a Glance
33002261 203
EMTH-CNVFI: Floating Point to Integer Conversion
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
FP
integer
EMTH
CNVFI
204 33002261
EMTH-CNVFI: Floating Point to Integer Conversion
Parameter Description
Integer Value The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied:
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The double precision integer result of the conversion is stored here.
Third implied This value should be the largest integer value possible that is ≤ the
FP value.
For example, the FP value 3.5 is converted to the integer value 3,
while the FP value -3.5 is converted to the integer value -4.
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
Runtime Errors If the resultant integer is too large for double precision integer format (> 99 999 999),
the conversion still occurs but an error is logged in the EMTH_ERLOG (See EMTH-
ERLOG: Floating Point Error Report Log, p. 235) function.
33002261 205
EMTH-CNVFI: Floating Point to Integer Conversion
206 33002261
EMTH-CNVIF: Integer-to-Floating
Point Conversion
40
At a Glance
33002261 207
EMTH-CNVIF: Integer-to-Floating Point Conversion
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
integer
result
EMTH
CNVIF
208 33002261
EMTH-CNVIF: Integer-to-Floating Point Conversion
Parameter Description
Integer Value The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied:
Register Content
Displayed The double precision integer value to be converted to 32-bit FP
First implied format (See The IEEE Floating Point Standard, p. 158) is stored
here.
Result The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied.
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The FP result of the conversion is posted here.
Third implied
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
Runtime Errors If an invalid integer value ( > 9 999) is entered in either of the two top-node registers,
the FP conversion will be performed but an error will be reported and logged in the
EMTH_ERLOG (See EMTH-ERLOG: Floating Point Error Report Log, p. 235)
function. The result of the conversion may not be correct.
33002261 209
EMTH-CNVIF: Integer-to-Floating Point Conversion
210 33002261
EMTH-CNVRD: Floating Point
Conversion of Radians to Degrees
41
At a Glance
33002261 211
EMTH-CNVRD: Floating Point Conversion of Radians to Degrees
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
result
EMTH
CNVRD
212 33002261
EMTH-CNVRD: Floating Point Conversion of Radians to Degrees
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied:
Register Content
Displayed The value in FP format (See The IEEE Floating Point Standard,
First implied p. 158) of an angle in radians is stored here.
Result in The first of four contiguous 4x registers is entered in the middle node. The remaining
Degrees three registers are implied.
(Middle Node)
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The converted result in FP format (See The IEEE Floating Point
Third implied Standard, p. 158) of the top-node value (in degrees) is posted here.
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 213
EMTH-CNVRD: Floating Point Conversion of Radians to Degrees
214 33002261
EMTH-COS: Floating Point Cosine
of an Angle (in Radians)
42
At a Glance
33002261 215
EMTH-COS: Floating Point Cosine of an Angle (in Radians)
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
cosine of
value
EMTH
COS
216 33002261
EMTH-COS: Floating Point Cosine of an Angle (in Radians)
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied.
Register Content
Displayed An FP value indicating the value of an angle in radians is stored
First implied here. The magnitude of this value must be < 65 536.0.
Cosine of Value The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The cosine of the value in the top node is posted here in FP format
Third implied (See The IEEE Floating Point Standard, p. 158).
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 217
EMTH-COS: Floating Point Cosine of an Angle (in Radians)
218 33002261
EMTH-DIVDP: Double Precision
Division
43
At a Glance
33002261 219
EMTH-DIVDP: Double Precision Division
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Double Precision Math (See Subfunctions for Double Precision Math, p. 156)".
Representation
operand 1
operand 2
quotient
remainder
EMTH
DIVDP
220 33002261
EMTH-DIVDP: Double Precision Division
Parameter Description
Operand 1 The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied.
Register Content
Displayed Low-order half of operand 1 is stored here.
First implied High-order half of Operand 1 is stored here.
Each register holds a value in the range 0000 ... 9 999, for a combined double
precision value in the range 0 ... 99 999 999.
Operand 2, The first of six contiguous 4x registers is entered in the middle node. The remaining
Quotient and five registers are implied
Remainder
Register Content
(Middle Node)
Displayed Register stores the low-order half of operand 2, respectively, for a
combined double precision value in the range 0 ... 99 999 999
First implied Register stores the high-order half of operand 2, respectively, for a
combined double precision value in the range 0 ... 99 999 999.
Second implied Registers store an eight-digit quotient.
Third implied
Fourth implied Registers store the remainder.
Fifth implied l f it is expressed as a decimal, it is four digits long and only the
fourth implied register is used.
l If it is expressed as a fraction, it is eight digits long and both
registers are used
Runtime Errors Since division by 0 is illegal, a 0 value causes an error, an error trapping routine sets
the remaining middle-node registers to 0000 and turns the bottom output ON.
33002261 221
EMTH-DIVDP: Double Precision Division
222 33002261
EMTH-DIVFI: Floating Point
Divided by Integer
44
At a Glance
33002261 223
EMTH-DIVFI: Floating Point Divided by Integer
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
FP
integer and
quotient
EMTH
DIVFI
224 33002261
EMTH-DIVFI: Floating Point Divided by Integer
Parameter Description
Floating Point The first of two contiguous 4x registers is entered in the top node. The second
Value (Top Node) register is implied:
Register Content
Displayed The FP value to be divided by the integer value is stored here.
First implied
Integer Value and The first of four contiguous 4x registers is entered in the middle node. The remaining
Quotient three registers are implied.
(Middle Node)
Register Content
Displayed The double precision integer value that divides the FP value is
First implied posted here.
Second implied The quotient is posted here in FP format (See The IEEE Floating
Third implied Point Standard, p. 158).
33002261 225
EMTH-DIVFI: Floating Point Divided by Integer
226 33002261
EMTH-DIVFP: Floating Point
Division
45
At a Glance
33002261 227
EMTH-DIVFP: Floating Point Division
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value 1
value 2 and
quotient
EMTH
DIVFP
228 33002261
EMTH-DIVFP: Floating Point Division
Parameter Description
Floating Point The first of two contiguous 4x registers is entered in the top node. The second
Value 1 register is implied:
(Top Node)
Register Content
Displayed FP value 1, which will be divided by the value 2, is stored here.
First implied
Floating Point The first of four contiguous 4x registers is entered in the middle node. The remaining
Value 2 and three registers are implied:
Quotient
Register Content
(Middle Node)
Displayed FP value 2, the value by which value 1 is divided, is stored here
First implied
Second implied The quotient is posted here in FP format (See The IEEE Floating
Third implied Point Standard, p. 158).
33002261 229
EMTH-DIVFP: Floating Point Division
230 33002261
EMTH-DIVIF: Integer Divided by
Floating Point
46
At a Glance
33002261 231
EMTH-DIVIF: Integer Divided by Floating Point
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
integer
FP and
quotient
EMTH
DIVIF
232 33002261
EMTH-DIVIF: Integer Divided by Floating Point
Parameter Description
Integer Value The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied:
Register Content
Displayed The double precision integer value to be divided by the FP value is
First implied stored here.
Floating Point The first of four contiguous 4x registers is entered in the middle node. The remaining
Value and three registers are implied.
Quotient
Register Content
(Middle Node)
Displayed The FP value to be divided in the operation is posted here.
First implied
Second implied The quotient is posted here in FP format (See The IEEE Floating
Third implied Point Standard, p. 158).
33002261 233
EMTH-DIVIF: Integer Divided by Floating Point
234 33002261
EMTH-ERLOG: Floating Point
Error Report Log
47
At a Glance
33002261 235
EMTH-ERLOG: Floating Point Error Report Log
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
not used
error data
EMTH
ERLOG
236 33002261
EMTH-ERLOG: Floating Point Error Report Log
Parameter Description
Not used The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied:
Register Content
Displayed These two registers are not used in the operation but their allocation
First implied in state RAM is required.
Error Data The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied.
Register Content
Displayed These two registers are not used but their allocation in state RAM is
First implied required.
Second implied Error log register, see table (See Error Log Register, p. 237 ).
Third implied This register has all its bits cleared to zero.
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since these registers must be allocated but
none are used.
Bit Function
1-8 Function code of last error logged
9 - 11 Not used
12 Integer/FP conversion error
13 Exponential function power too large
14 Invalid FP value or operation
15 FP overflow
16 FP underflow
If the bit is set to 1, then the specific error condition exists for that bit.
33002261 237
EMTH-ERLOG: Floating Point Error Report Log
238 33002261
EMTH-EXP: Floating Point
Exponential Function
48
At a Glance
33002261 239
EMTH-EXP: Floating Point Exponential Function
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
result
EMTH
EXP
240 33002261
EMTH-EXP: Floating Point Exponential Function
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied:
Register Content
Displayed A value in FP format (See The IEEE Floating Point Standard, p. 158)
First implied in the range -87.34 ... +88.72 is stored here.
If the value is out of range, the result will either be 0 or the maximum
value. No error will be flagged.
Result The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied:
Register Content
Displayed These registers are not used but their allocation in state RAM is
First implied required
Second implied The exponential of the value in the top node is posted here in FP
Third implied format (See The IEEE Floating Point Standard, p. 158).
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 241
EMTH-EXP: Floating Point Exponential Function
242 33002261
EMTH-LNFP: Floating Point
Natural Logarithm
49
At a Glance
33002261 243
EMTH-LNFP: Floating Point Natural Logarithm
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
result
EMTH
LNFP
244 33002261
EMTH-LNFP: Floating Point Natural Logarithm
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied:
Register Content
Displayed A value > 0 is stored here in FP format (See The IEEE Floating Point
First implied Standard, p. 158).
If the value ≤ 0, an invalid result will be returned in the middle node
and an error will be logged in the EMTH-ERLOG function.
Result The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied:
Register Content
Displayed These registers are not used but their allocation in state RAM is
First implied required
Second implied The natural logarithm of the value in the top node is posted here in
Third implied FP format (See The IEEE Floating Point Standard, p. 158).
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 245
EMTH-LNFP: Floating Point Natural Logarithm
246 33002261
EMTH-LOG: Base 10 Logarithm
50
At a Glance
33002261 247
EMTH-LOG: Base 10 Logarithm
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Integer Math (See Subfunctions for Integer Math, p. 156)".
Representation
source
result
EMTH
LOG
248 33002261
EMTH-LOG: Base 10 Logarithm
Parameter Description
Source Value The first of two contiguous 3x or 4x registers is entered in the top node. The second
(Top Node) register is implied. The source value upon which the log calculation will be
performed is stored in these registers.
If you specify a 4x register, the source value may be in the range 0 ... 99 999 99:
Register Content
Displayed The high-order half of the value is stored here.
First implied The low-order half of the value is stored here.
If you specify a 3x register, the source value may be in the range 0 ... 9 999:
Register Content
Displayed The source value upon which the log calculation will be performed is
stored here
First implied This register is required but not used.
Result The middle node contains a single 4x holding register where the result of the base
(Middle Node) 10 log calculation is posted. The result is expressed in the fixed decimal format
1.234, and is truncated after the third decimal position.
The largest result that can be calculated is 7.999, which would be posted in the
middle register as 7999.
33002261 249
EMTH-LOG: Base 10 Logarithm
250 33002261
EMTH-LOGFP: Floating Point
Common Logarithm
51
At a Glance
33002261 251
EMTH-LOGFP: Floating Point Common Logarithm
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
result
EMTH
LOGFP
252 33002261
EMTH-LOGFP: Floating Point Common Logarithm
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied:
Register Content
Displayed A value > 0 is stored here in FP format (See The IEEE Floating Point
First implied Standard, p. 158).
If the value ≤ 0, an invalid result will be returned in the middle node
and an error will be logged in the EMTH-ERLOG function.
Result The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied:
Register Content
Displayed These registers are not used but their allocation in state RAM is
First implied required
Second implied The common logarithm of the value in the top node is posted here in
Third implied FP format (See The IEEE Floating Point Standard, p. 158).
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 253
EMTH-LOGFP: Floating Point Common Logarithm
254 33002261
EMTH-MULDP: Double Precision
Multiplication
52
At a Glance
33002261 255
EMTH-MULDP: Double Precision Multiplication
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Double Precision Math (See Subfunctions for Double Precision Math, p. 156)".
Representation
operand 1
operand 2/
product
EMTH
MULDP
256 33002261
EMTH-MULDP: Double Precision Multiplication
Parameter Description
Operand 1 The first of two contiguous 4x registers is entered in the top node. The second 4x
(Top Node) register is implied. Operand 1 is stored here.
Register Content
Displayed Register stores the low-order half of operand 1
Range 0 000 ... 9 999, for a combined double precision value in the
range 0 ... 99 999 999
First implied Register stores the high-order half of operand 1
Range 0 000 ... 9 999, for a combined double precision value in the
range 0 ... 99 999 999
Operand 2 and The first of six contiguous 4x registers is entered in the middle node. The remaining
Product five registers are implied:
(Middle Node)
Register Content
Displayed Register stores the low-order half of operand 2, respectively, for a
combined double precision value in the range 0 ... 99 999 999
First implied Register stores the high-order half of operand 2, respectively, for a
combined double precision value in the range 0 ... 99 999 999
Second implied These registers store the double precision product in the range
Third implied 0 ... 9 999 999 999 999 999
Fourth implied
Fifth implied
33002261 257
EMTH-MULDP: Double Precision Multiplication
258 33002261
EMTH-MULFP: Floating Point
Multiplication
53
At a Glance
33002261 259
EMTH-MULFP: Floating Point Multiplication
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value 1
value 2 and
product
EMTH
MULFP
260 33002261
EMTH-MULFP: Floating Point Multiplication
Parameter Description
Floating Point The first of two contiguous 4x registers is entered in the top node. The second
Value 1 register is implied:
(Top Node)
Register Content
Displayed FP value 1 in the multiplication operation is stored here.
First implied
Floating Point The first of four contiguous 4x registers is entered in the middle node. The remaining
Value 2 and three registers are implied:
Product
Register Content
(Middle Node)
Displayed FP value 2 in the multiplication operation is stored here.
First implied
Second implied The product of the multiplication is stored here in FP format (See
Third implied The IEEE Floating Point Standard, p. 158).
33002261 261
EMTH-MULFP: Floating Point Multiplication
262 33002261
EMTH-MULIF: Integer x Floating
Point Multiplication
54
At a Glance
33002261 263
EMTH-MULIF: Integer x Floating Point Multiplication
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
integer
FP and
product
EMTH
MULIF
264 33002261
EMTH-MULIF: Integer x Floating Point Multiplication
Parameter Description
Integer Value The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied:
Register Content
Displayed The double precision integer value to be multiplied by the FP value
First implied is stored here.
FP Value and The first of four contiguous 4x registers is entered in the middle node. The remaining
Product (Middle three registers are implied:
Node)
Register Content
Displayed The FP value to be multiplied in the operation is stored here.
First implied
Second implied The product of the multiplication is stored here in FP format (See
Third implied The IEEE Floating Point Standard, p. 158).
33002261 265
EMTH-MULIF: Integer x Floating Point Multiplication
266 33002261
EMTH-PI: Load the Floating Point
Value of "Pi"
55
At a Glance
Introduction This chapter describes the EMTH subfunction EMTH-PI (Load the Floating Point
Value of π).
33002261 267
EMTH-PI: Load the Floating Point Value of "Pi"
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
not used
FP value
of π
EMTH
PI
268 33002261
EMTH-PI: Load the Floating Point Value of "Pi"
Parameter Description
Not used The first of two contiguous 4x registers is entered in the middle node. The second
(Top Node) register is implied:
Register Content
Displayed These registers are not used but their allocation in state RAM is
First implied required.
Floating Point The first of four contiguous 4x registers is entered in the middle node. The remaining
Value of π three registers are implied:
(Middle Node)
Register Content
Displayed These registers are not used but their allocation in state RAM is
First implied required.
Second implied The FP value of π is posted here.
Third implied
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 269
EMTH-PI: Load the Floating Point Value of "Pi"
270 33002261
EMTH-POW: Raising a Floating
Point Number to an Integer Power
56
At a Glance
33002261 271
EMTH-POW: Raising a Floating Point Number to an Integer Power
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
FP value
integer
and result
EMTH
POW
272 33002261
EMTH-POW: Raising a Floating Point Number to an Integer Power
Parameter Description
FP Value The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied:
Register Content
Displayed The FP value to be raised to the integer power is stored here.
First implied
Integer and The first of four contiguous 4x registers is entered in the middle node. The remaining
Result three registers are implied:
(Middle Node)
Register Content
Displayed The bit values in this register must all be cleared to zero.
First implied An integer value representing the power to which the top-node value
will be raised is stored here.
Second implied The result of the FP value being raised to the power of the integer
Third implied value is stored here.
33002261 273
EMTH-POW: Raising a Floating Point Number to an Integer Power
274 33002261
EMTH-SINE: Floating Point Sine of
an Angle (in Radians)
57
At a Glance
33002261 275
EMTH-SINE: Floating Point Sine of an Angle (in Radians)
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
sine of
value
EMTH
SINE
276 33002261
EMTH-SINE: Floating Point Sine of an Angle (in Radians)
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied.
Register Content
Displayed An FP value indicating the value of an angle in radians is stored
First implied here. The magnitude of this value must be < 65 536.0.
Sine of Value The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The sine of the value in the top node is posted here in FP format
Third implied (See The IEEE Floating Point Standard, p. 158).
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 277
EMTH-SINE: Floating Point Sine of an Angle (in Radians)
278 33002261
EMTH-SQRFP: Floating Point
Square Root
58
At a Glance
33002261 279
EMTH-SQRFP: Floating Point Square Root
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
result
EMTH
SQRFP
280 33002261
EMTH-SQRFP: Floating Point Square Root
Parameter Description
Floating Point The first of two contiguous 4x registers is entered in the top node. The second
Value (Top Node) register is implied.
Register Content
Displayed The FP value on which the square root operation is performed is
First implied stored here.
Result The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The result of the square root operation is posted here in FP format
Third implied (See The IEEE Floating Point Standard, p. 158).
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 281
EMTH-SQRFP: Floating Point Square Root
282 33002261
EMTH-SQRT: Floating Point
Square Root
59
At a Glance
33002261 283
EMTH-SQRT: Floating Point Square Root
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Integer Math (See Subfunctions for Integer Math, p. 156)".
Representation
source
result
EMTH
SQRT
284 33002261
EMTH-SQRT: Floating Point Square Root
Parameter Description
Source Value The first of two contiguous 3x or 4x registers is entered in the top node. The second
(Top Node) register is implied. The source value, i.e. the value for which the square root will be
derived, is stored here.
If you specify a 4x register, the source value may be in the range 0 ... 99 999 99:
Register Content
Displayed The high-order half of the value is stored here.
First implied The low-order half of the value is stored here.
If you specify a 3x register, the source value may be in the range 0 ... 9 999:
Register Content
Displayed The square root calculation is done on only the value in the
displayed register
First implied This register is required but not used.
Result Enter the first of two contiguous 4x registers in the middle node. The second register
(Middle Node) is implied. The result of the standard square root operation is stored here in the
fixed-decimal format: 1234.5600.:.
Register Content
Displayed This register stores the four-digit value to the left of the first decimal
point.
First implied This register stores the four-digit value to the right of the first decimal
point.
Note: Numbers after the second decimal point are truncated; no round-off
calculations are performed.
33002261 285
EMTH-SQRT: Floating Point Square Root
286 33002261
EMTH-SQRTP: Process Square
Root
60
At a Glance
33002261 287
EMTH-SQRTP: Process Square Root
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Integer Math (See Subfunctions for Integer Math, p. 156)".
The process square root function tailors the standard square root function for closed
loop analog control applications. It takes the result of the standard square root result,
multiplies it by 63.9922 (the square root of 4 095) and stores that linearized result in
the middle-node registers.
The process square root is often used to linearize signals from differential pressure
flow transmitters so that they may be used as inputs in closed loop control
operations.
Representation
source
linearized
result
EMTH
SQRTP
288 33002261
EMTH-SQRTP: Process Square Root
Parameter Description
Source Value The first of two contiguous 3x or 4x registers is entered in the top node. The second
(Top Node) register is implied. The source value, i.e. the value for which the square root will be
derived, is stored here. In order to generate values that have meaning, the source
value must not exceed 4 095.
If you specify a 4x register:
Register Content
Displayed Not used
First implied The source value will be stored here
Linearized The first of two contiguous 4x registers is entered in the middle node. The second
Result register is implied. The linearized result of the process square root operation is
(Middle Node) stored here n the fixed-decimal format 1234.5600..
Register Content
Displayed This register stores the four-digit value to the left of the first decimal
point.
First implied This register stores the four-digit value to the right of the first decimal
point.
Note: Numbers after the second decimal point are truncated; no round-off
calculations are performed.
33002261 289
EMTH-SQRTP: Process Square Root
Example
Process Square This example gives a quick overview of how the process square root is calculated.
Root Function Instruction
300030
400030
EMTH
SQRTP
2000 = 0044.72
Then this result is multiplied by 63.9922, yielding a linearized result of 2861.63:
0044.72 × 63.9922 = 2861.63
The linearized result is placed in the two registers in the middle node:
Register Part of the result
400030 2861 (four-digit value to the left of the first decimal point)
400031 6300 (four-digit value to the right of the first decimal point)
290 33002261
EMTH-SUBDP: Double Precision
Subtraction
61
At a Glance
33002261 291
EMTH-SUBDP: Double Precision Subtraction
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Double Precision Math (See Subfunctions for Double Precision Math, p. 156)".
Representation
operand 1
operand 2/
difference
EMTH
SUBDP
292 33002261
EMTH-SUBDP: Double Precision Subtraction
Parameter Description
Operand 1 The first of two contiguous 4x registers is entered in the top node. The second 4x
(Top Node) register is implied. Operand 1 is stored here.
Register Content
Displayed Register stores the low-order half of operand 1
Range 0 000 ... 9 999, for a combined double precision value in the
range 0 ... 99 999 999
First implied Register stores the high-order half of operand 1
Range 0 000 ... 9 999, for a combined double precision value in the
range 0 ... 99 999 999
Operand 2 and The first of six contiguous 4x registers is entered in the middle node. The remaining
Product five registers are implied:
(Middle Node)
Register Content
Displayed Register stores the low-order half of operand 2 for a combined
double precision value in the range 0 ... 99 999 999
First implied Register stores the high-order half of operand 2 for a combined
double precision value in the range 0 ... 99 999 999
Second implied This register stores the low-order half of the absolute difference in
double precision format
Third implied This register stores the high-order half of the absolute difference in
double precision format
Fourth implied 0 = operands in range
1 = operands out of range
Fifth implied This register is not used in the calculation but must exist in state
RAM.
33002261 293
EMTH-SUBDP: Double Precision Subtraction
294 33002261
EMTH-SUBFI: Floating Point -
Integer Subtraction
62
At a Glance
33002261 295
EMTH-SUBFI: Floating Point - Integer Subtraction
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
FP
integer and
difference
EMTH
SUBFI
296 33002261
EMTH-SUBFI: Floating Point - Integer Subtraction
Parameter Description
Floating Point The first of two contiguous 4x registers is entered in the top node. The second
Value (Top Node) register is implied.
Register Content
Displayed The FP value from which the integer value is subtracted is stored
First implied here.
Sine of Value The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied
Register Content
Displayed Registers store the double precision integer value to be subtracted
First implied from the FP value.
Second implied The difference is posted here in FP format (See The IEEE Floating
Third implied Point Standard, p. 158).
33002261 297
EMTH-SUBFI: Floating Point - Integer Subtraction
298 33002261
EMTH-SUBFP: Floating Point
Subtraction
63
At a Glance
33002261 299
EMTH-SUBFP: Floating Point Subtraction
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value 1
value 2 and
difference
EMTH
SUBFP
300 33002261
EMTH-SUBFP: Floating Point Subtraction
Parameter Description
Floating Point The first of two contiguous 4x registers is entered in the top node. The second
Value 1 register is implied.
(Top Node)
Register Content
Displayed FP value 1 (the value from which value 2 will be subtracted) is stored
First implied here.
Floating Point The first of four contiguous 4x registers is entered in the middle node. The remaining
Value 2 three registers are implied
(Top Node)
Register Content
Displayed FP value 2 (the value to be subtracted from value 1) is stored in
First implied these registers
Second implied The difference of the subtraction is stored here in FP format (See
Third implied The IEEE Floating Point Standard, p. 158).
33002261 301
EMTH-SUBFP: Floating Point Subtraction
302 33002261
EMTH-SUBIF: Integer - Floating
Point Subtraction
64
At a Glance
33002261 303
EMTH-SUBIF: Integer - Floating Point Subtraction
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
integer
FP and
difference
EMTH
SUBIF
304 33002261
EMTH-SUBIF: Integer - Floating Point Subtraction
Parameter Description
Integer Value The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied.
Register Content
Displayed The double precision integer value from which the FP value is
First implied subtracted is stored here.
FP Value and The first of four contiguous 4x registers is entered in the middle node. The remaining
Difference three registers are implied
(Middle Node)
Register Content
Displayed Registers store the FP value to be subtracted from the integer value.
First implied
Second implied The difference is posted here in FP format (See The IEEE Floating
Third implied Point Standard, p. 158).
33002261 305
EMTH-SUBIF: Integer - Floating Point Subtraction
306 33002261
EMTH-TAN: Floating Point
Tangent of an Angle (in Radians)
65
At a Glance
33002261 307
EMTH-TAN: Floating Point Tangent of an Angle (in Radians)
Short Description
Function This instruction is a subfunction of the EMTH instruction. It belongs to the category
Description "Floating Point Math (See Subfunctions for Floating Point Math, p. 157)".
Representation
value
tangent of
value
EMTH
TAN
308 33002261
EMTH-TAN: Floating Point Tangent of an Angle (in Radians)
Parameter Description
Value (Top Node) The first of two contiguous 4x registers is entered in the top node. The second
register is implied.
Register Content
Displayed An FP value indicating the value of an angle in radians is stored
First implied here. The magnitude of this value must be < 65 536.0.
Tangent of Value The first of four contiguous 4x registers is entered in the middle node. The remaining
(Middle Node) three registers are implied
Register Content
Displayed Registers are not used but their allocation in state RAM is required.
First implied
Second implied The tangent of the value in the top node is posted here in FP format
Third implied (See The IEEE Floating Point Standard, p. 158).
Note: To preserve registers, you can make the 4x reference numbers assigned to
the displayed register and the first implied register in the middle node equal to the
register references in the top node, since the first two middle-node registers are not
used.
33002261 309
EMTH-TAN: Floating Point Tangent of an Angle (in Radians)
310 33002261
ESI: Support of the ESI Module
66
At a Glance
33002261 311
ESI: Support of the ESI Module
Short Description
Function
Description
Note: This instruction is only available if you have unpacked and installed the DX
Loadables. For further information, see Installation of DX Loadable in Concept
Block Library LL984 (840 USE 506 00, Version 2.6).
The instruction for the ESI module 140 ESI 062 10 are optional loadable instructions
that can be used in a Quantum controller system to support operations using a ESI
module. The controller can use the ESI instruction to invoke the module. The power
of the loadable is its ability to cause a sequence of commands over one or more logic
scans.
With the ESI instruction, the controller can invoke the ESI module to:
l Read an ASCII message from a serial port on the ESI module, then perform a
sequence of GET DATA transfers from the module to the controller.
l Write an ASCII message to a serial port on the ESI module after having
performed a sequence of PUT DATA transfers to the variable data registers in the
module.
l Perform a sequence of GET DATA transfers (up to 16 384 registers of data from
the ESI module to the controller); one Get Data transfer will move up to 10 data
registers each time the instruction is solved.
l Perform a sequence of PUT DATA (up to 16 384 registers of data to the ESI
module from the controller). One PUT DATA transfer moves up to 10 registers of
data each time the instruction is solved.
l Abort the ESI loadable command sequence running.
Note: After placing the ESI instruction in your ladder diagram you must enter the
top, middle and bottom parameters. Proceed by double clicking on the instruction.
This action produces a form for the entry of the 3 paramteers. This parametric must
be completed to enable the DX zoom function in the Edit menu pulldown.
312 33002261
ESI: Support of the ESI Module
Representation
subfunction #
(1 ... 4)
subfunction
parameters
ESI
length
33002261 313
ESI: Support of the ESI Module
Parameter Description
Top Input When the input to the top node is powered ON, it enables the ESI instruction and
starts executing the command indicated by the subfunction code in the top node.
Middle Input When the input to the middle node is powered ON, an Abort command is issued. If
a message is running when the ABORT command is received, the instruction will
complete; if a data transfer is in process when the ABORT command is received, the
transfer will stop and the instruction will complete.
Subfunction # The top node may contain either a 4x register or an integer. The integer or the value
(Top Node) in the register must be in the range 1 ... 4.
It represents one of four possible subfunction command sequences to be executed
by the instruction:
Subfunction Command Sequence
1 One command READ ASCII Message, p. 317 followed by multiple GET
DATA commands
2 Multiple PUT DATA commands followed by one command WRITE ASCII
Message, p. 322
3 Zero or more commands GET DATA, p. 323
4 Zero or more commands PUT DATA, p. 325
Note: A fifth command, ABORT ASCII Message (See ABORT, p. 329), can be
initiated by enabling the middle input to the ESI instruction.
314 33002261
ESI: Support of the ESI Module
Subfunction The first of eighteen contiguous 4x registers is entered in the middle node. The
Parameters ramaining seventeen registers are implied.
(Middle Node) The following subfunction parameters are available:
Register Parameter Contents
Displayed ESI status register Returned error codes
First implied Address of the first 4x register Register address minus the leading 4 and
in the command structure any leading zeros, as specified in the I/O
Map (e.g., 1 represents register 400001)
Second Address of the first 3x register Register address minus the leading 3 and
implied in the command structure any leading zeros, as specified in the I/O
Map (e.g., 7 represents register 300007)
Third implied Address of the first 4x register Register address minus the leading 4 and
in the controller's data register any leading zeros (e.g., 100 representing
area register 400100)
Fourth implied Address of the first 3x register Register address minus the leading 3 and
in the controller's data register any leading zeros (e.g., 1000 representing
area register 301000)
Fifth implied Starting register for data Number in the range 0 ... 3FFF hex
register area in module
Sixth implied Data transfer count Number in the range 0 ... 4000 hex
Seventh ESI timeout value, in 100 ms Number in the range 0 ... FFFF hex, where
implied increments 0 means no timeout
Eighth implied ASCII message number Number in the range 1 ... 255 dec
Ninth implied ASCII port number 1 or 2
Note: The registers below are internally used by the ESI loadable. Do not write registers
while the ESI loadable is running. For best use, initialize these registers to 0 (zero) when the
loadable is inserted into logic.
10th implied ESI loadable previous scan power in state
11th implied Data left to transfer
12th implied Current ASCII module command running
13th implied ESI loadable sequence number
14th implied ESI loadable flags
15th implied ESI loadable timeout value (MSW)
16th implied ESI loadable timeout value (LSW)
17th implied Parameter Table Checksum generated by ESI loadable
33002261 315
ESI: Support of the ESI Module
Note: Once power has been applied to the top input, the ESI loadable starts
running. Until the ESI loadable compiles (successfully or in error), the subfunction
parameters should not be modified. If the ESI loadable detects a change, the
loadable will compile in error (Parameter Table Checksum Error (See Run Time
Errors, p. 330)).
Length The bottom node contains the length of the table in the middle node, i.e., the number
(Bottom Node) of subfunction parameter registers. For READ/ WRITE operations, the length must
be 10 registers. For PUT/GET operations, the required length is eight registers; 10
may be specified and the last two registers will be unused.
Ouptuts
Note: NSUP must be loaded before ESI in order for the loadable to work properly.
If ESI is loaded before NSUP or ESI is loaded alone, all three outputs will be turned
ON.
Middle Output The middle output goes ON for one scan when the subfunction operation specified
in the top node is completed, timed out, or aborted
Bottom Output The bottom output goes ON for one scan if an error has been detected. Error
checking is the first thing that is performed on the instruction when it is enabled. For
more details see error checking (See Run Time Errors, p. 330).
316 33002261
ESI: Support of the ESI Module
READ ASCII A READ ASCII command causes the ESI module to read incoming data from one of
Message its serial ports and store the data in internal variable data registers. The serial port
number is specified in the tenth (ninth implied) register of the subfunction
parameters table. The ASCII message number to be read is specified in the ninth
(eighth implied) register of the subfunction parameters table (See Subfunction
Parameters (Middle Node), p. 315). The received data is stored in the 16K variable
data space in user-programmed formats.
When the top node of the ESI instruction is 1, the controller invokes the module and
causes it to execute one READ ASCII command followed by a sequence of GET
DATA commands (transferring up to 16,384 registers of data) from the module to the
controller.
33002261 317
ESI: Support of the ESI Module
A Comparative Below is an example of how an ESI loadable instruction can simplify your logic
READ ASCII programming task in an ASCII read application. Assume that the 12-point
Message/Put bidirectional ESI module has been I/O mapped to 400001 ... 400012 output registers
Data Example and 300001 ... 300012 input registers. We want to read ASCII message #10 from
port 1, then transfer four words of data to registers 400501 ... 400504 in the
controller.
Parameterizing of the ESI instruction:
#0001
401000
ESI
#0018
The subfunction parameter table begins at register 401000 . Enter the following
parameters in the table:
Register Parameter Value Description
401000 nnnn ESI status register
401001 1 I/O mapped output starting register (400001)
401002 1 I/O mapped input starting register (300001)
401003 501 Starting register for the data transfer (400501)
401004 0 No 3x starting register for the data transfer
401005 100 Module start register
401006 4 Number of registers to transfer
401007 600 timeout = 60 s
401008 10 ASCII message number
401009 1 ASCII port number
401010-17 N/A Internal loadable variables
With these parameters entered to the table, the ESI instruction will handle the read
and data transfers automatically in one scan.
318 33002261
ESI: Support of the ESI Module
Read and Data The same task could be accomplished in ladder logic without the ESI loadable, but
Transfers it would require the following three networks to set up the command and transfer
without ESI parameters, then copy the data. Registers 400101 ... 400112 are used as
Instruction workspace for the output values. Registers 400201 ... 400212 are initial READ
ASCII Message command values. Registers 400501 ... 400504 are the data space
for the received data from the module.
First Network
000011 000011
400201 400101
000011
400101 400001
BLKM BLKM
#0012 #0012
Contents of registers
Register Value (hex) Description
400201 0114 READ ASCII Message command, Port 1, Four registers
400202 0064 Module’s starting register
400203 nnnn Not valid: data word 1
... ... ...
400212 nnnn Not valid: data word 10
The first network starts up the READ ASCII Message command by turning ON coil
000011 forever. It moves the READ ASCII Message command into the workspace,
then moves the workspace to the output registers for the module.
33002261 319
ESI: Support of the ESI Module
Second Network
BLKM AND
#0001 #0001
Contents of registers
Register Value (hex) Description
400098 nnnn Workspace for response word
400099 nnnn Workspace for response word
400088 7FFF Response word mask
400089 8000 Status word valid bit mask
As long as coil 000011 is ON, READ ASCII Message response Word 0 in the input
register is tested to make sure it is the same as command Word 0 in the workspace.
This is done by ANDing response Word 0 in the input register with 7FFF hex to get
rid of the Status Word Valid bit (bit 15) in Response Word 0.
The module start register in the input register is also tested against the module start
register in the workspace to make sure that they are the same.
If both these tests show matches, test the Status Word Valid bit in response Word
0. To do this, AND response Word 0 in the input register with 8000 hex to get rid of
the echoed command word 0 information. If the ANDed result equals the Status
Word Valid bit, coil 000020 is turned ON indicating an error and/or status in the
Module Status Word. If the ANDed result is not the status word valid bit, coil 000012
is turned ON indicating that the message is done and that you can start another
command in the module.
320 33002261
ESI: Support of the ESI Module
Third Network
300012
000020 000099
#0001
TEST
#0001
If coil 000020 is ON, this third network will test the Module Status Word for busy
status. If the module is busy, do nothing. If the Module Status Word is greater than
1 (busy), a detected error has been logged in the high byte and coil 000099 will be
turned ON. At this point, you need to determine what the error is by using some
error-handling logic that you have developed.
33002261 321
ESI: Support of the ESI Module
WRITE ASCII In a WRITE ASCII Message command, the ESI module writes an ASCII message to
Message one of its serial ports. The serial port number is specified in the tenth (ninth implied)
register of the subfunction parameters table (See Subfunction Parameters (Middle
Node), p. 315). The ASCII message number to be written is specified in the ninth
(eighth implied) register of the subfunction parameters table.
When the top node of the ESI instruction is 2, the controller invokes the module and
causes it to execute one Write ASCII command. Before starting the WRITE
command, subfunction 2 executes a sequence of PUT DATA transfers (transferring
up to 16 384 registers of data) from the controller to the module.
322 33002261
ESI: Support of the ESI Module
GET DATA A GET DATA command transfers up to 10 registers of data from the ESI module to
the controller each time the ESI instruction is solved in ladder logic. The total number
of words to be read is specified in Word 0 of the GET DATA command structure (the
data count). The data is returned in increments of 10 in Words 2 ... 11 in the GET
DATA response structure.
If a sequence of GET DATA commands is being executed in conjunction with a
READ ASCII Message command (via subfunction 1), up to nine registers are
transferred when the instruction is solved the first time. Additional data are returned
in groups of ten registers on subsequent solves of the instruction until all the data
has been transferred
If there is an error condition to be reported (other than a command syntax error), it
is reported in Word 11 in the GET DATA response structure. If the command has
requested 10 registers and the error needs to be reported, only nine registers of data
will be returned in Words 2 ... 10, and Word 11 will be used for error status.
Note: If the data count and starting register number that you specify are valid but
some of the registers to be read are beyond the valid register range, only data from
the registers in the valid range will be read. The data count returned in Word 0 of
the response structure will reflect the number of valid data registers returned, and
an error code (1280 hex) will be returned in the Module Status Word (Word 11 in
the response table).
33002261 323
ESI: Support of the ESI Module
324 33002261
ESI: Support of the ESI Module
PUT DATA A PUT DATA command writes up to 10 registers of data to the ESI module from the
controller each time the ESI instruction is solved in ladder logic. The total number of
words to be written is specified in Word 0 of the PUT DATA command structure (the
data count).
The data is returned in increments of 10 in words 2 ... 11 in the PUT DATA command
structure. The command is executed sequentially until command word 0 changes to
another command other than PUT DATA (040D hex).
Note: If the data count and starting register number that you specify are valid but
some of the registers to be written are beyond the valid register range, only data
from the registers in the valid range will be written. The data count returned in Word
0 of the response structure will reflect the number of valid data registers returned,
and an error code (1280 hex) will be returned in the Module Status Word (Word 11
in the response table).
33002261 325
ESI: Support of the ESI Module
A Comparative Below is an example of how an ESI loadable instruction can simplify your logic
PUT DATA programming task in a PUT DATA application. Assume that the 12-point
Example bidirectional ESI 062 module has been I/O mapped to 400001 ... 400012 output
registers and 300001 ... 300012 input registers. We want to put 30 controller data
registers, starting at register 400501, to the ESI module starting at location 100.
Parameterizing of the ESI instruction:
#0004
401000
ESI
#0018
The subfunction parameter table begins at register 401000 . Enter the following
parameters in the table:
Register Parameter Value Description
401000 nnnn ESI status register
401001 1 I/O mapped output starting register (400001)
401002 1 I/O mapped input starting register (300001)
401003 501 Starting register for the data transfer (400501)
401004 0 No 3x starting register for the data transfer
401005 100 Module start register
401006 30 Number of registers to transfer
401007 0 timeout = never
401008 N/A ASCII message number
401009 N/A ASCII port number
401009 N/A Internal loadable variables
With these parameters entered to the table, the ESI instruction will handle the data
transfers automatically over three ESI logic solves.
326 33002261
ESI: Support of the ESI Module
Handling of Data The same task could be accomplished in ladder logic without the ESI loadable, but
Transfer without it would require the following four networks to set up the command and transfer
ESI Instruction parameters, then copy data multiple times until the operation is complete. Registers
400101 ... 400112 are used as workspace for the output values. Registers 400201
... 400212 are initial PUT DATA command values. Registers 400501 ... 400530 are
the data registers to be sent to the module.
First Network - Command Register Network
000011 000011
Contents of registers
Register Value (hex) Description
400201 040A PUT DATA command, 10 registers
400202 0064 Module’s starting register
400203 nnnn Not valid: data word 1
... ... ...
400212 nnnn Not valid: data word 10
The first network starts up the transfer of the first 10 registers by turning ON coil
000011 forever. It moves the initial PUT DATA command into the workspace, moves
the first 10 registers (400501 ... 400510) into the workspace, and then moves the
workspace to the output registers for the module.
33002261 327
ESI: Support of the ESI Module
000020 000020
300001
000011 000020
400101 300002
As long as coil 000011 is ON and coil 000020 is OFF, PUT DATA response word 0
in the input register is tested to make sure it is the same as the command word in
the workspace. The module start register in the input register is also tested to make
sure it is the same as the module start register in the workspace.
If both these tests show matches, the current module start register is tested against
what would be the module start register of the last PUT DATA command for this
transfer. If the test shows that the current module start register is greater than or
equal to the last PUT DATA command, coil 000020 goes ON indicating that the
transfer is done. If the test shows that the current module start register is less than
the last PUT DATA command, coil 000012 indicating that the next 10 registers
should be transferred.
Third Network - Command Register Network
400102 400102
000012
#0100 #0110
TEST TEST
#0001 #0001
400511 400521
400103 400103
BLKM BLKM
#0010 #0010
As long as coil 000012 is ON, there is more data to be transferred. The module start
register needs to be tested from the last command solve to determine which set of
10 registers to transfer next. For example, if the last command started with module
register 400110, then the module start register for this command is 400120.
328 33002261
ESI: Support of the ESI Module
400101
000012
400001
#0010
BLKM
400102
#0012
AD16
400102
As long as coil 000012 is ON, add 10 to the module start register value in the
workspace and move the workspace to the output registers for the module to start
the next transfer of 10 registers.
ABORT When the middle input to the ESI instruction is powered ON, the instruction aborts
a running ASCII READ or WRITE message. The serial port buffers of the module
are not affected by the ABORT, only the message that is currently running.
33002261 329
ESI: Support of the ESI Module
Run Time Errors The command sequence executed by the ESI module (specified by the subfunction
value (See Subfunction # (Top Node), p. 314) in the top node of the ESI instruction)
needs to go through a series of error checking routines before the actual command
execution begins. If an error is detected, a message is posted in the register
displayed in the middle node.
The following table lists possible error message codes and their meanings:
Error Code (dec) Meaning
0001 Unknown subfunction specified in the top node
0010 ESI instruction has timed out (exceeded the time specified in the eighth
register of the subfunction parameter table (See Subfunction
Parameters (Middle Node), p. 315)
0101 Error in the READ ASCII Message sequence
0102 Error in the WRITE ASCII Message sequence
0103 Error in the GET DATA sequence
0104 Error in the PUT DATA sequence
1000 Length (Bottom Node), p. 316 is too small
1001 Nonzero value in both the 4x and 3x data offset parameters
1002 Zero value in both the 4x and 3x data offset parameters
1003 4x or 3x data offset parameter out of range
1004 4x or 3x data offset plus transfer count out of range
1005 3x data offset parameter set for GET DATA
1006 Parameter Table Checksum error
1101 Output registers from the offset parameter out of range
1102 Input registers from the offset parameter out of range
2001 Error reported from the ESI module
Once the parameter error checking has completed without finding an error, the ESI
module begins to execute the command sequence.
330 33002261
EUCA: Engineering Unit
Conversion and Alarms
67
At a Glance
33002261 331
EUCA: Engineering Unit Conversion and Alarms
Short Description
Function
Description
Note: This instruction is only available, if you have unpacked and installed the DX
Loadables; further information you will find in "IInstallation of DX Loadables, p. 71".
The use of ladder logic to convert binary-expressed analog data into decimal units
can be memory-intensive and scan-time intensive operation. The Engineering Unit
Conversion and Alarms (EUCA) loadable is designed to eliminate the need for extra
user logic normally required for these conversions. EUCA scales 12 bits of binary
data (representing analog signals or other variables) into engineering units that are
readily usable for display, data logging, or alarm generation.
Using Y = mX + b linear conversion, binary values between 0 ... 4095 are converted
to a scaled process variable (SPV). The SPV is expressed in engineering units in
the range 0 ... 9 999.
One EUCA instruction can perform up to four separate engineering unit conversions.
It also provides four levels of alarm checking on each of the four conversions:
Level Meaning
HA High absolute
HW High warning
LW Low warning
LA Low absolute
332 33002261
EUCA: Engineering Unit Conversion and Alarms
Representation
alarm
status
parameter
table
EUCA
nibble #
(1 ... 4)
33002261 333
EUCA: Engineering Unit Conversion and Alarms
Parameter Description
Alarm Status The 4x register entered in the top node displays the alarm status for as many as four
(Top Node) EUCA conversions, which can be performed by the instruction. The register is
segmented into four four-bit nibbles. Each four-bit nibble represents the four
possible alarm conditions for an individual EUCA conversion.
The most significant nibble represents the first conversion, and the least significant
nibble represents the fourth conversion:
HA1 HW1 LW1 LA1 HA2 HW2 LW2 LA2 HA3 HW3 LW3 LA3 HA4 HW4 LW4 LA4
Only one alarm condition can exist in any EUCA conversion at any given time. If the
SPV exceeds the high warning level the HW bit will be set. If the HA is exceeded,
the HW bit is cleared and the HA bit is set. The alarm bit will not change after
returning to a less severe condition until the deadband (DB) area has also been
exited.
334 33002261
EUCA: Engineering Unit Conversion and Alarms
Parameter Table The 4x register entered in the middle node is the first of nine contiguous holding
(Middle Node) registers in the EUCA parameter table:
Register Content Range
Displayed Binary value input by the user 0 ... 4 095
First implied SPV calculated by the EUCA block
Second implied High engineering unit (HEU), maximum LEU < HEU ≤ 99 999
SPV required and set by the user (top of the
scale)
Third implied Low engineering unit (LEU), minimum SPV 0 ≤ LEU < HEU
required and set by the user (bottom end of
the scale)
Fourth implied DB area in SPV units, below HA levels and 0 ≤ DB < (HEU - LEU)
above LA levels that must be crossed
before the alarm status bit will reset
Fifth implied HA alarm value in SPV units HW < HA ≤ HEU
Sixth implied HW alarm value in SPV units LW < HW < HA
Seventh implied LW alarm value in SPV units LA < LW < HW
Eighth implied LA alarm value in SPV units LEU ≤ LA < LW
Note: An error is generated if any value is out of the range defined above
33002261 335
EUCA: Engineering Unit Conversion and Alarms
Examples
Example 1 This example demonstrates the principles of EUCA operation. The binary value is
manually input in the displayed register in the middle node, and the result is visually
available in the SPV register (the first implied register in the middle node).
The illustration below shows an input range equivalent of a 0 ... 100 V measure,
corresponding to the whole binary 12-bit range:
MSB LSB
1 1 1 1 1 1 1 1 1 1 1 1 = 4095 or FFF hex
100V
90 (Displayed register in
the middle node)
80
70
60
50
40
30
20
10
0V 0 0 0 0 0 0 0 0 0 0 0 0 = 0 or 000 hex
unused
336 33002261
EUCA: Engineering Unit Conversion and Alarms
Programming the EUCA block is accomplished by selecting the EUCA loadable and
writing in the data as illustrated in the figure below:
400440
400450
EUCA
# 0001
Reference Data
Register Meaning Content
400440 STATUS 0000000000000000
400450 INPUT 1871 DEC
400451 SPV 46 DEC
400452 HIGH_unit 100 DEC
400453 LOW_unit 0 DEC
400454 Dead_band 5 DEC
400455 HIGH_ALARM 70 DEC
400456 HIGH_WARN 60 DEC
400457 LOW_ALARM 40 DEC
400458 LOW_WARN 30 DEC
The nine middle-node registers are set using the reference data editor. DB is 5 V
followed by 10 V increments of high and low warning. The actual high and low alarm
is set at 20 V above and below nominal.
33002261 337
EUCA: Engineering Unit Conversion and Alarms
30 Low Alarm
20 = Dead Band
10
0V
Note: The example value shows a decimal 46, which is in the normal range. No
alarm is set, i.e., register 400440 = 0.
You can now verify the instruction in a running PLC by entering values in register
400450 that fall into the defined ranges. The verification is done by observing the bit
change in register 400440 where:
1 = Low alarm
1 = Low warning
1 = High warning
1 = High alarm
338 33002261
EUCA: Engineering Unit Conversion and Alarms
Example 2 If the input of 0 ... 4095 indicates the speed of a drive system of 0 ... 5000 rpm, you
could set up a EUCA instruction as follows.
The binary value in 400210 results in an SPV of 4835 decimal, which exceeds the
high absolute alarm level, sets the HA bit in 400209, and powers the EUCA alarm
node.
Parameter Speed
Maximum Speed 5 000 rpm
Minimum Speed 0 rpm
DB 100 rpm
HA Alarm 4 800 rpm
HW Alarm 4 450 rpm
LW Alarm 2 000 rpm
LA Alarm 1 200 rpm
Instruction
400209
400210
EUCA
# 0001
Reference Data
Register Meaning Content
400209 STATUS 1000000000000000
400210 INPUT 3960 DEC
400211 SPV 4835 DEC
400212 MAX_SPEED 5000 DEC
400213 MIN_SPEED 0 DEC
400214 Dead_band 100 DEC
400215 HIGH_ALARM 4800 DEC
400216 HIGH_WARN 4450 DEC
400217 LOW_ALARM 2000 DEC
400218 LOW_WARN 1200 DEC
33002261 339
EUCA: Engineering Unit Conversion and Alarms
The N.O. contact is used to suppress alarm checks when the drive system is
shutdown, or during initial start up allowing the system to get above the Low alarm
RPM level.
Varying the binary value in register 400210 would cause the bits in nibble 1 of
register 400209 to correspond with the changes illustrated above. The DB becomes
effective when the alarm or warning has been set, then the signal falls into the DB
zone.
The alarm is maintained, thus taking what would be a switch chatter condition out of
a marginal signal level. This point is exemplified in the chart above, where after
setting the HA alarm and returning to the warning level at 4700 the signal crosses in
and out of DB at the warning level (4450) but the warning bit in 400209 stays ON.
The same action would be seen if the signal were generated through the low
settings.
340 33002261
EUCA: Engineering Unit Conversion and Alarms
Example 3 You can chain up to four EUCA conversions together to make one alarm status
register. Each conversion writes to the nibble defined in the block bottom node. In
the program example below, each EUCA block writes it‘s status (based on the table
values for that block) into a four bit (nibble) of the status register 400209.
000002
400210 400220 400230 400240
400209 000004
000023
000033
BLKM
#1
Reference Data
Register Meaning Content
400209 STATUS 0000001001001000
The status register can then be transferred using a BLKM instruction to a group of
discretes wired to illuminate lamps in an alarm enunciator panel.
As you observe the status content of register 400209 you see: no alarm in block 1,
an LW alarm in block 2, an HW alarm in Block 3, and an HA alarm in block 4.
33002261 341
EUCA: Engineering Unit Conversion and Alarms
The alarm conditions for the four blocks can be represented with the following table
settings:
Conversion 1 Conversion 2 Conversion 3 Conversion 4
Input 400210 = 2048 400220 = 1220 400230 = 3022 400240 = 3920
Scaled # 400211 = 2501 400221 = 1124 400231 = 7379 400241 = 0770
HEU 400212 = 5000 400222 = 3300 400232 = 9999 400242 = 0800
LEU 400213 = 0000 400223 = 0200 400233 = 0000 400243 = 0100
DB 400214 = 0015 400224 = 0022 400234 = 0100 400244 = 0006
Hi Alarm 400215 = 40000 400225 = 2900 400235 = 8090 400245 = 0768
Hi Warn 400216 = 3500 400226 = 2300 400236 = 7100 400246 = 0680
Lo Warn 400217 = 2000 400227 = 1200 400237 = 3200 400247 = 0280
Lo Alarm 400218 = 1200 400228 = 0430 400238 = 0992 400248 = 0230
342 33002261
FIN: First In
68
At a Glance
33002261 343
FIN: First In
Short Description
Function The FIN instruction is used to produce a first-in queue. An FOUT instruction needs
Description to be used to clear the register at the bottom of the queue. An FIN instruction has
one control input and can produce three possible outputs.
Representation
source
data
queue
pointer
FIN
queue
length
344 33002261
FIN: First In
Parameter Description
Mode of The FIN instruction is used to produce a first-in queue. It copies the source data from
Functioning the top node to the first register in a queue of holding registers. The source data is
always copied to the register at the top of the queue. When a queue has been filled,
no further source data can be copied to it.
FIN FIN FIN
1111 1111 2222 2222 3333 3333
Source Source 1111 Source 2222
1111
Queue Queue Queue
Queue Pointer The 4x register entered in the middle node is a queue pointer. The first register in
(Middle Node) the queue is the next contiguous 4x register following the pointer. For example, if the
middle node displays a a pointer reference of 400100, then the first register in the
queue is 400101.
The value posted in the queue pointer equals the number of registers in the queue
that are currently filled with source data. The value of the pointer cannot exceed the
integer maximum queue length value specified in the bottom node.
If the value in the queue pointer equals the integer specified in the bottom node, the
middle output passes power and no further source data can be written to the queue
until an FOUT instruction clears the register at the bottom of the queue.
33002261 345
FIN: First In
346 33002261
FOUT: First Out
69
At a Glance
33002261 347
FOUT: First Out
Short Description
Function The FOUT instruction works together with the FIN instruction to produce a first in-
Description first out (FIFO) queue. It moves the bit pattern of the holding register at the bottom
of a full queue to a destination register or to word that stores 16 discrete outputs.
An FOUT instruction has one control input and can produce three possible outputs.
DANGER
Overriding any disabled coils
FOUT will override any disabled coils within a destination register without enabling
them. This can cause injury if a coil has been disabled for repair or maintenance
because the coil’s state can change as a result of the FOUT operation.
Failure to follow this instruction will result in death or serious injury.
348 33002261
FOUT: First Out
Representation
source
pointer
destination
register
FOUT
queue
length
33002261 349
FOUT: First Out
Parameter Description
Mode of The FOUT instruction works together with the FIN (See FIN: First In, p. 343 )
Functioning instruction to produce a first in-first out (FIFO) queue. It moves the bit pattern of the
holding register at the bottom of a full queue to a destination register or to word that
stores 16 discrete outputs.
FIN FIN
3333 3333 3333 4444 4444
Source 2222 2222 FOUT Source 3333
1111 1111 1111 2222
Queue Queue Destination Queue
Note: The FOUT instruction should be placed before the FIN instruction in the
ladder logic FIFO to ensure removal of the oldest data from a full queue before the
newest data is entered. If the FIN block were to appear first, any attempts to enter
the new data into a full queue would be ignored.
Source Pointer In the FOUT instruction, the source data comes from the 4x register at the bottom of
(Top Node) a full queue. The next contiguous 4x register following the source pointer register in
the top node is the first register in the queue. For example, if the top node displays
pointer register 400100, then the first register in the queue is 400101.
The value posted in the source pointer equals the number of registers in the queue
that are currently filled. The value of the pointer cannot exceed the integer maximum
queue length value specified in the bottom node. If the value in the source pointer
equals the integer specified in the bottom node, the middle output passes power and
no further FIN data can be written to the queue until the FOUT instruction clears the
register at the bottom of the queue to the destination register.
Destination The destination specified in the middle node can be a 0x reference or 4x register.
Register When the queue has data and the top input to the FOUT passes power, the source
(Middle Node) data is cleared from the bottom register in the queue and is written to the destination
register.
350 33002261
FTOI: Floating Point to Integer
70
At a Glance
33002261 351
FTOI: Floating Point to Integer
Short Description
Function The FTOI instruction performs the conversion of a floating value to a signed or
Description unsigned integer (stored in two contiguous registers in the top node), then stores the
converted integer value in a 4x register in the middle node.
Representation
FP
converted
integer
FTOI
1
352 33002261
HLTH: History and Status Matrices
71
At a Glance
33002261 353
HLTH: History and Status Matrices
Short Description
Function
Description
Note: This instruction is only available, if you have unpacked and installed the DX
Loadables; further information you will find in "IInstallation of DX Loadables, p. 71".
The HLTH instruction creates history and status matrices from internal memory
registers that may be used in ladder logic to detect changes in PLC status and
communication capabilities with the I/O. It can also be used to alert the user to
changes in a PLC System. HLTH has two modes of operation, learn and monitor.
354 33002261
HLTH: History and Status Matrices
Representation
history
status
HLTH
length
33002261 355
HLTH: History and Status Matrices
Parameter Description
Learn / Monitor The HLTH instruction block has three control inputs and can produce three possible
Mode outputs.
(MIddle and The combined states of the middle and bottom inputs control the operating mode:
Bottom Input)
Middle Input Bottom Input Operation
ON OFF Learn Mode as Dual Cable System
ON ON Learn Mode as Single Cable System
OFF ON Monitor Mode
OFF OFF Monitor Mode Update Logic Checksum
356 33002261
HLTH: History and Status Matrices
History Matrix The 4x register entered in the top node is the first in a block of contiguous registers
(Top Node) that comprise the history matrix. The data for the history matrix is gathered by the
instruction during a learn mode operation and is set in the matrix when the mode
changes to monitor.
The history matrix can range from 6 ... 135 registers in length. Below is a description
of the words in the history matrix. The information from word 1 is contained in the
displayed register in the top node and the information from words 2 ... 135 is stored
in the implied registers.
Word 1 Enter drop number (range 0 ... 32) to be monitored for retries
Word 4 The status and a counter for multiplexing the inputs. HLTH processes 16 words of
input (256 inputs) per scan. This word holds the last word location of the last scan.
The register is overwritten on every scan. The value in the counter portion of the
word increases to the maximum number of inputs, then restarts at 0.
Usage of word 4:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = at least one disabled input has been found
2 - 16 Count of the number of word checked for disabled inputs prior to this scan.
33002261 357
HLTH: History and Status Matrices
Word 5 Status and a counter for multiplexing outputs to detect if one is disabled. HLTH looks
at 16 words (256 outputs) per scan to find one that is disabled. It holds the last word
location of the last scan. The block is overwritten on every scan. The value in the
counter portion increases to maximum outputs then restarts at 0.
Usage of word 5:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = at least one disabled output has been found.
2 - 16 Count of the number of word checked for disabled outputs prior to this scan.
Bit Function
1 1 = S911 present during learn.
2-8 Not used
9 1 = cable A is monitored.
10 1 = cable B is monitored.
11 - 16 Not used
358 33002261
HLTH: History and Status Matrices
Word 7 ... 134 These words define the learned condition of drop 1 to drop 32 as follows:
Word Drop No.
7 ... 10 1
11 ... 14 2
15 ... 18 3
: :
: :
131 ... 134 32
The structure of the four words allocated to each drop are as follows:
First Word
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 Drop delay bit 1
Note: Drop delay bits are used by the software to delay the monitoring of the
drop for four scans after reestablishing communications with a drop. The delay
value is for internal use only and needs no user intervention.
2 Drop delay bit 2
3 Drop delay bit 3
4 Drop delay bit 4
5 Drop delay bit 5
6 Rack 1, slot 1, module found
7 Rack 1, slot 2, module found
8 Rack 1, slot 3, module found
9 Rack 1, slot 4, module found
10 Rack 1, slot 5, module found
11 Rack 1, slot 6, module found
12 Rack 1, slot 7, module found
13 Rack 1, slot 8, module found
14 Rack 1, slot 9, module found
15 Rack 1, slot 10, module found
16 Rack 1, slot 11, module found
33002261 359
HLTH: History and Status Matrices
Second Word
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 Rack 2, slot 1, module found
2 Rack 2, slot 2, module found
3 Rack 2, slot 3, module found
4 Rack 2, slot 4, module found
5 Rack 2, slot 5, module found
6 Rack 2, slot 6, module found
7 Rack 2, slot 7, module found
8 Rack 2, slot 8, module found
9 Rack 2, slot 9, module found
10 Rack 2, slot 10, module found
11 Rack 2, slot 11, module found
12 Rack 3, slot 1, module found
13 Rack 3, slot 2, module found
14 Rack 3, slot 3, module found
15 Rack 3, slot 4, module found
16 Rack 3, slot 5, module found
360 33002261
HLTH: History and Status Matrices
Third Word
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 Rack 3, slot 6, module found
2 Rack 3, slot 7, module found
3 Rack 3, slot 8, module found
4 Rack 3, slot 9, module found
5 Rack 3, slot 10, module found
6 Rack 3, slot 11, module found
7 Rack 4, slot 1, module found
8 Rack 4, slot 2, module found
9 Rack 4, slot 3, module found
10 Rack 4, slot 4, module found
11 Rack 4, slot 5, module found
12 Rack 4, slot 6, module found
13 Rack 4, slot 7, module found
14 Rack 4, slot 8, module found
15 Rack 4, slot 9, module found
16 Rack 4, slot 10, module found
33002261 361
HLTH: History and Status Matrices
Fourth Word
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 Rack 4, slot 11, module found
2 Rack 5, slot 1, module found
3 Rack 5, slot 2, module found
4 Rack 5, slot 3, module found
5 Rack 5, slot 4, module found
6 Rack 5, slot 5, module found
7 Rack 5, slot 6, module found
8 Rack 5, slot 7, module found
9 Rack 5, slot 8, module found
10 Rack 5, slot 9, module found
11 Rack 5, slot 10, module found
12 Rack 5, slot 11, module found
13 ... 16 not used
362 33002261
HLTH: History and Status Matrices
Status Matrix The 4x register entered in the middle node is the first in a block of contiguous holding
(Middle Node) registers that will comprise the status matrix. The status matrix is updated by the
HLTH instruction during monitor mode (top input is ON and middle input is OFF).
The status matrix can range from 3 ... 132 registers in length. Below is a description
of the words in the status matrix. The information from word 1 is contained in the
displayed register in the middle node and the information from words 2 ... 131 is
stored in the implied registers.
Word 1 This word is a counter for lost-communications at the drop being monitored.
Usage of word 1:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1-8 Indicates the number of the drop being monitored (0 ... 32).
9 - 16 Count of the lost communication incidents (0 ... 15).
Word 2 This word is the cumulative retry counter for the drop being monitored (the drop
number is indicated in the high byte of word 1).
Usage of word 2:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1-4 Not used
5 - 16 Cumulative retry count (0 ... 255).
33002261 363
HLTH: History and Status Matrices
Word 3 This word updates PLC status (including Hot Standby health) on every scan.
Usage of word 3:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 ON = all drops are not communicating.
2 Not used
3 ON = logic checksum has changed since last learn.
4 ON = at least one disabled 1x input detected.
5 ON = at least one disabled 0x output detected.
6 ON = constant sweep enabled.
7 - 10 Not used
11 ON = memory protect is OFF.
12 ON = battery is bad.
13 ON = an S911 is bad.
14 ON = Hot Standby not active.
15 - 16 Not used
364 33002261
HLTH: History and Status Matrices
Word 4 ... 131 These words indicate the status of drop 1 to drop 32 as follows:
Word Drop No.
4 ... 7 1
8 ... 11 2
12 ... 15 3
: :
: :
128 ... 131 32
Bit Function
1 Drop communication fault detected
2 Rack 1, slot 1, module fault
3 Rack 1, slot 2, module fault
4 Rack 1, slot 3, module fault
5 Rack 1, slot 4, module fault
6 Rack 1, slot 5, module fault
7 Rack 1, slot 6, module fault
8 Rack 1, slot 7, module fault
9 Rack 1, slot 8, module fault
10 Rack 1, slot 9, module fault
11 Rack 1, slot 10, module fault
12 Rack 1, slot 11, module fault
13 Rack 2, slot 1, module fault
14 Rack 2, slot 2, module fault
15 Rack 2, slot 3, module fault
16 Rack 2, slot 4, module fault
33002261 365
HLTH: History and Status Matrices
Second Word
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 Rack 2, slot 5, module fault
2 Rack 2, slot 6, module fault
3 Rack 2, slot 7, module fault
4 Rack 2, slot 8, module fault
5 Rack 2, slot 9, module fault
6 Rack 2, slot 10, module fault
7 Rack 2, slot 11, module fault
8 Rack 3, slot 1, module fault
9 Rack 3, slot 2, module fault
10 Rack 3, slot 3, module fault
11 Rack 3, slot 4, module fault
12 Rack 3, slot 5, module fault
13 Rack 3, slot 6, module fault
14 Rack 3, slot 7, module fault
15 Rack 3, slot 8, module fault
16 Rack 3, slot 9, module fault
366 33002261
HLTH: History and Status Matrices
Third Word
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 Rack 3, slot 10, module fault
2 Rack 3, slot 11, module fault
3 Rack 4, slot 1, module fault
4 Rack 4, slot 2, module fault
5 Rack 4, slot 3, module fault
6 Rack 4, slot 4, module fault
7 Rack 4, slot 5, module fault
8 Rack 4, slot 6, module fault
9 Rack 4, slot 7, module fault
10 Rack 4, slot 8, module fault
11 Rack 4, slot 9, module fault
12 Rack 4, slot 10, module fault
13 Rack 4, slot 11, module fault
14 Rack 5, slot 1, module fault
15 Rack 5, slot 2, module fault
16 Rack 5, slot 3, module fault
Fourth Word
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 Rack 5, slot 4, module fault
2 Rack 5, slot 5, module fault
3 Rack 5, slot 6, module fault
4 Rack 5, slot 7, module fault
5 Rack 5, slot 8, module fault
6 Rack 5, slot 9, module fault
7 Rack 5, slot 10, module fault
8 Rack 5, slot 11, module fault
9 Cable A fault
10 Cable B fault
11 ... 16 not used
33002261 367
HLTH: History and Status Matrices
Length The decimal value entered in the bottom node is a function of how many I/O drops
(Bottom Node) you want to monitor. Each drop requires four registers/matrix. The length value is
calculated using the following formula:
This value gives you the number of registers in the status matrix. You only need to
enter this one value as the length because the length of the history matrix is
automatically increased by 3 registers -i.e., the size of the history matrix is
length + 3.
368 33002261
IBKR: Indirect Block Read
72
At a Glance
33002261 369
IBKR: Indirect Block Read
Short Description
Function The IBKR (indirect block read) instruction lets you access non-contiguous registers
Description dispersed throughout your application and copy the contents into a destination block
of contiguous registers. This instruction can be used with subroutines or for
streamlining data access by host computers or other PLCs.
Representation
source
table
destination
block
IBKR
length
(1 ... 255)
370 33002261
IBKW: Indirect Block Write
73
At a Glance
33002261 371
IBKW: Indirect Block Write
Short Description
Function The IBKW (indirect block write) instruction lets you copy the data from a table of
Description contiguous registers into several non-contiguous registers dispersed throughout
your application.
Representation
source
block
destination
pointers
IBKW
length
(1 ... 255)
372 33002261
ICMP: Input Compare
74
At a Glance
33002261 373
ICMP: Input Compare
Short Description
Function
Description
Note: This instruction is only available, if you have unpacked and installed the DX
Loadables; further information you will find in "Installation of DX Loadables, p. 71".
The ICMP (input compare) instruction provides logic for verifying the correct
operation of each step processed by a DRUM instruction. Errors detected by ICMP
may be used to trigger additional error-correction logic or to shut down the system.
ICMP and DRUM are synchronized through the use of a common step pointer
register. As the pointer increments, ICMP moves through its data table in lock step
with DRUM. As ICMP moves through each new step, it compares-bit for bit-the live
input data to the expected status of each point in its data table.
374 33002261
ICMP: Input Compare
Representation
step
pointer
step data
table
ICMP
length
33002261 375
ICMP: Input Compare
Parameter Description
Step Pointer The 4x register entered in the top node stores the step pointer, i.e., the number of
(Top Node) the current step in the step data table. This value is referenced by ICMP each time
the instruction is solved. The value must be controlled externally by a DRUM
instruction or by other user logic. The same register must be used in the top node of
all ICMP and DRUM instructions that are solved as a single sequencer.
Step Data Table The 4x register entered in the middle node is the first register in a table of step data
(Middle Node) information. The first eight registers in the table hold constant and variable data
required to solve the instruction:
Register Name Content
Displayed raw input data Loaded by user from a group of sequential inputs to
be used by ICMP for current step
First implied current step data Loaded by ICMP each time the block is solved;
contains a copy of data in the step pointer; causes
the block logic to automatically calculate register
offsets when accessing step data in the step data
table
Second input mask Loaded by user before using the block; contains a
implied mask to be ANDed with raw input data for each
step-masked bits will not be compared; masked
data are put in the masked input data register
Third implied masked input data Loaded by ICMP each time the block is solved;
contains the result of the ANDed input mask and
raw input data
Fourth implied compare status Loaded by ICMP each time the block is solved;
contains the result of an XOR of the masked input
data and the current step data; unmasked inputs
that are not in the correct logical state cause the
associated register bit to go to 1-non-zero bits
cause a miscompare, and middle output will not go
ON
Fifth implied machine ID number Identifies DRUM/ICMP blocks belonging to a
specific machine configuration; value range: 0 ...
9999 (0 = block not configured); all blocks
belonging to same machine configuration have the
same machine ID
376 33002261
ICMP: Input Compare
The remaining registers contain data for each step in the sequence.
Length The integer value entered in the bottom node is the length-i.e., the number of
(Bottom Node) application-specific registers-used in the step data table. The length can range from
1 .. 999 in a 24-bit CPU.
The total number of registers required in the step data table is the length + 8. The
length must be > the value placed in the steps used register in the middle node.
Cascaded A series of DRUM and/or ICMP blocks may be cascaded to simulate a mechanical
DRUM/ICMP drum up to 512 bits wide. Programming the same 4x register reference into the top
Blocks node of each related block causes them to cascade and step as a grouped unit
without the need of any additional application logic.
All DRUM/ICMP blocks with the same register reference in the top node are
automatically synchronized. The must also have the same constant value in the
bottom node, and must be set to use the same value in the steps used register in
the middle node.
33002261 377
ICMP: Input Compare
378 33002261
ID: Interrupt Disable
75
At a Glance
33002261 379
ID: Interrupt Disable
Short Description
Function
Description
Note: This instruction is only available after configuring a CPU without extension.
Three interrupt mask/unmask control instructions are available to help protect data
in both the normal (scheduled) ladder logic and the (unscheduled) interrupt handling
subroutine logic. These are the Interrupt Disable (ID) instruction, the Interrupt
Enable (IE) instruction, and the Block Move with Interrupts Disabled (BMDI)
instruction.
The ID instruction masks timer-generated and/or local I/O-generated interrupts.
An interrupt that is executed in the timeframe after an ID instruction has been solved
and before the next IE instruction has been solved is buffered. The execution of a
buffered interrupt takes place at the time the IE instruction is solved. If two or more
interrupts of the same type occur between the ID ... IE solve, the mask interrupt
overrun error bit is set, and the subroutine initiated by the interrupts is executed only
one time
Further Information you will find in the chapter Interrupt Handling, p. 67.
Representation
ID
Type
380 33002261
ID: Interrupt Disable
Parameter Description
Type Enter a constant integer in the range 1 ... 3 in the node. The value represents the
(Bottom Node) type of interrupt to be masked by the ID instruction, where:
Integer Value Interrupt Type
3 Timer interrupt masked
2 Local I/O module interrupt masked
1 Both interrupt types masked
33002261 381
ID: Interrupt Disable
382 33002261
IE: Interrupt Enable
76
At a Glance
33002261 383
IE: Interrupt Enable
Short Description
Function
Description
Note: This instruction is only available after configuring a CPU without extension.
Three interrupt mask/unmask control instructions are available to help protect data
in both the normal (scheduled) ladder logic and the (unscheduled) interrupt handling
subroutine logic. These are the Interrupt Disable (ID) instruction, the Interrupt
Enable (IE) instruction, and the Block Move with Interrupts Disabled (BMDI)
instruction.
The IE instruction unmasks interrupts from the timer or local I/O module and
responds to the pending interrupts by executing the designated subroutines.
An interrupt that is executed in the timeframe after an ID instruction has been solved
and before the next IE instruction has been solved is buffered. The execution of a
buffered interrupt takes place at the time the IE instruction is solved. If two or more
interrupts of the same type occur between the ID ... IE solve, the mask interrupt
overrun error bit is set, and the subroutine initiated by the interrupts is executed only
one time.
Further Information you will find in the chapter Interrupt Handling, p. 67.
Representation
IE
Type
384 33002261
IE: Interrupt Enable
Parameter Description
Top Input When the input is energized, the IE instruction unmasks interrupts from the timer or
local I/O module and responds to the pending interrupts by executing the designated
subroutines.
Type Enter a constant integer in the range 1 ... 3 in the node. The value represents the
(Bottom Node) type of interrupt to be unmasked by the IE instruction, where:
Integer Value Interrupt Type
3 Timer interrupt unmasked
2 Local I/O module interrupt unmasked
1 Both interrupt types unmasked
33002261 385
IE: Interrupt Enable
386 33002261
IMIO: Immediate I/O
77
At a Glance
Note: This instruction is only available after configuring a CPU without extension.
33002261 387
IMIO: Immediate I/O
Short Description
Function
Description
Note: This instruction is only available after configuring a CPU without extension.
The IMIO instruction permits access of specified I/O modules from within ladder
logic. This differs from normal I/O processing, where inputs are accessed at the
beginning of the logic solve for the segment in which they are used and outputs are
updated at the end of the segment’s solution. The I/O modules being accessed must
reside in the local backplane with the Quantum PLC.
In order to use IMIO instructions, the local I/O modules to be accessed must be
designated in the I/O Map in your panel software.
Further Information you will find in the chapter Interrupt Handling, p. 67.
Representation
control
block
IMIO
type
388 33002261
IMIO: Immediate I/O
Parameter Description
Control Block The first of two contiguous 4x registers is entered in the top node. The second
(Top Node) register is implied.
Register Content
Displayed This register specifies the Physical Address of the I/O Module,
p. 389 to be accessed.
First implied This register logs the error status (See Runtime Errors, p. 391),
which is maintained by the instruction.
Physical The high byte of the displayed register in the control block allows you to specify
Address of the which rack the I/O module to be accessed resides in, and the low byte allow you to
I/O Module specify slot number within the specified rack where the I/O module resides.
Usage of word:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1-5 Not used
6-8 Rack number 1 to 4 (only rack 1 is currently supported)
9 - 11 Not used
12 - 16 Slot number
Rack Number
Bit Number Rack Number
6 7 8
0 0 1 rack 1
0 1 0 rack 2
0 1 1 rack 3
1 0 0 rack 4
33002261 389
IMIO: Immediate I/O
Slot Number
Bit Number Slot Number
12 13 14 15 16
0 0 0 0 1 slot 1
0 0 0 1 0 slot 2
0 0 0 1 1 slot 3
0 0 1 0 0 slot 4
0 0 1 0 1 slot 5
0 0 1 1 0 slot 6
0 0 1 1 1 slot 7
0 1 0 0 0 slot 8
0 1 0 0 1 slot 9
0 1 0 1 0 slot 10
0 1 0 1 1 slot 11
0 1 1 0 0 slot 12
0 1 1 0 1 slot 13
0 1 1 1 0 slot 14
0 1 1 1 1 slot 15
1 0 0 0 0 slot 16
Type Enter a constant integer in the range 1 ... 3 in the bottom node. The value represents
(Bottom Node) the type of operation to be performed by the IMIO instruction, where:
Integer Value Type of Immediate Access
1 Input operation: transfers data from the specified module to state RAM
2 Output operation: transfers data from state RAM to the specified module
3 I/O operation: does both input and output if the specified module is
bidirectional
390 33002261
IMIO: Immediate I/O
Runtime Errors The implied register in the control block will contain the following error code when
the instruction detects an error:
Error Code Meaning
2001 Invalid type specified in the bottom node
2002 Problem with the specified I/O slot, either an invalid slot number entered
in the displayed register of the control block or the I/O Map does not
contain the correct module definition for this slot
2003 A type 3 operation is specified in the bottom node, and the module is not
bidirectional
F001 Specified I/O module is not healthy
33002261 391
IMIO: Immediate I/O
392 33002261
IMOD: Interrupt Module
Instruction
78
At a Glance
33002261 393
IMOD: Interrupt Module Instruction
Short Description
Function
Description
Note: This instruction is only available after configuring a CPU without extension.
The IMOD instruction initiates a ladder logic interrupt handler subroutine when the
appropriate interrupt is generated by a local interrupt module and received by the
PLC. Each IMOD instruction in an application is set up to correspond to a specific
slot in the local backplane where the interrupt module resides. The IMOD instruction
can designate the same or a separate interrupt handler subroutine for each interrupt
point on the associated interrupt module.
Further Information you will find in the chapter Interrupt Handling, p. 67.
394 33002261
IMOD: Interrupt Module Instruction
Representation
slot number
control
block
IMOD
number of
interrupts
33002261 395
IMOD: Interrupt Module Instruction
Parameter Description
General Up to 14 IMOD instructions can be programmed in a ladder logic application, one for
Information to each possible option slot in a local backplane.
IMOD Each interrupting point on each interrupt module can initiate a different interrupt
handler subroutine.
A maximum of 64 interrupt points can be defined in a user logic application. It is not
necessary that all possible input points on a local interrupt module be defined in the
IMOD instruction as interrupts.
Enabling of the When the input to the top node is energized, the IMOD instruction is enabled. The
Instruction PLC will respond to interrupts generated by the local interrupt module in the
(Top Input) designated slot number. When the top input is not energized, interrupts from the
module in the designated slot are disabled and all previously detected errors are
cleared including any pending masked interrupts.
Slot Number The top node contains a decimal in the range 1 ... 16, indicating the slot number
(Top Node) where the local interrupt module resides. This number is used to index into an array
of control structures used to implement the instruction.
Note: The slot number in one IMOD instruction must be unique with respect to the
slot numbers used in all other IMOD instruction in an application. If not the next
IMOD with that particular slot number will have an error.
Note: The slot numbers where the PLC and the power supply reside are illegal
entries -i.e., a maximum of 14 of the 16 possible slot numbers can be used as
interrupt module slots. If the IMOD slot number is the same as the PLC, the IMOD
will have an error.
396 33002261
IMOD: Interrupt Module Instruction
Control Block The middle node contains the first 4x register in the IMOD control block. The control
(Middle Node) block contains parameters required to program an IMOD instruction. The size
(number of registers) of the control block will equal the total number of programmed
interrupt points + 3.
The first three registers in the control block contain status information, of the
remaining registers provide means for you to specify the label (LAB) number of the
Subroutine Handling, p. 69 that is in the last (unscheduled) segment of the ladder
logic program.
Control Block for IMOD
Register Content
Displayed Function status bits
First implied State of inputs 1 ... 16 from the interrupt module at the time of the
interrupt
Second implied State of inputs 17 ... 32 from the interrupt module at the time of the
interrupt (invalid data for a 16-bit interrupt module)
Third implied LAB number and status for the first interrupt programmed point on
the interrupt module
... ...
Last implied LAB number and status for the last interrupt programmed point on
the interrupt
Bit Function
1-2 Not used
3 Error: controller slot
4 Error: interrupt lost due to comm error in backplane
5 Module not healthy or not in I/O map
6 Error: interrupt lost because of on-line editing
7 Error: Maximum number of interrupts exceeded
8 Error: slot number used in previous network (see CAUTION Lost of Interrupts,
p. 398)
9 - 15 Not used
16 0 = IMOD disabled
1 = IMOD enabled
33002261 397
IMOD: Interrupt Module Instruction
Lost of Interrupts
CAUTION
Lost of interrupts from the working IMOD instruction
An error is indicated in bit 8 when two IMOD instructions are assigned the same
slot number. When this happens, it is possible to lose interrupts from the working
IMOD instruction without an indication if the number specified in the bottom node
of the two instructions is different.
Failure to follow this instruction can result in injury or equipment damage.
Status Bits and Bits 1 ... 5 of the third implied through last implied registers are status bits for each
LAB Number for interrupt point. Bits 7 ... 16 are used to specify the LAB number for the interrupt
each Interrupt handler subroutine. The LAB number is a decimal value in the range 1 ... 1023
Point Function Status Bits
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
Interrupt Point Status
1 Execution delayed because of interrupt mask
2 Error: invalid block in the interrupt handler subroutine
3 Error: Mask interrupt overrun
4 Error: execution overrun
5 Error: invalid LAB number
6 not used
LAB number
7 - 16 LAB number for the associated interrupt handler
Value in the range 1 ... 1023
Whenever the input to the bottom node of the IMOD instruction is enabled, the status
bits (bits 1 ... 5) are cleared. If a LAB number is specified (in bits 7 ... 16) as 0 or an
invalid number, any interrupts generated from that point are ignored by the PLC.
398 33002261
IMOD: Interrupt Module Instruction
Number of The bottom node contains an integer indicating the number of interrupts that can be
Interrupts generated from the associated interrupt module. The size (number of registers) of
(Bottom Node) the control block is this number + 3.
The PLC is able to be configured for a maximum of 64 module interrupts (from all
the interrupt modules residing in the local backplane). If the number you enter in the
bottom node of an IMOD instruction causes the total number of module interrupts
systemwide to exceed 64, an error is logged in bit 7 of the first register in the control
block.
For example, if you use four interrupt modules in the local backplane and assign 16
interrupts to each of these modules (by entering 16 in the bottom node of each
associated IMOD instruction, the PLC will not be able to handle any more module
interrupts. If you attempt to create a fifth IMOD instruction, an error will be logged in
that IMOD’s control block when you specify a value in the bottom node.
33002261 399
IMOD: Interrupt Module Instruction
400 33002261
ITMR: Interrupt Timer
79
At a Glance
33002261 401
ITMR: Interrupt Timer
Short Description
Function
Description
Note: This instruction is only available after configuring a CPU without extension.
The ITMR instruction allows you to define an interval timer that generates interrupts
into the normal ladder logic scan and initiates the execution of an interrupt handling
subroutine. The user-defined interrupt handler is a ladder logic subroutine created
in the last, unscheduled segment of ladder logic with its first network marked by a
LAB instruction. Subroutine execution is asynchronous to the normal scan cycle
Up to 16 ITMR instructions can be programmed in an application. Each interval timer
can be programmed to initiate the same or different interrupt handler subroutines,
controlled by the JSR / LAB Method, p. 70 described in the chapter General.
Each instance of the interval timer is delayed for a programmed interval while the
PLC is running, then generates a processor interrupt when the interval has elapsed.
An interval timer can execute at any time during normal logic scan, including system
I/O updating or other system housekeeping operations. The resolution of each
interval timer is 1 ms. An interval can be programmed in units of 1 ms, 10 ms, 100
ms, or 1 s. An internal counter increments at the specified resolution.
Further Information you will find in the chapter Interrupt Handling, p. 67.
402 33002261
ITMR: Interrupt Timer
Representation
control
block
ITMR
timer
number
33002261 403
ITMR: Interrupt Timer
Parameter Description
Top Input When the top input is energized, the ITRM instruction is enabled. It begins counting
the programmed time interval. When that interval has expired the counter is reset
and the designated error handler logic executes.
When the top input is not energized, the following events occur:
l All indicated errors are cleared
l The timer is stopped
l The time count is either reset or held, depending on the state of bit 15 of the first
register in the control block (the displayed register in the top node)
l Any pending masked interrupt is cleared for this timer
Control Block The top node contains the first of three contiguous 4x registers in the ITMR control
(Top Node) block. These registers are used to specify the parameters required to program each
ITMR instruction.
Control Block for ITMR
Register Content
Displayed Function status and function control bits
First implied In this register specify a value representing the interval at which the
ITRM instruction will generate interrupts and initiate the execution of
the interrupt handler.
The interval will be incremented in the units specified by bits 12 and
13 of the first control block register, i.e. 1 ms, 10 ms, 100 ms, or 1 s
units.
Second implied In this register specify a value indicating the label (LAB) number that
will start the interrupt handler subroutine.
The number must be in the range 1 ... 1023.
Note: We recommend that the size of the logic subroutine associated with the LAB
be minimized so that the application does not become interrupt-driven.
404 33002261
ITMR: Interrupt Timer
Function Status The lower eight bits of the displayed register in the control block allow you to specify
and Function function control parameters, and the upper eight bits are used to display function
Control Bits status:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
Function Status
1 Execution delayed because of interrupt mask.
2 Invalid block in the interrupt handler subroutine.
3 Not used
4 Time = 0
5 Mask interrupt overrun.
6 Execution overrun.
7 No LAB or invalid LAB.
8 Timer number used in previous network.
Function Control
9 - 11 Not used
12 - 13 0 0 = 1 ms time base
0 1 = 10 ms time base
1 0 = 100 ms time base
1 1 = 1 s time base
14 1 = PLC stop holds counter.
0 = PLC stop resets counter.
15 1 = enable OFF holds counter.
0 = enable OFF resets counter.
16 1 = instruction enabled
0 = instruction disabled
Timer Number Up to 16 ITRM instructions can be programmed in an application. The interrupts are
(Bottom Node) distinguished from one another by a unique number between 1 ... 16, which you
assign to each instruction in the bottom node. The lowest interrupt number has the
highest execution priority.
For example, if ITMR 4 and ITMR 5 occur at the same time, ITMR 4 is executed first.
After ITMR 4 has finished, ITMR 5 generally will begin executing.
An exception would be when another ITMR interrupt with a higher priority occurs
during ITMR 4’s execution. For example, suppose that ITMR 3 occurs while ITMR 5
is waiting for ITMR 4 to finish executing. In this case, ITMR 3 begins executing when
ITMR4 finishes, and ITMR 5 continues to wait.
33002261 405
ITMR: Interrupt Timer
406 33002261
ITOF: Integer to Floating Point
80
At a Glance
33002261 407
ITOF: Integer to Floating Point
Short Description
Function The ITOF instruction performs the conversion of a signed or unsigned integer value
Description (its top node) to a floating point (FP) value, and stores the FP value in two
contiguous 4x registers in the middle node.
Representation
integer
converted
FP
ITOF
408 33002261
JSR: Jump to Subroutine
81
At a Glance
33002261 409
JSR: Jump to Subroutine
Short Description
Function When the logic scan encounters an enabled JSR instruction, it stops the normal
Description logic scan and jumps to the specified source subroutine in the last (unscheduled)
segment of ladder logic.
You can use a JSR instruction anywhere in user logic, even within the subroutine
segment. The process of calling one subroutine from another subroutine is called
nesting. The system allows you to nest up to 100 subroutines; however, we
recommend that you use no more than three nesting levels. You may also perform
a recursive form of nesting called looping, whereby a JSR call within the subroutine
recalls the same subroutine.
Example to An example to subroutine handling you will find in the chapter General, section
Subroutine Subroutine Handling, p. 69 .
Handling
Representation
source
JSR
#1
410 33002261
LAB: Label for a Subroutine
82
At a Glance
33002261 411
LAB: Label for a Subroutine
Short Description
Function The LAB instruction is used to label the starting point of a subroutine in the last
Description (unscheduled) segment of user logic. This instruction must be programmed in row
1, column 1 of a network in the last (unscheduled) segment of user logic. LAB is a
one-node function block
LAB also serves as a default return from the subroutine in the preceding networks.
If you are executing a series of subroutine networks and you find a network that
begins with LAB, the system knows that the previous subroutine is finished, and it
returns the logic scan to the node immediately following the most recently executed
JSR block.
Example to An example to subroutine handling you will find in the chapter General, section
Subroutine Subroutine Handling, p. 69 .
Handling
Representation
LAB
subroutine
(1 ... 255)
412 33002261
LAB: Label for a Subroutine
Parameter Description
Subroutine The integer value entered in the node identifies the subroutine you are about to
(Bottom Node) execute. The value can range from 1 ... 255. If more than one subroutine network
has the same LAB value, the network with the lowest number is used as the starting
point for the subroutine.
33002261 413
LAB: Label for a Subroutine
414 33002261
LOAD: Load Flash
83
At a Glance
33002261 415
LOAD: Load Flash
Short Description
Function
Description
Note: This instruction is available with the PLC family TSX Compact, with Quantum
CPUs 434 12/ 534 14 and Momentum CPUs CCC 960 x0/ 980 x0.
The LOAD instruction loads a block of 4x registers (previously SAVEd) from state
RAM where they are protected from unauthorized modification.
416 33002261
LOAD: Load Flash
Representation
register
1, 2, 3, 4
LOAD
length
33002261 417
LOAD: Load Flash
Parameter Description
1, 2, 3, 4 (Middle The middle node defines the specific buffer where the block of data is to be loaded.
Node) Four 512 word buffers are allowed. Each buffer is defined by placing its
corresponding value in the middle node, that is, the value 1 represents the first
buffer, value 2 represents the second buffer and so on. The legal values are 1, 2, 3,
and 4. When the PLC is started all four buffers are zeroed. Therefore, you may not
load data from the same buffer without first saving it with the instruction SAVE.
When this is attempted the middle output goes ON. In other words, once a buffer is
used, it may not be used again until the data has been removed.
Bottom Output The output from the bottom node goes ON when a LOAD request is not equal to the
registers that were SAVEd. This kind of transaction is allowed, however, it is your
responsibility to ensure this does not create a problem in your application.
418 33002261
MAP 3: MAP Transaction
84
At a Glance
33002261 419
MAP 3: MAP Transaction
Short Description
Function
Description
Note: This instruction is only available, if you have unpacked and installed the DX
Loadables; further information in the chapter "Installation of DX Loadables, p. 71".
Ladder logic applications running in the controller initiate communication with MAP
network nodes through the MAP3 instruction.
Representation
control
block
data
source
MAP3
length
420 33002261
MAP 3: MAP Transaction
Parameter Description
Top Input This input initiates a transaction. To start a transaction the input must be held ON
(HIGH) for at least one scan. If the S980 has resources to process the transaction,
the middle output passes power. If resources are not available, no outputs pass
power.
Once a transaction is started, it will run until a reply is received, a communications
error is detected, or a timeout occurs. The values in the Control Block, Data Source
and Length must not be altered, or the transaction will not be completed and the
bottom output will pass power. A second transaction cannot be started by the same
block until the first one is complete.
Middle Input If the top input is also HIGH, the middle input going ON allows a new transaction to
be initiated in the same scan, following the completion of a previous one. A new
transaction begins when the top output passes power from the first transaction.
33002261 421
MAP 3: MAP Transaction
Control Block The top node is the starting 4x register of a block of registers that control the block’s
(Top Node) operation.
The contents of each register is determined by the kind of operation to be performed
by the MAP3 block:
l Read or Write
l Information Report
l Unsolicited Status
l Conclude
l Abort
Registers of the Control Block:
Word Meaning
1 Destination Device, p. 423
2 Qualifier / Function Code, p. 423
3 Network Mode / Network Type, p. 423
4 Function Status, p. 424
5 Register A Reference Type
This word is labeled Register A* and contains the reference type for 4 types of
Read (0x, 1x, 3x, and 4x registers) and 2 types of Write (0X or 4x).
6 Register B Reference Number
This word is labeled Register B* and contains the starting reference number in
the range 1 to 99999.
7 Register C Reference Length
This word is labeled Register C* and contains the Quantity of references
requested.
8 Register D Timeout
This word is labeled Register D* and contains the Timeout parameter. This value
sets the maximum length of time used to complete a transaction, including
retries.
422 33002261
MAP 3: MAP Transaction
Destination Word 1 contains the destination device in bit position 9 through 16. The computer
Device works with this byte as the LSB and will accept a range of 1 to 255.
Usage of word 1:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1-8 Not used
9 - 16 Destination device
Qualifier / Word 2 contains two bytes of information The qualifier bits 1 to 8 and the function
Function Code code in bits 9 to 16.
Usage of word 2:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
Qualifier
1-8 0 = addressed
>0 = named
Function Code
9 - 16 4 = read
5 = write
Network Mode / Word 3 contains two bites of information. The mode is in bits 5 through 8 and the
Network Type type is in bits 9 through 16.
Usage of word 3:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1-4 Not used
Mode
5-8 1 = association
Type
9 - 12 7 = 7 layer MAP network
13 - 16 1 = type 1 service
33002261 423
MAP 3: MAP Transaction
Function Status Word 4 is the function status. An error code is returned if an error occurs in a block
initiated function.
The decimal codes are:
Code Meaning
1 Association request rejected
4 Message timeout application response
5 Invalid destination device
6 Message size exceeded
8 Invalid function code
17 Device not available
19 Unsupported network type
22 No channel available
23 MMS message not sent
24 Control block changed
25 Initiate failed
26 System download in progress
28 Channel not ready
99 Undetermined error
103 Access denied
105 Invalid address
110 Object nonexistent
Function The network controlling device may issue a function code that alters the control
summary block register assignment as given above for Read/Write. Those differences for
Information, Status, Conclude and Abort are identified in this summary on the
bottom of your screen
Refer to Modicon S980 MAP 3.0 Network Interface User Guide that describes the
register contents for each operation.
Data Source The middle node is the starting 4x register of the local data source (for a write
(Middle Node) request) or local data destination (for a read).
Length The bottom node defines the maximum size of the local data area (the quantity of
(Bottom Node) registers) starting at 4x register of data source, in the range of 1 to 255 decimal. The
quantity of data to be actually transferred in the operation is determined by a
Reference Length parameter in one of the control registers.
424 33002261
MAP 3: MAP Transaction
Top Output The top output passes power for one scan when a transaction completes
successfully.
Middle Output The middle output passes power when a transaction is in progress. If the top input
is ON and the middle input is OFF, then the middle output will go OFF on the same
scan that the top output goes ON. If both top input and middle input are ON, then the
middle output will remain ON
Bottom Output The bottom output passes power for one scan when a transaction cannot be
completed. An error code is returned to the Function Status Word (register 4x+3) in
the function’s control block.
33002261 425
MAP 3: MAP Transaction
426 33002261
MBIT: Modify Bit
85
At a Glance
33002261 427
MBIT: Modify Bit
Short Description
Function The MBIT instruction modifies bit locations within a data matrix, i.e. it sets the bit(s)
Description to 1 or clears the bit(s) to 0. One bit location may be modified per scan.
WARNING
Overriding of disabled coils without enabling them
MBIT will override any disabled coils within a destination group without enabling
them. This can cause injury if a coil has been disabled for repair or maintenance
because the coil’s state can change as a result of the MBIT instruction.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
428 33002261
MBIT: Modify Bit
Representation
bit
location
data
matrix
MBIT
length
33002261 429
MBIT: Modify Bit
Parameter Description
Bit Location
(Top Node)
Note: If the bit location is entered as an integer or in a 3x register, the instruction
will ignore the state of the bottom input.
Matrix Length The integer value entered in the bottom node specifies a matrix length, i.e, the
(Bottom Node) number of 16-bit words or registers in the data matrix. The length can range from
1 ... 600 in a 24-bit CPU, e.g, a matrix length of 200 indicates 3200 bit locations.
430 33002261
MBUS: MBUS Transaction
86
At a Glance
33002261 431
MBUS: MBUS Transaction
Short Description
Function
Description
Note: This instruction is only available, if you have unpacked and installed the DX
Loadables; further information in the chapter "Installation of DX Loadables, p. 71".
The S975 Modbus II Interface option modules use two loadable function blocks:
MBUS and PEER. MBUS is used to initiate a single transaction with another device
on the Modbus II network. In an MBUS transaction, you are able to read or write
discrete or register data.
PLCs on a Modbus II network can handle up to 16 transactions simultaneously.
Transactions include incoming (unsolicited) messages as well as outgoing
messages. Thus, the number of message initiations a PLC can manage at any time
is 16 - # of incoming messages.
A transaction cannot be initiated unless the S975 has enough resources for the
entire transaction to be performed. Once a transaction has been initiated, it runs until
a reply is received, an error is detected, or a timeout occurs. A second transaction
cannot be started in the same scan that the previous transaction completes unless
the middle input is ON. A second transaction cannot be initiated by the same MBUS
instruction until the first transaction has completed.
432 33002261
MBUS: MBUS Transaction
Representation
control
block
data
block
MBUS
length
33002261 433
MBUS: MBUS Transaction
Parameter Description
Control Block The 4x register entered in the top node is the first of seven contiguous registers in
(Top Node) the MBUS control block:
Register Content
Displayed Address of destination device (range: 0 ... 246)
First implied not used
Second implied Function code
Third implied Reference type
Fourth implied Reference number, e.g., if you placed a 4 in the third implied register
and you place a 23 in this register, the reference will be holding
register 400023
Fifth implied Number of words of discrete or register references to be read or
written
Sixth implied Time allowed for a transaction to be completed before an error is
declared; expressed as a multiple of 10 ms, e.g., 100 indicates 1 000
ms; the default timeout is 250 ms.
Function Code This register contains the function code for requested action:
Value Meaning
01 Read discretes
02 Read registers
03 Write discrete outputs
04 Write register outputs
255 Get system statistics
Reference Type This register contains one of 4 possible discrete or register reference types:
Value Reference type
0 Discrete output (0x)
1 Discrete input (1x)
2 Input register (3x)
3 Holding register (4x)
434 33002261
MBUS: MBUS Transaction
Number of Number of words of discrete or register references to be read or written; the length
Words to Read or limits are:
Write
Read register 251 registers
Write register 249 registers
Read coils 7.848 discretes
Write coils 7.800 discretes
Length The number of words reserved for the data block is entered as a constant value in
(Bottom Node) the bottom node. This number does not imply a data transaction length, but it can
restrict the maximum allowable number of register or discrete references to be read
or written in the transaction.
The maximum number of words that may be used in the specified transaction is:
Max. Number of Transaction
Words
251 Reading registers (one register/word)
249 Writing registers (one register/word)
490 Reading discretes using 24-bit CPUs (up to 16 discretes/word)
487 Writing discretes using 24-bit CPUs (up to 16 discretes/word
33002261 435
MBUS: MBUS Transaction
General Issuing function code 255 in the second implied register of the MBUS control block
obtains a copy of the Modbus II local statistics, a series of 46 contiguous register
locations where data describing error and system conditions is stored. To use MBUS
for a get statistics operation, set the length in the bottom node to 46, a length < 46
returns an error (the bottom output will go ON), and a length > 46 reserves extra
registers that cannot be used.
401000
46
Register 400101 is the first register in the MBUS control block, making register
400103 the control register that defines the MBUS function code. By entering a
value of 255 in register 400103, you implement a get statistics function. Registers
401000 ... 401045 are then filled with the system statistics.
436 33002261
MBUS: MBUS Transaction
Token Bus Registers 401000 ... 401003 are then filled with the following:
Controller (TBC)
Register Content
401000 Number of tokens passed by this station
401001 Number of tokens sent by this station
401002 Number of time the TBC has failed to pass token and has not found a
successor
401003 Number of times the station has had to look for a new successor
Software- Registers 401004 ... 401010 are then filled with the following:
maintained
Register Content
Receive
Statistics 401004 TBC-detected error frames
401005 Invalid request with response frames
401006 Applications message too long
401007 Media access control (MAC) address out of range
401008 Duplicate application frames
401009 Unsupported logical link control (LLC) message types
401010 Unsupported LLC address
TBC-maintained Registers 401011 ... 401018 are then filled with the following:
Error Counters
Register Content
401011 Receive noise bursts (no start delimiter)
401012 Frame check sequence errors
401013 E-bit error in end delimiter
401014 Fragmented frames received (start delimiter not followed by end delimiter)
401015 Receive frames too long
401016 Discarded frames because there is no receive buffer
401017 Receive overruns
401018 Token pass failures
33002261 437
MBUS: MBUS Transaction
Software- Registers 401019 ... 401020 are then filled with the following:
maintained
Register Content
Transmit Errors
401019 Retries on request with response frames
401020 All retries performed and no response received from unit
Software- Registers 401021... 401022 are then filled with the following:
maintained
Register Content
Receive Errors
401021 Bad transmit request
401022 Negative transmit confirmation
User Logic Registers 401023... 401024 are then filled with the following:
Transaction
Register Content
Errors
401023 Message sent but no application response
401024 Invalid MBUS/PEER logic
Manufacturing Registers 401025... 401026 are then filled with the following:
Message Format
Register Content
Standard
401025 Command not executable
401026 Data not available
(MMFS) Errors Registers 401027... 401035 are then filled with the following:
Register Content
401027 Device not available
401028 Function not implemented
401029 Request not recognized
401030 Syntax error
401031 Unspecified error
401032 Data request out of bounds
401033 Request contains invalid controller address
401034 Request contains invalid data type
401035 None of the above
438 33002261
MBUS: MBUS Transaction
Background Registers 401036... 401043 are then filled with the following:
Statistics
Register Content
401036 Invalid MBUS/PEER request
401037 Number of unsupported MMFS message types received
401038 Unexpected response or response received after timeout
401039 Duplicate application responses received
401040 Response from unspecified device
401041 Number of responses buffered to be processed (in the least significant byte);
number of MBUS/PEER requests to be processed (in the most significant
byte)
401042 Number of received requests to be processed (in the least significant byte);
number of transactions in process (in the most significant byte)
401043 S975 scan time in 10 ms increments
Software Registers 401044... 401045 are then filled with the following:
Revision
Register Content
401044 Version level of fixed software (PROMs): major version number in most
significant byte; minor version number in least significant byte
401045 Version of loadable software (EEPROMs): major version number in most
significant byte; minor version number in least significant byte
33002261 439
MBUS: MBUS Transaction
440 33002261
MRTM: Multi-Register Transfer
Module
87
At a Glance
33002261 441
MRTM: Multi-Register Transfer Module
Short Description
Function
Description
Note: This instruction is only available, if you have unpacked and installed the DX
Loadables; further information in the chapter "Installation of DX Loadables, p. 71".
The MRTM instruction is used to transfer blocks of holding registers from the
program table to the command block, a group of output registers. To verify each
block transfer, an echo of the data contained in the first holding register is returned
to an input register.
442 33002261
MRTM: Multi-Register Transfer Module
Representation
program
table
control
table
MRTM
length
33002261 443
MRTM: Multi-Register Transfer Module
Parameter Description
Mode of The MRTM transfers contiguous blocks of up to 127 registers from a table of register
Functioning blocks to a block size holding register area. The MRTM function block controls the
operation of the module in the following manner:
If power is Then ...
applied to the...
Top input The function block is enabled for data transfers.
Note: On initial startup, power must be applied to the bottom input.
Middle input The function block attempts to transfer one instruction block. Before a
transfer can occur, the echo register is evaluated. The most significant
bit (MSB) of the echo register is not evaluated just bits 0 through 14.
Echo mismatch is a condition that prohibits a transfer. If a transfer is
permitted, one instruction block is transferred form the table starting at
the table pointer.
The table pointer in the control table is then advanced. If the pointer’s
new value is equal to or greater than the table end, the bottom output is
turned on. A table pointer value less than the table end turns off the
output.
Bottom input The function block resets. The table pointer in the control table is
reloaded with the start of commands value from the header of the
program table
Parameter When power is applied, this input attempts to transfer one instruction block. Before
Description a transfer can occur, the echo register is evaluated. The most significant bit (MSB)
Increment Step of the echo register is not evaluated, just bits 0 through 14. Echo mismatch is a
(MIddle Input) condition that prohibits a transfer. If a transfer is permitted, one instruction block is
transferred from the program table starting at the table pointer. The table pointer in
the control table is then incremented by the value "Length" (displayed in the bottom
node).
Note: The MRTM function block is designed to accept fault indications from I/O
modules, which echo valid commands to the controller, but set a bit to indicate the
occurrence of a fault. This method of fault indication is common for motion products
and for most other I/O modules. If using a module that reports a fault condition in
any other way, especially if the echo involved is not an echo of a valid command,
special care must be taken when writing the error handler for the ladder logic to
ensure the fault is detected. Failure to do so may result in a lockup or some other
undesirable performance of the MRTM.
444 33002261
MRTM: Multi-Register Transfer Module
Parameter When power is applied to this input, the function block is reset. The table pointer in
Description the control table is reloaded with the start of commands value from the header of the
Reset Pointer program table.
(Bottom Input)
33002261 445
MRTM: Multi-Register Transfer Module
446 33002261
MSTR: Master
88
At a Glance
33002261 447
MSTR: Master
448 33002261
MSTR: Master
Short Description
Function PLCs that support networking communications capabilities over Modbus Plus and
Description Ethernet have a special MSTR (master) instruction with which nodes on the network
can initiate message transactions.
The MSTR instruction allows you to initiate one of 12 possible network
communications operations over the network:
l Read MSTR Operation
l Write MSTR Operation
l Get Local Statistics MSTR Operation
l Clear Local Statistics MSTR Operation
l Write Global Data MSTR Operation
l Read Global Data MSTR Operation
l Get Remote Statistics MSTR Operation
l Clear Remote Statistics MSTR Operation
l Peer Cop Health MSTR Operation
l Reset Option Module MSTR Operation
l Read CTE (Config Extension) MSTR Operation
l Write CTE (Config Extension) MSTR Operation
33002261 449
MSTR: Master
Representation
control
block
data
area
MSTR
length
450 33002261
MSTR: Master
Parameter Description
Mode of The MSTR instruction allows you to initiate one of 12 possible network
Functioning communications operations over the network. Each operation is designated by a
code.
Up to four MSTR instructions can be simultaneously active in a ladder logic program.
More than four MSTRs may be programmed to be enabled by the logic flow; as one
active MSTR block releases the resources it has been using and becomes
deactivated, the next MSTR operation encountered in logic can be activated.
Master Certain MSTR operations are supported on some networks and not on others:
Operations
Code Type of Operation Modbus TCP/IP SY/MAX
Plus Ethernet Ethernet
1 Write MSTR Operation, p. 456 x x x
2 READ MSTR Operation, p. 458 x x x
3 Get Local Statistics MSTR Operation, p. 461 x x -
4 Clear Local Statistics MSTR Operation, p. 463 x x -
5 Write Global Data MSTR Operation, p. 465 x - -
6 Read Global Data MSTR Operation, p. 466 x - -
7 Get Remote Statistics MSTR Operation, x x -
p. 467
8 Clear Remote Statistics MSTR Operation, x x -
p. 469
9 Peer Cop Health MSTR Operation, p. 471 x - -
10 Reset Option Module MSTR Operation, p. 474 - x x
11 Read CTE (Config Extension Table) MSTR - x x
Operation, p. 476
12 Write CTE (Config Extension Table) MSTR - x x
Operation, p. 478
Legend
x supported
- not supported
33002261 451
MSTR: Master
Control Block The 4x register entered in the top node is the first of several (network-dependant)
(Top Node) holding registers that comprise the network control block.
The control block structure differs according to the network in use:
l Modbus Plus (See Control Block for Modbus Plus, p. 452)
l TCP/IP Ethernet (See Control Block for TCP/IP Ethernet, p. 453)
l Momentum Ethernet (See Control Block for Momentum Ethernet, p. 454)
l SY/MAX Ethernet (See Control Block for SY/MAX Ethernet, p. 455)
Note: You need to understand the routing procedures used by the network you are
using when you program an MSTR instruction. A full discussion of Modbus Plus
routing path structures is given in Modbus Plus Network Planning and Installation
Guide. If TCP/IP or SY/MAX Ethernet routing is being implemented, it must be
accomplished via standard third-party Ethernet IP router products.
Control Block for The first of twelve contiguous 4x registers is entered in the top node. The remaining
Modbus Plus eleven registers are implied:
Register Content
Displayed Identifies one of the nine MSTR operations legal for Modbus Plus
(1 ... 9)
First implied Displays error status (See Run Time Errors , p. 486)
Second implied Displays length (number of registers transferred)
Third implied Displays MSTR operation-dependent information
Fourth implied The Routing 1 register, used to designate the address of the
destination node for a network transaction. The register display is
implemented physically for the Quantum PLCs
Fifth implied The Routing 2 register
Sixth implied The Routing 3 register
Seventh implied The Routing 4 register
Eighth implied The Routing 5 register
Ninth implied not applicable
Tenth implied not applicable
Eleventh implied not applicable
452 33002261
MSTR: Master
Routing 1 To target a Modbus Plus Network Option module (NOM) in a Quantum PLC
Register for backplane as the destination of an MSTR instruction, the value in the high byte
Quantum represents the physical slot location of the NOM, e.g. if the NOM resides in slot 7 in
Automation the backplane, the high byte of routing register 1 would look like this:
Series PLCs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
(Fourth Implied
Register)
Bit Function
1... 8
0 0 0 0 0 1 1 1
Note: If you have created a logic program using an MSTR instruction for a 984 PLC
and want to port it to a Quantum Automation Series PLC without having to edit the
routing 1 register value, make sure that NOM #1 is installed in slot 1 of the
Quantum backplane (and if a NOM #2 is used, that it is installed in slot 2 of the
backplane). If you try to run the ported application with the NOMs in other slots
without modifying the register, an F001 status error will appear, indicating the
wrong destination node.
Control Block for The first of nine contiguous 4x registers is entered in the top node. The remaining
TCP/IP Ethernet eight registers are implied:
Register Content
Displayed Identifies one of the nine MSTR operations legal for TCP/IP
(1 ... 4, 7, 8, 10 ... 12)
First implied Displays error status (See Run Time Errors , p. 486)
Second implied Displays length (number of registers transferred)
Third implied Displays MSTR operation-dependent information
Fourth implied Low byte: MBP-to-Ethernet Transporter (MET) Map index
High byte: slot address of the NOE module
Fifth implied Byte 4 of the 32-bit destination IP Address
Sixth implied Byte 3 of the 32-bit destination IP Address
Seventh implied Byte 2 of the 32-bit destination IP Address
Eighth implied Byte 1 of the 32-bit destination IP Address
33002261 453
MSTR: Master
Control Block for The first of nine contiguous 4x registers is entered in the top node. The remaining
Momentum eight registers are implied:
Ethernet
Register Content
Displayed Identifies one of the MSTR operations legal for Momentum
(1 = write, 2 = read
First implied Displays error status (See Run Time Errors , p. 486)
Second implied Displays length (number of registers transferred)
Third implied Starting register. Enter 100 to read starting at register 400100.
Fourth implied Low byte:
MB-to-Ethernet Transporter (MET) Map index (174CEV30010/
174CEV30020)
MBP-to-Ethernet Transporter (MET) Map index (174CEV20030/
174CEV20040)
High byte: slot address of the M1 Ethernet port is 01 hex
Fifth implied Byte 1 of the 32-bit destination IP Address
Sixth implied Byte 2 of the 32-bit destination IP Address
Seventh implied Byte 3 of the 32-bit destination IP Address
Eighth implied Byte 4 of the 32-bit destination IP Address
When using an MSTR function block for TCP/IP operation in an M1E, the Slot ID or
Sequence Number must be a value of 1.
MSTR : Modbus Plus Network Node Transaction
MSTR : TCP/IP . Node Transaction 2 /4
TCP/IP Operation Function Code 400001 UINT 2
Error Status 400002 UINT 0 HEX
Number of Registers Transferred 400003 UINT 1
Function-dependent Information 400004 UINT 1
Map Index (or unused) 400005 09:16 0
Slot ID or Sequence Number 400005 01:08 1
IP Address (B4.B3.B2.B1) 400006 UINT 112 112 112 20
Number of Input Regs (Func 23 only) 400010 UINT 0
Server Input Base Address (Func 23 only) 400011 UINT 0
Function Codes
01 -> WRITE DATA 02 -> READ DATA
03 -> GET LOCAL STATISTICS 04 -> CLEAR LOCAL STATISTICS
07 -> GET REMOTE STATISTICS 08 -> CLEAR REMOTE STATISTICS
09 -> Not Supported 10 -> RESET OPTION MODULE
11 -> READ CTE 12 -> WRITE CTE
23 -> READ/WRITE DATA
Use page 1 for MB+; page 3 for SYPEP MSTR; page 4 for MMSE MSTR
Close << >> Help
454 33002261
MSTR: Master
Control Block for The first of seven contiguous 4x registers is entered in the top node. The remaining
SY/MAX Ethernet six registers are implied:
Register Content
Displayed Identifies one of the nine MSTR operations legal for SY/MAX
(1, 2, 10 ... 12)
First implied Displays error status (See Run Time Errors , p. 486)
Second implied Displays Read/Write length (number of registers transferred)
Third implied Displays Read/Write base address
Fourth implied Low byte: slot address of the NOE module (e.g., slot 10 = 0A00, slot
6 = 0600)
High byte: MBP-to-Ethernet Transporter (MET) Map index
Fifth implied Destination drop number (or set to FF hex)
Sixth implied Terminator (set to FF hex)
Data Area The 4x register entered in the middle node is the first in a group of contiguous
(Middle Node) holding registers that comprise the data area. For operations that provide the
communication processor with data, such as a Write operation, the data area is the
source of the data. For operations that acquire data from the communication
processor, such as a Read operation, the data area is the destination for the data.
In the case of the Ethernet Read (See Read CTE (Config Extension Table) MSTR
Operation, p. 476) and Write (See Write CTE (Config Extension Table) MSTR
Operation, p. 478) CTE operations, the middle node stores the contents of the
Ethernet configuration extension table in a series of registers.
33002261 455
MSTR: Master
Short An MSTR Write operation transfers data from a master source device to a specified
Description slave destination device on the network. Read and Write use one data master
transaction path and may be completed over multiple scans.
If you attempt to program the MSTR to Write its own station address, an error will be
generated in the first implied register of the MSTR control block. It is possible to
attempt a Write operation to a nonexistent register in the slave device. The slave will
detect this condition and report it, this may take several scans.
Network The MSTR Write operation can be implemented on the Modbus Plus, TCP/IP
Implementation Ethernet, and SY/MAX Ethernet networks.
Control Block In a Write operation, the registers in the MSTR control block (the top node) contain
Utilization the information that differs depending on the type of network you are using:
l Modbus Plus
l TCP/IP Ethernet
l SY/MAX Ethernet
456 33002261
MSTR: Master
33002261 457
MSTR: Master
Short An MSTR Read operation transfers data from a specified slave source device to a
Description master destination device on the network. Read and Write use one data master
transaction path and may be completed over multiple scans.
If you attempt to program the MSTR to Read its own station address, an error will
be generated in the first implied register of the MSTR control block. It is possible to
attempt a Read operation to a nonexistent register in the slave device. The slave will
detect this condition and report it, this may take several scans.
Network The MSTR Read operation can be implemented on the Modbus Plus, TCP/IP
Implementation Ethernet, and SY/MAX Ethernet networks.
Control Block In a Read operation, the registers in the MSTR control block (the top node) contain
Utilization the information that differs depending on the type of network you are using:
l Modbus Plus
l TCP/IP Ethernet
l Momentum Ethernet
l SY/MAX Ethernet
458 33002261
MSTR: Master
33002261 459
MSTR: Master
460 33002261
MSTR: Master
Short The Get Local Statistics operation obtains information related to the local node,
Description where the MSTR has been programmed. This operation takes one scan to complete
and does not require a data master transaction path.
Network The Get Local Statistics operation (type 3 in the displayed register of the top node)
Implementation can be implemented for Modbus Plus and TCP/IP Ethernet networks. It is not used
for SY/MAX Ethernet.
The following network statistics are available:
l Modbus Plus Network Statistics, p. 480
l TCP/IP Ethernet Statistics, p. 485
Control Block In a Get local statistics operation, the registers in the MSTR control block (the top
Utilization node) contain the information that differs depending on the type of network you are
using:
l Modbus Plus
l TCP/IP Ethernet
33002261 461
MSTR: Master
462 33002261
MSTR: Master
Short The Clear local statistics operation clears statistics relative to the local node (where
Description the MSTR has been programmed). This operation takes one scan to complete and
does not require a data master transaction path.
Note: When you issue the Clear Local Statistics operation, only words 13 ... 22 in
the statistics table (See Modbus Plus Network Statistics, p. 480) are cleared
Network The Clear Local Statistics operation (type 4 in the displayed register of the top node)
Implementation can be implemented for Modbus Plus and TCP/IP Ethernet networks. It is not used
for SY/MAX Ethernet.
The following network statistics are available:
l Modbus Plus Network Statistics, p. 480
l TCP/IP Ethernet Statistics, p. 485
Control Block In a Clear local statistics operation, the registers in the MSTR control block (the top
Utilization node) differ according to the type of network in use:
l Modbus Plus
l TCP/IP Ethernet
33002261 463
MSTR: Master
464 33002261
MSTR: Master
Short The Write global data operation transfers data to the communications processor in
Description the current node so that it can be sent over the network when the node gets the
token. All nodes on the local network link can receive this data. This operation takes
one scan to complete and does not require a data master transaction path.
Network The Write global data operation (type 5 in the displayed register of the top node) can
Implementation be implemented only for Modbus Plus networks.
Control Block The registers in the MSTR control block (the top node) are used in a Write global
Utilization data operation
Register Function Content
Displayed Operation type 5
First implied Error status (See Displays a hex value indicating an MSTR error,
Run Time Errors , when relevant
p. 486)
Second implied Length Specifies the number of registers from the data area
to be sent to the comm processor; the value of the
length must be ≤ 32 and must not exceed the size of
the data area
Third implied Reserved
Fourth implied Routing 1 If this is the second of two local nodes, set the high
byte to a value of 1
Note: If your PLC does not support Modbus Plus
option modules (S985s or NOMs), the fourth implied
register is not used.
33002261 465
MSTR: Master
Short The Read global data operation gets data from the communications processor in
Description any node on the local network link that is providing global data. This operation may
require multiple scans to complete if global data is not currently available from the
requested node. If global data is available, the operation completes in a single scan.
No master transaction path is required.
Network The Read global data operation (type 6 in the displayed register of the top node) can
Implementation be implemented only for Modbus Plus networks.
Control Block The registers in the MSTR control block (the top node) are used in a Read global
Utilization data operation
Register Function Content
Displayed Operation type 6
First implied Error status (See Displays a hex value indicating an MSTR error,
Run Time Errors , when relevant
p. 486)
Second implied Length Specifies the number of words of global data to be
requested from the comm processor designated by
the routing 1 parameter; the value of the length must
be > 0 ≤ 32 and must not exceed the size of the data
area
Third implied Available words Contains the number of words available from the
requested node; the value is automatically updated
by internal software
Fourth implied Routing 1 The low byte specifies the address of the node
whose global data are to be returned (a value
between 1 ... 64); if this is the second of two local
nodes, set the high byte to a value of 1
Note: If your PLC does not support Modbus Plus
option modules (S985s or NOMs), the high byte of
the fourth implied register is not used and the
highbyte bits must all be set to 0.
466 33002261
MSTR: Master
Short The Get Remote Statistics operation obtains information relative to remote nodes on
Description the network. This operation may require multiple scans to complete and does not
require a master data transaction path.
Network The Get Remote Statistics operation (type 7 in the displayed register of the top
Implementation node) can be implemented for Modbus Plus and TCP/IP Ethernet networks. It is not
used for SY/MAX Ethernet.
Control Block In a Get remote statistics operation, the registers in the MSTR control block (the top
Utilization node) contain the information that differs depending on the type of network you are
using:
l Modbus Plus
l TCP/IP Ethernet
The remote comm processor always returns its complete statistics table when a
request is made, even if the request is for less than the full table. The MSTR
instruction then copies only the amount of words you have requested to the
designated 4x registers.
33002261 467
MSTR: Master
468 33002261
MSTR: Master
Short The Clear remote statistics operation clears statistics related to a remote network
Description node from the data area in the local node. This operation may require multiple scans
to complete and uses a single data master transaction path.
Note: When you issue the Clear Remote Statistics operation, only words 13 ... 22
in the statistics table (See Modbus Plus Network Statistics, p. 480 ) are cleared
Network The Clear remote statistics operation (type 8 in the displayed register of the top
Implementation node) can be implemented for Modbus Plus and TCP/IP Ethernet networks. It is not
used for SY/MAX Ethernet.
The following network statistics are available:
l Modbus Plus Network Statistics, p. 480
l TCP/IP Ethernet Statistics, p. 485
Control Block In a Clear remote statistics operation, the registers in the MSTR control block (the
Utilization top node) contain information that differs according to the type of network in use:
l Modbus Plus
l TCP/IP Ethernet
33002261 469
MSTR: Master
470 33002261
MSTR: Master
Short The peer cop health operation reads selected data from the peer cop
Description communications health table and loads that data to specified 4x registers in state
RAM. The peer cop communications health table is 12 words long, and the words
are indexed via this MSTR operation as words 0 ... 11.
Network The peer cop health operation (type 9) in the displayed register of the top node) can
Implementation be implemented only for Modbus Plus networks.
Control Block The registers in the MSTR control block (the top node) are used in a Peer cop health
Utilization operation:
Register Function Content
Displayed Operation type 9
First implied Error status (See Displays a hex value indicating an MSTR error,
Run Time Errors , when relevant
p. 486)
Second implied Data size Number of words requested from peer cop table
(range 1 ... 12)
Third implied Index First word from the table to be read (range 0 ... 11,
where 0 = the first word in the peer cop table and
11 = the last word in the table)
Fourth implied Routing 1 If this is the second of two local nodes, set the high
byte to a value of 1
Note: If your PLC does not support Modbus Plus
option modules (S985s or NOMs), the fourth implied
register is not used.
Peer Cop The peer cop communications health table comprises 12 contiguous registers that
Communications can be indexed in an MSTR operation as words 0 ... 11. Each bit in each of the table
Health Status words is used to represent an aspect of communications health relative to a specific
Information node on the Modbus Plus network.
33002261 471
MSTR: Master
Bit-to-Network The bits in words 0 ... 3 represent the health of the global input communication
Node expected from nodes 1 ... 64. The bits in words 4 ... 7 represent the health of the
Relationship output from a specific node. The bits in words 8 ... 11 represent the health of the
input to a specific node:
Type of Status Word Index Bit-to-network Node Relationship
Global Input 0
16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1
1
32 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17
2
48 47 46 45 44 43 42 41 40 39 38 37 36 35 34 33
3
64 63 62 61 60 59 58 57 56 55 54 53 52 51 50 49
Specific Output 4
16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1
5
32 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17
6
48 47 46 45 44 43 42 41 40 39 38 37 36 35 34 33
7
64 63 62 61 60 59 58 57 56 55 54 53 52 51 50 49
Specific Input 8
16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1
9
32 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17
10
48 47 46 45 44 43 42 41 40 39 38 37 36 35 34 33
11
64 63 62 61 60 59 58 57 56 55 54 53 52 51 50 49
472 33002261
MSTR: Master
State of a Peer The state of a peer cop health bit reflects the current communication status of its
Cop Health Bit associated node. A health bit is set when its associated node accepts inputs for its
peer copped input data group or hears that another node has accepted specific
output data from the its peer copped output data group. A health bit is cleared when
no communication has occurred for its associated data group within the configured
peer cop health time-out period.
All health bits are cleared when the Put Peer Cop interface command is executed at
PLC start-up time. Table values are not valid until at least one full token rotation
cycle has been completed after execution of the Put Peer Cop interface command.
The health bit for a given node is always zero when its associated peer cop entry is
null.
33002261 473
MSTR: Master
Short The Reset option module operation causes a Quantum NOE option module to enter
Description a reset cycle to reset its operational environment.
Network The Reset option module operation (type 10 in the displayed register of the top
Implementation node) can be implemented for TCP/IP and SY/MAX Ethernet networks, accessed
via the appropriate network adapter. Modbus Plus networks do not use this
operation.
Control Block In a Reset option module operation, the registers in the MSTR control block (the top
Utilization node) differ according to the type of network in use:
l TCP/IP Ethernet
l SY/MAX Ethernet
474 33002261
MSTR: Master
33002261 475
MSTR: Master
Short The Read CTE operation reads a given number of bytes from the Ethernet
Description configuration extension table to the indicated buffer in PLC memory. The bytes to be
read begin at a byte offset from the beginning of the CTE. The content of the
Ethernet CTE table (See CTE Display Implementation (Middle Node), p. 477) is
displayed in the middle node of the MSTR block.
Network The Read CTE operation (type 11 in the displayed register of the top node) can be
Implementation implemented for TCP/IP and SY/MAX Ethernet networks, accessed via the
appropriate network adapter. Modbus Plus networks do not use this operation.
Control Block In a Read CTE operation, the registers in the MSTR control block (the top node)
Utilization differ according to the type of network in use:
l TCP/IP Ethernet
l SY/MAX Ethernet
476 33002261
MSTR: Master
CTE Display The values in the Ethernet configuration extension table (CTE) are displayed in a
Implementation series of registers in the middle node of the MSTR instruction when a Read CTE
(Middle Node) operation is implemented. The middle node contains the first of 11 contiguous 4x
registers.
The registers display the following CTE data:
Parameter Register Content
Frame type Displayed 1 = 802.3
2 = Ethernet
IP address First implied First byte of the IP address
Second implied Second byte of the IP address
Third implied Third byte of the IP address
Fourth implied Fourth byte of the IP address
Subnetwork mask Fifth implied Hi word
Sixth implied Low word
Gateway Seventh implied First byte of the gateway
Eighth implied Second byte of the gateway
Ninth implied Third byte of the gateway
Tenth implied Fourth byte of the gateway
33002261 477
MSTR: Master
Short The Write CTE operation writes the configuration CTE table from the data specified
Description in the middle node to an indicated Ethernet configuration extension table or a
specified slot.
Network The Write CTE operation (type 12 in the displayed register of the top node) can be
Implementation implemented for TCP/IP and SY/MAX Ethernet networks, via the appropriate
network adapter. Modbus Plus networks do not use this operation.
Control Block In a Write CTE operation, the registers in the MSTR control block (the top node)
Utilization differ according to the type of network in use:
l TCP/IP Ethernet
l SY/MAX Ethernet
478 33002261
MSTR: Master
CTE Display The values in the Ethernet configuration extension table (CTE) are displayed in a
Implementation series of registers in the middle node of the MSTR instruction when a Write CTE
(Middle Node) operation is implemented. The middle node contains the first of 11 contiguous 4x
registers.
The registers are used to transfer the following CTE data:
Parameter Register Content
Frame type Displayed 1 = 802.3
2 = Ethernet
IP address First implied First byte of the IP address
Second implied Second byte of the IP address
Third implied Third byte of the IP address
Fourth implied Fourth byte of the IP address
Subnetwork mask Fifth implied Hi word
Sixth implied Low word
Gateway Seventh implied First byte of the gateway
Eighth implied Second byte of the gateway
Ninth implied Third byte of the gateway
Tenth implied Fourth byte of the gateway
33002261 479
MSTR: Master
Modbus Plus The following table shows the statistics available on the Modbus Plus network. You
Network may acquire this information by using the appropriate MSTR operation or by using
Statistics Modbus function code 8.
Note: When you issue the Clear local or Clear remote statistics operations, only
words 13 ... 22 are cleared.
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
480 33002261
MSTR: Master
33002261 481
MSTR: Master
482 33002261
MSTR: Master
33002261 483
MSTR: Master
484 33002261
MSTR: Master
TCP/IP Ethernet A TCP/IP Ethernet board responds to Get Local Statistics and Set Local Statistics
Statistics commands with the following information:
Word Meaning
00 ... 02 MAC address, e.g., if the MAC address is 00 00 54 00 12 34, it is
displayed as follows:
Word Content
00 00 00
01 00 54
02 34 12
03 Board status Meaning
0x0001 Running
0x4000 APPI LED (1=ON, 0 = OFF)
0x8000 Link LED
04 and 05 Number of receiver interrupts
06 and 07 Number of transmitter interrupts
08 and 09 Transmit-timeout error count
10 and 11 Collision-detect error count
12 and 13 Missed packets
14 and 15 Memory error count
16 and 17 Number of times driver has restarted lance
18 and 19 Receive framing error count
20 and 21 Receiver overflow error count
22 and 23 Receive CRC error count
24 and 25 Receive buffer error count
26 and 27 Transmit buffer error count
28 and 29 Transmit silo underflow count
30 and 31 Late collision count
32 and 33 Lost carrier count
34 and 35 Number of retries
33002261 485
MSTR: Master
Word Meaning
36 and 37 IP address, e.g., if the IP address is 198.202.137.113 (or c6 CA 89 71),
it is displayed as follows:
Word Content
36 89 71
37 C6 CA
Runtime Errors If an error occurs during a MSTR operation, a hexadecimal error code will be
displayed in the first implied register in the control block (the top node).
Function error codes are network-specific:
l Modbus Plus and SY/MAX Ethernet Error Codes, p. 487
l SY/MAX-specific Error Codes, p. 489
l TCP/IP Ethernet Error Codes, p. 491
l CTE Error Codes for SY/MAX and TCP/IP Ethernet, p. 494
486 33002261
MSTR: Master
Form of the The form of the function error code for Modbus Plus and SY/MAX Ethernet
Function Error transactions is Mmss, where
Code l M represents the major code
l m represents the minor code
l ss represents a subcode
Hexadecimal HEX Error Code for Modbus Plus and SY/MAX Ethernet:
Error Code
Hex Error Code Meaning
1001 User has aborted the MSTR element
2001 An unsupported operation type has been specified in the control block
2002 One or more control block parameter has been changed while the MSTR
element is active (applies only to operations that take multiple scans to
complete). Control block parameters may be changed only when the
MSTR element is not active.
2003 Invalid value in the length field of the control block
2004 Invalid value in the offset field of the control block
2005 Invalid values in the length and offset fields of the control block
2006 Invalid slave device data area
2007 Invalid slave device network area
2008 Invalid slave device network routing
2009 Route equal to your own address
200A Attempting to obtain more global data words than available
30ss Modbus slave exception response (See ss HEX Value in Error Code
30ss, p. 488)
4001 Inconsistent Modbus slave response
5001 Inconsistent network response
6mss) Routing failure (See ss Hex Value in Error Code 6mss, p. 488)
33002261 487
MSTR: Master
ss Hex Value in The m subfield in error code 6mss is an index into the routing information indicating
Error Code 6mss where an error has been detected (a value of 0 indicates the local node, a 2 the
second device on the route, etc.).
The ss subfield in error code 6mss is:
ss Hex Value Meaning
01 No response received
02 Program access denied
03 Node off-line and unable to communicate
04 Exception response received
05 Router node data paths busy
06 Slave device down
07 Bad destination address
08 Invalid node type in routing path
10 Slave has rejected the command
20 Initiated transaction forgotten by slave device
40 Unexpected master output path received
80 Unexpected response received
F001 Wrong destination node specified for the MSTR operation
488 33002261
MSTR: Master
Types or Errors Three additional types of errors may be reported in the MSTR instruction when
SY/MAX Ethernet is being used.
The error codes have the following designations:
l 71xx errors: Errors detected by the remote SY/MAX device
l 72xx errors: Errors detected by the serve
l 73xx errors: Errors detected by the Quantum translator
33002261 489
MSTR: Master
490 33002261
MSTR: Master
Error in an MSTR An error in an MSTR routine over TCP/IP Ethernet may produce one of the following
Routine errors in the MSTR control block.
The form of the code is Mmss, where
l M represents the major code
l m represents the minor code
l ss represents a subcode
33002261 491
MSTR: Master
HEX Error Code An error on the TCP/IP Ethernet network itself may produce one of the following
TCP/IP Ethernet errors in the MSTR control block:
Network
Hex Error Code Meaning
5004 Interrupted system call
5005 I/O error
5006 No such address
5009 The socket descriptor is invalid
500C Not enough memory
500D Permission denied
5011 Entry exists
5016 An argument is invalid
5017 An internal table has run out of space
5020 The connection is broken
5023 This operation would block and the socket is nonblocking
5024 The socket is nonblocking and the connection cannot be completed
5025 The socket is nonblocking and a previous connection attempt has not yet
completed
5026 Socket operation on a nonsocket
5027 The destination address is invalid
5028 Message too long
5029 Protocol wrong type for socket
502A Protocol not available
502B Protocol not supported
502C Socket type not supported
502D Operation not supported on socket
502E Protocol family not supported
502F Address family not supported
5030 Address is already in use
5031 Address not available
5032 Network is down
5033 Network is unreachable
5034 Network dropped connection on reset
5035 The connection has been aborted by the peer
5036 The connection has been reset by the peer
5037 An internal buffer is required, but cannot be allocated
5038 The socket is already connected
492 33002261
MSTR: Master
33002261 493
MSTR: Master
CTE Error Codes HEX Error Code MSTR routine over TCP/IP Ethernet:
for SY/MAX and
Hex Error Code Meaning
TCP/IP Ethernet
7001 The is no Ethernet configuration extension
7002 The CTE is not available for access
7003 The offset is invalid
7004 The offset + length is invalid
7005 Bad data field in the CTE
494 33002261
MU16: Multiply 16 Bit
89
At a Glance
33002261 495
MU16: Multiply 16 Bit
Short Description
Function The MU16 instruction performs signed or unsigned multiplication on the 16-bit
Description values in the top and middle nodes, then posts the product in two contiguous holding
registers in the bottom node.
Representation
value 1
value 2
MU16
product
496 33002261
MUL: Multiply
90
At a Glance
33002261 497
MUL: Multiply
Short Description
Function The MUL instruction multiplies unsigned value 1 (its top node) by unsigned value 2
Description (its middle node) and stores the product in two contiguous holding registers in the
bottom node.
Representation
value 1
value 2
MUL
result
498 33002261
MUL: Multiply
Example
Product of For example, if value 1 = 8 000 and value 2 = 2, the product is 16 000. The displayed
Instruction MUL register contains the value 0001 (the high-order half of the product), and implied
register contains the value 6 000 (the low-order half of the product).
33002261 499
MUL: Multiply
500 33002261
NBIT: Bit Control
91
At a Glance
33002261 501
NBIT: Bit Control
Short Description
Function The normal bit (NBIT) instruction lets you control the state of a bit from a register by
Description specifying its associated bit number in the bottom node. The bits being controlled
are similar to coils, when a bit is turned ON, it stays ON until a control signal turns it
OFF.
Note: The NBIT instruction does not follow the same rules of network placement
as 0x-referenced coils do. An NBIT instruction cannot be placed in column 11 of a
network and it can be placed to the left of other logic nodes on the same rungs of
the ladder.
Representation
register #
NBIT
bit #
(1 ... 16)
502 33002261
NCBT: Normally Closed Bit
92
At a Glance
33002261 503
NCBT: Normally Closed Bit
Short Description
Function The normally closed bit (NCBT) instruction lets you sense the logic state of a bit in
Description a register by specifying its associated bit number in the bottom node. The bit is
representative of an N.C contact. It passes power from the top output when the
specified bit is OFF and the top input is ON.
Representation
register #
NCBT
bit #
(1 ... 16)
504 33002261
NOBT: Normally Open Bit
93
At a Glance
33002261 505
NOBT: Normally Open Bit
Short Description
Function The normally open bit (NOBT) instruction lets you sense the logic state of a bit in a
Description register by specifying its associated bit number in the bottom node. The bit is
representative of an N.O contact.
Representation
register #
NOBT
bit #
(1 ... 16)
506 33002261
NOL: Network Option Module for
Lonworks
94
At a Glance
33002261 507
NOL: Network Option Module for Lonworks
Short Description
Function The following steps are necessary before using this instruction:
Requirements
Step Action
1 Add loadable NSUP.exe to the controller’s configuration
Note: This loadable needs only be loaded once to support multiple loadables,
such as ECS.exe and XMIT.exe.
CAUTION
The outputs of the instruction turn on, regardless of the input states
When the NSUP loadable is not installed or is installed after the NOL loadable or
is installed in a Quantum PLC with an executive < V2.0, all three outputs turn on,
regardless of the input states.
Failure to follow this instruction can result in injury or equipment damage.
Step Action
2 Unpack and install the DX Loadable NOL; further information you will find in the
chapter Installation of DX Loadables, p. 71.
Function The NOL instruction is provided to facilitate the movement of the large amount of
Description data between the NOL module and the controller register space. The NOL Module
is mapped for 16 input registers (3X) and 16 output registers (4X). Of these
registers, two input and two output registers are for handshaking between the NOL
Module and the instruction. The remaining fourteen input and fourteen output
registers are used to transport the data.
508 33002261
NOL: Network Option Module for Lonworks
Representation
function #
register
block
NOL
count
33002261 509
NOL: Network Option Module for Lonworks
Detailed Description
Register Block This block provides the registers for configuration and status information, the
(Middle Node) registers for the health status bits and the registers for the actual data of the
Standard Network Variable Types (SNVTs).
Register Block
Register Content
Configuration and Displayed and first implied I/O Map input base (3x)
Status information Second and third implied I/O Map output base (4x)
Fourth implied Enable health bits
Fifth implied Number of input registers
Sixth implied Number of output registers
Seventh implied Number of discrete input registers
Eighth implied Number of discrete output registers
Ninth implied Config checksum (CRC)
10th implied NOL version
11th implied Module firmware version
12th implied NOL DX version
13th implied Module DX version
14th to 15th implied Not used
SNVTs Health Bit 16th to 31st implied Health bits of each programmable
Status network variable
(if enabled in
DX-Zoom screen)
SNVTs Actual Enable Health Bit = NO: Data is stored in 4 groups:
Data from 16th implied up l Discrete inputs
Enable Health Bit = YES: l Register inputs
from 32nd implied up l Discrete outputs
l Register outputs
These groups of data are set up
consecutively and start on word
boundaries.
The first 16 registers with configuration and status information can be programmed
and monitored via the NOL DX Zoom screen. For setting up the link to the NOL
module the only parameters that need to be entered are the beginning 3x and 4x
registers used when I/O mapping the NOL module.
510 33002261
NOL: Network Option Module for Lonworks
Further information you will find in the documentation Network Option Module for
LonWorks.
Count Defines the total number of registers required by the function block. This value must
(Bottom Node) be set to a value equal to or greater than the number of data registers required to
transfer and store the network data being used by the NOL module. If the count
value is not large enough for the required data, the error output will be set.
33002261 511
NOL: Network Option Module for Lonworks
512 33002261
OR: Logical OR
95
At a Glance
33002261 513
OR: Logical OR
Short Description
Function The OR instruction performs a Boolean OR operation on the bit patterns in the
Description source and destination matrices.
The ORed bit pattern is then posted in the destination matrix, overwriting its previous
contents.
0 1 1 0
source
destination
bits OR OR OR OR bits
0 0 0 1 1 1 1 1
WARNING
Overriding of any disabled coils within the destination matrix without
enabling them
OR will override any disabled coils within the destination matrix without enabling
them. This can cause personal injury if a coil has disabled an operation for
maintenance or repair because the coil’s state can be changed by the OR
operation.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
514 33002261
OR: Logical OR
Representation
source
matrix
destination
matrix
OR
length
Parameter Description
Matrix Length The integer entered in the bottom node specifies the matrix length, i.e. the number
(Bottom Node) of registers or 16-bit words in the two matrices. The matrix length can be in the range
1 ... 100. A length of 2 indicates that 32 bits in each matrix will be ORed.
33002261 515
OR: Logical OR
516 33002261
PCFL: Process Control Function
Library
96
At a Glance
33002261 517
PCFL: Process Control Function Library
Short Description
Function The PCFL instruction gives you access to a library of process control functions
Description utilizing analog values.
PCFL operations fall into three major categories:
l Advanced Calculations
l Signal Processing
l Regulatory Control
A PCFL function is selected from a list of alphabetical subfunctions in a pulldown
menu in the panel software, and the subfunction is displayed in the top node of the
instruction (see the table Function (Top Node), p. 520 for a list of subfunctions and
descriptions).
PCFL uses the same FP library as EMTH. If the PLC that you are using for PCFL
does not have the onboard 80x87 math coprocessor chip, calculations take a
comparatively long time to execute. PLCs with the math coprocessor can solve
PCFL calculations ten times faster than PLCs without the chip. Speed, however,
should not be an issue for most traditional process control applications where
solution times are measured in seconds, not milliseconds.
518 33002261
PCFL: Process Control Function Library
Representation
function
parameter
block
PCFL
length
33002261 519
PCFL: Process Control Function Library
Parameter Description
Function A subfunction for the selected PCFL library function is specified in the top node:
(Top Node)
Operation Subfunction Description Time-
dependent
Operations
Advanced AVER Average weighted inputs no
Calculations CALC Calculate preset formula no
EQN Formatted equation calculator no
Signal ALARM Central alarm handler for a PV input no
Processing AIN Convert inputs to scaled engineering units no
AOUT Convert outputs to values in the 0 ... 4095 no
range
DELAY Time delay queue yes
LKUP Look-up table no
INTEG Integrate input at specified interval yes
LLAG First-order lead/lag filter yes
LIMIT Limiter for the PV (low/low, low, high, high/ no
high)
LIMV Velocity limiter for changes in the PV (low, yes
high)
MODE Put input in auto or manual mode no
RAMP Ramp to set point at a constant rate yes
RMPLN Logarithmic ramp to set point (~2/3 closer to yes
set point for each time constant)
RATE Derivative rate calculation over a specified yes
time
SEL High/low/average input selection no
Regulatory KPID Comprehensive ISA non-interacting yes
Control proportional-integral-derivative (PID)
ONOFF Specifies ON/OFF values for deadband no
PID PID algorithms yes
PI ISA non-interacting PI (with halt/manual/auto yes
operation features)
RATIO Four-station ratio controller no
TOTAL Totalizer for metering flow yes
520 33002261
PCFL: Process Control Function Library
Advanced Advanced calculations are used for general mathematical purposes and are not
Calculations limited to process control applications. With advanced calculations, you can create
custom signal processing algorithms, derive states of the controlled process, derive
statistical measures of the process, etc.
Simple math routines have already been offered in the EMTH instruction. The
calculation capability included in PCFL is a textual equation calculator for writing
custom equations instead of programming a series of math operations one by one.
Signal Signal processing functions are used to manipulate process and derived process
Processing signals. They can do this in a variety of ways; they linearize, filter, delay, and
otherwise modify a signal. This category would include functions such as an Analog
Input/Output, Limiters, Lead/Lag, and Ramp generators.
Parameter Block The 4x register entered in the middle node is the first in a block of contiguous holding
(Middle Node) register where the parameters for the specified PCFL operation are stored.
The ways that the various PCFL operations implement the parameter block are
described in the description of the various subfunctions (PCFL operations).
Within the parameter block of each PCFL function are two registers used for input
and output status.
33002261 521
PCFL: Process Control Function Library
Output Flags In all PCFL functions, bits 12 ... 16 of the output status register define the following
standard output flags:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 - 11 Not used
12 1 = Math error - invalid floating point or output
13 1 = Unknown PCFL function
14 not used
15 1 = Size of the allocated register table is too small
16 1 = Error has occurred - pass power to the bottom output
For time-dependent PCFL functions, bits 9 and 11 are also used as follows:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1-8 Not used
9 1 = Initialization working
10 Not used
11 1 = Illegal solution interval
12 1 = Math error - invalid floating point or output
13 1 = Unknown PCFL function
14 not used
15 1 = Size of the allocated register table is too small
16 1 = Error has occurred - pass power to the bottom output
522 33002261
PCFL: Process Control Function Library
Input Flags In all PCFL functions, bits 1 and 3 of the input status register define the following
standard input flags:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = Function initialization complete or in progress
0 = Initialize the function
2 not used
3 1 = Timer override
4 -16 not used
Length The integer value entered in the bottom node specifies the length, i.e. the number of
(Bottom Node) registers, of the PCFL parameter block. The maximum allowable length will vary
depending on the function you specify.
33002261 523
PCFL: Process Control Function Library
524 33002261
PCFL-AIN: Analog Input
97
At a Glance
33002261 525
PCFL-AIN: Analog Input
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The AIN function scales the raw input produced by analog input modules to
engineering values that can be used in the subsequent calculations.
Three scaling options are available:
l Auto input scaling
l Manual input scaling
l Implementing process square root on the input to linearize the signal before
scaling
526 33002261
PCFL-AIN: Analog Input
Representation
AIN
parameter
block
PCFL
14
33002261 527
PCFL-AIN: Analog Input
Parameter Description
Mode of AIN supports the range resolutions for following device types:
Functioning Quantum Engineering Ranges
Resolution Range: Valid Range: Under Range: Over
10 V 768 ... 64 768 767 64 769
5V 16 768 ... 48 768 16 767 48 769
0 ... 10 V 0 ... 64 000 0 64 001
0 ... 5 V 0 ... 32 000 0 32 001
1 ... 5 V 6 400 ... 32 000 6 399 32 001
Quantum Thermocouple
Resolution Range: Valid
TC degrees -454 ... +3 308
TC 0.1 degrees -4 540 ... +32 767
TC Raw Units 0 ... 65 535
Quantum Voltmeter
Resolution Range: Valid Range: Under Range: Over
10 V -10 000 ... +10 000 -10 001 +10 001
5V -5 000 ... +5 000 -5 001 +5 001
0 ... 10 V 0 ... 10 000 0 10 001
0 ... 5 V 0 ... 5 000 0 5 001
1 ... 5 V 1 000 ... 5 000 999 5 001
528 33002261
PCFL-AIN: Analog Input
Bit Function
1...5 Not used
6 1 = with TC PSQRT, invalid: in extrapolation range, PSQRT not used
7 1 = input out of range
8 1 = echo under range from input module
9 1 = echo over range from input module
10 1 = invalid output mode selected
11 1 = invalid Engineering Units
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
33002261 529
PCFL-AIN: Analog Input
Bit Function
1 ... 3 Standard input bits (flags) (See Input Flags, p. 523)
4 ... 8 Ranges (see following tables)
9 1 = process square root on raw input
10 1 = manual scaling mode
0 = auto scaling mode
11 1 = extrapolate over-/under-range for auto mode
0 = clamp over-/under-range for auto mode
12 ... 16 Not used
Quantum Thermocouple
Bit
4 5 6 7 8 Range
0 1 1 0 1 TC degrees
0 1 1 1 0 TC 0.1 degrees
0 1 1 1 1 TC raw units
530 33002261
PCFL-AIN: Analog Input
Quantum Voltmeter
Bit
4 5 6 7 8 Range
1 0 0 0 0 +/- 10V
1 0 0 1 0 +/- 5V
1 0 1 0 0 0 ... 10 V
1 0 1 1 0 0 ... 5 V
1 1 0 0 0 1 ... 5 V
33002261 531
PCFL-AIN: Analog Input
532 33002261
PCFL-ALARM: Central Alarm
Handler
98
At a Glance
33002261 533
PCFL-ALARM: Central Alarm Handler
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The ALARM function gives you a central block for alarm handling where you can set
high (H), low (L), high high (HH), and low low (LL) limits on a process variable.
ALARM lets you specify
l A choice of normal or deviation operating mode
l Whether to use H/L or both H/L and HH/LL limits
l Whether or not to use deadband (DB) around the limits
534 33002261
PCFL-ALARM: Central Alarm Handler
Representation
ALARM
parameter
block
PCFL
16
33002261 535
PCFL-ALARM: Central Alarm Handler
Parameter Description
Note: ALARM automatically tracks the last input, even when you specify normal
mode, to facilitate a smooth transition to deviation mode.
536 33002261
PCFL-ALARM: Central Alarm Handler
Bit Function
1 ... 4 Not used
5 1 = DB set to negative number
6 1 = deviation mode chosen with DB option
7 1 = LL crossed (x ≤ LL
8 1 = L crossed (x ≤ L or LL < x ≤ L) with HH/LL option set
9 1 = H crossed (x ≥ H or H ≤ x < HH) with HH/LL option set
10 1 = HH crossed (x ≥ HH)
11 1 = invalid limits specified
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 1 = deviation mode
0 = normal mode
6 1 = both H/L and HH/LL limits apply
7 1 = DB enabled
8 1 = retain H/L flag when HH/LL limits crossed
9 ... 16 Not used
33002261 537
PCFL-ALARM: Central Alarm Handler
538 33002261
PCFL-AOUT: Analog Output
99
At a Glance
33002261 539
PCFL-AOUT: Analog Output
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The AOUT function is an interface for calculated signals for output modules. It
converts the signal to a value in the range 0 ... 4 096.
540 33002261
PCFL-AOUT: Analog Output
Representation
AOUT
parameter
block
PCFL
33002261 541
PCFL-AOUT: Analog Output
Parameter Description
Bit Function
1 ... 7 Not used
8 1 = clamped low
9 1 = clamped high
10 not used
11 1 = invalid H/L limits
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 16 Not used
542 33002261
PCFL-AVER: Average Weighted
Inputs Calculate
100
At a Glance
33002261 543
PCFL-AVER: Average Weighted Inputs Calculate
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Advanced Calculations, p. 521.
544 33002261
PCFL-AVER: Average Weighted Inputs Calculate
Representation
AVER
parameter
block
PCFL
24
33002261 545
PCFL-AVER: Average Weighted Inputs Calculate
Parameter Description
Bit Function
1 ... 9 Not used
10 1 = no inputs activated
11 1 = result negative
0 = result positive
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
546 33002261
PCFL-AVER: Average Weighted Inputs Calculate
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 1 = In4 and w4 are used
6 1 = In3 and w3 are used
7 1 = In2 and w2 are used
8 1 = In1 and w1 are used
9 1 = k is active
10 ... 16 Not used
A weight can be used only when its corresponding input is enabled, e.g. the 20th
and 21st implied registers (which contain the value of w4) can be used only when
the 10th and 11th implied registers (which contain In4) are enabled. The I in the
denominator is used only when the constant is enabled.
33002261 547
PCFL-AVER: Average Weighted Inputs Calculate
548 33002261
PCFL-CALC: Calculated preset
formula
101
At a Glance
33002261 549
PCFL-CALC: Calculated preset formula
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Advanced Calculations, p. 521.
The CALC function calculates a preset formula with up to four inputs, each
characterized in a separate register of the parameter block.
Representation
CALC
parameter
block
PCFL
14
550 33002261
PCFL-CALC: Calculated preset formula
Parameter Description
Bit Function
1...10 Not used
11 1 = bad input code chosen
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
33002261 551
PCFL-CALC: Calculated preset formula
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 6 not used
7 ... 10 Formula Code
11 ... 16 Not used
Formula Code
Bit Formula Code
7 8 9 10
0 0 0 1 (A × B) – (C × D)
0 0 1 1 (A × B) ⁄ (C × D )
0 1 0 0 A ⁄ (B × C × D)
0 1 0 1 (A × B × C) ⁄ D
0 1 1 0 A×B×C×D
0 1 1 1 A+B+C+D
1 0 0 0 A × B ( C –D )
1 0 0 1 D
A[ (B ⁄ C ) ]
1 0 1 0 A × LN(B ⁄ C)
1 0 1 1 ( A – B ) – ( C – D ) ⁄ LN [ ( A – B ) ⁄ ( C – D ) ]
1 1 0 0 (–C ⁄ D )
(A ⁄ B)
1 1 0 1 ( A –B ) ⁄ ( C – D )
552 33002261
PCFL-DELAY: Time Delay Queue
102
At a Glance
33002261 553
PCFL-DELAY: Time Delay Queue
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The DELAY function can be used to build a series of readings for time-delay
compensation in the logic. Up to 10 sampling instances can be used to delay an
input.
All values are carried along in registers, where register x[0] contains the current
sampled input. The 10th delay period does not need to be stored. When the 10th
instance in the sequence takes place, the value in register x[9] can be moved
directly to the output
A DXDONE message is returned when the calculation is complete. The function can
be reset by toggling the first-scan bit.
554 33002261
PCFL-DELAY: Time Delay Queue
Representation
DELAY
parameter
block
PCFL
32
33002261 555
PCFL-DELAY: Time Delay Queue
Parameter Description
Bit Function
1...3 Not used
4 1 = k out of range
5 ... 8 Count of registers left to be initialized
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
556 33002261
PCFL-DELAY: Time Delay Queue
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 8 Time Delay ≤ 10
9 ... 11 Echo number of registers left to be initialized
12 ... 16 Not used
33002261 557
PCFL-DELAY: Time Delay Queue
558 33002261
PCFL-EQN: Formatted Equation
Calculator
103
At a Glance
33002261 559
PCFL-EQN: Formatted Equation Calculator
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Advanced Calculations, p. 521.
The EQN function is a formatted equation calculator. You must define the equation
in the parameter block with various codes that specify operators, input selection and
inputs.
EQN is used for equations that have four or fewer variables but do not fit into the
CALC format. It complements the CALC function by letting you input an equation
with floating point and integer inputs as well as operators.
560 33002261
PCFL-EQN: Formatted Equation Calculator
Representation
EQN
parameter
block
PCFL
15 ... 64
33002261 561
PCFL-EQN: Formatted Equation Calculator
Parameter Description
Parameter Block The length of the EQN parameter block can be as high as 64 registers:
(Middle Node)
Register Content
Displayed and first implied Reserved
Second implied Output Status, p. 562
Third implied Input Status, p. 563
Fourth and fifth implied Variable A
Sixth and seventh implied Variable B
Eighth and ninth implied Variable C
10th and 11th implied Variable D
12th and 13th implied Output
14th implied First Formula Code, p. 564
15th implied Second possible formula code
... ...
63rd implied Last possible formula code
Bit Function
1 Stack error
2...3 Not used
4 ... 8 Code of last error logged
9 1 = bad operator selection code
10 1 = EQN not fully programmed
11 1 = bad input code chosen
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
562 33002261
PCFL-EQN: Formatted Equation Calculator
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 1 = Degree/radian option for trigonometry
6 ... 8 not used
9 ... 16 Equation size for display in Concept
33002261 563
PCFL-EQN: Formatted Equation Calculator
Formula Code Each formula code in the EQN function defines either an input selection code or an
operator selection code.
Formula Code (Parameter Block)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 ... 4 Not used
5 ... 8 Definition of input selection
9 ... 11 Not used
12 ... 16 Definition of operator selection
Input Selection
Bit Input Selection
5 6 7 8
0 0 0 0 Use operator selection
0 0 0 1 Float input
0 0 1 1 16-bit integer
1 0 0 0 Variable A
1 0 0 1 Variable B
1 0 1 0 Variable C
1 0 1 1 Variable D
564 33002261
PCFL-EQN: Formatted Equation Calculator
Operator Selection
Bit Operator Selection
12 13 14 15 16
0 0 0 0 0 No operation
0 0 0 0 1 Absolute value
0 0 0 1 0 Addition
0 0 0 1 1 Division
0 0 1 0 0 Exponent
0 0 1 1 1 LN (natural logarithm)
0 1 0 0 0 G (logarithm)
0 1 0 0 1 Multiplication
0 1 0 1 0 Negation
0 1 0 1 1 Power
0 1 1 0 0 Square root
0 1 1 0 1 Subtraction
0 1 1 1 0 Sine
0 1 1 1 1 Cosine
1 0 0 0 0 Tangent
1 0 0 0 1 Arcsine
1 0 0 1 0 Arccosine
1 0 0 1 1 Arctangent
33002261 565
PCFL-EQN: Formatted Equation Calculator
566 33002261
PCFL-INTEG: Integrate Input at
Specified Interval
104
At a Glance
33002261 567
PCFL-INTEG: Integrate Input at Specified Interval
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The INTEG function is used to integrate over a specified time interval. No protection
against integral wind-up is provided in this function. INTEG is time-dependent, e.g.
if you are integrating at an input value of 1/sec, it matters whether it operates over
one second (in which case the result is 1) or over one minute (in which case the
result is 60).
You can set flags to either initialize or restart the function after an undetermined
down-time, and you can reset the integral sum if you wish. If you set the initialize
flag, you must specify a reset value (zero or the last output in case of power failure),
and calculations will be skipped for one sample.
The function returns a DXDONE message when the operation is complete.
568 33002261
PCFL-INTEG: Integrate Input at Specified Interval
Representation
INTEG
parameter
block
PCFL
16
33002261 569
PCFL-INTEG: Integrate Input at Specified Interval
Parameter Description
Bit Function
1...8 Not used
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 Reset sum
6 ... 16 Not used
570 33002261
PCFL-KPID: Comprehensive ISA
Non Interacting PID
105
At a Glance
33002261 571
PCFL-KPID: Comprehensive ISA Non Interacting PID
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Regulatory Control, p. 521.
The KPID function offers a superset of the functionality of the PID function, with
additional features that include:
l A gain reduction zone
l A separate register for bumpless transfer when the integral term is not used
l A reset mode
l An external set point for cascade control
l Built-in velocity limiters for set point changes and changes to a manual output
l A variable derivative filter constant
l Optional expansion of anti-reset wind-up limits
572 33002261
PCFL-KPID: Comprehensive ISA Non Interacting PID
Representation
KPID
parameter
block
PCFL
64
33002261 573
PCFL-KPID: Comprehensive ISA Non Interacting PID
Parameter Description
574 33002261
PCFL-KPID: Comprehensive ISA Non Interacting PID
Register Content
Outputs 38th and 39th implied Bumpless transfer register, BT
40th and 41st implied Calculated control difference (error term), XD
42nd implied Previous operating mode
43rd and 44th implied Dt (in ms) since last solve
45th and 46th implied Previous system deviation, XD_1
47th and 48th implied Previous input, X_1
49th and 50th implied Integral part for Y, YI
51st and 52nd implied Differential part for Y, YD
53rd and 54th implied Set point, SP
55th and 56th implied Proportional part for Y, YP
57th implied Previous operating status
Timing 58th implied 10 ms clock at time n
Information 59th implied Reserved
60th and 61th implied Solution interval (in ms)
Output 62th and 63th implied Manipulated output variable, Y
Bit Function
1 Error
2 1 = low limit exceeded
3 1 = high limit exceeded
4 1 = Cascade mode selected
5 1 = Auto mode selected
6 1 = Halt mode selected
7 1 = Manual mode selected
8 1 = Reset mode selected
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
33002261 575
PCFL-KPID: Comprehensive ISA Non Interacting PID
Bit Function
1...4 Not used
5 1 = Previous D mode selected
6 1 = Previous I mode selected
7 1 = Previous P mode selected
8 1 = Previous mode selected
9 ... 16 Not used
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 1 = Reset mode
6 1 = Manual mode
7 1 = Halt mode
8 1 = Cascade mode
9 1 = Solve proportional algorithm
10 1 = Solve integral algorithm
11 1 = Solve derivative algorithm
12 1 = solve derivative algorithm based on x
0 = solve derivative algorithm based on xd
13 1 = anti--reset wind-up on YI only
0 = normal anti--reset wind-up
14 1 = disable bumpless transfer
0 = bumpless transfer
15 1 = Manual Y tracks Y
16 1 = reverse action for loop output
0 = direct action for loop output
576 33002261
PCFL-LIMIT: Limiter for the Pv
106
At a Glance
33002261 577
PCFL-LIMIT: Limiter for the Pv
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The LIMIT function limits the input to a range between a specified high and low
value. If the high or low limit is reached, the function sets an H or L flag and clamps
the output.
LIMIT returns a DXDONE message when the operation is complete.
Representation
LIMIT
parameter
block
PCFL
578 33002261
PCFL-LIMIT: Limiter for the Pv
Parameter Description
Bit Function
1...8 Not used
9 1 = input < low limit
10 1 = input > high limit
11 1 = invalid high/low limits (e.g., low ≥ high
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 16 Not used
33002261 579
PCFL-LIMIT: Limiter for the Pv
580 33002261
PCFL-LIMV: Velocity Limiter for
Changes in the Pv
107
At a Glance
33002261 581
PCFL-LIMV: Velocity Limiter for Changes in the Pv
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The LIMV function limits the velocity of change in the input variable between a
specified high and low value. If the high or low limit is reached, the function sets an
H or L flag and clamps the output.
LIMV returns a DXDONE message when the operation is complete.
582 33002261
PCFL-LIMV: Velocity Limiter for Changes in the Pv
Representation
LIMV
parameter
block
PCFL
14
33002261 583
PCFL-LIMV: Velocity Limiter for Changes in the Pv
Parameter Description
Bit Function
1...5 Not used
6 1 = negative velocity limit
7 1 = input < low limit
8 1 = input > high limit
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 16 Not used
584 33002261
PCFL-LKUP: Look-up Table
108
At a Glance
33002261 585
PCFL-LKUP: Look-up Table
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The LKUP function establishes a look-up table using a linear algorithm to interpolate
between points. LKUP can handle variable point intervals and variable numbers of
points.
Representation
LKUP
parameter
block
PCFL
39
586 33002261
PCFL-LKUP: Look-up Table
Parameter Description
Mode of The LKUP function establishes a look-up table using a linear algorithm to interpolate
Functioning between points. LKUP can handle variable point intervals and variable numbers of
points.
If the input (x) is outside the specified range of points, the output (y) is clamped to
the corresponding output y0 or yn. If the specified parameter block length is too
small or if the number of points is out of range, the function does not check the xn
because the information from that pointer is invalid.
Points to be interpolated are determined by a binary search algorithm starting near
the center of x data. The search is valid for x1 < x < xn. The variable x may occur
multiple times with the same value, the value chosen from the look-up table is the
first instance found.
For example, if the table is:
x y
10.0 1.0
20.0 2.0
30.0 3.0
30.0 3.5
40.0 4.0
then an input of 30.0 finds the first instance of 30.0 and assigns 3.0 as the output.
An input of 31.0 would assign the value 3.55 as the output.
No sorting is done on the contents of the lookup table. Independent variable table
values should be entered in ascending order to prevent unreachable gaps in the
table.
The function returns a DXDONE message when the operation is complete.
33002261 587
PCFL-LKUP: Look-up Table
Bit Function
1 ... 9 Not used
10 1 = input clamped, i.e. out of table’s range
11 ! = invalid number of points
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 16 Not used
588 33002261
PCFL-LLAG: First-order Lead/Lag
Filter
109
At a Glance
33002261 589
PCFL-LLAG: First-order Lead/Lag Filter
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
590 33002261
PCFL-LLAG: First-order Lead/Lag Filter
Representation
LLAG
parameter
block
PCFL
20
33002261 591
PCFL-LLAG: First-order Lead/Lag Filter
Parameter Description
Bit Function
1...8 Not used
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 16 Not used
592 33002261
PCFL-MODE: Put Input in Auto or
Manual Mode
110
At a Glance
33002261 593
PCFL-MODE: Put Input in Auto or Manual Mode
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The MODE function sets up a manual or automatic station for enabling and disabling
data transfers to the next block. The function acts like a BLKM instruction, moving a
value to the output register.
In auto mode, the input is copied to the output. In manual mode, the output is
overwritten by a user entry.
MODE returns a DXDONE message when the operation completes.
594 33002261
PCFL-MODE: Put Input in Auto or Manual Mode
Representation
MODE
parameter
block
PCFL
33002261 595
PCFL-MODE: Put Input in Auto or Manual Mode
Parameter Description
Bit Function
1 ... 10 Not used
11 Echo mode:
1 = manual mode
0 = auto mode
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 1 = manual mode
0 = auto mode
6 ... 16 Not used
596 33002261
PCFL-ONOFF: ON/OFF Values for
Deadband
111
At a Glance
33002261 597
PCFL-ONOFF: ON/OFF Values for Deadband
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Regulatory Control, p. 521.
The ONOFF function is used to control the output signal between fully ON and fully
OFF conditions so that a user can manually force the output ON or OFF.
You can control the output via either a direct or reverse configuration:
Configuration IF Input... Then Output...
Direct < (SP - DB) ON
> (SP + DB) OFF
Revers > (SP + DB) ON
< (SP - DB) OFF
Manual Override Two bits in the input status register (the third implied register in the parameter block)
are used for manual override. When bit 6 is set to 1, manual mode is enforced. In
manual mode, a 0 in bit 7 forces the output OFF, and a 1 in bit 7 forces the output
ON. The state of bit 7 has meaning only in manual mode.
598 33002261
PCFL-ONOFF: ON/OFF Values for Deadband
Representation
ONOFF
parameter
block
PCFL
14
33002261 599
PCFL-ONOFF: ON/OFF Values for Deadband
Parameter Description
Bit Function
1 ... 8 Not used
9 1 = DB set to negative number
10 Echo mode:
1 = manual override
0 = auto mode
11 1 = output set to ON
0 = output set to OFF
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
600 33002261
PCFL-ONOFF: ON/OFF Values for Deadband
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 1 = reverse configuration
0 = direct configuration
6 1 = manual override
0 = auto mode
7 1 = force output ON in manual mode
0 = force output OFF in manual mode
8 ... 16 Not used
33002261 601
PCFL-ONOFF: ON/OFF Values for Deadband
602 33002261
PCFL-PI: ISA Non Interacting PI
112
At a Glance
33002261 603
PCFL-PI: ISA Non Interacting PI
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Regulatory Control, p. 521.
604 33002261
PCFL-PI: ISA Non Interacting PI
Representation
PI
parameter
block
PCFL
36
33002261 605
PCFL-PI: ISA Non Interacting PI
Parameter Description
606 33002261
PCFL-PI: ISA Non Interacting PI
Bit Function
1 Error
2 1 = low limit exceeded
3 1 = high limit exceeded
4 ... 8 Not used
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1...11 Not used
12 ... 16 Error Description
Error Description
Bit Meaning
12 13 14 15 16
1 0 1 1 0 Negative integral time constant
1 0 1 0 1 High/low limit error (low ≥ high)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 Not used
6 1 = Manual mode
7 1 = Halt mode
8 ... 15 Not used
16 1 = reverse action for loop output
0 = direct action for loop output
33002261 607
PCFL-PI: ISA Non Interacting PI
608 33002261
PCFL-PID: PID Algorithms
113
At a Glance
33002261 609
PCFL-PID: PID Algorithms
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Regulatory Control, p. 521.
Representation
PID
parameter
block
PCFL
44
610 33002261
PCFL-PID: PID Algorithms
Parameter Description
33002261 611
PCFL-PID: PID Algorithms
Bit Function
1 Error
2 1 = low limit exceeded
3 1 = high limit exceeded
4 ... 8 Not used
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1...11 Not used
12 ... 16 Error Description
Error Description
Bit Meaning
12 13 14 15 16
1 0 1 1 1 Negative derivative time constant
1 0 1 1 0 Negative integral time constant
1 0 1 0 1 High/low limit error (low ≥ high)
612 33002261
PCFL-PID: PID Algorithms
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 Not used
6 1 = Manual mode
7 1 = Halt mode
8 Not used
9 1 = Solve proportional algorithm
10 1 = Solve integral algorithm
11 1 = Solve derivative algorithm
12 1 = solve derivative algorithm based on x
0 = solve derivative algorithm based on xd
13... 15 Not used
16 1 = reverse action for loop output
0 = direct action for loop output
33002261 613
PCFL-PID: PID Algorithms
614 33002261
PCFL-RAMP: Ramp to Set Point at
a Constant Rate
114
At a Glance
33002261 615
PCFL-RAMP: Ramp to Set Point at a Constant Rate
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The RAMP function allows you to ramp up linearly to a target set point at a specified
approach rate.
You need to specify:
l The target set point, in the same units as the contents of the input register are
specified
l The sampling rate
l A positive rate toward the target set point, negative rates are illegal
The direction of the ramp depends on the relationship between the target set point
and the input, i.e. if x < SP, the ramp is up; if x > SP, the ramp is down.
You may use a flag to initialize after an undetermined down-time. The function will
store a new sample, then wait for one cycle to collect the second sample.
Calculations will be skipped for one cycle and the output will be left as is, after which
the ramp will resume.
RAMP terminates when the entire ramping operation is complete (over multiple
scans) and returns a DXDONE message.
Starting the The following steps need to be done when starting the ramp (up/down) and each
Ramp and every time you need to start or restart the ramp.
Step Action
1 Set bit 1 of the standard input bits (See Input Flags, p. 523) to "1" (third implied
register of the parameter block).
2 Retoggle the top input (enable input) to the instruction. Ramp will now start to
ramp up/down from the initial value previously configured up/down to the
previously configured setpoint. Monitor the 12th implied register of the parameter
block for floating point value of the ramp value in progress.
616 33002261
PCFL-RAMP: Ramp to Set Point at a Constant Rate
Representation
RAMP
parameter
block
PCFL
14
33002261 617
PCFL-RAMP: Ramp to Set Point at a Constant Rate
Parameter Description
Bit Function
1 ... 4 Not used
5 1 = ramp rate is negative
6 1 = ramp complete
0 = ramp in progress
7 1 = ramping down
8 1 = ramping up
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 16 Not used
618 33002261
PCFL-RAMP: Ramp to Set Point at a Constant Rate
Top Output The top output of the PCFL subfunction RAMP goes active at each successive
(Operation discrete ramp step up/down. It happens so fast that it appears to be solidly on. This
Succesfull) top output should NOT be used as "Ramp done bit".
Bit 6 of the output status (second impied register of the parameter block) should be
monitored as "Ramp done bit".
33002261 619
PCFL-RAMP: Ramp to Set Point at a Constant Rate
620 33002261
PCFL-RATE: Derivative Rate
Calculation over a Specified Time
115
At a Glance
33002261 621
PCFL-RATE: Derivative Rate Calculation over a Specified Time
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The RATE function calculates the rate of change over the last two input values. If
you set an initialization flag, the function records a sample and sets the appropriate
flags.
If a divide-by-zero operation is attempted, the function returns a DXERROR
message.
It returns a DXDONE message when the operation completes successfully.
622 33002261
PCFL-RATE: Derivative Rate Calculation over a Specified Time
Representation
RATE
parameter
block
PCFL
14
33002261 623
PCFL-RATE: Derivative Rate Calculation over a Specified Time
Parameter Description
Bit Function
1 ... 8 Not used
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 16 Not used
624 33002261
PCFL-RATIO: Four Station Ratio
Controller
116
At a Glance
33002261 625
PCFL-RATIO: Four Station Ratio Controller
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Regulatory Control, p. 521.
The RATIO function provides a four-station ratio controller. Ratio control can be
used in applications where one or more raw ingredients are dependent on a primary
ingredient. The primary ingredient is measured, and the measurement is converted
to engineering units via an AIN function. The converted value is used to set the
target for the other ratioed inputs.
Outputs from the ratio controller can provide set points for other controllers. They
can also be used in an open loop structure for applications where feedback is not
required.
626 33002261
PCFL-RATIO: Four Station Ratio Controller
Representation
RATIO
parameter
block
PCFL
20
33002261 627
PCFL-RATIO: Four Station Ratio Controller
Parameter Description
Bit Function
1 ... 9 Not used
10 1 = parameter(s) out of range
11 1 = no inputs activated
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
628 33002261
PCFL-RATIO: Four Station Ratio Controller
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 1= input 4 active
6 1= input 3 active
7 1= input 2 active
8 1= input 1 active
9 ... 16 Not used
33002261 629
PCFL-RATIO: Four Station Ratio Controller
630 33002261
PCFL-RMPLN: Logarithmic Ramp
to Set Point
117
At a Glance
33002261 631
PCFL-RMPLN: Logarithmic Ramp to Set Point
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The RMPLN function allows you to ramp up logarithmically to a target set point at a
specified approach rate. At each successive call, it calculates the output until it is
within a specified deadband (DB). DB is necessary because the incremental
distance the ramp crosses decreases with each solve.
You need to specify:
l The target set point, in the same units as the contents of the input register are
specified
l The sampling rate
l The time constant used for the logarithmic ramp, which is the time it takes to
reach 63.2% of the new set point
For best results, use a t that is ≥4 *∆t. This will ensure sufficient granularity in the
output response.
You may use a flag to initialize after an undetermined down-time. The function will
store a new sample, then wait for one cycle to collect the second sample.
Calculations will be skipped for one cycle and the output will be left as is, after which
the ramp will resume.
RMPLN terminates when the input reaches the target set point + the specified DB
and returns a DXDONE message.
632 33002261
PCFL-RMPLN: Logarithmic Ramp to Set Point
Representation
RMPLN
parameter
block
PCFL
16
33002261 633
PCFL-RMPLN: Logarithmic Ramp to Set Point
Parameter Description
Bit Function
1 ... 4 Not used
5 1 = DB or τ set to negative units
6 1 = ramp complete
0 = ramp in progress
7 1 = ramping down
8 1 = ramping up
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 ... 16 Not used
634 33002261
PCFL-SEL: Input Selection
118
At a Glance
33002261 635
PCFL-SEL: Input Selection
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Signal Processing, p. 521.
The SEL function compares up to four inputs and makes a selection based upon
either the highest, lowest, or average value. You choose the inputs to be compared
and the comparison criterion. The output is a copy of the selected input.
SEL returns a DXDONE message when the operation is complete.
Representation
SEL
parameter
block
PCFL
14
636 33002261
PCFL-SEL: Input Selection
Parameter Description
Bit Function
1 ... 9 Not used
10 Invalid selection modes
11 No inputs selected
12 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
33002261 637
PCFL-SEL: Input Selection
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 1 = enable input 1
0 = disable input 1
6 1 = enable input 2
0 = dyeable input 2
7 1 = enable input 3
0 = dyeable input 3
8 1 = enable input 4
0 = dyeable input 4
9 ... 10 Selection mode
11 ... 16 Not used
Selection mode
Bit Meaning
9 10
0 0 Select average
0 1 Select high
1 0 Select low
1 1 reserved / invalid
638 33002261
PCFL-TOTAL: Totalizer for
Metering Flow
119
At a Glance
33002261 639
PCFL-TOTAL: Totalizer for Metering Flow
Short Description
Function
Description
Note: This instruction is a subfunction of the PCFL instruction. It belongs to the
category Regulatory Control, p. 521.
The TOTAL function provides a material totalizer for batch processing reagents. The
input signal contains the units of weight or volume per unit of time. The totalizer
integrates the input over time.
The algorithm reports three outputs:
l The integration sum
l The remainder left to meter in
l The valve output (in engineering units).
640 33002261
PCFL-TOTAL: Totalizer for Metering Flow
Representation
TOTAL
parameter
block
PCFL
28
33002261 641
PCFL-TOTAL: Totalizer for Metering Flow
Parameter Description
642 33002261
PCFL-TOTAL: Totalizer for Metering Flow
Bit Function
1 ... 2 Not used
3 ... 4 0 0 = OFF
0 1 = trickle flow
1 0 = full flow
5 1 = operation done
6 1 = totalizer running
7 1 = overshoot past set point by more than 5%
8 1 = parameter(s) out of range
9 ... 16 Standard output bits (flags) (See Output Flags, p. 522)
33002261 643
PCFL-TOTAL: Totalizer for Metering Flow
Bit Function
1 ... 4 Standard input bits (flags) (See Input Flags, p. 523)
5 1 = reset sum
6 1 = halt integration
7 1 = deviation set point
0 = absolute set point
8 1 = use auxiliary trickle flow set point
9 ... 16 Not used
644 33002261
PEER: PEER Transaction
120
At a Glance
33002261 645
PEER: PEER Transaction
Short Description
Function
Description
Note: This instruction is only available, if you have unpacked and installed the DX
Loadables; further information in the chapter "Installation of DX Loadables, p. 71".
The S975 Modbus II Interface option modules use two loadable function blocks:
MBUS and PEER. The PEER instruction can initiate identical message transactions
with as many as 16 devices on Modbus II at one time. In a PEER transaction, you
may only write register data.
646 33002261
PEER: PEER Transaction
Representation
control
block
data
block
PEER
length
33002261 647
PEER: PEER Transaction
Parameter Description
Control Block The 4x register entered in the top node is the first of 19 contiguous registers in the
(Top Node) PEER control block:
Register Function
Displayed Indicates the status of the transactions at each device, the
leftmost bit being the status of device #1 and the rightmost
bit the status of device #16: 0 = OK, 1 = transaction error
First implied Defines the reference to the first 4x register to be written to
in the receiving device; a 0 in this field is an invalid value and
will produce an error (the bottom output will go ON)
Second implied Time allowed for a transaction to be completed before an
error is declared; expressed as a multiple of 10 ms, e.g. 100
indicates 1,000 ms; the default timeout is 250 ms
Third implied The Modbus port 3 address of the first of the receiving
devices; address range: 1 ... 255 (0 = no transaction
requested)
Fourth implied The Modbus port 3 address of the second of the receiving
devices; address range: 1 ... 255 (0 = no transaction
requested)
... ...
18th implied The Modbus port 3 address of the 16th of the receiving
devices (address range: 1 ... 255)
648 33002261
PID2: Proportional Integral
Derivative
121
At a Glance
33002261 649
PID2: Proportional Integral Derivative
Short Description
M V = K 1 E + bias
Proportional-Integral Control
t
æ ö
MV = K1 ç E + K 2 ò E∆t÷
ç ÷
è 0 ø
Proportional-Integral-Derivative Control
t
æ ö
∆PV
MV = K1 ç E + K 2 ò E∆t + K 3 ------------÷
ç ∆t ÷
è 0 ø
650 33002261
PID2: Proportional Integral Derivative
Representation
source
destination
PID2
solution
interval
33002261 651
PID2: Proportional Integral Derivative
Detailed Description
Derivative
Xn Contribution
X n-1 +
Xn
+
(4y + 6)/8 (4y + 6)/8
- ∆Pv ∆x
+ 60(RGL - 1)K3
PV RGL RGL Ts
Zn
4x13
- E E -
SP + +
Proportional
Contribution
(4x1 - 4x2) 100
x 4095
(4x11 - 4x12) PB
GE
+
+ Output
Bias Clamp Mn
4x8 +
Integral 4x17 4x2
Mn-1 Feedback Integral 4x18
FIOC - Contribution In
+
4x16
M Preload Qn
Mode Integral
TIOC Clamp
4x20
Wn
+ ∆I
- K2 T2
600000
In-1 + In
In-1 + In
4y + 3, + 4, + 5
652 33002261
PID2: Proportional Integral Derivative
Note: The integral mode contribution calculation actually integrates the difference
of the output and the integral sum, this is effectively the same as integrating the
error.
33002261 653
PID2: Proportional Integral Derivative
Proportional With proportional-only control (P), you can calculate the manipulated variable by
Control multiplying error by a proportional constant, K1, then adding a bias, see Formula,
p. 650.
However, process conditions in most applications are changed by other system
variables so that the bias does not remain constant; the result is offset error, where
PV is constantly offset from the SP. This condition limits the capability of
proportional-only control.
Proportional- To eliminate this offset error without forcing you to manually change the bias, an
Integral Control integral function can be added to the control equation, see Formula, p. 650.
Proportional-integral control (PI) eliminates offset by integrating E as a function of
time. K1 is the integral constant expressed as rep/min. As long as E ≠ 0, the
integrator increases (or decreases) its value, adjusting Mv. This continues until the
offset error is eliminated.
Proportional- You may want to add derivative functionality to the control equation to minimize the
Integral- effects of frequent load changes or to override the integral function in order to get to
Derivative the SP condition more quickly, see Formula, p. 650.
Control Proportional-integral-derivative (PID) control can be used to save energy in the
process or as a safety valve in the event of a sudden, unexpected change in process
flow. K3 is the derivative time constant expressed as min. DPV is the change in the
process variable over a time period of ∆t.
Example An example to PID2 level control you will find in PID2 Level Control Example, p. 55.
654 33002261
PID2: Proportional Integral Derivative
Parameter Description
Source Block The 4x register entered in the top node is the first of 21 contiguous holding registers
(Top Node) in a source block. The contents of the fifth ... eighth implied registers determine
whether the operation will be P, PI, or PID:
Operation Fifth Implied Sixth Implied Seventh Implied Eighth Implied
P ON ON
PI ON ON
PID ON ON ON
33002261 655
PID2: Proportional Integral Derivative
656 33002261
PID2: Proportional Integral Derivative
33002261 657
PID2: Proportional Integral Derivative
Destination The 4y register entered in the middle node is the first of nine contiguous holding
(MIddle Node) register used for PID2 calculations. You do not need to load anything into these
registers:
Register Name Content
Displayed Loop Status Register Twelve of the 16 bits in this register are used to
define loop status.
First implied Error (E) Status Bits This register displays PID2 error codes.
Second Loop Timer Register This register stores the real-time clock reading on
implied the system clock each time the loop is solved: the
difference between the current clock value and the
value stored in the register is the elapsed time; if
elapsed time ≥ solution interval (10 times the value
given in the bottom node of the PID2 block), then
the loop should be solved in this scan
Third implied For Internal Use Integral (integer portion)
Fourth implied For Internal Use Integral-fraction 1 (1/3 000)
Fifth implied For Internal Use Integral-fraction 2 (1/600 000)
Sixth implied Pv x 8 (Filtered) This register stores the result of the filtered analog
input (from register 4x14) multiplied by 8; this value
is useful in derivative control operations
Seventh Absolute Value of E This register, which is updated after each loop
implied solution, contains the absolute value of (SP - PV);
bit 8 in register 4y + 1 indicates the sign of E
Eighth implied For Internal Use Current solution interval
658 33002261
PID2: Proportional Integral Derivative
Bit Function
1 Top output status (Node lockout or parameter error
2 Middle output status (High alarm)
3 Bottom output status (Low alarm)
4 Loop in AUTO mode and time since last solution ≥ solution interval
5 Wind-down mod (for REV B or higher)
6 Loop in AUTO mode but not being solved
7 4x14 register referenced by 4x15 is valid
8 Sign of E in 4y + 7:
l 0 = + (plus)
l 1 = - (minus)
9 Rev B or higher
10 Integral windup limit never set
11 Integral windup saturated
12 Negative values in the equation
13 Bottom input status (direct / reverse acting)
14 Middle input status (tracking mode)
l 1 = tracking
l 0 = no tracking
15 Top input status (MAN / AUTO)
16 Bit 16 is set after initial startup or installation of the loop. If you clear the bit, the
following actions take place in one scan:
l The loop status register 4y is reset
l The current value in the real-time clock is stored in the first implied register
(4y+1)
l Values in the third ... fifth registers (4y+2,3) are cleared
l The value in the13th implied register (4x+13) x 8 is stored in the sixth implied
register (4y+6)
l The seventh and eighth implied registers (4y+7,8) are cleared
Solution Interval The bottom node indicates that this is a PID2 function and contains a number
(Bottom Node) ranging from 1 ... 255, indicating how often the function should be performed. The
number represents a time value in tenths of a second, or example, the number 17
indicates that the PID function should be performed every 1.7 s.
33002261 659
PID2: Proportional Integral Derivative
Error Status Bit The first implied register of the destination contains the error status bits:
Code Explanation Check these Registers in the
Source Block (Top Node)
0000 No errors, all validations OK None
0001 Scaled SP above 9999 First implied
0002 High alarm above 9999 Third implied
0003 Low alarm above 9999 Fourth implied
0004 Proportional band below 5 Fifth implied
0005 Proportional band above 500 Fifth implied
0006 Reset above 99.99 r/min Sixth implied
0007 Rate above 99.99 min Seventh implied
0008 Bias above 4095 Eighth implied
0009 High integral limit above 4095 Ninth implied
0010 Low integral limit above 4095 10th implied
0011 High engineering unit (E.U.) scale above 9999 11th implied
0012 Low E.U. scale above 9999 12th implied
0013 High E.U. below low E.U. 11th and 12th implied
0014 Scaled SP above high E.U. First and 11th implied
0015 .Scaled SP below low E.U. First and 12th implied
0016 Maximum loops/scan > 9999 15th implied
Note: Activated by maximum loop feature, i.e.
only if 4x15 is not zero.
0017 Reset feedback pointer out of range 16th implied
0018 High output clamp above 4095 17th implied
0019 Low output clamp above 4095 18th implied
0020 Low output clamp above high output clamp 17th and 18th implied
0021 RGL below 2 19th implied
0022 RGL above 30 19th implied
0023 Track F pointer out of range 20th implied with middle input
Note: Activated only if the track feature is ON, ON
i.e. the middle input of the PID2 block is
receiving power while in AUTO mode.
660 33002261
PID2: Proportional Integral Derivative
33002261 661
PID2: Proportional Integral Derivative
662 33002261
R −−> T: Register to Table
122
At a Glance
33002261 663
R --> T: Register to Table
Short Description
Function The R→T instruction copies the bit pattern of a register or of a string of contiguous
Description discretes stored in a word into a specific register located in a table. It can
accommodate the transfer of one register/word per scan.
Representation
source
destination
pointer
R→T
table length
664 33002261
R --> T: Register to Table
Parameter Description
Top Input The input to the top node initiates the DX move operation.
Middle Input When the middle input goes ON, the current value stored in the destination pointer
register is frozen while the DX operation continues. This causes new data being
copied to the destination to overwrite the data copied on the previous scan.
Bottom Input When the bottom input goes ON, the value in the destination pointer register is reset
to zero. This causes the next DX move operation to copy source data into the first
register in the destination table.
Destination The 4x register entered in the middle node is a pointer to the destination table where
Pointer source data will be copied in the scan. The first register in the destination table is the
(Middle Node) next contiguous 4x register following the pointer, i.e. if the pointer register is 400027,
then the destination table begins at register 400028.
The value posted in the pointer register indicates the register in the destination table
where the source data will be copied. A value of zero indicates that the source data
will be copied to the first register in the destination table; a value of 1 indicates that
the source data be copied to the second register in the destination table; etc.
Note: The value posted in the destination pointer register cannot be larger than the
table length integer specified in this node.
Outputs R→T can produce two possible outputs, from the top and middle nodes. The state
of the output from the top node echoes the state of the top input. The output from
the middle node goes ON when the value in the destination pointer register equals
the specified table length. At this point, the instruction cannot increment any further.
33002261 665
R --> T: Register to Table
666 33002261
RBIT: Reset Bit
123
At a Glance
33002261 667
RBIT: Reset Bit
Short Description
Function The reset bit (RBIT) instruction lets you clear a latched-ON bit by powering the top
Description input. The bit remains cleared after power is removed from the input. This instruction
is designed to clear a bit set by the SBIT instruction.
Note: The RBIT instruction does not follow the same rules of network placement
as 0x-referenced coils do. An RBIT instruction cannot be placed in column 11 of a
network and it can be placed to the left of other logic nodes on the same rungs of
the ladder.
Representation
register #
RBIT
bit #
(1 ... 16)
668 33002261
READ: Read
124
At a Glance
33002261 669
READ: Read
Short Description
Function The READ instruction provides the ability to read data from an ASCII input device
Description (keyboard, bar code reader, etc.) into the PLC’s memory via its RIO network. The
connection to the ASCII device is made at an RIO interface.
In the process of handling the messaging operation, READ performs the following
functions:
l Verifies the lengths of variable data fields
l Verifies the correctness of the ASCII communication parameters, e.g. the port
number, the message number
l Performs error detection and recording
l Reports RIO interface status
READ requires two tables of registers: a destination table where retrieved variable
data (the message) is stored, and a control block where comm port and message
parameters are identified.
Further information about formatting messages you will find in Formatting Messages
for ASCII READ/WRIT Operations, p. 59.
670 33002261
READ: Read
Representation
control
block
destination
READ
table
length
33002261 671
READ: Read
Parameter Description
Control Block The 4x register entered in the top node is the first of seven contiguous holding
(Top Node) register in the control block.
Register Definition
Displayed Port Number and Error Code, p. 673
First implied Message number
Second implied Number of registers required to satisfy format
Third implied Count of the number of registers transmitted thus far
Fourth implied Status of the solve
Fifth implied Reserved
Sixth implied Checksum of registers 0 ... 5
672 33002261
READ: Read
Bit Function
1 ... 4 PLC error code
5 Not used
6 Input from the ASCII device not compatible with format
7 Input buffer overrun, data received too quickly at RIOP
8 USART error, bad byte received at RIOP
9 Illegal format, not received properly by RIOP
10 ASCII device off-line, check cabling
11 ASCII message terminated early (in keyboard mode
12 ... 16 Comm port # (1 ... 32)
33002261 673
READ: Read
Destination The middle node contains the first 4x register in a destination table. Variable data in
(Middle Node) a READ message are written into this table. The length of the table is defined in the
bottom node.
Consider this READ message:
Note: An ASCII READ message may contain the embedded text, placed inside
quotation marks, as well as the variable data in the format statement, i.e., the ASCII
message.
The 10-character ASCII field AAAAAAAAAA is the variable data field; variable data
must be entered via an ASCII input device.
674 33002261
RET: Return from a Subroutine
125
At a Glance
33002261 675
RET: Return from a Subroutine
Short Description
Function The RET instruction may be used to conditionally return the logic scan to the node
Description immediately following the most recently executed JSR block. This instruction can be
implemented only from within the subroutine segment, the (unscheduled) last
segment in the user logic program.
Note: If a subroutine does not contain a RET block, either a LAB block or the end-
of-logic (whichever comes first) serves as the default return from the subroutine.
An example to the subroutine handling you will find in Subroutine Handling, p. 69.
Representation
RET
00001
676 33002261
SAVE: Save Flash
126
At a Glance
33002261 677
SAVE: Save Flash
Short Description
Function
Description
Note: This instruction is available with the PLC family TSX Compact, with Quantum
CPUs 434 12/ 534 14 and Momentum CPUs CCC 960 x0/ 980 x0.
The SAVE instruction saves a block of 4x registers to state RAM where they are
protected from unauthorized modification.
Representation
register
1, 2, 3, 4
SAVE
length
678 33002261
SAVE: Save Flash
Parameter Description
1, 2, 3, 4 The middle node defines the specific buffer, within state RAM, where the block of
(Middle Node) data is to be saved. Four 512 word buffers are allowed. Each buffer is defined by
placing its corresponding value in the middle node, that is, the value 1 represents
the first buffer, value 2 represents the second buffer and so on. The legal values are
1, 2, 3, and 4. When the PLC is started all four buffers are zeroed. Therefore, you
may not save data to the same buffer without first loading it with the instruction
LOAD. When this is attempted the middle output goes ON. In other words, once a
buffer is used, it may not be used again until the data has been removed.
Middle Output The output from the middle node goes ON when previously saved data has not been
accessed using the LOAD instruction. This prevents inadvertent overwriting of data
in the SAVE buffer.
33002261 679
SAVE: Save Flash
680 33002261
SBIT: Set Bit
127
At a Glance
33002261 681
SBIT: Set Bit
Short Description
Function The set bit (SBIT) instruction lets you set the state of the specified bit to ON (1) by
Description powering the top input.
Note: The SBIT instruction does not follow the same rules of network placement
as 0x-referenced coils do. An SBIT instruction cannot be placed in column 11 of a
network and it can be placed to the left of other logic nodes on the same rungs of
the ladder.
Representation
register #
SBIT
bit #
(1 ... 16)
682 33002261
SCIF: Sequential Control
Interfaces
128
At a Glance
33002261 683
SCIF: Sequential Control Interfaces
Short Description
Function The SCIF instruction performs either a drum sequencing operation or an input
Description comparison (ICMP) using the data defined in the step data table.
The choice of operation is made by defining the value in the first register of the step
data table:
l 0 = drum mode:
The instruction controls outputs in the drum sequencing application.
l 1 = ICMP mode:
The instruction reads inputs to ensure that limit switches, proximity switches,
pushbuttons, etc. are properly positioned to allow drum outputs to be fired.
684 33002261
SCIF: Sequential Control Interfaces
Representation
step
pointer
step data
table
SCIF
length
(1 ... 255)
33002261 685
SCIF: Sequential Control Interfaces
Parameter Description
Step Data Table The 4x register entered in the middle node is the first register in the step data table.
(Middle Node) The first seven registers in the table hold constant and variable data required to
solve the instruction:
Register Register Name Description
Displayed subfunction type 0 = drum mode; 1 = ICMP mode
(entry of any other value in this register will result
in all outputs OFF)
First implied masked output data Loaded by SCIF each time the block is solved;
(in drum mode) the register contains the contents of the current
step data register masked with the output mask
register
raw input data Loaded by the user from a group of sequential
(in ICMP mode) inputs to be used by the block in the current step
Second current step data Loaded by SCIF each time the block is solved;
implied the register contains data from the current step
(pointed to by the step pointer)
Third implied output mask Loaded by the user before using the block, the
(in drum mode) contents will not be altered during logic solving;
contains a mask to be applied to the data for
each sequencer step
input mask Loaded by the user before using the block, it
(in ICMP mode) contains a mask to be ANDed with raw input
data for each step, masked bits will not be
compared; the masked data are put in the
masked input data register
Fourth implied masked input data Loaded by SCIF each time the block is solved, it
(in ICMP mode) contains the result of the ANDed input mask and
raw input data
not used in drum mode
Fifth implied compare status Loaded by SCIF each time the block is solved, it
(in ICMP mode) contains the result of an XOR of the masked
input data and the current step data; unmasked
inputs that are not in the correct logical state
cause the associated register bit to go to 1, non-
zero bits cause a miscompare and turn ON the
middle output from the SCIF block
not used in drum mode
686 33002261
SCIF: Sequential Control Interfaces
Length of Step The integer value entered in the bottom node is the length, i.e. the number of
Data Table application-specific registers, used in the step data table. The length can range from
(Bottom Node) 1 ... 255.
The total number of registers required in the step data table is the length + 7. The
length must be ≥ the value placed in the steps used register in the middle node.
33002261 687
SCIF: Sequential Control Interfaces
688 33002261
SENS: Sense
129
At a Glance
33002261 689
SENS: Sense
Short Description
Function The SENS instruction examines and reports the sense (1 or 0) of a specific bit
Description location in a data matrix. One bit location is sensed per scan.
Representation
bit
location
data
matrix
SENS
length
690 33002261
SENS: Sense
Parameter Description
Matrix Length The integer value entered in the bottom node specifies a matrix length, i.e, the
(Bottom Node) number of 16-bit words or registers in the data matrix. The length can range from 1
... 600 in a 24-bit CPU, e.g, a matrix length of 200 indicates 3200 bit locations.
33002261 691
SENS: Sense
692 33002261
SKPC: Skip (Constants)
130
At a Glance
33002261 693
SKPC: Skip (Constants)
Short Description
Function When a SKPC instruction is implemented, skipped networks in the ladder logic
Description program are not solved. SKPC instructions can be used to reduce scan time and, in
effect, establish subroutines within the scheduled logic.
A SKPC operation cannot pass the boundary of a segment. No matter how many
extra networks you specify to be skipped, the instruction will stop if it reaches the
end of a segment.
WARNING
Inputs and outputs could be unintentionally skipped or not skipped.
SKPC is a dangerous instruction that should be used carefully. If inputs and
outputs that normally effect control are unintentionally skipped (or not skipped), the
result can create hazardous conditions for personnel and application equipment.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
694 33002261
SKPC: Skip (Constants)
Representation
SKPC
# of networks
skipped
Parameter Description
Number of The value entered in the node specifies the number of networks to be skipped.
Networks
skipped
(Bottom Node) The node value includes the network that contains the SKPC instruction. The nodal
regions in the network where the SKPC resides that have not already been scanned
will be skipped; this counts as one of the networks specified to be skipped. The CPU
continues to skip networks until the total number of networks skipped equals the
value specified.
33002261 695
SKPC: Skip (Constants)
Example
A simple SKPC The illustration is showing two contiguous networks of ladder logic. The first network
Example contains a SKPC instruction that specifies that two networks will be skipped when
contact 100001 passes power.
Network 1
000193
100003
SKPC
100001 #000002
Network 2
000116
100002
When N.O. contact 100001 is closed, the remainder of the top network and all of the
bottom network are skipped. The power flow display for these two networks
becomes invalid, and your system displays an information message to that effect.
Coil 000193 is still controlled by contact 100003 because the solution of coil 000193
occurs before the SKPC instruction. Coil 000116 will remain in whatever state it was
in when the bottom network was skipped.
696 33002261
SKPR: Skip (Registers)
131
At a Glance
33002261 697
SKPR: Skip (Registers)
Short Description
Function When a SKPR instruction is implemented, skipped networks in the ladder logic
Description program are not solved. SKPR instructions can be used to reduce scan time and, in
effect, establish subroutines within the scheduled logic.
A SKPR operation cannot pass the boundary of a segment. No matter how many
extra networks you specify to be skipped, the instruction will stop if it reaches the
end of a segment.
WARNING
Inputs and outputs could be unintentionally skipped or not skipped.
SKPR is a dangerous instruction that should be used carefully. If inputs and
outputs that normally effect control are unintentionally skipped (or not skipped), the
result can create hazardous conditions for personnel and application equipment.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
698 33002261
SKPR: Skip (Registers)
Representation
SKPR
# of networks
skipped
Parameter Description
Number of The value entered in the node specifies the number of networks to be skipped.
Networks The node value includes the network that contains the SKPR instruction. The nodal
skipped regions in the network where the SKPR resides that have not already been scanned
(Bottom Node) will be skipped; this counts as one of the networks specified to be skipped. The CPU
continues to skip networks until the total number of networks skipped equals the
value specified.
33002261 699
SKPR: Skip (Registers)
Example
A simple SKPR The illustration is showing two contiguous networks of ladder logic. The first network
Example contains a SKPR instruction that specifies that two networks will be skipped when
contact 100001 passes power.
Network 1:
000193
100003
SKPR
100001 #000002
Network 1:
000116
100002
When N.O. contact 100001 is closed, the remainder of the top network and all of the
bottom network are skipped. The power flow display for these two networks
becomes invalid, and your system displays an information message to that effect.
Coil 000193 is still controlled by contact 100003 because the solution of coil 000193
occurs before the SKPR instruction. Coil 000116 will remain in whatever state it was
in when the bottom network was skipped.
700 33002261
SRCH: Search
132
At a Glance
33002261 701
SRCH: Search
Short Description
Function The SRCH instruction searches the registers in a source table for a specific bit
Description pattern.
Representation
source
table
pointer
SRCH
table
length
702 33002261
SRCH: Search
Parameter Description
Pointer The 4x register entered in the middle node is the pointer into the source table. It
(Middle Node) points to the source register that contains the same value as the value stored in the
next contiguous register after the pointer, e.g. if the pointer register is 400015, then
register 400016 contains a value that the SRCH instruction will attempt to match in
source table.
33002261 703
SRCH: Search
704 33002261
STAT: Status
133
At a Glance
33002261 705
STAT: Status
Short Description
Function The STAT instruction accesses a specified number of words in a status table in the
Description PLC’s system memory. Here vital diagnostic information regarding the health of the
PLC and its remote I/O drops is posted.
This information includes:
l PLC status
l Possible error conditions in the I/O modules
l Input-to-PLC-to-output communication status
Representation
destination
STAT
length
706 33002261
STAT: Status
Parameter Description
Mode of With the STAT instruction, you can copy some or all of the status words into a block
Functioning of registers or a block of contiguous discrete references.
The copy to the STAT block always begins with the first word in the table up to the
last word of interest to you. For example, if the status table is 277 words long and
you are interested only in the statistics provided in word 11, you need to copy only
words 1 ... 11 by specifying a length of 11 in the STAT instruction.
Destination The reference number entered in the top node is the first position in the destination
Block (Top Node) block, i.e. the block where the current words of interest from the status table will be
copied.
The number of holding registers or 16-bit words in the destination block is specified
in the bottom node (length).
Note: We recommend that you do not use discretes in the STAT destination node
because of the excessive number required to contain status information.
Length The integer value entered in the bottom node specifies the number of registers or
(Bottom Node) 16-bit words in the destination block where the current status information will be
written. The maximum allowable length the Quantum PLCs with S908 RIO protocol
is 1 ... 277.
33002261 707
STAT: Status
General The STAT instruction is used to display the Status of Controller and I/O system for
Quantum, Atrium, TSX Compact and Momentum.
The first 11 status words are used by Quantum and Momentum in the same way and
by TSX Compact and Atrium in the same way. The following have a different
meaning for Quantum, TSX Compact and Momentum.
Quantum The 277 words in the status table are organized in three sections:
Overview l Controller Status (words 1 ... 11)
l I/O Module Health (words 12 ... 171)
l I/O Communications Health (words 172 ... 277)
Words of the status table:
Decimal Word Content Hex Word
Word
1 Controller Status 01
2 Hot Standby Status 02
3 Controller Status 03
4 RIO Status 04
5 Controller Stop State 06
6 Number of Ladder Logic Segments 06
7 End-of-logic (EOL) Pointer 07
8 RIO Redundancy and Timeout 08
9 ASCII Message Status 09
10 RUN/LOAD/DEBUG Status 0A
11 not used 0B
12 Drop 1, Rack 1 0C
13 Drop 1, Rack 2 0D
... ...... ...
16 Drop 1, Rack 5 0F
17 Drop 2, Rack 1 10
18 Drop 2, Rack 2 11
... ...... ...
171 Drop 32, Rack 5 AB
172 S908 Startup Error Code AC
173 Cable A Errors AD
708 33002261
STAT: Status
33002261 709
STAT: Status
Momentum The 20 words in the status table are organized in two sections:
Overview l Controller Status (words 1 ... 11)
l I/O Module Health (words 12 ... 20)
Words of the status table:
Decimal Word Content Hex Word
Word
1 Controller Status 01
2 Hot Standby Status 02
3 Controller Status 03
4 RIO Status 04
5 Controller Stop State 06
6 Number of Ladder Logic Segments 06
7 End-of-logic (EOL) Pointer 07
8 RIO Redundancy and Timeout 08
9 ASCII Message Status 09
10 RUN/LOAD/DEBUG Status 0A
11 not used 0B
12 Local Momentum I/O Module Health 0C
13 I/O Bus Module Health 0D
14 I/O Bus Module Health 0E
15 I/O Bus Module Health 0F
16 I/O Bus Module Health 10
17 I/O Bus Module Health 11
18 I/O Bus Module Health 12
19 I/O Bus Module Health 13
20 I/O Bus Module Health 14
710 33002261
STAT: Status
TSX Compact The 184 words in the status table are organized in three sections:
and Atrium l Controller Status (words 1 ... 11)
Overview l I/O Module Health (words 12 ... 15)
l Not used (16 ... 181)
l Global Health and Communications retry status (words 182 ... 184)
Words of the status table:
Decimal Word Content Hex Word
Word
1 CPU Status 01
2 not used 02
3 Controller Status 03
4 not used 04
5 CPU Stop State 06
6 Number of Ladder Logic Segments 06
7 End-of-logic (EOL) Pointer 07
8 not used 08
9 not used 09
10 RUN/LOAD/DEBUG Status 0A
11 not used 0B
12 I/O Health Status Rack 1 0C
13 I/O Health Status Rack 2 0D
14 I/O Health Status Rack 3 0E
15 I/O Health Status Rack 4 0F
16 ... 181 not used 10 ... B5
182 Health Status B6
183 I/O Error Counter B7
184 PAB Bus Retry Counter B8
33002261 711
STAT: Status
Controller Status Word 1 displays the following aspects of the PLC status:
(Word 1)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1-5 Not used
6 1 = enable constant sweep
7 1 = enable single sweep delay
8 1 = 16 bit user logic
0 = 24 bit user logic
9 1 = AC power on
10 1 = RUN light OFF
11 1 = memory protect OFF
12 1 = battery failed
13 - 16 Not used
712 33002261
STAT: Status
Hot Standby Word 2 displays the Hot Standby status for 984 PLCs that use S911/R911 Hot
Status (Word 2) Standby Modules:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = S911/R911 present and healthy
2 - 10 Not used
11 0 = controller toggle set to A
1 = controller toggle set to B
12 0 = controllers have matching logic
1 = controllers do not have matching logic
13, 14 Remote system state:
0 1 = Off line (1 dec)
1 0 = primary (2 dec)
1 1 = standby (3 dec)
15, 16 Local system state:
0 1 = Off line (1 dec)
1 0 = primary (2 dec)
1 1 = standby (3 dec)
Bit Function
1 1 = first scan
2 1 = start command pending
3 1 = constant sweep time exceeded
4 1 = Existing DIM AWARENESS
5 - 12 Not used
13 - 16 Single sweeps
33002261 713
STAT: Status
Bit Function
1 1 = IOP bad
2 1 = IOP time out
3 1 = IOP loop back
4 1 = IOP memory failure
5 - 12 Not used
13 - 16 00 = IO did not respond
01 = no response
02 = failed loopback
714 33002261
STAT: Status
Bit Function
1 1 = peripheral port stop
2 Extended memory parity error (for chassis mount controllers) or traffic cop/S908
error (for other controllers)
If the bit = 1 in a 984B controller, an error has been detected in extended
memory; the controller will run, but the error output will be ON for XMRD/XMWT
functions
If the bit = 1 for any other controller than a chassis mount, then either a traffic
cop error has been detected or the S908 is missing from a multi-drop
configuration.
3 1 = controller in DIM AWARENESS
4 1 = illegal peripheral intervention
5 1 = segment scheduler invalid
6 1 = start of node did not start segment
7 1 = state RAM test failed
8 1 = invalid traffic cop
9 1 = watchdog timer expired
10 1 = real time clock error
11 CPU logic solver failed (for chassis mount controllers) or Coil Use TABLE (for
other controllers)
If the bit = 1 in a chassis mount controller, the internal diagnostics have detected
CPU failure.
If the bit = 1 in any controller other than a chassis mount, then the Coil Use Table
does not match the coils in user logic.
12 1 = IOP failure
13 1 = invalid node
14 1 = logic checksum
15 1 = coil disabled in RUN mode (see Caution below)
16 1 = bad config
33002261 715
STAT: Status
CAUTION
Using a Quantum or 984-684E/785E PLC
If you are using a Quantum or 984-684E/785E PLC, bit 15 in word 5 is never set.
These PLCs can be started and run with coils disabled in RUN (optimized) mode.
Also all the bits in word 5 must be set to 0 when one of these PLCs is running.
Failure to follow this instruction can result in injury or equipment damage.
Controller Stop Word 6 displays the number of segments in ladder logic; a binary number is shown:
State (Word 6)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 - 16 Number of segments (expressed as a decimal number)
Controller Stop Word 7 displays the address of the end-of-logic (EOL) pointer:
State (Word 7)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 - 16 EOL pointer address
RIO Redundancy Word 8 uses its most significant bit to display whether or not redundant coaxial
and Timeout cables are run to the remote I/O drops, and it uses its four least significant bits to
(Word 8) display the remote I/O timeout constant:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 RIO redundant cables?
0 = NO
1 = YES
2 - 12 Not used
13 - 16 RIO timeout constant
716 33002261
STAT: Status
ASCII Message Word 9 uses its four least significant bits to display ASCII message status:
Status (Word 9)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 ... 12 Not used
13 1 = Mismatch between numbers of messages and pointers
14 1 = Invalid message pointer
15 1 = Invalid message
16 1 = Message checksum error
RUN/LOAD/ Word 10 uses its two least significant bits to display RUN/LOAD/DEBUG status:
DEBUG Status
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
(Word 10)
Bit Function
1 ... 14 Not used
15, 15 0 0 = Debug (0 dec)
0 1 = Run (1 dec)
1 0 = Load (2 dec)
33002261 717
STAT: Status
I/O Module Status words 12 ... 20 display I/O module health status.
Health Status 1 word is reserved for each of up to 1 Local drop, 8 words are used to represent the
health of up to 128 I/O Bus Modules
Local Momentum Word 12 displays the Local Momentum I/O Module health:
I/O Module
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Health
Bit Function
1 1 = Local Module
2 - 16 Not used
718 33002261
STAT: Status
Momentum I/O Word 13 through 20 display the health status for Momentum I/O Bus Modules as
Bus Module follows:
Health
Word I/O Bus Modules
13 1 ... 16
14 17 ... 32
15 33 ... 48
16 49 ... 64
17 65 ... 80
18 81 ... 96
19 97 ... 112
20 113 ... 128
Each Word display the Momentum I/O Bus Module health as follows:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = Module 1
2 1 = Module 2
3 1 = Module 3
4 1 = Module 4
5 1 = Module 5
6 1 = Module 6
7 1 = Module 7
8 1 = Module 8
9 1 = Module 9
10 1 = Module 10
11 1 = Module 11
12 1 = Module 12
13 1 = Module 13
14 1 = Module 14
15 1 = Module 15
16 1 = Module 16
33002261 719
STAT: Status
RIO Status Status words 12 ... 20 display I/O module health status.
Words Five words are reserved for each of up to 32 drops, one word for each of up to five
possible racks (I/O housings) in each drop. Each rack may contain up to 11 I/O
modules; bits 1 ... 11 in each word represent the health of the associated I/O module
in each rack.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = Slot 1
2 1 = Slot 2
3 1 = Slot 3
4 1 = Slot 4
5 1 = Slot 5
6 1 = Slot 6
7 1 = Slot 7
8 1 = Slot 8
9 1 = Slot 9
10 1 = Slot 10
11 1 = Slot 11
12 1 = Slot 12
13 1 = Slot 13
14 1 = Slot 14
15 1 = Slot 15
16 1 = Slot 16
Four conditions must be met before an I/O module can indicate good health:
l The slot must be traffic copped
l The slot must contain a module with the correct personality
l Valid communications must exist between the module and the RIO interface at
remote drops
l Valid communications must exist between the RIO interface at each remote drop
and the I/O processor in the controller
720 33002261
STAT: Status
Status Words for The status of the 32 Element Pushbutton Panels and PanelMate units on an RIO
the MMI Operator network can also be monitored with an I/O health status word. The Pushbutton
Panels Panels occupy slot 4 in an I/O rack and can be monitored at bit 4 of the appropriate
status word. A PanelMate on RIO occupies slot 1 in rack 1 of the drop and can be
monitored at bit 1 of the first status word for the drop.
Note: The ASCII Keypad’s communication status can be monitored with the error
codes in the ASCII READ/WRIT blocks.
33002261 721
STAT: Status
DIO Status Status words 172 ... 277 contain the I/O system communication status. Words
172 ... 181 are global status words. Among the remaining 96 words, three words are
dedicated to each of up to 32 drops, depending on the type of PLC.
Word 172 stores the Quantum Startup Error Code. This word is always 0 when the
system is running. If an error occurs, the controller does not start-it generates a stop
state code of 10 (word 5 (See Controller Stop State (Word 5), p. 715)).
Quantum Start-up Error Codes
Code Error Meaning (Where the error has occurred)
01 BADTCLEN Traffic Cop length
02 BADLNKNUM Remote I/O link number
03 BADNUMDPS Number of drops in Traffic Cop
04 BADTCSUM Traffic Cop checksum
10 BADDDLEN Drop descriptor length
11 BADDRPNUM I/O drop number
12 BADHUPTIM Drop holdup time
13 BADASCNUM ASCII port number
14 BADNUMODS Number of modules in drop
15 PRECONDRP Drop already configured
16 PRECONPRT Port already configured
17 TOOMNYOUT More than 1024 output points
18 TOOMNYINS More than 1024 input points
20 BADSLTNUM Module slot address
21 BADRCKNUM Module rack address
22 BADOUTBC Number of output bytes
23 BADINBC Number of input bytes
25 BADRF1MAP First reference number
26 BADRF2MAP Second reference number
27 NOBYTES No input or output bytes
28 BADDISMAP Discrete not on 16-bit boundary
30 BADODDOUT Unpaired odd output module
31 BADODDIN Unpaired odd input module
32 BADODDREF Unmatched odd module reference
33 BAD3X1XRF 1x reference after 3x register
722 33002261
STAT: Status
Status of Cable A Words 173 ... 175 are Cable A error words:
Word 173
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 ... 8 Counts framing errors
9 ... 16 Counts DMA receiver overruns
Word 174
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 ... 8 Counts receiver errors
9 ... 16 Counts bad drop receptions
Word 175
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = Short frame
2 1 = No end-of- frame
3 ... 12 Not used
13 1 = CRC error
14 1 = Alignment error
15 1 =Overrun error
16 Not used
33002261 723
STAT: Status
Status of Cable B Words 176 ... 178 are Cable A error words:
Word 176
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 ... 8 Counts framing errors
9 ... 16 Counts DMA receiver overruns
Word 177
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 ... 8 Counts receiver errors
9 -...16 Counts bad drop receptions
Word 178
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = Short frame
2 1 = No end-of- frame
3 ... 12 Not used
13 1 = CRC error
14 1 = Alignment error
15 1 =Overrun error
16 Not used
724 33002261
STAT: Status
Bit Function
1 ... 8 Counts detected errors
9 ... 162 Counts No responses
Bit Function
1 ... 8 Counts detected errors
9 ... 162 Counts No responses
33002261 725
STAT: Status
Status of Remote Words 182 ... 277 are used to describe remote I/O drop status; three status words
I/O (Words 182 ... are used for each drop.
277) The first word in each group of three displays communication status for the
appropriate drop:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = Communication health
2 1 = Cable A status
3 1 = Cable B status
4 Not used
5 ... 8 Lost communication counter
9 ... 16 Cumulative retry counter
The second word in each group of three is the drop cumulative error counter on
Cable A for the appropriate drop:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 ... 8 At least one error in words 173 ...175
9 ... 162 Counts No responses
The third word in each group of three is the drop cumulative error counter on Cable
B for the appropriate drop:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 ... 8 At least one error in words 176 ...178
9 ... 162 Counts No responses
Note: For PLCs where drop 1 is reserved for local I/O, status words 182 ... 184 are
used as follows:
726 33002261
STAT: Status
Bit Function
1 1 = All modules healthy
2 ... 8 Always 0
9 ... 162 Number of times a module has been seen as unhealthy; counter rolls over at 255
33002261 727
STAT: Status
CPU Status Word 1 displays the following aspects of the CPU status:
(Word 1)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1-5 Not used
6 1 = enable constant sweep
7 1 = enable single sweep delay
8 1 = 16 bit user logic
0 = 24 bit user logic
9 1 = AC power on
10 1 = RUN light OFF
11 1 = memory protect OFF
12 1 = battery failed
13 - 16 Not used
Bit Function
1 1 = first scan
2 1 = start command pending
3 1 = scan time has exceed constant scan target
4 1 = existing DIM AWARENESS
5 - 12 Not used
13 - 16 Single sweeps
728 33002261
STAT: Status
CPU Stop State Word 5 displays the CPU’s stop state conditions:
(Word 5)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = peripheral port stop
2 1 = XMEM parity error
3 1 = DIM AWARENESS
4 1 = illegal peripheral intervention
5 1 = invalid segment scheduler
6 1 = no start-of-network (SON) at the start of a segment
7 1 = state RAM test failed
8 1 = no end of logic (EOL), (bad Tcop)
9 1 = watch dog timer has expired
10 1 = real time clock error
11 1 = CPU failure
12 Not used
13 1 = invalid node in ladder logic
14 1 = logic checksum error
15 1 = coil disabled in RUN mode
16 1 = bad PLC setup
Number of Word 6 displays the number of segments in ladder logic; a binary number is shown.
Segments in This word is confirmed during power up to be the number of EOS (DOIO) nodes plus
program 1 (for the end of logic nodes), if untrue, a stop code is set, causing the run light to be
(Word 6) off:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 - 16 Number of segments in the current ladder logic program (expressed as a
decimal number)
33002261 729
STAT: Status
Address of the Word 7 displays the address of the end-of-logic (EOL) pointer:
End of Logic
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Pointer (Word 7)
Bit Function
1 - 16 EOL pointer address
RUN/LOAD/ Word 10 uses its two least significant bits to display RUN/LOAD/DEBUG status:
DEBUG Status
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
(Word 10)
Bit Function
1 ... 14 Not used
15, 16 0 0 = Debug (0 dec)
0 1 = Run (1 dec)
1 0 = Load (2 dec)
730 33002261
STAT: Status
TSX Compact I/O Words 12 ... 15 are used to display the health of the A120 I/O modules in the four
Module Health racks:
Word Rack No.
12 1
13 2
14 3
15 4
Each word contains the health status of up to five A120 I/O modules. The most
significant (left-most) bit represents the health of the module in Slot 1 of the rack:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = Slot 1
2 1 = Slot 2
3 1 = Slot 3
4 1 = Slot 4
5 1 = Slot 5
6 ... 16 Not used
If a module is I/O Mapped and ACTIVE, the bit will have a value of "1". If a module
is inactive or not I/O Mapped, the bit will have a value of "0".
Note: Slots 1 and 2 in Rack 1 (Word 12) are not used because the controller itself
uses those two slots.
33002261 731
STAT: Status
Global Health and Communications Retry Status Words 182 ... 184 for
TSX Compact
Overview There are three words that contain health and communication information on the
installed I/O modules. If monitored with the Stat block, they are found in Words 182
through 184. This requires that the length of the Stat block is a minimum of 184
(Words 16 through 181 are not used).
Health Status Word 182 increments each time a module becomes bad. After a module becomes
(Word 182) bad, this counter does not increment again until that module becomes good and
then bad again.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Bit Function
1 1 = All modules healthy
2 ... 9 Not used
10 ... 16 "Module went unhealthy" counter
I/O Error Counter This counter is similar to the above counter, except this word increments every scan
(Word 183) that a module remains in the bad state.
PAB Bus Retry Diagnostics are performed on the communications through the bus. This word
Counter (Word should normally be all zeroes. If after 5 retries, a bus error is still detected, the
184) controller will stop and error code 10 will be displayed. An error could occur if there
is a short in the backplane or from noise. The counter rolls over while running. If the
retries are less than 5, no bus error is detected.
732 33002261
SU16: Subtract 16 Bit
134
At a Glance
33002261 733
SU16: Subtract 16 Bit
Short Description
Function The SU16 instruction performs a signed or unsigned 16-bit subtraction (value 1 -
Description value 2) on the top and middle node values, then posts the signed or unsigned
difference in a 4x holding register in the bottom node.
Representation
value 1
value 2
SU16
difference
734 33002261
SUB: Subtraction
135
At a Glance
33002261 735
SUB: Subtraction
Short Description
Function The SUB instruction performs a signed or unsigned 16-bit subtraction (value 1 -
Description value 2) on the top and middle node values, then posts the signed or unsigned
difference in a 4x holding register in the bottom node.
Note: SUB is often used as a comparator where the state of the outputs identifies
whether value 1 is greater than, equal to, or less than value 2.
736 33002261
SUB: Subtraction
Representation
value 1
value 2
SUB
difference
33002261 737
SUB: Subtraction
738 33002261
T−−>R: Table to Register
136
At a Glance
33002261 739
T-->R: Table to Register
Short Description
Function The T→R instruction copies the bit pattern of a register or 16 contiguous discretes
Description in a table to a specific holding register. It can accommodate the transfer of one
register per scan. It has three control inputs and produces two possible outputs.
740 33002261
T-->R: Table to Register
Representation
source
table
pointer
T→R
table
length
33002261 741
T-->R: Table to Register
Parameter Description
Middle Input When the middle input goes ON, the current value stored in the pointer register is
frozen while the DX operation continues. This causes the same table data to be
written to the destination register on each scan.
Bottom Input When the bottom input goes ON, the value in the pointer is reset to zero. This causes
the next DX move operation to copy the first destination register in the table.
Pointer The 4x register entered in the middle node is a pointer to the destination where the
(Middle Node) source data will be copied. The destination register is the next contiguous 4x register
after the pointer. For example, if the middle node displays a pointer of 400100, then
the destination register for the T→R copy is 400101.
The value stored in the pointer register indicates which register in the source table
will be copied to the destination register in the current scan. A value of 0 in the
pointer indicates that the bit pattern in the first register of the source table will be
copied to the destination; a value of 1 in the pointer register indicates that the bit
pattern in the second register of the source table will be copied to the destination
register; etc.
742 33002261
T−−>T: Table to Table
137
At a Glance
33002261 743
T-->T: Table to Table
Short Description
Function The T→T instruction copies the bit pattern of a register or of 16 discretes from a
Description position within one table to an equivalent position in another table of registers. It can
accommodate the transfer of one register per scan. It has three control inputs and
produces two possible outputs.
744 33002261
T-->T: Table to Table
Representation
source
table
pointer
T→T
table
length
33002261 745
T-->T: Table to Table
Parameter Description
Middle Input When the input to the middle node goes ON, the current value stored in the pointer
register is frozen while the DX operation continues. This causes new data being
copied to the destination to overwrite the data copied on the previous scan.
Bottom Input When the input to the bottom node goes ON, the value in the pointer register is reset
to zero. This causes the next DX move operation to copy source data into the first
register in the destination table.
Pointer The 4x register entered in the middle node is a pointer into both the source and
(Middle Node) destination tables, indicating where the data will be copied from and to in the current
scan. The first register in the destination table is the next contiguous 4x register
following the pointer. For example, if the middle node displays a a pointer reference
of 400100, then the first register in the destination table is 400101.
The value stored in the pointer register indicates which register in the source table
will be copied to which register in the destination table. Since the length of the two
tables is equal and T→T copy is to the equivalent register in the destination table,
the current value in the pointer register also indicates which register in the
destination table the source data will be copied to.
A value of 0 in the pointer register indicates that the bit pattern in the first register of
the source table will be copied to the first register of the destination table; a value of
1 in the pointer register indicates that the bit pattern in the second register of the
source table will be copied to the second register of the destination register; etc.
746 33002261
T.01 Timer: One Hundredth
Second Timer
138
At a Glance
33002261 747
T.01 Timer: One Hundredth Second Timer
Short Description
Function The T.01 instruction measures time in hundredth of a second intervals. It can be
Description used for timing an event or creating a delay. T.01 has two control inputs and can
produce one of two possible outputs.
Representation
timer
preset
T.01
accumulated
time
748 33002261
T0.1 Timer: One Tenth Second
Timer
139
At a Glance
33002261 749
T0.1 Timer: One Tenth Second Timer
Short Description
Function The T0.1 instruction measures time in tenth-of-a-second increments. It can be used
Description for timing an event or creating a delay. T0.1 has two control inputs and can produce
one of two possible outputs.
Note: If you cascade T0.1 timers with presets of 1, the timers will time-out together;
to avoid this problem, change the presets to 10 and substitute a T.01 timer.
750 33002261
T0.1 Timer: One Tenth Second Timer
Representation
timer
preset
T0.1
accumulated
time
33002261 751
T0.1 Timer: One Tenth Second Timer
752 33002261
T1.0 Timer: One Second Timer
140
At a Glance
33002261 753
T1.0 Timer: One Second Timer
Short Description
Function The T1.0 timer instruction measures time in one-second increments. It can be used
Description for timing an event or creating a delay. T1.0 has two control inputs and can produce
one of two possible outputs.
Note: If you cascade T1.0 timers with presets of 1, the timers will time-out together;
to avoid this problem, change the presets to 10 and substitute a T0.1 timer.
754 33002261
T1.0 Timer: One Second Timer
Representation
timer
preset
T1.0
accumulated
time
33002261 755
T1.0 Timer: One Second Timer
756 33002261
T1MS Timer: One Millisecond
Timer
141
At a Glance
33002261 757
T1MS Timer: One Millisecond Timer
Short Description
Function
Description
Note: This instruction is available in Micro PLC models and the Quantum CPU 424
02 PLC.
758 33002261
T1MS Timer: One Millisecond Timer
Representation
timer
preset
accumulated
time
T1MS
#1
33002261 759
T1MS Timer: One Millisecond Timer
Example
A Millisecond Here is the ladder logic for a real-time clock with millisecond accuracy:
Timer Example
100
000001
400055 10
000002
000001 UCTR
T1MS
400054 60
1
000003
UCTR
400053 60
000002 000004
UCTR
400052 24
000003 000005
UCTR
400051
000004
000005
760 33002261
T1MS Timer: One Millisecond Timer
As the times accumulate in each counter, the time of day can be read in five holding
registers as follows:
Register Unit of Time Valid Range
40055 Thousandths-of-a-second 0 ... 100
40054 Tenths-of-a-second 0 ... 10
40053 Seconds 0 ... 60
40052 Minutes 0 ... 60
40051 Hours 0 ... 24
33002261 761
T1MS Timer: One Millisecond Timer
762 33002261
TBLK: Table to Block
142
At a Glance
33002261 763
TBLK: Table to Block
Short Description
Function The TBLK (table-to-block) instruction combines the functions of T→R and the BLKM
Description in a single instruction. In one scan, it can copy up to 100 contiguous 4x registers from
a table to a destination block. The destination block is of a fixed length. The block of
registers being copied from the source table is of the same length, but the overall
length of the source table is limited only by the number of registers in your system
configuration.
Representation
source
table
pointer
TBLK
block
length
764 33002261
TBLK: Table to Block
Parameter Description
Middle Input When the middle input is ON, the value in the pointer register is frozen while the
TBLK operation continues. This causes the same source data block to be copied to
the destination table on each scan.
Bottom Input When the bottom input is ON, the pointer value is reset to zero. This causes the
TBLK operation to copy data from the first block of registers in the source table.
CAUTION
Confine the value in the destination pointer to a safe range.
You should use external logic in conjunction with the middle and the bottom inputs
to confine the value in the destination pointer to a safe range.
Failure to follow this instruction can result in injury or equipment damage.
Source Table The 4x register entered in the top node is the first holding register in the source table.
(Top Node)
Note: The source table is segmented into a series of register blocks, each of which
is the same length as the destination block. Therefore, the size of the source table
is a multiple of the length of the destination block, but its overall size is not
specifically defined in the instruction. If left uncontrolled, the source table could
consume all the 4x registers available in the PLC configuration.
Pointer The 4x register entered in the middle node is the pointer to the source block. The
(Middle Node) first register in the destination block is the next contiguous register after the pointer.
For example, if the pointer is register 400107, then the first register in the destination
block is 400108.
The value stored in the pointer indicates which block of data from the source table
will be copied to the destination block. This value specifies a block number within the
source table.
33002261 765
TBLK: Table to Block
766 33002261
TEST: Test of 2 Values
143
At a Glance
33002261 767
TEST: Test of 2 Values
Short Description
Function The TEST instruction compares the signed or unsigned size of the 16-bit values in
Description the top and middle nodes and describes the relationship via the block outputs.
Representation
value 1
value 2
TEST
768 33002261
UCTR: Up Counter
144
At a Glance
33002261 769
UCTR: Up Counter
Short Description
Function The UCTR instruction counts control input transitions from OFF to ON up from zero
Description to a counter preset value.
Representation
counter
preset
UCTR
accumulated
count
770 33002261
WRIT: Write
145
At a Glance
33002261 771
WRIT: Write
Short Description
Function The WRIT instruction sends a message from the PLC over the RIO communications
Description link to an ASCII display (screen, printer, etc.).
In the process of sending the messaging operation, WRIT performs the following
functions:
l Verifies the correctness of the ASCII communication parameters, e.g. the port
number, the message number
l Verifies the lengths of variable data fields
l Performs error detection and recording
l Reports RIO interface status
WRIT requires two tables of registers: a source table where variable data (the
message) is copied, and a control block where comm port and message parameters
are identified.
Further information about formatting messages you will find in Formatting Messages
for ASCII READ/WRIT Operations, p. 59.
772 33002261
WRIT: Write
Representation
source
control
block
WRIT
table
length
33002261 773
WRIT: Write
Parameter Description
Source Table The top node contains the first 3x or 4x register in a source table whose length is
(Top Node) specified in the bottom node. This table contains the data required to fill the variable
field in a message.
Consider the following WRIT message
The 3-character ASCII field III is the variable data field; variable data are loaded,
typically via DX moves, into a table of variable field data.
Control Block The 4x register entered in the middle node is the first of seven contiguous holding
(Middle Node) register in the control block.
Register Definition
Displayed Port Number and Error Code, p. 775
First implied Message number
Second implied Number of registers required to satisfy format
Third implied Count of the number of registers transmitted thus far
Fourth implied Status of the solve
Fifth implied Reserved
Sixth implied Checksum of registers 0 ... 5
774 33002261
WRIT: Write
Bit Function
1 ... 4 PLC error code (see table below)
5 Not used
6 Input from the ASCII device not compatible with format
7 Input buffer overrun, data received too quickly at RIOP
8 USART error, bad byte received at RIOP
9 Illegal format, not received properly by RIOP
10 ASCII device off-line, check cabling
11 ASCII message terminated early (in keyboard mode
12 ... 16 Comm port # (1 ... 32)
33002261 775
WRIT: Write
776 33002261
XMIT: XMIT Communication Block
146
At a Glance
33002261 777
XMIT: XMIT Communication Block
Short Description
Function The following steps are necessary before using this instruction:
Requirements
Step Action
1 Add loadable NSUP.exe to the controller’s configuration
Note: This loadable needs only be loaded once to support multiple loadables,
such as ECS.exe and NOL.exe.
CAUTION
The outputs of the instruction turn on, regardless of the input states
When the NSUP loadable is not installed or is installed after the XMIT loadable or
is installed in a Quantum PLC with an executive < V2.0, all three outputs turn on,
regardless of the input states.
Failure to follow this instruction can result in injury or equipment damage.
Step Action
2 Unpack and install the DX Loadable XMIT; further information you will find in the
chapter Installation of DX Loadables, p. 71.
Function The XMIT instruction is provided to receive and transmit ASCII messages and
Description Modbus master messages using the PLC ports.
778 33002261
XMIT: XMIT Communication Block
Representation
port #
control
block
XMIT
number of
registers
33002261 779
XMIT: XMIT Communication Block
Detailed Description
Mode of The XMIT (Transmit) instruction sends Modbus messages from a master PLC to
Functioning multiple slave PLCs or sends ASCII character strings from the PLC's Modbus slave
port#1 or port#2 to ASCII printers and terminals. XMIT sends these messages over
telephone dialup modems, radio modems, or simply direct connection.
XMIT comes with three modes:
l communication mode
l port status mode
l conversion mode.
XMIT performs general ASCII input functions in the communication mode including
simple ASCII and terminated ASCII. You may use an additional XMIT block for
reporting port status information into registers while another XMIT block performs
the ASCII communication function. You may import and export ASCII or binary data
into your PLC and convert it into various binary data or ASCII to send to DCE (Data
Communication Equipment) devices based upon the needs of your application.
The block has built-in diagnostics that checks to make sure no other XMIT blocks
are active in the PLC. Within the XMIT block a control table allows you to control the
communications link between the PLC and DCE (Data Communication Equipment)
devices attached to Modbus port #1 or port#2 of the PLC. The XMIT block does NOT
activate the port LED when it is transmitting data.
Further information you will find in the Modicon XMIT Function Block User Guide.
CAUTION
Contention and Collision when using the XMIT instruction in a network with
multiple masters
Remember, the Modbus protocol is a master/ slave protocol. Modbus is designed
to have only one master polling multiple slaves. Therefore, when using the XMIT
instruction in a network with multiple masters, contention resolution and collision
avoidance is your responsibility and may easily be addressed through ladder logic
programming.
Failure to follow this instruction can result in injury or equipment damage.
Top Input The top input begins an XMIT operation and it should remain ON until the operation
has completed successfully or an error has occurred.
780 33002261
XMIT: XMIT Communication Block
Middle Input The middle input aborts any active XMIT operation and forces the port to slave
mode. An abort code (121) is placed into the fault status register. The port remains
closed as long as this input is ON.
Note: To reset an XMIT fault and clear the fault register, the top input must go OFF
for at least one PLC scan.
Port # (Top Node) In the top node you select the PLC port number, from where the messages are sent
or received.
The top node must contain one of the following constants:
l #0001 = PLC port #1
l #0002 = PLC port #2
Control Block The 4x register entered in the middle node is the first of sixteen contiguous 4x
(Middle Node) registers that comprise the control block:
Register Content
Displayed Current revision number of XMIT block.
First implied Fault Status, p. 782
Second implied Available to user
May be used as pointers for instructions like TBLK.
Third implied Data Rate:
50, 75, 110, 134, 150, 300, 600, 1200, 2400, 9600 and 19200
Fourth implied Data Bits:
7 for ASCII mode
8 for RTU mode
Fifth implied Parity:
0 = no parity
1 = odd parity
2 = even parity
Sixth implied Stop Bits
1 = one stop bit
2 = two stop bits
Seventh implied Available to user
May be used as pointers for instructions like TBLK.
Eighth implied Command Word, p. 784
0000-0001-0000-0000 (256Dec)
Ninth implied Pointer to message table (See Message Pointer, p. 786)
Limited by the range of 4x registers configured
33002261 781
XMIT: XMIT Communication Block
Register Content
10th implied Length of message
Range: 0...512
11th implied Response Time Out (ms)
Range: 0 ... 65535
12th implied Retry limit
Range: 0 ... 65535
13th implied Start of transmission delay (ms)
Range: 0 ... 65535
14th implied End of transmission delay (ms)
Range: 0 ... 65535
15th implied Current number of retry attempts made by the instruction
WARNING
No modification of the control block address
Do not modify the address in the middle node of the XMIT block or delete it from
the program while it is active. This locks up the port preventing communications.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
Fault Status The following fault code is generated by the XMIT instruction:
Fault Code Fault Description
1 Modbus exception Illegal function
2 Modbus exception Illegal data address
3 Modbus exception Illegal data value
4 Modbus exception Slave device failure
5 Modbus exception Acknowledge
6 Modbus exception Slave device busy
7 Modbus exception Negative acknowledge
8 Modbus exception Memory parity error
9 ... 99 Reserved
100 Slave PLC data area cannot equal zero
101 Master PLC data area cannot equal zero
102 Coil (0x) not configured
103 Holding register (4x) not configured
782 33002261
XMIT: XMIT Communication Block
33002261 783
XMIT: XMIT Communication Block
784 33002261
XMIT: XMIT Communication Block
33002261 785
XMIT: XMIT Communication Block
Detailed information about the bits of the command word you will find in the Modicon
XMIT Function Block User Guide .
Message Pointer You enter a pointer that points to the beginning of the message table. There are two
different handlings of the pointer depending on using ASCII character strings or
Modbus messages.
For ASCII character strings, the pointer is the register offset to the first register of
the ASCII character string. Each register holds up to two ASCII characters. Each
ASCII string may be up to 1024 characters in length. For example, when you want
to send 10 ASCII messages out of the PLC, you must program 10 ASCII character
strings into 4x registers of the PLC and then through ladder logic set the pointer to
the start of each message after each successful operation of XMIT.
For Modbus messages, the pointer is the register offset to the first register of the
Modbus definition table. The Modbus definition table has different length depending
on the used Modbus function code and you must program it for successful XMIT
operation.
Detailed information about the bits of the command word you will find in the Modicon
XMIT Function Block User Guide .
Outputs
CAUTION
All three outputs of the instruction turn on, regardless of the input states
When the NSUP loadable is not installed or is installed after the XMIT loadable or
is installed in a Quantum PLC with an executive < V2.0, all three outputs turn on,
regardless of the input states.
Failure to follow this instruction can result in injury or equipment damage.
786 33002261
XMRD: Extended Memory Read
147
At a Glance
33002261 787
XMRD: Extended Memory Read
Short Description
Function The XMRD instruction is used to copy a table of 6x extended memory registers to a
Description table of 4x holding registers in state RAM.
Representation
control
block
destination
XMRD
788 33002261
XMRD: Extended Memory Read
Parameter Description
Control Block The 4x register entered in the top node is the first of six contiguous holding registers
(Top Node) in the extended memory control block.
Reference Register Name Description
Displayed status word Contains the diagnostic information about extended
memory (see Status Word of the Control Block, p. 790)
First implied file number Specifies which of the extended memory files is
currently in use (range: 1 ... 10)
Second start address Specifies which 6x storage register in the current file is
implied the starting address; 0 = 60000, 9999 = 69999
Third implied count Specifies the number of registers to be read or written in
a scan when the appropriate function block is powered;
range: 0 ... 9999, not to exceed number specified in max
registers (fifth implied)
Fourth implied offset Keeps a running total of the number of registers
transferred thus far
Fifth implied max registers Specifies the maximum number of registers that may be
transferred when the function block is powered (range:
0 ... 9999)
If you are in multi-scan mode, these six registers should be unique to this function
block.
33002261 789
XMRD: Extended Memory Read
Bit Function
1 1 = power-up diagnostic error
2 1 = parity error in extended memory
3 1 = extended memory does not exist
4 0 = transfer not running
1 = busy
5 0 = transfer in progress
1 = transfer complete
6 1 = file boundary crossed
7 1 = offset parameter too large
8-9 Not used
10 1 = nonexistent state RAM
11 Not used
12 1 = maximum registers parameter error
13 1 = offset parameter error
14 1 = count parameter error
15 1 = starting address parameter error
16 1 = file number parameter error
790 33002261
XMWT: Extended Memory Write
148
At a Glance
33002261 791
XMWT: Extended Memory Write
Short Description
Function The XMWT instruction is used to write data from a block of input registers or holding
Description registers in state RAM to a block of 6x registers in an extended memory file.
Representation
source
control
block
XMWT
792 33002261
XMWT: Extended Memory Write
Parameter Description
Control Block The 4x register entered in the middle node is the first of six contiguous holding
(Top Node) registers in the extended memory control block.
Reference Register Name Description
Displayed status word Contains the diagnostic information about extended
memory (see Status Word of the Control Block, p. 794)
First implied file number Specifies which of the extended memory files is
currently in use (range: 1 ... 10)
Second start address Specifies which 6x storage register in the current file is
implied the starting address; 0 = 60000, 9999 = 69999
Third implied count Specifies the number of registers to be read or written in
a scan when the appropriate function block is powered;
range: 0 ... 9999, not to exceed number specified in max
registers (fifth implied)
Fourth implied offset Keeps a running total of the number of registers
transferred thus far
Fifth implied max registers Specifies the maximum number of registers that may be
transferred when the function block is powered (range:
0 ... 9999)
If you are in multi-scan mode, these six registers should be unique to this function
block.
33002261 793
XMWT: Extended Memory Write
Bit Function
1 1 = power-up diagnostic error
2 1 = parity error in extended memory
3 1 = extended memory does not exist
4 0 = transfer not running
1 = busy
5 0 = transfer in progress
1 = transfer complete
6 1 = file boundary crossed
7 1 = offset parameter too large
8-9 Not used
10 1 = nonexistent state RAM
11 Not used
12 1 = maximum registers parameter error
13 1 = offset parameter error
14 1 = count parameter error
15 1 = starting address parameter error
16 1 = file number parameter error
794 33002261
XOR: Exclusive OR
149
At a Glance
33002261 795
XOR: Exclusive OR
Short Description
Function The XOR instruction performs a Boolean Exclusive OR operation on the bit patterns
Description in the source and destination matrices.
The XORed bit pattern is then posted in the destination matrix, overwriting its
previous contents:
0 1 1 0
source
destination
bits XOR XOR XOR XOR bits
0 0 0 1 1 0 1 1
WARNING
XOR will override any disabled coils within the destination matrix without
enabling them.
This can cause personal injury if a coil has disabled an operation for maintenance
or repair because the coil’s state can be changed by the XOR operation.
Failure to follow this instruction can result in death, serious injury, or
equipment damage.
796 33002261
XOR: Exclusive OR
Representation
source
matrix
destination
matrix
XOR
length
Parameter Description
Matrix Length The integer entered in the bottom node specifies the matrix length, i.e. the number
(Bottom Node) of registers or 16-bit words in the two matrices. The matrix length can be in the range
1 ... 100. A length of 2 indicates that 32 bits in each matrix will be XORed.
33002261 797
XOR: Exclusive OR
798 33002261
Glossary
active Window The window, which is currently selected. Only one window can be active at any
given time. When a window is active, the color of the title bar changes, so that it is
distinguishable from the other windows. Unselected windows are inactive.
Addresses (Direct) addresses are memory ranges on the PLC. They are located in the State
RAM and can be assigned Input/Output modules.
The display/entry of direct addresses is possible in the following formats:
l Standard Format (400001)
l Separator Format (4:00001)
l Compact format (4:1)
l IEC Format (QW1)
ANL_IN ANL_IN stands for the "Analog Input" data type and is used when processing analog
values. The 3x-References for the configured analog input module, which were
specified in the I/O component list, are automatically assigned to the data type and
should therefore only be occupied with Unlocated Variables.
ANL_OUT ANL_OUT stands for the "Analog Output" data type and is used when processing
analog values. The 4x-References for the configured analog output module, which
were specified in the I/O component list, are automatically assigned to the data type
and should therefore only be occupied with Unlocated Variables.
ANY In the present version, "ANY" covers the BOOL, BYTE, DINT, INT, REAL, UDINT,
UINT, TIME and WORD elementary data types and related Derived Data Types.
33002261 799
Glossary
ANY_BIT In the present version, "ANY_BIT" covers the BOOL, BYTE and WORD data types.
ANY_ELEM In the present version, "ANY_ELEM" covers the BOOL, BYTE, DINT, INT, REAL,
UDINT, UINT, TIME and WORD data types.
ANY_INT In the present version, "ANY_INT" covers the DINT, INT, UDINT and UINT data
types.
ANY_NUM In the present version, "ANY_NUM" covers the DINT, INT, REAL, UDINT and UINT
data types.
ANY_REAL In the present version, "ANY_REAL" covers the REAL data type.
Application The window contains the workspace, menu bar and the tool bar for the application
Window program. The name of the application program appears in the title bar. An
application window can contain several Document windows. In Concept the
application window corresponds to a Project.
ASCII-Mode The ASCII (American Standard Code for Information Interchange) mode is used to
communicate with various host devices. ASCII works with 7 data bits.
Atrium The PC based Controller is located on a standard AT board, and can be operated
within a host computer in an ISA bus slot. The module has a motherboard (requires
SA85 driver) with two slots for PC104 daughter-boards. In this way, one PC104
daughter-board is used as a CPU and the other as the INTERBUS controller.
Backup file The backup file is a copy of the last Source coding file. The name of this backup file
(Concept-EFB) is "backup??.c" (this is assuming that you never have more than 100 copies of the
source coding file). The first backup file has the name "backup00.c". If you have
made alterations to the Definitions file which do not cause any changes to the EFB
interface, the generation of a backup file can be stopped by editing the source
coding file (Objects → Source). If a backup file is created, the source file can be
entered as the name.
800 33002261
Glossary
Base 16 literals Base 16 literals are used to input whole number values into the hexadecimal system.
The base must be denoted using the prefix 16#. The values can not have any signs
(+/-). Single underscores ( _ ) between numbers are not significant.
Example
16#F_F or 16#FF (decimal 255)
16#E_0 or 16#E0 (decimal 224)
Base 2 literals Base 2 literals are used to input whole number values into the dual system. The
base must be denoted using the prefix 2#. The values can not have any signs (+/-).
Single underscores ( _ ) between numbers are not significant.
Example
2#1111_1111 or 2#11111111 (decimal 255)
2#1110_0000 or 2#11100000 (decimal 224)
Base 8 literals Base 8 literals are used to input whole number values in the octosystem. The base
must be denoted using the prefix 8#. The values can not have any signs (+/-). Single
underscores ( _ ) between numbers are not significant.
Example
8#3_77 or 8#377 (decimal 255)
8#34_0 or 8#340 (decimal 224)
Binary Connections between FFB outputs and inputs with the data type BOOL.
Connections
BOOL BOOL stands for the data type "boolean". The length of the data element is 1 bit
(occupies 1 byte in the memory). The value range for the variables of this data type
is 0 (FALSE) and 1 (TRUE).
BYTE BYTE stands for the data type "bit sequence 8". Entries are made as base 2 literal,
base 8 literal or base 16 literal. The length of the data element is 8 bits. A numerical
value range can not be assigned to this data type.
33002261 801
Glossary
Clipboard The clipboard is a temporary memory for cut or copied objects. These objects can
be entered in sections. The contents of the clipboard are overwritten with each new
cut or copy.
Coil A coil is a LD element which transfers the status of the horizontal connection on its
left side, unchanged, to the horizontal connection on its right side. In doing this, the
status is saved in the relevant variable/direct address.
Compact format The first digit (the Reference) is separated from the address that follows by a colon
(4:1) (:) where the leading zeros are not specified.
Constants Constants are Unlocated variables, which are allocated a value that cannot be
modified by the logic program (write protected).
Contact A contact is a LD element, which transfers a status on the horizontal link to its right
side. This status comes from the boolean AND link of the status of the horizontal link
on the left side, with the status of the relevant variable/direct address. A contact
does not change the value of the relevant variable/direct address.
Data transfer Settings which determine how information is transferred from your programming
settings device to the PLC.
Data Types The overview shows the data type hierarchy, as used for inputs and outputs of
functions and function blocks. Generic data types are denoted using the prefix
"ANY".
l ANY_ELEM
l ANY_NUM
ANY_REAL (REAL)
ANY_INT (DINT, INT, UDINT, UINT)
l ANY_BIT (BOOL, BYTE, WORD)
l TIME
l System Data types (IEC Extensions)
l Derived (from "ANY" data types)
802 33002261
Glossary
DCP I/O drop A remote network with a super-ordinate PLC can be controlled using a Distributed
Control Processor (D908). When using a D908 with remote PLC, the super-ordinate
PLC considers the remote PLC as a remote I/O drop. The D908 and the remote PLC
communicate via the system bus, whereby a high performance is achieved with
minimum effect on the cycle time. The data exchange between the D908 and the
super-ordinate PLC takes place via the remote I/O bus at 1.5Mb per second. A
super-ordinate PLC can support up to 31 D908 processors (addresses 2-32).
DDE (Dynamic The DDE interface enables a dynamic data exchange between two programs in
Data Exchange) Windows. The user can also use the DDE interface in the extended monitor to call
up their own display applications. With this interface, the user (i.e. the DDE client)
can not only read data from the extended monitor (DDE server), but also write data
to the PLC via the server. The user can therefore alter data directly in the PLC, while
monitoring and analyzing results. When using this interface, the user can create
their own "Graphic Tool", "Face Plate" or "Tuning Tool" and integrate it into the
system. The tools can be written in any language, i.e. Visual Basic, Visual C++,
which supports DDE. The tools are invoked when the user presses one of the
buttons in the Extended Monitor dialog field. Concept Graphic Tool: Configuration
signals can be displayed as a timing diagram using the DDE connection between
Concept and Concept Graphic Tool.
Declaration Mechanism for specifying the definition of a language element. A declaration usually
covers the connection of an identifier to a language element and the assignment of
attributes such as data types and algorithms.
Definitions file The definitions file contains general descriptive information on the selected EFB and
(Concept-EFB) its formal parameters.
Defragmenting With defragmenting, unanticipated gaps (e.g. resulting from deleting unused
variables) are removed from memory.
Derived Data Derived data types are data types, which are derived from Elementary Data Types
Type and/or other derived data types. The definition of the derived data types is found in
the Concept data type editor.
A distinction is made between global data types and local data types.
33002261 803
Glossary
Derived Function A derived function block represents the invocation of a derived function block type.
Block (DFB) Details of the graphic form of the invocation can be found in the "Functional block
(instance)". In contrast to the invocation of EFB types, invocations of DFB types are
denoted by double vertical lines on the left and right hand side of the rectangular
block symbol.
The output side of a derived function block is created in FBD language, LD
language, ST language, IL language, but only in the current version of the
programming system. Derived functions can also not be defined in the current
version.
A distinction is made between local and global DFBs.
DFB Code The DFB code is the section's DFB code which can be executed. The size of the
DFB code is mainly dependent upon the number of blocks in the section.
DFB instance The DFB instance data is internal data from the derived function blocks used in the
data program.
DINT DINT stands for the data type "double length whole number (double integer)".
Entries are made as integer literal, base 2 literal, base 8 literal or base 16 literal. The
length of the data element is 32 bits. The value range for variables of this data type
reaches from -2 exp (31) to 2 exp (31) -1.
Direct A method of displaying variables in the PLC program, from which the assignment to
Representation the logical memory can be directly - and indirectly to the physical memory - derived.
Document A window within an application window. Several document windows can be open at
Window the same time in an application window. However, only one document window can
ever be active. Document windows in Concept are, for example, sections, the
message window, the reference data editor and the PLC configuration.
Dummy An empty file, which consists of a text heading with general file information, such as
author, date of creation, EFB designation etc. The user must complete this dummy
file with further entries.
DX Zoom This property enables the user to connect to a programming object, to monitor and,
if necessary change, its data value.
804 33002261
Glossary
EFB code The EFB code is the executable code of all EFBs used. In addition the used EFBs
count in DFBs.
Elementary Identifier for Functions or Function blocks, whose type definitions are not formulated
functions/ in one of the IEC languages, i.e. whose body for example can not be modified with
function blocks the DFB editor (Concept-DFB). EFB types are programmed in "C" and are prepared
(EFB) in a pre-compiled form using libraries.
EN / ENO (Enable If the value of EN is equal to "0" when the FFB is invoked, the algorithms that are
/ Error signal) defined by the FFB will not be executed and all outputs keep their previous values.
The value of ENO is in this case automatically set to "0". If the value of EN is equal
to "1", when the FFB is invoked, the algorithms which are defined by the FFD will be
executed. After the error-free execution of these algorithms, the value of ENO is
automatically set to "1". If an error occurs during the execution of these algorithms,
ENO is automatically set to "0". The output behavior of the FFB is independent of
whether the FFBs are invoked without EN/ENO or with EN=1. If the EN/ENO display
is switched on, it is imperative that the EN input is switched on. Otherwise, the FFB
is not executed. The configuration of EN and ENO is switched on or off in the Block
Properties dialog box. The dialog box can be invoked with the Objects →
Properties...menu command or by double-clicking on the FFB.
Error If an error is recognized during the processing of a FFB or a step (e.g. unauthorized
input values or a time error), an error message appears, which can be seen using
the Online → Event Viewer...menu command. For FFBs, the ENO output is now set
to "0".
Evaluation The process, through which a value is transmitted for a Function or for the output of
a Function block during Program execution.
FFB (Functions/ Collective term for EFB (elementary functions/function blocks) and DFB (Derived
Function blocks) function blocks)
33002261 805
Glossary
Field variables A variable, which is allocated a defined derived data type with the key word ARRAY
(field). A field is a collection of data elements with the same data type.
FIR Filter (Finite Impulse Response Filter) a filter with finite impulse answer
Formal Input / Output parameters, which are used within the logic of a FFB and led out of
parameters the FFB as inputs/outputs.
Function (FUNC) A program organization unit, which supplies an exact data element when
processing. a function has no internal status information. Multiple invocations of the
same function using the same input parameters always supply the same output
values.
Details of the graphic form of the function invocations can be found in the definition
"Functional block (instance)". In contrast to the invocations of the function blocks,
function invocations only have a single unnamed output, whose name is the same
as the function. In FBD each invocation is denoted by a unique number via the
graphic block, this number is automatically generated and can not be altered.
Function block A function block is a program organization unit, which correspondingly calculates the
(Instance) (FB) functionality values that were defined in the function block type description, for the
outputs and internal variable(s), if it is invoked as a certain instance. All internal
variable and output values for a certain function block instance remain from one
function block invocation to the next. Multiple invocations of the same function block
instance with the same arguments (input parameter values) do not therefore
necessarily supply the same output value(s).
Each function block instance is displayed graphically using a rectangular block
symbol. The name of the function block type is stated in the top center of the
rectangle. The name of the function block instance is also stated at the top, but
outside of the rectangle. It is automatically generated when creating an instance,
but, depending on the user's requirements, it can be altered by the user. Inputs are
displayed on the left side of the block and outputs are displayed on the right side.
The names of the formal input/output parameters are shown inside the rectangle in
the corresponding places.
The above description of the graphic display is especially applicable to the function
invocations and to DFB invocations. Differences are outlined in the corresponding
definitions.
Function Block One or more sections, which contain graphically displayed networks from Functions,
Dialog (FBD) Function blocks and Connections.
Function block A language element, consisting of: 1. the definition of a data structure, divided into
type input, output and internal variables; 2. a set of operations, which are performed with
elements of the data structure, when a function block type instance is invoked. This
set of operations can either be formulated in one of the IEC languages (DFB type)
or in "C" (EFB type). A function block type can be instanced (invoked) several times.
806 33002261
Glossary
Function The function number is used to uniquely denote a function in a program or DFB. The
Number function number can not be edited and is automatically assigned. The function
number is always formed as follows: .n.m
Generic Data A data type, which stands in place of several other data types.
Type
Generic literals If the literal's data type is not relevant, simply specify the value for the literal. If this
is the case, Concept automatically assigns the literal a suitable data type.
Global derived Global derived data types are available in each Concept project and are occupied in
data types the DFB directory directly under the Concept directory.
Global DFBs Global DFBs are available in each Concept project. The storage of the global DFBs
is dependant upon the settings in the CONCEPT.INI file.
Global macros Global macros are available in each Concept project and are stored in the DFB
directory directly under the Concept directory.
Groups (EFBs) Some EFB libraries (e.g. the IEC library) are divided into groups. This facilitates
locating the EFBs especially in expansive libraries.
Host Computer Hardware and software, which support programming, configuring, testing, operating
and error searching in the PLC application as well as in a remote system application,
in order to enable source documentation and archiving. The programming device
can also be possibly used for the display of the process.
33002261 807
Glossary
I/O Map The I/O and expert modules from the various CPUs are configured in the I/O map.
IEC Format There is an IEC type designation in initial position of the address, followed by the
(QW1) five-figure address.
l %0x12345 = %Q12345
l %1x12345 = %I12345
l %3x12345 = %IW12345
l %4x12345 = %QW12345
IEC name An identifier is a sequence of letters, numbers and underscores, which must begin
conventions with either a letter or underscore (i.e. the name of a function block type, an instance,
(identifier) a variable or a section). Letters of a national typeface (i.e.: ö,ü, é, õ) can be used,
except in project and DFB names.
Underscores are significant in identifiers; e.g. "A_BCD" and "AB_CD" are
interpreted as two separate identifiers. Several leading and multiple successive
underscores are not allowed.
Identifiers should not contain any spaces. No differentiation is made between upper
and lower case, e.g. "ABCD" and "abcd" are interpreted as the same identifier.
Identifiers should not be Keywords.
IEC Program The IEC program memory consists of the program code, EFB code, the section data
Memory and the DFB instance data.
IIR Filter (Infinite Impulse Response Filter) a filter with infinite impulse answer
Initial step The first step in a sequence. A step must be defined as an initial step for each
sequence. The sequence is started with the initial step when first invoked.
Initial value The value, which is allocated to a variable when the program is started. The values
are assigned in the form of literals.
808 33002261
Glossary
Input bits The 1/0 status of the input bits is controlled via the process data, which reaches from
(1x references) an input device to the CPU.
Note: The x, which follows the initial reference type number, represents a five-
figure storage location in the user data memory, i.e. the reference 100201 signifies
an output or marker bit at the address 201 in the State RAM.
Input parameter Upon invocation of a FFB, this transfers the corresponding argument.
(Input)
Input words An input word contains information, which originates from an external source and is
(3x references) represented by a 16 bit number. A 3x register can also contain 16 sequential input
bits, which were read into the register in binary or BCD (binary coded decimal)
format. Note: The x, which follows the initial reference type number, represents a
five-figure storage location in the user data memory, i.e. the reference 300201
signifies a 16-bit input word at the address 201 in the State RAM.
Instance Name An identifier, which belongs to a certain function block instance. The instance name
is used to clearly denote a function block within a program organization unit. The
instance name is automatically generated, but it can be edited. The instance name
must be unique throughout the whole program organization unit, and is not case
sensitive. If the name entered already exists, you will be warned and you will have
to choose another name. The instance name must comply with the IEC name
conventions otherwise an error message appears. The automatically generated
instance name is always formed as follows: FBI_n_m
Instruction (IL) Instructions are the "commands" of the IL programming language. Each instruction
begins on a new line and is performed by an operator with a modifier if necessary,
and if required for the current operation, by one or more operands. If several
operands are used, they are separated by commas. A character can come before
the instruction, which is then followed by a colon. The comment must, if present, be
the last element of the line.
33002261 809
Glossary
Instruction When programming electrical controls, the user must implement operation-coded
(LL984) instructions in the form of picture objects, which are divided into a recognizable
contact form. The designed program objects are, on a user level, converted to
computer usable OP codes during the download process. The OP codes are
decoded in the CPU and processed by the firmware functions of the controller in a
way that the required control is implemented.
Instruction (ST) Instructions are "commands" of the ST programming language. Instructions must be
completed by semicolons. Several instructions can be entered in one line (separated
by semicolons).
Instruction list IL is a text language according to IEC 1131, which is shown in operations, i.e.
(IL) conditional or unconditional invocations of Functions blocks and Functions,
conditional or unconditional jumps etc. through instructions.
INT INT stands for the data type "whole number (integer)". Entries are made as integer
literal, base 2 literal, base 8 literal or base 16 literal. The length of the data element
is 16 bits. The value range for variables of this datatype reaches from -2 exp (15) to
2 exp (15) -1.
Integer literals Integer literals are used to input whole number values into the decimal system. The
values can have a preceding sign (+/-). Single underscores ( _ ) between numbers
are not significant.
Example
-12, 0, 123_456, +986
INTERBUS (PCP) The new INTERBUS (PCP) I/O drop type is entered into the Concept configurator,
to allow use of the INTERBUS PCP channel and the INTERBUS process data pre-
processing (PDV). This I/O drop type is assigned the INTERBUS switching module
180-CRP-660-01.
The 180-CRP-660-01 differs from the 180-CRP-660-00 only in the fact that it has a
clearly larger I/O range in the control state RAM.
Jump Element of the SFC language. Jumps are used to skip zones in the sequence.
810 33002261
Glossary
Keywords Keywords are unique combinations of characters, which are used as special
syntactical components, as defined in Appendix B of the IEC 1131-3. All keywords
which are used in the IEC 1131-3 and therefore in Concept, are listed in Appendix
C of the IEC 1131-3. These keywords may not be used for any other purpose, i.e.
not as variable names, section names, instance names etc.
Ladder Diagram Ladder Diagram is a graphic programming dialog according to IEC1131, which is
(LD) optically oriented to the "rung" of a relay contact plan.
Ladder Logic 984 The terms Ladder Logic and Ladder Diagram refer to the word Ladder being
(LL) executed. In contrast to a circuit diagram, a ladder diagram is used by electrotech-
nicians to display an electrical circuit (using electrical symbols), which should show
the course of events and not the existing wires, which connect the parts with each
other. A usual user interface for controlling the actions of automation devices
permits a Ladder Diagram interface, so that electrotechnicians do not have to learn
new programming languages to be able to implement a control program.
The structure of the actual Ladder Diagram enables the connection of electric
elements in such a way that generates a control output, which is dependent upon a
logical power flow through used electrical objects, which displays the previously
requested condition of a physical electrical device.
In simple form, the user interface is a video display processed by the PLC
programming application, which sets up a vertical and horizontal grid in which
programming objects are classified. The diagram contains the power grid on the left
side, and when connected to activated objects, the power shifts from left to right.
Landscape Landscape means that when looking at the printed text, the page is wider than it is
high.
Language Every basic element in one of the IEC programming languages, e.g. a step in SFC,
Element a function block instance in FBD or the initial value of a variable.
Library Collection of software objects, which are intended for re-use when programming
new projects, or even building new libraries. Examples are the libraries of the
Elementary function block types.
EFB libraries can be divided up into Groups.
33002261 811
Glossary
Link A control or data flow connection between graphical objects (e.g. steps in the SFC
Editor, function blocks in the FBD Editor) within a section, represented graphically
as a line.
Literals Literals are used to provide FFB inputs, and transition conditions etc with direct
values. These values can not be overwritten by the program logic (write-protected).
A distinction is made between generic and standardized literals.
Literals are also used to allocate, to a constant, a value or a variable, an initial value.
Entries are made as base 2 literal, base 8 literal, base 16 literal, integer literal, real
literal or real literal with exponent.
Local derived Local derived data types are only available in a single Concept project and the local
data types DFBs and are placed in the DFB directory under the project directory.
Local DFBs Local DFBs are only available in a single Concept project and are placed in the DFB
directory under the project directory.
Local Link The local network is the network, which connects the local nodes with other nodes
either directly or through bus repeaters.
Local macros Local macros are only available in a single Concept project and are placed in the
DFB directory under the project directory.
Local network The local node is the one which is currently being configured.
nodes
Located variable A state RAM address (reference addresses 0x, 1x, 3x,4x) is allocated to located
variables. The value of these variables is saved in the state RAM and can be
modified online using the reference data editor. These variables can be addressed
using their symbolic names or their reference addresses.
All inputs and outputs of the PLC are connected to the state RAM. The program can
only access peripheral signals attached to the PLC via located variables. External
access via Modbus or Modbus Plus interfaces of the PLC, e.g. from visualization
systems, is also possible via located variables.
812 33002261
Glossary
Macro Macros are created with the help of the Concept DFB software.
Macros are used to duplicate frequently used sections and networks (including their
logic, variables and variable declaration).
A distinction is made between local and global macros.
MMI Man-Machine-Interface
Multi element Variables to which a Derived data type defined with STRUCT or ARRAY is allocated.
variables A distinction is made here between field variables and structured variables.
Network A network is the collective switching of devices to a common data path, which then
communicate with each other using a common protocol.
Network node A node is a device with an address (1...64) on the Modbus Plus network.
33002261 813
Glossary
Node Address The node address is used to uniquely denote a network node in the routing path.
The address is set on the node directly, e.g. using the rotary switch on the back of
the modules.
Output A parameter, through which the result(s) of the evaluation of a FFB is/are returned.
parameter
(output):
Output/Marker An output/marker bit can be used to control real output data using an output unit of
bits the control system, or to define one or more discrete outputs in the state RAM. Note:
(0x references) The x, which follows the initial reference type number, represents a five-figure
storage location in the user data memory, i.e. the reference 000201 signifies an
output or marker bit at the address 201 in the State RAM.
Output/marker An output / marker word can be used to save numerical data (binary or decimal) in
words the state RAM, or to send data from the CPU to an output unit in the control system.
(4x references) Note: The x, which follows the initial reference type number, represents a five-figure
storage location in the user data memory, i.e. the reference 400201 signifies a 16 bit
output or marker word at the address 201 in the State RAM.
Peer CPU The Peer CPU processes the token execution and the data flow between the
Modbus Plus network and the PLC user logic.
Portrait Portrait means that the sides are larger than the width when printed.
Program The uppermost program organization unit. A program is closed on a single PLC
download.
814 33002261
Glossary
Program A function, a function block, or a Program. This term can refer to either a type or an
organization unit instance.
Program A redundancy system consists of two identically configured PLC machines, which
redundancy communicate with one another via redundancy processors. In the case of a
system breakdown of the primary PLC, the secondary PLC takes over the control check.
(Hot Standby) Under normal conditions, the secondary PLC does not take over the control function,
but checks the status information, in order to detect errors.
Project General description for the highest level of a software tree structure, which specifies
the super-ordinate project name of a PLC application. After specifying the project
name you can save your system configuration and your control program under this
name. All data that is created whilst setting up the configuration and program,
belongs to this super-ordinate project for this specific automation task.
General description for the complete set of programming and configuration
information in the project database, which represents the source code that
describes the automation of a system.
Project database The database in the host computer, which contains the configuration information for
a project.
Prototype file The prototype file contains all the prototypes of the assigned functions. In addition,
(Concept-EFB) if one exists, a type definition of the internal status structure is specified.
REAL REAL stands for the data type "floating point number". The entry can be real-literal
or real-literal with an exponent. The length of the data element is 32 bits. The value
range for variables of this data type extends from +/-3.402823E+38.
Note: Dependent on the mathematical processor type of the CPU, different ranges
within this permissible value range cannot be represented. This applies to values
that are approaching ZERO and for values that approach INFINITY. In these cases
NAN (Not A Number) or INF (INFinite) will be displayed in the animation mode
instead of a number value.
Real literals Real literals are used to input floating point values into the decimal system. Real
literals are denoted by a decimal point. The values can have a preceding sign (+/-).
Single underscores ( _ ) between numbers are not significant.
Example
-12.0, 0.0, +0.456, 3.14159_26
33002261 815
Glossary
Real literals with Real literals with exponents are used to input floating point values into the decimal
exponents system. Real literals with exponents are identifiable by a decimal point. The
exponent indicates the power of ten, with which the existing number needs to be
multiplied in order to obtain the value to be represented. The base can have a
preceding negative sign (-). The exponent can have a preceding positive or negative
sign (+/-). Single underscores ( _ ) between numbers are not significant. (Only
between characters, not before or after the decimal point and not before or after "E",
"E+" or "E-")
Example
-1.34E-12 or -1.34e-12
1.0E+6 or 1.0e+6
1.234E6 or 1.234e6
Reference Every direct address is a reference that begins with an indicator, which specifies
whether it is an input or an output and whether it is a bit or a word. References that
begin with the code 6, represent registers in the extended memory of the state RAM.
0x range = Output/Marker bits
1x range = Input bits
3x range = Input words
4x range = Output registers
6x range = Register in the extended memory
Note: The x, which follows each initial reference type number, represents a five-
digit storage location in the user data memory, i.e. the reference 400201 signifies
a 16 bit output or marker word at the address 201 in the State RAM.
Register in the 6x references are holding registers in the extended memory of the PLC. They can
extended only be used with LL984 user programs and only with a CPU 213 04 or CPU 424 02.
memory
(6x-reference)
Remote Network Remote programming in the Modbus Plus network enables maximum performance
(DIO) when transferring data and dispenses with the need for connections. Programming
a remote network is simple. Setting up a network does not require any additional
ladder logic to be created. All requirements for data transfer are fulfilled via
corresponding entries in the Peer Cop Processor.
RIO (Remote I/O) Remote I/O indicates a physical location of the I/O point controlling devices with
regard to the CPU controlling them. Remote inp./outputs are connected to the
controlling device via a twisted communication cable.
816 33002261
Glossary
Runtime error Errors, which appear during program processing on the PLC, in SFC objects (e.g.
Steps) or FFBs. These are, for example, value range overflows for numbers or
timing errors for steps.
SA85 module The SA85 module is a Modbus Plus adapter for IBM-AT or compatible computers.
Scan A scan consists of reading the inputs, processing the program logic and outputting
the outputs.
Section A section can for example be used to describe the functioning mode of a
technological unit such as a motor.
A program or DFB consists of one or more sections. Sections can be programmed
with the IEC programming languages FBD and SFC. Only one of the named
programming languages may be used within a section at any one time.
Each section has its own document window in Concept. For reasons of clarity,
however, it is useful to divide a very large section into several small ones. The scroll
bar is used for scrolling within a section.
Section Code Section Code is the executable code of a section. The size of the Section Code is
mainly dependent upon the number of blocks in the section.
Section Data Section data is the local data in a section such as e.g. literals, connections between
blocks, non-connected block inputs and outputs, internal status memory of EFBs.
Note: Data which appears in the DFBs of this section is not section data.
Separator The first digit (the reference) is separated from the five-digit address that follows by
Format (4:00001) a colon (:).
Sequence The SFC Language Elements enable a PLC program organization unit to be divided
language (SFC) up into a number of Steps and Transitions, which are connected using directional
Links. A number of actions belong to each step, and transition conditions are
attached to each transition.
Serial With serial connections (COM) the information is transferred bit by bit.
Connections
33002261 817
Glossary
Source code file The source code file is a normal C++ source file. After executing the Library →
(Concept-EFB) Create files menu command, this file contains an EFB-code frame, in which you
have to enter a specific code for the EFB selected. To do this invoke the Objects →
Source menu command.
Standard Format The five-digit address comes directly after the first digit (the reference).
(400001)
Standardized If you would like to manually determine a literal's data type, this may be done using
literals the following construction: ’Data type name’#’value of the literal’.
Example
INT#15 (Data type: integer, value: 15),
BYTE#00001111 (Data type: byte, value: 00001111)
REAL#23.0 (Data type: real, value: 23.0)
To assign the data type REAL, the value may also be specified in the following
manner: 23.0.
Entering a comma will automatically assign the data type REAL.
State RAM The state RAM is the memory space for all variables, which are accessed via
References (Direct representation) in the user program. For example, discrete
inputs, coils, input registers, and output registers are located in the state RAM.
U3 D3 D2 U1
PLC-State RAM
0x / 1x / 3x / 4x
Status Bits For every device with global inputs or specific inputs/outputs of Peer Cop data, there
is a status bit. If a defined group of data has been successfully transferred within the
timeout that has been set, the corresponding status bit is set to 1. If this is not the
case, this bit is set to 0 and all the data belonging to this group is deleted (to 0).
818 33002261
Glossary
Step name The step name is used to uniquely denote a step in a program organization unit. The
step name is generated automatically, but it can be edited. The step name must be
unique within the entire program organization unit, otherwise an error message will
appear.
The automatically generated step name is always formed as follows: S_n_m
S = step
n = Number of the section (consecutive numbers)
m = Number of the step in the section (current number)
Structured text ST is a text language according to IEC 1131, in which operations, e.g. invocations
(ST) of Function blocks and Functions, conditional execution of instructions, repetitions
of instructions etc. are represented by instructions.
Structured Variables to which a Derived data type defined with STRUCT (structure) is allocated.
variables A structure is a collection of data elements with generally different data types
(elementary data types and/or derived data types).
SY/MAX In Quantum control devices, Concept includes the preparation of I/O-map SY/MAX-
I/O modules for remote controlling by the Quantum PLC. The SY/MAX remote
backplane has a remote I/O adapter in slot 1, which communicates via a Modicon
S908 R I/O System. The SY/MAX-I/O modules are executed for you for labeling and
inclusion in the I/O map of the Concept configuration.
Template file The template file is an ASCII file with layout information for the Concept FBD Editor,
(Concept-EFB) and the parameters for code creation.
TIME TIME stands for the data type "time". The entry is time literal. The length of the data
element is 32 bits. The value range for variables of this data type extends from 0 to
2exp(32)-1. The unit for the data type TIME is 1 ms.
33002261 819
Glossary
Time literals Permissible units for times (TIME) are days (D), hours (H), minutes (M), seconds (S)
and milliseconds (MS) or combinations of these. The time must be marked with the
prefix t#, T#, time# or TIME#. The "overflow" of the unit with the highest value is
permissible, e.g. the entry T#25H15M is allowed.
Example
t#14MS, T#14.7S, time#18M, TIME#19.9H, t#20.4D, T#25H15M,
time#5D14H12M18S3.5MS
Token The network "token" controls the temporary possession of the transfer right via a
single node. The token passes round the nodes in a rotating (increasing) address
sequence. All nodes follow the token rotation and can receive all the possible data
that is sent with it.
Total IEC The total IEC memory consists of the IEC program memory and the global data.
memory
Traffic Cop The traffic cop is an IO map, which is generated from the user-IO map. The traffic
cop is managed in the PLC and in addition to the user IO map, contains e.g. status
information on the I/O stations and modules.
Transition The condition, in which the control of one or more predecessor steps passes to one
or more successor steps along a directed link.
UDINT UDINT stands for the data type "unsigned double integer". Entries are made as
integer literal, base 2 literal, base 8 literal or base 16 literal. The length of the data
element is 32 bits. The value range for variables of this data type extends from 0 to
2exp(32)-1.
UINT UINT stands for the data type "unsigned integer". Entries are made as integer literal,
base 2 literal, base 8 literal or base 16 literal. The length of the data element is 16
bits. The value range for variables of this data type extends from 0 to (2exp 16)-1.
820 33002261
Glossary
Unlocated Unlocated variables are not allocated a state RAM address. They therefore do not
variable occupy any state RAM addresses. The value of these variables is saved in the
internal system and can be changed using the reference data editor. These
variables are only addressed using their symbolic names.
Signals requiring no peripheral access, e.g. intermediate results, system tags etc.,
should be primarily declared as unlocated variables.
Variables Variables are used to exchange data within a section, between several sections and
between the program and the PLC.
Variables consist of at least one variable name and one data type.
If a variable is assigned a direct address (reference), it is called a located variable.
If the variable has no direct address assigned to it, it is called an unlocated variable.
If the variable is assigned with a derived data type, it is called a multi element
variable.
There are also constants and literals.
Warning If a critical status is detected during the processing of a FFB or a step (e.g. critical
input values or an exceeded time limit), a warning appears, which can be seen using
the Online → Event Viewer...menu command. For FFBs, the ENO remains set to
"1".
WORD WORD stands for the data type "bit sequence 16". Entries are made as base 2
literal, base 8 literal or base 16 literal. The length of the data element is 16 bits. A
numerical value range can not be assigned to this data type.
33002261 821
Glossary
822 33002261
Index
B
AC
A BMDI, 103
BROT, 105
AD16, 85
ADD, 87
Add 16 Bit, 85 C
Addition, 87
Calculated preset formula, 549
AD16, 85
Central Alarm Handler, 533
ADD, 87
Changing the Sign of a Floating Point
Advanced Calculations, 518
Number, 187
Analog Input, 525
Check Sum, 115
Analog Output, 539
CHS, 109
Analog Values, 45
CKSM, 115
AND, 89
Closed Loop Control, 45
ASCII Functions
CMPR, 119
READ, 669
Coils, 73
WRIT, 771
Communications
Average Weighted Inputs Calculate, 543
MSTR, 447
COMP, 123
B Compare Register, 119
Complement a Matrix, 123
Base 10 Antilogarithm, 171
Comprehensive ISA Non Interacting PID,
Base 10 Logarithm, 247 571
BCD, 93 Configure Hot Standby, 109
Binary to Binary Code, 93
Contacts, 73
Bit Control, 501
Convertion
Bit pattern comparison
BCD to binary, 93
CMPR, 119
binary to BCD, 93
Bit Rotate, 105
BLKM, 95
BLKT, 99
Block Move, 95
Block Move with Interrupts Disabled, 103
Block to Table, 99
33002261 823
Index
824 33002261
Index
33002261 825
Index
IMIO, 387 L
Immediate I/O, 387
LAB, 411
IMOD, 393
Label for a Subroutine, 411
Indirect Block Read, 369
Limiter for the Pv, 577
Indirect Block Write, 371
LL984
Input Compare, 373
AD16, 85
Input Selection, 635
ADD, 87
Installation of DX Loadables, 71
AND, 89
Instruction
BCD, 93
Coils, Contacts and Interconnects, 73
BLKM, 95
Instruction Groups, 33
BLKT, 99
ASCII Communication Instructions, 35
BMDI, 103
Coils, Contacts and Interconnects, 44
BROT, 105
Counters and Timers Instructions, 35
CHS, 109
Fast I/O Instructions, 36
CKSM, 115
Loadable DX, 37
Closed Loop Control / Analog Values, 45
Math Instructions, 38
CMPR, 119
Matrix Instructions, 40
Coils, Contacts and Interconnects, 73
Miscellaneous, 41
COMP, 123
Move Instructions, 42
DCTR, 127
Overview, 34
DIOH, 129
Skips/Specials, 43
DIV, 133
Special Instructions, 44
DLOG, 137
Integer - Floating Point Subtraction, 303
DRUM, 143
Integer + Floating Point Addition, 167
DV16, 149
Integer Divided by Floating Point, 231
EMTH, 153
Integer to Floating Point, 407
EMTH-ADDDP, 159
Integer x Floating Point Multiplication, 263
EMTH-ADDFP, 163
Integer-Floating Point Comparison, 195
EMTH-ADDIF, 167
Integer-to-Floating Point Conversion, 207
EMTH-ANLOG, 171
Integrate Input at Specified Interval, 567
EMTH-ARCOS, 175
Interconnects, 73
EMTH-ARSIN, 179
Interrupt Disable, 379
EMTH-ARTAN, 183
Interrupt Enable, 383
EMTH-CHSIN, 187
Interrupt Handling, 67
EMTH-CMPFP, 191
Interrupt Module Instruction, 393
EMTH-CMPIF, 195
Interrupt Timer, 401
EMTH-CNVDR, 199
ISA Non Interacting PI, 603
EMTH-CNVFI, 203
ITMR, 401
EMTH-CNVIF, 207
ITOF, 407
EMTH-CNVRD, 211
EMTH-COS, 215
J EMTH-DIVDP, 219
EMTH-DIVFI, 223
JSR, 409
EMTH-DIVFP, 227
Jump to Subroutine, 409
EMTH-DIVIF, 231
826 33002261
Index
33002261 827
Index
LL984 Math
SU16, 733 AD16, 85
SUB, 735 ADD, 87
Subroutine Handling, 69 BCD, 93
T.01 Timer, 747 DIV, 133
T-->R, 739 DV16, 149
T-->T, 743 FTOI, 351
T0.1 Timer, 749 ITOF, 407
T1.0 Timer, 753 MU16, 495
T1MS Timer, 757 MUL, 497
TBLK, 763 SU16, 733
TEST, 767 SUB, 735
UCTR, 769 TEST, 767
WRIT, 771 Matrix
XMIT, 777 AND, 89
XMRD, 787 BROT, 105
XMWT, 791 CMPR, 119
XOR, 795 COMP, 123
LOAD, 415 MBIT, 427
Load Flash, 415 NBIT, 501
Load the Floating Point Value of "Pi", 267 NCBT, 503, 505
Loadable DX OR, 513
CHS, 109 RBIT, 667
DRUM, 143 SBIT, 681
ESI, 311 SENS, 689
EUCA, 331 XOR, 795
HLTH, 353 MBIT, 427
ICMP, 373 MBUS, 431
Installation, 71 MBUS Transaction, 431
MAP 3, 419 Miscellaneous
MBUS, 431 CKSM, 115
MRTM, 441 DLOG, 137
NOL, 507 EMTH, 153
PEER, 645 EMTH-ADDDP, 159
XMIT, 777 EMTH-ADDFP, 163
Logarithmic Ramp to Set Point, 631 EMTH-ADDIF, 167
Logical And, 89 EMTH-ANLOG, 171
Logical OR, 513 EMTH-ARCOS, 175, 215
Look-up Table, 585 EMTH-ARSIN, 179
EMTH-ARTAN, 183
EMTH-CHSIN, 187
M EMTH-CMPFP, 191
MAP 3, 419 EMTH-CMPIF, 195
MAP Transaction, 419 EMTH-CNVDR, 199
Master, 447 EMTH-CNVFI, 203
828 33002261
Index
33002261 829
Index
O PCFL-LIMIT, 577
PCFL-LIMV, 581
ON/OFF Values for Deadband, 597
PCFL-LKUP, 585
One Hundredth Second Timer, 747
PCFL-LLAG, 589
One Millisecond Timer, 757
PCFL-MODE, 593
One Second Timer, 753
PCFL-ONOFF, 597
One Tenth Second Timer, 749
PCFL-PI, 603
OR, 513
PCFL-PID, 609
PCFL-RAMP, 615
P PCFL-RATE, 621
PCFL-RATIO, 625
PCFL, 517 PCFL-RMPLN, 631
PCFL Subfunctions PCFL-SEL, 635
General, 47 PCFL-TOTAL, 639
PCFL-AIN, 525 PCFL-TOTAL, 639
PCFL-ALARM, 533 PEER, 645
PCFL-AOUT, 539 PEER Transaction, 645
PCFL-AVER, 543 PID Algorithms, 609
PCFL-CALC, 549 PID Example, 51
PCFL-DELAY, 553 PID2, 649
PCFL-EQN, 559 PID2 Level Control Example, 55
PCFL-INTEG, 567 Process Control Function Library, 517
PCFL-KPID, 571 Process Square Root, 287
PCFL-LIMIT, 577 Process Variable, 46
PCFL-LIMV, 581 Proportional Integral Derivative, 649
PCFL-LKUP, 585 Put Input in Auto or Manual Mode, 593
PCFL-LLAG, 589
PCFL-MODE, 593
PCFL-ONOFF, 597 R
PCFL-PI, 603
R --> T, 663
PCFL-PID, 609
Raising a Floating Point Number to an
PCFL-RAMP, 615
Integer Power, 271
PCFL-RATE, 621
Ramp to Set Point at a Constant Rate, 615
PCFL-RATIO, 625
RBIT, 667
PCFL-RMPLN, 631
READ, 669
PCFL-SEL, 635
MSTR, 458
PCFL-Subfunction
Read, 669
PCFL-AIN, 525
READ/WRIT Operations, 59
PCFL-ALARM, 533
Register to Table, 663
PCFL-AOUT, 539
Regulatory Control, 518
PCFL-AVER, 543
Reset Bit, 667
PCFL-CALC, 549
RET, 675
PCFL-DELAY, 553
Return from a Subroutine, 675
PCFL-EQN, 559
PCFL-INTEG, 567
PCFL-KPID, 571
830 33002261
Index
S PCFL-SEL, 635
PCFL-TOTAL, 639
SAVE, 677
PCPCFL-INTEGFL, 567
Save Flash, 677
PID2, 649
SBIT, 681
STAT, 705
SCIF, 683
SRCH, 701
Search, 701
STAT, 705
SENS, 689
Status, 705
Sense, 689
SU16, 733
Sequential Control Interfaces, 683
SUB, 735
Set Bit, 681
Subroutine Handling, 69
Set Point Vaiable, 46
Subtract 16 Bit, 733
Skip (Constants), 693
Subtraction, 735
Skip (Registers), 697
Support of the ESI Module, 311
Skips / Specials
RET, 675
SKPC, 693 T
SKPR, 697
T.01 Timer, 747
Skips/Specials
T-->R, 739
JSR, 409
T-->T, 743
LAB, 411
T0.1 Timer, 749
SKPC, 693
T1.0 Timer, 753
SKPR, 697
T1MS Timer, 757
Special
Table to Block, 763
DIOH, 129
Table to Register, 739
PCFL, 517
Table to Table, 743
PCFL-, 539
TBLK, 763
PCFL-AIN, 525
TCP/IP Ethernet Statistics
PCFL-ALARM, 533
MSTR, 485
PCFL-AVER, 543
TEST, 767
PCFL-CALC, 549
Test of 2 Values, 767
PCFL-DELAY, 553
Time Delay Queue, 553
PCFL-EQN, 559
Totalizer for Metering Flow, 639
PCFL-KPID, 571
PCFL-LIMIT, 577
PCFL-LIMV, 581 U
PCFL-LKUP, 585
PCFL-LLAG, 589 UCTR, 769
PCFL-MODE, 593 Up Counter, 769
PCFL-ONOFF, 597
PCFL-PI, 603
PCFL-PID, 609
V
PCFL-RAMP, 615 Velocity Limiter for Changes in the Pv, 581
PCFL-RATE, 621
PCFL-RATIO, 625
PCFL-RMPLN, 631
33002261 831
Index
W
WRIT, 771
Write, 771
MSTR, 456
X
XMIT, 777
XMIT Communication Block, 777
XMRD, 787
XMWT, 791
XOR, 795
832 33002261