EcoStruxure™ Process Expert WWW Library

EIO0000001107 05/2020

EcoStruxure™ Process
Expert Water Library
Control Services User Guide
05/2020
EIO0000001107.08

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

2 EIO0000001107 05/2020
 Table of Contents

Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Part I General Information . . . . . . . . . . . . . . . . . . . . . . . . . 19
Chapter 1 Water Library Control Expert Services . . . . . . . . . . . . . . 21
Delivering Control Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
List of Function Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Chapter 2 Using the Water Library . . . . . . . . . . . . . . . . . . . . . . . . . 25
Basic Features of the Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Simulation Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Part II Equipment Control Objects . . . . . . . . . . . . . . . . . . . . 31
Chapter 3 WMOTOR: One-direction and One-speed Motor . . . . . . . 33
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Chapter 4 WMOT1D2S: One-direction and Two-speed Motor . . . . . . 49
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Chapter 5 WMOT2D1S: Two-direction and One-speed motor . . . . . . 69
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

EIO0000001107 05/2020 3
 Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Chapter 6 WMOTORVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Chapter 7 WVALVE: On/Off Device Type Control Modules . . . . . . . . 103
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Chapter 8 WMVALVE: Motorized Valves with Positioner . . . . . . . . . . 119
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Chapter 9 WMVALVED: On/Off Motorized Valve DFB. . . . . . . . . . . . . 135
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

4 EIO0000001107 05/2020
 Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Chapter 10 WPENSTOCK: Penstock Valve . . . . . . . . . . . . . . . . . . . . . 149
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Input/Output Pins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Chapter 11 WAINPUT: Analog Input . . . . . . . . . . . . . . . . . . . . . . . . . 163
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Chapter 12 WAOUTPUT: Analog Output . . . . . . . . . . . . . . . . . . . . . . . 177
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Chapter 13 WDINPUT: Digital Input . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

EIO0000001107 05/2020 5
 Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Chapter 14 WDOUTPUT: Digital Output . . . . . . . . . . . . . . . . . . . . . . . . 197
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Part III Generic Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Chapter 15 WPUMPSEL: Pump Selection . . . . . . . . . . . . . . . . . . . . . . 209
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Chapter 16 WPUMPSEL1: Enchanced Pump Selection . . . . . . . . . . . . 219
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Chapter 17 WDMFCTL: Dual Media Filter Management . . . . . . . . . . . . 229
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

6 EIO0000001107 05/2020
 Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Chapter 18 WFLOWCALC: Flow Calculation . . . . . . . . . . . . . . . . . . . . 243
18.1 WREC_WEIR: Rectangular Weir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
18.2 WTRAP_WEIR: Trapezoidal Weir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
18.3 WV_WEIR: V Notch Weir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
18.4 WREC_FLU: Rectangular Flume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
18.5 WTRAP_FLU: Trapezoidal Flume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

EIO0000001107 05/2020 7
 18.6 WPARSH_FLU: Parshall Flume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
18.7 WU_FLU: U FLUME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Chapter 19 WFLOWCTL: Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . 287
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Chapter 20 WAERACTL: Aeration Control Block . . . . . . . . . . . . . . . . . 297
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Chapter 21 WSCHEDULER: Scheduler Function Management . . . . . . . 311
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

8 EIO0000001107 05/2020
 Part IV Auxiliary Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Chapter 22 WPIDIN: Water PID Input . . . . . . . . . . . . . . . . . . . . . . . 321
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Chapter 23 WPIDOUT: Water PID Output . . . . . . . . . . . . . . . . . . . . . 327
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Chapter 24 WDEVMNT: Device Maintenance . . . . . . . . . . . . . . . . . . . 333
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Chapter 25 WCONDSUM: Device Diagnostic Information/Interlock . . . 343
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Chapter 26 WHPROLPRO: Process Limits Auxiliary . . . . . . . . . . . . . . 353
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Index ......................................... 361

EIO0000001107 05/2020 9
10 EIO0000001107 05/2020
 Safety Information

Important Information

NOTICE
Read these instructions carefully, and look at the equipment to become familiar with the device
before trying to install, operate, service, or maintain it. The following special messages may appear
throughout this documentation or on the equipment to warn of potential hazards or to call attention
to information that clarifies or simplifies a procedure.

EIO0000001107 05/2020 11
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.

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

START-UP AND TEST

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

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

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

EIO0000001107 05/2020 13
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.

14 EIO0000001107 05/2020
 About the Book

At a Glance

Document Scope
This document describes the function blocks (DFBs) and variables that are encapsulated in the
Control facets referenced by the process control module templates to provide services.
For a list of templates and the services that they provide, refer to the user guides mentioned in this
document.
This document does not cover any development procedures and internal functionality details of
Control Expert.
Users of Control services need to have a working knowledge of Control Expert, and of the
Supervision and Control Participants.

Validity Note
This document is valid for EcoStruxure™ Process Expert 2020 - Water Library.

Related Documents

Title of Documentation Reference Number

EcoStruxure™ Process Expert Water Library Supervision Services EIO0000002050
User Guide
EcoStruxure™ Process Expert Water Library Templates User Guide EIO0000001577

You can download these technical publications and other technical information from our website
at https://www.se.com/ww/en/download/ .

EIO0000001107 05/2020 15
Product Related Information

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

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

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

16 EIO0000001107 05/2020
 Examples described in this manual are provided for information only.

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

EIO0000001107 05/2020 17
18 EIO0000001107 05/2020
 EcoStruxure™ Process Expert WWW Library
General Information
EIO0000001107 05/2020

Part I
General Information

General Information

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
1 Water Library Control Expert Services 21
2 Using the Water Library 25

EIO0000001107 05/2020 19
General Information

20 EIO0000001107 05/2020
 EcoStruxure™ Process Expert WWW Library
Water Library Control Expert Services
EIO0000001107 05/2020

Chapter 1
Water Library Control Expert Services

Water Library Control Expert Services

Overview
This chapter describes how the Control Expert services of the control module templates are made
available to you through Control Expert and the embedded Control Expert Participant.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Delivering Control Services 22
List of Function Blocks 23

EIO0000001107 05/2020 21
Water Library Control Expert Services

Delivering Control Services

Introduction
Inside process control module templates, the resources providing Control services are organized
in composite and facet templates. They are elements of the control module template and its
instances.
Interfaces link these elements within the control module and allow making links to instances of
other templates.

Control Facet Templates

The facet template is the smallest component of a process template.
It encapsulates the constituents of the Control Participant, which are the function blocks and
variables described in this document.
During generation, these constituents create the logic of the Control Participant project that you
have created in Control Expert.

Control Composite Templates

The Control composite template is a container for Control elements and/or other composite
references.
They help organizing Control services inside the control module template.

Configuring Control Services

Typically, process control module templates contain core and optional services.
To customize the services provided by an instance that uses the control module template, the
Properties window of the instance allows you to:
 Activate/deactivate optional resources.
 Configure the parameters of core resources and selected optional resources.

In addition, you can modify the logic of the Control Participant project during refinement.

22 EIO0000001107 05/2020
 Water Library Control Expert Services

List of Function Blocks

List of Families
The function blocks described in this document are grouped by family.
The families are the same as the ones used to group the process control module templates.
Each DFB is assigned to the same family as the control module template that references it.

Description
The table lists the Control Expert function of each family:

Family name Control Expert function

Equipment control WMOTOR: One-direction and one-speed motor (see page 33)
WMOT1D2S: One-direction and two-speed motor (see page 49)
WMOT2D1S: Two-direction and one-speed motor (see page 69)
WMOTORVS: Variable speed motor (see page 87)
WVALVE: On/Off device type control modules (see page 103)
WMVALVE: Motorized valves with positioner (see page 119)
WMVALVED: On/Off motorized valve (see page 135)
WPENSTOCK: Penstock valve (see page 149)
WAINPUT: Analog input conditioning (see page 163)
WAOUTPUT: Analog output conditioning (see page 177)
WDINPUT: Digital input (see page 187)
WDOUTPUT: Digital output (see page 197)
Generic process WPUMPSEL: Pump selection (see page 209)
WPUMPSEL1: Pump selection one (see page 219)
WDMFCTL: Dual media filter control
WAERCTL: Aeration control (see page 297)
WFLOWCALC: Flow calculation (see page 243)
WFLOWCTL: Flow control
WSCHEDULER: Scheduler function (see page 311)

EIO0000001107 05/2020 23
Water Library Control Expert Services

Family name Control Expert function

Auxiliary Objects WPIDIN: Water PID Input (see page 321)
WPIDOUT: Water PID Output (see page 327)
WDEVMNT: Device maintenance (see page 333)
WCONDSUM: Device Diagnostic Information/Interlock (see page 343)
WHPROLPRO: Process Limits Auxiliary (see page 353)

24 EIO0000001107 05/2020
 EcoStruxure™ Process Expert WWW Library
Using the Water Library
EIO0000001107 05/2020

Chapter 2
Using the Water Library

Using the Water Library

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Basic Features of the Library 26
Operating Modes 27
Simulation Function 30

EIO0000001107 05/2020 25
Using the Water Library

Basic Features of the Library

Introduction
The WWW Library Objects are designed to perform generic water process related functions. These
are defined as equipment control and device control functions.
The library object design include Control Expert Derived Function Block (DFB). It contains the data
structure and functional logic for library block operation.
The following functions are performed by Water library blocks:
 Control - Management of operating modes (Program, Operator, and Local)
 Alarming:
 Management of alarms and alerts
 Enabling/disabling alarms
 Alarm properties - Priorities, forwarding SMS, and audio alarms
 Configuration of timeout parameter

 Load shedding management:

 You can manage the electrical driven actuators (motors, motorized valves) through a
predefined interface used for load shedding
 Device management:
 Triggered through running hours, operation counts, time period, or cycles
 Information about the maintenance to-dos
 Maintenance schedules

26 EIO0000001107 05/2020
 Using the Water Library

Operating Modes

Overview
You can operate this function blocks especially the actuator devices in different operating modes.
The below section provides an overview of different operating modes specific to the following block
families:
 Motors and valves
 Controllers
 Other generic process blocks

Operating Modes Specific to Function Block Families

The following operating modes are specific for motors and valves:
 Program mode
 Operator mode
 Local mode
 Out of Service

The following operating modes are specific for controllers and generic process:
 Program mode
 Operator mode
 Auto mode (only for PID)
 Manual mode (only for PID)

Program Mode
This mode of operation receives command signal from another program driving the device
operation.
During Program mode, the operator does not have any access to operate the device from the
device faceplate (set point buttons – On/Off is disabled).
You can set the device to Program mode by setting the program as the owner from the faceplate.
This setting can be done from the program driving the device. Program mode is the default mode.
You can set the Program mode by the following two separate locations:
Local set point - The local set point is assigned to the sequential control or to the command
received from the monitoring system.
Remote set point - The remote set point is assigned to the control module from the logic
implemented in the continuous control.
The Program mode is available for actuator devices such as motors, motor operated valves,
pneumatic on/off valves, controllers, analog/digital outputs, circuit-breaker, pump selection
function block, and other generic process function blocks.
Refer to the respective function block sections for detailed description.

EIO0000001107 05/2020 27
Using the Water Library

Operator Mode
This mode of operation receives command signal from the operator with required user privileges
through the device faceplate.
During Operator mode, the operator provides the user privileges of set point from the faceplate
buttons to on/off the device.
You can set the device to Operator mode by setting the operator as the owner from the faceplate.
You can do the setting from device faceplate by pressing OPERATOR button.
The Operator mode is available for actuator devices such as motors, motor operated valves,
pneumatic on/off valves, controllers, analog/digital outputs, circuit-breaker, pump selector block,
and other generic process selection blocks.
Refer to the respective function selection block sections for detailed description.

Local Mode
This mode of operation enables the devices (motors and motorized valves) to be operated locally
from local push button station in the field or from MCC.
During this mode of operation, any operation from PLC controller and SCADA is bypassed. The
operator is only allowed to monitor the state of the device from the faceplate/genie.
You can put the device in Local mode by setting the local input parameter value to 1 from the
field/MCC (digital input). The device is in remote operation, that is, from the PLC by default.
When in Local mode, the device genie displays a LOC text in runtime.
The Program mode is available for motor operated devices such as motors and motor operated
valves.
Refer to the respective function block sections for detailed description.

Out of Service
The Out of Service mode is for device maintenance and service purpose. In this mode, the device
is shutdown/or removed for servicing of the device.
At this instance, the outputs of the block are put to defined position in Operator mode.
The operator and program does not perform any operations from the faceplate.
Out of Service symbol is shown on the device genie.
The Program mode is available for actuator devices such as motors, motor operated valves,
pneumatic on/off valves, controllers, and circuit-breaker.
Refer to the respective function block sections for detailed description.

28 EIO0000001107 05/2020
 Using the Water Library

Auto Mode
The Auto mode of operation is used in PID.
This mode of operation is available for both Program and Operator modes.
In this mode of operation, the output of the controller is automatically driven by the controller
mathematical expression (PID equation) with a set point entry from supervision by the operator, or
from the program.
Refer to the respective function block sections for detailed description.

Manual Mode
The Manual mode of operation is used in PID.
This mode of operation is available for both Program and Operator modes.
In this mode of operation, the operator or program can directly set the output of the controller within
the output limits bypassing the PID control algorithm.
Refer to the respective function block sections for detailed description.

Configurations
One-time configurations such as feedback time limit, enabling/disabling the feedback is done in
Public Variable of each block. Refer to the respective block description for more details.

EIO0000001107 05/2020 29
Using the Water Library

Simulation Function

Introduction
This function enables to simulate the operation of the equipment (motors and valves) without
having real time feedbacks. You cannot switch the block to Simulation mode when the block is
giving a command to the field.
In simulation, a project constant is available to enable/disable the field command output in this
mode. If the project constant (OPSIMEN is false and the mode is switched from Simulation to
Operator, the output is not disturbed.
You can configure the project constant from the WWW_PCON DFB output pin as shown below

This table describes about the configuration of project constant from the WWW_PCON DFB output:

Parameter Type Description

OPSIMEN BOOL 1 = Output enabled in Simulation
mode.

30 EIO0000001107 05/2020
 EcoStruxure™ Process Expert WWW Library
Equipment Control
EIO0000001107 05/2020

Part II
Equipment Control Objects

Equipment Control Objects

Overview
This part provides a detailed description of the functions, pins, pin layout, and variables of the
function blocks of the equipment control objects.

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

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

EIO0000001107 05/2020 31
Equipment Control

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
3 WMOTOR: One-direction and One-speed Motor 33
4 WMOT1D2S: One-direction and Two-speed Motor 49
5 WMOT2D1S: Two-direction and One-speed motor 69
6 WMOTORVS 87
7 WVALVE: On/Off Device Type Control Modules 103
8 WMVALVE: Motorized Valves with Positioner 119
9 WMVALVED: On/Off Motorized Valve DFB 135
10 WPENSTOCK: Penstock Valve 149
11 WAINPUT: Analog Input 163
12 WAOUTPUT: Analog Output 177
13 WDINPUT: Digital Input 187
14 WDOUTPUT: Digital Output 197

32 EIO0000001107 05/2020
 EcoStruxure™ Process Expert WWW Library
WMOTOR
EIO0000001107 05/2020

Chapter 3
WMOTOR: One-direction and One-speed Motor

WMOTOR: One-direction and One-speed Motor

Overview
This chapter describes the control services provided by WMOTOR DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 34
Description 35
DFB Representation 37
Inputs 38
Outputs 39
Inputs/Outputs 41
Public Variables 44
Usage 47

EIO0000001107 05/2020 33
WMOTOR

Introduction

General
The WMOTOR DFB controls motors with one direction and one speed.
The following table describes the main functions of this block:

Function Description
Control Receives digital feedback signals from field for monitoring and processes
commands from supervision, or from program for device operation by
sending digital signal to field according to defined conditions.
Operation feedback Provides operational feedbacks of the device (motor run/stop and trip) by
processing field digital input signals from MCC.You can optionally select the
number of signals to be processed.
Inoperable motor Enables to monitor the detected failure conditions of the motor. Generates
digital signal to display on supervision and an alarm in case of inoperable
motor. You can optionally select the conditions and have an option for
individual bypass of the detected failure conditions.
Detection of not confirmed Enables to monitor the detected fault of device feedback confirmation when
operation it is not responded after a predefined elapsed time (SC.TIMEOUT).
After elapsed time, the DFB generates a digital signal to display in
supervision and an alarm for not confirmed operation.
You can optionally select the detected failure generation in the DFB.
Manual resetting Allows you to reset manually after the detection of an inoperable device
condition or a not confirmed operation and thereby moving motor to the
current set point.
Local and remote set point Enables you to control the module with a set point that is determined through
(Program mode) a set point selector (local or remote).
The local set point is assigned to the sequential control or to the command
received from the monitoring system while the remote set point is assigned
to the module control from the logic implemented in the continuous control.
Interlocking The DFB gives the motor a command to move to the defined position
(run/stop) if an active interlock that requires this move is detected.
An interlock bypass function is available to bypass individual active interlock
conditions.
Owner selection Defines the ownership of the control from the module. The control remains
with supervision operator or Program to generate commands for operation.
Simulation You can switch the function block to Simulation mode where the feedback
signals are simulated, and confirm the normal operation of the function
block.The field feedback signals are bypassed in this case. Output to field is
configured as per project constant variable (OPSImEN). For detail refer to
Simulation (see page 30).
Load shedding management The function block supports energy management of motors in the Program
mode by load shedding.

34 EIO0000001107 05/2020
 WMOTOR

Description

Operating Modes
The WMOTOR DFB controls one-direction and one-speed motor.
It supports the following modes of motor control:
 Operator mode - Click the required buttons to start/stop the motor from the faceplate.
 Program mode - There are two internal modes: Remote and Local.
In Program - Remote mode, use RSP input pin to start/stop the motor. Set the variable SC.REM
to enable the Program - Remote mode.
In Program - Local mode, use the LSP public variable to start/stop the motor.. Reset the public
variable SC.REM to enable the Program - Local mode.
 Local mode - The motor is directly controlled by the local electrical panel but not by the PLC, so
the DFB outputs are reset.

Functional Description
The motor run output pin OP is to be connected to a digital output card, which is to be connected
to the contactor/circuit breaker.
The DFB monitors the run feedback through the input pin ZSH, which can be connected to a digital
input, wired to the seal-in-contact of the contactor/circuit breaker.
You have the provision to enable/disable the run feedback monitoring regardless of the modes
through the variable SC.ZSHEN. The delay for monitoring the run feedback is set in SC.TIMEOUT.
The DFB monitors the detected failure conditions through the input pin FAIL. If this input is set to
1, it indicates that the DFB has detected failure condition. This sets the output pin FAILD and
resets the output pins OP/SP.
The DFB monitors the interlock conditions through the input pin ILCK. If this input is set to 1, it
indicates that the DFB has detected an active interlock condition. This sets the output pin ILCKD
and resets the output pin OP/SP. If there are more than 1 detected failure/interlock conditions, use
WCONDSUM DFB along with WMOTOR DFB.
Connect the detected failure/interlock conditions to the input pins of WCONDSUM DFBs, and connect
the output pins RESULT to the FAIL/ILCK input pins of WMOTOR DFB. A provision to bypass the
individual detected failure/interlock condition is also available from faceplate.
This function block monitors the number of starting/running hours of the motor from the last reset
if WDEVMNT DFB is linked to WMOTOR DFB. In this case, the variable connected to pin WDEVMNT_ST
has to be connected to input pin DEVMNTST of WMOTOR DFB.
The DFB also supports the Simulation mode, which is a pre-commissioning mode where you can
test the block without any inputs being monitored.

EIO0000001107 05/2020 35
WMOTOR

Click the required button from the faceplate to set the motor to Out of Service mode. If OOS is
activated in running condition, it stops running of the motor. When the motor is set back into Service
mode, it acquires the stop condition.
The function block supports the load shedding phenomenon in Program-Remote mode, when the
function block is in Program mode and SC.REM = 1. To handle this phenomenon, set the parameter
SC.PARLDSHED to a particular value. When you set the input pin LDSHED to SC.PARLDSHED value
in Program mode, the outputs of the block are reset and motor is taken into load shedding. You
can provide a delay for the same from faceplate.
You can set a priority for sending SMS/speaker output for the individual detected failure/interlock
condition from the faceplate.

36 EIO0000001107 05/2020
 WMOTOR

DFB Representation

Overview
This figure shows the FBD representation of the WMOTOR DFB.

EIO0000001107 05/2020 37
WMOTOR

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the DFB
internal timers are reset and the signals are re-evaluated.
ZSH BOOL 1 = Motor running feedback input from the field/MCC
ZSL BOOL 1 = Motor stop signal derived from the logic
FAIL BOOL 1 = Detected failure in the device
LOCAL BOOL Local Mode operation
1 = Local mode active
RSP BOOL Remote set point set by the continous control. You can start and stop
the motor from RSP if the public variable SC.REM = 1.
1 = Motor Start command active from RSP.
ILCKSP BOOL Interlock set point that is used when the function block is interlocked.
1 = Motor starts.
ILCK BOOL Interlocks the motor at the defined position (run/stop).
 0 = Normal condition.
 1 = Interlocked condition.
EXTCTLD BOOL Indicates if the motor is controlled from outside of the system.
1 = External control
LDSHED WORD Load shedding input.
FCCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB for FAIL ( detected failure).
ILCKCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB for ILCK (interlock).
DEVMNTST WDEVMNT_ST_DDT Structure from WDEVMNTST DFB for DEVMNT (device maintenance).

38 EIO0000001107 05/2020
 WMOTOR

Outputs

Output Parameter Description

Parameter Type Description

OP BOOL Function block command output to field/MCC.
1 = Motor Start command.
SP BOOL Current motor command status.
 0 = Stop command
 1 = Start command
HIGHPOS BOOL 1 = Determines if the Motor has reached the position corresponding to the set point
(SP) with value 1
LOWPOS BOOL 1 = Determines if the motor has reached the position corresponding to the set point
(SP) with value 0.
ZSHPOS BOOL Indicates running status of motor.
1 = Indicates that the position corresponding to the set-point (SP) with a value 1 has
been reached. It is independent from the other detector if the ZSH detector is
available.
ZSLPOS BOOL Indicates stop status of motor.
1 = Indicates that the position corresponding to the set point (SP) with a value of 0
has been reached. It is independent from the other detector if the ZSL detector is
available.
ALARM BOOL 1= Motor function block has active alarms
FAILD BOOL 1 = Motor function block has detected failure conditions.
OOS BOOL Determines whether the motor is in Out of Service mode or in operation mode.
 0 = In operation
 1 = Out of Service
SPEAKER BOOL Activates audible alarming system.
1 = Output to activate audible alarming system is ON.
SMS BOOL 1 = Output for messaging alarm is ON.
SMSPRI INT Priority level for messaging SMS.

EIO0000001107 05/2020 39
WMOTOR

The below truth table shows the OP (output pin) value whenever there is a detected failure (FAIL
= 1), which are dependent on the configurable public parameters SC.FAILEN and
SC.FAILREARMEN.

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

SC.FAILEN public SC.FAILREARMEN OP output when FAIL = 1 OP output when FAIL = 1

variable public variable (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

40 EIO0000001107 05/2020
 WMOTOR

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WDEVCTL_ST WDEVCTL_ST_DDT Function block status handles data structure
(communication with Supervision)

Other DDTs which are used with WMOTOR DFB to function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WDEVCTL_ST_DDT Type
The following table describes the structure of the derived data type WDEVCTL_ST_DDT for the
WMOTOR DFB.

Name Type Description

LSDELAY UINT Load shedding delay.
SPW WORD Word containing the status bits of detected failure condition for speaker
output.
SMSW WORD Word containing the status bits of detected failure condition for SMS output.
FSMSPRI1...15 INT SMS priority of 1...15 detected failure conditions (FAIL).
RHPREWARN DINT Set point for running hour counter pre alert.
SPRHCNT DINT Set point for running hours counter alarm.
OCPREWARN DINT Pre alert for operation counter.
SPMCNT DINT Set point for operations counter alert.
TCPREWARN INT Set point for time counter pre alert.
SPTC INT Set point for time counter alert.
LOCAL WORD Indicates Local mode.
ISPW WORD Word containing the status bits of interlock conditions for speaker output.
ISMSW WORD Word containing the status bits of interlock conditions for SMS output.
ISMSWPRI1...15 INT SMS priority of 1...15 interlock conditions.
SEL UINT Selection for Maintenance modes.
OPMODE INT Standard operation mode.
STW WORD Monitors the motor status.
CFGW WORD Provides the means to control the motor from the monitoring subsystem.

EIO0000001107 05/2020 41
WMOTOR

Name Type Description

ALW WORD Provides information on alarms and alerts.
OHLUM DINT Operating hours left until maintenance of running hour.
OLUM DINT Operations left until maintenance of operations counter.
NXTMNT INT Next maintenance time counter.

WDEVCTL_ST.STW Word Structure

STW element monitors the status from the monitoring sub-system (Supervision)
Bit description of the STW element:

Bit Name Description

0 ZSHPOS Motor run status.
For detailed description, refer to Outputs (see page 39).
1 ZSLPOS Motor stop status
For detailed description, refer to Outputs (see page 39).
2 SP Motor operation command.
For detailed description, refer to Outputs (see page 39).
3 OP Motor command output to field/MCC.
For detailed description, refer to Outputs (see page 39).
4 ALARM Alarm for motor
1 = Alarm is active
5 FAILD 1 = Inoperable motor
6 REM Motor status. Indicates whether the current set point (SP) is local (0) or remote (1).
When the owner is Operator (OWNER = 1), the set point is always local. When the
owner is Program (OWNER = 0), the set point is selected with the SC.REM public
signal.
 0 = Local
 1 = Remote

7 ILCK Interlocks the device at the defined position.

 0 = Normal condition.
 1 = Interlocked condition.

8 REARMR Allows you to reset the motor (1). The function block sets the signal to 0 after each
run and sets the signal indicating that resetting is required CFGW.REARM to 0.
9 EXTCTLD Indicates if the motor is controlled from outside of the system.
1 = External control

42 EIO0000001107 05/2020
 WMOTOR

WDEVCTL_ST.CFGW Word Structure

CFGW element controls the function block from monitoring subsystem (Supervision).
Bit description of the CFGW element:

Bit Name Description

0 OWNER Enables you to configure whether the set point is determined by the Program (0) or
the Operator (1).
1 ILCKBP 1 = Allows motor control block to bypass active interlocks.
2 SIMMD Allows motor function block to operate in Simulation mode (value 1). Field input
feedbacks are bypassed and motor feedbacks are simulated.
3 REARM Manual Reset command (value 1) for resetting active detected failures/alarms.
4 LSP Allows the local set point (OWNER = 1) of the operator to get set from the monitoring
subsystem. If the set point is set by the Program (OWNER = 0), the block continuously
assigns it the value of the current set point (value 1).
12 ENRHWARN Enables alert for running hours.
13 ENOCWARN Enables alert for operation counter.
14 ENTCWARN Enables alert for time counter.
15 OOS Out of Service. Enables you to define whether the equipment is in Out of Service (1)
or in operational (0).
For detailed description, refer to Outputs (see page 39).

WDEVCTL_ST.ALW Word Structure

ALW generates the alerts from the monitoring sub-system (Supervision).
NOTE: Alert/Alarm will be generated when corresponding bits of Alw element are HIGH.
Bit description of the ALW element:

Bit Name Description

1 ALARM Alarm for motor.
3 FAILD Inoperable motor.
5 LSWARN Alert for load shedding.
6 OPWARN Alert for Operation mode.
7 RHPREWARN Pre alert for running hours counter.
8 RHWARN Alert for running hours counter.
9 TCPREWARN Pre alert for operations counter.
10 OCWARN Alert for operations counter.
11 TCPREWARN Pre alert for time counter.
12 TCWARN Alert for time counter.

EIO0000001107 05/2020 43
WMOTOR

Public Variables

Public Variable Description

Variable Type Description

SC WDEVCTL_SC_DDT Function block configuration and control
data structure

WDEVCTL_SC_DDT Type
The following table describes the structure of the derived data type WDEVCTL_SC_DDT of WMOTOR
DFB:

Name Type Description

TIMEOUT TIME Read/write access.
Enables the configuration of time (ms) during which confirmation alarm
monitoring is disabled. The value 0 disables confirmation alarm monitoring.
SCANTIME TIME Read/write access.
Enables the configuration of time (ms) during which alarm signals are kept
active. Allows the monitoring subsystem to acquire the data for alarms that
are automatically reset.
PARLDSHED WORD Read/write access.
Parameter for load shedding.
EXTCTLD BOOL Read-only access.
1 = Input pin EXTCTLD is high.
REM BOOL Read/write access. Allows you to configure the block for local set point or
remote set point.
 0 = Local set point (LSP).
 1 = Remote set point (RSP).

LSP BOOL Read/write access.

 0 = Copies the current set point (SP output continuously to this variable).
 1 = 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).
OP BOOL Read-only access.
1 = Current command output is high.
For detailed description, refer to (Outputs (see page 39))
SP BOOL Read-only access.
1 = Current set point is high.
For detailed description, refer to (Outputs (see page 39))

44 EIO0000001107 05/2020
 WMOTOR

Name Type Description

HIGHPOS BOOL Read-only access.
1 = Device has reached the position corresponding to the set point (SP) with
a value 1.
For detailed description, refer to (Outputs (see page 39))
LOWPOS BOOL Read-only access.
1 = Device has reached the position corresponding to the set point (SP) with
a value 0.
For detailed description, refer to Outputs (see page 39)
ZSHPOS BOOL Read-only access.
1 = Position corresponding to the set point (SP) with a value 1 has been
reached.
For detailed description, refer to Outputs (see page 39)
ZSLPOS BOOL Read-only access.
1 = Position corresponding to the set point (SP) with a value 0 has been
reached.
For detailed description, refer to Outputs (see page 39)
ALARM BOOL Read-only access.
1 = Active alarm present in the block for confirmation.
For detailed description, refer to Outputs (see page 39)
FAILD BOOL Read-only access.
1 = Active alarm present in the block for any inoperable device.
For detailed description, refer to Outputs (see page 39)
REARMR BOOL Read-only access.
1 = Requires manual resetting on any detected failure in block.
ILCKD BOOL Read-only access.
The signal is evaluated based on the ILCK input and
WMOTOR_ST.CFGW.ILCKBPinput/output.
1 = Block is interlocked
OWNER BOOL Read-only access.
 0 = Owner for block operation is Program
 1 = Owner for block operation is Operator
OOS BOOL Read-only access.
Indicates whether the equipment is in Out of Service or Operational mode.
 0 = In operation
 1 = Out of Service

For detailed description, refer to Outputs (see page 39)

ZSHEN BOOL Read/write access.
1 = Enables high position feedback.
ZSLEN BOOL Read/write access.
1 = Enables low position feedback.
FAILEN BOOL Read/write access.
1 = Enables monitoring of detected failure (FAIL).

EIO0000001107 05/2020 45
WMOTOR

Name Type Description

CONFREARMEN BOOL Read/write access.
 0 = The output OP remains in its previous state when a non-confirmed
operation is detected and does not require manual resetting.
 1 = Withdraws the output OP when a non-confirmed operation is detected
(ALARM = 1) and a mandatory resetting is required.
FAILREARMEN BOOL Read/write access.
 0 = The output OP remains in its previous state during detected failure
conditions and does not require manual resetting.
 1 = Withdraws the output OP during failure conditions (FAIL = 1, FAILEN
= 1) and a mandatory manual resetting is required once the FAIL
condition disappears (FAIL = 0).

46 EIO0000001107 05/2020
 WMOTOR

Usage

Overview
Examples in this manual are given for information only.

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

Based on the options selected, the WMOTOR DFB in the application is used for WCONDSUM and
WDEVMNT DFBs to configure the desired functionality for the device.
The following figure is shown as an example for WMOTOR DFB.

The WMOTOR block requires following external connections:

 A WCONDSUM block is to be connected to the ILCK pin which can handle a maximum of fifteen
interlocks.
 A WCONDSUM block is to be connected to the FAIL pin which can handle a maximum fifteen
detected failure conditions.
 OP is to be connected to a WDEVMNT DFB in case device management functions are required.

EIO0000001107 05/2020 47
WMOTOR

48 EIO0000001107 05/2020
 EcoStruxure™ Process Expert WWW Library
WMOT1D2S
EIO0000001107 05/2020

Chapter 4
WMOT1D2S: One-direction and Two-speed Motor

WMOT1D2S: One-direction and Two-speed Motor

Overview
This chapter describes the control services provided by the WMOT1D2S DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 50
Description 51
DFB Representation 53
Inputs 54
Outputs 56
Inputs/Outputs 58
Public Variables 62
Usage 66

EIO0000001107 05/2020 49
WMOT1D2S

Introduction

General
The WMOT1D2S DFB controls motors with one direction and two speeds.
The following table describes the main functions of this function block:

Function Description
Control Receives digital feedback signals from field for monitoring and processes
commands from faceplate or from program for device operation by sending digital
signal to field according to defined conditions.
Operation feedback Provides operational feedbacks of the device (motor run/stop and trip) by
processing field digital input signals from MCC.You can optionally select the
number of signals to be processed.
Inoperable motor Enables to monitor the detected failure conditions of the motor.
Generates digital signal to display on faceplate and an alarm in case of inoperable
motor.
You can optionally select the conditions and have an option for individual bypass of
the detected failure conditions.
Detection of not Enables to monitor the confirmation of a detected fault of device feedback when it
confirmed operation is not responded after a predefined elapsed time (SC.TIMEOUT).
After elapsed time, the DFB generates a digital signal to display on the faceplate
and an alarm for acknowledgement by the operator.
You can optionally select the detected failure generation in the DFB.
Manual resetting Allows you to reset manually after the detection of an inoperable device condition
or a not confirmed operation and thereby moving motor to the current set point.
Local and remote set Enables you to control the module with a set point that is determined through a set
point (Program mode) point selector (local or remote). The local set point is assigned to the sequential
control or to the command received from the monitoring system while the remote
set point is assigned to the module control from the logic implemented in the
continuous control.
Interlocking The DFB gives the motor a command to move to the defined position(run with
speed1/run with speed2 /stop) if an active interlock that requires this move is
detected.
An interlock bypass function is available to bypass individual active interlock
conditions.
Owner selection Defines the ownership of the control from the module. The control whether remains
with operator or Program to generate commands for operation.
Simulation You can switch the function block to Simulation mode where the feedback signals
are simulated, and confirm the normal operation of the function block. The field
feedback signals are bypassed in this case. Output to field is configured as per
project constant variable (OPSImEN). For detail refer to Simulation (see page 30).
Load shedding The function block supports energy management of motors in the Program mode
management by load shedding.

50 EIO0000001107 05/2020
 WMOT1D2S

Description

Introduction
The WMOT1D2S DFB controls one-direction and two-speed motor.
It supports the following modes of motor control:
 Operator mode - Click the required buttons to start/stop the motor in speed 1/speed 2 from the
faceplate.
 Program mode - There are two internal modes: Remote and Local.
In Program - Remote mode, use RSP input pin to start/stop the motor in speed 1/speed 2. Set
the variable SC.REM to enable the Program - Remote mode.
In Program - Local mode, use the LSP public variable to start/stop the motor. Reset the public
variable SC.REM to enable the Program - Local mode.
 Local mode - The motor is directly controlled by the local electrical panel but not by the PLC, so
the DFB outputs are reset.

Functional Description
The motor run output pins MOP1 or MOP2 is to be connected to a digital output card, which is to be
connected to the contactor/circuit breaker.
The DFB monitors the run feedback through the input pins ZSH1 or ZSH2, which can be connected
to a digital input, wired to the seal-in-contact of the contactor or circuit breaker.
You have the provision to enable/disable the run feedback monitoring regardless of the modes
through the variable SC.ZSHEN. The delay for monitoring the run feedback is set in SC.TIMEOUT.
The DFB monitors the detected failure conditions through the input pins FAIL1 and FAIL2. If this
input is set to 1, it indicates that the DFB has a detected failure condition. This sets the output pins
FAILD1 and FAILD2. In case, it is required to reset output pins MOP1/MOP2, the same input is also
to be connected to S1LOCKED/S2LOCKED.
The DFB monitors the interlock conditions through the input pin ILCK. If this input is set to 1, it
indicates that the DFB has detected an active interlock condition. This sets the output pin ILCKD,
and resets the output pins MOP1/MOP2. If there are more than one detected failure/interlock
conditions, use WCONDSUM DFB along with WMOT1D2S DFB.
Connect the detected failure/interlock conditions to the input pins of WCONDSUM DFBs, and connect
the output pin RESULT to the FAIL/ILCK input pins of WMOT1D2S DFB. A provision to bypass the
individual detected failure/interlock condition is also available from faceplate.
This function block monitors the number of starting/running hours of the motor from the last reset
if WDEVMNT DFB is linked to WMOT1D2S DFB. In this case, the variable connected to pin
WDEVMNT_ST has to be connected to input pin DEVMNTST of WMOT1D2S DFB.
The DFB also supports the Simulation mode, which is a pre-commissioning mode where you can
test the function block without any inputs being monitored.

EIO0000001107 05/2020 51
WMOT1D2S

Click the required button from the faceplate to set the motor to Out of Service mode. If OOS is
activated in running condition, it stops running of the motor.When the motor is set back into Service
mode it acquires the stop condition.
The function block supports the load shedding phenomenon in Program-Remote mode, when the
function block is in Program mode and SC.REM = 1. To handle this phenomenon, set the parameter
SC.PARLDSHED to a particular value. When you set the input pin LDSHED to SC.PARLDSHED value
in Program mode, the outputs of the function block are reset and motor is taken into load shedding.
You can provide a delay for the same from the faceplate.
You can set a priority for sending SMS/speaker output for the individual detected failure/interlock
condition from the faceplate.

52 EIO0000001107 05/2020
 WMOT1D2S

DFB Representation

Overview
This figure shows the FBD representation of the WMOT1D2S DFB.

EIO0000001107 05/2020 53
WMOT1D2S

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the
DFB internal timers are reset and the signals are re-evaluated.
ZSH1 BOOL 1 = Motor running feedback input from field/MCC for direction 1.
ZSH2 BOOL 1 = Motor running feedback input from field/MCC for direction 2.
FAIL1 BOOL 1 = Detected failure in the motor for speed 1.
FAIL2 BOOL 1 = Detected failure in the motor for speed 2.
LOCAL BOOL Local Mode operation
1 = Local mode active
RSPSEL BOOL Enables the selection of operation to be affected through the RSP
when the OWNER is Remote and Program.
 0 = Speed 1
 1 = Speed 2
RSP BOOL Remote set point set by the continuous control.
 0 = Motor stops.
 1 = Motor starts with speed selected through RSPSEL

ILCKSEL BOOL Enables the selection of the operation to be affected through the
ILCKSP set point when the ILCK interlocking signal is activated.
 0 = Speed 1
 1 = Speed 2
ILCKSP BOOL Interlock set point that is used when the function block is interlocked.
 0 = Motor stops.
 1 = Motor starts with speed selected through ILCKSEL.

ILCK BOOL Interlocks the motor at the defined position (run with speed1/run with
speed2/stop).
 0 = Normal condition.
 1 = Interlocked condition.
S1LOCKED BOOL 1 = Locks the speed 1 set point when MOP1 changes from 0 to 1.
S2LOCKED BOOL 1 = Locks the speed 2 set point when MOP2 changes from 0 to 1.
EXTCTLD BOOL Indicates if the motor is controlled from outside of the system.
1 = External control
LDSHED WORD Load shedding input.
FCCONDST1 WCONDSUM_ST_DDT DDT for Conditional Summary - Structure from WCONDSUM DFB for
FAIL1 (detected failure).

54 EIO0000001107 05/2020
 WMOT1D2S

Parameter Type Description

FCCONDST2 WCONDSUM_ST_DDT DDT for Conditional Summary - Structure from WCONDSUM DFB for
FAIL2 (detected failure).
ILCKCONDST WCONDSUM_ST_DDT DDT for Conditional Summary - Structure from WCONDSUM DFB for
ILCK (interlock).
DEVMNTST WDEVMNT_ST_DDT DDT for Conditional Summary - Structure from WDEVMNTST DFB for
DEVMNT (device maintenance).

EIO0000001107 05/2020 55
WMOT1D2S

Outputs

Output Parameter Description

Parameter Type Description

MOP1 BOOL Command signal for motor when speed 1 is selected.
 0 = Motor Stop command.
 1 = Motor Start command at speed 1.
MOP2 BOOL Command signal for motor when speed 2 is selected.
 0 = Motor Stop command.
 1 = Motor Start command at speed 2.
S1SELD BOOL 1 = Current set point for speed 1 is ON
S2SELD BOOL 1 = Current set point for speed 2 is ON
RUNNING1 BOOL Allows to determine whether the motor has reached the position
corresponding to set point SP = 1 and SPSEL = 0 (for speed 1).
1 = Motor running in speed 1.
RUNNING2 BOOL Allows to determine whether the motor has reached the position
corresponding to set point SP = 1 and SPSEL = 1 (for speed 2).
1 = Motor running in speed 2.
ZSH1POS BOOL 1 = Switching operation corresponding to the SP = 1 and SPSEL = 0
set point is confirmed.
ZSH2POS BOOL 1 = Switching operation corresponding to the SP = 1 and SPSEL = 1
set point is confirmed.
ALARM1 BOOL 1 = Active alarm for detection of not confirmed operation in the function
block for speed 1.
ALARM2 BOOL 1 = Active alarm for detection of not confirmed operation in the function
block for speed 2.
FAILD1 BOOL 1 = Indicates motor inoperable condition in speed 1.
FAILD2 BOOL 1 = Indicates motor inoperable condition in speed 2.
UNPOS BOOL  0 = Enables both speeds
 1 = Enables one speed
STOPPED BOOL 1 = Motor is stopped.
OOS BOOL Determines whether the motor is Out of Service or in operation.
 0 = In operation
 1 = Out of Service
SPEAKER BOOL Activates audible alarming system.
1 = Output to activate audible alarming system is ON.
SMS BOOL 1 = Output for messaging alarm is ON
SMSPRI INT Priority level for messaging SMS.

56 EIO0000001107 05/2020
 WMOT1D2S

The below truth table shows the MOPx (x = 1 or 2) (output pin) value whenever there is a detected
failure (FAILx = 1), which are dependent on the configurable public parameters SC.FAILxEN and
SC.FAILREARMEN.

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

SC.FAILEN public SC.FAILREARMEN MOPx output when FAILx = 1 MOPx output when FAILx = 1
variable public variable (assume OP = 1 before the (assume MOPx = 0 before the
detected failure) detected failure)
0 0 1 0
0 1 1 0
1 0 1 0
1 1 0 0
x = 1 or 2

EIO0000001107 05/2020 57
WMOT1D2S

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WMOT1D2S_ST WMOT1D2S_ST_DDT Function block status handles data structure
(communication with Supervision)

Other DDTs which are used with WMOT1D2S DFB block in function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WMOT1D2S_ST_DDT Type
The following table describes the structure of the derived data type WMOT1D2S_ST_DDT for the
WMOT1D2S function block:

Name Type Description

LSDELAY UINT Load shedding delay.
SPW WORD Word containing the status bits of detected failure condition 1 for speaker output.
SMSW WORD Word containing the status bits of detected failure condition 1 for SMS output.
FSMSPRI1...15 INT SMS priority of 1...15 detected failure conditions (FAIL1).
RHPREWARN DINT Pre alert for running hours counter.
SPRHCNT DINT Set point for running hours counter.
OCPREWARN DINT Pre alert for operation counter.
SPMCNT DINT Set point for operation counter.
TCPREWARN INT Pre alert for time counter.
SPTC INT Set point for time counter.
LOCAL WORD Indicates Local mode.
ISPW WORD Word containing the status bits of interlock conditions for speaker output.
ISMSW WORD Word containing the status bits of interlock conditions for SMS output.
ISMSPRI1...15 INT SMS priority of 1...15 interlock conditions.
SEL UINT Selection for Maintenance modes.
F2SPW WORD Word containing the status bits of detected failure condition 2 for speaker output.
F2SMSW WORD Word containing the status bits of detected failure condition 2 for SMS output.
F2SMSPRI1...15 INT SMS priority of 1...15 detected failure conditions (FAIL2).
OPMODE INT Operation mode defined in the faceplate.

58 EIO0000001107 05/2020
 WMOT1D2S

Name Type Description

STW WORD Monitors the motor status. Stores the data in the word in a bitwise format.
CFGW WORD Provides the means to control the motor from the monitoring subsystem.
ALW WORD Provides information on alarms and alerts.
OHLUM DINT Operating hours left until maintenance of running hour.
OLUM DINT Operations left until maintenance of operations counter.
NXTMNT INT Next maintenance time counter.

WMOT1DS2_ST.STW Word Structure

STW element provides a means to monitor the status, usually from the monitoring subsystem
(Supervision).
Bit description of the STW element:

Bit Name Description

0 ZSH1POS Indicates whether the switching operation in speed 1 corresponding to the SP = 1 and output
SPSEL = 0 set point is confirmed.
For detailed description, refer to Outputs (see page 56).
1 ZSH2POS Indicates whether the switching operation in speed 2 corresponding to the SP = 1 and output
SPSEL = 1 set point is confirmed.
For detailed description, refer to Outputs (see page 56).
2 UNPOS Indicates that only 1 speed is enabled, that is, ZSH1EN‚ ZSH2EN.
For detailed description, refer to Outputs (see page 56).
4 MOP1 Command signal for motor when speed 1 is selected.
 1 = Motor Start command at speed 1

For detailed description, refer to Outputs (see page 56).

5 MOP2 Command signal for motor when speed 2 is selected.
 1 = Motor Start command at speed 2

For detailed description, refer to Outputs (see page 56).

6 REM Motor status. Indicates whether the current set point (SP) is local (0) or remote (1). When the
owner is Operator (OWNER = 1), the set point is always local. When the owner is Program (OWNER
= 0), the set point is selected with the SC.REM public signal (1: Remote and 0: Local).
7 ILCK Interlocks the device at the defined position.
 0 = Normal condition.
 1 = Interlocked condition.

8 REARMR Allows you to reset the motor (1). The function block sets the signal to 0 after each run and sets
the signal indicating that resetting is required (CFGW.REARM) to 0.
9 EXTCTLD Indicates if the motor is controlled from outside of the system.
 1 = External control

For detailed description, refer to Outputs (see page 56).

EIO0000001107 05/2020 59
WMOT1D2S

Bit Name Description

10 ALARM1 Alarm for detection of not confirmed operation for speed 1
For detailed description, refer to Outputs (see page 56).
11 ALARM2 Alarm for detection of not confirmed operation for speed 2
For detailed description, refer to Outputs (see page 56).
12 FAILD1 1=Indicates motor inoperable condition in speed 1.
For detailed description, refer to Outputs (see page 56).
13 FAILD2 1=Indicates motor inoperable condition in speed 2.
For detailed description, refer to Outputs (see page 56).
14 S1LOCKED Indicates the activation of speed 1 set point, which is blocked when MOP1 changes from 0 to 1.
15 S2LOCKED Indicates the activation of speed 2 set point, which is blocked when MOP2 changes from 0 to 1.

WMOT1D2S_ST.CFGW Word Structure

CFGW element provides a means to control the function block, usually from the monitoring
subsystem (Supervision).
Bit description of the CFGW element:

Bit Name Description

0 OWNER Enables you to configure whether the set point is determined by the Program (0) or the Operator (1).
1 ILCKBP Allows you to bypass (1) the interlock.
2 SIMMD Enables you to place the motor in Simulation mode, so that the actual confirmation signals (ZSHx
inputs) are ignored, and both the operation confirmations and the non-existence of motor detected
failure are simulated.
3 REARM Manual Reset command (value 1) for resetting active detected failures/alarms.
4 LSPSEL Enables you to select the actuator, which is affected by the operators local set point (OWNER = 1)
from the monitoring subsystem (0 corresponds to the speed 1 and 1 corresponds to the speed 2).
If the selection is set by the Program (OWNER = 0), the function block continuously assigns it the
value of the current selection.
5 LSP Allows the operators local set point (OWNER = 1) to be set from the monitoring subsystem. If the set
point is set by the Program (OWNER = 0), the function block continuously assigns it the value of the
current set point.
12 ENEHWARN Enables alert/pre alert for running hours.
13 ENOCWARN Enables alert/pre alert for operation counter.
14 ENTCWARN Enables alert/pre alert for time counter.
15 OOS Enables you to define whether the equipment is in Out of Service mode (1) or in Operational (0)
mode.
For detailed description, refer to Outputs (see page 56).

60 EIO0000001107 05/2020
 WMOT1D2S

WMOT1D2S_ST.ALW Word Structure

ALW element provides a means to create the alarms, usually from the monitoring subsystem
(Supervision).
NOTE: Alert/alarm is generated when corresponding bits of ALW element are HIGH.
Bit description of the ALW element:

Bit Name Description

1 ALARM1 Alarm for detection of not confirmed operation for speed 1.
2 ALARM2 Alarm for detection of not confirmed operation for speed 2.
3 FAILD1 Alarm active when speed 1 is selected and field motor is inoperable.
4 FAILD2 Alarm active when speed 2 is selected and field motor is inoperable.
5 LSWARN Alert for load shedding.
6 OPWARN Alert for Operation mode.
7 RHPREWARN Pre alert for running hours counter.
8 RHWARN Alert for running hours counter.
9 OCPREWARN Pre alert for operations counter.
10 OCWARN Alert for operations counter.
11 TCPREWARN Pre alert for time counter.
12 TCWARN Alert for time counter.

EIO0000001107 05/2020 61
WMOT1D2S

Public Variables

Public Variable Description

Variable Type Description

SC WMOT1D2S_SC_DDT Function block configuration and control data structure

WMOT1D2S_SC_DDT Type
The following table describes the structure of the derived data type WMOT1D2S_SC_DDT of the
WMOT1D2S function block:

Name Type Description

PARLDSHED WORD Read/write access.
Parameter for load shedding delay.
EXTCTLD BOOL Read-only access.
1 = Input pin EXTCTLD is high.
For detailed description, refer to Outputs (see page 56).
REM BOOL Read/write access.
Allows the function block to be configured as local set point (LSP) or remote
set point (RSP).
 0 = Local set point
 1 = Remote set point
LSPSEL BOOL Read/write access.
Enables the sequential control to select the operation to be affected by the
local set point if the owner is the Program (OWNER = 0) and the selected set
point is local (REM = 0).
 0 = Speed 1
 1 = Speed 2
LSP BOOL Read/write access.
 0 = Copies the current set point (SP output) continuously to this variable.
 1 = 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 =
0).
MOP1 BOOL Read-only access.
Command signal for motor when speed 1 is selected.
 0 = Motor Stop command
 1 = Motor Start command at speed 1

