Eio0000002093 06

PlantStruxure General Purpose Library for Unity
EIO0000002093 01/2018
PlantStruxure General
Purpose Library for Unity
Process Components User Guide
01/2018
EIO0000002093.06
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.
No part of this document may be reproduced in any form or by any means, electronic or
mechanical, including photocopying, without express written permission of Schneider Electric.
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.
© 2017 Schneider Electric. All Rights Reserved.
2 EIO0000002093 01/2018
Table of Contents
Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Part I Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 1 Process Unity 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
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Chapter 6 DISignalCond1 - Digital Input Signal Conditioning . . . 61
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
EIO0000002093 01/2018 3
Chapter 7 DOSIGNALCOND - Digital Output Signal Conditioning. . . . 67
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Chapter 8 AHISIGNAL - HART Device Signal Mapping . . . . . . . . . . 73
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Chapter 9 AISignalHart1 - HART Input Signal Conditioning
(M580) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
EFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Chapter 10 ACALC - Analog Calculations . . . . . . . . . . . . . . . . . . . . . . 87
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Chapter 11 AALARM - Analog Alarms . . . . . . . . . . . . . . . . . . . . . . . . . 95
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Chapter 12 AINPUT - Analog Input Conditioning . . . . . . . . . . . . . . . . 103
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
4 EIO0000002093 01/2018
Chapter 13 AINPUT1 - Configurable-Range Analog Input
Conditioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Public Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Chapter 14 ALINEAR - Linear Interpolation. . . . . . . . . . . . . . . . . . . . 119
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Chapter 15 AOUTPUT - Analog Output Conditioning . . . . . . . . . . . . . 125
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Chapter 16 AOUTPUTLP - Local Panel for Analog Output Conditioning 135
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Chapter 17 DCALC - Digital Calculation . . . . . . . . . . . . . . . . . . . . . . . 147
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
EIO0000002093 01/2018 5
Chapter 18 DINPUT - Digital Input Conditioning . . . . . . . . . . . . . . . . . 153
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Chapter 19 DOUTPUT - Digital Output Conditioning . . . . . . . . . . . . . . 161
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Chapter 20 MAINPUT1 - Conditioning of Multiple Analog Inputs with
Configurable Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Chapter 21 STAHL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
21.1 STAHLAI8CH for STAHL 8-Channel Analog Input Modules . . . . . . . . 180
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
21.2 STAHLAO8CH for STAHL 8-Channel Analog Output Modules . . . . . . . 185
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
21.3 STAHLDI16CH for STAHL 16-Channel Digital Input Modules . . . . . . . 190
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
6 EIO0000002093 01/2018
21.4 STAHLDO8 for STAHL 8-Channel Digital Output Modules. . . . . . . . . . 195
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
21.5 STAHLHARTVal4 - Processing of Four HART Values . . . . . . . . . . . . 200
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
21.6 STAHLHARTVal8 - Processing of Eight HART Values . . . . . . . . . . . . 205
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Chapter 22 TOTAL - Totalizing Function . . . . . . . . . . . . . . . . . . . . . . 211
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Part III On/Off Device Control. . . . . . . . . . . . . . . . . . . . . . . . 229
Chapter 23 DEVCTL - On-Off Device. . . . . . . . . . . . . . . . . . . . . . . . . 231
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Chapter 24 DEVLP - Local Panel for Controlling On-Off Devices . . . 245
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
EIO0000002093 01/2018 7
Chapter 25 DEVMNT - On-Off Device Maintenance . . . . . . . . . . . . . . . 257
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Chapter 26 DUALOP - Dual Output . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Decription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Chapter 27 HVALVE - Manual Valve . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Chapter 28 MOTOR2 - 2-Speed/2-Rotation Direction Motor . . . . . . . . 281
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Chapter 29 MOTOR2LP - Local Panel for Controlling 2-Speed/2-
Rotation Direction Motors . . . . . . . . . . . . . . . . . . . . . . . . . 299
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
8 EIO0000002093 01/2018
Chapter 30 MVALVED - Discrete Motorized Valve . . . . . . . . . . . . . . . 311
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Chapter 31 MVALVEDLP - Local Panel for Controlling Motorized On-
Off Valves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Part IV Analog Device Control . . . . . . . . . . . . . . . . . . . . . . . 333
Chapter 32 CVALVE - Control Valve with Position Feedback . . . . . . 335
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Chapter 33 CVALVELP - Local Panel for Controlling Control Valves. 347
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Chapter 34 MVALVE - Motorized Valve with Positioner . . . . . . . . . . . 359
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
EIO0000002093 01/2018 9
Chapter 35 MVALVELP - Local Panel for Controlling Motorized Valves 371
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Chapter 36 SDDEVCTL - Device with Variable Speed Drive . . . . . . . . 383
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Chapter 37 SDDEVLP - Local Panel for Controlling Devices with a
Variable-Speed Drive . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Part V Process Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Chapter 38 ARAMP - RAMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Chapter 39 IMCTL - IMC Controller with Monitoring Interface . . . . . . 425
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
10 EIO0000002093 01/2018
Chapter 40 LDLGCTL - Lead-Lag Controller with Monitoring Interface 437
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Chapter 41 PIDCTL - PIDFF Regulator with Monitoring Interface. . . 447
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Chapter 42 PIDMUX - Multiplexer for 2 Groups of PIDCTL Parameters 457
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Chapter 43 PWMCTL - Pulse-Width Modulated Controller . . . . . . . . . 465
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Chapter 44 RATIOCTL - Ratio Controller . . . . . . . . . . . . . . . . . . . . . 473
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
EIO0000002093 01/2018 11
Chapter 45 SPLRGCTL - Split-Range Controller . . . . . . . . . . . . . . . . . 481
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Chapter 46 STEP3CTL - 3 Step Controller/Positioner . . . . . . . . . . . . . 489
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Part VI Sequential Control . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Chapter 47 Sequential Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Description of Sequential Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
Definition of Status and Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Status Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Status Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Chapter 48 SEQCTL1 - Advanced Sequential Control. . . . . . . . . . . . . 509
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
Chapter 49 Auxiliary Functions of Sequential Control. . . . . . . . . . . . . 519
49.1 SEQTRANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
49.2 SEQFAILED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
49.3 SEQSTABLESTEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
12 EIO0000002093 01/2018
49.4 SEQSTEPDESC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Chapter 50 SEQPARxx - Sequence Parameter Management . . . . . . 537
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
Chapter 51 SEQCTL1 - Example of Use . . . . . . . . . . . . . . . . . . . . . . 545
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
Reusable Sequence Logic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
Part VII Batch Phase Manager . . . . . . . . . . . . . . . . . . . . . . . 555
Chapter 52 Batch Phase Manager . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Description of Batch Phase Manager . . . . . . . . . . . . . . . . . . . . . . . . . 558
Definition of Phase Statuses, Batch Phase Statuses, Phase
Commands and Batch Phase Commands . . . . . . . . . . . . . . . . . . . . . 560
Status Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Status Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
Chapter 53 IBPHASE - Individual Batch Phase Manager . . . . . . . . . 567
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
Chapter 54 Auxiliary Functions of Batch Phase . . . . . . . . . . . . . . . . 585
54.1 IBTRANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
54.2 IBFAILED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
EIO0000002093 01/2018 13
54.3 IBSTABLESTEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
54.4 IBSTEPDESC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Chapter 55 IBPARxx - Batch Phase Parameter Management . . . . . . 603
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Chapter 56 USERPHASExx - User Defined Process Logic . . . . . . . . . 611
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Chapter 57 IBPHASE - Example of Use . . . . . . . . . . . . . . . . . . . . . . . 615
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Reusable Phase Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Part VIII Auxiliary Functions . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Chapter 58 ASELECT - Analog Signal Selector . . . . . . . . . . . . . . . . . 627
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Chapter 59 ASELECT1 - Selector for Analog Signals with Monitoring
Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
14 EIO0000002093 01/2018
Chapter 60 CONDSUM - Summary of Conditions . . . . . . . . . . . . . . . . 641
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
Chapter 61 CONDSUM1 - Interlock Condition Summary . . . . . . . . . . . 649
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Chapter 62 MSGBOX - Messages to the Operator . . . . . . . . . . . . . . . 657
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Index ......................................... 667
EIO0000002093 01/2018 15
16 EIO0000002093 01/2018
Safety Information
Important Information
NOTICE
Read these instructions carefully, and look at the equipment to become familiar with the device
before trying to install, operate, or maintain it. The following special messages may appear
throughout this documentation or on the equipment to warn of potential hazards or to call attention
to information that clarifies or simplifies a procedure.
EIO0000002093 01/2018 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 01/2018
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.
CAUTION
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 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 01/2018 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 01/2018
About the Book
At a Glance
Document Scope
This document provides an operating information of a project developed by using Unity Pro and
PlantStruxure General Purpose Library for Unity.
This document does not cover any development procedures and internal functionality details.
Users of the Unity Pro services are supposed to have a working knowledge in the employment of
Unity Pro.
Validity Note
This document has been updated with the release of PlantStruxure General Purpose Library for
Unity 2018.
PlantStruxure General Purpose Library for Unity process components support the following
software versions of Unity Pro:
 Unity Pro V11
This library is compatible with the following hardware platforms:

 Quantum
 M340
 M580
EIO0000002093 01/2018 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.
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.
22 EIO0000002093 01/2018
Examples described in this manual are provided for information only.
WARNING
Adapt examples that are given in this manual to the specific functions and requirements of your
industrial application before you implement them.
EIO0000002093 01/2018 23
24 EIO0000002093 01/2018
Overview
EIO0000002093 01/2018
Part I
Overview
Overview
Overview
The PlantStruxure General Purpose Library for Unity software 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 Unity Pro 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 Unity Components 27
2 General Function Block Concepts 31
EIO0000002093 01/2018 25
Overview
26 EIO0000002093 01/2018
Process Unity Components
EIO0000002093 01/2018
Chapter 1
List of Function Blocks
List of Families
The function blocks described in this document are grouped by family.
EIO0000002093 01/2018 27
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 01/2018

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 257) On-off device maintenance.
DUALOP (see page 265) Dual output.
HVALVE (see page 273) Hand valve.
MOTOR2 (see page 281) 2-speed/2-rotation direction motor.
MOTOR2LP (see page 299) Local panel for controlling 2-speed/2-rotation
direction motors.
MVALVED (see page 311) Motorized valve without positioner.
MVALAVEDLP (see page 321) Local panel for controlling motorized on-off
valves.
Analog device CVALVE (see page 335) Control valve.
control
CVALVELP (see page 347) Local panel for controlling control valves.
MVALVE (see page 359) Motorized valve with positioner.
MVALVELP (see page 371) Local panel for controlling motorized valves.
SDDEVCTL (see page 383) Motor with variable speed drive.
SDDEVLP (see page 399) Local panel for controlling devices with variable-
speed drive.
Process control ARAMP (see page 415) Ramp.
IMCTL (see page 425) Internal model controller.
LDLGCTL (see page 437) Lead-Lag controller.
PIDCTL (see page 447) PID controller.
PIDMUX (see page 457) Multiplexer for 2 groups of PIDCTL parameters.
PWMCTL (see page 465) Pulse width modulated controller.
RATIOCTL (see page 473) Ratio controller.
SPLRGCTL (see page 481) Split-range controller.
STEP3CTL (see page 489) 3-Step controller/positioner.
Sequential control SEQCTL1 (see page 509) Advanced sequential control.
SEQPARxx (see page 537) Sequential parameter management.
Batch Phase IBPHASE (see page 567) Individual Batch phase manager.
Manager
IBPARxx (see page 603) Batch phase parameter management.
EIO0000002093 01/2018 29

Auxiliary functions ASELECT (see page 627) Analog signal selector.
ASELECT1 (see page 633) Analog signal selector with monitoring
variables.
CONDSUM (see page 641) Summary of conditions.
CONDSUM1 (see page 649) Interlock condition summary.
MSGBOX (see page 657) Messages to the operator.
30 EIO0000002093 01/2018
General Concepts
EIO0000002093 01/2018
Chapter 2
General Function Block Concepts
General Function Block Concepts
Overview
This chapter describes the basic concepts that the process Unity Pro 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 01/2018 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 01/2018
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 01/2018 33
General Concepts
Illustration
The following figure illustrates the previous provided interface.
34 EIO0000002093 01/2018
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 01/2018 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 01/2018
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 01/2018 37
General Concepts
38 EIO0000002093 01/2018
Signal Processing
EIO0000002093 01/2018
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
regulations.
1For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
EIO0000002093 01/2018 39
Signal Processing

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 Device Signal Mapping 73
9 AISignalHart1 - HART Input Signal Conditioning (M580) 81
10 ACALC - Analog Calculations 87
11 AALARM - Analog Alarms 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 01/2018
AISignalCond1 and AISignalCondReal1
EIO0000002093 01/2018
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.

Topic Page
Description 42
EFB Representation 43
Inputs 44
Outputs 45
Obtaining the Module Status When Mapped to X80 I/O Module 46
EIO0000002093 01/2018 41
Description
General
PlantStruxure General Purpose library for Unity uses 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 01/2018
EFB Representation
Representation
These EFBs have been specifically designed for use with the FBD language of the controller.
EIO0000002093 01/2018 43
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.
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 01/2018
Outputs
Output Parameter 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 01/2018 45
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:
46 EIO0000002093 01/2018
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)..
 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:
EIO0000002093 01/2018 47
The following figure shows the ModuleStatus of channel 11:
48 EIO0000002093 01/2018
AOSIGNALCOND
EIO0000002093 01/2018
Chapter 4
AOSIGNALCOND - Analog Output Signal conditioning
AOSIGNALCOND - Analog Output Signal conditioning
Overview
This chapter describes the AOSIGNALCOND DFB.

Topic Page
Description 50
DFB Representation 51
Inputs 52
Outputs 53
EIO0000002093 01/2018 49
AOSIGNALCOND
Description
General
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 01/2018
AOSIGNALCOND
DFB Representation
Representation
This DFB has been specifically designed for use with the FBD language of the controller.
EIO0000002093 01/2018 51
AOSIGNALCOND
Inputs
Parameter Type Description

SIGNALVALUE INT Signal value from an analog output card.
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 BOOL 1 = Input.
52 EIO0000002093 01/2018
AOSIGNALCOND
Outputs

CHANNELVALUE INT Channel value after the modules 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 1 = Output.
EIO0000002093 01/2018 53
AOSIGNALCOND
54 EIO0000002093 01/2018
CounterSignalCondUInt and CounterSignalCondUDInt
EIO0000002093 01/2018
Chapter 5
CounterSignalCondUInt and CounterSignalCondUDInt - Counter Signal Conditioning
CounterSignalCondUInt and CounterSignalCon-

dUDInt - Counter Signal Conditioning
Overview
This chapter describes the CounterSignalCondUInt and CounterSignalCondUDInt EFBs.

Topic Page
Description 56
Inputs 58
Outputs 59
EIO0000002093 01/2018 55
Description
General
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 01/2018
EFB Representation
Representation
These EFBs have been specifically designed for use with the FBD language of the controller.
EIO0000002093 01/2018 57
Inputs

CHANNELVALUE UDINT CounterSignalCondUDInt Channel value from a counter
UINT CounterSignalCondUInt module.
ERROR BOOL CounterSignalCondUDInt Detected channel error signal from

CounterSignalCondUInt an analog input module.
HEALTH BOOL CounterSignalCondUDInt Inverted detected channel error
CounterSignalCondUInt signal from module.
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 01/2018
Outputs

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 detected

SIGNALFAILURE16 CounterSignalCondUInt channel or module or simulated channel
error.
SIMULATION BOOL CounterSignalCondUDInt Simulation status.
CounterSignalCondUInt 1 = Simulation ON.
EIO0000002093 01/2018 59
60 EIO0000002093 01/2018
DISignalCond1
EIO0000002093 01/2018
Chapter 6
DISignalCond1 - Digital Input Signal Conditioning
DISignalCond1 - Digital Input Signal Conditioning
Overview
This chapter describes the DISignalCond1 EFB.

Topic Page
Description 62
Inputs 64
Outputs 65
EIO0000002093 01/2018 61
DISignalCond1
Description
General
The DISignalCond1 EFB allows processing the digital signal value and signal quality data.
62 EIO0000002093 01/2018
DISignalCond1
EFB Representation
Representation
EIO0000002093 01/2018 63
DISignalCond1
Inputs

CHANNELVALUE BOOL DISignalCond1 1 = Channel value from a digital input
module.
ERROR BOOL DISignalCond1 Detected channel error signal from an
analog input module.
HEALTH BOOL DISignalCond1 Inverted detected channel error signal from
module.
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.
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 01/2018
DISignalCond1
Outputs

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 01/2018 65
DISignalCond1
66 EIO0000002093 01/2018
DOSIGNALCOND
EIO0000002093 01/2018
Chapter 7
DOSIGNALCOND - Digital Output Signal Conditioning
DOSIGNALCOND - Digital Output Signal Conditioning
Overview
This chapter describes the DOSIGNALCOND DFB.

Topic Page
Description 68
Inputs 70
Outputs 71
EIO0000002093 01/2018 67
DOSIGNALCOND
Description
General
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 01/2018
DOSIGNALCOND
DFB Representation
Representation
EIO0000002093 01/2018 69
DOSIGNALCOND
Inputs

SIGNALVALUE BOOL 1 = Signal value from a digital output card.
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 1 = Negates the signal value.
IN BOOL 1 = Input.
70 EIO0000002093 01/2018
DOSIGNALCOND
Outputs

CHANNELVALUE BOOL 1 = Channel value after the modules 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 1 = Output.
EIO0000002093 01/2018 71
DOSIGNALCOND
72 EIO0000002093 01/2018
AHISIGNAL
EIO0000002093 01/2018
Chapter 8
AHISIGNAL - HART Device Signal Mapping
AHISIGNAL - HART Device Signal Mapping
Overview
This chapter describes the AHISIGNAL DFB.

Topic Page
Description 74
Inputs 76
Outputs 77
Public Variables 80
EIO0000002093 01/2018 73
AHISIGNAL
Description
Overview
The AHISIGNAL DFB is used for HART devices that communicate with the controller through the
Advantys Island.
The function block maps the channel information from the Advantys to the device if the channel is
enabled and connected.
74 EIO0000002093 01/2018
AHISIGNAL
DFB Representation
Representation
The FBD is designed for use with the FBD language of the controller.
The figure shows the AHISIGNAL DFB:
EIO0000002093 01/2018 75
AHISIGNAL
Inputs

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 01/2018
AHISIGNAL
Outputs

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 80).
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 01/2018 77
AHISIGNAL

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:
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.
78 EIO0000002093 01/2018
AHISIGNAL

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:
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.
EIO0000002093 01/2018 79
AHISIGNAL
Public Variables
Public Variable 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:
80 EIO0000002093 01/2018
AISignalHart1
EIO0000002093 01/2018
Chapter 9
AISignalHart1 - HART Input Signal Conditioning (M580)
AISignalHart1 - HART Input Signal Conditioning (M580)
Overview
This chapter describes the AISignalHart1 EFB.

Topic Page
Description 82
Inputs 84
Outputs 85
EIO0000002093 01/2018 81
AISignalHart1
Description
General
The AISignalHart1 EFB is used to read DTM generated extended HART data from BMEAHI
and BMEAHO modules.
82 EIO0000002093 01/2018
AISignalHart1
EFB Representation
Representation
The EFB is designed for use with the FBD language of the controller.
EIO0000002093 01/2018 83
AISignalHart1
Inputs

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.
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 01/2018
AISignalHart1
Outputs

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 01/2018 85
AISignalHart1
86 EIO0000002093 01/2018
ACALC
EIO0000002093 01/2018
Chapter 10
ACALC - Analog Calculations
ACALC - Analog Calculations
Overview
This chapter describes the ACALC DFB.

Topic Page
Description 88
Inputs 90
Outputs 91
Public Variables 93
EIO0000002093 01/2018 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:
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 01/2018
ACALC
DFB Representation
Representation
EIO0000002093 01/2018 89
ACALC
Inputs

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.
90 EIO0000002093 01/2018
ACALC
Outputs

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 t r PV ³
KROC r ¥
£ £ £ ´
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.
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.
EIO0000002093 01/2018 91
ACALC
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 01/2018
ACALC
Public Variables
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 01/2018 93
ACALC
94 EIO0000002093 01/2018
AALARM
EIO0000002093 01/2018
Chapter 11
AALARM - Analog Alarms
AALARM - Analog Alarms
Overview
This chapter describes the AALARM DFB.

Topic Page
Description 96
Inputs 98
Outputs 100
Inputs/Outputs 101
Public Variables 102
EIO0000002093 01/2018 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.
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 01/2018
AALARM
DFB Representation
Representation
EIO0000002093 01/2018 97
AALARM
Inputs

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 in msec for connecting the detected alarms.
TOFFSP TIME Timing set-point in msec for disconnecting the detected alarms in
msec.
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 01/2018
AALARM
AALARM_CFG Type

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 01/2018 99
AALARM
Outputs

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 01/2018

AALARM
Inputs/Outputs
Input/Output Parameter 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 01/2018 101

AALARM
Public Variables

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

AHH BOOL 1 = Read-only access. Refer to the AHH output pin (see page 100).
AH BOOL 1 = Read-only access. Refer to the AH output pin (see page 100).
AD BOOL 1 = Read-only access. Refer to the AD output pin (see page 100).
AL BOOL 1 = Read-only access. Refer to the AL output pin (see page 100).
ALL BOOL 1 = Read-only access. Refer to the ALL output pin (see page 100).
102 EIO0000002093 01/2018

AINPUT
EIO0000002093 01/2018
Chapter 12
AINPUT - Analog Input Conditioning
AINPUT - Analog Input Conditioning
Overview
This chapter describes the AINPUT DFB.

