Modicon Libraries General Purpose

EIO0000002093 04/2020

Modicon Libraries General

Purpose
Process Components User Guide
04/2020
EIO0000002093.08

www.schneider-electric.com
 The information provided in this documentation contains general descriptions and/or technical
characteristics of the performance of the products contained herein. This documentation is not
intended as a substitute for and is not to be used for determining suitability or reliability of these
products for specific user applications. It is the duty of any such user or integrator to perform the
appropriate and complete risk analysis, evaluation and testing of the products with respect to the
relevant specific application or use thereof. Neither Schneider Electric nor any of its affiliates or
subsidiaries shall be responsible or liable for misuse of the information contained herein. If you
have any suggestions for improvements or amendments or have found errors in this publication,
please notify us.
You agree not to reproduce, other than for your own personal, noncommercial use, all or part of
this document on any medium whatsoever without permission of Schneider Electric, given in
writing. You also agree not to establish any hypertext links to this document or its content.
Schneider Electric does not grant any right or license for the personal and noncommercial use of
the document or its content, except for a non-exclusive license to consult it on an "as is" basis, at
your own risk. All other rights are reserved.
All pertinent state, regional, and local safety regulations must be observed when installing and
using this product. For reasons of safety and to help ensure compliance with documented system
data, only the manufacturer should perform repairs to components.
When devices are used for applications with technical safety requirements, the relevant
instructions must be followed.
Failure to use Schneider Electric software or approved software with our hardware products may
result in injury, harm, or improper operating results.
Failure to observe this information can result in injury or equipment damage.
© 2020 Schneider Electric. All rights reserved.

2 EIO0000002093 04/2020
 Table of Contents

Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Part I Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 1 Process Control Expert Components . . . . . . . . . . . . . . . 27
List of Function Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Chapter 2 General Function Block Concepts . . . . . . . . . . . . . . . . . 31
Modularity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Function Block Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Set-Point Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Simulation and Interlocking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Part II Signal Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Chapter 3 AISignalCond1 and AISignalCondReal1 - Analog
Input Signal Conditioning . . . . . . . . . . . . . . . . . . . . . . . . 41
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
EFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Obtaining the Module Status When Mapped to X80 I/O Module . . . . . 46
Chapter 4 AOSignalCond - Analog Output Signal conditioning. . . 49
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Chapter 5 CounterSignalCondUInt and CounterSignalCon-
dUDInt - Counter Signal Conditioning . . . . . . . . . . . . . . 55
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
EFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Chapter 6 DISignalCond1 - Digital Input Signal Conditioning . . . 61
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
EFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

EIO0000002093 04/2020 3
 Chapter 7 DOSignalCond - Digital Output Signal Conditioning. . . . 67
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Chapter 8 AHISIGNAL - HART Input Signal Conditioning (Advantys) 73
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Chapter 9 AISignalHart1 - HART Input Signal Conditioning
(M580) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
EFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Chapter 10 ACALC - Analog Calculation . . . . . . . . . . . . . . . . . . . . . . . 87
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Chapter 11 AALARM - Analog Alarm . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Chapter 12 AINPUT - Analog Input Conditioning . . . . . . . . . . . . . . . . 103
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

4 EIO0000002093 04/2020
 Chapter 13 AINPUT1 - Configurable Range Analog Input
Conditioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Chapter 14 ALINEAR - Linear Interpolation. . . . . . . . . . . . . . . . . . . . 119
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Chapter 15 AOUTPUT - Analog Output Conditioning . . . . . . . . . . . . . 125
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Chapter 16 AOUTPUTLP - Local Panel for Analog Output Conditioning 135
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Chapter 17 DCALC - Digital Calculation . . . . . . . . . . . . . . . . . . . . . . . 147
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

EIO0000002093 04/2020 5
 Chapter 18 DINPUT - Digital Input Conditioning . . . . . . . . . . . . . . . . . 153
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Chapter 19 DOUTPUT - Digital Output Conditioning . . . . . . . . . . . . . . 161
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Chapter 20 MAINPUT1 - Conditioning of Multiple Analog Inputs with
Configurable Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Chapter 21 STAHL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
21.1 STAHLAI8CH for STAHL 8-Channel Analog Input Modules . . . . . . . . 181
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
21.2 STAHLAO8CH for STAHL 8-Channel Analog Output Modules . . . . . . . 186
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
21.3 STAHLDI16CH for STAHL 16-Channel Digital Input Modules . . . . . . . 191
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

6 EIO0000002093 04/2020
 21.4 STAHLDO8 for STAHL 8-Channel Digital Output Modules. . . . . . . . . . 196
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
21.5 STAHLHARTVal4 - Processing of Four HART Values . . . . . . . . . . . . 201
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
21.6 STAHLHARTVal8 - Processing of Eight HART Values . . . . . . . . . . . . 206
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Chapter 22 TOTAL - Totalizing Function . . . . . . . . . . . . . . . . . . . . . . 211
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Part III On/Off Device Control. . . . . . . . . . . . . . . . . . . . . . . . 229
Chapter 23 DEVCTL - On/Off Device . . . . . . . . . . . . . . . . . . . . . . . . . 231
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Chapter 24 DEVLP - Local Panel for Controlling On/Off Devices . . . 245
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

EIO0000002093 04/2020 7
 Chapter 25 DEVMNT - Device Maintenance. . . . . . . . . . . . . . . . . . . . . 255
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Chapter 26 DUALOP - Dual Output . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Chapter 27 DUALOP1 - Dual Output with Dual Input . . . . . . . . . . . . . . 269
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Chapter 28 HVALVE - Manual Valve . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Chapter 29 MOTOR2 - 2 Speed/2 Rotation Direction Motor . . . . . . . . 283
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

8 EIO0000002093 04/2020
 Chapter 30 MOTOR2LP - Local Panel for Controlling 2 Speed/2
Rotation Direction Motors . . . . . . . . . . . . . . . . . . . . . . . . 301
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Chapter 31 MVALVED - Discrete Motorized Valve . . . . . . . . . . . . . . . 313
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Chapter 32 MVALVEDLP - Local Panel for Controlling Motorized
On/Off Valves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Chapter 33 DVALVE - Dual Output Valve . . . . . . . . . . . . . . . . . . . . . 335
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

EIO0000002093 04/2020 9
 Part IV Analog Device Control . . . . . . . . . . . . . . . . . . . . . . . 349
Chapter 34 CVALVE - Control Valve with Position Feedback . . . . . . . 351
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Chapter 35 CVALVELP - Local Panel for Controlling Control Valves. . 363
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Chapter 36 MVALVE - Motorized Valve with Positioner . . . . . . . . . . . . 375
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Chapter 37 MVALVELP - Local Panel for Controlling Motorized Valves 389
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Chapter 38 SDDEVCTL - Device with Variable Speed Drive . . . . . . . . 401
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

10 EIO0000002093 04/2020
 Chapter 39 SDDEVLP - Local Panel for Controlling Devices with a
Variable Speed Drive . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Part V Process Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Chapter 40 ARAMP - RAMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Chapter 41 IMCTL - IMC Controller with Monitoring Interface . . . . . 441
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Chapter 42 LDLGCTL - Lead/Lag Controller with Monitoring Interface 453
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Chapter 43 PIDCTL - PIDFF Regulator with Monitoring Interface. . . 463
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

EIO0000002093 04/2020 11
 Chapter 44 PIDMUX - Multiplexer for 2 Groups of PIDCTL Parameters 473
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Chapter 45 PWMCTL - Pulse Width Modulated Controller . . . . . . . . . . 481
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Chapter 46 RATIOCTL - Ratio Controller . . . . . . . . . . . . . . . . . . . . . . 489
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Chapter 47 SPLRGCTL - Split Range Controller . . . . . . . . . . . . . . . . . 497
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Chapter 48 STEP3CTL - 3 Step Controller/Positioner . . . . . . . . . . . . . 505
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

12 EIO0000002093 04/2020
 Part VI Sequential Control . . . . . . . . . . . . . . . . . . . . . . . . . . 515
Chapter 49 Sequential Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
Description of Sequential Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Definition of Status and Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Status Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Status Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
Chapter 50 SEQCTL1 - Advanced Sequential Control . . . . . . . . . . . . 525
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Chapter 51 Auxiliary Functions of Sequential Control . . . . . . . . . . . . 537
51.1 SEQTRANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
51.2 SEQFAILED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
51.3 SEQSTABLESTEP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
51.4 SEQSTEPDESC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
Chapter 52 SEQPARxx - Sequence Parameter Management . . . . . . 555
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562

EIO0000002093 04/2020 13
 Chapter 53 SEQCTL1 - Example of Use . . . . . . . . . . . . . . . . . . . . . . . 563
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
Reusable Sequence Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Part VII Batch Phase Manager . . . . . . . . . . . . . . . . . . . . . . . 573
Chapter 54 Batch Phase Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Description of Batch Phase Manager. . . . . . . . . . . . . . . . . . . . . . . . . . 576
Definition of Phase Statuses, Batch Phase Statuses, Phase
Commands and Batch Phase Commands . . . . . . . . . . . . . . . . . . . . . . 578
Status Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Status Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Chapter 55 IBPHASE - Individual Batch Phase Manager . . . . . . . . . . 585
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Chapter 56 Auxiliary Functions of Batch Phase . . . . . . . . . . . . . . . . . 601
56.1 IBTRANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
56.2 IBFAILED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
56.3 IBSTABLESTEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
56.4 IBSTEPDESC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618

14 EIO0000002093 04/2020
 Chapter 57 IBPARxx - Batch Phase Parameter Management . . . . . 619
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
Chapter 58 USERPHASExx - User Defined Process Logic . . . . . . . . 627
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Chapter 59 IBPHASE - Example of Use . . . . . . . . . . . . . . . . . . . . . . 631
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Reusable Phase Logic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Part VIII Auxiliary Functions . . . . . . . . . . . . . . . . . . . . . . . . . . 641
Chapter 60 ASELECT - Analog Signal Selector . . . . . . . . . . . . . . . . 643
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Chapter 61 ASELECT1 - Selector for Analog Signals with Monitoring
Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Chapter 62 CONDSUM - Summary of Conditions . . . . . . . . . . . . . . . . 659
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666

EIO0000002093 04/2020 15
 Chapter 63 CONDSUM1 - Interlock Condition Summary . . . . . . . . . . . . 667
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Chapter 64 MSGBOX - Messages to the Operator . . . . . . . . . . . . . . . . 675
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685

16 EIO0000002093 04/2020
 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, service, 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.

EIO0000002093 04/2020 17
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of
the use of this material.
A qualified person is one who has skills and knowledge related to the construction and operation
of electrical equipment and its installation, and has received safety training to recognize and avoid
the hazards involved.

BEFORE YOU BEGIN

Do not use this product on machinery lacking effective point-of-operation guarding. Lack of
effective point-of-operation guarding on a machine can result in serious injury to the operator of
that machine.

WARNING
UNGUARDED EQUIPMENT
 Do not use this software and related automation equipment on equipment which does not have
point-of-operation protection.
 Do not reach into machinery during operation.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

This automation equipment and related software is used to control a variety of industrial processes.
The type or model of automation equipment suitable for each application will vary depending on
factors such as the control function required, degree of protection required, production methods,
unusual conditions, government regulations, etc. In some applications, more than one processor
may be required, as when backup redundancy is needed.
Only you, the user, machine builder or system integrator can be aware of all the conditions and
factors present during setup, operation, and maintenance of the machine and, therefore, can
determine the automation equipment and the related safeties and interlocks which can be properly
used. When selecting automation and control equipment and related software for a particular
application, you should refer to the applicable local and national standards and regulations. The
National Safety Council's Accident Prevention Manual (nationally recognized in the United States
of America) also provides much useful information.
In some applications, such as packaging machinery, additional operator protection such as point-
of-operation guarding must be provided. This is necessary if the operator's hands and other parts
of the body are free to enter the pinch points or other hazardous areas and serious injury can occur.
Software products alone cannot protect an operator from injury. For this reason the software
cannot be substituted for or take the place of point-of-operation protection.

18 EIO0000002093 04/2020
 Ensure that appropriate safeties and mechanical/electrical interlocks related to point-of-operation
protection have been installed and are operational before placing the equipment into service. All
interlocks and safeties related to point-of-operation protection must be coordinated with the related
automation equipment and software programming.
NOTE: Coordination of safeties and mechanical/electrical interlocks for point-of-operation
protection is outside the scope of the Function Block Library, System User Guide, or other
implementation referenced in this documentation.

START-UP AND TEST

Before using electrical control and automation equipment for regular operation after installation,
the system should be given a start-up test by qualified personnel to verify correct operation of the
equipment. It is important that arrangements for such a check be made and that enough time is
allowed to perform complete and satisfactory testing.

WARNING
EQUIPMENT OPERATION HAZARD
 Verify that all installation and set up procedures have been completed.
 Before operational tests are performed, remove all blocks or other temporary holding means
used for shipment from all component devices.
 Remove tools, meters, and debris from equipment.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Follow all start-up tests recommended in the equipment documentation. Store all equipment
documentation for future references.
Software testing must be done in both simulated and real environments.
Verify that the completed system is free from all short circuits and temporary grounds that are not
installed according to local regulations (according to the National Electrical Code in the U.S.A, for
instance). If high-potential voltage testing is necessary, follow recommendations in equipment
documentation to prevent accidental equipment damage.
Before energizing equipment:
 Remove tools, meters, and debris from equipment.
 Close the equipment enclosure door.
 Remove all temporary grounds from incoming power lines.
 Perform all start-up tests recommended by the manufacturer.

EIO0000002093 04/2020 19
OPERATION AND ADJUSTMENTS
The following precautions are from the NEMA Standards Publication ICS 7.1-1995 (English
version prevails):
 Regardless of the care exercised in the design and manufacture of equipment or in the selection
and ratings of components, there are hazards that can be encountered if such equipment is
improperly operated.
 It is sometimes possible to misadjust the equipment and thus produce unsatisfactory or unsafe
operation. Always use the manufacturer’s instructions as a guide for functional adjustments.
Personnel who have access to these adjustments should be familiar with the equipment
manufacturer’s instructions and the machinery used with the electrical equipment.
 Only those operational adjustments actually required by the operator should be accessible to
the operator. Access to other controls should be restricted to prevent unauthorized changes in
operating characteristics.

20 EIO0000002093 04/2020
 About the Book

At a Glance

Document Scope
This document provides an operating information of a project developed by using Modicon
Libraries General Purpose.
This document does not cover any development procedures and internal functionality details.
Users of the Control Expert services are supposed to have a working knowledge in the
employment of Control Expert.

Validity Note
This document has been updated with the release of Modicon Libraries General Purpose 2020.
General Purpose Library of process components support the following software versions of
Control Expert:
 Control Expert V14.0 and V14.1

This library is compatible with the following hardware platforms:

 Quantum
 M340
 M580

EIO0000002093 04/2020 21
Product Related Information

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.
The application of this product requires expertise in the design and operation of control systems.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Allow only authorized personnel with expertise in the design and operation of control systems
to program, install, alter, and apply this product.
 Follow local and national safety codes and standards.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

22 EIO0000002093 04/2020
 Examples described in this manual are provided for information only.

WARNING
UNINTENDED EQUIPMENT OPERATION
Adapt examples that are given in this manual to the specific functions and requirements of your
industrial application before you implement them.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000002093 04/2020 23
24 EIO0000002093 04/2020
 Modicon Libraries General Purpose
Overview
EIO0000002093 04/2020

Part I
Overview

Overview

Overview
The Modicon Libraries General Purpose provides the function blocks (EFBs and DFBs) that are
pre-configured and tested by Schneider Electric and that are designed for automating a large
variety of processes.
The Control Expert components for process control provide the common required functions,
facilitating the development of control systems.
To automate and simplify the implementation process of control systems, you can use these DFBs
together with tools for code generation and for the synchronization of control and monitoring
subsystems.
This document describes the basic concepts and details behind each one of the function blocks
(EFBs and DFBs) for implementing the common cross-process and cross-market Control
functions.

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
1 Process Control Expert Components 27
2 General Function Block Concepts 31

EIO0000002093 04/2020 25
Overview

26 EIO0000002093 04/2020
 Modicon Libraries General Purpose
Process Control Expert Components
EIO0000002093 04/2020

Chapter 1
Process Control Expert Components

Process Control Expert Components

List of Function Blocks

List of Families
The function blocks described in this document are grouped by family.

EIO0000002093 04/2020 27
Process Control Expert Components

Description
The table lists the function blocks of each family:

Family Name Function Blocks Description

Signal processing AISignalCond1 (see page 41) Analog input signal conditioning.
and AISignalCondReal1
(see page 41)
AOSIGNALCOND (see page 49) Analog output signal conditioning.
CounterSignalCondUDInt and Counter signal conditioning.
CounterSignalCondUInt
(see page 55)
DISignalCond1 (see page 61) Digital input signal conditioning.
DOSIGNALCOND (see page 67) Digital output signal conditioning.
AHISIGNAL (see page 73) HART device signal mapping.
AISignalHart1 (see page 81) HART input signal conditioning (M580).
ACALC (see page 87) Analog calculations.
AALARM (see page 95) Analog alarm.
AINPUT (see page 103) Analog input conditioning.
AINPUT1 (see page 111) Configurable-range analog input conditioning.
ALINEAR (see page 119) Linearization.
AOUTPUT (see page 125) Analog output conditioning.
AOUTPUTLP (see page 135) Local panel for controlling analog outputs.
DCALC (see page 147) Digital calculations.
DINPUT (see page 153) Digital input conditioning.
DOUTPUT (see page 161) Digital output conditioning.
MAINPUT1 (see page 169) Multiple analog inputs with configurable range.
STAHL (see page 179) DFBs to process data of modules of the STAHL
IS1 Remote I/O system.
TOTAL (see page 211) Totalizer.

28 EIO0000002093 04/2020
 Process Control Expert Components

Family Name Function Blocks Description

On/Off device DEVCTL (see page 231) On-off device.
control
DEVLP (see page 245) Local panel for controlling on-off devices.
DEVMNT (see page 255) On-off device maintenance.
DUALOP (see page 263) Dual output.
DUALOP1 (see page 269) Dual output with dual input
HVALVE (see page 275) Hand valve.
MOTOR2 (see page 283) 2-speed/2-rotation direction motor.
MOTOR2LP (see page 301) Local panel for controlling 2-speed/2-rotation
direction motors.
MVALVED (see page 313) Motorized valve without positioner.
MVALAVEDLP (see page 323) Local panel for controlling motorized on-off
valves.
DVALVE (see page 335) Dual output valve
Analog device CVALVE (see page 351) Control valve.
control
CVALVELP (see page 363) Local panel for controlling control valves.
MVALVE (see page 375) Motorized valve with positioner.
MVALVELP (see page 389) Local panel for controlling motorized valves.
SDDEVCTL (see page 401) Motor with variable speed drive.
SDDEVLP (see page 417) Local panel for controlling devices with variable-
speed drive.
Process control ARAMP (see page 431) Ramp.
IMCTL (see page 441) Internal model controller.
LDLGCTL (see page 453) Lead-Lag controller.
PIDCTL (see page 463) PID controller.
PIDMUX (see page 473) Multiplexer for 2 groups of PIDCTL parameters.
PWMCTL (see page 481) Pulse width modulated controller.
RATIOCTL (see page 489) Ratio controller.
SPLRGCTL (see page 497) Split-range controller.
STEP3CTL (see page 505) 3-Step controller/positioner.
Sequential control SEQCTL1 (see page 525) Advanced sequential control.
SEQPARxx (see page 555) Sequential parameter management.
Batch Phase IBPHASE (see page 585) Individual Batch phase manager.
Manager
IBPARxx (see page 619) Batch phase parameter management.

EIO0000002093 04/2020 29
Process Control Expert Components

Family Name Function Blocks Description

Auxiliary functions ASELECT (see page 643) Analog signal selector.
ASELECT1 (see page 649) Analog signal selector with monitoring
variables.
CONDSUM (see page 659) Summary of conditions.
CONDSUM1 (see page 667) Interlock condition summary.
MSGBOX (see page 675) Messages to the operator.

30 EIO0000002093 04/2020
 Modicon Libraries General Purpose
General Concepts
EIO0000002093 04/2020

Chapter 2
General Function Block Concepts

General Function Block Concepts

Overview
This chapter describes the basic concepts that the process Control Expert components implement.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Modularity 32
Function Block Interface 33
Set-Point Management 35
Simulation and Interlocking 37

EIO0000002093 04/2020 31
General Concepts

Modularity

Overview
The function blocks are designed in such a way that the functions they implement are cumulative.
This way, you can incorporate the functions required for each specific case into the system.

Example
An example featuring three function blocks connected to each other to provide the necessary
functions to set up an on-off motor with interlocking and maintenance. A DEVCTL block (core
service) provides on-off motor functionalities. Additionally, you can integrate CONDSUM block
(optional service) to achieve interlock functionalities and DEVMNT block (optional service) to
provide maintenance functionalities (number of switch operations and hours of operation).

32 EIO0000002093 04/2020
 General Concepts

Function Block Interface

Overview
The function blocks for Process provide an interface that allows them to be configured, monitored,
and controlled both from the monitoring subsystem and the control subsystem (continuous and/or
sequential control).
The following interfaces are provided:
 Basic Configuration
 Continuous Control
 Sequential Control
 States and Monitoring

Basic Configuration
DFB input pins are usually connected to static data and recognized in engineering time (for
example, input channel range or limit switch enabling on an on-off device).

Continuous Control
DFB input and output pins:
 allow receiving commands from other blocks.
 provide block status to other blocks to enable implementing switching operations (for example,
remote set-point -RSP-), detected alarms (for example, high-level alarm -HIHI-), interlocking
(for example, activation of interlocking ILCK, or interlocking set-point -ILCKSP-), and so on.

Sequential Control
SC public and structured variable publishes the block status and allows its control from the control
sequences (commands not kept).

States and Monitoring

Depending on their types, the blocks feature up to 2 input/output pins that need to be connected
to variables used to maintain the pin states of the blocks. In addition, these variables allow the
commands and parameters received from the monitoring subsystem to be managed.
The frequently considered variables are:
 State (identified with the _ST suffix): These variables hold the state and control characteristics
used from the first monitoring subsystem level (dynamic symbols in the flowcharts).
 Configuration (identified with the _CFG suffix): These variables hold second-level information
for the parameter configuration of the block. This information is accessible from the monitoring
subsystem faceplates.

EIO0000002093 04/2020 33
General Concepts

Illustration
The following figure illustrates the previous provided interface.

34 EIO0000002093 04/2020
 General Concepts

Set-Point Management

Overview
The blocks for device control manage the set-points coming from the following sources according
to the owner:
 Operator
 Program

To avoid unwanted transitions in the set-point, continuously set the local set-points (Operator or
Program) to match the selected set-point.
In principle, the owner (Operator or Program) of the function block is not modified from the control
subsystem (through the program in the PLC) because the control subsystem is mechanism that
stops the Program from affecting the block. This is to confirm that the commands send towards the
block are those generated from the monitoring subsystem.

Operator
Operator/Local set-point commands received from the monitoring subsystem (Supervision). These
commands arrive at the function blocks.

EIO0000002093 04/2020 35
General Concepts

Program
Commands generated from the control program (Control).
Two different possible sources within the Program are as follows:
 Continuous Control (usually identified as a Program/Remote or Program/Cascade set-point):
The set-points generated from the Continuous Control strategies report to the function blocks
through a specific pin which is usually identified as Remote Set-Point (RSP). These commands
are given by level.
 Sequential Control (Local Set-Point): The set-points generated from the control sequences (for
example, for starting a continuous process section or a batch process stage) send the
commands to the function blocks through the public data structure of the block (SC – Sequential
Control – variable).

36 EIO0000002093 04/2020
 General Concepts

Simulation and Interlocking

Simulation
Function blocks connected to physical inputs (digital or analog) feature a simulation mode that
enables you to enter the value that needs to be considered as an input through the Supervision
system during operation.
This simulates the position of the associated device (DEVCTL and SDDEVCTL blocks) as the
position defined by the setpoint or interlock, regardless of the actual state of the physical inputs.
You can use this operating mode:
 In case an input loop is not working properly.
 To perform programming tests when the signals and instruments associated with the function
block are not available.

Interlocking
You can interlock function blocks that are connected to physical outputs (digital or analog) at a
determined configurable position.

EIO0000002093 04/2020 37
General Concepts

38 EIO0000002093 04/2020
 Modicon Libraries General Purpose
Signal Processing
EIO0000002093 04/2020

Part II
Signal Processing

Signal Processing

Overview
This part provides a detailed description of the functions, pins, pin layout, and variables of the
function blocks of the signal processing family.
These function blocks do not reflect any specific installation.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000002093 04/2020 39
Signal Processing

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
3 AISignalCond1 and AISignalCondReal1 - Analog Input Signal 41
Conditioning
4 AOSignalCond - Analog Output Signal conditioning 49
5 CounterSignalCondUInt and CounterSignalCondUDInt - Counter 55
Signal Conditioning
6 DISignalCond1 - Digital Input Signal Conditioning 61
7 DOSignalCond - Digital Output Signal Conditioning 67
8 AHISIGNAL - HART Input Signal Conditioning (Advantys) 73
9 AISignalHart1 - HART Input Signal Conditioning (M580) 81
10 ACALC - Analog Calculation 87
11 AALARM - Analog Alarm 95
12 AINPUT - Analog Input Conditioning 103
13 AINPUT1 - Configurable Range Analog Input Conditioning 111
14 ALINEAR - Linear Interpolation 119
15 AOUTPUT - Analog Output Conditioning 125
16 AOUTPUTLP - Local Panel for Analog Output Conditioning 135
17 DCALC - Digital Calculation 147
18 DINPUT - Digital Input Conditioning 153
19 DOUTPUT - Digital Output Conditioning 161
20 MAINPUT1 - Conditioning of Multiple Analog Inputs with Configurable Range 169
21 STAHL 179
22 TOTAL - Totalizing Function 211

40 EIO0000002093 04/2020
 Modicon Libraries General Purpose
AISignalCond1 and AISignalCondReal1
EIO0000002093 04/2020

Chapter 3
AISignalCond1 and AISignalCondReal1 - Analog Input Signal Conditioning

AISignalCond1 and AISignalCondReal1 - Analog Input

Signal Conditioning

Overview
This chapter describes the AISignalCond1 and AISignalCondReal1 EFBs.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 42
EFB Representation 43
Inputs 44
Outputs 45
Obtaining the Module Status When Mapped to X80 I/O Module 46

EIO0000002093 04/2020 41
AISignalCond1 and AISignalCondReal1

Description

General
AISignalCond1 and AISignalCondReal1 EFB acts as the hardware abstraction layer for
signal objects coming from the field to controllers.
The EFB allows processing the signal value and signal quality data. Depending on the data type
of the signal, this is either AISignalCond1 (for Int data type) or AISignalCondReal1 (for
Real data type).

42 EIO0000002093 04/2020
 AISignalCond1 and AISignalCondReal1

EFB Representation

Representation
These EFBs have been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 43
AISignalCond1 and AISignalCondReal1

Inputs

Input Parameter Description

Parameter Type EFB Description

CHANNELVALUE INT AISignalCond1 Channel value from an analog input
ARRAY [0..1] AISignalCondReal1 module.
OF WORD
ERROR BOOL AISignalCond1 Detected channel error signal from
AISignalCondReal1 an analog input module.
1 = Detected channel error.
HEALTH BOOL AISignalCond1 Inverted detected channel error
signal from module.
0 = Detected channel error.
MODULESTATUS BOOL AISignalCond1 Module status.
AISignalCondReal1 0 = Module not healthy.
Refer to Obtaining the Module
Status When Mapped to X80 I/O
Module (see page 46) for obtaining
the module status when mapped to
x80.
NOTMODULESTATUS BOOL AISignalCond1 Module status.
AISignalCondReal1 1 = Module not healthy.

COMSTATUS BOOL AISignalCond1 Communication status with module.

AISignalCondReal1 0 = Communication status not
healthy.
SIMMODE BOOL AISignalCond1 Simulation mode.
AISignalCondReal1 1 = Enable simulation.

SIMVALUE INT AISignalCond1 Simulation mode channel value.

ARRAY [0..1] AISignalCondReal1 When simulation is ON,
OF WORD SIGNALVALUE = SIMVALUE.

SIMFAILURE BOOL AISignalCond1 Simulation mode channel detected

AISignalCondReal1 failure value.
When simulation is ON,
SIGNALFAILURE = SIMFAILURE.

44 EIO0000002093 04/2020
 AISignalCond1 and AISignalCondReal1

Outputs

Output Parameter Description

Parameter Type EFB Description

SIGNALVALUE INT AISignalCond1 Signal value after quality check of channel,
REAL AISignalCondReal1 module and communication.

SIGNALFAILURE BOOL AISignalCond1 Detected signal failure due to a detected

AISignalCondReal1 channel or module or simulated channel error.

SIMULATION BOOL AISignalCond1 Simulation status.

AISignalCondReal1 1 = Simulation ON.

EIO0000002093 04/2020 45
AISignalCond1 and AISignalCondReal1

Obtaining the Module Status When Mapped to X80 I/O Module

Overview
The SignalFailure parameter indicates the health of each channel signal. When the signal is
mapped to an X80 I/O module, the value of the variable that is connected to the ModuleStatus
input of the signal conditioning EFB is true by default (the value is REF (PES_CONST_TRUE)). You
need to modify the generated logic to use the value of the MOD_HEALTH variable of the DDDT that
is created instead. This applies to the digital and analog input and output signal conditioning EFBs.
If you want to obtain the module status using module health, follow this procedure.

Module Status
After refine online of the control project, update the control project from the topological manager.
Use the module health provided by DDDT (Device Derived Data Types) variables for obtaining the
module status.
You can locate the MOD_HEALTH as shown in the following figure:

You can map the module health variable (MOD_HEALTH) in the following ways:
 Recommended method: By using the variable connected to the ModuleStatus pin of the
signal conditioning EFB. You can use the MOVE EFB to move the value of the MOD_HEALTH
variable to the variable that holds the module status (variable with S suffix)..

46 EIO0000002093 04/2020
 AISignalCond1 and AISignalCondReal1

 By replacing the variable holding the module status, which is connected to the ModuleStatus
pin of the signal conditioning EFB with the module health variable of the DDDT.

The following figure shows the ModuleStatus of channel 10:

The following figure shows the ModuleStatus of channel 11:

EIO0000002093 04/2020 47
AISignalCond1 and AISignalCondReal1

48 EIO0000002093 04/2020
 Modicon Libraries General Purpose
AOSignalCond
EIO0000002093 04/2020

Chapter 4
AOSignalCond - Analog Output Signal conditioning

AOSignalCond - Analog Output Signal conditioning

Overview
This chapter describes the AOSignalCond DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 50
DFB Representation 51
Inputs 52
Outputs 53

EIO0000002093 04/2020 49
AOSignalCond

Description

General
AOSIGNALCOND EFB acts as the hardware abstraction layer for signal objects coming from the
field to controllers.
The AOSIGNALCOND DFB allows processing the analog (Int data type) signal value and signal
quality data.
The AOSIGNALMOVE DFB allows processing the signal value only.

50 EIO0000002093 04/2020
 AOSignalCond

DFB Representation

Representation
These DFBs have been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 51
AOSignalCond

Inputs

Input Parameter Description

Parameter Type DFB Description

SIGNALVALUE INT AOSignalCond The SIGNALVALUE is the analog value coming from the
logic.
ERROR BOOL 1 = Channel detected error information from the card in
local rack.
HEALTH BOOL 1 = Channel health information from the card in X80 drop.
MODULESTATUS BOOL 1 = Module status information.
Refer to Obtaining the Module Status When Mapped to
X80 I/O Module (see page 46) for obtaining the module
status when mapped to x80.
NOTMODULESTATUS BOOL 1 = Negated status of the module is obtained (for
example, Advantys module).
COMSTATUS BOOL 1 = Communication status of the module.
IN INT AOSignalMove Signal value received from the logic.

52 EIO0000002093 04/2020
 AOSignalCond

Outputs

Output Parameter Description

Parameter Type DFB Description

CHANNELVALUE INT AOSignalCond Channel value after the module and
communication channel are checked
for quality.
SIGNALFAILURE BOOL 1 = The signal is not working properly
due to a non-operational channel,
module, or a communication
interruption.
OUT INT AOSignalMove Processed signal value.

EIO0000002093 04/2020 53
AOSignalCond

54 EIO0000002093 04/2020
 Modicon Libraries General Purpose
CounterSignalCondUInt and CounterSignalCondUDInt
EIO0000002093 04/2020

Chapter 5
CounterSignalCondUInt and CounterSignalCondUDInt - Counter Signal Conditioning

CounterSignalCondUInt and CounterSignalCon-

dUDInt - Counter Signal Conditioning

Overview
This chapter describes the CounterSignalCondUInt and CounterSignalCondUDInt EFBs.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 56
EFB Representation 57
Inputs 58
Outputs 59

EIO0000002093 04/2020 55
CounterSignalCondUInt and CounterSignalCondUDInt

Description

General
CounterSignalCondUInt and CounterSignalCondUDInt acts as the hardware abstraction layer
for signal objects coming from the field to controllers.
The EFB allows processing the signal value and signal quality data. Depending on the counter
channel data type of the signal, this is either CounterSignalCondUDInt (for UDINT data type)
or CounterSignalCondUInt (for UINT data type).

56 EIO0000002093 04/2020
 CounterSignalCondUInt and CounterSignalCondUDInt

EFB Representation

Representation
These EFBs have been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 57
CounterSignalCondUInt and CounterSignalCondUDInt

Inputs

Input Parameter Description

Parameter Type EFB Description

CHANNELVALUE UDINT CounterSignalCondUDInt Channel value from a counter
UINT CounterSignalCondUInt module.

ERROR BOOL CounterSignalCondUDInt Detected channel error signal from

CounterSignalCondUInt an analog input module.
1 = Detected channel error.
HEALTH BOOL CounterSignalCondUDInt Inverted detected channel error
CounterSignalCondUInt signal from module.
0 = Detected channel error.
MODULESTATUS BOOL CounterSignalCondUDInt Module status.
CounterSignalCondUInt 0 = Module not healthy.

NOTMODULESTATUS BOOL CounterSignalCondUDInt Module status.

CounterSignalCondUInt 1 = Module not healthy.

SIMMODE BOOL CounterSignalCondUDInt Simulation mode.

CounterSignalCondUInt 1 = Enable simulation.

SIMVALUE UDINT CounterSignalCondUDInt Simulation mode channel value.

UINT CounterSignalCondUInt When simulation is ON,
SIGNALVALUE = SIMVALUE.
SIMFAILURE BOOL CounterSignalCondUDInt Simulation mode channel detected
CounterSignalCondUInt failure value.
When simulation is ON,
SIGNALFAILURE = SIMFAILURE.

58 EIO0000002093 04/2020
 CounterSignalCondUInt and CounterSignalCondUDInt

Outputs

Output Parameter Description

Parameter Type EFB Description

SIGNALVALUE32 UDINT CounterSignalCondUDInt Signal value after quality check of
SIGNALVALUE16 UINT CounterSignalCondUInt channel, module and communication.

SIGNALFAILURE32 BOOL CounterSignalCondUDInt Detected signal failure due to a

SIGNALFAILURE16 CounterSignalCondUInt detected channel or module or
simulated channel error.
SIMULATION BOOL CounterSignalCondUDInt Simulation status.
CounterSignalCondUInt 1 = Simulation ON.

EIO0000002093 04/2020 59
CounterSignalCondUInt and CounterSignalCondUDInt

60 EIO0000002093 04/2020
 Modicon Libraries General Purpose
DISignalCond1
EIO0000002093 04/2020

Chapter 6
DISignalCond1 - Digital Input Signal Conditioning

DISignalCond1 - Digital Input Signal Conditioning

Overview
This chapter describes the DISignalCond1 EFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 62
EFB Representation 63
Inputs 64
Outputs 65

EIO0000002093 04/2020 61
DISignalCond1

Description

General
DISignalCond1 acts as the hardware abstraction layer for signal objects coming from the field to
controllers.
The DISignalCond1 EFB allows processing the digital signal value and signal quality data.

62 EIO0000002093 04/2020
 DISignalCond1

EFB Representation

Representation

EIO0000002093 04/2020 63
DISignalCond1

Inputs

Input Parameter Description

Parameter Type EFB Description

CHANNELVALUE BOOL DISignalCond1 1 = Channel value from a digital input module.
ERROR BOOL DISignalCond1 Detected channel error signal from an analog input
module.
1 = Detected channel error.
HEALTH BOOL DISignalCond1 Inverted detected channel error signal from
module.
0 = Detected channel error.
MODULESTATUS BOOL DISignalCond1 Module status.
0 = Module not healthy.
Refer to Obtaining the Module Status When
Mapped to X80 I/O Module (see page 46) for
obtaining the module status when mapped to x80.
NOTMODULESTATUS BOOL DISignalCond1 Module status.
1 = Module not healthy.
COMSTATUS BOOL DISignalCond1 Communication status with module.
0 = Communication status not healthy.
NEGATE BOOL DISignalCond1 Negates the channel value.
1 = SIGNALVALUE = Not CHANNELVALUE
SIMMODE BOOL DISignalCond1 Simulation mode.
1 = Enable simulation.
SIMVALUE BOOL DISignalCond1 Simulation mode channel value.
When simulation is ON, SIGNALVALUE =
SIMVALUE.
SIMFAILURE BOOL DISignalCond1 Simulation mode channel detected failure value.
When simulation is ON, SIGNALFAILURE =
SIMFAILURE.

64 EIO0000002093 04/2020
 DISignalCond1

Outputs

Output Parameter Description

Parameter Type EFB Description

SIGNALVALUE BOOL DISignalCond1 Signal value after quality check of channel,
module and communication.
SIGNALFAILURE BOOL DISignalCond1 Detected signal failure due to a detected
channel or module or simulated channel
error.
SIMULATION BOOL DISignalCond1 Simulation status.
1 = Simulation ON.

EIO0000002093 04/2020 65
DISignalCond1

66 EIO0000002093 04/2020
 Modicon Libraries General Purpose
DOSignalCond
EIO0000002093 04/2020

Chapter 7
DOSignalCond - Digital Output Signal Conditioning

DOSignalCond - Digital Output Signal Conditioning

Overview
This chapter describes the DOSignalCond DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 68
DFB Representation 69
Inputs 70
Outputs 71

EIO0000002093 04/2020 67
DOSignalCond

Description

General
DOSIGNALCOND acts as the hardware abstraction layer for signal objects coming from the field
to controllers.
The DOSIGNALCOND DFB allows processing the digital signal value and signal quality data.
The SIGNALMOVE DFB allows processing the digital signal value only.

68 EIO0000002093 04/2020
 DOSignalCond

DFB Representation

Representation
These DFBs have been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 69
DOSignalCond

Inputs

Input Parameter Description

Parameter Type DFB Description

SIGNALVALUE BOOL DOSignalCond 1 = Signal value coming from the
logic.
ERROR BOOL 1 = Channel detected error
information from the card in local
rack.
HEALTH BOOL 1 = Channel health information
from the card in X80 drop.
MODULESTATUS BOOL 1 = Module status information.
Refer to Obtaining the Module
Status When Mapped to X80 I/O
Module (see page 46) for
obtaining the module status
when mapped to x80.
NOTMODULESTATUS BOOL 1 = Negated status of the module
is obtained (for example,
Advantys module).
COMSTATUS BOOL 1 = Communication status of the
module.
NEGATE BOOL SignalMove 1 = Negates the signal value.
DOSignalCond
IN BOOL SignalMove 1 = Input.

70 EIO0000002093 04/2020
 DOSignalCond

Outputs

Output Parameter Description

Parameter Type DFB Description

CHANNELVALUE BOOL DOSignalCond 1 = Channel value after the module and
communication channel are checked for
quality.
SIGNALFAILURE BOOL 1 = The signal is not working properly
due to a non-operational channel,
module, or a communication
interruption.
OUT BOOL SignalMove 1 = Output.

EIO0000002093 04/2020 71
DOSignalCond

72 EIO0000002093 04/2020
 Modicon Libraries General Purpose
AHISIGNAL
EIO0000002093 04/2020

Chapter 8
AHISIGNAL - HART Input Signal Conditioning (Advantys)

AHISIGNAL - HART Input Signal Conditioning (Advantys)

Overview
This chapter describes the AHISIGNAL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 74
DFB Representation 75
Inputs 76
Outputs 77
Public Variables 79

EIO0000002093 04/2020 73
AHISIGNAL

Description

Overview
The AHISIGNAL DFB is used for HART devices that communicate with the controller through the
STB Island.
The function block maps the channel information from the STB to the device if the channel is
enabled and connected.

74 EIO0000002093 04/2020
 AHISIGNAL

DFB Representation

Representation
The DFB is designed for use with the FBD language of the controller.

EIO0000002093 04/2020 75
AHISIGNAL

Inputs

Input Parameter Description

Parameter Type Description

CHENABLE BOOL 1 = Allows you to enable the channel.
CHRESET BOOL 1 = Resets the channel in case of minor/major differences.
MODULESTATUS BOOL 1 = Status of the controller modules.
NOTMODULESTATUS BOOL 1 = Status of the Advantys module.
COMMSTATUS BOOL 1 = Communication status of the modules.
PVEN BOOL 1 = Enables PV in the channel.
CHPV ARRAY [0..1] Primary variable value.
of WORD
PVERROR BOOL 1 = Indicates a detected error.
The pin is negated.
SVEN BOOL 1 = Enables SV in the channel.
CHSV ARRAY [0..1] Secondary variable value.
of WORD
SVERROR BOOL 1 = Indicates a detected error.
The pin is negated.
TVEN BOOL 1 = Enables TV in the channel.
CHTV ARRAY [0..1] Tertiary variable value.
of WORD
TVERROR BOOL 1 = Indicates a detected error.
The pin is negated.
QVEN BOOL 1 = Enables QV in the channel.
CHQV ARRAY [0..1] Quaternary variable value.
OF WORD
QVERROR BOOL 1 = Indicates a detected error.
The pin is negated.
CHSTATUS BYTE Provides the channel status of each STBAHI 8321 module.
DEVSTATUS ARRAY [0...1] Represents the status of the instrument connected to the
of INT specified channel.
Refer to the STATUS output pin (see page 77).

76 EIO0000002093 04/2020
 AHISIGNAL

Outputs

Output Parameter Description

Parameter Type Description

CHENCMD BOOL 1 = maps the input pin CHENABLE on the output side.
CHENABLED BOOL 1 = Enabled when the HART channel is enabled
through the Advantys.
CHCONNECTED BOOL 1 = Indicates whether the channel is enabled and
connected to the HART instrument. Use this signal in
each input module to know whether the physical node
is present on the bus.
This variable is found in HART communication.
WARNING BOOL 1 = Enabled when either parameter of the
DEVSTATUS input is set:
 PVOUTOFLIM
 NONPVOUTOFLIM
 FIELDDEVICEMALFUNCTION

FAIL BOOL 1 = Enabled when either parameter of the

DEVSTATUS input is set:
 BUFFEROVERFLOW
 LONGITUDINALPARITYERROR
 FRAMINGERROR
 OVERRUNERROR
 VERTICALPARITYERROR
 COMMERROR

RESETING BOOL 1 = Resets detected error.

For more information, refer to the timing diagram
(see page 79).
PVENABLED BOOL 1 = PV is enabled in the channel.
PV REAL Primary variable value.
PVFAILURE BOOL 1 = Indicates PVERROR is reset.
SVENABLED BOOL 1 = SV is enabled in the channel.
SV REAL Secondary variable value.
SVFAILURE BOOL 1 = Indicates SVERROR is reset.
TVENABLED BOOL 1 = TV is enabled in the channel.
TV REAL Tertiary variable value.
TVFAILURE BOOL 1 = Indicates TVERROR is reset.
QVENABLED BOOL 1 = QV is enabled in the channel.
QV REAL Quaternary variable value.

EIO0000002093 04/2020 77
AHISIGNAL

Parameter Type Description

QVFAILURE BOOL 1 = Indicates QVERROR is reset.
HARTMES HART_IN_DDT Given as input to the INPUTS pin of HART device
only if the channel is connected and enabled.
The table describes the HART_IN_DDT structure:
Parameter Type Description
PV REAL Primary variable.
SV REAL Secondary variable.
TV REAL Tertiary variable.
QV REAL Quaternary variable.
CHANNELSTATUS WORD Channel status of each
STBAHI 8321 HART interface module.
DEVICESTATUS WORD Status of the instrument connected to the
specified channel.
STATUS DEVSTATUS_DDT This pin contains the structure of the
device/instrument status data of the Advantys HART
channel.
The table describes the DEVSTATUS_DDT
structure:
Parameter Type Description
BUFFEROVERFLOW BOOL 1 = Buffer overflow.
LONGITUDINALPARITYERROR BOOL 1 = Longitudinal parity diagnostic
information.
FRAMINGERROR BOOL 1 = Framing diagnostic information.
OVERRUNERROR BOOL 1 = Overrun diagnostic information.
VERTICALPARITYERROR BOOL 1 = Vertical parity diagnostic information.
COMMERROR BOOL 1 = Communication diagnostic information.
PVOUTOFLIM BOOL 1 = PV out of limits.
NONPVOUTOFLIM BOOL 1 = Non PV out of limits.
OUTCURRENTSATURATED BOOL 1 = Output current saturated.
OUTCURRENTFIXED BOOL 1 = Output current fixed.
MORESTATUSAVAILABLE BOOL 1 = More status available.
COLDSTART BOOL 1 = Cold start.
CONFIGCHANGED BOOL 1 = Configuration changed.
FIELDDEVICEMALFUNCTION BOOL 1 = Inoperable field device.

78 EIO0000002093 04/2020
 AHISIGNAL

Public Variables

Public Variable Description

Parameter Type Description

COMMANDCTRLWINDOW TIME Control time for operations. The block waits for the device to carry out the
operations during this time.
When CHRESET is set (TRUE) or channel reset is carried out during the
time of major/minor differences in the channel, RESETING pin resets to
TRUE. If the abnormal condition (only valid for major/minor differences on
the Advantys island AHI8321 channels) continues after the period
specified by COMMANDCTRLWINDOW has elapsed, the RESETING output
resets (FALSE). When the period specified by COMMANDCTRLWINDOW has
started, any reset in the minor/major differences in the channel is not
considered until the period ends.

Timing diagram:

EIO0000002093 04/2020 79
AHISIGNAL

80 EIO0000002093 04/2020
 Modicon Libraries General Purpose
AISignalHart1
EIO0000002093 04/2020

Chapter 9
AISignalHart1 - HART Input Signal Conditioning (M580)

AISignalHart1 - HART Input Signal Conditioning (M580)

Overview
This chapter describes the AISignalHart1 EFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 82
EFB Representation 83
Inputs 84
Outputs 85

EIO0000002093 04/2020 81
AISignalHart1

Description

General
The AISignalHart1 EFB is used to read DTM generated extended HART data from BMEAHI
and BMEAHO modules.

82 EIO0000002093 04/2020
 AISignalHart1

EFB Representation

Representation
The EFB is designed for use with the FBD language of the controller.

EIO0000002093 04/2020 83
AISignalHart1

Inputs

Input Parameter Description

Parameter Type Description

CHANNELVALUE REAL Channel Value in REAL from HART module.
HEALTH BOOL Inverted channel detected error signal from module.
1 = Channel in detected error.
MODULESTATUS BOOL Module status.
0 = Module not healthy.
SIMMODE BOOL Simulation mode.
1 = Enable simulation.
SIMVALUE BOOL Simulation mode channel value.
When simulation is ON, SIGNALVALUE = SIMVALUE.
SIMFAILURE BOOL Simulation mode channel detected failure value.
When simulation is ON, SIGNALFAILURE = SIMFAILURE.

84 EIO0000002093 04/2020
 AISignalHart1

Outputs

Output Parameter Description

Parameter Type Description

SIGNALVALUE REAL Signal value after quality check of channel,
module and communication.
SIGNALFAILURE BOOL Detected signal failure due to a detected
channel or module or simulated channel error.
SIMULATION BOOL Simulation status.
1 = Simulation ON.

EIO0000002093 04/2020 85
AISignalHart1

86 EIO0000002093 04/2020
 Modicon Libraries General Purpose
ACALC
EIO0000002093 04/2020

Chapter 10
ACALC - Analog Calculation

ACALC - Analog Calculation

Overview
This chapter describes the ACALC DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 88
DFB Representation 89
Inputs 90
Outputs 91
Public Variables 93

EIO0000002093 04/2020 87
ACALC

Description

General
The ACALC DFB is used to perform calculations based on an analog signal.
The DFB can perform the following calculations:
 Derivative Rate of Change (ROC)
 Totalizing (integral with the trapezoidal rule)
 Average
 Minimum
 Maximum

The DFB memorizes up to a maximum of 20 samples of the measurement (Present Value PV), and
calculations are performed based on them.
This DFB can supplement the General Purpose Library AINPUT DFB providing calculations based
on previously scaled analog inputs.
In turn, the DFB can provide calculated data to AINPUT DFBs (configured with an external PV
input) to provide the standard interface to the monitoring subsystem so that these calculations can
be represented in the user interface or detected alarms can be applied through AALARM-type
DFBs.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Derivative The slope of the measurement development is calculated with linear regression.
Totalizing The totalization (for example, for flows) is calculated with the trapezoidal rule algorithm.
Average Calculates the average of the values memorized in the DFB.
Maximum Calculates the maximum value of the measurement among those stored in the DFB.
Minimum Calculates the minimum value of the measurement among those stored in the DFB.The DFB
allows alarm monitoring to be enabled/disabled individually.

NOTE: The function block uses the Freerun function for time calculations. Therefore, the ACALC
DFB is only available if the controller CPU supports this function.

88 EIO0000002093 04/2020
 ACALC

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 89
ACALC

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL 0 = Indicates rising edge on this input is detected, the DFB internal timers are
reset and the first sample (time and value) is stored in the memory.
NOTE: The input is not reset (0) by the DFB.
PV REAL Calculated value of the measurement in engineering units.
SCANRATE TIME Allows you to configure the sample acquisition time.
The DFB takes a sample each time a time equal to or greater than the one
configured for this input has elapsed. For calculation purposes, the time elapsed
between one DFB execution and another is taken into account.
NOTE: You need to verify that the DFB execution parameters are compatible
with the time configured in the SCANRATE parameter; this allows the DFB to run
with a high enough frequency to carry out sampling with the configured time
including latency times. In any case, the DFB considers any possible execution
delays regarding the theoretical time adjusted in this parameter when it comes
to the calculations.
NUMSAMPLES UINT Maximum number of samples that need to be stored and that are used in the
calculations.
Configuration range: From 2 to 20
Default value: 20
NOTE: During the first runs of the DFB, a smaller number of samples than
those configured may be used.
KROC REAL Conversion factor applied to the derivative calculation ROC output pin
(see page 91).
Allows the derivative to be calculated in the desired engineering units.
If this signal is 0, the DFB applies a default factor of 1.0.
KTOTAL REAL Conversion factor applied to the totalizing calculation TOTAL output pin
(see page 91).
Allows the totalization to be calculated in the desired engineering units.
If this signal is 0, the DFB applies a default factor of 1.0.

90 EIO0000002093 04/2020
 ACALC

Outputs

Output Parameter Description

Parameter Type Description

ROC REAL The derivative is calculated (in engineering units/sec for a
KROC of 1.0) through linear regression.
Calculation is based on the formula provided is this topic.
TOTAL REAL Totalization is calculated with a trapezoidal sum between the
current and the previous sample (Therefore, it is only
calculated starting with the second sample and is 0 in the
meantime)
Calculation is based on the formula provided is this topic.
AVERAGE REAL Calculates the average value of the stored samples. It is
calculated as the measurement is present at the PV input
during the first run.
MIN REAL Calculates the minimum value among the stored samples. It
is calculated as the measurement is present at the PV input
during the first run.
MAX REAL Calculates the maximum value among the stored samples.
It is calculated as the measurement is present at the PV input
during the first run.

Calculation formula for the derivative:

¤ n t r PV
KROC r ¥
£ £ t r £ PV ³´
2
¥¦ n£ t 2 £ t ´µ

Where:
KROC Conversion factor applied to the derivative calculation. Refer to the KTOTAL input
(see page 90).
n Number of samples (up to 20 after the whole internal sample table is loaded).
t Relative time elapsed from the first sample to the sample used in the calculation (corresponding
PV value).
PV Sample value.

EIO0000002093 04/2020 91
ACALC

Calculation formula for the totalization:

¤ PV PV0 ³
KTOTAL r t1 t0 r ¥ 1 ´µ
¦ 2

Where:
KTOTAL Refer to the KROC input (see page 90).
t1 Time in which the current sample is taken.
t0 Time in which the previous sample was taken.
PV1 Value of the current measurement.
PV0 Value of the previous measurement.
The calculation is carried out with a value relative to 0, that is, values under 0 will be deducted from
the cumulative calculation. The calculation is only performed if it is enabled and resetting is
available (refer to the SC public variable (see page 93)).

92 EIO0000002093 04/2020
 ACALC

Public Variables

Public Variable Description

Variable Type Description

SC ACALC_SC_DDT Provides the data frequently needed data to monitor the
status of the alarms from the sequential control.

ACALC_SC_DDT Type

Name Type Description

PV REAL Read-only access. Refer to the PV input pin
(see page 90).
ROC REAL Read-only access (see page 91).
TOTAL REAL Read-only access (see page 91).
AVERAGE REAL Read-only access (see page 91).
MIN REAL Read-only access (see page 91).
MAX REAL Read-only access (see page 91).
TOTALEN BOOL Read/write access.
1 = Enables the totalizing calculation
0 = Disables the totalizing calculation. Does not set the
totalizer to 0.
TOTALRST BOOL Read/write access.
1 = Resets the totalized value (TOTAL output pin).
0 = The signal is processed.

EIO0000002093 04/2020 93
ACALC

94 EIO0000002093 04/2020
 Modicon Libraries General Purpose
AALARM
EIO0000002093 04/2020

Chapter 11
AALARM - Analog Alarm

AALARM - Analog Alarm

Overview
This chapter describes the AALARM DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 96
DFB Representation 97
Inputs 98
Outputs 100
Inputs/Outputs 101
Public Variables 102

EIO0000002093 04/2020 95
AALARM

Description

General
The AALARM DFB is used to evaluate detected timed alarms associated with an analog signal.
The DFB provides detected alarm functions by level (very high, high, low and/or very low) and by
deviation in relation to a set-point value.
This evaluation can be activated/deactivated individually according to the specific needs of the
process both from the continuous and sequential control strategies implemented in the controller
as well as from the monitoring system.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Level alarm Evaluates detected timed alarms by level. The detected alarm connection can
be timed. Timing and/or hysteresis can be applied to the disconnection.
Deviation Evaluates the detected alarm for maximum deviation in relation to a set-point.
alarm
Enabling The DFB allows detected alarm monitoring to be enabled/disabled
individually.

96 EIO0000002093 04/2020
 AALARM

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 97
AALARM

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL 1 = Indicates rising edge is detected on this input, the DFB internal
timers are reset and detected alarms are set to 0.
PV REAL Value of the measurement with which the detected alarms are
evaluated.
HHWATCH BOOL 1 = Allows very-high-level alarm monitoring to be enabled or
disabled depending on the dynamic conditions of the process.
HWATCH BOOL 1 = Allows high-level alarm monitoring to be enabled or disabled
depending on the dynamic conditions of the process.
DWATCH BOOL 1 = Allows dynamic alarm monitoring to be enabled (1) or disabled
(0) depending on the dynamic conditions of the process.
LWATCH BOOL 1 = Allows low-level alarm monitoring to be enabled (1) or disabled
(0) depending on the dynamic conditions of the process.
LLWATCH BOOL 1 = Allows very-low-level alarm monitoring to be enabled (1) or
disabled (0) depending on the dynamic conditions of the process.
TONSP TIME Timing set-point for connecting the detected alarms.
TOFFSP TIME Timing set-point for disconnecting the detected alarms.
HYSTSP REAL Hysteresis set-point for disconnecting the detected alarms (in
engineering units).
AALARM_CFG AALARM_CFG_DDT Configuration data necessary for evaluating the detected alarms.
This data can be defined from the monitoring subsystem or from the
control program.

98 EIO0000002093 04/2020
 AALARM

AALARM_CFG Type

Name Type Description

SPHH REAL Very-high-level set-point in engineering units (those associated with the corresponding PV)).
SPH REAL High-level set-point in engineering units (those associated with the corresponding PV)).
SP REAL set-point level used as a reference for deviation alarm evaluation in engineering units (those
associated with the corresponding PV)).
SPD REAL Set-point for the maximum deviation allowed in the measurement in relation to the set-point
configured in AALARM_CFG.SP in engineering units (those associated with the
corresponding PV).
SPL REAL Low-level set-point in engineering units (those associated with the corresponding PV)).
SPLL REAL Very-low-level set-point in engineering units (those associated with the corresponding PV)).
CFGW WORD DFB configuration word. Detected alarms configuration.
Bit 0 ENHH Enables very-high-level alarm evaluation.
Bit 1 ENH Enables high-level alarm evaluation.
Bit 2 END Enables deviation alarm evaluation.
Bit 3 ENL Enables low-level alarm evaluation.
Bit 4 ENLL Enables very-low-level alarm evaluation.

EIO0000002093 04/2020 99
AALARM

Outputs

Output Parameter Description

Parameter Type Description

AHH BOOL 1 = Very-high-level alarm activated.
AH BOOL 1 = High-level alarm activated.
AD BOOL 1 = Deviation alarm activated).
AL BOOL 1 = Low-level alarm activated.
ALL BOOL 1 = Very-low-level alarm activated.

NOTE: Each detected alarm is timed independently according to the configuration of the TONSP
(for detected alarm activation) and TOFFSP (for detected alarm deactivation) inputs. For
disconnection purposes, the configured hysteresis is also considered.

100 EIO0000002093 04/2020

 AALARM

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

STW WORD Provides the data necessary to monitor the
detected alarms status.

STW Word Structure

This pin STW is connected to the STW field of the AINPUT_ST data structure of the related analog
variable in the event that the latter has been processed through an AINPUT-type DFB. This way,
information generated from the AALARM DFB is added to the information that the AINPUT DFB has
generated in its status word. As a result, the diagnosis status (generated from the AINPUT DFB)
and you can include detected alarms status (generated from the AALARM DFB) in the same word.

Bit Name Description

3 HHWATCH Indicates if the very-high-level alarm is being monitored. Reproduces
the value of the HHWATCH input pin.
4 HWATCH Indicates if the high-level alarm is being monitored. Reproduces the
value of the HWATCH input pin.
5 DWATCH Indicates if the deviation alarm is being monitored. Reproduces the
value of the DWATCH input pin.
6 LWATCH Indicates if the low-level alarm is being monitored. Reproduces the
value of the LWATCH input pin.
7 LLWATCH Indicates if the very-low-level alarm is being monitored. Reproduces
the value of the LLWATCH input pin.
8 AHH Read-only access. Refer to the AHH output pin (see page 100).
9 AH Read-only access. Refer to the AH output pin (see page 100).
10 AD Read-only access. Refer to the AD output pin (see page 100).
11 AL Read-only access. Refer to the AL output pin (see page 100).
12 ALL Read-only access. Refer to the ALL output pin (see page 100).

EIO0000002093 04/2020 101

AALARM

Public Variables

Public Variable Description

Variable Type Description

SC AALARM_SC_DDT Provides the frequently needed data to monitor the status of the
detected alarms from the sequential control.

AALARM_SC_DDT Type

Name Type Description

AHH BOOL Read-only access
Refer to the AHH output pin (see page 100).
AH BOOL Read-only access
Refer to the AH output pin (see page 100).
AD BOOL Read-only access
Refer to the AD output pin (see page 100).
AL BOOL Read-only access
Refer to the AL output pin (see page 100).
ALL BOOL Read-only access
Refer to the ALL output pin (see page 100).

102 EIO0000002093 04/2020

 Modicon Libraries General Purpose
AINPUT
EIO0000002093 04/2020

Chapter 12
AINPUT - Analog Input Conditioning

AINPUT - Analog Input Conditioning

Overview
This chapter describes the AINPUT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 104
DFB Representation 105
Inputs 106
Outputs 107
Inputs/Outputs 108
Public Variables 109

EIO0000002093 04/2020 103

AINPUT

Description

General
The AINPUT DFB is used for conditioning an analog signal that usually comes from a physical
input.
The DFB provides linear scaling, cut-off, diagnosis, and simulation functions.
User can supplement AINPUT with two other DFBs of the General Purpose library:
 AALARM: Allows you to incorporate functions to evaluate the alarms associated with the
measurement.
 ACALC: Allows you to incorporate calculations on the analog input.

Function Description
The main functions of the DFB are described in the table:

Function Description
Scaling The DFB scales the input signal (usually in raw data) to engineering units through a linear
function.
Cut-Off You can configure a minimum value, which is called the cut-off value. If the measured value
received from the transmitter is below the cut-off value, the measured value is non-useable. In
such case, the cut-off value is being considered.
Diagnosis The DFB manages the diagnostic status of the signal if the peripherals used provide the signal,
and assigns the value that is to be used if the signal is not working properly.
Simulation You can configure the DFB to allow you to enter the value that needs to be used (in engineering
units).
This option enables you to conduct tests on the programming associated with the DFB from
the Supervision system.
External PV The DFB enables you to connect a signal that is already in engineering units (and therefore
does not need scaling, diagnosis, or cut-off operations) while maintaining the simulation
function.

104 EIO0000002093 04/2020

 AINPUT

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 105

AINPUT

Inputs

Input Parameter Description

Parameter Type Description

CHIN INT Input signal. Corresponds to a value in raw data coming from the
input/output peripherals.
CHFAILURE BOOL 1 = Indicates to the DFB that the input channel associated with the CHIN
input is operational.
HIRAW INT High range of the CHIN input signal.
LORAW INT Low range of the CHIN input signal.
HIPV REAL High range of the measurement in engineering units (PV output)
corresponds to the maximum value (configured in the HIRAW input) of the
CHIN input.
LOPV REAL Low range of the measurement in engineering units (PV output) corresponds
to the minimum value (configured in the LORAW input) of the CHIN input.
BADPV REAL Default value in engineering units (PV output signal) when the channel is not
operational.
CUTOFFPV REAL Value (in engineering units) resulting from the scaling calculation, and below
which the value entered into the LOPV input needs to be considered as the
measurement value (PV output).
EXTPVEN BOOL 1 = Enables you to configure the DFB to accept an analog input in
engineering units (EXTPV).
0 = Enables you to use the input in raw data (CHIN).
EXTPV REAL Input signal in engineering units (refer to the EXTPVEN input pin).

106 EIO0000002093 04/2020

 AINPUT

Outputs

Output Parameter Description

Parameter Type Description

PV REAL Calculated measurement value usually in engineering units.

The table describes how the DFB calculates the measurement value PV based on the value of the
inputs and the AINPUT_ST input/output:

EXTPVEN AINPUT_ST.CFGW.S CHFAILURE CHIN PV is calculated as:

IMMD
- ON - - AINPUT_CFG.SIM
ON OFF - - EXTPV
OFF OFF ON - BADPV
OFF OFF OFF <= LORAW LOPV

OFF OFF OFF >LORAW Refer to the linear scaling formula.

and
=<HIRAW
OFF OFF OFF >=HIRAW HIPV

Linear scaling formula:

¤ HIPV LOPV ³ ¤ HIPV LOPV ³
¥¦ r CHIN ´ LOPV ¥¦ r LORAW ´
HIRAW LORAW µ HIRAW LORAW µ

If the resulting value of the calculation is less than cut-off (and the signal comes from the CHIN
input), the PV output is matched to the LOPV input.

EIO0000002093 04/2020 107

AINPUT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

AINPUT_ST AINPUT_ST_DDT Provides the necessary data for monitoring the state of the input
analog signal and configuring its simulation when required.
AINPUT_CFG AINPUT_CFG_DDT Provides the data necessary to configure the DFB usually from
the monitoring subsystem.

AINPUT_ST_DDT Type

Name Type Description

STW WORD Read-only access
Bit 0 BADST Indicates whether the input channel is operational. Reproduces the
value of the CHFAILURE input if the CHIN input signal (EXTPVEN = 0)
is used.
CFGW WORD DFB configuration word
Bit 0 SIMMD Read/write access
Enables you to put the analog input in simulation (1) mode or normal
(0) mode.
PV REAL Read-only access

AINPUT_CFG_DDT Type

Name Type Description

SIM REAL Read/write access
Simulated value of the measurement in engineering units.
Default value: 0
NOTE: In case of a physical input (EXTPVEN = 0), the value that you enter in the
AINPUT_CFG.SIM input/output needs to be within the range delimited by LOPV and
HIPV. If you enter a value outside of this range, the DFB uses the current value of the
AINPUT_CFG.SIM input/output instead.

108 EIO0000002093 04/2020

 AINPUT

Public Variables

Public Variable Description

Variable Type Description

SC AINPUT_SC_DDT Provides the frequently needed data to monitor the
analog input status from the sequential control.

AINPUT_SC_DDT Type

Name Type Description

BADST BOOL Read-only access
Refer to the AINPUT.STW.BADST input/output pin
(see page 108).
PV REAL Read-only access
Refer to the PV output pin (see page 107).

EIO0000002093 04/2020 109

AINPUT

110 EIO0000002093 04/2020

 Modicon Libraries General Purpose
AINPUT1
EIO0000002093 04/2020

Chapter 13
AINPUT1 - Configurable Range Analog Input Conditioning

AINPUT1 - Configurable Range Analog Input Conditioning

Overview
This chapter describes the AINPUT1 DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 112
DFB Representation 113
Inputs 114
Outputs 115
Inputs/Outputs 116
Public Variables 118

EIO0000002093 04/2020 111

AINPUT1

Description

General
The AINPUT1 DFB is used to condition an analog signal normally coming from a physical input. In
contrast to the AINPUT, the AINPUT1 DFB allows you to configure the corresponding range from
the Supervision system.
The DFB provides linear scaling, cut-off, diagnosis, and simulation functions.
You can supplement AINPUT1 with two other DFBs of the General Purpose library:
 AALARM: Allows you to incorporate functions to evaluate the alarms associated with the
measurement.
 ACALC: Allows you to incorporate calculations on the analog input.

Function Description
The main functions of the DFB are described in the table:

Function Description
Scaling The DFB scales the input signal (usually in raw data) to engineering units by
using a linear function.
You can configure the signal range externally (normally through the
Supervision system) within the range that is configured in the program, which
is running in the controller. Enter values in engineering units.
Cut-Off You can configure a minimum value, which is called the cut-off value. If the
measured value received from the transmitter is below the cut-off value, the
measured value is non-useable. In such case, the cut-off value is being
considered.
You can configure the cut-off value externally; normally through the
Supervision system. Enter a value in engineering units within the range that
is configured in the program, which is running in the controller
Diagnosis The DFB manages the diagnostic status of the signal if the peripherals used
provide this signal and assigns the value that is to be used if the signal is not
working properly.
You can externally configure the value (normally through the Supervision
system) that is to be used if the signal is not working properly. Enter a value
in engineering units within the range that is configured in the program, which
is running in the controller.
Simulation You can configure the DFB to allow you to enter the value that needs to be
used (in engineering units).
This option enables you to conduct tests on the programming associated with
the DFB from the Supervision system.
External PV The DFB allows you to connect a signal that is already in engineering units
(and therefore does not need scaling, diagnosis, or cut-off operations) while
maintaining the simulation function.

112 EIO0000002093 04/2020

 AINPUT1

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 113

AINPUT1

Inputs

Input Parameter Description

Parameter Type Description

CHIN INT Input signal. Corresponds to a value in raw data coming
from the input/output peripherals.
CHFAILURE BOOL 1 = Indicates to the DFB that the input channel associated
with the CHIN input is operational.
HIRAW INT High range of the CHIN input signal.
LORAW INT Low range of the CHIN input signal.
HIPV REAL Maximum permissible value of the high range measurement
in engineering units (PV output) corresponding to the
maximum value (configured in the HIRAW input) of the CHIN
input.
Used as the high range by default if the high range is not
modified from the monitoring subsystem
(AINPUT1_CFG.CHIPV).
LOPV REAL Minimum permissible value of the low range measurement
in engineering units (PV output) corresponding to the
minimum value (configured in the LORAW input) of the CHIN
input.
Used as the low range by default if the high range is not
modified from the monitoring subsystem
(AINPUT1_CFG.CLOPV).
EXTPVEN BOOL 1 = Enables you to configure the DFB to accept an analog
input in engineering units (EXTPV).
0 = Enables you to configure the DFB to use the input in raw
data (CHIN).
EXTPV REAL Input signal in engineering units (refer to the EXTPVEN input
pin).

114 EIO0000002093 04/2020

 AINPUT1

Outputs

Output Parameter Description

Parameter Type Description

PV REAL Calculated measurement value usually in engineering units.

The table describes how the DFB calculates the measurement value PV based on the value of the
inputs and the AINPUT1_ST input/output:

EXTPVEN AINPUT1_ST.CFGW. CHFAILURE CHIN PV is calculated as:

SIMMD
- ON - - AINPUT1_CFG.SIM
ON OFF - - EXTPV
OFF OFF ON - AINPUT1_CFG.BADPV
OFF OFF OFF <= LORAW AINPUT1_CFG.CLOPV

OFF OFF OFF >LORAW Refer to the linear scaling formula.

and
<HIRAW
OFF OFF OFF >=HIRAW AINPUT1_CFG.CHIPV

Linear scaling formula:

If the resulting value of the calculation is less than AINPUT1_CFG.CUTOFFPV (and the signal
comes from the CHIN input), the PV output is set to match the AINPUT1_CFG.CLOPV input/output.

EIO0000002093 04/2020 115

AINPUT1

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

AINPUT1_ST AINPUT1_ST_DDT Provides the necessary data for monitoring the
state of the input analog signal and configuring its
simulation when required.
AINPUT1_CFG AINPUT1_CFG_DDT Provides the data necessary to configure the
DFB usually from the monitoring subsystem.

AINPUT1_ST_DDT Type

Name Type Description

STW WORD Read-only access
Bit 0 BADST Indicates whether the input channel is operational or
not. Reproduces the value of the CHFAILURE input
if the CHIN input signal (EXTPVEN = 0) is used.
CFGW WORD DFB configuration word
Bit 0 SIMMD Read/write access
Enables you to put the analog input in Simulation (1)
mode or Normal (0) mode.
PV REAL Read-only access
Refer to the PV output pin (see page 115).

AINPUT1_CFG_DDT Type

Name Type Description

SIM REAL Read/write access
Simulated value of the measurement in engineering units.
Default value: 0
NOTE: In case of a physical input (EXTPVEN = 0), the value that
you enter in the AINPUT1_CFG.SIM input/output needs to be within
the range delimited by LOPV and HIPV. If you enter a value outside
of this range, the DFB uses the current value of the
AINPUT1_CFG.SIM input/output instead.

116 EIO0000002093 04/2020

 AINPUT1

Name Type Description

CHIPV REAL High range of the measurement in engineering units (PV output)
corresponding to the maximum value (configured in the HIRAW
input) of the CHIN input pin.
The maximum value that this variable can assume is limited by the
value of the HIPV input pin.
If the range entered from the monitoring system is incorrect
(AINPUT1_CFG.CLOPV = AINPUT1_CFG.CHIPV = 0.0), it is
initialized with the value of the HIPV input pin.
CLOPV REAL Low range of the measurement in engineering units (PV output)
corresponding to the minimum value (configured in the LORAW input)
of the CHIN input pin.
The minimum value that this variable can assume is limited by the
value of the LOPV input pin.
If the range entered from the monitoring system is incorrect
(AINPUT1_CFG.CLOPV = AINPUT1_CFG.CHIPV = 0.0), it is
initialized with the value of the LOPV input pin.
BADPV REAL Value needs to be used in engineering units (PV output signal) when
the channel is not operational.
The value that this variable can assume is limited by the range
configured in engineering units (AINPUT1_CFG.CLOPV and
AINPUT1_CFG.CHIPV).
If the range entered from the monitoring system is incorrect
(AINPUT1_CFG.CLOPV = AINPUT1_CFG.CHIPV = 0.0), it is
initialized with the value of the HIPV input pin.
CUTOFFPV REAL Value (in engineering units) resulting from the scaling calculation
and below which the value entered into the AINPUT1_CFG.CLOPV
input/output needs to be used as the measurement value (PV
output).
The value that this variable can assume is limited by the low range
configured in engineering units (AINPUT1_CFG.CLOPV).
If the range entered from the monitoring system is incorrect
(AINPUT1_CFG.CLOPV = AINPUT1_CFG.CHIPV = 0.0), it is
initialized with the value of the LOPV input pin.
INPUTVALUE REAL Input value (in engineering units). If external PV is enable from the
control, then input value is equal to external PV. If external PV is
disable from the control, then input value is equal to channel value.

EIO0000002093 04/2020 117

AINPUT1

Public Variables

Public Variable Description

Variable Type Description

SC AINPUT1_SC_DDT Provides the frequently needed data to monitor the
analog input status from the sequential control.

AINPUT1_SC_DDT Type

Name Type Description

PV REAL Read-only access
Refer to the PV output pin (see page 115).
BADST BOOL Read-only access
Refer to the AINPUT1.STW.BADST input/output pin
(see page 116).

118 EIO0000002093 04/2020

 Modicon Libraries General Purpose
ALINEAR
EIO0000002093 04/2020

Chapter 14
ALINEAR - Linear Interpolation

ALINEAR - Linear Interpolation

Overview
This chapter describes the ALINEAR DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 120
DFB Representation 121
Inputs 122
Outputs 123

EIO0000002093 04/2020 119

ALINEAR

Description

General
The ALINEAR DFB is used to transform a signal by means of a linear characterization function.
The characterization function is defined with the use of points (up to 5).

120 EIO0000002093 04/2020

 ALINEAR

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 121

ALINEAR

Inputs

Input Parameter Description

Parameter Type Description

X REAL Value of the analog signal to be transformed.
Xi, Yi REAL Definition of the characterization function points.
NOTE: Enter the points in ascending order in relation to the X axis, that
is, from the lowest X value to the highest.
N UINT Number of points used (2...5).

122 EIO0000002093 04/2020

 ALINEAR

Outputs

Output Parameter Description

Parameter Type Description

Y REAL Value calculated from the X signal and the characterization function
defined with the points (X1, Y1) to (X5, Y5).
It is calculated as followed:
Y=Y1 for <= X1
Y=f(X) by linear interpolation according to the points entered for X >X1 and
X< Xn
Y=Yn for X>=Xn
Where n corresponds to the number of points selected on the N input.
If the N input is less than or equal to 2, Y is unconditionally assigned to
Y2. If N is greater than 5, the characterization function is applied as if
the value were 5.
ERROR BOOL 1 = High-level alarm.
The parameter is set to 1 if:
 The N input is not within range.
 The (X,Y) points are not correctly ordered (X axis).

EIO0000002093 04/2020 123

ALINEAR

124 EIO0000002093 04/2020

 Modicon Libraries General Purpose
AOUTPUT
EIO0000002093 04/2020

Chapter 15
AOUTPUT - Analog Output Conditioning

AOUTPUT - Analog Output Conditioning

Overview
This chapter describes the AOUTPUT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 126
DFB Representation 127
Inputs 128
Outputs 129
Inputs/Outputs 131
Public Variables 133

EIO0000002093 04/2020 125

AOUTPUT

Description

General
The AOUTPUT DFB is used to condition an analog signal usually associated with a physical output.
The DFB provides linear scaling, interlocking, diagnosis, and owner management functions.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Scaling The DFB scales the input signal in engineering units (for example, %) to raw
data through a linear function.
Diagnosis The DFB manages the diagnostic status of the signal if the periphery used
provides the signal.
Interlocking The DFB enables to move to the defined position if an active interlock that
requires this move is detected. An interlocking bypass function is available.
Owner The DFB manages control system level, which is the owner (Operator or
Program). As a result, it is responsible for setting the set-point to the desired
position.

126 EIO0000002093 04/2020

 AOUTPUT

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 127

AOUTPUT

Inputs

Input Parameter Description

Parameter Type Description

CHFAILURE INT Indicates to the DFB whether the output channel associated
with the CHOUT output is operational (1) or not (0).
HIRAW INT High range of the CHOUT output signal.
LORAW INT Low range of the CHOUT output signal.
HISP REAL High range of the set-point (SP) in engineering units
corresponding to the maximum value (configured in the
HIRAW input) of the CHOUT output.
LOSP REAL Low range of the set-point (SP) in engineering units
corresponding to the minimum value (configured in the
LORAW input) of the CHOUT output.
RSP REAL Remote set-point. Usually set by the continuous control; for
example, by a PID controller output.
ILCKSP REAL Use set-point when the DFB is interlocked. Refer to the ILCK
input pin.
ILCK BOOL 1 = Interlocks the device at the defined position.

128 EIO0000002093 04/2020

 AOUTPUT

Outputs

Output Parameter Description

Parameter Type Description

CHOUT INT Calculated value of the output in raw data.
Output calculation based on the OP value is detailed in the following table:
OP CHOUT
<= LOSP LORAW

> LOSP and < HISP Is calculated with the following linear formula.
>= HISP HIRAW
SP REAL Current set-point.
Set-point calculation based on the value of the input value and the AOUTPUT_ST
input/output is detailed in the following table:
OWNER (OFF: REM SP
Program, ON:
Operator)
OFF OFF SC.LSP
OFF ON RSP
ON - AOUTPUT_CFG.LSP
OP REAL Output in engineering units.
Set-point calculation based on the SC.ILCKD public variable value is detailed in
the following table:
SC.ILCKD OP
ON ILCKSP
OFF SP
TRACK BOOL Determines whether the remote set-point (RSP input) is one being considered (0)
or not (1) for the CHOUT output calculation.
1 = Report whether the control loop is open to the algorithm connected to the RSP
input (for example, a PID) so that it can readjust itself based on the output that is
really taking place (the one present at the OP output).
ILCKD OWNER REM TRACK is calculated as:
ON - - ON
OFF OFF OFF ON
OFF OFF ON OFF
OFF ON - ON

EIO0000002093 04/2020 129

AOUTPUT

Linear scaling formula:

¤ HIRAW LORAW ³ ¤ HIRAW LORAW ³
¥¦ r SP´ LORAW ¥¦ r LOSP´
HISP LOSP µ HISP LOSP µ

130 EIO0000002093 04/2020

 AOUTPUT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

AOUTPUT_ST AOUTPUT_ST_DDT Provides the data necessary to monitor the DFB status.
AOUTPUT_CFG AOUTPUT_CFG_DDT Provides the necessary data to control the DFB.

AOUTPUT_ST_DDT Type

Name Type Description

OP REAL Read-only access
Refer to the OP output pin (see page 129).
STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory. Read-only
access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read/write access to the data contained in this word.

AOUTPUT_ST.STW Word Structure

Bit Name Description

0 BADST Indicates whether the output channel is operational or not. Reproduces
the CHFAILURE input value.
1 ILCK Refer to the ILCK input pin (see page 128).
2 REM Refer to the SC.REM public variable (see page 133).

AOUTPUT_ST.CFGW Word Structure

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the:
0 Program
1 Operator
1 ILCKBP Read/write access
Allows the interlock to be bypassed (1).

EIO0000002093 04/2020 131

AOUTPUT

AOUTPUT_CFG_DDT Type

Name Type Description

LSP REAL Read/write access
This variable indicates current set-point and is calculated internally in the DFB as
long as the owner is not the Operator (is set to match the SP output). In which case,
you can modify it from the monitoring subsystem.

132 EIO0000002093 04/2020

 AOUTPUT

Public Variables

Public Variable Description

Variable Type Description

SC AOUTPUT_SC_DDT Provides the frequently needed data to monitor and control the
analog output status from the sequential control.

AOUTPUT_SC_DDT Type

Name Type Description

LSP REAL Read/write access
Allows to assign the local set-point normally for the sequential control if the owner is
the Program (OWNER input/output is set to 0) and the selected set-point is the Local on
(SC.REM public variable is set to 0). Otherwise, the current set-point (SP output) is
continuously copied to this variable.
SP REAL Refer to the SP output pin (see page 129).
OP REAL Read-only access
Refer to the OP output pin (see page 129).
OWNER BOOL Read-only access
Refer to the AOUTPUT_ST.CFGW.OWNER input/output pin (see page 131).
REM BOOL Read/write access
Allows the DFB to be configured to remote set-point—RSP—(1) or local set-point—
LSP— (0).
TRACK BOOL Read-only access
Refer to the TRACK output pin (see page 129).
BADST BOOL Read-only access
Refer to the AOUTPUT.STW.BADST input/output pin (see page 131).
ILCKD BOOL Read-only access
The signal evaluation depending on the ILCK input and the
AOUTPUT_ST.CFGW.ILCKBP input/output is shown in the following table:
ILCK ILCKBP SC.ILCKD is calculated as:
OFF - OFF
ON OFF ON
ON ON OFF

EIO0000002093 04/2020 133

AOUTPUT

134 EIO0000002093 04/2020

 Modicon Libraries General Purpose
AOUTPUTLP
EIO0000002093 04/2020

Chapter 16
AOUTPUTLP - Local Panel for Analog Output Conditioning

AOUTPUTLP - Local Panel for Analog Output Conditioning

Overview
This chapter describes the AOUTPUTLP DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 136
DFB Representation 137
Inputs 138
Outputs 141
Inputs/Outputs 142
Public Variables 145

EIO0000002093 04/2020 135

AOUTPUTLP

Description

General
The main objective of the AOUTPUTLP DFB is to manage a local panel that controls an analog
output implemented by means of an AOUTPUT function DFB.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Mode Switch Optionally manages the signals coming from an operating mode
switch in a local panel with the following configuration: Local - Zero -
Control System. The Zero mode signal is optional. However the user
can enable Local/Control System mode from the faceplate also,
when VirtualLPEN input pin signal is high and MODESignalsEN
signal is low in the DFB.
Push buttons The DFB manages up to two signals coming from OPEN and CLOSE
push buttons giving the CLOSE push button signal higher priority.
Owner Management The DFB enables to configure whether the Program needs to be the
analog output owner or not, after switching to the Control System
mode again.
Owner Locking The DFB enables to configure whether the monitoring (HMI) system
needs to block access to the drop-down list or not. It disables to
change the owner (Operator/Program) while the analog output is
controlled from the Local Panel.
Set-point Lock The DFB enables to configure whether or not the monitoring (HMI)
system needs to block access to the drop-down list or not. It disables
to change the set-point (Operator/Program) while the analog output
is controlled from the Local Panel.
Push button The push buttons on the Local Panel can be enabled/disabled
Enabling/Disabling through the DFB configuration (input pin) and/or from control
sequences.
Enabled Panel The DFB provides a signal that can be used to illuminate a light
Signaling source on the Local Panel to indicate when the push buttons are
enabled for operation.
Virtual Panel This signal enables the operator to select the Local/Control System
Enabling/Disabling mode of operation from the HMI so that the push button signals are
enabled for operation.
NOTE: VirtualLPEN input pin signal is applicable when Modicon
Libraries - General Purpose is used along with Modicon Libraries -
General Purpose for Wonderware System Platform.

136 EIO0000002093 04/2020

 AOUTPUTLP

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 137

AOUTPUTLP

Inputs

Input Parameter Description

Parameter Type Description

LPSignal BOOL 1 = The local panel mode switch is in the Local Panel position. Refer to the
table included with the description of the LPMode output pin (see page 141).
ZEROSignal BOOL 1 = The local panel mode switch is in the zero position.This signal is optional
even if a mode switch is available on the local panel. When this signal is a
logical high, user is not allowed to operate the device from the faceplate and
also from the DFB. Hence, all the functions in the faceplate will be disabled.
Refer to the table included with the description of the LPMode output pin
(see page 141).
CSSignal BOOL 1 = The local panel mode switch is in the Control System position. Refer to the
table included with the description of the LPMode output pin (see page 141).
OpenSignal BOOL 1= Indicates to the DFB that the OPEN push button on the local panel is
pressed.
CloseSignal BOOL 1 = Indicates to the DFB that the CLOSE push button on the local panel is
pressed.
DeltaSP REAL Absolute set-point increase or decrease value when the OPEN or CLOSE
push button is pressed.
DeltaFastSP REAL Absolute set-point increase or decrease value when the OPEN and CLOSE
push buttons are being held down.
TREPEAT TIME Indicates the maximum time that should elapse before the system interprets
that a command has been repeated when the push button is being held down.
This time also determines when a DeltaFastSP increase or decrease has to
be applied when the OPEN or CLOSE push button is being held down.
MODESignalsEN BOOL 1 = Enables the use of the Local Panel/Zero/Control System (or Local Panel -
Control System) mode switch on the local panel. Normally configured in
development phase based on the characteristics of the local panel being used.
If the mode switch is enabled, the LPSignal, ZEROSignal, and CSSignal
inputs are considered to determine the operating modes of the local panel.
Refer to the table included with the description of the LPMode output pin
(see page 141).
NOTE: MODESignalsEN input pin has higher priority than the VirtualLPEN
input pin signal.

138 EIO0000002093 04/2020

 AOUTPUTLP

Parameter Type Description

VirtualLPEN BOOL 1 = This signal enables the operator to select the Local/Control System mode
of operation from the HMI, so that the push button signals are enabled for
operation.
NOTE:
 When the owner is program, the Local/Control System mode selection
drop-down list will be visible but disabled for operation however, when the
owner is operator the Local Panel drop-down list will be accessible for
operation.
 VirtualLPEN input pin signal is applicable only for Modicon Libraries -
General Purpose for Wonderware System Platform offer only, however
there is no impact of this input signal in Modicon Libraries - General
Purpose for Citect SCADA offer.
Refer to the table included with the description of the LPMode output pin
(see page 141).
PBSignalsEN BOOL 1 = Enables to accept OPEN and CLOSE push button signals from the local
panel. This signal is not applicable if the mode switch is enabled (refer to the
MODESignalsEN input pin). This means that the push button signals are
considered in the Local Panel mode.
When the mode switch is disabled (MODESignalsEN = 0), PBSignalsEN
signal enables/disables the push buttons from control system itself based on
relevant process conditions. SC.DisableLP public variable is also
considered for determining whether the push buttons are enabled or not when
LPMode pin signal is high, as shown in the following table.
MODESignalsEN PBSignalsEN SC.DisableL Push buttons
P enabled?
OFF OFF - NO
OFF - ON NO
OFF ON OFF YES
ON - - YES
Therefore, you can use this signal to enable/disable the push buttons on a
simple local panel that does not feature a mode switch (Local
Panel/Zero/Control System) based on the relevant process conditions.
ToProgramEN BOOL 1 = Enables the functionality to change the owner of analog output to Program
when mode switch on the local panel returns to control system position (only
when the mode is switched). If this functionality is disabled, operator of the
monitoring (HMI) system switches to Program owner when the operator
deems it appropriate. Refer to the table included with the description of the
LockOwnerEN input pin.

EIO0000002093 04/2020 139

AOUTPUTLP

Parameter Type Description

LockOwnerEN BOOL 1 = Disables the access of the owner of analog output remaining as Operator
while the local panel mode is Local Panel.
The following table shows how the owner of analog output is evaluated based
on ToProgramEN and LockOwnerEN inputs and the local panel operating
mode:
Local Panel Mode ToProgramEN LockOwnerEN Owner
Zero - - Operator
Switch to Local Panel - - Operator
Local Panel - ON Operator
Switch to Control ON - Program
System
In remaining cases, owner of the analog output ceases to be defined from the
AOUTPUTLP DFB and it becomes possible to change it from monitoring (HMI)
system with the command word in the AOUTPUT_ST.CFGW input/output of the
corresponding AOUTPUT DFB.
In any case, consider that the analog output owner that had been set before
switching to the local panel mode is not memorized.
LockSetPointEN BOOL 1 = Disables the setpoint of the analog output and lock it into the one defined
on the local panel while the local panel mode is local panel and the device
owner is the Operator. User can switch to Program mode based on the signals
that have been previously described even if the local panel mode is set to
Local Panel.
Therefore, user can activate (1) this signal to lock setpoint operation from the
monitoring system while the analog output is controlled from the local panel.

140 EIO0000002093 04/2020

 AOUTPUTLP

Outputs

Output Parameter Description

Parameter Type Description

PBLIGHTSignal BOOL 1 = The push buttons on the local panel are fully operational, that is, the local panel
is in Local Panel mode (either because the mode is selected with the corresponding
switch or because the push buttons are enabled in the event that there is no selector
switch available or the VirtualLPEN is high with the local panel mode enabled).
LPMode BOOL 1 = The local panel mode is in Local Panel.
The following table shows how the local panel operating mode is determined based
on the MODESignalsEN, VirtualLPEN, PBSignalsEN, LPSignal, CSSignal
and ZEROSignal, input signals:
MODESig- Virtu- PBSig- LPSig CSSig- ZERO- OUTPUT
nalsEN alLPEN nalsEN nal nal Signal
0 0 0 0 0 0 CS mode
1 0 0 0 0 0 Zero mode
1 0 0 1 0 0 LP mode and
PBLIGHTSig-
nal
1 0 0 0 1 0 CS mode
0 1 1 NA NA NA CS mode
0 1 0 NA NA NA CS mode
0 0 1 0 0 0 LP mode and
PBLIGHTSig-
nal
1 1 0 1 0 0 LP mode and
PBLIGHTSig-
nal
1 1 0 0 0 0 Zero mode
1 1 0 0 0 1 Zero mode
1 1 0 0 1 0 CS mode
1 0 1 0 1 0 CS mode
1 1 1 0 1 0 CS mode
1 0 0 0 0 1 Zero mode
ZEROMode BOOL 1 = The local panel mode is in Zero. User is not allowed to operate the device from
the faceplate and also from DFB. Hence, all the functions in the faceplate will be
disabled. Refer to the table included with the description of the LPMode output.
CSMode BOOL 1 = The local panel mode is in Control System. Refer to the table included with the
description of the LPMode output.

EIO0000002093 04/2020 141

AOUTPUTLP

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

AOUTPUT_CFG AOUTPUT_CFG_DDT Data structure belonging to the analog output is to be controlled
from the local panel (for detailed information regarding this
structure, refer to the AOUTPUT DFB (see page 125)). The
structure provides information needed for the operation of the
AOUTPUTLP DFB. It enables this DFB to control the setpoint for
the analog output.
AOUTPUT_ST AOUTPUT_ST_DDT Data structure corresponding to the analog output is to be
controlled from the local panel (for detailed information regarding
this structure, refer to the AOUTPUT DFB (see page 125).
The structure provides information needed for the operation of
AOUTPUTLP DFB and enables this DFB to control the owner of
the analog output.
AOUTPUTLP_ST AOUTPUTLP_ST_DDT Data structure that is used as an interface with the monitoring
(HMI) system.

AOUTPUT_CFG.DDT Type

Name Type Description

LSP REAL Read/write access
Allows local set-point of the operator (OWNER = 1) to be set from the
monitoring (HMI) system. If setpoint is set by the Program (OWNER =
0), the DFB continuously assigns it the value of the current set-point.

AOUTPUT_ST.DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory. Read-only
access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read/write access to the data contained in this word.
OP REAL Read-only access
Refer to the OP output pin (see page 129).

142 EIO0000002093 04/2020

 AOUTPUTLP

AOUTPUTLP_ST.DDT Type

Name Type Description

STW WORD Read-only access
Bits word with the status of the local panel.

AOUTPUT_ST.CFGW Word
The following table describes the AOUTPUT_ST.CFGW word:

Bit Name Description

0 OWNER The control modes for the analog output
Read/write access
Enables to configure whether the set-point is set by the Program (0) or by
the Operator (1).
Refer to the table included with the description of the LPMode output pin,
which specifies the cases in which the AOUTPUTLP DFB can interact with
this signal.

AOUTPUTLP_ST.CFGW Word

Bit Name Description

0 LocalModeOn Read/write access only
 1 = Enables the Local Panel mode.
 0 = Enables the Control System mode.

EIO0000002093 04/2020 143

AOUTPUTLP

AOUTPUTLP_ST.STW Word
Read-only access. Status word. The following table describes the AOUTPUTLP_ST.STW word:

Bit Name Description

0 LPMode Local panel in Local Panel mode. Refer to the LPMode output
pin.
1 ZEROMode Local panel in zero mode. Refer to the ZEROMode output pin.
2 CSMode Local panel in Control System mode. Refer to the CSMode
output pin.
3 LockedOwner Indicates whether the owner change buttons in the monitoring
(HMI) system needs to be locked (1) or not (0).
Is activated when:
 The Local Panel mode is set to Zero or
 It is set to Local Panel and the LockOwnerEN input signal
has been configured as active (1).
4 SPLocked Indicates whether the set-point change and START buttons in
the monitoring (HMI) system needs to be locked (1) or not (0).
Is activated when:
 The local panel mode is set to Zero or
 It is set to Local Panel and the LockSetPointEN input
signal has been configured as active (1).
5 MODESignalsEN Indicates the state of the MODESignalsEN input signal, that is,
whether there is a mode switch (1) or not (0).
6 PBEnabled Indicates whether the push buttons of the local panel are
enabled (1) or not (0). The signal is activated when at least one
of the MODESignalsEN and PBSignalsEN signal inputs is
active.
7 VirtualLPEN Enables the drop-down list for the Local Panel / Control System
mode selection.
8 LPSignal Indicates the state of the LPSignal input signal.
9 ZEROSignal Indicates the state of the ZEROSignal input signal.
10 CSSignal Indicates the state of the CSSignal input signal.
11 OpenSignal Indicates the state of the OpenSignal input signal.
12 CloseSignal Indicates the state of the CloseSignal input signal.

144 EIO0000002093 04/2020

 AOUTPUTLP

Public Variables

Public Variable Description

Variable Type Description

SC AOUTPUTLP_SC_DDT Provides the frequently needed data to monitor
and control the DFB.

AOUTPUTLP_SC_DDT Type

Name Type Description

LPMode BOOL Read-only access
Refer to the LPMode output pin.
ZEROMode BOOL Read-only access
Refer to the ZEROMode output pin.
CSMode BOOL Read-only access
Refer to the CSMode output pin.
DisableLP BOOL Read/write access
1 = Disables the push buttons on the local panel. Only applicable
when a local panel without mode switch configuration is used
(MODESignalsEN = 0).

EIO0000002093 04/2020 145

AOUTPUTLP

146 EIO0000002093 04/2020

 Modicon Libraries General Purpose
DCALC
EIO0000002093 04/2020

Chapter 17
DCALC - Digital Calculation

DCALC - Digital Calculation

Overview
This chapter describes the DCALC DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 148
DFB Representation 149
Inputs 150
Outputs 151
Public Variables 152

EIO0000002093 04/2020 147

DCALC

Description

General
The DCALC DFB is used to perform calculations based on a digital signal; the calculations
performed are frequency and totalizing calculations.
The DFB memorizes up to 20 time samples with rising edges in the measurement (PV - Present
Value) based on which the calculations are performed.
Calculations are based on values of type REAL.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Frequency The frequency at which the input signal oscillates is calculated.
Totalizing The totalization is calculated by counting pulses and scaling to engineering
units.

NOTE: The function block uses the FREERUN function for time calculations. Therefore, the DCALC
DFB is only available if the controller CPU supports this function.

148 EIO0000002093 04/2020

 DCALC

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 149

DCALC

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL 0 = Rising edge on this input is detected, the DFB internal
timers are reset and the first sample (time and value) is stored
in the memory.
In the same execution cycle, the value of the outputs is
generated.
NOTE: The input is not reset (0) by the DFB.
PV BOOL 1 = Value of the measurement.
NOTE: You need to verify that the execution characteristics of
the DFB are compatible with the input frequency of the signal;
so, no edges are lost and the accuracy of the frequency
calculation is adequate for the requirements of the process.
NUMSAMPLES UINT Maximum number of samples that need to be stored and that
are used in the calculations.
Configuration range: From 2 to 20
Default value: 20
NOTE: During the first runs of the DFB, a smaller number of
samples than those configured may be used.
KFREQ REAL Conversion factor applied to the frequency calculation (refer to
the FREQ (see page 151) output).
Allows the frequency to be calculated in the desired
engineering units (for example, RPM).
If this signal is 0, the DFB applies a default factor of 1.0.
KTOTAL REAL Conversion factor applied to the totalizing calculation TOTAL
(see page 151) output.
Allows the total to be calculated in the desired engineering
units.
If this signal is 0, the DFB applies a default factor of 1.0.

150 EIO0000002093 04/2020

 DCALC

Outputs

Output Parameter Description

Parameter Type Description

FREQ REAL The frequency is calculated (in Hz when KFREQ is 1.0) based
on the time samples in which the rising edges of the
measurement have taken place (PV).
Frequency calculation is based on the following formula.
TOTAL REAL Calculates the totalization while it is activated (refer to the
SC.TOTALEN public variable (see page 152)). A unit is
accumulated (scaled with KTOTAL, when applicable) each
time a rising edge occurs on the input signal.
The calculation is only made if it has been enabled and you
can set it to 0 (refer to SC public variable (see page 152)).

Frequency calculation formula:

Where:
KFREQ Conversion factor applied to the frequency calculation. Refer to the KREQ input
(see page 150).
n Number of samples (up to 20 after the whole internal sample table is loaded).
t Relative time elapsed from the first edge to the corresponding edge.

Checking the Saturation Limit of the Output

Calculations based on values of type REAL may give incorrect results. For example, if the
increment (KTOTAL) that is used in the calculation of the output is smaller than the precision of the
output, the output may be wrong.
You can check whether the output is correct by using the SATURATION function block.
For more information, refer to SATURATION in the help of Control Participant.

EIO0000002093 04/2020 151

DCALC

Public Variables

Public Variable Description

Variable Type Description

SC DCALC_SC_DDT Provides the frequently needed data to monitor
and control the DFB.

DCALC_SC_DDT Type

Name Type Description

PV BOOL Read-only access
Refer to the PV input pin (see page 150).
FREQ REAL Read-only access
Refer to the FREQ output pin (see page 151).
TOTAL REAL Read-only access
Refer to the TOTAL output pin (see page 151).
TOTALEN BOOL Read/write access
1 = Enables the totalizing calculation.
0 = Disables the totalizing calculation. Does not set the totalizer to 0.
TOTALRST BOOL Read/write access
1 = Resets the totalized value (TOTAL output).
0 = After processing, the DFB sets this signal to 0.

152 EIO0000002093 04/2020

 Modicon Libraries General Purpose
DINPUT
EIO0000002093 04/2020

Chapter 18
DINPUT - Digital Input Conditioning

DINPUT - Digital Input Conditioning

Overview
This chapter describes the DINPUT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 154
DFB Representation 155
Inputs 156
Outputs 157
Inputs/Outputs 158
Public Variables 159

EIO0000002093 04/2020 153

DINPUT

Description

General
The DINPUT DFB is used to condition a digital signal usually coming from a physical input.
The DFB provides timing functions for the connection and/or disconnection, simulation, and can
use the signal status as an alarm function.

Function Description
The main functions of the DFB are described in the table:

Function Description
Timing The input signal is timed to evaluate an output logic signal that
absorbs rapid changes in the input signal.
Alarm You can enable/disable the evaluation of an alarm and indicate the
status that needs to be considered for the alarm. .
You need to incorporate an external logic to evaluate this alarm.
Diagnosis The DFB manages the diagnostic status of the signal if the
peripherals used provide it and assigns the value that is to be used if
the signal is not working properly.
Simulation You can configure the DFB to allow you to enter the value that needs
to be used (in engineering units).
This option enables you to conduct tests on the programming
associated with the DFB from the Supervision system.

154 EIO0000002093 04/2020

 DINPUT

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 155

DINPUT

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL 0 = Rising edge is produced on this input, the internal timers of
the DFB are reset. If the input and the detected alarm status are
timed, the detected alarm and the PV are set to 0.
CHIN BOOL 1 = Input signal
Usually corresponds to a value coming from the input
peripherals.
CHFAILURE BOOL 1 = Indicates to the DFB whether the input channel that is
associated with the CHIN input is operational.
BADPV BOOL 0 = Value needs to be used (PV output signal and for the
purposes of detected alarm evaluation).
ALARMST BOOL 1 = PV value needs to be considered as a detected alarm.
WATCH BOOL 1 = Enables the detected alarm monitoring depending on the
dynamic conditions of the process.
TONSP TIME Timing set-point for digital input connection (CHIN).
TOFFSP TIME Timing set-point for digital input disconnection (CHIN).

156 EIO0000002093 04/2020

 DINPUT

Outputs

Output Parameter Description

Parameter Type Description

PV BOOL Timed input value
The PV calculation that the DFB performs based on the value of the inputs
and the STW input/output is detailed in the following table:
STW.SIMMD CHFAILURE PV
ON - STW.SIM
OFF ON BADPV
OFF OFF Timed CHIN (TONSP/TOFFSP)
ALARM BOOL 1 = Detected alarm evaluated based on the PV value and the DFB
configuration is described in the following table:
STW.ALARMEN WATCH PV ALARMST ALARM
OFF - - - OFF
- OFF - - OFF
ON ON OFF OFF ON
ON ON OFF ON OFF
ON ON ON OFF OFF
ON ON ON ON ON

EIO0000002093 04/2020 157

DINPUT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

DINPUT_ST DINPUT_ST_DDT Provides the DFB status and configuration.

DINPUT_ST_DDT Type

Name Type Description

STW WORD Provides the discrete input status usually used from
the monitoring subsystem. Read-only access to the
data contained in this word.
CFGW WORD Provides the means to configure the DFB behavior.
Read-only access to the data contained in this word.

DINPUT_ST.CFGW Word Structure:

Bit Name Description

0 ALARMEN Enables the detected alarm evaluation to be enabled (1) or disabled
(0).
1 SIMMD Enables the digital input to be set to simulation mode (1) or normal (0).
2 SIM Enables the simulated input value to be selected.

DINPUT_ST.STW Word Structure:

Bit Name Description

0 PV Refer to the PV output pin (see page 157).
1 ALARM Refer to the ALARM output pin (see page 157).
2 BADST Indicates whether the input channel is operational or not. Reproduces
the CHFAILURE input value.
3 WATCH Indicates if the detected alarm is being monitored. Reproduces the
WATCH input value.
4 ALARMST PV value needs to be considered as a detected alarm. Reproduces the
ALARMST input value.
5 INPUTVALUE Indicates the channel value.

158 EIO0000002093 04/2020

 DINPUT

Public Variables

Public Variable Description

Variable Type Description

SC DINPUT_SC_DDT Provides the frequently needed data to monitor
the discrete input status from the sequential
control.

DINPUT_SC_DDT Type

Name Type Description

PV BOOL Read-only access
Refer to the PV output pin (see page 157).
ALARM BOOL Read-only access
Refer to the DINPUT_ST.STW.ALARM
input/output pin (see page 158).

EIO0000002093 04/2020 159

DINPUT

160 EIO0000002093 04/2020

 Modicon Libraries General Purpose
DOUTPUT
EIO0000002093 04/2020

Chapter 19
DOUTPUT - Digital Output Conditioning

DOUTPUT - Digital Output Conditioning

Overview
This chapter describes the DOUTPUT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 162
DFB Representation 163
Inputs 164
Outputs 165
Inputs/Outputs 166
Public Variables 167

EIO0000002093 04/2020 161

DOUTPUT

Description

General
The DOUTPUT DFB is used to condition a digital signal usually associated with a physical output.
The DFB provides interlocking, diagnosis, and owner management functions.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Diagnosis The DFB manages the diagnostic status of the signal if the periphery used provides
it.
Interlocking The DFB enables to move to the defined position if an active interlock that requires
this move is detected. An interlock bypass function is available.
Owner The DFB manages control system level, which is the owner (Operator or Program).
As a result, it is responsible for setting the set-point to the desired position.

162 EIO0000002093 04/2020

 DOUTPUT

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 163

DOUTPUT

Inputs

Input Parameter Description

Parameter Type Description

CHFAILURE BOOL 1 = Indicates to the DFB that the output channel associated with the CHOUT
output is operational.
RSP BOOL 1 = Remote set-point. Usually set by the continuous control; for example, by a
PID controller output.
ILCKSP BOOL 1 = Set-point needs to be used when the DFB is interlocked. Refer to the ILCK
input.
ILCK BOOL 1 = Interlocks the device at the defined position.

164 EIO0000002093 04/2020

 DOUTPUT

Outputs

Output Parameter Description

Parameter Type Description

CHOUT BOOL 1 = Calculated value of the output.
The output calculation that the DFB performs is detailed in the following table:
SC.ILCKD CHOUT
ON ILCKSP
OFF SP
SP BOOL 1 = Current set-point.
The output calculation that the DFB performs is detailed in the following table:
OWNER OFF: REM SP
Program; ON:
Operator
OFF OFF SC.LSP
OFF ON RSP
ON - DOUTPUT_ST.CFGW.LSP
TRACK BOOL 1 = Determines that the remote set-point (RSP input) is one being considered for the
CHOUT output calculation. This output is usually used to report to the algorithm
connected to the RSP input (that is, a PID) whether the control loop is open (TRACK
is 1) or not (TRACK is 0) so that it can be repositioned based on the output set-point
that is actually in effect.
The output calculation that the DFB performs is detailed in the following table:
SC.ILCKD OWNER REM TRACK
ON - - ON
OFF OFF OFF ON
OFF OFF ON OFF
OFF ON - ON

EIO0000002093 04/2020 165

DOUTPUT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

DOUTPUT_ST DOUTPUT_ST_DDT Provides the DFB status and configuration.

DOUTPUT_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and allows
data to be kept in the memory. Read-only access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem. Read/write
access to the data contained in this word.

DOUTPUT_ST.CFGW Word Structure:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or the Operator (1).
1 ILCKBP Read/write access
Enables the interlock to be bypassed (1).
2 LSP Read/write access
This variable indicates the current set-point and is internally calculated in the DFB when
the owner is not the Operator (if equal to the SP output). In which case, you can modify it
from the monitoring subsystem.

DOUTPUT_ST.STW Word Structure

Bit Name Description

0 BADST Indicates if the output channel is not operational. Reproduces the CHFAILURE input value.
1 ILCK Refer to the ILCK input pin (see page 164)
2 REM Refer to the SC.REM public variable (see page 167).
3 OP DFB status.

166 EIO0000002093 04/2020

 DOUTPUT

Public Variables

Public Variable Description

Variable Type Description

SC DOUTPUT_SC_DDT Provides the frequently needed data to monitor and control the analog
output status from the sequential control.

DOUTPUT_SC_DDT Type

Name Type Description

OWNER BOOL Read-only access
Refer to the DOUTPUT_ST.CFGW.OWNER input/output pin (see page 166).
LSP BOOL Read/write access
Enables the sequential control to assign the local set-point if the owner is the
Program (OWNER is 0), and the selected set-point is Local (SC.REM is 0).
Otherwise, the current set-point (SP output) is continuously copied to this
variable.
REM BOOL Read/write access
Enables the DFB to be configured for remote set-point—RSP—(1) or local set-
point—LSP – (0).
SP BOOL Read-only access
Refer to the SP output pin (see page 165).
OP BOOL Read-only access
TRACK BOOL Read-only access
Refer to the TRACK output pin (see page 165).
BADST BOOL Read-only access (see page 166)
ILCKD BOOL Read-only access
The signal evaluation depending on the ILCK input and the
DOUTPUT_ST.CFGW.ILCKBP input/output is shown in the following table:
ILCK ILCKBP SC.ILCKD
OFF - OFF
ON OFF ON
ON ON OFF

EIO0000002093 04/2020 167

DOUTPUT

168 EIO0000002093 04/2020

 Modicon Libraries General Purpose
MAINPUT1
EIO0000002093 04/2020

Chapter 20
MAINPUT1 - Conditioning of Multiple Analog Inputs with Configurable Range

MAINPUT1 - Conditioning of Multiple Analog Inputs with

Configurable Range

Overview
This chapter describes the MAINPUT1 DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 170
DFB Representation 171
Inputs 172
Outputs 174
Inputs/Outputs 175
Public Variables 178

EIO0000002093 04/2020 169

MAINPUT1

Description

General
The MAINPUT1 DFB is used to condition up to four analog signals normally coming from physical
inputs and allows selecting one of them based on the chosen criterion. You can configure the range
from the Supervision system.
The DFB provides linear scaling, cut-off, diagnosis, and simulation functions.
You can supplement MAINPUT1 with two other DFBs of the General Purpose library:
 AALARM: Allows you to incorporate functions to evaluate the alarms associated with the
measurement.
 ACALC: Allows you to incorporate calculations on the analog input.

Function Description
The main functions of the DFB are described in the table:

Function Description
Scaling Scales the input signals (normally in raw data) to engineering units by using a linear function.
You can configure the range of the signals externally (normally from the Supervision system)
within the range that is configured in the program, which is running in the controller. Enter
values in engineering units.
Cut-Off You can configure a minimum value, which is called the cut-off value. If the measured value
received from the transmitter is below the cut-off value, the measured value is not useable.
In such case, the cut-off value is considered.
You can configure the cut-off value externally; normally through the Supervision system.
Enter a value in engineering units within the range that is configured in the program, which
is running in the controller
Diagnosis The DFB manages the diagnostic status of the signal if the peripherals used provide this
signal, and assigns the value that is to be used if the signal is not working properly.
You can configure the value (normally through the Supervision system) that is to be used if
the signal is not working properly externally. Enter a value in engineering units within the
range that is configured in the program, which is running in the controller.
Simulation You can configure the DFB to allow you to enter the value that needs to be used (in
engineering units).
This option enables you to conduct tests on the programming associated with the DFB from
the Supervision system.
Selection The DFB allows you to select one analog signal among the input signals based on one of
the following criteria:
 Priority
 Direct selection
 Median
 Average
 Minimum
 Maximum

170 EIO0000002093 04/2020

 MAINPUT1

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 171

MAINPUT1

Inputs

Input Parameter Description

Parameter Type Description

CHIN1 INT Channel 1 input signal. Normally corresponds to a value in raw data coming
from the input/output peripherals.
CHFAILURE1 BOOL 1 = Indicates to the DFB that the input channel associated with the CHIN1 input
is operational.
CHIN2 INT Channel 2 input signal. Normally corresponds to a value in raw data coming
from the input/output peripherals.
CHFAILURE2 BOOL 1 = Indicates to the DFB that the input channel associated with the CHIN2 input
is operational.
CHIN3 INT Channel 3 input signal. Normally corresponds to a value in raw data coming
from the input/output peripherals.
CHFAILURE3 BOOL 1 = Indicates to the DFB that the input channel associated with the CHIN3 input
is operational.
CHIN4 INT Channel 4 input signal. Normally corresponds to a value in raw data coming
from the input/output peripherals.
CHFAILURE4 BOOL 1 = Indicates to the DFB that the input channel associated with the CHIN4 input
is operational.
HIRAW INT High range of the CHIN1 to CHIN4 input signals.
LORAW INT Low range of the CHIN1 to CHIN4 input signals.
HIPV REAL Maximum permissible value of the high range of measurement in engineering
units (PV output) corresponding to the maximum value (configured in the
HIRAW input) of the CHIN1 to CHIN4 inputs. Used as the high range by default
if the high range has not been modified from the monitoring subsystem
(MAINPUT1_CFG.CHIPV).
LOPV REAL Minimum permissible value of the low range of measurement in engineering
units (PV output) corresponding to the minimum value (configured in the LORAW
input) of the CHIN1 to CHIN4 inputs. Used as the low range by default if the low
range has not been modified from the monitoring subsystem
(MAINPUT1_CFG.CLOPV).
MAXDEV REAL Maximum permissible standard deviation for showing a detected alarm.
TONSP TIME Time for connecting the detected alarm due to standard deviation.
TOFFSP TIME Time for disconnecting the detected alarm due to standard deviation.

172 EIO0000002093 04/2020

 MAINPUT1

Parameter Type Description

RSEL INT Enables to select the selection method as shown in the following table:
RSEL PV is calculated as:
0 First value of the possible PVx signals that are enabled
and without a detected fault. (PV1 has maximum priority,
PV4 has minimum priority).
1 PV1
2 PV2
3 PV3
4 PV4
5 Median of signals enabled and without a detected fault.
6 Average value of signals enabled and without a detected
fault.
7 Minimum value among the enabled PVx signals.
8 Maximum value among the enabled PVx signals.

EIO0000002093 04/2020 173

MAINPUT1

Outputs

Output Parameter Description

Parameter Type Description

PV1..PV4 REAL Calculated measurement value normally in engineering units.
The DFB calculates the PVx measurement based on the value of the inputs and of
the MAINPUT1_ST and MAINPUT1_CFG inputs/outputs. PVx measurement is
shown in the following table:
CHFAILUREx CHINx PVx is calculated as:
ON - MAINPUT1_CFG.BADPV
OFF <= LORAW MAINPUT1_CFG.CLOPV

OFF > LORAW and < Refer to the formula.

HIRAW
OFF >= HIRAW MAINPUT1_CFG.CHIPV
PV REAL Value of the output (PVx) selected with the input signal.
ISGOOD BOOL 1 = Indicates the following:
 quality of the current selection
 selection is correct
 channel is functional
 simulation mode is inactive
SELD INT Selected selection method.
MEDIAN REAL Median of PVx signals enabled and without a detected fault.
AVG REAL Average of PVx signals enabled and without a detected fault.
DEV REAL Standard deviation of the channels that are enabled and without a detected fault.
DEVALM BOOL 1 = The standard deviation is higher than the maximum value specified with the
MAXDEV input.

Linear Scaling formula:

If the resulting value of the calculation is less than MAINPUT1_CFG.CUTOFFPV (and the signal
comes from the CHINx input), the PVx output is set to match the MAINPUT1_CFG.CLOPV
input/output.

174 EIO0000002093 04/2020

 MAINPUT1

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

MAINPUT1_ST MAINPUT1_ST_DDT Provides the necessary data for monitoring the DFB status and
configuring its simulation when required.
MAINPUT1_CFG MAINPUT1_CFG_DDT Provides the data needed to configure the DFB normally from the
monitoring subsystem.

MAINPUT1_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and allows
data to be kept in the memory. Read-only access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem. Read/write
access to the data contained in this word.
PV REAL Read-only access
Refer to the PV output pin (see page 174).

MAINPUT1_CFG_DDT Type

Name Type Description

PV1 REAL Read-only access
Refer to the PV1 output pin (see page 174).
PV2 REAL Read-only access
Refer to the PV2 output pin (see page 174).
PV3 REAL Read-only access
Refer to the PV3 output pin (see page 174).
PV4 REAL Read-only access
Refer to the PV4 output pin (see page 174).
SIM REAL Read/write access
Enables to select the value of the simulated measurement in engineering units.
CHIPV REAL High range of the measurement in engineering units (PVx outputs) corresponding
to the maximum value (configured in the HIRAW input) of the CHINx inputs.
The maximum value that this variable can assume is limited by the value of the
HIPV input.
If the range entered from the monitoring system is incorrect
(MAINPUT1_CFG.CLOPV = MAINPUT1_CFG.CHIPV = 0.0), it is initialized with the
value of the HIPV input.

EIO0000002093 04/2020 175

MAINPUT1

Name Type Description

CLOPV REAL Low range of the measurement in engineering units (PVx outputs) corresponding
to the minimum value (configured in the HIRAW input) of the CHINx inputs.
The minimum value that this variable can assume is limited by the value of the
LOPV input.
If the range entered from the monitoring system is incorrect
(MAINPUT1_CFG.CLOPV = MAINPUT1_CFG.CHIPV = 0.0), it is initialized with the
value of the LOPV input.
BADPV REAL Value needs to be used in engineering units (PVx output signals) when the
channel is not operational.
The value that this variable can assume is limited by the range configured in
engineering units (MAINPUT1_CFG.CLOPV and MAINPUT1_CFG.CHIPV).
If the range entered from the monitoring system is incorrect
(MAINPUT1_CFG.CLOPV = MAINPUT1_CFG.CHIPV = 0.0), it is initialized with
the value of the HIPV input.
CUTOFFPV REAL Value (in engineering units) resulting from the scaling calculation and below which
the value entered into the MAINPUT1_CFG.CLOPV input/output needs to be used
as the measurement value (PVx outputs).
The value that this variable can assume is limited by the low range configured in
engineering units (MAINPUT1_CFG.CLOPV).
If the range entered from the monitoring system is incorrect
(MAINPUT1_CFG.CLOPV = MAINPUT1_CFG.CHIPV = 0.0), it is initialized with the
value of the LOPV input.
PVW WORD Status word for the various PVx input channels.
LSEL INT Read/write access
Enables to select the selection criterion of the operator (OWNER = 1) from the
monitoring subsystem. As long as the set-point is defined by the Program (OWNER
= 0), the DFB will update the value continuously.

MAINPUT1_ST.STW Word Structure

Bit Name Description

0 BADST Indicates whether or not the input channel is operational. Reproduces the value of the
CHFAILURE input if the CHIN input signal (EXTPVEN = 0) is used.
1 CHFAIL One or more non-operational channel.
2 DEVALM Refer to the DEVALM output pin (see page 174).

176 EIO0000002093 04/2020

 MAINPUT1

MAINPUT1_ST.CFGW Word Structure

Bit Name Description

0 SIMMD Read/write access
Enables to put the analog input in Simulation (1) mode or Normal (0) mode.
1 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or Operator (1).

MAINPUT1_CFG.PVW Word Structure

Bit Name Description

0 PV1EN PV1 selection enabled
Enabled when a variable or value is connected to input CHIN1.
1 PV2EN PV2 selection enabled
Enabled when a variable or value is connected to input CHIN2.
2 PV3EN PV3 selection enabled
Enabled when a variable or value is connected to input CHIN3.
3 PV4EN PV4 selection enabled
Enabled when a variable or value is connected to input CHIN4.
4 PV1FAIL Detected error on signal PV1. PV1EN = 1 and CHFAILURE1 = 1.
5 PV2FAIL Detected error on signal PV2. PV2EN = 1 and CHFAILURE2 = 1.
6 PV3FAIL Detected error on signal PV3. PV3EN = 1 and CHFAILURE3 = 1.
7 PV4FAIL Detected error on signal PV4. PV4EN = 1 and CHFAILURE4 = 1.

EIO0000002093 04/2020 177

MAINPUT1

Public Variables

Public Variable Description

Variable Type Description

SC MAINPUT1_SC_DDT Provides the frequently needed data to monitor the status of the
DFB from the sequential control.

MAINPUT1_SC_DDT Type

Name Type Description

PV REAL Read-only access
Refer to the PV output pin (see page 174).
LSEL INT Read/write access. Enables to assign the local set-point normally for the sequential
control if the owner is the Program (OWNER input/output is set to 0), and the selected
set-point is Local (SC.REM public variable is set to 0). Otherwise, the current set-point
(SELD output) is continuously copied to this variable.
ISGOOD BOOL Read-only access
Refer to the ISGOOD output pin (see page 174).
REM BOOL Read/write access
Allows the DFB to be configured for a remote set-point -RSEL- (1) or local set-point -
LSEL- (0).
OWNER BOOL Read/write access
Refer to the MAINPUT1_ST.CGFW.OWNER input/output pin (see page 175).

178 EIO0000002093 04/2020

 Modicon Libraries General Purpose
STAHL Resources
EIO0000002093 04/2020

Chapter 21
STAHL

STAHL

Overview
This chapter describes the DFBs to process data of modules of the STAHL IS1 Remote
I/O system.
These function blocks do not reflect any specific installation.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000002093 04/2020 179

STAHL Resources

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
21.1 STAHLAI8CH for STAHL 8-Channel Analog Input Modules 181
21.2 STAHLAO8CH for STAHL 8-Channel Analog Output Modules 186
21.3 STAHLDI16CH for STAHL 16-Channel Digital Input Modules 191
21.4 STAHLDO8 for STAHL 8-Channel Digital Output Modules 196
21.5 STAHLHARTVal4 - Processing of Four HART Values 201
21.6 STAHLHARTVal8 - Processing of Eight HART Values 206

180 EIO0000002093 04/2020

 STAHL Resources

Section 21.1
STAHLAI8CH for STAHL 8-Channel Analog Input Modules

STAHLAI8CH for STAHL 8-Channel Analog Input Modules

Overview
This section describes the STAHLAI8CH DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 182
DFB Representation 183
Inputs 184
Outputs 185

EIO0000002093 04/2020 181

STAHL Resources

Description

General
The STAHLAI8CH DFB allows reading analog input signal values and signal quality data of STAHL
8-channel analog input modules.

182 EIO0000002093 04/2020

 STAHL Resources

DFB Representation

Representation
The following figure shows the STAHLAI8CH DFB as it appears in an FBD section:

EIO0000002093 04/2020 183

STAHL Resources

Inputs

Input Parameter Description

Parameter Type Description

CHx INT Signal value of channel x from the STAHL analog input module.
CHxFailure BOOL 1 = Healthy
Diagnostic information of channel x from the STAHL analog input module.
NOTE: Refer to the operating instructions of the STAHL module for troubleshooting
information.
x represents the channel number (0 to 7).

184 EIO0000002093 04/2020

 STAHL Resources

Outputs

Output Parameter Description

Parameter Type Description

Valuexx...ValueXX INT Signal value of channels 01 to 08.
Failurexx...Failurexx BOOL 0 = Healthy
Status of channels 01 to 08.
xx represents the channel number (01 to 08).

EIO0000002093 04/2020 185

STAHL Resources

Section 21.2
STAHLAO8CH for STAHL 8-Channel Analog Output Modules

STAHLAO8CH for STAHL 8-Channel Analog Output Modules

Overview
This section describes the STAHLAO8CH DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 187
DFB Representation 188
Inputs 189
Outputs 190

186 EIO0000002093 04/2020

 STAHL Resources

Description

General
The STAHLAO8CH DFB allows writing the analog output signal value to STAHL 8-channel analog
output modules. It also reads the signal quality data from each channel.

EIO0000002093 04/2020 187

STAHL Resources

DFB Representation

Representation
The following figure shows the STAHLAO8CH DFB as it appears in an FBD section:

188 EIO0000002093 04/2020

 STAHL Resources

Inputs

Input Parameter Description

Parameter Type Description

CHx INT Signal value for channel x.
CHxFailure BOOL 1 = Healthy
Diagnostic information of channel x from the STAHL analog output module.
NOTE: Refer to the operating instructions of the STAHL module for
troubleshooting information.
x represents the channel number (0 to 7).

EIO0000002093 04/2020 189

STAHL Resources

Outputs

Output Parameter Description

Parameter Type Description

Valuexx...Valuexx INT Provides signal value to channels 0 to 7 of the STAHL analog
output module.
Failurexx...Failurexx BOOL 0 = Healthy
Status of channels 0 to 7.
xx represents the channel number (01 to 08).

190 EIO0000002093 04/2020

 STAHL Resources

Section 21.3
STAHLDI16CH for STAHL 16-Channel Digital Input Modules

STAHLDI16CH for STAHL 16-Channel Digital Input Modules

Overview
This section describes the STAHLDI16CH DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 192
DFB Representation 193
Inputs 194
Outputs 195

EIO0000002093 04/2020 191

STAHL Resources

Description

General
The STAHLDI16CH DFB allows reading the digital input signal value and signal quality data of
STAHL 16-channel digital input modules.

192 EIO0000002093 04/2020

 STAHL Resources

DFB Representation

Representation
The following figure shows the STAHLDI16CH DFB as it appears in an FBD section:

EIO0000002093 04/2020 193

STAHL Resources

Inputs

Input Parameter Description

Parameter Type Description

CHx BOOL 1 = Signal value of channel x from the STAHL digital input module.
CHxFailure BOOL 1 = Healthy
Diagnostic information of channel x from the STAHL digital input module
NOTE: Refer to the operating instructions of the STAHL module for
troubleshooting information.
x represents the channel number (0 to 15).

194 EIO0000002093 04/2020

 STAHL Resources

Outputs

Output Parameter Description

Parameter Type Description

Valuexx...Valuexx BOOL Signal value of channels 0 to 15.
Failurexx...Failurexx BOOL 0 = Healthy
Status of channels 0 to 15.
xx represents the channel number (01 to 16).

EIO0000002093 04/2020 195

STAHL Resources

Section 21.4
STAHLDO8 for STAHL 8-Channel Digital Output Modules

STAHLDO8 for STAHL 8-Channel Digital Output Modules

Overview
This section describes the STAHLDO8CH DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 197
DFB Representation 198
Inputs 199
Outputs 200

196 EIO0000002093 04/2020

 STAHL Resources

Description

General
The STAHLDO8CH DFB allows writing digital output signal values to STAHL 8-channel digital output
modules. It also reads the signal quality data from each channel.

EIO0000002093 04/2020 197

STAHL Resources

DFB Representation

Representation
The following figure shows the STAHLDO8CH DFB as it appears in an FBD section:

198 EIO0000002093 04/2020

 STAHL Resources

Inputs

Input Parameter Description

Parameter Type Description

CHx BOOL 1 = Signal value for channel x.
CHxFailure BOOL 1 = Healthy
Diagnostic information of channel x from the STAHL digital output module.
NOTE: Refer to the operating instructions of the STAHL module for
troubleshooting information.
x represents the channel number (0 to 7).

EIO0000002093 04/2020 199

STAHL Resources

Outputs

Output Parameter Description

Parameter Type Description

Valuexx...Valuexx BOOL 1 = Provides signal value to channels 0 to 7 of the
STAHL digital output module.
Failurexx...Failurexx BOOL 0 = Healthy
Status of channels 0 to 7.
xx represents the channel number (01 to 08).

200 EIO0000002093 04/2020

 STAHL Resources

Section 21.5
STAHLHARTVal4 - Processing of Four HART Values

STAHLHARTVal4 - Processing of Four HART Values

Overview
This section describes the STAHLHARTVal4 DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 202
DFB Representation 203
Inputs 204
Outputs 205

EIO0000002093 04/2020 201

STAHL Resources

Description

General
The STAHLHARTVal4 DFB allows processing four HART values through a STAHL 8-channel
analog input module HART. For each HART value, the DFB converts the high and low register
values into one output value of data type Real.

202 EIO0000002093 04/2020

 STAHL Resources

DFB Representation

Representation
The following figure shows the STAHLHARTVal4 DFB as it appears in an FBD section:

EIO0000002093 04/2020 203

STAHL Resources

Inputs

Input Parameter Description

Parameter Type Description

HARTInxH INT Receives the high register value of HART value x from the
STAHL module.
HARTInxL INT Receives the low register value HART value x from STAHL
module.
[x] is used to identify the HART values (1...4).

204 EIO0000002093 04/2020

 STAHL Resources

Outputs

Output Parameter Description

Parameter Type Description

HARTValuex REAL Result of the conversion of inputs x into HART value x.
[x] is used to identify the HART values (1...4).

EIO0000002093 04/2020 205

STAHL Resources

Section 21.6
STAHLHARTVal8 - Processing of Eight HART Values

STAHLHARTVal8 - Processing of Eight HART Values

Overview
This section describes the STAHLHARTVal8 DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 207
DFB Representation 208
Inputs 209
Outputs 210

206 EIO0000002093 04/2020

 STAHL Resources

Description

General
The STAHLHARTVal8 DFB allows processing eight HART values through a STAHL 8-channel
analog input module HART. For each HART value, the DFB converts the high and low register
values into one output value of data type Real.

EIO0000002093 04/2020 207

STAHL Resources

DFB Representation

Representation
The following figure shows the STAHLHARTVal8 DFB as it appears in an FBD section:

208 EIO0000002093 04/2020

 STAHL Resources

Inputs

Input Parameter Description

Parameter Type Description

HARTInxH INT Receives the high register value of HART value x from the STAHL module.
HARTInxL INT Receives the low register value HART value x from STAHL module.
[x] is used to identify the HART values (1...8).

EIO0000002093 04/2020 209

STAHL Resources

Outputs

Output Parameter Description

Parameter Type Description

HARTValuex REAL Result of the conversion of inputs x into HART value x.
[x] is used to identify the HART values (1...4).

210 EIO0000002093 04/2020

 Modicon Libraries General Purpose
TOTAL
EIO0000002093 04/2020

Chapter 22
TOTAL - Totalizing Function

TOTAL - Totalizing Function

Overview
This chapter describes the TOTAL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 212
DFB Representation 215
Inputs 216
Outputs 221
Inputs/Outputs 224
Public Variables 226

EIO0000002093 04/2020 211

TOTAL

Description

General
The objective of TOTAL block is to perform totalizer calculation based on 3 inputs (analog signal,
digital pulses, counter).

Function Description
The main functions of the DFB are described in the following table:

Function Description
Control Controls start and stop of totalization of the input from field
equipment/instrument.
Owner selection The DFB manages the control system level, as to which is the owner (operator
or program). As a result, it is responsible for setting the setpoint for the desired
position.
Totalizing The totalization is done using trapezoidal rule algorithm for analog inputs,
while it is summation for digital as well as counter values.
Monitoring Enables the user to monitor the totalized value, last totalized value, setpoint
and active operation state.
Processing states and The DFB processes the commands received from Supervision function and
Commands determines the active operation state.
Local and remote setpoint Enables to monitor totalized value with the setpoint that is determined through
a setpoint selector (local or remote). The local set-point is assigned to the
sequential control or to command received from the monitoring system. At the
same time, remote setpoint is assigned to DFB control from the logic
implemented in continuous control.

212 EIO0000002093 04/2020

 TOTAL

State Chart
State chart explains the totalization operation

Commands and States

Command State
DFB initialization IDLE
Start IDLE → RUNNING
Hold  RUNNING → HELD
 HELDFORERROR → HELD

Restart HELD → RUNNING

Stop  HELD → STOPPED
 HELDFORERROR → STOPPED

Reset STOPPED→ IDLE

AutoReset STOPPED→ IDLE (automatically performs reset operation without consuming
any extra execution cycle)
AutoStart IDLE → RUNNING (automatically performs start operation without consuming
any extra execution cycle)

EIO0000002093 04/2020 213

TOTAL

Commands and States with respect to FAIL Input pin

FAIL Input Pin Value Last Active State Command Current Active State
0 IDLE Start RUNNING
0 RUNNING Hold HELD
0 RUNNING Stop STOPPED
0 HELD Restart RUNNING
0 STOPPED Reset IDLE
1 IDLE Start HELDFORERROR
1 RUNNING - HELDFORERROR
1 HELDFORERROR Hold HELD
1 HELDFORERROR Stop STOPPED
1 HELD - HELD
1 STOPPED - STOPPED
1 STOPPED Reset IDLE

214 EIO0000002093 04/2020

 TOTAL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller

EIO0000002093 04/2020 215

TOTAL

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Rising edge on this input resets DFB internal timers, data, etc.
NOTE:
 The input is not reset (0) by the DFB.
 The reference value is updated with the latest value.
PVFLOW REAL Process flow value of the measurement in engineering units.
NOTE:
 It is mandatory to connect the input pin to either a variable or
other blocks to use this DFB in this mode.
 Negative values of PV are not considered for totalization.
PVPULSE BOOL This input pin accepts series of pulses sent from the field
equipment/instrument.
NOTE:
 Only rising edge is considered.
 It is mandatory to connect the input pin to either a variable or
other blocks to use this DFB in this mode.
PVCOUNT_UDINT UDINT This input pin accepts a count value of an unsigned double integer
data type sent from the field equipment/instrument.
NOTE:
 Only upcounter is supported.
 It is mandatory to connect the input pin to, either a variable or
other blocks to use this DFB in this mode.
 If ROLLOVERCOUNT is not declared then the rollover count is
considered to be 4294967295 in this mode.
PVCOUNT_UINT UINT This input pin accepts a count value of an unsigned integer data
type sent from the field equipment/instrument.
NOTE:
 Only upcounter is supported.
 It is mandatory to connect the input pin to, either a variable or
link to other blocks to use this DFB in this mode.
 If ROLLOVERCOUNT is not declared then the rollover count is
considered to be 65535 in this mode.

216 EIO0000002093 04/2020

 TOTAL

Parameter Type Description

SCANRATE TIME Only applicable for PVFLOW. Allows the user to configure sample
acquisition time. The DFB takes a sample each time, a time equal
to or greater than the one configured for this input has elapsed. For
calculation purposes, the time elapsed between one DFB
execution and another is taken into account.
NOTE: If no value provided, then default value T#1s is considered
as SCANRATE. User need to verify that the DFB execution
parameters are compatible with the time configured in SCANRATE
parameter; this allows the DFB to run with a high frequency to
carry out sampling with the configured time including latency time.
In any case, the DFB considers any possible execution delays
regarding the theoretical time adjusted in this parameter when it
comes to calculations.

EIO0000002093 04/2020 217

TOTAL

Parameter Type Description

K REAL Conversion factor is applied to the totalizing calculation output.
This allows the total to be calculated in the desired engineering
units.
NOTE:
 Constant K is one time configuration.
 K is considered only when the DFB has a transition from IDLE
state to RUNNING state.
 Negative integers are not valid.
 If K=0. Then, the default value taken will be 1.0.

For example,
Case 1
 SCANRATE = 1s
 Constant flow rate = 1 Litre per hour at 9.00 AM.

Totalized value in Litres at 11.00 AM is as below.

AuxTotal is considered to be internal variable. Total is the output
of DFB.
AuxTotal = 7200L × second / hr.
K to be configured as (second / hour) which turns out to be,
K =(1/3600) = 0.00027
Total = AuxTotal × K
Total = 7200 × 0.00027
Total = 2 Litres.

Case 2
 Scanrate = 500ms
 Constant Flow rate = 1 Litre per hour at 9.00 AM.
User wants to see totalized value in Litres at 11.00 AM.
AuxTotal is considered to be internal variable. Total is the output
of DFB.
AuxTotal = 14400 [(L× 500ms)/hr.]
K to be configured as (millisecond/hour).
[(500 × 0.001)/3600] = 0.000139
Total = AuxTotal × K
Total = 14400 × 0.000139
Total=2 Litres.

218 EIO0000002093 04/2020

 TOTAL

Parameter Type Description

ROLLOVERCOUNT UDINT The rollover to be declared as the maximum PV value provided to
the input pin of PVCOUNT_UDINT or PVCOUNT_UINT.
NOTE:
 It is mandatory to connect the input pin to, either a variable or
link to other blocks to use this DFB in this mode.
 If ROLLOVERCOUNT is not declared then
 if PVCOUNT_UDINT is selected then rollover count is
considered to be 4294967295.
 If PVCOUNT_UINT is selected then rollover count is
considered to be 65535.
 If ROLLOVERCOUNT is not declared, also if PVCOUNT_UDINT is
not selected or if PVCOUNT_UINT is not selected then rollover
count is set to 0.
 If input value is greater than rollover count then totalizing is
deemed to be valid. Although rollover is not considered after
this scenario.
 In case the counter is restarted, wherein rollover is invalid, then
user has to verify that the rising edge is triggered to INITDFB
to reinitialize totalizing operation before providing new input to
the DFB. The total value is not affected during reinitialize.
For example,
Case 1: If rollover count is 10. The total when input value changes
from 0 to 5 is, 5. Continuing, when input value changes from 5 to
9, the total will be 9. Further, when the input value rolls back from
9 to1, the total will be 11.

Case 2: If rollover count is not configured and PVCOUNT_UINT is

selected. The total when input value changes from 0 to 5 is, 5.
Continuing, when input value changes from 5 to 9, the total will be
9. Further, when the input value rolls back from 9 to 2, the total will
be 65537.
FAIL BOOL A detected error in the device/ module is indicated to the DFB.
NOTE: When channel becomes healthy, TOTAL starts to run
automatically
RSTART BOOL A rising edge sends a start command only when program/remote-
cascade mode is configured.
RHOLD BOOL A rising edge sends a hold command only when program/remote-
cascade mode is configured.
RRESTART BOOL A rising edge sends a restart command only when
program/remote-cascade mode is configured.
RSTOP BOOL A rising edge sends a stop command only when program/remote-
cascade mode is configured.

EIO0000002093 04/2020 219

TOTAL

Parameter Type Description

RRESET BOOL A rising edge sends a reset command only when program/remote-
cascade mode is configured.
AUTORESET BOOL When STOPPED state is reached, the function acts as it is receiving
a RESET command automatically (without consuming any extra
execution cycle). After RESET command, the operation will move
to IDLE state
AUTOSTART BOOL When IDLE state is reached, the function acts as it is receiving a
START command automatically (without consuming any extra
execution cycle). After START command, the operation will move
to RUNNING state.
RSP REAL This setpoint will be considered for processing DONE status.
The remote set point is considered only if the below conditions are
satisfied:
 SC.REM = 1
 Owner = Program

NOTE: The range of setpoint is:

 Lower value: 0.0
 Higher value: 999999999.9999999

NOTE: Priorities are set based on the inputs that are selected for totalization.
Default priorities set for the inputs:
 PVFLOW = 0
 PVPULSE = 1
 PVCOUNT_UDINT = 2
 PVCOUNT_UINT = 3

Lower the value, higher the priority, that is, 0 is the maximum priority. If more than one input is
connected, detected configuration error occurs. During detected configuration error, totalization
continues without any interruption based on the priorities of inputs that are set. Only during IDLE
state the user can change the input priorities.

220 EIO0000002093 04/2020

 TOTAL

Outputs

Output Parameter Description

Parameter Type Description

TOTAL REAL Present totalized value in engineering units. Refer Formula for
Totalization topic for additional information.
NOTE: TOTAL is reset to 0 when reset command given.
LASTTOTAL REAL Holds the last TOTAL value when reset command is executed.
SP REAL Current set point.
IDLE BOOL Inactive operation. Waiting for START command to start totalizer
operation.
RUNNING BOOL RUNNING state is reached after the START command is processed.
Totalizer operation starts calculating.
HELD BOOL HELD state is reached after the HOLD command is processed. Totalizer
operation is paused.
HELDFORERROR BOOL HELDFORERROR state is reached when failure is detected during
RUNNING state, due to which totalizer operation is paused.
NOTE: Totalizer operation runs automatically, if a failure is not detected
during HELDFORERROR state considering latest PV as reference PV.
STOPPED BOOL STOPPED state is reached after STOP command is processed. Requires
an initialization command (RESET) to go to inactive (IDLE) state.
DONE BOOL DONE state will be high when present total value reaches SP (setpoint).
Despite DONE state being high, TOTAL output will keep calculating/
totalizing.
NOTE: DONE state is not applicable when setpoint is 0.

EIO0000002093 04/2020 221

TOTAL

Parameter Type Description

DIAGNOSTICS TOTALStatus_ Structure reporting the detected errors and status of the DFB.
DDT
Parameter Description
KApplied Value of KApplied is captured for calculation when the state of DFB is
changed from IDLE state to RUNNING state.
INFO A word with a series of bits reporting the detected errors and status of
the DFB.
NOTE: In case the user requires an alarm to be generated for
conditions in the INFO word, the bit representing the detected error can
be connected to the CONDSUM DFB, which in turn is connected to the
FAIL input of TOTAL DFB.
 Bit 0: Detected configuration error.
NOTE: This condition is true when:
More than one input PV or no PV, which are PVFLOW, PVPULSE,
PVCOUNT_UDINT and PVCOUNT_UINT are connected.
PVCOUNT_UDINT, PVCOUNT_UINT value is more than the
configured value of ROLLOVERCOUNT.
 Bit 1: Input K is not valid.
NOTE:
 Range of K which can be configured is 0 to 1000 inclusive.
 KNOTVALID is checked only during RUNNING or HELD or
HELDFORERROR state.
 PV value is not added to total, when the value of K is out of range.

 Bit 2: Rollover flag.

NOTE: True of bit represents TOTAL has crossed
999999999.9999999 The totalizing operation is reset automatically.
 Bit 3: PVFLOW selected for totalization.
 Bit 4: PVPULSE selected for totalization.
 Bit 5: PVCOUNT_UDINT selected for totalization.
 Bit 6: PVCOUNT_UINT selected for totalization.
 Bit 7: Negative PVFlow value.
NOTE: PV value is not added to TOTAL, when PVFlow value is
negative.

222 EIO0000002093 04/2020

 TOTAL

Formula for Totalization

The Control function offers totalization of 3 type of inputs:
 Analog (REAL) - based on trapezoidal rule
Aux = (b-a) × [f(b)+f(a)]/2
AuxTotal = AuxTotal + Aux
Total = AuxTotal × K
 Digital Pulses (BOOL)
AuxTotal = AuxTotal + [Rising edge (Digital input)]
Total = AuxTotal × K
 Counter (LONG)
AuxTotal = AuxTotal + (Current - Last)]
Total = AuxTotal × K
Where:
b = Time in which the current sample is taken.
a = Time in which the previous sample was taken.
f(b) = Value of the current measurement.
f(a) = Value of the previous measurement.
NOTE: AuxTotal and Aux variables are used for internal calculation.

SP Calculation

Owner SC.REM Output SP is calculated as

Program 0 = OFF SC.LSP (Local Set Point)
Program 1 = ON SetPoint (Remote Setpoint from input pin of TOTAL DFB)
Operator - HMI/ faceplate of TOTAL function block

EIO0000002093 04/2020 223

TOTAL

Inputs/Outputs

Inputs/Outputs Parameter Description

Parameter Type Description

TOTAL_ST TOTAL_ST_DDT Data structure holds the minimum information
required for performing controlling and
monitoring functions. The information used by the
operator screen is readable and writable from the
HMI/ SCADA system.
TOTAL_CFG TOTAL_CFG_DDT Provides the data necessary to configure the
DFB (normally from the monitoring subsystem).

TOTAL_ST_DDT Type

Parameter Type Description

STATE INT Provides active state of the operation. Read-only access to the
data is contained in the integer.
State info:
 State = 1 (IDLE)
 State = 2 (RUNNING)
 State = 4 (HELD)
 State = 8 (HELDFORERROR)
 State = 16 (STOPPED)

COMMAND INT Enable commands to perform operation from the Supervision

system.
Command Info:
 Command = 1 (Start)
 Command = 2 (Hold)
 Command = 4 (Restart)
 Command = 8 (Stop)
 Command = 16 (Reset)
STW WORD Status Word.
 Bit 0: REM (0= Local; 1=Remote).
 Bit 1: DONE
 Bit 2: Alarm (HELDFORERROR)
 Bit 3: Rollover flag. Refer INFO parameter in Output
Parameter Description topic (see page 221).
 Bit 4: AUTOSTART
 Bit 5: AUTORESET

224 EIO0000002093 04/2020

 TOTAL

Parameter Type Description

CFGW WORD Provides the data needed to configure the DFB (normally from the
monitoring system). Enables to configure whether the set-point is
set by:
 Bit 0: Owner (0= Program; 1=Operator)
 Bit 3: Reset rollover flag
TOTAL REAL Present totalized value in engineering units. Refer Formula for
Totalization topic for additional information (see page 223).
TOTALINT UDINT Integer part of TOTAL in engineering units.
TOTALDEC REAL Decimal part of TOTAL in engineering units.
SP REAL This variable indicates what the current set-point is, and is
calculated internally in the DFB as long as the owner is not the
operator.
When owner is operator, the setpoint is configured from the HMI
system.
NOTE: The range of setpoint is:
 Lower value: 0.0
 Higher value: 999999999.9999999

TOTAL_CFG_DDT Type

Parameter Type Description

LASTTOTAL REAL The value on current total in engineering units when
it was reset.
LASTTOTALINT UDINT Integer part of LASTTOTAL in engineering units.
LASTTOTALDEC REAL Decimal part of LASTTOTAL in engineering units.

EIO0000002093 04/2020 225

TOTAL

Public Variables

Public Variable Description

Parameter Type Description

SC TOTAL_SC_DDT Provides the frequently needed data for monitoring
and controlling of the DFB.

TOTAL_SC_DDTType

Parameter Type Description

LSP REAL Enables to assign the local target set-point for the sequential control
if the program is the owner (OWNER input/output = OFF) and the
selected set point is local (SC.REM public variable = OFF). Otherwise,
the current target set-point is continuously copied to this variable.
NOTE: The range of setpoint is:
 Lower value: 0.0
 Higher value: 999999999.9999999
TOTAL REAL Present totalized value in engineering units. Refer Formula for
Totalization topic for additional information (see page 223).
NOTE: TOTAL is reset to 0 when reset command given.

226 EIO0000002093 04/2020

 TOTAL

Parameter Type Description

PROPERTIES WORD WORD bits are expressed as RANKED bit
Bit0 (REM):
 1 = Allows the DFB to consider commands from program remote
mode.
 0 = Allows the DFB to consider commands from program local
mode
Bit 1 (OWNER): Provides the data needed to configure the DFB
normally from the monitoring subsystem. Enables to configure
whether the set-point is set by
 0 = Program
 1 = Operator

Bit 2 (START): Command to start the operation of the TOTAL DFB

from IDLE to RUNNING state. It is only valid if the state is inactive
(IDLE).
Bit 3 (HOLD): Command to hold the operation of the TOTAL DFB from
RUNNING to HELD or HELDFORERROR to HELD state
Bit 4 (RESTART): Command to restart the operation of TOTAL DFB
from HELD to RUNNING state.
Bit 5 (STOP): Command to stop the operation of TOTAL DFB from
RUNNING to STOPPED or HELD to STOPPED state.
Bit 6 (RESET): Command to reset the operation of TOTAL DFB from
STOPPED to IDLE State.
Bit 7 (IDLE): Inactive operation. Waiting for START command to start
totalizer operation.
Bit 8 (RUNNING): RUNNING state is reached after the START
command is processed. Totalizer operation starts calculating.
Bit 9 (HELD): HELD state is reached after the HOLD command is
processed. Totalizer operation is paused.
Bit 10 (HELDFORERROR): HELDFORERROR state is reached when
failure is detected during RUNNING state, due to which totalizer
operation is paused.
Bit 11 (STOPPED): STOPPED state is reached after STOP command is
processed. Requires an initialization command (RESET) to go to
inactive (IDLE) state.
Bit 12 (CONFIGURATIONERROR): If more than one input is
connected, detected configuration error occurs.
Bit 13 (DONE): DONE state will be high when present total value
reaches SP (setpoint). Total output will keep calculating/ totalizing.
DONE state is not applicable when setpoint is 0.

EIO0000002093 04/2020 227

TOTAL

228 EIO0000002093 04/2020

 Modicon Libraries General Purpose
On/Off Device Control
EIO0000002093 04/2020

Part III
On/Off Device Control

On/Off Device Control

Overview
This part provides a detailed description of the functions, pins, pin layout, and variables of the
function blocks of the on/off device control family.
These function blocks do not reflect any specific installation.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000002093 04/2020 229

On/Off Device Control

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
23 DEVCTL - On/Off Device 231
24 DEVLP - Local Panel for Controlling On/Off Devices 245
25 DEVMNT - Device Maintenance 255
26 DUALOP - Dual Output 263
27 DUALOP1 - Dual Output with Dual Input 269
28 HVALVE - Manual Valve 275
29 MOTOR2 - 2 Speed/2 Rotation Direction Motor 283
30 MOTOR2LP - Local Panel for Controlling 2 Speed/2 Rotation Direction Motors 301
31 MVALVED - Discrete Motorized Valve 313
32 MVALVEDLP - Local Panel for Controlling Motorized On/Off Valves 323
33 DVALVE - Dual Output Valve 335

230 EIO0000002093 04/2020

 Modicon Libraries General Purpose
DEVCTL
EIO0000002093 04/2020

Chapter 23
DEVCTL - On/Off Device

DEVCTL - On/Off Device

Overview
This chapter describes the DEVCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 232
DFB Representation 233
Inputs 234
Outputs 236
Inputs/Outputs 240
Public Variables 242

EIO0000002093 04/2020 231

DEVCTL

Description

General
The DEVCTL DFB is used to manage on-off device-type control modules, such as on-off actuated
valves and discrete motors (without variable-frequency drives).
The DFB allows management of the associated devices from the sequential control, the continuous
control, and/or the monitoring subsystem. It depends on their configuration and the system needs.
User can supplement the DFB with the DEVMNT, CONDSUM, and CONDSUM1 DFB from the General
Purpose Library.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Control Controls the digital control signal of the element based on the configuration and the
commands that the DFB receives according to the functions.
Owner selection The DFB manages the control system level, which is the owner (operator or
program). As a result, it is responsible for setting the set-point for the desired
position.
Local and remote set- Enables to control the DFB with a set-point that is determined through a set-point
point selector (local or remote) in program owner. The local set-point is assigned from the
sequential control while the remote set-point is assigned to the DFB control from the
logic implemented in the continuous control.
Position detection Allows to determine the actual position of the element to be controlled and monitored
with the help of high and low limit switch.
Interlocking The DFB gives a command to the device to move to the defined position in case of
an active interlock. An interlock bypass function is available.
Simulation The DFB can be switched to simulation mode. Thus, the actual position of the
controlled device is considered to be the same as its desired position regardless of
the signals received from the position detectors.

The optional functions of the DFB are described in the following table:

Function Description
Inoperable device Allows to monitor inoperable device condition (optional). DFB can be configured to
withdraw output based on this condition.
Detection of not If position is not confirmed within a configured time after the output command is
confirmed operation activated, DFB detects not confirmed operation.
Manual resetting Allows you to reset manually after the detection of an inoperable device condition or
a not confirmed operation. After reset, device output will follow set point.

232 EIO0000002093 04/2020

 DEVCTL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 233

DEVCTL

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL If a rising edge is detected on this input, the internal timers of the block are
reset and detected alarms are set to 0.
ZSH BOOL 1 = Indicates to the DFB that high limit position is reached. Usually, it is used
to connect the digital input of a positioner limit switch.Refer the ZSHEN input.
ZSL BOOL 1 = Indicates to the DFB that low limit position is reached. Usually, it is used
to connect the digital input of a positioner limit switch.Refer the ZSLEN input.
FAIL BOOL 1 = Indicates to the DFB a detected error in the device.
Usually used to connect the digital thermal trip input of a motor switch. Refer
the FAILEN input.
ZSHEN BOOL 1 = Enables ZSH position detector monitoring.
ZSLEN BOOL 1 = Enables ZSL position detector monitoring.
FAILEN BOOL 1 = Enables the FAIL parameter.
CONFREARMEN BOOL  1 = Withdraws the output OP when a non-confirmed operation is detected
(ALARM = 1) and requires a mandatory manual resetting once the ALARM
condition disappears.
 0 = The output OP remains in its previous state when a non-confirmed
operation is detected (ALARM = 1) and does not need manual resetting
once the ALARM condition disappears.
Refer the TIMEOUT input and the DEVCTL_ST.STW.ALARM input/output.
FAILREARMEN BOOL  1 = Withdraws the output OP upon a detected failure condition (FAILD =
1) and requires a mandatory manual resetting once the FAIL condition
disappears.
 0 = The output OP remains in its previous state upon a detected failure
condition (FAILD = 1) and does not need manual resetting once the
FAIL condition disappears.
RSP BOOL Remote set-point by the continuous control.
ILCKSP BOOL 1 = Set-point needs to be used when the DFB is interlocked. Refer to the
ILCK input.
ILCK BOOL 1 = Interlocks the device at the defined position.
NOTE: If the device requires resetting (STW.REAMR = 1), the OP takes the
value = 0 regardless of the ILCKSP value waiting for the operator to carry
out the reset.

234 EIO0000002093 04/2020

 DEVCTL

Parameter Type Description

TIMEOUT TIME Enables to configure the maximum time that the devicetakes to reached
defined position. When the output is triggered, if the limit switch is not
detected even after the TIMEOUT time is elapsed. The device is switched
to detected alarm state if the limit switch is not detected. When it has a value
of 0, monitoring is deactivated.
SCANTIME TIME The minimum time for which the detected alarm signals are kept active.
SCANTIME confirms that the supervision system acquires the data for
detected alarms that are automatically reset.
EXTCTLD BOOL 1 = Indicates to the DFB whether the device is being controlled from outside
of the system.
Monitoring of confirmation alarms is stopped during external control. The
FAIL input continues to be evaluated.

EIO0000002093 04/2020 235

DEVCTL

Outputs

Output Parameter Description

Parameter Type Description

OP BOOL 1 = Command signal Active
Allows the control signal of the device to be connected.
Refer to the OP Calculation (see page 237).
SP BOOL 1 = Current device set-point
Refer to the SP Calculation (see page 237).
HIGHPOS BOOL 1 = Determines if the device has reached the position corresponding to the set-
point (SP) with a value of 1. It is evaluated by considering any detectors. Refer to
the output LOWPOS and input/output DEVCTL_ST.CFGW.SIMMD (see page 240).
Refer the HIGHPOS and LOWPOS Calculation (see page 238).
LOWPOS BOOL 1 = Determines if the device has reached the position corresponding to the set-
point (SP) with a value of 0. It is evaluated by considering any detectors. Refer to
the output HIGHPOS and input/output DEVCTL_ST.CFGW.SIMMD (see page 240).
Refer to the HIGHPOS and LOWPOS Calculation (see page 238).
ZSHPOS BOOL 1 = Indicates whether the position corresponding to the set-point (SP) with a value
of 1 has been reached. It is independent from the other detector if the ZSH detector
is available.
Refer to the ZSHPOS ans ZSLPOS Calculation (see page 238).
ZSLPOS BOOL 1 = Indicates whether the position corresponding to the set-point (SP) with a value
of 0 has been reached. It is independent of the other detector if the ZSL detector
is available.
Refer to the ZSHPOS ans ZSLPOS Calculation (see page 238).
ALARM BOOL 1 = The detection of a not confirmed operation has occurred. Refer the AAlarm
Behavior (see page 239) for monitoring details.
FAILD BOOL 1 = Indicates an inoperable device. It is evaluated according to the value of the
FAIL and FAILEN inputs. When it is activated, it is timed so that the signal is
maintained for a minimum of SCANTIME.
0 = After the minimum activation time has passed, it is only deactivated if the FAIL
input signal is deactivated.
Refer to the FAILD Calculation (see page 238).
OOS BOOL 1 = Indicates the device is out of service.

236 EIO0000002093 04/2020

 DEVCTL

OP Calculation
The evaluation of the device control depending on the interlock status, the current set-point, and if
the DFB requires resetting is shown in the following table:

STW.REARMR SC.ILCKD ILCKSP OP is calculated as:

ON - - OFF
OFF ON ON ON
OFF ON OFF OFF
OFF OFF - DEVCTL_ST.STW.SP

WARNING
UNINTENDED EQUIPMENT OPERATION
 The CONFREARMEN pin has to be set to 1 for the OP pin to become 0, under non-confirmed
operations.
 The FAILREARMEN pin has to be set to 1 for the OP pin to become 0, under detected fail
conditions.
 Changes to the configuration of these parameters have to be performed by competent
personnel only.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

FAILEN input FAILREARMEN input OP output when FAIL = 1 (assume

OP = 1 before the detected failure)
0 0 1
0 1 1
1 0 1
1 1 0

SP Calculation
The signal evaluation depending on the SC.REM and RSP inputs and the
DEVCTL_ST.CFGW.OWNER input/output is shown in the following table:

OWNER REM SP is calculated as

OFF OFF SC.LSP
OFF ON RSP
ON - DEVCTLST.CFGW.LSP

EIO0000002093 04/2020 237

DEVCTL

HIGHPOS and LOWPOS Calculation

ZSHEN ZSLEN SIMMD HIGHPOS is calculated as: LOWPOS is calculated as:

- - ON OP not OP
OFF OFF OFF OP not OP
ON OFF OFF ZSH not ZSH
OFF ON OFF not ZSL ZSL

ON ON OFF ZSH and (not ZSL) ZSL and (not ZSH)

ZSHPOS and ZSLPOS Calculation

The signal evaluation depending on the ZSHEN and ZSLEN inputs and the
DEVCTL_ST.CFGW.SIMMD input/output is shown in the following table:

ZSHEN ZSLEN SIMMD ZSHPOS is calculated as: ZSLPOS is calculated as:

- - ON OP not OP
OFF OFF OFF OP not OP
OFF ON OFF not ZSL ZSL

ON OFF OFF ZSH not ZSH

ON ON OFF ZSH ZSL

FAILD Calculation
The signal evaluation depending on the FAIL and FAILEN inputs is shown in the following table:

FAIL FAILEN FAILD is calculated as:

- OFF OFF
OFF ON OFF
ON ON ON (minimum SCANTIME)

238 EIO0000002093 04/2020

 DEVCTL

Alarm Behavior
Monitoring is carried out on the detector signals after they have been evaluated (ZSHPOS and
ZSLPOS) according to the DFB configuration. It is activated when the control signal (OP output)
switches (0 to 1 or 1 to 0) as long as the timer preselection value is greater than 0 (TIMEOUT input
in and the device is not being controlled externally (EXTCTLD to 1). After the control signal
switching has occurred, the DFB internal timer is activated. As long as the timer is running, the
position of the device is not monitored. Once the time has elapsed, inoperable device condition
causes the alarm to be activated.
The detected error signal is maintained for a minimum of SCANTIME. After the time has elapsed,
the signal is recovered in the following conditions:
 If the detectors position (HIGHPOS and LOWPOS) becomes the desired position (according to the
OP value) or
 If the device is reset (through the DEVCTL_ST.CFGW.REARM input/output, and as long as the
CONFREARMEN input is 1)
In both cases, the internal timer is restarted with the TIMEOUT value.

EIO0000002093 04/2020 239

DEVCTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

DEVCTL_ST DEVCTL_ST_DDT Data structure of the DFB status.

DEVCTL_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem,
and allows data to be kept in the memory. Read-only access to the data
contained in this word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read-only access to the data contained in this word.

This table describes the DEVCTL_ST.STW word:

Bit Name Description

0 ZSHPOS Refer to the ZSHPOS output pin (see page 236).
1 ZSLPOS Refer to the ZSLPOS output pin (see page 236).
2 SP Refer to the SP output pin (see page 236).
3 OP Refer to the OP output pin (see page 236).
4 ALARM Refer to the ALARM output pin (see page 236).
5 FAILD Refer to the FAILD output pin (see page 236).
6 REM Refer to the REM REM (see page 242).
7 ILCK Refer to ILCK input pin (see page 234).

240 EIO0000002093 04/2020

 DEVCTL

Bit Name Description

8 REARMR Indicates if the device requires resetting (1) after the detection of an inoperable device
condition if it has been configured through the CONFREARMEN and/or FAILREARMEN
inputs.
The signal activation logic included in the DFB is as follows.

9 EXTCTLD Read-only access

Refer to EXTCTLD input pin (see page 234).

DEVCTL_ST.CFGW Word Structure

Bit Name Description

0 OWNER Read/write access
Allows you to configure whether the setpoint is set by the program (0) or by the operator (1).
1 ILCKBP Read/write access
Enables the interlock to be bypassed (1).
2 SIMMD Read/write access
Enables the device to switch to Simulation mode to stop it from reading the actual position
signals (ZSL and ZSH inputs). Also SIMMD simulates that the device is in the desired position
(according to the OP output) and that it is functional (as if the FAIL input was reset (0)).
3 REARM Write access
Enables the device to reset (1). The DFB sets the signal to 0 after each run and sets the
signal, which indicates that the resetting is required (CFGW.REARM) to 0.
4 LSP Read/write access
Enables the operator local setpoint (OWNER is 1) to be set from the monitoring subsystem. As
long as the setpoint is set by the Program (OWNER is 0), the DFB continuously assigns it the
value of the current set-point (DEVCTL_ST.STW.SP input/output).
15 OOS Out of Service
Read/write access
Enables to determine whether the device is out of service (1) or in use (0).

NOTE: The outputs (SP and OP) are de-energized when the device is in an out-of-service state
even if an interlock that requests the device to be started is active.

EIO0000002093 04/2020 241

DEVCTL

Public Variables

Public Variable Description

Variable Type Description

SC DEVCTL_SC_DDT Provides the frequently needed data to monitor the device status and to
control it from the sequential control.

DEVCTL_SC_DDT Type

Name Type Description

EXTCTLD BOOL Read-only access
Refer to the EXTCTLD Input pin (see page 234)
REM BOOL Read/write access
1 = Enables the DFB to be configured to remote set-point RSP
0 = Enables the DFB to be configured to local set-point LSP.
LSP BOOL Read/write access
1 = Enables to assign the target local set-point usually for the sequential control if
the owner is the Program (OWNER input/output is OFF) and the selected set-point is
Local (SC.REM public variable is OFF).
0 = The block automatically assigns the current value of the resulting set-point. It is
described as follows:
OWNER REM SC.LSP
OFF OFF SC.LSP
(Program) (last value or new value assigned from the
sequential control)
OFF ON SP (calculated from the RSP)
ON ON SP (last value or new value assigned by the
(Operator) Operator)
OP BOOL Read-only access
Refer to the OP output pin (see page 236).
SP BOOL Read-only access
Refer to the SP output pin (see page 236)
HIGHPOS BOOL Read-only access
Refer to the HIGHPOS output pin (see page 236).
LOWPOS BOOL Read-only access
Refer to the LOWPOS output pin (see page 236).
ZSHPOS BOOL Read-only access
Refer to the ZSHPOS output pin (see page 236).

242 EIO0000002093 04/2020

 DEVCTL

Name Type Description

ZSLPOS BOOL Read-only access
Refer to the ZSLPOS output pin (see page 236).
ALARM BOOL Read-only access
Refer to the DEVCTL_ST.STW.ALARM Input/output pin (see page 240).
FAILD BOOL Read-only access
Refer to the DEVCTL_ST.STW.FAILD Input/output pin (see page 240).
REARMR BOOL Read-only access
Refer to the DEVCTL_ST.STW.REARMR Input/output pin (see page 240).
ILCKD BOOL Read-only access
The signal evaluation depending on the ILCK input and the
DEVCTL_ST.CFGW.ILCKBP input/output is shown as follows:
ILCKD ILCKBP SC.ILCKD
OFF OFF OFF
OFF ON OFF
ON OFF ON
ON ON OFF
OWNER REAL Read-only access
Refer to the DEVCTL_ST.CFGW.OWNER Input/output pin (see page 240).
OOS BOOL Read-only access
Refer to the DEVCTL_ST.CFGW.OOS Input/output pin (see page 240).

EIO0000002093 04/2020 243

DEVCTL

244 EIO0000002093 04/2020

 Modicon Libraries General Purpose
DEVLP
EIO0000002093 04/2020

Chapter 24
DEVLP - Local Panel for Controlling On/Off Devices

DEVLP - Local Panel for Controlling On/Off Devices

Overview
This chapter describes DEVLP DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 246
DFB Representation 247
Inputs 248
Outputs 250
Inputs/Outputs 251
Public Variables 254

EIO0000002093 04/2020 245

DEVLP

Description

General
The DEVLP DFB is used to manage a local panel that controls an on-off device (for example, an
on-off motor) implemented with a DEVCTL (device control) function DFB and with signals that are
connected to the controller so that the latter defines the target position of the device.

Function Description
The main functions of the module are described in the following table:

Function Description
Mode Switch Optionally manages the signals coming from an operating mode switch in a local
panel with the following configuration: Local - Zero - Control System. The Zero mode
signal is optional. However the user can enable Local/Control System mode from
the faceplate also, when VirtualLPEN input pin signal is high and
MODESignalsEN signal is low in the DFB.
Push buttons The DFB manages up to two signals coming from OFF and ON push buttons of local
panel, giving the OFF push button higher priority.
Owner Management The DFB enables to configure whether the Program needs to be the device owner
or not, after switching to the Control System mode again.
Owner Locking The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not, it disables the access to change the owner
(Operator/Program) while the device is controlled from the Local Panel.
Set-point Lock The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not. It disables to change the set-point while the
device is controlled from the Local Panel.
Push button The push button signals from the Local Panel can be enabled/disabled through the
Enabling/Disabling DFB configuration (input pin) and/or from control sequences.
Enabled Panel The DFB provides a signal that can be used to illuminate a light source on the Local
Signaling Panel to indicate when the push buttons are enabled for operation.
Virtual Panel This signal enables the operator to select the Local / Control System mode of
Enabling/Disabling operation from the HMI so that the push button signals are enabled for operation.
NOTE: VirtualLPEN input pin signal is applicable when Modicon Libraries -
General Purpose is used along with Modicon Libraries - General Purpose for
Wonderware System Platform.

246 EIO0000002093 04/2020

 DEVLP

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 247

DEVLP

Inputs

Input Parameter Description

Parameter Type Description

LPSignal BOOL 1 = The local panel mode switch is in the Local Panel position. Refer to the table
included with the description of the LPMode output pin (see page 250).
ZEROSignal BOOL 1 = The local panel mode switch is in the zero position.This signal is optional
even if a mode switch is available on the local panel. When this signal is a logical
high, user is not allowed to operate the device from the faceplate and also from
the DFB. Hence, all the functions in the faceplate will be disabled. Refer to the
table included with the description of the LPMode output pin (see page 250).
CSSignal BOOL 1 = The local panel mode switch is in the Control System position. Refer to the
table included with the description of the LPMode output pin (see page 250).
OFFSignal BOOL 1 = The OFF push button on the local panel is pressed.
NOTE: OFF push button signal has higher priority than ON push button signal.
ONSignal BOOL 1 = The ON push button on the local panel is pressed.
MODESignalsEN BOOL 1 = Enables the use of the Local Panel/Zero/Control System (or Local Panel -
Control System) mode switch on the local panel. Normally configured in
development phase based on the characteristics of the local panel being used.
If the mode switch is enabled, the LPSignal, ZEROSignal, and CSSignal
inputs are considered to determine the operating modes of the local panel. Refer
to the table included with the description of the LPMode output pin
(see page 250).
NOTE: MODESignalsEN input pin has higher priority than the VirtualLPEN
input pin signal.
VirtualLPEN BOOL 1 = This signal enables the operator to select the Local/Control System mode of
operation from the HMI, so that the push button signals are enabled for
operation.
NOTE:
 When the owner is program, the Local/Control System mode selection drop-
down list will be visible but disabled for operation however, when the owner
is operator the Local Panel drop-down list will be accessible for operation.
 VirtualLPEN input pin signal is applicable only for Modicon Libraries -
General Purpose for Wonderware System Platform offer only, however there
is no impact of this input signal in Modicon Libraries - General Purpose for
Citect SCADA offer.
Refer to the table included with the description of the LPMode output pin
(see page 250).

248 EIO0000002093 04/2020

 DEVLP

Parameter Type Description

PBSignalsEN BOOL 1 = Enables to accept the OFF and ON push button signals from the local panel.
This signal is not applicable if the mode switch is enabled (refer to the
MODESignalsEN input). It means that push button signals are considered when
in Local Panel mode.
When the mode switch is disabled (MODESignalsEN = 0), the PBSignalsEN
signal enables/disables the push button signals from the control system itself
based on the relevant process conditions. The SC.DISABLELP public variable
is also considered for determining whether the push buttons are enabled or not
when LPMode pin signal is high, as shown in the following table.
MODESignalsEN PBSignalsEN SC.DisableLP Push buttons
enabled?
OFF OFF - NO
OFF - ON NO
OFF ON OFF YES
ON - - YES
Therefore, this signal can be used to enable/disable the push buttons on a
simple local panel that does not feature a mode switch (Local
Panel/Zero/Control System) based on relevant process conditions.
ToProgramEN BOOL 1 = Enables the functionality to change the owner from operator to program, only
when the mode is switched to control system mode. Refer to the table included
with the description of the LockOwnerEN input.
LockOwnerEN BOOL 1 = Disables the access of changing the owner from HMI while the mode switch
is in local panel. The following table shows how the on-off device owner is
evaluated based on ToProgramEN, LockOwnerEN input signals and the local
panel operating mode:
Local Panel Mode ToProgramEN LockOwnerEN Owner
Zero mode - - Operator
Switch to Local Panel - - Operator
Local Panel - ON Operator
Switch to Control System ON - Program
In remaining cases, owner of the on/off device ceases to be defined from the
DEVLP DFB and it enables to change it from monitoring (HMI) system with the
command word in DEVCTL_ST.CFGW input/output of the corresponding DEVCTL
DFB.
In any case, consider that, the device owner that had been set before switching
to the local panel mode is not memorized.
LockSetpointEN BOOL 1 = Disables the access to set point of on/off devices in the monitoring (HMI)
system when it is in local panel mode only, and the owner is operator.
Therefore, user can activate this signal to lock setpoint operation from the
monitoring (HMI) system while on/off device is controlled from the local panel.

EIO0000002093 04/2020 249

DEVLP

Outputs

Output Parameter Description

Parameter Type Description

PBLIGHTSignal BOOL 1 = The push buttons on the local panel are fully operational, that is, the local panel
is in Local Panel mode (either because the mode is selected with the corresponding
switch or because the push buttons are enabled in the event that there is no selector
switch available or the VirtualLPEN is high with the local panel mode enabled).
LPMode BOOL 1 = The local panel mode is in Local Panel.
The following table shows how the local panel operating mode is determined based
on the MODESignalsEN, VirtualLPEN, PBSignalsEN, LPSignal, CSSignal
and ZEROSignal, input signals:
MODESig- Virtu- PBSig- LPSig- CSSig- ZEROSig- OUTPUT
nalsEN alLPEN nalsEN nal nal nal
0 0 0 0 0 0 CS mode
1 0 0 0 0 0 Zero mode
1 0 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 0 0 0 1 0 CS mode
0 1 1 NA NA NA CS mode
0 1 0 NA NA NA CS mode
0 0 1 0 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 0 0 0 Zero mode
1 1 0 0 0 1 Zero mode
1 1 0 0 1 0 CS mode
1 0 1 0 1 0 CS mode
1 1 1 0 1 0 CS mode
1 0 0 0 0 1 Zero mode
ZEROMode BOOL 1 = The local panel mode is in Zero. User is not allowed to operate the device from
the faceplate and also from DFB. Hence, all the functions in the faceplate will be
disabled. Refer to the table included with the description of the LPMode output.
CSMode BOOL 1 = The local panel mode is in Control System. Refer to the table included with the
description of the LPMode output.

250 EIO0000002093 04/2020

 DEVLP

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

DEVCTL_ST DEVCTL_ST_DDT Data structure corresponding to the on-off device is to be controlled
(see page 240) from the local panel (for detailed information regarding this structure,
refer to the DEVCTL DFB (see page 231).
The structure provides the information needed for the operation of
the DEVLP DFB and enables this DFB to control the owner and set-
point for the on-off device.
DEVLP_ST DEVLP_ST_DDT Data structure is used as an interface with the monitoring (HMI)
system.

DEVCTL_ST.CFGW Type
The following table describes the logic applied to the signals controlled from the DEVLP DFB:

Name Type Description

CFGW WORD Provides the means to control the device from the monitoring (HMI) system.
Read-only access to the data contained in this word.

EIO0000002093 04/2020 251

DEVLP

DEVCTL_ST.CFGW Word
The following table describes the DEVCTL_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or by the Operator (1).
Refer to the following table included with the description of the LPMode output, which specifies
the cases in which the DEVLP DFB can interact with this signal.
4 LSP It is a device command which has read write access. Allows the local set-point of the Operator
(OWNER is 1) to be set from the monitoring (HMI) system. As long as the set-point is set by the
Program (OWNER = 0), the DFB continuously assigns it the value of the current set-point
(DEVCTL_ST.STW.SP input/output).
The DEVLP Owner OFFSignal ONSignal LockSetPointEN LSP is
DFB determines calculated
the set-point for as:
the On-Off
0 - - - - OFF
The Owner
signal is
forced to 1
(Operator).
Local Panel Operator ON - - OFF
Local Panel Operator OFF Switch to ON - ON
Local Panel Operator OFF OFF ON Last
Value
In other cases, the LSP signal is not modified from the DEVLP DFB

DEVLP_ST.CFGW Word

Bit Name Description

0 LocalModeOn Read/write access
 1 = Enables the Local Panel mode.
 0 = Enables the Control System mode.

DEVLP_ST_DDT Type

Name Type Description

STW WORD Read-only access
Bits word with the local panel status.

252 EIO0000002093 04/2020

 DEVLP

DEVLP_ST.STW Word
Read-only access. Bits word with input conditions (refer to the CONDxx inputs) and their evaluation
summary (refer to the ILCK output). The following table describes the DEVLP_ST.STW word:

Bit Name Description

0 LPMode Local panel in Local Panel mode. Refer to the LPMode output pin.
1 ZEROMode Local panel in zero mode. Refer to the ZEROMode output pin.
2 CSMode Local panel in Control System mode. Refer to the CSMode output pin.
3 LockedOwner Indicates whether the owner change buttons in monitoring (HMI) system needs
to be locked (1) or not (0).
Is activated when:
 The Local Panel is set to zero mode.
 The local panel is set to local panel mode and the LockOwnerEN input
signal has been configured as active (1).
4 SPLocked Indicates whether the set-point change buttons in the monitoring (HMI) system
should be locked (1) or not (0).
Is activated when:
 The Local Panel is set to zero mode.
 The local panel is set to local panel mode and the LockSetpointEN input
signal has been configured as active (1).
5 MODESignalsEN Indicates the state of the MODESignalsEN input signal, that is, whether there
is a mode switch (1) or not (0).
6 PBEnabled Indicates whether the push buttons of the local panel are enabled (1) or not (0).
The signal is activated when at least one of the MODESignalsEN and
PBSignalsEN signal inputs is active.
7 VirtualLPEN Enables the drop-down list for the Local Panel / Control System mode
selection.
8 LPSignal Indicates the state of the LPSignal input signal.
9 ZEROSignal Indicates the state of the ZEROSignal input signal.
10 CSSignal Indicates the state of the CSSignal input signal.
11 OFFSignal Indicates the state of the OFFSignal input signal.
12 ONSignal Indicates the state of the ONSignal input signal.

EIO0000002093 04/2020 253

DEVLP

Public Variables

Public Variable Description

Variable Type Description

SC DEVLP_SC_DDT Provides the frequently needed data for monitoring and controlling the
DFB.

DEVLP_SC_DDT Type

Name Type Description

LPMode BOOL Read-only access
Refer to the LPMode output pin (see page 250).
ZEROMode BOOL Read-only access
Refer to the ZEROMode output pin (see page 250).
CSMode BOOL Read-only access
Refer to the CSMode output pin (see page 250).
DisableLP BOOL Read/write access
1 = Disables the push buttons on the local panel. Only applicable when a local
panel without mode switch configuration is used (MODESignalsEN = 0).

254 EIO0000002093 04/2020

 Modicon Libraries General Purpose
DEVMNT
EIO0000002093 04/2020

Chapter 25
DEVMNT - Device Maintenance

DEVMNT - Device Maintenance

Overview
This chapter describes the DEVMNT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 256
DFB Representation 257
Inputs 258
Outputs 259
Inputs/Outputs 260
Public Variables 261

EIO0000002093 04/2020 255

DEVMNT

Description

General
The DEVMNT DFB is used to provide data that is useful for device maintenance.
You can use this DFB as a supplement to the DEVCTL DFB or independently. This DFB allows the
incorporation of totalizing functions for hours of operation and switching operations.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Switching Operation Counts the number of switching operations that have been performed
Totalization on the device since the totalizer last reset.
Hours of Operation Counts the number of hours of operation that the device has been in
Totalization operation since the totalizer last reset.
Reset The DFB allows to reset the described totalizers individually.

256 EIO0000002093 04/2020

 DEVMNT

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 257

DEVMNT

Inputs

Input Parameter Description

Parameter Type Description

POSITION BOOL 1 = ON (running, open, and so on) Provides the device status
information with which the totalizers are calculated.

258 EIO0000002093 04/2020

 DEVMNT

Outputs

Output Parameter Description

Parameter Type Description

RHCNT UINT Totalizes the number of hours device is in running operation. The calculation is done
based on the position indicator of the device shown by the POSITION input.
MCNT UINT Totalizes the number of switching operations that the device has performed. The
calculation is done based on the position indicator of the device shown by the
POSITION input. A new switching operation is added each time a rising edge is
detected.

EIO0000002093 04/2020 259

DEVMNT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

DEVMNT_ST DEVMNT_ST_DDT Data structure that is used as an interface with the monitoring
subsystem.

DEVMNT_ST_DDT Type

Name Type Description

STW WORD Provides the DFB status usually used from the monitoring subsystem. Read-only
access to the data contained in this word.
CFGW WORD Provides the means to control the DFB. Read-only access to the data contained in
this word.
RHCNT UINT Read-only access
Refer to the RHCNT output pin (see page 259).
MCNT UINT Read-only access
Refer to the MCNT output pin (see page 259).

DEVMNT_ST.STW Word Structure

Bit Name Description

0 HOV HOV is activated when the hours counter exceeds the maximum representable value
(65535). Is deactivated through DEVMNT_ST.STW.RSTH.
1 MOV MOV is activated when the switching operations counter exceeds the maximum
representable value (65535). Is deactivated through DEVMNT_ST.STW.RSTM.

DEVMNT_ST.CFGW Word Structure

Bit Name Description

0 RSTH Enables to reset the hours of operation totalizer. Also resets the internal seconds subtotal
from the last hour of operation fraction and from the DEVMNT.STW.HOV signal. The DFB
sets this signal to 0 after it has been processed.
1 RSTM Enables to reset the switching operation totalizer. Also resets the DEVMNT.STW.MOV
signal. The DFB sets this signal to 0 after it has been processed.

260 EIO0000002093 04/2020

 DEVMNT

Public Variables

Public Variable Description

Variable Type Description

SC DEVMNT_SC_DDT Provides the frequently needed data to monitor the DFB
status from the sequential control.

DEVMNT_SC_DDT Type

Name Type Description

RHCNT UINT Read-only access
Refer to the DEVMNT_ST.RHCNT input/output pin (see page 260).
MCNT UINT Read-only access
Refer to the DEVMNT_ST.MCNT input/output pin (see page 260).

EIO0000002093 04/2020 261

DEVMNT

262 EIO0000002093 04/2020

 Modicon Libraries General Purpose
DUALOP - Dual Output
EIO0000002093 04/2020

Chapter 26
DUALOP - Dual Output

DUALOP - Dual Output

Overview
This chapter describes the DUALOP DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 264
DFB Representation 266
Inputs 267
Outputs 268

EIO0000002093 04/2020 263

DUALOP - Dual Output

Description

General
The DUALOP is used to generate continuous or pulse type digital output based on digital input and
different modes of configuration.

264 EIO0000002093 04/2020

 DUALOP - Dual Output

Function Description
The main functions of the DFB are described in the following table:

Function Description
Digital Input The DFB can generate two outputs based on one logical input.
Operating The DFB provides continuous or pulse type digital output based on the digital input, limit switches and
modes selected mode.
This control function provides five different modes of operation:
 MODE 0: Continuous (continuous start/open or stop/close command).
 When an input is set to true, OPH is set to true.
 When an input is set to false, OPL is set to true.
 After initialization, outputs are triggered based on the input signal.

 MODE 1: Pulse based on continuous input signal (pulse type start/open or stop/close command).
 When input OP is set to true, OPH is set to true for the defined pulse duration (OPHPulseTime).
 When input OP is set to false, OPL is set to true for the defined pulse duration (OPLPulseTime).
 Outputs (OPH or OPL) should always follow the state of input (OP) signal condition.
 After initialization, outputs are triggered based on the input signal.

 MODE 2: Pulse based on input rising/falling trigger (pulse type start/open or stop/close command).
 When input OP is set to true, OPH is set to true for the defined pulse duration (OPHPulseTime).
 When input OP is set to false, OPL is set to true for the defined pulse duration (OPLPulseTime).
 After initialization, outputs (OPH or OPL) are set to low. The outputs are triggered by getting new
command/transition in the input.
 MODE 3: Till position is confirmed (release the start/open or stop/close command once the position
is reached).
 When input OP is set to true, OPH is set to true until the high position (ZSHPOS) is reached.
 When input OP is set to false, OPL is set to true until the low position (ZSLPOS) is reached.
 After initialization, outputs (OPH or OPL) are triggered based on the input signal and position
feedback signals.
 MODE 4: Till position is confirmed + extra time (release the start/open or stop/close command once
the position is reached + extra pulse time to stroke the output)
 When input OP is set to true, OPH is set to true until the high position (ZSHPOS) is reached +
defined pulse time duration (OPHPulsetime).
 When input OP is set to false, OPL is set to true until the low position is reached (ZSLPOS) +
defined pulse time duration (OPLPulsetime).
 After initialization, outputs (OPH or OPL) are triggered based on the input signal and position
feedback signals.
NOTE: For invalid entry of MODE (for example, MODE < 0 or MODE > 4) the DFB defaults to MODE 0.

EIO0000002093 04/2020 265

DUALOP - Dual Output

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

266 EIO0000002093 04/2020

 DUALOP - Dual Output

Inputs

Input Parameter Description

Parameter Type Description

OP BOOL Digital input signal
This input signal will be linked to the output signal OP from the device management
blocks.
ZSHPOS BOOL High position status
1 = High position confirmed
ZSLPOS BOOL Low position status
1 = Low position confirmed
MODE INT This input is used to select the operating modes of the DUALOP DFB. Initialization is
triggered whenever there is a MODE change. Valid entry is 0, 1, 2, 3, and 4, refer to
Functional Description (see page 271)
SWITCHDELAY TIME This input is used to set a delay between output switching. Default value will be 0
seconds. For the delay duration set in this input, both the outputs will be low. Then after
the delay, output (OPH or OPL) gets triggered based on the selected mode and input
signal condition.
OPHPulseTime TIME This input is used to set the pulse time duration for which output OPH will be high, when
the input signal (OP) is high. Once the pulse time duration elapses, the output OPH will
go low and both the outputs remain low.
OPLPulseTime TIME This input is used to set the pulse time duration for which output OPL will be high, when
the input signal (OP) is low. Once the pulse time duration elapses, the output OPL will go
low and both the outputs remain low.

EIO0000002093 04/2020 267

DUALOP - Dual Output

Outputs

Outputs Parameter Description

Parameter Type Description

OPH BOOL This output will be high when the Input signal OP is high. Duration of OPH
remaining in high status depends on the operating mode selected.
OPL BOOL This output will be high when the Input signal OP is low. Duration of OPL
remaining in high status depends on the operating mode selected.
ERROR BOOL This output is generated when there is a detected configuration error in the
DUALOP control function.
 In MODE 1, MODE 2 and MODE 4, ERROR is high if OPHPulseTime or
OPLPulseTime is set as 0 seconds.
 In MODE 3 and MODE 4, ERROR is high if ZSHPOS and ZSLPOS input pins are
not linked or assigned.

268 EIO0000002093 04/2020

 Modicon Libraries General Purpose
DUALOP1 - Dual Output with Dual Input
EIO0000002093 04/2020

Chapter 27
DUALOP1 - Dual Output with Dual Input

DUALOP1 - Dual Output with Dual Input

Overview
This chapter describes the DUALOP1 DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 270
DFB Representation 272
Inputs 273
Outputs 274

EIO0000002093 04/2020 269

DUALOP1 - Dual Output with Dual Input

Description

General
The DUALOP1 DFB is used to generate continuous or pulse type digital output with different modes
of configuration.

270 EIO0000002093 04/2020

 DUALOP1 - Dual Output with Dual Input

Function Description
The main functions of the DFB are described in the following table:

Function Description
Dual input The DFB generates dual digital output based on dual digital input.
Operating This control function provides five different modes of operation:
modes  MODE 0: Continuous (continuous start/open or stop/close command).
 When an input OP1 is set to true, OPH is set to true.
 When an input OP2 is set to true, OPL is set to true.
 After initialization, outputs are triggered based on the input signal.

 MODE 1: Pulse based on continuous input signal (pulse type start/open or stop/close
command).
 When input OP1 is set to true, OPH is set to true for the defined pulse duration
(OPHPulseTime).
 When input OP2 is set to true, OPL is set to true for the defined pulse duration
(OPLPulseTime).
 Outputs (OPH or OPL) should always follow the state of inputs (OP1 and OP2) signal
condition correspondingly.
 After initialization, outputs are triggered based on the input signal.

 MODE 2: Pulse based on input rising/falling trigger (pulse type start/open or stop/close
command).
 When input OP1 is set to true, OPH is set to true for the defined pulse duration
(OPHPulseTime).
 When input OP2 is set to true, OPL is set to true for the defined pulse duration
(OPLPulseTime).
 After initialization, outputs (OPH or OPL) are set to low. The outputs are triggered by getting
new command/transition in the input.
 MODE 3: Till position is confirmed (release the start/open or stop/close command once the
position is reached).
 When input OP1 is set to true, OPH is set to true until the high position (ZSHPOS) is reached.
 When input OP2 is set to true, OPL is set to true until the low position (ZSLPOS) is reached.
 After initialization, outputs (OPH or OPL) are triggered based on the input signal and position
feedback signals.
 MODE 4: Till position is confirmed + extra time (release the start/open or stop/close command
once the position is reached + extra pulse time to stroke the output)
 When input OP1 is set to true, OPH is set to true until the high position (ZSHPOS) is reached
+ defined pulse time duration (OPHPulsetime).
 When input OP2 is set to true, OPL is set to true until the low position is reached (ZSLPOS)
+ defined pulse time duration (OPLPulsetime).
 After initialization, outputs (OPH or OPL) are triggered based on the input signal and position
feedback signals.
NOTE: For invalid entry of Mode (for example, MODE < 0 or MODE > 4) the DFB defaults to
MODE 0.

EIO0000002093 04/2020 271

DUALOP1 - Dual Output with Dual Input

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

272 EIO0000002093 04/2020

 DUALOP1 - Dual Output with Dual Input

Inputs

Input Parameter Description

Parameter Type Description

OP1 BOOL 1 = High position digital input signal
OP2 BOOL 1 = Low position digital input signal
ZSHPOS BOOL High position status
1 = High position confirmed
ZSLPOS BOOL Low position status
1 = Low position confirmed
ENGPARAM DUALOP1_ Engineering parameters
ENGPAR_DDT
MODE INT This input is used to select the operating modes of the DUALOP DFB.
Initialization is triggered whenever there is a MODE change. Valid entry is
0, 1, 2, 3, and 4, refer to Functional Description (see page 271).
SWITCHDELAY TIME This input is used to set a delay between output switching. Default value
will be 0 seconds. For the delay duration set in this input, both the outputs
will be low. Then after the delay, output (OPH or OPL) gets triggered based
on the selected mode and input signal condition.
OPHPulseTime TIME This input is used to set the pulse time duration for which output OPH will
be high, when the input signal (OP1) is high. Once the pulse time duration
elapses, the output OPH will go low.
OPLPulseTime TIME This input is used to set the pulse time duration for which output OPL will
be high, when the input signal (OP2) is low. Once the pulse time duration
elapses, the output OPL will go low.

EIO0000002093 04/2020 273

DUALOP1 - Dual Output with Dual Input

Outputs

Outputs Parameter Description

Parameter Type Description

OPH BOOL This output will be high when the Input signal OP1 is high. Duration of OPH remaining in
high status depends on the operating mode selected.
OPL BOOL This output will be high when the Input signal OP2 is high. Duration of OPL remaining in
high status depends on the operating mode selected.
ERROR BOOL This output is generated when there is a detected configuration error in the DUALOP1
control function.
 In MODE 1, MODE 2 and MODE 4, ERROR is high if OPHPulseTime or OPLPulseTime
is set as 0 seconds.
 In MODE 3 and MODE 4, ERROR is high if ZSHPOS and ZSLPOS input pins are not linked
or assigned.
 In all Modes, If both inputs and OP1 and OP2 are high.

274 EIO0000002093 04/2020

 Modicon Libraries General Purpose
HVALVE
EIO0000002093 04/2020

Chapter 28
HVALVE - Manual Valve

HVALVE - Manual Valve

Overview
This chapter describes the HVALVE DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 276
DFB Representation 277
Inputs 278
Outputs 279
Inputs/Outputs 280
Public Variables 281

EIO0000002093 04/2020 275

HVALVE

Description

General
The main objective of the HVALVE DFB is to manage valves without actuators and with 1 or 2 limit
switches or any other type of positioner with 2 final positions.
User can supplement this DFB with DINPUT DFBs from the General Purpose Library. It enables
you to incorporate conditioning functions for the digital signals of the limit switches.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Position Detection Allows to determine the actual position of the element to be controlled and
monitored with the help of high and low limit switch.
Simulation The DFB can be switched to simulation mode. Thus, the actual position of the
controlled device is considered to be the same as its desired position regardless of
the signals received from the position detectors.

276 EIO0000002093 04/2020

 HVALVE

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 277

HVALVE

Inputs

Input Parameter Description

Parameter Type Description

ZSH BOOL 1 = Indicates to the DFB that high limit position is reached. Usually, it is used to
connect the digital input of a positioner high limit switch. The input pin is
considered, if an input parameter is connected or linked.
ZSL BOOL 1 = Indicates to the DFB that low limit position is reached. Usually, it is used to
connect the digital input of a positioner low limit switch. The input pin is
considered, if an input parameter is connected or linked.

278 EIO0000002093 04/2020

 HVALVE

Outputs

Output Parameter Description

Parameter Type Description

HIGHPOS BOOL 1 = Determines the device has reached the open-valve position considering
the status of the connected detectors and/or the simulated status. Refer to
the following table.
LOWPOS BOOL 1 = Determines the device has reached the closed-valve position considering
the status of the connected detectors and/or the simulated status.
Refer to the following table:
ZSH ZSL SIMMD HIGHPOS is LOWPOS is
connected connected calculated as: calculated as:
- - ON ZSSIM not ZSSIM
OFF OFF OFF OFF OFF
ON OFF OFF ZSH not ZSH
OFF ON OFF Not ZSL ZSL

ON ON OFF ZSH and not ZSL ZSL and not ZSH

ZSHPOS BOOL 1 = Indicates the high position has been reached based on the detector
connected on ZSH.
ZSLPOS BOOL 1 = Indicates the low position has been reached based on the detector
connected on ZSL.
FAILD BOOL 1 = Indicates an inoperable device when the ZSH and ZSL inputs are active
at the same time.

EIO0000002093 04/2020 279

HVALVE

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

HVALVE_ST HVALVE_ST_DDT Provides the data necessary to monitor the DFB status.

HVALVE_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory. Read-only
access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read/write access to the data contained in this word.

HVALVE_ST.STW Word Structure

Bit Name Description

0 ZSHPOS Refer to the ZSHPOS output pin (see page 279).
1 ZSLPOS Refer to the ZSLPOS output pin (see page 279).
2 FAILD Refer to the FAILD output pin (see page 279).

HVALVE_ST.CFGW Word Structure

Bit Name Description

0 SIMMD Read/write access
Enables you to place the device in simulation mode so that the actual position
signals (ZSL and ZSH inputs) are ignored and the ZSSIM simulated status signal
is used instead.
1 ZSSIM Read/write access
Enables you to define the value of ZSHPOS and ZSLPOS when the device is in
simulation mode.
The options available are: Open (1) (ZSHPOS = 1 and ZSLPOS = 0) and Closed (0)
(ZSHPOS = 0 and ZSLPOS = 1).

280 EIO0000002093 04/2020

 HVALVE

Public Variables

Public Variable Description

Variable Type Description

SC HVALVE_SC_DDT Provides the frequently needed data to monitor the DFB status.

HVALVE_SC_DDT Type

Name Type Description

HIGHPOS BOOL Read-only access
Refer to the HIGHPOS output pin (see page 279).
LOWPOS BOOL Read-only access
Refer to the LOWPOS output pin (see page 279).
ZSHPOS BOOL Read-only access
Refer to the ZSHPOS output pin (see page 279).
ZSLPOS BOOL Read-only access
Refer to the ZSLPOS output pin (see page 279).
FAILD BOOL Read-only access
Refer to the FAILD output pin (see page 279).

EIO0000002093 04/2020 281

HVALVE

282 EIO0000002093 04/2020

 Modicon Libraries General Purpose
MOTOR2
EIO0000002093 04/2020

Chapter 29
MOTOR2 - 2 Speed/2 Rotation Direction Motor

MOTOR2 - 2 Speed/2 Rotation Direction Motor

Overview
This chapter describes the MOTOR2 DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 284
DFB Representation 286
Inputs 287
Outputs 289
Inputs/Outputs 294
Public Variables 297

EIO0000002093 04/2020 283

MOTOR2

Description

General
The MOTOR2 DFB is used to control on-off motors with two rotation directions (forward/reverse) or
with two speeds (for example, slow speed and fast speed).
The DFB allows the management of associated motors from the sequential control, the continuous
control, and/or the Supervision system depending on their configuration and the system needs.
User can supplement the DFB with the MOTOR2LP, DEVMNT, CONDSUM, and CONDSUM1 DFB from
the General Purpose Library.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Control Controls the digital control signal of the element based on the configuration and
commands that the DFB receives according to the functions.
Owner selection The DFB manages control system level, which is the owner (operator or program). As
a result, it is responsible for setting the set-point for the desired position.
Local and remote Enables the DFB with a set-point (stop/run and speed/rotation direction) that is
setpoint determined through a set-point selector (local or remote) in program owner. The local
set-point is assigned from the sequential control while the remote set-point is
assigned to the DFB control from the logic implemented in the continuous control.
Position detection Allows to determine the actual position of the element to be controlled and monitored
with the help of two limit switch (ZSH1 and ZSH2).
Inoperable motor Allows to monitor inoperable device condition. DFB can be configured to withdraw
output based on this condition.
Interlocking The DFB gives a command to the device to move to the defined position in case of
an active interlock. An interlock bypass function is available.
Setpoint blocking You can configure the DFB to avoid the activation of a certain setpoint (rotation
direction or speed) depending on the conditions evaluated outside the DFB (for
example, to avoid reverse speeds from being activated when the motor is already
rotating in the forward direction).
Simulation You can switch the DFB to Simulation mode. Thus, the operation confirmations for
the controller motor are considered to be the same as the desired confirmations
regardless of the actual signals for detection of not confirmed operation and
inoperable device.

284 EIO0000002093 04/2020

 MOTOR2

The optional functions of the DFB are described in the following table:

Function Description
Detection of not If position is not confirmed within a configured time after the output command is
confirmed operation activated, DFB detects not confirmed operation.
Manual resetting Allows you to reset manually after the detection of an inoperable device condition or
a not confirmed operation. After reset, device output will follow set point.

EIO0000002093 04/2020 285

MOTOR2

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

286 EIO0000002093 04/2020

 MOTOR2

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL If a rising edge is detected on this input, the internal timers of the block are reset
and detected alarms are set to 0.
ZSH1 BOOL 1 = Indicates to the DFB that switching operation corresponding to the set-point
(SP = 1) is activated in the forward direction/speed 1 (SPSEL = 0). It is used to
connect the digital input of a motor switching operation confirmation. Refer to the
ZSH1EN input.
ZSH2 BOOL 1 = Indicates to the DFB that switching operation corresponding to the set-point
(SP = 1) is activated in the forward direction/speed 2 (SPSEL = 1). It is used to
connect the digital input of a motor switching operation confirmation. Refer to the
ZSH2EN input.
FAIL1 BOOL 1 = Indicates to the DFB if a detected error has occurred when activating forward
direction/speed 1 of the motor.
Used to connect the digital thermal trip input of a motor switch.
Refer to the FAIL1EN input. This detected error will affect both operations.
FAIL2 BOOL 1 = Indicates to the DFB if a detected error has occurred when activating reverse
direction/speed 2 of the motor.
Used to connect the digital thermal trip input of a motor switch. Refer to the
FAIL2EN input. This detected error will affect both operations.
ZSH1EN BOOL 1 = Enables ZSH1 position detector monitoring.
ZSH2EN BOOL 1 = Enables ZSH2 position detector monitoring.
FAIL1EN BOOL 1 = Enables the FAIL1 parameter.
FAIL2EN BOOL 1 = Enables the FAIL2 parameter.
CONFREARMEN BOOL  1 = Withdraws the output OPx (x = 1 or 2) when a non-confirmed operation is
detected (ALARM = 1) and requires a mandatory manual resetting once the
ALARM condition disappears.
 0 = The output OPx (x = 1 or 2) remains in its previous state when a non-
confirmed operation is detected (ALARM = 1) and does not need manual
resetting, once the ALARM condition disappears.
Refer to the TIMEOUT input and the MOTOR2ST.STW.ALARM input/output pin
(see page 294).
FAILREARMEN BOOL  1 = Withdraws the output OPx (x = 1 or 2) upon a detected failure condition
(FAILD = 1) and requires a mandatory manual resetting once the FAIL
condition disappears.
 0 = The output OPx (x = 1 or 2) remains in its previous state upon a detected
failure condition (FAILD = 1) and does not need manual resetting, once the
FAIL condition disappears.

EIO0000002093 04/2020 287

MOTOR2

Parameter Type Description

RSPSEL BOOL Remote set point selection.
0 = Forward direction/Speed 1 set point.
1 = Reverse direction/Speed 2 set point.
RSP BOOL Remote set-point by the continuous control.
1 = The set point selected in RSPSEL is considered.
0 = Stop command
ILCKSEL BOOL Interlock set point selection.
0 = Forward direction/Speed 1 set point.
1 = Reverse direction/Speed 2 set point.
ILCKSP BOOL 1 = Run
Set-point needs to be used when the block is interlocked.
Refer to the ILCK input.
ILCK BOOL 1 = Interlocks the motor at the defined position.
NOTE: If the motor requires resetting (STW.REARMR = 1), the OP1 and OP2
outputs are set to 0 if the FAILD1 or FAILD2 signals are active regardless of the
value of ILCKSP and will wait for the operator to reset the motor.
S1LOCKED BOOL 1 = Enables to block the activation of the actuator 1 (forward direction/speed 1)
setpoint in case of an OP1 transition from 0 to 1.
S2LOCKED BOOL 1 = Enables to block the activation of the actuator 2 (reverse direction/speed 2)
setpoint in case of an OP2 transition from 0 to 1.
TIMEOUT TIME 1 = Enables to configure the time during which confirmation alarm monitoring is
disabled. 0 disables confirmation alarm monitoring.
After the configured time has elapsed, the confirmation alarm is generated. Refer
to the MOTOR2LST.STW.ALARM input/output pin (see page 294).
SCANTIME TIME 1 = Enables to configure the time that the detected alarm signals are kept active.
This helps the Supervision system to acquire the data for detected alarms that
are automatically reset.
EXTCTLD BOOL 1 = Indicates to the DFB the motor is being controlled from outside the system.
Avoids the generation of erroneous confirmation messages while the motor is
being controlled from outside the system (for example, from an electrical switch
controlled by local push buttons that does not reach the control system).
Monitoring of the confirmation alarm ceases while the motor is being externally
controlled. The motor detected error (FAILx) continues to be evaluated.
NOTE: If EXTCTLD =1, the OP1 and OP2 outputs can still be manipulated.

288 EIO0000002093 04/2020

 MOTOR2

Outputs

OP1, OP2, S1SELD, S2SELD Outputs

Parameter Type Description

OP1 BOOL 1 = Forward direction/speed 1 command active. Allows the control signal of the
device to be connected.
OP2 BOOL 1 = Reverse direction/speed 2 command active. Allows the control signal of the
device to be connected.

When STW.8 is ON, OP1 and OP2 are OFF. When STW.8 is OFF and ILCKD is OFF, the following
table shows the status of OP1 and OP2:

FAIL ALARM S1SELD S2SELD OP1 OP2

ON OFF/ON OFF/ON OFF/ON S1SELD S2SELD
OFF ON OFF/ON OFF/ON S1SELD S2SELD
OFF OFF OFF/ON OFF/ON S1SELD S2SELD
ON OFF/ON ON ON OFF OFF
OFF/ON ON ON ON OFF OFF

WARNING
UNINTENDED EQUIPMENT OPERATION
 The CONFREARMEN pin has to be set to 1 for the OPx (x = 1 or 2) pin to become 0, under non-
confirmed operations.
 The FAILREARMEN pin has to be set to 1 for the OPx (x = 1 or 2) pin to become 0, under
detected fail conditions.
 Changes to the configuration of these parameters have to be performed by competent
personnel only.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

FAILEN input FAILREARME OPx output when FAIL = 1 (assume OPx output when FAIL = 1 (assume
N input OP = 1 before the detected failure) OP = 0 before the detected failure)
0 0 1 0
0 1 1 0
1 0 1 0
1 1 0 0
NOTE: x=1 or 2

EIO0000002093 04/2020 289

MOTOR2

The following table shows how the ILCKD variable is calculated in the public variables section:

STW.8 FAIL ALARM ILCKD ILCKSEL ILCKSP OPn OP1 OP2

ON - - - - - - OFF OFF
OFF ON - ON OFF/ON OFF/ON ON Not ILCKSEL ILCKSEL
and ILCKSP and ILCKSP
OFF OFF ON ON OFF/ON OFF/ON ON Not ILCKSEL ILCKSEL
and ILCKSP and ILCKSP
OFF OFF OFF ON OFF/ON OFF/ON - Not ILCKSEL ILCKSEL
and ILCKSP and ILCKSP
OFF ON - ON ON ON OFF OFF OFF
OFF - ON ON ON ON OFF OFF OFF

Parameter Type Description

S1SELD BOOL 1 = Run command with forward direction/speed 1 selected and with the command
not blocked at the time of OP1 activation (refer to the S1LOCKED input pin
(see page 287)).
S2SELD BOOL 1 = Run command with reverse direction/speed 2 selected and with the command
not blocked at the time of OP2 activation (refer to the S2LOCKED input pin
(see page 287)).

RUNNING1 and RUNNING2 Outputs

Parameter Type Description

RUNNING1 BOOL 1 = The motor has reached the position corresponding to setpoint SP = 1 and SPSEL
= 0. It is evaluated by considering any detectors. Refer to the RUNNING2 output and
MOTOR2_ST.CFGW.SIMMD input/output pin (see page 294).
RUNNING2 BOOL 1 = The motor has reached the position corresponding to setpoint SP = 1 and SPSEL
= 1. It is evaluated by considering any detectors. Refer to the RUNNING1 output and
MOTOR2_ST.CFGW.SIMMD input/output pin (see page 294).

290 EIO0000002093 04/2020

 MOTOR2

The evaluation of the motor position depending on the configuration implemented with the ZSH1EN
and ZSL2EN inputs and on the MOTOR2_ST.CFGW.SIMMD input/output is shown in the following
table:

EXTCTLD ZSH1EN ZSH2EN SIMMD RUNNING1 RUNNING2

- - - ON OP1 OP2
OFF OFF OFF OFF OP1 OP2
OFF OFF ON OFF ZSH2 and OP1 ZSH2 and OP2
OFF ON OFF OFF ZSH1 and OP1 ZSH1 and OP2
OFF ON ON OFF ZSH1 and (not ZSH2) ZSH2 and (not ZSH1)
OFF OFF - OFF OFF OFF
ON - OFF OFF OFF OFF
ON ON ON OFF ZSH1 and (not ZSH2) ZSH2 and (not ZSH1)

ZH1POS and ZH2POS Outputs

Parameter Type Description

ZSH1POS BOOL Forward direction/speed 1 position status.
1 = Forward direction/speed 1 position confirmed. It is independent from the other
detector if the ZSH1 detector is available.
ZSH2POS BOOL Reverse direction/speed 2 position status.
1 = Reverse direction/speed 2 position confirmed. It is independent from the other
detector if the ZSH2 detector is available.

ALARM1 Output
ALARM1 output activates based on the detection of a limit position switch confirmation.
The detected alarm activates in the following scenario:
 When the DFB output (OP1) is switches from 0 to 1 as long as TIMEOUT timer is running, the
operation confirmations are not monitored, when the time is elapsed and position limit
(ZSH1POS) is not confirmed. The alarm is not evaluated if device is controlled externally
(EXTCTLD = 1).
 If both the limit switch positions (ZSH1POS and ZSH2POS) detect at same time. This alarm is
continued to evaluated even (EXTCTLD = 1).
After the time has elapsed, the alarm is deactivated based on the following conditions:
 if the operation confirmation signal becomes the desired signal (according to the OP1 value) or
 if the motor is reset (through the MOTOR2ST.CFGW.REARM input/output, and as long as the
CONFREARMEN input is 1).
In both cases, the internal timer is restarted with the TIMEOUT value.

EIO0000002093 04/2020 291

MOTOR2

ALARM2 Output
ALARM2 output activates based on the detection of a limit position switch confirmation.
The detected alarm activates in the following scenario:
 When the DFB output (OP2) is switches from 0 to 1 as long as TIMEOUT timer is running, the
operation confirmations are not monitored, when the time is elapsed and position limit
(ZSH2POS) is not confirmed. The alarm is not evaluated if device is controlled externally
(EXTCTLD = 1).
 If both the limit switch positions (ZSH1POS and ZSH2POS) detect at same time. This alarm is
continued to evaluated even (EXTCTLD = 1).
Once the time has elapsed, the detected alarm is deactivated based on the following conditions:
 if the operation confirmation signal becomes the desired signal (according to the OP2 value) or
 if the motor is reset (through the MOTOR2ST.CFGW.REARM input/output, and as long as the
CONFREARMEN input is 1).
In both cases, the internal timer is restarted with the TIMEOUT value.

FAILD1 and FAILD2 Outputs

Parameter Type Description

FAILD1 BOOL 1 = Indicates motor detected error in the forward direction/speed 1.It is evaluated
according to the value of the FAIL1 and FAIL1EN inputs. It is timed so that the
signal is maintained for a minimum of SCANTIME.
0 = After the minimum activation time has elapsed, it deactivates if the FAIL1 input
signal is de-activated (0).
FAILD2 BOOL 1 = Indicates motor detected error in the reverse direction/speed 2.It is evaluated
according to the value of the FAIL2 and FAIL2EN inputs. It is timed so that the
signal is maintained for a minimum of SCANTIME.
0 = After the minimum activation time has elapsed, it deactivates if the FAIL2 input
signal is de-activated (0). Refer to the FAILD1 output.

The signal evaluation depending on the FAILx and FAILxEN inputs is shown in the following table:

FAILx FAILxEN FAILD

- OFF OFF
OFF ON OFF
ON ON ON (minimum SCANTIME)

292 EIO0000002093 04/2020

 MOTOR2

UNPOS Output

Parameter Type Description

UNPOS BOOL 1 = Indicates that there is no way of finding out which operation is active. This can
take place when only one confirmation input is enabled. ZH1EN /= ZSH2EN

The evaluation of the ZSH1POS, ZSH2POS, and UNPOS signals depending on the EXTCTLD,
ZSH1EN and ZSH2EN inputs and the MOTOR2ST.CFGW.SIMMD input/output is shown in the
following table:

EXTCTLD ZSH1EN ZSH2EN SIMMD ZSH1POS ZSH2POS UNPOS

OFF - - ON OP1 OP2 OFF
OFF OFF OFF OFF OP1 OP2 OFF
OFF OFF ON OFF ZSH2 and OP1 ZSH2 and OP2 ZSH2 and (not OP1
and not OP2)
OFF ON OFF OFF ZSH1 and OP1 ZSH1 and OP2 ZSH1 and (not OP1
and not OP2)
- ON ON OFF ZSH1 ZSH2 OFF
ON OFF OFF OFF OFF OFF ON
ON OFF ON OFF OFF OFF ON
ON ON OFF OFF ZSH1 ZSH2 ON

STOPPED and OOS Outputs

Parameter Type Description

STOPPED BOOL 1 = Indicates that the motor is stopped. It is activated when neither
the ZSH1POS nor the ZSH2POS output signals are active.
OOS BOOL 1 = Indicates whether the equipment is Out of Service.

EIO0000002093 04/2020 293

MOTOR2

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

MOTOR2_ST MOTOR2_ST_DDT Data structure of the DFB control and status.

MOTOR2_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and
allows data to be kept in the memory. Read-only access to the data contained
in this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem.
Read/write access to the data contained in this word.

MOTOR2_ST.STW Word
The following table describes the MOTOR2_ST.STW word:

Bit Name Description

0 ZSH1POS Refer to the ZSH1POS output pin (see page 289).
1 ZSH2POS Refer to the ZSH2POS output pin (see page 289).
2 UNPOS Refer to the UNPOS output pin (see page 289).
4 OP1 Refer to the OP1 output pin (see page 289).
5 OP2 Refer to the OP2 output pin (see page 289).
6 REM Indicates if the current setpoint (SP) is local (0) or remote (1). The set-point is local when
the owner is the Operator (OWNER =1). When the owner is the Program (OWNER = 0), the
setpoint is selected with the SC.REM public signal (1: remote, 0: local).
7 ILCK Refer to the ILCK input pin (see page 287).
8 REARMR Indicates if the motor requires resetting (1) after the detection of an inoperable device
condition that has been configured as requiring resetting through the CONFREARMEN
and/or FAILREARMEN inputs. The activation logic of the signal included in the DFB is
shown in the following figure.
9 EXTCTLD Refer to the EXTCTLD input pin (see page 287).
10 ALARM1 Refer to the ALARM1 output pin (see page 289).
11 ALARM2 Refer to the ALARM2 output pin (see page 289).
12 FAILD1 Indicates an inoperable device (1). Refer to the FAILD1 output pin (see page 289).
13 FAILD2 Indicates an inoperable device (1). Refer to the FAILD2 output pin (see page 289).

294 EIO0000002093 04/2020

 MOTOR2

Bit Name Description

14 S1LOCKED Refer to the S1LOCKED input pin (see page 287).
15 S2LOCKED Refer to the S2LOCKED input pin (see page 287).

Activation logic of REARMR signal

MOTOR2_ST_DDT.CFGW Word
The following table describes the MOTOR2_ST_DDT.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by
0 Program
1 Operator
1 ILCKBP Read/write access
Enables the interlock to be bypassed (1).
2 SIMMD Read/write access
Allows putting the motor into simulation mode so that:
 The actual confirmation signals (ZSHx inputs) are ignored.
 The operation confirmations (according to the OP1 and OP2 outputs) are simulated.
 The motor is considered to be functional (as if the FAIL1 and FAIL2 inputs were
reset (0)).
3 REARM Write access
Enables the motor to be reset (1). The DFB sets the signal to 0 after each run and sets
the signal indicating that resetting is required (CFGW.REARM) to 0.

EIO0000002093 04/2020 295

MOTOR2

Bit Name Description

4 LSPSEL Read/write access
Enables to select the actuator to be affected by the local setpoint of the operator (OWNER
is 1) from the Supervision system :
0 = forward direction/speed 1.
1 = reverse direction/speed 2.
If the selection is set by the program (OWNER is 0), the DFB continuously assigns it the
value of the current selection.
5 LSP Read/write access
Enables local set-point (OWNER is 1) of the operator to be set from the monitoring
subsystem.
If the setpoint is set by the program (OWNER is 0), the DFB continuously assigns it the
value of the current setpoint.
15 OOS Out of service
Read/write access
Indicates whether the equipment is out of service (1) or in use (0).

NOTE: The outputs (SP and OP) are de-energized when the device is in an out-of-service state
even if an interlock that requests the device to be started is active.

296 EIO0000002093 04/2020

 MOTOR2

Public Variables

Public Variable Description

Variable Type Description

SC MOTOR2_SC_DDT Provides the frequently needed data to monitor motor
status and to control it from the sequential control.

MOTOR2_SC_DDT Type

Name Type Description

EXTCTLD BOOL Read-only access
1 = Shows the value of the EXTCTLD input so that you can modify it from the
sequential control.
REM BOOL Read/write access
1 = Enables the DFB to be configured to remote set-point—RSP—(1) or local
set-point—LSP— (0).
LSPSEL BOOL Read/write access
1 = Enables to select the actuator to be affected by the local set-point (0
corresponds to the forward direction/speed 1 and 1 corresponds to the reverse
direction/speed 2) usually for the sequential control if the owner is the Program
(OWNER is 0) and the selected set-point is Local (REM is 0).
In any other case, the DFB continuously assigns LSPSEL one of following
value:
OWNER REM SC.LSPSEL is calculated as:
OFF OFF SC.LSPSEL (last value or new value assigned
from the sequential control)
OFF ON SPSEL (calculated from the RSPSEL input)
ON ON SPSEL (last value or new value assigned by the
Operator)

EIO0000002093 04/2020 297

MOTOR2

Name Type Description

LSP BOOL Read/write access
1 = Enables to assign the local set-point usually for the sequential control if the
owner is the Program (OWNER is 0), and the selected set-point is Local (REM
public variable is 0).
0 = The block automatically assigns LSP the value of the resulting set-point as
described in the following table:
OWNER REM SC.LSP is calculated as:
OFF OFF SC.LSP (last value or new value assigned from
the sequential control)
OFF ON SP (calculated from the RSP input)
ON ON SP (last value or new value assigned by the
Operator)
OP1 BOOL Read-only access
Refer to the OP1 output pin (see page 289).
OP2 BOOL Read-only access
Refer to the OP2 output pin (see page 289).
S1SELD BOOL Read-only access
Refer to the S1SELD output pin (see page 289).
S2SELD BOOL Read-only access
Refer to the S2SELD output pin (see page 289).
RUNNING1 BOOL Read-only access
Refer to the RUNNING1 output pin (see page 289).
RUNNING2 BOOL Read-only access
Refer to the RUNNING2 output pin (see page 289).
ZSH1POS BOOL Read-only access
Refer to the ZSH1POS output pin (see page 289).
ZSH2POS BOOL Read-only access
Refer to the ZSH2POS output pin (see page 289).
STOPPED BOOL Read-only access
Refer to the STOPPED output pin (see page 289).
UNPOS BOOL Read-only access
Refer to the UNPOS output pin (see page 289).
ALARM1 BOOL Read-only access
Refer to the MOTOR2_ST.STW.ALARM1 input/output pin (see page 294).
ALARM2 BOOL Read-only access
Refer to the MOTOR2_ST.STW.ALARM2 input/output pin (see page 294).
FAILD1 BOOL Read-only access
Refer to the MOTOR2_ST.STW.FAILD1 input/output pin (see page 294).

298 EIO0000002093 04/2020

 MOTOR2

Name Type Description

FAILD2 BOOL Read-only access
Refer to the MOTOR2_ST.STW.FAILD2 input/output pin (see page 294).
REARMR BOOL Read-only access
Refer to the MOTOR2_ST.STW.REARMR input/output pin (see page 294).
ILCKD BOOL Read-only access
The signal evaluation depending on the ILCK input and the
MOTOR2ST.CFGW.ILCKBP input/output is shown in the following table:
ILCK ILCKBP SC.ILCKD
OFF OFF OFF
OFF ON ON
ON OFF OFF
ON ON OFF
OWNER BOOL Read-only access
Refer to the OWNER input/output pin (see page 294).
S1LOCKED BOOL Read-only access
Refer to the S1LOCKED input pin (see page 287).
S2LOCKED BOOL Read-only access
Refer to the S2LOCKED input pin (see page 287).
OOS BOOL Read/write access
1 = Indicates whether the equipment is Out of Service (1)

EIO0000002093 04/2020 299

MOTOR2

300 EIO0000002093 04/2020

 Modicon Libraries General Purpose
MOTOR2LP
EIO0000002093 04/2020

Chapter 30
MOTOR2LP - Local Panel for Controlling 2 Speed/2 Rotation Direction Motors

MOTOR2LP - Local Panel for Controlling 2 Speed/2 Rotation

Direction Motors

Overview
This chapter describes the MOTOR2LP DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 302
DFB Representation 303
Inputs 304
Outputs 307
Inputs/Outputs 308
Public Variables 311

EIO0000002093 04/2020 301

MOTOR2LP

Description

General
The objective of the MOTOR2LP DFB is to manage a local panel that controls a motor with 2
directions of rotation or 2 speeds. This motor is implemented with a MOTOR2 DFB and with signals
that are wired to the controller so that the latter determines the target position for the device.

Function Description
The main functions of the module are described in the following table:

Function Description
Mode Switch Optionally manages the signals coming from an operating mode switch in a local
panel with the following configuration: Local - Zero - Control System. The Zero mode
signal is optional. However the user can enable Local/Control System mode from the
faceplate also, when VirtualLPEN input pin signal is high and MODESignalsEN
signal is low in the DFB.
Push buttons The DFB manages up to three signals coming from OFF, ON - forward direction of
rotation/speed 1 and ON - reverse direction of rotation/speed two push buttons. The
priority is given to the OFF push button signal and then to the closing (ON) push
button signal.
Owner Management The DFB enables to configure whether the Program needs to be the valve owner or
not, after switching to the Control System mode again.
Owner Locking The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not, it disables the access to change the owner
(Operator/Program) while the valve is controlled from the Local Panel.
Set-point Lock The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not. It disables to change the set-point while the
analog output is controlled from the Local Panel.
Push button The push button signals from the Local Panel can be enabled/disabled through the
Enabling/Disabling DFB configuration (input pin) and/or from control sequences.
Enabled Panel The DFB provides a signal that can be used to illuminate a light source on the Local
Signaling Panel to indicate when the push buttons are enabled for operation.
Virtual Panel This signal enables the operator to select the Local / Control System mode of
Enabling/Disabling operation from the HMI so that the push button signals are enabled for operation.
NOTE: VirtualLPEN input pin signal is applicable when Modicon Libraries -
General Purpose is used along with Modicon Libraries - General Purpose for
Wonderware System Platform.

302 EIO0000002093 04/2020

 MOTOR2LP

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 303

MOTOR2LP

Inputs

Input Parameter Description

Parameter Type Description

LPSignal BOOL 1 = The local panel mode switch is in the Local Panel position. Refer to
the table included with the description of the LPMode output pin
(see page 307).
ZEROSignal BOOL 1 = The local panel mode switch is in the zero position.This signal is
optional even if a mode switch is available on the local panel. When this
signal is a logical high, user is not allowed to operate the device from the
faceplate and also from the DFB. Hence, all the functions in the faceplate
will be disabled. Refer to the table included with the description of the
LPMode output pin (see page 307).
CSSignal BOOL 1 = The local panel mode switch is in the Control System position. Refer
to the table included with the description of the LPMode output pin
(see page 307).
OFFSignal BOOL 1 = The OFF push button on the local panel is pressed.
DirectS1Signal BOOL 1 = Indicates the DFB that forward direction/speed 1 operation push
button on the local panel is pressed.
ReverseS2Signal BOOL 1 = Indicates the DFB that reverse direction/speed 2 operation push
button on the local panel is pressed.
MODESignalsEN BOOL 1 = Enables the use of the Local Panel/Zero/ Control System (or Local
Panel - Control System) mode switch on the local panel. Normally
configured in development phase based on the characteristics of the
local panel being used. If the mode switch is enabled, the LPSignal,
ZEROSignal, and CSSignal inputs are considered to determine the
operating modes of the local panel. Refer to the table included with the
description of the LPMode output pin (see page 307).
NOTE: MODESignalsEN input pin has higher priority than the
VirtualLPEN input pin signal.

304 EIO0000002093 04/2020

 MOTOR2LP

Parameter Type Description

VirtualLPEN BOOL 1 = This signal enables the operator to select the Local/Control System
mode of operation from the HMI, so that the push button signals are
enabled for operation.
NOTE:
 When the owner is program, the Local/Control System mode selection
drop-down list will be visible but disabled for operation however, when
the owner is operator the Local Panel drop-down list will be accessible
for operation.
 VirtualLPEN input pin signal is applicable only for Modicon
Libraries - General Purpose for Wonderware System Platform offer
only, however there is no impact of this input signal in Modicon
Libraries - General Purpose for Citect SCADA offer.
Refer to the table included with the description of the LPMode output pin
(see page 307).
PBSignalsEN BOOL 1 = Enables to accept the OFF, ON - forward direction of rotation/speed
1, and ON - reverse direction of rotation/speed 2 push button signals from
the local panel. This signal is not applicable if the mode switch is enabled
(refer to the MODESignalsEN input). It means that the push button
signals are considered in Local Panel mode.
When the mode switch is disabled (MODESignalsEN = 0), the
PBSignalsEN signal enables/disables the push button signals from the
control system itself based on the relevant process conditions. The
SC.DISABLELP public variable is also considered when determining
whether the push buttons are enabled or not when LPMODE pin signal is
high, as shown in the following table:
MODESignalsEN PBSignalsEN SC.DisableLP Push buttons
enabled
OFF OFF - NO
OFF - ON NO
OFF ON OFF YES
ON - - YES
Therefore, this signal can be used to enable/disable the push buttons on
a simple local panel that does not feature a mode switch (Local Panel/
Zero/Control System) based on the relevant process conditions.
ToProgramEN BOOL 1 = Enables the functionality to change the owner of 2-speed/2-rotation
direction motor to Program when the mode switch on local panel returns
to control system position (only when the mode is switched). If this
functionality is disabled, the operator of monitoring (HMI) system will
have to switch to Program owner when the operator deems it as
appropriate. Refer to the table included with the description of the
LockOwnerEN input.

EIO0000002093 04/2020 305

MOTOR2LP

Parameter Type Description

LockOwnerEN BOOL 1 = Disables the access of owner of the 2-speed/2-rotation direction
motor remaining as Operator while the local panel mode is Local Panel.
The following table shows how the owner of the 2-speed/2-rotation
direction motor is evaluated based on the ToProgramEN and
LockOwnerEN inputs and the operating mode of the local panel:
Local Panel Mode ToProgramEN LockOwnerEN Owner
0 - - Operator
Switch to Local - - Operator
Panel
Local Panel - ON Operator
Switch to Control ON - Program
System
In the remaining cases, the owner of the 2-speed/2-rotation direction
motor ceases to be defined from the MOTOR2LP DFB and it enables to
change it from the monitoring (HMI) system with the command word in
the MOTOR2_ST.CFGW input/output of the corresponding MOTOR2 DFB.
In any case, take into account that the owner of the 2-speed/2-rotation
direction motor that had been set before switching to the local panel
mode is not memorized.
LockSetpointEN BOOL 1 = Disables the access to the set-point of 2-speed/2-rotation direction
motor and lock it into the one defined on the local panel while the local
panel mode is Local Panel and the device owner is Operator. Take into
account that the user can switch to Program mode based on the signals
that has been previously described even if the local panel mode is set to
Local Panel.
Therefore, this signal needs to be activated if user wants to lock setpoint
operation from the monitoring (HMI) system while the 2-speed/2-rotation
direction motor is controlled from the local panel.

306 EIO0000002093 04/2020

 MOTOR2LP

Outputs

Output Parameter Description

Parameter Type Description

PBLIGHTSignal BOOL 1 = The push buttons on the local panel are fully operational, that is, the local panel is
in Local Panel mode (either because the mode is selected with the corresponding
switch or because the push buttons are enabled in the event that there is no selector
switch available or the VirtualLPEN is high with the local panel mode enabled).
LPMode BOOL 1 = The local panel mode is in Local Panel.
The following table shows how the local panel operating mode is determined based
on the MODESignalsEN, VirtualLPEN, PBSignalsEN, LPSignal, CSSignal and
ZEROSignal, input signals:
MODESig- Virtu- PBSig- LPSig- CSSig- ZEROSig- OUTPUT
nalsEN alLPEN nalsEN nal nal nal
0 0 0 0 0 0 CS mode
1 0 0 0 0 0 Zero mode
1 0 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 0 0 0 1 0 CS mode
0 1 1 NA NA NA CS mode
0 1 0 NA NA NA CS mode
0 0 1 0 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 0 0 0 Zero mode
1 1 0 0 0 1 Zero mode
1 1 0 0 1 0 CS mode
1 0 1 0 1 0 CS mode
1 1 1 0 1 0 CS mode
1 0 0 0 0 1 Zero mode
ZEROMode BOOL 1 = The local panel mode is in Zero. User is not allowed to operate the device from the
faceplate and also from DFB. Hence, all the functions in the faceplate will be disabled.
Refer to the table included with the description of the LPMode output.
CSMode BOOL 1 = The local panel mode is in Control System. Refer to the table included with the
description of the LPMode output.

EIO0000002093 04/2020 307

MOTOR2LP

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

MOTOR2_ST MOTOR2_ST_DDT Data structure corresponding to the 2-speed/2-rotation direction
motor is to be controlled from the local panel (for detailed
information regarding this structure, refer to the MOTOR2 DFB
(see page 283).
The structure provides the information needed for the operation
of the MOTOR2LP DFB and enables this DFB to control the owner
of the 2-speed/2-rotation direction motor.
MOTOR2LP_ST MOTOR2LP_ST_DDT Data structure that is used as an interface with the monitoring
(HMI) system.

MOTOR2_ST.DDT Type

Name Type Description

CFGW WORD Provides the means to control the device from the monitoring (HMI)
system. Read-only access to the data contained in this word.

MOTOR2LP_ST.DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory. Read-only
access to the data contained in this word.

308 EIO0000002093 04/2020

 MOTOR2LP

MOTOR2_ST.CFGW Word
The following table describes the MOTOR2_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or by the Operator (1).
Refer to the following table included with the description of the LPMode output, which specifies the
cases in which the MOTOR2LP DFB can interact with this signal.
4 LSPSEL Read/write access
Enables to set the LSPSEL command from the monitoring (HMI) system when the owner is the
Operator (OWNER = 1). As long as the set-point is set by the Program (OWNER = 0), the DFB
continuously assigns it the value of the current command (MOTOR2_ST.STW.LSPSEL input/output).
Refer to the LSP bit.
5 LSP Read/write access
Enables to set the LSPSEL command from the monitoring (HMI) system when the owner is the
Operator (OWNER = 1). As long as the set-point is set by the Program (OWNER = 0), the DFB
continuously assigns it the value of the current command (MOTOR2_ST.STW.LSPSEL input/output).
Refer to the LSP bit.
The Owner OFF- DirectS1Sig- Revers- LockSet- LSP is LSPSEL
MOTOR2LP Signal nal eS2Sig- PointEN calcu- is calcu-
DFB nal lated lated as:
determines as:
the set-
point for
the 2-
speed/2-
rotation
direction
motor.
0 The OWNER - - - - OFF Last
signal is value
forced to
1(Operator).
Local Operator ON - - - OFF Last
Panel value
Local Operator OFF ON - - ON OFF
Panel
Local Operator OFF - ON - ON ON
Panel
Local Operator OFF OFF OFF ON Last Last
Panel value value
In other cases, the LSP and LSPSEL signals are not modified from the MOTOR2LP DFB.

EIO0000002093 04/2020 309

MOTOR2LP

MOTOR2LP_ST.CFGW Word

Bit Name Description

0 LocalModeOn Read/write access
 1 = Enables the Local Panel mode.
 0 = Enables the Control System mode.

MOTOR2LP_ST.STW Word
Read-only access. Status word. The following table describes the MOTOR2LP_ST.STW word:

Bit Name Description

0 LPMode Local panel in Local Panel mode. Refer to the LPMode output pin.
1 ZEROMode Local panel in zero mode. Refer to the ZEROMode output pin.
2 CSMode Local panel in Control System mode. Refer to the CSMode output pin.
3 LockedOwner Indicates whether the owner change buttons in the monitoring (HMI) system
needs to be locked (1) or not (0).
Is activated when:
 The Local Panel mode is set to Zero or
 It is set to Local Panel and the LockOwnerEN input signal has been
configured as active (1).
4 SPLocked Indicates whether the set-point change buttons in monitoring (HMI) system
needs to be locked (1) or not (0).
Is activated when:
 The Local Panel mode is set to Zero or
 It is set to Local Panel and the LockSetpointEN input signal has been
configured as active (1).
5 MODESignalsEN Indicates the state of the MODESignalsEN input signal, that is, whether there
is a mode switch (1) or not (0).
6 PBEnabled Indicates whether the push buttons of the local panel are enabled (1) or not
(0). The signal is activated when at least one of the MODESignalsEN and
PBSignalsEN signal inputs is active.
7 VirtualLPEN Enables the drop-down list for the Local Panel / Control System mode
selection.
8 LPSignal Indicates the state of the LPSignal input signal.
9 ZEROSignal Indicates the state of the ZEROSignal input signal.
10 CSSignal Indicates the state of the CSSignal input signal.
11 OFFSIGNAL Indicates the state of the OFFSignal input signal.
12 DirectS1Signal Indicates the state of the DirectS1Signal input signal.
13 ReverseS2Signal Indicates the state of the ReverseS2Signal input signal.

310 EIO0000002093 04/2020

 MOTOR2LP

Public Variables

Public Variable Description

Variable Type Description

SC MOTOR2LP_SC_DDT Provides the frequently needed data for
monitoring (HMI) and controlling the DFB.

MOTOR2LP_SC_DDT Type

Name Type Description

LPMode BOOL Read-only access
Refer to the LPMode output pin (see page 307).
ZEROMode BOOL Read-only access
Refer to the ZEROMode output pin (see page 307).
CSMode BOOL Read-only access
Refer to the CSMode output pin (see page 307).
DisableLP BOOL Read/write access
1 = Disables the push buttons on the local panel. Only
applicable when a local panel without mode switch
configuration is used (MODESignalsEN = 0).

EIO0000002093 04/2020 311

MOTOR2LP

312 EIO0000002093 04/2020

 Modicon Libraries General Purpose
MVALVED
EIO0000002093 04/2020

Chapter 31
MVALVED - Discrete Motorized Valve

MVALVED - Discrete Motorized Valve

Overview
This chapter describes the MVALVED DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 314
DFB Representation 315
Inputs 316
Outputs 318
Inputs/Outputs 319
Public Variables 321

EIO0000002093 04/2020 313

MVALVED

Description

General
The MVALVED DFB is designed to control a motorized valve, or a gate, with two limit switches
(open-valve and closed-valve) and a two-rotation-directions-motor based control.
User can combine the MVALVED DFB with the following Control Expert components from the
General Purpose Library:
 MOTOR2
 DINPUT

Function Description
The main functions of the DFB are described in this table:

Function Description
Control Controls the digital control signal of the element based on the configuration and the
commands that the block receives according to the functions that are described below.
Owner selection The module manages the control system level (operator or program), which is the owner.
As a result, it is responsible for setting the setpoint for the target position.
Local and Enables to control the DFB with a set-point that is determined through a set-point selector
remote setpoint (local or remote) in program owner. The local set-point is assigned from the sequential
control while the remote set-point is assigned to the DFB control from the logic
implemented in the continuous control.
Position Allows to determine the actual position of the element to be controlled and monitored with
detection the help of high and low limit switch.
Inoperable Allows to monitor inoperable device condition. DFB can be configured to withdraw output
device based on this condition.
Interlocking The DFB gives a command to the device to move to the defined position in case of an
active interlock. An interlock bypass function is available.
Detection of not If position is not confirmed within a configured time after the output command is activated,
confirmed DFB detects not confirmed operation.
operation
Manual resetting Allows you to reset manually after the detection of an inoperable device condition or a not
confirmed operation. After reset, device output will follow set point.

314 EIO0000002093 04/2020

 MVALVED

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 315

MVALVED

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL When a rising edge is detected on this input, the internal timers
of the block are reset and detected alarms are set to 0.
CONFREARMEN BOOL  1 = Withdraws the output SP_MOTOR2 when a non-confirmed
operation is detected (ALARM = 1) and requires a mandatory
manual resetting once the ALARM condition disappears.
 0 = The output SP_MOTOR2 remains in its previous state when
a non-confirmed operation is detected (ALARM = 1) and does
not need manual resetting, once the ALARM condition
disappears.
Refer to the REACTIONTIME inputs (see page 316) and
TIMEOUT inputs pin (see page 316).
FAILREARMEN BOOL  1 = Withdraws the output SP_MOTOR2 upon a detected failure
condition (FAILD = 1) and requires a mandatory manual
resetting once the FAIL condition disappears.
 0 = The output SP_MOTOR2 remains in its previous state upon
a detected failure condition (FAILD = 1) and does not need
manual resetting, once the FAIL condition disappears.
RSPSEL BOOL Remote set point selection
1 = Valve closing set point
0 = Valve opening set point
RSP BOOL Remote set-point by the continuous control.
1 = The set point selected in RSPSEL is considered.
0 = Stop command
ILCKSEL BOOL Interlock set point selection
1 = Valve closing set point
0 = Valve opening set point
ILCKSP BOOL 1 = Run
Setpoint needs to be used when the block is interlocked. Refer to
the ILCK input pin (see page 316).
ILCK BOOL 1 = Interlocks the valve at the defined position.
REACTIONTIME TIME Enables to configure the time during which monitoring for the
valve switching operations is enabled. During this time, a check
is run to verify that the valve leaves the limit switch opposite to
the operation that is carried out. When it has a value of 0,
monitoring is disabled. This time is useful for detecting irregularity
behavior in the valve and does not wait until the maximum stroke
time is elapsed to detect them.

316 EIO0000002093 04/2020

 MVALVED

Parameter Type Description

TIMEOUT TIME Enables to configure the maximum time that the valve takes to
complete its stroke for closing and opening. When the output is
triggered, if the limit switch is not detected even after the
TIMEOUT time is elapsed. The device is switched to detected
alarm state if the limit switch is not detected. When it has a value
of 0, monitoring is deactivated.
SCANTIME TIME The minimum time for which the detected alarm signals are kept
active. SCANTIME confirms that the Supervision system
acquires the data for detected alarms that are automatically
reset.
MOTOR2_ST MOTOR2_ST_DDT Enables to find out the status of the device. Provides the current
status, inoperable device conditions, detected alarms, lack of
setpoint follow-up, owner, and simulation of the motor that
actuates the valve.
ZSH_DINPUT_ST DINPUT_ST_DDT 1 = Indicates to the DFB that high limit position has been reached
Provides the quality of the channel and allows simulating the high
limit switch.
ZSL_DINPUT_ST DINPUT_ST_DDT 1 = Indicates to the DFB that low limit position has been reached.
Provides the quality of the channel and allows simulating the low
limit switch.

EIO0000002093 04/2020 317

MVALVED

Outputs

Output Parameter Description

Parameter Type Description

SP_MOTOR2 BOOL 1 = Provides the remote setpoint for motor control (RSP). Refer to the RSP
(see page 287) input of MOTOR2 block.
RSPSEL_MOTOR2 BOOL 1 = Provides the setpoint for selecting the actuator to be affected by the
SP_MOTOR2 setpoint. Refer to the RSPSEL input (see page 287) of
MOTOR2 block.
ILCK_MOTOR2 BOOL 1 = Interlocks the motor when one of the limit switches is detected and the
travel direction command remains in place.
OPEN BOOL 1 = Indicates the open-valve position is reached.
CLOSED BOOL 1 = Indicates the closed-valve position is reached.
S1SELD BOOL 1 = Valve opening command is not blocked when OP1 is activated.
S2SELD BOOL 1 = Valve closing command is not blocked when OP2 is activated.
ALARM1 BOOL 1 = Indicates a limit switch has not responded during valve opening.
Monitoring begins when MOTOR2 is actuated and continues until the open-
valve limit switch is detected. If the time defined in TIMEOUT is exceeded,
the alarm function of the device is activated.
ALARM2 BOOL 1 = Indicates a limit switch has not responded during valve closing.
Monitoring begins when MOTOR2 is actuated and continues until the close-
valve limit switch is detected. If the time defined in TIMEOUT is exceeded,
the alarm function of the device is activated.
FAILD BOOL 1= Irregularity in one of the auxiliary devices.

WARNING
UNINTENDED EQUIPMENT OPERATION
 The CONFREARMEN pin has to be set to 1 for the SP_MOTOR2 pin to become 0, under non-
confirmed operations.
 Changes to the configuration of these parameters have to be performed by competent
personnel only.
 The FAILREARMEN pin has to be set to 1 for the SP_MOTOR2 pin to become 0, under non-
confirmed operations. Changes to the configuration of these parameters have to be performed
by competent personnel only.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

318 EIO0000002093 04/2020

 MVALVED

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

MVALVED_ST MVALVED_ST_DDT Provides the data needed to monitor and/or control the block
status.

MVALVED_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory. Read-only
access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read/write access to the data contained in this word.

MVALVED_ST.STW Type

Bit Name Description

0 OPEN Refer to the OPEN output pin (see page 318).
1 CLOSED Refer to the CLOSED output pin (see page 318).
6 REM Refer to the SC.REM public variable (see page 321).
7 ILCK Refer to the ILCK input pin (see page 316).
8 REARMR Reset required (1).
10 ALARM1 Refer to the ALARM1 output pin (see page 318).
11 ALARM2 Refer to the ALARM2 output pin (see page 318).
12 FAILD Refer to the FAILD output pin (see page 318).

EIO0000002093 04/2020 319

MVALVED

MVALVED_ST.CFGW Type

Bit Name Description

0 OWNER Allows you to configure whether the set-point is set by the program (0) or by the
operator (1).
1 ILCKBP Enables the interlock to be bypassed (1).
3 REARM Write access
Reset the valve (1).
The DFB sets the signal to 0 after each run and sets the signal indicating that the
resetting is required (CFGW.REARM) to 0.
4 LSPSEL Read/write access
Enables to select the action that has to carried out by the operator local setpoint
(OWNER = 1) from the Supervision system (0 corresponds to opening and 1 to
closing). If the selection is set by the program (OWNER = 0), the block continuously
assigns it the value of the current selection.
5 LSP Read/write access
Allows the operator local setpoint (OWNER is 1) to be set from the Supervision
system. If the setpoint is set by the program (OWNER = 0), the block continuously
assigns it the value of the current setpoint.

320 EIO0000002093 04/2020

 MVALVED

Public Variables

Public Variable Description

Variable Type Description

SC MVALVED_SC_DDT Provides the common data required to monitor and
control the valve status from the sequential control.

MVALVED_SC_DDT Type

Name Type Description

REM BOOL Read/write access
1 = Enables the DFB to be configured to remote set-point RSP.
0 = Enables the DFB to be configured to local set-point LSP.
LSPSEL BOOL Read/write access
Enables the sequential control to select the actuator to be affected by the local
set-point
1 = Corresponds to the closing direction.when the owner is the Program (OWNER
= 0) and the selected set-point is local (REM = 0).
1 = Corresponds to the opening direction. when the owner is the Program
(OWNER = 0) and the selected set-point is local (REM = 0).
Calculation for LSPSEL:
OWNER REM SC.LSPSEL
OFF OFF SC.LSPSEL (last value or new value is assigned
from the sequential control).
OFF ON SPSEL (calculated on the basis of the RSPSEL
input).
ON ON SPSEL (last value or new value is assigned by the
Operator).
LSP BOOL Read/write access
1 = Enables the sequential control to assign the local set-point if the owner is the
Program (OWNER = 0) and the selected set-point is local (REM public variable = 0).
0 = The block automatically assigns the current value of the resulting set-point as
described below:
OWNER REM SC.LSP is calculated as:
OFF OFF SC.LSP (last value or new value is assigned from
the sequential control).
OFF ON SP (calculated based on the RSP input).
ON ON SP (last value or new value is assigned by the
Operator).

EIO0000002093 04/2020 321

MVALVED

Name Type Description

S1SELD BOOL Read-only access
Refer to the S1SELD output pin (see page 318).
S2SELD BOOL Read-only access
Refer to the S2SELD output pin (see page 318).
OPEN BOOL Read-only access
Refer to the OPEN output pin (see page 318).
CLOSED BOOL Read-only access
Refer to the CLOSED output pin (see page 318).
ALARM1 BOOL Read-only access
Refer to the ALARM1 output pin (see page 318).
ALARM2 BOOL Read-only access
Refer to the ALARM2 output pin (see page 318).
FAILD BOOL Read-only access
Refer to the FAILD output pin (see page 318).
REARMR BOOL Read-only access
ILCKD BOOL Read-only access
The way in which the signal is evaluated based on the ILCK input and the
MVALVED_ST.CFGW.ILCKBP input/output is shown below:
ILCK ILCKBP SC.ILCKD calculated as:
OFF – OFF
ON OFF ON
ON ON OFF
OWNER BOOL Read-only access
SP_MOTOR2 BOOL Read-only access
Refer to the SP_MOTOR2 output pin (see page 318).
SPSEL_MOTOR2 BOOL Read-only access
Refer to the SPSEL_MOTOR2 output pin (see page 318).
ILCK_MOTOR2 BOOL Read-only access
Refer to the ILCK_MOTOR2 output pin (see page 318).

322 EIO0000002093 04/2020

 Modicon Libraries General Purpose
MVALVEDLP
EIO0000002093 04/2020

Chapter 32
MVALVEDLP - Local Panel for Controlling Motorized On/Off Valves

MVALVEDLP - Local Panel for Controlling Motorized On/Off

Valves

Overview
This chapter describes the MVALVEDLP DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 324
DFB Representation 325
Inputs 326
Outputs 329
Inputs/Outputs 330
Public Variables 333

EIO0000002093 04/2020 323

MVALVEDLP

Description

General
The objective of the MVALVEDLP DFB is to manage a local panel that controls a motorized on-off
valve. This valve is implemented with an MVALVED DFB and with signals that are wired to the
controller so that the latter defines the target position for the device.

Function Description
The main functions of the module are described in the following table:

Function Description
Mode Switch Optionally manages the signals coming from an operating mode switch in a local
panel with the following configuration: Local - Zero - Control System. The Zero mode
signal is optional. However the user can enable Local/Control System mode from the
faceplate also, when VirtualLPEN input pin signal is high and MODESignalsEN
signal is low.
Push buttons The DFB manages up to three signals coming from OFF, OPEN and CLOSE push
buttons. The highest priority is given to the OFF push button signal followed by the
CLOSE push button signal.
Owner Management The DFB enables to configure whether the Program needs to be the valve owner or
not, after switching to the Control System mode again.
Owner Locking The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not, it disables the access to change the owner
(Operator/Program) while the valve is controlled from the Local Panel.
Set-point Lock The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not. It disables to change the set-point while the valve
is controlled from the Local Panel.
Push button The push button signals from the Local Panel can be enabled/disabled through the
Enabling/Disabling DFB configuration (input pin) and/or from control sequences.
Enabled Panel The DFB provides a signal that can be used to illuminate a light source on the Local
Signaling Panel to indicate when the push buttons are enabled for operation.
Virtual Panel This signal enables the operator to select the Local / Control System mode of
Enabling/Disabling operation from the HMI so that the push button signals are enabled for operation.
NOTE: VirtualLPEN input pin signal is applicable when Modicon Libraries -
General Purpose is used along with Modicon Libraries - General Purpose for
Wonderware System Platform.

324 EIO0000002093 04/2020

 MVALVEDLP

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 325

MVALVEDLP

Inputs

Input Parameter Description

Parameter Type Description

LPSignal BOOL 1 = The local panel mode switch is in the Local Panel position. Refer to the
table included with the description of the LPMode output pin
(see page 329).
ZEROSignal BOOL 1 = The local panel mode switch is in the zero position.This signal is
optional even if a mode switch is available on the local panel. When this
signal is a logical high, user is not allowed to operate the device from the
faceplate and also from the DFB. Hence, all the functions in the faceplate
will be disabled. Refer to the table included with the description of the
LPMode output pin (see page 329).
CSSignal BOOL 1 = The local panel mode switch is in the Control System position. Refer to
the table included with the description of the LPMode output pin
(see page 329).
OFFSignal BOOL 1 = The OFF push button on the local panel is pressed.
OpenSignal BOOL 1 = Indicates to the DFB the OPEN push button on the local panel is
pressed.
CloseSignal BOOL 1 = Indicates to the DFB the CLOSE push button on the local panel is
pressed.
MODESignalsEN BOOL 1 = Enables the use of the Local Panel/Zero/Control System (or Local panel
- Control System) mode switch on the local panel. Normally configured in
development phase based on the characteristics of the local panel being
used. If the mode switch is enabled, the LPSignal, ZEROSignal, and
CSSignal inputs are considered to determine the operating modes of the
local panel. Refer to the table included with the description of the LPMode
output pin (see page 329).
NOTE: MODESignalsEN input pin has higher priority than the
VirtualLPEN input pin signal.

326 EIO0000002093 04/2020

 MVALVEDLP

Parameter Type Description

VirtualLPEN BOOL 1 = This signal enables the operator to select the Local/Control System
mode of operation from the HMI, so that the push button signals are
enabled for operation.
NOTE:
 When the owner is program, the Local/Control System mode selection
drop-down list will be visible but disabled for operation however, when
the owner is operator the Local Panel drop-down list will be accessible
for operation.
 VirtualLPEN input pin signal is applicable only for Modicon Libraries
- General Purpose for Wonderware System Platform offer only,
however there is no impact of this input signal in Modicon Libraries -
General Purpose for Citect SCADA offer.
Refer to the table included with the description of the LPMode output pin
(see page 329).
PBSignalsEN BOOL 1 = Enables to accept the OFF, OPEN and CLOSE push buttons from the
local panel. This signal is not applicable if the mode switch is enabled (refer
to the MODESignalsEN input). It means that the push button signals are
considered in the local panel mode.
When the mode switch is disabled (MODESignalsEN = 0), the
PBSignalsEN signal enables/disables the push button signals from the
control system itself based on the relevant process conditions. The
SC.DISABLELP public variable is also considered when determining
whether the push buttons are enabled or not when LPMode pin signal is
high, as shown in the following table:
MODESignalsEN PBSignalsEN SC.DisableLP Push buttons
enabled ?
OFF OFF - NO
OFF - ON NO
OFF ON OFF YES
ON - - YES
Therefore, this signal can be used to enable/disable the push buttons on a
simple local panel that does not feature a mode switch (Local
Panel/Zero/Control System) based on the relevant process conditions.
ToProgramEN BOOL 1 = Enables the functionality to change the owner of the corresponding
motorized valve to Program when the mode switch on the local panel
returns to the control system position (only when the mode is switched). If
this functionality is disabled, the operator of the monitoring (HMI) system
switches to Program owner when the operator deems it appropriate. Refer
to the table included with the description of the LockOwnerEN input.

EIO0000002093 04/2020 327

MVALVEDLP

Parameter Type Description

LockOwnerEN BOOL 1 = Disables the access of the owner of the motorized valve remaining as
Operator while the local panel mode is Local Panel.
The following table shows how the owner of the motorized valve is
evaluated based on the ToProgramEN and LockOwnerEN inputs and
operating mode of the local panel:
Local Panel Mode ToProgramEN LockOwnerEN Owner
Zero - - Operator
Switch to Local - - Operator
Panel
Local Panel - ON Operator
Switch to Control ON - Program
System
In the remaining cases, the owner of the motorized valve ceases to be
defined from the MVALVEDLP DFB. It becomes possible to change it from
the monitoring (HMI) system with the command word in the
MVALVED_ST.CFGW input/output variable of the corresponding MVALVED
DFB.
In any case, consider that the valve owner that had been set before
switching to the local panel mode is not memorized.
LockSetPointEN BOOL 1 = Disables the access to the setpoint of the motorized valve and lock it
into the one defined on the local panel while the local panel mode is Local
Panel and the device owner is the Operator. You can switch to the Program
mode based on the signals that have been previously described even if the
local panel mode is set to Local Panel.
Therefore, user can activate (1) this signal to lock setpoint operation from
the monitoring (HMI) system while the motorized valve is controlled from
the local panel.

328 EIO0000002093 04/2020

 MVALVEDLP

Outputs

Output Parameter Description

Parameter Type Description

PBLIGHTSignal BOOL 1 = The push buttons on the local panel are fully operational, that is, the local panel is
in Local Panel mode (either because the mode is selected with the corresponding
switch or because the push buttons are enabled in the event that there is no selector
switch available or the VirtualLPEN is high with the local panel mode enabled).
LPMode BOOL 1 = The local panel mode is in Local Panel.
The following table shows how the local panel operating mode is determined based
on the MODESignalsEN, VirtualLPEN, PBSignalsEN, LPSignal, CSSignal and
ZEROSignal, input signals:
MODESig- Virtu- PBSig- LPSig- CSSig- ZEROSig- OUTPUT
nalsEN alLPEN nalsEN nal nal nal
0 0 0 0 0 0 CS mode
1 0 0 0 0 0 Zero mode
1 0 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 0 0 0 1 0 CS mode
0 1 1 NA NA NA CS mode
0 1 0 NA NA NA CS mode
0 0 1 0 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 0 0 0 Zero mode
1 1 0 0 0 1 Zero mode
1 1 0 0 1 0 CS mode
1 0 1 0 1 0 CS mode
1 1 1 0 1 0 CS mode
1 0 0 0 0 1 Zero mode
ZEROMode BOOL 1 = The local panel mode is in Zero. User is not allowed to operate the device from the
faceplate and also from DFB. Hence, all the functions in the faceplate will be disabled.
Refer to the table included with the description of the LPMode output.
CSMode BOOL 1 = The local panel mode is in control system. Refer to the table included with the
description of the LPMode output.

EIO0000002093 04/2020 329

MVALVEDLP

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

MVALVED_ST MVALVED_ST_DDT Data structure corresponding to the motorized on-off valve is
to be controlled from the local panel (for detailed information
regarding this structure, refer to the MVALVED DFB
(see page 313).
The structure provides the information needed for the
operation of the MVALVEDLP DFB and enables this DFB to
control the owner of the motorized valve.
MVALVEDLP_ST MVALVEDLP_ST_DDT Data structure that is used as an interface with the monitoring
(HMI) system.

MVALVED_ST.DDT Type

Name Type Description

CFGW WORD Provides the means to control the device from the monitoring (HMI) system.
Read-only access to the data contained in this word.

MVALVEDLP_ST.DDT Type

Name Type Description

STW WORD Read-only access
Bits word with the status of the local panel.

330 EIO0000002093 04/2020

 MVALVEDLP

MVALVE_ST.CFGW Word
The following table describes the MVALVED_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or by the Operator (1).
Refer to the table included with the description of the LPMode output pin, which specifies the cases
in which the MVALVEDLP DFB can interact with this signal.
4 LPSEL Read/write access
Enables to set the LPSEL command from the monitoring (HMI) system when the owner is the
Operator (OWNER = 1). As long as the set-point is set by the Program (OWNER = 0), the DFB
continuously assigns it the value of the current command (MVALVED_ST.STW.START
input/output).
The OWNER OFFSignal ONSignal LockSetPointEN LPSEL is calculated
MVALVEDLP as:
DFB
determines
the set-point
command.
0 - (The - - - OFF
OWNER
signal is
forced to
1(Operat
or).
Local Panel Operator ON - - OFF
Local Panel Operator OFF Switch to - ON
ON
Local Panel Operator OFF OFF ON Last value
In other cases, the START signal is not modified from the MVALVELP DFB.
5 LSP -

EIO0000002093 04/2020 331

MVALVEDLP

MVALVEDLP_ST.CFGW Word

Bit Name Description

0 LocalModeOn Read/write access only
 1 = Enables the Local Panel mode.
 0 = Enables the Control System mode.

MVAVEDLP_ST.STW Word
Read-only access. Status word. The following table describes the MVALVEDLP_ST.STW word:

Bit NAME Description

0 LPMode Local panel in Local Panel mode. Refer to the LPMode output pin.
1 ZEROMode Local panel in zero mode. Refer to the ZEROMode output pin.
2 CSMode Local panel in Control System mode. Refer to the CSMode output pin.
3 LockedOwner Indicates whether the owner change buttons in the monitoring (HMI) system
needs to be locked (1) or not (0).
Is activated when:
 The Local Panel mode is set to Zero or
 It is set to Local Panel and the LockOwnerEN input signal has been
configured as active (1).
4 SPLocked Indicates whether the set-point change and START buttons in the monitoring
(HMI) system needs to be locked (1) or not (0).
Is activated when:
 The Local Panel mode is set to Zero or
 It is set to Local Panel and the LockSetpointEN input signal has been
configured as active (1).
5 MODESignalsEN Indicates the state of the MODESignalsEN input signal, that is, whether there
is a mode switch (1) or not (0).
6 PBEnabled Indicates whether the push buttons of the local panel are enabled (1) or not (0).
The signal is activated when at least one of the MODESignalsEN and
PBSignalsEN signal inputs is active.
7 VirtualLPEN Enables the drop-down list for the Local Panel / Control System mode selection.
8 LPSignal Indicates the state of the LPSignal input signal.
9 ZEROSignal Indicates the state of the ZEROSignal input signal.
10 CSSignal Indicates the state of the CSSignal input signal.
11 OFFSignal Indicates the state of the OFFSignal input signal.
12 OpenSignal Indicates the state of the OpenSignal input signal.
13 CloseSignal Indicates the state of the CloseSignal input signal.

332 EIO0000002093 04/2020

 MVALVEDLP

Public Variables

Public Variable Description

Variable Type Description

SC MVALVEDLP_SC_DDT Provides the frequently needed data for monitoring and controlling
the block.

MVALVEDLP_SC_DDT Type

NAME Type Description

LPMode BOOL Read-only access
Refer to the LPMode output pin (see page 329).
ZEROMode BOOL Read-only access
Refer to the ZEROMode output pin (see page 329).
CSMode BOOL Read-only access
Refer to the CSMode output pin (see page 329).
DisableLP BOOL Read/write access
1 = Disables the push buttons on the local panel. Only applicable when a local
panel without mode switch configuration is used (MODESignalsEN = 0).

EIO0000002093 04/2020 333

MVALVEDLP

334 EIO0000002093 04/2020

 Modicon Libraries General Purpose
DVALVE - Dual Output Valve
EIO0000002093 04/2020

Chapter 33
DVALVE - Dual Output Valve

DVALVE - Dual Output Valve

Overview
This chapter describes the DVALVE DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 336
DFB Representation 337
Inputs 338
Outputs 340
Inputs/Outputs 345
Public Variables 347

EIO0000002093 04/2020 335

DVALVE - Dual Output Valve

Description

General
The DVALVE DFB manages the valves with dual output.
The DFB allows management of the associated devices from the sequential control, the continuous
control, and/or the monitoring subsystem. It depends on the user configuration and the system
needs.
User can supplement the DFB with the DEVMNT, CONDSUM, and CONDSUM1 DFB from the General
Purpose Library.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Control Controls the digital control signal of the element based on the configuration and the
commands that the DFB receives according to the functions.
Owner selection The DFB manages the control system level, which is the owner (operator or program).
As a result, it is responsible for setting the set-point for the desired position.
Local and remote set- Enables to control the DFB with a set-point that is determined through a set-point
point selector (local or remote) in program owner. The local set-point is assigned from the
sequential control while the remote set-point is assigned to the DFB control from the
logic implemented in the continuous control.
Position detection Allows to determine the actual position of the element to be controlled and monitored
with the help of high and low limit switch.
Inoperable device Allows to monitor inoperable device condition (optional). DFB can be configured to
withdraw output based on this condition.
Interlocking The DFB gives a command to the device to move to the defined position in case of an
active interlock. An interlock bypass function is available.
Detection of not If position is not confirmed within a configured time after the output command is
confirmed operation activated, DFB detects not confirmed operation.
Manual resetting Allows you to reset manually after the detection of an inoperable device condition or
a not confirmed operation. After reset, device output will follow set point.
Simulation The DFB can be switched to simulation mode. Thus, the actual position of the
controlled device is considered to be the same as its desired position regardless of
the signals received from the position detectors.

336 EIO0000002093 04/2020

 DVALVE - Dual Output Valve

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 337

DVALVE - Dual Output Valve

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL If a rising edge is detected on this input, the internal timers of
the block are reset and detected alarms are set to 0.
ZSH BOOL 1 = Indicates to the DFB that high limit position is reached.
Usually, it is used to connect the digital input of a positioner
high limit switch. The input pin is considered, if an input
parameter is connected or linked.
ZSL BOOL 1 = Indicates to the DFB that low limit position is reached.
Usually, it is used to connect the digital input of a positioner
low limit switch. The input pin is considered, if an input
parameter is connected or linked.
FAIL BOOL 1 = Indicates to the DFB a detected error in the device.
Refer to the FAILEN input.
FAILEN BOOL 1 = Enables the FAIL parameter.
RSPSEL BOOL Remote set point selection
1 = Low position set point
0 = High position set point
RSP BOOL Remote set-point by the continuous control.
1 = The set point selected in RSPSEL is considered.
0 = Stop command
ILCKSEL BOOL Interlock set point selection
1 = Low position set point
0 = High position set point
ILCKSP BOOL 1 = Run
Set-point needs to be used when the block is interlocked.
ILCK BOOL 1 = Interlocks the device at the defined position.
NOTE: If the device requires resetting (STW.REAMR = 1), the
OP takes the value = 0 regardless of the ILCKSP value waiting
for the operator to carry out the reset.
EXTCTLD BOOL 1 = Indicates to the DFB whether the device is being
controlled from outside of the system.
Monitoring of confirmation alarms is stopped during external
control. The FAIL input and detected position fail (ZSH and
ZSL = 1) continues to be evaluated.
ENGPARAM DVALVE_ENGPAR_DDT Engineering parameters

338 EIO0000002093 04/2020

 DVALVE - Dual Output Valve

DVALVE_ENGPAR_DDT Type

Name Type Description

TIMEOUT TIME Enables to configure the maximum time that the valve takes to
complete its stroke for closing and opening. When the output is
triggered, if the limit switch is not detected even after the
TIMEOUT time is elapsed. The device is switched to detected
alarm state if the limit switch is not detected. When it has a
value of 0, monitoring is deactivated.
SCANTIME TIME The minimum time for which the detected alarm signals are
kept active. SCANTIME confirms that the supervision system
acquires the data for detected alarms that are automatically
reset.
REACTIONTIME TIME Enables to configure the time during which monitoring for the
valve switching operations is enabled. During this time, a check
is run to verify that the valve leaves the limit switch opposite to
the operation that is carried out. When it has a value of 0,
monitoring is disabled. This time is useful for detecting
irregularity behavior in the valve and does not wait until the
maximum stroke time is elapsed to detect them.
CONFREARMEN BOOL  1 = Withdraws the output when a non-confirmed operation
is detected (ALARM = 1) and requires a mandatory manual
resetting once the ALARM condition disappears.
 0 = The output remains in its previous state when a non-
confirmed operation is detected (ALARM = 1) and does not
need manual resetting, once the ALARM condition
disappears.
FAILREARMEN BOOL  1 = Withdraws the output upon a detected failure condition
(FAILD = 1) and requires a mandatory manual resetting
once the FAIL condition disappears.
 0 = The output remains in its previous state upon a detected
failure condition (FAILD = 1) and does not need manual
resetting, once the FAIL condition disappears.

EIO0000002093 04/2020 339

DVALVE - Dual Output Valve

Outputs

Output Parameter Description

Parameter Type Description

OPH BOOL 1 = High position command active. Allows the control signal of the device to be
connected.
Refer to the OPH and OPL Calculation (see page 341).
OPL BOOL 1 = Low position command active. Allows the control signal of the device to be
connected.
Refer to the OPH and OPL Calculation (see page 341).
SPH BOOL 1 = High position set-point active
Refer to the SPH and SPL Calculation (see page 342).
SPL BOOL 1 = Low position set-point active.
Refer to the SPH and SPL Calculation (see page 342).
ZSHPOS BOOL High position status
1 = High position confirmed
It is independent from the other detector if the ZSH detector is available.
Refer to the ZSHPOS and ZSLPOS Calculation (see page 342).
ZSLPOS BOOL Low position status
1 = Low position confirmed
It is independent of the other detector if the ZSL detector is available.
Refer to the ZSHPOS and ZSLPOS Calculation (see page 342).
ALARMH BOOL 1 = Indicates a limit switch is not responded during valve opening. Monitoring
begins when valve is actuated and continues until the open-valve limit switch is
detected. If the time defined in TIMEOUT is exceeded, the alarm function of the
device is activated.
Refer to the ALARMH Output (see page 343).
ALARML BOOL 1 = Indicates a limit switch is not responded during valve opening. Monitoring
begins when valve is actuated and continues until the close-valve limit switch is
detected. If the time defined in TIMEOUT is exceeded, the alarm function of the
device is activated.
Refer to the ALARML Output (see page 344).
FAILD BOOL 1 = Indicates an inoperable valve condition. It is evaluated according to the value
of the FAIL and FAILEN inputs and detected position fail (ZSH and ZSL both are
activated at same time). When it is activated, it is timed so that the signal is
maintained for a minimum of SCANTIME.
0 = After the minimum activation time has passed, it is only deactivated if the FAIL
input signal is deactivated or any one of the input limit switch is deactivated.
Refer to the FAILD Calculation (see page 342).
OOS BOOL 1 = Indicates the device is out of service.

340 EIO0000002093 04/2020

 DVALVE - Dual Output Valve

OPH and OPL Calculation

The evaluation of the device control depending on the interlock status, the current set-point, and if
the DFB requires resetting is shown in the following table:

STW.REARMR SC.ILCKD ILCKSPSEL ILCKSP OPH is calculated as: OPL is calculated as:
ON - - - OFF OFF
OFF ON OFF ON ON OFF
OFF ON OFF OFF OFF OFF
OFF ON ON ON OFF ON
OFF ON ON OFF OFF OFF
OFF OFF - - DVALVE_ST.SPH DVALVE_ST.SPL

WARNING
UNINTENDED EQUIPMENT OPERATION
 The ENGPARAM.CONFREARMEN parameter has to be set to 1 for the OPH and OPL pin to
become 0, under non-confirmed operations.
 The ENGPARAM.FAILREARMEN parameter has to be set to 1 for the OPH and OPL pin to
become 0, under detected fail conditions.
 Changes to the configuration of these parameters have to be performed by competent
personnel only.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

FAILEN input FAILREARMEN input Output when FAIL = 1 (assume OPH and OPL = 1
before the detected failure)
- - OPH OPL
0 0 1 1
0 1 1 1
1 0 1 1
1 1 0 0

EIO0000002093 04/2020 341

DVALVE - Dual Output Valve

SPH and SPL Calculation

The signal evaluation depending on the SC.REM and RSP inputs and the DVALVE_ST.OWNER
input/output is shown in the following table:

OWNER REM SPH is calculated as SPL is calculated as

OFF OFF SC.LSP = 1 SC.LSP = 1 = 1
SC.LSPSEL = 0 SC.LSPSEL = 1
OFF ON RSP = 1 RSP =1
RSPSEL =0 RSPSEL = 1
ON - DVALVE_ST.LSP =1 DVALVE_ST.LSP = 1
DVALVE_ST.LSPSEL =0 DVALVE_ST.LSPSEL =1

ZSHPOS and ZSLPOS Calculation

The signal evaluation depending on the ZSH and ZSL inputs pin is connected or linked to a variable
and the DVALVE_ST.SIMMD input/output is shown in the following table:

ZSH pin ZSL pin SIMMD ZSHPOS is calculated as: ZSLPOS is calculated as:
connected connected
- - YES OPH OPL
NO NO NO OPH OPL
NO YES NO not ZSL ZSL

YES NO NO ZSH not ZSH

YES YES NO ZSH ZSL

FAILD Calculation
The signal evaluation depending on the FAILEN, FAIL, ZSH, and ZSL inputs is shown in the
following table:

FAILEN FAIL ZSH ZSL FAILD is calculated as:

OFF - OFF OFF OFF
OFF OFF ON ON ON (minimum SCANTIME)
OFF ON OFF OFF OFF
ON ON OFF OFF ON (minimum SCANTIME)

342 EIO0000002093 04/2020

 DVALVE - Dual Output Valve

ALARMH Output
ALARMH output activates based on the detection of a limit position switch confirmation.
The detected alarm activates in the following scenario:
 When the DFB output (OPH) is switches from 0 to 1 as long as TIMEOUT timer is running, the
operation confirmations are not monitored, when the time is elapsed and position limit (ZSHPOS)
is not confirmed.
 When the DFB output (OPH) is switches from 0 to 1 and receives high position limit (ZSHPOS)
confirmation, if DFB output (OPH) still at high position and device looses high limit position
(ZSHPOS) confirmation.
 When the DFB output OPH is switches from 0 to 1 and valve does not leaves low position limit
(ZSLPOS) confirmation, REACTIONTIME timer will start monitoring irregularity behavior, once
the REACTIONTIME time elapsed and valve does not leaves low position limit within
REACTIONTIME time.
NOTE: In the above scenarios, The alarm is not evaluated if device is controlled externally
(EXTCTLD = 1).
 If both the limit switch positions (ZSHPOS and ZSHLPOS) detect at same time. This alarm is
continued to evaluated even (EXTCTLD = 1).
The detected error signal is maintained for a minimum of SCANTIME.
After the SCANTIME is elapsed, the alarm is deactivated based on the following conditions:
 If the operation confirmation signal becomes the desired signal (according to the OPH value).
 If the valve is reset (through the DVALVE_ST.REARM input/output, and as long as the
ENGPARAM.CONFREARMEN parameter is 1).

EIO0000002093 04/2020 343

DVALVE - Dual Output Valve

ALARML Output
ALARML output activates based on the detection of a limit position switch confirmation.
The detected alarm activates in the following scenario:
 When the DFB output (OPL) is switches from 0 to 1 as long as TIMEOUT timer is running, the
operation confirmations are not monitored, when the time is elapsed and position limit (ZSLPOS)
is not confirmed.
 When the DFB output (OPL) is switches from 0 to 1 and receives low position limit (ZSLPOS)
confirmation, if DFB output (OPL) still at low position and device looses low limit position
(ZSLPOS) confirmation.
 When the DFB output (OPL) is switches from 0 to 1 and valve does not leaves high position limit
(ZSHPOS) confirmation, REACTIONTIME timer will start monitoring irregularity behavior, once
the REACTIONTIME time elapsed and valve does not leaves high position limit within
REACTIONTIME time.
NOTE: In the above scenarios, The alarm is not evaluated if device is controlled externally
(EXTCTLD = 1).
 If both the limit switch positions (ZSHPOS and ZSLPOS) detect at same time. This alarm is
continued to evaluated even (EXTCTLD = 1).
The detected error signal is maintained for a minimum of SCANTIME.
After the SCANTIME is elapsed, the alarm is deactivated based on the following conditions:
 If the operation confirmation signal becomes the desired signal (according to the OPH value).
 If the valve is reset (through the DVALVE_ST.REARM input/output, and as long as the
ENGPARAM.CONFREARMEN parameter is 1).

344 EIO0000002093 04/2020

 DVALVE - Dual Output Valve

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

DVALVE_ST DVALVE_ST_DDT Data structure of the DFB status.

DVALVE_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and allows data
to be kept in the memory. Read-only access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem. Read/write
access to the data contained in this word.

This table describes the DVALVE_ST.STW word:

Bit Name Description

0 ZSHPOS Refer to the ZSHPOS output pin (see page 340).
1 ZSLPOS Refer to the ZSLPOS output pin (see page 340).
2 SPH Refer to the SPH output pin (see page 340).
3 SPL Refer to the SPL output pin (see page 340).
4 OPH Refer to the OPH output pin (see page 340).
5 OPL Refer to the OPL output pin (see page 340).
6 REM Refer to the REM DVALVE_SC_DDT Type (see page 347).
7 ILCK Refer to ILCK input pin (see page 338).
8 REARMR Indicates if the device requires resetting (1) after the detection of an inoperable
device condition, if it has been configured through the ENGPARAM.CONFREARMEN
and/or ENGPARAM.FAILREARMEN parameter.
9 EXTCTLD Refer to EXTCTLD input pin (see page 338).
10 ALARMH Refer to the ALARMH output pin (see page 340).
11 ALARML Refer to the ALARML output pin (see page 340).
12 FAILD Refer to the FAILD output pin (see page 340).

EIO0000002093 04/2020 345

DVALVE - Dual Output Valve

DVALVE_ST.CFGW Word Structure

Bit Name Description

0 OWNER Read/write access
Allows you to configure whether the setpoint is set by the program (0) or by the
operator (1).
1 ILCKBP Read/write access
Enables the interlock to be bypassed (1).
2 SIMMD Read/write access
Enables the device to switch to Simulation mode to stop it from reading the actual
position signals (ZSL and ZSH inputs). Also SIMMD simulates that the device is in the
desired position (according to the OPH and OPL output) and that it is functional (as if
the FAIL input was reset (0)).
3 REARM Write access
Enables the device to reset (1). The DFB sets the signal to 0 after each run and sets
the signal, which indicates that the resetting is required (REARM) to 0.
4 LSPSEL Read/write access
Enables to select the action that has to carried out by the operator local set-point
(OWNER = 1) from the Supervision system (0 = high position and 1 = low position). If
the selection is set by the program (OWNER = 0), the block continuously assigns it the
value of the current selection.
5 LSP Read/write access
Allows the operator local set-point (OWNER is 1) to be set from the Supervision system.
If the set-point is set by the program (OWNER = 0), the block continuously assigns it
the value of the current set-point.
15 OOS Out of Service
Read/write access
Enables to determine whether the device is out of service (1) or in use (0).

346 EIO0000002093 04/2020

 DVALVE - Dual Output Valve

Public Variables

Public Variable Description

Variable Type Description

SC DVALVE_SC_DDT Provides the frequently needed data to monitor the device status and to
control it from the sequential control.

DVALVE_SC_DDT Type

Name Type Description

EXTCTLD BOOL Read-only access
Refer to the EXTCTLD input pin (see page 338).
REM BOOL Read/write access
1 = Enables the DFB to be configured to remote set-point RSP.
0 = Enables the DFB to be configured to local set-point LSP.
LSPSEL BOOL Read/write access
Enables the sequential control to select the DFB to be affected by the local set-point.
1 = Corresponds to the low position direction. When the owner is the Program
(OWNER = 0) and the selected set-point is local (REM = 0).
0 = Corresponds to the high position direction. When the owner is the Program
(OWNER = 0) and the selected set-point is local (REM = 0).
Calculation for LSPSEL:
OWNER REM SC.LSPSEL
OFF (Program) OFF Last value or new value assigned from the
sequential control.
OFF ON Calculated from the RSPSEL
ON (Operator) ON Last value or new value assigned by the Operator.
LSP BOOL Read/write access
1 = Enables the sequential control to assign the local set-point if the owner is the
Program (OWNER = 0) and the selected set-point is local (REM public variable = 0).
0 = The block automatically assigns the current value of the resulting set-point as
described below:
OWNER REM SC.LSP is calculated as:
OFF (Program) OFF Last value or new value assigned from the
sequential control.
OFF ON Calculated from the RSP
ON (Operator) ON Last value or new value assigned by the Operator.
OPH BOOL Read-only access
Refer to the OPH output pin (see page 340).

EIO0000002093 04/2020 347

DVALVE - Dual Output Valve

Name Type Description

OPL BOOL Read-only access
Refer to the OPL output pin (see page 340).
SPH BOOL Read-only access
Refer to the SPH output pin (see page 340).
SPL BOOL Read-only access
Refer to the SPL output pin (see page 340).
ZSHPOS BOOL Read-only access
Refer to the ZSHPOS output pin (see page 340).
ZSLPOS BOOL Read-only access
Refer to the ZSLPOS output pin (see page 340).
ALARMH BOOL Read-only access
Refer to the ALARMH output pin (see page 340).
ALARML BOOL Read-only access
Refer to the ALARML output pin (see page 340).
FAILD BOOL Read-only access
Refer to the FAILD output pin (see page 340).
REARMR BOOL Read-only access
Refer to the DVALVE_ST.STW.REARMR Input/output pin (see page 345).
ILCKD BOOL Read-only access
The way in which the signal is evaluated based on the ILCK input and the
DVALVE_ST.ILCKBP input/output is shown below:
ILCKD ILCKBP SC.ILCKD calculated as:
OFF OFF OFF
OFF ON OFF
ON OFF ON
ON ON OFF
OWNER REAL Read-only access
Refer to the DVALVE_ST.OWNER Input/output pin (see page 346).
OOS BOOL Read/write access
Indicates whether the equipment is out of service (1) or in use (0). Refer to the OOS
output pin (see page 340).

348 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Analog Device Control
EIO0000002093 04/2020

Part IV
Analog Device Control

Analog Device Control

Overview
This part provides a detailed description of the functions, pins, pin layout, and variables of the
function blocks of the analog device control family.
These function blocks do not reflect any specific installation.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000002093 04/2020 349

Analog Device Control

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
34 CVALVE - Control Valve with Position Feedback 351
35 CVALVELP - Local Panel for Controlling Control Valves 363
36 MVALVE - Motorized Valve with Positioner 375
37 MVALVELP - Local Panel for Controlling Motorized Valves 389
38 SDDEVCTL - Device with Variable Speed Drive 401
39 SDDEVLP - Local Panel for Controlling Devices with a Variable Speed Drive 417

350 EIO0000002093 04/2020

 Modicon Libraries General Purpose
CVALVE
EIO0000002093 04/2020

Chapter 34
CVALVE - Control Valve with Position Feedback

CVALVE - Control Valve with Position Feedback

Overview
This chapter describes the CVALVE DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 352
DFB Representation 353
Inputs 354
Outputs 356
Inputs/Outputs 358
Public Variables 360

EIO0000002093 04/2020 351

CVALVE

Description

General
The main objective of the CVALVE DFB is to manage control valves with optional position feedback
(position and/or limit switches).
User can supplement this DFB with DINPUT DFBs from the General Purpose Library. This DFB
enables to incorporate conditioning functions for the digital signals of the limit switches.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Owner The DFB manages the control system level which is the owner (Operator or Program).
As a result, it is responsible for setting the set-point and activation for the control.
Interlocking The DFB gives a command to the device to move to the defined position in case of an
active interlock. An interlock bypass function is available.
Set-point The DFB enables to work under a remote (normally set from the continuous control) or
local (set from the program or by the operator depending on the active owner) set-
point.
Simulation The target position of the valve is used as the current position in simulation mode. The
position limits that are normally determined based on the limit switches are simulated
based on the analog position.
Tracking The DFB activates monitoring for tracking the actual position in relation to the target
position.

352 EIO0000002093 04/2020

 CVALVE

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 353

CVALVE

Inputs

Input Description Table

Parameter Type Description

CHOUTFAILURE BOOL 1 = Indicates to the DFB the output channel associated with the CHOUT
output is operational.
HIRAWCHOUT INT High range for the CHOUT output signal in raw data.
LORAWCHOUT INT Low range for the CHOUT output signal in raw data.
CHIN INT Input signal that indicates the position of the valve.
Normally corresponds to a value in raw data coming from the input/output
peripherals. Connecting a variable or value to this DFB pin enables analog
position feedback.
CHINFAILURE BOOL 1 = Indicates to the DFB the input channel associated with the CHIN input is
operational as long as position feedback is enabled (refer to the CHIN input).
HIRAWCHIN INT High range for the CHIN input signal.
LORAWCHIN INT Low range for the CHIN input signal.
BADPV REAL Value in engineering units (PV output signal) needs to be used when the
channel is non-operational.
HISP REAL High range for the set-point (SP) corresponding to the maximum value
(configured in the HIRAWCHOUT input) of the CHOUT output in engineering
units.
LOSP REAL Low range for the set-point (SP) in engineering units corresponding to the
minimum value (configured in the LORAWCHOUT input) of the CHOUT output
in engineering units.
ZSH BOOL 1 = Indicates that the open valve position is reached.
Used to connect to the digital input of the open-valve limit switch. Disabled
internally by the DFB if no variable or value is connected.
ZSL BOOL 1 = indicates that the closed valve position is reached.
Used to connect to the digital input of the closed-valve limit switch. Disabled
internally by the DFB if no variable or value is connected.
RSP REAL Remote set-point by the continuous control for control PID controller output.
ILCKSP REAL 1 = Run
Set-point needs to be used when the block is interlocked.
ILCK BOOL 1 = Interlocks the device at the defined position.
MAXDEV REAL Enables to set the maximum permissible deviation between the current set-
point and the actual position. If the difference is greater than the value of this
parameter for a certain period (refer to the TMAXDEV input), the follow-up
detected fault alarm is activated.

354 EIO0000002093 04/2020

 CVALVE

Parameter Type Description

TMAXDEV TIME Maximum permissible time during which there can be a follow-up detected
fault. The follow-up detected fault is generated if the difference between the
set-point and the actual position is greater than the value entered in the
MAXDEV input. You can deactivate follow-up alarm monitoring by setting this
parameter to 0 (T#0s).
SCANTIME TIME Enables to configure the time during which the follow-up alarm signal is kept
active. This helps the monitoring subsystem to acquire the data in case of
brief alarms detected.
HITHRESHOLD REAL Enables to configure the open-valve threshold for the analog position
measurement as a percentage, that is, the threshold after which it is
considered that the valve is completely opened.
LOTHRESHOLD REAL Enables to configure the closed-valve threshold for the analog position
measurement as a percentage, that is, the threshold after which it is
considered that the valve is completely closed.

EIO0000002093 04/2020 355

CVALVE

Outputs

Output Parameter Description

Parameter Type Description

CHOUT INT Calculated value of the output in raw data is used to position the valve.
The CHOUT calculation is shown in the following table.
OP CHOUT is calculated as:
<= LOSP LORAW

> LOSP and < HISP Refer to the following linear scaling formula.
>= HISP HIRAW
SP REAL Current valve set-point.
The SP calculation is shown in the following table:
OWNER (OFF: Program, REM SP is calculated as:
ON: Operator)
OFF OFF SC.LSP
OFF ON RSP
ON - CVALVE_CFG.LSP
OP REAL Valve positioning output in engineering units.
The OP calculation is shown in the following table:
SC.ILCKD OP is calculated as:
ON ILCKSP
OFF SP
PV REAL Current valve position in engineering units.
PVOPEN BOOL 1 = Indicates the open-valve position has been reached. This is verified by
checking whether or not the analog input falls within the threshold specified by
means of the HITHRESHOLD input.
PVCLOSED BOOL 1 = Indicates the closed-valve position has been reached. This is verified by
checking whether or not the analog input falls within the threshold specified by
means of the LOTHRESHOLD input.
ZSHPOS BOOL 1 = Indicates the open-valve position has been reached. If ZSHPOS is not
operational, PVOPEN is used as a basis for the indication instead.
ZSLPOS BOOL 1 = Indicates the closed-valve position has been reached. If ZSLPOS is not
operational, PVCLOSED is used as a basis for the indication instead.
ALARM BOOL 1 = Indicates a follow-up detected fault (1) has occurred. The analog position
signal is monitored. Refer to the MAXDEV and MAXDEV and TMAXDEV inputs
(see page 354).

356 EIO0000002093 04/2020

 CVALVE

Parameter Type Description

FAILD BOOL 1 = Indicates an inoperable device (1) in the either of the following cases:
 when the ZSH and ZSL inputs are active simultaneously
 when the limit switches do not correspond to the maximum and minimum
values that are determined based on the measurement of current position.
TRACK BOOL 1 = Indicates that the tracking current output is not effective.

Linear Scaling Formula:

EIO0000002093 04/2020 357

CVALVE

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

CVALVE_CFG CVALVE_CFG_DDT Provides the data necessary to configure the DFB (normally from
the monitoring subsystem).
CVALVE_ST CVALVE_ST_DDT Provides the data necessary to monitor the DFB status.

CVALVE_CFG_DDT Type

Name Type Description

LSP REAL Read/write access
This variable indicates the current set-point. It is calculated internally in the DFB if
the Program is the owner. It is set to match the SP output. If the Operator is the
owner, you can modify it from the monitoring subsystem.

CVALVE_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and
allows data to be kept in the memory. Read-only access to the data contained in
this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem.
Read/write access to the data contained in this word.
PV REAL Read-only access
Refer to the PV output pin (see page 356).
OP REAL Read-only access
Refer to the OP output pin (see page 356).

CVALVE_ST.STW Word Structure

DFB status word. Read-only access. The following table describes CVALVE_ST.STW word:

Bit Name Description

0 CHINFAILURE Refer to the CHINFAILURE input pin (see page 354).
1 ILCK Refer to the ILCK input pin (see page 354).
2 REM Refer to the SC.REM public variable (see page 360).
4 CHOUTFAILURE Refer to the CHOUTFAILURE input pin (see page 354).
6 PVOPEN Refer to the PVOPEN output pin (see page 356).

358 EIO0000002093 04/2020

 CVALVE

Bit Name Description

7 PVCLOSED Refer to the PVCLOSED output pin (see page 356).
9 FAIL Refer to the FAIL output pin (see page 356).
10 ALARM Refer to the ALARM output pin (see page 356).
11 ZSLPOS Refer to the ZSLPOS output pin (see page 356).
12 ZSHPOS Refer to the ZSHPOS output pin (see page 356).
13 ZSLEN ZSL is connected.
14 ZSHEN ZSH is connected.

CVALVE_ST.CFGW Word Structure

Provides the data needed to configure the DFB normally from the monitoring subsystem. The
following table describes CVALVE_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program
(0) or by the Operator (1).
1 ILCKBP Read/write access
Allows the interlock to be bypassed (1).
2 SIMMD Read/write access
Enables you to place the device in Simulation mode so that the
actual position signals (CHIN, ZSL, and ZSH inputs) are ignored,
and the current position is considered to be the target position.

EIO0000002093 04/2020 359

CVALVE

Public Variables

Public Variable Description

Variable Type Description

SC CVALVE_SC_DDT Provides the frequently needed data to monitor the DFB status.

CVALVE_SC_DDT Type

Name Type Description

LSP REAL Read/write access
Enables the sequential control to assign the local set-point if the owner
is the Program (OWNER input/output is set to 0), and the selected set-
point is the local one (SC.REM public variable is set to 0). Otherwise,
the current set-point (SP output) is copied continuously to this variable.
OP REAL Read-only access
Refer to the OP output pin (see page 356).
PV BOOL Read-only access
Refer to the PV output pin (see page 356).
OWNER BOOL Read-only access
Refer to the CVALVE_ST.CFGW.OWNER input/output pin
(see page 358).
REM BOOL Read/write access
Allows the DFB to be configured for a remote set-point - RSP-(1) or local
set-point - LSP - (0).
ILCKD BOOL Read-only access
Indicates whether the motor is interlocked.
The signal evaluation depending on the ILCK input and the
CVALVE_ST.CFGW.ILCKBP input/output is shown in the following
table:
ILCK ILCKBP SC.ILCKD.LSP
OFF - OFF
ON OFF ON
ON ON OFF
PVOPEN BOOL Read-only access
Refer to the PVOPEN output pin (see page 356).
PVCLOSED BOOL Read-only access
Refer to the PVCLOSED output pin (see page 356).
FAILD BOOL Read-only access
Refer to the FAILD output pin (see page 356).

360 EIO0000002093 04/2020

 CVALVE

Name Type Description

ALARM BOOL Read-only access
Refer to the ALARM output pin (see page 356).
BADSTIN BOOL Read-only access
Refer to the CHINFAILURE input pin (see page 354).
BADSTOUT BOOL Read-only access
Refer to the CHOUTFAILURE input pin (see page 354).
ZSLPOS BOOL Read-only access
Refer to the ZSLPOS output pin (see page 356).
ZSHPOS BOOL Read-only access
Refer to the ZSHPOS output pin (see page 356).

EIO0000002093 04/2020 361

CVALVE

362 EIO0000002093 04/2020

 Modicon Libraries General Purpose
CVALVELP
EIO0000002093 04/2020

Chapter 35
CVALVELP - Local Panel for Controlling Control Valves

CVALVELP - Local Panel for Controlling Control Valves

Overview
This chapter describes CVALVELP DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 364
DFB Representation 365
Inputs 366
Outputs 369
Inputs/Outputs 370
Public Variables 373

EIO0000002093 04/2020 363

CVALVELP

Description

General
The main objective of the CVALVELP DFB is to manage a local panel that controls a control valve
with position feedback. This valve is implemented with a CVALVE function block and with signals
that are wired to the controller so that the latter defines the target position for the device.

Function Description
The main functions of the module are described in the following table:

Function Description
Mode Switch Optionally manages the signals coming from an operating mode switch in a local
panel with the following configuration: Local - Zero - Control System. The Zero
mode signal is optional. However the user can enable Local/Control System mode
from the faceplate also, when VirtualLPEN input pin signal is high and
MODESignalsEN signal is low.
Push buttons The DFB manages up to two signals coming from OPEN and CLOSE push buttons,
giving the CLOSE push button higher priority.
Owner Management The DFB enables to configure whether the Program needs to be the valve owner
or not, after switching to the Control System mode again.
Owner Locking The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not, it disables the access to change the owner
(Operator/Program) while the valve is controlled from the Local Panel.
Set-point Lock The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not. It disables to change the set-point while the
valve is controlled from the Local Panel.
Push button The push button signals from the Local Panel can be enabled/disabled through the
Enabling/Disabling DFB configuration (input pin) and/or from control sequences.
Enabled Panel The DFB provides a signal that can be used to illuminate a light source on the Local
Signaling Panel to indicate when the push buttons are enabled for operation.
Virtual Panel This signal enables the operator to select the Local / Control System mode of
Enabling/Disabling operation from the HMI so that the push button signals are enabled for operation.
NOTE: VirtualLPEN input pin signal is applicable when Modicon Libraries -
General Purpose is used along with Modicon Libraries - General Purpose for
Wonderware System Platform.

364 EIO0000002093 04/2020

 CVALVELP

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 365

CVALVELP

Inputs

Input Parameter Description

Parameter Type Description

LPSignal BOOL 1 = The local panel mode switch is in the Local Panel position. Refer to the
table included with the description of the LPMode output pin (see page 369).
ZEROSignal BOOL 1 = The local panel mode switch is in the zero position.This signal is optional
even if a mode switch is available on the local panel. When this signal is a
logical high, user is not allowed to operate the device from the faceplate and
also from the DFB. Hence, all the functions in the faceplate will be disabled.
Refer to the table included with the description of the LPMode output pin
(see page 369).
CSSignal BOOL 1 = The local panel mode switch is in the Control System position. Refer to the
table included with the description of the LPMode output pin (see page 369).
OpenSignal BOOL 1 = Indicates to the DFB the OPEN push button on the local panel is pressed.
CloseSignal BOOL 1 = Indicates to the DFB the CLOSE push button on the local panel is pressed.
DeltaSP REAL Absolute set-point increase or decrease value when the OPEN or CLOSE
push buttons are pressed.
DeltaFastSP REAL Absolute set-point increase or decrease value when the OPEN and CLOSE
push buttons are being pressed.
TREPEAT TIME Indicates the maximum time that needs to elapse before the system interprets
that a command has been repeated when the push button is pressed. This
time also determines when a DeltaFastSP increase or decrease has to be
applied when the OPEN or CLOSE push button is pressed.
MODESignalsEN BOOL 1 = Enables the use of the Local Panel/Zero/ Control System (or Local Panel
- Control System) mode switch on the local panel. Normally configured in
development phase based on the characteristics of the local panel being
used. If the mode switch is enabled, the LPSignal, ZEROSignal, and
CSSignal inputs are considered to determine the operating modes of the
local panel. Refer to the table included with the description of the LPMode
output pin (see page 369).
NOTE: MODESignalsEN input pin has higher priority than the
VirtualLPEN input pin signal.

366 EIO0000002093 04/2020

 CVALVELP

Parameter Type Description

VirtualLPEN BOOL 1 = This signal enables the operator to select the Local/Control System mode
of operation from the HMI, so that the push button signals are enabled for
operation.
NOTE:
 When the owner is program, the Local/Control System mode selection
drop-down list will be visible but disabled for operation however, when the
owner is operator the Local Panel drop-down list will be accessible for
operation.
 VirtualLPEN input pin signal is applicable only for Modicon Libraries -
General Purpose for Wonderware System Platform offer only, however
there is no impact of this input signal in Modicon Libraries - General
Purpose for Citect SCADA offer.
Refer to the table included with the description of the LPMode output pin
(see page 369).
PBSignalsEN BOOL 1 = Enables to accept the OPEN and CLOSE push buttons from the local
panel. This signal is not applicable if the mode switch is enabled (refer to the
MODESignalsEN input). This means that the push button signals are
considered in the Local Panel mode.
When the mode switch is disabled (MODESignalsEN = 0), PBSignalsEN
signal enables/disables the push button signals from control system itself
based on relevant process conditions. SC.DISABLELP public variable is also
considered for determining whether the push buttons are enabled or not when
LPMode pin signal is high as shown in the following table.
MODESIGNALSEN PBSIGNALSEN SC.DISABLELP Push buttons
enabled?
OFF OFF - NO
OFF - ON NO
OFF ON OFF YES
ON - - YES
Therefore, user can use this signal to enable/disable the push buttons on a
simple local panel that does not feature a mode switch (Local
Panel/Zero/Control System) based on the relevant process conditions.
ToProgramEN BOOL 1 = Enables the functionality that enables to change the owner of the valve to
Program when mode switch on the local panel returns to control system
position (only when the mode is switched). If this functionality is disabled, the
operator of the monitoring (HMI) system switches to Program owner when the
operator deems it appropriate. Refer to the table included with the description
of the LockOwnerEN input.

EIO0000002093 04/2020 367

CVALVELP

Parameter Type Description

LockOwnerEN BOOL 1 = Disables the access of owner of the valve remaining as Operator while the
local panel mode is Local Panel.
The following table shows how the valve owner is evaluated based on the
ToProgramEN and LockOwnerEN inputs and operating mode of the local
panel:
Local Panel Mode ToProgramEN LockOwnerEN Owner
Zero – – Operator
Switch to Local Panel – – Operator
Local Panel – ON Operator
Switch to Control ON – Program
System
In remaining cases, owner of the valve ceases to be defined from the
CVALVELP DFB, and it enables to change it from the monitoring (HMI) system
with the command word in the CVALVE_ST.CFGW input/output of the
corresponding CVALVE DFB.
In any case, consider that the owner of valve that had been set before
switching to Local Panel mode is not memorized.
LockSetpointEN BOOL 1 = Disables the setpoint of the valve device and lock it into the one defined
on the local panel while the local panel mode is Local Panel and the device
owner is the Operator. You can switch to the Program mode based on the
signals that have been previously described even if the local panel mode is
set to Local Panel.
Therefore, user can activate (1) this signal to lock setpoint operation from the
monitoring (HMI) system while the valve is controlled from the local panel.

368 EIO0000002093 04/2020

 CVALVELP

Outputs

Output Parameter Description

Parameter Type Description

PBLIGHTSignal BOOL 1 = The push buttons on the local panel are fully operational, that is, the local panel is
in Local Panel mode (either because the mode is selected with the corresponding
switch or because the push buttons are enabled in the event that there is no selector
switch available or the VirtualLPEN is high with the local panel mode enabled).
LPMode BOOL 1 = The local panel mode is in Local Panel.
The following table shows how the local panel operating mode is determined based
on the MODESignalsEN, VirtualLPEN, PBSignalsEN, LPSignal, CSSignal
and ZEROSignal, input signals:
MODESig- Virtu- PBSig- LPSig- CSSig- ZEROSig- OUTPUT
nalsEN alLPEN nalsEN nal nal nal
0 0 0 0 0 0 CS mode
1 0 0 0 0 0 Zero mode
1 0 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 0 0 0 1 0 CS mode
0 1 1 NA NA NA CS mode
0 1 0 NA NA NA CS mode
0 0 1 0 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 0 0 0 Zero mode
1 1 0 0 0 1 Zero mode
1 1 0 0 1 0 CS mode
1 0 1 0 1 0 CS mode
1 1 1 0 1 0 CS mode
1 0 0 0 0 1 Zero mode
ZEROMode BOOL 1 = The local panel mode is in Zero. User is not allowed to operate the device from
the faceplate and also from DFB. Hence, all the functions in the faceplate will be
disabled. Refer to the table included with the description of the LPMode output.
CSMode BOOL 1 = The local panel mode is in Control System. Refer to the table included with the
description of the LPMode output.

EIO0000002093 04/2020 369

CVALVELP

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

CVALVE_CFG CVALVE_CFG_DDT Data structure belonging to the control valve is to be controlled
from the local panel (for detailed information regarding this
structure, refer to the CVALVE DFB (see page 351)).
The structure provides the information needed for the operation
of the CVALVELP DFB. It enables this DFB to control the
setpoint for the control valve.
CVALVE_ST CVALVE_ST_DDT Data structure belonging to the valve is to be controlled from the
local panel (for detailed information regarding this structure,
refer to the CVALVE DFB (see page 351).
The structure provides the information needed for the operation
of the CVALVELP DFB and enables this DFB to control the
owner of the valve.
CVALVELP_ST CVALVELP_ST_DDT Data structure that is used as an interface with the monitoring
(HMI) system.

CVALVE_CFG.DDT Type

Name Type Description

LSP REAL Read/write access
Allows local set-point of the operator (OWNER = 1) to be set from the monitoring (HMI)
system. If set-point is set by the Program (OWNER = 0), the DFB continuously assigns
it the value of the current set-point.

CVALVE_ST.DDT Type

Name Type Description

STW WORD Read-only access
Bits word with the status of the local panel.
CFGW WORD Provides means to control the device from the monitoring (HMI)
system. Read-only access to the data contained in this bits word.
PV REAL Read-only access
Refer to the PV output pin (see page 356).
OP REAL Read-only access
Refer to the OP output pin (see page 356).

370 EIO0000002093 04/2020

 CVALVELP

CVALVE_ST.CFGW Word
The following table describes the CVALVE_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or by
the Operator (1).
Refer to the table included with the description of the LPMode output pin,
which specifies the cases in which the CVALVELP DFB can interact with
this signal.

CVALVELP_ST.CFGW Word

Bit Name Description

0 LocalModeOn Read/write access only
 1 = Enables the Local Panel mode.
 0 = Enables the Control System mode.

CVALVELP_ST.DDT Type

Name Type Description

STW WORD Read-only access
Bits word with the status of the local panel.

EIO0000002093 04/2020 371

CVALVELP

CVALVELP_ST.STW Word
Read-only access. Status word. The following table describes the CVALVELP_ST.STW word:

Bit Name Description

0 LPMode Local panel in Local Panel mode. Refer to the LPMode output
pin.
1 ZEROMode Local panel in zero mode. Refer to the ZEROMode output pin.
2 CSMode Local panel in Control System mode. Refer to the CSMode
output pin.
3 LockedOwner Indicates whether the owner change buttons in the monitoring
(HMI) system needs to be locked (1) or not (0).
Is activated when:
 The local panel mode is set to Zero or
 It is set to Local Panel, and the LockOwnerEN input signal
has been configured as active (1).
4 SPLocked Indicates whether the set-point change and START buttons in
the monitoring (HMI) system needs to be locked (1) or not (0).
Is activated when:
 The local panel mode is set to Zero or
 It is set to Local Panel, and the LockSetpointEN input
signal has been configured as active (1).
5 MODESignalsEN Indicates the state of the MODESignalsEN input signal, that is,
whether there is a mode switch (1) or not (0).
6 PBEnabled Indicates whether the push buttons of the local panel are
enabled (1) or not (0). The signal is activated when at least one
of the MODESignalsEN and PBSignalsEN signal inputs is
active.
7 VirtualLPEN Enables the drop-down list for the Local Panel / Control System
mode selection.
8 LPSignal Indicates the state of the LPSignal input signal.
9 ZEROSignal Indicates the state of the ZEROSignal input signal.
10 CSSignal Indicates the state of the CSSignal input signal.
11 OpenSignal Indicates the state of the OpenSignal input signal.
12 CloseSignal Indicates the state of the CloseSignal input signal.

372 EIO0000002093 04/2020

 CVALVELP

Public Variables

Public Variable Description

Variable Type Description

SC CVALVELP_SC_DDT Provides the frequently needed data for monitoring
and controlling the DFB.

CVALVELP_SC_DDT Type

Name Type Description

LPMode BOOL Read-only access
Refer to the LPMode output pin (see page 369).
ZEROMode BOOL Read-only access
Refer to the ZEROMode output pin (see page 369).
CSMode BOOL Read-only access
Refer to the CSMode output pin (see page 369).
DisableLP BOOL Read/write access
1 = Disables the push buttons on the local panel. Only
applicable when a local panel without mode switch
configuration is used (MODESignalsEN = 0).

EIO0000002093 04/2020 373

CVALVELP

374 EIO0000002093 04/2020

 Modicon Libraries General Purpose
MVALVE
EIO0000002093 04/2020

Chapter 36
MVALVE - Motorized Valve with Positioner

MVALVE - Motorized Valve with Positioner

Overview
This chapter describes the MVALVE DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 376
DFB Representation 377
Inputs 378
Outputs 381
Inputs/Outputs 383
Public Variables 386

EIO0000002093 04/2020 375

MVALVE

Description

General
The MVALVE DFB is designed to control a motorized valve, or a gate with position feedback and 2-
rotational-direction-motor-based control.
User combine the MVALVE DFB with the following Control Expert components from the General
Purpose Library:
 AINPUT
 MOTOR2
 DINPUT

Function Description
The main functions of the DFB are described in the following table:

Function Description
STEP3 The DFB includes and incorporates the functions provided by the STEP3
controller from the standard CONT_CTL Control Expert library.
Owner The DFB manages the control system level which is the owner (Operator or
Program). As a result, it is responsible for setting the set-point and activation for
the control
Interlocking The DFB gives a command to the device to move to the defined position in case
of an active interlock. An interlock bypass function is available.
Set-point The DFB enables to work under a remote (normally set from the continuous
control) or local (set from the program or by the operator depending on the active
owner) set-point.
Mode You can enable (START = 1) the STEP3CTL module to operate as described in
the STEP3 module in Automatic mode or disable (START = 0), in which case the
module continues calculating but forces the outputs to 0.

376 EIO0000002093 04/2020

 MVALVE

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 377

MVALVE

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL When a rising edge occurs on this input, the internal timers of the DFB are
reset and alarms are set to 0.
RSP REAL 1 = Remote speed set-point is usually set by the continuous control. Refer to
the SC.REM public variable (see page 386).
HIPV REAL Higher value of measurement range. This input limits the maximum set-point
admitted by the controller. This input is internally connected to the
PARA.PV_SUP parameter of the STEP3 controller.
LOPV REAL Lower value of measurement range. This input limits the minimum set-point
admitted by the controller. This input is internally connected to the
PARA.PV_INF parameter of the STEP3 controller.

RSTART BOOL 1 = Enables the operation of the STEP3 block in automatic mode as described
in the Control Expert document.
0 = It forces the OPINC and OPDEC outputs to 0, but the STEP3 continues to
run internally and to calculate the outputs.
The valid Start command for the calculation is obtained from the following
truth table.
OWNER REM Start is calculated as
OFF OFF SC.LSTART
OFF ON RSTART
ON - MVALVE_ST.CFGW.START
You can modify the set-point directly
from the monitoring subsystem while
this mode is active.

378 EIO0000002093 04/2020

 MVALVE

Parameter Type Description

ILCKSP REAL Set-point needs to be used when the block is interlocked. Refer to the ILCK
input.
ILCK BOOL 1 = Forces the DFB to run with the set-point defined on the ILCKSP input. You
can use the ILCKSP and ILCK combination to force the set-point of a
motorized valve to a certain position, for example, the value corresponding to
a 0% aperture. In this case, the DFB controls the outputs until an aperture of
0% is reached.
If de-energizing the outputs is desired, it is recommended to act on the
RSTART input (set to 0). In any case, if deactivating the control signals is
desirable, interlock the corresponding operations (using DEVCTL, MOTOR2,
DOUTPUT, and so on.).
CONFREARMEN BOOL  1 = Withdraws the output SP_MOTOR2 when a non-confirmed operation is
detected (ALARM = 1) and requires a mandatory manual resetting once the
ALARM condition disappears.
 0 = The output SP_MOTOR2 remains in its previous state when a non-
confirmed operation is detected (ALARM = 1) and does not need manual
resetting, once the ALARM condition disappears.
Refer to the TMAX input, TWATCH input and the MVALVE_ST.STW.ALARM
input/output pin (see page 411).
FAILREARMEN BOOL  1 = Withdraws the output SP_MOTOR2 upon a detected failure condition
(FAILD = 1) and requires a mandatory manual resetting once the FAIL
condition disappears.
 0 = The output SP_MOTOR2 remains in its previous state upon a detected
failure condition (FAILD = 1) and does not need manual resetting, once the
FAIL condition disappears.
TMAX TIME Enables to configure the maximum time that the valve needs to take in
completing its stroke, both for opening and closing. This input is used to
evaluate the detected alarm situation in the device.
TWATCH TIME Enables to configure the time during which monitoring for the switching
operations of the valve is enabled (0s = Disabled).
After this time, a check is run to verify that the valve has moved the distance
that was expected according to the maximum opening time (TMAX) that was
configured.
SCANTIME TIME Enables the time that the detected alarm signals are kept active to be
configured. Enables the monitoring subsystem to acquire the data for
detected alarms that are automatically reset.
HITHRESHOLD REAL Enables to configure the open-valve threshold for the analog position
measurement as a percentage, that is, the threshold after which it is
considered that the valve is completely open.
LOTHRESHOLD REAL Enables to configure the closed-valve threshold for the analog position
measurement as a percentage, that is, the threshold after which it is
considered that the valve is completely closed.

EIO0000002093 04/2020 379

MVALVE

Parameter Type Description

MOTOR2_ST MOTOR2_ Enables to find out the device status. This input is used to know the current
ST_DDT status, detected errors, detected alarms, lack of set-point follow-up, owner,
and simulation of the motor that actuates the valve.
AINPUT_ST AINPUT_ Enables to find out the device status. This input is used to know the current
ST_DDT status, detected errors in channels, and simulation of the analog valve
position measurement.
ZSH_DINPUT_ST DINPUT_ Enables to find out the device status. This input is used to know the current
ST_DDT status, detected errors in channels, and simulation of the open-valve limit
switch.
ZSL_DINPUT_ST DINPUT_ Enables to find out the device status. This input is used to know the current
ST_DDT status, detected errors in channels, and simulation of the closed-valve limit
switch.

380 EIO0000002093 04/2020

 MVALVE

Outputs

Output Parameter Description

Parameter Type Description

SP_MOTOR2 BOOL 1 = Provides the remote set-point for motor control (RSP). Read-only access. Refer to
the RSPinput (see page 287) of the MOTOR2 block.
SPSEL_MOTOR2 BOOL 1 = Provides the set-point for selecting the actuator to be affected by the SP_MOTOR2
set-point. Read-only access. Refer to the RSPSEL input (see page 287) of the MOTOR2
block.
ILCK_MOTOR2 BOOL 1 = Interlocks the motor. The DFB calculates the interlocking conditions of the motor
internally. Read-only access.
OPEN BOOL 1 = Indicates the maximum opening position is reached. It is calculated based on the
states obtained from the analog input and/or the digital input belonging to the open-
valve limit switch.
CLOSED BOOL 1 = Indicates the closed-valve position is reached. It is calculated based on the states
obtained from the analog input and/or digital input belonging to the closed-valve limit
switch.
DEV REAL Deviation (PV-SP) extracted directly from the STEP3 controller.
RUNNING BOOL 1 = Extracted from the STEP3 controller.
STATUS WORD States output by the STEP3 controller on the STATUS output. For more details, see the
Control Expert documentation for the STEP3 controller.

SP REAL Current set-point is used by the STEP3 algorithm. The manner in which the block
calculates the set-point is based on the signal statuses, is given below:
OWNER REM SP is calculated as:
OFF OFF OFF
OFF ON RSP
ON – MVALVE_ST.SP.
You can modify the set-point directly
from the monitoring subsystem while
this mode is active.

EIO0000002093 04/2020 381

MVALVE

Parameter Type Description

ALARM BOOL 1 = Indicates a switching operation fault detected has occurred. The analog position
signal is monitored. When the valve is operating,a maximum time during which a
certain path needs to be completed is determined; if this minimum path is not
completed, the detected alarm of the device is activated. (Refer to the TMAX and
TWATCH inputs (see page 378)).
POSMISALARM BOOL 1 = Indicates a position mismatch between digital and analog feedbacks.
FAILD BOOL 1 = Irregularity or wrong operation detected in one of the auxiliary devices.

WARNING
UNINTENDED EQUIPMENT OPERATION
 The CONFREARMEN pin has to be set to 1 for the SP_MOTOR2 pin to become 0, under non-
confirmed operations.
 Changes to the configuration of these parameters have to be performed by competent
personnel only.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

382 EIO0000002093 04/2020

 MVALVE

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

MVALVE_CFG MVALVE_CFG_DDT Provides the data needed to configure the block from the
monitoring subsystem or the sequential control.
MVALVE_ST MVALVE_ST_DDT Provides the data needed to monitor and/or control the block status.

MVALVE_CFG_DDT Type

Name Type Description

DEVLL REAL Enables to define the lower deviation threshold for the error detected (PV-SP). This
value needs to be 0; otherwise, the DFB considers it 0. Refer to the operation graph
(see page 378) in LOPV and STEP3 function block.
DEVHL REAL Enables to define the upper deviation threshold for the error detected (PV-SP). This
value needs to be ≥ 0; otherwise, the DFB considers it 0. Refer to the operation graph
(see page 378) in LOPV and STEP3 function block.
HYS REAL Defines the hysteresis value, which is considered by the STEP3 algorithm when
calculating the OPINC and OPDEC outputs. This value falls between 0 and the
minimum value among DEVHL and DEVLL without considering the sign.
The DFB avoids wrong hysteresis inputs with the following rules:
 If CFG_HYS < 0 it is considered 0.
 If CFG_HYS > DEVHL it is considered to be DEVHL.
 If CFG_HYS >DEVLL (unsigned) it is considered to be DEVLL (unsigned).

TARGETS REAL Read access

P This variable indicates the current set-point status before interlocking.

EIO0000002093 04/2020 383

MVALVE

MVALVE_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and allows
data to be kept in the memory. Read-only access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem. Read/write
access to the data contained in this word.
PV REAL Read-only access
Refer to the PV input pin (see page 378). This variable indicates the current
measurement.
SP REAL Read/write access
Refer to the SP output pin (see page 381). This variable indicates the current set-point
and is calculated internally in the block until the owner is not changed to the operator.
You can modify it from the monitoring subsystem.

MVALVE_ST_STW Type

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 386).
2 ILCK Refer to the ILCK input pin (see page 378).
3 SP_MOTOR2 Refer to the SP_MOTOR2 output pin (see page 381).
4 SPSEL_MOTOR2 Refer to the SPSEL_MOTOR2 output pin (see page 381).
5 ILCK_MOTOR2 Refer to the ILCK_MOTOR2 output pin (see page 381).
6 OPEN Refer to the OPEN output pin (see page 381).
7 CLOSED Refer to the CLOSED output pin (see page 381).
8 REARMR Reset required (1).
9 FAILD Refer to the FAILD output pin (see page 381).
10 ALARM Refer to the ALARM output pin (see page 381).
14 POSMISALARM Refer to the POSMISALARM output pin (see page 381).

384 EIO0000002093 04/2020

 MVALVE

MVALVE_ST_CFGW Type

Bit Name Description

0 OWNER Read/write access
Configures whether the set-point is set by the Program (0) or by the Operator (1).
1 ILCKBP Read/write access. Allows the interlock to be bypassed (1).
2 START START command while the owner is the Operator; otherwise, the valid START is
copied to ST.CFGW.START. Refer to the RSTART input pin (see page 378).
3 REARM Write access
Allows the device to be reset (1). The block sets the signal to 0 after each execution
and sets the signal indicating that the resetting is required (CFGW.REARM) to 0.

EIO0000002093 04/2020 385

MVALVE

Public Variables

Public Variable Description

Variable Type Description

SC MVALVE_SC_DDT Provides the common data required to monitor and
control the valve status from the sequential control.

MVALVE_SC_DDT Type

Name Type Description

LSP REAL Read/write access
Enables the sequential control, to assign the local set-point if the owner is the
Program (OWNER is 0), the selected mode is Auto, and the selected set-point is
local (SC.REM is 0). Otherwise, the current set-point (SP output) is copied
continuously to this variable.
TARGETSP REAL Read access
This variable indicates the current set-point status before interlocking.
PV REAL Read-only access
Refer to the PV input pin (see page 378).
LSTART BOOL Read/write access
1 = allows to enableSTART command while the owner is the Program and Local;
otherwise, the valid START is copied to SC.LSTART. Refer to the RSTART input
pin (see page 378).
OWNER BOOL Read-only access
Refer to the MVALVE_ST.CFGW.OWNER input/output pin (see page 383).
REM BOOL Read/write access
1 = Allows the block to configure for a remote set-point (RSP)
0 = Allows the block to configure for a local set-point (LSP), if the owner is the
Program and the mode is Auto.
ILCKD BOOL Read-only access
The way in which the signal is evaluated, based on the ILCK input and the
MVALVED_ST.CFGW.ILCKBP input/output is shown below:
ILCK ILCKBP SC.ILCKD is calculated as:
OFF – OFF
ON OFF ON
ON ON OFF
OPEN BOOL Read-only access
Refer to the OPEN output pin (see page 381).
CLOSED BOOL Read-only access
Refer to the CLOSED output pin (see page 381).

386 EIO0000002093 04/2020

 MVALVE

Name Type Description

REARMR BOOL Read-only access
Refer to the MVALVE_ST.STW.REARM input/output pin (see page 383).
FAILD BOOL Read-only access
Refer to the FAILD output pin (see page 381).
ALARM BOOL Read-only access
Refer to the ALARM output pin (see page 381).
POSMISALARM BOOL Read-only access
Refer to the POSMISALARM output pin (see page 381).

EIO0000002093 04/2020 387

MVALVE

388 EIO0000002093 04/2020

 Modicon Libraries General Purpose
MVALVELP
EIO0000002093 04/2020

Chapter 37
MVALVELP - Local Panel for Controlling Motorized Valves

MVALVELP - Local Panel for Controlling Motorized Valves

Overview
This chapter describes the MVALVELP DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 390
DFB Representation 391
Inputs 392
Outputs 395
Inputs/Outputs 396
Public Variables 399

EIO0000002093 04/2020 389

MVALVELP

Description

General
The objective of the MVALVELP DFB is to manage a local panel that controls a motorized valve.
This valve is implemented with an MVALVE DFB and with signals that are wired to the controller so
that the latter defines the target position for the device.

Function Description
The main functions of the module are described in the following table:

Function Description
Mode Switch Optionally manages the signals coming from an operating mode switch in a local
panel with the following configuration: Local - Zero - Control System. The Zero mode
signal is optional. However the user can enable Local/Control System mode from the
faceplate also, when VirtualLPEN input pin signal is high and MODESignalsEN
signal is low.
Push buttons The DFB manages up to six signals coming from OFF, ON, OPEN, CLOSE, OPEN
QUICKLY and CLOSE QUICKLY push buttons. The priority is given to the OFF push
button and then to the closing function push buttons.
Owner Management The DFB enables to configure whether the Program needs to be the valve owner or
not, after switching to the Control System mode again.
Owner Locking The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not, it disables the access to change the owner
(Operator/Program) while the valve is controlled from the Local Panel.
Set-point Lock The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not. It disables to change the set-point while the valve
is controlled from the Local Panel.
Push button The push button signals from the Local Panel can be enabled/disabled through the
Enabling/Disabling DFB configuration (input pin) and/or from control sequences.
Enabled Panel The DFB provides a signal that can be used to illuminate a light source on the Local
Signaling Panel to indicate when the push buttons are enabled for operation.
Virtual Panel This signal enables the operator to select the Local / Control System mode of
Enabling/Disabling operation from the HMI so that the push button signals are enabled for operation.
NOTE: VirtualLPEN input pin signal is applicable when Modicon Libraries -
General Purpose is used along with Modicon Libraries - General Purpose for
Wonderware System Platform.

390 EIO0000002093 04/2020

 MVALVELP

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 391

MVALVELP

Inputs

Input Parameter Description

Parameter Type Description

LPSignal BOOL 1 = The local panel mode switch is in the Local Panel position. Refer to the
table included with the description of the LPMode output pin (see page 395).
ZEROSignal BOOL 1 = The local panel mode switch is in the zero position.This signal is optional
even if a mode switch is available on the local panel.When this signal is a
logical high, user is not allowed to operate the device from the faceplate and
also from the DFB. Hence, all the functions in the faceplate will be disabled.
Refer to the table included with the description of the LPMode output pin
(see page 395).
CSSignal BOOL 1 = The local panel mode switch is in the Control System position. Refer to the
table included with the description of the LPMode output pin (see page 395).
OFFSignal BOOL 1 = The OFF push button on the local panel is pressed.
ONSignal BOOL 1 = The ON push button on the local panel is pressed.
OpenSignal BOOL 1 = Indicates to the DFB that OPEN push button on the local panel is pressed.
CloseSignal BOOL 1 = Indicates to the DFB that CLOSE push button on the local panel is
pressed.
DeltaSP REAL Absolute set-point increase or decrease value when the OPEN or CLOSE
push button is pressed.
DeltaFastSP REAL Absolute set-point increase or decrease value when the OPEN and CLOSE
push buttons are pressed.
TREPEAT TIME Indicates the maximum time that elapses before the system interprets that a
command has been repeated when the push button is pressed.
MODESignalsEN BOOL 1 = Enables the use of the Local Panel/Zero/ Control System (or local panel -
control system) mode switch on the local panel. Normally configured in
development phase based on the characteristics of the local panel being
used. If the mode switch is enabled, the LPSignal, ZEROSignal, and
CSSignal inputs are considered to determine the operating modes of the
local panel. Refer to the table included with the description of the LPMode
output pin (see page 395).
NOTE: MODESignalsEN input pin has higher priority than the
VirtualLPEN input pin signal.

392 EIO0000002093 04/2020

 MVALVELP

Parameter Type Description

VirtualLPEN BOOL 1 = This signal enables the operator to select the Local/Control System mode
of operation from the HMI, so that the push button signals are enabled for
operation.
NOTE:
 When the owner is program, the Local/Control System mode selection
drop-down list will be visible but disabled for operation however, when the
owner is operator the Local Panel drop-down list will be accessible for
operation.
 VirtualLPEN input pin signal is applicable only for Modicon Libraries -
General Purpose for Wonderware System Platform offer only, however
there is no impact of this input signal in Modicon Libraries - General
Purpose for Citect SCADA offer.
Refer to the table included with the description of the LPMode output pin
(see page 395).
PBSignalsEN BOOL 1 = Enables to accept the OFF, OPEN and CLOSE push buttons from the local
panel. This signal is not applicable if the mode switch is enabled (refer to the
MODESignalsEN input). This means that the push button signals are
considered when in Local Panel mode.
When the mode switch is disabled (MODESignalsEN = 0), PBSignalsEN
signal enables/disables the push button signals from control system itself
based on relevant process conditions. SC.DisableLP public variable is also
considered for determining whether the push buttons are enabled or not when
LPMode pin signal is high, as shown in the following table:
MODESignalsEN PBSignalsEN SC.DisableLP Push buttons
enabled?
OFF OFF - NO
OFF - ON NO
OFF ON OFF YES
ON - - YES
Therefore, this signal can be used to enable/disable the push buttons on a
simple local panel that does not feature a mode switch (Local
Panel/Zero/Control System) based on relevant process conditions.
ToProgramEN BOOL 1 = Enables the functionality to change the owner of the motorized valve to
Program when mode switch on the local panel returns to the control system
position (only when the mode is switched). If this functionality is disabled, the
operator of the monitoring (HMI) system switches to Program owner when the
operator deems it appropriate. Refer to the table included with the description
of LockOwnerEN input.

EIO0000002093 04/2020 393

MVALVELP

Parameter Type Description

LockOwnerEN BOOL 1 = Disables the access of owner of the motorized valve remaining as
Operator while the local panel mode is Local Panel.
The following table shows how the owner of motorized valve is evaluated
based on ToProgramEN and LockOwnerEN inputs and the operating mode
of local panel:
Local Panel Mode ToProgramEN LockOwnerEN Owner
Zero - - Operator
Switch to Local Panel - - Operator
Local Panel - ON Operator
Switch to Control ON - Program
System
In remaining cases, owner of the motorized valve ceases to be defined from
the MVALVELP DFB and it becomes possible to change it from the monitoring
(HMI) system with the command word in MVALVE_ST.CFGW input/output of
the corresponding MVALVE DFB.
In any case, consider that the valve owner that had been set before switching
to the local panel mode is not memorized.
LockSetPointEN BOOL 1 = Disables the setpoint of motorized valve and lock it into the one which is
defined on the local panel while the local panel mode is Local Panel and the
device owner is operator. User can switch to Program mode based on the
signals that have been previously described even if the local panel mode is
set to Local Panel.
Therefore, user can activate (1) this signal to lock setpoint operation from the
monitoring (HMI) system while motorized valve is controlled from the local
panel.

394 EIO0000002093 04/2020

 MVALVELP

Outputs

Output Parameter Description

Parameter Type Description

PBLIGHTSignal BOOL 1 = The push buttons on the local panel are fully operational, that is, the local panel is
in Local Panel mode (either because the mode is selected with the corresponding
switch or because the push buttons are enabled in the event that there is no selector
switch available or the VirtualLPEN is high with the local panel mode enabled).
LPMode BOOL 1 = The local panel mode is in Local Panel.
The following table shows how the local panel operating mode is determined based on
the MODESignalsEN, VirtualLPEN, PBSignalsEN, LPSignal, CSSignal and
ZEROSignal, input signals:
MODESig- Virtu- PBSig- LPSig- CSSig- ZEROSig- OUTPUT
nalsEN alLPEN nalsEN nal nal nal
0 0 0 0 0 0 CS mode
1 0 0 0 0 0 Zero mode
1 0 0 1 0 0 LP mode and
PBLIGHTSig
nal
1 0 0 0 1 0 CS mode
0 1 1 NA NA NA CS mode
0 1 0 NA NA NA CS mode
0 0 1 0 0 0 LP mode and
PBLIGHTSig
nal
1 1 0 1 0 0 LP mode and
PBLIGHTSig
nal
1 1 0 0 0 0 Zero mode
1 1 0 0 0 1 Zero mode
1 1 0 0 1 0 CS mode
1 0 1 0 1 0 CS mode
1 1 1 0 1 0 CS mode
1 0 0 0 0 1 Zero mode
ZEROMode BOOL 1 = The local panel mode is in Zero. User is not allowed to operate the device from the
faceplate and also from DFB. Hence, all the functions in the faceplate will be disabled.
Refer to the table included with the description of the LPMode output.
CSMode BOOL 1 = The local panel mode is in Control System. Refer to the table included with the
description of the LPMode output.

EIO0000002093 04/2020 395

MVALVELP

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

MVALVE_ST MVALVE_ST_DDT Data structure corresponding to the motorized valve is to be
controlled from the local panel (for detailed information regarding
this structure, refer to the MVALVE DFB (see page 375).
The structure provides the information needed for the operation of
the MVALVELP DFB and enables this DFB to control the owner of
the motorized valve.
MVALVE_CFG MVALVE_CFG_DDT Data structure corresponding to the motorized valve is to be
controlled from the local panel (for detailed information regarding
this structure, refer the MVALVE DFB). The structure provides the
information needed for the operation of the MVALVELP DFB. It
enables this DFB to control the set-point for the motorized valve.
MVALVELP_ST MVALVELP_ST_DDT Data structure that is used as an interface with the monitoring
(HMI) system.

MVALVE_ST.DDT Type

Name Type Description

CFGW WORD Provides the means to control the device from the monitoring (HMI) system.
Read-only access to the data contained in this word.

MVALVE_CFG.DDT Type

Name Type Description

TARGETSP REAL Read/write access
Allows the local set-point of the operator (OWNER = 1) to be set from the monitoring
(HMI) system. If the set-point is set by the Program (OWNER = 0), the DFB
continuously assigns it the value of the current set-point.

MVALVELP_ST.DDT Type

Name Type Description

STW WORD Read-only access
Bits word with the status of the local panel.

396 EIO0000002093 04/2020

 MVALVELP

MVALVE_ST.CFGW Word
The following table describes the MVALVE_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or by the Operator (1).
Refer to the table included with the description of LPMODE output pin, which specifies the cases in
which the MVALVELP DFB can interact with this signal.
2 START Read/write access
Enables to set the Start command from the monitoring (HMI) system when the owner is the
Operator (OWNER = 1). As long as the set-point is set by the Program (OWNER = 0), the DFB
continuously assigns it the value of the current command (MVALVE_ST.STW.START input/output).
The OWNER OFFSignal ONSignal LockSetPointEN START is
MVALVELP calculated
DFB as:
determines
the set-point
for the
motorized
valve.
0 - (The - - - OFF
OWNER
signal is
forced to
1(Operator)
.
Local Panel Operator ON - - OFF
Local Panel Operator OFF Switch to ON - ON
Local Panel Operator OFF OFF ON Last value
In other cases, the START signal is not modified from the MVALVELP DFB.

MVALVELP_ST.CFGW Word

Bit Name Description

0 LocalModeOn Read/write access
 1 = Enables the Local Panel mode.
 0 = Enables the Control System mode.

EIO0000002093 04/2020 397

MVALVELP

MVAVELP_ST.STW Word
Read-only access. Status word. The following table describes the MVALVELP_ST.STW word:

Bit Name Description

0 LPMode Local panel in Local Panel mode. Refer to the LPMode output pin.
1 ZEROMode Local panel in zero mode. Refer to the ZEROMode output pin.
2 CSMode Local panel in Control System mode. Refer to the CSMode output pin.
3 LockedOwner Indicates whether the owner change buttons in the monitoring (HMI) system
needs to be locked (1) or not (0).
Is activated when:
 The Local Panel mode is set to Zero or
 It is set to Local Panel and the LockOwnerEN input signal has been
configured as active (1).
4 SPLocked Indicates whether the set-point change and START buttons in the monitoring
(HMI) system needs to be locked (1) or not (0).
Is activated when:
 The Local Panel mode is set to Zero or
 It is set to Local Panel and the LockSetpointEN input signal has been
configured as active (1).
5 MODESignalsEN Indicates the state of the MODESignalsEN input signal, that is, whether there
is a mode switch (1) or not (0).
6 PBENABLED Indicates whether the push buttons of the local panel are enabled (1) or not
(0). The signal is activated when at least one of the MODESignalsEN and
PBSignalsEN signal inputs are active.
7 VirtualLPEN Enables the drop-down list for the Local Panel / Control System mode
selection.
8 LPSignal Indicates the state of the LPSignal input signal.
9 ZEROSignal Indicates the state of the ZEROSignal input signal.
10 CSSignal Indicates the state of the CSSignal input signal.
11 OFFSignal Indicates the state of the OFFSignal input signal.
12 ONSignal Indicates the state of the ONSignal input signal.
13 OpenSignal Indicates the state of the OpenSignal input signal.
14 CloseSignal Indicates the state of the CloseSignal input signal.

398 EIO0000002093 04/2020

 MVALVELP

Public Variables

Public Variable Description

Variable Type Description

SC MVALVEDLP_SC_DDT Provides the frequently needed data for
monitoring and controlling the DFB.

MVALVEDLP_SC_DDT Type

NAME Type Description

LPMode BOOL Read-only access
Refer to the LPMode output pin (see page 395).
ZEROMode BOOL Read-only access
Refer to the ZEROMode output pin (see page 395).
CSMode BOOL Read-only access
Refer to the CSMode output pin (see page 395).
DisableLP BOOL Read/write access
1 = Disables the push buttons on the local panel. Only
applicable when a local panel without mode switch
configuration is used (MODESignalsEN = 0).

EIO0000002093 04/2020 399

MVALVELP

400 EIO0000002093 04/2020

 Modicon Libraries General Purpose
SDDEVCTL
EIO0000002093 04/2020

Chapter 38
SDDEVCTL - Device with Variable Speed Drive

SDDEVCTL - Device with Variable Speed Drive

Overview
This chapter describes the SDDEVCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 402
DFB Representation 404
Inputs 405
Outputs 408
Inputs/Outputs 411
Public Variables 414

EIO0000002093 04/2020 401

SDDEVCTL

Description

General
The SDDEVCTL DFB is used to manage control modules for motors with a variable speed drive
whether the speed drive is switched through communication, I/O wiring, or a mix of both.
The DFB allows management of the associated devices from the sequential control, the continuous
control, and/or the monitoring subsystem. It depends on the user configuration and the system
needs.
User can supplement the DFB with the SDDEVLP, DEVMNT, CONDSUM, and CONDSUM1 DFB from
the General Purpose Library.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Control Controls the forward/reverse rotation direction based on the configuration and the
commands that the DFB receives according to the functions.
Owner selection The DFB manages control system level which is the owner (operator or program). As
a result, it is responsible for setting the setpoint for the desired position.
Local and remote Enables to control the DFB with a setpoint that is determined through a set-point
setpoint selector (local or remote).
The local setpoint is assigned to the sequential control or to the command received
from the Supervision system while the remote setpoint is assigned to the DFB control
from the logic implemented in the continuous control.
Position detection Allows to determine the actual position of the element to be controlled and monitored
with the help of limit switch.
Interlocking The DFB gives a command to the device to move to the defined position in case of
an active interlock. An interlock bypass function is available.
Multispeed Enables to select between speed configurable through an analog signal or between
3 preset speeds in the speed drive.
Simulation You can switch the DFB to simulation mode so that the actual position of the
controlled device is considered to be the same as its desired position, regardless of
the signals received from the position detectors.

402 EIO0000002093 04/2020

 SDDEVCTL

The optional functions of the DFB are described in the following table:

Function Description
Inoperable device Allows to monitor inoperable device condition (optional). DFB can be configured to
withdraw output based on this condition.
Commonly used for detecting whether or not the motor switch has tripped due to
thermal overload.
Detection of not If position is not confirmed within a configured time after the output command is
confirmed operation activated, DFB detects not confirmed operation.
Manual resetting Allows you to reset manually after the detection of an inoperable device condition
or a not confirmed operation. After reset, device output will follow set point.

EIO0000002093 04/2020 403

SDDEVCTL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

404 EIO0000002093 04/2020

 SDDEVCTL

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL If a rising edge is detected on this input, the internal timers of
the block are reset and detected alarms are set to 0.
PV REAL Current value of the speed measurement. Comes from the
speed drive or from a measurement device.
RUN BOOL 1 = Indicates to the DFB that the speed drive is generating an
output frequency. Refer to the RUNEN input.
POWERRMVL BOOL 1 = Indicates to the DFB that the speed drive is disabled
(Power Removal).
After activating this signal, the system requires resetting.
SDDEVCTLST.CFGW.REARM = 1. If you use the POWERMVL
signal of the speed drive without requiring resetting wire it to
a CONDSUM DFB input that does not require resetting and the
output of the latter to the ILCK input.
FAIL BOOL 1 = Indicates to the DFB a detected error in the device.
Refer to the FAILEN input.
RUNEN BOOL 1 = Allows the availability of the RUN input signal to be
enabled.
FAILEN BOOL 1 = Enables the FAIL parameter.
CONFREARMEN BOOL  1 = Withdraws the output OP when a non-confirmed
operation is detected (ALARM = 1) and requires a
mandatory manual resetting once the ALARM condition
disappears.
 0 = The output OP remains in its previous state when a
non-confirmed operation is detected (ALARM = 1) and
does not need manual resetting, once the ALARM
condition disappears.
Refer to the TIMEOUT input and the
SDDEVCTLST.STW.ALARM input/output pin (see page 411).
FAILREARMEN BOOL  1 = Withdraws the output OP upon a detected failure
condition (FAILD = 1) and requires a mandatory manual
resetting once the FAIL condition disappears.
 0 = The output OP remains in its previous state upon a
detected failure condition (FAILD = 1) and does not need
manual resetting, once the FAIL condition disappears.

EIO0000002093 04/2020 405

SDDEVCTL

Parameter Type Description

REVERSEEN BOOL 1 = Enable to configure whether the speed drive can operate
in forward and reverse rotation
0 = Enable to configure whether the speed drive can operate
in only forward.
SPEN BOOL 1 = Allows enabling the analog speed set-point (SP — analog
setpoint).
Applies both to the local/remote mode and to the
program/operator owner.
S1 REAL Enables (1) the availability of the multispeed setpoint x (value
S2 of the signal other than 0) and reports the speed configured
S3 on the speed drive as Sx to the Supervision system.
RSPSEL Uint Enables to select which remote setpoint should be
considered in the rogram/remote mode.
RSPSEL The remote set-point is calculated as follows:
RSPSEL The remote set-point is:
0 RSP
1 Speed 1 (S1 –configured in the speed drive)
2 Speed 2 (S2 –configured in the speed drive)
3 Speed 3 (S3 –configured in the speed drive)
NOTE: If the analog setpoint is selected (xSPSEL = 0) and
the signal has not been enabled (SPEN = 0), the setpoint
indicated by S1 will be considered as the active setpoint
regardless of its state.
RSPREV BOOL 1 = Selects rotation in reverse direction for the remote
setpoint in program/remote mode.
0 = 1 = Selects rotation in forward direction for the remote
setpoint in program/remote mode.
RSP REAL Enables the remote speed setpoint, which is usually set by
the continuous control, to be connected in program/remote
mode with the selected SP speed (RSPSEL = 0).
RSTART BOOL 1 = Enables the speed drive to be run in program/remote
mode.
ILCKSEL Uint Enables to select which remote setpoint needs to be
considered in the case of interlocking.
Refer to the possible RSPSEL values.
ILCKREV BOOL 1 = Selects rotation in reverse direction when the interlock is
activated.
0 = Selects rotation in forward direction when the interlock is
activated.
Refer to the ILCKSEL, ILCKSP, and ILCK inputs.

406 EIO0000002093 04/2020

 SDDEVCTL

Parameter Type Description

ILCKSP REAL Setpoint needs to be considered when the DFB is interlocked
and the analog setpoint is selected (ILCKSEL = 0).
Refer to the ILCKSEL and ILCK inputs.
ILCKSTART BOOL 1 = Enables to define the interlock position on run.
ILCK BOOL 1 = Interlocks the device at the defined position.
Refer to the ILCKSEL, ILCKSP, and ILCKREV inputs.
NOTE: The signal connected to this input will not be
effective if the device requires resetting. In which case, it will
be de-energized (FORWARD and REVERSE signals to 0).
TIMEOUT TIME Allows configuring the time during which the detection of not
confirmed operations is disabled. 0 disables the detection.
After the configured time has elapsed, an alarm is generated.
Refer to the ALARM output (see page 408) output and
SDDEVCTL_ST.STW.ALARM input/output pin
(see page 411).
SCANTIME TIME Allows configuring the time during which the detected alarm
signals are kept active. Allows the Supervision system to
acquire the data for alarms that are automatically reset. Refer
to the ALARM and FAILD outputs (see page 408).
EXTCTLD BOOL 1 = Indicates to the DFB the speed drive is being controlled
from outside (for example, from the console or from a push-
button panel) the system.
Enables to avoid the generation of erroneous detections of
not confirmed operation while the device is being controlled
from outside the system. Monitoring of the alarm for the
detection of not confirmed operations stops when the device
is externally controlled.

EIO0000002093 04/2020 407

SDDEVCTL

Outputs

Output Parameter Description

Parameter Type Description

DIRECT BOOL 1 = Forward direction drive signal to the speed drive.
REVERSE BOOL 1 = Reverse direction drive signal to the speed drive.
OP REAL Speed value corresponding to the current output of the speed drive. The signal
(coming from the speed drive) that provides this speed in the engineering units
desired for representation in the monitoring subsystem (the DFB does not scale
this signal) needs to be connected.
SPSELD BOOL 1 = Analog setpoint input activated in the speed drive.
S1SELD BOOL 1 = Multispeed x activated in the speed drive.
S2SELD
S3SELD
SCODE0 BOOL 1 = Encodes the selected speed.
SCODE1

The table shows the value of the coding based on the status of the SPSELD, S1SELD, S2SELD, and
S3SELD outputs:

Selected multispeed SCODE0 SCODE1

SP (SPSELD = ON) OFF OFF
S1 (S1SELD = ON) ON OFF
S2 (S2SELD = ON) OFF ON
S3 (S3SELD = ON) ON ON

Parameter Type Description

RUNNING BOOL 1 = Allows you to determine the speed drive is delivering a
frequency to the output. Is evaluated considering the RUN, RUNEN
inputs, and the simulation status.

408 EIO0000002093 04/2020

 SDDEVCTL

The evaluation of this signal depending on the configuration implemented on the RUNEN input and
on the SDDEVCTLST.CFGW.SIMMD input/output is shown in the table:

RUNEN SIMMD RUNNING

- ON FORWARD or REVERSE
OFF OFF FORWARD or REVERSE
ON OFF RUN

Parameter Type Description

SP BOOL 1 = Current speed setpoint in the speed drive.

SP calculation depending on the selected operating mode is shown in the table:

OWNER REM SP
OFF OFF Speed selected (in terms of the SC.LSP, SC.LSPSEL public variables and the
S1, S2, and S3 inputs) from the sequential control
OFF ON Speed selected from the continuous control (in terms of the RSP, RSPSEL, S1,
S2, and S3 inputs).
ON - Speed selected from the continuous control (in terms of the
SDDEVCTL_ST.CFGW.LSP and LSPSEL inputs/outputs and the S1, S2, and
S3 inputs.

Parameter Type Description

ALARM BOOL 1 = Indicates if the detection of a not confirmed operation has occurred. Refer
to the ALARM behavior for more details.
FAILD BOOL 1 = Indicates a speed drive detected error.
It is evaluated according to the value of the FAIL and FAILEN inputs. When it
is activated (1), it is timed so that the signal is maintained for a minimum of
SCANTIME.
After the minimum activation time has elapsed, it is only deactivated if the
FAIL input signal is deactivated (0).
OOS BOOL 1 = Indicates the equipment is out of service.

The table shows the FAILD signal evaluation depending on the FAIL and FAILEN inputs:

FAIL FAILEN FAILD

- OFF OFF
OFF ON OFF
ON ON ON (minimum SCANTIME

EIO0000002093 04/2020 409

SDDEVCTL

OP Calculation

WARNING
UNINTENDED EQUIPMENT OPERATION
 The CONFREARMEN pin has to be set to 1 for the OP pin to become 0, under non-confirmed
operations.
 The FAILREARMEN pin has to be set to 1 for the OP pin to become 0, under detected fail
conditions.
 Changes to the configuration of these parameters have to be performed by competent
personnel only.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

FAILEN input FAILREARMEN input OP output when FAIL = 1 OP output when FAIL = 1 (assume
(assume OP = 1 before OP = 0 before the detected failure)
the detected failure)
0 0 1 0
0 1 1 0
1 0 1 0
1 1 0 0

ALARM Behavior
Monitoring is carried out on the RUNNING output signal and is activated when one of the control
signals (FORWARD and REVERSE outputs) is switched (0 to 1 or 1 to 0) as long as the
preselection value of the timer is greater than 0 (TIMEOUT input) and the speed drive is not being
controlled from outside the control system (EXTCTLD to 1).
After the control switching has occurred, the DFB internal timer is activated.
As long as the timer is running, the position of the speed drive is not monitored (RUN input).
After the time has elapsed, any detection of not confirmed operation causes the alarm to be
generated immediately.
The detected error signal is maintained for a minimum of SCANTIME.
After this time has elapsed, the signal is recovered (0) based on the following conditions:
 If the position becomes correct (RUNNING output) according to the control status (FORWARD
and REVERSE outputs) or
 If the device is reset (through the SDDEVCTLST.CFGW.REARM input/output and as long as the
CONFREARMEN input is 1).
In both cases, the internal timer is restarted with the TIMEOUT value.

410 EIO0000002093 04/2020

 SDDEVCTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SDDEVCTL_ST SDDEVCTL_ST_DDT Data structure of the DFB status.
Usually used from the monitoring subsystem for
monitoring the status of the speed drive.
SDDEVCTL_CFG SDDEVCTL_CFG_DDT Data structure of the DFB configuration.

SDDEVCTL_ST_DDT Type

Name Type Description

PV REAL Current speed of the output of the speed drive.
Read-only access
Refer to the PV input pin (see page 405).
SP REAL Current speed set-point. Refer to the SP output pin (see page 408). The DFB
continuously copies the value of the current set-point in this signal if the mode is not
the Operator (Local) mode. In which case, you can modify it from the monitoring
subsystem.
OP REAL Current output to the speed drive. Refer to the OP output pin (see page 408).
STW WORD Provides the status of the device usually used from the monitoring subsystem and
allows data to be retained in the memory. Read-only access to the data contained in
this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem. Read-only
access to the data contained in this word.

SDDEVCTL_ST.STW Word Structure

Bit Name Description

0 RUNNING Refer to the RUNNING output pin (see page 408).
1 DIRECT Refer to the DIRECT output pin (see page 408).
2 REVERSE Refer to the REVERSE output pin (see page 408).
3 REVERSEEN Refer to the REVERSEEN input pin (see page 405).
4 ALARM Refer to the ALARM output pin (see page 408).
5 FAILD Indicates an inoperable device condition. Refer to the FAILD output pin
(see page 408).

EIO0000002093 04/2020 411

SDDEVCTL

Bit Name Description

6 REM Indicates if the current setpoint (SP) is local (0) or remote (1). The setpoint is local
when the owner is the operator (OWNER =1). When the owner is the program (OWNER
= 0), the setpoint is selected with the SC.REM public signal (1: remote, 0: local).
7 ILCK Refer to the ILCK input pin (see page 405).
8 REARMR Indicates if the device requires resetting (1) after the detection of an inoperable
device condition (with control order set to 1) that has been configured as requiring
resetting through the CONFREARMEN and/or FAILREARMEN input pins.
9 EXTCTLD Read-only access
Refer to the EXTCTLD input pin (see page 405).
10 SPSELD Read-only access
Refer to the SPSELD output pin (see page 408). The current speed setpoint is set
through continuous set-point.
11 S1SELD Read-only access
Refer to the S1SELD.
12 S2SELD Read-only access
Refer to the S2SELD.
13 S3SELD Read-only access
Refer to the S3SELD.
14 SPEN Read-only access
Refer to the SPEN input pin (see page 405).
15 POWERRMVL Read-only access
Refer to the POWERMVL input pin (see page 405).

SDDEVCTL_ST.CFGW Word Structure

Bit Name Description

0 OWNER Read/write access
Enables one to configure whether the setpoint is set by the program (0) or by the operator (1).
1 ILCKBP Read/write access
Allows the interlock to be bypassed (1).
2 SIMMD Read/write access
Enables to set the device to simulation mode so that the actual position signals (RUN input)
are ignored. It is simulated that the device is in the desired position (according to the OP
output pin) and is functional (as if the FAIL input pin is reset (0)).
3 REARM Write Access
Enables the device to reset (1). The DFB sets the signal to 0 after each execution and sets
the signal indicating that resetting is required (CFGW.REARM) to 0.

412 EIO0000002093 04/2020

 SDDEVCTL

Bit Name Description

4 LSPREV Read/write access
Allows setting the rotation direction (0: forward, 1: reverse) from the Supervision system if the
mode is operator (OWNER is 1). When the setpoint is set by the program (OWNER is 0), the DFB
continuously assigns it the rotation direction set from the program.
5 LSTART Read/write access
Enables the speed drive to run (1) or stop (0) in the operator mode.
15 OOS Read/write access
Indicates whether the equipment is out of service (1) or In use (0).

NOTE: The outputs (SP and OP) are de-energized when the device is in an out-of-service state;
even if an interlock that requests the device to be started is active.

SDDEVCTL_CFG_DDT Type

Name Type Description

SPSEL UINT Enables to select which local setpoint needs to be used if the owner is the operator.
This data is write-only if the owner is the operator (OWNER is 1), and is loaded with
the selected value if the owner is the program (OWNER is 0).
S1 REAL Read-only access
Refer to the S1 input pin (see page 405).
S2 REAL Read-only access
Refer to the S2 input pin (see page 405).
S3 REAL Read-only access
Refer to the S3 input pin (see page 405).
Reserved INT Reserved

EIO0000002093 04/2020 413

SDDEVCTL

Public Variables

Public Variable Description

Variable Type Description

SC SDDEVCTL_SC_DDT Provides the frequently needed data to monitor
and control the regulator status from the
sequential control.

SDDEVCTL_SC_DDT Type

Name Type Description

PV REAL Current value of the speed measurement. Comes from the speed drive or from
a measurement device (see page 411).
SP REAL Read-only access
Refer to the SP output pin (see page 408).
OP REAL Read-only access
Refer to the OP output pin (see page 408).
DIRECT BOOL Read-only access
Refer to the DIRECT output pin (see page 408).
REVERSE BOOL Read-only access
Refer to the REVERSE output pin (see page 408).
RUNNING BOOL Read-only access
Refer to the RUNNING output pin (see page 408).
ILCKD BOOL Read-only access
Indicates the motor is interlocked.
The signal evaluation depending on the ILCK input and the
SDDEVCTLST.CFGW.ILCKBP input/output is shown in the following table:
ILCK ILCKBP SC.ILCKD.LSP
OFF OFF OFF
OFF ON OFF
ON OFF ON
ON ON OFF
OWNER BOOL Read-only access
Refer to the SDDEVCTL_ST.CFGW.OWNER input/output pin (see page 411).
EXTCTLD BOOL Read-only access
Refer to the EXTCTLD input pin (see page 405).
SPSELD BOOL Read-only access
Refer to the SPSELD output pin (see page 408).

414 EIO0000002093 04/2020

 SDDEVCTL

Name Type Description

S1SELD BOOL Read-only access
S2SELD Refer to the S1SELD, S2SELD, or S3SELD output pin (see page 408).
S3SELD
ALARM BOOL Read-only access
Refer to the SDDEVCTL_ST.STW.ALARM input/output pin (see page 411).
POWERRMVL BOOL Read-only access
Refer to the POWERRMVL input pin (see page 405).
FAILD BOOL Read-only access
Refer to the SDDEVCTL_ST.STW.FAILD input/output pin (see page 411).
REM BOOL 1 = Allows the DFB to be configured to remote set-point RSP
0 = Allows the DFB to be configured to local set-point—LSP if the owner is the
Program (OWNER = 0).
Read/write access.
LSPREV BOOL 1 = Enables to set the reverse rotation direction (0: forward, 1: reverse) in
Program/Local mode.
0 = Enables to set the forward rotation direction in Program/Local mode.
In other modes, the DFB continuously assigns the current rotation direction set-
point to it.
LSTART BOOL 1 = Enables the speed driver to run in Program/Local mode.
Read/write access
Enables to set the applicable speed set-point in Program/Local mode when the
speed has been selected through the SC.SELSP variable. The DFB sets this
signal to 0 after the signal has been processed.
LSP REAL Enables to assign the local set-point normally for the sequential control if the
owner is the Program (OWNER is 0) and the selected set-point is Local (REM is
0). In any other case, the DFB automatically assigns it the current value of the
resulting set-point to it (refer to the SP output pin (see page 408)).
SELSP BOOL Read/write access
Enables the speed set-point to be set in Program/Local mode to the SC.LSP
speed. 1 allows this speed to be selected. The DFB sets this signal to 0 after
the signal has been processed.
SELS1 BOOL Read/write access
SELS2 1 = Enables the speed set-point to be set in Program/Local mode to the speed
SELS3 driver multispeed x. 1 enables this speed to be selected. The DFB sets this
signal to 0 after the signal has been processed.
NOTE: If more than one speed is selected simultaneously, the following order
of priority applies: SP, S1, S2, and S3.
OOS BOOL Read/write access
1 = Indicates the equipment is Out of Service.

EIO0000002093 04/2020 415

SDDEVCTL

416 EIO0000002093 04/2020

 Modicon Libraries General Purpose
SDDEVLP
EIO0000002093 04/2020

Chapter 39
SDDEVLP - Local Panel for Controlling Devices with a Variable Speed Drive

SDDEVLP - Local Panel for Controlling Devices with a Variable

Speed Drive

Overview
This chapter describes the SDDEVLP DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 418
DFB Representation 419
Inputs 420
Outputs 423
Inputs/Outputs 424
Public Variables 428

EIO0000002093 04/2020 417

SDDEVLP

Description

General
The objective of the SDDEVLP DFB is to manage a local panel that controls a motor with a variable-
speed drive. This variable-speed drive is implemented with an SDDEVCTL DFB and with signals
that are wired to the controller so that the latter defines the target position for the device.

Function Description
The main functions of the module are described in the following table:

Function Description
Mode Switch Optionally manages the signals coming from an operating mode switch in a local panel
with the following configuration: Local - Zero - Control System. The Zero mode signal
is optional. However the user can enable Local/Control System mode from the
faceplate also, when VirtualLPEN input pin signal is high and MODESignalsEN
signal is low.
Push buttons The DFB manages up to eight signals coming from OFF, Forward ON, Reverse ON,
Increase speed, Decrease speed, S1 set-point pre-established, S2 set-point pre-
established, and S3 set-point pre-established push buttons, giving the OFF push
button signal priority.
Owner Management The DFB enables to configure whether the Program needs to be the owner of the
speed driver-equipped motor or not, after switching to the Control System mode again.
Owner Locking The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not, it disables the access to change the owner
(Operator/Program) while the speed driver-equipped motor is controlled from the Local
Panel.
Set-point Lock The DFB enables to configure whether the monitoring (HMI) system needs to block
access to the drop-down list or not. It disables to change the set-point while the speed
driver-equipped motor is controlled from the Local Panel.
Push button The push button signals from the Local Panel can be enabled/disabled through the
Enabling/Disabling DFB configuration (input pin) and/or from control sequences.
Enabled Panel The DFB provides a signal that can be used to illuminate a light source on the Local
Signaling Panel to indicate when the push buttons are enabled for operation.
Virtual Panel This signal enables the operator to select the Local / Control System mode of
Enabling/Disabling/ operation from the HMI so that the push button signals are enabled for operation.
NOTE: VirtualLPEN input pin signal is applicable when Modicon Libraries -
General Purpose is used along with Modicon Libraries - General Purpose for
Wonderware System Platform.

418 EIO0000002093 04/2020

 SDDEVLP

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 419

SDDEVLP

Inputs

Input Parameter Description

Parameter Type Description

LPSignal BOOL 1 = The local panel mode switch is in the Local Panel position. Refer to the
table included with the description of the LPMode output pin (see page 423).
ZEROSignal BOOL 1 = The local panel mode switch is in the zero position.This signal is optional
even if a mode switch is available on the local panel.When this signal is a
logical high, user is not allowed to operate the device from the faceplate and
also from the DFB. Hence, all the functions in the faceplate will be disabled.
Refer to the table included with the description of the LPMode output pin
(see page 423).
CSSignal BOOL 1 = The local panel mode switch is in the Control System position. Refer to the
table included with the description of the LPMode output pin (see page 423).
OFFSignal BOOL 1 = The OFF push button on the local panel is pressed.
DirectSignal BOOL 1 = Indicates to the DFB that the Forward Direction ON push button on the
local panel is pressed.
ReverseSignal BOOL 1 = Indicates to the DFB that the Reverse Direction ON push button on the
local panel is pressed.
IncSPSignal BOOL 1 = Indicates to the DFB that the Increase set-point push button on the local
panel is pressed.
DecSPSignal BOOL 1 = Indicates to the DFB that the Decrease set-point push button on the local
panel is pressed.
S1Signal BOOL 1 = Indicates to the DFB that the S1 pre-established speed push button on the
local panel is pressed.
S2Signal BOOL 1 = Indicates to the DFB that the S2 pre-established speed on the local panel
is pressed.
S3Signal BOOL 1 = Indicates to the DFB that the S3 pre-established speed push button on the
local panel is pressed.
DeltaFastSP REAL Absolute set-point increase or decrease value when the Increase and
Decrease push buttons are pressed.
DeltaSP REAL Absolute set-point increase or decrease value when the Increase or Decrease
push button is pressed.
TREPEAT TIME Indicates the maximum time that needs to elapse before the system interprets
that a command has been repeated when the push button is being pressed.

420 EIO0000002093 04/2020

 SDDEVLP

Parameter Type Description

MODESignalsEN BOOL 1 = Enables the use of the local panel/zero/ control system (or local panel -
control system) mode switch on the local panel. Normally configured in
development phase based on the characteristics of the local panel being used.
If the mode switch is enabled, the LPSignal, ZEROSignal, and CSSignal
inputs are considered to determine the operating modes of the local panel.
Refer to the table included with the description of the LPMode output pin
(see page 423).
NOTE: MODESignalsEN input pin has higher priority than the VirtualLPEN
input pin signal.
VirtualLPEN BOOL 1 = This signal enables the operator to select the Local/Control System mode
of operation from the HMI, so that the push button signals are enabled for
operation.
NOTE:
 When the owner is program, the Local/Control System mode selection
drop-down list will be visible but disabled for operation however, when the
owner is operator the Local Panel drop-down list will be accessible for
operation.
 VirtualLPEN input pin signal is applicable only for Modicon Libraries -
General Purpose for Wonderware System Platform offer only, however
there is no impact of this input signal in Modicon Libraries - General
Purpose for Citect SCADA offer.
Refer to the table included with the description of the LPMode output pin
(see page 423).
PBSignalsEN BOOL 1 = Enables to accept the OFF, Forward ON, Reverse ON, Increase, Crease,
S1 Preset, S2 Preset and S3 Preset buttons from the local panel. This signal
is not applicable if the mode switch is enabled (refer to the MODESIGNALSEN
input). It means that the push button signals are considered in the Local Panel
mode.
When the mode switch is disabled (MODESIGNALSEN = 0), PBSIGNALSEN
signal enables/disables the push button signals from control system itself
based on relevant process conditions. SC.DISABLELP public variable is also
considered for determining whether the push buttons are enabled or not when
LPMode pin signal is high, as shown in the following table.
MODESignalsEN PBSignalsEN SC.DisableLP Push buttons
enabled?
OFF OFF - NO
OFF - ON NO
OFF ON OFF YES
ON - - YES
Therefore, this signal can be used to enable/disable the push buttons on a
simple local panel that does not feature a mode switch (Local
Panel/Zero/Control System) based on relevant process conditions.

EIO0000002093 04/2020 421

SDDEVLP

Parameter Type Description

ToProgramEN BOOL 1 = Enables the functionality to change the owner of the speed-driver-
equipped motor to Program when the mode switch on local panel returns to
the control system position (only when the mode is switched). If this
functionality is disabled, the operator of monitoring (HMI) system switches to
Program owner when the operator deems it appropriate. Refer to the table
included with description of the LockOwnerEN input.
LockOwnerEN BOOL 1 = Disables the access of owner of the speed-driver-equipped motor
remaining as Operator while the local panel mode is Local Panel.
The following table shows how the owner of the speed-driver-equipped motor
is evaluated based on ToProgramEN and LockOwnerEN inputs and the
operating mode of the local panel:
Local Panel Mode ToProgramEN LockOwnerEN Owner
0 - - Operator
Switch to Local Panel - - Operator
Local Panel - ON Operator
Switch to Control ON - Program
System
In remaining cases, owner of the speed-driver-equipped motor ceases to be
defined from the SDDEVLP DFB and it becomes possible to change it from
monitoring (HMI) system with the command word in the SDDEVCTL_ST.CFGW
input/output variable of the corresponding SDDEVCTL DFB.
In any case, consider that the owner of speed-driver-equipped motor that had
been set before switching to the local panel mode is not memorized.
LockSetPointEN BOOL 1 = Disables the setpoint of device and lock it into the one defined on the local
panel while local panel mode is Local Panel and the device owner is Operator.
You can switch to Program mode based on the signals that have been
previously described even if the local panel mode is set to Local Panel.
Therefore, user can activate (1) this signal to lock setpoint operation from the
monitoring (HMI) system while speed-driver-equipped motor is controlled from
the local panel.

422 EIO0000002093 04/2020

 SDDEVLP

Outputs

Output Parameter Description

Parameter Type Description

PBLIGHTSignal BOOL 1 = The push buttons on the local panel are fully operational, that is, the local panel
is in Local Panel mode (either because the mode is selected with the corresponding
switch or because the push buttons are enabled in the event that there is no selector
switch available or the VirtualLPEN is high with the local panel mode enabled).
LPMode BOOL 1 = The local panel mode is in Local Panel.
The following table shows how the local panel operating mode is determined based
on the MODESignalsEN, VirtualLPEN, PBSignalsEN, LPSignal, CSSignal
and ZEROSignal, input signals:
MODESig- Virtu- PBSig- LPSig- CSSig- ZEROSig- OUTPUT
nalsEN alLPEN nalsEN nal nal nal
0 0 0 0 0 0 CS mode
1 0 0 0 0 0 Zero mode
1 0 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 0 0 0 1 0 CS mode
0 1 1 NA NA NA CS mode
0 1 0 NA NA NA CS mode
0 0 1 0 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 1 0 0 LP mode and
PBLIGHT-
Signal
1 1 0 0 0 0 Zero mode
1 1 0 0 0 1 Zero mode
1 1 0 0 1 0 CS mode
1 0 1 0 1 0 CS mode
1 1 1 0 1 0 CS mode
1 0 0 0 0 1 Zero mode
ZEROMode BOOL 1 = The local panel mode is in Zero. User is not allowed to operate the device from
the faceplate and also from DFB. Hence, all the functions in the faceplate will be
disabled. Refer to the table included with the description of the LPMode output.
CSMode BOOL 1 = The local panel mode is in Control System. Refer to the table included with the
description of the LPMode output.

EIO0000002093 04/2020 423

SDDEVLP

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SDDEVCTL_CFG SDDEVCTL_CFG_DDT Data structure corresponding to the speed-driver-equipped
motor is to be controlled from the local panel (for detailed
information regarding this structure, refer the SDDEVCTL
DFB in the Process manual). The structure provides the
information needed for the operation of the SDDEVLP DFB.
It enables this DFB to control the set-point for the speed-
driver-equipped motor.
SDDEVCTL_ST SDDEVCTL_ST_DDT Data structure corresponds to the on-off device to be
controlled from the local panel (for detailed information
regarding this structure, refer to the SDDEVCTL DFB
(see page 401).
The structure provides the information needed for the
operation of the SDDEVLP DFB and enables this DFB to
control the owner of the speed-driver-equipped motor.
SDDEVLP_ST SDDEVLP_ST_DDT Data structure that is used as an interface with the
monitoring (HMI) system.

SDDEVCTL_CFG.DDT Type

Name Type Description

SPSEL UINT Read/write access
Enables to select from the monitoring (HMI) system the local set-point that needs to
be used when owner is the Operator (OWNER = 1). If the set-point is set by the
Program (OWNER = 0), the DFB continuously assigns it the current value.

SDDEVCTL_ST.DDT Type

Name Type Description

SP WORD Current speed set-point. The DFB continuously copies the value of the current set-
point to this signal if the mode is not the Operator (Local) mode. In this case, you can
modify it from the monitoring (HMI) system. The SDDEVLP DFB determines the set-
point for the speed-driver-equipped motor based on the operating mode of the
control panel, the owner, the status of the push button, and the set-point locking
(LockSetPointEN) signal.
CFGW WORD Provides the means to control the device from the monitoring (HMI) system. Read-
only access to the data contained in this word.

424 EIO0000002093 04/2020

 SDDEVLP

SDDEVLP_ST.DDT Type

Name Type Description

STW WORD Read-only access
Bits word with the status of the local panel.

SDDEVCTL_ST.CFGW Word
The following table describes the SDDEVCTL_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or by the Operator (1).
Refer to the table included with the description of the LPMode output pin, which specifies the cases in
which the SDDEVLP DFB can interact with this signal.
4 LSPREV Read/write access
Enables to set the rotation direction (0:forward, 1: reverse) from the monitoring (HMI) system if the
owner is the Operator (OWNER = 1). When the set-point is set by the Program (OWNER = 0), the DFB
continuously assigns it the direction of the rotation set from the Program.

EIO0000002093 04/2020 425

SDDEVLP

Bit Name Description

5 LSTART Read/write access
Enables to start running (1) or stop (0) from the monitoring (HMI) system when the owner is the
Operator (OWNER = 1). As long as the set-point is set by the Program (OWNER = 0), the DFB
continuously assigns it the value of the current command (SDDEVCTL_ST.STW.LSTART input/output).
The OWNER OFFSig- Di- Revers- Lock- LSTART LSPREV is
SDDEVLP nal rectSig- eSignal Set- is calculated
DFB nal PointEN calculated as:
determines as:
the set-point
for the
speed-
driver-
equipped
motor.
0 - (The - - - - OFF Last value
OWNER
signal is
forced to
1(Operator)
.
Local Panel Operator ON - - - OFF Last value
Local Panel Operator OFF ON - - ON OFF
Local Panel Operator OFF - ON - ON ON
Local Panel Operator OFF OFF OFF ON Last value Last value
In other cases, the LSTART signal is not modified from the SDDEVLP DFB.

SDDEVLP_ST.CFGW Word

Bit Name Description

0 LocalModeOn Read/write access only
 1 = Enables the Local Panel mode.
 0 = Enables the Control System mode.

426 EIO0000002093 04/2020

 SDDEVLP

SDDEVLP_ST.STW Word
Read-only access. Status word. The following table describes the SDDEVLP_ST.STW word:

Bit Name Description

0 LPMode Local panel in Local Panel mode. Refer to the LPMode output pin.
1 ZEROMode Local panel in zero mode. Refer to the ZEROMode output pin.
2 CSMode Local panel in Control System mode. Refer to the CSMode output pin.
3 LockedOwner Indicates whether the owner change buttons in the monitoring (HMI) system
needs to be locked (1) or not (0).
Is activated when:
 The Local Panel mode is set to Zero or
 It is set to Local Panel and the LockOwnerEN input signal has been
configured as active (1).
4 SPLocked Indicates whether the set-point change and START buttons in the monitoring
(HMI) system needs to be locked (1) or not (0).
Is activated when:
 The Local Panel mode is set to Zero or
 It is set to Local Panel and the LockSetpointEN input signal has been
configured as active (1).
5 MODESignalsEN Indicates the state of the MODESignalsEN input signal, that is, whether there is
a mode switch (1) or not (0).
6 PBEnabled Indicates whether the push buttons of the local panel are enabled (1) or not (0).
The signal is activated when at least one of the MODESignalsEN and
PBSignalsEN signal inputs is active.
7 VirtualLPEN Enables the drop-down list for the Local Panel / Control System mode selection.
8 LPSignal Indicates the state of the LPSignal input signal.
9 ZEROSignal Indicates the state of the ZEROSignal input signal.
10 CSSignal Indicates the state of the CSSignal input signal.
11 OFFSignal Indicates the state of the OFFSignal input signal.
12 DirectSignal Indicates the state of the DirectSignal input signal.
13 ReverseSignal Indicates the state of the ReverseSignal input signal.
14 IncSPSignal Indicates the state of the IncSPSignal input signal.
15 DecSPSignal Indicates the state of the DecSPSignal input signal.

EIO0000002093 04/2020 427

SDDEVLP

Public Variables

Public Variable Description

Variable Type Description

SC SDDEVLP_SC_DDT Provides the common data needed for monitoring
and controlling the DFB.

SDDEVLP_SC_DDT Type

Name Type Description

LPMode BOOL Read-only access
Refer to the LPMode output pin (see page 423).
ZEROMode BOOL Read-only access
Refer to the ZEROMode output pin (see page 423).
CSMode BOOL Read-only access
Refer to the CSMode output pin (see page 423).
DisableLP BOOL Read/write access
1 = Disables the push buttons on the local panel. Only applicable
when a local panel without mode switch configuration is used
(MODESignalsEN = 0).

428 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Process Control
EIO0000002093 04/2020

Part V
Process Control

Process Control

Overview
This part provides a detailed description of the functions, pins, pin layout, and variables of the
function blocks of the process control family.
These function blocks do not reflect any specific installation.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000002093 04/2020 429

Process Control

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
40 ARAMP - RAMP 431
41 IMCTL - IMC Controller with Monitoring Interface 441
42 LDLGCTL - Lead/Lag Controller with Monitoring Interface 453
43 PIDCTL - PIDFF Regulator with Monitoring Interface 463
44 PIDMUX - Multiplexer for 2 Groups of PIDCTL Parameters 473
45 PWMCTL - Pulse Width Modulated Controller 481
46 RATIOCTL - Ratio Controller 489
47 SPLRGCTL - Split Range Controller 497
48 STEP3CTL - 3 Step Controller/Positioner 505

430 EIO0000002093 04/2020

 Modicon Libraries General Purpose
ARAMP
EIO0000002093 04/2020

Chapter 40
ARAMP - RAMP

ARAMP - RAMP

Overview
This chapter describes the ARAMP DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 432
DFB Representation 433
Inputs 434
Outputs 435
Inputs/Outputs 437
Public Variables 439

EIO0000002093 04/2020 431

ARAMP

Description

General
The ARAMP DFB is used to generate rising or falling set-point ramps for other control modules, such
as PID regulators, direct analog outputs, and so on.
The ARAMP DFB is based on and internally instantiates a standard ARAMP DFB from the Control
library.
The DFB provides tracking functions (for example, for set-points or measurements, as required),
temporary ramp shutdown due to maximum deviation, management of set-points from monitoring
and/or control, and so on.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Ramp The DFB allows to generate rising and/or falling ramps with different slopes as required.
Maximum Optionally, configure the DFB so that the ramp is held until the deviation between the
Deviation measurement and the set-point is less than the maximum deviation allowed.
Tracking While the ramp DFB is not in operation, the signal on one of its pins is tracked (normally
the pin connected to the measurement that needs to be controlled or to the last position of
the control element – for example, a control valve).
Owner The DFB manages control system level, which is the owner (Operator or Program).
Therefore, it is responsible for setting the ramp set-points.
Local/Remote If the Program is the owner, you can set the ramp set-point from continuous control (with
Set-point the input pin designated for this purpose) or from the sequence (with the SC public
variable).

432 EIO0000002093 04/2020

 ARAMP

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 433

ARAMP

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL 1 = When a rising edge is produced on this input, the signal
connected to the TRACKSP input pin is tracked.
HISP REAL High range of the set-point (SP) in engineering units.
Enables to set set-points to match this maximum value if it
exceeds this maximum value.
LOSP REAL Low range of the set-point (SP) in engineering units.
Enables to set set-points to match this minimum value if it falls
below it.
TRACKSP REAL Tracking set-point in engineering units that the DFB needs to
generate while the ramp is not in operation. Refer to the SP
output pin (see page 435).
RTARGETSP REAL Target set-point in engineering units to be applied in the
Program/Remote mode. Refer to the SP output pin
(see page 435).
PV REAL Current value of the measurement in engineering units. This
input is only used for the purpose of holding the ramp if the
measurement is excessively delayed in relation to the set-
point generated by the DFB itself (SP output). Refer to the
ARAMP_CFG.MAXDEV output pin (see page 437).
RSTART BOOL 1 = Run in the Program/Remote mode.
0 = Ramp Stop in the Program/Remote mode

434 EIO0000002093 04/2020

 ARAMP

Outputs

Output Parameter Description

Parameter Type Description

SP REAL Calculated value of the set-point. In any event, this value is limited
according to the range specified in the HISP and LOSP inputs.
The set-point calculation performed by the DFB is detailed in the
following table:
RUNNING SP
OFF TRACKSP
ON SP value is calculated based on the last value
generated depending on the slopes configured
(ARAMP_CFG.INCRATE and DECRATE) and the target
set-point. The ramp is held if distance between the PV
input and the SP is greater than the maximum
deviation allowed (you can deactivate this monitoring
by canceling the ARAMP_CFG.MAXDEV signal).

The following configuration data is considered according to the operating mode selected:
ARAMP_ST.CFGW.OWNER SC.REM TARGET SET-POINT and
RUN COMMAND
OFF (Program) OFF (Local) SC.LTARGETSP and SC.LSTART
OFF ON (Remote/Cascade - RTARGETSP and RSTART
applicable while the
Program is the OWNER)
ON (Operator) - ARAMP_CFG.LTARGETSP and
ARAMP_ST.CFGW.LSTART

EIO0000002093 04/2020 435

ARAMP

RUNNING BOOL 1 = Indicates that the ramp is active. This signal responds to the xSTART command
depending on the operating mode that is running.
The RUNNING signal calculation based on the DFB operating mode is detailed in
the following table:
OWNER REM RUNNING
OFF OFF SC.LSTART
OFF ON RSTART
ON - ARAMP_CFG .CFGW.LSTART
HELD BOOL 1 = Indicates that the ramp is held. The ramp is held if a maximum deviation greater
than 0.0 (ARAMP_CFG.MAXDEV) has been configured and the distance between
the set-point (SP) and the measurement (PV) is greater than this deviation. While
this signal is active, the set-point is maintained at its last value and the ramp does
not go on.
The calculation of the HELD signal based on the DFB operating mode is detailed in
the following table:
ARAMP_CFG.MAXDEV RUNNING HELD
- OFF OFF
0.0 - OFF
>0.0 ON Distance between PV and SP greater
than ARAMP_CFG.MAXDEV
DONE BOOL 1 = Indicates that the set-point (SP output) has reached the set target. The module
stays active even if this signal is activated so that if the target set-point is modified,
the necessary ramp (rising or falling) is generated in order to reach it.
The DONE signal calculation based on the DFB operating mode is detailed in the
following table:
RUNNING DONE
OFF OFF
ON PV = RTARGETSP
STATUS WORD Status word generated by the standard Control RAMP DFB instantiated within the
ARAMP DFB. Refer Control Help for more details.

436 EIO0000002093 04/2020

 ARAMP

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

ARAMP_ST ARAMP_ST_DDT Provides the data necessary to monitor and/or control the DFB status.
ARAMP_CFG ARAMP_CFG_DDT Provides the data necessary to configure the DFB (Usually from the
monitoring subsystem).

ARAMP_ST_DDT Type
The following table describes the ARAMP_ST_DDT type:

Name Type Description

STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory. Read-only
access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read/write access to the data contained in this word.
SP REAL Current set-point generated by the DFB. Refer to the SP output pin
(see page 435).

The following table describes the ARAMP_ST.STW word:

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 439).
1 HELD Refer to the HELD output pin (see page 435).
2 DONE Refer to the DONE output pin (see page 435).
3 RUNNING Refer to the RUNNING output pin (see page 435).

The following table describes the ARAMP_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point parameters of the ramp are set by the
Program (0) or by the Operator (1).
1 LSTART Read/write access
Enables the ramp to be activated (1) or de-activated (0). This signal is loaded with the
current DFB activation value if the Program is the DFB owner.

EIO0000002093 04/2020 437

ARAMP

ARAMP_CFG_DDT Type

Name Type Description

LTARGETSP REAL Read/write access
This variable indicates what the target set-point is and is calculated internally in the
DFB as long as the Operator is not the owner. In which case, you can modify it from
the monitoring subsystem.
INCRATE REAL Read/write access
This variable indicates the rising slope that has been configured. User can modify
this variable from the monitoring subsystem.
DECRATE REAL Read/write access
This variable indicates the falling slope that has been configured. User can modify
this variable from the monitoring subsystem.
MAXDEV REAL Read/write access
This variable indicates the maximum deviation allowed between measurement
(PV) and set-point (SP). If it is 0, this monitoring is canceled. You can modify it from
the monitoring subsystem.

438 EIO0000002093 04/2020

 ARAMP

Public Variables

Public Variable Description

Variable Type Description

SC ARAMP_SC_DDT Provides the frequently needed data to monitor and
control the DFB status from the sequential control.

ARAMP_SC_DDT Type

Name Type Description

LTARGETSP REAL Read/write access
Enables to assign the local target set-point for the sequential control if
the Program is the owner (OWNER input/output = OFF) and the selected
set-point is the Local one (SC.REM public variable = OFF). Otherwise,
the current target set-point is continuously copied to this variable.
SP REAL Read-only access. Refer to the SP output pin (see page 435).
LSTART BOOL Read/write access
1 = Allows the ramp to be activated if the Program is the owner (OWNER
input/output is 0) and the selected set-point is the Local one (public
variable SC.REM is 0). Otherwise, the current activation command is
continuously copied to this variable.
OWNER BOOL Read-only access
Refer to the ARAMP_ST.CFGW.OWNER input/output pin
(see page 437).
REM BOOL Read/write access
1 = Allows the DFB to be configured to remote set-point RSP.
0 = Allows the DFB to be configured to local set-point LSP. Only
applicable if the Program is the owner.
RUNNING BOOL Read-only access
Refer to the RUNNING output pin (see page 435).
HELD BOOL Read-only access
Refer to the HELD output pin (see page 435).
DONE BOOL Read-only access
Refer to the DONE output pin (see page 435).

EIO0000002093 04/2020 439

ARAMP

440 EIO0000002093 04/2020

 Modicon Libraries General Purpose
IMCTL
EIO0000002093 04/2020

Chapter 41
IMCTL - IMC Controller with Monitoring Interface

IMCTL - IMC Controller with Monitoring Interface

Overview
This chapter describes the IMCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 442
DFB Representation 443
Inputs 444
Outputs 446
Inputs/Outputs 447
Public Variables 450

EIO0000002093 04/2020 441

IMCTL

Description

General
The IMCTL DFB is used to condition the signals associated with the control of a standard Control
library IMC controller (Internal Model Controller). This helps to monitor and control the controller
easily from the monitoring subsystem and to provide the operating modes used in the rest of the
General Purpose library process function blocks.
The IMC internal model controller is specifically designed to control processes with pure delays as
well as non-linear processes.

Function Description
The main functions of the DFB are described in the following table:

Function Description
IMC The DFB includes and incorporates functions provided by the IMC controller from the
standard CONT_CTL library. You can directly configure the IMC controller functions that
have not been shown through the DFB interface by accessing the DFB configuration
parameters (for example, FeedForward, variable gain, and so on). Refer to the Control
Help for more details.
Owner The DFB manages the control system level, which is the owner (Operator or Program).
As a result, it is responsible for setting the set-point to the target position (in the Auto mode
of the IMC controller ) or the manual output (in the Manual mode of the IMC controller).
Interlocking The DFB enables to move to the defined position if an active interlock that requires this
move is detected. An interlock bypass function is available.
Set-point The DFB enables to work under a remote (usually set from the continuous control) or local
(set from the program or by the operator depending on the active owner) set-point.
Override You can combine several IMCTL or other DFBs to control one single control module. This
way, the DFB that is not controlling this DFB at a certain point of time works with an
external output, that is, calculating the new output based on the position of control module
instead of the last position calculated by the DFB itself.
These functions are internally provided by the standard IMC controller.

442 EIO0000002093 04/2020

 IMCTL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 443

IMCTL

Inputs

Input Parameter Description

Parameter Type Description

IMCEN BOOL 1 = Enables the internal IMC DFB.
The standard Control library IMC DFB needs to be periodically executed by
having its EN input enabled. This input is internally connected to the IMCEN input
belonging to the IMCTL DFB. Normally, this input is connected to a DFB that
defines the execution frequency (for example, SAMPLETM). The frequency with
which this input is activated should match the value that is configured on the
Para.T_ECH input/output (time in seconds).
PV REAL Current value of the measurement in engineering units.
FF REAL Value of the variable that disrupts the behavior of the measurement. This input is
internally connected to the FF input of the IMC controller. Refer to the
PARA.ff_inf, PARA.ff_sup, PARA.otff_inf, and PARA.otff_sup
parameters of the IMC controller. These values are initialized to zero by default.
RCPY REAL Value of the current (actual) status of the output. You can use this input to feed
back the occurring output if multiple controllers controlling a single output
(OVRIDE). This input is internally connected to the RCPY input of the IMC
controller. Refer to the PARA.EN_RCPY input.
HIPV REAL Upper value of the measurement range. Used for limiting the maximum set-point
admitted by the controller. This input is internally connected to the PARA.PV_SUP
parameter of the IMC controller (therefore, this parameter cannot be set from
outside the IMCTL DFB because it would be overwritten).
LOPV REAL Lower value of the measurement range. Used for limiting the minimum set-point
admitted by the controller. This input is internally connected to the PARA.PV_INF
parameter of the IMC controller (therefore, this parameter cannot be set from
outside the IMCTL DFB because it would be overwritten).
HIOP REAL Upper value of the output range. Used for limiting the maximum output generated
by the controller. This input is internally connected to the PARA.OUT_SUP
parameter of the IMC controller (therefore, this parameter cannot be set from
outside the IMCTL DFB because it would be overwritten).
LOOP REAL Lower value of the output range. Used for limiting the minimum output generated
by the controller. This input is internally connected to the PARA.OUT_INF
parameter of the IMC controller (therefore, this parameter cannot be set from
outside the IMCTL DFB because it would be overwritten).
RSP REAL Remote set-point. Normally set by the continuous control, for example, by a PID
controller output. Operates in Program/Casc mode (Automatic + Remote). Refer
to the SC.REM public variable (see page 450).
ILCKOP REAL Output needs to be used when the DFB is interlocked. Refer to the ILCK input.

444 EIO0000002093 04/2020

 IMCTL

Parameter Type Description

ILCK BOOL 1 = Interlocks the controller at a defined position with the ILCKOP input. Internally,
the IMC controller is set to Tracking mode.
BUFFER Array This table of real values enables to store the measurement value for the IMC
[0..n] of controller so that they can be delayed. The programmer needs to set the size of
REAL the table of real values that is connected to this input in such a way that the table
can store the necessary data during the pure delay time of the configured process
(refer to the IMCTL_CFG.T_DELAY input/output pin (see page 447)). This way
and depending on the configured sampling time (refer to the PARA.T_ECH
input/output), it will be possible to store a sample every T_ECH seconds, a sample
every 2xT_ECH seconds, and so on. Refer to the Control Help for more details.

EIO0000002093 04/2020 445

IMCTL

Outputs

Output Parameter Description

Parameter Type Description

OUTD REAL Differential output generated from the OUTD output of the IMC controller.
DMO REAL Output including delay generated from the DMO output of the IMC
controller.
MA_O BOOL 1 = Current operating mode generated based on the MA_O output of the
IMC controller. Refer to IMC controller for more details.
INFO Info_IMC Variables output by the IMC controller on the INFO output. Refer to the
IMC controller for more details.
STATUS WORD Statuses output by the IMC controller on the STATUS output. Refer to the
IMC controller for more details.
SP REAL Current set-point that is being considered by the IMC algorithm.
You can modify the set-point directly from the monitoring subsystem while
this mode is active.

The set-point calculation that the DFB performs based on the signal status is detailed in the
following table:

OWNER (OFF: Program; REM SP is calculated as:

ON: Operator
OFF OFF SC.LSP
OFF ON RSP
ON - IMCTL_ST.SP
You can modify the set-point directly from the monitoring
subsystem while this mode is active.

446 EIO0000002093 04/2020

 IMCTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

IMCTL_CFG IMCTL_CFG_DDT Provides the data needed to configure the DFB normally from the
monitoring subsystem or the sequential control.
IMCTL_ST IMCTL_ST_DDT Provides the data needed to monitor and/or control the DFB status.
PARA PARA_IMC Configuration data structure of the IMC controller within the IMCTL
DFB. Refer standard IMCTL DFB in the Control documentation for
more details.
OUT REAL Output signal of the controller. Refer standard IMCTL DFB in the
Control documentation for more details.

IMCTL_CFG_DDT Type

Name Type Description

OPHILIM REAL Enables to define the maximum value of the output for the automatic operation
of the controller. This input is internally connected to the PARA.OUT_MAX
parameter of the IMC controller (therefore, the parameter cannot be set from
outside the IMCTL DFB because it would be overwritten).
OPLOLIM REAL Enables to define the minimum value of the output for the automatic operation
of the controller. This input is internally connected to the PARA.OUT_MIN
parameter of the IMC controller (therefore, the parameter cannot be set from
outside the IMCTL DFB because it would be overwritten).
KS REAL Enables to set the proportional gain parameter of the controller. This input is
internally connected to the PARA.KP parameter of the IMC controller (therefore,
the parameter cannot be set from outside the IMCTL DFB because it would be
overwritten).
OL_TIME REAL Enables to define the time constant for the open-loop process. This input is
internally connected to the PARA.OL_TIME parameter of the IMC controller
(therefore, this parameter cannot be set from outside the IMCTL DFB because
it would be overwritten).
CL_PERF REAL Enables to set the parameter defining the relationship between the natural time
constants of the open-loop/closed-loop process. This input is internally
connected to the PARA.C_PERF parameter of the IMC controller (therefore, this
parameter cannot be set from outside the IMCTL DFB because it would be
overwritten).
T_DELAY REAL Enables to set the pure delay parameter in seconds. This input is internally
connected to the PARA.T_DELAY parameter of the IMC controller (therefore,
this parameter cannot be set from outside the IMCTL DFB because it would be
overwritten).

EIO0000002093 04/2020 447

IMCTL

IMCTL_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory. Read-only
access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read/write access to the data contained in this word.
PV REAL Read access
Refer to the PV input (see page 444).
This variable indicates the current measurement.
SP REAL Read/write access
Refer to the SP output (see page 446).
This variable indicates the current set-point and is calculated internally
in the DFB as long as the owner is not the Operator. In this case, you
can modify it from the monitoring subsystem.
OP REAL Read/write access
This variable indicates the current output and is calculated internally in
the DFB as long as the owner is not the Operator. In this case, you can
modify it from the monitoring subsystem.

IMCTL_ST.STW Word Structure

DFB status word. Read-only access. The following table describes the IMCTL_ST.STW Word
structure.

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 450).
2 ILCK Refer to the ILCK input pin (see page 444).
3 OVRIDE Enables to determine if the DFB is operating with external output (1 – Override) or not
(0 – Normal). Refer to the PARA.EN_RCPY input.

448 EIO0000002093 04/2020

 IMCTL

IMCTL_ST.CFGW Word Structure

DFB configuration word. Read/write access. The following table describes the IMCTL_ST.CFGW
Word structure

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0)
or the Operator (1).
1 ILCKBP Read/write access
Allows the interlock to be bypassed (1).
2 MODE Read/write access
Reports the Operating mode of the IMC controller if the owner is the
Program, and enables the Operating mode to be configured if the
owner is the Operator. 1 corresponds to Auto and 0 to Manual.
3 ACTION Read/write access
Enables you to configure the action of the IMC controller. 0
corresponds to Reverse and 1 to Forward. The DFB automatically
assigns the value of this signal to the PARA.rev_dir signal of the
IMC controller.

EIO0000002093 04/2020 449

IMCTL

Public Variables

Public Variable Description

Variable Type Description

SC IMCTL_SC_DDT Provides the frequently needed data to monitor and
control the controller status from the sequential control.

IMCTL_SC_DDT Type

Name Type Description

LSP REAL Read/write access
Enables the sequential control to assign the local set-point if the owner is
the Program (OWNER is 0), the selected mode is Auto, and the selected
set-point is Local (SC.REM is 0). Otherwise, the current set-point (SP
output) is continuously copied to this variable.
LOP REAL Read/write access. Enables the sequential control to assign the local
output if the owner is the Program (OWNER is 0) and the mode is Manual.
Otherwise, the current output (OP output) is continuously copied to this
variable.
PV REAL Read-only access
Refer to the PV input pin (see page 444).
OWNER BOOL Read-only access
Refer to the IMCTL_ST.CFGW.OWNER input/output pin (see page 447).
MAN BOOL Write access
1 = Allows the controller to switch to Manual mode if the owner is the
Program.
0 = The DFB automatically sets the signal to 0 after processing the signal.
AUTO BOOL Write access
1 = Allows the controller to switch to Auto mode if the owner is the
Program.
1 = The DFB automatically sets the signal to 0 after processing the signal.
MODE BOOL Read-only access
1 = Auto
0 = Manual
Refer to the IMCTL_ST.CFGW.MODE input/output pin (see page 447).
REM BOOL Read-only access
1 = Allows the DFB to be configured for a remote set-point -RSP, if the
owner is the Program and the mode is Auto.
0 = Allows the DFB to be configured for a local set-point -LSP,if the owner
is the Program and the mode is Auto.

450 EIO0000002093 04/2020

 IMCTL

Name Type Description

ILCKD BOOL Read-only access
The signal evaluation depending on the ILCK input and the
IMCTL_ST.STW.ILCKBP input/output is shown in the following table:
ILCK ILCKBP SC.ILCKD is calculated as:
OFF - OFF
ON OFF ON
ON ON OFF

EIO0000002093 04/2020 451

IMCTL

452 EIO0000002093 04/2020

 Modicon Libraries General Purpose
LDLGCTL
EIO0000002093 04/2020

Chapter 42
LDLGCTL - Lead/Lag Controller with Monitoring Interface

LDLGCTL - Lead/Lag Controller with Monitoring Interface

Overview
This chapter describes the LDLGCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 454
DFB Representation 455
Inputs 456
Outputs 457
Inputs/Outputs 458
Public Variables 460

EIO0000002093 04/2020 453

LDLGCTL

Description

General
The LDLGCTL DFB is used to condition the signals associated to the control of a LEAD-LAG
controller. This DFB helps to monitor and control the controller easily from the monitoring
subsystem and to provide the operating modes used in the rest of the General Purpose library
process function blocks.

Function Description
The main functions of the DFB are described in the following table:

Function Description
LEAD-LAG The DFB includes and incorporates functions provided by the LEAD-
LAG controller from the standard CONT_CTL Control library.
Owner The DFB manages control system level, which is the owner
(Operator or Program). As a result, it is responsible for setting the set-
point to the desired position (in the Auto mode of the LEAD-LAG
controller) or the manual output (in the Manual mode of the LEAD-
LAG controller).
Interlocking The DFB enables to move to the defined position if an active interlock
that requires this move is detected. An interlock bypass function is
available.
Set-point The DFB enables you to work under a remote (usually set from the
continuous control) or local (set from the program or by the operator
depending on the active owner) set-point.

454 EIO0000002093 04/2020

 LDLGCTL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 455

LDLGCTL

Inputs

Input Parameter Description

Parameter Type Description

HISP REAL Upper value of the set-point range. Used to limit the maximum
value of the set-point admitted by the controller.
LOSP REAL Lower value of the set-point range. Used to limit the minimum value
of the set-point admitted by the controller.
HIOP REAL Upper value of the output range. Used to limit the maximum value
of the output admitted by the controller.
LOOP REAL Lower value of the output range. Used to limit the minimum value
of the output admitted by the controller.
RSP REAL Remote set-point normally set by the continuous control, for
example, by a PID controller output. Operates in Program/Casc
mode (Automatic + Remote). Refer to the SC.REM public variable
(see page 460).
ILCKOP REAL Output needs to be considered when the DFB is interlocked. Refer
to the ILCK input.
ILCK BOOL 1 = Interlocks the controller at a defined position with the ILCKOP
input. Internally, the LEAD-LAG controller is set to Tracking mode.

456 EIO0000002093 04/2020

 LDLGCTL

Outputs

Output Parameter Description

Parameter Type Description

SP REAL Current set-point that is being used by the LEADLAG DFB.
The set-point calculation that the DFB performs based on the signal
status is detailed in the following table:
OWNER (OFF: Program; REM SP is calculated as:
ON: Operator)
OFF OFF SC.LSP
OFF ON RSP
ON - LDLGCTL_ST.SP
You can modify the set-point
directly from the monitoring
subsystem while this mode is
active.
OP REAL Output calculated in engineering units by the DFB.
OUT REAL Output calculated by the DFB. Refer to the LEADLAG controller for more
details.

EIO0000002093 04/2020 457

LDLGCTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

LDLGCTL_CFG LDLGCTL_CFG_DDT Provides the data needed to configure the DFB
normally from the monitoring subsystem or the
sequential control.
LDLGCTL_ST LDLGCTL_ST_DDT Provides the data needed to monitor and/or
control the DFB status.

LDLGCTL_CFG_DDT Type

Name Type Description

GAIN REAL Enables to set the proportional gain parameter of the
controller.
LEAD TIME Enables to set the derivative time parameter of the
controller.
LAG TIME Enables to set the delay time parameter of the controller.

LDLGCTL_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory.
Read-only access to the data contained in this word.
CFGW WORD Provides the means to control the device from the
monitoring subsystem. Read/write access to the data
contained in this word.
SP REAL Read/write access
Refer to the SP output pin (see page 457).
This variable indicates the current setpoint and is calculated
internally in the DFB as long as the owner is not the
Operator. In this case, you can modify it from the monitoring
subsystem.
OP REAL Read/write access
Refer to the OP output pin (see page 457).
This variable indicates the current output and is calculated
internally in the DFB as long as the owner is not the
Operator. In this case, you can modify it from the monitoring
subsystem.

458 EIO0000002093 04/2020

 LDLGCTL

LDLGCTL_ST.STW Word Structure

DFB status word. Read-only access. The following table describes the LDLGCTL_ST.STW Word
structure:

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 460).
2 ILCK Refer to the ILCK input pin (see page 456).

LDLGCTL_ST.CFGW Word Structure

DFB configuration word. Read/write access. The following table describes the LDLGCTL_ST.CFGW
Word structure

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set point is set by the Program (0) or
the Operator (1).
1 ILCKBP Read/write access
Allows the interlock to be bypassed (1).
2 MODE Read/write access
Reports the operating mode of the LEAD-LAG controller if the owner
is the Program and enables to configure the operating mode if the
owner is the Operator. 1 corresponds to Auto and 0 corresponds to
Manual.

EIO0000002093 04/2020 459

LDLGCTL

Public Variables

Public Variable Description

Variable Type Description

SC LDLGCTL_SC_DDT Provides the frequently needed data to monitor and
control the controller status from the sequential
control.

LDLGCTL_SC_DDT Type

Name Type Description

LSP REAL Read/write access
Enables to assign the local set-point for the sequential
control if the owner is the Program (OWNER is 0), the
selected mode is Auto, and the selected set-point is
Local (SC.REM is 0). Otherwise, the current set-point
(SP output) is continuously copied to this variable.
LOP REAL Read/write access
Enables to assign the local output for the sequential
control if the owner is the Program (OWNER is 0) and
the mode is Manual. Otherwise, the current output (OP
output) is continuously copied to this variable.
OWNER BOOL Read-only access
Refer to the LDLGCTL_ST.CFGW.OWNER input/output
pin (see page 458).
MAN BOOL Write access.
1 = Allows to switch the controller to Manual mode if
the owner is the Program. The DFB automatically sets
the signal to 0 after processing the signal.
AUTO BOOL Write access
1 = Allows to switch the controller to Auto mode if the
owner is the Program. The DFB automatically sets the
signal to 0 after processing the signal.
MODE BOOL Read-only access
1 = Auto
0 = Manual
Refer to the LDLGCTL_ST.CFGW.MODE input/output
pin (see page 458).

460 EIO0000002093 04/2020

 LDLGCTL

Name Type Description

REM BOOL Read-only access
1 = Allows the DFB to be configured for a remote set-
point -RSP if the owner is the Program and the mode is
Auto.
0 = Allows the DFB to be configured for a local set-
point -LSP if the owner is the Program and the mode is
Auto.
ILCKD BOOL Read-only access
The signal evaluation depending on the ILCK input
and the LDLGCTL_ST.STW.ILCKBP input/output is
shown in the following table:
ILCK ILCKBP SC.ILCKD is calculated as:
OFF - OFF
ON OFF ON
ON ON OFF

EIO0000002093 04/2020 461

LDLGCTL

462 EIO0000002093 04/2020

 Modicon Libraries General Purpose
PIDCTL
EIO0000002093 04/2020

Chapter 43
PIDCTL - PIDFF Regulator with Monitoring Interface

PIDCTL - PIDFF Regulator with Monitoring Interface

Overview
This chapter describes the PIDCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 464
DFB Representation 465
Inputs 466
Outputs 467
Inputs/Outputs 468
Public Variables 471

EIO0000002093 04/2020 463

PIDCTL

Description

General
The PIDCTL DFB is used to condition the signals associated with the control of a PIDFF-type
controller. This DFB helps to monitor and control the controller easily from the monitoring
subsystem and to provide the operating modes used in the rest of the General Purpose library
process function blocks.

Function Description
The main functions of the DFB are described in the following table:

Function Description
PIDFF The DFB includes and incorporates functions provided by the PIDFF controller from the
standard CONTR_CTL library. You can directly configure the PIDFF controller functions that
have not been shown through the DFB interface by accessing its configuration parameters
(for example, FeedForward, variable gain, and so on).
Owner The DFB manages control system level, which is the owner (Operator or Program). As a
result, it is responsible for setting the set-point to the desired position (in the Auto mode of
the PID controller) or the manual output (in the Manual mode of the PID controller).
Interlocking The DFB enables to move to the defined position if an active interlock that requires this
move is detected. An interlock bypass function is available.
Set-point The DFB enables to work under a remote (usually set from the continuous control) or local
(set from the program or by the operator depending on the active owner) set-point.
Override You can combine several PIDCTL or other DFBs to control one single control module. This
way, the DFB that is not controlling this DFB at a certain point in time works with an external
output, that is, calculating the new output based on the position of control module instead of
the last position calculated by the DFB itself.
These functionalities are internally provided by the standard PIDFF controller.

464 EIO0000002093 04/2020

 PIDCTL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 465

PIDCTL

Inputs

Input Parameter Description

Parameter Type Description

PV REAL Current value of the measurement in engineering units.
FF REAL Value of the variable that disrupts the behavior of the measurement. This input is
internally connected to the FF input of the PIDFF controller. By default, a disruption
value does not have any repercussion on the output. Refer to the PARA.ff_inf,
PARA.ff_sup, PARA.otff_inf, and PARA.otff_sup parameters of a PIDFF
controller. These values are initialized to zero by default.
RCPY REAL Value of the output current (actual) status. You can use this input to feed back the
output in case of multiple controllers working against the same output (Override).
This input is internally connected to the RCPY input of the PIDFF controller. Refer
to the PARA.EN_RCPY input.
HIPV REAL Upper value of the measurement range. Used for limiting the maximum set-point
admitted by the controller. This input is internally connected to the PARA.PV_SUP
parameter of the PIDFF controller (therefore, you cannot set this parameter from
outside the PIDCTL DFB because it would be overwritten).
LOPV REAL Lower value of the measurement range. Used for limiting the minimum set-point
admitted by the controller. This input is internally connected to the PARA.PV_INF
parameter of the PIDFF controller (therefore, you cannot set this parameter from
outside the PIDCTL DFB because it would be overwritten).
HIOP REAL Upper value of the output range. Used for limiting the maximum output generated
by the controller. This input is internally connected to the PARA.OUT_SUP
parameter of the PIDFF controller (therefore, you cannot set this parameter from
outside the PIDCTL DFB because it would be overwritten).
LOOP REAL Lower value of the output range. Used for limiting the minimum output generated
by the controller. This input is internally connected to the PARA.OUT_INF
parameter of the PIDFF controller (therefore, you cannot set this parameter from
outside the PIDCTL DFB because it would be overwritten).
RSP REAL Remote set-point. Usually set by the continuous control; for example, by a PID
controller output. Operates in Program/Casc mode (Automatic + Remote). Refer to
the SC.REM public variable (see page 471).
ILCKOP REAL Use this output when the DFB is interlocked. Refer to the ILCK input.
ILCK BOOL 1 = Interlocks the controller at a defined position with the ILCKOP input. Internally,
the PIDFF controller is set to Tracking mode.

466 EIO0000002093 04/2020

 PIDCTL

Outputs

Output Parameter Description

Parameter Type Description

OUTD REAL Differential output. Is generated based on the OUTD output
of the PIDFF controller.
MA_O BOOL 1 = Current operating mode. Is generated based on the
MA_O output of the PIDFF controller. Refer to PIDFF
controller for more details.
INFO Info_PIDFF Variables output by the PIDFF controller on the INFO
output. Refer to the PIDFF controller for more details.
STATUS WORD Statuses output by the PIDFF controller on the STATUS
output. Refer to the PIDFF controller for more details.
SP REAL Current set-point that is being considered by the PID
algorithm.

The set-point calculation that the DFB performs based on the signal status is detailed in the
following table:

OWNER (OFF: Program; REM SP is calculated as:

ON: Operator
OFF OFF SC.LSP
OFF ON RSP
ON - PIDCTL_ST.SP
You can modify the set-point directly from the monitoring
subsystem while this mode is active.

EIO0000002093 04/2020 467

PIDCTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

PIDCTL_CFG PIDCTL_CFG_DDT Provides the data necessary to configure the DFB from the monitoring
subsystem or the sequential control.
PIDCTL_ST PIDCTL_ST_DDT Provides the data necessary to monitor and/or control the DFB status.
PARA PARA_PIDFF Data structure of the PIDFF controller configuration within the PIDCTL
DFB. Refer standard PIDFF DFB in the Control documentation for
more details.
OUT REAL Output signal of the controller. Refer standard PIDFF DFB in the
Control documentation for more details.

PIDCTL_CFG_DDT Type

Name Type Description

OPHILIM REAL Enables to define the maximum value of the output for the Automatic operation of the
controller. This input is internally connected to the PARA.OUT_MAX parameter of the
PIDFF controller (therefore, you cannot set the parameter from outside the PIDCTL
DFB because it would be overwritten).
OPLOLIM REAL Enables to define the minimum value of the output for the Automatic operation of the
controller. This input is internally connected to the PARA.OUT_MIN parameter of the
PIDFF controller (therefore, you cannot set the parameter from outside the PIDCTL
DFB because it would be overwritten).
GAIN REAL Enables to set the proportional gain parameter of the controller. This input is internally
connected to the PARA.KP parameter of the PIDFF controller (therefore, you cannot
the parameter from outside the PIDCTL DFB because it would be overwritten).
TI TIME Enables to set the integral time parameter of the controller. This input is internally
connected to the PARA.TI parameter of the PIDFF controller (therefore, you cannot
set the parameter from outside the PIDCTL DFB because it would be overwritten).
TD TIME Enables to set the derivative time parameter of the controller. This input is internally
connected to the PARA.TD parameter of the PIDFF controller (therefore, you cannot
set the parameter from outside the PIDCTL DFB because it would be overwritten).
KD REAL Enables to set the derivative gain parameter of the controller. This input is internally
connected to the PARA.KD parameter of the PIDFF controller (therefore, you cannot
set the parameter from outside the PIDCTL DFB because it would be overwritten).

468 EIO0000002093 04/2020

 PIDCTL

PIDCTL_ST_DDT Type

Name Type Description

PV REAL Read access
Refer to the PV input pin (see page 466).
This variable indicates what the current measurement is.
SP REAL Read/write access
Refer to the SP output pin (see page 467).
This variable indicates what the current set-point is, and is calculated
internally in the DFB as long as the owner is not the Operator. In
which case, you can modify it from the monitoring subsystem.
OP REAL Read/write access
Refer to the OUT input/output.
This variable indicates what the current set-point is, and is calculated
internally in the DFB as long as the owner is not the Operator. In
which case, you can modify it from the monitoring subsystem.
STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory. Read-only
access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read/write access to the data contained in this word.

PIDCTL_ST.STW Word Structure

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 471).
2 ILCK Refer to the ILCK input pin (see page 466).
3 OVRIDE Determines whether the DFB is operating with external output (1 –
Override) or not (0 – Normal). Refer to the PARA.EN_RCPY input.

EIO0000002093 04/2020 469

PIDCTL

PIDCTL_ST.CFGW Word Structure

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or
the Operator (1).
1 ILCKBP Read/write access
Enables the interlocking to be bypassed (1).
2 MODE Read/write access
Reports the operating mode of the PIDFF controller if the owner is the
Program, and enables the operating mode to be configured if the
owner is the Operator. 1 corresponds to AUTO and 0 to MANUAL.
3 ACTION Read/write access
Enables the PIFF controller action to be configured. 0 corresponds to
reverse and 1 to forward. The DFB automatically assigns the value of
this signal to the PARA.rev_dir signal of the IMC controller .
4 PVDEV Read/write access
Enables to configure whether the derivative action applies only to the
development of the measurement (PV) or the detected error (PV-SP or
SP-PV depending on the configured action). 0 corresponds to
considering the measurement only, and 1 to the detected error. The
DFB automatically assigns the value of this signal to the
PARA.pv_dev signal of the PIDFF controller.
5 MIXPAR Read/write access
Enables to configure whether the PIDFF controller calculation formula
is mixed (proportional gain affects integral and derivative terms) or
parallel (the action only affects the proportional term). 0 corresponds
to mixed and 1 to parallel. The DFB automatically assigns the value of
this signal to the PARA.MIX_PAR signal of the PIDFF controller.

470 EIO0000002093 04/2020

 PIDCTL

Public Variables

Public Variable Description

Variable Type Description

SC PIDCTL_SC_DDT Provides the frequently needed data to monitor and control the regulator
status from the sequential control.

PIDCTL_SC_DDT Type

Name Type Description

LSP REAL Read/write access
Enables to assign the local set-point for the sequential control if the owner is the
Program (OWNER is 0), the selected mode is AUTO, and the selected set-point is Local
(SC.REM is 0). Otherwise, the current set-point (SP output) is continuously copied to
this variable.
LOP REAL Read/write access
Enables to assign the local output for the sequential control if the owner is the Program
(OWNER is 0) and the mode is MANUAL. Otherwise, the current output (OP output) is
continuously copied to this variable.
PV REAL Read-only access
Refer to the PV input pin (see page 466).
OWNER BOOL Read-only access
Refer to the PV input/output pin (see page 468).
MAN BOOL Write access
1 = Allows the controller to be changed to Manual mode if the owner is the Program.
The DFB automatically sets the signal to 0 after processing the signal.
AUTO BOOL Write access
1 = Allows the controller to be switched to Auto mode (if the owner is the Program. The
DFB automatically sets the signal to 0 after processing the signal.
MODE BOOL Read-only access
1 = Auto
0 = Manual
Refer to the PIDCTL_ST.CFGW.MODE input/output pin (see page 468).

EIO0000002093 04/2020 471

PIDCTL

Name Type Description

REM BOOL Read/write access
1 = Allows the DFB to be configured for a remote set-point -RSP, if the owner is the
Program and the mode is Auto.
0 = Allows the DFB to be configured for a local set-point -LSP, if the owner is the
Program and the mode is Auto.
ILCKD BOOL Read-only access
The signal evaluation depending on the ILCK input and the
PIDCTL_ST.STW.ILCKBP input/output is shown in the following table.

ILCK ILCKBP SC.ILCKD is calculated as:

OFF - OFF
ON OFF ON
ON ON OFF

472 EIO0000002093 04/2020

 Modicon Libraries General Purpose
PIDMUX
EIO0000002093 04/2020

Chapter 44
PIDMUX - Multiplexer for 2 Groups of PIDCTL Parameters

PIDMUX - Multiplexer for 2 Groups of PIDCTL Parameters

Overview
This chapter describes the PIDMUX DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 474
DFB Representation 475
Inputs 476
Outputs 477
Inputs/Outputs 478
Public Variables 480

EIO0000002093 04/2020 473

PIDMUX

Description

General
The PIDMUX DFB is used to multiplex 2 different parameter configurations that affect a single PID
controller. This way, you can use one single PID controller with different configurations (for
example, split-range PID for cooling or heating).
You can monitor and control the DFB from the monitoring subsystem.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Parameter Switching During a scan cycle, the DFB activates the RCPY signal. This enables you to use the
signal to set the PIDCTL controller so that it uses an external output during the
parameter configuration change. This way, the controller initializes its integral term
and any jumps when switching outputs are stopped.
Owner The DFB manages control system level, which is the owner (Operator or Program).
Therefore, it is responsible for setting the active parameter set.
Parameter Selection You can control the parameter selector remotely (normally set from the continuous
control) or locally (set from the program or by the operator depending on the active
owner).

474 EIO0000002093 04/2020

 PIDMUX

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 475

PIDMUX

Inputs

Input Parameter Description

Parameter Type Description

RSPSEL BOOL Remote set point for selecting the parameter set normally set by the continuous
control. Operates in Program /Casc mode (Automatic + Remote). Refer to the
SC.REM public variable (see page 480).
0 = Corresponds to select parameter configuration 1 (PIDMUX_CFG1)
1 = Corresponds to select parameter configuration 2 (PIDMUX_CFG2).

476 EIO0000002093 04/2020

 PIDMUX

Outputs

Output Parameter Description

Parameter Type Description

RCPYEN BOOL 1 = Activates output during a scan cycle when the parameter
configuration change is made. This output can be used to
override the PIDCTL controller (PIDCTL.RCPY input) for which
the parameter configuration change is being made. The
change takes place without any jumps occurring on the output.

EIO0000002093 04/2020 477

PIDMUX

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

PIDCTL_CFG PIDMUX_CFG_DDT The configuration data structure belonging to the PIDCTL module
(see page 478) for which the parameters need to be configured
(PIDCTL.PIDCTL_ST input/output) needs to be connected to this
input. Refer to the PIDCTL module in the PIDCTL module user
manual for more details.
PIDCTL_ST PIDCTL_ST_DDT The status data structure belonging to the PIDCTL module for which
(see page 469) the parameters need to be configured (PIDCTL.PIDCTL_ST
input/output) needs to be connected to this input. Refer to the
PIDCTL module in the PIDCTL module user manual for more
details.
PIDMUX_CFGx PIDMUX_CFG_DDT Provides the data needed to configure the configuration parameters
(see page 478) for the associated PIDCTL module. This data can be accessed from
the monitoring subsystem.
PIDMUX_ST PIDMUX_ST_DDT Provides the data needed to monitor and/or control the DFB status.
(see page 479)

PIDMUX_CFG_DDT Type

Name Type Description

CFGW WORD Configuration word belonging to the associated PIDCTL controller.
RESERVE WORD Reserved
OPHILIM REAL Enables to define the maximum value of the output for the Automatic
operating mode of the controller.
OPLOLIM REAL Enables to define the minimum value of the output for the Automatic
operating mode of the controller.
GAIN REAL Enables to set the proportional gain parameter of the controller.
TI TIME Enables to set the integral time parameter of the controller.
TD TIME Enables to set the derivative time parameter of the controller.
KD REAL Enables to set the derivative gain parameter of the controller.

478 EIO0000002093 04/2020

 PIDMUX

PIDMUX_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and
allows data to be kept in the memory. Read-only access to the data
contained in this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem.
Read/write access to the data contained in this word.

PIDMUX_ST.STW Word Structure

DFB status word. Read-only access. The following table describes the PIDMUX_ST.STW Word
structure.

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 480).

PIDMUX_ST.CFGW Word Structure

DFB configuration word. Read/write access. The following table describes the PIDMUX_ST.CFGW
Word structure.

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or by the
Operator (1).
1 LSPSEL Read/write access
This variable indicates which parameter configuration is selected (0: parameter
configuration 1; 1: parameter configuration 2) and is calculated internally in the DFB
as long as the Operator is not the owner. In this case, it can be modified from the
monitoring subsystem.

EIO0000002093 04/2020 479

PIDMUX

Public Variables

Public Variable Description

Variable Type Description

SC PIDMUX_SC_DDT Provides the frequently needed data to monitor and
control the module status from the sequential control.

PIDMUX_SC_DDT Type

Name Type Description

LSPSEL BOOL Read/write access
1 = Enables the sequential control to select the parameter configuration if the
owner is the Program/Local (OWNER and SC.REM set to 0).
0 = The current selection set-point (SP output) is continuously copied to this
variable.
OWNER BOOL 1 = Refer to the PIDMUX_ST.CFGW.OWNER input/output pin (see page 478).
Read-only access
REM BOOL Read/write access
1 = Enables to configure the DFB for remote parameter configuration selection
-RSP while the owner is the Program.
0 = Enables to configure the DFB for local parameter configuration selection -
LSP while the owner is the Program.

480 EIO0000002093 04/2020

 Modicon Libraries General Purpose
PWMCTL
EIO0000002093 04/2020

Chapter 45
PWMCTL - Pulse Width Modulated Controller

PWMCTL - Pulse Width Modulated Controller

Overview
This chapter describes the PWMCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 482
DFB Representation 483
Inputs 484
Outputs 485
Inputs/Outputs 486
Public Variables 488

EIO0000002093 04/2020 481

PWMCTL

Description

General
The PWMCTL DFB is used to condition the signals associated with pulse-width modulated (PWM)
control.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Owner The DFB manages the control system level, which is the owner
(operator or program). As a result, it is responsible for setting the
setpoint for the desired position.
Interlocking The DFB gives a position command to the device to move to the
defined position in case of an active interlock. An interlock bypass
function is available.
Set-point The DFB enables to work under a remote (normally set from the
continuous control) or local (set from the program or by the operator
depending on the active owner) set-point.

482 EIO0000002093 04/2020

 PWMCTL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 483

PWMCTL

Inputs

Input Parameter Description

Parameter Type Description

HISP REAL Scale limit (positive or negative) for the set-point range. Used to limit the
maximum value of the set-point admitted by the controller. The minimum absolute
value for the set-point is 0 just as implemented in the standard Control DFB.
Therefore, if HISP > 0, the set-point range is 0 - HISP . If HISP < 0, the set-point
range is HISP - 0.
Depending on the sign of this signal and the set-point (SP), either the output that
acts to increase or decrease the measurement will be activated. Refer to the
OPINC and OPDEC outputs.
RSP REAL Remote set-point
Usually set by the continuous control, for example, by a PID controller output.
Operates in Program/Casc mode (Automatic + Remote). Refer to the SC.REM
public variable (see page 488).
RSTART BOOL 1 = Enables the operation of the PWM DFB in Automatic mode as described in the
Control documentation. When it has a value of 0, it forces the OPINC and OPDEC
outputs to 0.
ILCK BOOL 1 = Interlocks and de-energizes the outputs OPINC and OPDEC.

484 EIO0000002093 04/2020

 PWMCTL

Outputs

Output Parameter Description

Parameter Type Description

OPINC BOOL 1 = Calculates output for positive set-points (SP > 0 ) by the controller.
OPDEC BOOL 1 = Calculates output for negative set-points (SP < 0 ) by the controller.
RUNNING BOOL 1 = Indicates the controller is active.
SP REAL Current set-point that is being considered by the controller.

The DFB performs the set-point calculation based on the signal status. The set-point calculation is
detailed in the following table:

OWNER (OFF: Program; REM SP is calculated as:

ON: Operator)
OFF OFF SC.LSP
OFF ON RSP
ON – PWMCTL_ST.SP
You can modify the set-point directly from the monitoring
subsystem while this mode is active.

EIO0000002093 04/2020 485

PWMCTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

PWMCTL_CFG PWMCTL_CFG_DDT Provides the data needed to configure the DFB
normally from the monitoring subsystem.
PWMCTL_ST PWMCTL_ST_DDT Provides the data needed to monitor and/or control
the DFB status.

PWMCTL_CFG_DDT Type

Name Type Description

TPERIOD TIME Enables you to set the period for the output signal.
TMIN TIME Enables you to set the minimum pulse time (ON or OFF).

PWMCTL_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory.
Read-only access to the data contained in this word.
CFGW WORD Provides the means to control the device from the
monitoring subsystem. Read/write access to the data
contained in this word.
SP REAL Read/write access
Refer to the SP output pin (see page 485).
This variable indicates the current set-point and is
calculated internally in the DFB as long as the owner is not
the Operator. In this case, you can modify it from the
monitoring subsystem.

PWMCTL_ST.STW Word Structure

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 488).
2 ILCK Refer to the ILCK input pin (see page 484).
3 OPINC Refer to the OPINC output pin (see page 485).
4 OPDEC Refer to the OPDEC output pin (see page 485).

486 EIO0000002093 04/2020

 PWMCTL

PWMCTL_ST.CFGW Word Structure

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or
the Operator (1).
1 ILCKBP Read/write access
Allows the interlock to be bypassed (1).
2 START Read/write access
Reports whether or not the controller is in operation if the owner is the
Program and enables to activate/deactivate the controller if the owner
is the Operator. 1 corresponds to activating and 0 to deactivating.

EIO0000002093 04/2020 487

PWMCTL

Public Variables

Public Variable Description

Variable Type Description

SC PWMCTL_SC_DDT Provides the frequently needed data to monitor and
control the controller status from the sequential control.

PWMCTL_SC_DDT Type

Name Type Description

LSP REAL Read/write access
Enables the sequential control to assign the local set-point if the owner
is the Program (OWNER is 0), the selected mode is Auto, and the
selected set-point is Local (SC.REM is 0). Otherwise, the current set-
point (SP output) is continuously copied to this variable.
LSTART BOOL Read/write access
1 = Enables the sequential control to activate/deactivate the controller
if the owner is the Program (OWNER is 0) and the mode is Manual.
Otherwise, the current input (RSTART output) is continuously copied to
this variable.
OWNER BOOL Read-only access
Refer to the PWMCTL_ST.CFGW.OWNER input/output pin
(see page 486).
REM BOOL Read-only access
1 = Allows the DFB to be configured for a remote set-point -RSP, if the
owner is the Program and the mode is Auto.
0 = Allows the DFB to be configured for local set-point -LSP, if the
owner is the Program and the mode is Auto.
ILCKD BOOL Read-only access
The signal evaluation depending on the ILCK input and the
PWMCTL_ST.STW.ILCKBP input/output is shown in the following
table:
ILCK ILCKBP SC.ILCKD is calculated as:
OFF - OFF
ON OFF ON
ON ON OFF

488 EIO0000002093 04/2020

 Modicon Libraries General Purpose
RATIOCTL
EIO0000002093 04/2020

Chapter 46
RATIOCTL - Ratio Controller

RATIOCTL - Ratio Controller

Overview
This chapter describes the RATIOCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 490
DFB Representation 491
Inputs 492
Outputs 493
Inputs/Outputs 494
Public Variables 496

EIO0000002093 04/2020 489

RATIOCTL

Description

General
The RATIOCTL DFB is used to condition the signals associated to a standard Control library
RATIO controller. This helps to monitor and control the controller from the monitoring subsystem
and to provide the operating modes used in the rest of the General Purpose library process
function blocks.
The RATIO controller sets a set-point based on a measurement signal and the ratio that needs to
be maintained between them (that is, between the measurement signal and the set-point). This
DFB is especially used for dosing materials that should have a certain ratio in relation to one
another.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Ratio The DFB includes and incorporates functions provided by the RATIO
controller from the standard CONT_CTL Control library.
Owner The DFB manages the control system level, which is the owner (operator
or program). As a result, it is responsible for setting the setpoint for the
desired position.
Interlocking The DFB gives a position command to the device to move to the defined
position in case of an active interlock. An interlock bypass function is
available.
Set-point The DFB enables to work under a remote (normally set from the
continuous control) or local (set from the program or by the operator
depending on the active owner) set-point.

490 EIO0000002093 04/2020

 RATIOCTL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 491

RATIOCTL

Inputs

Input Parameter Description

Parameter Type Description

PV REAL Current value of the variable that is being controlled by the
controller.
PV_TRACK REAL Current value of the reference variable.
HIK REAL Upper value of the ratio that needs to be maintained between PV
and PV_TRACK. Used to limit the maximum constant admitted by
the controller. This input is internally connected to the
PARA.K_MAX parameter of the RATIO controller.
LOK REAL Lower value of the ratio that needs to be maintained between PV
and PV_TRACK. Used to limit the minimum constant admitted by
the controller. This input is internally connected to the
PARA.K_MIN parameter of the RATIO controller.
HIOP REAL Upper range of the output (OP) calculated by the RATIO controller.
Used to limit the output calculated by the controller. This input is
internally connected to the PARA.SP_MAX parameter of the RATIO
controller.
LOOP REAL Lower range of the output (OP) calculated by the RATIO controller.
Used to limit the output calculated by the controller. This input is
internally connected to the PARA.SP_MIN parameter of the RATIO
controller.
RK REAL Remote ratio set-point. Enables to define the desired ratio from the
continuous control. Refer to the SC.REM public variable
(see page 496).

492 EIO0000002093 04/2020

 RATIOCTL

Outputs

Output Parameter Description

Parameter Type Description

OP REAL Output generated by the RATIO controller based on the
measurement and the configured ratio. OP is calculated as: K x
PV_TRACK + RATIOCTL_CFG.BIAS.
STATUS WORD Statuses output by the RATIO controller on the STATUS output.
Refer to the RATIO controller in Control documentation for
more details.
KACT REAL Actual ratio coefficient generated by the RATIO controller.
KACT is calculated as: (PV - RATIOCTL_CFG.BIAS)/
PV_TRACK.
K REAL Ratio coefficient for the ratio between the generated output and
the measurement that is being applied on the basis of the
operating mode.

The DFB performs the ratio coefficient calculation based on the signal statuses. The ratio
coefficient calculation is detailed in the following table:

OWNER REM KD is calculated as:

OFF OFF SC.LK
OFF ON RK
ON - RATIOCTL_ST.LK
You can modify the ratio coefficient directly from the monitoring
subsystem while this mode is active.

EIO0000002093 04/2020 493

RATIOCTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

RATIOCTL_CFG RATIOCTL_CFG_DDT Provides the data needed to configure the DFB
normally from the monitoring subsystem.
RATIOCTL_ST RATIOCTL_ST_DDT Provides the data needed to monitor and/or
control the DFB status.

RATIOCTL_CFG_DDT Type

Name Type Description

BIAS REAL Enables to define the bias parameter for the RATIO
controller. Used for calculating the OP output.
KACT REAL Read-only access
Refer to the KACT output pin (see page 493).

RATIOCTL_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the
monitoring subsystem, and allows data to be kept in the
memory. Read-only access to the data contained in this
word.
CFGW WORD Provides the means to control the device from the
monitoring subsystem. Read/write access to the data
contained in this word.
PV REAL Read-only access
Refer to the PV input pin (see page 492).
PV_TRACK REAL Read-only access
Refer to the PV_TRACK input pin (see page 492).
OP REAL Read-only access
Refer to the OP output pin (see page 493).
LK REAL Read/write access
Enables to set the ratio when the owner is the Operator
(OWNER = 1).

494 EIO0000002093 04/2020

 RATIOCTL

RATIOCTL_ST.STW Word Structure

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 496).

RATIOCTL_ST.CFGW Word Structure

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the ratio set-point is set by the Program
(0) or the Operator (1).

EIO0000002093 04/2020 495

RATIOCTL

Public Variables

Public Variable Description

Variable Type Description

SC RATIOCTL_SC_DDT Provides the frequently needed data to monitor and
control the controller status from the sequential control.

RATIOCTL_SC_DDT Type

Name Type Description

OP REAL Read-only access
Refer to the OP output pin (see page 493).
PV_TRACK REAL Read-only access
Refer to the PV_TRACK input pin (see page 492).
PV REAL Read-only access
Refer to the PV input pin (see page 492).
OWNER BOOL Read-only access
Refer to the RATIOCTL_ST.CFGW.OWNER input/output
pin (see page 494).
REM BOOL Read-only access
1 = Allows to configure the DFB for a remote set-point
-RSP, if the owner is the Program
0 = Allows to configure the DFB for a local set-point -
LSP, if the owner is the Program.
LK REAL Read/write access
Enables the sequential control to assign the local ratio
set-point if the owner is the Program (OWNER is 0) and
the selected set-point is local (SC.REM is 0).
Otherwise, the current set-point (K output) is
continuously copied to this variable.

496 EIO0000002093 04/2020

 Modicon Libraries General Purpose
SPLRGCTL
EIO0000002093 04/2020

Chapter 47
SPLRGCTL - Split Range Controller

SPLRGCTL - Split Range Controller

Overview
This chapter describes the SPLRGCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 498
DFB Representation 499
Inputs 500
Outputs 501
Inputs/Outputs 502
Public Variables 504

EIO0000002093 04/2020 497

SPLRGCTL

Description

General
The SPLRGCTL DFB is used to condition the signals associated to the standard Control library
SPLRG DFB. This helps to monitor and control the controller from the monitoring subsystem and to
provide the operating modes used in the rest of the General Purpose library process function
blocks.
The standard Control library SPLRG DFB is used for split-range controllers (for example, cold/heat)
because it enables to generate 2 output signals based on a single signal that could come, for
instance, from the output of a PID controller.
You can combine this DFB with the PIDCTL and PIDMUX DFBs when you want to control a process
with 2 control modules (for example, 2 modulating valves) and PID control.

Function Description
The main functions of the DFB are described in the following table:

Function Description
SPLRG The DFB includes and incorporates functions provided by the
SPLRG controller from the standard CONT_CTL library.
Owner The DFB manages the control system level, which is the owner
(operator or program). As a result, it is responsible for setting the
setpoint for the desired position.
Interlocking The DFB gives a position command to the device to move to the
defined position in case of an active interlock. An interlock bypass
function is available.
Set-point The DFB enables to work under a remote (normally set from the
continuous control) or local (set from the program or by the operator
depending on the active owner) set-point.

498 EIO0000002093 04/2020

 SPLRGCTL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 499

SPLRGCTL

Inputs

Input Parameter Description

Parameter Type Description

HISP REAL High range for the set-point (SP) in engineering units. Enables to set set-
points to this maximum value in the event that they exceed it.
LOSP REAL Low range for the set-point (SP) in engineering units. Enables to set set-points
to this minimum value in the event that they fall below it.
HIOP REAL High range of the output (OP) in engineering units. Enables to set the output
to this maximum value in the event that the output exceeds it.
LOOP REAL Low range of the output (OP) in engineering units. Enables to set the output
to this minimum value in the event that the output falls below it.
RSP REAL Remote set-point is normally set by the continuous control.
ILCKOP1 REAL Value to which the OP1 output is forced when the DFB is interlocked. Refer to
the ILCK input.
ILCKOP2 REAL Value to which the OP2 output is forced when the DFB is interlocked. Refer to
the ILCK input.
ILCK BOOL 1 = Interlocks the device at the defined position.

500 EIO0000002093 04/2020

 SPLRGCTL

Outputs

Output Parameter Description

Parameter Type Description

OP1 REAL Output 1 generated by the SPLRG controller based on the parameters
defined in the SPLRGCTL_CFG configuration structure and the set-point range
(LOSP...HISP).
OP2 REAL Output 2 generated by the SPLRG controller based on the parameters
defined in the SPLRGCTL_CFG configuration structure and the set-point range
(LOSP...HISP).
SP REAL Current set-point.
The DFB performs set-point calculation based on the value of the inputs and
of the SPLRGCTL_ST input/output and the set-point calculation is detailed in
the following table:
OWNER (OFF: Program; REM SP is calculated as:
ON: Operator
OFF OFF SC.LSP
OFF ON RSP
ON - SPLRGCTL_CFG.LSP
STATUS WORD Statuses output by the SPLRG controller on the STATUS output. Refer to the
SPLRG controller in Control for more details.

EIO0000002093 04/2020 501

SPLRGCTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SPLRGCTL_CFG SPLRGCTL_CFG_DDT Provides the data needed to configure the DFB normally
from the monitoring subsystem.
SPLRGCTL_ST SPLRGCTL_ST_DDT Provides the data needed to monitor and/or control the
DFB status.

SPLRGCTL_CFG_DDT Type

Name Type Description

OUT1_TH1 REAL Value that the set-point (SP) should have so that the value specified
in OUT1_INF is applied on the OP1 output.
OUT1_TH2 REAL Value that the set-point (SP) should have so that the value specified
in OUT1_SUP is applied on the OP1 output.
OUT1_INF REAL Value of the OP1 output when the set-point (SP) assumes a value
less than or equal to the value specified in OUT1_TH1.
OUT1_SUP REAL Value of the OP1 output when the set-point (SP) assumes a value
greater than or equal to the value specified in OUT1_TH2.
OUT2_TH1 REAL Value that the set-point (SP) should have so that the value specified
in OUT2_INF is applied on the OP2 output.
OUT2_TH2 REAL Value that the set-point (SP) should have so that the value specified
in OUT2_SUP is applied on the OP2 output
OUT2_INF REAL Value of the OP2 output when the set-point (SP) assumes a value
less than or equal to the value specified in OUT2_TH1.
OUT2_SUP REAL Value of the OP2 output when the set-point (SP) assumes a value
greater than or equal to the value specified in OUT2_TH2.

502 EIO0000002093 04/2020

 SPLRGCTL

SPLRGCTL_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring
subsystem, and allows data to be kept in the memory. Read-only
access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read/write access to the data contained in this word.
SP REAL Read/write access
Allows to set the local set-point of the Operator (OWNER = 1) from the
monitoring subsystem. If the set-point is set by the Program (OWNER =
0), the DFB continuously assigns it the value of the current set-point.
OP1 REAL Read-only access
Refer to the OP1 output pin (see page 501).
OP2 REAL Read-only access
Refer to the OP2 output pin (see page 501).

SPLRGCTL_ST.STW Word Structure

DFB status word. Read-only access. The following table describes the SPLRGCTL_ST.STW Word
structure:

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 504).
2 ILCK Refer to the ILCK input pin (see page 500).

SPLRGCTL_ST.CFGW Word Structure

DFB configuration word. Read/write access. The following table describes the
SPLRGCTL_ST.CFGW Word structure:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point is set by the Program (0) or
by the Operator (1).
1 ILCKBP Read/write access
Allows the interlock to be bypassed (1).

EIO0000002093 04/2020 503

SPLRGCTL

Public Variables

Public Variable Description

Variable Type Description

SC SPLRGCTL_SC_DDT Provides the frequently needed data to monitor and
control the controller status from the sequential control.

SPLRGCTL_SC_DDT Type

Name Type Description

LSP REAL Read/write access
Enables to assign the local set-point normally for the
sequential control if the owner is the Program (OWNER
input/output = 0) and the selected set-point is local
(SC.REM public variable = 1). In any other case, the
DFB automatically assigns it the current value of the
resulting set-point (refer to the SP output pin
(see page 501).
OWNER BOOL Read-only access
Refer to the SPLRGCTL_ST.CFGW.OWNER input/output
pin (see page 502).
REM BOOL Read-only access
1 = Enables to configure the DFB for a remote set-point
-RSP while the owner is the Program,
0 = Enables to configure the DFB for a local set-point -
LSP while the owner is the Program.
ILCKD BOOL Read-only access
The signal evaluation based on the ILCK input and the
SPLRGCTL_ST.CFGW.ILCKBP input/output is shown in
the following table:
ILCK ILCKBP SC.ILCKD is calculated
as:
OFF - OFF
ON OFF ON
ON ON OFF
OP1 REAL Read-only access
Refer to the OP1 output pin (see page 501).
OP2 REAL Read-only access
Refer to the OP2 output pin (see page 501).

504 EIO0000002093 04/2020

 Modicon Libraries General Purpose
STEP3CTL
EIO0000002093 04/2020

Chapter 48
STEP3CTL - 3 Step Controller/Positioner

STEP3CTL - 3 Step Controller/Positioner

Overview
This chapter describes the STEP3CTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 506
DFB Representation 507
Inputs 508
Outputs 510
Inputs/Outputs 511
Public Variables 514

EIO0000002093 04/2020 505

STEP3CTL

Description

General
The STEP3CTL DFB is used to condition the signals associated with the control of a STEP3-type
controller. This helps to monitor and control the controller easily from the monitoring subsystem
and to provide the operating modes used in the rest of the General Purpose library process
function blocks.
The STEP3CTL DFB is designed for controlling process variables through discrete control modules
(for example, temperature control through hot liquid/cold liquid on-off valves) or for positioning of
analog components with discrete drives (for example, a motorized valve or a gate with position and
control feedback through a 2-direction motor). Because of this, combine the STEP3CTL DFB with
other library components such as AINPUT, DEVCTL, MOTOR2, DOUTPUT, and so on.

Function Description
The main functions of the DFB are described in the following table:

Function Description
STEP3 The DFB includes and incorporates functions provided by the STEP3
controller from the standard CONT_CTL library.
Owner The DFB manages the control system level, which is the owner (operator
or program). As a result, it is responsible for setting the setpoint for the
desired position.
Interlocking The DFB gives a command position to the device to move to the defined
position in case of an active interlock. An interlock bypass function is
available.
Set-point The DFB enables to work under a remote (usually set from the continuous
control) or local (set from the program or by the operator depending on the
active owner) set-point.
Mode You can enable the STEP3CTL DFB (Start=1) to operate as described in
the STEP3 DFB in automatic mode, or disable (Start=0). In this case, the
DFB continues calculating but forces the outputs to 0.

506 EIO0000002093 04/2020

 STEP3CTL

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 507

STEP3CTL

Inputs

Input Parameter Description

Parameter Type Description

PV REAL Current value of the measurement in engineering units.
RSP REAL Remote set-point. Is set by the continuous control. Acts in Program/Remote mode.
Refer to the SC.REM public variable (see page 514).
HIPV REAL Upper value of the measurement range. Used for limiting the maximum set-point
admitted by the controller. This input is internally connected to the PARA.PV_SUP
parameter of the STEP3 controller.
LOPV REAL Lower value of the measurement range. Used for limiting the minimum set-point
admitted by the controller. This input is internally connected to the PARA.PV_INF
parameter of the STEP3 controller. Check STEP3 operating graph in the following.
RSTART BOOL 1 = Enables the operation of the STEP3 DFB in Automatic mode as described in
the Control documentation. With a 0 value, it forces the OPINC and OPDEC outputs
to 0, but the STEP3 continues to run internally and calculate the outputs. The valid
START command for the calculation is obtained from the following truth table:
OWNER REM START
OFF OFF SC.LSTART
(Program)
OFF ON RSTART
ON (Operator) - STEP3CTL_ST.CFGW.START
You can modify the set-point directly from the
monitoring subsystem while this mode is active.
ILCKSP REAL Set-point needs to be considered when the DFB is interlocked. Refer to the ILCK
input pin.
ILCK BOOL 1 = Forces the STEP3 DFB to run with the set-point defined in the ILCKSP input.
You can use the ILCKSP and ILCK combination to force the set-point of a
motorized valve to a pre-defined position. For example, the value corresponding
to 0% aperture. In this case, the STEP3CTL module controls the outputs until 0%
aperture is reached. If de-energizing the outputs is desired, acting on the RSTART
input (set to 0) is recommended. In any case, if deactivating the control signals is
desirable, deactivate the control signals by interlocking the corresponding
operations (using DEVCTL, MOTOR2, DOUTPUT, and so on).

508 EIO0000002093 04/2020

 STEP3CTL

STEP3 operating graph:

EIO0000002093 04/2020 509

STEP3CTL

Outputs

Output Parameter Description

Parameter Type Description

OPINC BOOL 1 = Enabled in case of negative deviations. This output corresponds to the
operation that increases PV.
It is calculated according to the following table:
START OPINC
0 0
1 Refer to the STEP3 operation graph
(see page 508)
OPDEC BOOL 1 = Enabled in case of positive deviations. This output corresponds to the
operation that decreases PV.
It is calculated according to the following table:
START OPDEC
0 0
1 Refer to the STEP3 operation graph
(see page 508)
RUNNING BOOL 1 = Indicates the controller is running. Read-only access.
DEV REAL Deviation (PV-SP) directly extracted from the STEP3 controller.
STATUS WORD Statuses output by the STEP3 controller on the STATUS output.
SP REAL Current set-point that is being considered by the STEP3 algorithm.
The set-point calculation that the DFB performs based on the signal status is
detailed in the following table:
OWNER REM SP
OFF OFF SC.LSP
OFF ON RSP
ON - STEP3CTL_ST.SP
You can modify the set-point directly from the
monitoring subsystem while this mode is
active.

510 EIO0000002093 04/2020

 STEP3CTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

STEP3CTL_CFG STEP3CTL_CFG_DDT Provides the data necessary to configure the DFB usually from
the monitoring subsystem or the sequential control.
STEP3CTL_ST STEP3CTL_ST_DDT Provides the data necessary to monitor and/or control the DFB
status.

STEP3CTL_CFG_DDT Type

Name Type Description

DEVLL REAL Enables to define the lower deviation threshold for the detected error (PV-SP).
This value needs to be less than or equal to 0. Otherwise, the DFB considers it
as 0. Refer to the operating graph in LOPV (see page 508) and FB STEP3.
DEVHL REAL Enables to define the higher deviation threshold for the detected error (PV-SP).
This value needs to be greater than or equal to 0. Otherwise, the DFB will
consider it as 0. Refer to the operating graph in LOPV (see page 508) and FB
STEP3.
HYS REAL Enables to define the hysteresis value to be taken into account for calculating
the OPINC and OPDEC outputs by the STEP3 algorithm. This value needs to be
between 0 and the minimum between DEVHL and DEVLL without taking the sign
into account.
The DFB shields erroneous hysteresis inputs with the following rules:
 If CFG_HYS is < 0, it is considered as 0.
 If CFG_HYS is > DEVHL, it is considered as DEVHL.

If CFG_HYS is > DEVLL (unsigned), it is considered as DEVLL (unsigned).

TARGETSP REAL Read access
This variable indicates what the current set-point is before interlocking.

Highlight particular operation of the controller and the configuration of the three parameters above;
going through the operation graph is recommended.
For example, in case of temperature regulation with a cold liquid valve and a hot liquid valve (the
cold liquid valve is connected to OPDEC and the hot liquid valve to OPINC), the following
assumption is made:
 the set-point is 21° (SP).
 a maximum detected error of 1° above and below with a hysteresis of 0.5% is being considered
(DEVHL=1, DEVLL=1, HYS=0.5).
In this initial case, PV-SP = -11 (<DEVLL), and, as a result, OPINC=1 (output that corresponds to
increasing PV).

EIO0000002093 04/2020 511

STEP3CTL

As PV increases, the detected error decreases in absolute value until the detected error is less than
-0.5, that is, DEVLL+HYS=-1+0.5=-0.5, when OPINC becomes 0. Verify that the output stops at the
DEVLL+HYS threshold and not at DEVLL.
Hysteresis will be achieved if the detected error drops below the DEVLL value, at which point the
OPINC will return to the value of 1.
On the positive side of the detected error, you can consider the event in which the temperature is
30º with the same DEVHL, DEVLL, and HYS values.
In this initial case PV-SP = 9 (>DEVHL), and, as a result, OPDEC=1 (output that corresponds to
decreasing PV).
As PV drops, the detected error decreases in absolute value, until the detected error is less than
0.5, that is DEVHL-HYS=1-0.5=0.5, at which point OPDEC becomes 0. Verify that the output stops
at the DEVLL+HYS threshold and not at DEVLL.
Hysteresis will be achieved if the detected error rises above the DEVLL value, at which time the
OPINC will return to a value of 1.

STEP3CTL_ST_DDT Type

Name Type Description

PV REAL Read access
Refer to the PV input pin (see page 508).
This variable indicates what the current measurement is.
SP REAL Read/write access
Refer to the SP output pin (see page 510).
This variable indicates which is the current set-point and is calculated internally in
the DFB as long as the owner is not the Operator. In which case, you can modify
it from the monitoring subsystem.
STW WORD Provides the device status usually used from the monitoring subsystem, and
allows data to be kept in the memory. Read-only access to the data contained in
this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem.
Read/write access to the data contained in this word.

STEP3CTL_ST.STW Word

Bit Name Description

0 REM Refer to the SC.REM public variable (see page 514).
2 ILCK Refer to the ILCK input pin (see page 508).
3 OPINC Refer to the OPINC output pin (see page 510).
4 OPDEC Refer to the OPDEC output pin (see page 510).

512 EIO0000002093 04/2020

 STEP3CTL

STEP3CTL_ST.CFGW Word

Bit Name Description

0 OWNER Read/write access
Enables configuration whether the set-point is set by the Program (0)
or by the Operator (1).
1 ILCKBP Read/write access
Enables the interlock to be bypassed (1).
2 START Read/write access
START command while the owner is the Operator; otherwise, the valid
START is copied to ST.CFGW.START. Refer to the RSTART input pin
(see page 508).

EIO0000002093 04/2020 513

STEP3CTL

Public Variables

Public Variable Description

Variable Type Description

SC STEP3CTL_SC_DDT Provides the frequently needed data to monitor and control the
regulator status from the sequential control.

STEP3CTL_SC_DDT Type
The following table describes the STEP3CTL_SC_DDT type:

Name Type Description

LSP REAL Read/write access
Enables to assign the local set-point for the sequential control if the owner is
the Program (OWNER is 0), the selected mode is Auto, and the selected set-
point is Local (SC.REM is 0). Otherwise, the current set-point (SP output) is
continuously copied to this variable.
TARGETSP REAL Read access
This variable indicates what the current set-point is before interlocking.
PV REAL Read-only access
Refer to the PV input pin (see page 508).
LSTART BOOL Read/write access
Refer to the RSTART input pin (see page 508).
START command while the owner is the Program and Local; otherwise, the
valid START is copied to SC.LSTART.
OWNER BOOL Read-only access
Refer to the STEP3CTL_ST.CFGW.OWNER input/output pin (see page 511).
ILCKD BOOL Read-only access
The signal evaluation depending on the ILCK input and the
STEP3CTLST.STW.ILCKBP input/output is shown in the following table:
ILCK ILCKBP SC.ILCKD
OFF - OFF
ON OFF ON
ON ON OFF
REM BOOL Read/write access
1 = Allows the DFB to be configured to remote set-point RSP, if the owner is
the Program and the mode is Auto.
0 = Allows the DFB to be configured to local set-point LSP, if the owner is the
Program and the mode is Auto.

514 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Sequential Control
EIO0000002093 04/2020

Part VI
Sequential Control

Sequential Control

Overview
This part provides a detailed description of the functions, pins, pin layout, and variables of the
function blocks of the sequential control family.
These function blocks do not reflect any specific installation.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000002093 04/2020 515

Sequential Control

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
49 Sequential Control 517
50 SEQCTL1 - Advanced Sequential Control 525
51 Auxiliary Functions of Sequential Control 537
52 SEQPARxx - Sequence Parameter Management 555
53 SEQCTL1 - Example of Use 563

516 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Sequential Control
EIO0000002093 04/2020

Chapter 49
Sequential Control

Sequential Control

Overview
This chapter describes the sequential control management.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description of Sequential Control 518
Definition of Status and Commands 520
Status Matrix 522
Status Controller 523
Operating Modes 524

EIO0000002093 04/2020 517

Sequential Control

Description of Sequential Control

Overview
The operation of the function block that is available for sequence control is described in this
chapter.
The SEQCTL1 DFB belongs to the General Purpose library and is used to monitor and manage
control sequences. The module is based on the ISA-S88 Standard, Part 1 (S88.01) and
implements the status controller defined in this standard for controlling procedure model
components (phases, operations, and so on).

Function Description
You can use this DFB to change states in the process. In compliance with ISA-S88.01I, you can
use this DFB in continuous processes to initiate start, stop or emergency sequences. In batch
processes, this DFB can be used to set up phases and operations.
The DFB implements sequence state management and processes the commands received from:
 The Supervision system (when sequences are manually controlled by the operator)
 The batch control subsystem (in which case the subsystem sends the commands and checks
the status of the sequence to determine what action to take)
 Other control sequences

For example, sequences that implement operations defined in the ISA-S88 standard can control
the phases and can also be implemented through sequences managed from the component.
The table compares the functions that are available in the DFB:

Function SEQCTL1
Management of state machine and commands according to ISA-S88 x
Management of messages for the operator integrated with the sequence –
Management of operating modes according to ISA-S88: Manual (enables to x
change from one sequence step to any other sequence step), Semi (step
advance with confirmation from the operator), and Auto
Owner Management: Operator/Program x
Step time automatically calculated by the control block x
Automatic management of transitions through the SEQTRANS function block x
Automatic management of sequence detected failure through the SEQFAILED x
function block
Automatic management of sequence steady-step marking through the x
SEQSTABLESTEP function block
Possibility of displaying the sequence graphically (active step and next level of x
transitions and steps) from the monitoring subsystem
NOTE: ‘x’ indicates that the functions are available in the DFB.

518 EIO0000002093 04/2020

 Sequential Control

Program the steps and transitions that the sequences implement (through ST or SFC language)
while the component (SEQCTL or SEQCTL1) allows the programmer to:
 manage the statuses of the sequence and
 process the commands received from other levels as described above.

As a minimum, implement the subsequence that implements normal operation (RUNNING

(see page 564)).
Other you can implement subsequences that attend to commands received from other levels of the
control system or that react to detected failures in the process (HOLDING, RESTARTING,
STOPPING, and ABORTING) detected by the sequence itself.
The table describes the main functions of the DFB:

Function Description
Processing States and The DFB processes the commands received and
Commands determines the status of the control sequence with the
objective of determining the subsequences (normal, hold,
continue, abort, so on.) and which step needs to run in
each cycle of the program.
Managing Entry Points in the The DFB enables to retain the step number with which the
Sequence execution of the normal sequence (Running) needs to be
restarted (Restart) after being restarted from held status
(Held).
Handling of Detected Failures The component manages controller detected failures
(without user intervention from the Supervision system).
The component manages this detected failure and triggers
the execution of the detected failure handling
subsequence.

EIO0000002093 04/2020 519

Sequential Control

Definition of Status and Commands

Statuses
The table describes the possible sequence statuses along with the code that identifies each status:

Status Code Description

Idle 303 Inactive operation. Waiting for command to start (Start) running.
Running 302 Normal operation.
Complete 301 Normal operation has finished. Requires an initialization order (Reset) to return to
the Idle status.
Pausing 314 A pause (Pause) command is received for a short period while the normal
operation was being executed (Running). The normal sequence runs until it
automatically goes to paused (Paused) status.
Paused 315 Status reached after the pause sequence is completed and the next steady status
is reached. Upon receiving the command to continue (Resume), the sequence
continues with the next step of the normal operation sequence (Running).
Holding 316/326 A hold (Hold) command is received or a detected failure is automatically detected
in the process (for example, a detected failure in a control module), and the
sequence that allows the process to be changed to a known status is executed.
After this sequence is finished, it automatically goes to the held (Held) status.
Code 316 corresponds to having received a Hold and 326 to a detected failure.
Held 317/327 Status reached after the pause sequence is completed and the next steady status
is reached.
Code 317 corresponds to having received a Hold command and 327 to a detected
failure.
Restarting 318 A restart command (Restart) is received while the sequence is being held (Held).
The sequence runs to return to the normal operation sequence (Running). The
normal operation status (Running) is set automatically after the sequence is
complete.
Stopping 312 An order to stop (Stop) has been received. The sequence to finish the sequence in
a controlled way is executed (it is not possible to continue with it). The stopped
operation status (Stopped) is automatically activated after the sequence is
complete.
Stopped 313 The stop sequence (Stopping) is completed. Requires an initialization command
(Reset) to go to inactive (Idle) status.
Aborting 310 An order to end (Abort) has been received. A fast stop, which is not necessarily
controlled is executed. The aborted operation status (Aborted) is automatically
activated after the sequence is completed.
Aborted 311 An aborting sequence (Aborting) has been completed. Requires an initialization
command (Reset) to go to inactive (Idle) status.

The (Held) status can also be reached (without receiving a command) if the control sequence itself
detects a problem situation. The DFB has a signal that allows this situation to be communicated.

520 EIO0000002093 04/2020

 Sequential Control

The DFB has the necessary means to be able to restart the Running sequence from the last steady
step in which the initial run was held by a Hold command.

Commands
The table describes the commands that can be sent to the sequence along with the code and
description of each command:

Status Code Description

Start 1 Allows the normal operation of the sequence (Running) to be started.
It is only valid if the status is inactive (Idle).
Stop 2 Allows the sequence execution to be stopped (Running, Pausing,
Paused, Holding, Held, or Restarting) and the stopping sequence to
be run (Stopping).
Hold 3 Allows the sequence to be stopped (Running, Pausing, Paused,
Holding, Held, or Restarting) and the stopping sequence to be run
(Stopping).
Restart 5 Allows the sequence for continuing the operation (Restarting) and
resume normal operation (Running).
Abort 4 Allows the sequence to be aborted (in any status except Idle,
Complete, Aborting, and Aborted) and the aborting sequence to be
run (Aborting).
Reset 8 Triggers the transition to idle status (in Complete, Aborted, or Stopped
status).
Pause 6 Allows normal execution (Running) to be paused in the next steady
Sequence status.
Resume 7 Allows normal operation of the sequence (Running) to be resumed
from the paused (Paused) status.

EIO0000002093 04/2020 521

Sequential Control

Status Matrix

Description
The following table describes the finite status controller that the DFB implements:

Initial State Command Activity Final State (without command)

Idle Start Running –
Running Stop Stopping Stopped
Hold Holding Held
Pause Pausing Paused
Abort Aborting Aborted
Complete Reset Idle –
Pausing Stop Stopping Stopped
Hold Holding Held
Abort Aborting Aborted
Paused Stop Stopping Stopped
Resume Running
Abort Aborting Aborted
Holding Stop Stopping Stopped
Abort Aborting Aborted
Held Stop Stopping Stopped
Restart Restarting Running
Abort Aborting Aborted
Restarting Stop Stopping Stopped
Hold Holding Held
Abort Aborting Aborted
Stopping Abort Aborting Aborted
Stopped Reset Idle –
Abort Aborting Aborted
Aborting No action possible
Aborted Reset Idle –

The Held status can also be reached (without receiving a command) if the control sequence itself
encounters a detected error. The block has a signal that allows this situation to be communicated.
The block has the necessary means to be able to restart the Running sequence from the last
steady step in which the initial run was held by a Hold command.

522 EIO0000002093 04/2020

 Sequential Control

Status Controller

Description
The following diagram describes the possible statuses and commands that the Control Expert
component manages according to the ISA-S88 standard:

Next to the transition arrows, the commands that the component receives (from the Supervision
system or another higher level sequence) are shown in black, and the flags that the sequence itself
generates are shown in red in parentheses.

EIO0000002093 04/2020 523

Sequential Control

Operating Modes

Mode Table
The following table provides the description of the sequence operating modes of SEQCTL1 DFB:

Software Implemented as:

Automatic It is the normal running mode. The sequence runs automatically based on
the transitions defined in the controller.
Semiautomatic In this operating mode, after the conditions defined in the transitions are
met, you need to confirm the move to the next step.
Manual The sequence does not automatically advance to a step; user can
manually change from one sequence step to another.Once the sequence
step is selected, operating mode will change to semi-automatic and starts
the sequence step selected in manual mode.

524 EIO0000002093 04/2020

 Modicon Libraries General Purpose
SEQCTL1
EIO0000002093 04/2020

Chapter 50
SEQCTL1 - Advanced Sequential Control

SEQCTL1 - Advanced Sequential Control

Overview
This chapter provides a detailed description of the functions, pins, pin layout, and variables of the
SEQCTL1 DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 526
DFB Representation 527
Inputs/Outputs 528
Public Variables 531

EIO0000002093 04/2020 525

SEQCTL1

Description

Initialization
If the sequence status is unknown, it is initialized as Idle regardless of whether a controller has
restarted or not. This initialization is done automatically.

526 EIO0000002093 04/2020

 SEQCTL1

DFB Representation

Representation
The DFB that is used in the program has the following aspect at the section level when
imported.You can use it in any of the programming languages, although it is designed for use with
the FBD language.
The figure shows an example of the SEQCTL1 DFB instance:

Implement the sequence logic that controls the component in ST language to take advantage of
the sequence control potentials making the sequence reusable. That is, you can run
simultaneously several instances of the sequence that you have implemented. This reduces
engineering and maintenance efforts when it is necessary to set up the same control sequences
in several process units.

EIO0000002093 04/2020 527

SEQCTL1

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SEQCTL1_ST SEQCTL1_ST_DDT Provides the necessary data for monitoring and controlling
sequence execution.
SEQCTL1_CFG SEQCTL1_CFG_DDT Provides the necessary data for background monitoring.

SEQCTL1_ST_DDT Type

Name Type Description

STATE UINT Provides the status of the sequence. Read-only access to the data is
contained in this bits word. Refer to the Definition of States and
Commands section (see page 520).
COMMAND UINT Enables commands to be sent to the sequence usually from the
Supervision system. Write access to the data is contained in this bits
word. The DFB sets the command to 0 after processed (successfully
or not). Refer to the Definition of States and Commands section
(see page 520).
STW WORD Sequence status word. In this word, the SEQTRANS auxiliary DFB is
used to load the status of the transitions (maximum of 6) from the
current step of the sequence to the steps in the next level of the
sequence, where 0 means that the conditions in the transition are not
fulfilled and 1 means they are fulfilled.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read/write access to the data contained in this word.
ETIME UDINT The DFB calculates the execution time elapsed in tenths of a second
for the current step of the control sequence.
If execution of the program is stopped and resumed, the accumulated
execution time is considered but not the time that the program was
stopped.
CSTEPD String[22] Current step description (three characters for step number
concatenated with seventeen characters for description).

528 EIO0000002093 04/2020

 SEQCTL1

SEQCTL1_ST.STW Word
In this word, the SEQTRANS auxiliary DFB is used to load the status of the transitions (maximum of
6) from the current step of the sequence to the steps in the next level of the sequence where 0
means that the conditions in the transition are not fulfilled and 1 means that they are fulfilled.

Bit Description
0 Status of the first transition
1 Status of the second transition
... ...
5 Status of the sixth transition

SEQCTL1_ST.CFGW Word
The following table describes the SEQCTL1_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the sequence commands will come from the
program (0) or the operator (1).
1 SEMI Read/write access
Enables to configure the sequence in automatic (0) or semi-automatic (1) mode.
2 MANUAL Read/write access
Enables to configure the sequence in automatic/semi-automatic (0) or manual (1)
mode.
The meaning of the 1 and 2 bits combined is shown in the following table:
Bit 2 Bit 1 Mode
OFF OFF auto
OFF ON semi-automatic
ON – manual
3 NEXTSTEP Read/write access
Enables to confirm the change of steps to the next sequence step in Semi mode.
The DFB sets the signal to 0 after it is processed.
5 SCROLL_UP Read/write access
Enables to show the steps previous to the one being shown on the current window
in manual mode. The DFB sets the signal to 0 after it is processed.
6 SCROLL_DOWN Read/write access
Enables to show the steps following the one being shown on the current window
in manual mode. The DFB sets the signal to 0 after it is processed.

EIO0000002093 04/2020 529

SEQCTL1

SEQCTL1_CFG_DDT Type

Name Type Description

NSTEP INT Number of the new step at which the subsequence needs to
be positioned in manual mode. The DFB sets this variable to
0 after it is processed.
STEPD STRING[122] Description of steps. Limited to 6 steps. In automatic and
semi-automatic mode, it shows the destination steps specified
in the current step transitions. In manual mode, it shows the
list of the steps defined in the sequence. This variable format
is: 6 steps, 20 characters each. Of the 20 characters of each
step, the first 3 are for the step number and the next 17 are for
its description. The value of this variable is assigned for the
auxiliary functions.
TRANSD STRING[122] Description of transitions. Limited to 6 transitions. This
variable format is 6 transitions, 20 characters each. The 20
characters are for its description. The value of this variable is
assigned for the auxiliary functions.

530 EIO0000002093 04/2020

 SEQCTL1

Public Variables

Public Variable Description

Variable Type Description

SC SEQCTL1_SC_DDT Provides the frequently needed data to monitor the
sequence status and control it from the sequential
control.

SEQCTL1_SC_DDT Type

Name Type Description

STATE UNIT Read-only access
Refer to the SEQCTL1_ST.STATE input/output pin
(see page 528).
CSTEP INT Read-only access
Number of the active sequence current step (Running, Pausing,
Holding, Restarting, Stopping,or Aborting).
The value 0 corresponds to the initial step of each subsequence.
OWNER BOOL Read-only access (see page 528).
START BOOL Write access
1 = Sends a start sequence (Start) command if the owner is the
program (SC.OWNER is 0).
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
STOP BOOL Write access
1 = Sends a stop sequence (Stop) command if the owner is the
program (SC.OWNER is 0).
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
HOLD BOOL Write access
1 = Sends a hold sequence (Hold) command if the owner is the
program (SC.OWNER is 0).
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
PAUSE BOOL Write access
1 = Sends a pause sequence (Pause) command if the owner is
the program (SC.OWNER is 0).
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.

EIO0000002093 04/2020 531

SEQCTL1

Name Type Description

RESTART BOOL Write access
1 = Sends a command to continue the sequence (Hold) if the
owner is the program (SC.OWNER is 0).
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
ABORT BOOL Write access
1 = Sends a command to abort the sequence (Abort) if the owner
is the program (SC.OWNER is 0).
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
RESET BOOL Write access
1 = Sends a command to reset the sequence to be able to start it
(Reset) if the owner is the program (SC.OWNER is 0).
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
RESUME BOOL Write access
1 = Sends a command to resume the sequence execution
(Resume) if the owner is the program (SC.OWNER is 0).
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
ONENTRY BOOL Read-only access
1 = Reports that a new sequence step has just been started.
You can use this event in the logic of the sequence step actions
to run any actions. The actions run only when the step starts.
ONEXIT BOOL Read-only access
1 = Reports that the execution of the sequence current step is
about to finish.
You can use this event in the logic of the sequence step actions
to run any actions. The actions run only when the step ends.
STABLESTEP BOOL Write access
1 = Sends a command to mark the current step as a steady step,
that is:
 the step with which the sequence will resume after its is held
or
 the step on which the sequence will be held after the
sequence is paused.
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
As an alternative, forcing the value of this variable to 1 by using
the SEQSTABLESTEP auxiliary DFB is recommended.

532 EIO0000002093 04/2020

 SEQCTL1

Name Type Description

COMPLETED BOOL Write access
1 = Sends a command to finish the current subsequence
(Running, Holding, Restarting, Stopping, and so on).
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
As an alternative, forcing the value of this variable to 1 by using
the SEQTRANS auxiliary DFB is recommended.
FAIL BOOL Write access
1 = Sends a command to stop the sequence normal execution.
0 = The signal is automatically set to 0 by the DFB after the signal
is processed.
With the activation of this signal, the Holding For Detected
Error subsequence is run next if the Running, Pausing,
Restarting, or Paused subsequence was running previously.
NEXTSTEP INT Write access
Enables the number of the next step to be run in the sequence to
be set.
The signal is automatically set to 0 by the DFB after the signal is
processed. As an alternative, forcing the value of this variable to
1 by using the SEQTRANS auxiliary DFB is recommended.
MODE INT Read-only access (see page 528) (bits 1 and 2).
Mode is encoded as:
VALUE MODE
0 Automatic
1 Semi-automatic
2 Manual
DEST ARRAY[1..6] of INT Write access
Defines the possible destination steps for the current step; it is
limited to 6 transitions. As an alternative, forcing the value of this
variable by using the SEQTRANS auxiliary DFB is recommended.
The signals are automatically set to 0 by the DFB after the signal
is processed.
DESTW WORD Write access
Allows the definition of the state of up to 6 transitions (bits 0 to 5)
that originate with the current step. As an alternative, forcing the
value of this variable by using the SEQTRANS auxiliary DFB is
recommended.
The signals are automatically set to 0 by the DFB after the signal
is processed.
ETIME BOOL Read-only access (see page 528)
RUNNINGX BOOL Read-only access
1 = Indicates that the current state of the sequence is Holding
or Holding for Detected Error.

EIO0000002093 04/2020 533

SEQCTL1

Name Type Description

HOLDINGX BOOL Read-only access
1 = Indicates that the current state of the sequence is Holding
or Holding for Detected Error.
CURRENTITEM BOOL Read-only access
1 = Indicates the current position of the list of steps in Manual
mode. The value –1 indicates that there has been a mode change
and -2 indicates that the mode change has been identified.
NEWCYCLE BOOL Read-only access
1 = Indicates that a new sequence state machine execution cycle
has started.
UPDATESTEPD BOOL Read-only access
1= Internal mark indicates the need for updating the steps
descriptions.

The following elements (status) are described in the Status Controller section (see page 523). The
Definition of Statuses and Commands (see page 520) shows the sequence finite state controller.

Status Type Description

Idle BOOL Read-only access
1 = Indicates that the current state of the sequence is Idle.
Running BOOL Read-only access
1 = Indicates that the current state of the sequence is Running.
Complete BOOL Read-only access
1 = Indicates that the current state of the sequence is Complete.
Pausing BOOL Read-only access
1 = Indicates that the current state of the sequence is Pausing.
Paused BOOL Read-only access
1 = Indicates that the current state of the sequence is Paused.
Holding BOOL Read-only access
1 = Indicates that the current state of the sequence is Holding.
HoldingFE BOOL Read-only access
1 = Indicates that the current state of the sequence is Holding or
Holding for Detected Error.
Held BOOL Read-only access
1 = Indicates that the current state of the sequence is Held.
HeldFE BOOL Read-only access
1 = Indicates that the current state of the sequence is Held for
detected error.
Restarting BOOL Read-only access
1 = Indicates that the current state of the sequence is Restarting.

534 EIO0000002093 04/2020

 SEQCTL1

Status Type Description

Stopping BOOL Read-only access
1 = Indicates that the current state of the sequence is Stopping.
Stopped BOOL Read-only access
1 = Indicates that the current state of the sequence is Stopped.
Aborting BOOL Read-only access
1 = Indicates that the current state of the sequence is Aborting.
Aborted BOOL Read-only access
1 = Indicates that the current state of the sequence is Aborted.

EIO0000002093 04/2020 535

SEQCTL1

536 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Auxiliary Functions
EIO0000002093 04/2020

Chapter 51
Auxiliary Functions of Sequential Control

Auxiliary Functions of Sequential Control

Overview
This section describes the function blocks that supplement the SEQCTL1 DFB and that have the
objective of facilitating the programming of the control sequence.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
51.1 SEQTRANS 538
51.2 SEQFAILED 543
51.3 SEQSTABLESTEP 546
51.4 SEQSTEPDESC 549

EIO0000002093 04/2020 537

Auxiliary Functions

Section 51.1
SEQTRANS

SEQTRANS

Overview
This section describes the SEQTRANS DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 539
Inputs 541
Inputs/Outputs 542

538 EIO0000002093 04/2020

 Auxiliary Functions

Description

General
The main objective of SEQTRANS DFB is to set up the control sequence transitions based on the
condition to be evaluated and the next step to be executed when this expression is fulfilled.
Additionally, the DFB manages the information necessary to graphically represent the state of the
transitions and steps following the current step (DEST and DESTW fields of the SEQCTL1_ST_DDT
sequence state structure).
Include call to this function in the logic of the steps (normally in ST language) to program the
transitions between the sequence steps.

Function Call
The function call is carried out from the steps of the control subsequences (Running, Restarting,
Holding, and so on) normally in ST language to program the transitions between these steps.
If several SEQTRANS calls are included in the same step and if more than one of them is fulfilled in
the same step execution cycle, the step corresponding to the transition that is fulfilled and was
programmed first will run. The number of SEQTRANS calls from one single step is limited to 6.
TRANS (CONDITION := (*BOOL*),
DESC := (*string[22]*),
NEXTSTEP := (*INT*),
SEQCTL1_SC := (*SEQCTL1_SC_DDT*)
SEQCTL1_ST := (*SEQCTL1_ST_DDT*),
SEQCTL1_CFG := (*SEQCTL1_CFG_DDT*))
A function call example is included below:
4: (Wait for end of reactive dosing)
if SSC.ONENTRY then
BISEN2_REACT.REM:=false;
BISEN2_REACT.LSP:=true;
end_if;
BISEN2_REACT.LSPSEL:=(OP01 < (IP01 - 10.0)); (Speed 1 or 2)
TRANS ((IP01 - COLA_REACT) <= OP01, 'Dosing finished?', SSC.CSTEP+1, SSC,
SST, SCFG);

EIO0000002093 04/2020 539

Auxiliary Functions

In the previous example, the TRANS call included in step 4 of the sequence corresponds to a
SEQTRANS block instance to which the following parameters are passed:
 (IP01 - COLA_REACT) <= OP01OS: Corresponds to the expression of the condition that
needs to be fulfilled for the transition to be executed. You can include complex expressions that
result in a Boolean value (true or false).
 Dosing finished?: Corresponds to the description of the transition.
 SSC.CSTEP+1: Corresponds to the next step that needs to be executed when the transition is
fulfilled. In this case, the next step (step 5) is executed after the current step (step 4). You can
include any expression jumping to an existing step in the sequence.
 SSC: Corresponds to the SC public variable of the SEQCTL1 block instance that is controlling the
sequence execution.
 SST: Corresponds to the DDT_ST variable of the SEQCTL1 block instance that is controlling the
sequence execution.
 SCFG: Corresponds to the DDT_CFG variable of the SEQCTL1 block instance that is controlling
the sequence execution.

540 EIO0000002093 04/2020

 Auxiliary Functions

Inputs

Input Parameter Description

Parameter Type Description

CONDITION BOOL 1 = Indicates that the condition for executing the
transition is fulfilled.
DESC STRING[22] Provides the description of the transition to be
represented in the monitoring program. The character
string is limited to 20 characters.
NEXTSTEP INT Subsequence step number to which a jump needs to be
made when the transition is fulfilled. Refer to the
CONDITION input. The permissible values for the steps
go from 1 to 999 with the exception of NEXTSTEP to -1.
This indicates that when the transition is fulfilled, the
corresponding subsequence (to go, for example, from
Running to Complete, from Holding to Held, and so on)
will be completed.

EIO0000002093 04/2020 541

Auxiliary Functions

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SEQCTL1_SC SEQCTL1_SC_DDT Corresponds to the SC public variable of the
SEQCTL1 block instance that is controlling the
sequence execution.
SEQCTL1_ST SEQCTL1_ST_DDT Provides the data necessary to communicate
with the SEQCTL1 block that is controlling the
sequence. Refer to the SEQCTL1 block
(see page 525) for more details.
SEQCTL1_CFG SEQCTL1_CFG_DDT Provides the data necessary to communicate
with the SEQCTL1 block that is controlling the
sequence. Refer to the SEQCTL1 block
(see page 525) for more details.

542 EIO0000002093 04/2020

 Auxiliary Functions

Section 51.2
SEQFAILED

SEQFAILED

Overview
This section describes the SEQFAILED DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 544
Inputs/Outputs 545

EIO0000002093 04/2020 543

Auxiliary Functions

Description

General
The main objective of the SEQFAILED DFB is to report detected errors to the sequence
management block (SEQCTL1) during sequence execution so that the HoldingFE subsequence
is triggered.

Function Call
The function call is made from the Running, Restarting, Pausing, or Paused control subsequence
steps normally in ST language with the purpose of reporting detected errors in the process that is
being controlled. The detected error requires the hold sequence to be executed (HoldingFE).
A function call example is included below:
(Detected failure condition monitoring after initializations)
if SEQCTL1.CSTEP > 0 and CONDFALLO then
FAILED (SeqCtl1); (Trigger execution of the Hold sequence)
end_if;
In the previous example, the FAILED call that is included in the logic monitors the detected error
conditions in each execution cycle (in this particular case, but could be associated with a specific
step) corresponds to a SEQFAILED DFB block instance to which the following parameters are
passed:
 Seqctl1: Corresponds to the name of the SC public variable of the SEQCTL1 block instance
that is controlling the execution of the sequence.

544 EIO0000002093 04/2020

 Auxiliary Functions

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SEQCTL1_SC SEQCTL1_SC_DDT Provides the data necessary to communicate
with the SEQCTL1 block that is controlling the
sequence. Refer to the SEQCTL1 block
(see page 525) for more details.

EIO0000002093 04/2020 545

Auxiliary Functions

Section 51.3
SEQSTABLESTEP

SEQSTABLESTEP

Overview
The section describes the SEQSTABLESTEP DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 547
Inputs/Outputs 548

546 EIO0000002093 04/2020

 Auxiliary Functions

Description

General
The main objective of the SEQSTABLESTEP DFB is to report to the sequence management block
(SEQCTL1) that the current running sequence step corresponds to a step, that is, the re-entry point
in the normal execution (Running) sequence executes after restarting execution (Restarting).

Function Call
The function call is performed from the Running control subsequence steps normally in ST
language for the purpose of reporting. The current step is the entry point to which the program
should return when the Running subsequence is resumed after finishing the Restarting
subsequence. Basically, it enables to resume the sequence execution that verifies the appropriate
actions are performed or not.
For example, suppose a valve has to be opened. After the valve is opened, the next step involves
turning on a pump. While waiting for the valve to open, a detected failure that makes the sequence
stop occurs (Holding subsequence execution). You can resume execution by running the restart
(Restarting) subsequence. After this, the program returns to the normal running subsequence
(Running). After the program goes back to this Running subsequence, the intention is to make
another attempt at opening the valve (because most likely, it has been closed during the Holding
subsequence) not to start the pump in proceeding directly. Therefore, in the valve opening step,
the step is marked and does not call the function SEQSTABLESTEP in the pump starting step.
The following is an example of a function call:
0: (End Water dosing)
if SeqCtl1.ONENTRY then
RAMP_AGUA.LSTART:=false;
FIC_AGUA.REM:=false;
FIC_AGUA.MAN:=true;
FIC_AGUA.LOP:=0.0;
VALV_AGUA.LSP:=false;
STABLESTEP (SeqCtl1);
end_if;
TRANS (VALV_AGUA.LOWPOS, SEQCTL1.CSTEP+1, SeqCtl1);
In the previous example, the STABLESTEP call included in the logic that monitors detected failure
conditions in each execution cycle (in this particular case, but it could be associated with a specific
step) corresponds to a SEQSTABLESTEP DFB block instance to which the following parameters are
passed:
 Seqctl1: Corresponds to the name of the SC public variable of the SEQCTL1 block instance
that is controlling the sequence execution.

EIO0000002093 04/2020 547

Auxiliary Functions

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SEQCTL1_SC SEQCTL1_SC_DDT Provides the data necessary to communicate with
the SEQCTL1 block that is controlling the sequence.
Refer to the SEQCTL1 block (see page 525) for
more details.

548 EIO0000002093 04/2020

 Auxiliary Functions

Section 51.4
SEQSTEPDESC

SEQSTEPDESC

Overview
This section describes the SEQSTEPDESC DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 550
Inputs 552
Inputs/Outputs 553
Public Variables 554

EIO0000002093 04/2020 549

Auxiliary Functions

Description

General
The main objective of the SEQSTEPDESC DFB is to assign descriptions to the steps that are defined
in the sequence to allow you to monitor them from the Supervision system.

Function Calls
The function call is made from the control subsequence steps (Running, Restarting, Holding, and
so on) at the beginning of the code to provide the description of the subsequence steps for their
representation in the monitoring program. It is normally written in ST language.
Include as many SEQSTEPDESC calls as there are steps defined in the subsequence or as there
are steps that need to be represented in the Supervision system.
The syntax of the function is the following:
STEPDESC (STEPNUMBER := (INT),
DESC := (string[18]),
SEQCTL1_SC := (SEQCTL1_SC_DDT),
SEQCTL1_ST := (SEQCTL1_ST_DDT),
SEQCTL1_CFG := (SEQCTL1_CFG_DDT),
The following is an example of a function call:
(Running or Pausing Subsequence (302 / 314))
(Step descriptions)
STEPDESC (1, 'Init', SSC, SST, SCFG);
STEPDESC (2, 'Valves ON', SSC, SST, SCFG);
STEPDESC (3, 'Wait Valves ON', SSC, SST, SCFG);
STEPDESC (4, 'Dosing Reactive', SSC, SST, SCFG);
STEPDESC (5, 'Motor OFF', SSC, SST, SCFG);
STEPDESC (6, 'Waiting for queue', SSC, SST, SCFG);
(Steps and Transitions)
case SSC.CSTEP of
1: (#RunningStep0# Initial Step)
(Check initial conditions)
if IC_FAIL then
FalloCI := true;
FAILED (SSC); (Initial conditions not satisfied)

550 EIO0000002093 04/2020

 Auxiliary Functions

else
FalloCI := false;
(Initialization)
In the above example, the STEPDESC calls included at the beginning of the subsequence
correspond to a SEQSTEPDESC DFB block instance to which the following parameters are passed
in case of the first call:
 1: Corresponds to step number 1.
 Init: Corresponds to the definition of the step.
 SSC: Corresponds to the SC public variable of the SEQCTL1 block instance that is controlling the
sequence execution.
 SST: Corresponds to the DDT_ST variable of the SEQCTL1 block instance that is controlling the
sequence execution.
 SCFG: Corresponds to the DDT_CFG variable of the SEQCTL1 block instance that is controlling
the sequence execution.

EIO0000002093 04/2020 551

Auxiliary Functions

Inputs

Input Parameter Description

Parameter Type Description

STEPNUMBER INT Number of the subsequence step. The values allowed for
the steps are from 1 to 999.
DESC STRING[22] Description of the number of the subsequence step. The
character string is limited to 17 characters. This is the
value that will be shown in the sequence monitoring
program.

552 EIO0000002093 04/2020

 Auxiliary Functions

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SEQCTL1_SC SEQCTL1_SC_DDT Provides the data necessary to communicate
with the SEQCTL1 block that is controlling the
sequence. Refer to the SEQCTL1
(see page 525) block for more details.
SEQCTL1_ST SEQCTL1_ST_DDT Provides the data necessary to communicate
with the SEQCTL1 block that is controlling the
sequence. Refer to the SEQCTL1
(see page 525) block for more details.
SEQCTL1_CFG SEQCTL1_CFG_DDT Provides the data necessary to communicate
with the SEQCTL1 block that is controlling the
sequence. Refer to the SEQCTL1
(see page 525) block for more details.

EIO0000002093 04/2020 553

Auxiliary Functions

Public Variables

Public Variable Description

Parameter Type Description

ORDERNUMBER INT Read-only public variable reserved for building the list of
steps in manual mode that will be shown in the monitoring
program.
MAXORDERNUMBER INT Read-only public variable reserved for building the list of
steps in manual mode that will be shown in the monitoring
program.

554 EIO0000002093 04/2020

 Modicon Libraries General Purpose
SEQPARxx
EIO0000002093 04/2020

Chapter 52
SEQPARxx - Sequence Parameter Management

SEQPARxx - Sequence Parameter Management

Overview
This chapter describes the SEQPARxx DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 556
DFB Representation 557
Inputs 558
Outputs 559
Inputs/Outputs 560
Public Variables 562

EIO0000002093 04/2020 555

SEQPARxx

Description

General
The SEQPAR05, SEQPAR10 and SEQPAR16 DFBs manage up to 5, 10, and 16 sequence
parameters (input, output, and reports) respectively. The DFBs facilitate the management of
parameters from advanced control sequences implemented with the General Purpose Library
SEQCTL1 DFB.
These DFBs manage the sequence parameters with a data structure (DDT) making it easier to
implement reusable control sequences (the number of pins in a DFB is limited to 32 input pins and
32 output pins) because a single variable is used to provide access to the data that the sequence
manages.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Input Parameter Optionally, the DFB initializes the values of the input parameters with a value (-
Consistency 0.0) that enables to determine whether or not the applicable parameters of the
sequence have been correctly downloaded onto the controller. This way, the
sequence can be stopped from starting with an incomplete or inconsistent set of
input parameters.
Owner The DFB manages control system level, which is the owner (Operator or
Program) based on the owner of the associated sequence. As a result, it is
responsible for defining the input parameters of the sequence.
Output Parameters The DFB manages the output parameters generated from the control sequence.
Report Parameters The DFB copies the output parameters to report parameters when the sequence
ends and maintains them until the next sequence end. This facilitates the
acquisition of these parameters from the monitoring subsystem to generate
reports.

556 EIO0000002093 04/2020

 SEQPARxx

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 557

SEQPARxx

Inputs

Input Parameter Description

Parameter Type Description

IPCHECKMASK WORD Optionally, enables to connect a bits word (16) to configure
applicable input parameters. Only the applicable parameters will
be checked for consistency. Refer to the IPRESETEN input and
IPERROR output pin (see page 559).
If no data is connected to this input, the consistency check for input
parameter is disabled.
Bit SP is calculated as:

0 (20) Input parameter 1 is applicable (1) or not (0).

1 (21) Input parameter 2 is applicable (1) or not (0).

... ...
15
15 (2 ) Input parameter 16 is applicable (1) or not (0).
IPRESETEN BOOL 1 = Enables to configure the input parameters need to be initialized
with the -0.0 value when the associated control sequence switches
to an Idle status.
This configuration together with the IPCHECKMASK input pin is
used to determine whether or not the input parameters are
correctly downloaded (refer to the IPERROR output pin
(see page 559)).
SEQCTL1_ST SEQCTL1_ST_DDT Enables to connect the state structure of the control sequence for
which the parameters need to be managed. The DFB uses this
structure to determine the state of the sequence (Idle, Running and
so on) and its owner (Operator or Program).

558 EIO0000002093 04/2020

 SEQPARxx

Outputs

Output Parameter Description

Parameter Type Description

IPERROR BOOL 1 = A detected error in the assignment.
0 = The check is not activated.
The check is only carried out if the IPCHECKMASK input is
connected. If the IPCHECKMASK input is connected, a check is
run to verify whether the applicable parameters as defined in
the connected bit mask have a value other than -0.0 or not. The
responsibility of assigning the -0.0 value belongs to the DFB or
the programmer depending on how the IPRESETEN input is
configured.

EIO0000002093 04/2020 559

SEQPARxx

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SEQPARxx_ST SEQPARxx_ST_DDT Provides the data that is necessary for managing the types of
parameters that the DFB manages input, output, and report.

SEQPARxx_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and
allows data to be kept in the memory. Read-only access to the data contained
in this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem.
Read/write access to the data contained in this word.
IP01 REAL Read/write access
Input parameter 1.
Input parameter management:
 The DFB initializes the input parameters with a value of -0.0 if the
IPRESETEN input is enabled when the sequence state switches to Idle.
 If the owner of the control sequence is the Operator (SEQCTL1_ST.CFGW.0
= 1), this data is copied to the IPxx fields of the SC public variable. In other
words, the input parameters are received from the monitoring or batch control
subsystem in the Operator mode.
 If the owner of the control sequence is the Program (SEQCTL1_ST.CFGW.0
= 0), the input parameters are overwritten with the data in the IPxx fields of
the SC public variable.
... ...
IPxx REAL Read/write access
Input parameter xx.
OP01 REAL Read-only access
Output parameter 1.
Output parameter management:
 The values in the OPxx fields of the SC public variable are continuously
copied to these output parameters so that they can be accessed from the
monitoring subsystem. Therefore, the control sequence of the user needs to
define the value of the OPxx parameters of the SC public variable to indicate
the results of the execution of the sequence.
... ...
OPxx REAL Read-only access
Output parameter xx.

560 EIO0000002093 04/2020

 SEQPARxx

Name Type Description

RPT01 REAL Read-only access
Report parameter 1.
Report parameter management:
 The SEQPARxx DFB copies the values of the output parameters to the report
parameters when the execution of the associated control sequence ends (it
switches to the Complete, Stopped, or Aborted state) to facilitate their
acquisition from the report subsystem.
Refer to the NEWDATA (SEQPARxx_ST.STW.0) input/output.
... ...
RPTxx REAL Read-only access
Report parameter xx.

SEQPARxx_ST.STW Word Structure

DFB status word. Read-only access. The following table describes the SEQPARxx_ST.STW Word
structure:

Bit Name Description

0 NEWDATA Indicates that new data (1) is available in the report parameters
(RPTxx fields of the SEQPARxx_ST structure). The DFB activates this
signal when the control sequence switches to Complete, Stopped, or
Aborted and deactivates this signal (0) when its processing is
confirmed from the RPTACK (SEQPARxx_ST.CFGW.0) signal.
1 IPERROR Refer to the IPERROR output pin (see page 559).

SEQPARxx_ST.CFGW Word Structure

Provides the data needed to configure the DFB normally from the monitoring subsystem. The
following table describes the SEQPARxx_ST.CFGW Word structure:

Bit Name Description

0 RPTACK Read/write access
Enables to reset the NEWDATA (SEQPARxx_ST.STW.0) signal. This
signal is automatically set to 0 by the DFB after it has been processed.

EIO0000002093 04/2020 561

SEQPARxx

Public Variables

Public Variable Description

Variable Type Description

SC SEQPARxx_SC_DDT Provides the data needed to manage the parameters of a sequence
from the control sequence itself or from a different external
mechanism.

SEQPARxx_SC_DDT Type

Name Type Description

IPERROR BOOL Read-only access
Refer to the IPERROR output pin (see page 559).
IP01 REAL Read/write access
Input parameter 1.
Input parameter management:
 The DFB initializes the input parameters with a value of -0.0 if the
IPRESETEN input is enabled when the sequence status switches to Idle.
 If the owner of the control sequence is the Operator (SEQCTL1_ST.CFGW.0
= 1), this data is copied to the IPxx fields of the SC public variable. In other
words, the input parameters are received from the monitoring or batch
control subsystem in the Operator mode.
 If the owner of the control sequence is the Program (SEQCTL1_ST.CFGW.0
= 0), the input parameters are overwritten with the data in the IPxx fields of
the SC public variable.
... ...
IPxx REAL Read/write access
Input parameter xx.
OP01 REAL Read/write access
Output parameter 1.
Output parameter management:
 The values in the OPxx fields of the SC public variable are continuously
copied to these output parameters so that you can access the parameters
from the monitoring subsystem. Therefore, the control sequence of the user
needs to define the value of the OPxx parameters of the SC public variable
to indicate the results of the sequence execution.
... ...
OPxx REAL Read/write access
Output parameter xx.

562 EIO0000002093 04/2020

 Modicon Libraries General Purpose
SEQCTL1 - Example of Use
EIO0000002093 04/2020

Chapter 53
SEQCTL1 - Example of Use

SEQCTL1 - Example of Use

Overview
This chapter describes the example use of the SEQCTL1DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 564
DFB Representation 565
Reusable Sequence Logic 566

EIO0000002093 04/2020 563

SEQCTL1 - Example of Use

Description

General
This chapter gives an example of an advanced control sequence controlled by the SEQCTL1,
SEQTRANS, SEQSTABLESTEP, SEQFAILED, and SEQSTEPDESC DFBs.
The objective of the sequence is to control the loading of water in a process unit. For this purpose,
a reusable component (DFB) is created so that you can use this sequence in different process units
by only changing the connections of the component pins.

Reusable Sequence Definition

The reusable DFB of the user, PHWATER, declares the SEQCTL1 SEQCTL_Instance variable to
manage the state of the sequence.

NOTE: Declaration of the auxiliary components manages the transitions (SEQTRANS), steady-step
flags (SEQSTABLESTEP), and notifications to trigger the holding subsequence (SEQFAILED).

564 EIO0000002093 04/2020

 SEQCTL1 - Example of Use

DFB Representation

Representation
The following diagrams include the calls to the sequence created by the user as well as to the
control block that will control it (SEQCTL1).

NOTE: The call to the block controls the execution of the advanced control sequence.

NOTE: The call to the functional block implements the control sequence of the user and will reuse
for different process units if needed.

EIO0000002093 04/2020 565

SEQCTL1 - Example of Use

Reusable Sequence Logic

Sequence Logic With Description

The basic structure of the sequence as well as the steps that are defined for the sequence
objective are included: water dosing. The parts of the code that make up the basic structure of the
sequence are marked in bold.
(Initialization)
The following common actions have to be executed before the sequence execution:
Running := SSC.RUNNINGX;
Holding := SSC.HOLDINGX;
Restarting := SSC.RESTARTINGX;
Aborting := SSC.ABORTINGX;
Stopping := SSC.STOPPINGX;
NOTE: The default actions to be taken by DFB are defined in this section. However, if any section
has to be added by user and actions need to be taken before execution of that section, it has to be
added here.

(Running or Pausing Subsequence (302/314))

STEPDESC (1, 'Init', SSC, SST, SCFG);
STEPDESC (2, 'Valves ON', SSC, SST, SCFG);
STEPDESC (3, 'Wait Valves ON', SSC, SST, SCFG);
STEPDESC (4, 'Dosing Water', SSC, SST, SCFG);
STEPDESC (5, 'Valves OFF', SSC, SST, SCFG);
STEPDESC (6, 'Waiting for queue', SSC, SST, SCFG);
NOTE: Definition of the descriptions for the subsequence steps.
(Steps and Transitions)
case SSC.CSTEP of
1: (#RunningStep0# Initial Step)
NOTE: First step with a value of 1. The allowed values for steps are 1 to 999.
(Check initial conditions)
if IC_FAIL then
FalloCI := true;
FAILED (SSC); (Initial conditions not satisfied)
NOTE: Report detected failure to trigger the holding subsequence.

566 EIO0000002093 04/2020

 SEQCTL1 - Example of Use

else
FalloCI := false;
(Initializations)
OP01:=0.0;
(Reset and water totalizer activation)
FQ_AGUA.TOTALRST:=true;
FQ_AGUA.TOTALEN:=true;
TRANS (true, 'True', SSC.CSTEP+1, SSC, SST, SCFG); (Next Step)
NOTE: Unconditional transition to the next step.
end_if;
2: (Start Water dosing)
if SSC.ONENTRY then
STABLESTEP (SSC); (In this step, execution would restart in the event of Hold/Continue)
NOTE: Execute the actions only for the first time.
NOTE: Flag this step as steady.
DOSIF_AGUA:=true;
VALV_AGUA.REM:=false;
VALV_AGUA.LSP := true;
FCV_AGUA.REM:=true;
FIC_AGUA.REM:=false;
FIC_AGUA.MAN:=true;
FIC_AGUA.LOP:=10.0; (Initial valve opening)
end_if;
TRANS (true, 'trans1', SSC.CSTEP+1, SSC, SST, SCFG); (Next step)
TRANS (false, 'trans2', SSC.CSTEP+2, SSC, SST, SCFG); (Next step)
TRANS (false, 'trans3', SSC.CSTEP+3, SSC, SST, SCFG); (Next step)
TRANS (false, 'trans4', SSC.CSTEP+4, SSC, SST, SCFG); (Next step)
TRANS (false, 'trans5', SSC.CSTEP+5, SSC, SST, SCFG); (Next step)
TRANS (false, 'trans6', SSC.CSTEP+6, SSC, SST, SCFG); (Next step)
NOTE: The evaluation priority for these transitions is the order in which they are shown (up down;
these transitions are not functional, and have only been included as an example in this case). You
can define a maximum of 6 transitions.

EIO0000002093 04/2020 567

SEQCTL1 - Example of Use

3: (Wait for open valve)

TRANS (VALV_AGUA.HIGHPOS, 'Valve open?', SSC.CSTEP+1, SSC, SST, SCFG);
(Next step)
4: (Wait for end of Water dosing)
if SSC.ONENTRY then
RAMP_AGUA.REM := false; (Setpoint flow ramp)
RAMP_AGUA.LTARGETSP:=IP02; (Target set-point)
RAMP_AGUA.LSTART:=true
FIC_AGUA.REM:=true;
FIC_AGUA.AUTO:=true;
FIC_AGUA.LSP:=IP02; (Flow regulation)
end_if;
TRANS ((IP01 - COLA_AGUA) <= OP01, 'Dosing finished?', SSC.CSTEP + 1,
SSC, SST, SCFG);
5: (End Water dosing)
if SSC.ONENTRY then
RAMP_AGUA.LSTART:=false;
FIC_AGUA.REM:=false;
FIC_AGUA.MAN:=true;
FIC_AGUA.LOP:=0.0;
VALV_AGUA.LSP:=false;
STABLESTEP (SSC); (In this step, execution will restart in the event of Hold/Continue)
end_if;
TRANS (VALV_AGUA.LOWPOS, 'Valve Closed?', SSC.CSTEP+1, SSC, SST, SCFG);
6: (Wait for Water queue)
if SSC.ONENTRY then
(Wait for COLA_AGUA (Water queue) to fall)
STABLESTEP (SSC); (In this step, execution will restart in the event of Hold/Continue)
end_if;
TRANS (SSC.ETIME >= 50, 'Waiting for queue', -1, SSC, SST, SCFG); (End of
sequence)
NOTE: Complete sequence (go to COMPLETE) when the transition condition is met.

568 EIO0000002093 04/2020

 SEQCTL1 - Example of Use

end_case;
(Actions common to several steps)
(Detected failure condition monitoring after initializations)
if SSC.CSTEP > 0 and FC then
FAILED (SSC); (Trigger execution of the Hold sequence)
end_if;
(Holding Subsequence (316/326))
STEPDESC (1, 'Init', SSC, SST, SCFG);
STEPDESC (1, 'Closing Valves', SSC, SST, SCFG);
Steps and Transitions)
case SSC.CSTEP of
1: (Initial Step)
if FalloCI then
dosif_agua:=false;
end_if;
TRANS (FalloCI, 'Not InitCond', -1, SSC, SST, SCFG); (End of sequence)
TRANS (NOT FalloCI, 'InitCond OK', SSC.CSTEP+1, SSC, SST, SCFG); (Next step)
2:
if SSC.ONENTRY then
VALV_AGUA.LSP:=false;
RAMP_AGUA.LSTART:=false;
FIC_AGUA.MAN:=true;
FIC_AGUA.LOP:=0.0; (Close control valve)
end_if;
If (dosif_agua) AND SSC.ETIME >= 50 then
dosif_agua:=false;
end_if;
TRANS (SSC.ETIME >= 50 or not dosif_agua, 'Waiting for queue', -1, SSC,
SST, SCFG); (End of sequence)
end_case;
(Restarting subsequence(318))
STEPDESC (1, 'Init', SSC, SST, SCFG);

EIO0000002093 04/2020 569

SEQCTL1 - Example of Use

(Steps and Transitions)

case SSC.CSTEP of
1: (Initial Step)
TRANS (true, 'True', -1, SSC, SST, SCFG); (End of sequence)
end_case;
(Aborting subsequence(310))
STEPDESC (1, 'Closing Valves', SSC, SST, SCFG);
(Steps and Transitions)
case SSC.CSTEP of
1: (Initial Step)
VALV_AGUA.REM:=false;
VALV_AGUA.LSP:=false;
RAMP_AGUA.LSTART:=false;
FIC_AGUA.MAN:=true;
FIC_AGUA.LOP:=0.0; (Close control valve)
dosif_agua:=false;
TRANS (true, 'True', -1, SSC, SST, SCFG); (End of sequence)
end_case;
(Stopping subsequence(312))
STEPDESC (1, 'Closing Valves', SSC, SST, SCFG);
STEPDESC (2, 'Waiting for queue', SSC, SST, SCFG);
Steps and Transitions)
case SSC.CSTEP of
1: (Initial Step)
VALV_AGUA.REM:=false;
VALV_AGUA.LSP:=false;
RAMP_AGUA.LSTART:=false;
FIC_AGUA.MAN:=true;
FIC_AGUA.LOP:=0.0; (Close control valve)
TRANS (true, 'True', SSC.CSTEP+1, SSC, SST, SCFG); (Next step)
2:
If (dosif_agua) AND SSC.ETIME >= 50 then

570 EIO0000002093 04/2020

 SEQCTL1 - Example of Use

dosif_agua:=false;
end_if;
TRANS (SSC.ETIME >= 50 or not dosif_agua, 'Waiting for queue', -1, SSC,
SST, SCFG); (End of sequence)
end_case;

Common
Common actions to be executed after the sequence execution.
NOTE: No default actions are defined in this section. However, if any action has to be taken after
execution of section, it has to be added here.

EIO0000002093 04/2020 571

SEQCTL1 - Example of Use

572 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Batch Phase Manager
EIO0000002093 04/2020

Part VII
Batch Phase Manager

Batch Phase Manager

Overview
This part provides a detailed description of the functions, pins, pin layout, and variables of the
function blocks of the Batch phase manager.
These function blocks do not reflect any specific installation.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000002093 04/2020 573

Batch Phase Manager

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
54 Batch Phase Manager 575
55 IBPHASE - Individual Batch Phase Manager 585
56 Auxiliary Functions of Batch Phase 601
57 IBPARxx - Batch Phase Parameter Management 619
58 USERPHASExx - User Defined Process Logic 627
59 IBPHASE - Example of Use 631

574 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Batch Phase Manager
EIO0000002093 04/2020

Chapter 54
Batch Phase Manager

Batch Phase Manager

Overview
This chapter describes the Batch phase management.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description of Batch Phase Manager 576
Definition of Phase Statuses, Batch Phase Statuses, Phase Commands and Batch Phase 578
Commands
Status Matrix 581
Status Controller 582
Operating Modes 583

EIO0000002093 04/2020 575

Batch Phase Manager

Description of Batch Phase Manager

Overview
The operation of the function block that is available for Batch Phase Manager is described in this
chapter.
The IBPHASE DFB belongs to the General Purpose Library and is used to monitor and manage
control phases with InBatch tool. The module is based on the ISA-S88 Standard, Part 1 (S88.01i)
and implements the status controller defined in this standard for controlling procedure model
components (phases, operations, and so on). Prior knowledge about the InBatch tool will facilitate
to understand the Batch phase manager block.

Function Description
You can use this DFB to change states in the process. In compliance with ISA-S88.01i, you can
use this DFB to initiate start, stop or emergency phases. In batch processes, this DFB can be used
to set up phases and operations.
The DFB implements phase state management and processes the commands received from:
 The Supervision system (when phases are manually controlled by the operator)
 The batch control subsystem (in which case the subsystem sends the commands and checks
the status of the phase to determine what action to take)
 Other control phases

The table compares the functions that are available in the DFB:

Function IBPHASE
Management of state machine and commands according to ISA-S88 x
Management of operating modes according to ISA-S88: Manual (enables to x
change from one phase step to any other phase step), Semi (step advance with
confirmation from the operator), and Auto
Owner Management: Operator/Program x
Step time automatically calculated by the control block x
Automatic management of transitions through the IBTRANS function block x
Automatic management of phase detected failure through the IBFAILED x
function block
Automatic management of phase steady-step marking through the x
IBSTABLESTEP function block
Possibility of displaying the phase graphically (active step and next level of x
transitions and steps) from the monitoring subsystem
NOTE: ‘x’ indicates that the functions are available in the DFB.

576 EIO0000002093 04/2020

 Batch Phase Manager

Program the steps and transitions that the phases implement (through ST or SFC language) while
the component (IBPHASE) allows the programmer to:
 Manage the statuses of the phase and
 Process the commands received from other levels as described above.

As a minimum, implement the subphase that implements normal operation (RUNNING).

Other user can implement subphases that attend to commands received from other levels of the
control system or that react to detected failures in the process (HOLDING, RESTARTING,
STOPPING, and ABORTING) detected by the phase itself.
The table describes the main functions of the DFB:

Function Description
Processing States and The DFB processes the commands received and determines
Commands the status of the control phase with the objective of determining
the subphases (normal, hold, continue, abort, so on.) and which
step needs to run in each cycle of the program.
Managing Entry Points in the The DFB enables to retain the step number with which the
Phase execution of the normal phase (Running) needs to be restarted
(Restart) after being restarted from held status (Held).
Handling of Detected The component manages controller detected failures (without
Failures user intervention from the Supervision system). The component
manages this detected failure and triggers the execution of the
detected failure handling subphase.
Auto reset disable Automatic reset (STOPPED →IDLE, automatically performs
reset operation without consuming any extra execution cycle)
can be disabled by setting the input pin (AUTORESETDIS) to a
logical high when Owner is Operator.

EIO0000002093 04/2020 577

Batch Phase Manager

Definition of Phase Statuses, Batch Phase Statuses, Phase Commands and Batch
Phase Commands

Statuses
The table describes the phase statuses and their descriptions:

Status Description
Idle Inactive operation. Waiting for command to start (Start) running.
Running Normal operation.
Held Operation put on hold. Waiting for command to Restart (Restart) to get operation to
running.
HeldForError Operation put on hold due to detected fail condition. Waiting for command to Restart
(Restart) to get operation to running.
Stopped Operation stopped. Waiting for command to get state (Reset) to Idle.
Paused Operation paused. Waiting for command to get state (Resume) to running.
Aborted Operation canceled. Waiting for command to get state (Reset) to get operation to Idle.
Complete Normal operation has finished. Requires an initialization order (Reset) to return to the
Idle status.
Holding A hold (Hold) command is received and the phase that allows the process to be changed
to a known status is executed. After this phase is finished, it automatically goes to the
held (Held) status.
HoldingForError A detected failure is automatically detected in the process (for example, a detected
failure in a control module), and the phase that allows the process to be changed to a
known status is executed. After this phase is finished, it automatically goes to the held
(HeldForError) status.
Restarting A restart command (Restart) is received while the phase is being held (Held). The phase
returns to the normal operation phase (Running). The normal operation status (Running)
is set automatically after the phase is complete.
Pausing A pause (Pause) command is received for a short period while the normal operation was
being executed (Running). The normal phase runs until it automatically goes to paused
(Paused) status.
Stopping An order to stop (Stop) has been received. To finish the phase in a controlled way is
executed (it is not possible to continue with it). The stopped operation status (Stopped)
is automatically activated after the phase is complete.
Aborting An order to end (Abort) has been received. A fast stop, which is not necessarily controlled
is executed. The aborted operation status (Aborted) is automatically activated after the
phase is completed.
Interlocked Operation cannot start as initial conditions are not met.

The (Held) status can also be reached (without receiving a command) if the control phase itself
detects a problem situation. The DFB has a signal that allows this situation to be communicated.

578 EIO0000002093 04/2020

 Batch Phase Manager

The DFB has the necessary means to be able to restart the Running phase from the last steady
step in which the initial run was held by a Hold command.

Batch Phase Statuses

The table describes the Batch phase statuses and their descriptions:

IBSTATE Description
IBREADY Ready for operation. The phase state is in Idle.
IBRUN Normal operation. The phase can be in Running, Restarting, Stopping, Aborting,
Holding, Pausing and Paused states.
IBHELD Operation put on hold. The phase state is in Held.
IBABORTED Operation canceled. The phase can be in Stopped or Aborted states.
IBDONE Normal operation has finished. The phase state is in Completed.
IBINTERLOCKED Operation cannot start from InBatch tool as initial conditions are not met or Owner is
Operator. The phase state is in Interlocked.

Commands
The table describes the phase commands and their descriptions:

Status Description
Start Allows the normal operation of the phase (Running) to be started.
Hold Allows the phase state to be put on hold (Holding, HoldingForError).
Restart Allows the phase state for continuing the operation (Restarting) and resume normal operation
(Running).
Stop Allows the phase state to be stopped (Running, Pausing, Paused, Holding, Held, or
Restarting) and the transition of state from running to stopping (Stopping).
Reset Triggers the transition to idle status (in Complete, Aborted, or Stopped status).
Pause Allows normal execution (Running) to be paused in the next steady phase status.
Resume Allows normal operation of the phase (Running) to be resumed from the paused (Paused)
status.
Abort Allows the phase state to be aborted (in any status except Idle, Complete, Aborting, and
Aborted) and the aborting state achieved from running (Aborting).
Completed Allows phase state to reach quiescent states or final state from certain transient states.
Stablestep 1 = Sends a command to mark the current step as a steady step, that is, the step with which
the phase will resume after its is held or the step on which the phase will be held after the
phase is paused.
0 = The signal is automatically set to 0 by the DFB after the signal is processed.

EIO0000002093 04/2020 579

Batch Phase Manager

Batch Phase Commands

The table describes the Batch phase commands and their descriptions:

IBCOMMAND Description
IBSTART Allows the normal operation of the phase (IBRUN) to be started.
IBHOLD Allows the InBatch to be put on hold (IBHELD).
IBRESTART Allows the InBatch for continuing the operation and resume normal operation (IBRUN).
IBRESET Triggers the transition to Ready status IBREADY when batch phase state is in IBDONE
or IBABORTED. The command is automatically triggered by InBatch tool when
IBSTATE is Done or Aborted.
IBABORT Allows the InBatch to be aborted (in any batch phase status except Ready, Done, Run
(Aborting phase state) and Aborted).

580 EIO0000002093 04/2020

 Batch Phase Manager

Status Matrix

Description
The following table describes the phase status controller that the DFB implements:

Initial State Command Activity Final State (without command)

Idle Start Running –
Running Stop Stopping Stopped
Hold Holding Held
Pause Pausing Paused
Abort Aborting Aborted
Complete Reset Idle –
Pausing Stop Stopping Stopped
Hold Holding Held
Abort Aborting Aborted
Paused Stop Stopping Stopped
Resume - Running
Abort Aborting Aborted
Hold Holding Held
Holding Stop Stopping Stopped
Abort Aborting Aborted
Held Stop Stopping Stopped
Restart Restarting Running
Abort Aborting Aborted
Restarting Stop Stopping Stopped
Hold Holding Held
Abort Aborting Aborted
Stopping Abort Aborting Aborted
Stopped Reset Idle –
Abort Aborting Aborted
Aborting No action possible
Aborted Reset Idle –

The Held status can also be reached (without receiving a command) if the control phase itself
encounters a detected error. The block has a signal that allows this situation to be communicated.
The block has the necessary means to be able to restart the Running phase from the last steady
step in which the initial run was held by a Hold command.

EIO0000002093 04/2020 581

Batch Phase Manager

Status Controller

Description
The following diagram describes the possible phases statuses and phase commands that the
Control Expert component manages according to the ISA-S88 standard:

Next to the transition arrows, the phase commands that the component receives (from the
Supervision system or another higher level phase) are shown in black, and status/commands that
phase obtains from other blocks (for example, user logic) are shown in parenthesis.

582 EIO0000002093 04/2020

 Batch Phase Manager

Operating Modes

Mode Table
The following table provides the description of the phase operating modes of IBPHASE DFB:

Operating mode Implemented as:

Automatic It is the normal running mode. The phase runs automatically based on the
transitions defined in the controller.
Semiautomatic In this operating mode, after the conditions defined in the transitions are
met, you need to confirm the move to the next step.
Manual The phase does not automatically advance to a step; user can manually
change from one phase step to another.Once the phase step is selected,
operating mode will change to semi-automatic and starts the phase step
selected in manual mode.

EIO0000002093 04/2020 583

Batch Phase Manager

584 EIO0000002093 04/2020

 Modicon Libraries General Purpose
IBPHASE - Individual Batch Phase Manager
EIO0000002093 04/2020

Chapter 55
IBPHASE - Individual Batch Phase Manager

IBPHASE - Individual Batch Phase Manager

Overview
This chapter provides a detailed description of the functions, pins, pin layout, and variables of the
IBPHASE DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 586
DFB Representation 587
Inputs 588
Inputs/Outputs 589
Public Variables 595

EIO0000002093 04/2020 585

IBPHASE - Individual Batch Phase Manager

Description

Initialization
If either the phase status is unknown or unlike any of the normal states or section is beginning with
the execution then normal state is initialized as Idle, regardless of whether a controller has
restarted or not. This initialization is done automatically.

586 EIO0000002093 04/2020

 IBPHASE - Individual Batch Phase Manager

DFB Representation

Representation
The DFB that is used in the program has the following aspect at the section level when
imported.You can use it in any of the programming languages, although it is designed for use with
the FBD language.
The figure shows an example of the IBPHASE DFB instance:

Implement the phase logic that controls the component in ST language to take advantage of the
phase control potentials making the phase reusable. That is, you can run simultaneously several
instances of the phase that you have implemented. This reduces engineering and maintenance
efforts when it is necessary to set up the same control phases in several process units.

EIO0000002093 04/2020 587

IBPHASE - Individual Batch Phase Manager

Inputs

Input Parameter Description

Parameter Type Description

AUTORESETDIS BOOL Disabling the automatic reset of the phase state, when
Owner is Operator.

588 EIO0000002093 04/2020

 IBPHASE - Individual Batch Phase Manager

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

IBPHASE_ST IBPHASE_ST_DDT Provides the necessary data for monitoring
and controlling phase execution.
IBPHASE_CFG IBPHASE_CFG_DDT Provides the necessary data for background
monitoring.

IBPHASE_ST_DDT Type

Name BitRank Name (if any) Bit Number Type Description

(if any)
ETIME - UDINT The DFB calculates the execution time
elapsed in tenths of a second for the current
step of the control phase. If execution of the
program is stopped and resumed, the
accumulated execution time is considered but
not the time that the program was stopped
IBSTATE - UINT Provides the status of the batch phase
IBREADY 0 Inactive operation. Waiting for command to
start (Start) running.
IBRUN 1 Normal operation.
IBHELD 2 Operation put on hold. Waiting for command
to Restart (Restart) to get operation to
running.
IBABORTED 6 Operation canceled. Waiting for command to
get state (Reset) to get operation to Idle
IBDONE 14 Operation completed. Waiting for command to
get state (Reset) to get operation to Idle.
IBINTERLOCKED 15 Operation cannot start from InBatch tool as
initial conditions are not met. or Owner is
Operator.

EIO0000002093 04/2020 589

IBPHASE - Individual Batch Phase Manager

Name BitRank Name (if any) Bit Number Type Description

(if any)
IBCOMMAND - UINT Enables commands to be sent to the phase
from the InBatch. The DFB sets the command
to 0 after processed (successfully or not).
IBSTART 0 Allows the normal operation of the InBatch
(Running) to be started.
IBHOLD 1 Allows the InBatch to be put on hold (Holding,
HoldingForError).
IBRESTART 2 Allows the InBatch for continuing the
operation (Restarting) and resume normal
operation (Running).
IBRESET 4 Triggers the transition to idle status (in
Complete, Aborted, or Stopped status).
IBABORT 7 Allows the InBatch for continuing the
operation (Restarting) and resume normal
operation (Running).
STATE - UINT Provides the current status of the Phase.
IDLE 0 Inactive operation. Waiting for command to
start (Start) running.
RUNNING 1 Normal operation.
HELD 2 Operation put on hold. Waiting for command
to Restart (Restart) to get operation to
running.
HELDFORERROR 3 Operation put on hold due to detected fail
condition. Waiting for command to Restart
(Restart) to get operation to running.
STOPPED 4 Operation stopped. Waiting for command to
get state (Reset) to Idle
PAUSED 5 Operation paused. Waiting for command to
get state (Resume) to running
ABORTED 6 Operation canceled. Waiting for command to
get state (Reset) to get operation to idle
COMPLETE 7 Normal operation has finished. Requires an
initialization order (Reset) to return to the Idle
status.

590 EIO0000002093 04/2020

 IBPHASE - Individual Batch Phase Manager

Name BitRank Name (if any) Bit Number Type Description

(if any)
HOLDING 8 A hold (Hold) command is received and the
phase that allows the process to be changed
to a known status is executed. After this phase
is finished, it automatically goes to the held
(Held) status.
HOLDINGFORERROR 9 A detected failure is automatically detected in
the process (for example, a detected failure in
a control module), and the phase that allows
the process to be to a known status is
executed. After this phase is finished, it
automatically goes to the held (HeldForError)
status.
RESTARTING 10 Restart command (Restart) is received while
the phase is being held (Held). The phase
returns to the normal operation phase
(Running).
PAUSING 11 Operation cannot start from InBatch tool as
initial conditions are not met.
STOPPING 12 An order to stop (Stop) has been received.
The phase to finish the order in a controlled
way is executed (it is not possible to continue
with it). The stopped operation status
(Stopped) is automatically activated after the
(Stopping) sub phase is completed.
ABORTING 13 An order to end (Abort) has been received. A
fast stop, which is not necessarily controlled is
executed. The aborted operation status
(Aborted) is automatically activated after the
(Aborting) sub phase is completed.
INTERLOCKED 15 Operation cannot start as initial conditions are
not met.

EIO0000002093 04/2020 591

IBPHASE - Individual Batch Phase Manager

Name BitRank Name (if any) Bit Number Type Description

(if any)
COMMAND - UINT InBatch commands from HMI
START 0 Allows the normal operation of the phase
(Running) to be started.
HOLD 1 Allows the InBatch to be put on hold (Holding,
Holdingforerror).
RESTART 2 Allows the InBatch for continuing the
operation (Restarting) and resume normal
operation (Running).
STOP 3 Allows the InBatch to be stopped (Running,
Pausing, Paused, Holding, Held, or
Restarting) and the transition of state from
running to stopping (Stopping).
RESET 4 Triggers the transition to idle status (in
Complete, Aborted, or Stopped status).
PAUSE 5 Allows normal execution (Running) to be
paused in the next steady phase status.
RESUME 6 Allows normal operation of the phase
(Running) to be resumed from the paused
(Paused) status.
ABORT 7 Allows the InBatch to be aborted (in any status
except Idle, Complete, Aborting, and Aborted)
and the aborting state achieved from running
(Aborting).
STW - WORD Phase status word. In this word, the IBTRANS
auxiliary DFB is used to load the status of the
transitions (maximum of six) from the current
step of the phase to the steps in the next level
of the phase, where 0 means that the
conditions in the transition are not fulfilled and
1 means they are fulfilled.
STATUS1Transition 0 Status of the first transition
STATUS2Transition 1 Status of the second transition
STATUS3Transition 2 Status of the third transition
STATUS4Transition 3 Status of the fourth transition
STATUS5Transition 4 Status of the fifth transition
STATUS6Transition 5 Status of the sixth transition
INITCONDFAIL 14 Enables to confirm if initial condition is met.
AUTORESETDIS 15 Disable Auto-reset

592 EIO0000002093 04/2020

 IBPHASE - Individual Batch Phase Manager

Name BitRank Name (if any) Bit Number Type Description

(if any)
CFGW - WORD Phase configuration word.
OWNER 0 Read/write access. Enables to configure
whether the phase commands will come from
the program (0) or the operator (1).
SEMI 1 Read/write access. Enables to configure the
phase in automatic (0) or semi-automatic (1)
mode.
MANUAL 2 Read/write access. Enables to configure the
phase in automatic/semi-automatic (0) or
manual (1) mode.
Bit 1 Bit Mode
(SEMI)) 2(MANUAL))
OFF OFF Auto
ON OFF Semi-Auto
- ON Manual
NEXTSTEP 3 Read/write access. Enables to confirm the
change of steps to the next phase step in
Semi-Automatic mode. The DFB sets the
signal to 0 after it is processed.
SCROLL_UP 5 Read/write access. Enables to show the steps
previous to the one being shown on the
current window in manual mode. The DFB
sets the signal to 0 after it is processed.
SCROLL_DOWN 6 Read/write access. Enables to show the steps
following the one being shown on the current
window in manual mode. The DFB sets the
signal to 0 after it is processed.
BUTTON1 14 User configurable control button in InBatch
and Supervision function.
BUTTON2 15 User configurable control button in InBatch
and Supervision function.
CSTEPD - String[22] Current step description (three characters for
step number concatenated with seventeen
characters for description).

EIO0000002093 04/2020 593

IBPHASE - Individual Batch Phase Manager

IBPHASE_CFG_DDT Type

Name Type Description

NSTEP INT Number of the new step at which the sub phase needs to be
positioned in manual mode. The DFB sets this variable to 0
after it is processed.
STEPD STRING[122] Description of steps. Limited to six steps. In automatic and
semi-automatic mode, it shows the destination steps specified
in the current step transitions. In manual mode, it shows the
list of the steps defined in the phase. This variable format is:
six steps, twenty characters each. Of the twenty characters of
each step, the first three are for the step number and the next
seventeen are for its description. The value of this variable is
assigned for the auxiliary functions.
TRANSD STRING[122] Description of transitions. Limited to six transitions. This
variable format is six transitions, twenty characters each. The
twenty characters are for its description. The value of this
variable is assigned for the auxiliary functions.

594 EIO0000002093 04/2020

 IBPHASE - Individual Batch Phase Manager

Public Variables

Public Variable Description

Variable Type Description

SC IBPHASE_SC_DDT Provides the frequently needed data to monitor the
phase status and control it from the Batch phase
control.

IBPHASE_SC_DDT Type

Name BitRank Name (if any) Bit Number Type Description

(if any)
ETIME - UDINT Elapsed time in the current step (dsec).
STATE - UINT Current phase state.
IDLE 0 Inactive operation. Waiting for command to
start (Start) running.
RUNNING 1 Normal operation.
HELD 2 Operation put on hold. Waiting for
command to Restart (Restart) to get
operation to running.
HELDFORERROR 3 Operation put on hold due to detected fail
condition. Waiting for command to Restart
(Restart) to get operation to Running.
STOPPED 4 Operation stopped. Waiting for command
to get state (Reset) to Idle.

EIO0000002093 04/2020 595

IBPHASE - Individual Batch Phase Manager

Name BitRank Name (if any) Bit Number Type Description

(if any)
PAUSED 5 Operation paused. Waiting for command to
get state (Resume) to Running.
ABORTED 6 Operation canceled. Waiting for command
to get state (Reset) to get operation to Idle
COMPLETE 7 Normal operation has finished. Requires an
initialization order (Reset) to return to the
Idle status.
HOLDING 8 A hold (Hold) command is received and the
phase that allows the process to be
changed to a known status is executed.
After this phase is finished, it automatically
goes to the held (Held) status.
HOLDINGFORERROR 9 A detected failure is automatically detected
in the process (for example, a detected
failure in a control module), and the phase
that allows the process to be to a known
status is executed. After this phase is
finished, it automatically goes to the held
(HeldForError) status.
RESTARTING 10 Restart command (Restart) is received
while the InBatch is being held (Held). The
InBatch runs to return to the normal
operation phase (Running). The normal
operation status (Running) is set
automatically after the InBatch is complete.
PAUSING 11 A pause (Pause) command is received for
a short period while the normal operation
was being executed (Running). The normal
InBatch runs until it automatically goes to
paused (Paused) status.
STOPPING 12 An order to stop (Stop) has been received.
The phase to finish the order in a controlled
way is executed (it is not possible to
continue with it). The stopped operation
status (Stopped) is automatically activated
after the phase is complete.
ABORTING 13 An order to end (Abort) has been received.
A fast stop, which is not necessarily
controlled is executed. The aborted
operation status (Aborted) is automatically
activated after the phase is completed.
INTERLOCKED 15 Operation cannot start from InBatch tool as
initial conditions are not met.

596 EIO0000002093 04/2020

 IBPHASE - Individual Batch Phase Manager

Name BitRank Name (if any) Bit Number Type Description

(if any)
COMMAND - UINT Commands for transition states
START 0 Allows the normal operation of the phase
(Running) to be started.
HOLD 1 Allows the InBatch to be put on hold
(Holding, HoldingForError).
RESTART 2 Allows the InBatch for continuing the
operation (Restarting) and resume normal
operation (Running).
STOP 3 Allows the InBatch to be stopped (Running,
Pausing, Paused, Holding, Held, or
Restarting) and the transition of state from
running to stopping (Stopping).
RESET 4 Triggers the transition to idle status (in
Complete, Aborted, or Stopped status).
PAUSE 5 Allows normal execution (Running) to be
paused in the next steady phase status.
RESUME 6 Allows normal operation of the phase
(Running) to be resumed from the paused
(Paused) status.
ABORT 7 Allows the InBatch to be aborted (in any
status except Idle, Complete, Aborting, and
Aborted) and the aborting state achieved
from running (Aborting).
COMPLETED 8 Write access
1 = Sends a command to finish the current
sub phase (Running, Holding, Restarting,
Stopping, and so on).
0 = The signal is automatically set to 0 by
the DFB after the signal is processed. As
an alternative, forcing the value of this
variable to 1 by using the IBTRANS
auxiliary DFB is recommended.
STABLESTEP 9 Write access 1 = Sends a command to
mark the current step as a steady step, that
is, the step with which the phase will
resume after its is held or the step on which
the phase will be held after the phase is
paused.
0 = The signal is automatically set to 0 by
the DFB after the signal is processed.

EIO0000002093 04/2020 597

IBPHASE - Individual Batch Phase Manager

Name BitRank Name (if any) Bit Number Type Description

(if any)
CSTEP - INT Read-only access
Number of the active phase current step
(Running, Pausing, Holding, Restarting,
Stopping, or Aborting). The value 0
corresponds to the initial step of each sub
phase.
NEXTSTEP - INT Write access
Enables the number of the next step to be
run in the phase to be set.
The signal is automatically set to 0 by the
DFB after the signal is processed. As an
alternative, forcing the value of this variable
to 1 by using the IBTRANS auxiliary DFB is
recommended.
MODE - INT Read-only access (see page 589)
Operating modes
VALUE MODE
0 Automatic
1 Semi-Automatic
2 Manual
CURRENTITEM - INT Read-only access
1 = Indicates the current position of the list
of steps in Manual mode. The value –1
indicates that there has been a mode
change and -2 indicates that the mode
change has been identified.
DEST - ARRAY[1...6] Destinations steps after transitions
of INT
DESTW - WORD Transitions Conditions word
PROPERTIES - WORD Collective word of necessary boolean
variables.
OWNER 0 Read only access
Enables to configure whether the
commands will come from the InBatch (0)
or the operator (1).

598 EIO0000002093 04/2020

 IBPHASE - Individual Batch Phase Manager

Name BitRank Name (if any) Bit Number Type Description

(if any)
ONENTRY 1 Read-only access
1 = Reports that a new phase step has just
been started.
User can use this event in the logic of the
phase step actions to run any actions. The
actions run only when the step starts.
ONEXIT 2 Read-only access
1 = Reports that the execution of the phase
current step is about to finish.
User can use this event in the logic of the
phase step actions to run any actions. The
actions run only when the step ends.
INITCONDFAIL 3 1 = Initial conditions are not met to start the
batch phase.
FAIL 4 Write access
1 = Sends a command to stop the phase
normal execution.
0 = The signal is automatically set to 0 by
the DFB after the signal is processed.
With the activation of this signal, the
Holding For Detected Error sub
phase is run next if the Running, Pausing,
Restarting, or Paused sub phase was
running previously. As an alternative,
forcing the value of this variable to 1 by
using the IBFAILED auxiliary DFB is
recommended.
NEWCYCLE 5 Read-only access
1 = Indicates that a new phase state
machine execution cycle has started.
UPDATESTEP 6 Read-only access
1= Internal mark indicates the need for
updating the steps descriptions.
RUNNINGX 7 Read-only access
1 = Indicates that the current state of the
phase is Running or Pausing
HOLDINGX 8 Read-only access
1 = Indicates that the current state of the
phase is Holding or
Holding for Detected Error.
BUTTON1 14 User configurable control button in InBatch.
BUTTON2 15 User configurable control button in InBatch.

EIO0000002093 04/2020 599

IBPHASE - Individual Batch Phase Manager

600 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Auxiliary Functions of Batch Phase
EIO0000002093 04/2020

Chapter 56
Auxiliary Functions of Batch Phase

Auxiliary Functions of Batch Phase

Overview
This section describes the function blocks that supplement the IBPHASE DFB and that have the
objective of facilitating the programming of the control batch phase.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
56.1 IBTRANS 602
56.2 IBFAILED 607
56.3 IBSTABLESTEP 610
56.4 IBSTEPDESC 613

EIO0000002093 04/2020 601

Auxiliary Functions of Batch Phase

Section 56.1
IBTRANS

IBTRANS

Overview
This section describes the IBTRANS DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 603
Inputs 605
Inputs/Outputs 606

602 EIO0000002093 04/2020

 Auxiliary Functions of Batch Phase

Description

General
The main objective of IBTRANS DFB is to set up the control phase transitions based on the
condition to be evaluated and the next step to be executed when this expression is fulfilled.
Additionally, the DFB manages the information necessary to graphically represent the state of the
transitions and steps following the current step (DEST and DESTW fields of the IBPHASE_ST_DDT
phase state structure).
Include call to this function in the logic of the steps (normally in ST language) to program the
transitions between the phase steps.

Function Call
The function call is carried out from the steps of the control subphases (Running, Restarting,
Holding, and so on) normally in ST language to program the transitions between these steps.
If several IBTRANS calls are included in the same step and if more than one of them is fulfilled in
the same step execution cycle, the step corresponding to the transition that is fulfilled and was
programmed first will run. The number of IBTRANS calls from one single step is limited to 6.
TRANS (CONDITION := (*BOOL*),
DESC := (*string[22]*),
NEXTSTEP := (*INT*),
IBPHASE_SC := (*IBPHASE_SC_DDT*)
IBPHASE_ST := (*IBPHASE_ST_DDT*),
IBPHASE_CFG := (*IBPHASE_CFG_DDT*))
A function call example is included below:
4: (Wait for end of reactive dosing)
if IBSC.ONENTRY then
BISEN2_REACT.REM:=false;
BISEN2_REACT.LSP:=true;
end_if;
BISEN2_REACT.LSPSEL:=(OP01 < (IP01 - 10.0)); (Speed 1 or 2)
TRANS ((IP01 - COLA_REACT) <= OP01, 'Dosing finished?', IBSC.CSTEP+1,
IBSC, IBST, IBCFG);

EIO0000002093 04/2020 603

Auxiliary Functions of Batch Phase

In the previous example, the TRANS call included in step 4 of the phase corresponds to a IBTRANS
block instance to which the following parameters are passed:
 (IP01 - COLA_REACT) <= OP01OS: Corresponds to the expression of the condition that
needs to be fulfilled for the transition to be executed. You can include complex expressions that
result in a Boolean value (true or false).
 Dosing finished?: Corresponds to the description of the transition.
 IBSC.CSTEP+1: Corresponds to the next step that needs to be executed when the transition is
fulfilled. In this case, the next step (step 5) is executed after the current step (step 4). You can
include any expression jumping to an existing step in the phase.
 IBSC: Corresponds to the SC public variable of the IBPHASE block instance that is controlling
the phase execution.
 IBST: Corresponds to the DDT_ST variable of the IBPHASE block instance that is controlling the
phase execution.
 IBCFG: Corresponds to the DDT_CFG variable of the IBPHASE block instance that is controlling
the phase execution.

604 EIO0000002093 04/2020

 Auxiliary Functions of Batch Phase

Inputs

Input Parameter Description

Parameter Type Description

CONDITION BOOL 1 = Indicates that the condition for executing the
transition is fulfilled.
DESC STRING[22] Provides the description of the transition to be
represented in the monitoring program. The character
string is limited to 20 characters.
NEXTSTEP INT Sub phase step number to which a jump needs to be
made when the transition is fulfilled. Refer to the
CONDITION input. The permissible values for the steps
go from 1 to 999 with the exception of NEXTSTEP to -1.
This indicates that when the transition is fulfilled, the
corresponding sub phase (to go, for example, from
Running to Complete, from Holding to Held, and so on)
will be completed.

EIO0000002093 04/2020 605

Auxiliary Functions of Batch Phase

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

IBPHASE_SC IBPHASE_SC_DDT Corresponds to the SC public variable of the IBPHASE block
instance that is controlling the phase execution.
IBPHASE_ST IBPHASE_ST_DDT Provides the data necessary to communicate with the IBPHASE
block that is controlling the phase. Refer to the IBPHASE block
(see page 585) for more details.
IBPHASE_CFG IBPHASE_CFG_DDT Provides the data necessary to communicate with the IBPHASE
block that is controlling the phase. Refer to the IBPHASE block
(see page 585) for more details.

606 EIO0000002093 04/2020

 Auxiliary Functions of Batch Phase

Section 56.2
IBFAILED

IBFAILED

Overview
This section describes the IBFAILED DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 608
Inputs/Outputs 609

EIO0000002093 04/2020 607

Auxiliary Functions of Batch Phase

Description

General
The main objective of the IBFAILED DFB is to report detected errors to the batch phase
management block (IBPHASE) during phase execution so that the HoldingFE subphase is
triggered.

Function Call
The function call is made from the Running, Restarting, Pausing, or Paused control sub phase
steps normally in ST language with the purpose of reporting detected errors in the process that is
being controlled. The detected error requires the hold phase to be executed (HoldingFE).
A function call example is included below:
(Detected failure condition monitoring after initializations)
if IBPHASE.CSTEP > 0 and FAILCOND then
FAILED (IBSC); (Trigger execution of the Hold phase)
end_if;
In the previous example, the FAILED call that is included in the logic monitors the detected error
conditions in each execution cycle (in this particular case, but could be associated with a specific
step) corresponds to a IBFAILED DFB block instance to which the following parameters are
passed:
 IBPhase: Corresponds to the name of the SC public variable of the IBPHASE block instance
that is controlling the execution of the phase.

608 EIO0000002093 04/2020

 Auxiliary Functions of Batch Phase

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

IBPHASE_SC IBPHASE_SC_DDT Provides the data necessary to communicate
with the IBPHASE block that is controlling the
phase. Refer to the IBPHASE block
(see page 585) for more details.

EIO0000002093 04/2020 609

Auxiliary Functions of Batch Phase

Section 56.3
IBSTABLESTEP

IBSTABLESTEP

Overview
The section describes the IBSTABLESTEP DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 611
Inputs/Outputs 612

610 EIO0000002093 04/2020

 Auxiliary Functions of Batch Phase

Description

General
The main objective of the IBSTABLESTEP DFB is to report to the batch phase management block
(IBPHASE) that the current running phase step corresponds to a step, that is, the re-entry point in
the normal execution (Running) phase executes after restarting execution (Restarting).

Function Call
The function call is performed from the Running control sub phase steps normally in ST language
for the purpose of reporting. The current step is the entry point to which the program should return
when the Running sub phase is resumed after finishing the Restarting sub phase. Basically, it
enables to resume the phase execution that verifies the appropriate actions are performed or not.
For example, suppose a valve has to be opened. After the valve is opened, the next step involves
turning on a pump. While waiting for the valve to open, a detected failure that makes the phase
stop occurs (Holding sub phase execution). You can resume execution by running the restart
(Restarting) sub phase. After this, the program returns to the normal running sub phase (Running).
After the program goes back to this Running sub phase, the intention is to make another attempt
at opening the valve (because most likely, it has been closed during the Holding sub phase) not to
start the pump in proceeding directly. Therefore, in the valve opening step, the step is marked and
does not call the function IBSTABLESTEP in the pump starting step.
The following is an example of a function call:
0: (End Water dosing)
if IBSC.ONENTRY then
RAMP_AGUA.LSTART:=false;
FIC_AGUA.REM:=false;
FIC_AGUA.MAN:=true;
FIC_AGUA.LOP:=0.0;
VALV_AGUA.LSP:=false;
STABLESTEP (IBSC);
end_if;
TRANS (VALV_AGUA.LOWPOS, 'Valve Closed?', IBSC.CSTEP+1, IBSC, IBST,
IBCFG);
In the previous example, the STABLESTEP call included in the logic that monitors detected failure
conditions in each execution cycle (in this particular case, but it could be associated with a specific
step) corresponds to a IBSTABLESTEP DFB block instance to which the following parameters are
passed:
 IBPhase: Corresponds to the name of the SC public variable of the IBPHASE block instance
that is controlling the phase execution.

EIO0000002093 04/2020 611

Auxiliary Functions of Batch Phase

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

IBPHASE_SC IBPHASE_SC_DDT Provides the data necessary to communicate with
the IBPHASE block that is controlling the phase.
Refer to the IBPHASE block (see page 585) for
more details.

612 EIO0000002093 04/2020

 Auxiliary Functions of Batch Phase

Section 56.4
IBSTEPDESC

IBSTEPDESC

Overview
This section describes the IBSTEPDESC DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 614
Inputs 616
Inputs/Outputs 617
Public Variables 618

EIO0000002093 04/2020 613

Auxiliary Functions of Batch Phase

Description

General
The main objective of the IBSTEPDESC DFB is to assign descriptions to the steps that are defined
in the phase to allow you to monitor them from the Supervision system.

Function Calls
The function call is made from the control sub phase steps (Running, Restarting, Holding, and so
on) at the beginning of the code to provide the description of the sub phase steps for their represen-
tation in the monitoring program. It is normally written in ST language.
Include as many IBSTEPDESC calls as there are steps defined in the sub phase or as there are
steps that need to be represented in the Supervision system.
The syntax of the function is the following:
STEPDESC STEPNUMBER := (INT),
DESC := (string[18]),
IBPHASE_SC := (IBPHASE_SC_DDT),
IBPHASE_ST := (IBPHASE_ST_DDT),
IBPHASE_CFG := (IBPHASE_CFG_DDT),
The following is an example of a function call:
(Running or Pausing Sub phase (302 / 314))
(Step descriptions)
STEPDESC (1, 'Init', IBSC, IBST, IBCFG);
STEPDESC (2, 'Valves ON', IBSC, IBST, IBCFG);
STEPDESC (3, 'Wait Valves ON', IBSC, IBST, IBCFG);
STEPDESC (4, 'Dosing Reactive', IBSC, IBST, IBCFG);
STEPDESC (5, 'Motor OFF', IBSC, IBST, IBCFG);
STEPDESC (6, 'Waiting for queue', IBSC, IBST, IBCFG);
(Steps and Transitions)
case IBSC.CSTEP of
1: (#RunningStep0# Initial Step)
(Check initial conditions)
if IC_FAIL then
FalloCI := true;
FAILED (IBSC); (Initial conditions not satisfied)

614 EIO0000002093 04/2020

 Auxiliary Functions of Batch Phase

else
FalloCI := false;
(Initialization)
In the above example, the STEPDESC calls included at the beginning of the sub phase correspond
to a IBSTEPDESC DFB block instance to which the following parameters are passed in case of the
first call:
 1: Corresponds to step number 1.
 Init: Corresponds to the definition of the step.
 IBSC: Corresponds to the SC public variable of the IBPHASE block instance that is controlling
the phase execution.
 IBST: Corresponds to the DDT_ST variable of the IBPHASE block instance that is controlling the
phase execution.
 IBCFG: Corresponds to the DDT_CFG variable of the IBPHASE block instance that is controlling
the phase execution.

EIO0000002093 04/2020 615

Auxiliary Functions of Batch Phase

Inputs

Input Parameter Description

Parameter Type Description

STEPNUMBER INT Number of the sub phase step. The values allowed for
the steps are from 1 to 999.
DESC STRING[22] Description of the number of the sub phase step. The
character string is limited to 17 characters. This is the
value that will be shown in the phase monitoring
program.

616 EIO0000002093 04/2020

 Auxiliary Functions of Batch Phase

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

IBPHASE_SC IBPHASE_SC_DDT Provides the data necessary to communicate
with the IBPHASE block that is controlling the
phase. Refer to the IBPHASE (see page 585)
block for more details.
IBPHASE_ST IBPHASE_ST_DDT Provides the data necessary to communicate
with the IBPHASE block that is controlling the
phase. Refer to the IBPHASE (see page 585)
block for more details.
IBPHASE_CFG IBPHASE_CFG_DDT Provides the data necessary to communicate
with the IBPHASE block that is controlling the
phase. Refer to the IBPHASE (see page 585)
block for more details.

EIO0000002093 04/2020 617

Auxiliary Functions of Batch Phase

Public Variables

Public Variable Description

Parameter Type Description

ORDERNUMBER INT Read-only public variable reserved for building the list of
steps in manual mode that will be shown in the monitoring
program.
MAXORDERNUMBER INT Read-only public variable reserved for building the list of
steps in manual mode that will be shown in the monitoring
program.

618 EIO0000002093 04/2020

 Modicon Libraries General Purpose
IBPARxx - Batch Phase Parameter Management
EIO0000002093 04/2020

Chapter 57
IBPARxx - Batch Phase Parameter Management

IBPARxx - Batch Phase Parameter Management

Overview
This chapter describes the IBPARxx DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 620
DFB Representation 621
Inputs 622
Outputs 623
Inputs/Outputs 624
Public Variables 626

EIO0000002093 04/2020 619

IBPARxx - Batch Phase Parameter Management

Description

General
The IBPAR05, IBPAR10 and IBPAR16 DFBs manage up to 5, 10, and 16 phase parameters (input
and output) respectively. The DFBs facilitate the management of parameters from advanced
control phases implemented with the General Purpose Library IBPHASE DFB.
These DFBs manage the phase parameters with a data structure (DDT) making it easier to
implement reusable control phases (the number of pins in a DFB is limited to 32 input pins and 32
output pins) because a single variable is used to provide access to the data that the phase
manages.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Input Parameter Optionally, the DFB initializes the values of the input parameters with
Consistency a value (-0.0) that enables to determine whether or not the applicable
parameters of the phase have been correctly downloaded onto the
controller. This way, the phase can be stopped from starting with an
incomplete or inconsistent set of input parameters.
Owner The DFB manages control system level, which is the owner
(Operator or Program) based on the owner of the associated phase.
As a result, it is responsible for defining the input parameters of the
phase.
Output Parameters The DFB manages the output parameters generated from the control
phase.

620 EIO0000002093 04/2020

 IBPARxx - Batch Phase Parameter Management

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 621

IBPARxx - Batch Phase Parameter Management

Inputs

Input Parameter Description

Parameter Type Description

IPCHECKMASK WORD Optionally, enables to connect a bits word (16) to configure
applicable input parameters. Only the applicable parameters will
be checked for consistency. Refer to the IPRESETEN input and
IPERROR output pin (see page 559).
If no data is connected to this input, the consistency check for
input parameter is disabled.
Bit SP is calculated as:

0 (20) Input parameter 1 is applicable (1) or not (0).

1 (21) Input parameter 2 is applicable (1) or not (0).

... ...
15
15 (2 ) Input parameter 16 is applicable (1) or not (0).
IPRESETEN BOOL 1 = Enables to configure the input parameters need to be
initialized with the -0.0 value when the associated control phase
switches to an Idle status.
This configuration together with the IPCHECKMASK input pin is
used to determine whether or not the input parameters are
correctly downloaded (refer to the IPERROR output pin
(see page 623)).
IBPHASE_ST IBPHASE_ST_DDT Enables to connect the state structure of the control phase for
which the parameters need to be managed. The DFB uses this
structure to determine the state of the phase (Idle, Running and
so on) and its owner (Operator or Program).

622 EIO0000002093 04/2020

 IBPARxx - Batch Phase Parameter Management

Outputs

Output Parameter Description

Parameter Type Description

IPERROR BOOL 1 = A detected error in the assignment.
0 = The check is not activated.
The check is only carried out if the IPCHECKMASK input is
connected. If the IPCHECKMASK input is connected, a check is
run to verify whether the applicable parameters as defined in
the connected bit mask have a value other than -0.0 or not. The
responsibility of assigning the -0.0 value belongs to the DFB or
the programmer depending on how the IPRESETEN input is
configured.

EIO0000002093 04/2020 623

IBPARxx - Batch Phase Parameter Management

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

IBPARxx_ST IBPARxx_ST_DDT Provides the data that is necessary for managing the types of
parameters that the DFB manages input, output, and report.

IBPARxx_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and
allows data to be kept in the memory. Read-only access to the data contained in
this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem.
Read/write access to the data contained in this word.
IP01 REAL Read/write access
Input parameter 1.
Input parameter management:
 The DFB initializes the input parameters with a value of -0.0 if the IPRESETEN
input is enabled when the phase state switches to Idle.
 If the owner of the control phase is the Operator (IBPHASE_ST.CFGW.0 = 1),
this data is copied to the IPxx fields of the SC public variable. In other words,
the input parameters are received from the monitoring or batch control
subsystem in the Operator mode.
 If the owner of the control phase is the Program (IBPHASE_ST.CFGW.0 = 0),
the input parameters are overwritten with the data in the IPxx fields of the SC
public variable.
... ...
IPxx REAL Read/write access
Input parameter xx.
OP01 REAL Read-only access
Output parameter 1.
Output parameter management:
 The values in the OPxx fields of the SC public variable are continuously
copied to these output parameters so that they can be accessed from the
monitoring subsystem. Therefore, the control phase of the user needs to
define the value of the OPxx parameters of the SC public variable to indicate
the results of the execution of the phase.
... ...
OPxx REAL Read-only access
Output parameter xx.

624 EIO0000002093 04/2020

 IBPARxx - Batch Phase Parameter Management

IBPARxx_ST.STW Word Structure

DFB status word. Read-only access. The following table describes the IBPARxx_ST.STW Word
structure:

Bit Name Description

1 ERRDWLDIPPAR Detected error downloading input parameter.

EIO0000002093 04/2020 625

IBPARxx - Batch Phase Parameter Management

Public Variables

Public Variable Description

Variable Type Description

SC IBPARxx_SC_DDT Provides the data needed to manage the parameters of a phase from
the control phase itself or from a different external mechanism.

IBPARxx_SC_DDT Type

Name Type Description

IPERROR BOOL Read-only access
Refer to the IPERROR output pin (see page 623).
IP01 REAL Read/write access
Input parameter 1.
Input parameter management:
 The DFB initializes the input parameters with a value of -0.0 if the IPRESETEN
input is enabled when the phase status switches to Idle.
 If the owner of the control phase is the Operator (IBPHASE_ST.CFGW.0 = 1),
this data is copied to the IPxx fields of the SC public variable. In other words,
the input parameters are received from the monitoring or batch control
subsystem in the Operator mode.
 If the owner of the control phase is the Program (IBPHASE_ST.CFGW.0 = 0),
the input parameters are overwritten with the data in the IPxx fields of the SC
public variable.
... ...
IPxx REAL Read/write access
Input parameter xx.
OP01 REAL Read/write access
Output parameter 1.
Output parameter management:
 The values in the OPxx fields of the SC public variable are continuously copied
to these output parameters so that you can access the parameters from the
monitoring subsystem. Therefore, the control phase of the user needs to
define the value of the OPxx parameters of the SC public variable to indicate
the results of the phase execution.
... ...
OPxx REAL Read/write access
Output parameter xx.

626 EIO0000002093 04/2020

 Modicon Libraries General Purpose
USERPHASExx - User Defined Process Logic
EIO0000002093 04/2020

Chapter 58
USERPHASExx - User Defined Process Logic

USERPHASExx - User Defined Process Logic

Overview
This chapter describes the USERPHASExx DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 628
Inputs 629
Inputs/Outputs 630

EIO0000002093 04/2020 627

USERPHASExx - User Defined Process Logic

Description

General
It is an unprotected function block in which user can add the logic to manage phase states,
strategies depending upon the process controlled by the user. Sample codes are available in the
function block for the user reference.

628 EIO0000002093 04/2020

 USERPHASExx - User Defined Process Logic

Inputs

Input Parameter Description

Parameter Type Description

INITCONDFAIL BOOL User can leverage on this input pin to connect to interlock conditions
summary (CONDSUM) or other DFBs to take necessary actions
depending on the value of INITCONDFAIL.
FAILCOND BOOL User can leverage on this input pin to connect to detected failure
conditions summary (CONDSUM) to take necessary actions depending
on the value of FAILCOND.

EIO0000002093 04/2020 629

USERPHASExx - User Defined Process Logic

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

IBPHASE_SC IBPHASE_SC_DDT Corresponds to the SC public variable of the IBPHASE block
instance that is controlling the phase execution.
IBPHASE_ST IBPHASE_ST_DDT Provides the data necessary to communicate with the
IBPHASE block that is controlling the phase. Refer to the
IBPHASE block (see page 585) for more details.
IBPHASE_CFG IBPHASE_CFG_DDT Provides the data necessary to communicate with the
IBPHASE block that is controlling the phase. Refer to the
IBPHASE block (see page 585) for more details.

630 EIO0000002093 04/2020

 Modicon Libraries General Purpose
IBPHASE - Example of Use
EIO0000002093 04/2020

Chapter 59
IBPHASE - Example of Use

IBPHASE - Example of Use

Overview
This chapter describes the example use of the IBPHASE DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 632
DFB Representation 633
Reusable Phase Logic 634

EIO0000002093 04/2020 631

IBPHASE - Example of Use

Description

General
This chapter gives an example of Batch phase manager controlled by the IBPHASE, IBTRANS,
IBSTABLESTEP, IBFAILED, and IBSTEPDESC DFBs.
The objective of the phase is to control the loading of water in a process unit. For this purpose, a
reusable component (DFB) is created so that user can use this phase in different process units by
only changing the connections of the component pins.

Reusable Phase Definition

The reusable DFB of the user, PHWATER, declares the IBPHASE IBPHASE_Instance variable to
manage the state of the phase.

NOTE: Declaration of the auxiliary components manages the transitions (IBTRANS), steady-step
flags (IBSTABLESTEP), and notifications to trigger the holding sub phase (IBFAILED).

632 EIO0000002093 04/2020

 IBPHASE - Example of Use

DFB Representation

Representation
The following diagrams include the calls to the phase created by the user as well as to the control
block that will control it (IBPHASE).

NOTE: The call to the block controls the execution of the advanced equipment module.

NOTE: The call to the functional block implements the control phase of the user and will reuse for
different process units if needed.

EIO0000002093 04/2020 633

IBPHASE - Example of Use

Reusable Phase Logic

Phase Logic With Description

The basic structure of the phase as well as the steps that are defined for the phase objective are
included: water dosing. The parts of the code that make up the basic structure of the phase are
marked in bold.
(Initialization)
The following common actions have to be executed before the phase execution:
Running := IBSC.RUNNINGX;
Holding := IBSC.HOLDINGX;
Restarting := IBSC.Restarting;
Aborting := IBSC.Aborting;
Stopping := IBSC.Stopping;
IBSC.INITCONDFAIL := INITCONDFAIL;
NOTE: The default actions to be taken by DFB are defined in this section. However, if any section
has to be added by user and actions need to be taken before execution of that section, it has to be
added here.

(Running or Pausing Subphase)

STEPDESC (1, 'Init', IBSC, IBST, IBCFG);
STEPDESC (2, 'Valves ON', IBSC, IBST, IBCFG);
STEPDESC (3, 'Wait Valves ON', IBSC, IBST, IBCFG);
STEPDESC (4, 'Dosing Water', IBSC, IBST, IBCFG);
STEPDESC (5, 'Valves OFF', IBSC, IBST, IBCFG);
STEPDESC (6, 'Waiting for queue', IBSC, IBST, IBCFG);
NOTE: Definition of the descriptions for the subphase steps.
(Steps and Transitions)
case IBSC.CSTEP of
1: (#RunningStep0# Initial Step)
NOTE: First step with a value of 1.
(Check initial conditions)
if INITCONDFAIL then
FaultCI := true;
FAILED (IBSC); (Initial conditions not satisfied)

634 EIO0000002093 04/2020

 IBPHASE - Example of Use

NOTE: Report detected failure to trigger the holding subphase.

else
FaultCI := false;
(Initializations)
PARAM05.OP01:=0.0;
(Reset and water totalizer activation)
WATER_FQ.TOTALRST:=true;
WATER_FQ.TOTALEN:=true;
TRANS (TRUE, 'True', IBSC.CSTEP + 1, IBSC, IBST, IBCFG); (Next Step)
NOTE: Unconditional transition to the next step.
end_if;
2: (Start Water dosing)
if IBSC.ONENTRY then
STABLESTEP (IBSC); (In this step, it will initialize the execution in case of Stop/Continue)
NOTE: Execute the actions only for the first time.
NOTE: Flag this step as steady.
Dosing_water:=true;
WATER_VALVE.REM:=false;
WATER_VALVE.LSP := true;
if PARAM05.IP01 = 2.0 then
WATER_FCV.REM:=true;
WATER_FIC.REM:=false;
WATER_FIC.MAN:=true;
WATER_FIC.LOP:=10.0;
else
WATER_FCV.REM:=false;
WATER_FCV.LSP:=100.0;
end_if;
end_if;
TRANS (TRUE, 'True', IBSC.CSTEP + 1, IBSC, IBST, IBCFG); (Next step)

EIO0000002093 04/2020 635

IBPHASE - Example of Use

NOTE: The evaluation priority for these transitions is the order in which they are shown (up down;
these transitions are not functional, and have only been included as an example in this case). You
can define a maximum of 6 transitions.
3: (Wait for open valve)
TRANS (WATER_VALVE.HIGHPOS, 'Valve open?', IBSC.CSTEP + 1, IBSC, IBST,
IBCFG); (Next step)
4: (Wait for end of Water dosing)
if IBSC.ONENTRY then
if PARAM05.IP01 = 2.0 then (Dose)
WATER_RAMP.REM := false; (Set point of flow ramp)
WATER_RAMP.LTARGETSP:=PARAM05.IP03; (Desired set point)
WATER_RAMP.LSTART:=true;
WATER_FIC.REM:=true;
WATER_FIC.AUTO:=true;
WATER_FIC.LSP:=PARAM05.IP03; (Flow regulation)
end_if;
end_if;
TRANS ((PARAM05.IP02 - WATER_QUEUE) <= PARAM05.OP01, 'Dosing finished?',
IBSC.CSTEP + 1, IBSC, IBST, IBCFG);
5: (End Water dosing)
if IBSC.ONENTRY then
if PARAM05.IP01 = 2.0 then
WATER_RAMP.LSTART:=false;
WATER_FIC.REM:=false;
WATER_FIC.MAN:=true;
WATER_FIC.LOP:=0.0;
else
WATER_FCV.LSP:=0.0;
end_if;
WATER_VALVE.LSP:=false;
STABLESTEP (IBSC); (In this step, it will initialize the execution in case of Stop/Continue)
end_if;

636 EIO0000002093 04/2020

 IBPHASE - Example of Use

TRANS (WATER_VALVE.LOWPOS, 'Valve Closed?', IBSC.CSTEP + 1, IBSC, IBST,

IBCFG);
6: (Wait for Water queue)
if IBSC.ONENTRY then
(Wait for COLA_AGUA (Water queue) to fall)
STABLESTEP (IBSC); (In this step, it will initialize the execution in case of Stop/Continue)
end_if;
TRANS (IBSC.ETIME >= 50, 'Waiting for queue', -1, IBSC, IBST, IBCFG); (End
of phase)
NOTE: Complete phase (go to COMPLETE) when the transition condition is met.
end_case;
(Actions common to several steps)
(Detected failure condition monitoring after initializations)
if IBSC.CSTEP > 0 and FAILCOND then
FAILED (IBSC); (* It causes Hold phase execution *)
end_if;
(Holding Subphase)
STEPDESC (1, 'Init', IBSC, IBST, IBCFG);
STEPDESC (2, 'Closing Valves', IBSC, IBST, IBCFG);
(Steps and Transitions)
case IBSC.CSTEP of
1: (Initial Step)
if FaultCI then
Dosing_water:=false;
end_if;
TRANS (FaultCI, 'Not InitCond', -1, IBSC, IBST, IBCFG); (End of phase)
TRANS (NOT FaultCI, 'InitCond OK', IBSC.CSTEP + 1, IBSC, IBST, IBCFG);
(Next step)
2:
if IBSC.ONENTRY then
WATER_VALVE.LSP:= false;
WATER_RAMP.LSTART:=false;
WATER_FIC.MAN:=true;

EIO0000002093 04/2020 637

IBPHASE - Example of Use

WATER_FIC.LOP:=0.0; (To close regulating valve)

end_if;
If (Dosing_water) AND IBSC.ETIME >= 50 then
Dosing_water:=false;
end_if;
TRANS (IBSC.ETIME >= 50 OR NOT Dosing_water, 'Waiting for queue', -1,
IBSC, IBST, IBCFG); (End of phase)
end_case;
(Restarting subphase)
STEPDESC (1, 'Init', IBSC, IBST, IBCFG);
(Steps and Transitions)
case IBSC.CSTEP of
1: (Initial Step)
TRANS (TRUE, 'True', -1, IBSC, IBST, IBCFG); (End of phase)
end_case;
(Aborting subphase)
STEPDESC (1, 'Closing Valves', IBSC, IBST, IBCFG);
(Steps and Transitions)
case IBSC.CSTEP of
1: (Initial Step)
WATER_VALVE.REM:=false;
WATER_VALVE.LSP:=false;
WATER_RAMP.LSTART:=false;
WATER_FIC.MAN:=true;
WATER_FIC.LOP:=0.0; (Close control valve)
Dosing_water:=false;
TRANS (TRUE, 'True', -1, IBSC, IBST, IBCFG); (End of phase)
end_case;
(Stopping subphase)
STEPDESC (1, 'Closing Valves', IBSC, IBST, IBCFG);
STEPDESC (2, 'Waiting for queue', IBSC, IBST, IBCFG);
(Steps and Transitions)

638 EIO0000002093 04/2020

 IBPHASE - Example of Use

case IBSC.CSTEP of
1: (Initial Step)
WATER_VALVE.REM:=false;
WATER_VALVE.LSP:= false;
WATER_RAMP.LSTART:=false;
WATER_FIC.MAN:=true;
WATER_FIC.LOP:=0.0; (To close regulating valve)
TRANS (TRUE, 'True', IBSC.CSTEP + 1, IBSC, IBST, IBCFG); (Next step)
2:
If (Dosing_water ) AND IBSC.ETIME >= 50 then
Dosing_water:=false;
end_if;
TRANS (IBSC.ETIME >= 50 OR NOT Dosing_water, 'Waiting for queue', -1,
IBSC, IBST, IBCFG); (End of phase)
end_case;

Common actions to be executed after the phase execution.

if Dosing_water then
PARAM05.OP01 := WATER_FQ.TOTAL;
end_if;
NOTE: No default actions are defined in this section. However, if any action has to be taken after
execution of section, it has to be added here.

EIO0000002093 04/2020 639

IBPHASE - Example of Use

640 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Auxiliary Functions
EIO0000002093 04/2020

Part VIII
Auxiliary Functions

Auxiliary Functions

Overview
This part provides a detailed description of the functions, pins, pin layout, and variables of the
function blocks of the auxiliary functions family.
Auxiliary function blocks can be used in conjunction with other DFBs to provide additional services
and data.
These function blocks do not reflect any specific installation.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000002093 04/2020 641

Auxiliary Functions

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
60 ASELECT - Analog Signal Selector 643
61 ASELECT1 - Selector for Analog Signals with Monitoring Variables 649
62 CONDSUM - Summary of Conditions 659
63 CONDSUM1 - Interlock Condition Summary 667
64 MSGBOX - Messages to the Operator 675

642 EIO0000002093 04/2020

 Modicon Libraries General Purpose
ASELECT
EIO0000002093 04/2020

Chapter 60
ASELECT - Analog Signal Selector

ASELECT - Analog Signal Selector

Overview
This chapter describes the ASELECT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 644
DFB Representation 645
Inputs 646
Outputs 647

EIO0000002093 04/2020 643

ASELECT

Description

General
The ASELECT DFB elects an analog signal from among a maximum of four signals based on the
chosen selection criterion.
This DFB can supplement the PIDCTL and AOUTPUT DFBs from the General Purpose Library.

Function Description
The main functions of the DFB are summarized in the following table:

Function Description
Selection The DFB selects the analog signal from among the input signals according to one of the
following criteria:
 Maximum
 Minimum
 Direct selection

Feedback The DFB generates the signals needed to report to the DFBs. These DFBs generate the
analog signals whether or not their signals have been selected. This functionality is
especially useful when PID control is implemented in Override mode.

644 EIO0000002093 04/2020

 ASELECT

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 645

ASELECT

Inputs

Input Parameter Description

Parameter Type Description

SP1..SP4 REAL Value of the analog signals to be selected.
SP1EN..SP4EN BOOL 1 = Enables the corresponding input signal.
SPSEL UINT Enables to select the selection method used:
SPSEL SP is calculated as:
0 Minimum value among the enabled SPx signals (refer to
the SPMIN (see page 647) output pin).
1 SP1
2 SP2
3 SP3
4 SP4
5 Maximum value among the enabled SPx signals (refer to
the SPMAX (see page 647) output pin).

646 EIO0000002093 04/2020

 ASELECT

Outputs

Output Parameter Description

Parameter Type Description

SP1SELD..SP4SELD BOOL 1 = Indicates the corresponding input (SPx) has been selected
depending on the enabled signals and the selector value (refer
to the SPSEL (see page 646) input). No signal is activated if the
selected signal (1..4) is not enabled or if the selector value is
not valid (SPSEL>5).
SP REAL Input value (SP1-SP4) selected with the SPSEL input signal.
Refer to the SP1SELD-SP4SELD outputs for more details. Set
to 0 when none of these outputs is activated.
SPMIN REAL Minimum input value (SP1-SP4) among those enabled. Set to
0 if no output is enabled.
SPMAX REAL Maximum input value (SP1-SP4) among those enabled. Set to
0 if no output is enabled.
ERROR BOOL 1 = Is activated if:
 The SPSEL input value is out of range.
 The selected signal is not enabled.
 No input signal is enabled (SPxEN).

EIO0000002093 04/2020 647

ASELECT

648 EIO0000002093 04/2020

 Modicon Libraries General Purpose
ASELECT1
EIO0000002093 04/2020

Chapter 61
ASELECT1 - Selector for Analog Signals with Monitoring Variables

ASELECT1 - Selector for Analog Signals with Monitoring

Variables

Overview
This chapter describes the ASELECT1 DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 650
DFB Representation 651
Inputs 652
Outputs 653
Inputs/Outputs 654
Public Variables 657

EIO0000002093 04/2020 649

ASELECT1

Description

General
The ASELECT1 DFB features the same functionalities of the ASELECT component except for the
fact that it has variables designed for monitoring the DFB and owner management purposes.
The component is designed to select an analog signal from among a maximum of 4 signals
depending on the chosen selection criterion.
You can supplement this DFB with the PIDCTL and AOUTPUT (as well as other) DFBs from the
General Purpose Library.

Function Description
The main functions of the DFB are summarized in the following table:

Function Description
Selection The DFB selects the analog signal from among the input signals according to
one of the following criteria:
 Maximum
 Minimum
 Direct selection

Feedback The DFB generates the signals needed to report to the DFBs. These DFBs
generate the analog signals whether or not their signals have been selected.
This functionality is especially useful when PID control is implemented in
Override mode.
Owner The DFB manages control system level, which is the owner (Operator or
Program). Therefore, it is responsible for selecting the signal.

650 EIO0000002093 04/2020

 ASELECT1

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 651

ASELECT1

Inputs

Input Parameter Description

Parameter Type Description

SP1..SP4 REAL Value of the analog signals to be selected. The connection or non-connection of
a value or variable to the DFB pin enables/disables the corresponding signal.
RSPSEL UINT Enables to select the selection method used:
RPSEL SP is calculated as:
0 Minimum value among the enabled SPx signals (refer to the
SPMIN (see page 653) output).
1 SP1
2 SP2
3 SP3
4 SP4
5 Maximum value among the enabled SPx signals (refer to the
SPMAX (see page 653) output).

652 EIO0000002093 04/2020

 ASELECT1

Outputs

Output Parameter Description

Parameter Type Description

SP1SELD..SP4SELD BOOL 1 = Indicates the corresponding input (SPx) has been
selected depending on the enabled signals and the selector
value (refer to the RSPSEL (see page 652) input). No signal
is activated if the selected signal (1..4) is not enabled or if the
selector value is not valid (SPSEL>5).
SP REAL Input value (SP1-SP4) selected with the SPSEL input signal.
Refer to the SP1SELD-SP4SELD outputs for more details. Set
to 0 when none of these outputs is activated.
SPMIN REAL Minimum input value (SP1-SP4) among those connected.
Set to 0 if no output is connected.
SPMAX REAL Maximum input value (SP1-SP4) among those connected.
Set to 0 if no output is connected.
ERROR BOOL 1 = Is activated if:
 The RSPSEL input value is out of range.
 The selected signal is not connected.
 No signal is selected.
 No input signal is connected.
SPSELD UINT Selected selection method. Refer to the table for the RSPSEL
(see page 652) input pin.

EIO0000002093 04/2020 653

ASELECT1

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

ASELECT1_ST ASELECT1_ST_DDT Provides the data needed to monitor and/or control the DFB status.
ASELECT1_ ASELECT1_CFGW_DDT Provides the data necessary to configure the DFB normally from
CFG the monitoring subsystem.

ASELECT1_ST_DDT Type

Name Type Description

STW WORD Provides the device status usually used from the monitoring subsystem, and allows data
to be kept in the memory. Read-only access to the data contained in this word.
CFGW WORD Provides the means to control the device from the monitoring subsystem. Read/write
access to the data contained in this word.
SP REAL Current set-point generated by the DFB. Refer to the SP (see page 653) output.

ASELECT1_ST.STW Word Structure

DFB status word. Read-only access. The following table describes the ASELECT1_ST.STW word:

Bit Name Description

0 MINSELD Minimum selected input (SPSELD = 0).
1 SP1SELD Refer to the SP1SELD (see page 653) output pin.
2 SP2SELD Refer to the SP2SELD (see page 653) output pin.
3 SP3SELD Refer to the SP3SELD (see page 653) output pin.
4 SP4SELD Refer to the SP4SELD (see page 653) output pin.
5 MAXSELD Maximum selected input (SPSELD = 5 ).
6 MINEN Enables (1) the selection of the lowest SPx value. Enabled when more than one set-
point is connected.
7 SP1EN SP1 selection enabled. Enabled when a variable or value is connected to input SP1.
8 SP2EN SP2 selection enabled. Enabled when a variable or value is connected to input SP2.
9 SP3EN SP3 selection enabled. Enabled when a variable or value is connected to input SP3.
10 SP4EN SP4 selection enabled. Enabled when a variable or value is connected to input SP4.
11 MAXEN Enables (1) the selection of the highest SPx value. Enabled when more than one set-
point is connected.
12 ERROR Refer to the ERROR (see page 653) output pin.

654 EIO0000002093 04/2020

 ASELECT1

ASELECT1_ST.CTGW Word Structure

Provides the data needed to configure the DFB normally from the monitoring subsystem. The
following table describes the ASELECT1_ST.CFGW word:

Bit Name Description

0 OWNER Read/write access
Enables to configure whether the set-point selection parameters are set by the
Program (0) or by the Operator (1).
1 MINSEL Read/write access
Enables to select the minimum local set-point (OWNER = 1) of the Operator from the
monitoring subsystem. If the set-point is set by the Program (OWNER = 0), the DFB
continuously updates the value.
2 SP1SEL Read/write access
Enables to select the local SP1 set-point (OWNER = 1) of the Operator from the
monitoring subsystem. If the set-point is set by the Program (OWNER = 0), the DFB
continuously updates the value.
3 SP2SEL Read/write access
Enables to select the local SP2 set-point (OWNER = 1) of the Operator from the
monitoring subsystem. If the set-point is set by the Program (OWNER = 0), the DFB
continuously updates the value.
4 SP3SEL Read/write access
Enables to select the local SP3 set-point (OWNER = 1) of the Operator from the
monitoring subsystem. If the set-point is set by the Program (OWNER = 0), the DFB
continuously updates the value.
5 SP4SEL Read/write access
Enables to select the local SP4 set-point (OWNER = 1) of the Operator from the
monitoring subsystem. If the set-point is set by the Program (OWNER = 0), the DFB
continuously updates the value.
6 MAXSEL Read/write access
Enables to select the maximum local set-point (OWNER = 1) of the Operator from the
monitoring subsystem. If the set-point is set by the Program (OWNER = 0), the DFB
continuously updates the value.

EIO0000002093 04/2020 655

ASELECT1

ASELECT1_CFG_DDT Type

Name Type Description

SP1 REAL Read-only access
Value on SP1 input.
SP2 REAL Read-only access
Value on SP2 input.
SP3 REAL Read-only access
Value on SP3 input.
SP4 REAL Read-only access
Value on SP4 input.

656 EIO0000002093 04/2020

 ASELECT1

Public Variables

Public Variable Description

Variable Type Description

SC ASELECT1_SC_DDT Provides the frequently needed data to monitor
and/or control the DFB status from the sequential
control.

ASELECT1_SC_DDT Type

Name Type Description

REM BOOL Read/write access
1 = Allows the DFB to be configured for a remote set-point -RSPSEL.
0 = Allows the DFB to be configured for a local set-point -LSPSEL- (0).
OWNER BOOL Read-only access
Refer to the ASELECT1_ST.CFGW.OWNER input/output pin (see page 654).
SP REAL Read-only access. Refer to the SP output pin (see page 653).
LSPSELD UINT Read/write access
Enables the sequential control to assign the local set-point if the owner is the
Program (OWNER input/output is set to 0) and the selected set-point is the
local one (SC.REM public variable is set to 0). Otherwise, the current set-point
(SPSELD output) is continuously copied to this variable.
SP1SELD BOOL Read-only access
Refer to the SP1SELD output pin (see page 653).
SP2SELD BOOL Read-only access
Refer to the SP2SELD output pin (see page 653).
SP3SELD BOOL Read-only access
Refer to the SP3SELD output pin (see page 653).
SP4SELD BOOL Read-only access
Refer to the SP4SELD output pin (see page 653).
ERROR BOOL Read-only access
Refer to the ERROR output pin (see page 653).

EIO0000002093 04/2020 657

ASELECT1

658 EIO0000002093 04/2020

 Modicon Libraries General Purpose
CONDSUM
EIO0000002093 04/2020

Chapter 62
CONDSUM - Summary of Conditions

CONDSUM - Summary of Conditions

Overview
This chapter describes the CONDSUM DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 660
DFB Representation 661
Inputs 662
Outputs 663
Inputs/Outputs 664
Public Variables 666

EIO0000002093 04/2020 659

CONDSUM

Description

General
The CONDSUM DFB is used to evaluate up to 15 signals that can be used, for example, as interlocks
or initial conditions. The DFB allows to evaluate the logic OR of these conditions to be evaluated.
Each of them can require individual resetting or be ignored according to the DFB configuration.
You can use this DFB as a supplement to the rest of the General Purpose Library DFBs to evaluate
their interlocking inputs.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Summary Condition Evaluation The DFB ORs the conditions.
Manual Reset Conditions Conditions configured this way require resetting from the monitoring
system.
Bypass Enables the corresponding condition (one by one) to be ignored when
evaluating the expression.

660 EIO0000002093 04/2020

 CONDSUM

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 661

CONDSUM

Inputs

Input Parameter Description

Parameter Type Description

CONDxx BOOL 1 = Condition activated
REQREARMxx BOOL 1 = Enables to require manual resetting when the
corresponding input condition (CONDxx) is activated.

662 EIO0000002093 04/2020

 CONDSUM

Outputs

Output Parameter Description

Parameter Type Description

RESULT BOOL 1 = Summarizes the result of ORing the conditions according to the
following logic diagram.

EIO0000002093 04/2020 663

CONDSUM

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

CONDSUM_ST CONDSUM_ST_DDT Data structure that is used as an interface with the
monitoring subsystem.

CONDSUM_ST_DDT Type

Name Type Description

CONDW WORD Read-only access
Bits word with input conditions (refer to the CONDxx inputs
(see page 662)) and their evaluation summary (refer to the
RESULT output pin (see page 663).
BYPASSW WORD Read/write access
Bits word with the bypass signals set from the monitoring system.
REARMREQW WORD Read/write access
Bits word with the required resetting signals (1) set from the DFB
and forced resetting (0) from the monitoring system.

The following table describes the CONDSUM_ST.CONDW word:

Bit Description
0 COND01
1 COND02
... ...
14 COND15
15 RESULT

The following table describes the CONDSUM_ST.BYPASSW word:

Bit Description
0 BYPASS01
1 BYPASS02
... ...
14 BYPASS15

664 EIO0000002093 04/2020

 CONDSUM

The following table describes the CONDSUM_ST.REARMREQW word:

Bit Description
0 REARMREQ01
1 REARMREQ02
... ...
14 REARMREQ15

EIO0000002093 04/2020 665

CONDSUM

Public Variables

Public Variable Description

Variable Type Description

SC CONDSUM_SC_DDT Provides the frequently needed data to monitor the DFB
status from the sequential control.

CONDSUM_SC_DDT Type

Name Type Description

RESULT BOOL Read-only access
Refer to the RESULT output pin (see page 663).

666 EIO0000002093 04/2020

 Modicon Libraries General Purpose
CONDSUM1
EIO0000002093 04/2020

Chapter 63
CONDSUM1 - Interlock Condition Summary

CONDSUM1 - Interlock Condition Summary

Overview
This chapter describes the CONDSUM1 DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 668
DFB Representation 669
Inputs 670
Outputs 671
Inputs/Outputs 672
Public Variables 674

EIO0000002093 04/2020 667

CONDSUM1

Description

General
The features of the CONDSUM1 DFB are similar to those of the CONDSUM DFB. The CONDSUM1 DFB
is used to evaluate up to 7 conditions to implement interlocking strategies. The DFB allows to
evaluate the logic OR of these conditions. Each of them can require individual resetting or be
ignored (bypassed) according to the DFB configuration.
You can link this DFB to other DFBs of the General Purpose library to evaluate their interlocking
inputs and positions.
The table compares the functions of the CONDSUMx DFBs:

Function CONDSUM CONDSUM1

Maximum number of conditions 15 7
Condition prioritization N Y
Evaluation of interlock positions N Y
Possibility of inhibiting bypassing on a condition-by- N Y
condition basis

Function Description
The main functions of the DFB are described in the following table:

Function Description
Interlock Evaluation The DFB ORs the conditions giving Condition 1 priority over Condition 2,
Condition 2 priority over Condition 3, and so on.
Evaluation of interlock Each condition has a discrete position associated with it. The DFB
positions evaluates the position of each condition based on the active conditions
evaluated according to priority.
Interlocks Featuring Process conditions configured this way require resetting from the
Manual Resetting Supervision system.
Bypass Allows to bypass interlock conditions one by one.
The DFB allows to configure conditions that can be bypassed and others
that cannot.
Active Interlock Indication The DFB features output signals that report the state of each interlock
condition after internal logic has been applied (resetting and bypassing).
These signals can be used to implement program logic, or to select the
analog position for other DFBs that require it (for example, AOUTPUT) by
using an external multiplexer (for example, ASELECT1).

668 EIO0000002093 04/2020

 CONDSUM1

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 669

CONDSUM1

Inputs

Input Parameter Description

Parameter Type Description

CONDxx BOOL 1 = Interlock condition activated
REQREARMxx BOOL 1 = Enables to configure for manual resetting to be required when the
corresponding input condition (CONDxx) is activated.
SAFEPOSxx BOOL 1 = Enables to configure which is the position (0 or 1) that is
associated to each interlock condition (CONDxx).
BYPASSDISxx BOOL 1 = Bypassing Disabled. Makes it possible to disable bypassing for the
corresponding interlock conditions (CONDxx).

670 EIO0000002093 04/2020

 CONDSUM1

Outputs

Output Parameter Description

Parameter Type Description

ILCKSP BOOL 1 = Indicates the interlock position (refer to the SAFEPOSxx (see page 670)
inputs) that is associated to the active interlock after priorities have been
applied (refer to the ILCK output). If no interlocks are active, the ILCKSP
output is set to 0 by default.
ILCK BOOL 1 = Summarizes the status of the interlock after ORing the conditions
according to priority and the following logic:
In contrast to the CONDSUM DFB, conditions are applied with priority. Every
condition is evaluated every time, but the position (refer to the ILCKSP
output) is determined solely based on the first active interlock condition (the
one with the highest priority is condition 01 while the one with the lowest
priority is condition 07).
ILCKNUMBER INT Indicates the index of the active interlock (1..7). Set to 0 by default if no
interlocks are active.
ILCKxx BOOL 1 = Activated depending on the corresponding interlock condition is active
(considering both bypassing and whether or not the condition requires
manual resetting). Each output is independent from the previous one so that
the number of ILCKxx outputs activated corresponds to the number of
simultaneous active interlocks.

EIO0000002093 04/2020 671

CONDSUM1

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

CONDSUM1_ST CONDSUM1_ST_DDT Data structure that is used as an interface with the
monitoring subsystem.

CONDSUM1_ST_DDT Type

Name Type Description

CONDW WORD Read-only access
Bits word with the status for each interlock and the summary of the
corresponding evaluation (refer to the ILCKxx (see page 671) outputs).
BYPASSW WORD Read/write access
Bits word with the bypass signals set from the monitoring system. If the
corresponding BYPASSDISxx input signal is active, the DFB forces the
value of the corresponding bit in this word to 0.
REARMREQW WORD Read/write access
Bits word with the required resetting signals (1) set from the DFB and
forced resetting (0) signals set from the monitoring system.

CONDSUM1_ST.CONDW Word Structure

Read-only access. Bits word with input conditions (refer to the CONDxx (see page 670) inputs) and
their evaluation summary (refer to the ILCK (see page 671) output). The following table describes
the CONDSUM1_ST.CONDW word:

Bit Description
0 Interlock 01. Refer to the ILCK01 (see page 671) output pin.
1 Interlock 02. Refer to the ILCK02 (see page 671) output pin.
... ...
6 Interlock 07. Refer to the ILCK07 (see page 671) output pin.
15 Resulting interlock. Refer to the ILCK (see page 671) output pin.

672 EIO0000002093 04/2020

 CONDSUM1

CONDSUM1_ST.BYPASSW Word Structure

Read/write access. Bits word with the bypass signals set from the monitoring system. The following
table describes the CONDSUM1_ST.BYPASSW word:

Bit Description
0 Active bypass (1) for interlock 01
1 Active bypass (1) for interlock 02
... ...
6 Active bypass (1) for interlock 07.

CONDSUM1_ST.REARMREQW Word Structure

Read/write access. Bits word with the required resetting signals (1) set from the DFB and forced
resetting (0) signals set from the monitoring system. The following table describes the
CONDSUM1_ST.REARMREQW word:

Bit Description
0 Interlock 01 requires resetting (1) or does not require resetting (0). Interlock 01 is reset by
setting it to 0.
1 Interlock 02 requires resetting (1) or does not require resetting (0). Interlock 02 is reset by
setting it to 0.
... ...
6 Interlock 07 requires resetting (1) or does not require resetting (0). Interlock 07 is reset by
setting it to 0.

EIO0000002093 04/2020 673

CONDSUM1

Public Variables

Public Variable Description

Variable Type Description

SC CONDSUM1_SC_DDT Provides the frequently needed data to monitor the
status of the DFB from the sequential control.

CONDSUM1_SC_DDT Type

Name Type Description

ILCK BOOL Read-only access
Refer to the ILCK output pin (see page 671).
ILCKSP BOOL Read-only access
Refer to the ILCKSP output pin (see page 671).

674 EIO0000002093 04/2020

 Modicon Libraries General Purpose
MSGBOX
EIO0000002093 04/2020

Chapter 64
MSGBOX - Messages to the Operator

MSGBOX - Messages to the Operator

Overview
This chapter describes the MSGBOX DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 676
DFB Representation 677
Inputs 678
Outputs 679
Inputs/Outputs 680
Public Variables 682

EIO0000002093 04/2020 675

MSGBOX

Description

General
The MSGBOX DFB offers a standard user interface mechanism and allows messages to be
displayed for the operator. This DFB enables to request confirmations and/or data without having
to configure customized interfaces to channel the messages
The DFB combined with the Modicon Libraries - General Purpose function blocks allows you to
configure the format of the message for the operator so that you can format the message from the
program in Control incorporating icons, buttons, and/or data entry fields.

Function Description
The main functions of the DFB are described in the following table:

Function Description
Message Display The DFB allows the message display to be activated/aborted. Only
Management one message is managed at a time. Therefore, the number of
MSGBOX DFBs instantiated needs to be equal to the number of
simultaneous messages required per processing unit.
Icons Allows you to select the icon that needs to be shown on the user
interface.
Enables to display the following icons:
 Stop: To show diagnostics messages, for example.
 Question mark: To show request messages for data entry, for
example.
 Exclamation mark: To show alert messages, for example.
 Information: To show steps, or the status of the process in
general, for example.
Buttons Enables you to select the buttons that apply:
 No buttons required (for alert messages, for example).
 One single OK button (for example, for manual action
confirmation messages).
 An OK button and a Cancel button (for example, for messages in
which the user needs to choose between two alternatives).
Optional Data You can show up to 2 pieces of data stored in the controller along
with the message. A request for the entry of those pieces of data can
also be issued; for example, for entering process sampling results.

676 EIO0000002093 04/2020

 MSGBOX

DFB Representation

Representation
This DFB has been specifically designed for use with the FBD language of the controller.

EIO0000002093 04/2020 677

MSGBOX

Inputs

Input Parameter Description

The function module does not have inputs. Its operation parameters are configured through the SC
public variable and the MSGBOX_CFG and MSGBOX_ST data exchange structures.

678 EIO0000002093 04/2020

 MSGBOX

Outputs

Output Parameter Description

Parameter Type Description

INPROGRESS BOOL 1 = This signal is kept activated while a message is waiting for response, that is,
if a request for a new message has been issued (SC.SHOW = 1 and SC.CODE <>
0) and none of the selected buttons have been clicked on yet ( OK –
MSGBOX_ST.CFGW.8- or Cancel –MSGBOX_ST.CFGW.9-) or if an abort request
has been issued (SC.ABORT) for the message (the only option to finalize the
message for alert messages without waiting for an operator action).
DONE BOOL 1 = This signal is activated upon accepting the message in progress, that is, when
the OK button is clicked on MSGBOX_ST.CFGW.OK input/output pin
(see page 680) while a message is pending for response (INPROGRESS =1). The
signal is deactivated (0) when the message in progress is aborted or a new
message is in progress.
CANCELLED BOOL 1 = This signal is activated upon canceling the message in progress, that is, when
the Cancel button is clicked on MSGBOX_ST.CFGW.CANCEL input/output pin
(see page 680) while a message is pending for response (INPROGRESS = 1). The
signal is deactivated (0) when the message in progress is aborted or if a new
message is in progress.
DATA1 REAL Enables to check the first optional data shown to the operator and/or entered by
the operator according to the type of message selected. This data is not
exchanged until it has been confirmed by the operator (any values that could have
possibly been entered previously during editing are not copied). This signal is only
applicable if MSGBOX_ST.STW.DATA1EN is equal to 1.
DATA2 REAL Enables to check the second optional data shown to the operator and/or entered
by the operator according to the type of message selected. This data is not
exchanged until it has been confirmed by the operator (any values that could have
possibly been entered previously during editing are not copied). This signal is only
applicable if MSGBOX_ST.STW.DATA2EN is equal to 1.

EIO0000002093 04/2020 679

MSGBOX

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

MSGBOX_ST MSGBOX_ST_DDT Provides the data necessary for displaying the message, carrying out
the applicable actions (OK and/or Cancel) and defining the message
to be shown.
MSGBOX_CFG MSGBOX_CFG_DDT Provides the additional data (Data 1 and/or Data 2) that can be
associated with the message in progress.

MSGBOX_ST_DDT Type

Name Type Description

STW WORD Provides the data necessary to display the message. Reproduces the
values entered in SC.MODE (type of message to be shown).
Read-only access
CFGW WORD Enables the applicable actions (OK and/or Cancel) to be carried out.
Read/write access
MSG STRING[40] Main message to be shown. The character string is limited to 39
characters.

The following table describes the MSGBOX_ST.STW word:

Bit Name Description

0 OKEN Indicates that the OK button is applicable to the message in progress.
1 OKCANCELEN Indicates that the OK and Cancel buttons are applicable to the message in
progress.
2 DATA1EN Indicates that Data 1 is applicable to the message in progress.
3 DATA2EN Indicates that Data 2 is applicable to the message in progress.
4 ICON1EN Refer to the MSGBOX_ST.STW.ICON3EN input/output.
5 ICON2EN Refer to the MSGBOX_ST.STW.ICON3EN input/output.

680 EIO0000002093 04/2020

 MSGBOX

Bit Name Description

6 ICON3EN Combined with MSGBOX_ST.STW.ICON1EN and MSGBOX_ST.STW.ICON2EN,
enables to select the icon to be shown with the message. Refer to the SC.Mode
public variable (see page 682).
ICON1EN CON2EN ICON3EN Icon
OFF OFF OFF No icons are displayed
OFF OFF ON Information icon
OFF ON OFF Question icon
OFF ON ON Exclamation icon
ON OFF - Stop icon
ON ON - Exclamation icon

The following table describes the MSGBOX_ST.CFGW word:

Bit Name Description

8 OK Setting this signal to 1 enables to OK the message. The DFB sets this signal to 0 after
the signal has been processed.
9 Cancel Setting this signal to 1 enables to Cancel the message. The DFB sets this signal to 0
after the signal has been processed.

MSGBOX_CFG_DDT Type
The following table describes the MSGBOX_CFG_DDT type:

Name Type Description

DATA1 REAL Data 1 associated with the message. Loaded with SC.DATA1 when the latter is
applicable (refer to the SC.MODE public variable (see page 682)) when showing
the message. And vice-versa, the value in this signal is copied to SC.DATA1
after the message has been confirmed, provided that the data is applicable
(refer to the SC.MODE public variable (see page 682)).
DATA2 REAL Data 2 associated with the message. Loaded with SC.DATA2 when the latter is
applicable (refer to the SC.MODE public variable (see page 682)) when showing
the message. And, vice-versa, the value in this signal is copied to SC.DATA2
once the message has been confirmed, provided that the data is applicable
(refer to the SC.MODE public variable (see page 682)).
MSG1 STRING[40] Data 1 supplementary message. Limited to 39 characters. Loaded with
SC.MSG1 when the latter is applicable (refer to the SC.MODE public variable
(see page 682)) when showing the message.
MSG2 STRING[40] Data 2 supplementary message. Limited to 39 characters. Loaded with
SC.MSG2 when the latter is applicable (refer to the SC.MODE public variable
(see page 682)) when showing the message.

EIO0000002093 04/2020 681

MSGBOX

Public Variables

Public Variable Description

Variable Type Description

SC MSGBOX_SC_DDT Provides the interface for configuring the messages that are to be
shown, as well as their format (buttons, icons, and/or additional data).

The following table describes the MSGBOX_SC_DDT type:

Name Type Description

MSG STRING[40] Read/write access
Defines the message to be shown. The character string is limited to 39
characters. The value set in this character string is transferred to
MSGBOX_ST.MSG the moment that message activation (SC.SHOW = 1) is
requested.
MSG1 STRING[40] Read/write access
Defines supplementary message 1 to be shown. It is applicable as a
supplementary message for the main message, or as a descriptive
message for data 1. The character string is limited to 39 characters. The
value defined in this character string is transferred to MSGBOX_CFG.MSG1
the moment that message activation (SC.SHOW = 1) is requested.
MSG2 STRING[40] Read/write access
Sets the desired supplementary message 2 to be shown. It is applicable
as a supplementary message for the main message, or as a descriptive
message for data 2. The character string is limited to 39 characters. The
value defined in this character string is transferred to MSGBOX_CFG.MSG2
the moment that message activation (SC.SHOW = 1) is requested.
MODE UINT Read/write access
Refer to the MODE signal.
DATA1 REAL Read/write access
Needs to be set with the initial value to be shown in data 1 of the message
if this data is applicable when the message is activated (SC.SHOW = 1).
Also, it allows the value entered by the user to be captured after the
message is confirmed with the OK button (MSGBOX_ST.CFGW.OK).
DATA2 REAL Read/write access
Needs to be set with the initial value to be shown in data 2 of the message
if this data is applicable when the message is activated (SC.SHOW = 1).
Also, it allows the value entered by the user to be captured after the
message is confirmed with the OK button (MSGBOX_ST.CFGW.OK).

682 EIO0000002093 04/2020

 MSGBOX

Name Type Description

SHOW BOOL Read/write access
1 = Enables the message to be activated.
0 = The DFB sets the signal to 0 after the signal has been processed.
Prior to activation of this signal, the text of the message to be shown
(SC.MSG) and its format (SC.MODE) needs to be defined.
ABORT BOOL Read/write access
1 = Enables the display of the message in progress to be aborted.
1 = The DFB sets the signal to 0 after the latter is processed. It is used
both to stop showing display-only messages and to abort messages that
are awaiting the operator action.
INPROGRESS BOOL 1 = Read-only access. Refer to the INPROGRESS output pin
(see page 679).
DONE BOOL Read-only access
Refer to the DONE output pin (see page 679).
CANCELLED BOOL Read-only access
Refer to the CANCELLED output pin (see page 679).

EIO0000002093 04/2020 683

MSGBOX

MODE Signal
Enables to configure the type of message that needs to be displayed and configure the icons (Stop,
Question, Exclamation, or information), buttons (OK and/or Cancel), and/or additional data (up to
2) that needs to be shown together with the message. The configuration loaded in this signal is
transferred to the low byte under the MSGBOX_ST.STW status word the moment that message
activation (SC.SHOW = 1) is requested.
The MODE signal is defined by adding the codes associated with the different format types to those
that can be shown in the message.
The codes as well as an example of their use is included in the following table:

Code Format
0
1 (2 ) Enable the OK button

2 (21) Enable the OK and Cancel buttons

4 (22) Additional data 1 is applicable

8 (23) Additional data 2 is applicable

16(24) Show the Stop icon

32 (25) Show the Question icon

48 (24 and 25) Show the Exclamation icon

64 (26) Show the Information icon

For example, to configure the with: OK button,

(* Data 1, Data 2, and Question icon *)
MSG1_MSGBOX.SC.MODE:= 1 + 4 + 8 + 32;

684 EIO0000002093 04/2020

 Modicon Libraries General Purpose
Index
EIO0000002093 04/2020

Index

A ARAMP
DFB representation, 433
AALARM
function description, 432
DFB representation, 97
general description, 432
function description, 96
inputs, 434
general description, 96
inputs/outputs, 437
inputs, 98
outputs, 435
inputs/outputs, 101
public variables, 439
outputs, 100
ASELECT
public variables, 102
DFB representation, 645
ACALC
function description, 644
inputs, 90
general description, 644
advanced/process control
inputs, 646
ARAMP, 431
outputs, 647
IMCTL, 441
ASELECT1
LDLGCTL, 453
DFB representation, 651
PIDCTL, 463
function description, 650
PWMCTL, 481
general description, 650
RATIOCTL, 489
inputs, 652
SPLRGCTL, 497
inputs/outputs, 654
STEP3CTL, 505
outputs, 653
AHISIGNAL
public variables, 657
description, 74
auxiliary functions
DFB representation, 75
AALARM, 95
inputs, 76
AOUTPUTLP, 135
outputs, 77
ASELECT, 643
public variables, 79
ASELECT1, 649
analog devices control
CONDSUM, 659
CVALVE, 351
CONDSUM1, 667
MValveWithPos, 375
CVALVELP, 363
SDDEVCTL, 401
DEVCTL, 231
AOUTPUTLP
DEVLP, 245
DFB representation, 137
DEVMNT, 255
function description, 136
IBPARxx, 619
general description, 136
MOTOR2LP, 301
inputs, 138
MVALVEDLP, 323
inputs/outputs, 142
MVALVELP, 389
outputs, 141
PIDMUX, 473
public variables, 145
SDDEVLP, 417
SEQPARxx, 555

EIO0000002093 04/2020 685

Index

auxiliary functions of InBatch CVALVE

IBFAILED, 607 DFB representation, 353
IBSTABLESTEP, 610 function description, 352
IBSTEPDESC, 613 general description, 352
auxiliary functions of InBatchl inputs, 354
IBTRANS, 602 inputs/outputs, 358
auxiliary functions of sequential control outputs, 356
SEQFAILED, 543 public variables, 360
SEQSTABLESTEP, 546 CVALVELP
SEQSTEPDESC, 549 DFB representation, 365
SEQTRANS, 538 function description, 364
general description, 364
inputs, 366
B inputs/outputs, 370
Batch Phase Control outputs, 369
InBatch Overview, 575 public variables, 373

C D
commands DCALC
Batch phase control, 579 DFB representation, 149
sequential control, 521 function description, 148
CONDSUM general description, 148
DFB representation, 661 inputs, 150
function description, 660 outputs, 151
general description, 660 public variables, 152
inputs, 662 DEVCTL
inputs/outputs, 664 DFB representation, 233
outputs, 663 general description, 232
public variables, 666 inputs, 234
CONDSUM1 inputs/outputs, 240
DFB representation, 669 outputs, 236
function description, 668 public variables, 242
general description, 668 DEVLP
inputs, 670 DFB representation, 247
inputs/outputs, 672 function description, 246
outputs, 671 general description, 246
public variables, 674 inputs, 248
inputs/outputs, 251
outputs, 250
public variables, 254

686 EIO0000002093 04/2020

 Index

DEVMNT F
DFB representation, 257
function block interface
function description, 256
basic configuration, 33
general description, 256
continuous control, 33
inputs, 258
illustration, 34
inputs/outputs, 260
overview, 33
outputs, 259
sequential control, 33
public variables, 261
states and monitoring, 33
DINPUT
DFB representation, 155
function description, 154 G
general description, 154
general
inputs, 156
general function block concepts, 31
inputs/outputs, 158
general concepts
outputs, 157
function block interface, 33
public variables, 159
modularity, 32
DOUTPUT
set-point management, 35
DFB representation, 163
function description, 162
general description, 162
inputs, 164
H
inputs/outputs, 166 HVALVE
outputs, 165 DFB representation, 277
public variables, 167 function description, 276
DVALVE general description, 276
DFB representation, 337 inputs, 278
general description, 336 inputs/outputs, 280
inputs, 338 outputs, 279
inputs/outputs, 345 public variables, 281
outputs, 340
public variables, 347
I
IBFAILED
E function call, 608
EMCTL general description, 608
public variables, 595 inputs/outputs, 609
equipment module IBPARxx
IBPHASE - example of use, 631 DFB representation, 621, 623
function description, 620
general description, 620
public variables, 626

EIO0000002093 04/2020 687

Index

IBPHASE interlocking
description, 586 function description, 37
DFB representation, 587
inputs, 588
inputs/outputs, 589 L
IBPHASE - example of use LDLGCTL
DFB representation, 633 DFB representation, 455
reusable phase definition, 632 function description, 454
reusable phase logic, 634 general description, 454
IBPHASE-example of use inputs, 456
general description, 632 outputs, 457
IBSTABLESTEP public variables, 460
function call, 611
general description, 611
inputs/outputs, 612 M
IBSTEPDESC MAINPUT1
description, 614 function description, 170
function calls, 614 general description, 170
inputs, 616 miscellaneous functions
inputs/outputs, 617 MSGBOX, 675
public variables, 618 modularity
IBTRANS example, 32
function call, 603 overview, 32
general description, 603 MOTOR2
inputs, 605 DFB representation, 286
inputs/outputs, 606 general description, 284
IMCTL inputs, 287, 294
DFB representation, 443 outputs, 289
function description, 442 public variables, 297
general description, 442 MOTOR2LP
inputs, 444 DFB representation, 303
inputs/outputs, 447 function description, 302
outputs, 446 general description, 302
public variables, 450 inputs, 304
InBatch inputs/outputs, 308
auxiliary functions of InBatch, 601 outputs, 307
definition of statuses and commands, 578 public variables, 311
IBPHASE, 585 MSGBOX
operating modes, 583 DFB representation, 677
status controller, 582 inputs, 678
status matrix, 581 inputs/outputs, 680
InBatchl outputs, 679
function description, 576 public variables, 682
overview, 576

688 EIO0000002093 04/2020

 Index

MVALVE P
DFB representation, 377
PIDCTL
function description, 376
DFB representation, 465
general description, 376
function description, 464
inputs, 378
general description, 464
inputs/outputs, 383
inputs, 466
outputs, 381
inputs/outputs, 468
public variables, 386
outputs, 467
MVALVED
public variables, 471
DFB representation, 315
PIDMUX
function description, 314
DFB representation, 475
general description, 314
function description, 474
inputs, 316
general description, 474
inputs/outputs, 319
inputs, 476
outputs, 318
inputs/outputs, 478
public variables, 321
outputs, 477
MVALVEDLP
public variables, 480
DFB representation, 325
process Control Expert component
function description, 324
list of function blocks, 27
general description, 324
PWMCTL
inputs, 326
DFB representation, 483
inputs/outputs, 330
function description, 482
outputs, 329
general description, 482
public variables, 333
inputs, 484
MVALVELP
inputs/outputs, 486
DFB representation, 391
outputs, 485
function description, 390
public variables, 488
general description, 390
inputs, 392
inputs/outputs, 396 R
outputs, 395
RATIOCTL
public variables, 399
DFB representation, 491
function description, 490
O general description, 490
inputs, 492
on/off devices control
inputs/outputs, 494
HVALVE, 275
outputs, 493
MOTOR2, 283
public variables, 496
MVALVED, 313

EIO0000002093 04/2020 689

Index

S SEQSTEPDESC
description, 550
SDDEVCTL
function calls, 550
DFB representation, 404
inputs, 552
function description, 402
inputs/outputs, 553
general description, 402
public variables, 554
inputs, 405
SEQTRANS
inputs/outputs, 411
function call, 539
outputs, 408
general description, 539
public variables, 414
inputs, 541
SDDEVLP
inputs/outputs, 542
DFB representation, 419
sequential control
function description, 418
auxiliary functions of sequential control,
general description, 418
537
inputs, 420
definition of statuses and commands, 520
inputs/outputs, 424
function description, 518
outputs, 423
operating modes, 524
public variables, 428
overview, 518
SEQCTL1
SEQCTL1, 525
description, 526
SEQCTL1 - example of use, 563
DFB representation, 527
sequential control overview, 517
inputs/outputs, 528
status controller, 523
public variables, 531
status matrix, 522
SEQCTL1 - example of use
signal processing
DFB representation, 565
ACALC, 87
reusable sequence definition, 564
AINPUT, 103
reusable sequence logic, 566
AINPUT1, 111
SEQCTL1-example of use
AISignalCond1 and AISignalCondReal1,
general description, 564
41
SEQFAILED
AISignalHart1- HART Input Signal Condi-
function call, 544
tioning (M580), 81
general description, 544
ALINEAR, 119
inputs/outputs, 545
AOSignalCond, 49
SEQPARxx
AOUTPUT, 125
DFB representation, 557, 559
CounterSignalCondUInt and CounterSig-
function description, 556
nalCondUDInt, 55
general description, 556
DCALC, 147
inputs, 558, 622
DINPUT, 153
inputs/outputs, 560, 624
DISignalCond1, 61
public variables, 562
DOSignalCond, 67
SEQSTABLESTEP
DOUTPUT, 161
function call, 547
MAINPUT1, 169
general description, 547
TOTAL, 211
inputs/outputs, 548
simulation
function description, 37

690 EIO0000002093 04/2020

 Index

SPLRGCTL
DFB representation, 499
function description, 498
general description, 498
inputs, 500
inputs/outputs, 502
outputs, 501
public variables, 504
STAHL
DFB descriptions, 179
STAHLAI8CH
DFB description, 181
STAHLAO8CH
DFB description, 186
STAHLDI16CH
DFB description, 191
STAHLDO8CH
DFB description, 196
STAHLHARTVal4
DFB description, 201
STAHLHARTVal8
DFB description, 206
statuses
InBatch, 578
sequential control, 520
STEP3CTL, 510
DFB representation, 507
function description, 506
general description, 506
inputs, 508
inputs/outputs, 511
public variables, 514

U
USERPHASExx
inputs, 629
inputs/outputs, 630

EIO0000002093 04/2020 691

Index

692 EIO0000002093 04/2020