For detailed description, refer to Outputs (see page 56).

62 EIO0000001107 05/2020
 WMOT1D2S

Name Type Description

MOP2 BOOL Read-only access.
Command signal for motor when speed 2 is selected.
 0 = Motor Stop command.
 1 = Motor Start command at speed 2.

For detailed description, refer to Outputs (see page 56).

S1SELD BOOL Read-only access.
Current set point status when speed 1 is selected.
1 = Current set point for speed 1 is ON.
For detailed description, refer to Outputs (see page 56).
S2SELD BOOL Read-only access.
Current set point status when speed 2 is selected.
1 = Current set point for speed 2 is ON.
For detailed description, refer to Outputs (see page 56).
RUNNING1 BOOL Read-only access.
Allows to determine whether the motor is reached the position corresponding
to set point SP = 1 and SPSEL = 0 (for speed 1).
 0 = Motor not running
 1 = Motor running in speed 1.

For detailed description, refer to Outputs (see page 56).

RUNNING2 BOOL Read-only access.
Allows to determine whether the motor is reached the position corresponding
to set point SP = 1 and SPSEL = 0 (for speed 2).
 0 = Motor not running.
 1 = Motor running in speed 2.

For detailed description, refer to Outputs (see page 56).

ZSH1POS BOOL Read-only access.
1 = Switching operation corresponding to the SP = 1 and SPSEL = 0 set point
is confirmed.
For detailed description, refer to Outputs (see page 56).
ZSH2POS BOOL Read-only access.
1 = Switching operation corresponding to the SP = 1 and SPSEL = 1 set point
is confirmed.
For detailed description, refer to Outputs (see page 56).
STOPPED BOOL Read-only access.
1 = Motor is stopped.
For detailed description, refer to Outputs (see page 56).
UNPOS BOOL Read-only access.
 0 = Enables one speed.
 1 = Enables both speed.

For detailed description, refer to Outputs (see page 56).

EIO0000001107 05/2020 63
WMOT1D2S

Name Type Description

ALARM1 BOOL Read-only access.
1 = Active alarm for detection of not confirmed operation in the block for speed
1.
For detailed description, refer to Outputs (see page 56).
ALARM2 BOOL Read-only access.
1 = Active alarm for detection of not confirmed operation in the block for speed
2.
For detailed description, refer to Outputs (see page 56).
FAILD1 BOOL Read-only access.
1 = Alarm comes when speed 1 is selected and field motor is inoperable.
For detailed description, refer to Outputs (see page 56).
FAILD2 BOOL Read-only access.
1 = Alarm comes when speed 2 is selected and field motor is inoperable.
For detailed description, refer to Outputs (see page 56).
REARMR BOOL Read-only access.
1 = Requires manual resetting on any detected failure in the function block.
ILCKD BOOL Read-only access.
The signal is evaluated based on the ILCK input and the
WMOT1D2S_ST.CFGW.ILCKBP input/output.
1 = Block is interlocked.
OWNER BOOL Read-only access.
 0 = Owner for block operation is Program
 1 = Owner for block operation is Operator
S1LOCKED BOOL Read-only access.
1 = Blocks speed 1 set point to be blocked when MOP1 changes from 0 to 1.
For detailed description, refer to Outputs (see page 56).
S2LOCKED BOOL 1 = Blocks speed 2 set point to be blocked when MOP2 changes from 0 to 1.
For detailed description, refer to Outputs (see page 56).
OOS BOOL Read-only access.
Determines whether the motor is Out of Service or in operation.
 0 = In operation
 1 = Out of Service

For detailed description, refer to Outputs (see page 56).

TIMEOUT TIME Read/write access.
Enables the configuration of time (ms) during which confirmation alarm
monitoring is disabled. The value 0 disables confirmation alarm monitoring.
SCANTIME TIME Read/write access.
Enables the configuration of time (ms) during which alarm signals are kept
active. Allows the monitoring subsystem to acquire the data for alarms that are
automatically reset.
ZSH1EN BOOL Read/write access.
1 = Enables confirmation monitoring for speed 1 switching operation.

64 EIO0000001107 05/2020
 WMOT1D2S

Name Type Description

ZSH2EN BOOL Read/write access.
1 = Enables confirmation monitoring for speed 2 switching operation.
FAIL1EN BOOL Read/write access.
1 = Enables monitoring for detected failure 1.
FAIL2EN BOOL Read/write access.
1 = Enables monitoring for detected failure 2.
CONFREARMEN BOOL Read/write access.
 0 = The output MOP1/MOP2 remains in its previous state when a non-
confirmed operation is detected and does not require manual resetting.
 1 = Withdraws the output MOP1/MOP2 when a non-confirmed operation is
detected (ALARM1/ALARM2 = 1) and a mandatory manual resetting is
required.
FAILREARMEN BOOL Read/write access.
 0 = The output MOP1/MOP2 remains in its previous state during detected
failure conditions and does not require manual resetting.
 1 = Withdraws the output MOP1/MOP2 during detected failure conditions
(FAIL1/FAIL2 = 1, SC.FAIL1EN/SC.FAIL2EN = 1) and a mandatory
manual resetting is required once the FAIL condition disappears
(FAIL1/FAIL2 = 0).
TDELAY TIME Read/write access.
Time delay during speed switching.

EIO0000001107 05/2020 65
WMOT1D2S

Usage

Overview
Examples in this manual are given for information only.

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

Based on the options selected, the WMOT1D2S DFB in the application is used for WCONDSUM and
WDEVMNT DFBs to configure the desired functionality for the device.
The following figure is shown as an example for WMOT1D2S DFB.

66 EIO0000001107 05/2020
 WMOT1D2S

The WMOT1D2S DFB requires following external connections:

 A WCONDSUM DFB is to be connected to the ILCK pin which can handle a maximum of fifteen
interlocks.
 A WCONDSUM DFB is to be connected to the FAIL1 pin which can handle a maximum of fifteen
detected failure conditions.
 A WCONDSUM DFB is to be connected to the FAIL2 pin which can handle a maximum of fifteen
detected failure conditions.
 MOP1 or MOP2 is to be connected to a WDEVMNT DFB in case device management functions are
required.

EIO0000001107 05/2020 67
WMOT1D2S

68 EIO0000001107 05/2020
 EcoStruxure™ Process Expert WWW Library
WMOT2D1S
EIO0000001107 05/2020

Chapter 5
WMOT2D1S: Two-direction and One-speed motor

WMOT2D1S: Two-direction and One-speed motor

Overview
This chapter describes the control services provided by WMOT2D1S DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 70
Description 71
DFB Representation 73
Inputs 74
Outputs 75
Inputs/Outputs 77
Public Variables 81
Usage 84

EIO0000001107 05/2020 69
WMOT2D1S

Introduction

General
The WMOT2D1S DFB controls motors with two direction and one speed.
The following table describes the main functions of this function block:

Function Description
Control Receives digital feedback signals from field for monitoring and processes commands
from faceplate or from program for device operation by sending digital signal to field
according to defined conditions.
Operation feedback Provides operational feedbacks of the device (motor run/stop and trip) by processing
field digital input signals from MCC. The number of signals to be processed can be
optionally selected.
Inoperable motor Enables to monitor the detected failure conditions of the motor.
Generates digital signal to display on faceplate and an alarm in case of inoperable
motor.
You can optionally select the conditions and have an option for individual bypass of
the detected failure conditions.
Detection of not Enables to monitor the confirmation of a detected fault of device feedbackwhen it is
confirmed operation not responded after a predefined elapsed time (SC.TIMEOUT).
After elapsed time, the DFB generates a digital signal to display on thefaceplate and
an alarm for acknowledgement by the operator.
You can optionally select the detected failure generation in the DFB.
Manual resetting Allows you to reset manually after the detection of an inoperable motor condition or
a not confirmed operation and thereby moving motor to the current set point.
Local and remote set Enables you to control the module with a set point that is determined through a set
point (Program mode) point selector (local or remote). The local set point is assigned to the sequential
control or to the command received from the monitoring system while the remote set
point is assigned to the module control from the logic implemented in the continuous
control.
Interlocking The DFB gives the motor a command to move to the defined position (run in
direction1/run in direction2/stop) if an active interlock that requires this move is
detected.
An interlock bypass function is available to bypass individual active interlock
conditions.
Owner Defines the ownership of the control from the module. The control whether remains
with supervision operator or Program to generate commands for operation.
Simulation You can switch the function block to Simulation mode where the feedback signals are
simulated, and confirm the normal operation of the function block. The field feedback
signals are bypassed in this case. Output to field is configured as per project constant
variable (OPSImEN). For detail refer to Simulation (see page 30).
Load shedding The function block supports energy management of motors in the Program mode by
management load shedding.

70 EIO0000001107 05/2020
 WMOT2D1S

Description

Introduction
The WMOT2D1S DFB controls two-direction and one-speed motor.
It supports the following modes of motor control:
 Operator mode - Click the required buttons to start/stop the motor in speed 1/speed 2 from the
faceplate.
 Program mode - There are two internal modes: Remote and Local.
In Program - Remote mode, use RSP input pin to start/stop the motor. Set the variable SC.REM
to enable the Program - Remote mode.
In Program - Local mode, use the LSP public variable to start/stop the motor. Reset the public
variable SC.REM to enable the Program - Local mode.
 Local mode - The motor is directly controlled by the local electrical panel but not by the PLC, so
the DFB outputs are reset.

Functional Description
The motor run output pins MMOP1 or MOP2 is to be connected to a digital output card, which is to
be connected to the contactor/circuit breaker.
The DFB monitors the run feedback through the input pins ZSH1 and ZSH2, which can be
connected to a digital input, wired to the seal-in-contact of the contactor or circuit breaker.
You have the provision to enable/disable the run feedback monitoring (regardless of the modes)
through the variable SC.ZSH1EN and SC.ZSH2EN. The delay for monitoring the run feedback is
set in SC.TIMEOUT.
The DFB monitors the detected failure conditions through the input pins FAIL1 and FAIL2. If this
input is set to 1, it indicates that the DFB has a detected failure condition. This sets the output pins
FAILD1 and FAILD2. In case that it is required to reset output pins MOP1/MOP2, the same input is
also to be connected to S1LOCKED/S2LOCKED.
The DFB monitors the interlock conditions through the input pin ILCK. If this input is set to 1, it
indicates that the DFB has detected an active interlock condition. This resets the output pins
MOP1/MOP2. If there are more than one detected failure/interlock conditions, use WCONDSUM DFB
along with WMOT2D1S DFB.
Connect the detected failure/interlock conditions to the input pins of WCONDSUM DFBs, and connect
the output pins RESULT to the FAIL/ILCK input pins of WMOT2D1S DFB. A provision to bypass the
individual detected failure/interlock condition is also available from faceplate.
The DFB monitors the number of starting/running hours of the motor from the last reset if WDEVMNT
DFB is linked to WMOT2D1S DFB. In this case, the variable connected to pin WDEVMNT_ST has to
be connected to input pin DEVMNTST of WMOT2D1S DFB.
The DFB also supports the Simulation mode, which is a pre-commissioning mode where you can
test the function block without any inputs being monitored.

EIO0000001107 05/2020 71
WMOT2D1S

Click the required button from the faceplate to set the motor to Out of Service mode. If OOS is
activated in running condition, it stops running of the motor. When the motor is set back into Service
mode, it acquires the stop condition.
The function block supports the load shedding phenomenon in Program-Remote mode, when the
function block is in Program mode and SC.REM = 1. To support this phenomenon, set the
parameter SC.PARLDSHED to a particular value. When you set the input pin LDSHED to
SC.PARLDSHED value in Program mode, the outputs of the function block are reset and motor is
taken into Load shedding. You can provide a delay for the same from the faceplate.
You can set a priority for sending SMS/speaker output for the individual detected failure/interlock
condition from the faceplate.

72 EIO0000001107 05/2020
 WMOT2D1S

DFB Representation

Overview
The following figure shows the DFB representation of the WMOT2D1S DFB.

EIO0000001107 05/2020 73
WMOT2D1S

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the
DFB internal timers are reset and the signals are re-evaluated.
ZSH1 BOOL 1 = Motor running feedback input from field/MCC for direction 1.
ZSH2 BOOL 1 = Motor running feedback input from field/MCC for direction 2.
FAIL1 BOOL 1 = Detected failure in the device for direction 2.
FAIL2 BOOL 1 = Detected failure in the device for direction 2.
LOCAL BOOL Local Mode operation
1 = Local mode active
RSPSEL BOOL Enables the selection of the operation to be affected through the RSP
when the OWNER is Remote and Program.
 0 = Direction 1.
 1 = Direction 2.
RSP BOOL Remote set point set by the continuous control.
 0 = Motor stops.
 1 = Motor starts in selected direction through RSP.

ILCKSEL BOOL Enables the selection of the operation, which is affected through the
ILCKSP set point when the ILCK interlocking signal is activated.
 0 = Direction 1.
 1 = Direction 2.
ILCKSP BOOL Set point that is used when the function block is interlocked.
 0 = Motor stops.
 1 = Motor starts in direction as per ILCKSEL.

ILCK BOOL Device Interlock - Interlocks the device at the defined position.
 0 = Normal condition.
 1 = Interlocked condition.
S1LOCKED BOOL 1 = Locks the direction 1 set point when MOP1 changes from 0 to 1.
S2LOCKED BOOL 1 = Locks the direction 2 set point when MOP2 changes from 0 to 1.
EXTCTLD BOOL Indicates if the motor is controlled from outside of the system.
1 = External control
LDSHED WORD Load shedding input.
FCCONDST1 WCONDSUM_ST_DDT Structure from WCONDSUM DFB for FAIL1 (detected failure).
FCCONDST2 WCONDSUM_ST_DDT Structure from WCONDSUM DFB for FAIL2 (detected failure).
ILCKCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB or ILCK (interlock).
DEVMNTST WDEVMNT_ST_DDT Structure from WDEVMNTST DFB for DEVMNT (device maintenance).

74 EIO0000001107 05/2020
 WMOT2D1S

Outputs

Output Parameter Description

Parameter Type Description

MOP1 BOOL Command signal for motor when direction 1 is selected.
1 = Motor Start command at direction 1.
MOP2 BOOL Command signal for motor when direction 2 is selected.
1 = Motor Startcommand at direction 2.
S1SELD BOOL 1 = Current set point for direction 1 is ON.
S2SELD BOOL 1 = Current set point for direction 2 is ON.
RUNNING1 BOOL Allows to determine whether the motor is reached the position
corresponding to set point SP = 1 and SPSEL = 0 (for speed 1).
1 = Motor running in direction 1.
RUNNING2 BOOL Allows to determine whether the motor is reached the position
corresponding to set point SP = 1 and SPSEL = 1 (for speed 2).
1 = Motor running in direction 2.
ZSH1POS BOOL 1 = Switching operation corresponding to the SP = 1 and SPSEL = 0
set point is confirmed.
ZSH2POS BOOL 1 = Switching operation corresponding to the SP =1 and SPSEL =1 set
point is confirmed.
ALARM1 BOOL 1 = Active alarm for detection of not confirmed operation in the block
for direction 1.
ALARM2 BOOL 1 = Active alarm for detection of not confirmed operation in the block
for direction 2.
FAILD1 BOOL 1 = Indicates motor inoperable condition in direction 1.
FAILD2 BOOL 1 = Indicates motor inoperable condition in direction 2.
UNPOS BOOL  0 = Enables both speeds
 1 = Enables one speed
STOPPED BOOL 1 = Indicates that motor is stopped
OOS BOOL Determines whether the motor is Out of Service or in operation.
 0 = In operation.
 1 = Out of Service.
SPEAKER BOOL Activates audible alarming system.
1 = Output to activate audible alarming system is ON.
SMS BOOL 1 = Output for messaging alarm is ON.
SMSPRI INT Priority level for messaging SMS.

EIO0000001107 05/2020 75
WMOT2D1S

The below truth table shows the MOPx (x = 1 or 2) (output pin) value whenever there is a detected
failure (FAILx = 1), which are dependent on the configurable public parameters SC.FAILxEN and
SC.FAILREARMEN.

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

SC.FAILEN public SC.FAILREARMEN MOPx output when FAILx = 1 MOPx output when FAILx = 1
variable public variable (assume OP = 1 before the (assume MOPx = 0 before the
detected failure) detected failure)
0 0 1 0
0 1 1 0
1 0 1 0
1 1 0 0
x = 1 or 2

76 EIO0000001107 05/2020
 WMOT2D1S

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WMOT2D1S_ST WMOT2D1S_ST_DDT Function block status handles data structure
(communication with Supervision)

Other DDTs which are used with the WMOT1D2S DFB in function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WMOT2D1S_ST_DDT Type
The following table describes the structure of the derived data type WMOT2D1S_ST_DDT for the
WMOT2D1S function block:

Name Type Description

F2SMSPRI1...15 INT SMS priority of 1...15 detected failure conditions (FAIL2).
OPMODE INT Operation mode defined in the faceplate.
FSMSPRI1...15 INT SMS priority of 1...15 detected failure conditions (FAIL1).
ISMSPRI1...15 INT SMS priority of 1...15 interlock conditions.
LSDELAY UINT Load shedding delay.
RHPREWARN DINT Pre alert for running hours counter.
SPRHCNT DINT Set point for running hours counter.
OCPREWARN DINT Pre alert for operations counter.
SPMCNT DINT Set point for operations counter.
TCPREWARN INT Pre alert for time counter.
SPTC INT Set point for time counter.
SEL UINT Selection for Maintenance modes.
F2SPW WORD Word containing the status bits of detected failure condition 2 for speaker output.
F2SMSW WORD Word containing the status bits of detected failure condition 2 for SMS output.
ISPW WORD Word containing the status bits of interlock conditions for speaker output.
LOCAL WORD Indicates Local mode.
ISMSW WORD Word containing the status bits of interlock conditions for SMS output.
SMSW WORD Word containing the status bits of detected failure condition 1 for SMS output.
SPW WORD Word containing the status bits of detected failure condition 1 for speaker output.

EIO0000001107 05/2020 77
WMOT2D1S

Name Type Description

OHLUM DINT Operating hours left until maintenance of running hour.
OLUM DINT Operations left until maintenance of operations counter.
NXTMNT INT Next maintenance time counter.
STW WORD Monitors the motor status. Stores the data in the word in a bitwise format.
CFGW WORD Provides the means to control the motor from the monitoring subsystem.
ALW WORD Alarm word for alarms and alerts.

WMOT2D1S_ST.STW Word Structure

STW element provides a means to monitor the status, usually from the monitoring subsystem
(Supervision).
Bit description of the STW element:

Bit Name Description

0 ZSH1POS Indicates whether the switching operation in direction 1 corresponding to the SP = 1 and output
SPSEL = 0 set point is confirmed.
For detailed description, refer to Outputs (see page 75).
1 ZSH2POS Indicates whether the switching operation in direction 2 corresponding to the SP = 1 and output
SPSEL = 1 set point is confirmed.
For detailed description, refer to Outputs (see page 75).
2 UNPOS Indicates that only 1 speed is enabled, that is ZSH1EN ≠ ZSH2EN.
For detailed description, refer to Outputs (see page 75).
4 MOP1 Command signal for motor when direction 1 is selected.
 1 = Motor Start command at direction 1

For detailed description, refer to Outputs (see page 75).

5 MOP2 Command signal for motor when direction 2 is selected.
 1 = Motor Start command at direction 2

For detailed description, refer to Outputs (see page 75).

6 REM Motor status. Indicates whether the current set point (SP) is local (0) or remote (1). When the
owner is Operator (OWNER = 1), the set point is always local. When the owner is Program
(OWNER = 0), the set point is selected with the SC.REM public signal (1: Remote and 0: Local).
7 ILCK Interlocks the device at the defined position.
 0 = Normal condition.
 1 = Interlocked condition.

For detailed description, refer to Outputs (see page 75).

8 REARMR Allows you to reset the motor (1). The function block sets the signal to 0 after each run and sets
the signal indicating that resetting is required CFGW.REARM to 0.

78 EIO0000001107 05/2020
 WMOT2D1S

Bit Name Description