Topic Page
Description 104
Inputs 106
Outputs 107
Inputs/Outputs 108
EIO0000002093 01/2018 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.
You 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.
The main functions of the DFB are described in the table:
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 01/2018

AINPUT
DFB Representation
Representation
EIO0000002093 01/2018 105

AINPUT
Inputs

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).
106 EIO0000002093 01/2018

AINPUT
Outputs

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. CHFAILURE CHIN PV is calculated as:

SIMMD
- ON - - AINPUT_CFG.SIM
ON OFF - - EXTPV
OFF OFF ON - BADPV
OFF OFF OFF <= LORAW LOPV
OFF OFF OFF >LORAW Refer to the linear

and scaling formula.
=<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 01/2018 107

AINPUT
Inputs/Outputs

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

STW WORD DFB status word. Read-only access.
Bit 0 BADST DFB status. 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 DFB configuration. 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

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 01/2018

AINPUT
Public Variables

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

BADST BOOL 1 = DFB status word. 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 01/2018 109

AINPUT
110 EIO0000002093 01/2018

AINPUT1
EIO0000002093 01/2018
Chapter 13
AINPUT1 - Configurable-Range Analog Input Conditioning
AINPUT1 - Configurable-Range Analog Input Conditioning
Overview
This chapter describes the AINPUT1 DFB.

Topic Page
Description 112
Inputs 114
Outputs 115
Inputs/Outputs 116
EIO0000002093 01/2018 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
You can supplement AINPUT1 with two other DFBs of the General Purpose library:
measurement.
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.
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.
engineering units).
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 01/2018

AINPUT1
DFB Representation
Representation
EIO0000002093 01/2018 113

AINPUT1
Inputs

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).
114 EIO0000002093 01/2018

AINPUT1
Outputs

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
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 01/2018 115

AINPUT1
Inputs/Outputs

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

Bit 0 BADST DFB status. 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 DFB configuration. 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

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.
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.
116 EIO0000002093 01/2018

AINPUT1

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).
= 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).
= AINPUT1_CFG.CHIPV = 0.0), it is initialized with the value of the LOPV input pin.
EIO0000002093 01/2018 117

AINPUT1
Public Variables

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

BADST BOOL 1 = DFB status word. Read-only access.
Refer to the AINPUT1.STW.BADST input/output pin (see page 116).
118 EIO0000002093 01/2018

ALINEAR
EIO0000002093 01/2018
Chapter 14
ALINEAR - Linear Interpolation
ALINEAR - Linear Interpolation
Overview
This chapter describes the ALINEAR DFB.

Topic Page
Description 120
Inputs 122
Outputs 123
EIO0000002093 01/2018 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 01/2018

ALINEAR
DFB Representation
Representation
EIO0000002093 01/2018 121

ALINEAR
Inputs

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 01/2018

ALINEAR
Outputs

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 01/2018 123

ALINEAR
124 EIO0000002093 01/2018

AOUTPUT
EIO0000002093 01/2018
Chapter 15
AOUTPUT - Analog Output Conditioning
AOUTPUT - Analog Output Conditioning
Overview
This chapter describes the AOUTPUT DFB.

Topic Page
Description 126
Inputs 128
Outputs 129
Inputs/Outputs 131
EIO0000002093 01/2018 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.
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 01/2018

AOUTPUT
DFB Representation
Representation
EIO0000002093 01/2018 127

AOUTPUT
Inputs

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.
ILCK BOOL 1 = Interlocks the device at the defined position.
128 EIO0000002093 01/2018

AOUTPUT
Outputs

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: Program, ON: REM SP
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 01/2018 129

AOUTPUT

¤ HIRAW LORAW ³ ¤ HIRAW LORAW ³
¥¦ r SP´ LORAW ¥ r LOSP´
HISP LOSP µ ¦ HISP LOSP µ
130 EIO0000002093 01/2018

AOUTPUT
Inputs/Outputs

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

OP REAL Read-only access. Refer to the OP output pin (see page 129).
CFGW WORD Provides the necessary data to configure the DFB usually from the
monitoring subsystem.
AOUTPUT_ST.STW Word Structure

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

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

AOUTPUT
AOUTPUT_CFG_DDT Type

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 01/2018

AOUTPUT
Public Variables

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

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 Read-only access. Refer to the SP output pin (see page 129).
OWNER BOOL 1 = Read-only access.
Refer to the AOUTPUT_ST.CFGW.OWNER input/output pin (see page 131).
REM BOOL 1 = Read/write access.
Allows the DFB to be configured to remote set-point—RSP—(1) or local set-point—
LSP— (0).
TRACK BOOL 1 = Read-only access.
Refer to the TRACK output pin (see page 129).
BADST BOOL 1 = Read-only access.
Refer to the AOUTPUT.STW.BADST input/output pin (see page 131).
ILCKD BOOL 1 = 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 01/2018 133

AOUTPUT
134 EIO0000002093 01/2018

AOUTPUTLP
EIO0000002093 01/2018
Chapter 16
AOUTPUTLP - Local Panel for Analog Output Conditioning
AOUTPUTLP - Local Panel for Analog Output Conditioning
Overview
This chapter describes the AOUTPUTLP DFB.

Topic Page
Description 136
Inputs 138
Outputs 141
Inputs/Outputs 143
EIO0000002093 01/2018 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.
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 through the DFB
Enabling/Disabling 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 PlantStruxure General
Purpose Library for Unity is used along with PlantStruxure General Purpose Library
for WSP.
136 EIO0000002093 01/2018

AOUTPUTLP
DFB Representation
Representation
EIO0000002093 01/2018 137

AOUTPUTLP
Inputs

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 01/2018

AOUTPUTLP

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 PlantStruxure
General Purpose Library for WSP offer only, however there is no impact
of this input signal in PlantStruxure General Purpose Library for Citect
offer.
(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. Push buttons
DisableLP 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 01/2018 139

AOUTPUTLP

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 LockOwnerE Owner
N
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.
LockSetPoint- BOOL 1 = Disables the setpoint of the analog output and lock it into the one defined
EN 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 01/2018

AOUTPUTLP
Outputs

PBLIGHT- BOOL 1 = The push buttons on the local panel are fully operational, that is, the local panel
Signal 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:
MODES- Virtu- PBSig- LPSig- CSSig- ZEROSig- OUTPUT
ig- alLPEN nalsEN nal nal nal
nalsEN
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 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
EIO0000002093 01/2018 141

AOUTPUTLP

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.
142 EIO0000002093 01/2018

AOUTPUTLP
Inputs/Outputs

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

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

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

AOUTPUTLP
AOUTPUTLP_ST.DDT Type

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:

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

0 LocalModeOn Read/write access only.
 1 = Enables the Local Panel mode.
 0 = Enables the Control System mode.
AOUTPUTLP_ST.STW Word
Read-only access. Status word. The following table describes the AOUTPUTLP_ST.STW word:

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).
144 EIO0000002093 01/2018

AOUTPUTLP

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.
EIO0000002093 01/2018 145

AOUTPUTLP
Public Variables

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

LPMode BOOL 1 = Read-only access. Refer to the LPMode output pin.
ZEROMode BOOL 1 = Read-only access. Refer to the ZEROMode output pin.
CSMode BOOL 1 = 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).
146 EIO0000002093 01/2018

DCALC
EIO0000002093 01/2018
Chapter 17
DCALC - Digital Calculation
DCALC - Digital Calculation
Overview
This chapter describes the DCALC DFB.

Topic Page
Description 148
Inputs 150
Outputs 151
EIO0000002093 01/2018 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.
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 01/2018

DCALC
DFB Representation
Representation
EIO0000002093 01/2018 149

DCALC
Inputs

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).
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.
150 EIO0000002093 01/2018

DCALC
Outputs

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). 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.
EIO0000002093 01/2018 151

DCALC
Public Variables

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

PV BOOL 1 = Read-only access. Refer to the PV input pin (see page 150).
FREQ REAL 1 = Read-only access. Refer to the FREQ output pin (see page 151).
TOTAL REAL 1 = 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 01/2018

DINPUT
EIO0000002093 01/2018
Chapter 18
DINPUT - Digital Input Conditioning
DINPUT - Digital Input Conditioning
Overview
This chapter describes the DINPUT DFB.

Topic Page
Description 154
Inputs 156
Outputs 157
Inputs/Outputs 158
EIO0000002093 01/2018 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.
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 01/2018

DINPUT
DFB Representation
Representation
EIO0000002093 01/2018 155

DINPUT
Inputs

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) in msec (0 to deactivate
timing).
TOFFSP TIME Timing set-point for digital input disconnection (CHIN) in msec (0 to deactivate
timing).
156 EIO0000002093 01/2018

DINPUT
Outputs

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 01/2018 157

DINPUT
Inputs/Outputs

DINPUT_ST DINPUT_ST_DDT Provides the DFB status and configuration.
DINPUT_ST_DDT Type

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

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

DINPUT
DINPUT_ST.STW Word Structure:

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

DINPUT
Public Variables

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

PV BOOL 1 = Read-only access. Refer to the PV output pin
(see page 157).
ALARM BOOL 1 = Read-only access. Refer to the
DINPUT_ST.STW.ALARM input/output pin
(see page 158).
160 EIO0000002093 01/2018

DOUTPUT
EIO0000002093 01/2018
Chapter 19
DOUTPUT - Digital Output Conditioning
DOUTPUT - Digital Output Conditioning
Overview
This chapter describes the DOUTPUT DFB.

Topic Page
Description 162
Inputs 164
Outputs 165
Inputs/Outputs 166
EIO0000002093 01/2018 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.
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 01/2018

DOUTPUT
DFB Representation
Representation
EIO0000002093 01/2018 163

DOUTPUT
Inputs

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.
164 EIO0000002093 01/2018

DOUTPUT
Outputs

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.
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.
SC.ILCKD OWNER REM TRACK
ON - - ON
OFF OFF OFF ON
OFF OFF ON OFF
OFF ON - ON
EIO0000002093 01/2018 165

DOUTPUT
Inputs/Outputs

DOUTPUT_ST DOUTPUT_ST_DDT Provides the DFB status and configuration.
DOUTPUT_ST_DDT Type

CFGW WORD Provides the data necessary to configure the DFB usually from the
DOUTPUT_ST.CFGW Word Structure:

0 OWNER DFB commands.
Read/write access. Enables to configure whether the set-point is set by
the Program (0) or the Operator (1).
1 ILCKBP DFB commands.
Read/write access. Enables the interlock to be bypassed (1).
2 LSP DFB commands.
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
DOUTPUT_ST.STW Word Structure

0 BADST DFB status.
Indicates if the output channel is not operational. Reproduces the
CHFAILURE input value.
1 ILCK DFB status. Refer to the ILCK input pin (see page 164)
3 OP DFB status.
166 EIO0000002093 01/2018

DOUTPUT
Public Variables

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

OWNER BOOL 1 = Read-only access. Refer to the
DOUTPUT_ST.CFGW.OWNER input/output pin
(see page 166).
LSP BOOL 1 = 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 1 = Read/write access. Enables the DFB to be
configured for remote set-point—RSP—(1) or local set-
point—LSP – (0).
SP BOOL 1 = Read-only access. Refer to the SP output pin
(see page 165).
OP BOOL 1 = Read-only access.
TRACK BOOL 1 = Read-only access. Refer to the TRACK output pin
(see page 165).
BADST BOOL 1 = Read-only access (see page 166).
ILCKD BOOL 1 = 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 ILCKB SC.ILCKD
P
OFF - OFF
ON OFF ON
ON ON OFF
EIO0000002093 01/2018 167

DOUTPUT
168 EIO0000002093 01/2018

MAINPUT1
EIO0000002093 01/2018
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.

Topic Page
Description 170
Inputs 172
Outputs 174
Inputs/Outputs 175
EIO0000002093 01/2018 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.
You can supplement MAINPUT1 with two other DFBs of the General Purpose library:
measurement.
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.
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.
engineering units).
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 01/2018

MAINPUT1
DFB Representation
Representation
EIO0000002093 01/2018 171

MAINPUT1
Inputs

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.
is operational.
is operational.
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 01/2018

MAINPUT1

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 01/2018 173

MAINPUT1
Outputs

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 01/2018

MAINPUT1
Inputs/Outputs

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

STW WORD Read-only access. DFB status word.
CFGW WORD DFB configuration word. Read/write access.
MAINPUT1_CFG_DDT Type

PV1 REAL Read access. Refer to the PV1 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.
(MAINPUT1_CFG.CLOPV = MAINPUT1_CFG.CHIPV = 0.0), it is initialized with the
value of the HIPV input.
EIO0000002093 01/2018 175

MAINPUT1

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.
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).
(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).
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

0 BADST DFB status. 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 DFB status. One or more non-operational channel.
2 DEVALM DFB status. Refer to the DEVALM output pin (see page 174).
176 EIO0000002093 01/2018

MAINPUT1
MAINPUT1_ST.CFGW Word Structure

0 SIMMD DFB configuration. Read/write access. Enables to put the analog input in Simulation
(1) mode or Normal (0) mode.
1 OWNER Selector commands. Read/write access. Enables to configure whether the set-point is
set by the Program (0) or Operator (1).
MAINPUT1_CFG.PVW Word Structure

0 PV1EN DFB status. PV1 selection enabled. Enabled when a variable or value is connected to
input CHIN1.
input CHIN2.
input CHIN3.
input CHIN4.
4 PV1FAIL Detected error on signal PV1. PV1EN = 1 and CHFAILURE1 = 1.
EIO0000002093 01/2018 177

MAINPUT1
Public Variables

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

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 1 = Read-only access. Refer to the ISGOOD output pin (see page 174).
REM BOOL 1 = Read/write access. Allows the DFB to be configured for a remote set-point -RSEL-
(1) or local set-point -LSEL- (0).
OWNER BOOL 1 = Read/write access. Refer to the MAINPUT1_ST.CGFW.OWNER input/output pin
(see page 175).
178 EIO0000002093 01/2018

STAHL Resources
EIO0000002093 01/2018
Chapter 21
STAHL
STAHL
Overview
This chapter describes the DFBs to process data of modules of the STAHL IS1 Remote
I/O system.

This chapter contains the following sections:
Section Topic Page
21.1 STAHLAI8CH for STAHL 8-Channel Analog Input Modules 180
21.2 STAHLAO8CH for STAHL 8-Channel Analog Output Modules 185
21.3 STAHLDI16CH for STAHL 16-Channel Digital Input Modules 190
21.4 STAHLDO8 for STAHL 8-Channel Digital Output Modules 195
21.5 STAHLHARTVal4 - Processing of Four HART Values 200
21.6 STAHLHARTVal8 - Processing of Eight HART Values 205
EIO0000002093 01/2018 179

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 181
Inputs 183
Outputs 184
180 EIO0000002093 01/2018

STAHL Resources
Description
General
The STAHLAI8CH DFB allows reading analog input signal values and signal quality data of STAHL
8-channel analog input modules.
EIO0000002093 01/2018 181

STAHL Resources
DFB Representation
Representation
The following figure shows the STAHLAI8CH DFB as it appears in an FBD section:
182 EIO0000002093 01/2018

STAHL Resources
Inputs

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).
EIO0000002093 01/2018 183

STAHL Resources
Outputs

Value01...Value08 INT Signal value of channels 0 to 7.
Failure01...Failure08 BOOL 0 = Healthy
Status of channels 0 to 7.
184 EIO0000002093 01/2018

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.

Topic Page
Description 186
Inputs 188
Outputs 189
EIO0000002093 01/2018 185

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.
186 EIO0000002093 01/2018

STAHL Resources
DFB Representation
Representation
The following figure shows the STAHLAO8CH DFB as it appears in an FBD section:
EIO0000002093 01/2018 187

STAHL Resources
Inputs

CHx INT Signal value for channel x.
STAHL analog output module.
188 EIO0000002093 01/2018

STAHL Resources
Outputs

Value01...Value08 INT Provides signal value to channels 0 to 7 of the STAHL
analog output module.
EIO0000002093 01/2018 189

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.

Topic Page
Description 191
Inputs 193
Outputs 194
190 EIO0000002093 01/2018

STAHL Resources
Description
General
The STAHLDI8CH DFB allows reading the digital input signal value and signal quality data of
STAHL 16-channel digital input modules.
EIO0000002093 01/2018 191

STAHL Resources
DFB Representation
Representation
The following figure shows the STAHLDI16CH DFB as it appears in an FBD section:
192 EIO0000002093 01/2018

STAHL Resources
Inputs

CHx BOOL 1 = Signal value of channel x from the STAHL
digital input module.
STAHL digital input module
EIO0000002093 01/2018 193

STAHL Resources
Outputs

Value01...Value16 BOOL Signal value of channels 0 to 15.
194 EIO0000002093 01/2018

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.

Topic Page
Description 196
Inputs 198
Outputs 199
EIO0000002093 01/2018 195

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.
196 EIO0000002093 01/2018

STAHL Resources
DFB Representation
Representation
The following figure shows the STAHLDO8CH DFB as it appears in an FBD section:
EIO0000002093 01/2018 197

STAHL Resources
Inputs

CHx BOOL 1 = Signal value for channel x.
STAHL digital output module.
198 EIO0000002093 01/2018

STAHL Resources
Outputs

Value01...Value08 BOOL 1 = Provides signal value to channels 0 to 7 of the
STAHL digital output module.
EIO0000002093 01/2018 199

STAHL Resources
Section 21.5
STAHLHARTVal4 - Processing of Four HART Values
STAHLHARTVal4 - Processing of Four HART Values
Overview
This section describes the STAHLHARTVal4 DFB.

Topic Page
Description 201
Inputs 203
Outputs 204
200 EIO0000002093 01/2018

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.
EIO0000002093 01/2018 201

STAHL Resources
DFB Representation
Representation
The following figure shows the STAHLHARTVal4 DFB as it appears in an FBD section:
202 EIO0000002093 01/2018

STAHL Resources
Inputs

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).
EIO0000002093 01/2018 203

STAHL Resources
Outputs

HARTValuex REAL Result of the conversion of inputs x into HART value x.
204 EIO0000002093 01/2018

STAHL Resources
Section 21.6
STAHLHARTVal8 - Processing of Eight HART Values
STAHLHARTVal8 - Processing of Eight HART Values
Overview
This section describes the STAHLHARTVal8 DFB.

Topic Page
Description 206
Inputs 208
Outputs 209
EIO0000002093 01/2018 205

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.
206 EIO0000002093 01/2018

STAHL Resources
DFB Representation
Representation
The following figure shows the STAHLHARTVal8 DFB as it appears in an FBD section:
EIO0000002093 01/2018 207

STAHL Resources
Inputs

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.
208 EIO0000002093 01/2018

STAHL Resources
Outputs

HARTValuex REAL Result of the conversion of inputs x into HART value x.
EIO0000002093 01/2018 209

STAHL Resources
210 EIO0000002093 01/2018

TOTAL
EIO0000002093 01/2018
Chapter 22
TOTAL - Totalizing Function
TOTAL - Totalizing Function
Overview
This chapter describes the TOTAL DFB.

Topic Page
Description 212
Inputs 216
Outputs 221
Inputs/Outputs 224
EIO0000002093 01/2018 211

TOTAL
Description
General
The objective of TOTAL block is to perform totalizer calculation based on 3 inputs (analog signal,
digital pulses, counter).
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 01/2018

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 01/2018 213

TOTAL
Commands and States with respect to FAIL Input pin
FAIL Input Pin Last Active State Command Current Active State
Value
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 01/2018

TOTAL
DFB Representation
Representation
This DFB has been specifically designed for use with the FBD language of the controller
EIO0000002093 01/2018 215

TOTAL
Inputs

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
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
 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.
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 01/2018

TOTAL

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 01/2018 217

TOTAL

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 = 14400 × 0.000139
Total=2 Litres.
218 EIO0000002093 01/2018

TOTAL

ROLLOVERCOUNT UDINT The rollover to be declared as the maximum PV value provided to
the input pin of PVCOUNT_UDINT or PVCOUNT_UINT.
NOTE:
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-
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-
EIO0000002093 01/2018 219

TOTAL

RRESET BOOL A rising edge sends a reset command only when program/remote-
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 01/2018

TOTAL
Outputs

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 01/2018 221

TOTAL

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 01/2018

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
 Digital Pulses (BOOL)
AuxTotal = AuxTotal + [Rising edge (Digital input)]
 Counter (LONG)
AuxTotal = AuxTotal + (Current - Last)]
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 01/2018 223

TOTAL
Inputs/Outputs
Inputs/Outputs Parameter 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

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 01/2018

TOTAL

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.
 Higher value: 999999999.9999999
TOTAL_CFG_DDT Type

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 01/2018 225

TOTAL
Public Variables

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

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.
 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 01/2018

TOTAL

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 01/2018 227

TOTAL
228 EIO0000002093 01/2018

On/Off Device Control
EIO0000002093 01/2018
Part III
Overview
function blocks of the on/off device control family.
WARNING
LOSS OF CONTROL
regulations.
EIO0000002093 01/2018 229


23 DEVCTL - On-Off Device 231
24 DEVLP - Local Panel for Controlling On-Off Devices 245
25 DEVMNT - On-Off Device Maintenance 257
26 DUALOP - Dual Output 265
27 HVALVE - Manual Valve 273
28 MOTOR2 - 2-Speed/2-Rotation Direction Motor 281
29 MOTOR2LP - Local Panel for Controlling 2-Speed/2-Rotation Direction Motors 299
30 MVALVED - Discrete Motorized Valve 311
31 MVALVEDLP - Local Panel for Controlling Motorized On-Off Valves 321
230 EIO0000002093 01/2018

DEVCTL
EIO0000002093 01/2018
Chapter 23
DEVCTL - On-Off Device
DEVCTL - On-Off Device
Overview
This chapter describes the DEVCTL DFB.