9 EXTCTLD Indicates if the motor is controlled from outside of the system.
1 = External control
For detailed description, refer to Outputs (see page 75).
10 ALARM1 1 = Alarm for detection of not confirmed operation for direction 1.
For detailed description, refer to Outputs (see page 75).
11 ALARM2 1 = Alarm for detection of not confirmed operation for direction 2.
For detailed description, refer to Outputs (see page 75).
12 FAILD1 1 = Indicates motor inoperable condition in direction 1.
For detailed description, refer to Outputs (see page 75).
13 FAILD2 1 = Indicates motor inoperable condition in direction 2.
For detailed description, refer to Outputs (see page 75).
14 S1LOCKED Indicates the activation of direction 1 set point to be blocked when MOP1 changes from 0 to 1.
For detailed description, refer to Outputs (see page 75).
15 S2LOCKED Indicates the activation of direction 2 set point to be blocked when MOP2 changes from 0 to 1.
For detailed description, refer to Outputs (see page 75).

WMOT2D1S_ST.CFGW Word Structure

CFGW element provides a means to control the function block, usually from the monitoring
subsystem (Supervision).
Bit description of the CFGW element:

Bit Name Description

0 OWNER Enables you to configure whether the set point is determined by the Program (0) or the Operator (1).
1 ILCKBP Allows you to bypass (1) the interlock.
2 SIMMD Enables you to place the motor in Simulation mode, so that the actual confirmation signals (ZSHx
inputs) are ignored, and both the operation confirmations and the non-existence of motor detected
failure are simulated.
3 REARM Manual Reset command (value 1) for resetting active detected failures/alarms.
4 LSPSEL Enables you to select the motor, which is affected by the operators local set point (OWNER = 1) from
the monitoring subsystem (0 corresponds to the direction 1, and 1 corresponds to the direction 2).
If the selection is set by the Program (OWNER = 0), the function block continuously assigns it the
value of the current selection.
5 LSP Allows the operators to set the local set point (OWNER = 1) from the monitoring subsystem. If the set
point is set by the Program (OWNER = 0), the function block continuously assigns it the value of the
current set point.
12 ENEHWARN Enables alert/pre alert for running hours.
13 ENOCWARN Enables alert/pre alert for operation counter.
14 ENTCWARN Enables alert for time counter.
15 OOS Enables you to define whether the equipment is Out Of Service (1) or operational (0).

EIO0000001107 05/2020 79
WMOT2D1S

WMOT2D1S_ST.ALW Word Structure

ALW element provides a means to create the alarms, usually from the monitoring subsystem
(Supervision).
NOTE: Alert/Alarm will be generated when corresponding bits of ALW element are HIGH.
Bit description of the ALW element:

Bit Name Description

1 ALARM1 Alarm for detection of not confirmed operation when direction 1 is selected.
2 ALARM2 Alarm for detection of not confirmed operation when direction 2 is selected.
3 FAILD1 Alarm active when direction 1 is selected and field motor is inoperable.
4 FAILD2 Alarm active when direction 2 is selected and field motor is inoperable.
5 LSWARN Alert for load shedding.
6 OPWARN Alert for Operation mode.
7 RHPREWARN Pre alert for running hours counter.
8 RHWARN Alert for running hours counter.
9 OCPREWARN Pre alert for operations counter.
10 OCWARN Alert for operations counter.
11 TCPREWARN Pre alert for time counter.
12 TCWARN Alert for time counter.

80 EIO0000001107 05/2020
 WMOT2D1S

Public Variables

Public Variable Description

Variable Type Description

SC WMOT2D1S_SC_DDT Function block configuration and control data structure

WMOT2D1S_SC_DDT Type
The following table describes the structure of the derived data type WMOT2D1S_SC_DDT of the
WMOT2D1S DFB:

Name Type Description

PARLDSHED WORD Read/Write access.
Parameter for load shedding delay.
EXTCTLD BOOL Read only access.
1 = Input pin EXTCTLD is high.
For detailed description, refer to Inputs (see page 74).
REM BOOL Read/Write access. Allows you to configure the function block for a remote set point (RSP =
1) or local set point (LSP = 0).
 0 = Local set point
 1 = Remote set point
LSPSEL BOOL Read/Write access. Enables the sequential control to select the operation, which is affected
by the local set point if the owner is the Program (OWNER = 0) and the selected set point is
local (REM = 0).
 0 = Direction 1
 1 = Direction 2
LSP BOOL Read/Write access.
 0 = Copies the current set-point (SP output) to this variable.
 1 = Enables the sequential control to assign the local se -point if the owner is the
Program (OWNER is 0), and the selected set point is Local (SC.REM is 0).
MOP1 BOOL Read only access. Command signal for motor when direction 1 is selected.
 0 = Motor Stop command
 1 = Motor Start command at direction 1 is selected

For detailed description, refer to Outputs (see page 75).

MOP2 BOOL Read only access. Command signal for motor when direction 2 is selected.
 0 = Motor Stop command
 1 = Motor Start command at direction 2 is selected

For detailed description, refer to Outputs (see page 75).

S1SELD BOOL Read only access.
1 = Current set point for direction 1 is ON.

EIO0000001107 05/2020 81
WMOT2D1S

Name Type Description

S2SELD BOOL Read only access.
1 = Current set point for direction 2 is ON.
RUNNING1 BOOL Read only access. Allows to determine whether the motor is reached the position
corresponding to set point SP = 1 and SPSEL = 0 (for direction 1).
 0 = Motor not running
 1 = Motor running in direction 1

For detailed description, refer to Outputs (see page 75).

RUNNING2 BOOL Read only access. Allows to determine whether the motor is reached the position
corresponding to set point SP = 1 and SPSEL = 0 (for direction 2).
 0 = Motor not running
 1 = Motor running in direction 1

For detailed description, refer to Outputs (see page 75).

ZSH1POS BOOL Read only access.
1 = Switching operation corresponding to the SP = 1 and SPSEL = 0 set point is confirmed.
For detailed description, refer to Outputs (see page 75).
ZSH2POS BOOL Read only access.
1 = Switching operation corresponding to the SP = 1 and SPSEL = 1 set point is confirmed.
For detailed description, refer to Outputs (see page 75).
STOPPED BOOL Read only access. 1 = Motor is stopped.
For detailed description, refer to Outputs (see page 75).
UNPOS BOOL  0 = Enables both direction
 1 = Enables both directions that is ZSH1EN ≠ ZSH2EN

For detailed description, refer to Outputs (see page 75).

ALARM1 BOOL Read only access.
1 = Active alarm for detection of not confirmed operation in the function block for direction 1.
For detailed description, refer to Outputs (see page 75).
ALARM2 BOOL Read only access.
1 = Active alarm for detection of not confirmed operation in the function block for direction 2.
For detailed description, refer to Outputs (see page 75).
FAILD1 BOOL Read only access. Alarm comes when direction 1 is selected and field motor is inoperable.
For detailed description, refer to Outputs (see page 75).
FAILD2 BOOL Read only access. Alarm comes when direction 2 is selected and field motor is inoperable.
For detailed description, refer to Outputs (see page 75).
REARMR BOOL Allows you to reset the motor (1). The function block sets the signal to 0 after each run and
sets the signal indicating that resetting is required CFGW.REARM to 0.
ILCKD BOOL Read only access. The signal is evaluated based on the ILCK input and
WMOT2D1S_ST.CFGW.ILCKBP input/output.
1 = Block is interlocked.

82 EIO0000001107 05/2020
 WMOT2D1S

Name Type Description

OWNER BOOL Read only access.
 0 = Owner for block operation is program
 1 = Owner for block operation is operator
S1LOCKED BOOL Read only access.
1 = Locks the speed 1 set point when MOP1 changes from 0 to 1.
For detailed description, refer to Inputs (see page 74).
S2LOCKED BOOL Read only access.
1 = Locks the speed 1 set point when MOP2 changes from 0 to 1.
For detailed description, refer to Inputs (see page 74).
OOS BOOL Read only access. Determines whether the motor is Out Of Service or in operation.
For detailed description, refer to Outputs (see page 75).
TIMEOUT TIME Read/Write access. Enables the configuration of time (ms) during which confirmation alarm
monitoring is disabled. The value 0 disables confirmation alarm monitoring.
SCANTIME TIME Read/Write access. Enables the configuration of time (ms) during which alarm signals are
kept active. Allows the monitoring subsystem to acquire the data for alarms that are
automatically reset.
ZSH1EN BOOL Read/Write access. Enables monitoring for switching operation confirmation (ZSH1)
ZSH2EN BOOL Read/Write access.
1 = Enables monitoring for switching operation confirmation (ZSH2)
FAIL1EN BOOL Read/Write access.
1 = Enables monitoring for detected failure (FAIL1)
FAIL2EN BOOL Read/Write access.
1 = Enables monitoring for detected failure (FAIL2)
CONFREARMEN BOOL Read/Write access.
 0 = The output MOP1/MOP2 remains in its previous state when a non-confirmed operation
is detected and does not require manual resetting.
 1 = Withdraws the output MOP1/MOP2 when a non-confirmed operation is detected
(ALARM1/ALARM2 = 1) and a mandatory manual resetting is required.
FAILREARMEN BOOL Read/Write access.
 0 = The output MOP1/MOP2 remains in its previous state during detected failure
conditions and does not require manual resetting.
 1 = Withdraws the output MOP1/MOP2 during failure conditions (FAIL1/FAIL2 = 1,
SC.FAIL1EN/
SC.FAIL2EN = 1) and a mandatory manual resetting is required once the FAIL condition
disappears (FAIL1/FAIL2 = 0).
TDELAY TIME Read/Write access.
Time delay during speed switching.

EIO0000001107 05/2020 83
WMOT2D1S

Usage

Overview
Examples in this manual are given for information only.

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

Based on the options selected, the WMOT2D1S DFB in the application is used for WCONDSUM and
WDEVMNT DFBs to configure the desired functionality for the device.
The following figure is shown as an example for WMOT2D1S DFB.

84 EIO0000001107 05/2020
 WMOT2D1S

The WMOT2D1S DFB requires following external connections:

 The WCONDSUM DFB is to be connected to the ILCK pin which can handle a maximum of fifteen
interlocks.
 The WCONDSUM DFB is to be connected to the FAIL1 pin which can handle a maximum of fifteen
diagnostic conditions.
 The WCONDSUM DFB is to be connected to the FAIL2 pin which can handle a maximum fifteen
diagnostic conditions.
 MOP1 or MOP2 is to be connected to a WDEVMNT DFB in case device management functions are
required.

EIO0000001107 05/2020 85
WMOT2D1S

86 EIO0000001107 05/2020
 EcoStruxure™ Process Expert WWW Library
WMOTORVS
EIO0000001107 05/2020

Chapter 6
WMOTORVS

WMOTORVS

Overview
This chapter describes the control services provided by WMOTORVS DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 88
Description 89
DFB Representation 90
Inputs 91
Outputs 93
Inputs/Outputs 95
Public Variables 99
Usage 102

EIO0000001107 05/2020 87
WMOTORVS

Introduction

General
The WMOTORVS DFB manages the control modules for motors with a variable speed drive, whether
the speed driver is switched through communications, I/O wiring, or a mixture of both.
This table describes the main functions of this function block:

Function Description
Control Controls the motor in forward/reverse rotation direction.
Multispeed Enables you to select between speeds. Configurable through an analog
signal or between three preset speeds in the speed driver.
Position detection Controls and determines the real position of the element through up to two
limit switches or configurable digital detectors.
Local and remote set point Enables you to control the module with a set point determined through a set
point selector (local or remote).
The local set point is assigned to the sequential control, or to the command
received from the monitoring system. While the remote set point is assigned
to the module control from the logic implemented in the continuous control.
Manual resetting Allows you to reset manually after the detection of an inoperable motor
condition or a not confirmed operation and thereby moving motor to the
current set point.
Interlocking The DFB gives the motor a command to move to the defined position
(run/stop) with speed if an active interlock that requires this move is detected.
An interlock bypass function is available to bypass individual active interlock
conditions.
Detection of not confirmed Enables to monitor the detected fault of motor feedback confirmation when it
operation is not responded after a predefined elapsed time (SC.TIMEOUT).
After elapsed time, the DFB generates a digital signal to display on the
faceplate and an alarm for acknowledgement by the operator.
You can optionally select the detected failure generation in the DFB.
Inoperable motor A digital signal enables the operator to determine if the monitored control
module is in detected error condition mode.
Used for detecting if the motor switch is tripped due to thermal overload.
Owner Defines the ownership of the control from the module. The control whether
remains with supervision operator or Program to generate commands for
operation.
Simulation You can switch the function block to Simulation mode where the feedback
signals are simulated, and confirm the normal operation of the function block.
The field feedback signals are bypassed in this case. Output to field is
configured as per project constant variable (OPSImEN). For detail refer to
Simulation (see page 30).
Load shedding management The function block supports energy management of motors in the Program
mode by load shedding.

88 EIO0000001107 05/2020
 WMOTORVS

Description

Overview
The WMOTORVS DFB controls the motors with a variable-speed drive, regardless of whether the
speed driver is switched through communications, I/O wiring, or a combination of both.
The DFB controls the associated devices from the sequential control, continuous control, and/or
monitoring subsystem, depending on their configuration and on the needs of the system.
NOTE: you can use this module with the WDEVMNT module to add functions for operating hours,
switching operation and maintenance of the device.

EIO0000001107 05/2020 89
WMOTORVS

DFB Representation

Overview
This figure shows the FBD representation of the WMOTORVS DFB.

90 EIO0000001107 05/2020
 WMOTORVS

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the DFB internal
timers are reset and the signals are re-evaluated.
PV REAL Current value of the speed measurement. This comes from the speed driver or
from a measurement instrument.
RUN BOOL 1 = Speed driver is generating an output frequency.
POWERRMVL BOOL Indicates that the speed driver is disabled (power removal).
 0 = Speed driver in operating conditions
 1 = Disables speed driver that provides an output.

After activating this signal, the system requires resetting

(WSDDEVCTLST.CFGW.REARM = 1).
The system uses the POWERMVL signal of the speed driver without required
resetting and wire it to a CONDSUM DFB input that does not require resetting and
the output to the ILCK input.
FAIL BOOL Indicates if the speed driver has a diagnostic condition.
 0 = Normal status
 1 = Active error detected

Used to connect the digital thermal trip input of a motor switch.

LOCAL BOOL Local Mode operation
1 = Local mode active
S1 REAL Enables the availability of the multispeed set point x (value of the signal other
than 0) to be enabled to 1.
The speed configured on the speed driver as S1 is reported to the monitoring
subsystem.
S2 REAL Enables the availability of the multispeed set point x (value of the signal other
than 0) to be enabled to 1.
The speed configured on the speed driver as S2 is reported to the monitoring
subsystem.
S3 REAL Enables the availability of the multispeed set point x (value of the signal other
than 0) to be enabled to 1.
The speed configured on the speed driver as S3 is reported to the monitoring
subsystem.

EIO0000001107 05/2020 91
WMOTORVS

Parameter Type Description

RSPSEL UINT Enables to select which remote set point should be considered in the
Program/Remote mode.
The remote set point is calculated as follows:
The remote set point is:
 0 RSP
 Speed 1 (S1 –configured in the speed drive).
 Speed 2 (S2 –configured in the speed drive).
 Speed 3 (S3 –configured in the speed drive).

NOTE: If the analog set point is selected (xSPSEL = 0) and the signal has
not been enabled (SPEN = 0), the set point indicated by S1 will be considered
as the active set point regardless of its state.
RSPREV BOOL Selects rotation in reverse (1) or forward (0) direction for the remote setpoint in
Program/Remote mode.
RSP REAL Enables the remote speed set point, which is set by the continuous control.
This is to be connected in Program/Remote mode and with the selected SP
speed (RSPSEL = 0).
RSTART BOOL Enables the speed driver to be on run (1) or stop (0) in Program/Remote mode.
ILCKSEL UINT Enables the selection of remote set point, which should be considered in the
case of interlocking.
ILCKREV BOOL  0 = Selects rotation in forward direction when the interlock is activated.
 1 = Selects rotation in reverse direction when the interlock is activated.

Refer to ILCKSEL, ILCKSP, and ILCK values.

ILCKSP REAL Selects rotation in reverse (1) or forward (0) direction when the interlock is
activated.
Refer to ILCKSEL, and ILCK values.
ILCKSTART BOOL Enables to define the interlock position on stop (0) or run (1).
ILCK BOOL Interlocks the device at the defined position.
 0 = Normal condition.
 1 = Interlocked condition.

Refer to ILCKSEL, ILCKSP, and ILCKREV values.

NOTE: The signal connected to this input is not effective of the require device
resetting, but is always de-energized (forward and reverse signals to 0).
EXTCTLD BOOL Indicates if the motor is controlled from outside of the system.
1 = External control
LDSHED WORD Input for load shedding.
FCCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB (FAIL).
ILCKCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB (ILCK).
DEVMNTST WDEVMNT_ST_DDT Structure from WDEVMNTST DFB.

92 EIO0000001107 05/2020
 WMOTORVS

Outputs

Output Parameter Description

Parameter Type Description

DIRECT BOOL 1 = Command signal for forward direction.
REVERSE BOOL 1 = Command signal for reverse/backward direction.
OP REAL Function block command output to field/MCC.
1 = Motor Start command.
SPSELD BOOL 1 = Analog speed set point selected.
S1SELD BOOL 1 = Multispeed 1 is activated in the speed drive.
S2SELD BOOL 1 = Multispeed 2 is activated in the speed drive.
S3SELD BOOL 1 = Multispeed 3 is activated in the speed drive.
SCODE0 BOOL 1 = Multispeed 1 or 3 selected.
SCODE1 BOOL 1 = Multispeed 2 or 3 selected.
RUNNING BOOL 1 = Drive is running.
SP REAL Current speed setpoint in the speed drive.
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 sequentia 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 WSDDEVCTL_ST.CFGW.LSP
and LSPSEL inputs/outputs and the S1, S2,
and S3 inputs.
ALARM BOOL 1 = Alarm active in the DFB.
FAILD BOOL 1 = Inoperable device.
OOS BOOL  0 = Motor is in operation.
 1 = Motor is out of service.
SPEAKER BOOL Activates audible alarming system.
1 = Output to activate audible alarming system is ON.
SMS BOOL 1 = Output for messaging alarm active.
SMSPRI BOOL Priority level for messaging SMS.

EIO0000001107 05/2020 93
WMOTORVS

The below truth table shows the OP (output pin) value whenever there is a detected failure (FAIL
= 1), which are dependent on the configurable public parameters SC.FAILEN and
SC.FAILREARMEN.

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

SC.FAILEN public SC.FAILREARMEN OP output when FAIL = 1 OP output when FAIL = 1