Topic Page
Description 232
Inputs 235
Outputs 237
Inputs/Outputs 241
EIO0000002093 01/2018 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.
Likewise, you can supplement the DFB with the DEVMNT DFB from the General Purpose Library.
This allows the incorporation of totalizing functions for operating hours and switching operations.
Thus, the maintenance of the device is facilitated.
Control Controls the digital control signal of the element based on the configuration and the
commands that the DFB receives according to the functions.
Position detection Between 0 and 2 limit switches or digital detectors (configurable) that enables to
determine the actual position of the element to be controlled and monitored.
Local and remote Enables to control the DFB with a setpoint that is determined through a setpoint
setpoint selector (local or remote). The local set-point is assigned to the sequential control or
to the command received from the monitoring system. At the same time, the remote
setpoint is assigned to the DFB control from the logic implemented in the continuous
control.
Interlocking The DFB gives the device a command to move to the defined position if an active
interlock that requires this move is detected. An interlock bypass function is available.
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 setpoint for the desired position.
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.
232 EIO0000002093 01/2018

DEVCTL
The optional functions of the DFB are described in the following table:
Inoperable device A digital signal that enables to determine if the control DFB is not operational in
monitoring.
Commonly used for detecting whether or not the motor switch tripped due to thermal
overload.
Detection of not Detected error confirmation monitoring can be activated after a configurable time is
confirmed operation elapsed.
Manual resetting Allows you to configure the device to move to its position and reset manually after the
detection of an inoperable device condition or a not confirmed operation.
EIO0000002093 01/2018 233

DEVCTL
DFB Representation
Representation
234 EIO0000002093 01/2018

DEVCTL
Inputs

INITDFB BOOL 0 = Rising edge is produced on this input, the DFB internal timers are reset
and the signals are re-evaluated.
ZSH BOOL 1 = Indicates to the DFB whether or not the position corresponding to the set-
point (SP) with a value of 1 has been reached. Usually used to connect the
digital input of a positioner limit switch or the confirmation of a motor switch
operation.Refer the ZSHEN input.
ZSL BOOL 1 = Indicates to the DFB whether or not the position corresponding to the set-
point (SP) with a value of 0 has been reached. Usually 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
RSP BOOL 1 = Remote set-point is usually set by the continuous control.
ILCKSP BOOL 1 = Set-point needs to be used when the DFB is interlocked. Refer to the
ILCK input.
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.
EIO0000002093 01/2018 235

DEVCTL

TIMEOUT TIME Allows to configure the time (msec) during which confirmation alarm
monitoring is disabled to be configured. 0 disables confirmation alarm
monitoring. After the configured time has elapsed, the confirmation alarm is
generated (see page 241).
SCANTIME TIME Allows to configure the time (msec) that the detected alarm signals are kept
active to be configured. This helps to confirm that the monitoring subsystem
will acquire 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.
Allows avoiding the generation of erroneous detections of not confirmed
operation while the device is being controlled from outside of the system (for
example, from an electrical switch controlled by local push buttons that does
not reach the control system).
Monitoring of confirmation alarms is stopped during external control. The
FAIL input continues to be evaluated.
236 EIO0000002093 01/2018

DEVCTL
Outputs

OP BOOL 1 = Corresponds to the position determined by the set-point (SP) with a value of
1.Allows the control signal of the device to be connected.
Refer to the OP Calculation (see page 238).
SP BOOL 1 = Current device set-point.
Refer to the SP Calculation (see page 238).
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 241).
Refer the HIGHPOS and LOWPOS Calculation (see page 239).
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 241).
Refer to the HIGHPOS and LOWPOS Calculation (see page 239).
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 Calculation (see page 239).
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 ZSLPOS Calculation (see page 239).
ALARM BOOL 1 = The detection of a not confirmed operation has occurred. Refer the AAlarm
Behavior (see page 240) for monitoring details.
FAILD BOOL 1 = Indicates an inoperable device (1). 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 (msec).
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 240).
OOS BOOL 1 = Indicates the device is out of service.
EIO0000002093 01/2018 237

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
 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.
FAILEN input FAILREARMEN input OP output when FAIL = 1 OP output when FAIL = 1 (assume
(assume OP = 1 before the OP = 0 before the detected failure)
detected failure)
0 0 1 0
0 1 1 0
1 0 1 0
1 1 0 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
238 EIO0000002093 01/2018

DEVCTL
HIGHPOS and LOWPOS Calculation
ZSHEN ZSLEN SIMMD HIGHPOS is LOWPOS is calculated as:

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 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:

- - ON OP
OFF OFF OFF OP
OFF ON OFF not ZSL
ON OFF OFF ZSH
ON ON OFF ZSH
ZSLPOS Calculation
The signal evaluation depending on the ZSHLEN and ZSLEN inputs and the
DEVCTL_ST.CFGW.SIMMD input/output is shown in the following table:
ZSHEN ZSLEN SIMMD ZSHPOS is calculated as:

- - ON not OP
OFF OFF OFF not OP
OFF ON OFF ZSL
ON OFF OFF not ZSH
ON ON OFF ZSL
EIO0000002093 01/2018 239

DEVCTL
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 msec)
AAlarm 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 msec) 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 (msec). 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.
240 EIO0000002093 01/2018

DEVCTL
Inputs/Outputs

DEVCTL_ST DEVCTL_ST_DDT Data structure of the DFB status.
DEVCTL_ST_DDT Type

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 is contained in this bits word.
CFGW WORD Provides the means to control the device from the monitoring subsystem. Read-only
access to the data is contained in this bits word.
This table describes the DEVCTL_ST.STW word:

0 ZSHPOS Device status. Refer to the ZSHPOS output pin (see page 237).
1 ZSLPOS Device status. Refer to the ZSLPOS output pin (see page 237).
2 SP Device status. Refer to the SP output pin (see page 237).
3 OP Device status. Refer to the OP output pin (see page 237).
4 ALARM Device status. Refer to the ALARM output pin (see page 237).
5 FAILD Device status. Refer to the FAILD output pin (see page 237).
6 REM Device status. Indicates whether the current set-point (SP) is local (0) or remote (1).
The set-point is local when the owner is the Operator (OWNER = 1). If the owner is the
Program (OWNER = 0), the set-point is selected with the SC.REM public variable
(1: remote, 0: local).
7 ILCK Device status. Refer to ILCK input pin (see page 235).
EIO0000002093 01/2018 241

DEVCTL

8 REARMR Device status. Indicates if the device requires resetting (1) after the detection of an
inoperable device condition if it has been configured as requiring resetting through the
CONFREARMEN and/or FAILREARMEN inputs.
The signal activation logic included in the DFB is as follows.
9 EXTCTLD Device status. Read-only access. Refer to EXTCTLD input pin (see page 235).
DEVCTL_ST.CFGW Word Structure

0 OWNER Device commands. Read/write access.
Allows you to configure whether the setpoint is set by the program (0) or by the
operator (1).
1 ILCKBP Device commands. Read/write access.
Enables the interlock to be bypassed (1).
2 SIMMD Device commands. 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 Device commands. 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 Device commands. 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.
242 EIO0000002093 01/2018

DEVCTL
Public Variables

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

EXTCTLD BOOL Read-only access.
1 = Shows the value of the EXTCTLD input so that it can be used
from the sequential control.
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).
In any other case, the DFB 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
(Operator) the Operator)
OP BOOL 1 = Read-only access. Refer to the OP output pin (see page 237).
SP BOOL 1 = Read-only access. Refer to the SP output pin (see page 237)
HIGHPOS BOOL 1 = Read-only access. Refer to the HIGHPOS output pin
(see page 237).
LOWPOS BOOL 1 = Read-only access. Refer to the LOWPOS output pin
(see page 237).
ZSHPOS BOOL 1 = Read-only access. Refer to the ZSHPOS output pin
(see page 237).
EIO0000002093 01/2018 243

DEVCTL

ZSLPOS BOOL 1 = Read-only access. Refer to the ZSLPOS output pin
(see page 237).
ALARM BOOL 1 = Read-only access. Refer to the DEVCTL_ST.STW.ALARM
Input/output pin (see page 241).
FAILD BOOL 1 = Read-only access. Refer to the DEVCTL_ST.STW.FAILD
REARMR BOOL 1 = Read-only access. Refer to the DEVCTL_ST.STW.REARMR
ILCKD BOOL 1 = 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 1 = Read-only access. Refer to the DEVCTL_ST.CFGW.OWNER
OOS BOOL 1 = Read-only access. Refer to the DEVCTL_ST.CFGW.OOS
244 EIO0000002093 01/2018

DEVLP
EIO0000002093 01/2018
Chapter 24
DEVLP - Local Panel for Controlling On-Off Devices
DEVLP - Local Panel for Controlling On-Off Devices
Overview
This chapter describes DEVLP DFB.

Topic Page
Description 246
Inputs 248
Outputs 251
Inputs/Outputs 253
EIO0000002093 01/2018 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.
The main functions of the module are described in the following table:
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.
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.
Virtual Panel This signal enables the operator to select the Local / Control System mode of
for WSP.
246 EIO0000002093 01/2018

DEVLP
DFB Representation
Representation
EIO0000002093 01/2018 247

DEVLP
Inputs

table included with the description of the LPMode output pin
(see page 251).
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 251).
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 251).
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 251).
248 EIO0000002093 01/2018

DEVLP

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:
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.
General Purpose Library for WSP offer only, however there is no
impact of this input signal in PlantStruxure General Purpose Library for
Citect offer.
(see page 251).
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 PBSignalsE SC.Disable Push buttons
N LP 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.
EIO0000002093 01/2018 249

DEVLP

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 ToProgramE LockOwnerE Owner
N N
Zero mode - - Operator
System
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.
250 EIO0000002093 01/2018

DEVLP
Outputs

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).
nalsEN
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 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
EIO0000002093 01/2018 251

DEVLP

252 EIO0000002093 01/2018

DEVLP
Inputs/Outputs

DEVCTL_ST DEVCTL_ST_DDT Data structure corresponding to the on-off device is to be controlled
(see page 241) 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:

CFGW WORD Provides the means to control the device from the monitoring (HMI) system. Read-
only access to the data contained in this bits word.
DEVCTL_ST.CFGW Word
The following table describes the DEVCTL_ST.CFGW word:

0 OWNER Device commands. 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.
EIO0000002093 01/2018 253

DEVLP

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 LockSet- LSP is
DFB determines PointEN 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

DEVLP_ST_DDT Type

STW WORD Read-only access. Bits word with the local panel status.
254 EIO0000002093 01/2018

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:

0 LPMode Local panel in Local Panel mode. Refer to the LPMode 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
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
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.
11 OFFSignal Indicates the state of the OFFSignal input signal.
12 ONSignal Indicates the state of the ONSignal input signal.
EIO0000002093 01/2018 255

DEVLP
Public Variables

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

LPMode BOOL 1 = Read-only access. Refer to the LPMode output pin
(see page 251).
ZEROMode BOOL 1 = Read-only access. Refer to the ZEROMode output pin
(see page 251).
CSMode BOOL 1 = Read-only access. Refer to the CSMode output pin
(see page 251).
256 EIO0000002093 01/2018

DEVMNT
EIO0000002093 01/2018
Chapter 25
DEVMNT - On-Off Device Maintenance
DEVMNT - On-Off Device Maintenance
Overview
This chapter describes the DEVMNT DFB.

Topic Page
Description 258
Inputs 260
Outputs 261
Inputs/Outputs 262
EIO0000002093 01/2018 257

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.
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.
258 EIO0000002093 01/2018

DEVMNT
DFB Representation
Representation
EIO0000002093 01/2018 259

DEVMNT
Inputs

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

DEVMNT
Outputs

RHCNT UINT Totalizes the number of the device hours of 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 01/2018 261

DEVMNT
Inputs/Outputs

DEVMNT_ST DEVMNT_ST_DDT Data structure that is used as an interface with the
DEVMNT_ST_DDT Type

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

0 HOV Device maintenance status. Is activated when the hours counter exceeds the maximum
representable value (65535). Is deactivated through DEVMNT_ST.STW.RSTH.
1 MOV Device maintenance status. 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

0 RSTH Device maintenance status. 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 Device maintenance status. 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.
262 EIO0000002093 01/2018

DEVMNT
Public Variables

SC DEVMNT_SC_DDT Provides the frequently needed data to monitor the DFB
DEVMNT_SC_DDT Type

RHCNT UINT Read-only access. Refer to the DEVMNT_ST.RHCNT input/output
pin (see page 262).
MCNT UINT Read-only access. Refer to the DEVMNT_ST.MCNT input/output pin
(see page 262).
EIO0000002093 01/2018 263

DEVMNT
264 EIO0000002093 01/2018

DUALOP - Dual Output
EIO0000002093 01/2018
Chapter 26
Overview
This chapter describes the DUALOP DFB.

Topic Page
Decription 266
Inputs 268
Outputs 271
EIO0000002093 01/2018 265

Decription
General
The DUALOP DFB is used to manage start/stop or open/ close of the devices. The control function
DUALOP can be connected with DEVCTL (device control) to generate two outputs based on one
logical input.
Single input to dual output The DFB can generate two outputs based on one logical input.
Operating modes The DFB provides five operating modes that facilitate various application
requirements by using the device output and limit switches. The DFB outputs
can be continuous or pulse type depending on the mode selection.
266 EIO0000002093 01/2018

DFB Representation
Representation
EIO0000002093 01/2018 267

Inputs

OP BOOL OP is input signal to the DUALOP DFB. This input signal will be linked to the output signal OP from
the device management blocks.
ZSHPOS BOOL 1 = Indicates to the DFB that the position corresponding to OP with a value of 1 has been
reached.
ZSLPOS BOOL 1 = Indicates to the DFB that the position corresponding to OP with a value of 0 has been
reached.
268 EIO0000002093 01/2018


Mode INT This input is used to select the operating modes of the DUALOP DFB. Initialization is triggered
whenever there is a Mode change. 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.
Switch- TIME This input is used to set a delay between output switching. Default value will be 0 seconds. For
Delay 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.
EIO0000002093 01/2018 269


OPHPul- TIME This input is used to set the pulse time duration for which output OPH will be high, when the input
seTime signal (OP) is high. Once the pulse time duration elapses, the output OPH will go low and both
the outputs remain low.
OPLPul- TIME This input is used to set the pulse time duration for which output OPL will be high, when the input
seTime signal (OP) is low. Once the pulse time duration elapses, the output OPL will go low and both the
outputs remain low.
270 EIO0000002093 01/2018

Outputs
Outputs Parameter 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.
EIO0000002093 01/2018 271

272 EIO0000002093 01/2018

HVALVE
EIO0000002093 01/2018
Chapter 27
HVALVE - Manual Valve
HVALVE - Manual Valve
Overview
This chapter describes the HVALVE DFB.

Topic Page
Description 274
Inputs 276
Outputs 277
Inputs/Outputs 278
EIO0000002093 01/2018 273

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.
You 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.
Position Detection A total of 1 to 2 limit switches that enable to determine the actual
position of the valve are monitored.
Simulation The DFB enables you to simulate the position of the valve.
274 EIO0000002093 01/2018

HVALVE
DFB Representation
Representation
EIO0000002093 01/2018 275

HVALVE
Inputs

ZSH BOOL 1 = Indicates to the DFB that position 1 is reached. Normally used to connect the
digital input corresponding to the open-valve limit switch. If a variable or value is
not connected, the DFB disables it internally.
ZSL BOOL 1 = Indicates to the DFB that position 0 is reached. Normally used to connect the
digital input corresponding to the closed-valve limit switch. If a variable or value
is not connected, the DFB disables it internally.
276 EIO0000002093 01/2018

HVALVE
Outputs

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 calculated
as: 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 and not

ZSL ZSH
ZSHPOS BOOL 1 = Indicates the open-valve position has been reached based on
the detector connected on ZSH.
ZSLPOS BOOL 1 = Indicates the closed-valve 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 01/2018 277

HVALVE
Inputs/Outputs

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

CFGW WORD Provides the data needed to configure the DFB normally
from the monitoring subsystem.
HVALVE_ST.STW Word Structure

0 ZSHPOS Refer to the ZSHPOS output pin (see page 277).
1 ZSLPOS Refer to the ZSLPOS output pin (see page 277).
2 FAILD Refer to the FAILD output pin (see page 277).
HVALVE_ST.CFGW Word Structure

0 SIMMD DFB commands. 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 DFB commands. 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).
278 EIO0000002093 01/2018

HVALVE
Public Variables

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

HIGHPOS BOOL 1 = Read-only access. Refer to the HIGHPOS output pin
(see page 277).
LOWPOS BOOL 1 = Read-only access. Refer to the LOWPOS output pin
(see page 277).
ZSHPOS BOOL 1 = Read-only access. Refer to the ZSHPOS output pin
(see page 277).
ZSLPOS BOOL 1 = Read-only access. Refer to the ZSLPOS output pin
(see page 277).
FAILD BOOL 1 = Read-only access. Refer to the FAILD output pin
(see page 277).
EIO0000002093 01/2018 279

HVALVE
280 EIO0000002093 01/2018

MOTOR2
EIO0000002093 01/2018
Chapter 28
MOTOR2 - 2-Speed/2-Rotation Direction Motor
MOTOR2 - 2-Speed/2-Rotation Direction Motor
Overview
This chapter describes the MOTOR2 DFB.

Topic Page
Description 282
Inputs 285
Outputs 287
Inputs/Outputs 293
EIO0000002093 01/2018 281

MOTOR2
Description
General
The MOTOR2 DFB is used to control on-off motors with 2 rotation directions (forward/reverse) or
with 2 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.
Likewise, you can supplement this DFB with the DEVMNT DFB from the General Purpose Library.
This allows the incorporation of totalizing functions for hours of operation and number of switching
operations. Thus, the maintenance of the motor is facilitated.
Control Controls the digital control signal of the element based on the configuration and
commands that the DFB receives according to the functions.
Position detection Up to 2 running digital confirmation signals (configurable) that allow to determine the
actual statuses of the switching operation of the element to be controlled are
monitored.
Inoperable motor Up to 2 digital signals (configurable), which enables to determine whether or not the
control module has changed, are monitored.
Commonly used for detecting whether or not the switch of the motor switch has
tripped due to thermal overload.
Local and remote Enables the DFB to be controlled through setpoints (stop/run and speed/rotation
setpoint direction) that are determined through a selector (local or remote). The local set-
points are assigned to the sequential control or to the commands received from the
monitoring system while the remote setpoints are assigned to the DFB control from
the logic implemented in the continuous control.
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).
Interlocking The DFB gives the motor the command to move to the defined position if an active
interlock requiring this move is detected. An interlock bypass function is available.
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.
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.
282 EIO0000002093 01/2018

MOTOR2
Detection of not You can activate detected error confirmation monitoring after a
confirmed operation configurable time is passed.
Manual resetting Allows configuring the motor to move to its inactive position (de-
energized outputs) and to manually reset after the detection of an
inoperable device condition or a not confirmed operation.
EIO0000002093 01/2018 283

MOTOR2
DFB Representation
Representation
284 EIO0000002093 01/2018

MOTOR2
Inputs

INITDFB BOOL 0 = Default.
When a rising edge is produced on this input, the DFB internal timers are reset
and the signals are re-evaluated.
ZSH1 BOOL 1 = Indicates to the DFB if the switching operation corresponding to the
operation setpoint (SP = 1) is activated in the forward direction/speed 1 (SPSEL
= 0).
Used to connect the digital input of a motor switching operation confirmation.
1indicates that the position has been reached.
Refer to the ZSH1EN input.
ZSH2 BOOL 1 = Indicates to the DFB if the switching operation corresponding to the
operation setpoint (SP = 1) is activated in the reverse direction/speed 2 (SPSEL
= 1).
Used to connect the digital input of a motor switching operation confirmation.
1indicates that the position has been reached.
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 = It allows switching operation confirmation monitoring on ZSH1.
ZSH2EN BOOL 1 = It allows switching operation confirmation monitoring on ZSH2.
FAIL1EN BOOL 1 = Enables detected error monitoring on FAIL1.
FAIL2EN BOOL 1 = Enables detected error monitoring on FAIL2.
CONFREARMEN BOOL 1 = Makes manual resetting of the device mandatory after the detection of a not
confirmed operation on ZSH1 or ZSH2. The corresponding ZSH1EN or ZSH2EN
input needs to be set. Refer to the TIMEOUT input and the
MOTOR2ST.STW.ALARM input/output pin (see page 293).
FAILREARMEN BOOL 1 = Makes manual resetting of the device mandatory when FAIL1 or FAIL2 is
set (1). The corresponding FAIL1EN or FAIL2EN input needs to be set (1).
EIO0000002093 01/2018 285

MOTOR2

RSPSEL BOOL 0 = operation 1 will be affected (forward direction/speed 1).
1 = operation 2 will be affected (reverse direction/speed 2).
Enables to select the operation to be affected through the RSP setpoint when
the control owner (OWNER) is remote and program (MOTOR2ST.STW.REM and
MOTOR2ST.CFGW.OWNER inputs/outputs pin (see page 293).
The combination of RSPSEL and RSP will be evaluated on a level basis.
RSP BOOL 1= the actuator selected in RESPSEL will start.
0 = both actuators will stop (1 and 2).
Remote setpoint. Set by the continuous control.
ILCKSEL BOOL 0 = operation 1 will be affected (forward direction/speed 1).
1 = operation 2 will be affected (reverse direction/speed 2).
Enables to select the actuator to be affected through the ILCKSP setpoint when
the ILCK interlocking signal is activated.
The combination of ILCK, ILCKSEL and ILCKSP is evaluated by level and has
priority over any setpoints.
ILCKSP BOOL Set-point needs to be used when the DFB is interlocked.
1 = run. 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 you to configure the time (msec) 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 293).
SCANTIME TIME 1 = Enables you to configure the time (msec) 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.
286 EIO0000002093 01/2018

MOTOR2
Outputs
OP1, OP2, S1SELD, S2SELD Outputs