variable public variable (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

94 EIO0000001107 05/2020
 WMOTORVS

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WMOTORVS_ST WMOTORVS_ST_DDT Function block status handles data structure (communication
with Supervision)

Other DDTs which are used with WMOTORVS DFB to function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WMOTORVS_ST_DDT Type
This structure contains the DFB control and status data.
This table describes the structure of the derived data type WSDDEVCTL_ST_DDT for the WMOTORVS
DFB.

Name Type Description

STW WORD Provides status of the motor, usually used from the monitoring subsystem, and
allows data to be retained in memory.
CFGW WORD Provides the means to control the motor from the monitoring subsystem.
ALW WORD Alarm word for alarms and alerts.
PV REAL Present value measurement (according to instrument or drive).
SP REAL Current set point.
OP UINT Current command signal.
SPSEL UINT Select the analog set point.
S1 REAL Select the multispeed 1.
S2 REAL Select the multispeed 2.
S3 UINT Select the multispeed 3.
PARLDSHED WORD Parameter for load shedding.
LSDELAY UINT Load shedding delay.
SPW WORD Word containing the status bits of diagnostic conditions for SPEAKER output.
SMSW WORD Word containing the status bits of diagnostic conditions for SMS output.
FSMSPRI1...15 INT SMS priority of 1...15 diagnostic conditions.
RHPREWARN DINT Pre alert for running hours counter.
SPRHCNT DINT Set point for running hours counter.

EIO0000001107 05/2020 95
WMOTORVS

Name Type Description

OCPREWARN DINT Pre alert for operation counters.
SPMCNT DINT Set point for operation counters.
TCPREWARN INT Pre alert for time counters.
SPTC INT Set point for time counters.
LOCAL WORD Local mode.
ISPW WORD Word containing the status bits of interlock conditions for SPEAKER output.
ISMSW WORD Word containing the status bits of interlock conditions for SMS output.
ISMSPR1...15 INT SMS priority of 1...15 interlock conditions.

WMOTORVS_ST.STW Word Structure

STW element provides a means to monitor the status, usually from the monitoring subsystem (Vijeo
Citect supervision-SCADA).
Bit description of the STW element:

Bit Name Description

0 RUNNING Motor status. Refer to the RUNNING output (see page 93).
1 DIRECT Motor status. Refer to the DIRECT output (see page 93).
2 REVERSE Motor status. Refer to the REVERSE output (see page 93).
3 REVERSEEN Motor status. Refer to the REVERSEEN input (see page 91).
4 ALARM Motor status. Refer to the ALARM output (see page 93).
5 FAILD Motor status. Indicates an inoperable device condition. Refer to the FAILD output (see page 93).
6 REM Motor 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 SDDEVCTL.
7 ILCK Motor status. Refer to the ILCK input (see page 91).
8 REARMR Allows you to reset the motor (1). The function block sets the signal to 0 after each run and sets
the signal indicating that resetting is required CFGW.REARM to 0.
9 EXTCTLD Indicates if the motor is controlled from outside of the system.
1 = External control.
10 SPSELD Motor status. Valid read-only access. Refer to the SPSELD output (see page 93). The current
speed set point is set through continuous set point.
11 S1SELD Motor status. Valid read-only access. Refer to the S1SELD (see page 93).
12 S2SELD Motor status. Valid read-only access. Refer to the S2SELD (see page 93).

96 EIO0000001107 05/2020
 WMOTORVS

Bit Name Description

13 S3SELD Motor status. Valid read-only access. Refer to the S3SELD (see page 93).
14 SPEN Motor status. Valid read-only access. Refer to the SPEN input (see page 91).
15 POWERRMVL Motor status. Valid read-only access. Refer to the POWERRMVL input (see page 91).

WMOTORVS_ST.CFGW Word Structure

CFGW element provides a means to control the DFB, usually from the monitoring subsystem (Vijeo
Citect supervision-SCADA).
Bit description of the CFGW element:

Bit Name Description

0 OWNER Enables you to configure whether the set point is set by the Program (0) or by the
operator (1).
1 ILCKBP Allows you to bypass (1) the interlock.
2 SIMMD Allows motor function block to operate in Simulation mode(value1). Field input feedbacks
are bypassed and motor feedbacks are simulated.
3 REARM Manual Reset command (value 1) for resetting active detected failures/alarms.
4 DIRECTION 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 START/STOP Enables the speed drive to run (1) or stop (0) in the operator mode.
15 OOS Enables you to define whether the equipment is in Out of Service mode (1) or in
Operational (0) mode.

EIO0000001107 05/2020 97
WMOTORVS

WMOTORVS_ST.ALW Word Structure

ALW element provides a means to create the alarms, usually from the monitoring subsystem (Vijeo
Citect supervision-SCADA).
Bit description of the ALW element:

Bit Name Description

1 ALARM Refer to ALARM output (see page 91).
3 FAILD Refer to FAILD output (see page 91).
5 LSWARN 1 = Alert for load shedding.
6 OPWARN 1 = Alert for Operation mode.
7 RHPREWARN 1 = Pre alert for running hours counter.
8 RHWARN 1 = Alert for running hours counter.
9 OCPREWARN 1 = Pre alert for operations counter.
10 OCWARN 1 = Alert for operations counter.
11 TCPREWARN 1 = Pre alert for time counter.
12 TCWARN 1 = Alert for time counter.

98 EIO0000001107 05/2020
 WMOTORVS

Public Variables

Public Variable Description

Variable Type Description

SC WMOTORVS_SC_DDT Function block configuration and control data structure

WMOTORVS_SC_DDT Type
This table describes the structure of the derived data type WSDDEVCTL_SC_DDT of WMOTORVS
DFB:

Name Type Description

SP REAL Read-only access. Current set point
For detailed description, refer to Outputs (see page 93).
OP REAL Read-only access. Current command signal
For detailed description, refer to Outputs (see page 93).
DIRECT BOOL Read-only access.
1 = Command signal for forward direction activated
For detailed description, refer to Outputs (see page 93).
REVERSE BOOL Read-only access.
1 = Command signal for reverse/backward direction activated
For detailed description, refer to Outputs (see page 93).
RUNNING BOOL Read-only access.
1 = Running signal from the drive.
For detailed description, refer to Outputs (see page 93).
ILCKD BOOL Read-only access.
1 = Device is in interlock state.
Owner BOOL Read-only access.
 0 = Owner for DFB operation is program
 1 = Owner for DFB operation is operator
EXTCTLD BOOL Read-only access. Indicates if the motor is controlled from outside of the system.
1 = External control
For detailed description, refer to Inputs (see page 91).
SPSELD BOOL Read-only access.
1 = Analog speed set point selected.
For detailed description, refer to Outputs (see page 93).
S1SELD BOOL Read-only access.
1 = Selects multispeed 1.
For detailed description, refer to Outputs (see page 93).
S2SELD BOOL Read-only access.
1 = Selects multispeed 2.
For detailed description, refer to Outputs (see page 93).

EIO0000001107 05/2020 99
WMOTORVS

Name Type Description

S3SELD BOOL Read-only access.
1 = Selects multispeed 3.
For detailed description, refer to Outputs (see page 93).
POWERRMVL BOOL Read-only access. Voltage signal from the disabled drive.
ALARM BOOL Read-only access.
1 = Detected fault confirmation.
FAILD BOOL Read-only access.
1 = Device fault detected.
For detailed description, refer to Outputs (see page 93).
REM BOOL Read/write access.
Allows the function block to be configured as local set point (LSP) or remote set
point (RSP)
 0 = Selects local mode.
 1 = Selects remote mode.
LSPREV BOOL Read/write access.
 0 = Enables forward direction in Program/Local mode
 1 = Enables reverse direction in Program/Local mode

In other modes, the DFB continuously assigns the current rotation direction set
point to it.
LSTART BOOL Read/write access.
1 = Remote Start command.
LSP BOOL Read/write access.
1 = Selects remote analog set point selected.
SELSP BOOL 1 = Selects analog speed set point 1.
SELS2 BOOL 1 = Selects multispeed 2.
SELS3 BOOL 1 = Selects multispeed 3.
OOS BOOL Indicates Out Of Service.
1 = Motor in Out Of Service
TIMEOUT TIME Read/write access.
Maximum time for position confirmation (0 s: disabled)
1 = Selects reverse direction.
SCANTIME TIME Read/write access.
Minimum time for position confirmation (0 s: disabled)
1 = Selects reverse direction.
RUNEN BOOL Read/write access.
1 = Run signal used.
FAILEN BOOL Read/write access.
1 = Detected fault signal of the device enabled.
SPEN BOOL Read/write access.
1 = Enable speed analog set point.

100 EIO0000001107 05/2020

 WMOTORVS

Name Type Description

CONFREARMEN BOOL Read/write access.
 0 = The output OP remains in its previous state when a non-confirmed
operation is detected and does not require manual resetting.
 1 = Withdraws the output OP when a non-confirmed operation is detected
(ALARM = 1) and a mandatory manual resetting is required.
FAILREARMEN BOOL Read/write access.
 0 = The output OP remains in its previous state during detected failure
conditions and does not require manual resetting.
 1 = Withdraws the output OP during failure conditions (FAIL = 1, FAILEN = 1)
and a mandatory manual resetting is required once the FAIL condition
disappears (FAIL = 0).
REVERSEEN BOOL Read/write access.
1 = Enable reverse/backward direction.
PARALDSHED WORD Read/write access.
Parameter for load shedding

EIO0000001107 05/2020 101

WMOTORVS

Usage

Overview
Examples in this manual are given for information only.

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

Based on the options selected, the WMOTORVS DFB in the application is used for WCONDSUM and
WDEVMNT DFBs to configure the desired functionality for the device..

The WMOTORVS block requires following external connections:

 Connect a WCONDSUM block to the ILCK pin which can handle a maximum of fifteen interlocks.
 Connect a WCONDSUM block to the FAIL pin which can handle a maximum of fifteen diagnostic
conditions.
 Connect the OP pin to a WDEVMNT DFB in case device management functions are required.

102 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WVALVE
EIO0000001107 05/2020

Chapter 7
WVALVE: On/Off Device Type Control Modules

WVALVE: On/Off Device Type Control Modules

Overview
This chapter describes the control services provided by WVALVE DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 104
Description 105
DFB Representation 107
Inputs 108
Outputs 109
Inputs/Outputs 111
Public Variables 114
Usage 117

EIO0000001107 05/2020 103

WVALVE

Introduction

General
The WVALVE DFB manages on-off device type control modules, such as on-off valves -
Electro/Electro-Pneumatic. This is an on-off valve library with 2 limit switches.
The following table describes the main functions of this function block:

Function Description
Control Receives digital feedback signals from field for monitoring and processes commands
from faceplate or from program for device operation by sending digital signal to field
according to defined conditions.
Position feedback A total of 0...2 limit switches or digital detectors (configurable) that determines the actual
position of the element to be controlled are monitored.
Inoperable device Enables to monitor the diagnostic conditions of the device.
Generates digital signal to display on faceplate and an alarm in case of inoperable
condition of valve.
You can optionally select the conditions and have an option for individual bypass of the
diagnostic conditions.
Detection of not Enables to monitor the confirmation of a detected fault of device feedback when it is not
confirmed responded after a predefined elapsed time (SC.TIMEOUT).
operation After elapsed time, the DFB generates a digital signal to display on the faceplate and an
alarm for acknowledgement by the operator.
You can optionally select the detected failure generation in the DFB.
Manual resetting Allows to put the valve in defined/initial position when a detected failure occurs.
You can optionally select the facility.
Local and remote Enables you to control the module with a set point that is determined through a set point
set point (Program selector (local or remote). The local set point is assigned to the sequential control or to
mode) the command received from the monitoring system while the remote set point is assigned
to the module control from the logic implemented in the continuous control.
Interlocking Provides a function to drive the output to put the device onto a defined position
(open/close) when an active interlock is detected.
The function block has a facility to bypass individual active interlock conditions.
Owner selection Defines the ownership of the control from the module. The control whether remains with
operator or Program to generate commands for operation.
Simulation You can switch the function block to Simulation mode where the feedback signals are
simulated, and confirm the normal operation of the function block. The field feedback
signals are bypassed in this case. Output to field is configured as per project constant
variable (OPSImEN). For detail refer to Simulation (see page 30).
Load shedding The function block supports energy management of motors in the Program mode by load
management shedding.

104 EIO0000001107 05/2020

 WVALVE

Description

Functional Description
The WVALVE is an on-off valve library used for managing on-off device type control modules. For
example, electro and electro-pneumatic valves.
It can be programmed in following four ways:
 No limit switches
 Only the close limit switch
 Only the open limit switch
 Both open/close limit switches

The open/close limit switches feedback connected to the digital inputs is connected to DFB input
pins ZSH/ZSL correspondingly.
The limit switches are provided with a feedback supervision through the public variables
SC.ZSHEN and SC.ZSLEN (open/close - enabling/disabling). The delay for monitoring the
open/close feedbacks is set in SC.TIMEOUT.
The DFB output pin OP has to be connected to the digital output card, which is connected to the
solenoid valve/pneumatic actuator (through a relay/relay board if required).
The DFB monitors the detected failure conditions through the input pin FAIL. If this input is set to
1, it indicates that the DFB has a detected failure condition. This sets the output pin FAILD and
resets the output pins OP/SP. If there are more than 1 detected failure conditions, use WCONDSUM
DFB with WVALVE DFB.
The DFB monitors the interlock conditions through the input pin ILCK. If this input is set to 1, it
indicates that the DFB has detected an active interlock condition. This initiates the outputs based
on the selection at DFB input pin ILCKSP. If there are more than 1 interlock conditions, use
WCONDSUM DFB along with WVALVE DFB.
Connect the detected failure/interlock conditions (separately) to the input pins of WCONDSUM DFBs
and connect the output pin RESULT to the FAIL/ILCK input pins of WVALVE DFB. Click the partial
bypass button to bypass the individual detected failure/interlock condition. A provision to bypass
the interlocks is also available from configuration tab.
The DFB monitors the number of open operations from the last reset if WDEVMNT DFB is linked to
WVALVE DFB. In this case, the variable connected to pin WDEVMNT_ST has to be connected to input
pin DEVMNST of WVALVE DFB.
The DFB also supports the Simulation mode, which is a pre-commissioning mode where you can
test the function block without any inputs being monitored.

EIO0000001107 05/2020 105

WVALVE

Click the required button from the faceplate to set the valve to Out of Service mode.
If OOS is activated in open condition, it closes the valve. When the valve is set back into Service
mode, it acquires the close condition.
You can set the priority for sending the SMS/speaker output for the individual detected failure
condition from the faceplate.

106 EIO0000001107 05/2020

 WVALVE

DFB Representation

Overview
This figure shows the FBD representation of the WVALVE function block.

EIO0000001107 05/2020 107

WVALVE

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the
DFB internal timers are reset and the signals are re-evaluated.
ZSH BOOL 1 = Position corresponding to the set point (SP) with a value 1 is
reached.
ZSL BOOL 1 = Position corresponding to the set point (SP) with a value 0 is
reached.
FAIL BOOL Indicates to the DFB a detected error in the device.
1 = Detected error in the device.
LOCAL BOOL Local Mode operation
1 = Local mode active
RSP BOOL Remote set point set by the continuous control.
1 = Valve open.
ILCKSP BOOL Set point that is used when the function block is interlocked.
 0 = Valve closes
 1 = Valve opens
ILCK BOOL Interlocks the device at the defined position.
 0 = Interlock condition
 1 = Normal condition
EXTCTLD BOOL Indicates if the valve is controlled from outside of the system.
1 = External control
FCCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB for (FAIL).
ILCKCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB (ILCK).
DEVMNTST WDEVMNT_ST_DDT Structure from WDEVMNTST DFB.

108 EIO0000001107 05/2020

 WVALVE

Outputs

Output Parameter Description

Parameter Type Description

OP BOOL Function block command output to field/MCC.
1 = Motor Start command.
SP BOOL 1 = Current set point is high.
HIGHPOS BOOL 1 = Device has reached the position corresponding to the set point (SP) with
a value 1.
LOWPOS BOOL 1 = Device has reached the position corresponding to the set point (SP) with
a value 0.
ZSHPOS BOOL 1 = Position corresponding to the set point (SP) with a value of 1 is reached.
ZSLPOS BOOL  0 = Device has not reached the position corresponding to the set
point(SP) with a value of 0.
 1 = Device has reached the position corresponding to the set point (SP)
with a value of 0.
1 = Position corresponding to the set point (SP) with a value of 1 is reached.
ALARM BOOL 1 = Active alarm in the function block for detection of not confirmed
operation.
FAILD BOOL 1 = Active alarm present in the function block for inoperable device.
OOS BOOL Indicates whether the equipment is in Out of Service or operational.
 0 = In operational
 1 = Out of Service
SPEAKER BOOL Activates audible alarming system.
1 = Output to activate audible alarming system is ON.
SMS BOOL 1 = Output for messaging alarm is ON.
SMSPRI INT Priority level for messaging SMS.

EIO0000001107 05/2020 109

WVALVE

The below truth table shows the OP (output pin) value whenever there is a detected failure (FAIL
= 1), which are dependent on the configurable public variables SC.FAILEN and
SC.FAILREARMEN.

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

SC.FAILEN public SC.FAILREARMEN OP output when FAIL = 1 OP output when FAIL = 1

variable public variable (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

110 EIO0000001107 05/2020

 WVALVE

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WVALVE_ST WVALVE_ST_DDT Function block status handles data structure (communication with
Supervision)

Other DDTs which are used with WVALVE DFB to function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WVALVE_ST_DDT Type
The following table describes the structure of the derived data type WVALVE_ST_DDT for the
WVALVE function block:

Name Type Description

STW WORD Provides status of the valve, usually used from the monitoring subsystem and
allows data to be retained in memory
CFGW WORD Provides the means to control the valve from the monitoring subsystem
SPW WORD Word containing the status bits of diagnostic condition 1 for speaker output
SMSW WORD Word containing the status bits of diagnostic condition 1 for SMS output
FSMSPRI1...15 INT SMS priority of 1...15 diagnostic conditions (FAIL)
OCPREWARN DINT Pre alert for operations counters
SPMCNT DINT Set point for operations counters
TCPREWARN INT Pre alert for time counters
SPTC INT Set point for time counters
LOCAL WORD Indicates Local mode
ISPW WORD Word containing the status bits of interlock conditions for speaker output
ISMSW WORD Word containing the status bits of interlock conditions for SMS output
ISMSPRI1...15 INT SMS priority of 1...15 interlock conditions
ALW WORD Alarm word for alarms and notifications
SEL UINT Selection for maintenance modes
OPMODE INT Operation mode defined in the faceplate
OLUM DINT Operations left until maintenance of operations counter
NXTMNT INT Next maintenance time counter

EIO0000001107 05/2020 111

WVALVE

WVALVE_ST.STW Word Structure

STW element provides a means to monitor the status, usually from the monitoring subsystem
(Supervision).
Bit description of the STW element:

Bit Name Description

0 ZSHPOS Indicates if the position corresponding to the set point (SP) with a value 1 is reached.
1 ZSLPOS Indicates if the position corresponding to the set point (SP) with a value 0 is reached.
2 SP Enables the device control signal to be connected. 1 corresponds to the position
determined by the set point (SP) with a value of 1.
3 OP Current set point status.
4 ALARM Alarm for confirmation detected error.
5 FAILD Alarm for valve detected failure.
6 REM Valve status. Indicates whether the current set point (SP) is local (0) or remote (1).
The set point is always local when the owner is the operator (OWNER = 1). When the
owner is Program (OWNER = 0), the set point is selected with the SC.REM public
signal (1: Remote and 0: Local).
7 ILCK Valve status. Interlocks the device at the defined-position.
 0 = Normal condition
 1 = Interlocked condition

8 REARMR Indicates if any detected error is configured in valve status.The valve requires
manual resetting through the CONFREARMEN and/or FAILREARMEN inputs.
9 EXTCTLD Indicates if the motor is controlled from outside of the system.
1 = External control

112 EIO0000001107 05/2020

 WVALVE

WVALVE_ST.CFGW Word Structure

CFGW element provides a means to control the function block, usually from the monitoring
subsystem (Supervision).
Bit description of the CFGW element:

Bit Name Description

1 ALARM Alarm for detection of not confirmed operation.
3 FAILD Alarm for detected failure.
5 LSWARN Alert for load shedding.
6 OPWARN Alert for Operation mode.
7 RHPREWARN Pre alert for running hours counter.
8 RHWARN Alert for running hours counter.
9 OCPREWARN Pre alert for operations counter.
10 OCWARN Alert for operations counter.
11 TCPREWARN Pre alert for time counter.
12 TCWARN Alert for time counter.

WVALVE_ST.ALW Word Structure

ALW element provides a means to create the alarms, usually from the monitoring subsystem (Vijeo
Citect supervision-SCADA).
Bit description of the ALW element:

Bit Name Description

1 ALARM Alarm for detection of not confirmed operation.
3 FAILD Alarm for detected failure.
5 LSWARN Alert for load shedding.
6 OPWARN Alert for Operation mode.
9 OCPREWARN Pre alert for operations counter.
10 OCWARN Alert for operations counter.
11 TCPREWARN Pre alert for time counter.
12 TCWARN Alert for time counter.

EIO0000001107 05/2020 113

WVALVE

Public Variables

Public Variable Description

Variable Type Description

SC WVALVE_SC_DDT Function block configuration and control data structure

WVALVE_SC_DDT Type
The following table describes the structure of the derived data type WVALVE_SC_DDT of the
WVALVE function block:

Name Type Description

EXTCTLD BOOL Read only access.
1 = Input pin EXTCTLD is high.
REM BOOL Read/write access.
 0 = Copies the current set point (SP output) continuously to this variable.
 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, (SC.REM = 0).
LSP BOOL Read/write access.
Allows the function block to be configured as local set point (LSP) or remote set
point (RSP)
 0 = Local set point
 1 = Remote set point
SP BOOL Read only access.
1 = Current set point is high.
For detailed description, refer to Outputs (see page 109).
OP BOOL Read only access.
1 = Current command output is high.
For detailed description, refer to Outputs (see page 109).
HIGHPOS BOOL Read only access.
1 = Device has reached the position corresponding to the set point (SP) with a
value 1.
For detailed description, refer to Outputs (see page 109).
LOWPOS BOOL Read only access.
1 = Device has reached the position corresponding to the set point (SP) with a
value 0.
For detailed description, refer to Outputs (see page 109).
ZSHPOS BOOL Read only access.
1 = Position corresponding to the set point (SP) with a value 1 is reached.
For detailed description, refer to Outputs (see page 109).

114 EIO0000001107 05/2020

 WVALVE

Name Type Description

ZSLPOS BOOL Read only access.
1 = Position corresponding to the set point (SP) with a value 0 is reached.
For detailed description, refer to Outputs (see page 109).
ALARM BOOL Read only access.
1 = Active alarm present in the function block for confirmation.
For detailed description, refer to Outputs (see page 109).
FAILD BOOL Read only access.
1 = Active alarm present in the function block for inoperable device.
For detailed description, refer to Outputs (see page 109).
REARMR BOOL Read only access.
1 = Requires manual resetting required on any detected failure in function block.
ILCKD BOOL Read only access.
The signal is evaluated based on the ILCK input and WVALVE_ST.CFGW.ILCKBP
input/output.
1 = Function block is interlocked.
OWNER BOOL Read only access.
 0 = Owner for block operation is Program
 1 = Owner for block operation is Operator
OOS BOOL Read only access.
Indicates whether the equipment is in Out of Service or Operational mode.
 0 = Operational.
 1 = Out Of Service.

For detailed description, refer to Outputs (see page 109).

TIMEOUT TIME Read/write access.
Enables the configuration of time (ms) during which confirmation alarm monitoring
is disabled. The value 0 disables confirmation alarm monitoring.
SCANTIME TIME Read/write access.
Enables the configuration of time (ms) during which alarm signals are kept active.
Allows the monitoring subsystem to acquire the data for alarms that are
automatically reset.
ZSHEN BOOL Read/write access.
1 = Enables monitoring for switch limit position 1 confirmation.
ZSLEN BOOL Read/write access.
1 = Enables monitoring for switch limit position 0 confirmation.
FAIL1EN BOOL Read/write access.
1 = Enables monitoring of detected failure (FAIL).

EIO0000001107 05/2020 115

WVALVE

Name Type Description

CONFREARMEN BOOL Read/write access.
 0 = The output OP remains in its previous state when a non-confirmed operation
is detected and does not require manual resetting.
 1 = Withdraws the output OP when a non-confirmed operation is detected
(ALARM = 1) and a mandatory manual resetting is required.
FAILREARMEN BOOL Read/write access.
 0 = The output OP remains in its previous state during detected failure
conditions and does not require manual resetting.
 1 = Withdraws the output OP during detected failure conditions (FAIL = 1,
FAILEN = 1) and a mandatory manual resetting is required once the FAIL
condition disappears (FAIL = 0).

116 EIO0000001107 05/2020

 WVALVE

Usage

Overview
Examples in this manual are given for information only.

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

Based on the options selected, the WVALVE DFB in the application is used for WCONDSUM and
WDEVMNT DFB to configure the desired functionality for the device.
The WVALVE DFB is used to manage on-off device type control modules. For example, on-off
valves - electro/electro-pneumatic.
The following figure is shown as an example for WVALVE DFB.

EIO0000001107 05/2020 117

WVALVE

118 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WMVALVE
EIO0000001107 05/2020

Chapter 8
WMVALVE: Motorized Valves with Positioner

WMVALVE: Motorized Valves with Positioner

Overview
This chapter describes the control services provided by WMVALVE DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 120
Description 122
DFB Representation 123
Inputs 124
Outputs 126
Inputs/Outputs 128
Public Variables 131
Usage 133

EIO0000001107 05/2020 119

WMVALVE

Introduction

General
The WMVALVE DFB is used to manage motorized valves with positioner.
The following table describes the main functions of this function block:

Function Description
Control Receives digital feedback signals from field for monitoring and processing of
commands from faceplate, or from program for device operation by sending digital
signal to field according to the defined conditions.
Inoperable device Provides function for detecting and monitoring of detected failure conditions of the
device. Generates digital signal for display on faceplate, and alarm for motor
detected failure. The conditions can be optionally selected and provided with a
provision for individual bypass of the detected failure conditions.
Detection of not Enables to monitor the detected fault of device feedback confirmation when it is
confirmed operation not responded after a predefined elapsed time (SC.TIMEOUT).
After elapsed time, the DFB generates a digital signal to display on the faceplate
and an alarm for acknowledgement by the operator.
You can optionally select the detected failure generation in the DFB.
Manual resetting Optionally, enables you to configure the valve to move to its position and require
manual resetting if the device does not respond or when the monitoring function is
activated.
Local and remote set Enables you to control the module with a set point that is determined through a set
point (Program mode) point selector (local or remote). The local set point is assigned to the sequential
control or to the command received from the monitoring system. While the remote
set point is assigned to the module control from the logic implemented in the
continuous control.
Interlocking Provides a function to drive the output to put the device onto a predefined position
(open/close) when an active interlock is detected.
The function block has a facility to bypass individual active interlock conditions.
Owner Defines the ownership of the control from the module. The control whether remains
with operator or Program to generate commands for operation.
Simulation You can switch the function block to Simulation mode where the feedback signals
are simulated, and confirm the normal operation of the function block. The field
feedback signals are bypassed in this case. Output to field is configured as per
project constant variable (OPSImEN). For detail refer to Simulation (see page 30).

120 EIO0000001107 05/2020

 WMVALVE

Function Description
Step3 control The function block includes and incorporates the functions provided by the Step3
controller from the standard CONT_CTL Unity library.
The operation of the Step3 controller can be interpreted in the below figure.

EIO0000001107 05/2020 121

WMVALVE

Description

Functional Description
The WMVALVE DFB manages motorized valves with positioner and limit switches.
The feedback of the positioner is connected to DFB input pin CHIN through an analog input card.
The configuration required for the positioner feedback is done in DFB input pin RANGE which
consists of DDT elements HIGHRAW, LOWRAW, HIPV, and LOPV.
The open/close limit switches feedback (connected to the digital input card) has to be connected
to DFB input pins ZSH/ZSL correspondingly. The DFB monitors the run feedback of the motor
through the input pins MZSH1/MZSH2 (forward/reverse directions). The delay for monitoring the
open/close feedbacks is set in SC.TIMEOUT.
The DFB output pins MOP1/MOP2 (forward/reverse directions) have to be connected to the digital
output card, which is to be connected to the contactor/circuit breaker.
The DFB monitors the detected failure conditions through the input pin FAIL. If this input is set to
1, it indicates that the DFB has a detected failure condition. This sets the output pin FAILD and
sets the output pin MOP2/MS2SELD until the close limit switch feedback is not received. If there are
more than 1 detected failure conditions, use WCONDSUM DFB with WMVALVE DFB.
The DFB monitors the interlock conditions through the input pin ILCK. If this input is set to 1, it
indicates that the DFB has detected an active interlock condition. This initiates the valve to
open/close based on the DFB ILCKSP input. If there are more than 1 interlock conditions, use
WCONDSUM DFB along with WMVALVE DFB.
Connect the detected failure/interlock conditions (separately) to the input pins of WCONDSUM DFBs
and connect the output pin RESULT to the FAIL/ILCK input pins of WMVALVE DFB. You have a
provision to bypass the interlocks (from faceplate configuration tab).
The DFB monitors the number of open operations from the last reset if WDEVMNT DFB is linked to
WMVALVE DFB. In this case, the variable connected to pin WDEVMNT_ST has to be connected to
input pin DEVMNTST of WMVALVE DFB. The DFB also supports the Simulation mode, which is a pre-
commissioning mode where you can test the function block without monitoring any inputs.

Click the required button from the faceplate to set the valve to Out of Service mode.
If OOS is activated in open condition, it closes the valve. When the valve is set back into Service
mode, it acquires the close condition.
You can set the priority for sending the SMS/speaker output for the individual detected failure
condition from the faceplate.

122 EIO0000001107 05/2020

 WMVALVE

DFB Representation

Overview
This figure shows the FBD representation of the WMVALVE DFB.

EIO0000001107 05/2020 123

WMVALVE

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the
DFB internal timers are reset and the signals are re-evaluated.
CHIN INT Positioner feedback.Usually corresponds to a value coming from an
analog input channel.
CHFAILURE BOOL Indicates if the input channel associated with CHIN is detected with
an inoperable conditon or not.
1 = Channel inoperable.
RANGE WSCALE_DDT Analog range.
 HIRAW - High range (RAW)
 LORAW - Low range (RAW)
 HIPV - High range (PV)
 LOPV - Low range (PV)

BADPV REAL Default value in engineering units (PV output signal) if the channel is
in detected error state.
ZSH BOOL 1 = Position corresponding to the set point (SP) with a value of 1 is
reached.
ZSL BOOL 1 = Position corresponding to the set point (SP) with a value of 0 is
reached.
MZSH1 BOOL 1 = Running confirmation of direction 1.
MZSH2 BOOL 1 = Running confirmation of direction 2.
FAIL BOOL 1 = Inoperable device condition.
LOCAL BOOL Local Mode operation
1 = Local mode active
RSP BOOL Remote set point set by the continuous control.
1 = Valve is open.
PSP REAL Remote set point for position control of the valve.
ILCKSP REAL Set point to be considered when the function block is interlocked.
ILCK BOOL Interlocks the valve at the defined position.
 0 = Normal condition.
 1 = Interlocked condition.
EXTCTLD BOOL Indicates if the motor is controlled from outside of the system.
1 = External control
OPENPOS REAL Minimum value of positioner is considered as valve fully opened.

124 EIO0000001107 05/2020

 WMVALVE

Parameter Type Description

CLOSEDPOS REAL Maximum value of positioner is considered as valve fully closed.
FCCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB for (FAIL).
ILCKCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB (ILCK).
DEVMNTST WDEVMNT_ST_DDT Structure from WDEVMNTST DFB.

EIO0000001107 05/2020 125

WMVALVE

Outputs

Output Parameter Description

Parameter Type Description

MOP1 BOOL 1 = Command signal of motor for direction 1 is ON.
MOP2 BOOL 1 = Command signal of motor for direction 2 is ON.
MS1SELD BOOL 1 = Current setpoint for direction 1 is ON.
MS2SELD BOOL 1 = Current setpoint for direction 2 is ON.
MRUNNING1 BOOL 1 = Motor is running in direction 1.
MRUNNING2 BOOL 1 = Motor is running in direction 2.
MZSH1POS BOOL 1 = Switching operation corresponding to direction 1 is confirmed.
MZSH2POS BOOL 1 = Switching operation corresponding to direction 2 is confirmed.
HIGHPOS BOOL 1 = Device has reached the position corresponding to the set point (SP)
with a value of 1.
LOWPOS BOOL 1 = Device has reached the position corresponding to the set point (SP)
with a value of 0.
ZSHPOS BOOL 1 = Position corresponding to the set point (SP) with a value of 1 is
reached.
ZSLPOS BOOL 1 = Position corresponding to the set point (SP) with a value of 0 is
reached.
SP REAL Current set point is considered by the STEP3 algorithm.
PV REAL Position feedback.
ALARM BOOL 1 = Active Alarm in the function block for detection of not confirmed
operation.
FAILD BOOL 1 = Active alarm present in the function block for inoperable device.
OOS BOOL Indicates whether the equipment is Out Of Service or operational.
 0 = Operational
 1 = Out Of Service
SPEAKER BOOL Activates audible alarming system.
1 = Output to activate audible alarming system is ON.
SMS BOOL 1 = Output for messaging alarm is ON.
SMSPRI INT Priority level for messaging SMS.

126 EIO0000001107 05/2020

 WMVALVE

The below truth table shows the MOPx (output pin) value whenever there is a detected failure (FAIL
= 1), which are dependent on the configurable public parameters SC.FAILEN and
SC.FAILREARMEN.

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

SC.FAILEN input SC.FAILREARMEN input MOPx output when FAIL = 1 MOPx output when FAIL = 1
(assume MOPx = 1 before the (assume MOPx = 0 before the
detected failure) detected failure)
0 0 1 0
0 1 1 0
1 0 0 0
1 1 0 0
x = 1 or 2

EIO0000001107 05/2020 127

WMVALVE

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WMVALVE_ST WMVALVE_ST_DDT Function block status handles data structure (communication
with Supervision.)

Other DDTs which are used with WMVALVE DFB to function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WMVALVE_ST_DDT Type
The following table describes the structure of the derived data type WMVALVE_ST_DDT for the
WMVALVE DFB:

Name Type Description

STW WORD Provides status of the valve, usually used from the monitoring subsystem, and
allows data to be retained in memory.
CFGW WORD Provides the means to control the valve from the monitoring subsystem.
SPW WORD Word containing the status bits of diagnostic condition 1 for speaker output.
SMSW WORD Word containing the status bits of diagnostic condition 1 for SMS output.
FSMSPRI1...15 INT SMS priority of 1...15 diagnostic conditions (FAIL).
OCPREWARN DINT Pre alert for operations counters.
SPMCNT DINT Set point for operations counters.
TCPREWARN INT Pre alert for time counters.
SPTC INT Set point for time counters.
LOCAL WORD Indication for Local mode.
ISPW WORD Word containing the status bits of interlock conditions for speaker output.
ISMSW WORD Word containing the status bits of interlock conditions for SMS output.
ISMSPRI1...15 INT SMS priority of 1...15 interlock conditions.
ALW WORD Alarm word for alarms and notifications.
SEL UINT Selection for maintenance modes.
OPMODE INT Operation mode defined in the faceplate
OLUM DINT Operations left until maintenance of operations counter.
NXTMNT INT Next maintenance time counter.

128 EIO0000001107 05/2020

 WMVALVE

Name Type Description

HYST REAL Hysteresis.
HIDEV 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.
LODEV 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.
TARGSP REAL Target set point.

WMVALVE_ST.STW Word Structure

STW element provides a means to monitor the status, usually from the monitoring subsystem (Vijeo
Citect supervision-SCADA).
Bit description of the STW element:

Bit Name Description

0 ZSHPOS 1 = Indicates if the position corresponding to the set point (SP) with a value of 1 is reached.
1 ZSLPOS 1 = Indicates if the position corresponding to the set point (SP) with a value of 0 is reached.
2 SP 1 = Current set point that is considered by the STEP3 algorithm.
3 PV 1 = Valve position feedback.
4 ALARM 1 = Alarm for inoperable device condition.
5 FAILD 1 = Alarm for valve detected failure.
6 REM Valve status. Indicates whether the current set point (SP) is local (0) or remote (1). The set
point is always local when the owner is the Operator (OWNER = 1). When the owner is
Program (OWNER = 0), the set point is selected with the SC.REM public signal (1: Remote and
0: Local).
7 ILCK Interlocks the device at the defined position.
 0 = Normal condition
 1 = Interlocked condition

8 REARMR 1 = Valve status. Indicates if any detected error is configured, the valve requires manual
resetting (1) the CONFREARMEN and/or FAILREARMEN inputs.
9 EXTCTLD Indicates if the motor is controlled from outside of the system.
1 = External control

EIO0000001107 05/2020 129

WMVALVE

WMVALVE_ST.CFGW Word Structure

CFGW element provides a means to control the function block, usually from the monitoring
subsystem (Vijeo Citect supervision-SCADA).
Bit description of the CFGW element:

Bit Name Description

0 OWNER Enables you to configure whether the set point is determined by the Program (0)
or the Operator (1).
1 ILCKBP 1 = Allows the interlock to be bypassed .
2 SIMMD 1 = Allows to place the valve in Simulation mode so that the actual confirmation
signals (ZSHx inputs) are ignored and both the operation confirmations and the
non-existence of a valve detected failure are simulated.
3 REARM Allows the valve (1) to be reset. The function block sets the signal to 0 after each
run and sets the signal indicating that resetting is required (CFGW.REARM) to 0.
4 LSP 1 = Allows local set point of the operator (OWNER = 1) to be set from the monitoring
subsystem. If the set point is set by the Program (OWNER = 0), the function block
continuously assigns the value of the current set point.
13 ENOCWARN 1 = Enables operation counter alert.
14 ENTCWARN 1 = Enables time counter alert.
15 OOS Out of Service (Allows to define whether the equipment is Out of Service (1) or
operational (0).
For detailed description, refer to Outputs (see page 126).

ST_DDT.ALW Word Structure

ALW element provides a means to create the alarms, usually from the monitoring subsystem (Vijeo
Citect supervision-SCADA).
Bit description of the ALW element:

Bit Name Description

1 ALARM 1 = Alarm for confirmation detected error conditon.
3 FAILD 1 = Alarm for valve detected failure.
5 LSWARN 1 = Alert for load shedding.
6 OPWARN 1 = Alert for Operation mode.
9 OCPREWARN 1 = Pre alert for operations counter.
10 OCWARN 1 = Alert for operations counter.
11 TCPREWARN 1 = Pre alert for time counter.
12 TCWARN 1 = Alert for time counter.

130 EIO0000001107 05/2020

 WMVALVE

Public Variables

Public Variable Description

Variable Type Description

SC WMVALVE_SC_DDT Function block configuration and control data structure

WMVALVE_SC_DDT Type
The following table describes the structure of the derived data type WMVALVE_SC_DDT of the
WMVALVE DFB:

Name Type Description

EXTCTLD BOOL Read only access.
1 = Shows the value of the EXTCTLD input, so that it can be used from the
sequential control.
For detailed description, refer to Inputs (see page 124)
REM BOOL Read/Write access.
1 = Allows the function block to be configured for a remote set point (RSP = 1) or
local set point (LSP = 0).
LSP BOOL Read/Write access.
1 = Enables the sequential control to assign the local set point if the owner is the
Program (OWNER = 0) and the selected set point is Local (REM = 0).
SP BOOL Read only access.
1 = Current set point that is considered by the STEP3 algorithm.
For detailed description, refer to Outputs (see page 126)
HIGHPOS BOOL Read only access.
1 = Determines if the device has reached the position corresponding to the set
point (SP) with a value of 1.
For detailed description, refer to Outputs (see page 126)
LOWPOS BOOL Read only access.
1 = Determines if the device has reached the position corresponding to the set
point (SP) with a value of 0.
For detailed description, refer to Outputs (see page 126)
ZSHPOS BOOL Read only access.
1 = Indicates if the position corresponding to the set point (SP) with a value of 1 is
reached.
For detailed description, refer to Outputs (see page 126)
ZSLPOS BOOL Read only access.
1 = Indicates if the position corresponding to the set point (SP) with a value of 0 is
reached.
For detailed description, refer to Outputs (see page 126)

EIO0000001107 05/2020 131

WMVALVE

Name Type Description

ALARM BOOL Read only access.
1 = Alarm for confirmation detected error.
For detailed description, refer to Outputs (see page 126)
FAILD BOOL Read only access.
1 = Alarm for valve detected failure.
For detailed description, refer to Outputs (see page 126)
REARMR BOOL Read only access.
1 = Valve status. Indicates if any detected error conditon is configured, the valve
requires manual resetting (1) the CONFREARMEN and/or FAILREARMEN inputs.
ILCKD BOOL Read only access.
1 = The signal is evaluated based on the ILCK input and the
WMVALVED_ST.CFGW.ILCKBP input/output.
OWNER BOOL Read only access.
Allows to configure the set point selection.
 0 = Program
 1 = Operator
OOS BOOL Read only access.
For detailed description, refer to Outputs (see page 126)
TIMEOUT TIME Read/write access.
Enables the configuration of time (ms) during which confirmation alarm monitoring
is disabled. The value 0 disables confirmation alarm monitoring.
SCANTIME TIME Read/write access.
Enables the configuration of time (ms) for which alarm signals are kept active.
Allows the monitoring subsystem to acquire the data for alarms that are
automatically reset.
ZSHEN BOOL Read/write access.
1 = Enables switching operation confirmation monitoring (ZSH).
ZSLEN BOOL Read/write access.
1 = Enables switching operation confirmation monitoring (ZSL).
FAILEN BOOL Read/write access.
1 = Enables diagnostic condition monitoring (FAIL).
CONFREARMEN BOOL Read/write access.
 0 = The output MOP1/MOP2 remains in its previous state when a non-confirmed
operation is detected and does not require manual resetting.
 1 = Withdraws the output MOP1/MOP2 when a non-confirmed operation is
detected (ALARM = 1) and a mandatory manual resetting is required.
FAILREARMEN BOOL Read/write access.
1= Enables mandatory manual resetting of the valve during an inoperable
condition.

132 EIO0000001107 05/2020

 WMVALVE

Usage

Overview
Examples in this manual are given for information only.

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

Based on the options selected, the WMVALVE DFB in the application is used for WCONDSUM and
WDEVMNT DFBs to configure the desired functionality for the device.
The WMVALVE library is used to manage motorized valves with positioner.
The following figure is shown as an example for WMVALVE DFB.

EIO0000001107 05/2020 133

WMVALVE

134 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WMVALVED
EIO0000001107 05/2020

Chapter 9
WMVALVED: On/Off Motorized Valve DFB

WMVALVED: On/Off Motorized Valve DFB

Overview
This chapter describes the control services provided by WMVALVED DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 136
Description 137
DFB Representation 138
Inputs 139
Outputs 140
Inputs/Outputs 142
Public Variables 145
Usage 147

EIO0000001107 05/2020 135

WMVALVED

Introduction

General
The WMVALVED DFB manages the on/off motorized valves. This function block controls a
motorized valve or a gate with two limit switches.
The following table describes the main functions of this function block:

Function Description
Control Receives digital feedback signals from field for monitoring and processing of
commands from faceplate, or from program for device operation by sending digital
signal to field according to the defined conditions.
Inoperable device Provides function for detecting and monitoring of inoperable conditions of the device.
Generates digital signal for display on faceplate, and alarm for inoperable device
condition. The conditions can be optionally selected and provided with a provision for
individual bypass of the detected failure conditions.
Detection of not Enables to monitor the detected fault of device feedback confirmation when it is not
confirmed operation responded after a predefined elapsed time (SC.TIMEOUT).
After elapsed time, the DFB generates a digital signal to display on the faceplate and
an alarm for acknowledgement by the operator.
You can optionally select the detected failure generation in the DFB.
Manual resetting Allows you to reset manually after the detection of an inoperable valve condition or a
not confirmed operation and thereby moving the valve to the current set point.
Local and remote set Enables you to control the module with a set point that is determined through a set
point (Program mode) point selector (local or remote). The local set point is assigned to the sequential
control or to the command received from the monitoring system. While the remote
set point is assigned to the module control from the logic implemented in the
continuous control.
Interlocking Provides a function to drive the output to put the device onto a defined position
(open/close) when an active interlock is detected.
The function block has a facility to bypass individual active interlock conditions.
Owner Defines the ownership of the control from the module. The control whether remains
with operator or Program to generate commands for operation.
Simulation You can switch the function block to Simulation mode where the feedback signals are
simulated, and confirm the normal operation of the function block. The field feedback
signals are bypassed in this case. Output to field is configured as per project constant
variable (OPSImEN). For detail refer to Simulation (see page 30).

136 EIO0000001107 05/2020

 WMVALVED

Description

Functional Description
The WMVALVED DFB manages motorized on/off valves.
The open/close limit switches feedback (connected to the digital input card) is to be connected to
DFB input pins ZSH/ZSL correspondingly. The DFB monitors the run feedback of the motor through
the input pins MZSH1/MZSH2 (forward/reverse directions). The delay for monitoring the open/close
feedbacks is set in SC.TIMEOUT.
The DFB output pins MOP1/MOP2 (forward/reverse directions) has to be connected to the digital
output card, which is to be connected to the contactor/circuit breaker. The DFB monitors the
detected failure conditions through the input pin FAIL. If this input is set to 1, it indicates that the
DFB has a detected failure condition. This sets the output pin FAILD and MOP2/MS2SELD until the
close limit switch feedback is not received.
If there are more than 1 detected failure condition, then use WCONDSUM DFB with WMVALVED DFB.
The DFB monitors the interlock conditions through the input pin ILCK. If this input is set to 1, it
indicates that the DFB has detected an active interlock condition. This initiates the valve to
open/close based on the DFB ILCKSP input. If there are more than 1 interlock conditions, then use
WCONDSUM DFB with WMVALVED DFB.
Connect the detected failure/interlock conditions (separately) to the input pins of WCONDSUM DFBs
and connect the output pin RESULT to the FAIL/ILCK input pins of WMVALVED DFB. Click the
partial bypass button to bypass the individual detected failure/interlock condition. A provision is
also available to bypass all the interlocks. From the faceplate Configuration tab, the DFB monitors
the number of open operations from the last reset if WDEVMNT DFB is linked to WMVALVED DFB. In
this case, the variable connected to pin WDEVMNT_ST has to be connected to input pin DEVMNTST
of WMVALVED DFB.
The library also supports the Simulation mode, which is a pre-commissioning mode where you can
test the function block without any inputs being monitored.

Click the required button from the faceplate to set the valve to Out of Service mode. If OOS is
activated in open condition, it closes the valve. When the valve is set back into Service mode, it
acquires the close condition.
You can set the priority for sending the SMS/speaker output for the individual detected failure
condition from the faceplate.

EIO0000001107 05/2020 137

WMVALVED

DFB Representation

Overview
This figure shows the FBD representation of the WMVALVED DFB:

138 EIO0000001107 05/2020

 WMVALVED

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the DFB
internal timers are reset and the signals are re-evaluated.
ZSH BOOL 1 = Position corresponding to the set point (SP) with a value of 1 is
reached.
ZSL BOOL 1 = Position corresponding to the set point (SP) with a value of 0 is
reached.
ZSH1 BOOL 1 = Running confirmation of direction1.
ZSH2 BOOL 1 = Running confirmation of direction 2.
FAIL BOOL Indicates to the DFB a detected error in the motorized valve which is
in the field.
 0 = Normal status.
 1 = Detected error in the device.
LOCAL BOOL Local Mode operation.
1 = Local mode active.
RSP BOOL Remote set point set by the continuous control.
1 = Value open.
ILCKSP BOOL Set point that is used when the function block is interlocked.
 0 = Motor starts in direction2.
 1 = Motor starts in direction1.
ILCK BOOL Interlocks the device at the defined position.
 0 = Normal condition.
 1 = Interlock condition.
EXTCTLD BOOL Indicates if the motor is controlled from outside of the system.
1 = External control.
FCCONDST WCONDSUM_ST_DDT Structure from WCONDSUM function block (FAIL).
ILCKCONDST WCONDSUM_ST_DDT Structure from WCONDSUM function block for (ILCK).
DEVMNTST WDEVMNT_ST_DDT Structure from WDEVMNTST function block.

EIO0000001107 05/2020 139

WMVALVED

Outputs

Output Parameter Description

Parameter Type Description

MOP1 BOOL 1 = Command signal of motor for direction 1 is ON.
MOP2 BOOL 1 = Command signal of motor for direction 2 is ON.
MS1SELD BOOL 1 = Current set point for direction 1 is ON.
MS2SELD BOOL 1 = Current set point for direction 2 is ON.
MRUNNING1 BOOL 1 = Motor is running in direction1.
MRUNNING2 BOOL 1 = Motor is running in direction 2.
MZSH1POS BOOL 1 = Switching operation corresponding to direction 1 is confirmed.
MZSH2POS BOOL 1 = Switching operation corresponding to direction 2 is confirmed.
HIGHPOS BOOL  0 = Device has not reached the position corresponding to the
set point (SP) with a value of 1.
 1 = Device has reached the position corresponding to the set
point (SP) with a value of 1.
LOWPOS BOOL  0 = Device has not reached the position corresponding to the
set point (SP) with a value of 1.
 1 = Device has reached the position corresponding to the set
point (SP) with a value of 0.
ZSHPOS BOOL  0 = Position corresponding to the set point (SP) with a value
of 1 is not reached
 1 = Position corresponding to the set point (SP) with a value
of 1 is reached.
ZSLPOS BOOL  0 = Device has not reached the position corresponding to the
set point (SP) with a value of 0
 1 = Device has reached the position corresponding to the set
point (SP) with a value of 0.
ALARM BOOL 1 = Alarm is raised in case of detection of not confirmed operation.
FAILD BOOL 1 = Active alarm for detected failure of valve.
OOS BOOL Indicates whether the equipment is in Out Of Service or
Operational mode.
 0 = Operational
 1 = Out of Service
SPEAKER BOOL Activates audible alarming system.
1 = Output to activate audible alarming system is ON.
SMS BOOL 1 = Output for messaging alarm is ON.
SMSPRI INT Priority level for messaging SMS.

140 EIO0000001107 05/2020

 WMVALVED

The below truth table shows the MOPx (output pin) value whenever there is a detected failure (FAIL
= 1), which are dependent on the configurable public parameters SC.FAILEN and
SC.FAILREARMEN.

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

SC.FAILEN SC.FAILREARMEN MOPx output when FAIL = 1 MOPx output when FAIL = 1
input input (assume MOPx = 1 before the (assume MOPx = 0 before
detected failure) the detected failure)
0 0 1 0
0 1 1 0
1 0 0 0
1 1 0 0
x = 1 or 2

EIO0000001107 05/2020 141

WMVALVED

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WMVALVED_ST WMVALVED_ST_DDT Function block status handles data structure (communication
with Supervision)

Other DDTs which are used with WMVALVED DFB to function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WMVALVED_ST_DDT Type
The following table describes the structure of the derived data type WMVALVED_ST_DDT for the
WMVALVED FBD:

Name Type Description

STW WORD 1 = Provides status of the valve, usually used from the monitoring subsystem,
and allows data to be retained in memory
CFGW WORD 1 = Provides the means to control the valve from the monitoring subsystem
SPW WORD 1 = Word containing the status bits of diagnostic condition 1 for speaker output
SMSW WORD 1 = Word containing the status bits of diagnostic condition detection for SMS
output
FSMSPRI1...15 INT 1 = SMS priority of 1...15 diagnostic condition detection (FAIL)
OCPREWARN DINT 1 = Pre alert for operations counters
SPMCNT DINT 1 = Set point for operations counters
TCPREWARN INT 1 = Pre alert for time counters
SPTC INT 1 = Set point for time counters
LOCAL WORD 1 = Indication for Local mode
ISPW WORD 1 = Word containing the status bits of interlock conditions for speaker output
ISMSW WORD 1 = Word containing the status bits of interlock conditions for SMS output
ISMSPRI1...15 INT 1 = SMS priority of 1...15 interlock conditions
ALW WORD 1 = Word for alarms and alerts
SEL UINT 1 = Selection for Maintenance modes
OPMODE INT 1 = Operation mode defined in the faceplate

142 EIO0000001107 05/2020

 WMVALVED

WMVALVED_ST.STW Word Structure

STW element provides a means to monitor the status, usually from the monitoring subsystem
(Supervision).
Bit description of the STW element:

Bit Name Description

0 ZSHPOS Indicates if the position corresponding to the set point (SP) with a value of 1 is reached.
1 ZSLPOS Indicates if the position corresponding to the set point (SP) with a value of 0 is reached.
4 ALARM Alarm for feedback confirmation detected failure .
5 FAILD Alarm for valve diagnostic conditon.
6 REM Valve status. Indicates whether the current set point (SP) is local (0) or remote (1). The
set point is always local when the owner is the Operator (OWNER = 1). When the owner
is Program (OWNER = 0), the set point is selected with the SC.REM public signal (1:
Remote and 0: Local).
7 ILCK Interlocks the device at the defined position.
 0 = Normal condition
 1 = Interlocked condition

8 REARMR Indicates if any diagnostic conditon is configured, the valve requires manual resetting (1)
through the CONFREARMEN and/or FAILREARMEN inputs.
9 EXTCTLD Indicates if the valve is being controlled from outside of the system (1) or not (0).

EIO0000001107 05/2020 143

WMVALVED

WMVALVED_ST.CFGW Word Structure

CFGW element provides a means to control the FBD, usually from the monitoring subsystem
(Supervision).
Bit description of the CFGW element:

Bit Name Description

0 OWNER Enables you to configure whether the set point is determined by the Program (0) or the
Operator (1).
1 ILCKBP 1 = Allows the interlock to be bypassed (1).
2 SIMMD 1 = Allows to place the motorized valve in Simulation mode so that the actual
confirmation signals (ZSHx inputs) are ignored, and both the operation confirmations
and the non-existence of a valve detected failure are simulated.
3 REARM 1 = Allows the valve to be reset. The function FBD sets the signal to 0 after each run
and sets the signal indicating that resetting is required (CFGW.REARM) to 0.
4 LSP 1 = Allows the operators local set point (OWNER = 1) to be set from the monitoring
subsystem. If the set point is set by the Program (OWNER = 0), the FBD continuously
assigns the value of the current set point.
13 ENOCWARN 1 = Enables operation counter alert.
14 ENTCWARN 1 = Enables time counter alert.
15 OOS Determines if the equipment is Out of Service
For detailed description, refer to Outputs (see page 140).

WMVALVED_ST.ALW Word Structure

ALW element provides a means to create the alarms, usually from the monitoring subsystem
(Supervision).
Bit description of the ALW element:

Bit Name Description

1 ALARM Alarm for feedback confirmation diagnostic condition.
3 FAILD Alarm for diagnostic conditon.
5 LSWARN Alert for load shedding.
6 OPWARN Alert for Operation mode.
9 OCPREWARN Pre alert for operations counter.
10 OCWARN Alert for operations counter.
11 TCPREWARN Pre alert for time counter.
12 TCWARN Alert for time counter.

144 EIO0000001107 05/2020

 WMVALVED

Public Variables

Public Variable Description

Variable Type Description

SC WMVALVED_SC_DDT Function block configuration and control data structure

WMVALVED_SC_DDT Type
The following table describes the structure of the derived data type WMVALVED_SC_DDT of the
WMVALVED FBD:

Name Type Description

EXTCTLD BOOL Read only access.
1 = Shows the value of the EXTCTLD input, so that it can be used from the
sequential control.
For detailed description, refer to Inputs (see page 139).
REM BOOL Read/write access.
1 = Allows the function block to be configured for a remote set point (RSP = 1) or
local set point (LSP = 0).
LSP BOOL Read/write access.
1 = Enables the sequential control to assign the local set point if the owner is the
Program (OWNER = 0) and the selected set point is Local (REM = 0).
SP BOOL Read only access.
1 = Current set point that is considered by the STEP3 algorithm.
PV BOOL Read only access.
1 = Valve position feedback.
HIGHPOS BOOL Read only access.
1 = Determines if the device has reached the position corresponding to the set
point (SP) with a value of 1.
For detailed description, refer to Outputs (see page 140).
LOWPOS BOOL Read only access.
1 = Determines if the device has reached the position corresponding to the set
point (SP) with a value of 0.
For detailed description, refer to Outputs (see page 140).
ZSHPOS BOOL Read only access.
1 = Indicates if the position corresponding to the set point (SP) with a value of 1 is
reached.
For detailed description, refer to Outputs (see page 140).
ZSLPOS BOOL Read only access.
1 = Indicates if the position corresponding to the set point (SP) with a value of 0 is
reached.
For detailed description, refer to Outputs (see page 140).

EIO0000001107 05/2020 145

WMVALVED

Name Type Description

ALARM BOOL Read only access.
1 = Alarm for confirmation detected error.
FAILD BOOL Read only access.
1 = Alarm for valve detected failure.
REARMR BOOL Read only access.
1 = Valve status. Indicates if any detected error condition is configured, the valve
requires manual resetting (1) the CONFREARMEN and/or FAILREARMEN inputs.
ILCKD BOOL Read only access.
1 = The signal is evaluated based on the ILCK input and
WMVALVED_ST.CFGW.ILCKBP input/output.
OWNER BOOL Read only access.
Allows to configure the set point selection.
 0 = Program.
 1 = Operator.
OOS BOOL Read only access.
For detailed description, refer to Outputs (see page 140).
TIMEOUT TIME Read/write access.
Enables the configuration of time (ms) during which confirmation alarm monitoring
is disabled. The value 0 disables confirmation alarm monitoring.
SCANTIME TIME Read/write access.
Enables the configuration of time (ms) for which alarm signals are kept active.
Allows the monitoring subsystem to acquire the data for alarms that are
automatically reset.
ZSHEN BOOL Read/write access.
1 = Enables switching operation confirmation monitoring (ZSH).
ZSLEN BOOL Read/write access.
1 = Enables switching operation confirmation monitoring (ZSL).
FAILEN BOOL Read/write access.
1 = Enables detected failure monitoring (FAIL).
CONFREARMEN BOOL Read/write access.
 0 = The output MOP1/MOP2 remains in its previous state when a non-confirmed
operation is detected and does not need manual resetting.
 1 = Withdraws the output MOP1/MOP2 when a non-confirmed operation is
detected (ALARM = 1) and a mandatory manual resetting is required.
FAILREARMEN BOOL Read/write access.
1 = Enables mandatory manual resetting of the valve during an inoperable
condition.

146 EIO0000001107 05/2020

 WMVALVED

Usage

Overview
Examples in this manual are given for information only.

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

Based on the options selected, the WMVALVED DFB in the application is used for WCONDSUM and
WDEVMNT DFBs to configure the desired functionality for the device.
The WMVALVED library is used to manage operation of motor operated on-off valve. The WMVALVED
DFB is designed with the objective of controlling a motorized valve, or a gate, with two limit
switches (open-valve and closed-valve) and two rotational-direction-motor-based control.
The following figure is shown as an example for WMVALVED DFB.

EIO0000001107 05/2020 147

WMVALVED

148 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WPENSTOCK
EIO0000001107 05/2020

Chapter 10
WPENSTOCK: Penstock Valve

WPENSTOCK: Penstock Valve

Overview
This chapter describes the control services provided by WPENSTOCK DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 150
Description 151
DFB Representation 153
Inputs 154
Outputs 155
Input/Output Pins 157
Public Variables 160
Usage 162

EIO0000001107 05/2020 149

WPENSTOCK

Introduction

General
The WPENSTOCK function block is used to manage the operation and control of a motor operated
penstock valve / gate in an Open-Stop-Close operation. A penstock is very commonly used in
many water and waste water plant at various locations such as intake, distribution, clarifications
and filtration. It is installed in closed pipelines as valves or open RCC channels as gates. The
operation of the function block is very similar to a Motor operated On-Off Valve with some
enhancements which are required and favoured for a Penstock valve operation.

150 EIO0000001107 05/2020

 WPENSTOCK

Description

The WPENSTOCK DFB manages the operation and control of a motor operated penstock valve/gate
in open/stop/close operations.
A penstock valve is used in water and waste water plants at locations such as intake, distribution,
clarifications, and filtration. It is installed in closed pipelines as valves or open RCC channels such
as gates. The operation of the DFB is similar to a motor operated on/off valve.
The WPENSTOCK DFB controls the motor operated valve.
The tables describe the main functions of this DFB:

Function Description
Status display Provides display information on the supervision about the status of the
penstock (open, closed, intermediate, interlocked, detected inoperable,
operated locally, managed by operator or program, in simulation and out of
service).
Control Controls the opening/closing/intermediate stopping of the penstock based on
the command received either from operator, the program or locally from the
field (not processed through PLC).
Inoperable Device Optionally, one digital signal determines if the control module has detected
inoperable device condition. The status of this signal is continuously
monitored. You can link the signal to motor overload trip, high torque value,
or any other configured process detected inoperable device conditions.
During inoperable device, the OP command to the field is set to 0.
Detection of not confirmed Optionally, you can generate a detected failure if the penstock does not
operation open/close after a time duration (configurable) from the respective command
given by the PLC.
NOTE: You have to ensure that no stop command is generated. During
inoperable device, the OP command to the field is set to 0.
Manual resetting Allows you to reset manually after the detection of an inoperable device
condition or a not confirmed operation and thereby moving the valve to the
current set point.
Local and remote set point Allows the function block to accept a set point (command) to operate the
penstock either from a local set point or a remote set point in Program mode
of operation.
Local set point - In Program mode the command is generated by another
program such as a sequential control system. By default, the function block is
designed to accept local set point.
Remote set point - In Program mode, you can connect the output pin from
other logic to the respective remote set point pin of the DFB to generate the
command. Normally, continuous control logic in DFB uses remote set point
pin.

EIO0000001107 05/2020 151

WPENSTOCK

Function Description
Interlocking Provides a function to drive the output to put the device onto a defined
position (open/close) when an active interlock is detected.
The function block has a facility to bypass individual active interlock
conditions.
Owner The DFB selects the program or operator as owner for the control system.
In Program mode, the operation is managed by local or remote set point. In
Operator mode, the operation is managed by commands received from the
operator.
Simulation You can switch the function block to Simulation mode where the feedback
signals are simulated, and confirm the normal operation of the function block.
The field feedback signals are bypassed in this case. Output to field is
configured as per project constant variable (OPSImEN). For detail refer to
Simulation (see page 30).
Intermediate stop As required on WWW industry, the penstock valve can be stopped
intermediately at a desired position , in between the open and close with the
help of an Intermediate stop command.
In this case, the display shows the penstock in an intermediate position but
does show the actual % of valve opening. If the penstock valve is supported
by a position transmitter, it can show the % of opening.

152 EIO0000001107 05/2020

 WPENSTOCK

DFB Representation

Overview
This figure shows the FBD representation of the WPENSTOCK DFB.

EIO0000001107 05/2020 153

WPENSTOCK

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the DFB
internal timers are reset and the signals are re-evaluated.
ZSH BOOL Indication for status of the position corresponding to the set point (SP). Open
feedback limit switch.
1 = The position corresponding to the set point (SP) with a value of 1 is
reached.
ZSL BOOL Indication for status of the set point corresponding to the set point of 0.
1 = The position corresponding to the set point (SP) with a value of 0 is
reached.
MZSH1 BOOL Confirmation for running in direction 1.
1 = Running in direction 1 confirmed.
MZSH2 BOOL Confirmation for running in direction 2.
1 = Running in direction 2 confirmed.
FAIL BOOL Detection for inoperable device.
 0 = Equipment healthy
 1 = Inoperable device
LOCAL BOOL Local Mode operation
1 = Local mode active
RSP BOOL Selection for remote set point set by the continuous control SC.REM.
 0 = Command to open the valve.
 1 = Command to close the valve.
RSPSTOP BOOL Enables the selection of stopping the valve in intermediate position.
 1 = Stops the penstock valve.
ILCKSP BOOL Command to put device in defined position. (set point that has to be used
when the function block is interlocked).
 0 = Indicates non usage of set point when function block is interlocked.
 1 = Indicates usage of set point when function block is interlocked
ILCK BOOL Indication for the device.
 0 = Normal condition.
 1 = Interlocked condition.
EXTCTLD BOOL Indicates if the motor is controlled from outside of the system.
1 = External control
FCCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB for WCONDSUM DFB (Fail) (interlock).
ILCKCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB for WCONDSUM(ILCK) (interlock).
DEVMNTST WDEVMNT_ST_DDT Structure from WDEVMNTST DFB for DEVMNT (device maintenance).

154 EIO0000001107 05/2020

 WPENSTOCK

Outputs

Output Parameter Description

Parameter Type Description

OP1 BOOL Command signal for motor when direction 1 is selected.
 0 = Motor Stop command
 1 = Motor Start command at direction 1
OP2 BOOL Command signal for motor when direction 2 is selected.
 0 = Motor Stop command
 1 = Motor Start command at direction 2
S1SELD BOOL Current set point status when direction 1 is selected.
1 = Current set point selected for direction 1.
S2SELD BOOL Current set point status when direction 2 is selected.
1 = Current set point selected for direction 2
RUNNING1 BOOL Indicates the status of position of motor at set point SP = 1 and SPSEL = 0
(for speed 1).
1 = Motor Position at set point when speed 1 selected.
RUNNING2 BOOL Indicates the status of position of motor at set point SP = 1 and SPSEL = 0
(for speed 2).
1 = Motor Position at setpoint when speed 2 selected.
ZSH1POS BOOL 1 = Confirmation of the switching operation corresponding to the SP = 1
and SPSEL = 0 set point.
ZSH2POS BOOL 1 = Confirmation of the switching operation corresponding to the SP = 1
and SPSEL = 1 set point.
ALARM BOOL 1 = Alarm for not confirmed operation of the penstock valve.
FAILD BOOL 1 = Alarm for inoperable device condition.
UNPOS BOOL Indicates that only 1 speed is enabled, that is ZSH1EN ≠ ZSH2EN.
STOPPED BOOL 1 = Indicates the motor is stopped.
OOS BOOL Determines whether the motor is Out of Service or in operation.
 0 = In operation
 1 = Out Of Service
SPEAKER BOOL Activates audible alarming system.
1 = Output to activate audible alarming system is ON.
SMS BOOL 1 = Output for messaging alarm.
SMSPRI INT Priority level for messaging SMS.

EIO0000001107 05/2020 155

WPENSTOCK

The below truth table shows the MOPx (output pin) value whenever there is a detected failure (FAIL
= 1), which are dependent on the configurable public parameters SC.FAILEN and
SC.FAILREARMEN.

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

SC.FAILEN input SC.FAILREARMEN MOPx output when FAIL = 1 MOPx output when FAIL = 1
input (assume MOPx = 1 before the (assume MOPx = 0 before the
detected failure) detected failure)
0 0 1 0
0 1 1 0
1 0 1 0
1 1 0 0
x = 1 or 2

156 EIO0000001107 05/2020

 WPENSTOCK

Input/Output Pins

Input/Output Parameter

Parameter Type Description

WPENSTOCK_M WPENSTOCK_M_DDT Structure for extracting the motor data in WPENSTOCK DFB.
WPENSTOCK_ST WPENSTOCK_ST_DDT Structure to interface the DFB with Supervision supervision.

WPENSTOCK_M_DDT Type
This structure contains the DFB control and status data for the for the WPENSTCOCK DFB.

Name Type Description

STW WORD Motor status word.

WPENSTOCK_ST_DDT Type
The following table describes the structure of the derived data type WPENSTOCK_ST_DDT for the
WPENSTOCK DFB.

Name Type Description

STW WORD Provides the valve status, normally used from the monitoring subsystem,
and allows data to retain in memory.
CFGW WORD Provides the means to control the valve from the monitoring subsystem.
SPW WORD Word containing the status bits of diagnostic condition 1 for speaker
output.
SMSW WORD Word containing the status bits of diagnostic condition 1 for SMS output.
FSMSPRIx (x: 1...15) INT SMS priority of the diagnostic condition x (x: 1...15)(FAIL).
OCPREWARN UINT Pre alert for operations counters.
SPMCNT UINT Set point for operations counters.
TCPREWARN UINT Pre alert for time counters.
SPTC UINT Set point for time counters.
LOCAL WORD Indication for Local mode.
ISPW WORD Word containing the status bits of Interlock conditions for speaker output
ISMSW WORD Word containing the status bits of Interlock conditions for SMS output.
ISMSPRIx (x: 1...15) INT SMS priority of interlock condition x (x: 1...15).
ALW WORD Alarm word for alarms and alerts.
SEL UINT Selection for Maintenance modes.
OPMODE INT Operation mode defined in the supervision.

EIO0000001107 05/2020 157

WPENSTOCK

WPENSTOCK_ST.STW Word Structure

STW Provides the status, normally used from the monitoring subsystem, and allows data to be
retained in memory
Bit description of the STW element:

Bit Name Description

0 ZSHPOS Indication for ZSHPOS.
1 = ZSHPOS active
1 ZSLPOS Indication for ZSLPOS.
1 = ZSLPOS active
2 SP Indication for SP output.
1 = SP active
3 OP Indication for OP.
1 = OP active
4 Alarm Alarm Indication.
1 = Alarm active
5 FAILD Indication for FAILD output.
1 = FAILD inoperable condition
6 REM REM valve status. Indicates whether the current set point (SP) is local (0) or
remote (1). The set point is always local when the owner is the Operator
(OWNER = 1). When the owner is the Program (OWNER = 0), the set point is
selected with the SC.REM public signal.
 1 = Remote
 0 = Local

7 ILCK Indicates ILCK valve status.

1 = ILCK valve active
For detailed description, refer to Inputs (see page 154).
8 REARMR REARMR valve status. Indicates when the valve requires manual resetting
(1) after a detected failure is configured for manual resetting though the
CONFREARMEN and/or FAILREARMEN inputs.
1 = REARMR valve active
9 EXTCTLD Indicates if the motor is controlled from outside of the system.
For detailed description, refer to Inputs (see page 154).
12 INTERMEDIATE Indicates valve in intermediate position.
1 = Valve in intermediate position

158 EIO0000001107 05/2020

 WPENSTOCK

WPENSTOCK_ST.CFGW Word Structure

Bit description of the CFGW element:

Bit Name Description

0 OWNER Enables you to configure whether the set point is determined by the Program (0) or
the Operator (1).
1 ILCKBP Interlock bypass enabled/disabled
1 = Interlock bypass allowed.
2 SIMMD Enables you to place the motor in Simulation mode, so that the actual confirmation
signals (ZSHx inputs) are ignored, and both the operation confirmations and the non-
existence of motor detected failure are simulated.
3 REARM Allows the valve to be reset. The DFB sets the signal to 0 after each run and sets the
signal indicating that resetting is required (CFGW.REARM) to 0
4 LSP Allows you to locally set the set point from the monitoring subsystem. If the set-point
is set by the Program, the DFB continuously assigns it the value of the current set-
point.
 0 = The DFB continuously assigns the value of current set point to the local set
point.
 1 = Local set point set from the monitoring subsystem.

10 STOP Selection to stop the actuator in intermediate position.

1 = Actuator stopped in intermediate position.
13 ENOCWARN Enables Operation counter alert.
1 = Operation counter alert enabled.
14 ENTCWARN Enables Time counter alert.
1 = Timer counter alert is enabled.
15 OOS Indication for Out of service.
1 = Out of service indication is enabled.
For detailed description, refer to Outputs (see page 155).

WPENSTOCK_ST.ALW Word Structure

Bit description of the ALW element:

Bit Name Description

1 ALARM Indication for ALARM.
1 = ALARM active.
3 FAILD Indication for FAILD.
1 = FAILD active
6 Operator mode alert.
1 = Alarm is active

EIO0000001107 05/2020 159

WPENSTOCK

Public Variables

Public Variable Description

Variable Type Description

SC WPENSTOCK_SC_DDT Function block configuration and control data structure

WPENSTOCK_SC_DDT Type
The following table describes the structure of the derived data type WPENSTOCK_SC_DDT of
WPENSTOCK function block

Name Type Description

EXTCTLD BOOL Read only access.
1 = Shows the value of the EXTCTLD input, so that it can be used from the
sequential control.
For detailed description, refer to Inputs (see page 154).
REM BOOL Read only access.
1 = Allows the function block to be configured for a remote set point (RSP = 1)
or local set point (LSP = 0).
LSP BOOL Read/write access.
1 = Enables the sequential control to assign the local set point if the owner is
the Pogram (OWNER = 0) and the selected set point is Local (REM = 0).
SP BOOL Read only access.
1 = Current set point that is considered by the STEP3 algorithm.
PV BOOL Read only access.
1 = Valve position feedback.
HIGHPOS BOOL Read only access.
1 = Determines if the device has reached the position corresponding to the set
point (SP) with a value of 1.
LOWPOS BOOL Read only access.
1 = Determines if the device has reached the position corresponding to the set
point (SP) with a value of 0.
ZSHPOS BOOL Read only access.
1 = Indicates if the position corresponding to the set point (SP) with a value of
1 is reached.
ZSLPOS BOOL Read only access.
1 = Indicates if the position corresponding to the set point (SP) with a value of
0 is reached.
ALARM BOOL Read only access.
1 = Alarm for confirmation detected error.

160 EIO0000001107 05/2020

 WPENSTOCK

Name Type Description

FAILD BOOL Read only access.
1 = Alarm for valve detected failure.
REARMR BOOL Read only access.
1 = Valve status. Indicates if any detected error condition is configured, the
valve requires manual resetting (1) the CONFREARMEN and/or FAILREARMEN
inputs.
ILCKD BOOL Read only access.
The signal is evaluated based on the ILCK input and the WPENSTOCK
ST.CFGW.ILCKBP input/output.
OWNER BOOL Read only access.
 0 = Program
 1 = Owner
OOS TIME Read only access.
For detailed description, refer to Ouputs (see page 155)
TIMEOUT TIME Read/write access.
Enables the configuration of time (ms) during which confirmation alarm
monitoring is disabled. The value 0 disables confirmation alarm monitoring.
SCANTIME BOOL Read/write access.
Enables the configuration of time (ms) for which alarm signals are kept active.
Allows the monitoring subsystem to acquire the data for alarms that are
automatically reset.
ZSHEN BOOL Read/write access.
Enables switching confirmation for ZSH.
ZSLEN BOOL Read/write access.
Enables switching confirmation for ZSL.
FAILEN BOOL Read/write access.
1 = Enables detected failure condition monitoring (FAIL).
CONFREARMEN BOOL Read/write access.
 0 = The output MOP1/MOP2 remains in its previous state when a non-
confirmed operation is detected and does not need manual resetting.
 1 = Withdraws the output MOP1/MOP2 when a non-confirmed operation is
detected (ALARM = 1) and a mandatory manual resetting is required.
FAILREARMEN BOOL Read/write access.
 0 = The output MOP1/MOP2 remains in its previous state during detected
failure conditions and does not require manual resetting.
 1 = Withdraws the output MOP1/MOP2 during detected failure conditions
(FAIL = 1, SC.FAILEN= 1) and a mandatory manual resetting is required
once the FAIL condition disappears (FAIL = 0).

EIO0000001107 05/2020 161

WPENSTOCK

Usage

Overview
Examples in this manual are given for information only.

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

WPENSTOCK is a DFB similar to the valve DFBs. This DFB has a device maintenance option
available like the other equipment DFBs. There two WCONDSUM DFBs (one for detected failure and
the other for interlock) which are used along the WPENSTOCK. .
The following figure is shown as an example for WPENSTOCK DFB.

162 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WAINPUT
EIO0000001107 05/2020

Chapter 11
WAINPUT: Analog Input

WAINPUT: Analog Input

Overview
This chapter describes the control services provided by WAINPUT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 164
Description 165
DFB Representation 166
Inputs 167
Outputs 169
Inputs/Outputs 170
Public Variables 173
Usage 174

EIO0000001107 05/2020 163

WAINPUT

Introduction

General
The WAINPUT DFB is used to condition a signal coming from an analog input card. The signal is
conditioned for scaled value, range alarms and over range/under range (cut-off) limits.
The following table describes the main functions of this function DFB:

Function Description
Scaling 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-usable. In such case, the cut-off value is considered.
Diagnosis The function block manages the diagnostic status of the signal if the peripherals used
provide it and assigns the value that is configured for different scenarios.
Simulation The function block can be configured in order to enable modifying the entry of the value
that needs to be considered (in engineering units).
This option enables to conduct tests on the programming associated with the function
block from the monitoring subsystem.
External PV The function block allows a signal that is already in engineering units (therefore, it does
not need scaling, diagnosis; or cut-off) to be connected, maintaining the simulation
function.
Alarm The function block allows the alarm evaluation. To evaluate the alarm, the status should
be enabled/disabled. The incorporation of an external logic should be added to the
evaluation of this alarm.

164 EIO0000001107 05/2020

 WAINPUT

Description

Operating Modes
The WAINPUT DFB conditions a signal coming from an analog input card.
The function block supports the following two modes of operation:
 Simulation mode - In Simulation mode, you can enter a simulated value of analog input (in
engineering units) from Configuration tab.
 Normal mode - In Normal mode, the input values are scaled by the function block.

Functional Description
 The raw count of the analog input card has to be connected to DFB input CHIN and the channel
not operational status has to be connected to CHFAILURE.
 You can enter high and low values of raw count at HIRAW and LORAW correspondingly.
 You can enter high and low limits of engineered value at input pins of HIPV and LOPV DFBs.
 You can enter BADPV at DFBs input pin. In case of channel not operational, this value is taken
as PV.
 You can bypass the analog input card and obtain value from somewhere else (logics) by using
the engineered value at EXTPV.For enabling the EXTPV, set EXTPVEN high.
 If the raw count is below the LORAW, you can have cut-off PV.
 The DFB generates five different types of alarms: HIHI, LOWLOW, HI, LOW, and deviation as
per SP entered for these values in the faceplate.
 The alarms can be made on or off with the delay as per the value entered in TONSP and TOFFSP
respectively.
 You can define hysteresis at the DFB input HYSTSP.
 You can enable the alarm by clicking the ALARM ENABLED/ALARM DISABLED button in the
faceplate and the respective input of alarm watch (for example, HHWATCH) has to be set.
 The processed analog input value in engineering value is passed on to DFBs output PV in case
the alarm DFB output is set.

EIO0000001107 05/2020 165

WAINPUT

DFB Representation

Overview
This figure shows the FBD representation of the WAINPUT DFB:

166 EIO0000001107 05/2020

 WAINPUT

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the DFB internal timers
are reset and the signals are re-evaluated.
CHIN INT Channel Input - Input signal. Usually corresponds to a value coming from analog
input channel.
Raw count as per input card specification.
CHFAILURE BOOL Inoperable channel condition detection -Indicates that the input channel associated
with the CHIN input is inoperable or not.
1 = Inoperable channel
HIRAW INT High Range alert - High range of the CHIN input signal.
LORAW INT Low Range alert - Low range of the CHIN input signal.
HIPV REAL High Process Variable - High range of the measurement in engineering units (PV
output) corresponding to the maximum value (configured in the HIRAW input) of the
CHIN input.
LOPV REAL Low Process Variable - Low range of the measurement in engineering units (PV
output) corresponding 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 Cut-off Value Process Variable - Value (in engineering units) resulting from the
scaling calculation, and below which the value entered into the LOPV input should be
considered as the measurement value (PV output).
EXTPVEN BOOL External PV Enable - Enables to configure the function block to accept an analog
input in engineering units (EXTPV) or to use the input in raw data (CHIN).
1 = EXPV is used.
EXTPV REAL External PV - External input signal in engineering units.
HHWATCH BOOL Very High-Level Alarm Watch - Enables very high-level alarm monitoring to be
enabled or disabled depending on the dynamic conditions of the process.
1 = Enables HH alarm.
HWATCH BOOL High-Level Alarm Watch - Enables high-level alarm monitoring to be enabled or
disabled depending on the dynamic conditions of the process.
1 = Enables H alarm.
DWATCH BOOL Deviation Watch - Enables deviation alarm monitoring to be enabled or disabled
depending on the dynamic conditions of the process.
1 = Enables D alarm.

EIO0000001107 05/2020 167

WAINPUT

Parameter Type Description

LWATCH BOOL Low-Level Alarm - Enables low-level alarm monitoring to be enabled or disabled
depending on the dynamic conditions of the process.
1 = Enables L alarm.
LLWATCH BOOL Very Low-Level Alarm - Enables very low-level alarm monitoring to be enabled or
disabled depending on the dynamic conditions of the process.
1 = Enables LL alarm.
TONSP TIME Timing Set Point On - Timing set point for analog input connection (CHIN) in ms (0
to activate timing).
TOFFSP TIME Timing Set Point Off - Timing set point for analog input disconnection (CHIN) in ms
(1 to deactivate timing).
HYSTSP REAL Hysteresis Set Point - Hysteresis set point for disconnecting the alarms (in
engineering units).

168 EIO0000001107 05/2020

 WAINPUT

Outputs

Output Parameter Description

Parameter Type Description

PV REAL Calculated measurement value in engineering units.
Scale range in engineering units.
AHH BOOL Very high-level alarm.
1 = Active high-high alarm.
AH BOOL High-level alarm.
1 = Active high alarm.
AD BOOL Deviation alarm.
1 = Active deviation alarm.
AL BOOL Low-level alarm.
1 = Active low alarm.
ALL BOOL Very low-level alarm.
1 = Active low-low alarm.
SPEAKER BOOL Activates audible alarming system.
1= Output to activate audible alarming system is ON.
SMS BOOL 1= Output for messaging alarm is ON.
SMSPRI INT Priority level for messaging SMS.

EIO0000001107 05/2020 169

WAINPUT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WAINPUT_ST WAINPUT_ST_DDT Function block status handles data structure (communication
with Supervision)

Other DDTs which are used with WAINPUT DFB to function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WAINPUT_ST_DDT Type
The following table describes the structure of the derived data type WAINPUT_ST_DDT for the
WAINPUT function block:

Name Type Description

PV REAL Calculated measurement value in engineering units.
SIM REAL Simulated value in engineering units.
SP REAL Set point level used as a reference for deviation alarm evaluation in
engineering units.
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).
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).
STW WORD Status word.
CFGW WORD Configuration word.
ALW WORD Alarm word.

170 EIO0000001107 05/2020

 WAINPUT

WAINPUT_ST.STW Word Structure

STW element provides the means to control the function block status usually from the monitoring
subsystem (Vijeo Citect supervision-SCADA)
Bit description of STW :

Bit Bit Description

0 BADST Indicates detected failure of input channel or not. Reproduces the
CHFAILURE input value.
For detailed description, refer to Inputs (see page 167).
3 HHWATCH AHH is enabled.
For detailed description, refer to Inputs (see page 167).
4 HWATCH AH is enabled.
For detailed description, refer to Inputs (see page 167).
5 DWATCH AD is enabled.
For detailed description, refer to Inputs (see page 167).
6 LWATCH AL is enabled.
For detailed description, refer to Inputs (see page 167).
7 LLWATCH ALL is enabled.
For detailed description, refer to Inputs (see page 167).
8 AHH Very high-level alarm.
For detailed description, refer to Outputs (see page 167).
9 AH High-level alarm.
For detailed description, refer to Outputs (see page 167).
10 AD Deviation alarm.
For detailed description, refer to Outputs (see page 167).
11 AL Low-level alarm.
For detailed description, refer to Outputs (see page 167).
12 ALL Very low-level alarm.
For detailed description, refer to Outputs (see page 167).

EIO0000001107 05/2020 171

WAINPUT

WAINPUT_ST.CFGW Word Structure

CFGW controls the DFB status from the monitoring subsystem (Vijeo Citect supervision-SCADA).
Bit description of CFGW :

Bit Name Description

1 SIMMD Enables the analog input to be set to Simulation or Normal mode.)
 0 = Normal mode
 1 = Simulation mode