OP1 BOOL 1 = Allows the control signal 1 (forward direction/speed 1) of the motor to be
connected. Corresponds to the position determined by the setpoint (SP) with the
value 1 and SPSEL with a value of 0.
OP2 BOOL 1 = Allows the control signal 2 (reverse direction/speed 1) of the motor to be
connected. Corresponds to the position determined by the setpoint (SP) with the
value 1 and SPSEL with a value of 1.
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
 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.
personnel only.
EIO0000002093 01/2018 287

MOTOR2
FAILEN input FAILREARMEN input OPx output when FAIL = 1 OPx output when FAIL = 1
(assume OP = 1 before the (assume OP = 0 before the
detected failure) detected failure)
0 0 1 0
0 1 1 0
1 0 1 0
1 1 0 0
NOTE: x=1 or 2
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
and ILCKSP
ILCKSP
OFF OFF ON ON OFF/ON OFF/ON ON Not ILCKSEL
ILCKSEL and
and ILCKSP
ILCKSP
OFF OFF OFF ON OFF/ON OFF/ON - Not ILCKSEL
ILCKSEL and
and ILCKSP
ILCKSP
OFF ON - ON ON ON OFF OFF OFF
OFF - ON ON ON ON OFF OFF OFF

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 285)).
S2SELD BOOL 1 = Run command with forward direction/speed 2 selected and with the command
not blocked at the time of OP2 activation (refer to the S2LOCKED input pin
(see page 285)).
288 EIO0000002093 01/2018

MOTOR2
RUNNING1 and RUNNING2 Outputs

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 293).
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 293).
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

ZSH1POS BOOL 1 = The switching operation corresponding to the SP = 1 and SPSEL = 0 setpoints is
confirmed. It is independent of the other switching operation when the ZSH1 detector
is available. Refer to the truth table in the UNPOS output.
ZSH2POS BOOL 1 = The switching operation corresponding to the SP = 1 and SPSEL =1 setpoints
has been confirmed. It is independent of the other switching operation when the
ZSH2 detector is available. Refer to the truth table in the UNPOS output.
EIO0000002093 01/2018 289

MOTOR2
ALARM1 Output
This variable is a boolean.
Indicates if the detection of a not confirmed operation has occurred on device 1. Monitoring is done
on operation confirmation signals.
Based on the DFB configuration, it is activated when the control signal (OP1 output) is switched (0
to 1 or 1 to 0) as long as the timer preselection value is greater than 0 (TIMEOUT input in msec)
and the device is not being controlled externally (EXTCTLD to 1).
After the control signal is switched, the DFB internal timer is activated.
As long as the timer is running, the operation confirmations are not monitored. When the time has
elapses, any detection of not confirmed operation causes the alarm to be generated. The detected
alarm is also activated if the UNPOS signal is active after the TIMEOUT time has elapsed (msec).
The detected error signal is maintained for a minimum of SCANTIME (msec).
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).
ALARM2 Output
This variable is a boolean.
Indicates if the detection of a not confirmed operation has occurred on device 2. Monitoring is done
on operation confirmation signals.
Based on the DFB configuration, it is activated when the control signal (OP2 output) is switched (0
to 1 or 1 to 0) as long as the timer preselection value is greater than 0 (TIMEOUT input in msec)
and the device is not being controlled externally (EXTCTLD to 1).
After the control signal is switched, the DFB internal timer is activated. As long as the timer is
running, the operation confirmations are not monitored.
After the time has elapsed, any detection of not confirmed operation causes the alarm to be
generated. The alarm is also activated if the UNPOS signal is active after the TIMEOUT time has
elapsed (msec).
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
290 EIO0000002093 01/2018

MOTOR2
FAILD1 and FAILD2 Outputs

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 (msec).
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 (msec).
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
UNPOS Output

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
EIO0000002093 01/2018 291

MOTOR2
EXTCTLD ZSH1EN ZSH2EN SIMMD ZSH1POS ZSH2POS UNPOS

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

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.
292 EIO0000002093 01/2018

MOTOR2
Inputs/Outputs

MOTOR2_ST MOTOR2_ST_DDT Data structure of the DFB control and status.
MOTOR2_ST_DDT Type

CFGW WORD Provides the data necessary to configure the DFB usually from
MOTOR2_ST.STW Word
The following table describes the MOTOR2_ST.STW word:

0 ZSH1POS Motor status. Refer to the ZSH1POS output pin (see page 287).
1 ZSH2POS Motor status. Refer to the ZSH2POS output pin (see page 287).
2 UNPOS Motor status. Refer to the UNPOS output pin (see page 287).
4 OP1 Motor status. Refer to the OP1 output pin (see page 287).
5 OP2 Motor status. Refer to the OP2 output pin (see page 287).
6 REM Motor status. 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 Motor status. Refer to the ILCK input pin (see page 285).
8 REARMR Motor status. 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 Motor status. Valid read-only access. Refer to the EXTCTLD input pin
(see page 285).
10 ALARM1 DFB status. Refer to the ALARM1 output pin (see page 287).
11 ALARM2 DFB status. Refer to the ALARM2 output pin (see page 287).
EIO0000002093 01/2018 293

MOTOR2

12 FAILD1 Motor status. Indicates an inoperable device (1). Refer to the FAILD1
13 FAILD2 Motor status. Indicates an inoperable device (1). Refer to the FAILD2
14 S1LOCKED Motor status. Valid read-only access. Refer to the S1LOCKED input pin
(see page 285).
15 S2LOCKED Motor status. Valid read-only access. Refer to the S2LOCKED input pin
(see page 285).
Activation logic of REARMR signal
294 EIO0000002093 01/2018

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

0 OWNER Motor commands.
Read/write access.
Enables to configure whether the set-point is set by
0 Program
1 Operator
1 ILCKBP Motor commands.
Read/write access.
Enables the interlock to be bypassed (1).
2 SIMMD Motor commands.
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 Motor commands.
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.
4 LSPSEL Motor commands.
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 Motor commands.
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 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
EIO0000002093 01/2018 295

MOTOR2
Public Variables

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

EXTCTLD BOOL Read-only access.
1 = Shows the value of the EXTCTLD input so that you can modify it from the
sequential control.
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)
296 EIO0000002093 01/2018

MOTOR2

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).
In any other case, the DFB 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 1 = Read-only access. Refer to the OP1 output pin (see page 287).
OP2 BOOL 1 = Read-only access. Refer to the OP2 output pin (see page 287).
S1SELD BOOL 1 = Read-only access. Refer to the S1SELD output pin (see page 287).
S2SELD BOOL 1 = Read-only access. Refer to the S2SELD output pin (see page 287).
RUNNING1 BOOL 1 = Read-only access. Refer to the RUNNING1 output pin (see page 287).
RUNNING2 BOOL 1 = Read-only access. Refer to the RUNNING2 output pin (see page 287).
ZSH1POS BOOL 1 = Read-only access. Refer to the ZSH1POS output pin (see page 287).
ZSH2POS BOOL 1 = Read-only access. Refer to the ZSH2POS output pin (see page 287).
STOPPED BOOL 1 = Read-only access. Refer to the STOPPED output pin (see page 287).
UNPOS BOOL 1 = Read-only access. Refer to the UNPOS output pin (see page 287).
ALARM1 BOOL 1 = Read-only access. Refer to the MOTOR2_ST.STW.ALARM1 input/output
pin (see page 293).
ALARM2 BOOL 1 = Read-only access. Refer to the MOTOR2_ST.STW.ALARM2 input/output
pin (see page 293).
FAILD1 BOOL 1 = Read-only access. Refer to the MOTOR2_ST.STW.FAILD1 input/output
pin (see page 293).
FAILD2 BOOL 1 = Read-only access. Refer to the MOTOR2_ST.STW.FAILD2 input/output
pin (see page 293).
REARMR BOOL 1 = Read-only access. Refer to the MOTOR2_ST.STW.REARMR input/output
pin (see page 293).
EIO0000002093 01/2018 297

MOTOR2

ILCKD BOOL 1 = Valid 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 1 = Read-only access. Refer to the OWNER input/output pin (see page 293).
S1LOCKED BOOL 1 = Read-only access. Refer to the S1LOCKED input pin (see page 285).
S2LOCKED BOOL 1 = Read-only access. Refer to the S2LOCKED input pin (see page 285).
OOS BOOL Read/write access
1 = Indicates whether the equipment is Out of Service (1)
298 EIO0000002093 01/2018

MOTOR2LP
EIO0000002093 01/2018
Chapter 29
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.

Topic Page
Description 300
Inputs 302
Outputs 305
Inputs/Outputs 307
EIO0000002093 01/2018 299

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.
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
(Operator/Program) while the valve is controlled from the Local Panel.
analog output is controlled from the Local Panel.
for WSP.
300 EIO0000002093 01/2018

MOTOR2LP
DFB Representation
Representation
EIO0000002093 01/2018 301

MOTOR2LP
Inputs

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
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 305).
CSSignal BOOL 1 = The local panel mode switch is in the Control System position.
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.
302 EIO0000002093 01/2018

MOTOR2LP

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
PlantStruxure General Purpose Library for WSP offer only,
however there is no impact of this input signal in PlantStruxure
General Purpose Library for Citect offer.
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 PBSig- SC.Disa- Push buttons
nalsEN bleLP 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.
EIO0000002093 01/2018 303

MOTOR2LP

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.
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 ToProgram LockOwner Owner
EN EN
0 - - Operator
Switch to Local - - Operator
Panel
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.
304 EIO0000002093 01/2018

MOTOR2LP
Outputs

Signal 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).
The following table shows how the local panel operating mode is determined
based on the MODESignalsEN, VirtualLPEN, PBSignalsEN, LPSignal,
CSSignal and ZEROSignal, input signals:
nalsEN
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 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
EIO0000002093 01/2018 305

MOTOR2LP

306 EIO0000002093 01/2018

MOTOR2LP
Inputs/Outputs

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 281).
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

MOTOR2LP_ST.DDT Type

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

0 OWNER Valve commands. 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 Commands for 2-speed/2-rotation direction motor. 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.
EIO0000002093 01/2018 307

MOTOR2LP

5 LSP Commands for 2-speed/2-rotation direction motor. 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 OFFSig- DirectS Revers- Lock- LSP is LSPSEL is
MOTOR2LP nal 1Signal eS2Sig- Set- calculat- calculated
DFB nal PointE ed as: as:
determines N
the set-point
for the
2-speed/
2-rotation
direction
motor.
0 The OWNER - - - - OFF Last value
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 Last value
value
In other cases, the LSP and LSPSEL signals are not modified from the MOTOR2LP DFB.
MOTOR2LP_ST.CFGW Word

308 EIO0000002093 01/2018

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

3 LockedOwner Indicates whether the owner change buttons in the monitoring (HMI) system
needs to be locked (1) or not (0).
Is activated when:
 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
Is activated when:
 It is set to Local Panel and the LockSetpointEN input signal has been
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
7 VirtualLPEN Enables the drop-down list for the Local Panel / Control System mode
selection.
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.
EIO0000002093 01/2018 309

MOTOR2LP
Public Variables

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

(see page 305).
(see page 305).
(see page 305).
310 EIO0000002093 01/2018

MVALVED
EIO0000002093 01/2018
Chapter 30
MVALVED - Discrete Motorized Valve
MVALVED - Discrete Motorized Valve
Overview
This chapter describes the MVALVED DFB.

Topic Page
Description 312
Inputs 314
Outputs 316
Inputs/Outputs 317
EIO0000002093 01/2018 311

MVALVED
Description
General
The MVALVED DFB is designed to control a motorized valve, or a gate, with 2 limit switches (open-
valve and closed-valve) and a 2-rotation-directions-motor based control.
As a result, you can combine the MVALVED DFB with the following Unity Pro components from the
General Purpose Library:
 MOTOR2
 DINPUT
The main functions of the DFB are described in this table:
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.
Position A total of 0...2 limit switches or digital detectors (configurable) that allow to determine the
detection actual position of the element to be controlled are monitored.
Inoperable Optionally, one digital signal is monitored that allows determining if the control module has
device responded.
Detection of not Optionally, this monitoring function can be activated after a configurable time has elapsed.
confirmed
operation
Manual resetting Optionally, enables you to configure the device to move to its position and require manual
resetting if the device does not respond or when the monitoring function is activated.
Local and Enables the DFB to control the module through a setpoint that is determined with a
remote setpoint 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 module control from the logic implemented in the continuous control.
Interlocking The DFB gives the device the command to move to the defined position if an active
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.
312 EIO0000002093 01/2018

MVALVED
DFB Representation
Representation
EIO0000002093 01/2018 313

MVALVED
Inputs

INITDFB BOOL 1 = Normally resets to 0.
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 314) and TIMEOUT inputs pin
(see page 314).
FAILREARMEN BOOL  1 = Withdraws the output SP_MOTOR2 upon a detected failure condition
(FAILD = 1) and requires a mandatory manual resetting once the FAIL
 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 1 = The valve closing actuator is affected.
0 = The valve opening actuator is affected.
Enables to select the actuator to be affected through the RSP setpoint when
the control owner (OWNER) is REMOTE and PROGRAM (see
MVALVED_ST.STW.REM and MVALVED_ST.CFGW.OWNER).
The combination of RSPSEL and RSP is evaluated by level.
RSP BOOL Remote setpoint is set by the continuous control.
1 = The actuator selected in RSPSEL is started.
0 = Both actuators are stopped (1 and 2).
ILCKSEL BOOL 1 = The valve closing actuator is affected.
0 = The valve opening actuator is affected.
Enables to select the actuator to be affected through the ILCKSP setpoint
when the ILCK interlocking signal is activated. The combination of ILCK,
ILCKSEL, and ILCKSP is evaluated by level and has priority over any
setpoints.
ILCKSP BOOL 1 = Run
Setpoint needs to be used when the block is interlocked. Refer to the ILCK
input pin (see page 314).
ILCK BOOL 1 = Interlocks the valve at the defined position.
314 EIO0000002093 01/2018

MVALVED

REACTIONTIME TIME Enables to configure the time (msec) 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.
TIMEOUT TIME Enables to configure the maximum time (msec) that the valve takes to
complete its stroke, both for closing and opening. This parameter is used to
enable monitoring of the valve switching operations. After the time has
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 Enables to configure the time (msec) that the detected alarm signals are kept
active. Confirms that the Supervision system acquires the data for detected
alarms that are automatically reset.
MOTOR2_ST MOTOR2 Enables to find out the status of the device. Provides the current status,
_ST_DDT inoperable device conditions, detected alarms, lack of setpoint follow-up,
owner, and simulation of the motor that actuates the valve.
ZSH_DINPUT_ST DINPUT_ Enables to find out the status of the device. Provides the quality of the
ST_DDT channel and allows simulating the open-valve limit switch.
ZSL_DINPUT_ST DINPUT_ Enables to find out the status of the device. Provides the quality of the
ST_DDT channel and allows simulating the closed-valve limit switch.
EIO0000002093 01/2018 315

MVALVED
Outputs

SP_MOTOR2 BOOL 1 = Provides the remote setpoint for motor control (RSP). Read-only
access. Refer to the RSP (see page 285) input of MOTOR2 block.
RSPSEL_MOTOR2 BOOL 1 = Provides the setpoint for selecting the actuator to be affected by
the SP_MOTOR2 setpoint. Read-only access. Refer to the RSPSEL
input (see page 285) 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. Read-only access.
OPEN BOOL 1 = Indicates the maximum opening position is reached. It is calculated
based on the state obtained from 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 state obtained from the digital input belonging to the
closed-valve limit switch.
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
 The CONFREARMEN pin has to be set to 1 for the SP_MOTOR2 pin to become 0, under non-
personnel only.
316 EIO0000002093 01/2018

MVALVED
Inputs/Outputs

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

STW WORD Block status word. Valid read-only access.
CFGW WORD Block configuration word. Valid read/write access.
MVALVED_ST.STW Type

0 OPEN Block status. Refer to the OPEN output pin (see page 316).
1 CLOSED Block status. Refer to the CLOSED output pin (see page 316).
6 REM Block status. Refer to the SC.REM public variable
(see page 319).
7 ILCK Block status. Refer to the ILCK input pin (see page 314).
8 REARMR Block status. Reset required (1).
10 ALARM1 Block status. Refer to the ALARM1 output pin (see page 316).
11 ALARM2 Block status. Refer to the ALARM2 output pin (see page 316).
12 FAILD Block status. Refer to the FAILD output pin (see page 316).
EIO0000002093 01/2018 317

MVALVED
MVALVED_ST.CFGW Type

0 OWNER Block configuration. Read/write access. Configures whether the setpoint is set by
the program (0) or by the operator (1).
1 ILCKBP Block configuration. Read/write access. Allows the interlock to be bypassed (1).
3 REARM Valve commands, Write access. Resets 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 Valve commands. 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 Valve commands. 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.
318 EIO0000002093 01/2018

MVALVED
Public Variables

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

1 = Allows the block to be configured 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.
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).
In other case, the block continuously assigns the value of the current selection.
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).
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).
S1SELD BOOL 1 = Valid read-only access. Refer to the S1SELD output pin (see page 316).
S2SELD BOOL 1 = Valid read-only access. Refer to the S2SELD output pin (see page 316).
EIO0000002093 01/2018 319

MVALVED

OPEN BOOL 1 = Valid read-only access. Refer to the OPEN output pin (see page 316).
CLOSED BOOL 1 = Valid read-only access. Refer to the CLOSED output pin (see page 316).
ALARM1 BOOL 1 = Valid read-only access. Refer to the ALARM1 output pin (see page 316).
ALARM2 BOOL 1 = Valid read-only access. Refer to the ALARM2 output pin (see page 316).
FAILD BOOL 1 = Valid read-only access. Refer to the FAILD output pin (see page 316).
REARMR BOOL 1 = Valid read-only access.
ILCKD BOOL 1 = Valid 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 1 = Valid read-only access.
SP_MOTOR2 BOOL 1 = Valid read-only access. Refer to the SP_MOTOR2 output pin (see page 316).
SPSEL_MOTOR2 BOOL 1 = Valid read-only access. Refer to the SPSEL_MOTOR2 output pin
(see page 316).
ILCK_MOTOR2 BOOL 1 = Valid read-only access. Refer to the ILCK_MOTOR2 output pin
(see page 316).
320 EIO0000002093 01/2018

MVALVEDLP
EIO0000002093 01/2018
Chapter 31
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.

Topic Page
Description 322
Inputs 324
Outputs 327
Inputs/Outputs 329
EIO0000002093 01/2018 321

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.
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.
access to the drop-down list or not. It disables to change the set-point while the valve
is controlled from the Local Panel.
for WSP.
322 EIO0000002093 01/2018

MVALVEDLP
DFB Representation
Representation
EIO0000002093 01/2018 323

MVALVEDLP
Inputs

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 327).
(see page 327).
CSSignal BOOL 1 = The local panel mode switch is in the Control System position. Refer to the
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.
(see page 327).
NOTE: MODESignalsEN input pin has higher priority than the VirtualLPEN
input pin signal.
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 PlantStruxure General
Purpose Library for WSP offer only, however there is no impact of this input
signal in PlantStruxure General Purpose Library for Citect offer.
(see page 327).
324 EIO0000002093 01/2018

MVALVEDLP

PBSignalsEN BOOL 1 = Enables to accept the OFF, OPEN and CLOSE push buttons from the local
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
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.
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
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.
EIO0000002093 01/2018 325

MVALVEDLP

LockSetPoint- BOOL 1 = Disables the access to the setpoint of the motorized valve and lock it into
EN 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.
monitoring (HMI) system while the motorized valve is controlled from the local
panel.
326 EIO0000002093 01/2018

MVALVEDLP
Outputs

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).
The following table shows how the local panel operating mode is determined
based on the MODESignalsEN, VirtualLPEN, PBSignalsEN, LPSignal,
CSSignal and ZEROSignal, input signals:
MODE- Virtu- PBSig- LPSig- CSSig- ZEROSig- OUTPUT
Sig- alLPEN nalsEN nal nal nal
nalsE
N
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 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
EIO0000002093 01/2018 327

MVALVEDLP

328 EIO0000002093 01/2018

MVALVEDLP
Inputs/Outputs

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 311).
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

MVALVEDLP_ST.DDT Type