3 ENHH Enables very high-level alarm.

1 = HH alarm is enabled
4 ENH Enables high-level alarm.
1 = H alarm is enabled
5 END Enables deviation alarm.
1 = D alarm is enabled
6 ENL Enables low-level alarm.
1 = L alarm is enabled
7 ENLL Enables very low-level alarm.
1 = LL alarm is enabled

WAINPUT_ST.ALW Word Structure

ALW element provides a means to create the alarms usually from the monitoring subsystem (Vijeo
Citect supervision-SCADA).
Bit description of the ALW element:

Bit Name Description

0 BADST Alarm for detected failure in analog input channel.
8 AHH Very high-level alarm
9 AH High-level alarm
10 AD Deviation alarm
11 AL Low-level alarm
12 ALL Very low-level alarm

172 EIO0000001107 05/2020

 WAINPUT

Public Variables

Public Variable Description

Variable Type Description

SC WAINPUT_SC_DDT Function block configuration and control data structure

WAINPUT_SC_DDT Type
The following table describes the structure of the derived data type WAINPUT_SC_DDT of the
WAINPUT DFB :

Name Type Description

PV REAL Read-only access.
Calculated measurement value in engineering units.
For detailed description, refer to Outputs (see page 169).
BADST BOOL Read-only access.
1 = Inoperable input channel.
AHH BOOL Read-only access.
For detailed description, refer to Outputs (see page 169).
AH BOOL Read-only access.
For detailed description, refer to Outputs (see page 169).
AD BOOL Read-only access.
For detailed description, refer to Outputs (see page 169).
AL BOOL Read-only access.
For detailed description, refer to Outputs (see page 169).
ALL BOOL Read-only access.
For detailed description, refer to Outputs (see page 169).

EIO0000001107 05/2020 173

WAINPUT

Usage

Overview
Examples in this manual are given for information only.

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

174 EIO0000001107 05/2020

 WAINPUT

The WAINPUT DFB can be used independently, and the usage of this DFB are:
 The raw count of the analog input card has to be connected to DFB input CHIN and the channel
failure detected status from the analog input card has to be connected to CHFAILURE.
 You can enter high and low values of raw count at HIRAW and LORAW.
 You can enter high and low limits of engineered value at the input pins of HIPV and LOPV DFBs.
 You can enter BADPV at DFBs input pin. In case of channel detected failure, this value is taken
as PV.
 You can bypass the analog input card and obtain value from somewhere else (logics) by using
the engineered value at EXTPV. For enabling the EXTPV, you has to set EXTPVEN high.
 If the raw count is below the LORAW, then you can have cut-off PV.
 The DFB generates 5 different types of alarms: HIHI, LOWLOW, HI, LOW, and deviation as per
SP entered for these values in the faceplate by you.
 The alarms can be made on or off with the delay as per the value entered in TONSP and TOFFSP.
 You can define hysteresis at the DFB input HYSTSP.
 You can enable the alarm by clicking the ALARM ENABLED/ALARM DISABLED button in the
faceplate and the respective input of alarm watch (for example, HHWATCH) has to be set.
 The processed analog input value in engineering value is passed on to DFBs output PV in case
the alarm DFB output is set.

EIO0000001107 05/2020 175

WAINPUT

176 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WAOUTPUT
EIO0000001107 05/2020

Chapter 12
WAOUTPUT: Analog Output

WAOUTPUT: Analog Output

Overview
This chapter describes the control services provided by WAOUTPUT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 178
Description 179
DFB Representation 180
Inputs 181
Outputs 182
Inputs/Outputs 183
Public Variables 185
Usage 186

EIO0000001107 05/2020 177

WAOUTPUT

Introduction

General
The WAOUTPUT DFB is used to condition an analog signal associated with a physical output. The
module provides linear scaling, interlocking, diagnosing, and owner management functions.
The following table describes the main functions of this DFB:

Function Description
Scaling Scales the input signal in engineering units (for example, %) to raw data by
means of a linear function.
Diagnosis The function block manages the diagnostic status of the signal if the
peripherals used provide it and assigns the value that is configured for
different scenarios.
Interlocking The module gives the command to the device for moving to the defined
position if an active interlock that requires the move is detected. An
interlock bypass function is available.
Owner The module manages which control system level (Operator or Program) is
the owner. As a result, it is responsible for setting the set point for the
desired position.

178 EIO0000001107 05/2020

 WAOUTPUT

Description