EIO0000002093 01/2018 329

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

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 Valve commands. 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 OFFSig- ONSignal LockSet- LPSEL is calculated as:
MVALVEDLP nal PointEN
DFB
determines
the set-point
command.
0 - (The - - - OFF
OWNER
signal is
forced to
1(Operator).
Local Panel Operator OFF OFF ON Last value
In other cases, the START signal is not modified from the MVALVELP DFB.
5 LSP -
MVALVEDLP_ST.CFGW Word

330 EIO0000002093 01/2018

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

pin.
output pin.
Is activated when:
Is activated when:
 It is set to Local Panel and the LockSetpointEN input
6 PBEnabled Indicates whether the push buttons of the local panel are
of the MODESignalsEN and PBSignalsEN signal inputs is
active.
mode selection.
EIO0000002093 01/2018 331

MVALVEDLP
Public Variables

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

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

Analog Device Control
EIO0000002093 01/2018
Part IV
Overview
function blocks of the analog device control family.
WARNING
LOSS OF CONTROL
regulations.
EIO0000002093 01/2018 333


32 CVALVE - Control Valve with Position Feedback 335
33 CVALVELP - Local Panel for Controlling Control Valves 347
34 MVALVE - Motorized Valve with Positioner 359
35 MVALVELP - Local Panel for Controlling Motorized Valves 371
36 SDDEVCTL - Device with Variable Speed Drive 383
37 SDDEVLP - Local Panel for Controlling Devices with a Variable-Speed Drive 399
334 EIO0000002093 01/2018

CVALVE
EIO0000002093 01/2018
Chapter 32
CVALVE - Control Valve with Position Feedback
CVALVE - Control Valve with Position Feedback
Overview
This chapter describes the CVALVE DFB.

Topic Page
Description 336
Inputs 338
Outputs 340
Inputs/Outputs 342
EIO0000002093 01/2018 335

CVALVE
Description
General
The main objective of the CVALVE DFB is to manage control valves with optional position feedback
(position and/or limit switches).
You 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.
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 enables you to assign 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 (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.
336 EIO0000002093 01/2018

CVALVE
DFB Representation
Representation
EIO0000002093 01/2018 337

CVALVE
Inputs
Input Description Table

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. Normally set by the continuous control, for example, by
means of a PID controller output.
ILCKSP REAL Valve position when the DFB is interlocked. Refer to the ILCK input.
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.
338 EIO0000002093 01/2018

CVALVE

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 (msec) 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
considered that the valve is completely closed.
EIO0000002093 01/2018 339

CVALVE
Outputs

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 based on the limit switch
connected to ZSHPOS. 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 based on the limit
switch connected to ZSLPOS. 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 338).
340 EIO0000002093 01/2018

CVALVE

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 01/2018 341

CVALVE
Inputs/Outputs

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

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
CVALVE_ST_DDT Type

CFGW WORD Provides the data needed to configure the DFB normally from the
CVALVE_ST.STW Word Structure

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

0 CHINFAILURE Refer to the CHINFAILURE input pin (see page 338).
1 ILCK Refer to the ILCK input pin (see page 338).
2 REM Refer to the SC.REM public variable (see page 344).
4 CHOUTFAILURE Refer to the CHOUTFAILURE input pin (see page 338).
6 PVOPEN Refer to the PVOPEN output pin (see page 340).
7 PVCLOSED Refer to the PVCLOSED output pin (see page 340).
9 FAIL Refer to the FAIL output pin (see page 340).
342 EIO0000002093 01/2018

CVALVE

10 ALARM Refer to the ALARM output pin (see page 340).
11 ZSLPOS Refer to the ZSLPOS output pin (see page 340).
12 ZSHPOS Refer to the ZSHPOS output pin (see page 340).
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:

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 01/2018 343

CVALVE
Public Variables

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

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.
PV BOOL 1 = Read-only access. Refer to the PV output pin (see page 340).
OWNER BOOL 1 = Read-only access. Refer to the CVALVE_ST.CFGW.OWNER
input/output pin (see page 342).
REM BOOL 1 = Read/write access. Allows the DFB to be configured for a remote
set-point - RSP-(1) or local set-point - LSP - (0).
ILCKD BOOL 1 = Valid read-only access. Indicates whether the motor is interlocked.
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 1 = Valid read-only access. Refer to the PVOPEN output pin
(see page 340).
PVCLOSED BOOL 1 = Valid read-only access. Refer to the PVCLOSED output pin
(see page 340).
FAILD BOOL 1 = Valid read-only access. Refer to the FAILD output pin
(see page 340).
ALARM BOOL 1 = Valid read-only access. Refer to the ALARM output pin
(see page 340).
344 EIO0000002093 01/2018

CVALVE

BADSTIN BOOL 1 = Valid read-only access. Refer to the CHINFAILURE input pin
(see page 338).
BADSTOUT BOOL 1 = Valid read-only access. Refer to the CHOUTFAILURE input pin
(see page 338).
ZSLPOS BOOL 1 = Valid read-only access. Refer to the ZSLPOS output pin
(see page 340).
ZSHPOS BOOL 1 = Valid read-only access. Refer to the ZSHPOS output pin
(see page 340).
EIO0000002093 01/2018 345

CVALVE
346 EIO0000002093 01/2018

CVALVELP
EIO0000002093 01/2018
Chapter 33
CVALVELP - Local Panel for Controlling Control Valves
CVALVELP - Local Panel for Controlling Control Valves
Overview
This chapter describes CVALVELP DFB.

Topic Page
Description 348
Inputs 350
Outputs 353
Inputs/Outputs 355
EIO0000002093 01/2018 347

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.
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.
for WSP.
348 EIO0000002093 01/2018

CVALVELP
DFB Representation
Representation
EIO0000002093 01/2018 349

CVALVELP
Inputs

(see page 353).
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 353).
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.
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
350 EIO0000002093 01/2018

CVALVELP

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:
operation.
General Purpose Library for WSP offer only, however there is no impact
of this input signal in PlantStruxure General Purpose Library for Citect
offer.
(see page 353).
PBSignalsEN BOOL 1 = Enables to accept the OPEN and CLOSE push buttons from the local
MODESignalsEN input). This means that the push button signals are
considered in the Local Panel mode.
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.DISABLE Push buttons
LP 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
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 01/2018 351

CVALVELP

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 LockOwnerE Owner
N
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.
monitoring (HMI) system while the valve is controlled from the local panel.
352 EIO0000002093 01/2018

CVALVELP
Outputs

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).
nalsEN
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 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
EIO0000002093 01/2018 353

CVALVELP

354 EIO0000002093 01/2018

CVALVELP
Inputs/Outputs

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 335)).
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 335).
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

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

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

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

0 OWNER Valve commands. Read/write access. Enables to configure whether the set-point is set
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

CVALVELP_ST.DDT Type

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

Is activated when:
 It is set to Local Panel, and the LockOwnerEN input signal has been
4 SPLocked Indicates whether the set-point change and START buttons in the monitoring
Is activated when:
 It is set to Local Panel, and the LockSetpointEN input signal has been
356 EIO0000002093 01/2018

CVALVELP

5 MODESignalsEN Indicates the state of the MODESignalsEN input signal, that is, whether there is
a mode switch (1) or not (0).
EIO0000002093 01/2018 357

CVALVELP
Public Variables

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

(see page 353).
(see page 353).
(see page 353).
1 = Disables the push buttons on the local panel. Only applicable
when a local panel without mode switch configuration is used
(MODESignalsEN = 0).
358 EIO0000002093 01/2018

MVALVE
EIO0000002093 01/2018
Chapter 34
MVALVE - Motorized Valve with Positioner
MVALVE - Motorized Valve with Positioner
Overview
This chapter describes the MVALVE DFB.

Topic Page
Description 360
Inputs 362
Outputs 365
Inputs/Outputs 367
EIO0000002093 01/2018 359

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.
As a result, combine the MVALVE DFB with the following Unity Pro components from the General
Purpose Library:
 AINPUT
 MOTOR2
 DINPUT
STEP3 The DFB includes and incorporates the functions provided by the STEP3 controller
from the standard CONT_CTL Unity 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 enables you to assign the defined position if an active interlock that requires
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.
360 EIO0000002093 01/2018

MVALVE
DFB Representation
Representation
EIO0000002093 01/2018 361

MVALVE
Inputs

When a rising edge occurs on this input, the internal timers of the DFB are
reset and alarms are set to 0.
RSP REAL Enables the remote speed set-point, which is usually set by the continuous
control. Acts in Program/Remote mode. Refer to the SC.REM public variable
(see page 369).
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
PARA.PV_INF parameter of the STEP3 controller.
362 EIO0000002093 01/2018

MVALVE

RSTART BOOL 1 = Enables the operation of the STEP3 block in automatic mode as described
in the Unity 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.
ILCKSP REAL Use the set-point when the DFB 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
FAILREARMEN BOOL  1 = Withdraws the output SP_MOTOR2 upon a detected failure condition
(FAILD = 1) and requires a mandatory manual resetting once the FAIL
 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 (msec) 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.
EIO0000002093 01/2018 363

MVALVE

TWATCH TIME Enables to configure the time (msec) 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 (msec) 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
considered that the valve is completely open.
LOTHRESHOLD REAL Enables to configure the closed-valve threshold for the analog position
considered that the valve is completely closed.
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.
364 EIO0000002093 01/2018

MVALVE
Outputs

SP_MOTOR2 BOOL 1 = Provides the remote set-point for motor control (RSP). Read-only access. Refer to
the RSPinput (see page 285) of the MOTOR2 block.
SPSEL_ BOOL 1 = Provides the set-point for selecting the actuator to be affected by the SP_MOTOR2
MOTOR2 set-point. Read-only access. Refer to the RSPSEL input (see page 285) 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
Unity 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.
EIO0000002093 01/2018 365

MVALVE

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 362)).
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
 The CONFREARMEN pin has to be set to 1 for the SP_MOTOR2 pin to become 0, under non-
personnel only.
366 EIO0000002093 01/2018

MVALVE
Inputs/Outputs

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

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 362) 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 362) 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).
TARGETSP REAL Valid read access. This variable indicates the current set-point status before
interlocking.
MVALVE_ST_DDT Type

STW WORD Block status word. Valid read-only access.
CFGW WORD Block configuration word. Valid read/write access.
PV REAL Valid read access. Refer to the PV input pin (see page 362). This variable indicates
the current measurement.
SP REAL Valid read/write access. Refer to the SP output pin (see page 365). 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.
EIO0000002093 01/2018 367

MVALVE
MVALVE_ST_STW Type

0 REM Block status. Refer to the SC.REM public variable (see page 369).
2 ILCK Block status. Refer to the ILCK input pin (see page 362).
3 SP_MOTOR2 Block status. Refer to the SP_MOTOR2 output pin (see page 365).
4 SPSEL_MOTOR2 Block status. Refer to the SPSEL_MOTOR2 output pin
(see page 365).
5 ILCK_MOTOR2 Block status. Refer to the ILCK_MOTOR2 output pin
(see page 365).
6 OPEN Block status. Refer to the OPEN output pin (see page 365).
7 CLOSED Block status. Refer to the CLOSED output pin (see page 365).
8 REARMR Block status. Reset required (1).
9 FAILD Block status. Refer to the FAILD output pin (see page 365).
10 ALARM Block status. Refer to the ALARM output pin (see page 365).
14 POSMISALARM Block status. Refer to the POSMISALARM output pin
(see page 365).
MVALVE_ST_CFGW Type

0 OWNER Block configuration. Read/write access. Configures whether the set-point is set by the
1 ILCKBP Block configuration. Read/write access. Allows the interlock to be bypassed (1).
2 START Block configuration. 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 362).
3 REARM Device commands. 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.
368 EIO0000002093 01/2018

MVALVE
Public Variables

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

LSP REAL Valid 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 Valid read access. This variable indicates the current set-point status before
interlocking.
PV REAL Valid read-only access. Refer to the PV input pin (see page 362).
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 362).
OWNER BOOL 1 = Valid read-only access
Refer to the MVALVE_ST.CFGW.OWNER input/output pin (see page 367).
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 1 = Valid 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:
OFF – OFF
ON OFF ON
ON ON OFF
OPEN BOOL 1 = Valid read-only access. Refer to the OPEN output pin (see page 365).
CLOSED BOOL 1 = Valid read-only access. Refer to the CLOSED output pin (see page 365).
REARMR BOOL Valid read-only access. Refer to the MVALVE_ST.STW.REARM input/output pin
(see page 367).
EIO0000002093 01/2018 369

MVALVE

FAILD BOOL 1 = Valid read-only access. Refer to the FAILD output pin (see page 365).
ALARM BOOL 1 = Valid read-only access. Refer to the ALARM output pin (see page 365).
POSMISALARM BOOL 1 = Valid read-only access. Refer to the POSMISALARM output pin
(see page 365).
370 EIO0000002093 01/2018

MVALVELP
EIO0000002093 01/2018
Chapter 35
MVALVELP - Local Panel for Controlling Motorized Valves
MVALVELP - Local Panel for Controlling Motorized Valves
Overview
This chapter describes the MVALVELP DFB.

Topic Page
Description 372
Inputs 374
Outputs 377
Inputs/Outputs 379
EIO0000002093 01/2018 371

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.
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.
for WSP.
372 EIO0000002093 01/2018

MVALVELP
DFB Representation
Representation
EIO0000002093 01/2018 373

MVALVELP
Inputs

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 377).
even if a mode switch is available on the local panel.When this signal is a
(see page 377).
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.
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
(see page 377).
input pin signal.
374 EIO0000002093 01/2018

MVALVELP

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.
(see page 377).
PBSignalsEN BOOL 1 = Enables to accept the OFF, OPEN and CLOSE push buttons from the local
MODESignalsEN input). This means that the push button signals are
considered when in Local Panel mode.
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
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 01/2018 375

MVALVELP

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:
Zero - - Operator
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.
LockSetPoint- BOOL 1 = Disables the setpoint of motorized valve and lock it into the one which is
EN 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.
monitoring (HMI) system while motorized valve is controlled from the local
panel.
376 EIO0000002093 01/2018

MVALVELP
Outputs

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).
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 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
EIO0000002093 01/2018 377

MVALVELP

378 EIO0000002093 01/2018

MVALVELP
Inputs/Outputs

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 359).
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

MVALVE_CFG.DDT Type

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

EIO0000002093 01/2018 379

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

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 Valve commands. 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 as:
DFB
determines
the set-point
for the
motorized
valve.
0 - (The - - - OFF
OWNER
signal is
forced to
1(Opera-
tor).
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

380 EIO0000002093 01/2018

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

pin.
output pin.
Is activated when:
Is activated when:
 It is set to Local Panel and the LockSetpointEN input
6 PBENABLED Indicates whether the push buttons of the local panel are
of the MODESignalsEN and PBSignalsEN signal inputs are
active.
mode selection.
12 ONSignal Indicates the state of the ONSignal input signal.
EIO0000002093 01/2018 381

MVALVELP
Public Variables

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

(see page 377).
(see page 377).
(see page 377).
382 EIO0000002093 01/2018

SDDEVCTL
EIO0000002093 01/2018
Chapter 36
SDDEVCTL - Device with Variable Speed Drive
SDDEVCTL - Device with Variable Speed Drive
Overview
This chapter describes the SDDEVCTL DFB.

Topic Page
Description 384
Inputs 387
Outputs 390
Inputs/Outputs 393
EIO0000002093 01/2018 383

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 managing associated devices from the sequential control, the continuous control,
and/or the Supervision system depending on their configuration and on the system needs.
Likewise, you can supplement this DFB with the DEVMNT DFB from the General Purpose Library.
This allows the incorporation of totalizing functions for operating hours and switching operations.
Thus, maintenance of the device is facilitated.
Control Forward/reverse rotation direction.
Multispeed Enables to select between speed configurable through an analog signal or between
3 preset speeds in the speed drive.
Position detection Up to 2 limit switches or digital detectors (configurable) that allow determining the
actual position of the element to be controlled are monitored.
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.
Interlocking The DFB gives the device the command to move to the defined position if an active
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.
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.
384 EIO0000002093 01/2018

SDDEVCTL
Inoperable device A digital signal that enables to determine if the control module that is in detected error
state is monitored.
Commonly used for detecting whether or not the motor switch has tripped due to
thermal overload.
Detection of not You can activate the detection of not confirmed operations after a configurable time
confirmed operation has elapsed.
Manual resetting Allows to configure the device to move to its position and reset manually when the
device does not respond or when the monitoring function is active.
EIO0000002093 01/2018 385

SDDEVCTL
DFB Representation
Representation
386 EIO0000002093 01/2018

SDDEVCTL
Inputs

When a rising edge occurs on this input, the internal timers of the DFB are
reset and the signals are re-evaluated.
During initialization, the outputs are updated in terms of the variables stored
in the data structures of the device.
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.
Used to connect the digital thermal trip input of a motor switch.
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
 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 393).
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
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.
EIO0000002093 01/2018 387

SDDEVCTL

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 of the signal
S2 other than 0) and reports the speed configured on the speed drive as Sx to
S3 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)
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.
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.
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).
388 EIO0000002093 01/2018

SDDEVCTL

TIMEOUT TIME Allows configuring the time (msec) 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 390) output and SDDEVCTL_ST.STW.ALARM input/output
pin (see page 393).
SCANTIME TIME Allows configuring the time (msec) 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 390).
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 01/2018 389

SDDEVCTL
Outputs

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

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.
390 EIO0000002093 01/2018

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

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.

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 (msec).
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
EIO0000002093 01/2018 391

SDDEVCTL
OP Calculation
WARNING
 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.
personnel only.
FAILEN input FAILREARMEN input OP output when OP output when FAIL = 1 (assume
FAIL = 1 (assume OP = OP = 0 before the detected failure)
1 before 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.
After this time has elapsed, the signal is recovered (0) based on the following conditions:
 f the position becomes correct (RUNNING output) according to the control status (FORWARD
and REVERSE outputs) or
 f the device is reset (through the SDDEVCTLST.CFGW.REARM input/output and as long as the
392 EIO0000002093 01/2018

SDDEVCTL
Inputs/Outputs

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

PV REAL Current speed of the output of the speed drive. Read-only access.
Refer to the PV input pin (see page 387).
SP REAL Current speed set-point. Refer to the SP output pin (see page 390).
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 390).
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 is contained in this bits word.
CFGW WORD Provides the means to control the device from the monitoring
subsystem. Read-only access to the data is contained in this bits
word.
SDDEVCTL_ST.STW Word Structure

0 RUNNING Device status. Refer to the RUNNING output pin (see page 390).
1 DIRECT Device status. Refer to the DIRECT output pin (see page 390).
2 REVERSE Device status. Refer to the REVERSE output pin (see page 390).
3 REVERSEEN Device status. Refer to the REVERSEEN input pin (see page 387).
4 ALARM Device status. Refer to the ALARM output pin (see page 390).
5 FAILD Device status. Indicates an inoperable device condition. Refer to the
FAILD output pin (see page 390).
EIO0000002093 01/2018 393

SDDEVCTL

6 REM Device status. 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 Device status. Refer to the ILCK input pin (see page 387).
8 REARMR Device status. 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 Device status. Valid read-only access. Refer to the EXTCTLD input
pin (see page 387).
10 SPSELD Device status. Valid read-only access. Refer to the SPSELD output
pin (see page 390). The current speed setpoint is set through
continuous set-point.
11 S1SELD Device status. Valid read-only access. Refer to the S1SELD.
14 SPEN Device status. Valid read-only access. Refer to the SPEN input pin
(see page 387).
15 POWERRMVL Device status. Valid read-only access. Refer to the POWERMVL input
pin (see page 387).
SDDEVCTL_ST.CFGW Word Structure

0 OWNER Device commands. Read/write access. Enables one to configure whether
the setpoint is set by the program (0) or by the operator (1).
1 ILCKBP Device commands. Read/write access. Allows the interlock to be
bypassed (1).
2 SIMMD Device commands. 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 Device commands. 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.
394 EIO0000002093 01/2018

SDDEVCTL

4 LSPREV Device commands. 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 Device commands. 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;
SDDEVCTL_CFG_DDT Type

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 387).
Reserved INT Reserved.
EIO0000002093 01/2018 395

SDDEVCTL
Public Variables

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

PV REAL Current value of the speed measurement. Comes from the speed drive or from
a measurement device (see page 393).
DIRECT BOOL 1 = Read-only access. Refer to the DIRECT output pin (see page 390).
REVERSE BOOL 1 = Read-only access. Refer to the REVERSE output pin (see page 390).
RUNNING BOOL 1 = Read-only access. Refer to the RUNNING output pin (see page 390).
ILCKD BOOL 1 = Read-only access. Indicates the motor is interlocked.
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 1 = Read-only access. Refer to the SDDEVCTL_ST.CFGW.OWNER input/output
pin (see page 393).
EXTCTLD BOOL 1 = Read-only access. Refer to the EXTCTLD input pin (see page 387).
SPSELD BOOL 1 = Read-only access. Refer to the SPSELD output pin (see page 390).
S1SELD BOOL 1 = Read-only access. Refer to the S1SELD, S2SELD, or S3SELD output pin
S2SELD (see page 390).
S3SELD
ALARM BOOL 1 = Read-only access. Refer to the SDDEVCTL_ST.STW.ALARM input/output
pin (see page 393).
POWERRMVL BOOL 1 = Read-only access. Refer to the POWERRMVL input pin (see page 387).
396 EIO0000002093 01/2018

SDDEVCTL

FAILD BOOL 1 = Read-only access. Refer to the SDDEVCTL_ST.STW.FAILD input/output
pin (see page 393).
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 390)).
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 01/2018 397

SDDEVCTL
398 EIO0000002093 01/2018

SDDEVLP
EIO0000002093 01/2018
Chapter 37
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.

Topic Page
Description 400
Inputs 402
Outputs 405
Inputs/Outputs 407
EIO0000002093 01/2018 399

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.
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.
(Operator/Program) while the speed driver-equipped motor is controlled from the
Local Panel.
speed driver-equipped motor is controlled from the Local Panel.
Enabling/Disabling/ operation from the HMI so that the push button signals are enabled for operation.
for WSP.
400 EIO0000002093 01/2018

SDDEVLP
DFB Representation
Representation
EIO0000002093 01/2018 401

SDDEVLP
Inputs

even if a mode switch is available on the local panel.When this signal is a
(see page 405).
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
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
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
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.
402 EIO0000002093 01/2018

SDDEVLP

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
(see page 405).
input pin signal.
operation.
NOTE:
operation.
(see page 405).
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
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
EIO0000002093 01/2018 403

SDDEVLP

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:
0 - - Operator
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.
LockSetPoint- BOOL 1 = Disables the setpoint of device and lock it into the one defined on the local
EN 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.
monitoring (HMI) system while speed-driver-equipped motor is controlled from
the local panel.
404 EIO0000002093 01/2018

SDDEVLP
Outputs

corresponding switch or because the buttons are enabled in the event that there
is no selector switch available or the VirtualLPEN is high with the local panel
mode enabled).
nalsEN
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 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
EIO0000002093 01/2018 405

SDDEVLP

406 EIO0000002093 01/2018

SDDEVLP
Inputs/Outputs

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 383).
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

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

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.
EIO0000002093 01/2018 407

SDDEVLP
SDDEVLP_ST.DDT Type

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

0 OWNER Commands for the speed-driver-equipped motor. 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 Device commands. 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.
408 EIO0000002093 01/2018