Operating Modes
The WAOUTPUT DFB conditions an analog signal associated with a physical output. The module
provides linear scaling, interlocking, diagnosing, and owner management functions.
The WAOUTPUT DFB conditions a signal send to an analog output card.
It supports the following modes of operation:
 Program mode - In Program mode, value is scaled by the DFB. The DFB takes the value from
the pin RSP in between HIRAW and LORAW, and scales the output in between HISP and LOSP.
 CHFAIL status has to be connected to CHFAILURE
 You can enter high and low values of raw count at HIRAW and LORAW
 Similarly, HI and low limits of set point value are entered at DFBs input pin HISP and LOSP

 Operator mode - You can enter the value in REAL datatype only.
The DFB handles the interlock and provides you the provision to bypass the interlock.

Functional Description
The raw count of the analog output card has to be connected to DFB output CHOUT.
You have to provide inputs high and low values of raw count at HIRAW and LORAW respectively.
Similarly, you can enter engineering values of high and low limits in DFBs input pin HIPV and
LOPV.
The pin TRACK determines if the remote set point (RSP input) is considered (0) or not (1) for the
CHOUT output calculation. This output is used to report to the algorithm connected to the RSP input
(that is a PID) whether the control loop is open (TRACK = 1) or not (TRACK = 0). As a result, the
control loop can be repositioned in terms of the output set point that is having an effect.
If the DFB is operated in Remote mode, the input to the DFB is given at the input RSP.
If there is any interlock, the input is given at the input ILCKSP.

EIO0000001107 05/2020 179

WAOUTPUT

DFB Representation

Overview
This figure shows the FBD representation of the WAOUTPUT DFB:

180 EIO0000001107 05/2020

 WAOUTPUT

Inputs

Input Parameter Description

Parameter Type Description

CHFAILURE BOOL Indicates if the output channel associated with CHOUT is
inoperable or not to the function block.
1 = Channel is inoperable.
HIRAW INT Indicates the high range of the CHOUT output signal.
LORAW INT Indicates the low range of the CHOUT.
HISP REAL Indicates high range of the measurement in engineering units
(PV output) corresponding to the maximum value (configured in
the HIRAW input) of the CHOUT.
LOSP REAL Indicates low range of the measurement in engineering units (PV
output) corresponding to the minimum value (configured in the
LORAW input) of the CHOUT.
RSP REAL Set by the continuous control, for example, by a PID controller
output.
ILCKSP REAL Set point that is used when the funciton block is interlocked.
ILCK BOOL Interlocks the device at defined position.
 0 = Normal condition
 1 = Interlock condition
ILCKCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB for ILCK (interlock).

EIO0000001107 05/2020 181

WAOUTPUT

Outputs

Output Parameter Description

Parameter Type Description

CHOUT INT Calculated value of the output.
Raw count range corresponding to analog output card specification.
SP REAL Current set point.
OP REAL Output (in engineering units).
TRACK BOOL  0 = RSP is not considered for the CHOUT output calculation.
 1 = RSP is considered for the CHOUT output calculation. This output is used
to report to the algorithm connected to the RSP input (that is a PID), whether
the control loop is open (TRACK = 1) or not (TRACK = 0). So that, you can
reposition the control loop in terms of the output set point that has an effect.
SPEAKER BOOL Activates audible alarming system.
1= Output to activate audible alarming system is ON.
SMS BOOL 1= Output for messaging alarm is ON.
SMSPRI INT Priority level for messaging SMS.

182 EIO0000001107 05/2020

 WAOUTPUT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WAOUTPUT_ST WAOUTPUT_ST_DDT Function block status handles data structure (communication
with Supervision)

Other DDTs which are used with WAOUTPUT DFB to function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WAOUTPUT_ST_DDT Type
The following table describes the structure of the derived data type WAOUTPUT_ST_DDT for the
WAOUTPUT function block:

Name Type Description

OP REAL Current set point/local set point (Operator)
LSP REAL Local set point
STW WORD Status word
CFGW WORD Configuration word
ALW WORD Alarm word

WAOUTPUT_ST.STW Word Structure

STW element provides a means to monitor the function block status, usually from the monitoring
subsystem (Supervision).
Bit description of the STW element:

Bit Name Description

0 BADST 1 = Indicates the input channel is inoperable .Reproduces the CHFAILURE input
value.
1 ILCK 1 = Interlocks the device at the defined-position.
2 REM 1 = Allows the block to be configured for a remote set point (RSP = 1) or local set
point (LSP = 0).

EIO0000001107 05/2020 183

WAOUTPUT

WAOUTPUT_ST.CFGW Word Structure

CFGW element provides a means to control the block, usually from the monitoring subsystem
(Supervision).
Bit description of the CFGW element:

Bit Name Description

0 OWNER Enables you to configure whether the set point is determined by the Program (0) or
the Operator (1).
1 ILCKBP 1 = Allows the interlock to be bypassed.

WAOUTPUT_ST.ALW Word Structure

ALW element provides a means to create the alarms, usually from the monitoring subsystem
(Supervision).
Bit description of the ALW element:

Bit Name Description

0 BADST 1 = Analog output channel detected inoperable condition alarm.

184 EIO0000001107 05/2020

 WAOUTPUT

Public Variables

Public Variable Description

Variable Type Description

SC WMVALVED_SC_DDT Function block configuration and control data structure.

WAOUTPUT_SC_DDT Type
The following table describes the structure of the derived data type WAOUTPUT_SC_DDT of
WAOUTPUT function block:

Name Type Description

LSP REAL Read/Write access..
Local set point
SP REAL Read only access.
Current set point
For detailed description, refer to Outputs (see page 182).
OP REAL Read only access.
Output (in engineering units)
For detailed description, refer to Outputs (see page 182).
OWNER BOOL Read only access.
 0 = Owner for funciton block operation is Program
 1 = Owner for funciton block operation is Operator
REM BOOL Read only access.
 0 = Allows the function block to be configured for local set point (LSP).
 1 = Allows the function block to be configured for remote set point (RSP).

TRACK BOOL Read only access.

For detailed description, refer to Outputs (see page 182).
BADST BOOL Read only access.
 0 = Output channel is operational.
 1 = Output channel is not operational. This value reproduces the
CHFAILURE input value.
ILCKD BOOL Read only access.
The signal is evaluated based on the ILCK input and
WAOUT_ST.CFGW.ILCKBP input/output.
1 = Block is in interlock state.

EIO0000001107 05/2020 185

WAOUTPUT

Usage

Overview
Examples in this manual are given for information only.

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

This WAOUTPUT DFB can be used along with the WPIDCTL DFB. The set point to the WAOUTPUT
DFB can be given from the output of the PID control DFB.

186 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WDINPUT
EIO0000001107 05/2020

Chapter 13
WDINPUT: Digital Input

WDINPUT: Digital Input

Overview
This chapter describes the control services provided by WDINPUT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 188
Description 189
DFB Representation 190
Inputs 191
Outputs 192
Inputs/Outputs 193
Public Variables 195
Usage 196

EIO0000001107 05/2020 187

WDINPUT

Introduction

General
The WDINPUT DFB is used to condition a signal coming from a digital input card.
The following table describes the main functions of this function block:

Function Description
Timing The input signal is timed for the purpose of evaluating an output logic signal
that absorbs rapid changes in the input signal.
Alarm The function block allows the alarm evaluation and the status that is
considered as an alarm to be enabled/disabled. It also allows the
incorporation of an external logic that has to be added to the evaluation of this
alarm.
Diagnosis The function block manages the diagnostic status of the signal if the
peripherals used provide it and assigns the value that is configured for
different scenarios.
Simulation You can configure the function block so as to enable entering the value that
should be considered. This option enables to conduct tests on the
programming associated with the function block from the monitoring
subsystem.

188 EIO0000001107 05/2020

 WDINPUT

Description

Operating Modes
The WDINPUT DFB conditions the digital input signal from the field connected to the digital input
card.
It supports the following modes of operation:
 Simulation mode - In this mode, you can on or off the signal from the faceplate.
 Normal mode - In this mode, the DFB conditions the signal.

The switching between Normal and Simulation mode can be done using the configuration tab.

Functional Description
In Normal mode, status of physical input connected to a particular channel of the digital input card
is connected to CHIN and FAIL signal to CHFAILURE. You can enter the values of BADPV. It is
moved to PV in case of CHFAIL.
You can enter the condition in which alarm has to be considered (0 or 1) at ALARMST to enable the
alarm. Click ALARM ENABLED in the faceplate and set the DFB input WATCH.
Alarm can be made on or off with the delay as per the value entered in TONSP or TOFFSP.
The processed digital input value is moved to DFB output PV. In case of alarm, the DFB output
ALARM is set.

EIO0000001107 05/2020 189

WDINPUT

DFB Representation

Overview
This figure shows the FBD representation of the WDINPUT DFB:

190 EIO0000001107 05/2020

 WDINPUT

Inputs

Input Parameter Description

Parameter Type Description

INITDFB BOOL Usually set to 0. When a rising edge is produced on this input, the DFB
internal timers are reset and the signals are re-evaluated.
CHIN BOOL Input signal corresponds to a value coming from a digital input channel.
1 = Input signal is high.
CHFAILURE BOOL Indicates that the input channel associated with the CHIN input is inoperable
or not.
1 = Inoperable channel.
BADPV BOOL Default value in engineering units (PV output signal) when the channel is not
operational.
ALARMST BOOL PV value that should be considered as an alarm.
1 = PV value should be considered as an alarm
WATCH BOOL Allows enabling or disabling alarm monitoring, depending on the dynamic
conditions of the process.
1 = Enable alarm.
TONSP TIME For digital input connection (CHIN) in ms (0 to activate timing).
TOFFSP TIME For digital input disconnection (CHIN) in ms (1 to deactivate timing).

EIO0000001107 05/2020 191

WDINPUT

Outputs

Output Parameter Description

Parameter Type Description

PV BOOL Timed input value.
1 = Public variable is high.
ALARM BOOL Alarm evaluated based on the PV value.
1 = Active alarms.
SMS BOOL Messaging Output.
1 = Output for messaging alarm is ON.
SPEAKER BOOL Activates audible alarming system.
1 = Output to activate audible alarming system is ON.

192 EIO0000001107 05/2020

 WDINPUT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WDINPUT_ST WDINPUT_ST_DDT Function block status handles data structure (communication with
Supervision)

Other DDTs which are used with WDINPUT DFB to function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WDINPUT_ST_DDT Type
The following table describes the structure of the derived data type WDINPUT_ST_DDT for the
WDINPUT DFB:

Name Type Description

STW WORD Status word
CFGW WORD Configuration word
ALW WORD Alarm word

WDINPUT_SC.STW Word Structure

STW element provides a means to monitor the DFB status, usually from the monitoring subsystem
(Vijeo Citect supervision-SCADA).
Bit description of the STW element:

Bit Name Description

0 PV For detailed description, refer to Outputs (see page 192).
1 ALARM 1 = Alarm evaluated based on the PV value.
2 BADST 1 = Indicates whether the input channel is operational or not. Reproduces the
CHFAILURE input value.0 = Input channel is operational1 = Input channel is not
operational
3 WATCH 1 = Indicates if the alarm is being monitored. Reproduces the WATCH input value.
4 ALARMST 1 = PV value that should be considered as an alarm. Reproduces the ALARMST input
value.

EIO0000001107 05/2020 193

WDINPUT

WDINPUT_SC.CFGW Word Structure

CFGW element provides a means to control the DFB, usually from the monitoring subsystem (Vijeo
Citect supervision-SCADA).
Bit description of the CFGW element:

Bit Name Description

0 ALARMEN Enables or disables the alarm evaluation.
1 = Alarm is enabled
1 SIMMD Enables the digital input to be set to Simulation mode or Normal mode.
 0 = Simulation mode
 1 = Normal mode

2 SIM 1 = Enables the simulated input value to be selected.

WDINPUT_SC.ALW Word Structure

ALW element provides a means to create the alarms, usually used in the monitoring subsystem
(Vijeo Citect supervision-SCADA).
Bit description of the ALW element:

Bit Name Description

0 BADST Alarm for non-operational digital input channel.
1 ALARM Alarm for WDINPUT DFB.

194 EIO0000001107 05/2020

 WDINPUT

Public Variables

Public Variable Description

Variable Type Description

SC WDINPUT_SC_DDT Function block configuration and control data structure.

WDINPUT_SC_DDT Type
The following table describes the structure of the derived data type WDINPUT_SC_DDT of the
WDINPUT DFB:

Name Type Description

PV BOOL Read only access.
1 = Timed input value.
For detailed description, refer to Outputs (see page 192).
ALARM BOOL Read only access.
1 = Alarm active in the function block.

EIO0000001107 05/2020 195

WDINPUT

Usage

Overview
Examples in this manual are given for information only.

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

The CHIN input pin is connected to any of the digital input channel.
You can enter the condition in which alarm has to be considered (0 or 1) at ALARMST to enable the
alarm. Click ALARM ENABLED in the faceplate and set the DFB input WATCH.
Alarm can be made on or off with the delay as per the value entered in TONSP/TOFFSP.
The processed digital input value is moved to DFB output PV. In case of alarm, the DFB output
ALARM is set.

196 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WDOUTPUT
EIO0000001107 05/2020

Chapter 14
WDOUTPUT: Digital Output

WDOUTPUT: Digital Output

Overview
This chapter describes the control services provided by WDOUTPUT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 198
Description 199
DFB Representation 200
Inputs 201
Outputs 202
Inputs/Outputs 203
Public Variables 205
Usage 206

EIO0000001107 05/2020 197

WDOUTPUT

Introduction

General
The WDOUTPUT DFB is used for conditioning a digital signal usually associated with a physical
output.
The following table describes the main functions of this DFB:

Function Description
Diagnosis The function block manages the diagnostic status of the signal if the
peripherals used provide it and assigns the value that is configured for
different scenarios.
Interlocking The module makes it possible to move to the defined position if an active
interlock that requires this move is detected. An interlock bypass function is
available.
Owner The module manages which control system level (Operator or Program) is
the owner. As a result, it is responsible for setting the set point for the desired
position.

198 EIO0000001107 05/2020

 WDOUTPUT

Description

Operating Modes
The WDOUTPUT DFB conditions the signals sent from from controller to the field devices connected
to the digital output card.
It supports the following modes of operation:
 Program mode - In this mode, the WDOUTPUT DFB takes the input from the pin RSP and
calculates the value and gives it in the pin CHOUT. The current set point is displayed at the output
SP.
The pin TRACK determines if the remote set point (RSP) input is considered (0) or not (1) for the
CHOUT output calculation. This output is used to report to the algorithm connected to the RSP
input (that is a PID) whether the control loop is open (TRACK = 1) or not (TRACK = 0). As a result,
the control loop can be repositioned in terms of the output set point that is really having an effect.
 Operator mode - You can enter the inputs at the set point through the faceplate and hold the
buttons ON and OFF.
The DFB handles the interlock and you have the provision to bypass the interlock.

EIO0000001107 05/2020 199

WDOUTPUT

DFB Representation

Overview
This figure shows the FBD representation of the WDOUTPUT DFB:

200 EIO0000001107 05/2020

 WDOUTPUT

Inputs

Input Parameter Description

Parameter Type Description

CHFAILURE BOOL Indicates whether the output channel associated with the CHOUT
output is inoperable or not.
1 = Channel is inoperable.
RSP BOOL Remote set point. Usually set by the continuous control; for
example, by a PID controller output.
1 = Remote set point is high.
ILCKSP BOOL Set point is used when the DFB is interlocked.
 0 = When DFB is interlocked, value 0 moves to CHOUT.
 1 = When DFB is interlocked, value 1 moves to CHOUT.

ILCK BOOL The device has interlocked at the defined position.

 0 = Normal condition
 1 = Interlock condition
DEVMNTST WDEVMNT_ST_DDT Structure from WDEVMNTST DFB.
ILCKCONDST WCONDSUM_ST_DDT Structure from WCONDSUM DFB for ILCK (interlock).

EIO0000001107 05/2020 201

WDOUTPUT

Outputs

Output Parameter Description

Parameter Type Description

CHOUT BOOL Calculated value of the output.
1 = Calculated value of the output is high.
The output calculation that the DFB performs is given below:
SC.ILCKD CHOUT
ILCKSP
ON
SP
OFF
SP BOOL 1 = Current setpoint is high
The output calculation that the DFB performs is given below:
OWNER REM SP
OFF = Program – –
ON = Operator
OFF OFF SC.LP
OFF ON RSP
ON – DOUTPUT_ST.CFGW.LSP
TRACK BOOL 1 = RSP is considered for the CHOUT output calculation
This output is used to report to the algorithm connected to the RSP input (that
is a PID), whether the control loop is open (TRACK = 1) or not (TRACK = 0). So
that, you can do the reposition of control loop in terms of output set point that
has an effect.
SPEAKER BOOL Activates audible alarming system.
1= Output to activate audible alarming system is ON.
SMS BOOL 1= Output for messaging alarm is ON.
SMSPRI INT Priority level for messaging SMS.

202 EIO0000001107 05/2020

 WDOUTPUT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WDOUTPUT_ST WDOUTPUT_ST_DDT Function block status handles data structure (communication
with Supervision)

Other DDTs which are used with WDOUTPUT DFB to function are WCONDSUM_ST_DDT and
WDEVMNT_ST_DDT.
NOTE: Refer to the WCONDSUM (see page 343) and WDEVMNT (see page 333) sections for
detailed description.

WDOUTPUT_ST_DDT Type
The following table describes the structure of the derived data type WDOUTPUT_ST_DDT for the
WDOUTPUT DFB:

Name Type Description

STW WORD Status word
CFGW WORD Configuration word
SPRHCNT UINT Set point for running hours counter
OCPREWARN UINT Pre alert for operations counter
SPMCNT UINT Set point for operations counter
TCPREWARN UINT Pre alert for time counter
SPTC UINT Set point for time counter
ALW WORD Alarm word
SEL UINT Selection for Maintenance modes

EIO0000001107 05/2020 203

WDOUTPUT

WDOUTPUT_ST.STW Word Structure

Bit description for the STW element:

Bit Name Description

0 BADST Indicates the output channel inoperable condition. Reproduces the CHFAILURE input
value.
1 ILCK IInterlocks the device at the defined-position.
2 REM Allows the DFB to be configured for a remote set point (RSP = 1) or local set point
(LSP = 0).
3 OP Calculated value of the output.
For detailed description, refer to Outputs (see page 202).

WDOUTPUT_ST.CFGW Word Structure

Bit description for the CFGW element:

Bit Name Description

0 OWNER Enables you to configure whether the set point is determined by the Program (0) or
the Operator (1).
1 ILCKBP 1= Allows the interlock to be bypassed.
2 LSP 1 = 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 this case, it can be modified
from the monitoring subsystem.

WDOUTPUT_ST.ALW Word Structure

Bit description for the ALW element:

Bit Name Description

0 BADST Digital output channel inoperbale alarm.
9 OCPREWARN Pre alert for operations counter.
10 OCWARN Alert for operations counter.
11 TCPREWARN Pre alert for time counter.
12 TCWARN Alert for time counter.

204 EIO0000001107 05/2020

 WDOUTPUT

Public Variables

Public Variable Description

Variable Type Description

SC WDOUTPUT_SC_DDT Function block configuration and control
data structure

WDOUTPUT_SC_DDT Type
The following table describes the structure of the derived data type WDOUTPUT_SC_DDT of the
WDOUTPUT DFB:

Name Type Description

OWNER BOOL Read only access.
 0 = Owner for DFB operation is Program.
 1 = Owner for DFB operation is Operator.
LSP BOOL Read/write access.
 0 = Current set point (SP output) is continuously copied to this variable.
 1 = 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).
REM BOOL Read/write access.
 0 = Allows the DFB to be configured for local set point (LSP).
 1 = Allows the DFB to be configured for remote set point (RSP).

SP BOOL Read only access.

For detailed description, refer to Outputs (see page 202).
OP BOOL Read only access.
1 = Calculated value of output is high.
TRACK BOOL Read only access.
1 = RSP is considered for the CHOUT output calculation.
This output is used to report to the algorithm connected to the RSP input
(that is a PID), whether the control loop is open (TRACK = 1) or not (TRACK
= 0). So that, you can reposition the control loop in terms of the output set
point that has an effect
BADST BOOL Read only access.
1 = Active alarm for digital output inoperable channel.
ILCKD BOOL Read only access.
The signal is evaluated based on the ILCK input and ILCKBP input/output.
1 = DFB is in interlock state.

EIO0000001107 05/2020 205

WDOUTPUT

Usage

Overview
Examples in this manual are given for information only.

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

The WDOUTPUT DFB requires the following external connections.

 The WCONDSUM DFB is to be connected to the ILCK pin, which can handle a maximum of fifteen
interlocks.
 CHOUT is to be connected to a WDEVMNT DFB if device management functions are required.

206 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
Generic Process
EIO0000001107 05/2020

Part III
Generic Process

Generic Process

Overview
The following part describes the generic process objects.

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

1For 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.

EIO0000001107 05/2020 207

Generic Process

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
15 WPUMPSEL: Pump Selection 209
16 WPUMPSEL1: Enchanced Pump Selection 219
17 WDMFCTL: Dual Media Filter Management 229
18 WFLOWCALC: Flow Calculation 243
19 WFLOWCTL: Flow Control 287
20 WAERACTL: Aeration Control Block 297
21 WSCHEDULER: Scheduler Function Management 311

208 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WPUMPSEL
EIO0000001107 05/2020

Chapter 15
WPUMPSEL: Pump Selection

WPUMPSEL: Pump Selection

Overview
This chapter describes the control services provided by WPUMPSEL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 210
DFB Representation 211
Inputs 212
Outputs 213
Inputs/Outputs 214
Public Variables 217
Usage 218

EIO0000001107 05/2020 209

WPUMPSEL

Introduction

General
The WPUMPSEL DFB checks status and controls operations of maximum five pumps.
The function block supports two modes of operation:
In Program mode, the function block receives run feedback from all activated pumps and
calculates the number of operation hours of each pump. The maximum number of operation hours
per cycle is given to each pump through the input-output WPMPSEL_ST.PMPHRSET. After
completion of the set operation hours, the function block changes the working pumps into Standby
mode and standby pumps into Working mode. The cycle continues in this manner. The function
block accepts the pump healthy signal and ignores the operation if any of the pumps are not
healthy.
In Manual mode, the Operator switches over between pumps by using the buttons in the faceplate.

210 EIO0000001107 05/2020

 WPUMPSEL

DFB Representation

Overview
This figure shows the FBD representation of the WPUMPSEL DFB:

EIO0000001107 05/2020 211

WPUMPSEL

Inputs

Input Parameter Description

Parameter Type Description

START BOOL 1 = Starts the sequence.
FBPMP1 BOOL Feedback signal of operation from pump 1.
1= Pump1 running
FBPMP2 BOOL Feedback signal of operation from pump 2.
1= Pump2 running
FBPMP3 BOOL Feedback signal of operation from pump 3.
1= Pump3 running
FBPMP4 BOOL Feedback signal of operation from pump 4.
1= Pump4 running
FBPMP5 BOOL Feedback signal of operation from pump 5.
1= Pump5 running
HLTYPMP1 BOOL 1 = Healthy signal from pump 1.
HLTYPMP2 BOOL 1 = Healthy signal from pump 2.
HLTYPMP3 BOOL 1 = Healthy signal from pump 3.
HLTYPMP4 BOOL 1 = Healthy signal from pump 4.
HLTYPMP5 BOOL 1 = Healthy signal from pump 5.

212 EIO0000001107 05/2020

 WPUMPSEL

Outputs

Output Parameter Description

Parameter Type Description

PMP1MD BOOL Indicates operating mode of pump 1.
 0 = Standby mode
 1 = Auto mode
PMP2MD BOOL Indicates operating mode of pump 2.
 0 = Standby mode
 1 = Auto mode
PMP3MD BOOL Indicates operating mode of pump 3.
 0 = Standby mode
 1 = Auto mode
PMP4MD BOOL Indicates operating mode of pump 4.
 0 = Standby mode
 1 = Auto mode
PMP5MD BOOL Indicates operating mode of pump 5.
 0 = Standby mode
 1 = Auto mode
PMP1HR REAL Indicates operating minutes of pump 1.
PMP2HR REAL Indicates operating minutes of pump 2.
PMP3HR REAL Indicates operating minutes of pump 3.
PMP4HR REAL Indicates operating minutes of pump 4.
PMP5HR REAL Indicates operating minutes of pump 5.
ALARM BOOL Alarm status:
1 = Active Alarm
WARN BOOL Alert status:
1 = Active Alert

EIO0000001107 05/2020 213

WPUMPSEL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WPUMPSEL_ST WPUMPSEL_ST_DDT Structure to interface the DFB with supervision.

WPUMPSEL_ST_DDT Type
This table describes the structure of the derived data type WPUMPSEL_ST_DDT for the WPUMPSEL
DFB:

Name Type Description

STW WORD This variable provides the status normally used from the monitoring
subsystem and allows data to be retained in memory.
CFGW WORD This variable provides the data to control the DFB from the monitoring
subsystem.
ALW WORD This variable provides the data to generate the alarms usually used in
the monitoring subsystem.
PMP1AOPHR REAL Actual operation hours of pump 1.
PMP2AOPHR REAL Actual operation hours of pump 2.
PMP3AOPHR REAL Actual operation hours of pump 3.
PMP4AOPHR REAL Actual operation hours of pump 4.
PMP5AOPHR REAL Actual operation hours of pump 5.
PMP1TOPHR REAL Total actual operation hours of pump 1.
PMP2TOPHR REAL Total actual operation hours of pump 2.
PMP3TOPHR REAL Total actual operation hours of pump 3.
PMP4TOPHR REAL Total actual operation hours of pump 4.
PMP5TOPHR REAL Total actual operation hours of pump 5.
PMP1OPHRSET REAL Maximum operation\working hours setting for pump 1.
PMP2OPHRSET REAL Maximum operation\working hours setting for pump 2.
PMP3OPHRSET REAL Maximum operation\working hours setting for pump 3.
PMP4OPHRSET REAL Maximum operation\working hours setting for pump 4.
PMP5OPHRSET REAL Maximum operation\working hours setting for pump 5.
PMPUSENO INT Total number of pumps used (= running pumps + standby pumps).
PMPRUNNO INT Total number of pumps in Run mode.
PMPTIMERST WORD Pump reset time.

214 EIO0000001107 05/2020

 WPUMPSEL

WPUMPSEL_ST.STW Word Structure

STW element provides the data to monitor the DFB status usually used from the monitoring
subsystem (Supervision).
Bit description of STW

Bit Description
3 SEQSTART.
4 PMP1MD.
Refer to the PMP1MD output (see page 213).
5 PMP2MD.
Refer to the PMP2MD output (see page 213).
6 PMP3MD.
Refer to the PMP3MD output (see page 213).
7 PMP4MD.
Refer to the PMP4MD output (see page 213).
8 PMP5MD.
Refer to the PMP5MD output (see page 213).
12 ALARM.
Refer to the ALARM output (see page 213).
14 WARN.
Refer to the WARN output (see page 213).

EIO0000001107 05/2020 215

WPUMPSEL

WPUMPSEL_ST.CFGW Word Structure

CFGW element provides the data to control the function DFB used from the monitoring subsystem
(Supervision).
Bit description of CFGW:

Bit Name Description

2 RUNPMP1 Run command for pump 1.
3 RUNPMP2 Run command for pump 2.
4 RUNPMP3 Run command for pump 3.
5 RUNPMP4 Run command for pump 4.
6 RUNPMP5 Run command for pump 5.
7 STBYPMP1 Stand by command for pump 1.
8 STBYPMP2 Stand by command for pump 2.
9 STBYPMP3 Stand by command for pump 3.
10 STBYPMP4 Stand by command for pump 4.
11 STBYPMP5 Stand by command for pump 5.
12 SEQSTART Used to start the sequence.
13 ALARMEN Enables alarm monitoring.
14 WARNEN Enables alert monitoring.

WPUMPSEL_ST.ALW Word Structure

ALW element provides the data to generate the alarms, usually used in the monitoring subsystem
(Supervision).
Bit description of ALW :

Bit Name Description

1 PMP1FLT Pump 1 is unhealthy.
2 PMP2FLT Pump 2 is unhealthy.
3 PMP2FLT Pump 3 is unhealthy.
4 PMP4FLT Pump 4 is unhealthy.
5 PMP5FLT Pump 5 is unhealthy.
6 WRONGCLASSPMP Wrong classification of pumps.
7 ALLSTDBYPMP All stand-by pumps.

216 EIO0000001107 05/2020

 WPUMPSEL

Public Variables

Public Variable Parameter Description

Parameter Type Description

SC WPMPSEL_SC_DDT Provides data needed for the pump status and to control it from the
sequential control.

WPUMPSEL_SC_DDT Type
This table describes the structure of the derived data type WPUMPSEL_SC_DDT:

Name Type Description

PMPUSENO INT Read/write access. Total number of pumps used (Running pumps + Standby
pumps).
OWNER BOOL Read only access.
Owner:
 0 = Program
 1 = Operator

EIO0000001107 05/2020 217

WPUMPSEL

Usage

Overview
Examples in this manual are given for information only.

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

You can use the pump-selection DFB along with the motor-control DFBs as shown in the figure.
The function block takes as input, the running feedback signals from all active pumps and
calculates the number of operation hours of each pump.
After the set operation hours are completed, the DFB changes the working pumps to Standby
mode and standby pumps to Working mode.
To provide a status of the motors or pumps, the detected failure condition signal of the function
block is connected as a feedback to the WPUMPSEL DFB.Hence, the function block accepts the
pump healthy signal and ignores the operation if any of the pumps are not healthy.

218 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WPUMPSEL1
EIO0000001107 05/2020

Chapter 16
WPUMPSEL1: Enchanced Pump Selection

WPUMPSEL1: Enchanced Pump Selection

Overview
This chapter describes the control services provided by WPUMPSEL1 DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 220
DFB Representation 221
Inputs 222
Outputs 223
Inputs/Outputs 224
Public Variables 226
Usage 227

EIO0000001107 05/2020 219

WPUMPSEL1

Description

Function Description
The WPUMPSEL1 DFB checks the status and controls the operations of a maximum five pumps.
The following table describes the main functions of this DFB:

Function Description
Selection Selects the active pumps.The pumps with the minimum run hours are selected for
operation. The pumps with the maximum run hours are switched off. Only when the
pump is in program mode with SC.REM = 1, the pump selection block controls the
pumps.
Standby (In case of If an inoperable condition is detected in an active pump in the field, a Stop command
inoperable pump) is issued from block to inoperable pump and another pump with the minimum run hour
start.
When the detected fault status of a pump is reset, the pump automatically goes to
Standby mode and waits for the next command from the next calculation/switching
caused by the following factors:
 Change in the number of requested pumps.
 Detected failure of an active pump and switch over to a standby one.
 Recalculation is requested or forced.

NOTE: If the number of active pumps is less than the number of requested pumps and
the motor returns from detected fault-status, the pump restarts automatically.
Recalculation Enables to recalculate the ordering of the motors based on the operating hours.This
data helps you to switch over of pumps based on recalculation of the operating hours.
Enables you to enter a time duration after which the DFB recalculates the running hour
data and starts the least run pumps as per the set point. For example, if pumps A and
B are running for more than 2 hours as per set point and pump C and D are running for
less than the 2 hours and if you set the duration as 2 hours for recalculation, the DFB
recalculates and gives commands to pump C and D to run after 2 hours.
Owner selection In Program mode, the pump selection happens based on the run hours. In operator
mode, the operator can choose the motors to run from the faceplate.

220 EIO0000001107 05/2020

 WPUMPSEL1

DFB Representation

Overview
This figure shows the FBD representation of the WPUMPSEL1 DFB:

EIO0000001107 05/2020 221

WPUMPSEL1

Inputs

Input Parameter Description

Parameter Type Description

RUN BOOL Selection bit for pump sequence .
 0 = Disables the operation of pump selection block
 1 = Starts running of the pumps sequentially.
PMPRUNNO UINT Number of pumps in operation depending on the process
requirement.
RECALC BOOL 1 = Recalculates and chooses the pump with least running hour.
Recalculation-input is an additional feauture that lets the block to
recalculate the sequencing of pumps based on the number of hours
in Run mode.This input is used only if the end-user wants to force a
switching based on a recalculation of number of hours in
operation.Typically, in applications where you have a 24/7 operation
of the motor(s).
P1FAILD BOOL Healthy signal from pump 1.
1 = Unhealthy
P2FAILD BOOL Healthy signal from pump 2.
1 = Unhealthy
P3FAILD BOOL Healthy signal from pump 3.
1 = Unhealthy
P4FAILD BOOL Healthy signal from pump 4.
1 = Unhealthy
P5FAILD BOOL Healthy signal from pump 5.
1 = Unhealthy
RHCNTP1 DINT Run hour counter of pump 1 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).
RHCNTP2 DINT Run hour counter of pump 2 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).
RHCNTP3 DINT Run hour counter of pump 3 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).
RHCNTP4 DINT Run hour counter of pump 4 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).
RHCNTP5 DINT Run hour counter of pump 5 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).

222 EIO0000001107 05/2020

 WPUMPSEL1

Outputs

Output Parameter Description

Parameter Type Description

RUNCMDP1 BOOL Indicates remote set point status of pump 1.
1 = Run pump 1.
RUNCMDP2 BOOL Indicates remote set point status of pump 2.
1 = Run pump 2.
RUNCMDP3 BOOL Indicates remote set point status of pump 3.
1 = Run pump 3.
RUNCMDP4 BOOL Indicates remote set point status of pump 4.
1 = Run pump 4.
RUNCMDP5 BOOL Indicates remote set point status of pump 5.
1 = Run pump 5.
FBERRORP1 BOOL 1 = Detected error in feedback for pump 1.
FBERRORP2 BOOL 1 = Detected error in feedback for pump 2.
FBERRORP3 BOOL 1 = Detected error in feedback for pump 3.
FBERRORP4 BOOL 1 = Detected error in feedback for pump 4.
FBERRORP5 BOOL 1 = Detected error in feedback for pump 5.

EIO0000001107 05/2020 223

WPUMPSEL1

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WPUMPSEL1_ST WPUMPSEL1_ST_DDT Structure to interface the DFB with supervision.

WPUMPSEL1_ST_DDT Type
The following table describes the structure of the derived data type WPMPSEL1_ST_DDT of the
WPMPSEL1 DFB.

Name Type Description

STW WORD Provides the status, used from the monitoring subsystem, and
allows data to retain in memory.
CFGW WORD Provides the means to control the function block from the
monitoring subsystem.
ALW WORD Alarm word for alarms and alerts.
RHCNTP1 DINT Actual operation hours of pump1.
RHCNTP2 DINT Actual operation hours of pump 2.
RHCNTP3 DINT Actual operation hours of pump 3.
RHCNTP4 DINT Actual operation hours of pump 4.
RHCNTP5 DINT Actual operation hours of pump 5.
PUMPUSENO UINT Total number of pumps available.
PUMPUSENO UINT Number of pumps running.

WPUMPSEL1_ST.STW Word Structure

Bit description of the STW element:

Bit Description
4 RUNCMDP1 - Refer to RUNCMDP1 output (see page 223).
5 RUNCMDP2 - Refer to RUNCMDP2 output (see page 223).
6 RUNCMDP3 - Refer to RUNCMDP3 output (see page 223).
7 RUNCMDP4 - Refer to RUNCMDP4 output (see page 223).
8 RUNCMDP5 - Refer to RUNCMDP5 output (see page 223).

224 EIO0000001107 05/2020

 WPUMPSEL1

WPUMPSEL1_ST.CFGW Word Structure

Bit description of the CFGW element:

Bit Name Description

2 RUNCMDP1 Run command for Pump 1 in Operator mode.
3 RUNCMDP2 Run command for Pump 2 in Operator mode.
4 RUNCMDP3 Run command for Pump 3 in Operator mode.
5 RUNCMDP4 Run command for Pump 4 in Operator mode.
6 RUNCMDP5 Run command for Pump 5 in Operator mode.

WPUMPSEL1_ST.ALW Word Structure

NOTE: Alert/alarm will be generated when corresponding bits of ALW are high.
Bit description of the ALW element:

Bit Description
11 Number of pumps required is not available.

EIO0000001107 05/2020 225

WPUMPSEL1

Public Variables

Public Variable Parameter Description

Variable Type Description

SC WPMPSEL1_SC_DDT Provides data needed for the pump status and to
control it from the sequential control.

WPMPSEL1_SC_DDT Type
The following table describes the structure of the derived data type WPMPSEL1_SC_DDT for the
WPMPSEL1 DFB.

Name Type Description

USEPUMPNO INT Read/write access.
Total number of pumps available. Configure this variable
according to the number of pumps required in the process.
OWNER BOOL Read only access.
Owner:
 0 = Program
 1 = Operator

226 EIO0000001107 05/2020

 WPUMPSEL1

Usage

Overview
Examples in this manual are given for information only.

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

WPUMPSEL1 is connected to the motor DFBs as shown below. The run hour is fed to the
WPUMPSEL1 DFB from the WDEVMNT (device maintenance DFB). In operator mode, you can
connect interlock condition and Out of service mode to the PFAILD pin of the corresponding pump.
The FAIL and the RUN FEEDBACK are the other inputs to the WPUMPSEL1 DFB.

EIO0000001107 05/2020 227

WPUMPSEL1

228 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WDMFCTL
EIO0000001107 05/2020

Chapter 17
WDMFCTL: Dual Media Filter Management

WDMFCTL: Dual Media Filter Management

Overview
This chapter describes the control srevices by the WDMFCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 230
Description 231
DFB Representation 233
Inputs 234
Outputs 235
Inputs/Outputs 236
Public Variables 241
Usage 242

EIO0000001107 05/2020 229

WDMFCTL

Introduction

General
Dual media filters are used in waste water treatment plants for filtering, backwash, and short flush
operations.

230 EIO0000001107 05/2020

 WDMFCTL

Description

The WDMFCTL DFB controls the dual media filter equipment used in waste water treatment plants.
The major operations of this equipment are filtering, backwash, and short-flush. The DFB facilitates
these operations . User has to configure all the equipment for various operations (filtering,
backwash, and short flush).
The table below describes the functions of the DFB:

Function Description
Operations The operations controlled by the DFB are:
 Filtering
 Backwash
 Short flush
 Idle

Filtering The filtering operation is not based on pre-configured timings. The switching
from backwash sequence to filtering operation depends on the input to
START_BW pin or the dirty status of the filter.
The filtering operation does not have any alarms.
Backwash Backwash operation is initiated when START_BW (start backwash) pin is
high. The DFB can handle a maximum eight backwash operations. The
operations are controlled in a sequential manner. You can configure the
number of backwash operations.
The backwash operation sequence is initiated depending on the step delay
and a step feedback input from the DFB pin. Step delay is the duration of
each of the steps.
A common timer preset value is configured for all the steps. The timer-done
bit is enabled,every time the value of the timer value matches the preset
value.
An alarm for feedback is generated for each of the operational steps, if the
feedback is not enabled within the specified common time out. After the
completion of backwash sequence and the START_BW pin becomes low, the
dual media filter (DMF) switches to Filter mode. If the START_BW pin is high
even after the completion of backwash operational sequence, an alarm is
generated with the step output high.
The step delay for each of the steps is configurable from the PES and
faceplates.
The sequence stops in case of an alarm.
If there is any steps without feedback you have to force the corresponding
step feedback pin to HIGH.
Idle This input pin forces the filter to switch to Idle mode. Idle mode enabled only
in Filtering mode.
If a backwash is required during the Idle mode, it will start only after the
completion of Idle mode,

EIO0000001107 05/2020 231

WDMFCTL

Function Description
Short flush The short flush is optional configuration.You can select short flush operation
from the faceplate.
The short flush operation is a one-step operation. The alarm for step delay
is applicable for short flush operation.
Device maintenance The device maintenance is based on the filtering hours,number of
backwash operations, and calendar days.
Owner selection In the Operator mode, the buttons on the faceplate enable you to start and
stop various operations. The backwash operational sequence is initiated by
the respective push button in the faceplate.
Switching of modes:
 Program to operator: There is no switching during the backwash and
short flush operations.
 Operator to program: There is no switching during the backwash and
short flush operations.
Alarms management Eight feedback alarms for backwash step operations, one feedback alarm
for short flush operation and one alarm at the end of backwash sequence if
START_BW pin is high.

232 EIO0000001107 05/2020

 WDMFCTL

DFB Representation

Overview
This figure shows the FBD representation of the WDMFCTL DFB.

EIO0000001107 05/2020 233

WDMFCTL

Inputs

Input Parameter Description

Parameter Type Description

RSP BOOL Remote set point.
1 = Activates filter.
START_BW BOOL 1 = Starts a back wash operation
BW_FB1 BOOL Feedback status of backwash Step1.
1= Feedback received
BW_FB2 BOOL Feedback status of backwash Step2.
1 = Feedback received
BW_FB3 BOOL Feedback status of backwash Step3.
1 = Feedback received
BW_FB4 BOOL Feedback status of backwash Step4.
1 = Feedback received
BW_FB5 BOOL Feedback status of backwash Step5.
1 = Feedback received
BW_FB6 BOOL Feedback status of backwash Step6.
1 = Feedback received
BW_FB7 BOOL Feedback status of backwash Step7.
1 = Feedback received
BW_FB8 BOOL Feedback status of backwash Step8.
1 = Feedback received
SHTFLSH_FB BOOL Feedback status of shortflush.
1 = Feedback received
SET_IDLE BOOL 1 = Set to Idle mode.

234 EIO0000001107 05/2020

 WDMFCTL

Outputs

Output Parameter Description

Parameter Type Description

FILTER BOOL 1 = Activates filtering operation.
BW_OP1 BOOL 1 = Activates backwash operation 1.
BW_OP2 BOOL 1 = Activates backwash operation 2.
BW_OP3 BOOL 1 = Activates backwash operation 3.
BW_OP4 BOOL 1 = Activates backwash operation 4.
BW_OP5 BOOL 1 = Activates backwash operation 5.
BW_OP6 BOOL 1 = Activates backwash operation 6.
BW_OP7 BOOL 1 = Activates backwash operation 7.
BW_OP8 BOOL 1 = Activates backwash operation 8.
BW_FB8 BOOL 1 = Activates feedback for backwash operation 8.
IDLE BOOL 1 = Moves the filter into Idle mode.
ALARM BOOL 1 = Alarm is triggered.

EIO0000001107 05/2020 235

WDMFCTL

Inputs/Outputs

Input/Output Parameter Description

Input/Output Type Description

WDMFCTL_ST WDMFCTL_ST_DDT Supervision and configuration structure of WDMFCTL DFB.
WPARAM_ST WPARAM_ST_DDT Structure for handling step delay parameter.
WDMFMNT_ST BOOL Device maintenance structure.

WDMFCTL_ST_DDT Type
This structure contains the block control and status data for the for the WDMFCTL DFB.

Parameter Type Description

CFGW WORD Provides the means to control the valve from the monitoring subsystem.
STW WORD Provides the function block status, normally used from the monitoring
subsystem, and allows data to retain in memory.
ALW WORD Alarm word for alarms and alerts.

WPARAM_ST_DDT Type
This structure contains the block control and status data for the for the WDMFCTL DFB.

Parameter Type Description

STW_I WORD Provides the backwash step and shortflush status, normally
used from the monitoring subsystem, and allows data to retain
in memory.
BW01 TIME Backwash step delay 1.
BW02 TIME Backwash step delay 2.
BW03 TIME Backwash step delay 3.
BW04 TIME Backwash step delay 4.
BW05 TIME Backwash step delay 5.
BW06 TIME Backwash step delay 6.
BW07 TIME Backwash step delay 7.
BW08 TIME Backwash step delay 8.
SF TIME Short flush delay.
TIMEOUT TIME Common time out for backwash and shortflush.
BWPARNUM INT Number of backwash steps.

236 EIO0000001107 05/2020

 WDMFCTL

WDMFMNT_ST_DDT Type
This structure contains the block control and status data for the for the WDMFCTL DFB.

Parameter Type Description

CFGW WORD Maintenance configuration word.
STW WORD Maintenance indication word.
F_RHCNT DINT Filter running hour count.
B_MCNT DINT Backwash manoeuvres numbers.
F_SPRHCNT INT Setpoint for running hours counter.
F_RHPREWARN INT Pre alert for running hours counter.
ALW WORD Maintenance alarm word.
B_SPMCNT DINT Setpoint for backwash operations counter.
F_SPTC INT Setpoint for time counter.
F_TCPREWARN INT Setpoint for running hours counter.
B_OCPREWARN DINT Pre alert for operations counter.
NXTMNT INT Next maintenance.
F_RHPST DINT Preset for running hours.
B_TMCNT DINT Total manoeuvres numbers.
OHLUM DINT Filter operating hours left until maintenance of running hour.
OLUM DINT Operations left until maintenance of operations counter.
FRHCNT DINT Total filter running hour count.
BMCNT DINT Total manoeuvres numbers.
SEL WORD Selection of maintenance mode.

WDMFCTL_ST.CFGW Word Structure

CFGW element provides a means to control the FBD, usually from the monitoring subsystem
(Supervision).

Bit Description
0 Configuration of set point by Operator/Program.
 0 = Program
 1 = Operator

5 Command for filtering operation.

6 Command for backwash operation.
7 Command for shortflush operation.
8 Command for skip step operation.

EIO0000001107 05/2020 237

WDMFCTL

WPARAM_ST.STW_I Word Structure

This STW element provides a means to monitor the status of the function block, usually from the
monitoring subsystem (Supervision)

Bit Description
0 Indicates if filtering mode status.
Refer to FILTER (see page 235) output pin.
1 Indicates if backwash step1 status.
Refer to BW_OP1 (see page 235) output pin.
2 Indicates if backwash step2 status.
Refer to BW_OP2 (see page 235) output pin.
3 Indicates if backwash step3 status.
Refer to BW_OP3 (see page 235) output pin.
4 Indicates if backwash step4 status.
Refer to BW_OP4 (see page 235) output pin.
5 Indicates if backwash step5 status.
Refer to BW_OP5 (see page 235) output pin.
6 Indicates if backwash step6 status.
Refer to BW_OP6 (see page 235) output pin.
7 Indicates if backwash step7 status.
Refer to BW_OP7 (see page 235) output pin.
8 Indicates if backwash step8 status.
Refer to BW_OP8 (see page 235) output pin.
9 Indicates if shortflush status.
Refer to SHTFLSH output pin.
10 Indicates if idle status.
Refer to IDLE (see page 235) output pin.

WDMFMNT_ST.STW Word Structure

This STW element provides a means to monitor the device maintenance feature status of the
function block, usually from the monitoring subsystem (Supervision)

Bit Description
0 Device maintenance status. Activated when the hours counter exceeds the maximum
displayable value (65535).
1 Device maintenance status. Activated when the switching operations counter exceeds the
maximum displayable value (65535). Deactivated through

238 EIO0000001107 05/2020

 WDMFCTL

WDMFMNT_ST.CFGW Word Structure

This CFGW element provides a means to monitor the device maintenance feature of the function
block, usually from the monitoring subsystem (Supervision)

Bit Description
0 Device maintenance status. Allows to reset (1) the hours-of-operation totalizer.
Also,resets the internal seconds subtotal from the last hour-of-operation fraction.
The function block sets this signal to 0 once it is processed.
1 Device maintenance status. Allows to reset (1) the switching operation totalizer.
The function block sets this signal to 0 once it has been processed.

WDMFCTL_ST.ALW Word Structure

ALW element provides a means to create the alarms, usually from the monitoring subsystem
(Supervision).

Bit Description
2 Alarm if ST_BW pin is high after the completion of the backwash sequence.
6 Alarm for not confirmed shortflush operation.
7 Alarm for not confirmed backwash step1.
8 Alarm for not confirmed backwash step2.
9 Alarm for not confirmed backwash step3.
10 Alarm for not confirmed backwash step4.
11 Alarm for not confirmed backwash step5.
13 Alarm for not confirmed backwash step6.
14 Alarm for not confirmed backwash step7.
15 Alarm for not confirmed backwash step8.

WDMFMNT_ST.ALW Word Structure

ALW element provides a means to create the maintenance alarms, usually from the monitoring
subsystem (Supervision).

Bit Description
3 Pre alert for exceeded backwash sequences.
4 Alert for exceeded backwash sequences.
7 Pre alert for exceeded filtering hours.
8 Alert for exceeded filtering hours.
11 Pre alert for time counter.
12 Alert for time counter.

EIO0000001107 05/2020 239

WDMFCTL

WDMFCTL_SC_DDT Type

Parameter Type Description

OWNER BOOL Read only access. Setpoint is set by:
 0 = Program
 1 = Operator

240 EIO0000001107 05/2020

 WDMFCTL

Public Variables

Public Variable Parameter Description

Parameter Type Description

SC WDMFCTL _SC_DDT Provides data needed for the pump status and to
control it from the sequential control.

WDMFCTL_SC_DDT Type

Parameter Type Description

OWNER BOOL Read only access. Set point is set by:
 0 = Program
 1 = Operator

EIO0000001107 05/2020 241

WDMFCTL

Usage

Overview
Examples in this manual are given for information only.

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

The following figure is shown as an example for WDMFCTL. It does not require any additional DFBs
for its operation. The RSP pin is used to initiate the filtering operation and START_BW is the pin
which determines the start of a backwash sequence in the program mode of operation.

242 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WFLOWCALC
EIO0000001107 05/2020

Chapter 18
WFLOWCALC: Flow Calculation

WFLOWCALC: Flow Calculation

Overview
This chapter describes the Control services provided by WFLOWCALC objects.
The objects of this function calculate the flow discharge in the open channel for various
constructions such as weirs, flumes, notches and make data available be displayed as flow rate on
SCADA. 7 function blocks are available for different types of channel constructions. You can use
these objects in combination with AI Signal DFB from the General Purpose library.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
18.1 WREC_WEIR: Rectangular Weir 244
18.2 WTRAP_WEIR: Trapezoidal Weir 250
18.3 WV_WEIR: V Notch Weir 255
18.4 WREC_FLU: Rectangular Flume 261
18.5 WTRAP_FLU: Trapezoidal Flume 267
18.6 WPARSH_FLU: Parshall Flume 274
18.7 WU_FLU: U FLUME 280

EIO0000001107 05/2020 243

WFLOWCALC

Section 18.1
WREC_WEIR: Rectangular Weir

WREC_WEIR: Rectangular Weir

Overview
This section describes the WREC_WEIR DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Introduction 245
Description 246
DFB Representation 247
Inputs 248
Outputs 249

244 EIO0000001107 05/2020

 WFLOWCALC

Introduction

General
Weirs are installed in open channels to determine discharge. A sharp-crested rectangular weir is
a flat plate obstruction in an open channel flow path with a straight level opening to allow the water
flow over the weir.
It is used to measure the water flow over the weir (through the open channel) by measuring the
head of water over the weir crest.

EIO0000001107 05/2020 245

WFLOWCALC

Description

Functional Description
The WREC_WEIR DFB determines the discharge rate in a rectangular weir.
The discharge or flow is calculated in gallons per minute (gpm) and millions of gallons per day
(mgd) neglecting the velocity of approach. You can configure EN and ENO as additional
parameters.
Discharge equation:

246 EIO0000001107 05/2020

 WFLOWCALC

DFB Representation

Overview
This figure shows the FBD representation of the WREC_WEIR DFB.

EIO0000001107 05/2020 247

WFLOWCALC

Inputs

Input Parameter Description

Parameter Type Description

HEAD_FT REAL Head on the weir. At a measured point, it has to be greater than
four times H upstream from the weir.
LENGTH_F REAL Length of the weir (in feet).

248 EIO0000001107 05/2020

 WFLOWCALC

Outputs

Output Parameter Description

Parameter Type Description

GPM REAL Flow in gallons per minute (gpm).
MGD REAL Flow in millions of gallons per day (mgd).

EIO0000001107 05/2020 249

WFLOWCALC

Section 18.2
WTRAP_WEIR: Trapezoidal Weir

WTRAP_WEIR: Trapezoidal Weir

Overview
This section describes the WTRAP_WEIR DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Description 251
DFB Representation 252
Inputs 253
Outputs 254

250 EIO0000001107 05/2020

 WFLOWCALC

Description

Functional Description
The WTRAP_WEIR DFB determines the discharge rate of a Cipoletti or trapezoidal weir.
The discharge or flow is calculated in gallons per minute (gpm) and millions of gallons per day
(mgd) neglecting the velocity of approach.
Discharge equation:

EIO0000001107 05/2020 251

WFLOWCALC

DFB Representation

Overview
This figure shows the FBD representation of the WTRAP_WEIR DFB.

252 EIO0000001107 05/2020

 WFLOWCALC

Inputs

Input Parameter Description

Parameter Type Description

HEAD_FT REAL Head the weir (in feet).
LENGTH_F REAL Length of the weir (in feet). This has to be at least three times H and
four times H or longer.

EIO0000001107 05/2020 253

WFLOWCALC

Outputs

Output Parameter Description

Parameter Type Description

GPM REAL Flow in gallons per minute (gpm).
MGD REAL Flow in millions of gallons per day (mgd).

254 EIO0000001107 05/2020

 WFLOWCALC

Section 18.3
WV_WEIR: V Notch Weir

WV_WEIR: V Notch Weir

Overview
This section describes the WV_WEIR DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Introduction 256
Description 257
DFB Representation 258
Inputs 259
Outputs 260

EIO0000001107 05/2020 255

WFLOWCALC

Introduction

General
The V-notch weir is a triangular channel section used to measure small discharge values.

256 EIO0000001107 05/2020

 WFLOWCALC

Description

Overview
The WV_WEIR DFB determines the discharge rate of a 90° V-Notch weir.
Weirs are installed in open channels to determine discharge rate for a 90° V-Notch weir. The
discharge or flow is calculated in gallons per minute(gpm)and millions of gallons per day(mgd)
neglecting the velocity of approach. EN and ENO can be configured as additional parameters.
Discharge equation:

EIO0000001107 05/2020 257

WFLOWCALC

DFB Representation

Overview
This figure shows the FBD representation of the WV_WEIR DFB.

258 EIO0000001107 05/2020

 WFLOWCALC

Inputs

Input Parameter Description

Parameter Type Description

HEAD_FT REAL Vertical distance between the vortex or lowest part of the notch and
the elevation of the weir pond (in ft).

EIO0000001107 05/2020 259

WFLOWCALC

Outputs

Output Parameter Description

Parameter Type Description

GPM REAL Flow in gallons per minute (gpm).
MGD REAL Flow in millions of gallons per day (mgd).

260 EIO0000001107 05/2020

 WFLOWCALC

Section 18.4
WREC_FLU: Rectangular Flume

WREC_FLU: Rectangular Flume

Overview
This section describes the WREC_FLU DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Introduction 262
Description 263
DFB Representation 264
Inputs 265
Outputs 266

EIO0000001107 05/2020 261

WFLOWCALC

Introduction

General
A flume is a man-made channel for water, in the form of an open declined gravity chute whose walls
are raised above the surrounding terrain, in contrast to a trench or ditch. Flumes lead water from
a diversion dam or weir to their desired location. The flumes with rectangular cross section is called
a rectangular flume.

262 EIO0000001107 05/2020

 WFLOWCALC

Description

Functional Description
The WREC_FLU DFB determines the discharge rate of a rectangular flume. This DFB uses the ISO
4359 and 1983 methodology for the flume calculation.
The discharge or flow is calculated in m3/sec, gallons per minute (gpm) and millions of gallons per
day (mgd) ). You can configure EN and ENO as additional parameters.
Equations:

(Calculated from a numerical solution)

Conditions:
0 <= h <= 3 m; 0.01<b<16 m; b<B1<10,000; 0 <= P < 3 m ; 0 < L < 10,000 ; Cd >0; and (h∗b∗Cd/A)
< 0.93
Where: Cd = Coefficient of discharge of rectangular, trapezoidal, and U flumes (unit-less).
Cv = Coefficient of approach velocity of rectangular, trapezoidal, and U flumes (unit-less).
Cs = Shape coefficient for trapezoidal flume (unit-less).

EIO0000001107 05/2020 263

WFLOWCALC

DFB Representation

Overview
This figure shows the FBD representation of the WREC_FLU DFB.

264 EIO0000001107 05/2020

 WFLOWCALC

Inputs

Input Parameter Description

Parameter Type Description

B REAL Bottom width of flume throat (in m).
H REAL Measured head (in m).
L REAL Throat length of flume throat (in m).
P REAL Hump height (in m).
B1 REAL Approach bottom width (in m).
KNOWN_CV BOOL Coefficient value:
 0 = Coefficient value is calculated by the program.
 1 = Coefficient value (CV) is known.
CV_USER REAL Known coefficient (CV).

EIO0000001107 05/2020 265

WFLOWCALC

Outputs

Output Parameter Description

Parameter Type Description

Q REAL Flow in m3/sec.
GPM REAL Flow in gallons per minute (gpm).
MGD REAL Flow in millions of gallons per day (mgd).
ERROR_Q BOOL Status of flow value calculation.
 0 = No detected error.
 1 = Flow cannot be calculated.

266 EIO0000001107 05/2020

 WFLOWCALC

Section 18.5
WTRAP_FLU: Trapezoidal Flume

WTRAP_FLU: Trapezoidal Flume

Overview
This section describes the WTRAP_FLU DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Introduction 268
Description 269
DFB Representation 271
Inputs 272
Outputs 273

EIO0000001107 05/2020 267

WFLOWCALC

Introduction

General
Flumes with a trapezoid as its cross section are called trapezoidal flume.

268 EIO0000001107 05/2020

 WFLOWCALC

Description

Operating Modes
The WTRAP_FLU DFB determines the discharge rate of a trapezoidal flume. This DFB uses the ISO
4359 and 1983 methodology for the flume calculation.
The discharge or flow is calculated in m3/sec, gallons per minute(gpm) and millions of gallons per
day (mgd)). You can configure EN and ENO as additional parameters.
Equations:

(Calculated from a numerical solution)

EIO0000001107 05/2020 269

WFLOWCALC

(H = h, first time to get the value of C5 and the flow is re-computed 6 times for more accuracy).
0<= h <= 3 m ; 0.01< b < 16 m ; b < B1< 10,000 ; 0 <= P < 3 m ; 0 < L < 10,000 ; 0 < m < 100
0 < M1 < 10,000 ; (h∗b∗Cs/Area) < 0.93 and 0.02 <= mH/b <= 5.

270 EIO0000001107 05/2020

 WFLOWCALC

DFB Representation

Overview
This figure shows the FBD representation of the WTRAP_FLU DFB:

EIO0000001107 05/2020 271

WFLOWCALC

Inputs

Input Parameter Description

Parameter Type Description

B REAL Bottom width of flume throat (in m).
H REAL Measured head (in m).
M REAL Side slope of flume throat (in m).
L REAL Throat length of flume throat (in m).
P REAL Hump height (in m).
M1 REAL Approach side slope (in m).
B1 REAL Approach bottom width (in m).
KNOWN_VR BOOL  0 = Coefficient value is calculated by the program.
 1 = Coefficient values (CV and CS) are known.
CS_USER REAL Known coefficient value (CS).
CV_USER REAL Known coefficient value (CV).

272 EIO0000001107 05/2020

 WFLOWCALC

Outputs

Output Parameter Description

Parameter Type Description

Q REAL Flow in m3/sec.
GPM REAL Flow in gallons per minute (gpm).
MGD REAL Flow in millions of gallons per day (mgd).
ERROR_Q BOOL  0 = No detected error.
 1 = Flow cannot be calculated.

EIO0000001107 05/2020 273

WFLOWCALC

Section 18.6
WPARSH_FLU: Parshall Flume

WPARSH_FLU: Parshall Flume

Overview
This section describes the WPARSH_FLU DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Introduction 275
Description 276
DFB Representation 277
Inputs 278
Outputs 279

274 EIO0000001107 05/2020

 WFLOWCALC

Introduction

General
A parshall flume is a fixed hydraulic structure used in measuring volumetric flow rate in surface
water, waste water treatment plant, and industrial discharge applications. The parshall flume
accelerates flow though a contraction of both the parallel sidewalls and a drop in the floor at the
flume throat.

EIO0000001107 05/2020 275

WFLOWCALC

Description

Functional Description
The WPARSH_FLU DFB determines the discharge rate of a Parshall flume. The discharge or flow
is calculated in gallons per minute (gpm) and millions of gallons per day (mgd).
You can configure EN and ENO as additional parameters.
Discharge equation:

(For widths (W) ranging from 1...8 ft).

Discharge equation:

(For widths ranging from 10...50 ft).

276 EIO0000001107 05/2020

 WFLOWCALC

DFB Representation

Overview
This figure shows the FBD representation of the WPARSH_FLU DFB.

EIO0000001107 05/2020 277

WFLOWCALC

Inputs

Input Parameter Description

Parameter Type Description

H1 REAL Height (ft).
W REAL Width of the channel (ft).

278 EIO0000001107 05/2020

 WFLOWCALC

Outputs

Output Parameter Description

Parameter Type Description

GPM REAL Flow in gallons per minute (gpm).
MGD REAL Flow in millions of gallons per day (mgd).
ERROR_Q BOOL  0 = No detected error
 1 = Flow cannot be calculated

EIO0000001107 05/2020 279

WFLOWCALC

Section 18.7
WU_FLU: U FLUME

WU_FLU: U FLUME

Overview
This section describes the WU_FLU DFB.

What Is in This Section?

This section contains the following topics:
Topic Page
Introduction 281
Description 282
DFB Representation 283
Inputs 284
Outputs 285

280 EIO0000001107 05/2020

 WFLOWCALC

Introduction

General
Flumes with U shaped cross section are called U Flumes.

EIO0000001107 05/2020 281

WFLOWCALC

Description

Operating Modes
The WU_FLU DFB determines the discharge rate for a WU_FLU. This DFB uses the ISO 4359 and
1983 methodology for the flume calculation.
The discharge or flow is calculated in m3/sec, gallons per minute (gpm) and millions of gallons per
day (mgd).You can configure EN and ENO as additional parameters.
Equations:

(Calculated from a numerical solution).

(H = h, first time to get the value of Cu and the flow is re-computed six times for more accuracy.
Conditions:
0⇐ h⇐ 3 m; 0.01<b<16 m; 0⇐P< 3 m; 0<L<10,000; d<D<10,000; Cd>0; and (h∗d∗Cu/A)< 0.93.

282 EIO0000001107 05/2020

 WFLOWCALC

DFB Representation

Overview
This figure shows the FBD representation of the WU_FLU DFB

EIO0000001107 05/2020 283

WFLOWCALC

Inputs

Parameter Description

Parameter Type Description

H REAL Measured head (m).
L REAL Length of flume throat (m).
P REAL Hump height (m).
D REAL Diameter of throat of U flume (m).
D1 REAL Diameter of approach channel of U flume (m).
KNOWN_VR BOOL
 0 = Coefficient value is calculated by the program.
 1 = Coefficient values (CV and CU) are known.
CV_USER REAL CV coefficient known.
CU_USER REAL CU coefficient known.

284 EIO0000001107 05/2020

 WFLOWCALC

Outputs

Output Parameter Description

Parameter Type Description

Q REAL Flow in m3/sec.
GPM REAL Flow in gallons per minute (gpm).
MGD REAL Flow in millions of gallons per day (mgd).
ERROR_Q BOOL  0 = No detected error.
 1 = Flow cannot be calculated.

EIO0000001107 05/2020 285

WFLOWCALC

286 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WFLOWCTL
EIO0000001107 05/2020

Chapter 19
WFLOWCTL: Flow Control

WFLOWCTL: Flow Control

Overview
This chapter describes the control services provided by WFLOWCTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 288
DFB Representation 289
Inputs 290
Outputs 291
Inputs/Outputs 292
Public Variables 295
Usage 296

EIO0000001107 05/2020 287

WFLOWCTL

Introduction

General
The WFLOWCTL DFB controls the flow by controlling the operation of maximum five variable speed
pump. Operation of pumps include the start/stop and the speed set points management.The
controlled flow happens mainly in the chemical dosing operation in the water treatment plants.
The following table describes the main functions of this function block:

Function Description
Required Depending upon the flow set point, the required number of pumps are calculated from a PID
number of controller output. The function block chooses (n) out of 5 pumps, where ‘n’ is the number of
pumps required pumps for operation.
Speed The function block is capable of calculating the speed set points for the selected pumps to
calculation achieve the calculated flow set point.For example, consider a case, where the number of
pumps available is four, and calculated PID output is 60% (Considering PID output range is 0
to 100%) and the number of pumps running are three. So, two pumps would run at full speed
and third pump runs at 40% of the full speed to meet the flow calculations.
Selection The pump selection is based on the run hours of individual pumps. The pumps with least run
based on run hours are chosen for the operation.
hours The sorting happens every time at the start of an operation and the run hour sorting does not
happen during the runtime.
Standby (in If an inoperable condition is detected in an active pump in the field, a Stop command is issued
case of from block to inoperable pump and another pump with the minimum run hour start.
inoperable When a pump is reset from a detected fault status, this motor is automatically switched to
pump) Standby mode and is considered during the next calculation/switching caused by either of
following:
 Change of the number of required pumps
 Detected fault of an active pump -> switch over to a standby one
 Recalculation is requested/forced

If none of those actions happen the pump goes to Standby mode.

Owner Defines the ownership of the control from the module. In program (Owner) pumps and speed
selection set point selection happens based on the flow PID output while in operator (Owner), operator
can choose the pump to run from the faceplate and speed of the pump.

288 EIO0000001107 05/2020

 WFLOWCTL

DFB Representation

Overview
This figure shows the FBD representation of the WFLOWCTL DFB.

EIO0000001107 05/2020 289

WFLOWCTL

Inputs

Input Parameter Description

Parameter Type Description

FLOPIDIN WPIDIN_ST_DDT Flow PID input parameters (see page 325).
RECALC BOOL  0 = Enables switch over of pumps by calculating the operating
time of the pumps on fixed interval.
 1 = Recalculates and selects the pump with the least operating
time.
Set the interval after which the data recalculates.
P1FAILD BOOL Healthy signal from pump 1.
1 = Unhealthy.
P2FAILD BOOL Healthy signal from pump 2.
1 = Unhealthy.
P3FAILD BOOL Healthy signal from pump 3.
1 = Unhealthy.
P4FAILD BOOL Healthy signal from pump 4.
1 = Unhealthy.
P5FAILD BOOL Healthy signal from pump 5.
1 = Unhealthy.
RHCNTP1 DINT Run hour counter of pump 1 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).
RHCNTP2 DINT Run hour counter of pump 2 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).
RHCNTP3 DINT Run hour counter of pump 3 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).
RHCNTP4 DINT Run hour counter of pump 4 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).
RHCNTP5 DINT Run hour counter of pump 5 (connected to RHCNT pin of WDEVMNT
DFB of respective motor).
RUN BOOL  1 = Starts running the pumps sequentially (similar to enabling
the block).
 0 = Disables the operation of pump selection block.

290 EIO0000001107 05/2020

 WFLOWCTL

Outputs

Output Parameter Description

Parameter Type Description

RUNCMDP1 BOOL Remote set point status of pump 1.
1 = Runs pump 1.
RUNCMDP2 BOOL Remote set point status of pump 2.
1 = Runs pump 2.
RUNCMDP3 BOOL Remote set point status of pump 3.
1 = Runs pump 3.
RUNCMDP4 BOOL Remote set point status of pump 4.
1 = Runs pump 4.
RUNCMDP5 BOOL Remote set point status of pump 5.
1 = Runs pump 5.
FBERRORP1 BOOL 1 = Incorrect feedback status of Pump 1.
FBERRORP2 BOOL 1 = Incorrect feedback status of Pump 2
FBERRORP3 BOOL 1 = Incorrect feedback status of Pump 3.
FBERRORP4 BOOL 1 = Incorrect feedback status of Pump 4.
FBERRORP5 BOOL 1 = Incorrect feedback status of Pump 5.
FLOPIDOUT WPIDOUT_ST_DDT Flow PID output.
NEXTPMPSTPNO INT The next pump is stopped in case of a reduction in
demand.

EIO0000001107 05/2020 291

WFLOWCTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WFLOWCTL_ST WFLOWCTL_ST_DDT PLC Supervision variables.
FLOWOUT REAL Current output of the PID.
FLOWPIDPARA PARA_PIDFF PIDFF parameters.

WFLOWCTL_ST_DDT Type
The following table describes the structure of the derived data type WFLOWCTL_ST_DDT for the
WFLOWCTL DFB.

Name Type Description

STW WORD Provides the status, normally used from the monitoring
subsystem, and allows to retain data in the memory.
ALW WORD Alarm word.
CFGW WORD Provides the means to control the function block from the
monitoring subsystem.
SPEEDP1 REAL Speed of pump 1.
SPEEDP2 REAL Speed of pump 2.
SPEEDP3 REAL Speed of pump 3.
SPEEDP4 REAL Speed of pump 4.
SPEEDP5 REAL Speed of pump 5.
SPEEDPV1 REAL Speed PV of pump 1.
SPEEDP2 REAL Speed of pump 2.
SPEEDP3 REAL Speed of pump 3.
SPEEDP4 REAL Speed of pump 4.
SPEEDP5 REAL Speed of pump 5.
MAXSPEED REAL Maximum speed.
MINSPEED REAL Minimum speed.
FLOWPID_CFGW PIDCTL_CFG_DDT FLOWPID configuration.
FLOWPID_ST PIDCTL_ST_DDT FLOWPID status.
PUMPSEL1_ST WPUMPSEL1_ST_DDT Pump selection status.

292 EIO0000001107 05/2020

 WFLOWCTL

WFLOWPID_CFGW Word Structure

Name Type Description

WFLOWPID_CFGW PIDCTL_CFG_DDT FLOWPID configuration.
Name Type Description
OPHILIM REAL Output high limit.
OPLOLIM REAL Output low limit.
GAIN REAL Gain.
TI TIME Integral constant (TI).
TD TIME Derivative constant (TD).
KD TIME Proportional constant (KD).

WFLOWPID_ST Type

Name Type Description

WFLOWPID_ST PIDCTL_ST_DDT FLOWPID status.
Name Type Description
PV REAL Present value of measurement.
SP REAL Current set point.
OP REAL Current output.
STW WORD Status word.
CFGW WORD Configuration word.

EIO0000001107 05/2020 293

WFLOWCTL

WPUMPSEL1_ST Type

Name Type Description

WPUMPSEL1_ST WPUMPSEL1_ST_DDT FLOWPID status.
Name Type Description
RHCNTP1 DINT Actual operation hours of pump 1.
RHCNTP2 DINT Actual operation hours of pump 2.
RHCNTP3 DINT Actual operation hours of pump 3.
RHCNTP4 DINT Actual operation hours of pump 4.
RHCNTP5 DINT Actual operation hours of pump 5.
PUMPUSENO UINT Total number of pumps available.
PUMPRUNNO UINT Number of pumps running.
STW WORD Provides the status, used from the
monitoring subsystem and allows data
to retain in memory.
CFGW WORD Provides the means to control the
function block from the monitoring
subsystem.
ALW WORD Alarm word for alarms and alerts.