SDDEVLP

5 LSTART Device commands. 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 calcu- calculated
DFB nal PointEN lated as: as:
determines
the set-point
for the
speed-
driver-
equipped
motor.
0 - (The - - - - OFF Last value
OWNER
signal is
forced to
1(Opera-
tor).
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 Last value
value
In other cases, the LSTART signal is not modified from the SDDEVLP DFB.
SDDEVLP_ST.CFGW Word

EIO0000002093 01/2018 409

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

Is activated when:
 It is set to Local Panel and the LockOwnerEN input signal has been
4 SPLocked Indicates whether the set-point change and START buttons in the monitoring
Is activated when:
 It is set to Local Panel and the LockSetpointEN input signal has been
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.
410 EIO0000002093 01/2018

SDDEVLP
Public Variables

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

(see page 405).
(see page 405).
(see page 405).
1 = Disables the push buttons on the local panel. Only applicable
when a local panel without mode switch configuration is used
(MODESignalsEN = 0).
EIO0000002093 01/2018 411

SDDEVLP
412 EIO0000002093 01/2018

Process Control
EIO0000002093 01/2018
Part V
Process Control
Process Control
Overview
function blocks of the process control family.
WARNING
LOSS OF CONTROL
regulations.
EIO0000002093 01/2018 413

Process Control

38 ARAMP - RAMP 415
39 IMCTL - IMC Controller with Monitoring Interface 425
40 LDLGCTL - Lead-Lag Controller with Monitoring Interface 437
41 PIDCTL - PIDFF Regulator with Monitoring Interface 447
42 PIDMUX - Multiplexer for 2 Groups of PIDCTL Parameters 457
43 PWMCTL - Pulse-Width Modulated Controller 465
44 RATIOCTL - Ratio Controller 473
45 SPLRGCTL - Split-Range Controller 481
46 STEP3CTL - 3 Step Controller/Positioner 489
414 EIO0000002093 01/2018

ARAMP
EIO0000002093 01/2018
Chapter 38
ARAMP - RAMP
ARAMP - RAMP
Overview
This chapter describes the ARAMP DFB.

Topic Page
Description 416
Inputs 418
Outputs 419
Inputs/Outputs 421
EIO0000002093 01/2018 415

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.
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).
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).
416 EIO0000002093 01/2018

ARAMP
DFB Representation
Representation
EIO0000002093 01/2018 417

ARAMP
Inputs

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 419).
RTARGETSP REAL Target set-point in engineering units to be applied in the Program/Remote
mode. Refer to the SP output pin (see page 419).
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 421).
RSTART BOOL 1 = Run in the Program/Remote mode.
0 = Ramp Stop in the Program/Remote mode
418 EIO0000002093 01/2018

ARAMP
Outputs

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
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
EIO0000002093 01/2018 419

ARAMP
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.
420 EIO0000002093 01/2018

ARAMP
Inputs/Outputs

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:

CFGW WORD Provides the data necessary to configure the DFB from
SP REAL Current set-point generated by the DFB. Refer to the
SP output pin (see page 419).
The following table describes the ARAMP_ST.STW word:

1 HELD DFB status. Refer to the HELD output pin (see page 419).
2 DONE DFB status. Refer to the DONE output pin (see page 419).
3 RUNNING DFB status. Refer to the RUNNING output pin (see page 419).
The following table describes the ARAMP_ST.CFGW word:

0 OWNER DFB commands. Read/write access.
Enables to configure whether the set-point parameters of the ramp are set by the
1 LSTART DFB commands. 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 01/2018 421

ARAMP
ARAMP_CFG_DDT Type

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
INCRATE REAL Read/write access.
This variable indicates the rising slope that has been configured. You can modify
this variable from the monitoring subsystem.
DECRATE REAL Read/write access.
This variable indicates the falling slope that has been configured. You 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
422 EIO0000002093 01/2018

ARAMP
Public Variables

SC ARAMP_SC_DDT Provides the frequently needed data to monitor and control the DFB
ARAMP_SC_DDT Type

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.
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 1 = Read-only access. Refer to the ARAMP_ST.CFGW.OWNER
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 1 = Read-only access. Refer to the RUNNING output pin
(see page 419).
HELD BOOL 1 = Read-only access. Refer to the HELD output pin (see page 419).
DONE BOOL 1 = Read-only access. Refer to the DONE output pin (see page 419).
EIO0000002093 01/2018 423

ARAMP
424 EIO0000002093 01/2018

IMCTL
EIO0000002093 01/2018
Chapter 39
IMCTL - IMC Controller with Monitoring Interface
IMCTL - IMC Controller with Monitoring Interface
Overview
This chapter describes the IMCTL DFB.

Topic Page
Description 426
Inputs 428
Outputs 430
Inputs/Outputs 431
EIO0000002093 01/2018 425

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.
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
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.
426 EIO0000002093 01/2018

IMCTL
DFB Representation
Representation
EIO0000002093 01/2018 427

IMCTL
Inputs

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
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
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 434).
ILCKOP REAL Output needs to be used when the DFB is interlocked. Refer to the ILCK input.
428 EIO0000002093 01/2018

IMCTL

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 431)).
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 01/2018 429

IMCTL
Outputs

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
The set-point calculation that the DFB performs based on the signal status is detailed in the
following table:
OWNER (OFF: REM SP is calculated as:

Program; 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
430 EIO0000002093 01/2018

IMCTL
Inputs/Outputs

IMCTL_CFG IMCTL_CFG_DDT Provides the data needed to configure the DFB normally from the
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

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
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
EIO0000002093 01/2018 431

IMCTL

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
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_ST_DDT Type

PV REAL Read access. Refer to the PV input (see page 428).
This variable indicates the current measurement.
SP REAL Read/write access. Refer to the SP output (see page 430).
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.

3 OVRIDE DFB status. Enables to determine if the DFB is operating with external output (1 –
Override) or not (0 – Normal). Refer to the PARA.EN_RCPY input.
432 EIO0000002093 01/2018

IMCTL
IMCTL_ST.CFGW Word Structure

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

0 OWNER DFB configuration.
Read/write access. Enables to configure whether the set-point is set by the Program
(0) or the Operator (1).
1 ILCKBP DFB configuration.
Read/write access. Allows the interlock to be bypassed (1).
2 MODE DFB configuration.
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 DFB configuration.
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 01/2018 433

IMCTL
Public Variables

SC IMCTL_SC_DDT Provides the frequently needed data to monitor and control the controller
IMCTL_SC_DDT Type

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 428).
OWNER BOOL 1 = Read-only access. Refer to the IMCTL_ST.CFGW.OWNER
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 431).
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.
434 EIO0000002093 01/2018

IMCTL

ILCKD BOOL 1 = 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:
OFF - OFF
ON OFF ON
ON ON OFF
EIO0000002093 01/2018 435

IMCTL
436 EIO0000002093 01/2018

LDLGCTL
EIO0000002093 01/2018
Chapter 40
LDLGCTL - Lead-Lag Controller with Monitoring Interface
LDLGCTL - Lead-Lag Controller with Monitoring Interface
Overview
This chapter describes the LDLGCTL DFB.

Topic Page
Description 438
Inputs 440
Outputs 441
Inputs/Outputs 442
EIO0000002093 01/2018 437

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.
LEAD-LAG The DFB includes and incorporates functions provided by the LEAD-LAG controller
from the standard CONT_CTL Control library.
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).
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.
438 EIO0000002093 01/2018

LDLGCTL
DFB Representation
Representation
EIO0000002093 01/2018 439

LDLGCTL
Inputs

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
HIOP REAL Upper value of the output range. Used to limit the maximum value of the output
LOOP REAL Lower value of the output range. Used to limit the minimum value of the output
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 444).
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.
440 EIO0000002093 01/2018

LDLGCTL
Outputs

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:
Program; ON:
Operator)
OFF OFF SC.LSP
OFF ON RSP
ON - LDLGCTL_ST.SP
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 01/2018 441

LDLGCTL
Inputs/Outputs

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

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

SP REAL Read/write access. Refer to the SP output pin (see page 441).
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 441).
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.
LDLGCTL_ST.STW Word Structure

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

442 EIO0000002093 01/2018

LDLGCTL
LDLGCTL_ST.CFGW Word Structure

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

Read/write access. Enables to configure whether the set point is set by the Program
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 01/2018 443

LDLGCTL
Public Variables

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

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 1 = Valid read-only access. Refer to the LDLGCTL_ST.CFGW.OWNER
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.
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.
1 = Auto.
0 = Manual.
Refer to the LDLGCTL_ST.CFGW.MODE input/output pin
(see page 442).
1 = Allows the DFB to be configured for a remote set-point -RSP if the
0 = Allows the DFB to be configured for a local set-point -LSP if the
444 EIO0000002093 01/2018

LDLGCTL

input and the LDLGCTL_ST.STW.ILCKBP input/output is shown in the
following table:
OFF - OFF
ON OFF ON
ON ON OFF
EIO0000002093 01/2018 445

LDLGCTL
446 EIO0000002093 01/2018

PIDCTL
EIO0000002093 01/2018
Chapter 41
PIDCTL - PIDFF Regulator with Monitoring Interface
PIDCTL - PIDFF Regulator with Monitoring Interface
Overview
This chapter describes the PIDCTL DFB.

Topic Page
Description 448
Inputs 450
Outputs 451
Inputs/Outputs 452
EIO0000002093 01/2018 447

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.
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).
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).
Set-point The DFB enables to work under a remote (usually set from the continuous control)
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.
448 EIO0000002093 01/2018

PIDCTL
DFB Representation
Representation
EIO0000002093 01/2018 449

PIDCTL
Inputs

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.
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).
admitted by the controller. This input is internally connected to the PARA.PV_INF
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
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
RSP REAL Remote set-point. Usually set by the continuous control; for example, by a PID
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.
450 EIO0000002093 01/2018

PIDCTL
Outputs

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:

Program; 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 01/2018 451

PIDCTL
Inputs/Outputs

PIDCTL_CFG PIDCTL_CFG_DDT Provides the data necessary to configure the DFB from the
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

OPHILIM REAL Enables to define the maximum value of the output for the Automatic
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
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
452 EIO0000002093 01/2018

PIDCTL

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
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
PIDCTL_ST_DDT Type

PV REAL Read access. Refer to the PV input pin (see page 450).
This variable indicates what the current measurement is.
SP REAL Read/write access. Refer to the SP output pin (see page 451).
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
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
PIDCTL_ST.STW Word Structure

3 OVRIDE DFB status. Determines whether the DFB is operating with external output (1 –
Override) or not (0 – Normal). Refer to the PARA.EN_RCPY input.
EIO0000002093 01/2018 453

PIDCTL
PIDCTL_ST.CFGW Word Structure

Read/write access. Enables to configure whether the set-point is set by the Program (0)
or the Operator (1).
Read/write access. Enables the interlocking to be bypassed (1).
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 DFB configuration.
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 DFB configuration.
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 DFB configuration.
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.
454 EIO0000002093 01/2018

PIDCTL
Public Variables

SC PIDCTL_SC_DDT Provides the frequently needed data to monitor and control the regulator
PIDCTL_SC_DDT Type

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 450).
OWNER BOOL 1 = Valid read-only access. Refer to the PV input/output pin
(see page 452).
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.
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.
1 = Auto.
0 = Manual. Refer to the PIDCTL_ST.CFGW.MODE input/output pin
(see page 452).
EIO0000002093 01/2018 455

PIDCTL

0 = Allows the DFB to be configured for a local set-point -LSP, if the
input and the PIDCTL_ST.STW.ILCKBP input/output is shown in the
following table.

OFF - OFF
ON OFF ON
ON ON OFF
456 EIO0000002093 01/2018

PIDMUX
EIO0000002093 01/2018
Chapter 42
PIDMUX - Multiplexer for 2 Groups of PIDCTL Parameters
PIDMUX - Multiplexer for 2 Groups of PIDCTL Parameters
Overview
This chapter describes the PIDMUX DFB.

Topic Page
Description 458
Inputs 460
Outputs 461
Inputs/Outputs 462
EIO0000002093 01/2018 457

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.
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.
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).
458 EIO0000002093 01/2018

PIDMUX
DFB Representation
Representation
EIO0000002093 01/2018 459

PIDMUX
Inputs

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 464).
0 = Corresponds to select parameter configuration 1 (PIDMUX_CFG1)
1 = Corresponds to select parameter configuration 2 (PIDMUX_CFG2).
460 EIO0000002093 01/2018

PIDMUX
Outputs

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 01/2018 461

PIDMUX
Inputs/Outputs

PIDCTL_CFG PIDMUX_CFG_DDT The configuration data structure belonging to the PIDCTL module
(see page 462) 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 453) 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 462) for the associated PIDCTL module. This data can be accessed from
PIDMUX_ST PIDMUX_ST_DDT Provides the data needed to monitor and/or control the DFB status.
(see page 463)
PIDMUX_CFG_DDT Type

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.
462 EIO0000002093 01/2018

PIDMUX
PIDMUX_ST_DDT Type

PIDMUX_ST.STW Word Structure

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

PIDMUX_ST.CFGW Word Structure

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

0 OWNER DFB configuration. 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 01/2018 463

PIDMUX
Public Variables

SC PIDMUX_SC_DDT Provides the frequently needed data to monitor and
control the module status from the sequential control.
PIDMUX_SC_DDT Type

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 462). Valid read-only 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.
464 EIO0000002093 01/2018

PWMCTL
EIO0000002093 01/2018
Chapter 43
PWMCTL - Pulse-Width Modulated Controller
PWMCTL - Pulse-Width Modulated Controller
Overview
This chapter describes the PWMCTL DFB.

Topic Page
Description 466
Inputs 468
Outputs 469
Inputs/Outputs 470
EIO0000002093 01/2018 465

PWMCTL
Description
General
The PWMCTL DFB is used to condition the signals associated with pulse-width modulated (PWM)
control.
As a result, it is responsible for setting the set-point and activation for the controller.
point.
466 EIO0000002093 01/2018

PWMCTL
DFB Representation
Representation
EIO0000002093 01/2018 467

PWMCTL
Inputs

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
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.
468 EIO0000002093 01/2018

PWMCTL
Outputs

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:

Program; 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 01/2018 469

PWMCTL
Inputs/Outputs

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

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

SP REAL Read/write access. Refer to the SP output pin
(see page 469).
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
PWMCTL_ST.STW Word Structure

3 OPINC DFB status. Refer to the OPINC output pin (see page 469).
4 OPDEC DFB status. Refer to the OPDEC output pin (see page 469).
470 EIO0000002093 01/2018

PWMCTL
PWMCTL_ST.CFGW Word Structure

Read/write access. Enables to configure whether the set-point is set by the Program
2 START DFB configuration.
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 01/2018 471

PWMCTL
Public Variables

SC PWMCTL_SC_DDT Provides the frequently needed data to monitor and control the
PWMCTL_SC_DDT Type

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.
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 1 = Valid read-only access. Refer to the PWMCTL_ST.CFGW.OWNER
0 = Allows the DFB to be configured for local set-point -LSP, if the owner
is the Program and the mode is Auto.
input and the PWMCTL_ST.STW.ILCKBP input/output is shown in the
following table:
OFF - OFF
ON OFF ON
ON ON OFF
472 EIO0000002093 01/2018

RATIOCTL
EIO0000002093 01/2018
Chapter 44
RATIOCTL - Ratio Controller
RATIOCTL - Ratio Controller
Overview
This chapter describes the RATIOCTL DFB.

Topic Page
Description 474
Inputs 476
Outputs 477
Inputs/Outputs 478
EIO0000002093 01/2018 473

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.
Ratio The DFB includes and incorporates functions provided by the RATIO controller from the
standard CONT_CTL Control library.
result, it is responsible for setting the set-point and activation for the controller.
Interlocking The DFB enables to move to the defined position if an active interlock that requires this
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.
474 EIO0000002093 01/2018

RATIOCTL
DFB Representation
Representation
EIO0000002093 01/2018 475

RATIOCTL
Inputs

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 480).
476 EIO0000002093 01/2018

RATIOCTL
Outputs

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 01/2018 477

RATIOCTL
Inputs/Outputs

RATIOCTL_CFG RATIOCTL_CFG_DDT Provides the data needed to configure the DFB normally from
RATIOCTL_ST RATIOCTL_ST_DDT Provides the data needed to monitor and/or control the DFB
status.
RATIOCTL_CFG_DDT Type

BIAS REAL Enables to define the bias parameter for the RATIO controller.
Used for calculating the OP output.
KACT REAL Valid read-only access. Refer to the KACT output pin
(see page 477).
RATIOCTL_ST_DDT Type

STW WORD DFB status word. Valid read-only access.
CFGW WORD Read/write access. DFB configuration word.
PV_TRACK REAL Valid read-only access. Refer to the PV_TRACK input pin
(see page 476).
OP REAL Valid read-only access. Refer to the OP output pin
(see page 477).
LK REAL Read/write access. Enables to set the ratio when the owner is the
Operator (OWNER = 1).
RATIOCTL_ST.STW Word Structure

478 EIO0000002093 01/2018

RATIOCTL
RATIOCTL_ST.CFGW Word Structure

Read/write access. Enables to configure whether the ratio set-point is
set by the Program (0) or the Operator (1).
EIO0000002093 01/2018 479

RATIOCTL
Public Variables

SC RATIOCTL_SC_DDT Provides the frequently needed data to monitor and control the
RATIOCTL_SC_DDT Type

OP REAL Valid read-only access. Refer to the OP output pin (see page 477).
PV_TRACK REAL Valid read-only access. Refer to the PV_TRACK input pin
(see page 476).
OWNER BOOL 1 = Valid read-only access. Refer to the
RATIOCTL_ST.CFGW.OWNER input/output pin (see page 478).
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.
480 EIO0000002093 01/2018

SPLRGCTL
EIO0000002093 01/2018
Chapter 45
SPLRGCTL - Split-Range Controller
SPLRGCTL - Split-Range Controller
Overview
This chapter describes the SPLRGCTL DFB.

Topic Page
Description 482
Inputs 484
Outputs 485
Inputs/Outputs 486
EIO0000002093 01/2018 481

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.
SPLRG The DFB includes and incorporates functions provided by the SPLRG controller from
the standard CONT_CTL library.
As a result, it is responsible for setting the set-point and activation for the controller.
point.
482 EIO0000002093 01/2018

SPLRGCTL
DFB Representation
Representation
EIO0000002093 01/2018 483

SPLRGCTL
Inputs

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.
484 EIO0000002093 01/2018

SPLRGCTL
Outputs

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 01/2018 485

SPLRGCTL
Inputs/Outputs

SPLRGCTL_CFG SPLRGCTL_CFG_DDT Provides the data needed to configure the DFB normally from
SPLRGCTL_ST SPLRGCTL_ST_DDT Provides the data needed to monitor and/or control the DFB
status.
SPLRGCTL_CFG_DDT Type

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.
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.
specified in OUT2_INF is applied on the OP2 output.
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.
486 EIO0000002093 01/2018

SPLRGCTL
SPLRGCTL_ST_DDT Type

STW WORD Valid read-only access. DFB status 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 Valid read-only access. Refer to the OP1 output pin (see page 485).
OP2 REAL Valid read-only access. Refer to the OP2 output pin (see page 485).
SPLRGCTL_ST.STW Word Structure

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

0 REM Refer to the SC.REM public variable (see page 488).
2 ILCK Refer to the ILCK input pin (see page 484).
SPLRGCTL_ST.CFGW Word Structure

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

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 01/2018 487

SPLRGCTL
Public Variables

SC SPLRGCTL_SC_DDT Provides the frequently needed data to monitor and control the
SPLRGCTL_SC_DDT Type

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 485).
OWNER BOOL 1 = Valid read-only access. Refer to the SPLRGCTL_ST.CFGW.OWNER
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 1 = 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:
OFF - OFF
ON OFF ON
ON ON OFF
OP1 REAL Read-only access. Refer to the OP1 output pin (see page 485).
OP2 REAL Read-only access. Refer to the OP2 output pin (see page 485).
488 EIO0000002093 01/2018

STEP3CTL
EIO0000002093 01/2018
Chapter 46
STEP3CTL - 3 Step Controller/Positioner
STEP3CTL - 3 Step Controller/Positioner
Overview
This chapter describes the STEP3CTL DFB.

Topic Page
Description 490
Inputs 492
Outputs 494
Inputs/Outputs 495
EIO0000002093 01/2018 489

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.
STEP3 The DFB includes and incorporates functions provided by the STEP3 controller from the
standard CONT_CTL library.
result, it is responsible for setting the set-point and activation for the controller.
Interlocking The DFB enables to move to a defined set-point if an active interlocking that requires this
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.
490 EIO0000002093 01/2018

STEP3CTL
DFB Representation
Representation
EIO0000002093 01/2018 491

STEP3CTL
Inputs

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 498).
admitted by the controller. This input is internally connected to the PARA.PV_SUP
parameter of the STEP3 controller.
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 (Program) OFF SC.LSTART
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).
492 EIO0000002093 01/2018

STEP3CTL
STEP3 operating graph:
EIO0000002093 01/2018 493

STEP3CTL
Outputs

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 492)
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 492)
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
494 EIO0000002093 01/2018

STEP3CTL
Inputs/Outputs

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

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 492) 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 492) 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 Valid 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.
EIO0000002093 01/2018 495

STEP3CTL
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).
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

PV REAL Valid read access. Refer to the PV input pin (see page 492).
This variable indicates what the current measurement is.
SP REAL Valid read/write access. Refer to the SP output pin (see page 494).
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.
496 EIO0000002093 01/2018

STEP3CTL
STEP3CTL_ST.STW Word

3 OPINC DFB status. Refer to the OPINC output pin (see page 494).
4 OPDEC DFB status. Refer to the OPDEC output pin (see page 494).
STEP3CTL_ST.CFGW Word

Read/write access. Enables configuration whether the set-point is set
Read/write access. Enables the interlock to be bypassed (1).
2 START DFB configuration.
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 492).
EIO0000002093 01/2018 497

STEP3CTL
Public Variables

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:

LSP REAL Valid 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 Valid read access. This variable indicates what the current set-point
is before interlocking.
LSTART BOOL 1 = Read/write access. Refer to the RSTART input pin
(see page 492).
START command while the owner is the Program and Local;
otherwise, the valid START is copied to SC.LSTART.
OWNER BOOL 1 = Valid read-only access. Refer to the
STEP3CTL_ST.CFGW.OWNER input/output pin (see page 495).
ILCKD BOOL 1 = Valid 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
1 = Allows the DFB to be configured to remote set-point RSP, if the
0 = Allows the DFB to be configured to local set-point LSP, if the
498 EIO0000002093 01/2018

Sequential Control
EIO0000002093 01/2018
Part VI
Sequential Control
Sequential Control
Overview
function blocks of the sequential control family.
WARNING
LOSS OF CONTROL
regulations.
EIO0000002093 01/2018 499

Sequential Control

47 Sequential Control 501
48 SEQCTL1 - Advanced Sequential Control 509
49 Auxiliary Functions of Sequential Control 519
50 SEQPARxx - Sequence Parameter Management 537
51 SEQCTL1 - Example of Use 545
500 EIO0000002093 01/2018

Sequential Control
EIO0000002093 01/2018
Chapter 47
Sequential Control
Sequential Control
Overview
This chapter describes the sequential control management.

Topic Page
Description of Sequential Control 502
Definition of Status and Commands 504
Status Matrix 506
Status Controller 507
Operating Modes 508
EIO0000002093 01/2018 501

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).
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.
502 EIO0000002093 01/2018

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 546)).
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:
Processing States and The DFB processes the commands received and determines the status of
Commands 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 execution of the
Sequence 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 01/2018 503

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.
504 EIO0000002093 01/2018

Sequential Control

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.
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:

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 01/2018 505

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
Paused Stop Stopping Stopped
Resume Running
Holding Stop Stopping Stopped
Held Stop Stopping Stopped
Restart Restarting Running
Restarting Stop Stopping Stopped
Hold Holding Held
Stopping Abort Aborting Aborted
Stopped Reset Idle –
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.
506 EIO0000002093 01/2018

Sequential Control
Status Controller
Description
The following diagram describes the possible statuses and commands that the Unity Pro
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 01/2018 507

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.
508 EIO0000002093 01/2018

SEQCTL1
EIO0000002093 01/2018
Chapter 48
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.

Topic Page
Description 510
Inputs/Outputs 512
EIO0000002093 01/2018 509

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.
510 EIO0000002093 01/2018

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 01/2018 511

SEQCTL1
Inputs/Outputs

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

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 504).
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 504).
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 Sequence configuration 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).
512 EIO0000002093 01/2018

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:

0 OWNER Configuration. Read/write access. Enables to configure whether the sequence
commands will come from the program (0) or the operator (1).
1 SEMI Configuration. Read/write access. Enables to configure the sequence in automatic (0)
or semi-automatic (1) mode.
2 MANUAL Configuration. 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 Configuration. 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_ Read/write access. Enables to show the steps previous to the one being shown on the
UP current window in manual mode. The DFB sets the signal to 0 after it is processed.
6 SCROLL_ Read/write access. Enables to show the steps following the one being shown on the
DOWN current window in manual mode. The DFB sets the signal to 0 after it is processed.
EIO0000002093 01/2018 513

SEQCTL1
SEQCTL1_CFG_DDT Type

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.
514 EIO0000002093 01/2018

SEQCTL1
Public Variables

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

STATE UNIT Read-only access. Refer to the SEQCTL1_ST.STATE input/output
pin (see page 512).
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 1 = Read-only access (see page 512).
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
is processed.
HOLD BOOL Write access.
1 = Sends a hold sequence (Hold) command if the owner is the
is processed.
PAUSE BOOL Write access.
1 = Sends a pause sequence (Pause) command if the owner is the
is processed.
RESTART BOOL Write access.
1 = Sends a command to continue the sequence (Hold) if the owner
is the program (SC.OWNER is 0).
is processed.
EIO0000002093 01/2018 515

SEQCTL1

ABORT BOOL Write access.
1 = Sends a command to abort the sequence (Abort) if the owner is
the program (SC.OWNER is 0).
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).
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).
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.
is processed.
As an alternative, forcing the value of this variable to 1 by using the
SEQSTABLESTEP auxiliary DFB is recommended.
COMPLETED BOOL Write access.
1 = Sends a command to finish the current subsequence (Running,
Holding, Restarting, Stopping, and so on).
is processed.
As an alternative, forcing the value of this variable to 1 by using the
SEQTRANS auxiliary DFB is recommended.
516 EIO0000002093 01/2018

SEQCTL1

FAIL BOOL Write access.
1 = Sends a command to stop the sequence normal execution.
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 512) (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 1 = Read-only access (see page 512).
RUNNINGX BOOL Read-only access.
1 = Indicates that the current state of the sequence is Holding or
Holding for Detected Error.
HOLDINGX BOOL Read-only access.
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.
EIO0000002093 01/2018 517

SEQCTL1

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 507). The
Definition of Statuses and Commands (see page 504) 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.
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.
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.
518 EIO0000002093 01/2018

Auxiliary Functions
EIO0000002093 01/2018
Chapter 49
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.

Section Topic Page
49.1 SEQTRANS 520
49.2 SEQFAILED 525
49.3 SEQSTABLESTEP 528
49.4 SEQSTEPDESC 531
EIO0000002093 01/2018 519

Auxiliary Functions
Section 49.1
SEQTRANS
SEQTRANS
Overview
This section describes the SEQTRANS DFB.

Topic Page
Description 521
Inputs 523
Inputs/Outputs 524
520 EIO0000002093 01/2018

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 01/2018 521

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.
522 EIO0000002093 01/2018

Auxiliary Functions
Inputs

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 01/2018 523

Auxiliary Functions
Inputs/Outputs

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 509) for more details.
SEQCTL1_CFG SEQCTL1_CFG_DDT Provides the data necessary to communicate with the
524 EIO0000002093 01/2018

Auxiliary Functions
Section 49.2
SEQFAILED
SEQFAILED
Overview
This section describes the SEQFAILED DFB.

Topic Page
Description 526
Inputs/Outputs 527
EIO0000002093 01/2018 525

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).
(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.
526 EIO0000002093 01/2018

Auxiliary Functions
Inputs/Outputs

SEQCTL1_SC SEQCTL1_SC_DDT Provides the data necessary to communicate with the
EIO0000002093 01/2018 527

Auxiliary Functions
Section 49.3
SEQSTABLESTEP
SEQSTABLESTEP
Overview
The section describes the SEQSTABLESTEP DFB.

Topic Page
Description 529
Inputs/Outputs 530
528 EIO0000002093 01/2018

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 01/2018 529

Auxiliary Functions
Inputs/Outputs

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 509) for more details.
530 EIO0000002093 01/2018

Auxiliary Functions
Section 49.4
SEQSTEPDESC
SEQSTEPDESC
Overview
This section describes the SEQSTEPDESC DFB.

Topic Page
Description 532
Inputs 534
Inputs/Outputs 535
EIO0000002093 01/2018 531

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),
(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)
532 EIO0000002093 01/2018

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 01/2018 533

Auxiliary Functions
Inputs

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.
534 EIO0000002093 01/2018

Auxiliary Functions
Inputs/Outputs

SEQCTL1_SC SEQCTL1_SC_DDT Provides the data necessary to communicate with the
SEQCTL1 (see page 509) block for more details.
SEQCTL1_ST SEQCTL1_ST_DDT Provides the data necessary to communicate with the
SEQCTL1_CFG SEQCTL1_CFG_DDT Provides the data necessary to communicate with the
EIO0000002093 01/2018 535

Auxiliary Functions
Public Variables

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
536 EIO0000002093 01/2018

SEQPARxx
EIO0000002093 01/2018
Chapter 50
SEQPARxx - Sequence Parameter Management
SEQPARxx - Sequence Parameter Management
Overview
This chapter describes the SEQPARxx DFB.

Topic Page
Description 538
Inputs 540
Outputs 541
Inputs/Outputs 542
EIO0000002093 01/2018 537

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.
Input Parameter Optionally, the DFB initializes the values of the input parameters with a value (-0.0)
Consistency 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.
538 EIO0000002093 01/2018

SEQPARxx
DFB Representation
Representation
EIO0000002093 01/2018 539

SEQPARxx
Inputs

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 541).
If no data is connected to this input, the consistency check for
input parameter is disabled.
Bit SP is calculated as:
0 (2 )0 Input parameter 1 is applicable (1) or not (0).
1 (21) Input parameter 2 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 541)).
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).
540 EIO0000002093 01/2018

SEQPARxx
Outputs

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 01/2018 541

SEQPARxx
Inputs/Outputs

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

CFGW WORD Provides the data needed to configure the DFB normally from the monitoring
subsystem.
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.
542 EIO0000002093 01/2018

SEQPARxx

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:

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 541).
SEQPARxx_ST.CFGW Word Structure

following table describes the SEQPARxx_ST.CFGW Word structure:

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 01/2018 543

SEQPARxx
Public Variables

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

IPERROR BOOL 1 = Read-only access. Refer to the IPERROR output pin (see page 541).
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
 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.
... ...
OP01 REAL Read/write access. Output parameter 1.
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.
544 EIO0000002093 01/2018

SEQCTL1 - Example of Use
EIO0000002093 01/2018
Chapter 51
Overview
This chapter describes the example use of the SEQCTL1DFB.

Topic Page
Description 546
Reusable Sequence Logic 548
EIO0000002093 01/2018 545

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).
546 EIO0000002093 01/2018

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 01/2018 547

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 (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);
NOTE: Definition of the descriptions for the subsequence steps.
case SSC.CSTEP of
NOTE: First step with a value of 1. The allowed values for steps are 1 to 999.
if IC_FAIL then
FalloCI := true;
FAILED (SSC); (Initial conditions not satisfied)
548 EIO0000002093 01/2018

NOTE: Report detected failure to trigger the holding subsequence.

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.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)
EIO0000002093 01/2018 549

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 (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);
if SSC.ONENTRY then
FIC_AGUA.MAN:=true;
FIC_AGUA.LOP:=0.0;
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;
550 EIO0000002093 01/2018

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.
end_case;
(Actions common to several steps)
if SSC.CSTEP > 0 and FC then
FAILED (SSC); (Trigger execution of the Hold sequence)
end_if;
(Holding Subsequence (316/326))
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
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)
EIO0000002093 01/2018 551

end_case;
(Restarting subsequence(318))
case SSC.CSTEP of
1: (Initial Step)
TRANS (true, 'True', -1, SSC, SST, SCFG); (End of sequence)
end_case;
(Aborting subsequence(310))
case SSC.CSTEP of
1: (Initial Step)
FIC_AGUA.MAN:=true;
dosif_agua:=false;
TRANS (true, 'True', -1, SSC, SST, SCFG); (End of sequence)
end_case;
(Stopping subsequence(312))
Steps and Transitions)
case SSC.CSTEP of
1: (Initial Step)
FIC_AGUA.MAN:=true;
552 EIO0000002093 01/2018

TRANS (true, 'True', SSC.CSTEP+1, SSC, SST, SCFG); (Next step)

2:
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;
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 01/2018 553

554 EIO0000002093 01/2018

Batch Phase Manager
EIO0000002093 01/2018
Part VII
Batch Phase Manager
Batch Phase Manager
Overview
function blocks of the Batch phase manager.
WARNING
LOSS OF CONTROL
regulations.
EIO0000002093 01/2018 555

Batch Phase Manager

52 Batch Phase Manager 557
53 IBPHASE - Individual Batch Phase Manager 567
54 Auxiliary Functions of Batch Phase 585
55 IBPARxx - Batch Phase Parameter Management 603
56 USERPHASExx - User Defined Process Logic 611
57 IBPHASE - Example of Use 615
556 EIO0000002093 01/2018

Batch Phase Manager
EIO0000002093 01/2018
Chapter 52
Batch Phase Manager
Batch Phase Manager
Overview
This chapter describes the Batch phase management.

Topic Page
Description of Batch Phase Manager 558
Definition of Phase Statuses, Batch Phase Statuses, Phase Commands and Batch Phase 560
Commands
Status Matrix 563
Status Controller 564
Operating Modes 565
EIO0000002093 01/2018 557

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.
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 change from one x
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 function block x
Automatic management of phase steady-step marking through the IBSTABLESTEP function x
block
Possibility of displaying the phase graphically (active step and next level of transitions and x
steps) from the monitoring subsystem
NOTE: ‘x’ indicates that the functions are available in the DFB.
558 EIO0000002093 01/2018

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:
Processing States and The DFB processes the commands received and determines the status of the
Commands 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 execution of the
Phase 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 user
Failures 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 01/2018 559

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.
560 EIO0000002093 01/2018

Batch Phase Manager
The DFB has the necessary means to be able to restart the Running phase from the last steady
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 01/2018 561

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).
562 EIO0000002093 01/2018

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
Complete Reset Idle –
Pausing Stop Stopping Stopped
Hold Holding Held
Paused Stop Stopping Stopped
Resume - Running
Hold Holding Held
Holding Stop Stopping Stopped
Held Stop Stopping Stopped
Restart Restarting Running
Restarting Stop Stopping Stopped
Hold Holding Held
Stopping Abort Aborting Aborted
Stopped Reset Idle –
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
EIO0000002093 01/2018 563

Batch Phase Manager
Status Controller
Description
The following diagram describes the possible phases statuses and phase commands that the Unity
Pro 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.
564 EIO0000002093 01/2018

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 01/2018 565

Batch Phase Manager
566 EIO0000002093 01/2018

IBPHASE - Individual Batch Phase Manager
EIO0000002093 01/2018
Chapter 53
Overview
This chapter provides a detailed description of the functions, pins, pin layout, and variables of the
IBPHASE DFB.

Topic Page
Description 568
Inputs 570
Inputs/Outputs 571
EIO0000002093 01/2018 567

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.
568 EIO0000002093 01/2018

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 01/2018 569

Inputs

AUTORESETDIS BOOL Disabling the automatic reset of the phase state, when Owner is
Operator.
570 EIO0000002093 01/2018

Inputs/Outputs

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 Type Description

Number
(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
operation to Idle.
IBINTERLOCKED 15 Operation cannot start from InBatch tool
as initial conditions are not met. or
Owner is Operator.
EIO0000002093 01/2018 571


Number
(if any)
IBCOMMAN - UINT Enables commands to be sent to the
D 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
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
operation to idle
COMPLETE 7 Normal operation has finished.
Requires an initialization order (Reset)
to return to the Idle status.
572 EIO0000002093 01/2018


Number
(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 01/2018 573


Number
(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
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
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).
574 EIO0000002093 01/2018


Number
(if any)
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
EIO0000002093 01/2018 575


Number
(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).
576 EIO0000002093 01/2018

IBPHASE_CFG_DDT Type

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.
EIO0000002093 01/2018 577

Public Variables

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 Bit Number Type Description

(if any) (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.
578 EIO0000002093 01/2018


(if any) (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.
EIO0000002093 01/2018 579


(if any) (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
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.
DFB after the signal is processed.
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.
580 EIO0000002093 01/2018


(if any) (if any)
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 571).
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 Destinations steps after transitions.
[1...6]
of INT
DESTW - WORD Transitions Conditions word.
PROPERTIES - WORD Collective word of necessary boolean variables.
OWNER 0 Configuration. Read only access. Enables to
configure whether the commands will come from
the InBatch (0) or the operator (1).
EIO0000002093 01/2018 581


(if any) (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.
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
BUTTON1 14 User configurable control button in InBatch.
BUTTON2 15 User configurable control button in InBatch.
582 EIO0000002093 01/2018

EIO0000002093 01/2018 583

584 EIO0000002093 01/2018

Auxiliary Functions of Batch Phase
EIO0000002093 01/2018
Chapter 54
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.

Section Topic Page
54.1 IBTRANS 586
54.2 IBFAILED 591
54.3 IBSTABLESTEP 594
54.4 IBSTEPDESC 597
EIO0000002093 01/2018 585

Section 54.1
IBTRANS
IBTRANS
Overview
This section describes the IBTRANS DFB.

Topic Page
Description 587
Inputs 589
Inputs/Outputs 590
586 EIO0000002093 01/2018

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*))
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 01/2018 587

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
588 EIO0000002093 01/2018

Inputs

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 01/2018 589

Inputs/Outputs

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 567) for more details.
IBPHASE_CFG IBPHASE_CFG_DDT Provides the data necessary to communicate with the
590 EIO0000002093 01/2018

Section 54.2
IBFAILED
IBFAILED
Overview
This section describes the IBFAILED DFB.

Topic Page
Description 592
Inputs/Outputs 593
EIO0000002093 01/2018 591

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).
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.
592 EIO0000002093 01/2018

Inputs/Outputs

IBPHASE_SC IBPHASE_SC_DDT Provides the data necessary to communicate with the
EIO0000002093 01/2018 593

Section 54.3
IBSTABLESTEP
IBSTABLESTEP
Overview
The section describes the IBSTABLESTEP DFB.

Topic Page
Description 595
Inputs/Outputs 596
594 EIO0000002093 01/2018

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.
FIC_AGUA.MAN:=true;
FIC_AGUA.LOP:=0.0;
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 01/2018 595

Inputs/Outputs

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 567) for more details.
596 EIO0000002093 01/2018

Section 54.4
IBSTEPDESC
IBSTEPDESC
Overview
This section describes the IBSTEPDESC DFB.

Topic Page
Description 598
Inputs 600
Inputs/Outputs 601
EIO0000002093 01/2018 597

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),
(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);
case IBSC.CSTEP of
if IC_FAIL then
FalloCI := true;
FAILED (IBSC); (Initial conditions not satisfied)
598 EIO0000002093 01/2018

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
 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
EIO0000002093 01/2018 599

Inputs

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.
600 EIO0000002093 01/2018

Inputs/Outputs

IBPHASE_SC IBPHASE_SC_DDT Provides the data necessary to communicate with the
IBPHASE (see page 567) block for more details.
EIO0000002093 01/2018 601

Public Variables

ORDERNUMBER INT Read-only public variable reserved for building the list of steps in manual
MAXORDERNUMBER INT Read-only public variable reserved for building the list of steps in manual
602 EIO0000002093 01/2018

IBPARxx - Batch Phase Parameter Management
EIO0000002093 01/2018
Chapter 55
Overview
This chapter describes the IBPARxx DFB.

Topic Page
Description 604
Inputs 606
Outputs 607
Inputs/Outputs 608
EIO0000002093 01/2018 603

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.
Input Parameter Optionally, the DFB initializes the values of the input parameters with a value (-0.0)
Consistency 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.
604 EIO0000002093 01/2018

DFB Representation
Representation
EIO0000002093 01/2018 605

Inputs

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 541).
If no data is connected to this input, the consistency check for
input parameter is disabled.
Bit SP is calculated as:
0 (2 )0 Input parameter 1 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 607)).
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).
606 EIO0000002093 01/2018

Outputs

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 01/2018 607

Inputs/Outputs

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

CFGW WORD Provides the data needed to configure the DFB normally from the monitoring
subsystem.
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
 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.
... ...
OP01 REAL Read-only access. Output parameter 1.
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.
608 EIO0000002093 01/2018

IBPARxx_ST.STW Word Structure

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

1 ERRDWLDIPPAR Detected error downloading input parameter.
EIO0000002093 01/2018 609

Public Variables

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

IPERROR BOOL 1 = Read-only access. Refer to the IPERROR output pin (see page 607).
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
 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.
... ...
OP01 REAL Read/write access. Output parameter 1.
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.
610 EIO0000002093 01/2018

USERPHASExx - User Defined Process Logic
EIO0000002093 01/2018
Chapter 56
Overview
This chapter describes the USERPHASExx DFB.

Topic Page
Description 612
Inputs 613
Inputs/Outputs 614
EIO0000002093 01/2018 611

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.
612 EIO0000002093 01/2018

Inputs

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 01/2018 613

Inputs/Outputs

IBPHASE_SC IBPHASE_SC_DDT Corresponds to the SC public variable of the IBPHASE block
instance that is controlling the phase execution.
614 EIO0000002093 01/2018

IBPHASE - Example of Use
EIO0000002093 01/2018
Chapter 57
Overview
This chapter describes the example use of the IBPHASE DFB.

Topic Page
Description 616
Reusable Phase Logic 618
EIO0000002093 01/2018 615

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).
616 EIO0000002093 01/2018

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 01/2018 617

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 (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);
NOTE: Definition of the descriptions for the subphase steps.
case IBSC.CSTEP of
NOTE: First step with a value of 1.
if INITCONDFAIL then
FaultCI := true;
FAILED (IBSC); (Initial conditions not satisfied)
618 EIO0000002093 01/2018

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)
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 01/2018 619

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 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);
if PARAM05.IP01 = 2.0 then
WATER_RAMP.LSTART:=false;
WATER_FIC.REM:=false;
WATER_FIC.LOP:=0.0;
else
WATER_FCV.LSP:=0.0;
end_if;
WATER_VALVE.LSP:=false;
end_if;
620 EIO0000002093 01/2018

TRANS (WATER_VALVE.LOWPOS, 'Valve Closed?', IBSC.CSTEP + 1, IBSC, IBST,

IBCFG);
6: (Wait for Water queue)
(Wait for COLA_AGUA (Water queue) to fall)
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)
if IBSC.CSTEP > 0 and FAILCOND then
FAILED (IBSC); (* It causes Hold phase execution *)
end_if;
(Holding Subphase)
STEPDESC (2, 'Closing Valves', IBSC, IBST, IBCFG);
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:
WATER_VALVE.LSP:= false;
EIO0000002093 01/2018 621