NOTE: For description of bit structure of STW , CFGW and ALW, refer to WPUMPSEL1 inputs/outputs
(see page 224).

294 EIO0000001107 05/2020

 WFLOWCTL

Public Variables

Public Variable Parameter Description

Variable Type Description

SC WFLOWCTL _SC_DDT Provides data needed for the pump status and to
control it from the sequential control.

WFLOWCTL_SC_DDT Type

Name Type Description

TOTPUMPNUM INT Read/write access. Total number of pumps available
PMPOWNER BOOL Read-only acces.
 0 = Owner for block operation is program
 1 = Owner for block operation is operator
FLOPIDPUB PIDCTL_SC_DDT Name Type Description
LSP REAL Local set point.
LOP REAL Local output.
OWNER REAL Owner.
 0 = Program
 1 = Operator
MAN BOOL 1 = Pass PID regulator
to Manual mode.
AUTO BOOL 1 = Pass PID regulator
to Auto mode.
MODE BOOL Work mode.
 0 = Manual
 1 = Auto
REM BOOL Establishes work
mode.
 0 = Local
 1 = Remote
ILCKD BOOL 1 = Regulator interlock.

EIO0000001107 05/2020 295

WFLOWCTL

Usage

Overview
Examples in this manual are given for information only.

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

WFLOWCTL requires a WPIDIN and WPIDOUT DFB for the PID input and output parameter
interfacing. The FAIL pin and the OOS pins of the WMOTORVS is interfaced to the FAILD pin of
WFLOWCTL. The RUNCMD pin and the SPEED pin of the WFLOWCTL is connected to the RSTART and
RSP pin WMOTRVS respectively

296 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WAERACTL
EIO0000001107 05/2020

Chapter 20
WAERACTL: Aeration Control Block

WAERACTL: Aeration Control Block

Overview
This chapter describes the control services provided by WAERACTL DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 298
Description 299
DFB Representation 300
Inputs 301
Outputs 302
Inputs/Outputs 303
Public Variables 307
Usage 309

EIO0000001107 05/2020 297

WAERACTL

Introduction

General
The WAERACTL controls the aeration process in water treatment plant. Aeration is a process
involved in the secondary stage treatment of waste water, in the waste water treatment plants.
Aeration is done based on the DO (dissolved oxygen) content in the water.
The following table describes the main functions of this function block:

Function Description
DO control DO control is used for maintaining the require amount of dissolved oxygen(DO) in the Zone.
For this a PID controller is used to control the opening of valve in one aeration zone. DO
Content can be varied by regulating the opening of the valve. The function block can control
a maximum of five zones in one aeration line. The Do setpoint is configurable.
Ammonium Determines the number of active aeration zones depending on the amount of ammonium
control present in the water. So it enables/disables the DO control of repective zone accordingly. The
priority number method is adapted for ammonium control. Ammonium control is an optional
control available.
The priority number for each line is calculated as shown below depending on the NH4
(Ammonium) PV value a priority number is calculated:
 Value < Low level => priority number = 1
 Low level < Value < Set point => Priority number = 2
 Set point < Value < High level => Priority number = 3
 Value > High level => priority number = 4
NOTE: If NH4 PV = NH4 SP, it falls in the lesser priority group (for example, LSP = 10, PV
= 20, SP = 20, HSP = 90, calculated priority is 2).
 If the priority number is greater than or equal to the zone priority number, the zone
becomes active.
 The calculated priority number is one less than the actual calculated priority number if there
is a sudden decrease in ammonium process value by AMMOD in TIMED duration.
 The calculated priority number is greater than the actual calculated priority number by one
when there is a sudden rate of increase in ammonium process value by AMMOD in TIMED
duration.
 If the zone is inactive, then respective zone PID is interlocked. If ammonium control is not
available by default, all the zones get active and you get an option from the faceplate to
activate or deactivate the zones.
Use the AMMOEN public variable to enable the ammonium control.
Pressure Controls the air blower speed. This is available as an optional control.The pressure in the line
control is measured and depending on the pressure set point ,the PID controls the speed of the
blower motor.
Use the PRSEN public variable to enable the pressure control.

298 EIO0000001107 05/2020

 WAERACTL

Description

General
This DFB controls the aeration process in water treatment plant. Aeration is a process involved in
the secondary stage treatment of waste water in the waste water treatment plants. Aeration is done
based on the DO (dissolved oxygen) content in the water.
For detail Control service information of PIDCTL Function block (which is used for zone's PID and
Pressure control PID) refer to Control service user guide of General Purpose library.

EIO0000001107 05/2020 299

WAERACTL

DFB Representation

Overview
This figure shows the FBD representation of the WAERACTL DFB.

300 EIO0000001107 05/2020

 WAERACTL

Inputs

Input Parameter Description

Parameter Type Description

AMMOIN REAL Ammonium process value.
ZONE1PIDIN WPIDIN_ST_DDT Zone 1 PID input parameters.
ZONE2PIDIN WPIDIN_ST_DDT Zone 2 PID input parameters.
ZONE3PIDIN WPIDIN_ST_DDT Zone 3 PID input parameters.
ZONE4PIDIN WPIDIN_ST_DDT Zone 4 PID input parameters.
ZONE5PIDIN WPIDIN_ST_DDT Zone 5 PID input parameters.
PRPIDIN WPIDIN_ST_DDT Pressure control PID input parameters.

EIO0000001107 05/2020 301

WAERACTL

Outputs

Output Parameter Description

Parameter Type Description

PID1OUT WPIDOUT_ST_DDT Zone1 PID output parameter.
PID2OUT WPIDOUT_ST_DDT Zone2 PID output parameter.
PID3OUT WPIDOUT_ST_DDT Zone3 PID output parameter.
PID4OUT WPIDOUT_ST_DDT Zone4 PID output parameter.
PID5OUT WPIDOUT_ST_DDT Zone5 PID output parameter.
PRPIDOUT WPIDOUT_ST_DDT Pressure control PID output parameter.

302 EIO0000001107 05/2020

 WAERACTL

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WAERACTL_ST WAERACTL_ST_DDT Structure to interface function block with Supervision.
WAERAPIDPAR WAERAPIDPAR_ST_DDT PIDFF parameters for each of the PIDs.
Z1OUT REAL Current output of zone 1 PID.
Z2OUT REAL Current output of zone 2 PID.
Z3OUT REAL Current output of zone 3 PID.
Z4OUT REAL Current output of zone 4 PID.
Z5OUT REAL Current output of zone 5 PID.
PROUT REAL Current output of pressure control PID.

WAERACTL_ST_DDT Type
The following table describes the structure of the derived data type WAERACTL_ST_DDT for the
WAERACTL DFB.

Parameter Type Description

STW WORD Provides the status, normally used from the monitoring
subsystem, and allows to retain data in the memory.
CFGW WORD Configuration word.
AMMOLOSP REAL Ammonium low set point.
AMMOHISP REAL Ammonium high set point.
AMMOPV REAL Ammonium current value of the measurement.
AMMOD REAL Maximum difference in the ammonium input value
during TIMED.
AMMDEAD REAL Deadband percentage.
AMMOSP REAL Ammonium set point.
TIMED TIME Time delay for detecting AMMOD.
CALCPRIO INT Calculated priority number.
PRIO1 INT Priority number for zone 1.
PRIO2 INT Priority number for zone 2.
PRIO3 INT Priority number for zone 3.
PRIO4 INT Priority number for zone 4.
PRIO5 INT Priority number for zone 5.

EIO0000001107 05/2020 303

WAERACTL

Parameter Type Description

TOTZONE INT Total number of zones.
ZONExPID_CFGW x (1...5) PIDCTL_CFG_DDT ZONExPID configuration structure x (1...5)
ZONExPID_STATUSx (1...5) PIDCTL_ST_DDT ZONExPID status structure x (1...5)

WAERACTL_ST.STW Word Structure

Bit description of the STW element:

Bit Description
0 Indication for zone 1 active status.
1 = Zone 1 is active.
1 Indication for zone 2 Active status.
1 = Zone 2 is active.
2 Indication for zone 3 active status.
1 = Zone 3 is active.
3 Indication for zone 4 active status.
1 = Zone 4 is active.
4 Indication for zone active status.
1 = Zone is active.

WAERACTL_ST.CFGW Word Structure

Bit description of the CFGW element:

Bit Description
0 Indication for Ammonium control enabled status.
1 = Ammonium control enabled.
1 Indication for pressure control enabled status.
1 = Pressure control enabled.
2 Indication for Ammonium control enabled status.
1 = Ammonium control not enabled.

304 EIO0000001107 05/2020

 WAERACTL

ZONExPID_CFGW Description

Parameter Type Description

ZONExPID_CFGW PIDCTL_CFG_DDT ZONExPID configuration.
Name Type Description
OPHILIM REAL Output high limit.
OPLOLIM REAL Output low limit.
GAIN REAL Gain.
TI TIME Integral constant (TI).
TD TIME Derivative constant (TD).
KD TIME Proportional constant (KD).
x denotes zone numbers.

ZONExPID_STATUS

Parameter Type Description

ZONExPID_Status PIDCTL_ST_DDT ZONExPID status.
Name Type Description
PV REAL Present value of measurement.
SP REAL Current set point.
OP REAL Current output.
STW WORD Status word.
CFGW WORD Configuration word.
x denotes zone numbers.

NOTE: The bit structure description for STW and CFGW, refer PIDCTL Function block in Control
service user guide of General Purpose library.

EIO0000001107 05/2020 305

WAERACTL

PRESSUREPID_CFGW

Parameter Type Description

PRESSUREPID_CFGW PIDCTL_CFG_DDT PRESSUREPID configuration.
Name Type Description
OPHILIM REAL Output high limit
OPLOLIM REAL Output low limit
Gain REAL Gain
TI TIME Integral constant (TI)
TD TIME Derivative constant (TD)
KD TIME Proportional constant (KD)

PRESSUREPID_STATUS

Parameter Type Description

PRESSUREPID_STATUS PIDCTL_ST_DDT PRESSUREPID status.
Name Type Description
PV REAL Present value of measurement.
SP REAL Current set point.
OP REAL Current output.
STW WORD Status word.
CFGW WORD Configuration word.

306 EIO0000001107 05/2020

 WAERACTL

Public Variables

Public Variable Parameter Description

Parameter Type Description

SC WAERACTL _SC_DDT Provides data needed for the pump status and to
control it from the sequential control.

WAERACTL_SC_DDT Type

Name Type Description

AMMEN BOOL Ammonium control enable.
1 = Enables NH4 control.
AMMHIRAW REAL Ammonium high range (engineering unit).
AMMLORAW REAL Ammonium low range (engineering unit).
PRSEN BOOL Pressure control enable.
1 = Enables pressure control.
ZONE1PIDSC PIDCTL_SC_DDT Zone 1 PID public parameters.
ZONE2PIDSC PIDCTL_SC_DDT Zone 2 PID public parameters.
ZONE3PIDSC PIDCTL_SC_DDT Zone 3 PID public parameters.
ZONE4PIDSC PIDCTL_SC_DDT Zone 4 PID public parameters.
ZONE5PIDSC PIDCTL_SC_DDT Zone 5 PID public parameters.
PRPIDSC PIDCTL_SC_DDT Pressure PID public parameters.

EIO0000001107 05/2020 307

WAERACTL

PIDCTL_SC_DDT Type

Name Type Description

LSP REAL Read/write access.
Enables to assign the local set point for the sequential control if the owner is the
Program (Owner is 0), the selected mode is Auto and the selected set-point is
Local (SC.REM is 0). Otherwise, the current set point (SP output) is continuously
copied to this variable.
LOP REAL Read/write access.
Enables to assign the local output for the sequential control if the owner is the
Program (Owner is 0) and the mode is Manual. Otherwise, the current output (OP
output) is continuously copied to this variable.
PV REAL Read-only access. Refer to the PV input.
Owner BOOL Valid read-only access. Refer to the PV input/output. MAN BOOL
Write access. Allows the controller to be changed to Manual mode (1) if the owner
is the Program. The DFB automatically sets the signal to 0 after processing the
signal.
OWNER BOOL Valid read-only access. Refer to the PV input/output.
MAN BOOL Write access.
Allows the controller to be changed to Manual mode (1) if the owner is the Program.
The DFB automatically sets the signal to 0 after processing the signal.
AUTO BOOL Write access.
Allows the controller to be switched to Auto mode (1) if the owner is the Program.
The DFB automatically sets the signal to 0 after processing the signal.
MODE BOOL Read-only access. (Manual = 0, Auto= 1).
REM BOOL Read-only access.
Allows the DFB to be configured for a remote set point - RSP- (1) or local set point
- LSP (0) if the owner is the Program and the mode is Auto.
ILCKD BOOL Read-only access.
The signal evaluation depending on the ILCK input and the
PIDCTL_ST.STW.ILCKBP input/output.

308 EIO0000001107 05/2020

 WAERACTL

Usage

Overview
Examples in this manual are given for information only.

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

The WAERACTL DFB is interfaced to a WPIDIN and WPIOUT DFB as shown below. The WPIDN and
WPIDOUT DFBs are used because of the limitation in number of input and output pins in Control
Expert. One zone requires one WPIDIN and one WPIDOUT DFB. The WCONDSUM DFB is connected
to determine the interlock conditions for the PID.

EIO0000001107 05/2020 309

WAERACTL

310 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WSCHEDULER
EIO0000001107 05/2020

Chapter 21
WSCHEDULER: Scheduler Function Management

WSCHEDULER: Scheduler Function Management

Overview
This chapter describes the control services provided by WSCHEDULER DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 312
Description 313
DFB Representation 314
Outputs 315
Inputs/Outputs 316
Usage 317

EIO0000001107 05/2020 311

WSCHEDULER

Introduction

General
The WSCHEDULER DFB provides scheduling function and time driven output (actuator and value).
The following table describe the main function of this function block:

Function Description
Scheduling The DFB compares the current PLC time with configured event times in the
schedule data. After comparison, the function block releases the outputs
EVENTON and value as per the event time and configured values.

312 EIO0000001107 05/2020

 WSCHEDULER

Description

Functional Description
You can enter the scheduled timings for events from the faceplate, and are stored in
WSCHEDULER_ST.
When the value of WSCHEDULER_ST.SCHEDULEON = 1, the DFB compares the current PLC time
with configured event times in the schedule data. After comparison, the DFB releases the outputs
EVENTON and value as per the event time and configured values.
If any event is active, the output ACTIVE = 1. The output EVENTON connects to any actuator
command inputs used for Program mode. The output is available for more than one actuator. The
output VALUE can be used to set a PID value, control valve output, or speed SP of a motor. The
structure connected at the input/output WSCHEDULER_ST is capable of holding information for upto
to ten events .

EIO0000001107 05/2020 313

WSCHEDULER

DFB Representation

Overview
This figure shows the FBD representation of the WSCHEDULER DFB.

314 EIO0000001107 05/2020

 WSCHEDULER

Outputs

Output Parameter Description

Parameter Type Description

ACTIVE BOOL Indicates if a scheduled event is active.
1 = Event is active.
EVENTON BOOL Indicates state as per scheduled output.
1 = Event is On.
VALUE REAL Real value output changes as per the predefined scheduled value when
active = 1.

EIO0000001107 05/2020 315

WSCHEDULER

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WSCHEDULER_ST WSCHEDULER_ST_DDT Structure to interface the DFB with supervision.
SC WSCHEDULER _SC_DDT Provides data needed for the pump status and to
control it from the sequential control.

WSCHEDULER_ST_DDT Type
The following table describes the structure of the derived data type WSCHEDULER_ST_DDT for the
WSCHEDULER DFB:

Name Type Description

PRESETVALx (x: 1...10) REAL Sets the value for event x (x: 1...10)
STARTTIMEx (x: 1...10) REAL Sets the start time of event x (x: 1...10)
ACTIVETIMEx (x: 1...10) DINT Sets the event x (x: 1...10) on time for mode 2...4
PAUSETIMEx (x: 1...10) DINT Sets the event x (x: 1...10) pause time for mode 2...4
DAYx (x: 1...10) UINT Sets the day on which event x (x: 1...10) has to be
performed
MODEx (x: 1...10) UINT Sets the type of event x (x: 1...10)
CURREVENT INT Indicates the current active event
SCHEDULEON INT Indicates the status of scheduling

316 EIO0000001107 05/2020

 WSCHEDULER

Usage

Overview
Examples in this manual are given for information only.

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

The WSCHEDULER DFB has to be used along with PLC clock.

For example, if the motor has to be switched on when an event occurs, the function block has to
be connected in the manner as shown in the previous figure.
The motor should be kept in Remote mode by setting SC.REM public variable to high. The RSP pin
of the WMOTOR DFB is connected to the output pin ACTIVE of the scheduler.
You can configure the event occurring condition in the scheduler faceplate, depending on the
requirement. For example, if the motor is switched on from 8:00 hrs to 14:00 hrs, you can configure
these values in the scheduler function block faceplate. When these conditions are met, the ACTIVE
pin of the scheduler goes high, and the motor is switched on.

EIO0000001107 05/2020 317

WSCHEDULER

318 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
Auxiliary Objects
EIO0000001107 05/2020

Part IV
Auxiliary Objects

Auxiliary Objects

Overview
The following part describes the Auxiliary objects.

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

1For 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.

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
22 WPIDIN: Water PID Input 321
23 WPIDOUT: Water PID Output 327
24 WDEVMNT: Device Maintenance 333
25 WCONDSUM: Device Diagnostic Information/Interlock 343
26 WHPROLPRO: Process Limits Auxiliary 353

EIO0000001107 05/2020 319

Auxiliary Objects

320 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WPIDIN
EIO0000001107 05/2020

Chapter 22
WPIDIN: Water PID Input

WPIDIN: Water PID Input

Overview
This chapter describes the control services provided by WPIDIN DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 322
DFB Representation 323
Inputs 324
Outputs 325

EIO0000001107 05/2020 321

WPIDIN

Description

Functional Description
The WPIDIN function block contains PIDCTL input parameters as its input pin and they are moved
to a DDT. This PIDIn function block has to be connected with PIDCTL input pins of WAERACTL
and WFLOWCTL.
NOTE: PIDCTL is a PID controller block available in General Purpose Library.

322 EIO0000001107 05/2020

 WPIDIN

DFB Representation

Overview
This figure shows the FBD representation of the WPIDIN DFB.

EIO0000001107 05/2020 323

WPIDIN

Inputs

Input Parameter Description

Parameter Type Description

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

324 EIO0000001107 05/2020

 WPIDIN

Outputs

Output Parameter Description

Parameter Type Description

WPID WPIDIN_ST_DDT PID input structure.

EIO0000001107 05/2020 325

WPIDIN

326 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WPIDOUT
EIO0000001107 05/2020

Chapter 23
WPIDOUT: Water PID Output

WPIDOUT: Water PID Output

Overview
This chapter describes the control services provided by WPIDOUT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 328
DFB Representation 329
Inputs 330
Outputs 331

EIO0000001107 05/2020 327

WPIDOUT

Description

Functional Description
The WPIDOUT function block contains PIDCTL output parameters as its output pin. This PIDOUT
function block has to be connected with PIDCTL output pins of WAERACTL and WFLOWCTL to
extract PID output parameters.
NOTE: PIDCTL is a PID controller block available in General Purpose Library.

328 EIO0000001107 05/2020

 WPIDOUT

DFB Representation

Overview
This figure shows the FBD representation of the WPIDOUT DFB.

EIO0000001107 05/2020 329

WPIDOUT

Inputs

Input Parameter Description

Parameter Type Description

OUTPID WPIDOUT_ST_DDT PID input structure.

330 EIO0000001107 05/2020

 WPIDOUT

Outputs

Output Parameter Description

Parameter Type Description

OUT_D REAL Differential output. It is generated based on the OUTD output of the
PIDFF controller.
MA_O BOOL 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 REAL 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.

EIO0000001107 05/2020 331

WPIDOUT

332 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WDEVMNT
EIO0000001107 05/2020

Chapter 24
WDEVMNT: Device Maintenance

WDEVMNT: Device Maintenance

Overview
This chapter describes the control services provided by WDEVMNT DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 334
Description 335
DFB Representation 336
Inputs 337
Outputs 338
Inputs/Outputs 339
Public Variables 341
Usage 342

EIO0000001107 05/2020 333

WDEVMNT

Introduction

General
The WDEVMNT DFB is used to provide data that is useful for device maintenance purposes.
It can not be used independently. It has to be used along with other DFBs, for example, motor, and
valve.
The following table describes the main functions of this DFB:

Function Description
Switching operation totalization Counts the number of switching operations that are performed on the
device since the totalizers last reset.
Hours of operation totalization Counts the number of hours of operation that are in operation since
the totalizers last reset.
Reset The function block makes it possible to reset the described totalizers
individually.

334 EIO0000001107 05/2020

 WDEVMNT

Description

Functional Description
You can use this DFB as a supplement to the actuator and valve DFBs, or can be used
independently. It allows the incorporation of totalizing functions for hours of operation and
switching operations. The DFB has to be executed with a minimum frequency of 1/250 ms to assist
in correct operation. Totalizing function is preformed depending on the status of the input at the pin
position. For example, when it is used with the WMOTOR DFB the OP pin is connected to the
POSITION pin of WDEVMNT.

EIO0000001107 05/2020 335

WDEVMNT

DFB Representation

Overview
This figure shows the FBD representation of the WDEVMNT DFB.

336 EIO0000001107 05/2020

 WDEVMNT

Inputs

Input Parameter Description

Parameter Type Description

POSITION BOOL Provides the device status information with which the totalizers are
calculated.
 0 = Corrsponds to the OFF position (stopped and closed).
 1 = Corresponds to the ON position (running and open).

EIO0000001107 05/2020 337

WDEVMNT

Outputs

Output Parameter Description

Parameter Type Description

RHCNT UINT Totalizes hours of operation of the device. The calculation is
performed based on the device position indicator, as shown by the
POSITION input.
The time during which the program is stopped is not counted.
TRHCNT – Total run hour counter (continuous counter).
MCNT UINT Totalizes the number of switching operations that the device has
performed. The calculation is performed based on the device position
indicator, as shown by the POSITION input.
A new switching operation is added each time, when a rising edge is
detected.
TMCNT DINT Total operations counter (continuous counter).

338 EIO0000001107 05/2020

 WDEVMNT

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WDEVMNT_ST WDEVMNT_ST_DDT Function block status handling data structure
(communication with Vijeo Citect)

WDEVMNT_ST_DDT Type
The following table describes the structure of the derived data type WDEVMNT_ST_DDT for the
WDEVMNT DFB:

Input/Output Type Description

STW WORD Provides the function block status used from the monitoring
subsystem. Read-only access to the data contained in this bits
word.
CFGW WORD Provides the means to control the function block. Read-only
access to the data contained in this bits word.
RHCNT DINT Read-only access.
Totalizes the device hours of operation. The calculation is
performed based on the device position indicator, as shown by
the POSITION input. The time during which the program is
stopped is not counted.
MCNT DINT Read-only access.
Totalizes the number of switching operations that the device has
performed. The calculation is performed based on the device
position indicator, as shown by the POSITION input. A new
switching operation is added each time, when a rising edge is
detected.
RHPST DINT Preset for running hours.
MCNTPST DINT Preset for maintenance counter.
TRHCNT DINT Count of total running hours.
TMCNT DINT Maneuvers numbers total.

EIO0000001107 05/2020 339

WDEVMNT

WDEVMNT_ST.STW Word Structure

STW element provides a means to monitor the function block status, usually from the monitoring
subsystem (Vijeo Citect supervision-SCADA).
Bit description of the STW :

Bit Name Description

0 HOV Device maintenance status. Activated when the hours counter exceeds the maximum
displayable value (65535). Deactivated through WDEVMNT_ST.CFGW.RSTH.
1 MOV Device maintenance status. Activated when the switching operations counter exceeds the
maximum displayable value (65535). Deactivated through WDEVMNT_ST.CFGW.RSTM.

WDEVMNT_ST.CFGW Word Structure

CFGW element provides a means to control the function block, usually from the monitoring
subsystem (Vijeo Citect supervision-SCADA).
Bit description of the CFGW :

Bit Name Description

0 RSTH Device maintenance status. Allows to reset (1) the hours-of-operation totalizer. Also,
resets the internal seconds subtotal from the last hour-of-operation fraction and from the
WDEVMNT.STW.HOV signal. The function block sets this signal to 0 once it is processed.
1 RSTM Device maintenance status. Allows to reset (1) the switching operation totalizer. Also,
resets the WDEVMNT.STW.MOV signal. The function block sets this signal to 0 once it has
been processed.

WDEVMNT_SC_DDT Type
The following table describes the structure of the derived data type WDEVMNT_SC_DDT of the
WDEVMNT DFB:

Variable Type Description

RHCNT INT Read-only access.
Totalizes the device hours of operation. The calculation is performed based on
the device position indicator, as shown by the POSITION input. The time during
which the program is stopped is not counted.
MCNT INT Totalizes the number of switching operations that the device has performed. The
calculation is performed based on the device position indicator, as shown by the
POSITION input. A new switching operation is added each time, when a rising
edge is detected.

340 EIO0000001107 05/2020

 WDEVMNT

Public Variables

Public Variable Description

Variable Type Description

SC WDEVMNT_SC_DDT Function block configuration and control data
structure

WDEVMNT_SC_DDT Type
The following table describes the structure of the derived data type WDEVMNT_SC_DDT of the
WDEVMNT DFB:

Variable Type Description

RHCNT INT Read-only access.
Totalizes the device hours of operation. The calculation is performed based on
the device position indicator, as shown by the POSITION input. The time
during which the program is stopped is not counted.
MCNT INT Totalizes the number of switching operations that the device has performed.
The calculation is performed based on the device position indicator, as shown
by the POSITION input. A new switching operation is added each time, when
a rising edge is detected.

EIO0000001107 05/2020 341

WDEVMNT

Usage

Overview
Examples in this manual are given for information only.

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

The WDEVMNT DFB can be used with any other DFB; such as WMOTOR that provides data, which is
useful for device maintenance and shown with the following figure.

342 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WCONDSUM
EIO0000001107 05/2020

Chapter 25
WCONDSUM: Device Diagnostic Information/Interlock

WCONDSUM: Device Diagnostic Information/Interlock

Overview
This chapter describes the control services provided by WCONDSUM DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 344
DFB Representation 345
Inputs 346
Outputs 347
Inputs/Outputs 348
Public Variables 350
Usage 351

EIO0000001107 05/2020 343

WCONDSUM

Introduction

General
The WCONDSUM DFB evaluates interlock or detected failure conditions. The function block
evaluates up to fifteen signals that can be used as a supplement for the rest of the process library
blocks to evaluate their interlocking inputs.Each one of them can be ignored or require individual
resetting according to the DFB configuration.
The following table describes the main functions of this function block:

Function Description
Summary condition The function block executes the OR function for the
evaluation conditions.
Manual reset conditions Conditions configured require resetting from the monitoring
system.
Bypass Allows the corresponding condition (one by one) to be
ignored when evaluating the expression.

344 EIO0000001107 05/2020

 WCONDSUM

DFB Representation

Overview
This figure shows the FBD representation of the WCONDSUM DFB.

EIO0000001107 05/2020 345

WCONDSUM

Inputs

Input Parameter Description

Parameter Type Description

CONDx (x: 1...15) BOOL Condition status.
1 = Activated
REQREARMx (x: 1...15) BOOL 1 = Mandatory manual resetting required when the
corresponding input condition is activated.

346 EIO0000001107 05/2020

 WCONDSUM

Outputs

Output Parameter Description

Parameter Type Description

RESULT BOOL Summarizes the result of OR function.
 0 = No condition in input is activated.
 1 = Any condition in input is activated.

EIO0000001107 05/2020 347

WCONDSUM

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WCONDSUM_ST WCONDSUM_ST_DDT Function block status handling data structure
(communication with Vijeo Citect)

WCONDSUM_ST_DDT Type
The following table describes the structure of the derived data type WCONDSUM_ST_DDT for the
WCONDSUM DFB:

Name Type Description

CONDW WORD Read-only access. Bits word with input conditions (refer to the
inputs COND x and their evaluation summary (refer to the output
RESULT.
BYPASSW WORD Read/write access. Bits word with the bypass signals set fom the
monitoring system.
REARMREQW WORD Read/write access. Bits word with the require setting signals (1)
set from the block and forced setting (0) signals set from the
monitoring system.

CONDW
The WCONDSUM DFB structure is designed on two primary derived data structures:
 WCONDSUM_ST_DDT: Function block status handling data structure (communication with
SCADA).
 WCONDSUM_SC_DDT: Function block configuration and control data structure (public variables).

Bit description of the CONDW element:

Bit Name Description

0...14 COND0...14 1 = The function block is capable of handling fifteen interlock conditions.
15 RESULT 1 = Read-only access.

WCONDSUM_ST.BYPASSW Word Structure

Bit description of the BYPASSW t:

Bit Name Description

0...14 BYPASS01...15 1 = The function block is capable of handling fifteen interlock conditions. Each
of these interlocks can be bypassed individually.

348 EIO0000001107 05/2020

 WCONDSUM

WCONDSUM_ST.REARMREQW Word Structure

Bit description of the REARMREQW :

Bit Name Description

0...14 REARMREQ01...15 1 = The function block is capable of handling fifteen interlock conditions
in WCONDSUM DFB with individual rearming requirement if the valve for 1st
bit is 1, then the rearm for that (interlock detected failure) condition is
required.

WCONDSUM_SC_DDT Type
The following table describes the structure of the derived data type WCONDSUM_SC_DDT of the
WCONDSUM block:

Name Type Description

RESULT BOOL Read-only access. summarizes the result of OR function.
 0 = No condition in input is activated.
 1 = Any condition in input is activated.

NOTE: The DFB can not be used alone. It has to be used along with DFB such as WMOT1D2S or
WCIRBRK, which gives all information regarding the interlocks or any detected failures. Also it does
not have genie associated with it.

EIO0000001107 05/2020 349

WCONDSUM

Public Variables

Public Variable Description

Variable Type Description

SC WCONDSUM_SC_DDT Function block configuration and control
data structure

WCONDSUM_SC_DDT Type
The following table describes the structure of the derived data type WCONDSUM_SC_DDT of the
WCONDSUM block:

Name Type Description

RESULT BOOL Read-only access. summarizes the result of OR function.
 0 = No condition in input is activated.
 1 = Any condition in input is activated.

NOTE: The DFB can not be used alone. It has to be used along with DFB such as WMOT1D2S or
WCIRBRK, which gives all information regarding the interlocks or any detected failures. Also it does
not have genie associated with it.

350 EIO0000001107 05/2020

 WCONDSUM

Usage

Overview
Examples in this manual are given for information only.

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

The WCONDSUM DFB is used with other DFBs like WMOTOR and WMOT1D2S for evaluating interlock
and detected failure conditions. The RESULT output of this DFB which OR’s all the conditions is
connected to the respective pin in these DFB.

EIO0000001107 05/2020 351

WCONDSUM

352 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
WHPROLPRO
EIO0000001107 05/2020

Chapter 26
WHPROLPRO: Process Limits Auxiliary

WHPROLPRO: Process Limits Auxiliary

Overview
This chapter describes the control services provided by WHPROLPRO DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 354
DFB Representation 355
Inputs 356
Outputs 357
Inputs/Outputs 358
Public Variables 359
Usage 360

EIO0000001107 05/2020 353

WHPROLPRO

Introduction

General
The WHPROLPRO function block adds the process limit handling feature to the WAINPUT function
block. It acts as an auxiliary function block to WAINPUT function block.
The process-related actions are required when certain analog values exceed process limits that
are configured from faceplate. For example, a temperature value exceeding certain high limit is
needed to start a water pump automatically.

354 EIO0000001107 05/2020

 WHPROLPRO

DFB Representation

Overview
This figure shows the FBD representation of the WHPROLPRO DFB.

EIO0000001107 05/2020 355

WHPROLPRO

Inputs

Input Parameter Description

Parameter Type Description

PV REAL Analog input value.
Connect the PV output of WAINPUT function block to
WHPROLPRO function block.

356 EIO0000001107 05/2020

 WHPROLPRO

Outputs

Output Parameter Description

Parameter Type Description

HPRO BOOL High process value.
PV input value ≤ High process value configured from the faceplate.
LPRO BOOL Low process value.
APV input value ≥ Low process value configured from the faceplate.

EIO0000001107 05/2020 357

WHPROLPRO

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

WHPROLPRO_ST WHPROLPRO_ST_DDT Function block status handles data structure
(communication with Supervision)

WHPROLPRO_ST_DDT Type
The following table describes the structure of the derived data type WCHPROLPRO_ST_DDT for the
WHPROLPRO DFB:

Name Type Description

HPRO REAL Set point for high process limit.
LPRO REAL Set point for low process limit.

358 EIO0000001107 05/2020

 WHPROLPRO

Public Variables

Public Variable Description

Variable Type Description

SC WHPROLPRO_SC_DDT Function block configuration and control
data structure

WHPROLPRO_SC_DDT Type
The following table describes the structure of the derived data type WHPROLPRO_SC_DDT of the
WHPROLPRO block:

Name Type Description

TON TIME Timer value for HPRO and LPRO to ON.
TOFF TIME Timer value for HPRO and LPRO to OFF.

EIO0000001107 05/2020 359

WHPROLPRO

Usage

Overview
Examples in this manual are given for information only.

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

The WHPROLPRO DFB can be used along with the WAINPUT. The process analog input value is
connected to the WHPROLPRO function block and the process high low limits are configured from
the faceplate of corresponding WAINPUT function block. If the limits are exceeded, the
corresponding outputs (HPRO,LPRO) gives the status/action command.

360 EIO0000001107 05/2020

 EcoStruxure™ Process Expert WWW Library
Index
EIO0000001107 05/2020

Index

E G
Equipment Control General Information
Flow Calculation, 243 Using the Water Library, 25
equipment control Generic Process
WAINPUT: analog input, 163 Pump Selection 1 Block, 219
WAOUTPUT: analog output, 177 WAERACTL: Water Aeration Control
WAOUTPUT: digital output, 197 Block, 297
WCONDSUM: device diagnostic informa- generic process
tion/interlock, 343 WDMFCTL: dual media filter manage-
WDEVMNT: device maintenance, 333 ment, 229
WDINPUT: digital input, 187 Generic Process
Equipment Control WPARSH_FLU: Parshall Flume, 274
WFLOWCTL: Flow Control, 287 WPUMPSEL: Pump Selection , 209
equipment control WREC_FLU: Rectangular Flume, 261
WHPROLPRO - process limits auxiliary, WREC_WEIR: Rectangular Weir, 244
353 generic process
WMOT1D2S: one-direction and two- WSCHEDULER: scheduler function man-
speed motor, 49 agement, 311
WMOT2D1S: two-direction and one- Generic Process
speed motor, 69 WTRAP_FLU: Trapezoidal Flume, 267
Equipment Control WU_FLU: U FLUME, 280
WMOTOR: One-direction and one-speed WV_WEIR: V Notch Weir, 255
motor DFB, 33
WMOTORVS: Variable Speed Motor, 87
equipment control P
WMVALVE: motorized valves with posi- process Control services
tioner, 119 list of function blocks, 23
WMVALVED: on/off motorized valve, 135 process control templates
Equipment Control description, 22
WPENSTOCK: Penstock Valve Block,
149
WPIDIN: Water PID Input Block, 321 U
WPIDOUT: Water PID Output Block, 327 using the water library
WTRAP_WEIR: Trapezoidal Weir, 250 basic features of the library, 26
equipment control operating modes, 27
WVALVE: on-off device type control mod- simulation function of equipment blocks,
ules, 103 30

EIO0000001107 05/2020 361

Index

362 EIO0000001107 05/2020