WATER_FIC.LOP:=0.0; (To close regulating valve)

end_if;
If (Dosing_water) AND IBSC.ETIME >= 50 then
end_if;
TRANS (IBSC.ETIME >= 50 OR NOT Dosing_water, 'Waiting for queue', -1,
IBSC, IBST, IBCFG); (End of phase)
end_case;
(Restarting subphase)
case IBSC.CSTEP of
1: (Initial Step)
TRANS (TRUE, 'True', -1, IBSC, IBST, IBCFG); (End of phase)
end_case;
(Aborting subphase)
case IBSC.CSTEP of
1: (Initial Step)
WATER_VALVE.LSP:=false;
WATER_FIC.LOP:=0.0; (Close control valve)
TRANS (TRUE, 'True', -1, IBSC, IBST, IBCFG); (End of phase)
end_case;
(Stopping subphase)
622 EIO0000002093 01/2018


case IBSC.CSTEP of
1: (Initial Step)
WATER_VALVE.LSP:= false;
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
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 01/2018 623

624 EIO0000002093 01/2018

Auxiliary Functions
EIO0000002093 01/2018
Part VIII
Auxiliary Functions
Auxiliary Functions
Overview
function blocks of the auxiliary functions family.
Auxiliary function blocks can be used in conjunction with other DFBs to provide additional services
and data.
WARNING
LOSS OF CONTROL
regulations.
1 For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
EIO0000002093 01/2018 625

Auxiliary Functions

58 ASELECT - Analog Signal Selector 627
59 ASELECT1 - Selector for Analog Signals with Monitoring Variables 633
60 CONDSUM - Summary of Conditions 641
61 CONDSUM1 - Interlock Condition Summary 649
62 MSGBOX - Messages to the Operator 657
626 EIO0000002093 01/2018

ASELECT
EIO0000002093 01/2018
Chapter 58
ASELECT - Analog Signal Selector
ASELECT - Analog Signal Selector
Overview
This chapter describes the ASELECT DFB.

Topic Page
Description 628
Inputs 630
Outputs 631
EIO0000002093 01/2018 627

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.
The main functions of the DFB are summarized in the following table:
Selection The DFB selects the analog signal from among the input signals according to one of the
following criteria:
 Maximum
 Minimum
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.
628 EIO0000002093 01/2018

ASELECT
DFB Representation
Representation
EIO0000002093 01/2018 629

ASELECT
Inputs

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 631)
output pin).
1 SP1
2 SP2
3 SP3
4 SP4
5 Maximum value among the enabled SPx
signals (refer to the SPMAX (see page 631)
output pin).
630 EIO0000002093 01/2018

ASELECT
Outputs

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 630) 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 01/2018 631

ASELECT
632 EIO0000002093 01/2018

ASELECT1
EIO0000002093 01/2018
Chapter 59
ASELECT1 - Selector for Analog Signals with Monitoring Variables
ASELECT1 - Selector for Analog Signals with Monitoring

Variables
Overview
This chapter describes the ASELECT1 DFB.

Topic Page
Description 634
Inputs 636
Outputs 637
Inputs/Outputs 638
EIO0000002093 01/2018 633

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.
The main functions of the DFB are summarized in the following table:
Selection The DFB selects the analog signal from among the input signals according to one of the
following criteria:
 Maximum
 Minimum
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.
634 EIO0000002093 01/2018

ASELECT1
DFB Representation
Representation
EIO0000002093 01/2018 635

ASELECT1
Inputs

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 637) output).
1 SP1
2 SP2
3 SP3
4 SP4
5 Maximum value among the enabled SPx signals (refer to
the SPMAX (see page 637) output).
636 EIO0000002093 01/2018

ASELECT1
Outputs

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 636) 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 636) input pin.
EIO0000002093 01/2018 637

ASELECT1
Inputs/Outputs

ASELECT1_ST ASELECT1_ST_DDT Provides the data needed to monitor and/or control the DFB
status.
ASELECT1_CFG ASELECT1_CFGW_DDT Provides the data necessary to configure the DFB normally
ASELECT1_ST_DDT Type

CFGW WORD Provides the data needed to configure the DFB normally from
SP REAL Current set-point generated by the DFB. Refer to the SP
(see page 637) output.
ASELECT1_ST.STW Word Structure

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

0 MINSELD Minimum selected input (SPSELD = 0).
1 SP1SELD Refer to the SP1SELD (see page 637) 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.
638 EIO0000002093 01/2018

ASELECT1

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 637) output pin.
ASELECT1_ST.CTGW Word Structure

following table describes the ASELECT1_ST.CFGW word:

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.
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.
ASELECT1_CFG_DDT Type

SP1 REAL Read-only access. Value on SP1 input.
EIO0000002093 01/2018 639

ASELECT1
Public Variables

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

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 1 = Read-only access. Refer to the ASELECT1_ST.CFGW.OWNER
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 1 = Read-only access. Refer to the SP1SELD output pin (see page 637).
ERROR BOOL 1 = Read-only access. Refer to the ERROR output pin (see page 637).
640 EIO0000002093 01/2018

CONDSUM
EIO0000002093 01/2018
Chapter 60
CONDSUM - Summary of Conditions
CONDSUM - Summary of Conditions
Overview
This chapter describes the CONDSUM DFB.

Topic Page
Description 642
Inputs 644
Outputs 645
Inputs/Outputs 646
EIO0000002093 01/2018 641

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.
Summary Condition Evaluation The DFB ORs the conditions.
Manual Reset 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.
642 EIO0000002093 01/2018

CONDSUM
DFB Representation
Representation
EIO0000002093 01/2018 643

CONDSUM
Inputs

CONDxx BOOL 1 = Condition activated.
REQREARMxx BOOL 1 =- Enables to require manual resetting when the corresponding input
condition (CONDxx) is activated.
644 EIO0000002093 01/2018

CONDSUM
Outputs

RESULT BOOL 1 = Summarizes the result of ORing the conditions according to the following logic
diagram.
EIO0000002093 01/2018 645

CONDSUM
Inputs/Outputs

CONDSUM_ST CONDSUM_ST_DDT Data structure that is used as an interface with the monitoring
subsystem.
CONDSUM_ST_DDT Type

CONDW WORD Read-only access.
Bits word with input conditions (refer to the CONDxx inputs
(see page 644)) and their evaluation summary (refer to the RESULT
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
646 EIO0000002093 01/2018

CONDSUM
The following table describes the CONDSUM_ST.REARMREQW word:
Bit Description
0 REARMREQ01
1 REARMREQ02
... ...
14 REARMREQ15
EIO0000002093 01/2018 647

CONDSUM
Public Variables

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

RESULT BOOL 1 = Read-only access. Refer to the RESULT output pin (see page 645).
648 EIO0000002093 01/2018

CONDSUM1
EIO0000002093 01/2018
Chapter 61
CONDSUM1 - Interlock Condition Summary
CONDSUM1 - Interlock Condition Summary
Overview
This chapter describes the CONDSUM1 DFB.

Topic Page
Description 650
Inputs 652
Outputs 653
Inputs/Outputs 654
EIO0000002093 01/2018 649

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
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 positions Each condition has a discrete position associated with it. The DFB
evaluates the position of each condition based on the active
conditions evaluated according to priority.
Interlocks Featuring Manual Resetting Process conditions configured this way require resetting from the
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).
650 EIO0000002093 01/2018

CONDSUM1
DFB Representation
Representation
EIO0000002093 01/2018 651

CONDSUM1
Inputs

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).
652 EIO0000002093 01/2018

CONDSUM1
Outputs

ILCKSP BOOL 1 = Indicates the interlock position (refer to the SAFEPOSxx (see page 652)
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 01/2018 653

CONDSUM1
Inputs/Outputs

CONDSUM1_ST CONDSUM1_ST_DDT Data structure that is used as an interface with the monitoring
subsystem.
CONDSUM_ST_DDT Type

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 653) 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 652) inputs) and
their evaluation summary (refer to the ILCK (see page 653) output). The following table describes
the CONDSUM1_ST.CONDW word:
Bit Description
0 Interlock 01. Refer to the ILCK01 (see page 653) output pin.
... ...
15 Resulting interlock. Refer to the ILCK (see page 653) output pin.
654 EIO0000002093 01/2018

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.
... ...
EIO0000002093 01/2018 655

CONDSUM1
Public Variables

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

ILCK BOOL 1 = Read-only access. Refer to the ILCK output pin (see page 653).
ILCKSP BOOL 1 = Read-only access. Refer to the ILCKSP output pin (see page 653).
656 EIO0000002093 01/2018

MSGBOX
EIO0000002093 01/2018
Chapter 62
MSGBOX - Messages to the Operator
MSGBOX - Messages to the Operator
Overview
This chapter describes the MSGBOX DFB.

Topic Page
Description 658
Inputs 660
Outputs 661
Inputs/Outputs 662
EIO0000002093 01/2018 657

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 PlantStruxure General Purpose library for Unity 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.
Message Display The DFB allows the message display to be activated/aborted. Only one message is
Management 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.
658 EIO0000002093 01/2018

MSGBOX
DFB Representation
Representation
EIO0000002093 01/2018 659

MSGBOX
Inputs

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.
660 EIO0000002093 01/2018

MSGBOX
Outputs

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 662) 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 662) 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 01/2018 661

MSGBOX
Inputs/Outputs

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

STW WORD DFB status word. Provides the data necessary to display the
message. Reproduces the values entered in SC.MODE (type of
message to be shown). Valid read-only access.
CFGW WORD DFB configuration word. Enables the applicable actions (OK and/or
Cancel) to be carried out. Valid 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:

0 OKEN DFB status. Indicates that the OK button is applicable to the message in progress.
1 OKCANCELEN DFB status. Indicates that the OK and Cancel buttons are applicable to the
message in progress.
2 DATA1EN DFB status. Indicates that Data 1 is applicable to the message in progress.
3 DATA2EN DFB status. Indicates that Data 2 is applicable to the message in progress.
4 ICON1EN DFB status. Refer to the MSGBOX_ST.STW.ICON3EN input/output.
5 ICON2EN DFB status. Refer to the MSGBOX_ST.STW.ICON3EN input/output.
662 EIO0000002093 01/2018

MSGBOX

6 ICON3EN DFB status. 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 664).
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:

8 OK DFB configuration. 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 DFB configuration. 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:

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 664)) 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 664)).
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 664)) 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 664)).
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 664)) 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 664)) when showing the message.
EIO0000002093 01/2018 663

MSGBOX
Public Variables

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:

MSG STRING[40] Valid 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] Valid 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] Valid 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).
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.
664 EIO0000002093 01/2018

MSGBOX

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.
INPROG- BOOL 1 = Read-only access. Refer to the INPROGRESS output pin (see page 661).
RESS
DONE BOOL 1 = Read-only access. Refer to the DONE output pin (see page 661).
CAN- BOOL 1 = Read-only access. Refer to the CANCELLED output pin (see page 661).
CELLED
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
1 (2 0) 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;
EIO0000002093 01/2018 665

MSGBOX
666 EIO0000002093 01/2018

Index
EIO0000002093 01/2018
Index
A ARAMP
DFB representation, 417
AALARM
function description, 416
general description, 416
inputs, 418
inputs/outputs, 421
inputs, 98
outputs, 419
inputs/outputs, 101
public variables, 423
outputs, 100
ASELECT
ACALC
inputs, 90
advanced/process control
inputs, 630
ARAMP, 415
outputs, 631
IMCTL, 425
ASELECT1
LDLGCTL, 437
PIDCTL, 447
PWMCTL, 465
RATIOCTL, 473
inputs, 636
SPLRGCTL, 481
inputs/outputs, 638
STEP3CTL, 489
outputs, 637
AHISIGNAL
description, 74
auxiliary functions
AALARM, 95
inputs, 76
AOUTPUTLP, 135
outputs, 77
ASELECT, 627
ASELECT1, 633
analog devices control
CONDSUM, 641
CVALVE, 335
CONDSUM1, 649
MValveWithPos, 359
CVALVELP, 347
SDDEVCTL, 383
DEVCTL, 231
AOUTPUTLP
DEVLP, 245
DEVMNT, 257
IBPARxx, 603
MOTOR2LP, 299
inputs, 138
MVALVEDLP, 321
inputs/outputs, 143
MVALVELP, 371
outputs, 141
PIDMUX, 457
SDDEVLP, 399
SEQPARxx, 537
EIO0000002093 01/2018 667

Index
auxiliary functions of InBatch CVALVE

IBFAILED, 591 DFB representation, 337
IBSTABLESTEP, 594 function description, 336
IBSTEPDESC, 597 general description, 336
auxiliary functions of InBatchl inputs, 338
IBTRANS, 586 inputs/outputs, 342
auxiliary functions of sequential control outputs, 340
SEQFAILED, 525 public variables, 344
SEQSTABLESTEP, 528 CVALVELP
SEQSTEPDESC, 531 DFB representation, 349
SEQTRANS, 520 function description, 348
inputs, 350
B inputs/outputs, 355
Batch Phase Control outputs, 353
InBatch Overview, 557 public variables, 358
C D
commands DCALC
Batch phase control, 561 DFB representation, 149
sequential control, 505 function description, 148
CONDSUM general description, 148
DFB representation, 643 inputs, 150
function description, 642 outputs, 151
general description, 642 public variables, 152
inputs, 644 DEVCTL
inputs/outputs, 646 DFB representation, 234
outputs, 645 general description, 232
public variables, 648 inputs, 235
CONDSUM1 inputs/outputs, 241
DFB representation, 651 outputs, 237
function description, 650 public variables, 243
general description, 650 DEVLP
inputs, 652 DFB representation, 247
inputs/outputs, 654 function description, 246
inputs/outputs, 253
outputs, 251
668 EIO0000002093 01/2018

Index
DEVMNT G
general
general function block concepts, 31
general concepts
inputs, 260
function block interface, 33
inputs/outputs, 262
modularity, 32
outputs, 261
set-point management, 35
DINPUT
DFB representation, 155 H
HVALVE
inputs, 156
inputs/outputs, 158
outputs, 157
inputs, 276
inputs/outputs, 278
DOUTPUT
outputs, 277
inputs, 164
inputs/outputs, 166
I
outputs, 165 IBFAILED
public variables, 167 function call, 592
inputs/outputs, 593
E IBPARxx
DFB representation, 605, 607
EMCTL
equipment module
IBPHASE - example of use, 615
IBPHASE
description, 568
F DFB representation, 569
inputs, 570
function block interface
inputs/outputs, 571
basic configuration, 33
IBPHASE - example of use
continuous control, 33
illustration, 34
reusable phase definition, 616
overview, 33
reusable phase logic, 618
sequential control, 33
IBPHASE-example of use
states and monitoring, 33
IBSTABLESTEP
function call, 595
inputs/outputs, 596
EIO0000002093 01/2018 669

Index
IBSTEPDESC
description, 598
M
MAINPUT1
function calls, 598
inputs, 600
inputs/outputs, 601
miscellaneous functions
MSGBOX, 657
IBTRANS
modularity
function call, 587
example, 32
overview, 32
inputs, 589
MOTOR2
inputs/outputs, 590
IMCTL
inputs, 285, 293
outputs, 287
inputs, 428
MOTOR2LP
inputs/outputs, 431
outputs, 430
InBatch
inputs, 302
auxiliary functions of InBatch, 585
inputs/outputs, 307
definition of statuses and commands, 560
outputs, 305
IBPHASE, 567
operating modes, 565
MSGBOX
status controller, 564
status matrix, 563
inputs, 660
InBatchl
inputs/outputs, 662
outputs, 661
overview, 558
interlocking
MVALVE
L general description, 360
inputs, 362
LDLGCTL
inputs/outputs, 367
outputs, 365
MVALVED
inputs, 440
outputs, 441
inputs, 314
inputs/outputs, 317
outputs, 316
670 EIO0000002093 01/2018

Index
MVALVEDLP PWMCTL
DFB representation, 323 DFB representation, 467
function description, 322 function description, 466
general description, 322 general description, 466
inputs, 324 inputs, 468
inputs/outputs, 329 inputs/outputs, 470
outputs, 327 outputs, 469
public variables, 332 public variables, 472
MVALVELP
function description, 372 R
general description, 372 RATIOCTL
inputs, 374 DFB representation, 475
inputs/outputs, 379 function description, 474
inputs/outputs, 478
outputs, 477
O public variables, 480
on/off devices control
HVALVE, 273
MOTOR2, 281 S
MVALVED, 311 SDDEVCTL
P general description, 384
PIDCTL inputs, 387
DFB representation, 449 inputs/outputs, 393
inputs, 450 SDDEVLP
inputs/outputs, 452 DFB representation, 401
outputs, 451 function description, 400
public variables, 455 general description, 400
PIDMUX inputs, 402
DFB representation, 459 inputs/outputs, 407
inputs, 460 SEQCTL1
inputs/outputs, 462 description, 510
outputs, 461 DFB representation, 511
public variables, 464 inputs/outputs, 512
process Unity component public variables, 515
list of function blocks, 27
EIO0000002093 01/2018 671

Index
SEQCTL1 - example of use signal processing

DFB representation, 547 ACALC, 87
reusable sequence definition, 546 AINPUT, 103
reusable sequence logic, 548 AINPUT1, 111
SEQCTL1-example of use AISignalCond1 and AISignalCondReal1,
general description, 546 41
SEQFAILED AISignalHart1- HART Input Signal Condi-
function call, 526 tioning (M580), 81
general description, 526 ALINEAR, 119
inputs/outputs, 527 AOSIGNALCOND, 49
SEQPARxx AOUTPUT, 125
DFB representation, 539, 541 CounterSignalCondUInt and CounterSig-
function description, 538 nalCondUDInt, 55
general description, 538 DCALC, 147
inputs, 540, 606 DINPUT, 153
inputs/outputs, 542, 608 DISignalCond1, 61
public variables, 544 DOSIGNALCOND, 67
SEQSTABLESTEP DOUTPUT, 161
function call, 529 MAINPUT1, 169
general description, 529 TOTAL, 211
inputs/outputs, 530 simulation
SEQSTEPDESC function description, 37
description, 532 SPLRGCTL
function calls, 532 DFB representation, 483
inputs, 534 function description, 482
inputs/outputs, 535 general description, 482
SEQTRANS inputs/outputs, 486
function call, 521 outputs, 485
inputs, 523 STAHL
inputs/outputs, 524 DFB descriptions, 179
sequential control STAHLAI8CH
auxiliary functions of sequential control, DFB description, 180
519 STAHLAO8CH
definition of statuses and commands, 504 DFB description, 185
function description, 502 STAHLDI16CH
operating modes, 508 DFB description, 190
overview, 502 STAHLDO8CH
SEQCTL1, 509 DFB description, 195
SEQCTL1 - example of use, 545 STAHLHARTVal4
sequential control overview, 501 DFB description, 200
status controller, 507 STAHLHARTVal8
status matrix, 506 DFB description, 205
672 EIO0000002093 01/2018

Index
statuses
InBatch, 560
sequential control, 504
STEP3CTL, 494
inputs, 492
inputs/outputs, 495
U
USERPHASExx
inputs, 613
inputs/outputs, 614
EIO0000002093 01/2018 673

Index
674 EIO0000002093 01/2018

Eio0000002093 06

Diunggah oleh

Informasi Dokumen

Judul Asli

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

Eio0000002093 06

Diunggah oleh

Hak Cipta:

Format Tersedia

PlantStruxure General Purpose Library for Unity

BEFORE YOU BEGIN

START-UP AND TEST

This library is compatible with the following hardware platforms:

What Is in This Part?

Process Unity Components

List of Function Blocks

Family Name Function Blocks Description

Family Name Function Blocks Description

Family Name Function Blocks Description

General Function Block Concepts

What Is in This Chapter?

Function Block Interface

States and Monitoring

Simulation and Interlocking

What Is in This Part?

AISignalCond1 and AISignalCondReal1 - Analog Input

What Is in This Chapter?

Input Parameter Description

Parameter Type EFB Description

COMSTATUS BOOL AISignalCond1 Communication status with module.

SIMVALUE INT AISignalCond1 Simulation mode channel value.

SIMFAILURE BOOL AISignalCond1 Simulation mode channel detected

Output Parameter Description

Parameter Type EFB Description

SIGNALFAILURE BOOL AISignalCond1 Detected signal failure due to a detected

SIMULATION BOOL AISignalCond1 Simulation status.

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

The following figure shows the ModuleStatus of channel 10:

The following figure shows the ModuleStatus of channel 11:

AOSIGNALCOND - Analog Output Signal conditioning

What Is in This Chapter?

Input Parameter Description

Parameter Type Description

Output Parameter Description

Parameter Type Description

CounterSignalCondUInt and CounterSignalCon-

What Is in This Chapter?

Input Parameter Description

Parameter Type EFB Description

ERROR BOOL CounterSignalCondUDInt Detected channel error signal from

NOTMODULESTATUS BOOL CounterSignalCondUDInt Module status.

SIMMODE BOOL CounterSignalCondUDInt Simulation mode.

SIMVALUE UDINT CounterSignalCondUDInt Simulation mode channel value.

Output Parameter Description

Parameter Type EFB Description

SIGNALFAILURE32 BOOL CounterSignalCondUDInt Detected signal failure due to a detected

DISignalCond1 - Digital Input Signal Conditioning

What Is in This Chapter?

Input Parameter Description

Parameter Type EFB Description

Output Parameter Description

Parameter Type EFB Description

DOSIGNALCOND - Digital Output Signal Conditioning

What Is in This Chapter?

Input Parameter Description

Parameter Type Description

Output Parameter Description

Parameter Type Description

AHISIGNAL - HART Device Signal Mapping

What Is in This Chapter?

Input Parameter Description

Parameter Type Description