Modicon Libraries General Purpose

EIO0000002092 04/2020

Modicon Libraries General

Purpose
Devices Components User Guide
04/2020
EIO0000002092.09

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 EIO0000002092 04/2020
 Table of Contents

Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Part I General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Chapter 1 General Overview of Device Components . . . . . . . . . . . 19
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Chapter 2 Overview of Device Resources. . . . . . . . . . . . . . . . . . . . 21
List of Function Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Chapter 3 Overview of Supervision Services . . . . . . . . . . . . . . . . . 27
Function Blocks (DFB) Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Set-Point Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Part II Special Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapter 4 Special Cards - Quantum . . . . . . . . . . . . . . . . . . . . . . . . 35
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Chapter 5 Special Cards - M340 . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Part III Circuit Breakers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Chapter 6 COMPACT Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Diagnostics Information Management . . . . . . . . . . . . . . . . . . . . . . . . . 71

EIO0000002092 04/2020 3
 Chapter 7 MASTERPACT Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Diagnostics Information Management . . . . . . . . . . . . . . . . . . . . . . . . . 98
Chapter 8 HWCIRCUITBREAKER . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Diagnostics Information Management . . . . . . . . . . . . . . . . . . . . . . . . . 109
Chapter 9 OperationLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Part IV Digital Protection Relays . . . . . . . . . . . . . . . . . . . . . 117
Chapter 10 SEPAM Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Diagnostics Information Management . . . . . . . . . . . . . . . . . . . . . . . . . 151
Part V Motor Controllers and Starters . . . . . . . . . . . . . . . . . 153
Chapter 11 TeSys T Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Diagnostics Information Management . . . . . . . . . . . . . . . . . . . . . . . . . 188

4 EIO0000002092 04/2020
 Chapter 12 Tesys U Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Diagnostics Information Management . . . . . . . . . . . . . . . . . . . . . . . . . 214
Part VI Power Monitoring Devices . . . . . . . . . . . . . . . . . . . . 217
Chapter 13 PM Profile - Power Monitoring Profile. . . . . . . . . . . . . . . 219
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Diagnostic Information Management . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Chapter 14 Smart UPS Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Diagnostic Information Management . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Chapter 15 ACCUSINE PCS Profile . . . . . . . . . . . . . . . . . . . . . . . . . 259
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Diagnostic Information Management . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Communication Needs And/Or Requirements . . . . . . . . . . . . . . . . . . 277

EIO0000002092 04/2020 5
 Part VII Progressive Starters. . . . . . . . . . . . . . . . . . . . . . . . . 279
Chapter 16 ATS Progressive Starter Profile . . . . . . . . . . . . . . . . . . . . 281
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Diagnostic Information Management . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Part VIII Variable Speed Drives . . . . . . . . . . . . . . . . . . . . . . . 305
Chapter 17 ATV Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Diagnostics Information Management . . . . . . . . . . . . . . . . . . . . . . . . . 363
Chapter 18 EMATVWarn - Extended Warnings of Process Drives
(Supports 9 Alarm registers) . . . . . . . . . . . . . . . . . . . . . . 367
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Chapter 19 EMATVWarn1 - Extended Warnings of Process Drives
(Supports 12 Alarm registers) . . . . . . . . . . . . . . . . . . . . . 405
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Part IX Weighing Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Chapter 20 Weighing Module Profile . . . . . . . . . . . . . . . . . . . . . . . . . 453
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

6 EIO0000002092 04/2020
 Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Diagnostic Information Management . . . . . . . . . . . . . . . . . . . . . . . . . 469
Configuration of PMESWT Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
PMESWT DFB Work Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Part X Safety Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Chapter 21 XPSMC - XPSMC Reader (16 Inputs/ 32 Inputs) . . . . . . 483
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Inputs/Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Part XI Communication Technologies. . . . . . . . . . . . . . . . . . 503
Chapter 22 Ethernet Technology. . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
22.1 CommunicationOK Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
22.2 ATV71/61 Control Block on Ethernet with IO Scanning . . . . . . . . . . . 508
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Preparing the Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
ATV 71/61 IO Scanner Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 511
Modifying the ATV7161 IOScanner Configuration. . . . . . . . . . . . . . . . 514
Configuring the IO Scanning of the Controller . . . . . . . . . . . . . . . . . . . 517
22.3 Tesys T Control Block on Ethernet . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
Tesys T Hardware Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Preparing the Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Configuring the IO Scanning of the Controller . . . . . . . . . . . . . . . . . . . 523
22.4 Modbus Devices Used Through Gateway . . . . . . . . . . . . . . . . . . . . . . 525
Modbus Devices Used Through Gateway . . . . . . . . . . . . . . . . . . . . . . 526
TSXETG100 Gateway Configuration Description . . . . . . . . . . . . . . . . 529
Control Program Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
22.5 Configuration Procedure for Device DTM . . . . . . . . . . . . . . . . . . . . . . 533
Configuring Device DTM for Communication with Device Control
Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Selection of Profile/Parameter in Device DTM . . . . . . . . . . . . . . . . . . 549
22.6 Modbus TCPIP - Implicit with IOScanning. . . . . . . . . . . . . . . . . . . . . . 553
Creating an Application using Modbus TCPIP Communication
Technology (Implicit with NOE/CPU). . . . . . . . . . . . . . . . . . . . . . . . . . 553

EIO0000002092 04/2020 7
 22.7 Modbus TCPIP - Implicit with Device DTM . . . . . . . . . . . . . . . . . . . . . 562
Modbus TCPIP - Implicit with Device DTM . . . . . . . . . . . . . . . . . . . . . 562
22.8 Modbus TCPIP - Explicit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Creating an Application using Modbus TCPIP Communication
Technology (Explicit).. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
22.9 Modbus TCPIP - Explicit with Gateway . . . . . . . . . . . . . . . . . . . . . . . . 584
Modbus Serial - Explicit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Chapter 23 Modbus over ULP Technology . . . . . . . . . . . . . . . . . . . . . 591
Creating a Project with $MASTERPACTMTZMBU for IFM connected to
Masterpact MTZ and Modbus Serial RJ45 Ports . . . . . . . . . . . . . . . . . 592
Creating a Project with $MasterpactMTZMBU for IFE or IFE stacked
with IFM connected to Masterpact MTZ and Modbus Ethernet RJ45
Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
Chapter 24 Modbus Technology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
24.1 General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Modbus Technology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Determining Timeout Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
24.2 Configuring the Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
ATV 31, ATV 312, and ATV 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
ATV 71 and ATV 61 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Tesys U . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Tesys T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
ATS 22 and ATS 48 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
SEPAM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
PM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Compact and Masterpact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
24.3 Modbus Serial - Explicit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Creating an Application using Modbus Communication Technology
Using M340/ M580 on Local Rack. . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Creating an Application using Modbus Communication Technology
using Quantum Controller on X80 drop . . . . . . . . . . . . . . . . . . . . . . . . 620
Creating an Application using Modbus Communication Technology
using M580 Controller on X80 drop . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Chapter 25 Profibus Technology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
25.1 Profibus Communication Using PRM. . . . . . . . . . . . . . . . . . . . . . . . . . 630
Profibus Communication Using PRM. . . . . . . . . . . . . . . . . . . . . . . . . . 630
Chapter 26 CANOpen Technology . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
26.1 Advantys Communication using IO Scanning . . . . . . . . . . . . . . . . . . . 654
Advantys Communication Using IO Scanning . . . . . . . . . . . . . . . . . . . 654
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663

8 EIO0000002092 04/2020
 Safety Information

Important Information

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

EIO0000002092 04/2020 9
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.
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.

10 EIO0000002092 04/2020
 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.

EIO0000002092 04/2020 11
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.

12 EIO0000002092 04/2020
 About the Book

At a Glance

Document Scope
This document describes Control Expert components of Modicon Libraries General Purpose and
its functionality.
This document does not cover any development procedures and internal functionality details.
Users of the Control Expert services are supposed to have a working knowledge in the
employment of Control Expert.

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

This library is compatible with the following hardware platforms:

 Quantum
 M340
 M580

EIO0000002092 04/2020 13
Product Related Information

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

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.

14 EIO0000002092 04/2020
 Examples described in this manual are provided for information only.

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

EIO0000002092 04/2020 15
16 EIO0000002092 04/2020
 Modicon Libraries General Purpose
General
EIO0000002092 04/2020

Part I
General

General

Overview
This part explains general overview of General Purpose device library and concepts implemented
for controlling devices.

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
1 General Overview of Device Components 19
2 Overview of Device Resources 21
3 Overview of Supervision Services 27

EIO0000002092 04/2020 17
General

18 EIO0000002092 04/2020
 Modicon Libraries General Purpose
General Overview of Device Components
EIO0000002092 04/2020

Chapter 1
General Overview of Device Components

General Overview of Device Components

Introduction

The Modicon Libraries General Purpose provides DFBs that have been pre-configured and tested
by Schneider Electric and that are designed specifically for automating the control of Schneider
Electric devices such as variable-speed drives, starters, and power meters.
The Control (functional blocks, components, and libraries) and the monitoring resources
(components for Supervision) provide common required functions, facilitating the development of
control systems.
The system provides Control function blocks (DFB) for control.
To automate and simplify the implementation of control systems of the electrical devices, you can
use these resources with the tools for massive code generation and for the synchronization of
control and monitoring subsystems.
You can link the resources that are specifically designed for device control purposes with other
generic resources for discrete, continuous, and/or batch process management included in
Modicon Libraries - General Purpose. You can use device control function with communication
objects (TCP, EIP, Modbus) for data monitoring and control.
This document describes the basic concepts and details of each function blocks (DFBs) to
implement the device control functions.

EIO0000002092 04/2020 19
General Overview of Device Components

20 EIO0000002092 04/2020
 Modicon Libraries General Purpose
General Overview of Device Resources
EIO0000002092 04/2020

Chapter 2
Overview of Device Resources

Overview of Device Resources

List of Function Blocks

Overview
This chapter lists the resources designed for device control automation purposes.

WARNING
UNINTENDED EQUIPMENT OPERATION
Only authorized and suitably trained personnel have to implement an industrial control scheme
or application using these function blocks.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000002092 04/2020 21
General Overview of Device Resources

Function Blocks for Devices

The DFBs have been classified based on the family being used.
The following table lists the function blocks and their description:

Family name Profile name Function blocks Description

Special cards - Quantum Quantum Q140EHC10500 Quantum high-speed 5-channel counter
module.
Q140EHC20200 Quantum high-speed 2-channel counter
module.
Q140ERT85410 Quantum expert time stamp module.
Special cards - M340 M340 T_SIGN_CPT_BMX Special inrack - M340.
(see page 41)
T_UNSIGN_CPT_BMX
(see page 41)
Circuit breakers COMPACT MBCOMPACTNSX Compact NSX management.
(see page 49)
MBUCOMPACTNSX Compact NSX management.
(see page 49)
MASTERPACT MBMASTERPACT Masterpact management.
(see page 73)
MBMASTERPACTC Masterpact chassis management.
(see page 73)
MBUMASTERPACTMTZ Masterpact MTZ circuit breaker without
(see page 73) chassis management.
MBUMASTERPACTMTZC Masterpact MTZ circuit breaker with
(see page 73) chassis management.
MBUMASTERPACTNx Masterpact Nx circuit breaker without
(see page 73) chassis management.
MBUMASTERPACTNxC Masterpact Nx circuit breaker with chassis
(see page 73) management.
Hard Wired HWCIRCUITBREAKER
Circuit Breaker
Operational OperationLimit
Limit

22 EIO0000002092 04/2020
 General Overview of Device Resources

Family name Profile name Function blocks Description

Digital protective relays SEPAM MBSEPAM20CB Sepam 20 management.
(see page 119)
MBSEPAM40C Sepam 40 management.
(see page 119)
MBSEPAM80C Sepam 80 management (Modbus serial).
(see page 119)
ESEPAM80C Sepam 80 management (I/O scanning).
(see page 119)
Motor controllers and TESYST EIOTESYST TeSys T management (normal I/O
starters (see page 155) scanning).
ETESYST (see page 155) TeSys T management (fast I/O scanning).
EMESTESYST TeSys T management (Ethernet explicit
(see page 155) messaging).
MBTESYST TeSys T management (Modbus serial).
(see page 155)
TESYSTCTL TeSys T motor management system.
(see page 155)
TESYSTPB TeSys T motor management system
(see page 155) (Profibus).
TESYS U MBTESYSUSCST TeSys U standard starter management
(see page 191) (Modbus serial).
MBTESYSUSC TeSys U advanced and multifunction
(see page 191) starter management (Modbus serial),
MBTESYSUC TeSys U advanced and multifunction
(see page 191) controller management (Modbus serial),
TESYSUSCST TeSys U standard starter.
(see page 191)
TESYSUCTL TeSys U advanced starter.
(see page 191)
TESYSUSC TeSys U multifunction starter.
(see page 191)
TESYSUC (see page 191) TeSys U advanced and multifunction
controller.

EIO0000002092 04/2020 23
General Overview of Device Resources

Family name Profile name Function blocks Description

Power monitoring PM MBPM700 (see page 219) Power Meter 700 management.
devices MBPM800 (see page 219) Power Meter 800 management (Modbus
serial).
MBPM1200 Power Meter 1200 management.
(see page 219)
MBPM9C (see page 219) Power Meter 9C management.
EPM800 (see page 219) Power Meter 800 management (I/O
scanning).
EMPM800 (see page 219) Power Meter 800 management.
MBPM5350 Power Meter 5350 management (Modbus
(see page 219) serial).
EMPM53xx Power Meter 53xx management (Modbus
(see page 219) TCPIP).
EMPM82xx Power Meter 82xx management (Modbus
(see page 219) TCPIP).
SMARTUPS MBSMARTUPS Smart UPS management.
(see page 243)
ACCUSINE EACCUSINE Accusine management.
(see page 259)
Progressive starters ATS 22 MBATS22 (see page 281) Altistart 22 management.
ATS 48 MBATS48 Altistart 48 management.
Variable speed drives ATV ATV7161 (see page 307) Altivar 61 and Altivar 71 management (I/O
scanning).
EATV32 (see page 307) Altivar 32 management (I/O scanning).
EMESATV7161 Altivar 61 and Altivar 71 drive Ethernet
(see page 307) messaging overview.
MBATV (see page 307) Altivar 12, Altivar 312, and Altivar31 drive
Modbus.
MBATV212 Altivar 212 management.
(see page 307)
MBATV7161 Altivar 61 and Altivar 71 drive Modbus.
(see page 307)
ASATV31 (see page 307) Altivar 31 drive Advantys.
ASATV7161 Altivar 61 and Altivar 71 drive Advantys.
(see page 307)
PBATV7161 Altivar 7161 management (Profibus).
(see page 307)
ATV6xx (see page 307) Altivar 6xx management.
ATV9xx (see page 307) Altivar 9xx management.

24 EIO0000002092 04/2020
 General Overview of Device Resources

Family name Profile name Function blocks Description

Weighing Module Weighing EIPMPMESWT Weighing module
module profile (see page 453)
Safety module Safety module XPSMC (see page 483) XPSMC reader (16 inputs/ 32 inputs).

EIO0000002092 04/2020 25
General Overview of Device Resources

26 EIO0000002092 04/2020
 Modicon Libraries General Purpose
Supervision Services
EIO0000002092 04/2020

Chapter 3
Overview of Supervision Services

Overview of Supervision Services

Overview
This chapter describes the concepts implemented by the resources used for device Supervision
purposes.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Function Blocks (DFB) Interface 28
Set-Point Management 30
Monitoring 31

EIO0000002092 04/2020 27
Supervision Services

Function Blocks (DFB) Interface

Overview
The Control function blocks for devices provide an interface that allows the DFBs to be configured,
monitored, and controlled both from the monitoring subsystem and from the control subsystem
itself.
The following interfaces are provided:
 Basic Configuration
 Control
 States and Monitoring
 Variables

Basic Configuration
DFB public variables for static and identified data are in engineering time (for example, range for
an input channel, refreshing communication variables and so on).

Control
DFB input and output pins:
 enable issuing commands from other program blocks or sections.
 provide the DFB status to allow implementing switching operations (for example, device
controlled from HMI/SCADA system, ExtControlled output pin), detected failures (for
example, communication interruption), alarm (for example, thermal trip alarm), and so on.

States and Monitoring

Depending on their types, the DFBs have several input/output pins that need to be connected to
variables used to hold either the states of the pins or data. In addition, these variables allow
commands and parameters received from the monitoring subsystem to be managed.
The following variables are considered:
State and control (identified by means of the _ST suffix):
These variables hold the state and control used from the first monitoring subsystem level
(dynamic symbols in flowcharts). This variable is an input/output variable.
Configuration and information (identified with the _CFG suffix):
These variables hold second-level information for configuring device control or information
parameters (device status and so on). This information is normally accessible from the
faceplates of the monitoring subsystem. This variable is an input/output variable.
Status/state of measurements or of device inputs/outputs (identified with _IO, _MEA, or other
suffixes):
This information is normally accessible from the faceplates of the monitoring subsystem for
digital or analog values. This variable is an output variable and is available depending on the
device information and on the communications system (Modbus or Ethernet) being used.

28 EIO0000002092 04/2020
 Supervision Services

Variables
Variables communicate with devices. If you use components with or Ethernet-based
communications, the DFBs have an Inputs input DDT and an Outputs output DDT to
communicate with the actual physical device. Allocate these variables (%MWX) to the memory
segment reserved for communications so that the device control mechanisms work correctly.
When you use Modbus-based communications, use a Modbus port that serializes the requests
sent to the devices on the bus (messaging).

Function Block Illustration

EIO0000002092 04/2020 29
Supervision Services

Set-Point Management

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

To avoid unwanted transitions in the set-point, continuously set the local set-points (Operator or
Program) to match the selected set-point.
In principle, the owner (Operator or Program) of the function block is not modified from the control
subsystem (through the program in the PLC) because the control subsystem is mechanism that
stops the Program from affecting the block. This is to confirm that the commands issued towards
the block are those generated from the monitoring subsystem.
NOTE: The dynamic symbols and the faceplates corresponding to the General Purpose library
devices are used to implement the control function for block resetting (as long as the block is in
Operator mode). If you want to perform additional control actions (Run, QuickStop, and so on)
from faceplates, use the control blocks included in the General Purpose library for process.

Operator (Operator/Local set-point)

Receives commands from the monitoring subsystem (Supervision/HMI). The DFBs receive these
commands through ***_ST and ***_CFG structures. The Owner variable is implemented in the
devices in the ***_ST.CFGW.1 and is set to 1 to specify operator-based control.

Program
Generates commands from the control program (Control). The DFBs receive these commands
through the input and output pins of the DFBs. The Owner variable is implemented in the devices
in the ***_ST.CFGW.1 and is set to 0 to specify program-based control.

30 EIO0000002092 04/2020
 Supervision Services

Monitoring

Overview
The function blocks in the General Purpose library have Monitoring mode (which you can select by
setting the ControlCommand input to FALSE) that allows the device to be monitored in a
communications-based manner independently of the state of the control inputs. This way, the
control block only performs read operations on the device and updates the output variables of the
block without sending any commands.
You can use the operating mode if switching operations are carried out on the device locally
through a physical screw terminal.
NOTE: If the block is in Monitoring mode (ControlCommand set to FALSE), it resets
communication interruptions through the program or HMI/SCADA system.
If you configure the device to be controlled and monitored completely by the PLC in a
communications-based manner, set this variable to TRUE.

EIO0000002092 04/2020 31
Supervision Services

32 EIO0000002092 04/2020
 Modicon Libraries General Purpose
Special Cards
EIO0000002092 04/2020

Part II
Special Cards

Special Cards

Overview
This part provides the detailed description, pin layout, pin description, operator screen of the device
control blocks of the Special Cards family.

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

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

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
4 Special Cards - Quantum 35
5 Special Cards - M340 41

EIO0000002092 04/2020 33
Special Cards

34 EIO0000002092 04/2020
 Chapter 4
Special Cards - Quantum

Special Cards - Quantum

Overview
This chapter describes the quantum special cards.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 36
DFB Representation 37
Inputs 38
Outputs 39
Inputs/Outputs 40

35
Description

General
The Q140EHC10500 special inrack card DFB is the control block to manage a high speed counter
with 5 channels. It uses 5 equivalent, independently usable counters. The mapping value is 12
%IW-3X and 12 %MW-4X
The Q140EHC20200 special inrack card DFB is the control block to manage a high speed counter
with 2 channels. It is a two-channel module suited for high-speed counting applications up to
500 kHz or for applications that require a quadrature counter interface. The mapping value is 6
%IW-3X and 6 %MW-4X.
These DFBs are specific for the particular special card model to handle the data transfer and
conditioning. These DFBs receive the initial addresses of the configured STATE RAM memory
areas plus the mapping model (1X versus 3X) to transfer the data from/to the special card.

36
DFB Representation

Representation
The following figure represents functional modules of special card Quantum:

NOTE: The underlined parameters are specific for some components.

The table shows the parameter available for specific DFBs:

Parameter Components
Q140EHC10500 Q140EHC20200
Input Channel X –

37
Inputs

Input Parameter Description

Parameter Type Description

Channel* INT This input is used to select a channel.
DATAIN3X ARRAY OF WORD The DFB receives the initial addresses of the
configured STATE RAM memory areas from this input
to transfer the data from the special card.
*
: Parameter is available for specific components.

38
Outputs

Output Parameter Description

Parameter Type Description

DATAOUT4X ARRAY OF This output is used to transfer the data to the
WORD special card.

39
Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

DATA ARRAY OF Harmonized values from the special card for
INT application usage.

40
 Modicon Libraries General Purpose
Special Cards - M340
EIO0000002092 04/2020

Chapter 5
Special Cards - M340

Special Cards - M340

Overview
This chapter describes the special cards.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 42
DFB Representation 43
Inputs 44
Outputs 45
Inputs/Outputs 46

EIO0000002092 04/2020 41
Special Cards - M340

Description

General
The special inrack cards, that are used for high speed counting are available with M340 controller.
There are 2 control blocks supporting 2 and 8 channels respectively, which can be configured to
perform different functions.
The 2 control blocks are:
 BMXEHC0200: This high-speed control blocks supports 2 channels. Each of these high speed
counter channels supports up to 9 functions.
 BMXEHC0800: This high-speed control blocks supports 8 channels. Each of these high speed
counter channels supports up to 6 functions.

Function Description
The control blocks that are available supports 2 IO DDTs to obtain the information from the
hardware, T_SIGN_CPT_BMX and T_UNSIGN_CPT_BMX.
You have to select the I/O DDT type from the respective application template of the module. The
function block is generated based on the selection of I/O DDT. This block packages the data for
operator information.

42 EIO0000002092 04/2020
 Special Cards - M340

DFB Representation

Representation
This DFB is designed for the use of packaging signed data from the T_SIGN_CPT_BMX and
T_UNSIGN_CPT_BMX counter block.
This figure represents T_SIGN_CPT_BMX DFB in Control Expert:

This figure represents T_UNSIGN_CPT_BMX DFB in Control Expert:

EIO0000002092 04/2020 43
Special Cards - M340

Inputs

N/A

44 EIO0000002092 04/2020
 Special Cards - M340

Outputs

N/A

EIO0000002092 04/2020 45
Special Cards - M340

Inputs/Outputs

Input/Output Parameter Description

This table describes the input/output parameters:

Parameter Datatype Description

CHANNEL T_SIGN_CPT_BMX / This pin resembles the standard
T_UNSIGN_CPT_BMX Control Expert I/O DDT of the special card
DATA T_SIGN_CPT_BMX_DDT / This pin stores information in an organized
T_UNSIGN_CPT_BMX_DDT structured.

For structure of I/O DDT, refer to standard Control Expert Help file.

46 EIO0000002092 04/2020
 Modicon Libraries General Purpose
Circuit Breakers
EIO0000002092 04/2020

Part III
Circuit Breakers

Circuit Breakers

Overview
This part provides the detailed description, pin layout, pin description, operator screen of the device
control blocks of the Circuit Breakers.
These function blocks do not reflect any specific installation.

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

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

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
6 COMPACT Profile 49
7 MASTERPACT Profile 73
8 HWCIRCUITBREAKER 101
9 OperationLimit 111

EIO0000002092 04/2020 47
Circuit Breakers

48 EIO0000002092 04/2020
 Modicon Libraries General Purpose
COMPACT Profile
EIO0000002092 04/2020

Chapter 6
COMPACT Profile

COMPACT Profile

Overview
This chapter describes the DFBs of Compact profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 50
DFB Representation 51
Inputs 53
Outputs 55
Inputs/Outputs 65
Public Variables 69
Diagnostics Information Management 71

EIO0000002092 04/2020 49
COMPACT Profile

Description

General
The COMPACTNSX profile is the control function to manage Compact NSX electrical protection
circuit breakers.

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

Function Description
Remote Resetting Allows resetting of the device.
Open/Close Allows circuit breaker to open and close.
Monitoring Allows the device measurement data to be monitored.

50 EIO0000002092 04/2020
 COMPACT Profile

DFB Representation

Representation
The following figure represents the function module of COMPACTNSX profile:

NOTE:
 The underlined parameters are specific for some components.
 Data type of WarningOrderCode output pin for MBCOMPACTNSX is COMPACTWARNINGORDER.
Similarly, for MBUCOMPACTNSX the data type is INT

EIO0000002092 04/2020 51
COMPACT Profile

The table shows the parameters available for specific DFBs:

Parameters Components
Modbus Modbus over ULP
MBCOMPACTNSX MBUCOMPACTNSX
Inputs ModBusAddress X –
IFMModBusAddress – X
X : Parameter is available
– : Parameter is not available

NOTE:
 If IFMModbusAddress is not configured then default value of 255 is considered.
 For how to create project using CompactNSX circuit breakers,refer Communication
technologies (see page 591).
 IFM v2 and above hardware supports these control functions.

52 EIO0000002092 04/2020
 COMPACT Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the
control block.
 0 = The entire DFB is restarted (statuses,
output values, counters are lost) and output
values are set to 0.
 1 = Enables communications with the devices
for their operation.
Public variable values are loaded during the first
enabling cycle.
OpenClose BOOL This input controls the circuit breaker.
 Rising edge on pin = Closes the circuit
breaker.
 Falling edge on pin = Opens the circuit
breaker.
ResetFail BOOL 1 = Resets the Fail output parameter to 0 or in
case of inoperable device, sends a reset
command to the device if ControlCommand is
1.
ModbusAddress1 INT Device address within the Modbus network.
You can find this variable in Modbus
communications.
IFMModbusAddress2 UINT Modbus address of the IFM Module.

ControlCommand BOOL Indicates to the DFB whether the Compact NSX

is being controlled locally or from a source
external to the DFB.
 0 = Performs only read operations to monitor
the status of the device and does not perform
any control functions.
 1 = Performs read operations and performs
control operations not conflicting with control
commands coming from an external control
source.
NOTE: This pin configuration does not impact
the Compact unit.
1
: Parameter available only for MBCompactNSX.
2
: Parameter available only for MBUCompactNSX.

EIO0000002092 04/2020 53
COMPACT Profile

Parameter Type Description

StatisticSelector INT Variable used to obtain statistics for the Modbus
network (requests carried out, time between
requests, and so on). This data provides
information for using StatisticConnector
pin within the StatisticCounter DFB in
General Purpose library for communication.
The following table displays the
StatisticSelector value:
Variable Value Description
1 Read statistics, client.
2 Write statistics, client.
EngParam 2 MBUCOMPACTNSXENGPARAM Engineering parameters.
Parameter Type Description
Refresh TIME Time to refresh the cyclic data.
CommandCtlWi TIME Time window for the device to execute orders.
ndow
ScanTime TIME Minimum time to maintain warning signals.
Password string[2 Protection for commands.
6]
ResetMode BOOL 0= Manual Reset.
1= Automatic Reset.
MaxResetTime TIME Maximum time between two resets.
1
: Parameter available only for MBCompactNSX.
2
: Parameter available only for MBUCompactNSX.

54 EIO0000002092 04/2020
 COMPACT Profile

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL 1 = The device is enabled and free of detected errors.
This variable is TRUE as long as there are no
communication interruptions and the device has not
tripped.
Fail BOOL 1 = A detected failure in the control block or in the device
or communication interruption.To reset the Fail output
pin, the ResetFail input has to be activated. The last
detected error code is shown on FailCode.
NOTE: If a communication interruption occurs, the
variables being read from the device ceases to be
refreshed as a refresh operation can no longer be carried
out. The variables keep their last value.
Warning BOOL 1 = An alarm has been activated for the device. It does
not affect the block operation and does not need to be
reset. This signal remains active until the cause of the
alarm disappears.
WarningOrder BOOL 1 = The device has returned an alarm condition as the
result of having executed a command. It does not affect
the block operation and does not need to be reset.
This signal remains active until a different command that
ends without an alarm condition is executed.
FailCode ARRAY [0..2] OF INT When the Fail output is 1, it holds the code for the
detected error.
if the Fail bit is 0, it indicates the last detected error that
occurred. The detected error source is specified by using
a 3-level structure.
Refer to Diagnostic Information Management
(see page 71) for more details.
1: These parameters are available only with MBCompactNSX.
2: These parameters are available only with MBUCompactNSX.

EIO0000002092 04/2020 55
COMPACT Profile

Parameter Type Description

WarningCode COMPACTNSXWARNING Variable holds the alarm code.
The following table describes the WarningCode
information:
Parameter Type Description
Alarm201 BOOL 1 = User-defined alarm 201.
Alarm202 BOOL 1 = User-defined alarm 202.
Alarm203 BOOL 1 = User-defined alarm 203.
Alarm204 BOOL 1 = User-defined alarm 204.
Alarm205 BOOL 1 = User-defined alarm 205.
Alarm206 BOOL 1 = User-defined alarm 206.
Alarm207 BOOL 1 = User-defined alarm 207.
Alarm208 BOOL 1 = User-defined alarm 208.
Alarm209 BOOL 1 = User-defined alarm 209.
Alarm210 BOOL 1 = User-defined alarm 210.
LongTimeProtection BOOL 1 = Long delay protection prealarm
(PAL Ir).
EarthLeakage BOOL 1 = Differential protection prealarm (Vigi)
(PAL IΔn).
GroundFault BOOL 1 = Ground fault protection prealarm
(PAL Ig).
LongTimePickup BOOL 1 = Protection prealarm.
WarningOrderCode1 COMPACTNSXWARNINGORDER Variable holds the alarm code returned as the result of
executing a command. Commands can generate the
following diagnostic codes. These codes are returned in
word 8020.
The following table describes the WarningOrderCode
information:
Parameter Type Description
Order BOOL 1 = A follow-up alarm. The device is not
responding to the control command
within the time specified in
CommandCtrlWindow.
WrongPassword BOOL 1 = Insufficient user permissions
(incorrect password).
1
: These parameters are available only with MBCompactNSX.
2
: These parameters are available only with MBUCompactNSX.

56 EIO0000002092 04/2020
 COMPACT Profile

Parameter Type Description

WarningOrderCode1 MbPadLocked BOOL 1 = Access violation (the padlock for the
Modbus communications interface
module is locked).
InternalWarning BOOL 1 = Any other positive detected error
code represents an internal detected
error.
OutOfOrder BOOL 1 = The BSCM module is out of service.
NeedReset BOOL 1 = The circuit breaker has tripped. It has
to reset before the command.
AlreadyClosed BOOL 1 = The circuit breaker is already closed.
AlreadyOpen BOOL 1 = The circuit breaker is already open.
AlreadyReset BOOL 1 = The circuit breaker is already reset.
ManualMode BOOL 1 = The control is in Manual mode.
Remote commands are not permitted.
NotPresent BOOL 1 = No control present.
InProgress BOOL 1 = A previous command is still being
executed.
ResetForbidden BOOL 1 = The reset command is prohibited
when SDE has been established.
WarningOrderCode2 INT Warning order register for Compact circuit breakers.
Parameter Value Description
OrderUnsuccessful 1 Order unsuccessful
WrongPassword 2 Insufficient user rights (incorrect
password)
ManualMode 4 Manual mode
AlreadyClosed 13 Already closed
AlreadyOpen 14 Already open
AlreadyReset 15 Already reset
ResourceNotPresent 16 Actuator not present
InhibitModeOn 17 Inhibit mode on
OutofOrder 18 Resource is out of order
NeedReset 19 Need reset
InProgress 20 In progress
ResetForbidden 21 Reset forbidden
IFMPadlocked 22 IFM locking pad is locked
1
: These parameters are available only with MBCompactNSX.
2: These parameters are available only with MBUCompactNSX.

EIO0000002092 04/2020 57
COMPACT Profile

Parameter Type Description

Running BOOL 1 = The Compact unit is closed.
ExtControlled BOOL 1 = The device is being controlled from a source external
(for example, from the console, from a push button
panel, or from the monitoring system) to the system.
NOTE: To calculate the state of this signal, use the
ControlCommand signal and the Owner variable. You
cannot use this signal as a ControlCommand input.
Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the
maximum time for resetting the detected error.
When a device or communication reset is carried out
with ResetFail, the DFB tries to reset the detected
error within the time period defined in
CommandCtrlWindow.
If the detected error is reset, the Fail and Reseting
output variables are reset (set to FALSE). On the other
hand, if the detected error is not reset, the Reseting
variable is set to FALSE and the Fail variable remains
TRUE. The ResetFail is edge-based.
Refer to the Timing diagram below.
1
: These parameters are available only with MBCompactNSX.
2: These parameters are available only with MBUCompactNSX.

58 EIO0000002092 04/2020
 COMPACT Profile

Parameter Type Description

Status COMPACTSTATUS The structure holds data containing the information that
the block extracts from the status variable of the circuit
breaker and communicating electrical drive.
The following table describes the status information:
Parameter Type Description
Open BOOL OFF state.
1 = The circuit breaker is open.
Closed BOOL ON state.
1 = The circuit breaker is closed.
Trip BOOL SD trip signal.
0 = Not tripped.
1 = The circuit breaker has tripped due to
an inappropriate electrical condition or a
leakage-caused trip.
TripElec BOOL Detected fault trip signal - SDE.
0 = Not tripped.
1 = The circuit breaker has tripped due to
an inappropriate electrical condition.
NotAvailable BOOL Availability of device status value.
0 = Status available
1 = Status not available due to device
internal detected error.
Info INT Device status.
Refer to Info table.
MotorAvailable BOOL Availability of motor mechanism.
0 = Not available
1 = Available
MotorMode BOOL Motor operating mode.
0 = Manual
1 = Auto
1
: These parameters are available only with MBCompactNSX.
2: These parameters are available only with MBUCompactNSX.

EIO0000002092 04/2020 59
COMPACT Profile

Parameter Type Description

StatisticConnector STATISTICCONNECTOR Information used with Modbus communication to obtain
statistics on the Modbus network (requests carried out,
time between requests, and so on). This structure has
been created to use together with the
StatisticCounter DFB in General Purpose library
for communication.
The following table describes the
StatisticConnector:
Parameter Type Description
Start BOOL 1 = Operation has started.
EndOk BOOL 1 = Operation has ended correctly.
EndNOk BOOL 1 = Operation has ended with a detected
error.
PartialTime DINT Partial time.
COMPACT_MEA COMPACT_MEA_DDT Data structure with measurement information. Whether
this data is available depending on the specific
Micrologic model: A=Ammeter, E=Energy, M=Motor,
30/31/40/41=Type of system (W3313; refer to the
Communication Manual for the Compact unit).
The following table describes the COMPACT_MEA_DDT
type:
Parameter Availability Type Description
CurrentI1 A/E/M REAL Current, instantaneous,
phase 1.
CurrentI2 A/E/M REAL Current, instantaneous,
phase 2.
CurrentI3 A/E/M REAL Current, instantaneous,
phase 3.
ResidualCurrentIN A/E, 30/41 REAL Current, instantaneous, N.
TrippingCause – INT –
OverrunAlarms – INT –
PreAlarms – INT –
UserAlarms – INT –
TripCounter – INT –
ResetDevice – INT –
1
: These parameters are available only with MBCompactNSX.
2
: These parameters are available only with MBUCompactNSX.

60 EIO0000002092 04/2020
 COMPACT Profile

Parameter Type Description

COMPACT_MEAExt COMPACT_MEAExt_DDT Data structure with extended measurement information.
Whether this data is available depending on the specific
Micrologic model: E, P, H.
The following table describes the
COMPACT_MEAExt_DDT type:
VoltageU21 E/M REAL Voltage, phases 1-2.
VoltageU32 E/M REAL Voltage, phases 2-3.
VoltageU13 E/M REAL Voltage, phases 1-3.
VoltageV1 E, 40/41 REAL Voltage, phase 1-N.
VoltageV2 E, 40/41 REAL Voltage, phase 2-N.
VoltageV3 E, 40/41 REAL Voltage, phase 3-N.
1
: These parameters are available only with MBCompactNSX.
2:
These parameters are available only with MBUCompactNSX.

EIO0000002092 04/2020 61
COMPACT Profile

Parameter Type Description

Frequency E/M REAL Frequency (derived from
phase 1).
TotalActivePower E/M REAL Total real power.
TotalReactivePower E/M REAL Total reactive power.
TotalApparentPower E/M REAL Total apparent power.
ActivePowerL1 E, 30/41 REAL Real power, phase 1.
ActivePowerL2 E, 30/41 REAL Real power, phase 2.
ActivePowerL3 E, 30/41 REAL Real power, phase 3.
ReactivePowerL1 E, 30/41 REAL Reactive power, phase 1.
ReactivePowerL2 E, 30/41 REAL Reactive power, phase 2.
ReactivePowerL3 E, 30/41 REAL Reactive power, phase 3.
ApparentPowerL1 E, 30/41 REAL Apparent power, phase 1.
ApparentPowerL2 E, 30/41 REAL Apparent power, phase 2.
ApparentPowerL3 E, 30/41 REAL Apparent power, phase 3.
CosPhi E/M REAL Cos phi power factor.
ActiveEnergy E/M REAL Real power consumption.
ReactiveEnergy E/M REAL Reactive power
consumption.
ApparentEnergyTotal E/M REAL Total apparent power
consumption.
PositiveActiveEnergy E/M REAL Positive real power
Ea+ (kWh).
NegativeActiveEnergy E/M REAL Negative real power
Ea- (kWh).
PositiveReactiveEnergy E/M REAL Positive reactive power
Er+ (kVARh).
NegativeReactiveEnergy E/M REAL Negative reactive power
Er- (kVARh).
1
: These parameters are available only with MBCompactNSX.
2: These parameters are available only with MBUCompactNSX.

62 EIO0000002092 04/2020
 COMPACT Profile

Parameter Type Description

COMPACT_MEAExt1 COMPACT_MEAExt1_DDT Data structure with extended measurement information.
Whether this data is available depending on the specific
Micrologic model: P, H.
The following table describes the
COMPACT_MEAExt1_DDT type:
THDVoltageL1ToL2 E/M REAL THD, voltage, 1-2.
THDVoltageL2ToL3 E/M REAL THD, voltage, 2-3.
THDVoltageL1ToL3 E/M REAL THD, voltage, 1-3.
THDVoltageL1ToNeutral E, 40/41 REAL THD, voltage, 1-N.
THDVoltageL2ToNeutral E, 40/41 REAL THD, voltage, 2-N.
THDVoltageL3ToNeutral E, 40/41 REAL THD, voltage, 3-N.
THDCurrentL1 E/M REAL THD, current, phase 1.
THDCurrentL2 E/M REAL THD, current, phase 2.
THDCurrentL3 E/M REAL THD, current, phase 3.
1
: These parameters are available only with MBCompactNSX.
2:
These parameters are available only with MBUCompactNSX.

Info Structure
Code with the information shown on the Control operator screen.The following table describes the
Info structure:

Variable value Status

2 Waiting for Ready signal.
6 Compact unit open.
7 Compact unit closed.
10 Waiting ControlCommand. It needs to be set to 1.
11 Missing EnableDFB.
12 Missing CommunicationOK. communication interruption.
13 The status register is not available.
24 Remove ResetFail. Needs to be reset again.
81 Missing ResetFail. Inoperable device.
82 A reset is required.

EIO0000002092 04/2020 63
COMPACT Profile

Timing diagram:

64 EIO0000002092 04/2020
 COMPACT Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

COMPACT_ST COMPACT_ST_DDT Device data structure holds the minimum information required
for performing control and monitoring functions. The information
used by the operator screen is usable from the HMI/SCADA
system.
COMPACT_CFG COMPACT_CFG_DDT Data structure with device information. The information used by
the operator screen is readable from the HMI/SCADA system.
WorkMemory ANY_ARRAY_INT Array used for Modbus communications.
This variable is to be used with a Modbus port that serializes
Modbus requests in an optimum manner.

COMPACT_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit word is read-only.
CFGW WORD Device control.
Enables to control the device from the monitoring subsystem or from the operator screen
if Owner (1), or only from the monitoring subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value for reading from the
HMI/SCADA system.

COMPACT_CFG_DDT Type

Name Type Description

DataStatus WORD Information on the device status. Information on the Status output structure.
Info INT Code with information on statuses and required actions.
WarningCode WORD Information on the alarm code. Takes the values from the WarningCode
output.
WarningCodeOrder WORD Information on the command alarm code. Takes the values from the
WarningCodeOrder output.
FailCode0 INT Code of last level 0 detected error. Indicates which detected error has
occurred, FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates which detected error has
occurred, FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates which detected error has
occurred, FailCode[2].

EIO0000002092 04/2020 65
COMPACT Profile

COMPACT_ST.STW Word Structure

Bit Description
0 Unknown device status or communication interruption. No variable refreshing.
1 Not ready.
2 Refer to the Closed status in the Status output pin (see page 55).
3 Inoperable device.
4 Alarm on device or repetitive detected fault alarm requires resetting.
5 communication interruption.
6 Requires resetting. A ResetFail is required.
7 Externally controlled.
8 Refer to the Reseting output pin (see page 55).
9 Refer to the EnableDFB input pin (see page 53).

COMPACT_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 53).
1 Owner.
3 Refer to the Closed status in the Status output pin (see page 55).
6 Refer to the Open status in the Status output pin (see page 55).
7 Refer to the ControlCommand input pin (see page 53).

COMPACT_CFG.DataStatus Word Structure

Bit Description
0 Refer to the Open status in the Status output pin (see page 55).
1 Refer to the Closed status in the Status output pin (see page 55).
2 Refer to the Trip status in the Status output pin (see page 55).
3 Refer to the TripElec status in the Status output pin (see page 55).
4 Refer to the NotAvailable status in the Status output pin (see page 55).
5 Refer to the MotorAvailable status in the Status output pin (see page 55).
6 Refer to the MotorMode status in the Status output pin (see page 55).

66 EIO0000002092 04/2020
 COMPACT Profile

COMPACT_CFG.WarningCode Word Structure

Bit Description
0 Refer to the Alarm201 code in the WarningCode output pin (see page 55).
1 Refer to the Alarm202 code in the WarningCode output pin (see page 55).
2 Refer to the Alarm203 code in the WarningCode output pin (see page 55).
3 Refer to the Alarm204 code in the WarningCode output pin (see page 55).
4 Refer to the Alarm205 code in the WarningCode output pin (see page 55).
5 Refer to the Alarm206 code in the WarningCode output pin (see page 55).
6 Refer to the Alarm207 code in the WarningCode output pin (see page 55).
7 Refer to the Alarm208 code in the WarningCode output pin (see page 55).
8 Refer to the Alarm209 code in the WarningCode output pin (see page 55).
9 Refer to the Alarm210 code in the WarningCode output pin (see page 55).
10 Refer to the LongTimeProtection code in the WarningCode output pin (see page 55).
11 Refer to the EarthLeakage code in the WarningCode output pin (see page 55).
12 Refer to the GroundFault code in the WarningCode output pin (see page 55).

COMPACT_CFG.WarningOrderCode Word Structure for MBCompactNSX

Bit Description
0 Refer to the Order code in the WarningOrderCode output pin (see page 55).
1 Refer to the WrongPassword code in the WarningOrderCode output pin (see page 55).
2 Refer to the MbPadLocked code in the WarningOrderCode output pin (see page 55).
3 Refer to the InternalWarning code in the WarningOrderCode output pin (see page 55).
4 Refer to the OutOfOrder code in the WarningOrderCode output pin (see page 55).
5 Refer to the NeedReset code in the WarningOrderCode output pin (see page 55).
6 Refer to the AlreadyClosed code in the WarningOrderCode output pin (see page 55).
7 Refer to the AlreadyOpen code in the WarningOrderCode output pin (see page 55).
8 Refer to the AlreadyReset code in the WarningOrderCode output pin (see page 55).
9 Refer to the ManualMode code in the WarningOrderCode output pin (see page 55).
10 Refer to the NotPresent code in the WarningOrderCode output pin (see page 55).
11 Refer to the InProgress code in the WarningOrderCode output pin (see page 55).
12 Refer to the ResetForbidden code in the WarningOrderCode output pin (see page 55).

EIO0000002092 04/2020 67
COMPACT Profile

COMPACT_CFG.WarningOrderCode Word Structure for MBUCompactNSX

Bit Description
0 Refer to the OrderUnsuccessful code in the WarningOrderCode2 output pin (see page 55).
1 Refer to the WrongPassword code in the WarningOrderCode output pin (see page 55).
2 Refer to the ManualMode code in the WarningOrderCode output pin (see page 55).
3 Refer to the AlreadyClosed code in the WarningOrderCode output pin (see page 55).
4 Refer to the AlreadyOpen code in the WarningOrderCode output pin (see page 55).
5 Refer to the AlreadyReset code in the WarningOrderCode output pin (see page 55).
6 Refer to the ResourceNotPresent code in the WarningOrderCode output pin (see page 55).
7 Refer to the InhibitModeOn code in the WarningOrderCode output pin (see page 55).
8 Refer to the OutOfOrder code in the WarningOrderCode output pin (see page 55).
9 Refer to the NeedReset code in the WarningOrderCode output pin (see page 55).
10 Refer to the InProgress code in the WarningOrderCode output pin (see page 55).
11 Refer to the ResetForbidden code in the WarningOrderCode output pin (see page 55).
12 Refer to the IFMPadlocked code in the WarningOrderCode output pin (see page 55).

68 EIO0000002092 04/2020
 COMPACT Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block waits for
the operations to be carried out by the device.
If a command has been sent and the command is not executed
within the time indicated by this variable, a follow-up alarm is issued.
The commands controlled are Open and Close. In the event of a
ResetFail, this is not interpreted as an alarm. Instead, the
detected failure continues, and you have to reset the Reseting
output (to FALSE).
Refresh TIME Refresh time for device data on serial Modbus communications.
NOTE: This refresh operation is carried out on read variables. Write
requests are carried out when required and have maximum priority.
ScanTime TIME Allows you to configure the time for which the alarm signals are kept
active.
Helps the monitoring subsystem to acquire the data for the alarms
that are automatically reset.
Password STRING Password is made up of 4 ASCII bytes and is sent internally before
executing certain commands. If the password is incorrect, it returns
WarningOrder to point this out.
ResetMode BOOL Enables to configure the type of reset. This type of reset is used for
communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset needs to be carried out. The first reset is
carried out after the time defined in CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow * 2
elapses, so on. If the value of CommandCtrlWindow is 0 s, its value
is not used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
Value
FALSE Communications are/the device is reset with the ResetFail
variable.
TRUE Communications are/the device is reset automatically.

EIO0000002092 04/2020 69
COMPACT Profile

Variable Type Description

ResetMinMax INT Resets registers to its minimum/maximum values.
MaxResetTime TIME When in automatic ResetMode, this variable is used to define the
maximum time that can elapse between 2 consecutive resets.
Refer to the Timing diagram below.
Scalefactor REAL Scale factor for Masterpact NT/NW and Compact NS Micrologix 5.0,
6.0 0r 7.0 trip units is 1.
Scale factor for Compact NSX Micrologix 5.2, 5.3, 6.2, 7.2 or 7.3 trip
units is 10.

NOTE: Public parameters are applicable only for MBCompactNSX.

Timing diagram:

70 EIO0000002092 04/2020
 COMPACT Profile

Diagnostics Information Management

Overview
The diagnostic codes that the device can return are read on the FailCode output variable.

Modbus Communication Diagnostics Codes

This code indicates that communications have not been established and can be reset:
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

This code indicates that communications have not been established between IFE and TRIP UNIT
and can be reset:
 FailCode[0]: 16#0004
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

or
 FailCode[0]: 16#0007
 FailCode[1]: 16#0200
 FailCode[2]: 16#0001
or
 FailCode[0]: 16#01FF
 FailCode[1]: 16#0200
 FailCode[2]: 16#0001
After the communications have been established, check Modbus client diagnostic codes for
FailCode [0] and FailCode [1]. The components make a distinction between detected read
request problems and write request problems:
 FailCode[2]: 16#0001 Read
 FailCode[2]: 16#0002 Write

EIO0000002092 04/2020 71
COMPACT Profile

Diagnostics Code Example

For a detected error, the code is:
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005

The field status can be reset.

The FailCode[0] can have one of the following codes:

Bit Value FailCode[0]–Cause of Trip Operation

0 1 Long-time protection Ir.
1 2 Short-time protection Isd.
2 4 Instantaneous protection Ii.
3 8 Ground-fault protection Ig.
4 16 Earth leakage (Vigi) protection IΔn.
5 32 Integrated instantaneous protection.
6 64 Internal detected failure (Stop).
9 512 Instantaneous protection with earth leakage (Vigi) trip unit.
10 1024 Unbalanced motor protection.
11 2048 Motor jam protection.
12 4096 Underload motor protection.
13 8192 Longstart motor protection.
14 16384 Reflex tripping protection.

72 EIO0000002092 04/2020
 Modicon Libraries General Purpose
MASTERPACT Profile
EIO0000002092 04/2020

Chapter 7
MASTERPACT Profile

MASTERPACT Profile

Overview
This chapter describes the DFBs of the MASTERPACT profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 74
DFB Representation 75
Inputs 78
Outputs 80
Inputs/Outputs 91
Public Variables 96
Diagnostics Information Management 98

EIO0000002092 04/2020 73
MASTERPACT Profile

Description

General
The MASTERPACT profile is used to manage the Masterpact and Masterpact draw-out/chassis
electrical protection circuit breakers.

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

Function Description
Remote resetting Allows resetting of the device.
Open/Close Allows circuit breaker to open and close.
Monitoring Allows the device measurement data to be monitored.

74 EIO0000002092 04/2020
 MASTERPACT Profile

DFB Representation

Representation
The following figure represents the function module of Masterpact profile:

NOTE:
 The underlined parameters are specific to profiles supported by DFB.
 Datatype of WarningOrderCode output pin for MBMASTERPACT and MBMASTERPACTC is
MASTERPACTSTATUS. Similarly, for MBUMASTERPACTMTZ, MBUMASTERPACTMTZC,
MBUMASTERPACTNx and MBUMASTERPACTNxC the datatype is INT

EIO0000002092 04/2020 75
MASTERPACT Profile

The table shows the parameters available for specific DFBs:

Parameters Components
Modbus Modbus over ULP
MBMAS- MBMAS- MBUMAS- MBUMASTER- MBUMAS- MBUMAS-
TER- TERPACTC TERPACT- PACTMTZC TERPACTNx TERPACT-
PACT MTZ NxC
Inputs ModBusAddress X X – – – –
IFMModBusAddress – – X X X X
Outputs ConnectedCE – X – X – X
DisconnectedCD – X – X – X
TestPositionCT – X – X – X
X : Parameter is available
– : Parameter is not available

NOTICE
COMMUNICATION INTERRUPTION
Provide possible combination of communication interruptions between Masterpact chassis and
PLC. Otherwise, it leads to loss of data.
Failure to follow these instructions can result in equipment damage.

76 EIO0000002092 04/2020
 MASTERPACT Profile

The IO module rotary position has to be set to have Cradle Management for Masterpact BCM-
ULP.

Function User Defined Predefined Application Selected

Applications 1 2 3 4 5 6 7 8 9(IO1) 9(IO2)
Monitoring Cradle X – – – – – – – – X
management
X : User defined application available
– : User defined application not available

NOTE:
 If a configuration of IO module is changed the EnableDFB pin has to be reset.
 MBMasterPactC, MBUMasterPactMTZC and MBUMasterPactNxC has to be used only if IO
module is configured for cradle management application.
 Cradle management is always IO1 for EIFE.
 For how to create project using Masterpact MTZ/Masterpact Nx circuit breakers,refer
Communication technologies (see page 591).
 If IFMModbusAddress is not configured then default value of 255 is considered.
 IFM v2 and above hardware supports these control functions.

EIO0000002092 04/2020 77
MASTERPACT Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the
control block.
 0 = The entire DFB is restarted (statuses,
output values, counters are lost) and
output values are set to 0.
 1 = Enables communications with the
devices for their operation.
Public variable values are loaded during the
first enabling cycle.
OpenClose BOOL This input controls the circuit breaker.
 Rising edge on pin = Closes the circuit
breaker.
 Falling edge on pin = Opens the circuit
breaker.
ResetFail BOOL 1 = Resets the Fail output parameter to 0 or
in case of inoperable device, sends a reset
command to the device if ControlCommand
is 1.
ModbusAddress1 INT Device address within the Modbus network.
You can find this variable in Modbus
communications.
IFMModbusAddress2 UINT Modbus address of the IFM Module.

ControlCommand BOOL Indicates to the DFB whether the Masterpact

is being controlled locally or from a source
external to the DFB.
 0 = Performs only read operations to
monitor the status of the device and does
not perform any control functions.
 1 = Performs read operations and
performs control operations not conflicting
with control commands coming from an
external control source.
NOTE: This pin configuration does not
impact the Masterpact unit.
1
: Parameter available only for MBMASTERPACT and MBMASTERPACTC.
2
: Parameter available only for MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC .

78 EIO0000002092 04/2020
 MASTERPACT Profile

Parameter Type Description

StatisticSelector INT Variable used to obtain statistics for the
Modbus network (requests carried out, time
between requests, and so on). This data
provides information for using
StatisticConnector pin within the
StatisticCounter DFB in General
Purpose library for communication.
The following list displays the
StatisticSelector value:
 1= Statistics of read request.
 2 = Statistics of write request.

EngParam2 MBUMASTERPACTMTZENGPARAM/ Engineering Parameters

MBUMASTERPACTNxENGPARAM
Parameter Type Description
Refresh TIME Time to refresh the cyclic data.
CommandCtrlWindow TIME Time window for the device to execute orders.
ScanTime TIME Minimum time to maintain warning signals.
Password string[26] Protection for commands.
ResetMode BOOL 0= Manual Reset.
1= Automatic Reset.
MaxResetTime TIME Maximum time between two resets.
1
: Parameter available only for MBMASTERPACT and MBMASTERPACTC.
2
: Parameter available only for MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC .

EIO0000002092 04/2020 79
MASTERPACT Profile

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL 1 = The device is enabled and free of detected errors.
This variable is TRUE as long as there is chassis
connected (CE), no communication interruption, no device
resetting, and the device is not tripped.
Fail BOOL 1 = A detected failure in the control block or in the device
or communication interruption.To reset the Fail output
pin, the ResetFail input has to be activated. The last
detected error code is shown on FailCode.
NOTE: If a communication interruption occurs, the
variables being read from the device cease to be refreshed
as a refresh operation can no longer be carried out. The
variables keep their last value.
Warning BOOL 1 = An alarm has been activated for the device. It does not
affect the block operation and does not need to be reset.
This signal remains active until the configured scan time.
WarningOrder BOOL 1 = The device has returned an alarm condition as the
result of executing a command. It does not affect the block
operation and does not need to be reset.
This signal remains active until the configured scan time.
FailCode ARRAY [0..2] OF INT When the Fail output is 1, it holds the code for the
detected error.
If the Fail bit is 0, it indicates the last detected error that
occurred. The detected error source is specified by using a
3-level structure.
Refer to Diagnostics Information Management
(see page 98) for more details.
1
: These parameters are available only with MBMASTERPACT and MBMASTERPACTC.
2
: These parameters are available only with MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC
3
: These parameters are available only with MBMASTERPACTC, MBUMASTERPACTNxC and MBUMASTERPACTMTZC.

80 EIO0000002092 04/2020
 MASTERPACT Profile

Parameter Type Description

WarningCode MASTERPACTWARNING Variable holds the alarm code.
The following table describes the WarningCode
information:
Parameter Type Description
LongTimePickUp BOOL 1 = Long-delay trip threshold.
CurrentUnbalance BOOL 1 = Current unbalance.
MaxCurrentPhase1 BOOL 1 = Maximum current on phase 1.
MaxCurrentPhase2 BOOL 1 = Maximum current on phase 2.
MaxCurrentPhase3 BOOL 1 = Maximum current on phase 3.
MaxCurrentNeutral BOOL 1 = Maximum current on neutral.
MinVoltage BOOL 1 = Minimum voltage.
MaxVoltage BOOL 1 = Maximum voltage.
VoltageUnbalance BOOL 1 = Voltage unbalance.
MaxPower BOOL 1 = Maximum power.
ReversePower BOOL 1 = Reverse power.
MinFrequency BOOL 1 = Minimum frequency.
MaxFrequency BOOL 1 = Maximum frequency.
PhaseRotation BOOL 1 = Phase rotation.
LoadSheddingCurrent BOOL 1 = Current-based load shedding.
LoadSheddingPower BOOL 1 = Power-based load shedding.
GroundFault BOOL 1 = Ground fault notification.
EarthLeakage BOOL 1 = Differential alarm (Vigi).
Discordance BOOL 1 = Chassis status discordance.
UnknownIOConfiguration BOOL 1 = Unknown IO configuration.
1
: These parameters are available only with MBMASTERPACT and MBMASTERPACTC.
2
: These parameters are available only with MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC
3
: These parameters are available only with MBMASTERPACTC, MBUMASTERPACTNxC and MBUMASTERPACTMTZC.

EIO0000002092 04/2020 81
MASTERPACT Profile

Parameter Type Description

WarningOrderCode1 MASTERPACTWARNINGORDER Variable holds the alarm code returned as the result of
executing a command. Commands can generate the
following diagnostic codes.
The following table describes the WarningOrderCode
information for MBMASTERPACT and MBMASTERPACTC:
Parameter Type Description
Order BOOL 1 = Follow-up alarm. The device is not
responding to the control command within
the time specified in CommandCtrlWindow.
WrongPassword BOOL 1 = Insufficient user permissions (incorrect
password).
InternalWarning BOOL 1 = Any other positive diagnostic codes
represent an internal detected error.
ManualMode BOOL 1 = The control is in Manual mode. Remote
commands are not permitted.
IncorrectCoilValue BOOL 1 = The DFB has an internal detected error.
An invalid number of windings are requested
during a write operation.
IncorrectNbrOfParam BOOL 1 = The DFB has an internal detected error
An invalid number of parameters are sent for
a 57400 command.
1
: These parameters are available only with MBMASTERPACT and MBMASTERPACTC.
2:
These parameters are available only with MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC
3:
These parameters are available only with MBMASTERPACTC, MBUMASTERPACTNxC and MBUMASTERPACTMTZC.

82 EIO0000002092 04/2020
 MASTERPACT Profile

Parameter Type Description

WarningOrderCode2 INT Variable holds the alarm code returned as
the result of executing a command.
Commands can generate the following
diagnostic codes.
The following table describes the
WarningOrderCode information for
MBUMASTERPACTMTZ,
MBUMASTERPACTMTZC,
MBUMASTERPACTNx and
MBUMASTERPACTNxC :
Parameter Value Description
Order 1 1 = Follow-up alarm. The device is not
responding to the control command within
the time specified in CommandCtrlWindow.
WrongPassword 2 1 = Insufficient user permissions (incorrect
password).
InternalWarning 3 1 = Any other positive diagnostic codes
represent an internal detected error.
ManualMode 4 1 = The control is in Manual mode. Remote
commands are not permitted.
IncorrectCoilValue 5 1 = The DFB has an internal detected error.
An invalid number of windings are requested
during a write operation.
IncorrectNumberOfParam 6 1 = The DFB has an internal detected error
An invalid number of parameters are sent for
a 57400 command.
InProgress 7 Command in progress.
IFEPadlocked 8 Access violation (IFE locking pad locked or
EIFE intrusive command mode is locked).
IFMPadlocked 9 Unable execute service (IFM locking pad
locked).
ResourceNotExist 10 Resource does not exist.
TimeoutDuringCommand 11 Timeout during command.
ResetBeforeCommand 12 Circuit breaker tripped, rests before
commands.
AlreadyClosed 13 Circuit breaker already closed.
AlreadyOpen 14 Circuit breaker already open.
AlreadyReset 15 Circuit breaker already reset.
NotPresent 16 Actuator not present.
InhibitModeOn 17 Inhibit mode on.
1
: These parameters are available only with MBMASTERPACT and MBMASTERPACTC.
EIO0000002092
2 04/2020 83
: These parameters are available only with MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC
3
: These parameters are available only with MBMASTERPACTC, MBUMASTERPACTNxC and MBUMASTERPACTMTZC.
MASTERPACT Profile

Parameter Type Description

Running BOOL 1 = The Masterpact unit is closed.

ConnectedCE 3 BOOL 1 = In case of Masterpact units with draw-out/chassis

enclosures, a value of 1 signal that the Masterpact unit is
mounted and connected for normal operation.
DisconnectedCD3 BOOL 1 = In case of Masterpact units with draw-out/chassis
enclosures, a value of 1 signal that the Masterpact unit is
disconnected and cannot be actuated.
TestPositionCT3 BOOL 1 = In case of Masterpact units with draw-out/chassis
enclosures, a value of 1 signal that the Masterpact unit is
in its Test position and can be actuated. Although, it does
not actually close the contact.
ExtControlled BOOL 1 = The device is being controlled from a source external
(for example, from the console, from a push-button panel,
or from the monitoring system) to the program.
NOTE: To calculate the state of this signal, use the
ControlCommand signal and the Owner variable. You
cannot use this signal as a ControlCommand input.
Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the
maximum time for resetting the detected error.
When a device or communication reset is carried out with
ResetFail, the DFB tries to reset the detected error
within the time period defined in CommandCtrlWindow.
If the detected error is reset, the Fail and Reseting
output variables are reset (set to FALSE). If the detected
error is not reset, the Reseting variable is FALSE and the
Fail variable remains TRUE. The ResetFail is edge-
based.
Refer to the Timing diagram below.
1: These parameters are available only with MBMASTERPACT and MBMASTERPACTC.
2
: These parameters are available only with MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC
3
: These parameters are available only with MBMASTERPACTC, MBUMASTERPACTNxC and MBUMASTERPACTMTZC.

84 EIO0000002092 04/2020
 MASTERPACT Profile

Parameter Type Description

Status MASTERPACTSTATUS The structure holds data containing the information that the
block extracts from the status variable of the circuit breaker
and communicating electrical drive.
The following table describes the status information:
Parameter Type Description
Open BOOL OFF state.
0 = The circuit breaker is open.
Closed BOOL ON state.
1 = The circuit breaker is closed.
TripSD BOOL SD trip indication contact
0 = Not tripped.
1 = Circuit breaker is tripped due to electrical
fault, shunt trip, or push-to-trip.
TripSDE BOOL SDE fault trip indication contact
0 = Circuit breaker is not tripped on electrical
fault.
1 = Circuit breaker is tripped due to electrical
fault (including ground-fault test and earth-
leakage test).
Discharged BOOL 1 = Discharged springs in motor-equipped
devices.
Charged BOOL 1 = Charged springs in motor-equipped
devices.
NotReadyToClose BOOL 1 = Not ready to close.
ReadyToClose BOOL 1 = Ready to close.
NotAvailable BOOL 1 = The status of the circuit breaker is
unavailable.
Info INT Indicates device status.
TrippingCause INT Cause of trip operation.
TrippingCauseExt INT Cause of trip operation extended.
1: These parameters are available only with MBMASTERPACT and MBMASTERPACTC.
2
: These parameters are available only with MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC
3: These parameters are available only with MBMASTERPACTC, MBUMASTERPACTNxC and MBUMASTERPACTMTZC.

EIO0000002092 04/2020 85
MASTERPACT Profile

Parameter Type Description

StatisticConnector STATISTICCONNECTOR Information used with Modbus communication to obtain
statistics on the Modbus network (requests carried out,
time between requests, and so on). This structure has
been created to use together with the
StatisticCounter DFB in General Purpose library for
communication.
The following table describes the StatisticConnector:
Parameter Type Description
Start BOOL 1 = Operation has started.
EndOk BOOL 1 = Operation has ended correctly.
EndNOk BOOL 1 = Operation has ended with a detected
error.
PartialTime DINT Partial time.
MASTERPACT_MEA MASTERPACT_MEA_DDT Data structure with measurement information. Whether
this data is available depends on the specific Micrologic
model: A=Ammeter, P=Power meter, H=Harmonics,
30/31/40/41=Type of system.
The following table describes the MASTERPACT_MEA_DDT
type:
Parameter Availability Type Description
CurrentI1 A/P/H REAL Current, instantaneous,
phase 1.
CurrentI2 A/P/H REAL Current, instantaneous,
phase 2.
CurrentI3 A/P/H REAL Current, instantaneous,
phase 3.
ResidualCurrentIN A/P/H, 41 REAL Current, instantaneous, N.
OverrunAlarms – INT Overrun alarms.
OverrunAlarmsExt – INT Overrun alarms extended.
OverrunAlarmsExt2 – INT Overrun alarms extended 2.
TripCounter – DINT Trip counter.
1
: These parameters are available only with MBMASTERPACT and MBMASTERPACTC.
2
: These parameters are available only with MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC
3
: These parameters are available only with MBMASTERPACTC, MBUMASTERPACTNxC and MBUMASTERPACTMTZC.

86 EIO0000002092 04/2020
 MASTERPACT Profile

Parameter Type Description

MASTERPACT_MEAExt MASTERPACT_MEAExt_DDT Data structure with measurement information. Whether
this data is available depends on the specific Micrologic
model: A, E, P, H.
The following table describes the
MASTERPACT_MEAExt_DDT type:
Parameter Availability Type Description
VoltageU21 P/H REAL Voltage, phases 1-2.
VoltageU32 P/H REAL Voltage, phases 2-3.
VoltageU13 P/H REAL Voltage, phases 1-3.
VoltageV1 P/H, 40/41 REAL Voltage, phase 1-N.
VoltageV2 P/H, 40/41 REAL Voltage, phase 2-N.
VoltageV3 P/H, 40/41 REAL Voltage, phase 3-N.
Frequency P/H REAL Frequency (derived from
phase 1).
TotalActivePower P/H REAL Total real power.
TotalReactivePower P/H REAL Total reactive power.
TotalApparentPower P/H REAL Total apparent power.
ActivePowerL1 P/H, 40/41 REAL Real power, phase 1.
ActivePowerL2 P/H, 40/41 REAL Real power, phase 2.
ActivePowerL3 P/H, 40/41 REAL Real power, phase 3.
ReactivePowerL1 P/H, 40/41 REAL Reactive power, phase 1.
ReactivePowerL2 P/H, 40/41 REAL Reactive power, phase 2.
ReactivePowerL3 P/H, 40/41 REAL Reactive power, phase 3.
ApparentPowerL1 P/H, 40/41 REAL Apparent power, phase 1.
ApparentPowerL2 P/H, 40/41 REAL Apparent power, phase 2.
1
: These parameters are available only with MBMASTERPACT and MBMASTERPACTC.
2
: These parameters are available only with MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC
3
: These parameters are available only with MBMASTERPACTC, MBUMASTERPACTNxC and MBUMASTERPACTMTZC.

EIO0000002092 04/2020 87
MASTERPACT Profile

Parameter Type Description

ApparentPowerL3 P/H, 40/41 REAL Apparent power, phase 3.
CosPhi H REAL Cos phi power factor.
ActiveEnergy P/H REAL Real power consumption.
ReactiveEnergy P/H REAL Reactive power consumption.
ApparentEnergyTotal P/H REAL Total apparent power
consumption.
PositiveActiveEnergy P/H REAL Positive real power Ea+ (kWh).
NegativeActiveEnergy P/H REAL Negative real power Ea- (kWh).
PositiveReactiveEnergy P/H REAL Positive reactive power Er+
(kVarh).
NegativeReactiveEnergy P/H REAL Negative reactive power Er-
(kVarh).
MASTERPACT_MEAExt1 MASTERPACT_MEAExt1_DDT Data structure with measurement information. Whether
this data is available depends on the specific Micrologic
model: P, H.
The following table describes the
MASTERPACT_MEAExt1_DDT type:
Parameter Availability Type Description
THDVoltageL1ToL2 H REAL THD, voltage, 1-2.
THDVoltageL2ToL3 H REAL THD, voltage, 2-3.
THDVoltageL1ToL3 H REAL THD, voltage, 1-3.
THDVoltageL1ToNeutral H REAL THD, voltage, 1-N.
THDVoltageL2ToNeutral H REAL THD, voltage, 2-N.
THDVoltageL3ToNeutral H REAL THD, voltage, 3-N.
THDCurrentL1 H REAL THD, current, phase 1.
THDCurrentL2 H REAL THD, current, phase 2.
THDCurrentL3 H REAL THD, current, phase 3.
THDCurrentAvg H REAL Average of 3 phase current
THD.
1
: These parameters are available only with MBMASTERPACT and MBMASTERPACTC.
2
: These parameters are available only with MBUMASTERPACTMTZ, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC
3: These parameters are available only with MBMASTERPACTC, MBUMASTERPACTNxC and MBUMASTERPACTMTZC.

88 EIO0000002092 04/2020
 MASTERPACT Profile

Info
Code with the information shown on the Control operator screen.The following table describes the
Info structure:

Variable value Status

2 Waiting for ready signal.
6 Masterpact unit open.
7 Masterpact unit closed.
10 Waiting ControlCommand. It has to be set to 1.
11 Missing EnableDFB.
12 Missing CommunicationOK. Communication interruption.
13 The status register is not available.
24 Remove ResetFail. Needs to be reset again.
81 Missing ResetFail. Inoperable device.
82 A reset is required.

TrippingCause
The register used to record the cause of a trip operation gives information regarding the cause of
a trip operation for basic protective functions. If a bit is set in this register, it means that the device
has tripped. The following table describes the reasons for tripping:

Bit Variable Value TrippingCause

0 1 Long-time protection Ir.
1 2 Short-time protection Isd.
2 4 Instantaneous protection Ii.
3 8 Ground-fault protection Ig.
4 16 Earth leakage (Vigi) protection IΔn.
5 32 Integrated instantaneous protection.
6 64 Internal detected failure (Stop).
7 128 Excessively high temperature.
8 256 Other protection (check TrippingCauseExt).
9 512 Instantaneous with earth-leakage protection (Vigi module) on the trip unit.
10 1024 Unbalance motor protection.
11 2048 Jam motor protection.
12 4096 Underload motor protection.
13 8192 Long-start motor protection.
14 16384 Reflex tripping protection.

EIO0000002092 04/2020 89
MASTERPACT Profile

TrippingCauseExt
If bit 8 of TrippingCause is active, the following table describes the reasons for trip operation:

Bit TrippingCauseExt
0 Current imbalance.
1 Overcurrent, phase 1.
2 Overcurrent, phase 2.
3 Overcurrent, phase 3.
4 Overcurrent on neutral.
5 Undervoltage.
6 Overvoltage.
7 Voltage imbalance.
8 Excessive power.
9 Reverse power.
10 Underfrequency.
11 Overfrequency.
12 Phase rotation.
13 Load shedding based on current.
14 Load shedding based on power.

Timing diagram:

90 EIO0000002092 04/2020
 MASTERPACT Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

MASTERPACT_ST MASTERPSACT_ST_DDT Device data structure holds the minimum information
required for performing control and monitoring functions.
The information used by the operator screen is usable
from the HMI/SCADA system.
MASTERPACT_CFG MASTERPACT_CFG_DDT Data structure with device information. The information
used by the operator screen is readable from the
HMI/SCADA system.
WorkMemory ANY_ARRAY_INT Array used for Modbus communications.
This variable is used with a Modbus port that serializes
Modbus requests in an optimum manner.

MASTERPACT_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit word is read-only.
CFGW WORD Device control.
Provides the means to control the device from the monitoring subsystem or from the
operator screen if Owner (1), or only from the monitoring subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value for reading from the
HMI/SCADA system.

MASTERPACT_CFG_DDT Type

Name Type Description

DataStatus WORD Device status
Info INT Code with information on statuses and required actions.
WarningCode WORD Information on the alarm code. Takes the values from the WarningCode
output.
WarningCodeExt WORD Extra information on the alarm code. Takes the values from the
WarningCode output.
WarningOrderCode WORD Information on the command alarm code. Takes the values from the
WarningOrderCode output.
FailCode0 INT Code of last level 0 detected error. Indicates which detected error has
occurred, FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates which detected error has
occurred, FailCode[1].

EIO0000002092 04/2020 91
MASTERPACT Profile

Name Type Description

FailCode2 INT Code of last level 2 detected error. Indicates which detected error has
occurred, FailCode[2].
TrippingCause INT Information about what caused the device trip.
TrippingCauseExt INT Extended information about what caused the device trip. Active when
TrippingCause bit 8 is active.

MASTERPACT_ST.STW Word Structure

Bit Description
0 Unknown device status or communication interruption. No variable refreshing.
1 Not ready.
2 Refer to the Closed status in the Status output pin (see page 80).
3 Inoperable device.
4 Alarm on the device or repetitive detected fault alarm requires resetting.
5 Communication interruption.
6 Requires resetting. A ResetFail is required.
7 Externally controlled.
8 Refer to the Reseting output pin (see page 80).
9 Refer to the EnableDFB input pin (see page 78).
10 TestPositionCT.
11 Charged.
12 Refer to the ReadyToClose status in the Status output pin (see page 80).
13 ConnectedCE.
14 Refer to the Open status in the Status output pin (see page 80).
15 Refer to the Trip status in the Status output pin (see page 80).

MASTERPACT_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 78).
1 Owner.
3 Refer to the Closed status in the Status output pin (see page 80).
6 Refer to the Open status in the Status output pin (see page 80).
7 Refer to the ControlCommand input pin (see page 78).

92 EIO0000002092 04/2020
 MASTERPACT Profile

MASTERPACT_CFG.DataStatus Word Structure

Bit Description
0 Refer to the Open status in the Status output pin (see page 80).
1 Refer to the Closed status in the Status output pin (see page 80).

2 * Refer to the TestPositionCT status in the output pin (see page 80).
3 Refer to the TripSD status in the Status output pin (see page 80).
4 Refer to the TripSDE status in the Status output pin (see page 80).
5 Refer to the Discharged status in the Status output pin (see page 80).
6 Refer to the Charged status in the Status output pin (see page 80).
7 Refer to the NotReadyToClose status in the Status output pin (see page 80).
8 Refer to the ReadyToClose status in the Status output pin (see page 80).
9 Refer to the NotAvailable status in the Status output pin (see page 80).

10* Refer to the ConnectedCE status in the output pin (see page 80).

11* Refer to the DisconnectedCD status in the output pin (see page 80).
*
: Available only for MBMASTERPACTC, MBUMASTERPACTMTZC, MBUMASTERPACTNx and
MBUMASTERPACTNxC.

MASTERPACT_CFG.WarningCode Word Structure

Bit Description
0 Refer to the LongTimePickUp code in the WarningCode output pin (see page 80).
1 Refer to the CurrentUnbalance code in the WarningCode output pin (see page 80).
2 Refer to the MaxCurrentPhase1 code in the WarningCode output pin (see page 80).
3 Refer to the MaxCurrentPhase2 code in the WarningCode output pin (see page 80).
4 Refer to the MaxCurrentPhase3 code in the WarningCode output pin (see page 80).
5 Refer to the MaxCurrentNeutral code in the WarningCode output pin (see page 80).
6 Refer to the MinVoltage code in the WarningCode output pin (see page 80).
7 Refer to the MaxVoltage code in the WarningCode output pin (see page 80).
8 Refer to the VoltageUnbalance code in the WarningCode output pin (see page 80).
9 Refer to the MaxPower code in the WarningCode output pin (see page 80).
10 Refer to the ReversePower code in the WarningCode output pin (see page 80).
11 Refer to the MinFrequency code in the WarningCode output pin (see page 80).
12 Refer to the MaxFrequency code in the WarningCode output pin (see page 80).

EIO0000002092 04/2020 93
MASTERPACT Profile

Bit Description
13 Refer to the PhaseRotation code in the WarningCode output pin (see page 80).
14 Refer to the LoadSheddingCurrent code in the WarningCode output pin (see page 80).
15 Refer to the LoadSheddingPower code in the WarningCode output pin (see page 80).

MASTERPACT_CFG.WarningCodeExt Word Structure

Bit Description
0 Refer to the GroundFault code in the WarningCode output pin (see page 80).
1 Refer to the EarthLeakage code in the WarningCode output pin (see page 80).

MASTERPACT_CFG.WarningOrderCode Word Structure

This table describes the WarningOrderCode for MBMASTERPACT and MBMASTERPACTC only.

Bit Description
0 Refer to the Order code in the WarningOrderCode output pin (see page 80).
1 Refer to the WrongPassword code in the WarningOrderCode output pin (see page 80).
2 Refer to the InternalWarning code in the WarningOrderCode output pin (see page 80).
3 Refer to the ManualMode code in the WarningOrderCode output pin (see page 80).
4 Refer to the IncorrectCoilValue code in the WarningOrderCode output pin (see page 80).
5 Refer to the IncorrectNbrOfParam code in the WarningOrderCode output pin (see page 80).

94 EIO0000002092 04/2020
 MASTERPACT Profile

MASTERPACT_CFG.WarningOrderCode Word Structure

This table describes the WarningOrderCode for MBUMASTERPACTMTZ, MBUMASTERPACTMTZC,
MBUMASTERPACTNx and MBUMASTERPACTNxC only.

Bit Description
0 Refer to the Order code in the WarningOrderCode output pin (see page 80).
1 Refer to the WrongPassword code in the WarningOrderCode output pin (see page 80).
2 Refer to the IFEPadLocked code in the WarningOrderCode output pin (see page 80).
3 Refer to the IFMPadLocked code in the WarningOrderCode output pin (see page 80).
4 Refer to the ResourceNotExist code in the WarningOrderCode output pin (see page 80).
5 Refer to the TimeoutDuringCommand code in the WarningOrderCode output pin (see page 80).
6 Refer to the ResetBeforeCommand code in the WarningOrderCode output pin (see page 80).
7 Refer to the InProgress code in the WarningOrderCode output pin (see page 80).
8 Refer to the AlreadyOpen code in the WarningOrderCode output pin (see page 80).
9 Refer to the AlreadyReset code in the WarningOrderCode output pin (see page 80).
10 Refer to the ManualMode code in the WarningOrderCode output pin (see page 80).
11 Refer to the NotPresent code in the WarningOrderCode output pin (see page 80).
12 Refer to the InhibitModeOn code in the WarningOrderCode output pin (see page 80).

EIO0000002092 04/2020 95
MASTERPACT Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block waits for
the operations to be carried out by the device.
If a command has been sent and the command is not executed
within the time indicated by this variable, a follow-up alarm is issued.
The commands controlled are Open and Close. In the event of a
ResetFail, this is not interpreted as an alarm. Instead, the
detected failure continues, and you have to reset the Reseting
output (to FALSE).
Refresh TIME Refresh time for device data on serial Modbus communications.
NOTE: This refresh operation is carried out on read variables. Write
requests are carried out when needed.
ScanTime TIME Allows you to configure the time for which the alarm signals are kept
active.
Helps the monitoring subsystem to acquire the data for the alarms
that are automatically reset.
Password STRING Password is made up of 4 ASCII bytes. This password is sent
internally before executing certain commands. If the password is
incorrect, it returns WarningOrder to point this out.
ResetMode BOOL Enables to configure the type of reset. This type of reset is used for
communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset has to be carried out. The first reset is
carried out after the time defined in CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow * 2
elapses, so on. If the value of CommandCtrlWindow is 0 s, its value
is not used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
value
FALSE Communications are/the device is reset with the ResetFail
variable.
TRUE Communications are/the device is reset automatically.

96 EIO0000002092 04/2020
 MASTERPACT Profile

Variable Type Description

MaxResetTime TIME When in automatic ResetMode, this variable is used to define the
maximum time that can elapse between 2 consecutive resets.
Timing diagram:

Scalefactor REAL Scale factor for Masterpact NT/NW and Compact NSX Micrologix
5.0, 6.0 0r 7.0 trip units is 1.
Scale factor for Compact NSX Micrologix 5.2, 5.3, 6.2, 7.2 or 7.3 trip
units is 10.

NOTE: Public parameters are applicable only for MBMASTERPACT, and MBMASTERPACTC.

EIO0000002092 04/2020 97
MASTERPACT Profile

Diagnostics Information Management

Overview
The diagnostic codes that the device can return are read on the FailCode output variable.

Modbus Communication Diagnostics Codes

This code indicates that communications have not been established and can be reset:
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

This code indicates that communications have not been established between IFE and TRIP UNIT
and can be reset:
 FailCode[0]: 16#0004
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

or
 FailCode[0]: 16#0007
 FailCode[1]: 16#0200
 FailCode[2]: 16#0001
or
 FailCode[0]: 16#01FF
 FailCode[1]: 16#0200
 FailCode[2]: 16#0001
This code indicates that communications have not been established between IFE and IO modules
and can be reset:
 FailCode[0]: 16#0005
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

After the communications have been established, check Modbus client diagnostic codes for
FailCode [0] and FailCode [1]. Components make a distinction between detected read
request problem and write request problem:
 FailCode[2]: 16#0001 Read
 FailCode[2]: 16#0002 Write

98 EIO0000002092 04/2020
 MASTERPACT Profile

Diagnostics Code Example

For a detected error, the code is:
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005

The diagnostic code is found in the TrippingCause status or TrippingCauseExt field.

The FailCode[0] can have one of the following codes:

Bit Value FailCode[0]–Cause of Trip Operation

0 1 Long-time protection Ir.
1 2 Short-time protection Isd.
2 4 Instantaneous protection Ii.
3 8 Ground-fault protection Ig.
4 16 Earth leakage (Vigi) protection IΔn.
5 32 Integrated instantaneous protection.
6 64 Internal detected failure (Stop).
9 512 Instantaneous protection with earth leakage (Vigi) trip unit.
10 1024 Unbalanced motor protection.
11 2048 Motor jam protection.
12 4096 Underload motor protection.
13 8192 Longstart motor protection.
14 16384 Reflex tripping protection.

EIO0000002092 04/2020 99
MASTERPACT Profile

100 EIO0000002092 04/2020

 Modicon Libraries General Purpose
HWCIRCUITBREAKER
EIO0000002092 04/2020

Chapter 8
HWCIRCUITBREAKER

HWCIRCUITBREAKER

Overview
This chapter describes the DFB of the Hardwired Circuit Breaker.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 102
DFB Representation 103
Inputs 104
Outputs 105
Inputs/Outputs 106
Diagnostics Information Management 109

EIO0000002092 04/2020 101

HWCIRCUITBREAKER

Description

General
The HWCIRCUITBREAKER control function is used to manage hardwired circuit breakers such as
MASTERPACT, COMPACT and other third-party circuit breakers.

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

Function Description
Remote resetting Allows resetting of the device.
Open/Close Allows circuit breaker to open and close.
Monitoring Allows the device status to be monitored.

102 EIO0000002092 04/2020

 HWCIRCUITBREAKER

DFB Representation

Representation
The following figure represents the function module of Hardwired circuit breaker.

EIO0000002092 04/2020 103

HWCIRCUITBREAKER

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL Enables the control function.
Open BOOL Command to open the circuit breaker (Rising edge
opens the breaker).
Close BOOL Command to close the circuit breaker (Rising edge
closes the breaker).
ResetFail BOOL Reset the detected failure of the DFB and the circuit
breaker.
ControlCommand BOOL Enables or disables the command sending to the
circuit breaker.
OFSignal BOOL Open or closed status.
 1 = Close
 0 = Open
SDSignal BOOL 1=Tripped (Push to trip).
SDESignal BOOL 1= Electrically tripped.
PFSignal BOOL 1= Breaker is ready to close.
CHSignal BOOL 1= Spring charged.
CESignal BOOL 1= Chassis connected.
CDSignal BOOL 1= Chassis disconnected.
CTSignal BOOL 1= Chassis in test position.
EngParam HWCB_ENGPAR_DDT Engineering parameters
Parameter Type Description
CommandCtrl TIME Time window for the device to execute orders.
Window
ScanTime TIME Minimum time to maintain warning signals.
//MaxResetTime TIME Maximum time between two resets.
ResetMode BOOL  0 = Manual Reset
 1 = Automatic reset

104 EIO0000002092 04/2020

 HWCIRCUITBREAKER

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL Device ready for operation.
Fail BOOL Inoperable device.
Warning BOOL Device alert
FailCode ARRAY[0..2] Stores the last active FailCode.
OF INT
OpenStatus BOOL Circuit breaker in open position.
ClosedStatus BOOL Circuit breaker in closed position.
SD BOOL Tripped (for example, push to trip).
SDE BOOL Electrically tripped.
PF BOOL Ready to close.
CH BOOL Spring charged.
CE BOOL Chassis connected.
CD BOOL Chassis disconnected.
CT BOOL Chassis in test position.
ExtControlled BOOL Circuit breaker is not controlled by the DFB.
Reseting BOOL Resetting the detected failures.
XF BOOL Close command pulse for 500 milliseconds.
MX BOOL Open Command pulse for 500 milliseconds.
Res BOOL Reset Command pulse for 500 milliseconds.

EIO0000002092 04/2020 105

HWCIRCUITBREAKER

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

HWCB_ST HWCB_ST_DDT Device data structure holds the minimum information
required for performing control and monitoring
functions. The information used by the operator
screen is usable from the HMI/SCADA system.
HWCB_CFG HWCB_CFG_DDT Data structure with device information. The
information used by the operator screen is readable
from the HMI/SCADA system.

HWCB_ST_DDT

Parameter Type Description

STW WORD Provides the device status. Access to the data held in
this bit word is read-only.
CFGW WORD Provides the data status and FailCode.

HWCB_CFG_DDT

Parameter Type Description

DataStatus WORD Device status
FailCode0 INT Code of last level 1 detected error. Indicates which
detected error has occurred, FailCode[0].
FailCode1 INT Code of last level 2 detected error. Indicates which
detected error has occurred, FailCode[1].
FailCode2 INT Code of last level 3 detected error. Indicates which
detected error has occurred, FailCode[2].
Info INT Provides device status information.

106 EIO0000002092 04/2020

 HWCIRCUITBREAKER

HWCB_ST.STW Words Structure

Bit Description
1 Control Function is not ready to send command.
2 Circuit breaker is in closed state.
3 Control Function is in Fail state due to trip.
4 Control Function is in Warning state due to feedback
not obtained after command is sent.
6 Reset is required as control function is in Fail state.
7 Control function is externally controlled.
8 Reseting is in progress.
9 EnableDFB pin status.
10 Test position.
11 Spring is charged.
12 Breaker is ready to close.
13 Chassis is connected to breaker.
14 Circuit breaker is in opened state.
15 Trip status (SD as well as SDE).

HWCB_ST.CFGW Word Structure

Bit Description
0 ResetFail command obtained from HMI.
1 Owner
3 Close command
6 Open command
7 Control command

EIO0000002092 04/2020 107

HWCIRCUITBREAKER

HWCsB_CFG.DataStatus Word Structure

Bit Description
0 Circuit breaker is in opened state.
1 Circuit breaker is in closed state.
2 SD trip status.
3 SDE trip status.
4 Chassis connected status.
5 Chassis disonnected status.
6 Chassis test position status
7 Spring charged status.
8 Ready to close status

108 EIO0000002092 04/2020

 HWCIRCUITBREAKER

Diagnostics Information Management

Overview
Diagnostic information describes the type of detected fail, by displaying diagnostic codes on the
FailCode output variable.

Modbus Communication Diagnostics Codes

This code indicates that the device has SD Electrical Trip:
 FailCode[0]: 16#0001
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005

This code indicates that the device has SDE Electrical Trip:
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005

EIO0000002092 04/2020 109

HWCIRCUITBREAKER

110 EIO0000002092 04/2020

 Modicon Libraries General Purpose
OperationLimit
EIO0000002092 04/2020

Chapter 9
OperationLimit

OperationLimit

Overview
This chapter describes the Operation Limit DFB which helps you limit the number of commands
issued to HWCIRCUITBREAKER control function within the configured time.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 112
DFB Representation 113
Inputs 114
Outputs 115

EIO0000002092 04/2020 111

OperationLimit

Description

General
The OperationLimit control function is used to limit the number of commands to manage opening
and closing operation of hardwired circuit breaker.

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

Function Description
Open/Close Limits the open and close commands issued to circuit breaker
control function.
Retries Number of command Retries.
Alert An alert is issued if the number of commands exceed the
configured Retries.

For example, if you configure the WatchTime as 4 seconds and Retries as 3 seconds, then you
can issue a total of 7 commands considering both open and close within 4 seconds.

112 EIO0000002092 04/2020

 OperationLimit

DFB Representation

Representation
The following figure represents the function module of Operation limit.

EIO0000002092 04/2020 113

OperationLimit

Inputs

Input Parameter Description

Parameter Type Description

Open BOOL Open command.
Close BOOL Close command.
EngParam OperationLimit_ENGPAR_D Engineering parameters
DT
Parameter Type Description
WatchTime TIME Within this time interval, the maximum number of
commands possible is less than or equal to Retries
configured.
Retries TIME Number of command retries.

NOTE:
 If EngParam is not connected then a default value of 60 seconds as WatchTime and 3
Retries are considered.
 If EngParam is connected and WatchTime is 0 seconds, then there are no restrictions on
commands.

114 EIO0000002092 04/2020

 OperationLimit

Outputs

Output Parameter Description

Parameter Type Description

OpenCommand BOOL Open command within retry.
CloseCommand BOOL Close command within retry.
Warning BOOL Retries exceeded for open and close command
combined.
NOTE: Warning is reset automatically after the
WatchTime is expired.

EIO0000002092 04/2020 115

OperationLimit

116 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Digital Protection Relays
EIO0000002092 04/2020

Part IV
Digital Protection Relays

Digital Protection Relays

EIO0000002092 04/2020 117

Digital Protection Relays

118 EIO0000002092 04/2020

 Modicon Libraries General Purpose
SEPAM Profile
EIO0000002092 04/2020

Chapter 10
SEPAM Profile

SEPAM Profile

Overview
This chapter describes the DFBs of SEPAM profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 120
DFB Representation 121
Inputs 124
Outputs 126
Inputs/Outputs 146
Public Variables 149
Diagnostics Information Management 151

EIO0000002092 04/2020 119

SEPAM Profile

Description

General
The SEPAM profile is used to manage Sepam 20, 40, and 80 digital protection devices in a
communications-based manner.
The Sepam20MB is classified into two variants:
 The MBSEPAM20CSTM DFB is the control block to manage the Sepam 20 digital protection
devices on a Modbus network for S (Substation),T (Transformer), M (Motor) variants of the
product.
 The MBSEPAM20CB DFB is the control block to manage the Sepam 20 digital protection devices
on a Modbus network for B (Busbar) variant of the product.

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

Function Description
Remote resetting Allows resetting of the device.
Opening/Closing Allows the element controlled by the Sepam to be opened or
closed.
Monitoring Allows the required parameter devices to be monitored.

120 EIO0000002092 04/2020

 SEPAM Profile

DFB Representation

Representation
The following figure represents the functional module of Sepam profile:

EIO0000002092 04/2020 121

SEPAM Profile

NOTE: The underlined parameters are specific for some components.

For DFBs communicating by I/O scanning, variables read from the device retain their last value
when a communication interruption occurs. For details, refer to the description of the
corresponding output parameter (see page 126).

WARNING
UNINTENDED EQUIPMENT OPERATION
When you configure the Last value parameter of the I/O scanner line, take into consideration
the behavior of the DFB when a communication interruption occurs.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

122 EIO0000002092 04/2020

 SEPAM Profile

The table shows the parameters available for specific components:

Parameters Components
SEPAM 20 SEPAM 40 SEPAM 80
MB- MB- MB- MB- ESE-
SEPAM20CB SEPAM20CSTM SEPAM40C SEPAM80C PAM80C
Inputs ModBusAddress X X X X –
IOScannerStatus – – – – X
StatisticSelector X X X X –
InputRead1 – – – – X
InputRead2 – – – – X
InputRead3 – – – – X
Outputs Status X X – – –
(SEPAM20STATUS)
Status – – X – –
(SEPAM40STATUS)
Ststus – – – X X
(SEPAM80STATUS)
InputsMap X X – – –
IOMap – – X – –
(SEPAM40IOMAP)
IOMap – – – X X
(SEPAM80IOMAP)
StatisticConnector X X X X –
SEPAM_IO20 X X – – –
SEPAM_IO40 – – X – –
SEPAM_IO80 – – – X X
SEPAM_AMEA – X – – –
SEPAM_VMEA X – – – –
SEPAM_MEA – – X X X
CommunicationOK – – – – X
OutputData – – – – X
X: Parameter is available.
–: Parameter is not available.

EIO0000002092 04/2020 123

SEPAM Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control
block.
 0 = The entire DFB is restarted (statuses, output
values, counters are lost) and output values are set
to 0.
 1 = Enables communications with the devices for
their operation.
Public variable values are loaded during the first
enabling cycle.
Open BOOL 1 = Opens the element controlled by the Sepam.
Close BOOL 1 = Closes the element controlled by the Sepam.
ResetFail BOOL 1 = Resets the Fail output parameter to 0 or in case
of inoperable device, sends a reset command to the
device if ControlCommand is 1.

ModBusAddress* INT Device address within the Modbus network.

IOScannerStatus* BOOL 1 = The node is present on the bus.

You can find this variable in Ethernet communications.
ControlCommand BOOL Indicates to the DFB whether the Sepam is being
controlled locally or from a source external to the DFB.
 0 = Performs only read operations to monitor the
status of the device and does not perform any
control functions.
 1 = Performs read operations and performs control
operations not conflicting with control commands
coming from an external control source.
NOTE: This input does not configure the Sepam.
InputRead1 * ARRAY [1..80] An array contains the read information obtained from
of INT the SEPAM80 unit through the IOScan. For the block
to work properly, allocate the structure (%MWx).
InputRead2* ARRAY [1..21]
of INT

InputRead3* ARRAY [1..16]

of INT
*
: Parameter is available for specific components.

124 EIO0000002092 04/2020

 SEPAM Profile

Parameter Type Description

StatisticSelector* INT This variable is used to obtain statistics for the
Modbus network (requests carried out, time between
requests, so on). This data provides information for
using StatisticConnector pin within the
StatisticCounter DFB in General Purpose library
for communication.
The following table displays the
StatisticSelector value:
Variable value Description
1 Read statistics, client.
2 Write statistics, client.
*
: Parameter is available for specific components.

EIO0000002092 04/2020 125

SEPAM Profile

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL 1 = The device is enabled and free of detected errors.
The device is ready to carry out or carrying out any
Open or Close command.
Fail BOOL 1 = A detected failure in the control block or in the
device or communication interruption.To reset the Fail
output pin, the ResetFail input has to be activated.
The last detected error code is shown on FailCode.
NOTE: If a communication interruption occurs, the
variables being read from the device cease to be
refreshed as a refresh operation can no longer be
carried out. The variables retain their last value.
Warning BOOL 1 = An alarm has been activated for the device. It does
not affect the block operation and does not need to be
reset.
This signal remains active until the cause of the alarm
disappears.
FailCode ARRAY [0..2] OF INT When the Fail output is 1, it holds the code for the
detected error.
If the Fail bit is 0, it indicates the last detected error
that occurred. The detected error source is specified by
using a 3-level structure. Refer to the Diagnostics
Information Management (see page 151) for more
details.
WarningCode SEPAMWARNING Holds a data structure with information on the alarm
currently on the Sepam unit.
The following table describes the code for the
WarningCode:
Parameter Type Description
Order BOOL 1 = Follow-up alarm. The device is not
responding to the control command within the
time specified in CommandCtrlWindow.
*: Parameter is available only for specific components.
1
: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

126 EIO0000002092 04/2020

 SEPAM Profile

Parameter Type Description

ExtControlled BOOL 1 = The Sepam is being controlled from a source
external (from the HMI/SCADA monitoring system) to
the system.
It does not consider local control through inputs
because the parameters of the local forcing input can be
configured with positive or negative logic.
Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the
maximum time for resetting the detected error.
When a device or communication reset is carried out
with ResetFail, the DFB tries to reset the detected
error within the time period defined in
CommandCtrlWindow.
If the detected error is reset, the Fail and Reseting
output variables are reset (set to FALSE). If the
detected error is not reset, the Reseting variable is
FALSE and the Fail variable remains TRUE. The
ResetFail is edge-based.
Refer to the Timing diagram below.
CommunicationOK BOOL 1 = Communication is OK.
*
: Parameter is available only for specific components.
1: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

EIO0000002092 04/2020 127

SEPAM Profile

Parameter Type Description

Status* SEPAM20STATUS The structure holds data containing the information that
the block extracts from the status variable of the
Sepam 20C unit (W16#0100).
NOTE: You can use the LocalRemote status variable
as an input for ControlCommand with positive or
negative logic depending on how parameters are
configured on the Sepam unit.
The following table describes the status information:
Parameter Type Description
Opened BOOL 1 = The element controlled by the Sepam unit
is opened.
Closed BOOL 1 = The element controlled by the Sepam unit
is closed.
Trip BOOL 1 = The Sepam unit is in tripped status.
Fault BOOL 1 = The Sepam unit requires resetting after
detected fault.
LocalRemote BOOL 1 = Remote control (to be configured through
an input.
SettingAActive BOOL 1 = Setting group A active.
SettingBActive BOOL 1 = Setting group B active.
TimeOutdated BOOL 1 = The Sepam unit does not have the correct
time.
PartialFault BOOL 1 = Partial detected error on the Sepam unit.
MajorFault BOOL 1 = Major detected error on the Sepam unit.
SettingMode BOOL 1 = The Sepam unit is in Local settings mode.
SynchronizationLost BOOL 1 = The Sepam unit is not synchronized.
DataLoss1Event BOOL 1 = Event detected in first zone.
Event1Zone BOOL 1 = Event occurrence in the first event zone.
Info INT Numerical code with the information on
statuses and required actions.
Refer to the Info table below.
*
: Parameter is available only for specific components.
1
: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

128 EIO0000002092 04/2020

 SEPAM Profile

Parameter Type Description

Status* SEPAM40STATUS The structure holds data containing the information that
the block extracts from the status variable of the
Sepam 40C unit (W16#0100).
The following table describes the status information:
Parameter Type Description
Opened BOOL 1 = The element controlled by the Sepam unit
is opened.
Closed BOOL 1 = The element controlled by the Sepam unit
is closed.
Trip BOOL 1 = The Sepam unit is in tripped status.
Fault BOOL 1 = The Sepam unit requires resetting after
detected fault.
LocalRemote BOOL 1 = Remote control (to be configured through
an input.
DataLoss2Event BOOL 1 = Event detected in second zone.
SettingAActive BOOL 1 = Setting group A active.
Event2Zone BOOL 1 = Event occurrence in second event zone.
SettingBActive BOOL 1 = Setting group A active.
TimeOutdated BOOL 1 = The Sepam unit does not have the correct
time.
PartialFault BOOL 1 = Partial detected error on the Sepam unit.
MajorFault BOOL 1 = Major detected error on the Sepam unit.
SettingMode BOOL 1 = The Sepam unit is in Local settings mode.
SynchronizationLost BOOL 1 = The Sepam unit is not synchronized.
DataLoss1Event BOOL 1 = Event detected in first zone.
Event1Zone BOOL 1 = Event occurrence in the first event zone.
Info INT Numerical code with the information on
statuses and required actions.
Refer to the Info table below.
*
: Parameter is available only for specific components.
1: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

EIO0000002092 04/2020 129

SEPAM Profile

Parameter Type Description

Status* SEPAM80STATUS The structure holds data containing the information that
the block extracts from the status variable of the
Sepam 80 unit.
The following table describes the status information:
Parameter Type Description
Opened BOOL 1 = The element controlled by the Sepam unit
is opened.
Closed BOOL 1 = The element controlled by the Sepam unit
is closed.
Trip BOOL 1 = The Sepam unit in tripped status.
Fault BOOL 1 = The Sepam unit requires resetting after
detected fault.
LocalRemote BOOL 1 = Remote control (to be configured through
an input.
ModbusSecurity BOOL 1 = The function is enabled.
DataLoss2Event BOOL 1 = Event detected in second zone.
SettingAActive BOOL 1 = Setting group A active.
Event2Zone BOOL 1 = Event occurrence in second event zone.
SettingBActive BOOL 1 = Setting group B active.
TimeOutdated BOOL 1 = The Sepam unit does not have the correct
time.
PartialFault BOOL 1 = Partial detected error on the Sepam unit.
MajorFault BOOL 1 = Major detected error on the Sepam unit.
SettingMode BOOL 1 = The Sepam unit is in Local settings mode.
RemoteSetting BOOL 1 = Remote setting is disabled.
CapacitiveInductive BOOL  0 = Capacitive network.
 1 = Inductive network.
SynchronizationLost BOOL 1 = The Sepam unit is not synchronized.
DataLoss1Event BOOL 1 = Event detected in first zone.
Event1Zone BOOL 1 = Event occurrence in the first event zone.
Info INT Numerical code with the information on
statuses and required actions.
Refer to the Info table below.
*: Parameter is available only for specific components.
1
: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

130 EIO0000002092 04/2020

 SEPAM Profile

Parameter Type Description

TS1 ARRAY OF WORD Array that holds remote indications (TS). Remote
indications are pre-assigned to protection or control
functions depending on the type of the Sepam unit
being used.
The following table describes the TS:
Parameter Type Description
TS0 WORD TS1–TS16. Remote indications (TS) from
TS1 to 16.
TS1 WORD TS17–TS32. Remote indications (TS) from
TS17 to 32.
TS2 WORD TS33–TS48. Remote indications (TS) from
TS33 to 48.
TS3 WORD TS49–TS64. Remote indications (TS) from
TS49 to 64.
TS4 WORD TS65–TS80. Remote indications (TS) from
TS65 to 80.
TS5 WORD TS81–TS96. Remote indications (TS) from
TS81 to 96.
TS6 WORD TS97–TS112. Remote indications (TS) from
TS97 to 112.
TS7 WORD TS113–TS128. Remote indications (TS) from
TS113 to 128.
TS8 WORD TS129–TS144. Remote indications (TS) from
TS129 to 144.
TS9 WORD TS145–TS160. Remote indications (TS) from
TS145 to 160.
TS10 WORD TS161–TS176. Remote indications (TS) from
TS161 to 176.
TS11 WORD TS177–TS192. Remote indications (TS) from
TS177 to 192.
TS12 WORD TS193–TS208. Remote indications (TS) from
TS193 to 208.
TS13 WORD TS209–TS224. Remote indications (TS) from
TS209 to 224.
TS14 WORD TS225–TS240. Remote indications (TS) from
TS225 to 240.
*: Parameter is available only for specific components.
1
: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

EIO0000002092 04/2020 131

SEPAM Profile

Parameter Type Description

InputsMap* SEPAM20INPUTSMAP Holds a data structure with the information on the state
of the inputs of the Sepam 20 unit.
The following table describes the InputsMap:
Parameter Type Description
I11 BOOL 1 = The state of the input I11.
I12 BOOL 1 = The state of the input I12.
I13 BOOL 1 = The state of the input I13.
I14 BOOL 1 = The state of the input I14.
I21 BOOL 1 = The state of the input I21.
I22 BOOL 1 = The state of the input I22.
I23 BOOL 1 = The state of the input I23.
I24 BOOL 1 = The state of the input I24.
I25 BOOL 1 = The state of the input I25.
I26 BOOL 1 = The state of the input I26.
*: Parameter is available only for specific components.
1: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

132 EIO0000002092 04/2020

 SEPAM Profile

Parameter Type Description

IOMap* SEPAM40IOMAP Holds a data structure with the information on the state
of the inputs and outputs of the Sepam 40 unit.
The following table describes the IOMap:
Parameter Type Description
I11 BOOL 1 = The state of the input I11.
I12 BOOL 1 = The state of the input I12.
I13 BOOL 1 = The state of the input I13.
I14 BOOL 1 = The state of the input I14.
I21 BOOL 1 = The state of the input I21.
I22 BOOL 1 = The state of the input I22.
I23 BOOL 1 = The state of the input I23.
I24 BOOL 1 = The state of the input I24.
I25 BOOL 1 = The state of the input I25.
I26 BOOL 1 = The state of the input I26.
O1 BOOL 1 = The state of the output O1.
O2 BOOL 1 = The state of the output O2.
O3 BOOL 1 = The state of the output O3.
O4 BOOL 1 = The state of the output O4.
O11 BOOL 1 = The state of the output O11.
O12 BOOL 1 = The state of the output O12.
O13 BOOL 1 = The state of the output O13.
O14 BOOL 1 = The state of the output O14.
Led1 BOOL 1 = The state of the LED 1.
Led2 BOOL 1 = The state of the LED 2.
Led3 BOOL 1 = The state of the LED 3.
Led4 BOOL 1 = The state of the LED 4.
Led5 BOOL 1 = The state of the LED 5.
Led6 BOOL 1 = The state of the LED 6.
Led7 BOOL 1 = The state of the LED 7.
Led8 BOOL 1 = The state of the LED 8.
Led9 BOOL 1 = The state of the LED 9.
*: Parameter is available only for specific components.
1
: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

EIO0000002092 04/2020 133

SEPAM Profile

Parameter Type Description

IOMap* SEPAM80IOMAP Holds a data structure with the information on the state
of the inputs and outputs of the Sepam 80 unit.
The following table describes the IOMap:
Parameter Type Description
I101 BOOL 1 = The state of the input I101.
I102 BOOL 1 = The state of the input I102.
I103 BOOL 1 = The state of the input I103.
I104 BOOL 1 = The state of the input I104.
I105 BOOL 1 = The state of the input I105.
I106 BOOL 1 = The state of the input I106.
I107 BOOL 1 = The state of the input I107.
I108 BOOL 1 = The state of the input I108.
I109 BOOL 1 = The state of the input I109.
I110 BOOL 1 = The state of the input I110.
I111 BOOL 1 = The state of the input I111.
I112 BOOL 1 = The state of the input I112.
I113 BOOL 1 = The state of the input I113.
I114 BOOL 1 = The state of the input I114.
O1 BOOL 1 = The state of the output O1.
O2 BOOL 1 = The state of the output O2.
O3 BOOL 1 = The state of the output O3.
O4 BOOL 1 = The state of the output O4.
O5 BOOL 1 = The state of the output O5.
O101 BOOL 1 = The state of the output O101.
O102 BOOL 1 = The state of the output O102.
O103 BOOL 1 = The state of the output O103.
O104 BOOL 1 = The state of the output O104.
*
: Parameter is available only for specific components.
1
: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

134 EIO0000002092 04/2020

 SEPAM Profile

Parameter Type Description

O105 BOOL 1 = The state of the output O105.
O106 BOOL 1 = The state of the output O106.
Led1 BOOL 1 = The state of the LED 1.
Led2 BOOL 1 = The state of the LED 2.
Led3 BOOL 1 = The state of the LED 3.
Led4 BOOL 1 = The state of the LED 4.

StatisticConnector * STATISTICCONNECTOR Information data is used with Modbus communication to

obtain statistics on the Modbus network (requests
carried out, time between requests, so on). This
structure has been created for its use together with the
StatisticCounter DFB in General Purpose library
for communication.
The following table describes the
StatisticConnector:
Parameter Type Description
Start BOOL 1 = Operation has started.
EndOk BOOL 1 = Operation has ended correctly.
EndNOk BOOL 1 = Operation has ended with a detected
error.
PartialTime DINT Partial time.
OutputData*
ARRAY [0...2] OF Remote control order.
INT
SEPAM_IO20_DDT Device data structure holds the information Description
for performing monitoring. The information
used by operator screen is usable from the
HMI/SCADA system.
The following table describes the
SEPAM_IO20_DDT type:
Parameter Type WORD Data with inputs. Provides the states for the
Sepam 20 inputs.
Refer to the InputsMap table below.
TS0 WORD TS1–TS16. Remote indications (TS) from
TS1 to 16.
TS1 WORD TS17–TS32. Remote indications (TS) from
TS17 to 32.
*: Parameter is available only for specific components.
1
: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

EIO0000002092 04/2020 135

SEPAM Profile

Parameter Type Description

TS2 WORD TS33–TS48. Remote indications (TS) from
TS33 to 48.
TS3 WORD TS49–TS64. Remote indications (TS) from
TS49 to 64.
SEPAM_IO40* SEPAM_IO40_DDT Device data structure holds the information for
performing monitoring. The information used by
operator screen is usable from the HMI/SCADA system.
The following table describes the SEPAM_IO40_DDT
type:
Parameter Type Description
InputsMap WORD Data with inputs. Provides the status for the
Sepam 40 inputs.
Refer to the InputsMap table below.
OutputsMap WORD Data with outputs. Provides the status for the
Sepam 40 outputs.
Refer to the OutputsMap table below.
LedStatus WORD Data with LEDs. Provides the status for the
Sepam 40 LEDs.
Refer to the LedStatus table below.
TS0 WORD TS1–TS16. Remote indications (TS) from
TS1 to 16.
TS1 WORD TS17–TS32. Remote indications (TS) from
TS17 to 32.
TS2 WORD TS33–TS48. Remote indications (TS) from
TS33 to 48.
TS3 WORD TS49–TS64. Remote indications (TS) from
TS49 to 64.
TS4 WORD TS65–TS80. Remote indications (TS) from
TS65 to 80.
TS5 WORD TS81–TS96. Remote indications (TS) from
TS81 to 96.
TS6 WORD TS97–TS112. Remote indications (TS) from
TS97 to112.
TS7 WORD TS113–TS128. Remote indications (TS) from
TS113 to 128.
TS8 WORD TS129–TS144. Remote indications (TS) from
TS129 to 144.
*
: Parameter is available only for specific components.
1: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

136 EIO0000002092 04/2020

 SEPAM Profile

Parameter Type Description

SEPAM_IO80* SEPAM_IO80_DDT Device data structure holds the information for
performing functions. The information used by operator
screen is usable from the HMI/SCADA system.
The following table describes the SEPAM_IO80_DDT
type:
Parameter Type Description
DataStatusExt WORD Device status extended for the Sepam 80.
Refer to the DataStatusExt table below.
InputsMap WORD Digital inputs. Provides the status for the
Sepam 80 inputs.
Refer to the InputsMap table below.
*
: Parameter is available only for specific components.
1: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

EIO0000002092 04/2020 137

SEPAM Profile

Parameter Type Description

OutputsMap WORD Digital outputs. Provides the status for the
Sepam 80 outputs.
Refer to the OutputsMap table below.
LedStatus WORD Data with LEDs. Provides the status for the
Sepam 80 LEDs.
Refer to the LedStatus table below.
TS0 WORD TS1–TS16. Remote indications (TS) from
TS1 to 16.
TS1 WORD TS17–TS32. Remote indications (TS) from
TS17 to 32.
TS2 WORD TS33–TS48. Remote indications (TS) from
TS33 to 48.
TS3 WORD TS49–TS64. Remote indications (TS) from
TS49 to 64.
TS4 WORD TS65–TS80. Remote indications (TS) from
TS65 to 80.
TS5 WORD TS81–TS96. Remote indications (TS) from
TS81 to 96.
TS6 WORD TS97–TS112. Remote indications (TS) from
TS97 to112.
TS7 WORD TS113–TS128. Remote indications (TS) from
TS113 to 128.
TS8 WORD TS129–TS144. Remote indications (TS) from
TS129 to 144.
TS9 WORD TS145–TS160. Remote indications (TS) from
TS145 to 160.
TS10 WORD TS161–TS176. Remote indications (TS) from
TS161 to 176.
TS11 WORD TS177–TS192. Remote indications (TS) from
TS177 to192.
TS12 WORD TS193–TS208. Remote indications (TS) from
TS193 to 208.
TS13 WORD TS209–TS224. Remote indications (TS) from
TS209 to 224.
TS14 WORD TS225–TS240. Remote indications (TS) from
TS225 to 240.
Reserved INT Reserved.
*: Parameter is available only for specific components.
1
: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

138 EIO0000002092 04/2020

 SEPAM Profile

Parameter Type Description

SEPAM_MEA* SEPAM_MEA_DDT Data structure with the device measurement
information.
The following table describes the SEPAM_MEA_DDT:
Parameter Type Description
CurrentI1 REAL Phase current I1 (A).
CurrentI2 REAL Phase current I2 (A).
CurrentI3 REAL Phase current I3 (A).
ResidualCurrentSum REAL Total residual current Io (A).
ResidualCurrentMeasured REAL Measured residual current (A).
AverageCurrentIm1 REAL Average phase current Im1 (A).
AverageCurrentIm2 REAL Average phase current Im2 (A).
AverageCurrentIm3 REAL Average phase current Im3 (A).
PeakCurrentIM1 REAL Peak demand phase current IM1 (A).
PeakCurrentIM2 REAL Peak demand phase current IM2 (A).
PeakCurrentIM3 REAL Peak demand phase current IM3 (A).
VoltageU21 REAL Line-to-line voltage U21 (V).
VoltageU32 REAL Line-to-line voltage U32 (V).
VoltageU13 REAL Line-to-line voltage U13 (V).
VoltageV1 REAL Line-to-neutral voltage V1 (V).
VoltageV2 REAL Line-to-neutral voltage V2 (V).
VoltageV3 REAL Line-to-neutral voltage V3 (V).
ResidualVoltage REAL Residual voltage V0 (V).
PositiveVoltage REAL Forward voltage Vd (V).
NegativeVoltage REAL Inverse voltage Vi (V).
Frequency REAL Frequency (Hz).
ActivePower REAL Real power p(kW).
ReactivePower REAL Reactive power Q(kVar).
AparentPower REAL Apparent power S(kVA).
PeakActivePower REAL Peak demand real power Pm(kW).
CosPhi REAL Cos Phi power factor.
*
: Parameter is available only for specific components.
1: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

EIO0000002092 04/2020 139

SEPAM Profile

Parameter Type Description

PositiveActiveEnergy DINT Positive real power Ea+(kWh).
NegativeActiveEnergy DINT Negative real power Ea-(kWh).
PositiveReactiveEnergy DINT Positive reactive power Er+(kVarh).
NegativeReactiveEnergy DINT Negative reactive power Er-(kVarh).
*
: Parameter is available only for specific components.
1
: From TS0 to TS8 is applicable for MBSEPAM40C. From TS0 to TS14 is applicable for MBSEPAM80C and ESEPAM80C.

SEPAM_VMEA_DDT for MBSEPAM20CB DFB

Parameter Type Description

SEPAM_VMEA* SEPAM_VMEA_DDT Voltage measurements for the Sepam B20, B21, and B22.
Parameter Type Description
VoltageU13 REAL Phase-to-phase voltage U13 (in Volts).
VoltageU21 REAL Phase-to-phase voltage U21 (in Volts).
VoltageU32 REAL Phase-to-phase voltage U32 (in Volts).
VoltageV1 REAL Phase-to-neutral voltage V1 (in Volts).
VoltageV2 REAL Phase-to-neutral voltage V2 (in Volts).
VoltageV3 REAL Phase-to-neutral voltage V3 (in Volts).
ResidualVoltage REAL Residual voltage V0 (in Volts).
PositiveVoltage REAL Positive sequence voltage Vd (in Volts).
Frequency REAL Frequency (in Hertz).

140 EIO0000002092 04/2020

 SEPAM Profile

SEPAM_AMEA_DDT for MBSEPAM20CSTM DFB

Parameter Type Description

SEPAM_AMEA* SEPAM_AMEA_DDT Current measurements for the Sepam B20, B21, and
B22.
Parameter Type Description
CurrentI1 REAL Phase current I1 (in Amps).
CurrentI2 REAL Phase current I2 (in Amps).
CurrentI3 REAL Phase current I3 (in Amps).
ResidualCurrent REAL Residual current I0 (in Amps).
ResidualCurrentMea REAL Residual current measured (in
Amps).
AverageCurrentI1 REAL Average phase current I1 (in Amps).
AverageCurrentI2 REAL Average phase current I2 (in Amps).
AverageCurrentI3 REAL Average phase current I3 (in Amps).
PeakCurrentIM1 REAL Peak demand phase current IM1 (in
Amps).
PeakCurrentIM2 REAL Peak demand phase current IM2 (in
Amps).
PeakCurrentIM3 REAL Peak demand phase current IM3 (in
Amps).

Info
The code with the information is shown on the Control Expert operator screen. The following table
describes the Info:

Variable value Description

1 Incorrect configuration of DFB parameter.
2 Waiting for Ready.
6 The Sepam unit is open.
7 The Sepam unit is closed.
10 Waiting ControlCommand. It has to be 1.
11 Missing EnableDFB.
12 Missing Communication OK.Communication interruption.
13 Status register value is 0.
23 Remove Open. It has to be 0.
24 Remove ResetFail. Reset again.

EIO0000002092 04/2020 141

SEPAM Profile

Variable value Description

81 Missing ResetFail. Inoperable device.
82 A reset is needed.

DataStatusExt Word Structure

The following table describes the DataStatusExt Word structure:

Bit Description
0 Refer to the ModbusSecurity status in the Status output pin.
1 Refer to the RemoteSettings status in the Status output pin.
2 Refer to the CapacitiveInductive status in the Status output pin.

OutputsMap Word Structure

The following table describes the OutputsMap Word structure:

Bit Description
0 Shows the state of the output 01.
1 Shows the state of the output 02.
2 Shows the state of the output 03.
3 Shows the state of the output 04.
4 Shows the state of the output 05.
5 Shows the state of the output 0101.
6 Shows the state of the output 0102.
7 Shows the state of the output 0103.
8 Shows the state of the output 0104.
9 Shows the state of the output 0105.
10 Shows the state of the output 0106.

142 EIO0000002092 04/2020

 SEPAM Profile

InputsMap Word Structure (SEPAM 20 and SEPAM 40)

The following table describes the InputsMap Word structure:

Bit Description
0 Shows the state of the digital input 11.
1 Shows the state of the digital input 12.
2 Shows the state of the digital input 13.
3 Shows the state of the digital input 14.
4 Shows the state of the digital input 21.
5 Shows the state of the digital input 22.
6 Shows the state of the digital input 23.
7 Shows the state of the digital input 24.
8 Shows the state of the digital input 25.
9 Shows the state of the digital input 26.

Timing diagram:

EIO0000002092 04/2020 143

SEPAM Profile

InputsMap Word Structure (SEPAM 80)

The following table describes the InputsMap Word structure:

Bit Description
0 Shows the state of the digital input I101.
1 Shows the state of the digital input I102.
2 Shows the state of the digital input I103.
3 Shows the state of the digital input I104.
4 Shows the state of the digital input I105.
5 Shows the state of the digital input I106.
6 Shows the state of the digital input I107.
7 Shows the state of the digital input I108.
8 Shows the state of the digital input I109.
9 Shows the state of the digital input I110.
10 Shows the state of the digital input I111.
11 Shows the state of the digital input I112.
12 Shows the state of the digital input I113.
13 Shows the state of the digital input I114.

LEDStatus Word Structure

The following table describes the LEDStatus Word structure:

Bit Description
0 Shows the state of the LED 1.
1 Shows the state of the LED 2.
2 Shows the state of the LED 3.
3 Shows the state of the LED 4.
4 Shows the state of the LED 5.
5 Shows the state of the LED 6.
6 Shows the state of the LED 7.
7 Shows the state of the LED 8.
8 Shows the state of the LED 9.
9 Shows the state of the LED 10.

144 EIO0000002092 04/2020

 SEPAM Profile

Timing diagram:

EIO0000002092 04/2020 145

SEPAM Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SEPAM_ST SEPAM_ST_DDT Device data structure holds the minimum
information required for performing control and
monitoring functions. The information used by the
operator screen is readable/writable from the
HMI/SCADA system.
SEPAM_CFG SEPAM_CFG_DDT Data structure with device information. The
information used by the operator screen is readable
from the HMI/SCADA system.
WorkMemory ANY_ARRAY_INT Array is used for Modbus communications.
This variable is meant to be used with a Modbus
port that serializes Modbus requests in an optimum
manner.

SEPAM_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit
word is read-only.
CFGW WORD Device control.
Enables to control the device from the monitoring subsystem or
from the operator screen if Owner (1), or only from the monitoring
subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value
for reading from the HMI/SCADA system.

SEPAM_CFG_DDT Type

Name Type Description

DataStatus WORD Information on the device status. Information on the Status
output structure.
Info INT Device information. Its value is Info status.
WarningCode WORD Sepam alarm code information. Takes the values from the
WarningCode output pin.
FailCode0 INT Code of last level 0 detected error. Indicates that a detected
error has occurred FailCode[0].

146 EIO0000002092 04/2020

 SEPAM Profile

Name Type Description

FailCode1 INT Code of last level 1 detected error. Indicates that a detected
error has occurred FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates that a detected
error has occurred FailCode[2].

SEPAM_ST.STW Word Structure

Bit Description
0 Unknown device status or communication interruption. No variable
refreshing.
1 Not ready.
2 Module is running.
3 Inoperable device problem.
4 Alarm on the device or DFB (follow-up or screw terminal-based
control).
5 Communication interruption.
6 Requires resetting. ResetFail is required.
8 Refer to the Reseting output pin (see page 126).
9 Refer to the EnableDFB input pin (see page 124).

SEPAM_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 124).
1 Owner.
3 Refer to the Close input pin (see page 124).
6 Refer to the Open input pin (see page 124).
7 Refer to the ControlCommand input pin (see page 124).

EIO0000002092 04/2020 147

SEPAM Profile

SEPAM_CFG.DataStatus Word Structure

Bit Description
0 Refer to the Fault status in the Status output pin (see page 126).
1 Refer to the Opened status in the Status output pin
(see page 126).
2 Refer to the Closed status in the Status output pin
(see page 126).
3 Refer to the Trip status in the Status output pin (see page 126).
4 Refer to the LocalRemote status in the Status output pin
(see page 126).
5 Refer to the SettingAActive status in the Status output pin
(see page 126).
6 Refer to the SettingBActive status in the Status output pin
(see page 126).
7 Refer to the TimeOutdated status in the Status output pin
(see page 126).
8 Refer to the SettingMode status in the Status output pin
(see page 126).
9 Refer to the SynchronizationLost status in the Status output
pin (see page 126).
10 Refer to the DataLoss1Event status in the Status output pin
(see page 126).
11 Refer to the Event1Zone status in the Status output pin
(see page 126).
12 Refer to the PartialFault status in the Status output pin
(see page 126).
13 Refer to the MajorFault status in the Status output pin
(see page 126).
14 Refer to the DataLoss2Event status in the Status output pin
(see page 126).
15 Refer to the Event2Zone status in the Status output pin
(see page 126).

SEPAM_CFG.WarningCode Word Structure

Bit Description
0 Refer to the Order in the WarningCode output pin (see page 126).

148 EIO0000002092 04/2020

 SEPAM Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block
waits for the operations to be carried out by the device.
If a command has been sent and the command is not
executed within the time indicated by this variable, a follow-
up alarm is issued.
The commands controlled are Open and Close. In the
event of a ResetFail, this is not interpreted as an alarm.
Instead, the detected failure continues, and you have to
reset the Reseting output (to FALSE).
Refresh TIME Refresh time for device data on serial Modbus
communications.
NOTE: This refresh operation is carried out on read
variables. Write requests are carried out when needed.
ScanTime TIME Allows you to configure the time for which the alarm signals
are kept active.
Helps the monitoring subsystem to acquire the data for the
alarms that are automatically reset.
ResetMode BOOL Enables to configure the type of reset. This type of reset is
used for communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to
define the interval after which a reset has to be carried out.
The first reset is carried out after the time defined in
CommandCtrlWindow elapses. The second reset is
carried out after CommandCtrlWindow * 2 elapses, so on.
If the value of CommandCtrlWindow is 0 s, its value is not
used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable value Description
FALSE Communications are/the device is reset with the
ResetFail variable.
TRUE Communications are/the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable is used to
define the maximum time that can elapse between 2
consecutive resets.
Refer to the Timing diagram below.

EIO0000002092 04/2020 149

SEPAM Profile

Timing diagram:

150 EIO0000002092 04/2020

 SEPAM Profile

Diagnostics Information Management

Overview
The diagnostic codes that the device can return are read on the FailCode output variable.

Parameter Configuration Diagnostics Codes

This detected error indicates that a public variable parameter contains a value that is not allowed.
To load new values, a rising edge is required on the EnableDFB input:
 FailCode[0]: 16#0003
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

Modbus Communication Diagnostics Codes

This code indicates that communications have not been established and can be reset:
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

After the communications have been established, check Modbus client diagnostic codes for
FailCode [0] and FailCode [1]. The components make a distinction between detected read
request problem and write request problem:
 FailCode[2]: 16#0001 Read
 FailCode[2]: 16#0002 Write

Diagnostics Code Example

For a detected error, the code is:
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005

It can be reset.

EIO0000002092 04/2020 151

SEPAM Profile

152 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Motor Controllers and Starters
EIO0000002092 04/2020

Part V
Motor Controllers and Starters

Motor Controllers and Starters

Overview
This part provides the detailed description, pin layout, pin description, operator screen of the device
control blocks of the Motor Controllers and Starters family.
These function blocks do not reflect any specific installation.

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

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

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
11 TeSys T Profile 155
12 Tesys U Profile 191

EIO0000002092 04/2020 153

Motor Controllers and Starters

154 EIO0000002092 04/2020

 Modicon Libraries General Purpose
TeSys T Profile
EIO0000002092 04/2020

Chapter 11
TeSys T Profile

TeSys T Profile

Overview
This chapter describes the DFBs of TeSys T profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 156
DFB Representation 157
Inputs 159
Outputs 171
Inputs/Outputs 182
Public Variables 186
Diagnostics Information Management 188

EIO0000002092 04/2020 155

TeSys T Profile

Description

General
The TeSys T profile is used to manage TeSys T motor management system on different
communication networks (Ethernet network based on IO scanning, Ethernet network using fast IO
scanning, Ethernet network using messaging, Modbus network, Advantys STB I/O island or
Profibus using PRM gateway/PRM master).

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

Function Description
Control Device operation.
Address Forward/reverse direction of rotation.
Speed This function enables the change of speed (fast or slow) if you are
working with a 2-speed motor start (double winding).
Device status Displays the status of the device.
indication
Remote resetting Allows resetting of the device.
Control or Monitoring Enables you to control or monitor the device.
Owner Manages the control system which is the owner (Operator or
Program). Therefore, it is responsible for setting the control.

NOTE:
 ETESYST and EIOSTESYST DFBs do not support corresponding device DTM for M340
controllers.
 For establishing the communication with TesysT devices through IOScanning or by using DTM,
the device Unit ID for TesysT varies for different firmware versions. Hence default value is set
to 1, as it supports most of the firmware versions. In case of unsuccessful communication, you
may need to configure the correct device Unit ID in the configuration parameter.

156 EIO0000002092 04/2020

 TeSys T Profile

DFB Representation

Representation
The following figure represents the functional module of TeSys T profile:

NOTE: The underlined parameters are specific for some components.

For DFBs communicating by I/O scanning, variables read from the device retain their last value
when a communication interruption occurs. For details, refer to the description of the
corresponding output parameter (see page 126).

EIO0000002092 04/2020 157

TeSys T Profile

WARNING
UNINTENDED EQUIPMENT OPERATION
When you configure the Last value parameter of the I/O scanner line, take into consideration
the behavior of the DFB when a communication interruption occurs.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

The table shows the parameters available for specific components:

Parameters Components
Ethernet Mod- Advantys Profib-
Normal IO Fast IO Messaging bus (TESYS- sus (TE-
scanning (EIO- scanning (EMESTE- (MBTE- TCTL) SYSPB)
STESYST) (ETE- SYST) SYST)
SYST)
Inputs ModbusAddress – – – X – –
DeviceAddress – – X – – –
IOScannerStatus X X – – – X
CommunicationOK – – – – X –
StatisticSelector – – X X – –
Inputs X X – – X X
DTMInputs X X – – – –
Outputs CommunicationOK X X – – – X
StatusExt X X X X X X
(TESYSTSTATUSEXT)
AverageCurrent X – X X – X
TESYST_MEA X – X X – –
TESYST_MEAEXT X – X X – –
TESYST_MEAEXT1 – – – X – –
TESYST_MEAEV40 X – X X – –
StatisticConnector – – X X – –
Outputs X X – – X X
DTMOutputs X X – – – –
Inputs/ WorkMemory – – X X – –
Outputs
X: Parameter is available.
–: Parameter is not available.

158 EIO0000002092 04/2020

 TeSys T Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control block.
 0 = The entire DFB is restarted (states, output values,
counters are lost) and output values are set to 0.
 1 = Enables communications with the devices for their
operation.
Public variable values are loaded during the first enabling cycle.

If the device is reset and Run pin is active, then the device will auto start. If manual start of the
device is required, then reset the Run pin followed by device.

NOTICE
UNINTENDED EQUIPMENT OPERATION
Reset the Run variable before resuming operation.
Failure to follow these instructions can result in equipment damage.

Parameter Type Description

Run BOOL 1 = Starts the motor run in the direction selected
with the Direction input variable.
Direction BOOL Direction of rotation of the motor.
 0 = Activates the forward direction drive.
 1 = Activates the reverse direction drive.

Only used in 2/3 Wire Reverser mode

configuration in TeSys T device. The device
causes incorrect operation in other operating
modes.

*
: Parameter is available for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

EIO0000002092 04/2020 159

TeSys T Profile

Parameter Type Description

ResetFail BOOL 1 = Resets the Fail output parameter to 0 or in
case of inoperable device, sends a reset
command to the device if ControlCommand is
1.
LowFastSpeed BOOL Slow/fast speed of rotation. For 2-speed motor
start configuration in device, refer to the TesysT
user manual.
Only used in the 2/3 Wire two Speed mode
configuration in TeSys T device.The device
causes incorrect operation in other operating
modes.

ThermalTest BOOL 1 = Checks the forced thermal detected error

input on the TeSys T.
OutputsMap TESYSTOUTPUTSMAP Holds a structure to control the Tesys outputs.
These outputs hold an image of this structure
values. (Memory in Modbus 700).
Name Type Description
Output1 BOOL 1 = Controls the state of output 1.
Output2 BOOL 1 = Controls the state of output 2.
Output3 BOOL 1 = Controls the state of output 3.
Output4 BOOL 1 = Controls the state of output 4.
ModbusAddress* INT Device address within the Modbus network.
You can find this variable in Modbus
communications.
*
: Parameter is available for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2
: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

160 EIO0000002092 04/2020

 TeSys T Profile

Parameter Type Description

DeviceAddress* STRING[26] Device address within the Ethernet network.
Refer to the Ethernet Technology
(see page 505).
Depending on the platform, the following
definitions apply:
Platform IP Addressing DeviceAddress (variable)
M340 ‘{IP}ID’
Quantum ‘{IP}ID’
M580 ‘{IP}ID’
NOTE: ID is 0.
IOScannerStatus* BOOL 1 = Indicates that the node is present on the
bus.
You can find this variable in Ethernet
communications.
NOTE: UnitID for EIOSTesysT and
ETesysT profile is 1.

CommunicationOK* BOOL 1 = The communication ok for the device

present in the IO scanner.
StatisticSelector* INT Refer to StatisticSelector
(see page 170).
ControlCommand BOOL Indicates to the DFB whether the motor is being
controlled locally or from a source external to
the DFB.
 0 = Performs only read operations to monitor
the status of the device and does not perform
any control functions.
 1 = Performs read operations and performs
control operations not conflicting with control
commands coming from an external control
source.
NOTE: This input does not configure the motor.
*
: Parameter is available for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4: Parameter is available only for Profibus components.

EIO0000002092 04/2020 161

TeSys T Profile

Parameter Type Description

INPUTS1 ANY_ARRAY_INT Holds an array structure with data obtained from
the device. You can control the starter/controller
with this input variable. This input is reserved for
the DFB, and you cannot use this input directly.
For the control block to work properly, allocate
the structure (%MWx). Refer to the
Communications Technologies (see page 503).
The Inputs pin should not be connected when
DTMInputs pin is connected, otherwise the
function detects an incorrect configuration.
The following table describes the
INPUTSstructure:
Parameter Type Description
Inputs [0] INT Reserved.
Inputs [1] INT Reserved.
Inputs [2] INT Reserved.
Inputs [3] INT Reserved.
Inputs [4] INT Status register 1.
*: Parameter is available for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

162 EIO0000002092 04/2020

 TeSys T Profile

Parameter Type Description

INPUTS1 Inputs [5] INT Status register 2.
Inputs [6] INT Logic input status.
Inputs [7] INT Logic output status.
Inputs [8] INT Reserved.
Inputs [9] INT Reserved.
Inputs [10] INT Notification register.
Inputs [11] INT Reserved.
Inputs [12] INT Reserved.
Inputs [13] INT Reserved.
Inputs [14] INT Thermal capacity.
Inputs [15] INT Average current.
Inputs [16] INT FLC current L1.
Inputs [17] INT FLC current L2.
Inputs [18] INT FLC current L3.
Inputs [19] INT FLC ground current.
Inputs [20] INT Current phase.
Inputs [21] INT Temperature.
Inputs [22] INT Reserved.
Inputs [23] INT Frequency.
Inputs [24] INT Motor temperature.
Inputs [25] INT Average voltage.
Inputs [26] INT L3 to L1 voltage.
Inputs [27] INT L1 to L2 voltage.
Inputs [28] INT L2 to L3 voltage.
Inputs [29] INT Voltage imbalance.
Inputs [30] INT Power factor.
Inputs [31] INT Real power.
Inputs [32] INT Reactive power.
*
: Parameter is available for specific components.
1: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

EIO0000002092 04/2020 163

TeSys T Profile

Parameter Type Description

INPUTS1 Inputs [33] INT Reserved.
Inputs [34] INT Reserved.
Inputs [35] INT Reserved.
Inputs [36] INT Reserved.
Inputs [37] INT Reserved.
Inputs [38] INT Reserved.
Inputs [39] INT Reserved.
Inputs [40] INT Reserved.
Inputs [41] INT Reserved.
Inputs [42] INT Reserved.
Inputs [43] INT Reserved.
Inputs [44] INT Reserved.
Inputs [45] INT Reserved.
Inputs [46] INT Reserved.
Inputs [47] INT Reserved.
Inputs [48] INT Reserved.
Inputs [49] INT Average current.
Inputs [50] INT Average current.
Inputs [51] INT L1 current.
Inputs [52] INT L1 current.
Inputs [53] INT L2 current.
Inputs [54] INT L2 current.
Inputs [55] INT L3 current
Inputs [56] INT L3 current.
Inputs [57] INT Ground current.
Inputs [58] INT Ground current.
Inputs [59] INT Reserved.
Inputs [60] INT Time trip.
*
: Parameter is available for specific components.
1: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

164 EIO0000002092 04/2020

 TeSys T Profile

Parameter Type Description

Inputs [61] INT Last start current.
Inputs [62] INT Last start duration.
Inputs [63] INT Number of starts.
INPUTS * ANY_ARRAY_INT Holds an array structure with data obtained from
the device. You can control the starter/controller
with this input variable. This input is reserved for
the DFB, and you cannot use this input directly.
For the control block to work properly, allocate
the structure (%MWx). Refer to the
Communications Technologies (see page 503).
The Inputs pin should not be connected when
DTMInputs pin is connected, otherwise the
function detects an incorrect configuration.
The following table describes the
INPUTSstructure:
Parameter Type Description
Inputs [0] INT Status register 1.
Inputs [1] INT Status register 2.
Inputs [2] INT Logic input status.
Inputs [3] INT Logic output status.
*:
Parameter is available for specific components.
1: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4: Parameter is available only for Profibus components.

EIO0000002092 04/2020 165

TeSys T Profile

Parameter Type Description

INPUTS4 ARRAY [0..9] OF BYTE Holds an array structure with data coming from
the acutuator. This variable is reserved for the
DFB, and You cannot use this variable directly.
The following table describes the
INPUTSstructure:
Parameter Type Description
Inputs [0] BYTE System status.
Inputs [1] BYTE System status.
Inputs [2] BYTE Average current MSB.
Inputs [3] BYTE Average current LSB.
Inputs [4] BYTE Logic input status MSB.
Inputs [5] BYTE Logic input status LSB.
Inputs [6] BYTE Logic output status MSB.
Inputs [7] BYTE Logic output status LSB.
Inputs [8] BYTE System status register 2 - MSB.
Inputs [9] BYTE System status register 2 - LSB.
DTMINPUTS1 EIOSTESYST_IN_NOCETH Holds an input structure for the data to be
obtained from device DTM. You can read device
monitoring information with this input variables.
This input pin has to be used with the device
DTM.
The DTMInputs pin should not be connected
when Inputs pin is connected, otherwise the
function detects an incorrect configuration
The information available for
EIOSTESYST_IN_NOCETH on Ethernet is
shown in the following table:
Parameter Type Description
Fault_code UINT Code of detected fault
Fault_register_1 WORD Register 1 of detected fault
Fault_register_2 WORD Register 2 of detected fault
*: Parameter is available for specific components.
1: Parameter is available only for Ethernet normal IO scanning.
2
: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

166 EIO0000002092 04/2020

 TeSys T Profile

Parameter Type Description

DTMINPUTS1 Fault_register_3 WORD Register 3 of detected fault
System_status_register_1 WORD System status register 1
System_status_register_2 WORD System status register 2
Logic_inputs_status WORD Logic input status
Logic_outputs_status WORD Logic output status
IO_status WORD I/O status
Warning_code UINT Alert code
Warning_register_1 WORD Alert register 1
Warning_register_2 WORD Alert register 2
Warning_register_3 WORD Alert register 3
Motor_temperature_ UINT Motor temperature sensor
sensor_degree
Thermal_capacity_level UINT Thermal capacity level (% trip level)
Average_current_ratio UINT Average current ratio (% FLC)
L1_current_ratio UINT L1 current ratio (% FLC)
L2_current_ratio UINT L2 current ratio (% FLC)
L3_current_ratio UINT L3 current ratio (% FLC)
Ground_current_ratio UINT Ground current ratio (x0.1% FLC
Min)
Current_phase_imbalance UINT Current phase imbalance (%)
Controller_internal_ INT Controller Internal Temperature
temperature
Controller_config_ UINT Controller configuration checksum
checksum
Frequency UINT Frequency (x0.01Hz)
Motor_temperature_sensor UINT Motor temperature sensor (x0.1
ohms)
Average_voltage UINT Average voltage
L3L1_voltage UINT L3 to L1 voltage
L1L2_voltage UINT L1 to L2 voltage
L2L3_voltage UINT L2 to L3 voltage
Voltage_phase_imbalance UINT Voltage phase imbalance (%)
Power_factor UINT Power factor (x0.01)
*
: Parameter is available for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter
EIO0000002092 04/2020 is available only for Profibus components. 167
TeSys T Profile

Parameter Type Description

DTMINPUTS1 Active_power UINT Active power (x0.01kW)
Reactive_power UINT Reactive power (x0.0kVAR)
Auto_restart_status_ WORD Auto restart status register
register
Controller_last_power_ WORD Last power Off duration
off_durati
Not_significant UINT Not significant
Not_significantA UINT Not significant
Not_significantB UINT Not significant
Not_significantC UINT Not significant
Network_port_monitoring WORD Network port monitoring
Network_port_baud_rate UINT Network port baud rate
Not_significantD UINT Not significant
Network_port_parity UINT Network port parity
Not_significantE UINT Not significant
Not_significantF UINT Not significant
Not_significantG UINT Not significant
Not_significantH UINT Not significant
Not_significantI UINT Not significant
Not_significantJ UINT Not significant
Average_current UINT Average current (x0.01A)
Average_current_1 UINT Average current (x0.01A)
L1_current UINT L1 current (x0.001A)
L1_current_1 UINT L1 current (x0.001A)
L2_current UINT L2 current (x0.001A)
L2_current_1 UINT L2 current (x0.001A)
L3_current UINT L3 current (x0.001A)
L3_current_1 UINT L3 current (x0.001A)
Ground_current UINT Ground current (mA)
Ground_current_1 UINT Ground current (mA)
*
: Parameter is available for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

168 EIO0000002092 04/2020

 TeSys T Profile

Parameter Type Description

DTMINPUTS1 Controller_port_ID UINT Controller port ID
Time_to_trip UINT Time to trip (x1s)
Motor_last_start_ UINT Motor last start current ratio (%FLC)
current_ ratio
Motor_last_duration UINT Motor last duration (x0.1% FLC Min)
Motor_last_duration UINT Motor starts per hour count

DTMINPUTS2 ETESYST_IN_NOCETH Holds an input structure for the data to be

obtained from device DTM. You can read device
monitoring information with this input variables.
This input pin has to be used with the device
DTM.
The DTMInputs pin should not be connected
when Inputs pin is connected, otherwise the
function detects an incorrect configuration
The information available for
ETESYST_IN_NOCETH on Ethernet is shown in
the following table:
Parameter Type Description
Mirror_status_register WORD Mirror status register
Reserved WORD Reserved
Mirrors_System_Status_ WORD Mirrors system status register 1
Register_1
Mirrors_System_Status_ WORD Mirrors system status register 2
Register_2t
Mirrors_logic_inputs_ WORD Mirrors logic inputs status
status
Logic_outputs_status WORD Logic outputs status
*
: Parameter is available for specific components.
1: Parameter is available only for Ethernet normal IO scanning.
2
: Parameter is available for Ethernet fast IO scanning.
3: Parameter is available for Advantys components.
4: Parameter is available only for Profibus components.

NOTE: For DTM configuration (see page 534).

EIO0000002092 04/2020 169

TeSys T Profile

StatisticSelector
Variable is used to obtain statistics for the Modbus network (requests carried out, time between
requests, so on). This data provides information for using StatisticConnector pin within the
StatisticCounter DFB in General Purpose library for communication.

Variable value Description

1 Read statistics, client.
2 Write statistics, client.

170 EIO0000002092 04/2020

 TeSys T Profile

Outputs

Output Parameter Description

Output Type Description

Ready BOOL 1 = The device is enabled and free of detected errors.
The device is ready to carry out or carrying out any Run
or Stop command.
Fail BOOL 1 = A detected failure in the control block or in the
device or communication interruption.To reset the
Fail output pin, the ResetFail input has to be
activated. The last detected error code is shown on
FailCode.
NOTE: If communication interruption occurs, the
variables being read from the device ceases to be
refreshed as a refresh operation can no longer be
carried out. The variables keep their last value.
Warning BOOL 1 = An alarm has been activated for the device. It
cannot be reset because the signal remains active until
the cause of the alarm is removed or until the maximum
set ScanTime is reached.
FailCode ARRAY [0..2] OF INT When Fail output is 1, it holds the code for the
detected error.
If Fail output is 0, it indicates the last detected error
that occurred.
The detected error source is specified by a 3-level
structure. Refer to the Diagnostics Information
Management (see page 188) for more details.
*
: Parameter is available only for specific components.
1: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

EIO0000002092 04/2020 171

TeSys T Profile

Output Type Description

WarningCode TESYSTWARNING Holds a data structure with information about the alarm
currently on the device.
Name Type Description
Ground BOOL 1 = Ground alarm.
Thermal BOOL 1 = Thermal alarm on the device.
Jam BOOL 1 = Mechanical jam alarm.
Phase BOOL 1 = Phase alarm.
UnderCurrent BOOL 1 = An undercurrent alarm.
HMIPort BOOL 1 = An HMI port communication
interruption alarm.
InternalTmp BOOL 1 = Internal temperature alarm.
Internal BOOL 1 = An alarm for internal detected error.
Network BOOL 1 = Network port communication
interruption alarm.
Order BOOL 1 = Follow-up alarm.
The device is not responding to the
control command within the time
specified in CommandCtrlWindow.
ForcedLocalMode BOOL 1 = The device is forced locally in the
ForcedLocalMode status.
Is controlled through the screw
terminal.
Running BOOL 1 = The TeSys T is running. Current is higher than 10%
of FLC.
ExtControlled BOOL 1 = The device is being controlled from an external
source (for example, from the console, from a push-
button panel, or from the monitoring system) to the
system.
Provides information for programming.
NOTE: The ControlCommand signal, the Owner
variable, and the ForcedLocalMode status are used
to activate this signal. You cannot use this signal as a
ControlCommand input.
*
: Parameter is available only for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2
: Parameter is available for Ethernet fast IO scanning.
3: Parameter is available for Advantys components.
4: Parameter is available only for Profibus components.

172 EIO0000002092 04/2020

 TeSys T Profile

Output Type Description

Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the
maximum time for resetting the detected failure.
When a device or communication reset is carried out
with ResetFail, the DFB tries to reset the detected
failure within the time period defined in
CommandCtrlWindow.
If the detected failure is reset, the Fail and Reseting
output variables are reset (set to FALSE). If the
detected failure is not reset, the Reseting variable is
set to FALSE and the Fail variable remains TRUE.
The ResetFail is edge-based.
Timing diagram:

CommunicationOk* BOOL 1 = The communication is ok for the device present in

the IO scanner.
*: Parameter is available only for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4: Parameter is available only for Profibus components.

EIO0000002092 04/2020 173

TeSys T Profile

Output Type Description

Status TESYSTSTATUS The structure holds data structure with the information
that the module extracts from the status variable of the
device.
The following table describes the status information:
Parameter Type Description
Ready BOOL 1 = Switch in ON position. Device is
operational.
Activated BOOL 1 = The contact is activated. System
on.
Fail BOOL 1 = TesysT is not operational.
Warning BOOL 1 = Alarm present on device.
Trip BOOL 1 = The Tesys protection has tripped.
ResetAuth BOOL 1 = Reset authorized detected error.
ControllerPower BOOL 1 = The system is powered.
MotorRunning BOOL 1 = Motor running with a current higher
than 10% of full-load amperage.
HMIControlled BOOL 1 = HMI port is controlled.
MotorStarting BOOL 1 = The motor is starting.
State (see page 180) INT Numerical code corresponding to the
device status.
Refer to the State table below.
Info (see page 181) INT Numerical code with the information on
statuses and required actions.
Refer to the Info table below.
*: Parameter is available only for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2
: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

174 EIO0000002092 04/2020

 TeSys T Profile

Output Type Description

StatusExt* TESYSTSTATUSEXT Holds a data structure with information that the module
extracts from the state variable of the device.
The following table describes the StatusExt:
Parameter Type Description
AutoResetActive BOOL 1 = Auto-reset is active.
FaultRequested BOOL 1 = Detected error, restart (off/on)
request.
RestartTimeUnd BOOL 1 = Motor restart time undefined.
RapidCicleLockout BOOL 1 = Rapid cycle lockout.
LoadSheding BOOL 1 = Load shedding.
MotorSpeed BOOL 1 = Motor speed.
HMILostComms BOOL 1 = Communication interruption with
the HMI port.
LostComms BOOL 1 = Communication interruption with
the network port.
MotorTransitionLockout BOOL 1 = Motor transition lockout.
InputsMap TESYSTINPUTSMAP Holds a data structure with information on the state of
the device inputs.
The following table describes the InputsMap:
Parameter Type Description
Input1 BOOL 1 = The state of the logic input 1.
Input2 BOOL 1 = The state of the logic input 2.
Input3 BOOL 1 = The state of the logic input 3.
Input4 BOOL 1 = The state of the logic input 4.
Input5 BOOL 1 = The state of the logic input 5.
Input6 BOOL 1 = The state of the logic input 6.
Input7 BOOL 1 = The state of the logic input 7.
Input8 BOOL 1 = The state of the logic input 8.
Input9 BOOL 1 = The state of the logic input 9.
Input10 BOOL 1 = The state of the logic input 10.
*
: Parameter is available only for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2
: Parameter is available for Ethernet fast IO scanning.
3: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

EIO0000002092 04/2020 175

TeSys T Profile

Output Type Description

IOMap TESYSTIOMAP Holds a data structure with information on the state of
the device inputs and outputs.
The following table describes the IOMap:
Parameter Type Description
Output1 BOOL 1 = The state of the digital output 1.
Output2 BOOL 1 = The state of the digital output 2.
Output3 BOOL 1 = The state of the digital output 3.
Output4 BOOL 1 = The state of the digital output 4.
AverageCurrent* INT Average value of current ratio in %FLC.

TESYST_MEA* TESYST_MEA_DDT Refer to TESYST_MEA_DDT (see page 178) Type.

TESYST_MEAEXT* TESYST_MEAEXT_DDT Refer to TESYST_MEAEXT_DDT (see page 179) Type.

TESYST_MEAEV40* TESYST_MEAEV40_DDT Refer to TESYST_MEAEV40_DDT (see page 179)

Type.
TESYST_MEAEXT1* TESYST_MEAEXT1_DDT Refer to TESYST_MEAEXT1_DDT (see page 180)
Type.
StatisticConnector STATISTICCONNECTOR Refer to STATISTICCONNECTOR (see page 180).

Outputs* ANY_ARRAY_INT Holds an array structure with data sent to the device.
You can control the starter/controller with this output
variable. This variable is reserved for the DFB, and
You cannot use this variable directly. For the control
block to work properly, allocate the structure (%MWx).
Refer to the Communications Technologies
(see page 503).
The following table describes the OUTPUTSstructure:
Parameter Type Description
Outputs [0] INT Output control.
Outputs [1] INT System control.
Outputs [2] INT Reserved.
Outputs3 ANY_ARRAY_INT Data sent to the actuator.
*: Parameter is available only for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2
: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

176 EIO0000002092 04/2020

 TeSys T Profile

Output Type Description

Outputs4 ARRAY [0..5] OF BYTE Holds an array structure with data sent to the
acutuator. This variable is reserved for the DFB, and
You cannot use this variable directly.
The following table describes the OUTPUTSstructure:
Parameter Type Description
Outputs [0] BYTE Control command.
Outputs [1] BYTE Control command.
Outputs [2] BYTE Reserved.
Outputs [3] BYTE Reserved.
Outputs [4] BYTE Logic output command.
Outputs [5] BYTE Logic output command.
DTMOutputs1 EIOSTESYST_OUT_NOCETH Holds an output structure for the data to be written from
controller to the device via Device DTM. This output pin
has to be used when the device DTM is used.
The following table describes the
EIOSTESYST_OUT_NOCETH information available for
TeSysT on Ethernet networks:
Parameter Type Description
Logic_outputs_command_re WORD Logic outputs command register of
gister Tesys T
Reserved WORD Reserved
Reserved_1 WORD Reserved 1
Reserved_2 WORD Reserved 2
Control_register_1 WORD Control register 1
*: Parameter is available only for specific components.
1:
Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4
: Parameter is available only for Profibus components.

EIO0000002092 04/2020 177

TeSys T Profile

Output Type Description

DTMOutputs2 ETESYST_OUT_NOCETH Holds an output structure for the data to be written from
controller to the device via Device DTM. This output pin
has to be used when the device DTM is used.
The following table describes the
ETESYST_OUT_NOCETH information available for
TeSysTFast on Ethernet networks:
Parameter Type Description
Logic_Outputs_Command_Re WORD Logic outputs command register
gister
Control_Register_1 WORD Control register 1
Analog_Output_1_Command WORD Analog output 1 command
*:
Parameter is available only for specific components.
1
: Parameter is available only for Ethernet normal IO scanning.
2: Parameter is available for Ethernet fast IO scanning.
3
: Parameter is available for Advantys components.
4: Parameter is available only for Profibus components.

TESYST_MEA_DDT Type
TESYST_MEA is a data structure with device information. The following table describes the
TESYST_MEA_DDT:

Parameter Type Description

FLCGroundCurrent REAL Ground current ratio (%FLC minimum).
Frequency REAL Frequency (Hz).
ThermalCapacity INT Thermal capacity level (% trip level).
CurrentPhase INT Phase current imbalance.
StartsCount INT Number of starts per hour.
Reserved INT Reserved.

178 EIO0000002092 04/2020

 TeSys T Profile

TESYST_MEAEXT_DDT Type
TESYST_MEAEXT is a data structure with extended information about the device on Modbus
communications. The following table describes the TESYST_MEAEXT_DDT:

Parameter Type Description

FLCCurrentL1 INT L1 current (%FLC).
FLCCurrentL2 INT L2 current (%FLC).
FLCCurrentL3 INT L3 current (%FLC).
Temperature INT Internal controller temperature (°C).
Current REAL Average current (A).
CurrentL1 REAL L1 current (A).
CurrentL2 REAL L2 current (A).
CurrentL3 REAL L3 current (A).
GroundCurrent REAL Ground current (A).
MotorTemperature INT Motor temperature sensor (%).
TimeTrip INT Time to trip (x 1 s).
LastStartCurrent INT Motor last start current ratio (%FLC).
LastStartDuration INT Motor last start duration (s).

TESYST_MEAEV40_DDT Type
TESYST_MEAEV40 is a data structure with information about the device with an EV40 expansion
module on Modbus communications. The following table describes the TESYST_MEAEV40_DDT:

Parameter Type Description

PowerFactor REAL Power factor.
AverageVolatge INT Average voltage (V).
L3L1Voltage INT L3-L1voltage (V).
L1L2Voltage INT L1-L2 voltage (V).
L2L3Voltage INT L2-L3 voltage (V).
ActivePower REAL Active power consumption (kW).
ReactivePower REAL Active power consumption (kVAR).
VoltageImbalance INT Phase voltage imbalance (%).
Reserved INT Reserved.

EIO0000002092 04/2020 179

TeSys T Profile

TESYST_MEAEXT1_DDT Type
TESYST_MEAEXT1 is a data structure with extended information on the device with Modbus
communications.

Parameter Type Description

FltReg1 WORD Detected fault register 1.
FltReg2 WORD Detected fault register 2.
FltReg3 WORD Detected fault register 3.
WarReg1 WORD Notification register 1.
WarReg2 WORD Notification register 2.
WarReg3 WORD Notification register 3.
ActivePwrRecord REAL Active power consumption (kW).
ReactivePwrRecord REAL Reactive power consumption (kVAR).

STATISTICCONNECTOR
StatisticConnector is information data used with Ethernet communication to obtain statistics
on the Ethernet network (requests carried out, time between requests, and so on). This structure
has been created to be used with the StatisticCounter DFB in General Purpose for
communication.

Parameter Type Description

Start BOOL 1= The operation has started.
EndOk BOOL 1 = The operation has ended correctly.
EndNOk BOOL 1 = The operation has ended with a detected error.
PartialTime DINT 1 = Partial time.

State
The following table describes the State variable:

Variable value Description

-2 Device has detected error.
-1 Not initialized. Waiting for data.
0 Disabled.
5 Ready.
8 Inoperable device.
9 Device notification.

180 EIO0000002092 04/2020

 TeSys T Profile

Info
The following table describes the Info variable:

Variable value Description

1 Incorrect configuration of DFB parameter.
2 Waiting Ready.
8 Tesys working OK.
10 Waiting for device information.
11 Missing EnableDFB.
12 Missing Communication OK Communication interruption.
13 Status word value is 0.
14 Local forcing has to be 0.
23 Remove Run has to be 0.
24 Remove ResetFail. Reset again.
25 Tesys T stopped.
81 Missing ResetFail. Inoperable device.
82 A reset is needed.
99 Unknown status.

EIO0000002092 04/2020 181

TeSys T Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

TESYST_ST TESYST_ST_DDT Refer to TESYST_ST_DDT (see page 182) Type.
TESYST_CFG TESYST_CFG_DDT Refer to TESYST_CFG_DDT (see page 183) Type.

WorkMemory* ANY_ARRAY_INT Array is used for Ethernet communications.

This variable is meant for use with an Ethernet port
that serializes Ethernet requests in an optimum
manner.
*:
Parameter is available only for specific components.

TESYST_ST_DDT Type
TESYST_ST is a device data structure that holds the minimum information required for performing
control and monitoring functions. The information used by the operator screen is readable/writable
from the HMI/SCADA system.

Name Type Description

STW (see page 182) WORD Provides the device status. Access to the data held in
this bit word is read-only.
CFGW (see page 183) WORD Device control.
Provides the means to control the device from the
monitoring subsystem or from the operator screen if
Owner (1), or only from the monitoring subsystem if
Owner (0).
If Owner is 0, it takes the input variables of the DFB as a
value for reading from the HMI/SCADA system.
AverageCurrent REAL Actual current value in FLC%.

TESYST_ST.STW Word Structure

Bit Description
0 Unknown technological module status. No variable refreshing.
1 Not ready.
2 Technological module is running.
3 Inoperable device.
4 Alarm on the device or repetitive detected fault alarm requires resetting.
5 Communication interruption.

182 EIO0000002092 04/2020

 TeSys T Profile

Bit Description
6 Requires resetting. ResetFail is required.
7 Refer to the ExtControlled output pin (see page 171).
8 Refer to the Reseting output pin (see page 171).
9 Refer to the EnableDFB input pin (see page 159).

TESYST_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 159).
1 Owner.
3 Refer to the Direction input pin (see page 159).
6 Refer to the Run input pin (see page 159).
7 Refer to the ControlCommand input pin (see page 159).
11 Refer to the LowFastSpeed input pin (see page 159).
12 Refer to the ThermalTest input pin (see page 159).

NOTE: The Owner bit enables to control the block from the TESYST_ST_DDT input/output
structure ignoring the input signals of the block. It enables control from a monitoring system (HMI,
SCADA, operator screen) in the Manual mode without using the programmed switching operation.

TESYST_CFG_DDT Type
TESYST_CFG is a data structure with device information. The information used by the operator
screen is readable from the HMI/SCADA system.

Name Type Description

DataStatus WORD Information on the device status.
(see page 184)
InputsMap WORD Information on the digital input status.
(see page 185)
IOMap WORD Information on the outputs command and status.
(see page 185)
Info INT TeSys T information. Its value is Info status.
WarningCode WORD TeSys T alarm code information. Takes the values from the WarningCode
(see page 184) output pin.
FailCode0 INT Code of last level 0 detected error. Indicates which detected error has
occurred, FailCode[0].

EIO0000002092 04/2020 183

TeSys T Profile

Name Type Description

FailCode1 INT Code of last level 1 detected error. Indicates which detected error has
occurred, FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates which detected error has
occurred, FailCode[2].

TESYST_CFG.DataStatus Word Structure

Bit Description
0 Refer to the Ready status in the Status output pin (see page 171).
1 Refer to the Activated status in the Status output pin (see page 171).
2 Refer to the Fail status in the Status output pin (see page 171).
3 Refer to the Warning status in the Status output pin (see page 171).
4 Refer to the Trip status in the Status output pin (see page 171).
5 Refer to the ResetAuth in the Status output pin (see page 171).
6 Refer to the ControlledPower status in the Status output pin (see page 171).
7 Refer to the MotorRunning status in the Status output pin (see page 171).
8 Refer to the HMIControlled status in the Status output pin (see page 171).
9 Refer to the MotorStarting status in the Status output pin (see page 171).
10 Refer to the AutoResetActive status in the StatusExt output pin (see page 171).
11 Refer to the FaultRequested status in the StatusExt output pin (see page 171).
12 Refer to the RapidCicleLockout in the StatusExt output pin (see page 171).
13 Refer to the LoadSheding in the StatusExt output pin (see page 171).
14 Refer to the HMILostComms in the StatusExt output pin (see page 171).
15 Refer to the MotorTransitionLockout in the StatusExt output pin (see page 171).

TESYST_CFG.WarningCode Word Structure

Bit Description
2 Refer to the Ground in the WarningCode output pin (see page 171).
3 Refer to the Thermal in the WarningCode output pin (see page 171).
5 Refer to the Jam in the WarningCode output pin (see page 171).
6 Refer to the Phase in the WarningCode output pin (see page 171).
7 Refer to the UnderCurrent in the WarningCode output pin (see page 171).
8 Refer to the Order in the WarningCode output pin (see page 171).

184 EIO0000002092 04/2020

 TeSys T Profile

Bit Description
9 Refer to the ForcedLocalMode in the WarningCode output pin (see page 171).
10 Refer to the HMIPort in the WarningCode output pin (see page 171).
11 Refer to the InternalTmp in the WarningCode output pin (see page 171).
12 Refer to the Internal in the WarningCode output pin (see page 171).
15 Refer to the Network in the WarningCode output pin (see page 171).

TESYST_CFG.InputsMap Word Structure

Bit Description
0 Status of the digital input I1 on a controller base.
1 Status of the digital input I2 on a controller base.
2 Status of the digital input I3 on a controller base.
3 Status of the digital input I4 on a controller base.
4 Status of the digital input I5 on a controller base.
5 Status of the digital input I6 on a controller base.
6 Status of the digital input I7 on a controller base.
7 Status of the digital input I8 on a controller base.
8 Status of the digital input I9 on a controller base.
9 Status of the digital input I10 on a controller base.

TESYST_CFG.IOMap Word Structure

Bit Description
0 Status and command of the output O1 on a controller base.
1 Status and command of the output O2 on a controller base.
2 Status and command of the output O3 on a controller base.
3 Status and command of the output O4 on a controller base.

EIO0000002092 04/2020 185

TeSys T Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block waits for
the operations to be carried out by the device.
If a command has been sent and the command is not executed
within the time indicated by this variable, a follow-up alarm is issued.
The command that is controlled is Run. In the event of ResetFail,
this is not interpreted as an alarm. Instead, the detected failure
continues, and you have to reset the Reseting output.
Refresh TIME Refresh time for device data on serial Modbus communications.
NOTE: This refresh operation is carried out on read variables. Write
requests are carried out when needed and have maximum priority.
ScanTime TIME Allows you to configure the time for which the alarm signals are kept
active.
Helps the monitoring subsystem to acquire the data for the alarms
that are automatically reset.
ResetMode BOOL Enables to configure the type of reset. This type of reset is used for
communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset has to be carried out. The first reset is
carried out after the time defined in CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow * 2
elapses, and so on. If the value of CommandCtrlWindow is 0 s, its
value is not used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
value
FALSE Communications are/the device is reset with the ResetFail
variable.
TRUE Communications are/the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable is used to define the
maximum time that can elapse between 2 consecutive resets.
Refer to the Timing diagram below.

186 EIO0000002092 04/2020

 TeSys T Profile

Timing diagram:

EIO0000002092 04/2020 187

TeSys T Profile

Diagnostics Information Management

Overview
The diagnostics codes the device can return are read from the FailCode output variable.

Parameter Configuration Diagnostic Codes

This diagnostic code indicates that the function block has incorrect configuration.
 FailCode[0]: 16#0003
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
This diagnostic code can occur for any of the below conditions:
 Wrong array size at Inputs or Outputs pins of the function block.
 Variables connected to both DTMInputs and Inputs pins of the function Block.

During the above detected FailCode the function block does not process any inputs and the
function blocks output displays the last processed state.
This detected FailCode can be reset by a rising edge to the EnableDFB input pin after correcting
the configuration of the function block.

Modbus Communications Diagnostics Codes

For Modbus communications, this code is used to indicate that communications have not been
established. It can be reset.
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
After Modbus communications have been established, check Modbus client diagnostic codes for
FailCode [0] and FailCode [1]. Components make a distinction between detected read
request problems and write request problems:
 FailCode[2]: 16#0001 - Read
 FailCode[2]: 16#0002 - Write

188 EIO0000002092 04/2020

 TeSys T Profile

Diagnostics Code Example

For a detected error, the code is:
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005
The Failcode[0] variable can have the following codes:

Diagnostics codes Meaning

0 No detected error.
3 Ground current.
4 Thermal overload.
5 Extended start.
6 Mechanical jam.
7 Phase current imbalance.
8 Undercurrent.
10 Test.
11 HMI port detected error.
12 Interruption of HMI port communications.
13 Internal network port detected error
16 External detected error assigned by PCODE.
18 Diagnosis.
19 Wiring.
20 Overcurrent.
21 Phase current dropout.
22 Phase currents inverted.
23 Motor temperature sensor.
24 Phase voltage imbalance.
25 Phase voltage dropout.
26 Control over voltage.
26 Phase voltages inverted.
27 Undervoltage.
28 Overvoltage.
29 Insufficient power.
30 Excessive power.
31 Insufficient power factor.
32 Excessive power factor.
33 Load shedding.

EIO0000002092 04/2020 189

TeSys T Profile

Diagnostics codes Meaning

34 Incorrect temperature reading.
35 Open circuit in temperature sensor.
36 Inverted TC.
46 Startup test.
47 Run repeat test.
48 Stop test.
49 Stop repeat test.
51 Internal controller temperature detected error.
55 Internal controller detected error (stack overflow).
56 Internal controller detected error (RAM).
57 Internal controller detected error (RAM checksum).
58 Internal controller detected error (hardware monitoring problem).
60 L2 current detected in single-phase mode.
64 Inoperable non-volatile memory.
65 Communication interruption in expansion module.
66 Reset button jammed.
67 Logical function detected error.
100–104 Internal network port detected error.
109 Communication interruption in network port.
555 Incorrect network port configuration.

The inoperable device reset is sent to the device.

190 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Tesys U Profile
EIO0000002092 04/2020

Chapter 12
Tesys U Profile

Tesys U Profile

Overview
This chapter describes the DFBs of Tesys U profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 192
DFB Representation 193
Inputs 196
Outputs 199
Inputs/Outputs 208
Public Variables 212
Diagnostics Information Management 214

EIO0000002092 04/2020 191

Tesys U Profile

Description

General
The Tesys U profile is used to manage the TesysU family of devices on different communications
networks (Modbus network or Advantys STB I/O island).

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

Function Description
Control Forward/reverse direction of rotation.
Device status Displays the status of the device.
indication
Remote resetting Allows resetting of the device.
Control or Monitoring Enables you to control and monitor the device.
Owner Manages the control system which is the owner (Operator or
Program). Therefore, it is responsible for setting the control.

192 EIO0000002092 04/2020

 Tesys U Profile

DFB Representation

Representation
The following figure represents the functional module of TESYS U profile:

NOTE: The underlined parameters are specific for some components.

EIO0000002092 04/2020 193

Tesys U Profile

The table shows the parameters available for specific components:

Parameters Starter components

Modbus Advantys
Standard Advanced and Standard Advanced Multifunction
(MBTESYS- multifunction (TESYS- (TESYS- (TESYSUSC)
USCST) (MBTESYSUSC) USCST) UCTL)
Inputs ModbusAddress X X – – –
CommunicationOK – – X X X
StatisticSelector X X – – –
Inputs – – X X X
Outputs WarningCode X – X – –
(GENERICWARNING)
WarningCode – X – X X
(TESYSUWARNING)
Status X – X – –
(TESYSUSTATUSST)
Status – X – X X
(TESYSUSTATUS)
StatusExt – X – – X
(TESYSUSTATUSEXT)
AverageCurrent – X – X X
StatisticConnector X X – – –
Outputs – – X X X
TESYSU_MEC – X – – X
Input/ WorkMemory X X – – –
Output
X: Parameter is available.
–: Parameter is not available.

194 EIO0000002092 04/2020

 Tesys U Profile

The table shows the parameters available for specific components:

Parameters Controller components

Modbus Advantys
Advanced and multifunction Advanced and
(MBTESYSUC) multifunction
(TESYSUC)
Inputs ModbusAddress X –
CommunicationOK – X
OutputsMapExt X X
StatisticSelector X –
Inputs – X
Outputs WarningCode – –
(GENERICWARNING)
WarningCode X X
(TESYSUWARNING)
Status – –
(TESYSUSTATUSST)
Status X X
(TESYSUSTATUS)
StatusExt X –
(TESYSUSTATUSEXT)
AverageCurrent X X
IOMapExt X X
StatisticConnector X –
Outputs – X
TESYSU_IO X X
Input/Output WorkMemory X –
X: Parameter is available.
–: Parameter is not available.

EIO0000002092 04/2020 195

Tesys U Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control block.
 0 = The entire DFB is restarted (states, output values,
counters are lost) and output values are set to 0.
 1 = Enables communications with the devices for their
operation.
Public variable values are loaded during the first enabling
cycle.

If the device is reset and Run pin is active, then the device will auto start. If manual start of the
device is required, then reset the Run pin followed by device.

NOTICE
UNINTENDED EQUIPMENT OPERATION
Reset the Run variable before resuming operation.
Failure to follow these instructions can result in equipment damage.

Parameter Type Description

Run BOOL 1 = Starts the starter run in the direction selected with the
Direction input variable.
If the device is being enabled or reset, reset the inputs so
that unexpected start does not occur. In these cases, first
reset the input to resume the operation.
Direction BOOL Direction of rotation of the starter.
 0 = Activates the forward direction drive.
 1 = Activates the reverse direction drive.
ResetFail BOOL 1 = Resets the Fail output parameter to 0 or in case of
inoperable device, sends a reset command to the device if
ControlCommand is 1.

CommunicationOk* BOOL 1 = The node is present on the bus.

You can find this variable in Ethernet communications.
*
: Parameter is available for specific components.
1
: Parameter is available only for TESYSUSCST.
2
: Parameter is available only for TESYSUCTL and TESYSUSC.

196 EIO0000002092 04/2020

 Tesys U Profile

Parameter Type Description

ModbusAddress* INT Device address within the Modbus network.
You can find this variable in Modbus communications.
OutputsMapExt* TESYSUOUTPUT- Standard outputs of the controller.
SMAPEXT The following table describes TESYSUOUTPUTSMAPEXT:
Name Type Description
O13 BOOL 1 = Enables O13 digital output (if 687 LSB = 2).
O23 BOOL 1 = Enables O13 digital output (if 687 LSB = 2).
ControlCommand BOOL Indicates to the DFB whether the motor is being controlled
locally or from a source external to the DFB.
 0 = Performs only read operations to monitor the status
of the device and does not perform any control functions.
 1 = Performs read operations and performs control
operations not conflicting with control commands coming
from an external control source.
NOTE: This input does not configure the starter.
StatisticSelector* INT Variable obtains statistics for the Modbus network (requests
carried out, time between requests, so on). This data
provides information for using StatisticConnector pin
within the StatisticCounter DFB inGeneral Purpose
library for communication.
The following table displays the StatisticSelector
value:
Variable value Description
1 Read statistics, client.
2 Write statistics, client.
OutputsMap TESYSUOUTPUTSMA Holds a structure used to control the Tesys outputs.
P If one of the variables is unavailable, a comment stating that
the information cannot be accessed appears.
Name Type Description
OA1 BOOL 1 = Controls the state of the OA1 digital output.
OA3 BOOL 1 = Controls the state of the OA3 digital output.
LO1 BOOL 1 = Controls the state of the LO1 digital output.
*: Parameter is available for specific components.
1
: Parameter is available only for TESYSUSCST.
2: Parameter is available only for TESYSUCTL and TESYSUSC.

EIO0000002092 04/2020 197

Tesys U Profile

Parameter Type Description

Inputs1 ANY_ARRAY_INT Holds an array structure with data obtained from the device.
You can control the starter/controller with this input variable.
This variable is reserved for the DFB, and you cannot use
this variable directly. For the control block to work properly,
allocate the structure (%MWx). Refer to the Communications
Technologies (see page 503).
Based on the device and the relevant communications, one
of the structures is used.
The information available for starters with a standard control
unit on an Advantys STB is shown in the following table:
Parameter Type Description
Inputs [0] INT Status register.
Inputs [1] INT I/O module status register.
Inputs 2 ANY_ARRAY_INT Holds an array structure with data obtained from the device.
You can control the starter/controller with this input variable.
This input is reserved for the DFB, and you cannot use this
input directly. For the control block to work properly, allocate
the structure (%MWx). Refer to the Communications
Technologies (see page 503).
Based on the device and the relevant communications, the
following structure is used.
The information available for starters with an advanced
control unit on an Advantys STB is shown in the following
table:
Parameter Type Description
Inputs [0] INT Status register.
Inputs [1] INT I/O module status register.
Inputs [2] INT Notification register.
Inputs [3] INT I/O status.
*:
Parameter is available for specific components.
1: Parameter is available only for TESYSUSCST.
2: Parameter is available only for TESYSUCTL and TESYSUSC.

198 EIO0000002092 04/2020

 Tesys U Profile

Outputs

Output Parameter Description

Output Type Description

Ready BOOL 1 = The device is enabled and free of detected errors. The
device is ready to carry out or carrying out any Run or Stop
command.
Fail BOOL 1 = A detected failure in the control block or in the device
or communication interruption.To reset the Fail output
pin, the ResetFail input has to be activated. The last
diagnostic code is shown on FailCode.
NOTE: If a communication interruption occurs, the
variables being read from the device cease to be refreshed
as a refresh operation can no longer be carried out. The
variables retain their last value.
Warning BOOL 1 = An alarm has been activated for the device. It does not
affect the blocks operation and does not need to be reset.
The signal remains active until the cause for the alarm
disappears.
FailCode ARRAY [0..2] OF INT When Fail output is 1, it holds the code for the detected
error.
If Fail output is 0, it indicates the last detected error that
occurred.
The detected error source is specified by a 3-level
structure. Refer to the Diagnostics Information
Management (see page 214) for more details.
WarningCode* GENERICWARNING Holds a data structure with information about the alarm
currently present on the starter with a standard control
block.
Name Type Description
Order BOOL 1 = A follow-up alarm. The device is not
responding to the control command (Run, so
on) within the time specified in
CommandCtrlWindow.
Device BOOL 1 = An alarm on the device.
*: Parameter is available for specific components.

EIO0000002092 04/2020 199

Tesys U Profile

Output Type Description

WarningCode* TESYSUWARNING Holds a data structure with information about the alarm
currently on the starter.
Name Type Description
Ground BOOL 1 = A ground alarm.
Thermal BOOL 1 = A thermal alarm on the device.
LongStart BOOL 1 = The start has been delayed.
Jam BOOL 1 = A mechanical jam alarm.
Phase BOOL 1 = A phase alarm.
UnderCurrent BOOL 1 = An undercurrent alarm.
Communication BOOL 1 = Communication interruption alarm.
InternalTmp BOOL 1 = An internal temperature alarm.
Internal BOOL 1 = An alarm for internal detected error.
Module BOOL 1 = An alarm is present on device.
Order BOOL 1 = A follow-up alarm.
The device is not responding to the control
command within the time specified in
CommandCtrlWindow.
ForcedLocalMode BOOL 1 = The device is forced locally; indicated by
the device having the ForcedLocalMode
status.
Is controlled through the screw terminal.
Running BOOL 1 = The Tesys is running.
The current is higher than 10% of FLA for advanced and
multifunction starters and controllers.
ExtControlled BOOL 1 = The device is being controlled from an external source
(for example, from the console, from a push-button panel,
or from the monitoring system) to the system.
Provides information for programming.
NOTE: The ControlCommand signal, the Owner
variable, and the ForcedLocalMode status are used to
activate this signal. You cannot use this signal as a
ControlCommand input.
*
: Parameter is available for specific components.

200 EIO0000002092 04/2020

 Tesys U Profile

Output Type Description

Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the
maximum time for resetting the detected failure.
When a device or communication reset is carried out with
ResetFail, the DFB tries to reset the detected failure
within the time period defined in CommandCtrlWindow.
If the detected failure is reset, the Fail and Reseting
output variables are reset (when set to FALSE). If the
detected failure is not reset, the Reseting variable is
FALSE and the Fail variable remains TRUE. The
ResetFail is edge-based.
Timing diagram:

Status* TESYSUSTATUSST Holds data containing the information that the module
extracts from the status variable of starters or controllers
with advanced or multifunction control blocks.
The following table describes the status information:
Parameter Type Description
Ready BOOL 1 = Switch in ON position. Device is
operational.
PoleClosed BOOL 1 = Contacts are closed on power base.
Fault BOOL 1 = An inoperable device.
Warning BOOL 1 = An alarm is present on device.
Trip BOOL 1 = The Tesys protection has tripped.
State INT Numerical code corresponding to the state of
the starter.
Info INT Numerical code with the information on
statuses and required actions.
*: Parameter is available for specific components.

EIO0000002092 04/2020 201

Tesys U Profile

Output Type Description

Status* TESYSUSTATUS Holds data structure containing the information that the
module extracts from the status variable of controllers with
advanced and multifunction control modules.
The following table describes the status information:
Parameter Type Description
Ready BOOL 1 = Switch in ON position. Device is
operational.
PoleClosed BOOL 1 = The contacts are closed on power base.
Fault BOOL 1 = An inoperable device.
Warning BOOL 1 = An alarm is present on device.
Trip BOOL 1 = The Tesys protection has tripped.
ResetAuth BOOL 1 = Reset authorized detected error.
PoweredUp BOOL 1 = The A1/A2 contacts are powered with
power base or powered I.1 or I.2 inputs.
Running BOOL 1 = The device is active with a current higher
than 10% of full-load amperage or pole closed.
ForcedLocalMode BOOL 1 = Forced local mode on control unit.
Start BOOL  1 = Rising current is higher than 10% of
FLA.
 0 = Falling current is lower than 10% of
FLA.
State (see page 205) INT Numerical code corresponding to the device
status.
Info (see page 205) INT Numerical code with the information on
statuses and required actions.
StatusExt* TESYSUSTATUSEXT Holds a data structure with information on the mechanical
status of advanced or multifunction starters on a Modbus
network.
The following table describes the StatusExt:
Parameter Type Description
ButtonOn BOOL Indicates the button position:
 0 = Off
 1 = On
ButtonTrip BOOL Indicates the button position:
 0 = Not tripped
 1 = Tripped
VoltagePresent BOOL 1 = 24 V dc power supply voltage is present on
the outputs.
*: Parameter is available for specific components.

202 EIO0000002092 04/2020

 Tesys U Profile

Output Type Description

IOMap TESYSUIOMAP Holds a data structure that contains information on the
state of the starter inputs and outputs.
The following table describes the IOMap:
Parameter Type Description
OA1 BOOL 1 = The state of the digital output OA1.
OA3 BOOL 1 = The state of the digital output OA3.
LO1 BOOL 1 = The state of the digital output LO1.
LI1 BOOL 1 = The state of the digital input LI1.
LI2 BOOL 1 = The state of the digital input LI2.

IOMapExt* TESYSUIOMAPEXT Standard inputs/outputs information of the controllers.

The following table describes the IOMapExt:
Parameter Type Description
I1 BOOL 1 =Output 13 locally controlled.
I2 BOOL 1 = Output 23 locally controlled.
I3 BOOL 1 = Contactor status healthy for output 13.
I4 BOOL 1 = Contactor status healthy for output 23.
I5 BOOL 1 = Input status (reset).
I6 BOOL 1 = Input status (external detected fault)..
I7 BOOL 1 = Input status (system ready).
I8 BOOL 1 = Input status (free).
I9 BOOL 1 = Input status (free).
I10 BOOL 1 = Device is in local/remote mixed mode if
683=2.
O13 BOOL 1 = Output 13 is closed.
O23 BOOL 1 = Output 23 is closed.
O95 BOOL 1 = Output 95, output 96 is closed and output
97 and output 98 is opened.
O5 BOOL 1 = Output 5 and output 6 is closed.

AverageCurrent * INT Average value of device current in FLA%.

*: Parameter is available for specific components.

EIO0000002092 04/2020 203

Tesys U Profile

Output Type Description

StatisticConnector* STATISTICCONNECTOR Information data is used with Modbus communications to
obtain statistics on the Modbus network.
This data provides information for using the
StatisticConnector pin within the
StatisticCounter DFB in the General Purpose library
for communication.
Parameter Type Description
Start BOOL 1 = The operation has started.
EndOk BOOL 1 = The operation has ended correctly.
EndNOk BOOL 1 = The operation has ended with a detected
error.
PartialTime DINT Partial time.
Outputs* ANY_ARRAY_INT Holds an array structure with data sent to the device. You
can control the starter/controller with this output variable.
This variable is reserved for the DFB, and you cannot use
this variable directly. For the control block to work properly,
allocate the structure (%MWx). Refer to the
Communications Technologies (see page 503).
Based on the device and the relevant communications, the
following structure is used.
The information available for starters with a standard
control unit on Advantys STB is shown in the following
table:
Parameter Type Description
Outputs [0] INT System control.
Outputs [1] INT Module control.
Outputs [2] INT Output control.

TESYSU_MEC * TESYSU_MEC_DDT Information on the mechanical status of advanced or

multifunction starters. Information for SCADA/HMI system.
Parameter Type Description
MecStatus WORD Provides information on the mechanical status
of the device. Access to the data held in this bit
word is read-only.
Refer to the TESYSU_MEC table below.
Reserved INT Reserved.
*
: Parameter is available for specific components.

204 EIO0000002092 04/2020

 Tesys U Profile

Output Type Description

TESYSU_IO TESYSU_IO_DDT Standard inputs/outputs information of the controllers for
the controller base (used by HMI/SCADA). The following
table describes the TESYSU_IO:
Parameter Type Description
IOMap WORD Input/output status on the controller base.
Refer to the IOMap table below.
Reserved INT Reserved.
*
: Parameter is available for specific components.

State
The following table describes the State variable:

Variable value Description

-2 Device detected error.
-1 Not initialized. Waiting for data.
0 Disabled.
5 Ready.
8 Inoperable device.
9 Device notification.

Info
The following table describes the Info variable:

Variable value Description

1 Incorrect configuration of DFB parameter.
2 Waiting Ready.
8 Tesys working OK.
10 Waiting for device information.
11 Missing EnableDFB.
12 Missing CommunicationOK.
Communication interruption.
13 Device not ready or status word value is 0.
23 Remove Run has to be 0.
24 Remove ResetFail. Reset again.
81 Missing ResetFail. Inoperable device.

EIO0000002092 04/2020 205

Tesys U Profile

Variable value Description

82 A reset is required.
99 Unknown status.

TESYSU_MEC_DDT Word
The following table describes the TESYSU_MEC_DDT word structure:

Variable value Description

0 ButtonOn
1 ButtonTrip
2 ContactorVoltagePresent

MecStatus Word
The following table describes the MecStatus word structure:

Variable value Description

0 Switch: ON.
1 Switch: Trip.
2 Auxiliary voltage on current communicator.

IOMap
The following table describes the IOMap variable:

Variable value Description

0 Status of the input I1 on a controller base.
1 Status of the input I2 on a controller base.
2 Status of the input I3 on a controller base.
3 Status of the input I4 on a controller base.
4 Status of the input I5 on a controller base.
5 Status of the input I6 on a controller base.
6 Status of the input I7 on a controller base.
7 Status of the input I8 on a controller base.
8 Status of the input I9 on a controller base.
9 Status of the input I10 on a controller base.
10 Status of the output O13 on a controller base.

206 EIO0000002092 04/2020

 Tesys U Profile

Variable value Description

11 Status of the output O95 on a controller base.
12 Status of the output O13 on a controller base.
13 Status of the output O5 on a controller base.

EIO0000002092 04/2020 207

Tesys U Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

TESYSU_ST TESYSU_ST_DDT Device data structure holds the minimum
(see page 208) information required for performing control and
monitoring functions. The information used by the
operator screen is readable/writable from the
HMI/SCADA system.
TESYSU_CFG TESYSU_CFG_DDT Data structure with device information. The
(see page 208) information used by the operator screen is
readable from the HMI/SCADA system.
WorkMemory* ANY_ARRAY_INT Array is used for Modbus communications.
This variable is used with a Modbus port that
serializes Modbus requests in an optimum
manner.
*:
Parameter is available for specific components.

TESYSU_ST_DDT Type

Name Type Description

STW (see page 209) WORD Provides the device status. Access to the data held in this
bit word is read-only.
CFGW (see page 209) WORD Device control.
Enables to control the device from the monitoring
subsystem or from the operator screen if Owner (1), or
only from the monitoring subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a
value for reading from the HMI/SCADA system.
AverageCurrent REAL Actual current value in FLA%.

TESYSU_CFG_DDT Type

Name Type Description

DataStatus WORD Provides the device status. Information on the Status output
(see page 210) structure.
Info INT Tesys information. Its value is Info status in the Status
output pin.
WarningCode WORD Tesys U alarm code information. It takes the value from the
(see page 210) WarningCode output pin.

208 EIO0000002092 04/2020

 Tesys U Profile

Name Type Description

FailCode0 INT Code of last level 0 detected error. Indicates which detected
error has occurred.
FailCode1 INT Code of last level 1 detected error. Indicates which detected
error has occurred.
FailCode2 INT Code of last level 2 detected error. Indicates which detected
error has occurred.

TESYSU_ST.STW Word Structure

Bit Description
0 Unknown device status or communication interruption. No variable
refreshing.
1 Not ready.
2 Technological module is running.
3 Inoperable device.
4 Alarm on the device or repetitive detected fault alarm requires
resetting.
5 Communication interruption.
6 Requires resetting. ResetFail is required.
7 Refer to the ExtControlled output pin (see page 199).
8 Refer to the Reseting output pin (see page 199).
9 Refer to the EnableDFB input pin (see page 196).

TESYSU_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 196).
1 Owner.
3 Refer to the Direction input pin (see page 196).
6 Refer to the Run input pin (see page 196).
7 Refer to the ControlCommand input pin (see page 196).

NOTE: The Owner bit enables to control the block from the TESYSU_ST_DDT input/output
structure ignoring the input signals of the block. It enables control from a monitoring system (HMI,
SCADA, operator screen) in the Manual mode without using the programmed switching operation.

EIO0000002092 04/2020 209

Tesys U Profile

TESYSU_CFG.DataStatus Word Structure

Bit Description
0 Refer to the Ready status in the Status output pin (see page 199).
1 Refer to the PoleClosed status in the Status output pin
(see page 199)
2 Refer to the Fault status in the Status output pin (see page 199).
3 Refer to the Warning status in the Status output pin
(see page 199).
4 Refer to the Trip status in the Status output pin (see page 199).
10 Refer to the OA1 in the IOMap output pin (see page 199).
11 Refer to the OA3 in the IOMap output pin (see page 199).
12 Refer to the LO1 in the IOMap output pin (see page 199).
13 Refer to the LI1 in the IOMap output pin (see page 199).
14 Refer to the LI2 in the IOMap output pin (see page 199).

TESYSU_CFG.WarningCode Word Structure

Bit Description
2 Refer to the Ground in the WarningCode output pin
(see page 199).
3 Refer to the Thermal in the WarningCode output pin
(see page 199).
4 Refer to the LongStart in the WarningCode output pin
(see page 199).
5 Refer to the Jam in the WarningCode output pin (see page 199).
6 Refer to the Phase in the WarningCode output pin (see page 199).
7 Refer to the UnderCurrent in the WarningCode output pin
(see page 199).
8 Refer to the Order in the WarningCode output pin (see page 199).
9 Refer to the ForcedLocalMode in the WarningCode output pin
(see page 199).
10 Refer to the Communication in the WarningCode output pin
(see page 199).
11 Refer to the InternalTmp in the WarningCode output pin
(see page 199).

210 EIO0000002092 04/2020

 Tesys U Profile

Bit Description
12 Refer to the Internal in the WarningCode output pin
(see page 199).
15 Refer to the Module in the WarningCode output pin
(see page 199).

NOTE: All control blocks cannot show alarm codes. Check the device manual and the
WarningCode output variable.

EIO0000002092 04/2020 211

Tesys U Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block waits for the
operations to be carried out by the device.
If a command has been sent and the command is not executed within
the time indicated by this variable, a follow-up alarm is issued.
The command that is controlled is Run. In case of ResetFail, this is
not interpreted as an alarm. Instead, the detected failure continues,
and you have to reset the Reseting output.

Refresh* TIME Refresh time for device data on serial Modbus communications.
NOTE: This refresh operation is carried out on read variables. Write
requests are carried out when needed and have maximum priority.
ScanTime TIME Allows the time that the alarm signals are kept active to be configured.
Helps the monitoring subsystem to acquire the data for the alarms that
are automatically reset.
ResetMode BOOL Enables to configure the type of reset. This type of reset is used for
communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset needs to be carried out. The first reset is
carried out after the time defined in CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow * 2
elapses, so on. If the value of CommandCtrlWindow is 0 s, its value
is not used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
value
FALSE Communications are/the device is reset with the ResetFail variable.
TRUE Communications are/the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable is used to define the
maximum time that can elapse between 2 consecutive resets.
Refer to the Timing diagram below.
*: Parameter is available for specific components.

212 EIO0000002092 04/2020

 Tesys U Profile

Timing diagram:

EIO0000002092 04/2020 213

Tesys U Profile

Diagnostics Information Management

Overview
The detected error codes the device can return are read from the FailCode output variable.

Parameter Configuration Diagnostics Codes

This detected error indicates that a public variable parameter contains a value that is not allowed.
To reload new values, a rising edge is required on the EnableDFB input:
 FailCode[0]: 16#0003
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
This diagnostic code can occur for any of the below conditions:
 Wrong array size at Inputs or Outputs pins of the function block.
 Variables connected to both DTMInputs and Inputs pins of the function Block.

During the above detected FailCode the function block does not process any inputs and the
function blocks output displays the last processed state.
This detected FailCode can be reset by a rising edge to the EnableDFB input pin after correcting
the configuration of the function block.

Modbus Communications Diagnostics Codes

For Modbus communications, this code is used to indicate that communications have not been
established. It can be reset.
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
After Modbus communications have been established, check Modbus client diagnostic codes for
FailCode [0] and FailCode [1]. Components make a distinction between detected read and
write request problem:
 FailCode[2]: 16#0001 Read
 FailCode[2]: 16#0002 Write

214 EIO0000002092 04/2020

 Tesys U Profile

Diagnostics Code Example

For a detected error, the code is:
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005
The Failcode[0] variable can have the following codes:

Diagnostic code Meaning

0 No detected failure.
1 Trip due to short-circuit (Trip).
2 Magnetic trip (Trip)
3 Ground detected error trip (Trip).
4 Thermal overload.
5 Starting time too long.
6 Mechanical jam.
7 Phase imbalance.
8 Detected failure due to load condition.
9 Detected failure due to switching operation (Shunt trip).
10 Test trip (TRIP. Overheating simulation).
11 Interruption of communications on LUCM. Detected error in
Modbus port (dropped out).
12 Interruption of communications on LUCM. Detected error in
Modbus port (tripped).
13 Reserved.
14 Module identification detected error.
15 Module not installed or missing 24 V supply.
51 Internal detected error in LUCM; temperature or broken sensor.
52 - 58 Internal detected error.
59 Current flow with unpowered winding.
60 L2 current detected in single-phase mode.
61 Trip base not detected.
62 Control cabling.
63 Control over voltage.

EIO0000002092 04/2020 215

Tesys U Profile

Diagnostic code Meaning

100 Detected internal problem in communications module.
101 Communication interruption with LUCM multifunction control unit.
102 Detected internal problem in communications module.
104 Detected internal problem in communications module.
105 Communication interruption with LUCM control base.
300 Communication interruption.

The inoperable device can be reset as long as ControlCommand is TRUE. Otherwise, it can be
reset only on the controllers through the screw terminal with the appropriate parameter
configuration.
NOTE: The diagnostics codes of device are available for Tesys, except for those that communicate
through the Advantys STB.

216 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Power Monitoring Devices
EIO0000002092 04/2020

Part VI
Power Monitoring Devices

Power Monitoring Devices

Overview
This part provides the detailed description, pin layout, pin description, operator screen of the device
control blocks of the Power Monitoring Devices family.
These function blocks do not reflect any specific installation.

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

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

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
13 PM Profile - Power Monitoring Profile 219
14 Smart UPS Profile 243
15 ACCUSINE PCS Profile 259

EIO0000002092 04/2020 217

Power Monitoring Devices

218 EIO0000002092 04/2020

 Modicon Libraries General Purpose
PM Profile
EIO0000002092 04/2020

Chapter 13
PM Profile - Power Monitoring Profile

PM Profile - Power Monitoring Profile

Overview
This chapter describes the DFBs of Power Monitoring profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 220
DFB Representation 221
Inputs 224
Outputs 225
Inputs/Outputs 235
Public Variables 239
Diagnostic Information Management 241

EIO0000002092 04/2020 219

PM Profile

Description

General
The PM profile is used to manage the Power logic series power meters on different communication
networks (Modbus or Ethernet).
The power meter is a multifunction, digital instrumentation and data acquisition device. It can
replace various meters, relays, transducers, and other components. You can install the power
meter at multiple locations within a facility.

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

Function Description
Remote resetting Allows resetting of the device.
Monitoring Allows the device parameters to be monitored.

I/O Scanning Information

The below table explains the configuration for I/O scanning messaging.

Function Modbus ID Read Address Read Length Write Write Length

Block Address
EPM800 255 1 11 0 0
255 700 2 0 0
255 600 4 1001 1
EACCUSINE 255 1099 114 0 0
255 1715 12 0 0
255 3208 47 0 0

220 EIO0000002092 04/2020

 PM Profile

DFB Representation

Representation
The following figure represents the functional module of PM profile:

NOTE: The underlined parameters are specific for some components.

For DFBs communicating by I/O scanning, variables read from the device retain their last value
when a communication interruption occurs. For details, refer to the description of the
corresponding output parameter (see page 126).

WARNING
UNINTENDED EQUIPMENT OPERATION
When you configure the Last value parameter of the I/O scanner line, take into consideration
the behavior of the DFB when a communication interruption occurs.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000002092 04/2020 221

PM Profile

The table shows the parameters available for specific components:

Parameters Components
Modbus Ethernet
MB- MB- MBPM MB- MBPM EPM800 EMPM800 EMPM EMPM
PM700 PM800 1200 PM9C 5350 (Depre- (Depre- 53xx 82xx
(Depre- (Dep- (Depre- cated) cated)
cated) recat- cated)
ed)
Inputs ModbusAd- X X X X X – – – –
dress
DEVICEAD- – – – – – – X X X
DRESS
IOSCAN- – – – – – X – – –
NERSTATUS
INPUTDA- – – – – – X – – –
TA1
INPUTDA- – – – – – X – – –
TA2
INPUTDA- – – – – – X – – –
TA3
Outputs Communi- – – – – – X – – –
cationOK
Statis- X X X X X – X X X
ticCon-
nector
Warning X X – – X X X X –
Warning- X X – – X X X X –
Code
PM_MEA X X – – X X X – –
PM9C_MEA – – – X – – – – –
PM1200_ – – X X – – – – –
sMEA
PM53xx- – – – – – – – X –
_MEA
PM82xx- – – – – – – – – X
_MEA
X: Parameter is available.
–: Parameter is not available.

222 EIO0000002092 04/2020

 PM Profile

Parameters Components
Modbus Ethernet
MB- MB- MBPM MB- MBPM EPM800 EMPM800 EMPM EMPM
PM700 PM800 1200 PM9C 5350 (Depre- (Depre- 53xx 82xx
(Depre- (Dep- (Depre- cated) cated)
cated) recat- cated)
ed)
Inputs/ WorkMemo- X X X X X – X X X
Outputs ry
PM_ST_DDT X X X X X X X X X
PM_CFG – – – – – – – X –
(PM_CF-
G_DDT)
PM_CFG – – – – – – – – X
(PM82xx-
_CFG_DDT)
PM_CFG – – X – – – – – –
(PM1200_C
FG_DDT)
PM_CFG – – – X – – – – –
(PM9C_CF-
G_DDT)
X: Parameter is available.
–: Parameter is not available.

EIO0000002092 04/2020 223

PM Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control block.
 0 = The entire DFB is restarted (statuses, output values,
counters are lost) and output values are set to 0.
 1 = Enables communications with the devices for their
operation.
Public variable values are loaded during the first enabling cycle.
ResetFail EBOOL 1 = Resets the Fail output parameter to 0 or in case of
inoperable device, sends a reset command to the device if
ControlCommand is 1.

ModbusAddress1 INT Device address within the Modbus network.

DeviceAddress2 STRING[26] PM Ethernet address.

Platform IP Addressing DeviceAddress (variable)
M340 ‘{IP}ID’
Quantum ‘{IP}ID’
M580 ‘{IP}ID’
NOTE: ID is 255.
IOScannerStatus3 BOOL 1 = The node is present on the bus.
You can find this variable in Ethernet communications.
InputData13 ANY_ARRAY_INT These arrays contain the read information obtained from the
PM 800 unit through the IOScan. For the block to work properly,
InputData23 ANY_ARRAY_INT
allocate the structure (%MWx)
InputData33 ANY_ARRAY_INT

1
Parameter available only for MBPM800, MBPM5350,MBPM9C, MBPM1200,MBPM710.
2
Parameter available only for EMPM800, EMPM53xx (PM5320,PM5340) and EMPM82xx (PM8240,PM8244)
3
Parameter available only for EPM800

224 EIO0000002092 04/2020

 PM Profile

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL 1 = The device is active and free of detected
errors. The device is ready to carry out or is
carrying out any read operation.
Fail BOOL 1 = A detected failure in the control block or in
the device or communication interruption.To
reset the Fail output pin, the ResetFail
input has to be activated. The last detected
error code is shown on FailCode.
NOTE: If a communication interruption occurs,
the variables being read from the device cease
to be refreshed as a refresh operation can no
longer be carried out. The variables keep their
last value.
Warning* BOOL 1 = An alarm has been activated for the device.
It does not affect the block operation, and does
not need to be reset.
This signal remains active until the cause of the
alarm disappears.
FailCode ARRAY [0..2] OF INT When the Fail output is 1, it holds the code for
the detected error.
If the Fail bit is 0, it indicates the last detected
error that occurred. The detected error source
is specified by using a 3-level structure. Refer
to the Diagnostic Information Management
(see page 241) for more details.
* These parameters are available only with specific components.

EIO0000002092 04/2020 225

PM Profile

Parameter Type Description

WarningCode* WORD Variable holds the alarm code.
The following table describes the
WarningCode for PM700 block:
Bit Description for PM700 (W1112)
0 Phase 1 voltage out of range.
1 Phase 2 voltage out of range.
2 Phase 3 voltage out of range.
3 Phase 1 current out of range.
4 Phase 2 current out of range.
5 Phase 3 current out of range.
6 Frequency out of range, or phase 1 voltage
insufficient to determine frequency.
Bit Description for MBPM800, EPM800,
EMPM800, and MBPM5350 (W3254),
EMPM53xx.
0 Summary bit (activated if any other bit is
activated).
1 Incorrect configuration.
2 Incorrect scaling.
3 Phase dropout.
4 Incorrect cabling.
5 Incremental energy could be incorrect due to
the reset operation of the meter.
6 External demand synchronous waiting time.
ExtControlled BOOL 1 = Function block is controlled from the
Supervision system (Operator mode).
*
These parameters are available only with specific components.

226 EIO0000002092 04/2020

 PM Profile

Parameter Type Description

Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates
the maximum time for resetting the detected
failure.
When a device or communication reset is
carried out with ResetFail, the DFB tries to
reset the detected failure within the time period
defined in CommandCtrlWindow.
If the detected failure is reset, the Fail and
Reseting output variables are reset (when set
to FALSE). If the detected failure is not reset,
the Reseting variable is FALSE and the Fail
variable remains TRUE. The ResetFail is
edge-based.
Refer to the Timing diagram below.
CommunicationOK* BOOL 1 = The communication is OK.

ApparentEnergy DINT Apparent power consumption (kVAh).

TotalApparentPower REAL Total apparent power (kVA).
TotalPowerFactor REAL Total power factor.
AverageCurrent REAL Average current between the three phases (A).
StatisticConnector * STATISTICCONNECTOR The information data is used with Ethernet
communication to obtain statistics on the
Modbus network (requests carried out, time
between requests, so on). This structure has
been created for its use together with the
StatisticCounter DFB in General Purpose
updated for communication.
The following table describes the
StatisticConnector:
Parameter Type Description
Start BOOL 1 = The operation has started.
EndOk BOOL 1 = The operation has ended
correctly.
EndNOk BOOL 1 = The operation has ended with a
detected error.
PartialTime DINT Partial time.
* These parameters are available only with specific components.

EIO0000002092 04/2020 227

PM Profile

Parameter Type Description

PM_MEA* PM_MEA_DDT Data structure with the device measurement
information.
The following table describes the
PM_MEA_DDT:
Parameter Type Description
ActiveEnergy REAL Active energy consumption (kW).
ReactiveEnergy REAL Reactive energy consumption
(kVAR).
TotalActivePower REAL Total real power (kW).
TotalReactivePower REAL Total reactive power (kVAR).
AverageLineToLineVoltage REAL Voltage, L-L, average between the 3
phases (V).
AverageLineToNeutralVoltage REAL Voltage, L-N, average between the 3
phases (V).
Frequency REAL Frequency (derived from phase 1)
(Hz).
ActualCurrentL1 REAL Instantaneous current phase 1 (A).
ActualCurrentL2 REAL Instantaneous current phase 2 (A).
ActualCurrentL3 REAL Instantaneous current phase 3 (A).
VoltageL1ToL2 REAL Voltage, phases 1-2 (V).
VoltageL2ToL3 REAL Voltage, phases 2-3 (V).
VoltageL1ToL3 REAL Voltage, phases 1-3 (V).
VoltageL1ToNeutral REAL Voltage, phase 1-N (V).
VoltageL2ToNeutral REAL Voltage, phase 2-N (V).
VoltageL3ToNeutral REAL Voltage, phase 3-N (V).
ActivePowerL1 REAL Real power, phase 1 (kW).
ActivePowerL2 REAL Real power, phase 2 (kW).
ActivePowerL3 REAL Real power, phase 3 (kW).
ApparentPowerL1 REAL Apparent power, phase 1 (kVA).
ApparentPowerL2 REAL Apparent power, phase 2 (kVA).
ApparentPowerL3 REAL Apparent power, phase 3 (kVA).
ReactivePowerL1 REAL Reactive power, phase 1 (kVAR).
ReactivePowerL2 REAL Reactive power, phase 2 (kVAR).
ReactivePowerL3 REAL Reactive power, phase 3 (kVAR).
THDCurrentL1 REAL THD, current, phase 1 (%).
*
These parameters are available only with specific components.

228 EIO0000002092 04/2020

 PM Profile

Parameter Type Description

THDCurrentL2 REAL THD, current, phase 2 (%).
THDCurrentL3 REAL THD, current, phase 3 (%).
THDVoltageL1ToNeutral REAL THD, voltage, phase 1-N (%).
THDVoltageL2ToNeutral REAL THD, voltage, phase 2-N (%).
THDVoltageL3ToNeutral REAL THD, voltage, phase 3-N (%).
THDVoltageL1ToL2 REAL THD, voltage, phases 1-2 (%).
THDVoltageL2ToL3 REAL THD, voltage, phases 2-3 (%).
THDVoltageL1ToL3 REAL THD, voltage, phases 1-3 (%).
PM9C_MEA* PM9C_MEA_DDT Data structure with the device measurement
information.
The following table describes the
PM1200_MEA_DDT:
Parameter Type Description
ActiveEnergy REAL Active energy consumption (kWh).
ReactiveEnergy REAL Reactive energy consumption
(kVARh).
TotalActivePower REAL Total real power (kW).
TotalReactivePower REAL Total reactive power (kVAR).
AverageLineToLineVoltage REAL Voltage, L-L, average between the 3
phases (V).
AverageLineToNeutralVoltage REAL Voltage, L-N, average between the 3
phases (V).
Frequency REAL Frequency (derived from phase 1)
(Hz).
ActualCurrentL1 REAL Instantaneous current phase 1(A).
ActualCurrentL2 REAL Instantaneous current phase 2 (A).
ActualCurrentL3 REAL Instantaneous current phase 3 (A).
VoltageL1ToL2 REAL Voltage, phases 1-2 (V).
VoltageL2ToL3 REAL Voltage, phases 2-3 (V).
VoltageL1ToL3 REAL Voltage, phases 1-3 (V).
VoltageL1ToNeutral REAL Voltage, phase 1-N (V).
*
These parameters are available only with specific components.

EIO0000002092 04/2020 229

PM Profile

Parameter Type Description

VoltageL2ToNeutral REAL Voltage, phase 2-N (V).
VoltageL3ToNeutral REAL Voltage, phase 3-N (V).
ActivePowerL1 REAL Real power, phase 1 (kW).
ActivePowerL2 REAL Real power, phase 2 (kW).
ActivePowerL3 REAL Real power, phase 3 (kW).
ReactivePowerL1 REAL Reactive power, phase 1 (kVAR).
ReactivePowerL2 REAL Reactive power, phase 2 (kVAR).
ReactivePowerL3 REAL Reactive power, phase 3 (kVAR).
PM1200_MEA* PM1200_MEA_DDT Data structure with the device measurement
information.
The following table describes the
PM1200_MEA_DDT:
Parameter Type Description
ActiveEnergy REAL Active energy consumption (kWh).
ReactiveInductiveEnergy REAL Inductive reactive energy (kVARh)
ReactiveCapacitiveEnergy REAL Capacitive reactive energy (kVARh)
TotalActivePower REAL Total real power (kW).
TotalReactivePower REAL Total reactive power (kVAR).
AverageLineToLineVoltage REAL Voltage, L-L, average between the
3 phases (V).
AverageLineToNeutralVoltage REAL Voltage, L-N, average between the
3 phases (V).
Frequency REAL Frequency
(derived from phase 1) (Hz).
ActualCurrentL1 REAL Instantaneous current phase 1 (A).
ActualCurrentL2 REAL Instantaneous current phase 2 (A).
ActualCurrentL3 REAL Instantaneous current phase 3 (A).
VoltageL1ToL2 REAL Voltage, phases 1-2 (V).
VoltageL2ToL3 REAL Voltage, phases 2-3 (V).
VoltageL1ToL3 REAL Voltage, phases 1-3 (V).
VoltageL1ToNeutral REAL Voltage, phase 1-N (V).
PM1200_MEA VoltageL2ToNeutral REAL Voltage, phase 2-N. (V)
*
These parameters are available only with specific components.

230 EIO0000002092 04/2020

 PM Profile

Parameter Type Description

VoltageL3ToNeutral REAL Voltage, phase 3-N (V).
ActivePowerL1 REAL Real power, phase 1 (kW).
ActivePowerL2 REAL Real power, phase 2 (kW).
ActivePowerL3 REAL Real power, phase 3 (kW).
AparentPowerL1 REAL Apparent power, phase 1 (kVA).
AparentPowerL2 REAL Apparent power, phase 2 (kVA).
AparentPowerL3 REAL Apparent power, phase 3 (kVA).
ReactivePowerL1 REAL Reactive power, phase 1 (kVAR).
ReactivePowerL2 REAL Reactive power, phase 2 (kVAR).
ReactivePowerL3 REAL Reactive power, phase 3 (kVAR).
THDCurrentL1 REAL THD, current, phase 1 (%).
THDCurrentL2 REAL THD, current, phase 2 (%).
THDCurrentL3 REAL THD, current, phase 3 (%).
THDVoltageL1ToNeutral REAL THD, voltage, phase 1-N (%).
THDVoltageL2ToNeutral REAL THD, voltage, phase 2-N (%).
THDVoltageL3ToNeutral REAL THD, voltage, phase 3-N (%).

PM53xx_MEA* PM53xx_MEA_DDT Data structure with the device measurement

information.
The following table describes the
PM53xx_MEA_DDT:
Parameter Type Description
ActiveEnergy REAL Active energy consumption (kWh).
Reactive Energy REAL Reactive energy consumption
(kVARh).
TotalActivePower REAL Total active power detected (kW).
TotalReactivePower REAL Total reactive power detected
(kVAR).
AverageLineToLineVoltage REAL Average voltage between lines (V).
AverageLineToNeutralVoltage REAL Average voltage between line and
ground (V).
*
These parameters are available only with specific components.

EIO0000002092 04/2020 231

PM Profile

Parameter Type Description

Frequency REAL Detected frequency from line 1 (Hz).
ActualCurrentL1 REAL Instant current from line 1(A).
ActualCurrentL2 REAL Instant current from line 2(A).
ActualCurrentL3 REAL Instant current from line 3(A).
VoltageL1ToL2 REAL Voltage between line 1 and 2(V).
VoltageL2ToL3 REAL Voltage between line 2 and 3(V).
VoltageL1ToL3 REAL Voltage between line 1 and 3(V).
VoltageL1ToNeutral REAL Voltage between line 1 and ground
(V).
VoltageL2ToNeutral REAL Voltage between line 2 and ground
(V).
VoltageL3ToNeutral REAL Voltage between line 3 and ground
(V).
ActivePowerL1 REAL Active power at line 1 (kW).
ActivePowerL2 REAL Active power at line 2 (kW).
ActivePowerL3 REAL Active power at line 3 (kW).
ApparentPowerL1 REAL Apparent power at line 1 (kVA).
ApparentPowerL2 REAL Apparent power at line 2 (kVA).
ApparentPowerL3 REAL Apparent power at line 3 (kVA).
ReactivePowerL1 REAL Reactive power at line 1 (kW).
ReactivePowerL2 REAL Reactive power at line 2 (kW).
ReactivePowerL3 REAL Reactive power at line 3 (kW).
UnbalVoltageLinetoLineWorst REAL Unbalanced voltage line to line worst
(%).
ActivePowerDemand REAL Active power demand - Present (kW)
ReactivePowerDemand REAL Reactive power demand - Present
(kVAR)
ApparentPowerDemand REAL Apparent power demand - Present
(kVA)
*
These parameters are available only with specific components.

232 EIO0000002092 04/2020

 PM Profile

Parameter Type Description

PM82xx_MEA* PM82xx_MEA_DDT Data structure with the device measurement
information.
The following table describes the
PM82xx_MEA_DDT:
Parameter Type Description
ActiveEnergy REAL Active energy consumption (kWh).
ReactiveEnergy REAL Reactive energy consumption
(kVARh).
TotalActivePower REAL Total Active power (kW)
TotalReactivePower REAL Total reactive power (kVAR).
AverageLineToLineVoltage REAL Average L-L Voltage, between the 3
phases (V).
AverageLineToNeutral Voltage REAL Average L-N Voltage, between the 3
phases (V).
Frequency REAL Frequency (Hz)
ActualCurrentL1 REAL Instantaneous current from Phase 1
(A).
ActualCurrentL2 REAL Instantaneous current from Phase 2
(A).
ActualCurrentL3 REAL Instantaneous current from Phase 3
(A).
VoltageL1ToL2 REAL Voltage between line 1 and 2 (V).
VoltageL2ToL3 REAL Voltage between line 2 and 3 (V).
VoltageL1ToL3 REAL Voltage between line 1 and 3 (V).
VoltageL1ToNeutral REAL Voltage between line 1 and ground
(V).
VoltageL2ToNeutral REAL Voltage between line 2 and ground
(V).
VoltageL3ToNeutral REAL Voltage between line 3 and ground
(V).
ActivePowerL1 REAL Active power at line 1(kW).
ActivePowerL2 REAL Active power at line 2 (kW).
ActivePowerL3 REAL Active power at line 3 (kW).
ApparentPowerL1 REAL Apparent power at line 1 (kVA).
* These parameters are available only with specific components.

EIO0000002092 04/2020 233

PM Profile

Parameter Type Description

ApparentPowerL2 REAL Apparent power at line 2 (kVA).
ApparentPowerL3 REAL Apparent power at line 3 (kVA).
ReactivePowerL1 REAL Reactive Power at Line 1 (kVAR).
ReactivePowerL2 REAL Reactive Power at Line 2 (kVAR).
ReactivePowerL3 REAL Reactive Power at Line 3 (kVAR).
UnbalancedVoltageLtoNWorst REAL Unbalanced voltage Line to Neutral
Worst(%).
ActivePowerLastDemand REAL Active power last demand (kW).
(kW = Active power demand
delivered - Active power demand
received)
ReactivePowerTotalLastDemand REAL Reactive power total last demand
(kVAR).
(kVAR = Reactive power demand
delivered + Reactive power demand
received)
ApparentPowerLastDemand REAL Apparent power last demand (kVA).
(kVA = Apparent power demand
delivered - Apparent power demand
received)
*
These parameters are available only with specific components.

Timing diagram:

234 EIO0000002092 04/2020

 PM Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

PM_ST PM_ST_DDT Device data structure holds the minimum information
required for performing control and monitoring functions.
The information used by the operator screen is usable
from the HMI/SCADA system.
PM_CFG PM_CFG_DDT Data structure with device information. The information
used by the operator screen is readable from the
HMI/SCADA system.
PM_CFG* PM82xx_CFG_DDT Data structure with device information. The information
used by the operator screen is readable from the
HMI/SCADA system.
PM_CFG* PM1200_CFG_DDT Data structure with device information. The information
used by the operator screen is readable from the
HMI/SCADA system.
PM_CFG*s- PM9C_CFG_DDT Data structure with device information. The information
used by the operator screen is readable from the
HMI/SCADA system.
WorkMemory ANY_ARRAY_INT Array is used for Modbus communications.
This variable is to be used with a Modbus port that
serializes Modbus requests in an optimum manner.
*
These parameters are available only with specific components.

PM_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit word is read-only.
CFGW WORD Device control.
Enables to control the device from the monitoring subsystem or from the operator
screen if Owner (1), or only from the monitoring subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value for reading from
the HMI/SCADA system.
AparentEnergy DINT Apparent power consumption (kVAh).
TotalAparentPower REAL Total apparent power (kVA).
TotalPowerFactor REAL Total power factor.
AverageCurrent REAL Average current between the 3 phases (A).

EIO0000002092 04/2020 235

PM Profile

PM_CFG_DDT Type

Name Type Description

WarningCode WORD Alarm code.
Detected PM alarm code information. Takes the values from the
WarningCode output pin.
NOTE: WarningCode is not applicable for EMPM82xx
FailCode0 INT Code of last level 0 detected error. Indicates that a detected error has
occurred FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates that a detected error has
occurred FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates that a detected error has
occurred FailCode[2].

PM82xx_CFG_DDT

Name Type Description

FailCode0 INT Code of last level 0 detected error. Indicates that a detected error
has occurred FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates that a detected error
has occurred FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates that a detected error
has occurred FailCode[2].

PM1200_CFG_DDT Type

Name Type Description

FailCode0 INT Code of last level 0 detected error. Indicates that a detected error
has occurred FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates that a detected error
has occurred FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates that a detected error
has occurred FailCode[2].

236 EIO0000002092 04/2020

 PM Profile

PM9C_CFG_DDT Type

Name Type Description

FailCode0 INT Code of last level 0 detected error. Indicates that a detected error has
occurred FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates that a detected error has
occurred FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates that a detected error has
occurred FailCode[2].

PM_ST.STW Word Structure

Bit Description
0 Unknown device status or communication interruption. No variable
refreshing.
1 Not ready.
2 Module is running.
3 Inoperable device.
4 Alarm on the device or repetitive detected fault alarm requires
resetting.
NOTE: Not applicable for EMPM82xx
5 Communication interruption.
6 Requires resetting. ResetFail is required.
8 Refer to the Reseting output pin (see page 225).
9 Refer to the EnableDFB input pin (see page 224).

PM_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 224).
1 Owner.

EIO0000002092 04/2020 237

PM Profile

PM_CFG.WarningCode Word Structure

Bit Description for PM700

0 Phase 1 voltage out of range.
1 Phase 2 voltage out of range.
2 Phase 3 voltage out of range.
3 Phase 1 current out of range.
4 Phase 2 current out of range.
5 Phase 3 current out of range.
6 Frequency out of range or phase 1 voltage is insufficient to
determine frequency.

Bit Description for PM800

0 Summary bit (activated if any other bit is activated).
1 Incorrect configuration
2 Incorrect scaling.
3 Phase dropout.
4 Incorrect cabling.
5 Incremental energy could be incorrect due to the reset operation of
the meter.
6 External demand synchronous waiting time.

238 EIO0000002092 04/2020

 PM Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block waits for the
operations to be carried out by the device.
The PM unit only allows using ResetFail for communications. If the
detected failure continues after the period specified in
CommandCtrlWindow has elapsed, Fail remains TRUE and the
Reseting output resets (when set to FALSE).
Refresh TIME Refresh time for device data on Modbus communications.
NOTE: This refresh operation is carried out on read variables. Write
requests are carried out when needed.
ScanTime* TIME Allows you to configure the time for which the alarm signals are kept
active.
Helps the monitoring subsystem to acquire the data for the alarms that
are automatically reset. (Minimum time to maintain alarm signals).
ResetMode BOOL Enables to configure the type of reset. This type of reset is used for
communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset needs to be carried out. The first reset is
carried out after the time defined in CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow * 2
elapses, so on. If the value of CommandCtrlWindow is 0 s, its value
is not used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
value
FALSE Communications are/the device is reset with the ResetFail variable.
TRUE Communications are/the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable is used to define the
maximum time that can elapse between 2 consecutive resets.
Refer to the Timing diagram below.
*: These parameters are available only with specific components.

EIO0000002092 04/2020 239

PM Profile

Timing diagram:

240 EIO0000002092 04/2020

 PM Profile

Diagnostic Information Management

Overview
The diagnostic codes the device can return are read from the FailCode output variable.

Parameter Configuration Diagnostic Codes

This detected error indicates that a public variable parameter contains a value that is not allowed.
To reload new values, a rising edge is required on the EnableDFB input:
 FailCode[0]: 16#0003
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
NOTE: The inoperable device reset is sent to the device.

Modbus Communications Diagnostic Codes

For Modbus communications, this code is used to indicate that communications have not been
established. It can be reset.
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
After Modbus communications have been established, check Modbus client diagnostic codes for
FailCode [0] and FailCode [1]. The components make a distinction between read request
problems and write request problems:
 FailCode[2]: 16#0001 - Read
 FailCode[2]: 16#0002 - Write

EIO0000002092 04/2020 241

PM Profile

242 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Smart UPS Profile
EIO0000002092 04/2020

Chapter 14
Smart UPS Profile

Smart UPS Profile

Overview
This chapter describes the DFB of Smart UPS profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 244
DFB Representation 245
Inputs 246
Outputs 247
Inputs/Outputs 251
Public Variables 255
Diagnostic Information Management 257

EIO0000002092 04/2020 243

Smart UPS Profile

Description

General
The MBSMARTUPS DFB is the control block to manage SMART UPS uninterrupted power supplies
based on a Modbus.
NOTE: The MBSMARTUPS DFB requires a Smart UPS device connected through an AP9622
communication card.

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

Function Description
Device detected failure Monitors the inoperable devive.
Remote resetting Enables you to reset communicationinterruptions.
Monitoring Allows the device parameters to be monitored.

244 EIO0000002092 04/2020

 Smart UPS Profile

DFB Representation

Representation
The following figure represents MBSMARTUPS DFB in Control Expert:

EIO0000002092 04/2020 245

Smart UPS Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control block.
 0 = The entire DFB is restarted (statuses, output values,
counters are lost) and output values are set to 0.
 1 = Enables communications with the devices for their
operation.
Public variable values are loaded during the first enabling
cycle.
ResetFail EBOOL 1 = Resets the Fail output parameter to 0 or in case of
inoperable device, sends a reset command to the device if
ControlCommand is 1.
ModbusAddress INT Device address within the Modbus network.

246 EIO0000002092 04/2020

 Smart UPS Profile

Outputs

Output Parameter Description

Output Type Description

Ready BOOL 1 = The device is enabled and free of detected errors. The
device is ready to carry out any operation.
Fail BOOL 1 = A detected failure in the control block or in the device or
communication interruption.To reset the Fail output pin,
the ResetFail input has to be activated. The last detected
error code is shown on FailCode.
NOTE: If a communication interruption occurs, the
variables being read from the device cease to be refreshed
as a refresh operation can no longer be carried out. The
variables keep their last value.
Warning BOOL 1 = An alarm has been activated for the device. It does not
affect the block operation and does not need to be reset.
The signal remains active until the cause for the alarm
disappears.
FailCode ARRAY [0..2] OF INT When Fail output is 1, it holds the code for the detected
error.
If Fail output is 0, it indicates the last detected error that
occurred.
The detected error source is specified by a 3 level structure.
Refer to the Diagnostic Information Management
(see page 302) section.
WarningCode WORD The WarningCode output holds a data structure with
information on the alarm currently on the UPS.
Bit Description
0 Replace battery.
1 Low battery.
2 Overload.
ExtControlled BOOL 1 = The device is being controlled from an external source
(for example, from the monitoring system) to the system.

EIO0000002092 04/2020 247

Smart UPS Profile

Output Type Description

Reseting 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the
maximum time for resetting the detected failure.
When a device or communication reset is carried out with
ResetFail, the DFB tries to reset the detected failure
within the time period defined in CommandCtrlWindow.
If the detected failure is reset, the Fail and Reseting
output variables are reset (set to FALSE). On the other
hand, if the detected failure is not reset, the Reseting
variable is set to FALSE and the Fail variable remains
TRUE. The ResetFail is edge-based.
Refer to the timing diagram below.
SMARTUPSStatus SMARTUPSSTATUS The structure holds the data containing the information that
the block extracts from the status word variable of the
device.
The following table describes the status information:
Parameter Type Description
Status SMARTUPS_ General status of SMARTUPS.
DeviceStatus
(see page 249)
Warning SMARTUPS_Wa SMARTUPS notification condition.
(see page 249)rnin
g
Fail SMARTUPS_Fail SMARTUPS failure detected
(see page 250) condition.
BatteryCharge INT
Load Indicates the remaiBOOLning battery capacity
as a percentage of the fully-charged condition
(%) of the battery.
RemainingTime Indicates the UPS output load as a percentage
of full rated load in watts (%).
StatisticConnector STATISTICCONNECTOR Information data used with Modbus communications to
obtain statistics on the Modbus network (for example,
requests carried out, time between requests, so on.
This structure has been created for its use together with the
Communications library Statistics module.
Parameter Type Description
Start BOOL 1 = The operation has started.
EndOk BOOL 1 = The operation has ended correctly.
EndNOK BOOL 1 = The operation has ended with a
detected error.
PartialTime DINTt Partial time.

248 EIO0000002092 04/2020

 Smart UPS Profile

Output Type Description

SMARTUPS_MEA SMARTUPS_MEA_DDT Data structure with device measurement information.
Parameter Type Description
NominalOutput INT Nominal output voltage (V).
ActualOutput INT Actual output voltage (V).
InputVoltage INT Input voltage (V).

SMARTUPS_DeviceStatus
The following table describes the SMARTUPS_DeviceStatus variables:

Parameter Type Description

OnLine BOOL 1 = The device is on line.
OnBattery BOOL 1 = The battery is on.
Bypass BOOL 1 = The SMARTUPS is in bypass mode.
Warning BOOL 1 = The SMARTUPS notification.
Fail BOOL 1 = A SMARTUPS fault detected.
AVRBoost BOOL 1 = AVRBoost.
AVRTrim BOOL 1 = AVRTrim.
TurningOn BOOL 1 = The device is turning on.
BypassInternalFault BOOL 1 = The device is in bypass mode due to an internal fault
detected, indicated through register 0002 or 0003.
GoingBypass BOOL 1 = The device is switching to bypass mode due to a command.
BypassCmd BOOL 1 = The device is in bypass mode due to a command.
Returning BOOL 1 = The device is returning from bypass mode.
BypassMan BOOL 1 = The device is in bypass mode as a result of manual bypass
control.
ReadyToPower BOOL 1 = The device is ready to provide the power to the load on the
user command.
ReadyToProvide BOOL 1 = The device is ready to provide the power to the load on the
return of normal line voltage or on the user command.

SMARTUPS_Warning
The following table describes the SMARTUPS_Warning variables:

Parameter Type Description

ReplaceBattery BOOL 1 = The battery needs to be replaced.
LowBattery BOOL 1 = Low battery.
Overload BOOL 1 = Overload.

EIO0000002092 04/2020 249

Smart UPS Profile

SMARTUPS_Fail
The following table describes the SMARTUPS_Fail variables:.

Parameter Type Description

LowBattShutdown BOOL 1 = The UPS output is not receiving power due to low-battery
shutdown.
OverloadFault BOOL 1 = The UPS is unable to switch to on-battery operation due to
overload.
RelayMalfunction BOOL 1 = The main relay is not working.
SleepMode BOOL 1 = The UPS is in sleep mode.
ShutdownMode BOOL 1 = The UPS is in shutdown mode.
BatteryChargerFailure BOOL 1 = Battery charger failure detected.
BypassRelayMalfunction BOOL 1 = The bypass relay is not working.
TemperatureFault BOOL 1 = UPS fault detected, internal temperature exceeded nominal
limits.
FanFailure BOOL 1 = Electronic unit fan failure detected.
IsolationFanFailure BOOL 1 = Isolation unit fan failure detected.
BypassSupplyFailure BOOL 1 = Bypass supply failure detected.
OutputFailure BOOL 1 = Output voltage selection failure detected – UPS is in bypass
mode.
UPSFault BOOL 1 = UPS fault detected – UPS is in bypass mode.
NoBatteriesAttached BOOL 1 = The UPS commanded out of bypass mode with no batteries
attached – UPS is in bypass mode.
AVRFault BOOL 1 = An AVR Boost or trim relay fault detected.
InverterFault BOOL 1 = Inverter fault detected.

250 EIO0000002092 04/2020

 Smart UPS Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

SMARTUPS_ST SMARTUPS_ST_DDT Device data structure that holds the minimum
information required for performing control and
monitoring.
The information is used by the operator screen and can
be read from or written to HMI/SCADA system.
SMARTUPS_CFG SMARTUPS_CFG_DDT Data structure with device information. Information
used by the operator screen is readable from
HMI/SCADA system.
WorkMemory ANY_ARRAY_INT The array is used in Modbus communications.
This variable is to be used with a Modbus port that
serializes Modbus requests in an optimum manner.

SMARTUPS_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit
word is read-only.
CFGW WORD Enables controlling of the device from the monitoring
subsystem or from the operator screen if Owner (1), or only
from the monitoring subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value
for reading from the HMI/SCADA system.
BatteryCharge INT Battery capacity. Remaining battery capacity as a percentage
of the fully-charged condition (%) of the battery.
Load INT UPS output load as a percentage of full rated load in watts (%).
RemainingTime INT Remaining runtime (min).

EIO0000002092 04/2020 251

Smart UPS Profile

SMARTUPS_CFG_DDT Type

Name Type Description

DataStatus WORD Provides the status information of the device for displaying in the
background on the monitoring subsystem.
WarningStatus WORD Provides the notification information of the device for displaying in the
background on the monitoring subsystem.
FailStatus WORD Provides detected failure information of the device for displaying, in the
background on the monitoring subsystem.
WarningCode WORD Provides SMART UPS alarm code information. Takes values from the
WarningCode output (W3).
FailCode0 INT Indicates which detected error has occurred, FailCode[0].
FailCode1 INT Indicates which detected error has occurred, FailCode[1].
FailCode2 INT Indicates which detected error has occurred, FailCode[2].

SMARTUPS_ST.STW Word Structure

Battery on.
Bit Description
0 Unknown technological module status. No variable refreshing.
1 Not ready.
2 Module is running.
3 Device failure detected.
4 Alarm on the device or repetitive detected fault alarm requires resetting.
5 Communication interruption.
6 Requires resetting. ResetFail is required.
8 Refer to the Reseting output pin (see page 247).
9 Refer to the EnableDFB input pin (see page 246).
10 On line.
11
12 Bypass mode.

252 EIO0000002092 04/2020

 Smart UPS Profile

SMARTUPS_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 246).
1 Owner.

SMARTUPS_CFG.DataStatus Word Structure

Bit Description
0 Refer to the OnLine status in the Status output pin (see page 247).
1 Refer to the OnBattery status in the Status output pin (see page 247).
2 Refer to the Bypass status in the Status output pin (see page 247) .
3 Refer to the Warning status in the Status output pin (see page 247).
4 Refer to the Fail status in the Status output pin (see page 247).
5 Refer to the AVRBoost status in the Status output pin (see page 247).
6 Refer to the AVRTrim status in the Status output pin (see page 247).
7 Refer to the TurningOn status in the Status output pin (see page 247).
8 Refer to the BypassInternalFault status in the Status output pin (see page 247).
9 Refer to the GoingBypass status in the Status output pin (see page 247).
10 Refer to the BypassCmd status in the Status output pin (see page 247).
11 Refer to the Returning status in the Status output pin (see page 247).
12 Refer to the BypassMan status in the Status output pin (see page 247).
13 Refer to the ReadyToPower status in the Status output pin (see page 247).
14 Refer to the ReadyToProvide status in the Status output pin (see page 247).

SMARTUPS_CFG.WarningStatus Word Structure

Bit Description
0 Refer to the ReplaceBattery output pin (see page 247).
1 Refer to the LowBattery output pin (see page 247).
2 Refer to the Overload output pin (see page 247).

EIO0000002092 04/2020 253

Smart UPS Profile

SMARTUPS_CFG.FailStatus Word Structure

Bit Description
0 Refer to the LowBattShutdown status in the FailStatus output pin (see page 247).
1 Refer to the OverloadFault status in the FailStatus output pin (see page 247).
2 Refer to the RelayMalfunction status in the FailStatus output pin (see page 247).
3 Refer to the SleepMode status in the FailStatus output pin (see page 247).
4 Refer to the ShutdownMode status in the FailStatus output pin (see page 247).
5 Refer to the BatteryChargerFailure status in the FailStatus output pin (see page 247).
6 Refer to the BypassRelayMalfunction status in the FailStatus output pin
(see page 247).
7 Refer to the TemperatureFault status in the FailStatus output pin (see page 247).
8 Refer to the FanFailure status in the FailStatus output pin (see page 247).
9 Refer to the IsolationFanFailure status in the FailStatus output pin (see page 247).
10 Refer to the BypassSupplyFailure status in the FailStatus output pin (see page 247).
11 Refer to the OutputFailure status in the FailStatus output pin (see page 247).
12 Refer to the UPSFault status in the FailStatus output pin (see page 247).
13 Refer to the NoBatteriesAttached status in the FailStatus output pin (see page 247).
14 Refer to the AVRFault status in the FailStatus output pin (see page 247).
15 Refer to the InverterFault status in the FailStatus output pin (see page 247).

SMARTUPS_CFG.WarningCode Word Structure

Bit Description
5 Refer to the Overload in the WarningCode output pin (see page 247).
6 Refer to the Low battery in the WarningCode output pin (see page 247).
7 Refer to the Replace battery in the WarningCode output pin (see page 247).

254 EIO0000002092 04/2020

 Smart UPS Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block waits for the
operations to be carried out by the device.
The PM only allows a communications ResetFail. If the failure
detected continues after the CommandCtrlWindow time has elapsed,
Fail remains TRUE and the Reseting resets (resets to FALSE).
Refresh TIME Refresh time for device data on Modbus communications.
NOTE: This refresh operation is carried out on read variables. Write
requests are carried out when needed.
ScanTime TIME Allows you to configure the time for which the alarm signals are kept
active.
Helps the monitoring subsystem to acquire the data for the alarms that
are automatically reset.
ResetMode BOOL Enables to configure the type of reset. This type of reset is used for
communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset needs to be carried out. The first reset is
carried out after the time defined in CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow * 2
elapses, so on. If the value of CommandCtrlWindow is 0 s, its value
is not used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
Value
FALSE Communications are/the device is reset with the ResetFail variable.
TRUE Communications are/the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable sets the maximum time
between 2 consecutive resets.
Refer to the timing diagram below.

EIO0000002092 04/2020 255

Smart UPS Profile

Timing diagram:

256 EIO0000002092 04/2020

 Smart UPS Profile

Diagnostic Information Management

Overview
The diagnostic codes the device can return are read from the ErrorCode output variable.

Parameter Configuration Diagnostic Codes

This detected error indicates that a public variable parameter contains a value that is not allowed.
To reload new values, a rising edge is required on the EnableDFB input:
 FailCode[0]: 16#0003
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

Modbus Communications Diagnostic Codes

For Modbus communications, this code is used to indicate that communications have not been
established. This code can be reset.
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
After Modbus communications have been established, check Modbus client diagnostic codes for
FailCode[0] and FailCode [1]. The components make a distinction between read requests
problems and write requests problems:
 FailCode[2]: 16#0001 Read
 FailCode[2]: 16#0002 Write

Diagnostic Code Example

For a detected error, the code is:
 FailCode[1]: 16#0001
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005
It can be reset.

EIO0000002092 04/2020 257

Smart UPS Profile

258 EIO0000002092 04/2020

 Modicon Libraries General Purpose
ACCUSINE PCS Profile
EIO0000002092 04/2020

Chapter 15
ACCUSINE PCS Profile

ACCUSINE PCS Profile

Overview
This chapter describes the DFB of Accusine PCS profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 260
DFB Representation 261
Inputs 262
Outputs 265
Inputs/Outputs 271
Public Variables 275
Diagnostic Information Management 276
Communication Needs And/Or Requirements 277

EIO0000002092 04/2020 259

ACCUSINE PCS Profile

Description

General
The EACCUSINE DFB is the control block to manage family ACCUSINE PCS harmonic filters
based on an Ethernet network.
NOTE: To use the EACCUSINE DFB, the Magelis HMI has to be running Active Filter Runtime
Application version 5.1.12.1205 or higher.

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

Function Description
Control Run/Stop command.
Monitoring Allows the device parameters to be monitored.
Remote resetting Allows resetting of the communication interruption.
Owner Manages the control system which is the owner (Operator or
Program). Therefore, it is responsible for setting the control.

For DFBs communicating by I/O scanning, variables read from the device retain their last value
when a communication interruption occurs. For details, refer to the description of the
corresponding output parameter (see page 126).

WARNING
UNINTENDED EQUIPMENT OPERATION
When you configure the Last value parameter of the I/O scanner line, take into consideration
the behavior of the DFB when a communication interruption occurs.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

260 EIO0000002092 04/2020

 ACCUSINE PCS Profile

DFB Representation

Representation
The following figure represents EACCUSINE DFB in Control Expert:

EIO0000002092 04/2020 261

ACCUSINE PCS Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control
block.
 0 = When the input is set to 0, the entire DFB is
restarted (statuses, output values, counters are lost)
and output values are set to 0.
 1 = When the input is set to 1, this input enables
communications with the devices for their operation.
Public variable values are loaded during the first enabling
cycle.
Run BOOL 1 = Starts the active filter.
ResetFail BOOL 1 = Resets the Fail output parameter to 0 or in case of
inoperable device, sends a reset command to the device
if ControlCommand is 1.
IOScannerStatus BOOL 1 = The node is present on the bus.
You can find this variable in Ethernet communications.
ControlCommand BOOL Indicates to the DFB whether the motor is being
controlled locally or from a source external to the DFB.
 0 = The DFB performs only read operations to monitor
the status of the device and does not perform any
control functions.
 1 = The DFB performs read operations and performs
control operations not conflicting with control
commands coming from an external control source.

262 EIO0000002092 04/2020

 ACCUSINE PCS Profile

Parameter Type Description

Inputs1 ARRAY [1...11] OF UINT An array contains the read information obtained from the
AccuSine unit through the IOScan. For the block to work
properly, allocate the structure (%MWx).
Parameter Type Description
Inputs1[1] UINT Total rms load current, A
phase.
Inputs1[2] UINT Total rms load current, B
phase.
Inputs1[3] UINT Total rms load current, C
phase.
Inputs1[4] UINT AccuSine PCS output rms
current, A phase.
Inputs1[5] UINT AccuSine PCS output rms
current, B phase.
Inputs1[6] UINT AccuSine PCS output rms
current, C phase.
Inputs1[7] UINT Harmonic rms load current, A
phase.
Inputs1[8] UINT Harmonic rms load current, B
phase.
Inputs1[9] UINT Harmonic rms load current, C
phase.
Inputs1[10] UINT Reactive rms load current.
Inputs1[11] UINT AccuSine PCS reactive rms
output current.
Inputs2 ARRAY [1...2] OF UINT An array contains the read information obtained from the
AccuSine unit through the IOScan. For the block to work
properly, allocate the structure (%MWx).
Parameter Type Description
Inputs2[1] UINT 1: Running.
0: Stopped.
Inputs2[2] UINT Enable remote status.

EIO0000002092 04/2020 263

ACCUSINE PCS Profile

Parameter Type Description

Inputs3 ARRAY [1...4] OF WORD An array contains the read information obtained from the
AccuSine unit through the IOScan. For the block to work
properly, allocate the structure (%MWx).
Parameter Type Description
Inputs3[1] WORD Word containing information
about the events with top
priority.
Inputs3[2] WORD Word 1 containing
information about the events
with lower priority.
Inputs3[3] WORD Word 2 containing
information about the events
with lower priority.
Inputs3[4] WORD Alarm status.

264 EIO0000002092 04/2020

 ACCUSINE PCS Profile

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL 1 = The device is enabled and free of detected errors. The
device is ready to carry out any operation.
Fail BOOL 1 = A detected failure in the control block or in the device or
communication interruption.To reset the Fail output pin, the
ResetFail input has to be activated. The last detected error
code is shown on FailCode.
NOTE: If a communication interruption occurs, the variables
being read from the device cease to be refreshed as a
refresh operation can no longer be carried out. The variables
keep their last value.
Warning BOOL 1 = An alarm has been activated for the device. It does not
affect the block operation and does not need to be reset.
The signal remains active until the cause for the alarm
disappears.
FailCode ARRAY [0..2] OF INT When Fail output is 1, it holds the code for the detected
error.
If Fail output is 0, it indicates the last detected error that
occurred.
The detected error source is specified by a 3 level structure.
Refer to the Diagnostic Information Management
(see page 276) section.
WarningCode WORD The WarningCode output holds a data structure with
information on the alarm currently on the AccuSine unit.
Bit Description
0 Maximum capacity alarm detected.
1 Thermal limit override.
2 Low-order harmonic alarm detected.
Running BOOL 1 = Indicates that the active filter is running.
ExtControlled BOOL 1 = The device is being controlled from an external source
(for example, from the monitoring system) to the system.

EIO0000002092 04/2020 265

ACCUSINE PCS Profile

Parameter Type Description

Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the maximum
time for resetting the detected failure.
When a device or communication reset is carried out with
ResetFail, the DFB tries to reset the detected failure within
the time period defined in CommandCtrlWindow.
If the detected failure is reset, the Fail and Reseting
output variables are reset (set to FALSE). If the detected
failure is not reset, the Reseting variable sets to FALSE
and the Fail variable remains TRUE. The ResetFail is
edge-based.
Refer to the timing diagram below.
CommunicationOK BOOL 1 = Indicates that the node is present on the bus. You can
find this variable in Ethernet communications.
Status EACCUSINEStatus The structure holds the data containing the information that
the block extracts from the status word variable of the device.
The following table describes the status information:
Parameter Type Description
Status EACCUSINE_ Provides the general status of the device.
DeviceStatus Access to the data held in this bit word is
read-only.
Alarm EACCUSINE_ Provides the information on the device
Alarm status.
CriticalFail EACCUSINE_ Provides the notification information of the
CriticalFail device. Access to the data held in this bit
word is read-only.
NonCriticalFail EACCUSINE_ Provides the notification information of the
NonCriticalFail device. Access to the data held in this bit
word is read-only.
State INT Numerical code of device status.
Info INT Code with information on statuses and
required actions.
Outputs ARRAY OF UINT Holds an array structure with data sent to the device. The
control exerted on the device can be influenced with this
output variable.This variable is reserved for the DFB, and
you cannot use this variable directly. For the control block to
work properly, allocate the structure (%MWx). Refer to the
Communications Technologies (see page 503).
Parameter Type Description
Outputs[1] UINT Command:
 0 to 1: Run
 1 to 0: Stop

266 EIO0000002092 04/2020

 ACCUSINE PCS Profile

Parameter Type Description

ACCUSINE_MEA ACCUSINE_MEA_DDT Data structure with device measurement information.
The following table describes the status information:
Parameter Type Description
TOTAL_LOAD_A UINT Total rms load current, A phase.
TOTAL_LOAD_B UINT Total rms load current, B phase.
TOTAL_LOAD_C UINT Total rms load current, C phase.
OUTPUT_A UINT AccuSine PCS output rms current, A phase.
OUTPUT_B UINT AccuSine PCS output rms current, B phase.
OUTPUT_C UINT AccuSine PCS output rms current, C phase.
HARMONIC_A UINT Harmonic rms load current, A phase.
HARMONIC_B UINT Harmonic rms load current, B phase.
HARMONIC_C UINT Harmonic rms load current, C phase.
TOTAL_LOAD_PF UINT Reactive rms load current.
OUTPUT_PF UINT AccuSine PCS reactive rms output current.

EACCUSINE_DeviceStatus
The following table describes the EACCUSINE_DeviceStatus variable:

Parameter Type Description

Running BOOL 1 = The device is running.
EnableRemote BOOL 1 = A remote status is enabled.
Warning BOOL 1 = An ACCUSINE notification.
Fail BOOL 1 = An ACCUSINE detected failure.

EACCUSINE_Alarm
The following table describes the EACCUSINE_Alarm variable:

Parameter Type Description

MaxCapacity BOOL 1 = Maximum capacity
alarm detected.
ThermalLimit BOOL 1 = Thermal limit override.
LowOrderHarmo BOOL 1 = Low-order harmonic
nic alarm detected.

EIO0000002092 04/2020 267

ACCUSINE PCS Profile

EACCUSINE_CriticalFail
The following table describes the EACCUSINE_CriticalFail variable:

Parameter Type Description

Fail_5V_OV BOOL 1 = A 5 V OV failure detected.
Fail_5V_UV BOOL 1 = A 5 V UV failure detected.
Fail_P15V_UV BOOL 1 = A +15 V UV failure detected.
Fail_L15V_UV BOOL 1 = A -15 V UV failure detected.
UserSetup BOOL 1 = User setup failure detected.
TimeOut BOOL 1 = Timeout failure detected.
AutoDetect BOOL 1 = Auto detect failure detected.
HMILost BOOL 1 = HMI lost failure detected.
InvalidRating BOOL 1 = Invalid rating.
PhaseRotation BOOL 1 = Phase rotation failure detected.

EACCUSINE_NonCriticalFail
The following table describes the EACCUSINE_NonCriticalFail variable:

Parameter Type Description

ACLineLoss BOOL 1 = Detected failure in AC line.
ACPhaseLoss BOOL 1 = Detected failure in AC phase.
ACImbalance BOOL 1 = Detected failure in AC imbalance.
ACOverVolt BOOL 1 = AC overvoltage.
ACFreq BOOL 1 = Incorrect AC frequency.
Sensor BOOL 1 = Sensor failure detected.
Frequency BOOL 1 = Frequency failure detected.
IGBTA BOOL 1 = IGBT A failure detected.
IGBTB BOOL 1 = IGBT B failure detected.
IGBTC BOOL 1 = IGBT C failure detected.
IGBT1OverT BOOL 1 = IGBT1 excess temp failure detected.
IGBT2OverT BOOL 1 = IGBT2 excess temp failure detected.
IGBT3OverT BOOL 1 = IGBT3 excess temp failure detected.
PhaseOverT BOOL 1 = 3 Ph excess temp failure detected.
Filter BOOL 1 = Filter failure detected.
EnclosureOverT BOOL 1 = Enclosure excess temp failure detected.
DCBusOverV BOOL 1 = DC bus over voltage failure detected.
DCBusLowV BOOL 1 = DC bus low voltage failure detected.

268 EIO0000002092 04/2020

 ACCUSINE PCS Profile

Parameter Type Description

EnclosureUnderT BOOL 1 = Enclosure temp lower than minimum temp failure detected.
F110COverT BOOL 1 = 110C excess temp failure detected.
BoardOverT BOOL 1 = Circuit board excess temp failure detected.

State
The following table describes the State variable:

Variable value Description

–2 Device has detected error.
–1 Not initialized. Waiting for data.
0 Disabled.
5 Ready.
8 Device failure detected.

Info
The following table describes the Info variable:

Variable value Description

1 Incorrect configuration of DFB parameter.
8 Accusine running.
11 Missing EnableDFB. Initial state.
12 Missing CommunicationOK. Communication interruption.
24 Remove ResetFail. Reset again.
25 Accusine stopped.
81 Missing ResetFail. Device error detected.
82 A Reset is needed.

EIO0000002092 04/2020 269

ACCUSINE PCS Profile

Timing diagram:

270 EIO0000002092 04/2020

 ACCUSINE PCS Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

ACCUSINE_ST ACCUSINE_ST_DDT Device data structure holds the minimum information required
for performing control and monitoring.
The information is used by the operator screen and can be read
from or written to HMI/SCADA system.
ACCUSINE_CFG ACCUSINE_CFG_DDT Data structure with device information. Information used by the
operator screen is readable from HMI/SCADA system.

ACCUSINE_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit
word is read-only.
CFGW WORD Enables controlling the device from the monitoring subsystem
or from the operator screen if Owner (1), or only from the
monitoring subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value
for reading from the HMI/SCADA system.

ACCUSINE_CFG_DDT Type

Name Type Description

DataStatus WORD Provides the status information of the device for displaying in the
background on the monitoring subsystem.
FailStatus WORD Provides information about the detected failure found in the
device, for displaying in the background, on the monitoring
subsystem.
NonCriticalFailStatus WORD Provides the status information of the device for displaying in the
background on the monitoring subsystem.
WarningCode WORD Provides EACCUSINE alarm code information. Takes values from
the WarningCode output (W3).
FailCode0 INT Indicates which detected error has occurred, FailCode[0.
FailCode1 INT Indicates which detected error has occurred, FailCode[1.
FailCode2 INT Indicates which detected error has occurred, FailCode[2].

EIO0000002092 04/2020 271

ACCUSINE PCS Profile

ACCUSINE_ST.STW Word Structure

Bit Description
0 Unknown device status or communication interruption. No variable refreshing.
1 Not ready.
2 Module is running.
3 Inoperable device.
4 Alarm on the device or repetitive detected fault alarm requires resetting.
5 Communication interruptions.
6 Requires resetting. ResetFail is required.
7 Refer to the ExtControlled output pin (see page 265).
8 Refer to the Reseting output pin (see page 265).
9 Refer to the EnableDFB input pin (see page 262).

ACCUSINE_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 262).
1 Owner.
6 Refer to the Run input pin (see page 262).
7 Refer to the ControlCommand input pin (see page 262).

ACCUSINE_CFG.DataStatus Word Structure

Bit Description
0 Refer to the Running status in the Status output pin (see page 267).
1 Refer to the EnableRemote status in the Status output pin (see page 267).
2 Refer to the Warning status in the Status output pin (see page 267) .
3 Refer to the Fail status in the Status output pin (see page 267).
4 Refer to the MaxCapacity status in the Status output pin (see page 267).
5 Refer to the ThermalLimit status in the Status output pin (see page 267).
6 Refer to the LowOrderHarmonic status in the Status output pin (see page 267).

272 EIO0000002092 04/2020

 ACCUSINE PCS Profile

ACCUSINE_CFG.FailStatus Word Structure

Bits Description
0 Refer to the Fail_5V_OV(CR) in the CriticalFail output pin (see page 268).
1 Refer to the Fail_5V_UV(CR) in the CriticalFail output pin (see page 268).
2 Refer to the Fail_P15V_UV in the CriticalFail output pin (see page 268).
3 Refer to the Fail_L15V_UV in the CriticalFail output pin (see page 268).
4 Refer to the UserSetup in the CriticalFail output pin (see page 268).
5 Refer to the TimeOut in the CriticalFail output pin (see page 268).
6 Refer to the AutoDetect in the CriticalFail output pin (see page 268).
7 Refer to the HMILost in the CriticalFail output pin (see page 268).
8 Refer to the InvalidRating in the CriticalFail output pin (see page 268).
9 Refer to the PhaseRotation in the CriticalFail output pin (see page 268).
10 –
11 Refer to the DCBusOverV in the CriticalFail output pin (see page 268).
12 Refer to the DCBusLowV in the CriticalFail output pin (see page 268).
13 Refer to the EnclosureUnderT in the CriticalFail output pin (see page 268).
14 Refer to the F110COverT in the CriticalFail output pin (see page 268).
15 Refer to the BoardOverT in the CriticalFail output pin (see page 268).

ACCUSINE_CFG.NonCriticalFailStatus Word Structure

Bit Description
0 Refer to the ACLineLoss in the NonCriticalFail output pin (see page 268).
1 Refer to the ACPhaseLoss in the NonCriticalFail output pin (see page 268).
2 Refer to the ACImbalance in the NonCriticalFail output pin (see page 268).
3 Refer to the ACOverVolt in the NonCriticalFail output pin (see page 268).
4 Refer to the ACFreq in the NonCriticalFail output pin (see page 268).
5 Refer to the Sensor in the NonCriticalFail output pin (see page 268).
6 Refer to the Frequency in the NonCriticalFail output pin (see page 268).
7 Refer to the IGBTA in the NonCriticalFail output pin (see page 268).
8 Refer to the IGBTB in the NonCriticalFail output pin (see page 268).
9 Refer to the IGBTC in the NonCriticalFail output pin (see page 268).
10 Refer to the IGBT1OverT in the NonCriticalFail output pin (see page 268).

EIO0000002092 04/2020 273

ACCUSINE PCS Profile

Bit Description
11 Refer to the IGBT2OverT in the NonCriticalFail output pin (see page 268).
12 Refer to the IGBT3OverT in the NonCriticalFail output pin (see page 268).
13 Refer to the PhaseOverT in the NonCriticalFail output pin (see page 268).
14 Refer to the Filter in the NonCriticalFail output pin (see page 268).
15 Refer to the EnclosureOverT in the NonCriticalFail output pin (see page 268).

ACCUSINE_CFG.WarningCode Word Structure

Bit Description
0 Refer to the MaxCapacity in the WarningCode output pin (see page 267).
1 Refer to the ThermalLimit in the WarningCode output pin (see page 267).
2 Refer to the LowOrderHarmonic in the WarningCode output pin (see page 267).

274 EIO0000002092 04/2020

 ACCUSINE PCS Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block waits for the
operations to be carried out by the device.
The PM only allows a communications ResetFail. If the detected
failure, continues after the CommandCtrlWindow time has elapsed,
Fail remains set to TRUE and the Reseting output resets (set to
FALSE).
ScanTime TIME Allows you to configure the time for which the alarm signals are kept
active.
Helps the monitoring subsystem to acquire the data for the alarms
that are automatically reset.
ResetMode BOOL Enables to configure the type of reset. This type of reset is used for
communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset needs to be carried out. The first reset is
carried out after the time defined in CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow * 2
elapses, so on. If the value of CommandCtrlWindow is 0 s, its value
is not used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
Value
FALSE Communications are/the device is reset with the ResetFail
variable.
TRUE Communications are/the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable sets the maximum time
between 2 consecutive resets.
Refer to the timing diagram below.

EIO0000002092 04/2020 275

ACCUSINE PCS Profile

Diagnostic Information Management

Overview
The diagnostic codes, the device can return are read from the ErrorCode output variable.

Parameter Configuration Diagnostic Codes

This detected error indicates that a public variable parameter contains a value that is not allowed.
To reload new values, a rising edge is required on the EnableDFB input:
 FailCode[0]: 16#0003
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

Modbus Communications Diagnostic Codes

For Modbus communications, this code is used to indicate that communications have not been
established. This code can be reset.
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

Diagnostic Code Example

For a detected error, the code will be:
 FailCode[1]: 16#0001
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005
Can be reset if ControlCommand=TRUE.

276 EIO0000002092 04/2020

 ACCUSINE PCS Profile

Communication Needs And/Or Requirements

IOSCAN Communications
The EACCUSINE component needs 3 IOScan lines:
 First IOScan line:
This IOScan line needs to be configured as follows:
 UnitID: 255
 Slave Syntax: Index
 RD Ref Slave: 1
 RD Length: 11
 Last value (Input): Set to 0
 WR Ref Slave: 0
 WR Length: 0

 Second IOScan line:

This IOScan line needs to be configured as follows:
 UnitID: 255
 Slave Syntax: Index
 RD Ref Slave: 700
 RD Length: 2
 Last value (Input): Set to 0
 WR Ref Slave: 0
 WR Length: 0

 Third IOScan line:

This IOScan line needs to be configured as follows:
 UnitID: 255
 Slave Syntax: Index
 RD Ref Slave: 600
 RD Length: 4
 Last value (Input): Set to 0
 WR Ref Slave: 1001
 WR Length: 1

The following figure shows the IO scanner line:

EIO0000002092 04/2020 277

ACCUSINE PCS Profile

The EACCUSINE section needs the input/output values (RD/WR Master Object) and heart bit of
the IOScan line.
 RD Master Object:
The EACCUSINE DFB needs the Inputs1, Inputs2, and Inputs3. In the diagram given
above, Inputs1 (11 words) is mapped to %MW101, Inputs2 (2 words) is mapped to %MW112,
and Inputs3 (4 words) is mapped to %MW114 but the values needs to be filled from 3 different
variable sections of EACCUSINE memory.
 WR Master Object:
The EACCUSINE DFB needs the outputs. In the diagram given above, outputs is mapped to
%MW100. This value is only used in the third IOScan line.

278 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Progressive Starters
EIO0000002092 04/2020

Part VII
Progressive Starters

Progressive Starters

EIO0000002092 04/2020 279

Progressive Starters

280 EIO0000002092 04/2020

 Modicon Libraries General Purpose
ATS Progressive Starter Profile
EIO0000002092 04/2020

Chapter 16
ATS Progressive Starter Profile

ATS Progressive Starter Profile

Overview
This chapter describes the DFBs of ATS Progressive Starter profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 282
DFB Representation 283
Inputs 285
Outputs 287
Inputs/Outputs 295
Public Variables 300
Diagnostic Information Management 302

EIO0000002092 04/2020 281

ATS Progressive Starter Profile

Description

General
The ATS progressive starter profile is used to manage ATS soft starters on a Modbus network.

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

Function Description
Control Start/Stop command.
Inoperable device Monitors the inoperable device.
Remote resetting Allows resetting of the device.
Control Enables you to monitor the device.
You can control from the controller or with the wired
inputs/outputs of the speed driver.

282 EIO0000002092 04/2020

 ATS Progressive Starter Profile

DFB Representation

Representation
The following figure represents the functional module of ATS profile:

NOTE: The device can only work on serial Modbus mode.

NOTE: The underlined parameters are specific for some components.

EIO0000002092 04/2020 283

ATS Progressive Starter Profile

The table shows the parameters available for specific components:

Parameters Components
Modbus
MBATS22 MBATS48
Inputs EnableDevice – X
QuickStop – X
Outputs WarningCode (ATS22WARNING) X –
WarningCode (ATSWARNING) – X
Status (ATS22STATUS) X –
Status (ATSSTATUS) – X
IOMAP (ATS22IOMAP) X –
IOMAP (ATSIOMAP) – X
Current – X
CurrentL1 X –
CurrentL2 X –
CurrentL3 X –
Torque – X
ActivePower – X
ThermicStatus – X
CosPhi – X
Frequency X –
Voltage X –
TotalStarts X –
TotalRunTime X –
LastStartTime X –
LastStartMaxC X –
TripCurrent X –
Inputs/Outputs ATS22_ST X –
ATS_ST – X
ATS22_CFG – X
ATS_CFG – X
X: Parameter is available.
–: Parameter is not available.

284 EIO0000002092 04/2020

 ATS Progressive Starter Profile

Inputs

Input Parameter Description

Input Type Description

EnableDFB BOOL This input enables the normal execution of the control block.
 0 = The entire DFB is restarted (statuses, output values,
counters are lost) and output values are set to 0.
 1 = Enables communications with the devices for their operation.

Public variable values are loaded during the first enabling cycle.
EnableDevice * BOOL 1 = Valid if the EnableDFB variable is active.
The starter has to be enabled in order to be controlled.
* These parameters are available only with specific components.

If the device is reset and Run pin is active, then the device will auto start. If manual start of the
device is required, then reset the Run pin followed by device.

NOTICE
UNINTENDED EQUIPMENT OPERATION
Reset the Run variable before resuming operation.
Failure to follow these instructions can result in equipment damage.

Input Type Description

Run BOOL 1 = Starts the starter.
If the device is being enabled or reset, reset the inputs so that
unexpected starts do not occur. In these cases, first reset the input
to resume the operation.
ResetFail BOOL 1 = Resets the Fail output parameter to 0 or in case of inoperable
device, sends a reset command to the device if ControlCommand
is 1.
You can carry out communication resets when required. To carry
out an automatic reset, use the ResetMode public variable.

QuickStop* BOOL 1 = Stops the starter quickly with fast stop ramp. It is state-based.
If there is a QuickStop, the Run bit has to be reset to resume
operation.
ModbusAddress INT Device address within the Modbus network.
* These parameters are available only with specific components.

EIO0000002092 04/2020 285

ATS Progressive Starter Profile

Input Type Description

ControlCommand BOOL Indicates to the DFB whether the motor is being controlled locally or
from a source external to the DFB.
 0 = Performs only read operations to monitor the status of the
device and does not perform any control functions.
 1 = Performs read operations and performs control operations
not conflicting with control commands coming from an external
control source.
NOTE: This input does not configure the starter.
StatisticSelector INT Variable is used to obtain statistics for the Modbus network. This
data provides information for using the StatisticConnector pin
with the StatisticCounter DFB in General Purpose library for
communication.
The following table displays the StatisticSelector value:
Variable Description
value
1 Read statistics, client.
2 Write statistics, client.
*
These parameters are available only with specific components.

286 EIO0000002092 04/2020

 ATS Progressive Starter Profile

Outputs

Output Parameter Description

Output Type Description

Ready BOOL 1 = The device is enabled and free of detected errors. The
device is ready to carry out or carrying out any Run or Stop
command.
Fail BOOL 1 = A detected failure in the control block or in the device or a
communication interruption.To reset the Fail output pin, the
ResetFail input has to be activated. The last detected error
code is shown on FailCode.
NOTE: If a communication interruption occurs, the variables
being read from the device cease to be refreshed as a refresh
operation can no longer be carried out. The variables keep
their last value.
Warning BOOL 1 = An alarm has been activated for the device. It does not
affect the block operation and does not need to be reset.
This signal remains active until the cause of the alarm
disappears.
FailCode ARRAY [0..2] OF INT When Fail output is 1, it holds the code for the detected
error.
If Fail output is 0, it indicates the last detected error that
occurred.
The detected error source is specified by a 3-level structure.
Refer to the Diagnostic Information Management
(see page 302) section.
WarningCode* ATS22WARNING The WarningCode output is a data structure with information
on the alarm currently on the starter.
Name Type Description
Order BOOL 1 = An alarm is present on the device.
ForcedLocalMode BOOL 1 = A follow-up alarm. The device is not
responding to the control command (Run,
QuickStop, so on) within the time specified in
CommandCtrlWindow.
Device BOOL 1 = The device is forced locally. It is controlled
through the screw terminals.
*
These parameters are available only with specific components.

EIO0000002092 04/2020 287

ATS Progressive Starter Profile

Output Type Description

WarningCode* ATSWARNING Holds a data structure with information on the alarm currently
on the starter.
Name Type Description
Order BOOL 1 = A follow-up alarm. The device is not
responding to the control command (Run,
QuickStop, so on) within the time specified in
CommandCtrlWindow.
ForcedLocalMode BOOL 1 = The device is forced locally. It is controlled
through the screw terminal.
Device BOOL 1 = An alarm on the device (W 458.7).
Current BOOL 1 = A detected current limit alarm (W 459.11).
Torque BOOL 1 = A detected torque limit alarm (W 459.12).
Thermal BOOL 1 = A detected thermal limit alarm (W 459.7).
Running BOOL 1 = The starter is running.
ExtControlled BOOL 1 = The device is being controlled from an external source (for
example, from the console, from a push-button panel, or from
the monitoring system) to the system.
Provides information for programming.
NOTE: The ControlCommand signal, the Owner variable,
and the ForcedLocalMode status are used to activate this
signal. You cannot use this signal as a ControlCommand
input.
Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the maximum
time for resetting the detected failure.
When a device or communication reset is carried out with
ResetFail, the DFB tries to reset the detected failure within
the time period defined in CommandCtrlWindow.
If the detected failure is reset, the Fail and Reseting output
variables are reset (set to FALSE). On the other hand, if the
detected failure is not reset, the Reseting variable is set to
FALSE and the Fail variable remains TRUE. The
ResetFail is edge-based.
Refer to the Timing diagram below.
*
These parameters are available only with specific components.

288 EIO0000002092 04/2020

 ATS Progressive Starter Profile

Output Type Description

Status* ATS22STATUS The structure holds data containing the information that the
block extracts from the ETA variable (W256) of the starter.
The following table describes the status information:
Parameter Type Description
Ready BOOL 1 = The device is ready to start or stop
(W256.0).
Running BOOL  0 = The starter is not running (W256.1).
 1 = The starter is running (W256.1).

Trip BOOL 1 = A trip condition has occurred (W256.2).

Alarm BOOL 1 = An alarm is present on device (W256.3).
ForcedLocalMode BOOL 1 = The device is controlled by physical inputs
(W256.14).
Ramping BOOL 1 = The starter is accelerating or slowing down
(W256.15).
Info INT Numerical code with the information on
statuses and required actions.
Refer to the Info table below.
*
These parameters are available only with specific components.

EIO0000002092 04/2020 289

ATS Progressive Starter Profile

Output Type Description

Status* ATSSTATUS The structure holds data containing the information that the
block extracts from the status variable of the starter.
The following table describes the status information:
Parameter Type Description
ReadyToSwitchOn BOOL 1 = The DSP402 device is ready to switch on
(W458.0).
SwitchedOn BOOL 1 = The DSP402 device is switched on
(W458.1).
OperationEnabled BOOL 1 =DSP402 device operation is enabled
(W458.2).
Malfunction BOOL 1 = A detected failure on the device (W458.3).
VoltageEnabled BOOL 1 = Voltage at the device terminals (Not
W458.4).
QuickStop BOOL 1 = Quick stop is activated (Not W458.5).
SwitchOnDisabled BOOL 1 = DSP402 device switch-on is disabled
(W458.6).
Alarm BOOL 1 = An alarm is present on the device
(W458.7).
ForcedLocalMode BOOL 1 = Device controlled by physical inputs
(W458.9).
LocalMode BOOL 1 = Commands accepted through terminals for
writing and reading. Drivecom disabled
(W459.13 and W459.14).
ResetAuthorization BOOL 1 = Detected fault reset authorized (W459.0).
Running BOOL 1 = Motor running (W459.4).
Accelerating BOOL Start accelerating
1 = Active (W459.9).
Decelerating BOOL Start decelerating
1 = Active (W459.10).
State INT Numerical code corresponding to the state of
the starter.
Refer to the State table below.
Info INT Numerical code with the information on
statuses and required actions.
Refer to the Info table below.
* These parameters are available only with specific components.

290 EIO0000002092 04/2020

 ATS Progressive Starter Profile

Output Type Description

IOMap* ATS22IOMAP Holds a data structure that contains information on the state
of the starter inputs and outputs (W262 and W263).
The following table describes the IOMap:
Parameter Type Description
LI1 BOOL 1 = The state of the digital input LI1.
LI2 BOOL 1 = The state of the digital input LI2.
LI3 BOOL 1 = The state of the digital input LI3.
R1 BOOL 1 = The state of the digital output R1.
R2 BOOL 1 = The state of the digital output R2.

IOMap * ATSIOMAP Holds a data structure that contains information on the state
of the starter inputs and outputs.
The following table describes the IOMap:
Parameter Type Description
LIRUN BOOL 1 = The state of the digital input LIRUN.
LISTOP BOOL 1 = The state of the digital input LISTOP.
LI3 BOOL 1 = The state of the digital input LI3.
LI4 BOOL 1 = The state of the digital input LI4.
LO1 BOOL 1 = The state of the digital output LO1.
LO2 BOOL 1 = The state of the digital output LO2.
R1 BOOL 1 = The state of the digital output R1.
R2 BOOL 1 = The state of the digital output R2.
R3 BOOL 1 = The state of the digital output R3.
AO INT Range (0-10000). Shows the state of the
analog output.

Current L1* INT Present current on starter line 1 in amperes (W 257).

Current L2* INT Present current on starter line 2 in amperes (W 258).

Current L3* INT Present current on starter line 3 in amperes (W 259).

Current* REAL Motor current (A) (W 4062).

Torque* INT Current motor torque in % (W 4063).

ActivePower* INT Power currently consumed by the motor (W 4072).

ThermicStatus* INT Motor thermic status in % (W 4064).

CosPhi* REAL Current value of phi cosine (W4067).

* These parameters are available only with specific components.

EIO0000002092 04/2020 291

ATS Progressive Starter Profile

Output Type Description

Frequency* INT Voltage frequency in Hertz (W 279).

Voltage* INT Input voltage in volts (W 260).

TotalStarts* INT Number of times that the ATS 22 has started (W 274).

TotalRuntime* INT Total time (in hours) during which the ATS 22 has been
operating (W 273).

LastStartTime* INT Last starting time (W 275).

LastStartMaxC* INT Maximum detected current during last start (W 276).

TripCurrent* INT Current present when last tripping event occurred (W 280).
StatisticConnector STATISTICCONNECTOR Information data is used with Modbus communications to
obtain statistics on the Modbus network (requests carried out,
time between requests, so on).
This structure has been created to be used within
StatisticCounter DFB in General Purpose library for
communication.
Parameter Type Description
Start BOOL 1 = The operation has started.
EndOk BOOL 1 = The operation has ended correctly.
EndNOk BOOL 1 = The operation has ended with a detected
error.
PartialTime DINT Partial time.
* These parameters are available only with specific components.

Info
The following table describes the Info variable of MBATS22:

Variable value Description

2 Waiting for Ready.
11 Missing EnableDFB.
12 Communication interruption.
20 Remove local forcing needs to be 0.
21 Waiting Running.
22 Running.
23 Waiting stopped.
24 Stopped.
25 Remove ResetFail needs to be 0.

292 EIO0000002092 04/2020

 ATS Progressive Starter Profile

Variable value Description

30 In forced local mode.
31 Waiting ForcedLocalMode.
40 Remove Run needs to be 0.
81 Missing ResetFail. Inoperable starter.
82 Do starter reset.

The following table describes the Info variable of MBATS48:

Variable value Description

2 Waiting SwitchOnDisabled.
3 Waiting ReadyToSwitchOn.
4 Waiting SwitchOn.
5 Waiting OperationEnabled.
6 Waiting QuickStop active.
11 Missing EnableDFB.
12 Communication Interruption.
13 ETA value is 0.
14 Remove local forcing needs to be 0.
21 Missing EnableDevice.
23 Remove Run needs to be 0.
24 Remove ResetFail. Reset again.
51 Starter stopped.
53 Run.
56 Waiting starter running
57 Waiting starter stop.
61 Remove QuickStop needs to be 0.
62 QuickStop is activated.
81 Missing ResetFail. Inoperable starter.
82 Do starter reset.
99 Unexpected state.

EIO0000002092 04/2020 293

ATS Progressive Starter Profile

Timing diagram:

294 EIO0000002092 04/2020

 ATS Progressive Starter Profile

Inputs/Outputs

Input/Output Parameter Description

Name Type Description

ATS22_ST* ATS22_ST_DDT Device data structure holds the minimum information required for
(see page 295) performing control and monitoring.
The information is used by the operator screen and can be read from
or written to HMI/SCADA system.
ATS_ST* ATS_ST_DDT Device data structure holds the minimum information required for
(see page 296) performing control and monitoring functions.
Information used by the operator screen is usable from the HMI or
SCADA.
ATS22_CFG* ATS22_CFG_DDT Data structure with device information. Information used by the
(see page 297) operator screen is readable from HMI/SCADA system.

ATS_CFG* ATS_CFG_DDT Device data structure with device information. Information used by
(see page 296) the operator screen is readable from the HMI or SCADA system.
WorkMemory ANY_ARRAY_INT The array is used in Modbus communications.
This variable is meant for use with a Modbus port that serializes
Modbus requests in an optimum manner.
*
These parameters are available only with specific components.

ATS22_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit word is read-
(see page 297) only.

CFGW WORD Device control.

(see page 298) Enables to control the device from the monitoring subsystem or from the
operator screen if Owner (1), or only from the monitoring subsystem if
Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value for reading
from the HMI/SCADA system.
CurrentL1 REAL Current consumed by the starter through line 1.
CurrentL2 REAL Current consumed by the starter through line 2.
CurrentL3 REAL Current consumed by the starter through line 3.

EIO0000002092 04/2020 295

ATS Progressive Starter Profile

ATS_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit word is
(see page 298) read-only.

CFGW WORD Device control.

(see page 298) Provides the means to control the device from the monitoring subsystem
or from the operator screen if Owner (1), or only from the monitoring
subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value for reading
from the HMI/SCADA system.
Current REAL Active current (A).

ATS_CFG_DDT Type

Name Type Description

DataStatus WORD Information on the device status. Provides the information on the
(see page 299) Status output structure.
IOMap WORD Provides information on the state of the digital inputs/outputs of the
device. Information on the IOMap output structure.
Info INT Starter information. Its value is Info status.
State INT Starter status code information. Its value is State status.
Torque INT Active torque in %.
ThermicStatus INT Motor thermal capacity in %.
ActivePower INT Power consumed by the motor in %.
CosPhi REAL Current value of phi cosine.
AO INT Value of the analog output. Its value is in AO IOMAP.
WarningCode INT WarningCode register.
FailCode0 INT Code of last level 0 detected error. Indicates which detected error has
occurred, FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates which detected error has
occurred, FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates which detected error has
occurred, FailCode[2].

296 EIO0000002092 04/2020

 ATS Progressive Starter Profile

ATS22_CFG_DDT Type

Name Type Description

DataStatus WORD Provides the device status. Information on the Status
(see page 299) output structure.
IOMap WORD Provides information on the state of the digital
(see page 299) inputs/outputs of the device.
Info INT Provides device information.
WarningCode INT WarningCode register.
FailCode0 INT Code of last level 0 detected error.
FailCode1 INT Code of last level 1 detected error.
FailCode2 INT Code of last level 2 detected error.
Frequency INT Voltage frequency in Hertz (W 279).
Voltage INT Input voltage in volts (W 260).
TotalStarts INT Number of times that the ATS22 has started (W 274).
TotalRuntime INT Total time (in hours) during which the ATS22 has been
operating (W 273).
LastStartTime INT Total time that the last start lasted (W 275).
LastStartMaxC INT Maximum detected current during last start (W 276).
TripCurrent INT Current present when last tripping event occurred (W 280).

ATS22_ST.STW Word Structure

Bit Description
0 Unknown technological module status. No variable refreshing.
1 Not ready.
2 Device is running.
3 Inoperable device.
4 Alarm on the device (follow-up requires resetting).
5 Communication interruption.
6 Requires resetting. ResetFail is required.
7 Refer to the ExtControlled output pin (see page 287).
8 Refer to the Reseting output pin (see page 287).
9 Refer to the EnableDFB input pin (see page 285).

EIO0000002092 04/2020 297

ATS Progressive Starter Profile

ATS_ST.STW Word Structure

Bit Description
0 Unknown technological module status. No variable refreshing.
1 Not ready.
2 Device is running.
3 Inoperable device.
4 Alarm on the device or DFB (follow-up or screw terminal-based
control).
5 Communication interruption.
6 Requires resetting. ResetFail is required.
7 Refer to the ExtControlled output pin (see page 287).
8 Refer to the Reseting output pin (see page 287).
9 Refer to the EnableDFB input pin (see page 285).

ATS22_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 285).
1 Owner.
6 Refer to the Run input pin (see page 285).
7 Refer to the ControlCommand input pin (see page 285).

NOTE: The Owner bit enables to control the block from the ***_ST_DDT input/output structure
ignoring the input signals of the block. It enables control from a monitoring system (HMI, SCADA,
operator screen) in the Manual mode without using the programmed switching operation.

ATS_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 285).
1 Owner.
4 Refer to the QuickStop input pin (see page 285)
5 Refer to the EnableDevice input pin (see page 285).
6 Refer to the Run input pin (see page 285).
7 Refer to the ControlCommand input pin (see page 285).

298 EIO0000002092 04/2020

 ATS Progressive Starter Profile

ATS22_CFG.DataStatus Word Structure

Bit Description
0 Refer to the Ready status in the Status output pin (see page 287).
1 Refer to the Running status in the Status output pin (see page 287).
2 Refer to the Trip status in the Status output pin (see page 287).
3 Refer to the Alarm status in the Status output pin (see page 287).
14 Refer to the ForcedLocalMode status in the Status output pin (see page 287).
15 Refer to the Ramping status in the Status output pin (see page 287).

ATS_CFG.DataStatus Word Structure

Bit Description
0 Refer to the ReadyToSwitchOn status in the Status output pin (see page 287).
1 Refer to the SwitchedOn status in the Status output pin (see page 287).
2 Refer to the OperationEnabled status in the Status output pin (see page 287).
3 Refer to the Malfunction status in the Status output pin (see page 287).
4 Refer to the VoltageEnabled status in the Status output pin (see page 287).
5 Refer to the QuickStop status in the Status output pin (see page 287)
6 Refer to the SwitchOnDisabled status in the Status output pin (see page 287).
7 Refer to the Alarm status in the Status output pin (see page 287).
8 Refer to the ForcedLocalMode status in the Status output pin (see page 287).
9 Refer to the ResetAuthorization status in the Status output pin (see page 287).
10 Refer to the Running status in the Status output pin (see page 287).
11 Refer to the Accelerating status in the Status output pin (see page 287).
12 Refer to the Decelarating status in the Status output pin (see page 287).

ATS22_CFG.IOMap Word Structure

Bit Description
0 Refer to the LI1 output pin (see page 287).
1 Refer to the LI2 output pin (see page 287).
2 Refer to the LI3 output pin (see page 287).
3 Refer to the R1 output pin (see page 287).
4 Refer to the R2 output pin (see page 287).

EIO0000002092 04/2020 299

ATS Progressive Starter Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block waits for
the operations to be carried out by the device.
If a command has been sent and the command is not executed
within the time indicated by this variable, a follow-up alarm is sent.
The command that is controlled is Run. In the event of a
ResetFail, this is not interpreted as an alarm. Instead, the
detected failure continues, and you have to reset the Reseting
output.
Refresh TIME Refresh time for device data on Modbus communications.
NOTE: This refresh operation is carried out on read variables.
Write requests are carried out when needed.
ScanTime TIME Allows you to configure the time for which the alarm signals are kept
active.
Helps the monitoring subsystem to acquire the data for the alarms
that are automatically reset.
ResetMode BOOL Enables to configure the type of reset. This type of reset is used for
communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset needs to be carried out. The first reset is
carried out after the time defined in CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow * 2
elapses, so on. If the value of CommandCtrlWindow is 0 s, its value
is not used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
Value
FALSE Communications are/the device is reset with the ResetFail
variable.
TRUE Communications are/the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable is used to define the
maximum time that can elapse between 2 consecutive resets.
Refer to the Timing diagram below.

300 EIO0000002092 04/2020

 ATS Progressive Starter Profile

Timing diagram:

EIO0000002092 04/2020 301

ATS Progressive Starter Profile

Diagnostic Information Management

Overview
The diagnostic codes the device can return are read from the FailCode output variable.

Parameter Configuration Diagnostic Codes

This detected error indicates that a public variable parameter contains a value that is not allowed.
To reload new values, a rising edge is required on the EnableDFB input.
 FailCode[0]: 16#0003
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
The Failcode[0] variable can have the following codes:

Diagnostic Code Symbol Meaning

0 NOF No detected failure.
1 UCF Motor current below minimum limit.
2 OCF Motor current above maximum limit.
3 PHbd Phase imbalance.
4 Grdf Ground fault.
5 OLF Motor overload.
6 OtF Excessively high motor temperature.
7 OHF Excessively high motor temperature detected.
8 PIF Inverted phase fault.
9 PHF Phase or line fault, or inoperable motor.
10 USF No voltage or voltage too low.
11 OSF Voltage too high.
12 StF Excessive starting time.
13 Snbf Too many starts.
14 SSCr Connection or short-circuit fault in thyristor.
15 EtF External detected fault.
16 InF Internal detected fault.
17 SLF Modbus timeout.
18 trAP Trap code.
19 SCF Short-circuit.
20 bPF Fault detected on bypass contactor.
21 CFF Invalid configuration.

302 EIO0000002092 04/2020

 ATS Progressive Starter Profile

The inoperable device can be reset as long as ControlCommand is RUE. Otherwise, it can be
reset on the starter through the screw terminal with the appropriate parameter configuration.

Modbus Communications Diagnostic Codes

For Modbus communications, this code is used to indicate that communications have not been
established. This code can be reset.
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
After Modbus communications have been established, check Modbus client diagnostic codes for
FailCode [0] and FailCode [1]. The components make a distinction between read requests
problems and write requests problems:
 FailCode[2]: 16#0001 Read
 FailCode[2]: 16#0002 Write

Diagnostic Code Example

For a detected error, the code is:
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005

EIO0000002092 04/2020 303

ATS Progressive Starter Profile

304 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Variable Speed Drives
EIO0000002092 04/2020

Part VIII
Variable Speed Drives

Variable Speed Drives

Overview
This part provides the detailed description, pin layout, pin description, operator screen of the device
control blocks of the Variable Speed Drives family.
These function blocks do not reflect any specific installation.

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

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

EIO0000002092 04/2020 305

Variable Speed Drives

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
17 ATV Profile 307
18 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm 367
registers)
19 EMATVWarn1 - Extended Warnings of Process Drives (Supports 12 Alarm 405
registers)

306 EIO0000002092 04/2020

 Modicon Libraries General Purpose
ATV Profile
EIO0000002092 04/2020

Chapter 17
ATV Profile

ATV Profile

Overview
This chapter describes the DFBs of ATV profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 308
DFB Representation 309
Inputs 316
Outputs 332
Inputs/Outputs 354
Public Variables 361
Diagnostics Information Management 363

EIO0000002092 04/2020 307

ATV Profile

Description

General
The ATV profile is used to manage the Altivar variable speed drives on different communication
networks.

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

Function Description
Control Forward/reverse direction of rotation.
Speed Allows the speed set-point of the device to be sent.
Device status indication Displays the status of the device.
Remote resetting Allows resetting of the device.
Control or Monitoring Enables you to monitor the device.
You can control the command or set-point from the controller or through the wired
inputs/outputs of the speed drive. Also allows the command and set-point to be
controlled separately.
Owner Manages the control system which is the owner (Operator or Program). Therefore,
it is responsible for setting the control.
Torque Allows the drive to run based on Torque set point.

I/O Scanning Information

The below table explains the configuration for I/O scanning messaging.

Function Block Modbus ID Read Address Read Length Write Address Write Length
ATV7161 255 0 9 0 7
ATV6xx 255 0 12 0 5
ATV9xx 255 0 12 0 6
EATV32 255 0 7 0 5
ATV6xxx 255 0 14 0 6

DTM Profile Selection

To select a DTM profile:
 For ATV6xx, you have to select ATV6xx DFB as its DTM profile.
 For ATV9xx, you have to select ATV9xx DFB as its DTM profile.
 For ATV6xxx, you have to select ATV6xxx DFB as its DTM profile.

NOTE: ATV blocks are designed for DRIVECOM profile. In the Command and reference
parameter, CHCF (Channel configuration) is set to Combined channel mode as current value.

308 EIO0000002092 04/2020

 ATV Profile

DFB Representation

Representation
The following figure represents the function module of ATV profile:

EIO0000002092 04/2020 309

ATV Profile

NOTE:
 The underlined parameters are specific for some components.
 ATV blocks do not support corresponding device DTM for M340 controllers.

For DFBs communicating by I/O scanning, variables read from the device retain their last value
when a communication interruption occurs. For details, refer to the description of the
corresponding output parameter (see page 126).

WARNING
UNINTENDED EQUIPMENT OPERATION
When you configure the Last value parameter of the I/O scanner line, take into consideration
the behavior of the DFB when a communication interruption occurs.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

The table shows the parameters available for specific components:

Parameters Compo-
nents
Modbus Advantys Ethernet Profibus
STB
All All I/O scanning Mes- All
ATV7 EAT ATV9 ATV6x ATV6x saging
161 V32 xx x xx
Inputs DeviceAddress – – X – – – - X –
IOScannerStatus – – X X X X X – X
ModBusAddress X – – – – – - – –
CommunicationOK – X – – – – - – –
OutputsMap – – X X – – - – –
(ATVOUTPUTS)
OutputsMapExt – – X X – – - – –
(ATVOUTPUTSEXT)
OutputsMap – – – – – X - – –
(ATV6xxOUTPUTS)
OutputsMapExt – – – – – X – – –
(ATV6xxOUTPUTSEXT)
OutputsMap – – – – – – X – –
(ATV6xxxOUTPUTS)
X: Parameter is available.
–: Parameter is not available.

310 EIO0000002092 04/2020

 ATV Profile

Parameters Compo-
nents
Modbus Advantys Ethernet Profibus
STB
All All I/O scanning Mes- All
ATV7 EAT ATV9 ATV6x ATV6x saging
161 V32 xx x xx
OutputsMapExt – – – – – – X – –
(ATV6xxxOUTPUTSEXT)
OutputsMap – – – – X – – – –
(ATV9xxOUTPUTS)
OutputsMapExt – – – – X – – – –
(ATV9xxOUTPUTSEXT)
TorqueSetpoint – – – – X – X – –
AO1 – – X X – X - – –
AO2 – – X – – X - – –
AQ1 – – – – X – X – –
AQ2 – – – – X – X – –
StatisticSelector X – – – – – - X –
ExternalError – – – – X X X – –
C515 – – – – X X X – –
Inputs – X X X – – - – X
(ANY_ARRAY_INT)
Inputs – – – – – X – – –
(ATV6xx_IN_DDT)
Inputs – – – – – – X – –
(ATV6xxx_IN_DDT)
Inputs Inputs – – – – X – – – –
(ATV9xx_IN_DDT)
DTMInputs – – – X – – – – –
(ATV32_IN_NOCETH)
DTMInputs – – X – – – – – –
(ATV7161_IN_NOCETH)
DTMInputs – – – – – X – – –
(ATV6xxE_IN_NOCETH)
DTMInputs – – – – – – X – –
(ATV6xxxE_IN_
NOCETH)
X: Parameter is available.
–: Parameter is not available.

EIO0000002092 04/2020 311

ATV Profile

Parameters Compo-
nents
Modbus Advantys Ethernet Profibus
STB
All All I/O scanning Mes- All
ATV7 EAT ATV9 ATV6x ATV6x saging
161 V32 xx x xx
DTMInputs – – – – X – – – –
(ATV9xxE_IN_NOCETH)
Outputs WarningCode X X X X – – – X X
(ATVWARNING)
WarningCode – – – – – X – – –
(ATV6xxWARNING)
WarningCode – – – – – – X – –
(ATV6xxxWARNING)
WarningCode – – – – X – – – –
(ATV9xxWARNING)
CommunicationOK – – X – X X X – X
Status (ATVSTATUS) X X X X – – – X X
Status – – – – – X – – –
(ATV6xxSTATUS)
Status – – – – – – X – –
(ATV6xxxSTATUS)
Status – – – – X – – – –
(ATV9xxSTATUS)
CommandStatus – – – – – – X – –
InputsMap – – X X – – – – –
(ATVINPUTS)
InputsMapExt – – X X – – – – –
(ATVINPUTSEXT)
InputsMap – – – – – X – – –
(ATV6xxINPUTS)
InputsMap – – – – – – X – –
(ATV6xxxINPUTS)
InputsMapExt – – – – – X – – –
(ATV6xxINPUTSEXT)
InputsMapExt – – – – – – X – –
(ATV6xxxINPUTSEXT)
X: Parameter is available.
–: Parameter is not available.

312 EIO0000002092 04/2020

 ATV Profile

Parameters Compo-
nents
Modbus Advantys Ethernet Profibus
STB
All All I/O scanning Mes- All
ATV7 EAT ATV9 ATV6x ATV6x saging
161 V32 xx x xx
InputsMap – – – – X – – – –
(ATV9xxINPUTS)
InputsMapExt – – – – X – – – –
(ATV9xxINPUTSEXT)
Current – – X X X X X – –
Torque – – X X X X X – –
Outputs Power – – – – X X X – –
AI1 – – X – X X X – –
AI2 – – X – X X X – –
AI3 – – – – X X X – –
StatisticConnector X – – – – – – – –
Outputs – X X X – – – – X
(ANY_ARRAY_INT)
Outputs – – – – – X – – –
(ATV6xx_OUT_DDT)
Outputs – – – – – – X – –
(ATV6xxx_OUT_DDT)
Outputs – – – – X – – - –
(ATV9xx_OUT_DDT)
DTMOutputs – – – X – – – – –
(ATV32_OUT_NOCETH)
DTMOutputs – – X – – – – – –
(ATV7161_OUT_
NOCETH)
DTMOutputs – – – – – X – – –
(ATV6xxE_OUT_
NOCETH)
DTMOutputs – – – – – – X – –
(ATV6xxxE_OUT_
NOCETH)
X: Parameter is available.
–: Parameter is not available.

EIO0000002092 04/2020 313

ATV Profile

Parameters Compo-
nents
Modbus Advantys Ethernet Profibus
STB
All All I/O scanning Mes- All
ATV7 EAT ATV9 ATV6x ATV6x saging
161 V32 xx x xx
DTMOutputs – – – – X – – – –
(ATV9xxE_OUT_
NOCETH)
ATV_IO (ATV_IO_EXT) – – X X – – – – –
ATV_IOEXT – – X X – – – – –
(ATV_IOEXT_DDT)
ATV_IO – – – – – X – – –
(ATV6xx_IO_EXT)
ATV_IO – – – – – – X – –
(ATV6xxx_IO_EXT)
ATV_IOEXT – – – – – X – – –
(ATV6xx_IOEXT_DDT)
ATV_IOEXT – – – – – – X – –
(ATV6xx_IOEXT_DDT)
ATV_IO – – – – X – – – –
(ATV9xx_IO_DDT)
ATV_IOEXT – – – – X – – – –
(ATV9xx_IOEXT_DDT)
Inputs/ ATV_ST (ATV_ST_DDT) X X X X – – – X X
outputs
ATV_ST – – – – – X – – –
(ATV6xx_ST_DDT)
ATV_ST – – – – – – X – –
(ATV6xxx_ST_DDT)
ATV_ST – – – – X – – – –
(ATV9xx_ST_DDT)
ATV_CFG X X X X – – – X X
(ATV_CFG_DDT)
X: Parameter is available.
–: Parameter is not available.

314 EIO0000002092 04/2020

 ATV Profile

Parameters Compo-
nents
Modbus Advantys Ethernet Profibus
STB
All All I/O scanning Mes- All
ATV7 EAT ATV9 ATV6x ATV6x saging
161 V32 xx x xx
ATV_CFG – – – – – X – – –
(ATV6xx_CFG_DDT)
ATV_CFG – – – – – – X – –
(ATV6xxx_CFG_DDT)
ATV_CFG – – – – X – – – –
(ATV9xx_CFG_DDT)
Workmemory X – – – – – – X –
X: Parameter is available.
–: Parameter is not available.

EIO0000002092 04/2020 315

ATV Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control block.
 0 = The entire DFB is restarted (statuses, output values, counters are
lost) and output values are set to 0.
 1 = Enables communications with the devices for their operation.

Public variable values are loaded during the first enabling cycle.
EnableDevice BOOL 1 = Enables the devices if the EnableDFB variable is active.
The speed drive has to be enabled in order to be controlled.

If the device is reset and Run pin is active, then the device will auto start. If manual start of the
device is required, then reset the Run pin followed by device.

NOTICE
UNINTENDED EQUIPMENT OPERATION
Reset the Run variable before resuming operation.
Failure to follow these instructions can result in equipment damage.

NOTICE
UNINTENDED EQUIPMENT OPERATION
Configure the Torque setpoint through the drive.
Failure to follow these instructions can result in equipment damage.

316 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

Run BOOL 1 = Starts the motor run in the direction selected with the
Direction input variable.
Direction BOOL Direction of rotation of the motor.
 0 = Activates the reverse direction drive.
 1 = Activates the forward direction drive.

You cannot change the direction of rotation by changing the

sign in SetPoint input variable. SetPoint only accepts
positive values.
SetPoint REAL The speed set-point is requested from the speed drive and
only accepts positive values.
It is measured in engineering units and you can configure
these units with the following public variables:
 HighRangeRpm
 LowRangeRpm
 HighRangeEngUnit
 LowRangeEngUnit

NOTE: Verify that the unit is within the correct range.

The DFB makes the conversion between engineering units
and speed drive rpms.

TorqueSetPoint 5and 6 REAL The torque set-point is requested from the speed drive.
*: Parameters are available only for specific components.
1
: Parameter is available only for ATV7161.
2: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV9xx.
6
: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8: Parameter is available only for ATV6xx.

EIO0000002092 04/2020 317

ATV Profile

Parameter Type Description

ResetFail BOOL 1 = Resets the Fail output parameter to 0 or in case of
inoperable device, sends a reset command to the device if
ControlCommand is 1.
QuickStop BOOL 1 = Stops the speed drive quickly with fast stop ramp. If
there is a QuickStop, the Run bit has to be reset to
resume operation.
ExternalError6 BOOL Indicates the drive that a detected process failure has
occurred.
C5156 BOOL User configurable digital input. For additional information
refer to the respective ATV device user manual.
CommunicationOK* BOOL 1 = The node is present on the bus. You can find this
variable in Ethernet communications. For more
information, refer to the CommunicationOk
(see page 506) variable.

IOScannerStatus* BOOL 1 = The node is present on the bus.

You can find this variable in Ethernet communications.
ModbusAddress* INT Device address within the Modbus network.
You can find this variable in Modbus communications.
DeviceAddress7 STRING[26] Device address within the Ethernet network.
Depending on the platform, the following definitions apply:
Platform IP Addressing DeviceAddress (variable)
M340 ‘{IP}ID’
M580 ‘{IP}ID’
Quantum ‘{IP}ID’
NOTE: ID is 0.
*:
Parameters are available only for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV9xx.
6
: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7: Parameter is applicable only for Ethernet messaging.
8
: Parameter is available only for ATV6xx.

318 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

ControlCommand* BOOL Indicates to the DFB whether the motor is being controlled
locally or from a source external to the DFB.
 0 = Performs only read operations to monitor the status
of the device and does not perform any control
functions.
 1 = Performs read operations and performs control
operations not conflicting with control commands
coming from an external control source.
If the speed driver is an ATV 61/32/12/212/6xx/6xxx/9xx
unit and you need to use this input to switch between
sending the set-point through the network and sending it
through the screw terminal, you have to configure the
speed driver so that it works accordingly. Refer to the
Preparing the Device (see page 510) for more information
on how to set this configuration.
ControlSetpoint BOOL Indicates to the DFB whether the speed of the device is
being controlled by the DFB or from a source external to the
DFB.
 0 = Speed of the device is being controlled from an
external source.
 1 = Speed of the device is being controlled by the DFB.

If the speed driver is an ATV 61/32/12/212/6xx/6xxx/9xx

unit and you need to use this input to switch between
sending the set-point through the network and sending it
through the screw terminal, you have to configure the
speed driver so that it works accordingly. Refer to the
Preparing the Device (see page 510) for more information
on how to set this configuration.
*
: Parameters are available only for specific components.
1:
Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV9xx.
6
: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8: Parameter is available only for ATV6xx.

EIO0000002092 04/2020 319

ATV Profile

Parameter Type Description

ENGPARAM6 ATV6xxxENGPARAM ATV6xxx engineering parameters.
Parameter Type Description
CommandCtrlWindow TIME Time window for the device to execute orders.
ScanTime TIME Minimum time to maintain detected warning
signals.
MaxResetTime TIME Maximum time between two resets.
ScalingFactorCurrent REAL Define scaling factor for current depending on
drive rate.
HighRangeEngUnit REAL Maximum inverter speed measured in user units.
LowRangeEngUnit REAL Minimum inverter speed measured in user units.
HighRangeRpm INT Maximum inverter speed measured in rpm.
LowRangeRpm INT Minimum inverter speed measured in rpm.
ResetMode BOOL False = Manual reset
True = Automatic reset
OutputsMap* ATVOUTPUTSMAP Holds a data structure that is used to control the speed
driver outputs. The information is available on Ethernet
networks.
You can only control the outputs of the speed driver with
this input variable. You cannot control the outputs of the
speed driver from the HMI/SCADA system.
The following table describes the OutputsMap:
Parameter Type Description
R1 BOOL 1 = Controls the state of the R1 relay output
R2 BOOL 1 = Controls the state of the R2 relay output.
*:
Parameters are available only for specific components.
1:
Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV9xx.
6: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8
: Parameter is available only for ATV6xx.

320 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

OutputsMap* ATV6xxOUTPUTS/ATV9xxO Holds a data structure that is used to control the speed
UTPUTS/ATV6xxxOUTPUTS driver outputs.
You can only control the outputs of the speed driver with
this input variable. You cannot control the outputs of the
speed driver from the HMI/SCADA system.
The following table describes the Outputs Map:
Parameter Type Description
R1 BOOL 1 = Controls the state of the R1 relay output.
R2 BOOL 1 = Controls the state of the R2 relay output.
R3 BOOL 1 = Controls the state of the R3 relay output.

OutputsMapExt* ATVOUTPUTSMAPEXT Holds a data structure that is used to control the speed
driver outputs for ATV61 and ATV71 on Ethernet networks
and for ATV32 extended cards on Ethernet networks.
You can only control the outputs of the speed driver with
this input variable. You cannot control the outputs of the
speed driver from the HMI/SCADA system.
The following table describes the OutputsMapExt:
Output Type Description
R3 BOOL 1 = The state of the R3 relay output.
R4 BOOL 1 = The state of the R4 relay output.
LO1 BOOL 1 = The state of the LO1 digital output.
LO2 BOOL 1 = The state of the LO2 digital output.
LO3 BOOL 1 = The state of the LO3 digital output.
LO4 BOOL 1 = The state of the LO4 digital output.
*
: Parameters are available only for specific components.
1: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV9xx.
6
: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8: Parameter is available only for ATV6xx.

EIO0000002092 04/2020 321

ATV Profile

Parameter Type Description

OutputsMapExt* ATV6xxOUTPUTSEXT/ Holds a data structure that is used to control the speed
ATV9xxOUTPUTSEXT/ driver outputs.
ATV6xxxOUTPUTSEXT You can only control the outputs of the speed driver with
this input variable. You cannot control the outputs of the
speed driver from the HMI/SCADA system.
The following table describes the OutputsMapExt:
Parameter Type Description
R4 BOOL 1 = Controls the state of the R4 relay output.
R5 BOOL 1 = Controls the state of the R5 relay output.
R6 BOOL 1 = Controls the state of the R6 relay output.

DQ16 BOOL 1 = Controls the state of the digital output DQ1.

DQ11 BOOL 1 = Controls the state of the digital output DQ11.
DQ12 BOOL 1 = Controls the state of the digital output DQ12.
AO1* INT Controls the value of the AO1 analog output. You can find
this value on devices on Ethernet networks. You can only
control the analog output of the speed driver with this input
variable. You cannot control the analog output of the speed
from the HMI/SCADA system.
AO2* INT Controls the value of the AO2 analog output. This value can
be found on ATV61 and ATV71 on Ethernet networks. You
can only control the analog output of the speed driver with
this input variable. You cannot control the analog output of
the speed from the HMI/SCADA system.
AQ15, 6,8 INT Controls the value of the AQ1 analog output. The speed
driver analog output can only be controlled with this input
variable; it cannot be controlled from the HMI/SCADA
system..
*:
Parameters are available only for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV9xx.
6
: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8
: Parameter is available only for ATV6xx.

322 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

AQ25, 6,8 INT Controls the value of the AQ2 analog output. The speed
driver analog output can only be controlled with this input
variable; it cannot be controlled from the HMI/SCADA
system..
StatisticSelector* INT Variable is used to obtain statistics for the Modbus network
(requests carried out, time between requests, so on). This
data provides information for using
StatisticConnector pin within the
StatisticCounter DFB in General Purpose library for
communication.
The following table displays the StatisticSelector
value:
Variable value Description
1 Read statistics, client.
2 Write statistics, client.
*
: Parameters are available only for specific components.
1:
Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3:
Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV9xx.
6:
Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8: Parameter is available only for ATV6xx.

EIO0000002092 04/2020 323

ATV Profile

Parameter Type Description

Inputs1 ANY_ARRAY_INT Holds an array structure with the data obtained from the
device. You can control the speed driver with this input
variable. This input is reserved for the DFB, and you cannot
use this input directly. To make the control block to work
properly, allocate the structure (%MWx). Refer to the
Communications Technologies (see page 503).
The Inputs pin should not be connected when
DTMInputs pin is connected, otherwise the function
detects an incorrect configuration.
The information available for the ATV61 and ATV71 on
Ethernet is shown in the following table:
Parameter Type Description
Inputs [0] INT Status word (ETA).
Inputs [1] INT Output velocity (RFRD).
Inputs [2] INT CIA402 diagnostic code (ERRD).
Inputs [3] INT Motor current (LCR).
Inputs [4] INT Motor torque (OTR).
Inputs [5] INT Logic input states (IL1R).
Inputs [6] INT Analog input 1 (AI1C).
Inputs [7] INT Analog input 2 (AI2C).
*: Parameters are available only for specific components.
1:
Parameter is available only for ATV7161.
2:
Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4:
Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV9xx.
6: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8: Parameter is available only for ATV6xx.

324 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

Inputs2 ANY_ARRAY_INT Holds an array structure with the data obtained from the
device. You can control the speed driver with this input
variable. This input is reserved for the DFB, and you cannot
use this input directly. To make the control block to work
properly, allocate the structure (%MWx). Refer to the
Communications Technologies (see page 503).
The Inputs pin should not be connected when
DTMInputs pin is connected, otherwise the function
detects an incorrect configuration.
The information available for the ATV32 on Ethernet is
shown in the following table:
Parameter Type Description
Inputs [0] INT Status word (ETA).
Inputs [1] INT Output velocity (RFRD).
Inputs [2] INT CIA402 diagnostic code (ERRD).
Inputs [3] INT Motor current (LCR).
Inputs [4] INT Motor torque (OTR).
Inputs [5] INT Logic input states (IL1R).

Inputs3 ANY_ARRAY_INT Holds an array structure with the data obtained from the
device. You can control the speed driver with this input
variable. This input variable is reserved for the DFB, and
you cannot use this variable directly. To make the control
block to work properly, allocate the structure (%MWx). Refer
to the Communications Technologies (see page 503).
The information available for speed drivers on an Advantys
STB is shown in the following table:
Parameter Type Description
Inputs [0] INT Status word (ETA).
Inputs [1] INT Control effort (rpm).

Inputs4 ARRAY [0..27] OF BYTE Holds a structure with the data obtained from the inverter.

*: Parameters are available only for specific components.

1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV9xx.
6
: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7: Parameter is applicable only for Ethernet messaging.
8
: Parameter is available only for ATV6xx.

EIO0000002092 04/2020 325

ATV Profile

Parameter Type Description

Inputs5,8 ARRAY [0..11] OF INT Holds an array structure with the data obtained from the
device. You can control the speed driver with this input
variable. This input is reserved for the DFB, and you cannot
use this input directly. To make the control block to work
properly, allocate the structure (%MWx).
The Inputs pin should not be connected when
DTMInputs pin is connected, otherwise the function
detects an incorrect configuration.
The information available for the ATV6xx/ATV9xx on
Ethernet is shown in the following table:
Parameter Type Description
Inputs [0] INT Status word (ETA).
Inputs [1] INT Output Velocity (RFRD).
Inputs [2] INT CiA402 diagnostic code (ERRD).
Inputs [3] INT Motor current (LCR).
Inputs [4] INT Motor torque (OTR).
Inputs [5] INT Logic input states (IL1R).
Inputs [6] INT Analog input 1 (AI1C).
Inputs [7] INT Analog input 2 (AI2C).
Inputs [8] INT Analog input 3 (AI3C).
Inputs [9] INT Active command channel (CCC).
Inputs [10] INT Active reference channel (CRC).
Inputs [11] INT Active electrical output power estimation (EPRW).
*:
Parameters are available only for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3: Parameter is available only for ASATV31 and ASATV7161.
4: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV9xx.
6
: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8
: Parameter is available only for ATV6xx.

326 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

Inputs6 ARRAY [0..13] OF INT Holds an array structure with the data obtained from the
device. You can control the speed driver with this input
variable. This input is reserved for the DFB, and you cannot
use this input directly. To make the control block to work
properly, allocate the structure (%MWx).
The Inputs pin should not be connected when
DTMInputs pin is connected, otherwise the function
detects an incorrect configuration.
The information available for the ATV6xxx on Ethernet is
shown in the following table:
Parameter Type Description
Inputs [0] INT Status word (ETA).
Inputs [1] INT Output Velocity (RFRD).
Inputs [2] INT CiA402 diagnostic code (ERRD).
Inputs [3] INT Motor current (LCR).
Inputs [4] INT Motor torque (OTR).
Inputs [5] INT Logic input states (IL1R).
Inputs [6] INT Analog input 1 (AI1C).
Inputs [7] INT Analog input 2 (AI2C).
Inputs [8] INT Analog input 3 (AI3C).
Inputs [9] INT Active command channel (CCC).
Inputs [10] INT Active reference channel (CRC).
Inputs [11] INT Active electrical output power estimation (EPRW).
Inputs [12] INT Mains and Inrush circuit breaker word status
(BWS0).
Inputs [13] INT Drive command status (CMDS)
*
: Parameters are available only for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV9xx.
6: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8: Parameter is available only for ATV6xx.

EIO0000002092 04/2020 327

ATV Profile

Parameter Type Description

DTMInputs1 ATV7161_IN_NOCETH Holds an input structure for the data to be obtained from
device DTM. You can read device monitoring information
with this input variables. This input pin has to be used with
the device DTM.
The DTMInputs pin should not be connected when Inputs
pin is connected, otherwise the function detects an
incorrect configuration
The information available for the ATV7161_IN_NOCETH on
Ethernet is shown in the following table:
Parameter Type Description
RESERVED UINT Reserved.
ETA UINT Status word.
RFRD INT Output velocity.
ERRD UINT CIA402 diagnostic code.
LCR INT Motor current.
OTR INT Motor torque.
IL1R INT Logic input states.
AI1C INT Analog input 1.
AI2C INT Analog input 2.
*: Parameters are available only for specific components.
1
: Parameter is available only for ATV7161.
2: Parameter is available only for EATV32.
3:
Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV9xx.
6
: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7:
Parameter is applicable only for Ethernet messaging.
8
: Parameter is available only for ATV6xx.

328 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

DTMInputs2 ATV32_IN_NOCETH Holds an input structure for the data to be obtained from
device DTM. You can read device monitoring information
with this input variables. This input pin has to be used with
the device DTM.
The DTMInputs pin should not be connected when Inputs
pin is connected, otherwise the function detects an
incorrect configuration
The information available for the ATV32_IN_NOCETH on
Ethernet is shown in the following table:
Parameter Type Description
ETA UINT Status word.
RFRD INT Output velocity.
ERRD UINT CIA402 diagnostic code.
LCR UINT Motor current.
OTR INT Motor torque.
IL1R UINT Logic input states.
*: Parameters are available only for specific components.
1:
Parameter is available only for ATV7161.
2: Parameter is available only for EATV32.
3:
Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV9xx.
6: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7:
Parameter is applicable only for Ethernet messaging.
8
: Parameter is available only for ATV6xx.

EIO0000002092 04/2020 329

ATV Profile

Parameter Type Description

DTMInputs5,8 ATV6XXE_IN_NOCETH/ Holds an input structure for the data to be obtained from
ATV9XXE_IN_NOCETH device DTM. You can read device monitoring information
with this input variables. This input pin has to be used with
the device DTM.
The DTMInputs pin should not be connected when Inputs
pin is connected, otherwise the function detects an
incorrect configuration
The information available for the
ATV6XXE_IN_NOCETH/ATV9XXE_IN_NOCETH on
Ethernet is shown in the following table:
Parameter Type Description
ETA WORD Status word.
RFRD INT Output Velocity.
ERRD WORD CIA402 diagnostic code.
LCR UINT Motor current.
OTR INT Motor torque.
IL1R WORD Logic input states.
AI1C INT Analog input 1.
AI2C INT Analog input 2.
AI3C INT Analog input 3.
CCC WORD Active command channel.
CRC WORD Active reference channel.
EPRW INT Active electrical output power estimation.
*
: Parameters are available only for specific components.
1: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3:
Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV9xx.
6: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8: Parameter is available only for ATV6xx.

330 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

DTMInputs6 ATV6xxxE_IN_NOCETH Holds an input structure for the data to be obtained from
device DTM. You can read device monitoring information
with this input variables. This input pin has to be used with
the device DTM.
The DTMInputs pin should not be connected when Inputs
pin is connected, otherwise the function detects an
incorrect configuration
The information available for the ATV6xxxE_IN_NOCETH
on Ethernet is shown in the following table:
Parameter Type Description
ETA WORD Status word.
RFRD INT Output Velocity.
ERRD WORD CIA402 diagnostic code.
LCR UINT Motor current.
OTR INT Motor torque.
IL1R WORD Logic input states.
AI1C INT Analog input 1.
AI2C INT Analog input 2.
AI3C INT Analog input 3.
CCC WORD Active command channel.
CRC WORD Active reference channel.
EPRW INT Active electrical output power estimation.
BWS0 WORD Mains and Inrush circuit breaker word status.
CMDS INT Drive command status
*
: Parameters are available only for specific components.
1: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV9xx.
6: Parameter is available only for ATV6xx, ATV9xx and ATV6xxx.
7
: Parameter is applicable only for Ethernet messaging.
8
: Parameter is available only for ATV6xx.

NOTE: For DTM configuration (see page 534).

EIO0000002092 04/2020 331

ATV Profile

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL 1 = The device is enabled and free of detected errors.
The device is ready to carry out or carrying out any
Run or Stop command.
If QuickStop is enabled, this output resets to 0. This
variable is TRUE as long as there are no
communication interruption and the device is in
DSP402 state 5.
Fail BOOL 1 = A detected failure in the control block or in the
device or a communication interruption. To reset the
Fail output pin, the ResetFail input has to be
activated. The last detected error code is shown on
FailCode.
NOTE: If a communication interruption occurs, the
variables being read from the device cease to be
refreshed as a refresh operation can no longer be
carried out. The variables keep their last value.
Warning BOOL 1 = An alarm has been activated for the device. It
cannot be reset because the signal remains active
until the cause of the alarm is removed or until the
maximum set ScanTime is reached.
FailCode ARRAY [0..2] OF INT When the Fail output is 1, it holds the code for the
detected error.
If the Fail bit is 0, it indicates the last detected error
that occurred. The detected error source is specified
by using a 3 level structure. Refer to the Diagnostic
Information Management (see page 363) for more
details.
*
: Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

332 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

WarningCode* ATVWARNING Holds a data structure with the alarm information
currently on the speed driver.
The following table describes the WarningCode:
Parameter Type Description
Device BOOL 1 = An alarm present on the device.
Order BOOL 1 = An alarm. The device is not responding to
the control command (Run, QuickStop)
within the time specified in
CommandCtrlWindow.
ForcedLocalMode BOOL 1 = The device is forced locally. It is controlled
through the screw terminals.

WarningCode5,6 ATV6xxWARNING/ Holds a data structure with the alarm information

ATV6xxxWARNING/ currently on the speed driver.
ATV9xxWARNING The following table describes the WarningCode:

Parameter Type Description

Device BOOL 1 = An alarm is present on the device.
Order BOOL 1 = Follow-up alarm. The device is not
responding to the control command (Run,
QuickStop, so on) within the time specified in
CommandCtrlWindow.
ForcedLocalMode BOOL 1 = The device is forced locally. It is controlled
through the screw terminals.
ReservedReferenceChannel BOOL 1 = The drive reference channel is reserved by
DTM (Control Expert, SoMove) or WEB server.
ReservedCommandChannel BOOL 1 = The drive command channel is reserved by
DTM (Control Expert, SoMove) or WEB server.
Running BOOL 1 = The speed driver is running and has an output
frequency.
NOTE: If SetPoint is 0 and Run is active, the
Running signal is activated.
*
: Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7: Parameter is available only for MBATV212.

EIO0000002092 04/2020 333

ATV Profile

Parameter Type Description

ExtControlled BOOL 1 = The device is being controlled from an external
source (for example, from the console, from a push-
button panel, or from the monitoring system) to the
system.
Provides information for programming.
NOTE: The ControlCommand signal, the Owner
variable, and the ForcedLocalMode status are used
to activate this signal. You cannot use this signal as a
ControlCommand input.
Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the
maximum time for resetting the detected failure.
When a device or communication reset is carried out
with ResetFail, the DFB tries to reset the detected
failure within the time period defined in
CommandCtrlWindow.
If the detected failure is reset, the Fail and
Reseting output variables are reset (set to FALSE).
If the detected failure is not reset, the Reseting
variable is set to FALSE and the Fail variable
remains TRUE. The ResetFail is edge-based.
Refer to the timing diagram below.

*
: Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

334 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

CommunicationOk* BOOL 1 = Communication ok for the device present in the I/O
scanner.
MVCBReadyToClose6 BOOL Medium voltage circuit breaker ready to close.

Status* ATVSTATUS The structure holds data containing the information

that the block extracts from the status variable of the
speed driver.
The following table describes the status information:
Parameter Type Description
ReadyToSwitchOn BOOL 1 = The device is ready to switch on
(DRIVECOM [ETA.0]).
SwitchedOn BOOL 1 = The device is switched on (ETA.1).
OperationEnabled BOOL 1 = Operation is enabled (ETA.2).
Malfunction BOOL 1 = A detected failure on the device (ETA.3).
VoltageEnabled BOOL 1 = Voltage on the device terminals (ETA.4).
QuickStop BOOL 1 = Quick stop is activated (ETA.5).
SwitchOnDisabled BOOL 1 = Switch-on is disabled (ETA.6).
Alarm BOOL 1 = An alarm is present on the device (ETA.7).
ForcedLocalMode BOOL 1 = Forced local mode (ETA.9).
ReferenceReached BOOL 1 = The speed set-point has been reached
(ETA.10).
ReferenceExceeded BOOL 1 = The speed set-point has exceeded limits
(ETA.11).
StopImposed BOOL 1 = Stop is forced by remote control STOP key
(ETA.14).
ForwardReverseRotation BOOL  0 = Reverse running direction (ETA.15).
 1 = Forward running direction (ETA.15).
*
: Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3: Parameter is available only for ASATV31 and ASATV7161.
4: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

EIO0000002092 04/2020 335

ATV Profile

Parameter Type Description

 State INT Numerical code corresponding to the state of
the speed driver.
Refer to the State (see page 348) table
below.
Info INT Numerical code with the information on
statuses and required actions.
Refer to the Info (see page 349) table below.

Status7 MBATV212STATUS The structure holds data containing the information

that the function block extracts from the status variable
of the speed driver. The following table describes the
status information:
Parameter Type Description

OutputFailure 7 BOOL  1 = The device is active (ETA.0).

 0 = The device is not active (ETA.0).

Tripped7 BOOL 1 = The device is tripped (ETA.1).

Alarm7 BOOL 1 = An alarm is present on the device (ETA.2)

(see page 365).
MOFF7 BOOL 1 = Main circuit undervoltage alarm is issued
(ETA.3).

MotorSelectionTHR7 BOOL  1 = Motor 2 (THR2) is selected (ETA.4).

 0 = Motor 1 (THR1) is selected (ETA.4).

PIControl7 BOOL 1 = PI control is prohibited (ETA.5)

AccelerationPattern7 BOOL  1 = Acceleration/deceleration pattern 2

(AD2) is selected (ETA.6).
 0 = Acceleration/deceleration pattern 1
(AD1) is selected (ETA.6).

DCBraking7 BOOL 1 = Forced DC braking (ETA.7).

ForwardReverseRotation7 BOOL  1 = Reverse running direction (ETA.9).

 0 = Forward running direction (ETA.9).
*
: Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

336 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

 Run7 BOOL 1 = Device is running (ETA.10).

CoastStop7 BOOL 1 = ST is off (ETA.11).

EmergencyStop7 BOOL 1 = Emergency stop status (ETA.12).

StandbyST7 BOOL 1 = The device is standby ST mode (ETA.13).

Standby7 BOOL 1 = The device is standby mode (ETA.14).

LocalRemote7 BOOL  1 = The device is in local mode (ETA.15).

 0 = The device is in remote mode
(ETA.15).

Status5,6 ATV6xxSTATUS/ATV9xxSTATUS/ The structure holds data containing the information

ATV6xxxSTATUS that the function block extracts from the status variable
of the speed driver.
The following table describes the status information:
Parameter Type Description
ReadyToSwitchOn BOOL 1 = The device is ready to switch on
(DRIVECOM [ETA.0]).
SwitchedOn BOOL 1 = The device is switched on (ETA.1).
OperationEnabled BOOL 1 = Operation is enabled (ETA.2).
Malfunction BOOL 1 = A detected failure on the device (ETA.3).
VoltageEnabled BOOL 1 = Voltage on the device terminals (ETA.4).
QuickStop BOOL 1 = Quick stop is activated (ETA.5).
SwitchOnDisabled BOOL 1 = Switch-on is disabled (ETA.6).
Alarm BOOL 1 = An alarm is present on the device (ETA.7).
ForcedLocalMode BOOL 1 = Forced local mode (ETA.9).
ReferenceReached BOOL 1 = The speed set-point has been reached
(ETA.10).
ReferenceExceeded BOOL 1 = The speed set-point has exceeded limits
(ETA.11).
*
: Parameters are available for specific components.
1: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV6xx.
6: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

EIO0000002092 04/2020 337

ATV Profile

Parameter Type Description

StopImposed BOOL 1 = Stop is forced by remote control STOP key
(ETA.14).
ForwardReverseRotation BOOL  1 = Forward running direction (ETA.15).
 0 = Reverse running direction (ETA.15).

NOTE:
 Drive is in ready state, default forward
status will be active.
 Drive is in run state, status gets updated as
per direction selection.
ReservedReferenceChannel BOOL 1 = The drive reference channel is reserved by
DTM (Control Expert, SoMove) or WEB server
(W8441.15) CRC.
ReservedCommandChannel BOOL 1 = The drive command channel is reserved by
DTM (Control Expert, SoMove) or WEB server
(W8442.15) CCC.
State INT Numerical code corresponding to the state of
the speed driver.
Refer to the State (see page 348) table.
Info INT Numerical code with the information on
statuses and required actions.
Refer to the Info (see page 349) table.

CommandStatus6 INT Indicate to controller program, from which source

speed driver command is controlled.
 0 - No command selected
 1 - Remote command selected
 2 - Local command selected
 3 - Panel command selected
*:
Parameters are available for specific components.
1: Parameter is available only for ATV7161.
2: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7: Parameter is available only for MBATV212.

338 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

InputsMap* ATVINPUTS Holds a data structure with the information on the state
of the inputs of the speed driver. The information is
available on Ethernet networks.
The following table describes the InputsMap:
Input Type Description
L1 BOOL 1 = The state of the digital input L1.
L2 BOOL 1 = The state of the digital input L2.
L3 BOOL 1 = The state of the digital input L3.
L4 BOOL 1 = The state of the digital input L4.
L5 BOOL 1 = The state of the digital input L5.
L6 BOOL 1 = The state of the digital input L6.

InputsMap* ATV6xxINPUTS/ATV9xxINPUTS/ Holds a data structure with the information on the state
ATV6xxxINPUTS of the inputs of the speed driver.
The following table describes the InputsMap:
Parameter Type Description
DI1 BOOL 1 = State of the digital input DI1.
DI2 BOOL 1 = State of the digital input DI2.
DI3 BOOL 1 = State of the digital input DI3.
DI4 BOOL 1 = State of the digital input DI4.
DI5 BOOL 1 = State of the digital input DI5.
DI6 BOOL 1 = State of the digital input DI6.

DI76 BOOL 1 = State of the digital input DI7.

DI86 BOOL 1 = State of the digital input DI8.

*
: Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

EIO0000002092 04/2020 339

ATV Profile

Parameter Type Description

InputsMapExt* ATVINPUTSEXT Holds a data structure with the information on the state
of the inputs of the speed driver for ATV61 and ATV71
extended cards on Ethernet networks.
The following table describes the InputsMapExt:
Input Type Description
L7 BOOL 1 = The state of the digital input L7.
L8 BOOL 1 = The state of the digital input L8.
L9 BOOL 1 = The state of the digital input L9.
L10 BOOL 1 = The state of the digital input L10.
L11 BOOL 1 = The state of the digital input L11.
L12 BOOL 1 = The state of the digital input L12.
L13 BOOL 1 = The state of the digital input L13.
L14 BOOL 1 = The state of the digital input L14.

InputsMapExt5,6 ATV6xxINPUTSEXT/ Holds a data structure with the information on the state
ATV9xxINPUTSEXT/ of the inputs of the speed driver.
ATV6xxxINPUTSEXT The following table describes the InputsMapExt:

Parameter Type Description

DI7 5 BOOL 1 = State of the digital input DI7.

DI85 BOOL 1 = State of the digital input DI8.

DI11 BOOL 1 = State of the digital input DI11.

DI12 BOOL 1 = State of the digital input DI12.
DI13 BOOL 1 = State of the digital input DI13.
DI14 BOOL 1 = State of the digital input DI14.
DI15 BOOL 1 = State of the digital input DI15.
DI16 BOOL 1 = State of the digital input DI16.
PresentValue REAL Current speed of rotation in engineering units (EU).
*
: Parameters are available for specific components.
1: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV6xx.
6: Parameter is available only for ATV9xx and ATV6xxx.
7: Parameter is available only for MBATV212.

340 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

PresentSpeed REAL Current motor speed in rpm (rotation per minute).

Current * REAL Present motor current in percentage (%). You can find
this value on speed drives on ATV61 and ATV71 units
on Ethernet networks and on speed drivers on ATV32
unit on Ethernet networks..
Torque* REAL Current motor torque in 0.1 A increment. You can find
this value on ATV61 and ATV71 on Ethernet networks
and on ATV32 unit on Ethernet networks..

Power* REAL Actual drive electrical power in kW. (Resolution is

0.00).
AI1* INT The value of the AI1 analog device input. You can find
this value on devices ATV61 and ATV71 units on
Ethernet networks.
AI2* INT The value of the AI2 analog device input. You can find
this value on ATV61 and ATV71 on Ethernet networks.

AI3* INT The value of the AI3 analog device input.

ATV_IO * ATV_IO_DDT (see page 350) Device data structure holds the information for
performing monitoring functions. The information used
by the operator screen is readable from HMI or
SCADA system.
ATV_IOEXT* ATV_IOEXT_DDT (see page 350) Device data structure holds the information for
performing monitoring functions. The information used
by the operator screen is readable from HMI or
SCADA system.
ATV_IO5,6 ATV6xx_IO_DDT Device data structure holds the information for
(see page 350)/ATV9xx_IO_DDT performing monitoring functions. The information used
(see page 350)/ATV6xxx_IO_ by the operator screen is readable from HMI or
DDT (see page 350) SCADA system.

*: Parameters are available for specific components.

1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

EIO0000002092 04/2020 341

ATV Profile

Parameter Type Description

ATV_IOEXT5,6 ATV6xx_IOEXT_DDT Device data structure holds the information for
(see page 351)/ATV9xx_IOEXT_ performing monitoring functions. The information used
DDT (see page 351)/ATV6xxx_ by the operator screen is readable from HMI or
IOEXT_DDT (see page 351) SCADA system.

Outputs1 ANY_ARRAY_INT Holds an array structure with data sent to the device.
You can control the speed driver with this output
variable. This variable is reserved for the DFB, and
you cannot use this variable directly. To make the
control block work properly, allocate the structure
(%MWx). Refer to the Communications Technologies
(see page 503).
The following table describes the ANY_ARRAY_INT
information available for EATV61 and EATV71 units on
Ethernet networks:
Parameter Type Description
Outputs [0] INT Control word (CMD).
Outputs [1] INT Speed set-point (LFRD).
Outputs [2] INT Logic output states (OL1R).
Outputs [3] INT Analog output 1 physical value (AO1C).
Outputs [4] INT Analog output 2 physical value (AO2C).
Outputs [5] INT Analog output 3 physical value (AO3C).
*:
Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2:
Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7: Parameter is available only for MBATV212.

342 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

Outputs2 ANY_ARRAY_INT Holds an array structure with data sent to the device.
You can control the speed driver with this output
variable. This variable is reserved for the DFB, and
you cannot use this variable directly. To make the
control block work properly, allocate the structure
(%MWx). Refer to the Communications Technologies
(see page 503).
The following table describes the ANY_ARRAY_INT
information available for ATV32E on Ethernet
networks:
Parameter Type Description
Outputs [0] INT Control word (CMD).
Outputs [1] INT Speed set-point (LFRD).
Outputs [2] INT Logic output states (OL1R).
Outputs [3] INT Analog output 1physical value (AO1C).

Outputs 3 ANY_ARRAY_INT Holds an array structure with data sent to the device.
You can control the speed driver with this output
variable. This variable is reserved for the DFB, and
you cannot use this variable directly. To make the
control block work properly, allocate the structure
(%MWx). Refer to the Communication Technologies
(see page 503).
The information available for speed drivers on an
Advantys STB is shown in the following table:
Parameter Type Description
Outputs [0] INT Control word (CWD).
Outputs [1] INT Speed set-point.
Outputs4 ARRAY [0..27] OF BYTE Holds an array structure with data sent to the inverter.
(Reserved for DFB usage).
*
: Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

EIO0000002092 04/2020 343

ATV Profile

Parameter Type Description

Outputs5 ARRAY [0..4] OF INT Holds an array structure with data sent to the device.
You can control the speed driver with this output
variable. This variable is reserved for the DFB, and
you cannot use this variable directly. To make the
control block work properly, allocate the structure
(%MWx).
The following table describes the ATV6xx_OUT_DDT
information available for ATV6xx on Ethernet
networks:
Parameter Type Description
Outputs [0] INT Control word (CMD).
Outputs [1] INT Speed set-point (LFRD).
Outputs [2] INT Logic output states (OL1R).
Outputs [3] INT Analog output 1 physical value (AO1C).
Outputs [4] INT Analog output 2 physical value (AO2C).
*: Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2:
Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5:
Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7:
Parameter is available only for MBATV212.

344 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

Outputs6 ARRAY [0..5] OF INT Holds an array structure with data sent to the device.
You can control the speed driver with this output
variable. This variable is reserved for the DFB, and
you cannot use this variable directly. To make the
control block work properly, allocate the structure
(%MWx).
The following table describes
theATV9xx_OUT_DDT/ATV6xxx_OUT_DDT
information available for ATV9xx/ATV6xxx on
Ethernet networks:
Parameter Type Description
Outputs [0] INT Control word (CMD).
Outputs [1] INT Speed set-point (LFRD).
Outputs [2] INT Torque set-point (LTR).
Outputs [3] INT Logic output states (OL1R).
Outputs [4] INT Analog output 1 physical value (AO1C).
Outputs [5] INT Analog output 2 physical value (AO2C).
*:
Parameters are available for specific components.
1:
Parameter is available only for ATV7161.
2:
Parameter is available only for EATV32.
3:
Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7:
Parameter is available only for MBATV212.

EIO0000002092 04/2020 345

ATV Profile

Parameter Type Description

DTMOutputs1 ATV7161E_OUT_NOCETH Holds an output structure for the data to be written
from controller to the device via Device DTM. This
output pin has to be used when the device DTM is
used.
The following table describes the
ATV7161E_OUT_NOCETH information available for
ATV7161 on Ethernet networks:
Parameter Type Description
Reserved. UINT Reserved.
CMD UINT Control word.
LFRD INT Speed set-point.
OL1R UINT Logic output states.
AO1C INT Analog output 1 physical value.
AO2C INT Analog output 2 physical value.
AO3C INT Analog output 3 physical value.
DTMOutputs2 ATV32_OUT_NOCETH Holds an output structure for the data to be written
from controller to the device via Device DTM. This
output pin has to be used when the device DTM is
used
The following table describes the
ATV32_OUT_NOCETH information available for
ATV32E on Ethernet networks:
Parameter Type Description
CMD UINT Control word.
LFRD INT Speed set-point.
OL1R UINT Logic output states.
AO1C INT Analog output 1 physical value.
*: Parameters are available for specific components.
1: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV6xx.
6: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

346 EIO0000002092 04/2020

 ATV Profile

Parameter Type Description

DTMOutputs5 ATV6xxE_OUT_NOCETH Holds an output structure for the data to be written
from controller to the device via Device DTM. This
output pin has to be used when the device DTM is
used
The following table describes the
ATV6xxE_OUT_NOCETH information available for
ATV6xx on Ethernet networks:
Parameter Type Description
CMD INT Control word.
LFRD INT Speed set-point.
OL1R INT Logic output states.
AO1C INT Analog output 1 physical value.
AO2C INT Analog output 2 physical value.

DTMOutputs6 ATV9xxE_OUT_NOCETH/ Holds an output structure for the data to be written

ATV6xxxE_OUT_NOCETH from controller to the device via Device DTM. This
output pin has to be used when the device DTM is
used
The following table describes the
ATV9xx_OUT_NOCETH/ATV6xxxE_OUT_NOCETH
information available for ATV9xx/ATV6xxx on
Ethernet networks:
Parameter Type Description
CMD INT Control word.
LFRD INT Speed set-point.
LTR INT Torque set-point.
OL1R INT Logic output states.
AO1C INT Analog output 1 physical value.
AO2C INT Analog output 2 physical value.
*
: Parameters are available for specific components.
1
: Parameter is available only for ATV7161.
2
: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4
: Parameter is available only for PBATV7161.
5: Parameter is available only for ATV6xx.
6
: Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

EIO0000002092 04/2020 347

ATV Profile

Parameter Type Description

StatisticConnector* STATISTICCONNECTOR Information data is used with Modbus communication
to obtain statistics on the Modbus network (requests
carried out, time between requests). This structure has
been created for its use together with the
StatisticCounter DFB in General Purpose library
for communication.
The following table describes the
StatisticConnector:
Parameter Type Description
Start BOOL 1 = The operation has started.
EndOk BOOL 1 = The operation has ended correctly.
EndNOk BOOL 1 = The operation has ended with a detected
error.
PartialTime DINT Partial time.
*: Parameters are available for specific components.
1: Parameter is available only for ATV7161.
2: Parameter is available only for EATV32.
3
: Parameter is available only for ASATV31 and ASATV7161.
4:
Parameter is available only for PBATV7161.
5
: Parameter is available only for ATV6xx.
6:
Parameter is available only for ATV9xx and ATV6xxx.
7
: Parameter is available only for MBATV212.

State
The following table describes the State variable:

Variable value Description

-2 Detected error in DFB.
-1 Not initialized. Waiting for data.
0 Disabled.
2 Switch on disabled (Nst status).
3 Ready to switch on (Nst status).
4 Switched on (Nst status).
5 Operation enabled (Rdy status).
6 Quick stop (Fst status).
8 Inoperable device (Flt status).

348 EIO0000002092 04/2020

 ATV Profile

Info
The code with the information is shown on the Control Expert operator screen. This variable is for
informational purposes only. Do not use it to program switching operations. The following table
describes the Info variable:

Variable value Description

1 Incorrect configuration of DFB parameter.
2 Waiting SwitchOnDisabled.
3 Waiting ReadyToSwitchOn.
4 Waiting SwitchOn.
5 Waiting OperationEnabled.
6 Waiting QuickStop active.
10 Waiting for device information.
11 Missing EnableDFB.
12 Communication interruption.
13 ETA value is 0.
14 Remove local forcing has to be 0.
21 Missing EnableDevice.
23 Remove Run has to be 0.
24 Remove ResetFail. Reset again.
51 Speed driver stopped.
52 Speed driver running with speed 0.
53 Speed driver running.
54 Speed driver at rated running
55 Waiting speed-driver operation (Run).
56 Wait speed driver speed.
57 Waiting speed driver stop.
58 Speed set-point is 0.
59 Speed outside limits.
61 Remove QuickStop has to be 0.
62 QuickStop is activated.
81 Missing ResetFail. Inoperable speed driver.
82 Do speed driver reset.
99 Unexpected state.

EIO0000002092 04/2020 349

ATV Profile

ATV_IO_DDT Type

Name Type Description

OutputsMap WORD Data with the outputs of the speed driver.
(see page 351)
AO1 INT Device control. Value of the AO1 analog output (value of the AO1 input variable).
Current REAL Present current value. Current motor current in 0.1 A increment (value of the
Current output variable).

ATV_IOEXT_DDT Type

Name Type Description

InputsMap WORD State of the digital inputs of the speed driver.
(see page 352)
AI1* INT AI1 analog input. Value of the AI1 analog input (value of the AI1 output
variable)
AI2* INT AI2 analog input. Value of the AI2 analog output (value of the AI2 output
variable).
AO2* INT AO2 analog output. Value of the AO2 analog output (Value of the AO2 input
variable).
Torque DINT Current torque value. Current motor torque in 0.1 A increment (value of the
Torque output variable).
*: Parameters are available for specific components.

ATV6xx_IO_DDT/ATV9xx_IO_DDT/ATV6xxx_IO_DDT Type

Name Type Description

OutputsMap WORD Data with the outputs of the speed driver.
(see page 351)
AQ1 INT Device control. Value of the AQ1 analog output (value of the AQ1 input variable).
Current REAL Motor current value. Actual motor current in Amps.

350 EIO0000002092 04/2020

 ATV Profile

ATV6xx_IOEXT_DDT/ATV9xx_IOEXT_DDT/ATV6xxx_IOEXT_DDT Type

Name Type Description

InputsMap WORD State of the digital inputs of the speed driver.
(see page 353)
AI1 INT AI1 analog input. Value of the AI1 analog input (value of the AI1 output
variable)
AI2 INT AI2 analog input. Value of the AI2 analog output (value of the AI2 output
variable).
AI3 INT AI3 analog input. Value of the AI3 analog output (value of the AI3 output
variable).
AQ2 INT AQ2 analog output. Value of the AQ2 analog output (Value of the AO2 input
variable).
Torque DINT Motor torque value. Actual drive torque in %.
Power REAL Electrical power value. Actual driver power in kW.

OutputsMap Word Structure (ATV6xx, ATV9xx, ATV6xx)

Provides control over the device outputs. The following table describes the OutputsMap word
structure:

Bit Description
0 R1 output state (OutputsMap.R1 (see page 316))
1 R2 output state (OutputsMap.R2 (see page 316)).
2 R3 output state (OutputsMap.R3 (see page 316)).
3 R4 output state (OutputsMapExt.R4 (see page 316)).
4 R5 output state (OutputsMapExt.R5 (see page 316)).
5 R6 output state (OutputsMapExt.R6 (see page 316)).
8 DQ1 output state (OutputsMapExt.DQ1 (see page 316)).
12 DQ11 output state (OutputsMapExt.DQ11 (see page 316)).
13 DQ12 output state (OutputsMapExt.DQ12 (see page 316)).

EIO0000002092 04/2020 351

ATV Profile

OutputsMap Word Structure (ATV7161)

Provides control over the device outputs. The following table describes the OutputsMap word
structure:

Bit Description
0 R1 output state (OutputsMap.R1)
1 R2 output state (OutputsMap.R2).
2 R3 output state (OutputsMap.R3) for ATV 71 and ATV 61.
3 R4 output state (OutputsMap.R4) for ATV 71 and ATV 61.
4 LO1 output state (OutputsMapExt.LO1) for ATV 71 and ATV 61.
5 LO2 output state (OutputsMapExt.LO2) for ATV 71 and ATV 61.
6 LO3 output state (OutputsMapExt.LO3) for ATV 71 and ATV 61.
7 LO4 output state (OutputsMapExt.LO4) for ATV 71 and ATV 61.

InputsMap Word Structure (ATV7161)

Provides the value of the device inputs. The following table describes the InputsMap word
structure:

Bit Description
0 Value of the digital input DI1 (InputsMap.DI1).
1 Value of the digital input DI2 (InputsMap.DI2).
2 Value of the digital input DI3 (InputsMap.DI3).
3 Value of the digital input DI4 (InputsMap.DI4).
4 Value of the digital input DI5 (InputsMap.DI5).
5 Value of the digital input DI6 (InputsMap.DI6).
6 Value of the digital input DI7 (InputsMap.DI7).
7 Value of the digital input DI8 (InputsMap.DI8).
10 Value of the digital input DI11 (InputsMap.DI11).
11 Value of the digital input DI12 (InputsMap.DI12).
12 Value of the digital input DI13 (InputsMap.DI13).
13 Value of the digital input DI14 (InputsMap.DI14).
14 Value of the digital input DI15 (InputsMap.DI15).
15 Value of the digital input DI16 (InputsMap.DI16).

352 EIO0000002092 04/2020

 ATV Profile

Timing diagram:

InputsMap Word Structure (ATV6xx, ATV9xx, ATV6xxx)

Provides the value of the device inputs. The following table describes the InputsMap word
structure:

Bit Description
0 Value of the digital input L1 (InputsMap.L1).
1 Value of the digital input L2 (InputsMap.L2).
2 Value of the digital input L3 (InputsMap.L3).
3 Value of the digital input L4 (InputsMap.L4).
4 Value of the digital input L5 (InputsMap.L5).
5 Value of the digital input L6 (InputsMap.L6).
6 Value of the digital input L7 (InputsMap.L7).
7 Value of the digital input L8 (InputsMap.L8).
8 Value of the digital input L9 (InputsMap.L9).
9 Value of the digital input L10 (InputsMap.L10).
10 Value of the digital input L11 (InputsMap.L11).
11 Value of the digital input L12 (InputsMap.L2).
12 Value of the digital input L13 (InputsMap.L13).
13 Value of the digital input L14 (InputsMap.L14).
14 Value of the digital input L15 (InputsMap.L15).

EIO0000002092 04/2020 353

ATV Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

ATV_ST1 ATV_ST_DDT (see page 354) Device data structure that holds the minimum
information required for performing control and
monitoring functions. The information used by the
operator screen is readable/writable from the HMI
or SCADA system.
ATV_CFG1 ATV_CFG_DDT (see page 355) Data structure with the device information. The
information is used by the operator screen and is
readable from the HMI or SCADA system.
ATV_ST2 ATV6xx_ST_DDT Device data structure holds the minimum
(see page 355)/ATV9xx_ST_DDT information required for performing control and
(see page 355)/ATV6xxx_ST_DDT monitoring functions. The information used by the
(see page 355) operator screen, is readable/writable from the
HMI/SCADA system.
ATV_CFG2 ATV6xx_CFG_DDT Data structure with the device information. The
(see page 357)/ATV9xx_CFG_DDT information is used by the operator screen, is
(see page 357)/ATV6xxx_CFG_DDT readable from the HMI/SCADA system.
(see page 356)

WorkMemory1 ANY_ARRAY_INT Array is used for Modbus communications.

This variable is to be used with a Modbus port that
serializes Modbus requests in an optimum manner.
1
: Parameters are available only for specific components.
2:
Parameters are available only for ATV6xx, ATV9xx and AVT6xxx.

ATV_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit word
(see page 358) is read-only.

CFGW WORD Device control.

(see page 355) Provides the means necessary to control the device from the
monitoring subsystem or from the operator screen if Owner (1), or
only from the monitoring subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value for
reading from the HMI/SCADA system.
PresentValue REAL Current speed value. Current speed of rotation.
SetPoint REAL Set-point variable. The speed set-point is requested from the
speed driver.

354 EIO0000002092 04/2020

 ATV Profile

ATV_CFG_DDT Type

Name Type Description

DataStatus WORD Information on the device status. Information on the Status output structure.
(see page 358)
Info INT Device information. Speed driver information. Its value is Info status.
WarningCode WORD Alarm code information. Takes the values from the WarningCode output.
(see page 359)
State INT Speed driver status code. Speed driver status code information. Its value is
State status.
FailCode0 INT Code of last level 0 detected error. Indicates that a detected error has occurred
FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates that a detected error has occurred
FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates that a detected error has occurred
FailCode[2].

ATV6xx_ST_DDT/ATV9xx_ST_DDT/ATV6xxx_ST_DDT Type

Name Type Description

STW WORD Provides information on the device status. Access to the data held
in this bit word is read-only.
CFGW (see page 356) WORD Device control.
Provides the means necessary to control the device from the
monitoring subsystem or from the operator screen if Owner (1), or
only from the monitoring subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value for
reading from the HMI/SCADA system.
PresentValue REAL Actual speed value. Present speed of rotation
SetPoint REAL Speed set-point variable. The speed set-point is requested from the
speed driver.

TorqueSetPoint* REAL Torque set-point variable is requested from the speed driver.
*
: Parameters are available for 9xx and 6xxx.

EIO0000002092 04/2020 355

ATV Profile

ATV6xx_CFG_DDT/ATV9xx_CFG_DDT/ATV6xxx_CFG_DDT Type

Name Type Description

DataStatus WORD Provides information on the device status. Information on the Status
output structure.
Channelstatus WORD Provides information on the channel status. Information on the Status
(see page 359) output structure.
ExtendedStatus WORD Extended device status.
(see page 359)*
Info INT Device information. Speed driver information. Its value is Info status.
State INT Speed driver status code. Speed driver status code information. Its value
is State status.
WarningCode WORD Notification code register.
FailCode0 INT Code of last level 0 detected error. Indicates that a detected error has
occurred FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates that a detected error has
occurred FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates that a detected error has
occurred FailCode[2].
*:
Parameter is applicable only for ATV6xxx.

ATV_ST.STW/ATV6xx_ST.STW/ATV9xx_ST.STW/ATV6xxx_ST.STW Word Structure

Bit Description
0 Unknown technological module status. No variable refreshing.
1 Not ready.
2 Technological module is running.
3 Inoperable device.
4 Alarm on the device or DFB (follow-up or screw terminal-based control).
5 Communication interruption.
6 Requires resetting. ResetFail is required.
7 Refer to the ExtControlled output pin (see page 332).
8 Refer to the Resetting output pin (see page 332).
9 Refer to the EnableDFB input pin (see page 316).
15 Direction of rotation.

356 EIO0000002092 04/2020

 ATV Profile

ATV_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 316).
1 Owner.
3 Refer to the Direction input pin (see page 316).
4 Refer to the QuickStop input pin (see page 316).
5 Refer to the EnableDevice input pin (see page 316).
6 Refer to the Run input pin (see page 316).
7 Refer to the ControlCommand input pin (see page 316).
8 Refer to the ControlSetPoint input pin (see page 316).

ATV6xx_ST.CFGW/ATV9xx_ST.CFGW/ATV6xxx_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 316).
1 Owner.
3 Refer to the Direction input pin (see page 316).
4 Refer to the QuickStop input pin (see page 316).
5 Refer to the EnableDevice input pin (see page 316).
6 Refer to the Run input pin (see page 316).
7 Refer to the ControlCommand input pin (see page 316).
8 Refer to the ControlSetPoint input pin (see page 316).
9 Refer to the ExternalError input pin (see page 316).

NOTE: The Owner bit enables to control the block from the ***_ST_DDT input/output structure
ignoring the input signals of the block. It enables control from a monitoring system (HMI, SCADA,
Operator screen) in the Manual mode without using the programmed switching operation.

EIO0000002092 04/2020 357

ATV Profile

ATV_CFG.DataStatus/ATV6xx_CFG.DataStatus/ATV9xx_CFG.DataStatus/ATV6xxx_CFG.Dat
aStatus Word Structure

Bit Description
0 Refer to the ReadyToSwitchOn status in the Status output pin (see page 332).
1 Refer to the SwitchedOn status in the Status output pin (see page 332).
2 Refer to the OperationEnabled status in the Status output pin (see page 332).
3 Refer to the Malfunction status in the Status output pin (see page 332).
4 Refer to the VoltageEnabled status in the Status output pin (see page 332).
5 Refer to the QuickStop status in the Status output pin (see page 332).
6 Refer to the SwitchOnDisabled status in the Status output pin (see page 332).
7 Refer to the Alarm status in the Status output pin (see page 332).
8 Refer to the ForcedLocalMode status in the Status output pin (see page 332).
9 Refer to the ReferenceReached status in the Status output pin (see page 332).
10 Refer to the ReferenceExceeded status in the Status output pin (see page 332).
11 Refer to the StopImposed status in the Status output pin (see page 332).
12 Refer to the FowardReverseRotation status in the Status output pin (see page 332).

ATV_CFG.DataStatus Word Structure for MBATV212 Variable Speed Drive

Bit Description
0 Refer to the OutputFailure status in the Status output pin (see page 332).
1 Refer to the Tripped status in the Status output pin (see page 332).
2 Refer to the Alarm status in the Status output pin (see page 332).
3 Refer to the MOFF status in the Status output pin (see page 332).
4 Refer to the MotorSelectionTHR status in the Status output pin (see page 332).
5 Refer to the PIControl status in the Status output pin (see page 332).
6 Refer to the AccelerationPattern status in the Status output pin (see page 332).
7 Refer to the DCBraking status in the Status output pin (see page 332).
9 Refer to the ForwardReverseRotation status in the Status output pin (see page 332).
10 Refer to the Run status in the Status output pin (see page 332).
11 Refer to the CoastStop status in the Status output pin (see page 332).
12 Refer to the EmergencyStop status in the Status output pin (see page 332).
13 Refer to the StandbyST status in the Status output pin (see page 332).

358 EIO0000002092 04/2020

 ATV Profile

Bit Description
14 Refer to the Standby status in the Status output pin (see page 332).
15 Refer to the LocalRemote status in the Status output pin (see page 332).

ATV6xx_CFG.ChannelStatus/ATV9xx_CFG.ChannelStatus Word Structure

Bit Description
0 Refer to the ReservedReferenceChannel status in the Status output pin (see page 332).
1 Refer to the ReservedCommandChannel status in the Status output pin (see page 332).

ATV6xxx_CFG.ExtendedStatus Word Structure

Bit Description
0 Refer to the ReservedReferenceChannel status in the Status output pin (see page 332).
1 Refer to the ReservedCommandChannel status in the Status output pin (see page 332).
2 Refer to the MVCBReadyToClose status in the Status output pin (see page 332).
3 No command selected. Refer to CommandStatus output pin (see page 332).
4 Remote command selected. Refer to CommandStatus output pin (see page 332)
5 Local command selected. Refer to CommandStatus output pin (see page 332)
6 Panel command selected. Refer to CommandStatus output pin (see page 332)

ATV_CFG.WarningCode Word Structure

Bit Description
1 Refer to the Device in the WarningCode output pin (see page 332).
2 Refer to the Order in the WarningCode output pin (see page 332).
3 Refer to the ForcedLocalMode in the WarningCode output pin (see page 332).

EIO0000002092 04/2020 359

ATV Profile

ATV6xx_CFG.WarningCode/ATV9xx_CFG.WarningCode/ATV6xxx_CFG.WarningCode Word
Structure

Bit Description
1 Refer to the Device in the WarningCode output pin (see page 332).
2 Refer to the Order in the WarningCode output pin (see page 332).
3 Refer to the ForcedLocalMode in the WarningCode output pin (see page 332).
4 Refer to ReservedReferenceChannel in the WarningCode output pin (see page 332).
5 Refer to ReferenceCommandChannel in the WarningCode output pin (see page 332).

360 EIO0000002092 04/2020

 ATV Profile

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. This is the time that the block waits for
the operations to be carried out by the device.
If a command has been sent and the command is not executed
within the time indicated by this variable, an alarm is issued.
The commands that are controlled are EnableDevice, Run, and
QuickStop. In the event of a ResetFail, this is not interpreted as
an alarm. Instead, the detected failure continues, and you have to
reset the Reseting output.
ScanTime TIME Allows you to configure the time for which the alarm signals are kept
active.
Helps the monitoring subsystem to acquire the data for the alarms
that are automatically reset.
HighRangeRpm INT High range of the input signal in rpm.
NOTE: The parameter value has to be higher than LowRangeRpm.
LowRangeRpm INT Low range of the input signal in rpm.
NOTE: The parameter value has to be higher than 0.
HighRangeEngUnit REAL High range for the measurement in engineering units (Refer to the
SetPoint input pin (see page 316)).

For operating the motor at different rpm, LowRangeEngUnit has to be less than the
HighRangeEngUnit. If both the values are same, motor operates at HighRangeEngUnit.

NOTICE
UNEXPECTED EQUIPMENT BEHAVIOR
Do not configure LowRangeEngUnit to be same as HighRangeEngUnit.
Failure to follow these instructions can result in equipment damage.

EIO0000002092 04/2020 361

ATV Profile

LowRangeEngUnit REAL Low range for the measurement in engineering units (Refer to
the SetPoint input pin (see page 316)).
NOTE: The parameter value has to be higher than
LowRangeRpm.
ResetMode BOOL Enables to configure the type of reset. This type of reset is used
for communication interruption and device interruptions.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset has to be carried out. The first reset
is carried out after the time defined in CommandCtrlWindow
elapses. The second reset is carried out after
CommandCtrlWindow * 2 elapses, so on. If the value of
CommandCtrlWindow is 0 s, its value is not used and is instead
replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
value
FALSE Communications with the device is reset with the ResetFail
variable.
TRUE Communications with the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable is used to define
the maximum time that can elapse between 2 consecutive
resets.
Refer to the Timing diagram below.
ScalingFactorCurrent REAL Define scaling factor for current depending on drive rate.

Timing diagram:

362 EIO0000002092 04/2020

 ATV Profile

Diagnostics Information Management

Overview
The diagnostic codes that the device can return are read on the FailCode output variable.

Parameter Configuration Diagnostic Codes

This diagnostic code indicates that the function block has incorrect configuration.
 FailCode[0]: 16#0003
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004
This diagnostic code can occur for any of the below conditions:
 Wrong array size at Inputs or Outputs pins of the function block.
 Variables connected to both DTMInputs and Inputs pins of the function Block.

During the above detected FailCode the function block does not process any inputs and the
function blocks output displays the last processed state.
This detected FailCode can be reset by a rising edge to the EnableDFB input pin after correcting
the configuration of the function block.

Ethernet Communication Diagnostic Codes

This code indicates that communications have not been established and can be reset:
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

After the communications have been established, check Ethernet client diagnostic codes for
FailCode [0] and FailCode [1]. The components make a distinction between detected read
request and write request interruptions:
 FailCode[2]: 16#0001 Read
 FailCode[2]: 16#0002 Write

EIO0000002092 04/2020 363

ATV Profile

Diagnostic Code Example

For a detected error, the code is:
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005

The FailCode[0] can have one of the following codes:

Diagnostic code Symbol Meaning

16#0000 nOF No detected failure.
16#1000 CrF Detected failure in capacitor pre-charge.
OLF Motor overload or
SOF Overspeed.
16#2310 OCF Overcurrent.
16#2320 SCF Short-circuit impedance.
Power stage detected failure.
16#2330 SCF Motor ground fault.
16#2340 SCF Short-circuit between motor phases.
16#3110 OSF Supply over voltage detected failure.
16#3120 USF Low bus voltage.
16#3130 PHF Phase dropout detected failure.
16#3310 ObF Over voltage on DC bus.
OPF Motor phase dropout.
16#4210 OHF Drive overheating.
16#5520 EEF Inoperable EEPROM memory.
16#6100 InF Internal detected failure.
16#6300 CFF Incorrect (parameter) configuration or
CFI Invalid parameters.
16#7300 LFF Inoperable 4...20 mA AI3 input.
16#7510 SLF Modbus is not operational.
16#9000 EPF External detected failure.
16#FF00 tnF Inoperable auto-tuning.
16#FF01 bLF Brake control unit is not operational.

The inoperable device can be reset if ControlCommand is TRUE. If this condition is not met, the
detected failure can be reset on the speed driver or through the screw terminal with the correct
parameter configuration.
NOTE: The diagnostic codes of the device are available for speed drives, except for those that
communicate through the Advantys STB Island.

364 EIO0000002092 04/2020

 ATV Profile

Diagnostic Code Example for MBATV212 Variable Speed Drive

The FailCode[0] can have one of the following codes:

Diagnostic bit Meaning

0 Overcurrent.
1 Drive overload.
2 Motor overload.
3 Overheat.
4 Overvoltage.
5 Main circuit undervoltage.
6 Reserved.
7 Undercurrent.
8 Over-torque.
9 Reserved.
10 Cumulative operation hours reached.
11 Reserved.
12 Reserved.
13 Main circuit undervoltage alarm same as MS-relay status.
14 At the time of the instant blackout, Forced deceleration/stop.
15 An automatic stop during the lower limit frequency continuance.

EIO0000002092 04/2020 365

ATV Profile

366 EIO0000002092 04/2020

 Modicon Libraries General Purpose
EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)
EIO0000002092 04/2020

Chapter 18
EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

EMATVWarn - Extended Warnings of Process Drives

(Supports 9 Alarm registers)

Overview
This chapter describes the features of Extended Warnings of Process Drives (ATV6xx and
ATV9xx) which shall be accessible through the EMATVWarn DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 368
DFB Representation 369
Inputs 370
Outputs 371
Inputs/Outputs 373
Public Variables 403

EIO0000002092 04/2020 367

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

Description

General
The EMATVWarn block is part of the device control block family. Its objective is to manage
Extended Warnings of Process Drives (ATV9xx and ATV6xx) using Explicit Communication.
NOTE: Warnings association to the warning groups has to be configured in device DTM. Refer
ATV6xx/ATV9xx Device DTM User Manual to configure the warnings.

Function Description
The DFB main functions are summarized below:

Function Description
Monitoring Makes it possible to monitor the device warnings in Control Expert.
Device Status Displays the status of the device.
Indication
Remote Allows resetting of the function block.
resetting
Monitoring Enables you to monitor the device.

368 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

DFB Representation

Representation
The following figure represents the function module of EMATVWarn DFB.

EIO0000002092 04/2020 369

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control block.
0 = The entire DFB is restarted and output values are set to 0.
1 = Enables communications with the devices for their operation.
ResetFail BOOL 1 = Resets the Fail output parameter to 0. It resets any DFB failure
DeviceAddress String[26] Device address within the Ethernet network. Depending on the
platform, the following definitions apply:
Platform Description
M340 '{IP}ID'
M580 '{IP}ID'
Quantum '{IP}ID'
NOTE: ID is 0.

370 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL 1 = The device is enabled and free of detected errors. DFB is
ready to read status of the device.
Fail BOOL 1 = A detected failure in the control block or in the device or a
communication interruption.To reset the Fail output pin, the
ResetFail input has to be activated.
FailCode Array[0..2] of Int When the Fail output is 1, it holds the code for the detected
error. If the Fail bit is 0, it indicates the last detected error that
occurred. The detected error source is specified by using a 3
level structure.

Refer to the Diagnostics Information Management Codes in

Modicon Libraries General Purpose Communication
Components User Guide.
Reseting BOOL 1 = A reset is being carried out.The CommandCtrlWindow
variable indicates the maximum time for resetting the detected
failure.When a device or communication reset is carried out
withResetFail, the DFB tries to reset the detected failure
within the time period defined in CommandCtrlWindow.If the
detected failure is reset, the Fail and Reseting output variables
are reset (set to FALSE). If the detected failure is not reset, the
Reseting variable is set to FALSEand the Fail variable remains
TRUE. The ResetFail is edge-based.
WarnGroupStatus ATVWarnStatus Warning Group Status
Parameter Type Description
WarningGroup1 BOOL Warning in Group 1
WarningGroup2 BOOL Warning in Group 2
WarningGroup3 BOOL Warning in Group 3
WarningGroup4 BOOL Warning in Group 4
WarningGroup5 BOOL Warning in Group 5

EIO0000002092 04/2020 371

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

Parameter Type Description

StatisticsConnector StatisticConnector Information data is used with ModbusTCP communication to
obtain statistics on the Modbus network (requests carried out,
time between requests). This structure has been created for its
use together with the StatisticCounter DFB in General
Purpose library for communication.
The following table describes the StatisticConnector
Parameter Type Description
Start BOOL 1 = The operation has started.
EndOk BOOL 1 = The operation has ended
correctly.
EndNOk BOOL 1 = The operation has ended with a
detected error.
PartialTime DINT Partial time.

372 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

Inputs/Outputs

Inputs/Outputs Parameter Description

Parameter Type Description

EMATVWARN_ST EMATVWarn_ST_DDT Device data structure holds the minimum information
required for performing monitoring functions. The
information used by the operator screen is readable
from the HMI/ SCADA system.
EMATVWARN_CFG EMATVWarn_CFG_DDT Data structure with device information. The
information used by the operator screen is readable
from the HMI/SCADA system.
WorkMemory ANY_ARRAY_INT Array used for Modbus communications. This
variable is to be used with a Modbus Ethernet port
that serializes Modbus requests in an optimum
manner.

EMATVWarn_ST_DDT Type

Parameter Type Description

STW WORD Provides the device status. Access to the data held in this bit
word is read-only. Device main status.
(bit 5 - Communication Fail, bit 8 - Reseting)
CFGW WORD Device control. Provides the means to control the device
from the monitoring subsystem or from the operator screen
if Owner (1), or only from the monitoring subsystem if Owner
(0).
If Owner is 0, it takes the input variables of the DFB as a
value for reading from the HMI/SCADA system.Device main
control orders.
Bit 0 - ResetFail.
Bit 1 - Owner.
NOTE:
 If Owner is 1,HMI control (write).
 Owner is 0, information from inputs (read).
WarningStatus Array[0..4] Provides the device Warning Registers 12860 to 12867.
of DINT Access to the data held in this bit word is read-only. (ALR1,
ALR2, ALR3…. ALR9).

EIO0000002092 04/2020 373

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

Parameter Type Description

WarningGroupMapping Array[0..22] Configuration of Warning register (45 registers) to Warning
of DINT group (5 registers) at 12821 to 12855 (ALR1 to ALR7),
12871 to 12875 (ALR8), 12881 to 12885 (ALR9). Provides
the device Alarm Group Status. Register is 12821 to 12855.
Access to the data held in this bit word is read-only. Warning
Group (AG11, AG12, AG13, AG14, AG15, AG21, AG22,….,
AG95).
Warning Group( AG11, AG12, AG13, AG14, AG15, AG16,
AG17, AG18, AG19, AG21, AG22,.... AG57, AG58, AG59).
Combining of two words to one Double integer to reduce
count of PLC HMI Data

EMATVWarn_CFW_DDT Type

Parameter Type Description

FailCode0 INT Code of last level 0 detected error. Indicates which
detected error has occurred, FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates which
detected error has occurred, FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates which
detected error has occurred, FailCode[2].

EMATVWarn_ST.WarningStatus[0] DINT Structure

WarningStatus[0] Description
Bit 0 Fallback frequency reaction.
Bit 1 Speed maintained.
Bit 2 Type of stop.
Bit 3 Reference frequency warning.
Bit 4 Life cycle warning 1.
Bit 5 Life cycle warning 2.
Bit 6 Drive running warning.
Bit 7 Low flow warning.
Bit 8 High flow warning.
Bit 9 Inlet pressure warning.
Bit 10 Outlet pressure low warning.
Bit 11 Outlet pressure high warning.
Bit 12 Pump cycle warning.
Bit 13 Anti jam warning.

374 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningStatus[0] Description
Bit 14 Pump low flow.
Bit 15 Low pressure warning.
Bit 16 Flow limit activated.
Bit 17 PID error warning.
Bit 18 PID feedback warning.
Bit 19 PID high feedback warning.
Bit 20 PID low feedback warning.
Bit 21 Regulation warning.
Bit 22 Limit switch reached.
Bit 23 Rope slack detection.
Bit 24 Dynamic load warning.
Bit 25 AI2 thermal sensor warning.
Bit 26 AI3 thermal sensor warning.
Bit 27 AI4 thermal sensor warning.
Bit 28 AI5 thermal sensor warning.
Bit 29 AI1 4-20 loss warning.
Bit 30 AI2 4-20 loss warning.
Bit 31 AI3 4-20 loss warning.

EMATVWarn_ST.WarningStatus[1] DINT Structure

WarningStatus[1] Description
Bit 0 AI4 4-20 loss warning.
Bit 1 AI5 4-20 loss warning..
Bit 2 Drive thermal state warning.
Bit 3 IGBT thermal warning.
Bit 4 Fan counter warning.
Bit 5 Fan feedback warning.
Bit 6 Braking resistor overload alarm is raised.
Bit 7 External error warning.
Bit 8 Undervoltage warning.
Bit 9 Preventive undervoltage active.
Bit 10 Drive in forced run.
Bit 11 Motor frequency high threshold reached.
Bit 12 Motor frequency low threshold reached.

EIO0000002092 04/2020 375

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningStatus[1] Description
Bit 13 Motor frequency high threshold 2 reached.
Bit 14 Motor frequency low threshold 2 reached.
Bit 15 High speed reached.
Bit 16 Reference frequency high threshold reached.
Bit 17 Reference frequency low threshold reached.
Bit 18 Second frequency threshold reached.
Bit 19 Current threshold reached.
Bit 20 Low current threshold reached.
Bit 21 High torque threshold reached.
Bit 22 Low torque threshold reached.
Bit 23 Process under load warning.
Bit 24 Process overload warning.
Bit 25 Torque current limitation warning.
Bit 26 Torque regulation warning.
Bit 27 Drive thermal threshold reached.
Bit 28 Motor thermal threshold reached.
Bit 29 Moto2 thermal threshold reached.
Bit 30 Motor3 thermal threshold reached.
Bit 31 Motor4 thermal threshold reached.

EMATVWarn_ST.WarningStatus[2] DINT Structure

WarningStatus[2] Description
Bit 0 Power high threshold reached.
Bit 1 Power low threshold reached.
Bit 2 Customer warning 1.
Bit 3 Customer warning 2.
Bit 4 Customer warning 3.
Bit 5 Customer warning 4.
Bit 6 Customer warning 5.
Bit 7 Intelligent rectifier warning.
Bit 8 Power consumption warning.
Bit 9 Outlet pressure high switch warning.
Bit 10 Ethernet internal warning.
Bit 11 Device replacement activated but not plugged.

376 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningStatus[2] Description
Bit 12 Device replacement transfer failure.
Bit 13 Multi-pumps capacity alarm.
Bit 14 Water: multi pump lead alarm.
Bit 15 Not available.
Bit 16 Level control low alarm
Bit 17 Level control low alarm
Bit 18 Slipping warning.
Bit 19 Not available.
Bit 20 Load movement warning.
Bit 21 Brake contact warning.
Bit 22 AI1 thermal sensor warning.
Bit 23 Back spin controls control is active.
Bit 24 Not available.
Bit 25 Not available.
Bit 26 Not available.
Bit 27 Not available.
Bit 28 Not available.
Bit 29 Not available.
Bit 30 Not available.
Bit 31 Not available.

EMATVWarn_ST.WarningStatus[3] DINT Structure

WarningStatus[3] Description
Bit 0 Not available.
Bit 1 Not available.
Bit 2 Not available.
Bit 3 Not available.
Bit 4 Not available.
Bit 5 Not available.
Bit 6 Not available.
Bit 7 Not available.
Bit 8 Not available.
Bit 9 Not available.
Bit 10 Not available.

EIO0000002092 04/2020 377

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningStatus[3] Description
Bit 11 Not available.
Bit 12 Not available.
Bit 13 Not available.
Bit 14 Not available.
Bit 15 Not available.
Bit 16 Not available.
Bit 17 Not available.
Bit 18 Not available.
Bit 19 Not available.
Bit 20 Not available.
Bit 21 Not available.
Bit 22 Not available.
Bit 23 Not available.
Bit 24 Not available.
Bit 25 Not available.
Bit 26 Not available.
Bit 27 M/S device alert.
Bit 28 Backlash sequence: Alarm.
Bit 29 Encoder module thermal warning.
Bit 30 BU: Fan running time.
Bit 31 BU: Fan frequency.

378 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

EMATVWarn_ST.WarningStatus[4] DINT Structure

WarningStatus[4] Description
Bit 0 BY: Sensor thermal state.
Bit 1 Multidrive: communication link between safe and drive loss (PWM disable).
Bit 2 Not available.
Bit 3 Not available.
Bit 4 Not available.
Bit 5 Not available.
Bit 6 Not available.
Bit 7 Not available.
Bit 8 Not available.
Bit 9 Not available.
Bit 10 Not available.
Bit 11 Not available.
Bit 12 Not available.
Bit 13 Not available.
Bit 14 Not available.
Bit 15 Not available.
Bit 16 Not available.
Bit 17 Not available.
Bit 18 Not available.
Bit 19 Not available.
Bit 20 Not available.
Bit 21 Not available.
Bit 22 Not available.
Bit 23 Not available.
Bit 24 Not available.
Bit 25 Not available.
Bit 26 Not available.
Bit 27 Not available.
Bit 28 Not available.
Bit 29 Not available.
Bit 30 Not available.
Bit 31 Not available.

EIO0000002092 04/2020 379

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

EMATVWarn_ST.WarningGroupMapping DINT Structure

WarningGroupMapping[0] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR1 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALR2 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

380 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[1] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR3 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALR4 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 381

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[2] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR5 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALR6 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

382 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[3] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR7 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALR8 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 383

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[4] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR9 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 2 and ALR1 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

384 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[5] of DINT Description

Bit 0 Alarm configuration of Warning group 2 and ALR2 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 2 and ALR3 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 385

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[6] of DINT Description

Bit 0 Alarm configuration of Warning group 2 and ALR4 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 2 and ALR5 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

386 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[7] of DINT Description

Bit 0 Alarm configuration of Warning group 2 and ALR6 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 2 and ALR7 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 387

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[8] of DINT Description

Bit 0 Alarm configuration of Warning group 2 and ALR8 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 2 and ALR9 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

388 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[9] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR1 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALR2 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 389

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[10] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR3 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALR4 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

390 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[11] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR5 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALR6 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 391

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[12] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR7 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALR8 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

392 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[13] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR9 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALR1 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 393

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[14] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALR2 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALR3 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

394 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[15] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALR4 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALR5 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 395

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[16] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALR6 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALR7 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

396 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[17] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALR8 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALR9 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 397

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[18] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR1 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALR2 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

398 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[19] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR3 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALR4 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 399

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[20] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR5 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALR6 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

400 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[21] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR7 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALR8 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 401

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

WarningGroupMapping[22] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR9 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Not Available.
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

402 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

Public Variables

Public Variable Description

Parameter Type Description

Refresh TIME Allows you to configure the time for which the detected
alarm signals are kept active. Helps the monitoring
subsystem to acquire the data for the alarms that are
automatically reset.
CommandCtrlWindow TIME Control time for operations. This is the time that the block
waits for the operations to be carried out by the device.
ResetMode BOOL Enables to configure the type of reset. This type of reset
is used for detected communication and device
interruptions. The time defined in CommandCtrlWindow
is used to define the interval after which a reset has to be
carried out. The first reset is carried out after the time
defined in CommandCtrlWindow elapses. The second
reset is carried out after CommandCtrlWindow * 2
elapses, so on. If the value of CommandCtrlWindow is
0 s, its value is not used and is instead replaced with a
value of 1 s.
The following table describes the type of the reset:
Variable Value Description
FALSE Communications with the device is reset with the
ResetFail variable.
TRUE Communications with the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable is used to
define the maximum time that can elapse between 2
consecutive resets.

EIO0000002092 04/2020 403

EMATVWarn - Extended Warnings of Process Drives (Supports 9 Alarm registers)

404 EIO0000002092 04/2020

 Modicon Libraries General Purpose
EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)
EIO0000002092 04/2020

Chapter 19
EMATVWarn1 - Extended Warnings of Process Drives (Supports 12 Alarm registers)

EMATVWarn1 - Extended Warnings of Process Drives

(Supports 12 Alarm registers)

Overview
This chapter describes the features of Extended Warnings of Process Drives (ATV6xxx) which
shall be accessible through the EMATVWarn1 DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 406
DFB Representation 407
Inputs 408
Outputs 410
Inputs/Outputs 412

EIO0000002092 04/2020 405

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

Description

General
The EMATVWarn1 block is part of the device control block family. Its objective is to manage
Extended Warnings of Process Drives (ATV6xxx) using Explicit Communication.
NOTE: Warnings association to the warning groups has to be configured in device DTM. Refer
ATV6xxx Device DTM User Manual to configure the warnings.

Function Description
The DFB main functions are summarized below:

Function Description
Monitoring Makes it possible to monitor the device warnings in Control Expert.
Device Status Displays the status of the device.
Indication
Remote Allows resetting of the function block.
resetting
Monitoring Enables you to monitor the device.

406 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

DFB Representation

Representation
The following figure represents the function module of EMATVWarn1 DFB.

EIO0000002092 04/2020 407

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control block.
0 = The entire DFB is restarted and output values are set to 0.
1 = Enables communications with the devices for their
operation.
ResetFail BOOL 1 = Resets the Fail output parameter to 0. It resets any DFB
failure
DeviceAddress String[26] Device address within the Ethernet network. Depending on
the platform, the following definitions apply:
Platform Description
M340 '{IP}ID'
M580 '{IP}ID'
Quantum '{IP}ID'
NOTE: ID is 0.
EngParam BOOL ATV6xxx engineering parameters.
Parameter Type Default Description
value
CommandCtrlWindow TIME t#5 s Control time for operations. This is
the time that the block waits for the
operations to be carried out by the
device.
If a command has been sent and
the command is not executed
within the time indicated by this
variable, an alarm is issued. The
commands that are controlled are
EnableDevice, Run, and
QuickStop. In the event of a
ResetFail, this is not interpreted
as an alarm. Instead, the detected
failure continues, and you have to
reset the Reseting output.

408 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

Parameter Type Description

Refresh TIME t#500 ms Allows you to configure the time
for which the detected alarm
signals are kept active. Helps the
monitoring subsystem to acquire
the data for the alarms that are
automatically reset.
ResetMode BOOL FALSE Enables to configure the type of
reset. This type of reset is used for
communication interruption and
device interruptions. The time
defined in CommandCtrlWindow
is used to define the interval after
which a reset has to be carried
out. The first reset is carried out
after the time defined in
CommandCtrlWindow elapses.
The second reset is carried out
after CommandCtrlWindow * 2
elapses, so on. If the value of
CommandCtrlWindow is 0 s, its
value is not used and is instead
replaced with a value of 1 s.
FALSE = Communications with
the device is reset with the
ResetFail variable.
TRUE = Communications with the
device is reset automatically.
MaxResetTime TIME t#1 s When in automatic ResetMode,
this variable is used to define the
maximum time that can elapse
between 2 consecutive resets.

EIO0000002092 04/2020 409

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL 1 = The device is enabled and free of detected errors. DFB is
ready to read status of the device.
Fail BOOL 1 = A detected failure in the control block or in the device or a
communication interruption.To reset the Fail output pin, the
ResetFail input has to be activated.
FailCode Array[0..2] of Int When the Fail output is 1, it holds the code for the detected
error. If the Fail bit is 0, it indicates the last detected error that
occurred. The detected error source is specified by using a 3
level structure.

Refer to the Diagnostics Information Management Codes in

Modicon Libraries General Purpose Communication
Components User Guide.
Reseting BOOL 1 = A reset is being carried out.The CommandCtrlWindow
variable indicates the maximum time for resetting the detected
failure.When a device or communication reset is carried out
withResetFail, the DFB tries to reset the detected failure
within the time period defined in CommandCtrlWindow.If the
detected failure is reset, the Fail and Reseting output variables
are reset (set to FALSE). If the detected failure is not reset, the
Reseting variable is set to FALSEand the Fail variable remains
TRUE. The ResetFail is edge-based.
WarnGroupStatus ATVWarn1Status Warning Group Status
Parameter Type Description
WarningGroup1 BOOL Warning in Group 1
WarningGroup2 BOOL Warning in Group 2
WarningGroup3 BOOL Warning in Group 3
WarningGroup4 BOOL Warning in Group 4
WarningGroup5 BOOL Warning in Group 5

410 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

Parameter Type Description

StatisticsConnector StatisticConnector Information data is used with ModbusTCP communication to
obtain statistics on the Modbus network (requests carried out,
time between requests). This structure has been created for its
use together with the StatisticCounter DFB in General
Purpose library for communication.
The following table describes the StatisticConnector
Parameter Type Description
Start BOOL 1 = The operation has started.
EndOk BOOL 1 = The operation has ended
correctly.
EndNOk BOOL 1 = The operation has ended with a
detected error.
PartialTime DINT Partial time.

EIO0000002092 04/2020 411

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

Inputs/Outputs

Inputs/Outputs Parameter Description

Parameter Type Description

EMATVWARN1_ST EMATVWarn1_ST_DDT Device data structure holds the minimum information
required for performing monitoring functions. The
information used by the operator screen is readable
from the HMI/ SCADA system.
EMATVWARN1_CFG EMATVWarn1_CFG_DDT Data structure with device information. The
information used by the operator screen is readable
from the HMI/SCADA system.
WorkMemory ANY_ARRAY_INT Array used for Modbus communications. This
variable is to be used with a Modbus Ethernet port
that serializes Modbus requests in an optimum
manner.

EMATVWarn1_ST_DDT Type

Parameter Type Description

STW WORD Provides the device status. Access to the data held in this bit
word is read-only. Device main status.
(bit 5 - Communication Fail, bit 8 - Reseting)
CFGW WORD Device control. Provides the means to control the device from
the monitoring subsystem or from the operator screen if
Owner (1), or only from the monitoring subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value
for reading from the HMI/SCADA system.Device main control
orders.
Bit 0 - ResetFail.
Bit 1 - Owner.
NOTE:
 If Owner is 1,HMI control (write).
 Owner is 0, information from inputs (read).
WarningStatus Array[0...5] Provides the device Warning Registers 12860 to 12868.
of DINT Access to the data held in this bit word is read-only. (ALR1,
ALR2, ALR3…. ALRC).

412 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

Parameter Type Description

WarningGroupMapping Array[0..29] Configuration of Warning register (45 registers) to Warning
of DINT group (5 registers) at 12821 to 12855 (ALR1 to ALR7), 12871
to 12875 (ALR8), 12881 to 12885 (ALR9), at 16921 to 16935
(ALRA, ALRB. ALRC). Provides the device Alarm Group
Status. Register is 12821 to 12885, and from 16921 to 16935.
Access to the data held in this bit word is read-only. Warning
Group (AG11, AG12, AG13, AG14, AG15, AG21, AG22,….,
AG5C).
Warning Group( AG11, AG12, AG13, AG14, AG15, AG16,
AG17, AG18, AG19, AG21, AG22,.... AG5B, AG5C).
Combining of two words to one Double integer to reduce count
of PLC HMI Data

EMATVWarn1_CFW_DDT Type

Parameter Type Description

FailCode0 INT Code of last level 0 detected error. Indicates which
detected error has occurred, FailCode[0].
FailCode1 INT Code of last level 1 detected error. Indicates which
detected error has occurred, FailCode[1].
FailCode2 INT Code of last level 2 detected error. Indicates which
detected error has occurred, FailCode[2].

EMATVWarn1_ST.WarningStatus[0] DINT Structure

WarningStatus[0] Description
Bit 0 Fallback frequency reaction.
Bit 1 Speed maintained.
Bit 2 Type of stop.
Bit 3 Reference frequency warning.
Bit 4 Life cycle warning 1.
Bit 5 Life cycle warning 2.
Bit 6 Drive running warning.
Bit 7 Mot applicable.
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12 Pump cycle warning.

EIO0000002092 04/2020 413

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningStatus[0] Description
Bit 13 Not applicable.
Bit 14
Bit 15
Bit 16
Bit 17 PID error warning.
Bit 18 PID feedback warning.
Bit 19 PID high feedback warning.
Bit 20 PID low feedback warning.
Bit 21 Regulation warning.
Bit 22 Not applicable.
Bit 23
Bit 24
Bit 25
Bit 26 AI3 thermal sensor warning.
Bit 27 AI4 thermal sensor warning.
Bit 28 AI5 thermal sensor warning.
Bit 29 AI1 4-20 loss warning.
Bit 30 Not applicable.
Bit 31 AI3 4-20 loss warning.

EMATVWarn1_ST.WarningStatus[1] DINT Structure

WarningStatus[1] Description
Bit 0 AI4 4-20 loss warning.
Bit 1 AI5 4-20 loss warning..
Bit 2 Drive thermal state warning.
Bit 3 Not applicable.
Bit 4 Fan counter warning.
Bit 5 Fan feedback warning.
Bit 6 Not applicable.
Bit 7 External error warning.
Bit 8 Undervoltage warning.
Bit 9 Preventive undervoltage active.
Bit 10 Drive in forced run.
Bit 11 Motor frequency high threshold reached.

414 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningStatus[1] Description
Bit 12 Motor frequency low threshold reached.
Bit 13 Motor frequency high threshold 2 reached.
Bit 14 Motor frequency low threshold 2 reached.
Bit 15 High speed reached.
Bit 16 Reference frequency high threshold reached.
Bit 17 Reference frequency low threshold reached.
Bit 18 Second frequency threshold reached.
Bit 19 Current threshold reached.
Bit 20 Low current threshold reached.
Bit 21 High torque threshold reached.
Bit 22 Low torque threshold reached.
Bit 23 Process under load warning.
Bit 24 Process overload warning.
Bit 25 Torque current limitation warning.
Bit 26 Torque regulation warning.
Bit 27 Drive thermal threshold reached.
Bit 28 Motor thermal threshold reached.
Bit 29 Moto2 thermal threshold reached.
Bit 30 Motor3 thermal threshold reached.
Bit 31 Motor4 thermal threshold reached.

EIO0000002092 04/2020 415

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

EMATVWarn_ST.WarningStatus[2] DINT Structure

WarningStatus[2] Description
Bit 0 Power high threshold reached.
Bit 1 Power low threshold reached.
Bit 2 Customer warning 1.
Bit 3 Customer warning 2.
Bit 4 Customer warning 3.
Bit 5 Customer warning 4.
Bit 6 Customer warning 5.
Bit 7 Not applicable.
Bit 8 Power consumption warning.
Bit 9 Not applicable.
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16
Bit 17
Bit 18 Slipping warning.
Bit 19 Not available.
Bit 20 Load movement warning.
Bit 21 Brake contact warning.
Bit 22 AI1 thermal sensor warning.
Bit 23 Not applicable.
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

416 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

EMATVWarn1_ST.WarningStatus[3] DINT Structure

WarningStatus[3] Description
Bit 0 IO function: Digital warning A.
Bit 1 IO function: Digital warning B.
Bit 2 IO function: Digital warning C.
Bit 3 IO function: Digital warning D.
Bit 4 IO function: Cabinet warning A.
Bit 5 IO function: Cabinet warning B.
Bit 6 IO function: Cabinet warning C.
Bit 7 IO function: Thermal input warning A.
Bit 8 IO function: Thermal input warning B.
Bit 9 IO function: Thermal input warning C.
Bit 10 IO function: Thermal input warning D.
Bit 11 Not available.
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22 Cabinet overheating alarm.
Bit 23 Not available.
Bit 24
Bit 25
Bit 26
Bit 27 M/S device alert.
Bit 28 Backlash warning.
Bit 29 Encoder module thermal warning.
Bit 30 Not available.
Bit 31

EIO0000002092 04/2020 417

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

EMATVWarn1_ST.WarningStatus[4] DINT Structure

WarningStatus[4] Description
Bit 0 Not available.
Bit 1
Bit 2
Bit 3 Power cells over-braking light overvoltage warning.
Bit 4 Mains input ground voltage warning.
Bit 5 Motor output ground voltage warning.
Bit 6 PLC cabinet warning 1.
Bit 7 PLC cabinet warning 2.
Bit 8 PLC cabinet warning 3.
Bit 9 PLC cabinet warning 4.
Bit 10 PLC cabinet warning 5.
Bit 11 PLC cabinet warning 6.
Bit 12 PLC cabinet warning 7.
Bit 13 PLC cabinet warning 8.
Bit 14 PLC cabinet warning 9.
Bit 15 PLC cabinet warning 10.
Bit 16 PLC cabinet warning 11.
Bit 17 PLC cabinet warning 12.
Bit 18 PLC cabinet warning 13.
Bit 19 PLC cabinet warning 14.
Bit 20 PLC cabinet warning 15.
Bit 21 PLC cabinet warning 16.
Bit 22 PLC cabinet warning 17.
Bit 23 PLC cabinet warning 18.
Bit 24 PLC cabinet warning 19.
Bit 25 PLC cabinet warning 20.
Bit 26 PLC cabinet warning 21.
Bit 27 PLC cabinet warning 22.
Bit 28 PLC cabinet warning 23.
Bit 29 PLC cabinet warning 24.
Bit 30 PLC cabinet warning 25.
Bit 31 PLC cabinet warning 26.

418 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

EMATVWarn1_ST.WarningStatus[5] DINT Structure

WarningStatus[5] Description
Bit 0 PLC cabinet warning 27.
Bit 1 PLC cabinet warning 28.
Bit 2 PLC cabinet warning 29.
Bit 3 PLC cabinet warning 30.
Bit 4 PLC cabinet warning 31.
Bit 5 PLC cabinet warning 32.
Bit 6 PLC application ETO warning 1.
Bit 7 PLC application ETO warning 2.
Bit 8 PLC application ETO warning 3.
Bit 9 PLC application ETO warning 4
Bit 10 PLC application ETO warning 5.
Bit 11 PLC application ETO warning 6.
Bit 12 PLC application ETO warning 7.
Bit 13 PLC application ETO warning 8.
Bit 14 PLC application ETO warning 9.
Bit 15 PLC application ETO warning 10.
Bit 16 PLC application ETO warning 11.
Bit 17 PLC application ETO warning 12.
Bit 18 PLC application ETO warning 13.
Bit 19 PLC application ETO warning 14.
Bit 20 PLC application ETO warning 15.
Bit 21 PLC application ETO warning 16.
Bit 22 Motor parameter scaling warning.
Bit 23 Not available.
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 419

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

EMATVWarn1_ST.WarningGroupMapping DINT Structure

WarningGroupMapping[0] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR1 register
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALR2 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

420 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[1] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR3 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALR4 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 421

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[2] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR5 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALR6 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

422 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[3] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR7 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALR8 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 423

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[4] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALR9 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALRA register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

424 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[5] of DINT Description

Bit 0 Alarm configuration of Warning group 1 and ALRB register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 1 and ALRC register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 425

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[6] of DINT Description

Bit 0 Alarm configuration of Warning group 2 and ALR1 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 2 and ALR2 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

426 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[7] of DINT Description

Bit 0 Alarm configuration of Warning group 2 and ALR3 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 2 and ALR4 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 427

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[8] of DINT Description

Bit 0 Alarm configuration of Warning group 2 and ALR5 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 2 and AL6 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

428 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[9] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR7 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALR8 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 429

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[10] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR9 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALRA register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

430 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[11] of DINT Description

Bit 0 Alarm configuration of Warning group 2 and ALRB register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 2 and ALRC register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 431

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[12] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR1 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALR2 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

432 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[13] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR3 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALR4 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 433

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[14] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR5 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALR6 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

434 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[15] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR7 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALR8 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 435

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[16] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALR9 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALRA register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

436 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[17] of DINT Description

Bit 0 Alarm configuration of Warning group 3 and ALRB register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 3 and ALRC register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 437

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[18] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALR1 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALR2 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

438 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[19] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALR3 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALR4 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 439

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[20] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALR5 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALR6 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

440 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[21] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALR7 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALR8 register
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 441

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[22] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALR9 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALRA register.
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

442 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[23] of DINT Description

Bit 0 Alarm configuration of Warning group 4 and ALRB register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 4 and ALRC register.
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 443

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[24] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR1 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALR2 register.
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

444 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[25] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR3 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALR4 register.
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 445

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[26] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR5 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALR6 register.
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

446 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[27] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR7 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALR8 register.
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 447

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[28] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALR9 register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALRA register.
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

448 EIO0000002092 04/2020

 EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

WarningGroupMapping[29] of DINT Description

Bit 0 Alarm configuration of Warning group 5 and ALRB register.
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Bit 8
Bit 9
Bit 10
Bit 11
Bit 12
Bit 13
Bit 14
Bit 15
Bit 16 Alarm configuration of Warning group 5 and ALRC register.
Bit 17
Bit 18
Bit 19
Bit 20
Bit 21
Bit 22
Bit 23
Bit 24
Bit 25
Bit 26
Bit 27
Bit 28
Bit 29
Bit 30
Bit 31

EIO0000002092 04/2020 449

EMATVWarn - Extended Warnings of Process Drives (Supports 12 Alarm registers)

450 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Weighing Module
EIO0000002092 04/2020

Part IX
Weighing Module

Weighing Module

EIO0000002092 04/2020 451

Weighing Module

452 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Weighing Module Profile
EIO0000002092 04/2020

Chapter 20
Weighing Module Profile

Weighing Module Profile

Overview
This chapter describes the DFB of Weighing module profile.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Description 454
DFB Representation 455
Inputs 456
Outputs 459
Inputs/Outputs 462
Public Variables 468
Diagnostic Information Management 469
Configuration of PMESWT Module 470
PMESWT DFB Work Flow 478

EIO0000002092 04/2020 453

Weighing Module Profile

Description

General
EIPMPMESWT is a high performance weighing module controller which is used for vessels and silos
weighing, dosing process and dynamic weighing application on Ethernet IP using Explicit
unconnected messaging.

Function Description

Function Description
Control and Monitoring When owner is program, functional commands (Tare, Cancel Tare and Zero
Adjustment) are executed through user sequence DFB.
Also it enables you to monitor the device.
You can control the functional commands from the user sequence DFB.
Device status Displays the status of the device.
indication
Remote resetting Allows resetting of the device.
Owner Manages the control system which is the owner (Operator or Program).
Failure management Fail output pin will be high based on the following conditions. It requires
ResetFail/Reseting when failure occurred.
 Inoperable Device
 Communication interruption
 Configuration interruption

SignalFailure output pin will be high based on the following conditions. It

requiresResetFail/Reseting when failure occurred.
 Fail
 OOS mode

454 EIO0000002092 04/2020

 Weighing Module Profile

DFB Representation

Representation
The following figure represents the functional module of EIPMPMESWT.

EIO0000002092 04/2020 455

Weighing Module Profile

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control block.
0 = The entire DFB is restarted (statuses and output values are lost)
and output values are set to 0 and OOS mode is set to true.
1 = Enables communication with the devices for their operation.
ResetFail BOOL 1 = Resets the Fail and SignalFailure output pin to 0.
NOTE:
 When there is a detected configuration mismatch, output pins Fail
and SignalFailure cannot be reset to 0.
 When Owner is in Program and no detected failure, output pins
Fail and SignalFailure can be reset to 0.
DeviceAddress STRING[20] Device address on Ethernet IP network

456 EIO0000002092 04/2020

 Weighing Module Profile

Parameter Type Description

EngParam PMESWTEngParam Engineering parameters.
PMESWTParam The structure holds data containing the engineering parameter that the
block requires. (Constants enabled). The following table describes
parameter information.
Parameter Type Description
CommandCtrlWindow TIME Control time for operations. This is the time that the block waits
for the operations to be carried out by the device.
If a command has been sent and the command is not executed
within the time indicated by this variable, an alarm is issued.
The commands that are controlled are Tare, Cancel Tare,
and Zero Adjustment. In the event of a ResetFail, this is not
interpreted as an alarm. Instead, the detected failure
continues, and you have to reset the Reseting output.
Refresh TIME Refresh time for device data on Ethernet IP communications.
NOTE: This refresh operation is carried out on read variables.
Write requests are carried out when needed.
Scantime TIME Allows you to configure the time for which the alarm signals are
kept active. Helps the monitoring subsystem to acquire the
data for the alarms that are automatically reset.
MaxResetTime TIME When in automatic ResetMode, this variable is used to define
the maximum time that can elapse between 2 consecutive
resets.
EngUnit UINT User defined Engineering unit. Possible values are:
 0=g
 1 = kg
 2=t
 3 = oz
 4 = lb
 5=N

NOTE:
 DTM calibration window allows you to configure µdef and
N.m unit. This measurement unit is mainly used in strain
gauge and torque based applications respectively. Since
this control function will be used for weighing application.
µdef and N.m unit are not taken into consideration.
 If user enters other than predefined engineering unit, then
control function will consider the last configured
engineering unit.

EIO0000002092 04/2020 457

Weighing Module Profile

Parameter Type Description

EngParam ResetMode BOOL Enables to configure the type of reset. This type of reset is
used for communication interruption and device interruption.
The time defined in CommandCtrlWindow is used to define
the interval after which a reset has to be carried out. The first
reset is carried out after the time defined in
CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow *
2 elapses, so on. If the value of CommandCtrlWindow is 0 s,
its value is not used and is instead replaced with a value of 1
s. The following table describes the type of the reset:
Value Description
False Communications with the device is reset
with the ResetFail variable.
True Communications with the device is reset
automatically.
CommParam The structure holds data containing the engineering parameter that the
client block requires. The following table describes parameter
information.
Parameter Type Description
CommFailRetries INT Number of retries in case of a communication interruption.
Timeout TIME Time for which client will wait for a response, once the request
is initiated, before moving fail state.
InactivityTime TIME The period for which the client will not initiate a request after
the retries are expired.

Timing Diagram

458 EIO0000002092 04/2020

 Weighing Module Profile

Outputs

Output Parameter Description

Parameter Type Description

Ready BOOL 1 = The device is enabled and free of detected errors. The
device is ready to carry out weighing functional commands
(Tare, Cancel Tare and Zero Adjustment).
Fail BOOL 1 = A detected failure in the control block or in the device or a
communication interruption. To reset the Fail output pin, the
ResetFail input has to be activated. The last detected error
code is shown on FailCode.
NOTE: If a communication interruption occurs, the variables
being read from the device cease to be refreshed as a refresh
operation can no longer be carried out. The variables keep
their last value.
SignalFailure BOOL 1 = A detected failure in the control block or in the device or a
communication interruption or OOS mode is enabled.
NOTE: To reset the Fail output pin, the ResetFail input
has to be activated. The last detected error code is shown on
FailCode.
Warning BOOL 1 = An alarm has been activated for the device. It cannot be
reset because the signal remains active until the cause of the
alarm is removed or until the maximum set ScanTime is
reached.
FailCode Array [0..2] of INT When the Fail output is 1, it holds the code for the detected
error. If Fail bit is 0, it indicates the last detected error that
occurred. The detected error source is specified by using a 3
level structure. Refer to Diagnostic Information Management
(see page 469) for additional information.
WarningCode PMESWTWarning Holds a data structure with the alarm information currently on
the device.
The following table describes the WarningCode
Parameter Type Description
Device BOOL Detected warning when executing weighing
functional commands (Tare, Cancel
Tare and Zero Adjustment).
Order BOOL 1 = An alarm. The device is not responding
to the command within the time specified in
CommandCtrlWindow.

EIO0000002092 04/2020 459

Weighing Module Profile

Parameter Type Description

Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the maximum
time for resetting the detected failure.
When a communication reset is carried out with ResetFail,
the DFB tries to reset the detected failure within the time
period defined in CommandCtrlWindow.
If the detected failure is reset, the Fail and Reseting
output variables are reset (set to FALSE). If the detected
failure is not reset, the Reseting variable is set to FALSE
and the Fail variable remains TRUE. The ResetFail is
edge-based.
StatisticConnector DeviceStatisticCon- StatisticConnector has two client data, Read client and
nector2 Write client.
Parameter Type Description
ReadClient Statistic- StatisticConnector of Read client.
Connector1
WriteClient Statistic- StatisticConnector of Write client.
Connector1
StatisticConnector1 Information data is used with EIP communication to obtain
statistics on the bus network (requests carried out and time
between requests). This structure has been created for its use
together with the StatisticCounter DFB in General
Purpose library for communication.
Parameter Type Description
Start BOOL 1 = The operation has started.
EndOk BOOL 1 = The operation has ended successfully.
EndNOk BOOL 1 = The operation has ended with a
detected error.
TotalTime INT Total time taken for current request.
Status PMEStatus The structure holds data containing the information that the
function block extracts from the status variable of the
weighing module.
Parameter Type Description
DeviceStatus WORD Information on device calibration of the
weighing module.
MeasurementStatus WORD Measurement and device status of the
weighing module.
ResponseStatus WORD Response status provides the state of the
command currently being processed by the
device.

460 EIO0000002092 04/2020

 Weighing Module Profile

Parameter Type Description

NetPV REAL Net measurement value in Engineering units.
GrossPV REAL Gross measurement value in Engineering units.
TarePV REAL Tare measurement value in Engineering units.

EIO0000002092 04/2020 461

Weighing Module Profile

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

PMESWT_ST PMESWT_ST_DDT Device data structure that holds the minimum
information required for performing control and
monitoring functions. The information used by the
operator screen is readable/writable from the HMI or
SCADA system.
PMESWT_CFG PMESWT_CFG_DDT Data structure with the device information. The
information is used by the operator screen and is
readable from the HMI or SCADA system.
Workmemory ANY_ARRAY_INT Memory area which contains the client reference is
used for Ethernet/IP communications.

PMESWT_ST_DDT

Parameter Type Description

NetPV REAL Net measurement value in Engineering units.
GrossPV REAL Gross measurement value in Engineering units.
TarePV REAL Tare measurement value in Engineering units.
STW WORD Provides the device status. Access to the data held in this bit word
is read-only.
CFGW WORD Device control.
Provides the necessary means to control the device from the
supervision in operator mode (Owner = 1).
EngUnit UINT Unit for Processing the measurement values in Engineering unit.
Possible values are:
 0=g
 1 = kg
 2=t
 3 = oz
 4 = lb
 5=N

462 EIO0000002092 04/2020

 Weighing Module Profile

PMESWT_CFG_DDT

Parameter Type Description

MaxCapacity UDINT Maximum capacity of the weighing module.
CalibratedMaxCapacity UDINT Last calibrated maximum capacity of the weighing module.
CalibrationLoad UDINT Calibration load for calibration the device.
MeasurementStatus WORD Measurement and device status of the weighing module.
DeviceStatus WORD Informations on Device calibration of the weighing module.
ResponseStatus WORD Response status provides the state of the command
currently being processed by the device.
Warningcode WORD Alarm code information. Captures the values from the
WarningCode output.
Failcode0 INT Code of last level 0 detected error. Indicates that a detected
error has occurred FailCode[0].
Failcode1 INT Code of last level 1 detected error. Indicates that a detected
error has occurred FailCode[1].
Failcode2 INT Code of last level 2 detected error. Indicates that a detected
error has occurred FailCode[2].
ScaleInterval UINT Minimal difference between two consecutive indicated
values (either gross or net). Read & write access. Possible
value are: 1, 2, 5, 10, 20, 50
CalibratedScaleInterval UINT Indicates last calibrated Scale interval parameter.
Stepcalibration UINT Number of the step calibration in progress.
 1 = Calibration parameter mismatch
 2 = Physical calibration done
 3 = Zero acquisition done.
 4 = Load - 1 acquisition done.
 5 = Calibration done and parameters saved.
 6 = Calibration canceled.
 7 = Device not responding.
NOTE: In Step Calibration = 6, the last calibrated
values are returned back to the device register.
CalibratedCalibrationUnit UINT Indicates the lasts calibrated unit.
CalibrationUnit UINT Engineering unit which is used for calibrating the device.
Read and write access.
Possible values are:
 0=g
 1 = kg
 2=t
 3 = oz
 4 = lb
 5=N

EIO0000002092 04/2020 463

Weighing Module Profile

PMESWT_CFG.MeasurementStatus Structure

Bit Description
0 Measurement is OK.
1 Gross weight is less than negative Maximum capacity.
2 Gross weight is greater than maximum capacity.
3 Converter saturation or Analog signal out of A/D input range.
4 0 = Measurement is unstable.
1 = Measurement is stable.
5 Measurement out of ¼ division flag.
6 0 = Memory Ok.
1 = Detected memory failure.
7 0 = none.
1 = At least one preset tare is processed.
8 0 = Logical Input I0 state is disabled.
1 = Logical Input I0 state is enabled.
9 0 = Logical Input I1 state is disabled.
1 = Logical Input I1 state is enabled
10 0 = Logical Output S0 state is disabled.
1 = Logical Output S0 state is enabled.
11 0 = Logical Output S1 state is disabled.
1 = Logical Output S1 state is enabled.
12 0 = Logical Output S2 state is disabled.
1 = Logical Output S2 state is enabled.
13 0 = Logical Output S3 state is disabled.
1 = Logical Output S3 state is enabled
14 Tare process flag.
15 Zero/Tare process flag.

464 EIO0000002092 04/2020

 Weighing Module Profile

PMESWT_CFG.DeviceStatus Structure

Bit Description
0 User dosing cycle in progress.
1 At least one user calibration is processed.
2 Physical calibration is set.
3 Theoretical calibration is set.
4 Load cell wiring mode:
 0 = 4 wire
 1 = 6 wire

5 Termination resistor is set.

6 Theoretical zero done.
7 Theoretical calibration done.
8 Zero adjustment done.
9 Span adjustment done.
10 Start physical calibration done.
11 Zero acquisition done.
12 Load 1 acquisition done
13 Load 2 acquisition done.
14 Load 3 acquisition done.
15 Save calibration done.

PMESWT_CFG.ResponseStatus Structure

Bit Description
0 Ready to accept a new command.
1 Command execution in progress.
2 Command execution complete.
3 Detected error during command execution.

EIO0000002092 04/2020 465

Weighing Module Profile

PMESWT_ST.STW Structure

Bit Description
0 Unknown state.
1 Not ready.
2 -
3 Inoperable device.
4 Detected warning.
5 Communication interruption.
6 Requires Reseting.
7 -
8 Reseting.
9 Enable DFB.
10 SignalFailure.
11 Stability.
12 Cancel calibration disable.
13 REARM enable.
14 ExtCalibration - If OOS not enabled & calibration parameters are modified. Then this bit is
triggered to enable Accept Device Values.

PMESWT_ST.CFGW Structure

Bit Description
0 Reset Fail.
1 Owner.
 0 - Program
 1 - Operator

2 Tare command.
3 Cancel tare command.
4 Zero adjustment command.
5 Physical calibration command.
6 Validation step calibration.
7 Cancel calibration command.
10 Accept new values.
15 OOS mode. Enables to determine whether the device is out of service (1) or in use (0).

466 EIO0000002092 04/2020

 Weighing Module Profile

Warning Bit Structure

Bit Description
0 Refer to Device in the WarningCode (see page 459) output pin .
1 Refer to Order in the WarningCode (see page 459) output pin.

EIO0000002092 04/2020 467

Weighing Module Profile

Public Variables

Public Variable Description

Parameter Type Description

SC PMESWT_SC_DDT Provides the frequently needed data for monitoring and
controlling the DFB from sequence control.

PMESWT_SC_DDT

Parameter Type Description

NetPV REAL Net measurement value in Engineering unit.
GrossPV REAL Gross measurement value in Engineering unit.
TarePV REAL Tare measurement value in Engineering unit
Properties WORD Bits are expressed as ranked bit.
 Bit 0 (Owner): Provides the data needed to configure the DFB normally from
the monitoring subsystem.
 Read access 0 = Program
 1 = Operator

 Bit 1 (OOS): 1 = Out-Of-Service mode is selected. Read access.

 Bit 2 (Fail): A detected failure in the control block or in the device or a
communication interruption.
 Bit 3 (CONFIGFail): Configuration mismatch.
 Bit 4 (Stable): 1 = Measurement is stable, 0 = Measurement is not stable.
Read only.
 Bit 5 (TareDone): 1 = At least one tare is processed. Read only.
 Bit 6 (ZeroDone): 1 = At least one zero is processed. Read only.
 Bit 7 (CMDReady): Ready to accept a new command. Ready only.
 Bit 8 (CMDInProgress): Command execution in progress. Ready only.
 Bit 9 (CMDComplete): Command execution complete. Ready only.
 Bit 10 (CMDError): Detected error during command execution. Ready only.
 Bit 11: (TareCMD): Execution of tare command. Read/ Write access.
 Bit 12 (CancelTareCMD): Execution of cancel tare command. Read/ Write
access.
 Bit 13 (ZeroADJCMD): Execution of Zero adjustment command. Read/ Write
access.

468 EIO0000002092 04/2020

 Weighing Module Profile

Diagnostic Information Management

Overview
The diagnostic codes the device can return are read from the FailCode output variable.

Parameter Configuration Diagnostic Codes

Following are the Parameter configuration diagnostic codes:
 FAILCODE [0]: 16#0003
 FAILCODE [1]: 16#0000
 FAILCODE [2]: 16#0004

The above mentioned parameter configuration diagnostic codes occurs due to the given below
conditions:
 If user enters other than predefined engineering units through other source (DTM).
 If there is a difference in calibrated calibration parameters from device register parameters and
when Out Of Service mode is not enabled.
 When Out Of Service mode is enabled to start the calibration operation.

EthernetIP Communication Diagnostic Codes

This code indicates that communications have not been established and can be reset:
 FailCode[0]: 16#0002
 FailCode[1]: 16#0000
 FailCode[2]: 16#0004

After the communications have been established, check EthernetIP client diagnostic codes for
FailCode [0] and FailCode [1]. The components make a distinction between detected read
request and write request interruptions:
 FailCode[2]: 16#0001 Read
 FailCode[2]: 16#0002 Write

Device Diagnostic Codes

Following are the Device diagnostic codes:
 FailCode[0]: 16#0001
 FailCode[1]: 16#0000
 FailCode[2]: 16#0005

The above mentioned device diagnostic codes occurs due to the given below conditions:
 Detected Memory failure.
 Gross weight is less than negative maximum capacity.
 Gross weight is greater than maximum capacity.
 Converter saturation or analog signal out of A/D input range.

EIO0000002092 04/2020 469

Weighing Module Profile

Configuration of PMESWT Module

Procedure to Configure PMESWT Module on M580 Controller

Step Action
1 Create new Control Expert project by selecting M580 CPU.
2 Add PME SWT module by right clicking on empty slot of M580 Ethernet backplane and select PME SWT
module from new device window.

NOTE: Verify that you have not selected slot number 2, 8, 10 and 11 to add PME SWT device as Ethernet
Port is absent in those slots.

470 EIO0000002092 04/2020

 Weighing Module Profile

Step Action
3 Navigate to PLC bus (Project Browser →Configuration →PLC bus). Click on the Ethernet Port available
on the CPU which opens the port configuration. On the Security tab, click the Unlock Security button to
enable FTP, TFTP and HTTP communication.

4 Open DTM browser screen from Menu Tools → DTM Browser. Right click the master DTM in the DTM
browser and select PME SWT 0100 device DTM and click Add DTM.

EIO0000002092 04/2020 471

Weighing Module Profile

Step Action
5 Provide the Alias name for the DTM of your choice and click OK on Properties of device window.

472 EIO0000002092 04/2020

 Weighing Module Profile

Step Action
6 In the DTM browser, right click on the CPU master DTM and click Open. The Master DTM properties window
opens.

EIO0000002092 04/2020 473

Weighing Module Profile

Step Action
7 In the Master DTM properties window, navigate to Device List → PMESWT, select Address Setting tab to
configure the device IP address and address server configuration and then click Apply.

8 Build and transfer the Control Expert configuration file to the PLC.
9 In the DTM browser, right click on the M580 CPU DTM and then select Connect.

474 EIO0000002092 04/2020

 Weighing Module Profile

Step Action
10 In the DTM browser, right click on the PMESWT device DTM and then navigate to Device menu →
Additional functions → Transfer to FDR Server.

11 After successful transfer of FDR, device will become healthy and the following message window displays.

12 To verify that the device is connected or not, In the DTM browser, right click on the PMESWT device DTM
and select Connect. Now, the IP address and name of PMESWT module appears in bold lettering, indicating
both devices are connected.

EIO0000002092 04/2020 475

Weighing Module Profile

Procedure to save Calibration from Device to FDR Server

It is recommended to perform the below steps at the end of each calibration from Supervision.

Step Action
1 In the DTM browser, right click on the PMESWT device DTM and then navigate to Device menu →
Additional functions → Calibration.

476 EIO0000002092 04/2020

 Weighing Module Profile

Step Action
2 In the DTM calibration window, click Save calibration from device to FDR server.

EIO0000002092 04/2020 477

Weighing Module Profile

PMESWT DFB Work Flow

Using the Control Function Block

Step Action
1 During rising edge of EnableDFB or first download, control function is set to Owner (Program) and
Mode (In-Service).
2 Once the device is ready for operation, control function reads the measurement values and
calibration parameters from the device and process the EU conversion accordingly.
3 If you want to perform calibration, then you need to set Owner (Operator) and Mode (Out Of
Service). For execution of calibration commands refer Weighing Module Calibration Commands
Flow Chart (see page 479).
4 For execution of functional commands refer Weighing Module Functional Commands Flow Chart
(see page 480).
5 During operation, if you perform calibration from external source (DTM), then control function will
generate detected configuration failure because the last calibrated value and new value read from
device register are different (calibration parameter mismatch). In such scenario, if you have
performed calibration through external source (DTM), then Accept Device Values button in the
calibration faceplate gives flexibility to accept the calibrated values. Accept Device Values button
is enabled only when there is calibrated parameter mismatch (detected configuration failure).
You can clear this detected failure by clicking Accept Device Values button or start calibration
procedure from the faceplate, by taking the object in Out Of Service mode.

478 EIO0000002092 04/2020

 Weighing Module Profile

Weighing Module Calibration Commands Flow Chart

EIO0000002092 04/2020 479

Weighing Module Profile

NOTE:
 Initially you have to configure the weighing module through DTM.
 It is suggested to perform the calibration from the faceplate only.
 Before the start of calibration you need to verify that calibration parameters are entered
properly.
 In Load acquisition state (after zero acquisition done) during calibration you need to verify that
a physical load is placed on the load cell.
 At the end of each calibration, once the device reset is performed and before giving ResetFail
you need to verify that the physical device is healthy.
 In Step Calibration = 6, the last calibrated values are returned back to the device register.

Weighing Module Functional Commands Flow Chart

480 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Safety Module
EIO0000002092 04/2020

Part X
Safety Module

Safety Module

EIO0000002092 04/2020 481

Safety Module

482 EIO0000002092 04/2020

 Modicon Libraries General Purpose
XPSMC
EIO0000002092 04/2020

Chapter 21
XPSMC - XPSMC Reader (16 Inputs/ 32 Inputs)

XPSMC - XPSMC Reader (16 Inputs/ 32 Inputs)

Overview
This chapter describes the XPSMC DFB.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
DFB Representation 484
Inputs 485
Outputs 486
Inputs/Outputs 495
Public Variables 500

EIO0000002092 04/2020 483

XPSMC

DFB Representation

Representation
The following figure represents XPSMC DFB in Control Expert:

484 EIO0000002092 04/2020

 XPSMC

Inputs

Input Parameter Description

Parameter Type Description

EnableDFB BOOL This input enables the normal execution of the control
block.
 0 = The entire DFB is restarted (states, output values,
counters are lost) and output values are set to 0.
 1 = Enables communications with the devices for
their operation.
ResetFail BOOL 1 = Resets the Fail output parameter to 0 or in case
of inoperable device, sends a reset command to the
device if ControlCommand is 1.
CommunicationOk BOOL 1 = The node is present on the bus. You can find this
variable in Ethernet communications.
Inputs ANY_ARRAY_INT Holds an array structure with data obtained from the
device. You can control the starter/controller with this
input variable. This input is reserved for the DFB, and
you cannot use this input directly. For the control block to
work properly, allocate the structure (%MWx). Refer to
the Communications Technologies (see page 503).
Based on the device and the relevant communications,
the following structure is used.
The information available for controllers on an XPSMC
reader is shown in the following table:
Parameter Type Description
Inputs [0] INT Status register.
Inputs [1] INT I/O module status register.
Inputs [2] INT Notification register.
Inputs [3] INT I/O status.

EIO0000002092 04/2020 485

XPSMC

Outputs

Output Parameter Description

Output Type Description

Ready BOOL 1 = The device is enabled and free of detected errors. The device
is ready to carry out or carrying out any Run or Stop command.
Fail BOOL 1 = A detected failure in the control block or in the device or
communication interruption.To reset the Fail output pin, the
ResetFail input has to be activated. The last detected error
code is shown on FailCode.
Warning BOOL 1 = An alarm has been activated for the device. It does not affect
the block operation and does not need to be reset.
The signal remains active until the cause for the alarm
disappears.
FailCode ARRAY [0..2] OF INT When Fail output is 1, this variable holds the code for the
detected error.
If Fail output is 0, it indicates the last detected detected error
that occurred.
The detected error source is specified by a three-level structure.
ExtControlled BOOL 1 = The device is being controlled from an external source (for
example, from the console, from a push-button panel, or from the
monitoring system) to the system.
Provides information for programming.
NOTE: The ControlCommand signal, the Owner variable, and
the ForcedLocalMode status are used to activate this signal.
You cannot use this signal as a ControlCommand input.

486 EIO0000002092 04/2020

 XPSMC

Output Type Description

Reseting BOOL 1 = A reset is being carried out.
The CommandCtrlWindow variable indicates the maximum time
for resetting the detected failure.
When a device or communication reset is carried out with
ResetFail, the DFB tries to reset the detected failure within the
time period defined in CommandCtrlWindow.
If the detected failure is reset, the Fail and Reseting output
variables are reset (set to FALSE). Alternatively, if the detected
failure is not reset, the Reseting variable is set to FALSE and
the Fail variable remains TRUE. The ResetFail is edge-
based.
Refer to the Timing diagram.

EIO0000002092 04/2020 487

XPSMC

Output Type Description

Status XPSMCSTATUS Holds data structure containing the information that the module
extracts from the status variable of XPSMC control blocks.
The following table describes the status information:
Parameter Type Description
Run BOOL 1 = Running status of the device.
LoadingConfiguration BOOL 1 = The device is loading the configuration.
InternalError BOOL 1 = The device has an internal detected error.
ExternalError BOOL 1 = The device has an external detected error.
Stop BOOL 1 = Stopped status of the device.
FromRunToStop BOOL 1 = The device is stopping.
RebootSwitch BOOL 1 = Enables restart switch.
DeviceActive BOOL 1 = Working condition of fieldbus.
XPSMC BOOL 1 = The device is an XPSMC16.
0 = The device is an XPSMC32.
Checking BOOL 1 = Automatic checking is enabled.
ConfigurationOK BOOL 1 = Valid configuration.
OrderStop BOOL 1 = Stop order received

488 EIO0000002092 04/2020

 XPSMC

Output Type Description

IOMap XPSMCIOMAP Holds a data structure with information on the state of the inputs
and outputs of the controller.
The following table describes the IOMap:
Parameter Type Description
I1 BOOL 1 = The state of the digital input I1.
I2 BOOL 1 = The state of the digital input I2.
I3 BOOL 1 = The state of the digital input I3.
I4 BOOL 1 = The state of the digital input I4.
I5 BOOL 1 = The state of the digital input I5.
I6 BOOL 1 = The state of the digital input I6.
I7 BOOL 1 = The state of the digital input I7.
I8 BOOL 1 = The state of the digital input I8.
I9 BOOL 1 = The state of the digital input I9.
I10 BOOL 1 = The state of the digital input I10.
I11 BOOL 1 = The state of the digital input I11.
I12 BOOL 1 = The state of the digital input I12.
I13 BOOL 1 = The state of the digital input I13.
I14 BOOL 1 = The state of the digital input I14.
I15 BOOL 1 = The state of the digital input I15.
I16 BOOL 1 = The state of the digital input I16.
O1 BOOL 1 = The state of the digital output O1.
O2 BOOL 1 = The state of the digital output O2.
O3 BOOL 1 = The state of the digital output O3.
O4 BOOL 1 = The state of the digital output O4.
O5 BOOL 1 = The state of the digital output O5.
O6 BOOL 1 = The state of the digital output O6.
R1 BOOL 1 = The state of the digital output R1.
R2 BOOL 1 = The state of the digital output R2.

EIO0000002092 04/2020 489

XPSMC

Output Type Description

IOMapExt XPSMCIOMAPEXT Standard inputs/outputs information of the controllers.
The following table describes the IOMapExt:
Parameter Type Description
I17 BOOL 1 = The state of the digital input I17.
I18 BOOL 1 = The state of the digital input I18.
I19 BOOL 1 = The state of the digital input I19.
I20 BOOL 1 = The state of the digital input I20.
I21 BOOL 1 = The state of the digital input I21.
I22 BOOL 1 = The state of the digital input I22.
I23 BOOL 1 = The state of the digital input I23.
I24 BOOL 1 = The state of the digital input I24.
I25 BOOL 1 = The state of the digital input I25.
I26 BOOL 1 = The state of the digital input I26.
I27 BOOL 1 = The state of the digital input I27.
I28 BOOL 1 = The state of the digital input I28.
I29 BOOL 1 = The state of the digital input I29.
I30 BOOL 1 = The state of the digital input I30.
I31 BOOL 1 = The state of the digital input I31.
I32 BOOL 1 = The state of the digital input I32.

490 EIO0000002092 04/2020

 XPSMC

Output Type Description

ErrorMap XPSMCErrorMAP Holds a data structure with information on the errors detected of
the inputs and outputs of the controller.
The following table describes the ErrorMap:
Parameter Type Description
I1 BOOL 1 = Signals a detected error of the digital input I1.
I2 BOOL 1 = Signals a detected error of the digital input I2.
I3 BOOL 1 = Signals a detected error of the digital input I3.
I4 BOOL 1 = Signals a detected error of the digital input I4.
I5 BOOL 1 = Signals a detected error of the digital input I5.
I6 BOOL 1 = Signals a detected error of the digital input I6.
I7 BOOL 1 = Signals a detected error of the digital input I7.
I8 BOOL 1 = Signals a detected error of the digital input I8.
I9 BOOL 1 = Signals a detected error of the digital input I9.
I10 BOOL 1 = Signals a detected error of the digital input I10.
I11 BOOL 1 = Signals a detected error of the digital input I11.
I12 BOOL 1 = Signals a detected error of the digital input I12.
I13 BOOL 1 = Signals a detected error of the digital input I13.
I14 BOOL 1 = Signals a detected error of the digital input I14.
I15 BOOL 1 = Signals a detected error of the digital input I15.
I16 BOOL 1 = Signals a detected error of the digital input I16.
C1 BOOL 1 = Signals a detected error of the digital output C1.
C2 BOOL 1 = Signals a detected error of the digital output C2.
C3 BOOL 1 = Signals a detected error of the digital output C3.
C4 BOOL 1 = Signals a detected error of the digital output C4.
C5 BOOL 1 = Signals a detected error of the digital output C5.
C6 BOOL 1 = Signals a detected error of the digital output C6.
C7 BOOL 1 = Signals a detected error of the digital output C7.
C8 BOOL 1 = Signals a detected error of the digital output C8.

EIO0000002092 04/2020 491

XPSMC

Output Type Description

ErrorMapExt XPSMCERRORMAPEXT Holds a data structure with information on the extended errors
detected of the inputs and outputs of the controller.
The following table describes the ErrorMapExt:
Parameter Type Description
I17 BOOL 1 = Signals a detected error of the digital input I17.
I18 BOOL 1 = Signals a detected error of the digital inputI18.
I19 BOOL 1 = Signals a detected error of the digital input I19.
I20 BOOL 1 = Signals a detected error of the digital input I20.
I21 BOOL 1 = Signals a detected error of the digital input I21.
I22 BOOL 1 = Signals a detected error of the digital input I22.
I23 BOOL 1 = Signals a detected error of the digital input I23.
I24 BOOL 1 = Signals a detected error of the digital input I24.
I25 BOOL 1 = Signals a detected error of the digital input I25.
I26 BOOL 1 = Signals a detected error of the digital input I26.
I27 BOOL 1 = Signals a detected error of the digital input I27.
I28 BOOL 1 = Signals a detected error of the digital input I28.
I29 BOOL 1 = Signals a detected error of the digital input I29.
I30 BOOL 1 = Signals a detected error of the digital input I30.
I31 BOOL 1 = Signals a detected error of the digital input I31.
I32 BOOL 1 = Signals a detected error of the digital input I32.
Diagnostics ARRAY[0..2] OF Advanced diagnostics of the device.
XPSMCDiagnostic
XPSMC_IO XPSMC_IO_DDT Standard inputs/outputs information of the controllers for the
controller base (used by HMI/SCADA).
The following table describes the XPSMC_IO:
Parameter Type Description
InputsMapExt WORD Extended input status on the controller base.
Refer to the InputMapExt table below.
InputsErrorMapExt WORD Status of the detected errors in the extended input on
the controller base.
Refer to the InputErrorMapExt table below.

492 EIO0000002092 04/2020

 XPSMC

InputMapExt
The following table describes the InputMapExt variable:

Bit Description
0 Status of the extended input I17 on a controller base.
1 Status of the extended input I18 on a controller base.
2 Status of the extended input I19 on a controller base.
3 Status of the extended input I20 on a controller base.
4 Status of the extended input I21 on a controller base.
5 Status of the extended input I22 on a controller base.
6 Status of the extended input I23 on a controller base.
7 Status of the extended input I24 on a controller base.
8 Status of the extended input I25 on a controller base.
9 Status of the extended input I26 on a controller base.
10 Status of the extended input I27 on a controller base.
11 Status of the extended input I28 on a controller base.
12 Status of the extended input I29 on a controller base.
13 Status of the extended input I30 on a controller base.
14 Status of the extended input I31 on a controller base.
15 Status of the extended input I32 on a controller base.

EIO0000002092 04/2020 493

XPSMC

InputErrorMapExt
The following table describes the InputErrorMapExt variable:

Bit Description
0 Status of the detected error in the extended input I17 on a controller base.
1 Status of the detected error in the extended input I18 on a controller base.
2 Status of the detected error in the extended input I19 on a controller base.
3 Status of the detected error in the extended input I20 on a controller base.
4 Status of the detected error in the extended input I21 on a controller base.
5 Status of the detected error in the extended input I22 on a controller base.
6 Status of the detected error in the extended input I23 on a controller base.
7 Status of the detected error in the extended input I24 on a controller base.
8 Status of the detected error in the extended input I25 on a controller base.
9 Status of the detected error in the extended input I26 on a controller base.
10 Status of the detected error in the extended input I27 on a controller base.
11 Status of the detected error in the extended input I28 on a controller base.
12 Status of the detected error in the extended input I29 on a controller base.
13 Status of the detected error in the extended input I30 on a controller base.
14 Status of the detected error in the extended input I31 on a controller base.
15 Status of the detected error in the extended input I32 on a controller base.

494 EIO0000002092 04/2020

 XPSMC

Inputs/Outputs

Input/Output Parameter Description

Parameter Type Description

XPSMC_ST XPSMC_ST_DDT Device data structure holds the minimum information required
for performing control and monitor functions. The information
used by the operator screen is readable/writable from the
HMI/SCADA system.
XPSMC_CFG XPSMC_CFG_DDT Data structure with device information. The information used by
the operator screen is readable from the HMI/SCADA system.

XPSMC_ST_DDT Type

Name Type Description

STW WORD Provides the device status. Access to the data held in this bit word is
read-only.
CFGW WORD Device control.
Provides the data to control the device from the monitoring subsystem
or from the operator screen if Owner (1), or only from the monitoring
subsystem if Owner (0).
If Owner is 0, it takes the input variables of the DFB as a value for
reading from the HMI/SCADA system.

XPSMC_CFG_DDT Type

Name Type Description

DataStatus WORD Information on the device status.
InputsMap WORD Status of the standard inputs.
OutputMaps WORD Status of the outputs.
InputErrorMaps WORD Status of the detected errors in the standard inputs.
OutputErrorMaps WORD Status of the found errors in the outputs.
DiagnosticIndex1 INT Diagnostic device number 1.
DiagnosticIndex2 INT Diagnostic device number 2.
DiagnosticIndex3 INT Diagnostic device number 3.
DiagnosticMessage1 INT Diagnostic message 1.
DiagnosticMessage2 INT Diagnostic message 2.
DiagnosticMessage3 INT Diagnostic message 3.

EIO0000002092 04/2020 495

XPSMC

Name Type Description

FailCode0 INT Code of last level 0 detected error. Indicates which detected error has
occurred,
FailCode1 INT Code of last level 1 detected error. Indicates which detected error has
occurred.
FailCode2 INT Code of last level 2 detected error. Indicates which detected error has
occurred.

XPSMC_ST.STW Word Structure

Bit Description
0 Unknown device status or communication interruption. No variable refreshing.
1 Not ready.
4 Alarm on the device or repetitive detected fault alarm requires resetting.
5 Communication interruption.
6 Requires resetting. ResetFail is required.
9 Refer to the EnableDFB input pin (see page 485).

XPSMC_ST.CFGW Word Structure

Bit Description
0 Refer to the ResetFail input pin (see page 485).
1 Owner.

NOTE: The Owner bit enables to control the block from the XPSMC_ST_DDT input/output structure
ignoring the input signals of the block. It enables control from a monitoring system (HMI, SCADA,
operator screen) in the Manual mode without using the programmed switching operation.

XPSMC_CFG.DataStatus Word Structure

Bit Description
0 Refer to the Run in the Status output pin (see page 486).
1 Refer to the LoadingConfiguration in the Status output pin (see page 486).
2 Refer to the InternalError in the Status output pin (see page 486).
3 Refer to the ExternalError in the Status output pin (see page 486).
4 Refer to the Stop in the Status output pin (see page 486).
5 Refer to the FromRunToStop in the Status output pin (see page 486).

496 EIO0000002092 04/2020

 XPSMC

Bit Description
6 Refer to the RebootSwitch in the Status output pin (see page 486).
7 Refer to the DeviceActive in the Status output pin (see page 486).
8 Refer to the XPSMC in the Status output pin (see page 486).
9 Refer to the Checking in the Status output pin (see page 486).
10 Refer to the ConfigurationOK in the Status output pin (see page 486).
11 Refer to the OrderStop in the Status output pin (see page 486).

XPSMC_CFG.InputsMap Word Structure

Bit Description
0 Status of the standard input I1 on a controller base.
1 Status of the standard input I2 on a controller base.
2 Status of the standard input I3 on a controller base.
3 Status of the standard input I4 on a controller base.
4 Status of the standard input I5 on a controller base.
5 Status of the standard input I6 on a controller base.
6 Status of the standard input I7 on a controller base.
7 Status of the standard input I8 on a controller base.
8 Status of the standard input I9 on a controller base.
9 Status of the standard input I10 on a controller base.
10 Status of the standard input I11 on a controller base.
11 Status of the standard input I12 on a controller base.
12 Status of the standard input I13 on a controller base.
13 Status of the standard input I14 on a controller base.
14 Status of the standard input I15 on a controller base.
15 Status of the standard input I16 on a controller base.

EIO0000002092 04/2020 497

XPSMC

XPSMC_CFG.OutputsMap Word Structure

Bit Description
0 Status of the output O1 on a controller base.
1 Status of the output O2 on a controller base.
2 Status of the output O3 on a controller base.
3 Status of the output O4 on a controller base.
4 Status of the output O5 on a controller base.
5 Status of the output O6 on a controller base.
6 Status of the output R1 on a controller base.
7 Status of the output R2 on a controller base.

XPSMC_CFG.InputsErrorMap Word Structure

Bit Description
0 Status of the detected errors in the standard input I1 on a controller base.
1 Status of the detected errors in the standard input I2 on a controller base.
2 Status of the detected errors in the standard input I3 on a controller base.
3 Status of the detected errors in the standard input I4 on a controller base.
4 Status of the detected errors in the standard input I5 on a controller base.
5 Status of the detected errors in the standard input I6 on a controller base.
6 Status of the detected errors in the standard input I7 on a controller base.
7 Status of the detected errors in the standard input I8 on a controller base.
8 Status of the detected errors in the standard input I9 on a controller base.
9 Status of the detected errors in the standard input I10 on a controller base.
10 Status of the detected errors in the standard input I11 on a controller base.
11 Status of the detected errors in the standard input I12 on a controller base.
12 Status of the detected errors in the standard input I13 on a controller base.
13 Status of the detected errors in the standard input I14 on a controller base.
14 Status of the detected errors in the standard input I15 on a controller base.
15 Status of the detected errors in the standard input I16 on a controller base.

498 EIO0000002092 04/2020

 XPSMC

XPSMC_CFG.OutputsErrorMap Word Structure

Bit Description
0 Status of the detected errors in the output C1 on a controller base.
1 Status of the detected errors in the output C2 on a controller base.
2 Status of the detected errors in the output C3 on a controller base.
3 Status of the detected errors in the output C4 on a controller base.
4 Status of the detected errors in the output C5 on a controller base.
5 Status of the detected errors in the output C6 on a controller base.
6 Status of the detected errors in the output C7 on a controller base.
7 Status of the detected errors in the output C8 on a controller base.

EIO0000002092 04/2020 499

XPSMC

Public Variables

Public Variable Description

Variable Type Description

CommandCtrlWindow TIME Control time for operations. The block waits for the operations to be
carried out by the device during this time.
If a command has been sent and the command is not executed
within the time indicated by this variable, a follow-up alarm is issued.
The command that is controlled is Run. In case of ResetFail, this
is not interpreted as an alarm. Instead, the detected failure
continues, and you have to reset the Reseting output.
ScanTime TIME Allows to configure the time during which the alarm signals are kept
active.
Helps the monitoring subsystem to acquire the data for the alarms
that are automatically reset.
ResetMode BOOL Enables to configure the type of reset. This type of reset is used for
communication interruption and inoperable device.
The time defined in CommandCtrlWindow is used to define the
interval after which a reset needs to be carried out. The first reset is
carried out after the time defined in CommandCtrlWindow elapses.
The second reset is carried out after CommandCtrlWindow * 2
elapses, and so on. If the value of CommandCtrlWindow is 0 s, its
value is not used and is instead replaced with a value of 1 s.
The following table describes the type of the reset:
Variable Description
Value
FALSE Communications are/the device is reset with the ResetFail
variable.
TRUE Communications are/the device is reset automatically.
MaxResetTime TIME When in automatic ResetMode, this variable is used to define the
maximum time that can elapse between 2 consecutive resets.
Refer to the Timing diagram below.

500 EIO0000002092 04/2020

 XPSMC

Timing diagram:

EIO0000002092 04/2020 501

XPSMC

502 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Communication Technologies
EIO0000002092 04/2020

Part XI
Communication Technologies

Communication Technologies

Overview
This part describes the communication technologies used in the Devices library.
These function blocks do not reflect any specific installation.

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

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 Ethernet Technology 505
23 Modbus over ULP Technology 591
24 Modbus Technology 595
25 Profibus Technology 629
26 CANOpen Technology 653

EIO0000002092 04/2020 503

Communication Technologies

504 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Ethernet Technology
EIO0000002092 04/2020

Chapter 22
Ethernet Technology

Ethernet Technology

Overview
This chapter describes configuration details of Ethernet technology on various devices.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
22.1 CommunicationOK Variable 506
22.2 ATV71/61 Control Block on Ethernet with IO Scanning 508
22.3 Tesys T Control Block on Ethernet 519
22.4 Modbus Devices Used Through Gateway 525
22.5 Configuration Procedure for Device DTM 533
22.6 Modbus TCPIP - Implicit with IOScanning 553
22.7 Modbus TCPIP - Implicit with Device DTM 562
22.8 Modbus TCPIP - Explicit 580
22.9 Modbus TCPIP - Explicit with Gateway 584

EIO0000002092 04/2020 505

Ethernet Technology

Section 22.1
CommunicationOK Variable

CommunicationOK Variable

Description

IODDT Variable Description

To check the presence of a device on an Ethernet network, you can check the IODDT variable for
Ethernet communications.
NOTE: The variable is pre-defined by the manufacturer, which includes input and output language
objects that are part of the channel corresponding to a module used for a specific function.
This table describes Ethernet communication IODDTs that depend on the type of hardware
installed:

Sl.NO IODDT Name Module Name Platform

1 T_COM_ETH_BMX – M340 Platform

System Word Description

The System Word is used instead of IODDT variable in Quantum platform device on an Ethernet
network. For example, %SW160 and %SW167.
This figure shows the IOScanning rows on Ethernet communication:

Declaring a variable as an IODDT enables to obtain an indicator of the communication status for
each IOScanning row.
NOTE: Templates generated with an Ethernet communications network by the SGStudio program
have the Ethernet variable correctly declared and allocated. If a user template is used, declare this
variable.
In the case of the Quantum Copro platform, the IODDT variable is not used. System words are
used instead (%SW160 to %SW167). For example, IOScanning line 1 corresponds to %SW160.0.

506 EIO0000002092 04/2020

 Ethernet Technology

In the case of the Quantum NOE platform, the IODDT variable is not used. System words are used
instead (%IW1 to %IW8). For example, IOScanning line 1 corresponds to %IW1.0.
For example, if you use the SG Workbench template, the CommunicationOK input is shown as
Ethernet.REFRESH_IO_X, which has to be replaced with Ethernet.REFRESH_IO_1.0 for line 1.
The IODDT variable has to be addressed with %cha.b.c, where:
a = Rack number
b = Number of slots inside the PLC
c = Number of channels in the Ethernet module
In the following example, the address for the IODDT variable is %CH0.2.0.
As for the device defined on the first IOScanning line: Ethernet.REFRESH_IO_1.

EIO0000002092 04/2020 507

Ethernet Technology

Section 22.2
ATV71/61 Control Block on Ethernet with IO Scanning

ATV71/61 Control Block on Ethernet with IO Scanning

Overview
This section provides the configuration and setup details involving the Altivar 71 and Altivar 61
variable speed drives connected through Modbus TCP (Ethernet) in the Modicon M340, M580, and
Quantum automation platforms.

What Is in This Section?

This section contains the following topics:
Topic Page
Introduction 509
Preparing the Device 510
ATV 71/61 IO Scanner Configuration 511
Modifying the ATV7161 IOScanner Configuration 514
Configuring the IO Scanning of the Controller 517

508 EIO0000002092 04/2020

 Ethernet Technology

Introduction

The Device library currently incorporates many elements with Ethernet technology. One example
is the ATV 71 and ATV 61 speed drivers and the Tesys T motor protection devices. You can use
any device in serial Modbus mode by using a serial Modbus–Modbus TCP gateway and the
EGtwMB block from the Communication library.
You can operate both ATV 61 and ATV 71 devices and Tesys T devices with messaging or IO
scanning. This documentation refers explicitly to device configurations designed to work with
IOScanning because working with messaging requires the exact same steps until the step of
assigning an IP address to the device. After assigning an IP address to the device is completed,
the address has to be fed to the DeviceAddress input on each one of the devices.

ATV71/61 Control Block on Ethernet

WARNING
UNINTENDED EQUIPMENT OPERATION
Adapt the below examples to configure device or communication network parameters before you
implement them.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Refer to the configuration manual for communication networks and Control devices.
This figure represents the hardware configuration:

EIO0000002092 04/2020 509

Ethernet Technology

Preparing the Device

Introduction
Configure each Altivar 71/61 device in such a way that it is on the same network as the PLC that
controls it.

Graphic Terminal Settings Description

The following settings need to be defined from the graphic terminal.
1. DRIVE MENU
1.9 COMMUNICATIONS
ETHERNET
IP card (the device IP address)
IP mask (Mask)
IP Gate IP (Gate IP, if any)
IP Process (IP of the controller that controls the device)
You can configure the Process IP section if you want only one single specific controller to control
the speed driver. In this case, only the device with the specified IP can access the speed driver. If
access control is not required, do not specify an IP, that is, enter 0.0.0.0.
After you have configured this data, you can access the device through the Ethernet network.

510 EIO0000002092 04/2020

 Ethernet Technology

ATV 71/61 IO Scanner Configuration

Overview
To implement I/O exchange operations between the speed driver and the PLC, both the
ATV 61/ATV 71 IO Scanner and I/O scanning of the controllers have to be configured.

IO Scanner Configuration Procedure

To configure the IO Scanner, you have to access the ATV61/ATV71 webpage. To do this, open
Windows Explorer and enter the IP address that has been specified for the device. For example,
the address is: http://197.129.17.118/.
NOTE: To access the device from the computer, the computer has to be on the same network as
the speed driver.
For example, if IP address of the speed driver is 197.129.17.118 and the subnet mask is
255.255.255.0, the valid IP address for the PC will be 192.129.17.xxx, where:
xxx = Can be any number except for 118 (which is the number corresponding to the speed driver).
This table shows the step-by-step configuration of the ATV71/61 I/O scanner:

STEP ACTION RESULT

1 Enter the Speed The speed drivers login screen appears.
drivers IP address This figure represents the speed drivers login screen:
into widows
explorer

The default values are:

user name: USER
Password: USER
NOTE: If you change these values, store the values because you cannot
access the webpage if the values are not known.

EIO0000002092 04/2020 511

Ethernet Technology

STEP ACTION RESULT

2 Enter the user The Home screen for the speed drivers appears:
name and This figure represents the Speed drivers Home screen:
password.

512 EIO0000002092 04/2020

 Ethernet Technology

STEP ACTION RESULT

3 Click Setup tab to Setup menu appears.
access the This figure represents the home screen with Setup menu:
Configuration
menu.

4 Select the IO IO SCANNER screen appears.

Scanner option (on This figure represents the default configuration values of the latest
the left menu) to configuration:
display the IO
SCANNER screen.

Change the configuration to match the inputs and outputs expected by the
device defined in Control.
The configuration required corresponds to the inputs (ATV7161_IN_DDT)
and outputs (ATV7161_OUT_DDT).

EIO0000002092 04/2020 513

Ethernet Technology

Modifying the ATV7161 IOScanner Configuration

Procedure
After the IOScanner is configured, follow the procedure to modify the IOScanner configuration:

STEP ACTION RESULT

1 Click PassWord IO SCANNER home screen refreshes displaying Enter you password field
button on the IO instead of PassWord button to enter the appropriate password.
SCANNER home This figure represents the IO SCANNER home screen:
screen.
Enter the default
password (USER).

NOTE: You can change this password but store it in the memory to modify
this configuration in future.
2 After entering the IO SCANNER home screen with disable option appears:
password, disable
IO SCANNER by
selecting No from
IO Scanner list.

514 EIO0000002092 04/2020

 Ethernet Technology

STEP ACTION RESULT

3 Enter the modified The modified final table appears.
configuration. This figure represents modified configuration screen:

4 After you have This action causes the speed driver to store the new configuration in its
finished setting the memory.
configuration, click
Save button.

EIO0000002092 04/2020 515

Ethernet Technology

STEP ACTION RESULT

5 Activate the IO The reactivated IO SCANNER screen appears.
SCANNER again to This figure represents reactivated IOScanner configuration screen:
enable data
exchange with the
PLC by selecting
Yes.

NOTE: If you have followed the above steps, the IO SCANNER home screen with the data
configured in the speed driver appears when it is activated.

516 EIO0000002092 04/2020

 Ethernet Technology

Configuring the IO Scanning of the Controller

Description
To control the speed driver, configure the I/O scanning of the controller.
This configuration is different for each module and needs to match corresponding IO Scanner
configuration of the devices.
In the Modicon M340 automation platform, IO scanning is only available if the hardware
configuration features a NOE communications module.
This parameter configuration is used to define the relationship between the function I/Os and the
device I/Os, which are configured with the IO Scanner.
The ATV7161 function requires 8 input words in the ***_Inputs variable (ANY_ARRAY_INT) and
6 output words for the ***_Outputs variable (ANY_ARRAY_INT).
The first I/O scanning word is reserved, this means that an I/O Scanning row with 9 read words and
7 write words has to be configured.
The following table describes data variables:

DFB Variable Parameter Device variable Type Direction

Input0 Reserved Read %MWx
Input1 ETA Status Word (ETA) Read %MWx+1
Input2 RFRD Output Velocity (rpm) Read %MWx+2
Input3 ERRD Code of last detected error Read %MWx+3
Input4 LCR Present Current Read %MWx+4
Input5 OTR Current Torque Read %MWx+5
Input6 IL1R IL1I (Digital inputs) Read %MWx+6
Input7 AI1C AI1 (Analog input 1) Read %MWx+7
Input8 AI2C AI2 (Analog input 2) Read %MWx+8
Output0 Reserved Write %MWy
Output1 CMD CWD (Control Word) Write %MWy+1
Output2 LFRD Speed Set-Point Write %MWy+2
Output3 OL1R OL1R (ATV digital outputs) Write %MWy+3
Output4 AO1C AO1 (Analog output 1) Write %MWy+4
Output5 AO2C AO2 (Analog output 2) Write %MWy+5
Output6 AO3C AO3 (Analog output 3) Write %MWy+6

EIO0000002092 04/2020 517

Ethernet Technology

Scanning Row Appearance

The following figure shows an example of how a scanning row would look in Control Expert.
In this example, 9 words are read starting with %MW500 and 7 words are written starting with
%MW550. The slave variables need to have a value of 0.
The following figure shows the controller IO scanning rows.

When this configuration is used, the data used by the controller is as follows
The following figure shows configuration data used by the controller:

518 EIO0000002092 04/2020

 Ethernet Technology

Section 22.3
Tesys T Control Block on Ethernet

Tesys T Control Block on Ethernet

Overview
This section provides the complete connection and setup details of TeSys T devices connected
through Modbus TCP (Ethernet) on Modicon M340, M580, or Quantum automation platforms.

What Is in This Section?

This section contains the following topics:
Topic Page
Tesys T Hardware Configuration 520
Preparing the Device 521
Configuring the IO Scanning of the Controller 523

EIO0000002092 04/2020 519

Ethernet Technology

Tesys T Hardware Configuration

WARNING
UNINTENDED EQUIPMENT OPERATION
Adapt the below examples to configure device or communication network parameters before you
implement them.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Refer to the configuration manual for communication networks and Control devices.
The following figure represents the hardware configuration of the Tesys T devices:

520 EIO0000002092 04/2020

 Ethernet Technology

Preparing the Device

Introduction
Configure each Tesys T devices on the same network as the PLC that controls it.

Configuration with and without Expansion Module

To configure the Tesys T, Use the Power Suite software tool by connecting the system exactly as
shown in the following figure.

EIO0000002092 04/2020 521

Ethernet Technology

After you are connected, you have to define the options that appear in the following figure.

522 EIO0000002092 04/2020

 Ethernet Technology

Configuring the IO Scanning of the Controller

Description
To control the Tesys T, configure the I/O scanning of the controller.
In the Modicon M340 automation platform, IO Scanning is only available if the hardware
configuration features a NOE communications module.
This parameter configuration is used to define the relationship between the function I/Os and the
device I/Os.
2 different Tesys T functions use I/O scanning. A function (ETESYST) uses limited amount of words
that are refreshed very quickly and the other function (EIOSTESYST) reads a large portion of the
words available but at lower speeds.
The ETESYST function requires 4 input words in the Inputs variable (ANY_ARRAY_INT structure)
and 3 output words in the Outputs variable (ANY_ARRAY_INT structure). The input words are
read starting on word 2502, and the write words are written starting on word 2506.
The EIOSTESYST function requires 64 input words in the Inputs variable (ANY_ARRAY_INT
structure) and 5 output words in the Outputs variable (ANY_ARRAY_INT structure). The input
words are read starting on word 451, and the output words are read starting on word 700. The
refresh rate has to be more than or equal to 200 ms.
The data used in the controller by the ETESYST DFB is as follows::

DFB Variable Device Variable Type Direction

Input0 Status register 1 Read %MWx
Input1 Status register 2 Read %MWx+1
Input2 Logic input status Read %MWx+2
Input3 Logic output status Read %MWx+3
Output0 Output control Write %MWy
Output1 CWD (Control Word) Write %MWy+1
Output2 Reserved Write %MWy+2

EIO0000002092 04/2020 523

Ethernet Technology

Scanning Row Appearance

The following figure shows an example of a scanning line for an ETESYST DFB in Control Expert.
In this example, 4 words are read starting with %MW500 and 3 words are written starting with
%MW550. The slave ID needs to be 0.
The following figure shows the controller IO scanning rows.

524 EIO0000002092 04/2020

 Ethernet Technology

Section 22.4
Modbus Devices Used Through Gateway

Modbus Devices Used Through Gateway

Overview
This section provides the complete connection details of several devices on an Ethernet network
using an M340 controller and a TSXETG100 gateway.

What Is in This Section?

This section contains the following topics:
Topic Page
Modbus Devices Used Through Gateway 526
TSXETG100 Gateway Configuration Description 529
Control Program Example 530

EIO0000002092 04/2020 525

Ethernet Technology

Modbus Devices Used Through Gateway

M340 Controller
This section includes an example that shows how to connect several devices on an Ethernet
network using M340 controller and a TSXETG100 gateway. Refer to the hardware manual and the
Communication library manual for more details regarding the elements used in this example.
This figure represents the hardware configuration of M340 controller:

526 EIO0000002092 04/2020

 Ethernet Technology

Configuration Procedure
This table describes the procedure to configure the IP address within the Ethernet network:

STEP ACTION DESCRIPTION

1 Access the home Check the manual for the selected gateway chosen to find the factory IP
screen of the address and the login/password required to access the gateway for the first
gateway to configure time from the computer.
the IP address within This figure shows the hardware configuration:
the Ethernet network
by using your
computer.

2 Configure the Configure the new IP address (which needs to be within the working range),
gateway address. the media type (type of cable), and the baud rate for communicating with the
devices on the Ethernet network.
This figure represents the IP address configuration:

EIO0000002092 04/2020 527

Ethernet Technology

STEP ACTION DESCRIPTION

3 Configure the This figure represents the Modbus network configuration:
Modbus network.

Refer to the TSXETG100 Configuration Description (see page 529).

528 EIO0000002092 04/2020

 Ethernet Technology

TSXETG100 Gateway Configuration Description

General
The TSXETG100 gateway can operate either in Master mode or in Slave mode. Normally, it needs
to operate in the Master mode for SGU solutions.

Master Mode
The gateway function as the Master for the Modbus network under it, forcing a communication
speed and parity for the entire network that it controls and a time out in case of a communications
interruption.

Timeout
The configurable TimeOut time is the Hardware time out.

Slave Mode
This gateway model can also work in Slave mode, in which case it serves as an additional slave in
the Modbus network. This is useful in networks in which the network Master is a PLC on a Modbus
network . To this you can connect an Ethernet slave, that is, the exact opposite route when
compared to the one described in this manual.

Polarity
Regarding the polarization of the Modbus network and the addition of terminating resistors, the
EGT100 gateway has micro switches available for their configuration.
This figure shows the gateway with Polarization circuit:

EIO0000002092 04/2020 529

Ethernet Technology

Control Program Example

Program Procedure
The control program for the 2 variable speed drives and for the ATS 48 starter using the CPUs own
Ethernet port is as follows.
This table describes the declaration and configuration of the parameters for the devices on the
Modbus network.

STEP ACTION RESULT

1 Declare and configure the The first speed driver is configured with address 1.
first speed driver with This figure represents the configured first speed driver
address 1.

2 Declare and configure the The second speed driver is configured with address 2.
second speed driver with This figure represents the configured second speed driver.
address 2.

530 EIO0000002092 04/2020

 Ethernet Technology

STEP ACTION RESULT

3 Declare and configure the The starter is configured with address 3.
starter with address 3. This figure represents the configured starter:

4 Insert EGtwMB DFB. The IP address needs to be entered in the GatewayAddress input
variable.
This figure represents the EGtwMB DFB:

EIO0000002092 04/2020 531

Ethernet Technology

STEP ACTION RESULT

5 The DFB has a public This is the channel through which the PLC sends its requests to the
variable in which the slave.
name of the configured This figure represents the slave configuration:
channel of the PLC (IP +
services) needs to be
entered.
This figure represents Ethernet port configuration:

NOTE: The name of the EGtwMB_MBWorkMemory variable needs to match in the ATV, ATS, and
EGtwMB.
NOTE: The name of the EPortM_EWorkMemory variable needs to match in the EGtwMB and
EPortM.

532 EIO0000002092 04/2020

 Ethernet Technology

Section 22.5
Configuration Procedure for Device DTM

Configuration Procedure for Device DTM

Overview
This section describes the procedure to add and configure device DTM to communicate with
device control function.

What Is in This Section?

This section contains the following topics:
Topic Page
Configuring Device DTM for Communication with Device Control Function 534
Selection of Profile/Parameter in Device DTM 549

EIO0000002092 04/2020 533

Ethernet Technology

Configuring Device DTM for Communication with Device Control Function

Overview
In this section, ATV6171 is taken as reference for the user. This example has to be used while
configuring other devices. For each device, user has to select the respective device IO
profile/parameter in DTM, which is mentioned in the section (see page 549).

Prerequisites
Download and install the supported DTM version from Schneider website.

534 EIO0000002092 04/2020

 Ethernet Technology

Example: How to Add and Configure ATV61/71 DTM and Communicate with the Control Function
Supported DTM Version for ATV61/71
The following DTM version is required while communicating with ATV61/71:
 ATV71 v 2.0.1.0
 ATV61 v 2.0.0.9

NOTE: For required DTM version of other device (see page 549)

Step Action
1 Install the supported DTM version.
2 Navigate to Tools menu, select Hardware Catalog.

NOTE: For the M580 controller, Navigate to Tools → Project Settings → Build setting, and
select the Enhanced as a Property value from the drop-down menu for the Property Label I/O
Scanning mode. Then click OK or Apply.

EIO0000002092 04/2020 535

Ethernet Technology

Step Action
3 In the Hardware Catalog window, navigate to DTM Catalog tab. Check if the ATV71 or ATV61
DTM is visible. If yes, click Update.

536 EIO0000002092 04/2020

 Ethernet Technology

Step Action
4 Navigate to TOOLS → DTM Browser.

5 Two ways to use device DTM are:

 Adding device DTM (Offline mode) (see page 540)
 Field bus discovery option (Online mode) (see page 543)

EIO0000002092 04/2020 537

Ethernet Technology

Step Action
6 Navigate to Project Browser, double-click Variables & FB Instances to view ATV71 or ATV61
structure variables, which comprise of element configured in IO Scanner table.

538 EIO0000002092 04/2020

 Ethernet Technology

Step Action
7 Perform the following mapping of ATV71 or ATV61 DTM structure variable to ATV7161 DFB:
Map ATV71.Inputs ↔ DTMInputs
Map ATV71.Outputs ↔ DTMOutputs
Map ATV71.Freshness ↔ IOScannerStatus

EIO0000002092 04/2020 539

Ethernet Technology

Adding Device DTM (Offline Mode)

Step Action
1 Right click Master DTM → Add

2 Select ATV61 or ATV71 DTM and click Add DTM.

540 EIO0000002092 04/2020

 Ethernet Technology

Step Action
3 Select Required protocols as Modbus over TCP in the Protocol information tab and click OK.

4 Double-click the added ATV71 or ATV61 device DTM.

5 Configure as per the actual specification of field device and click OK.
Example:

EIO0000002092 04/2020 541

Ethernet Technology

Step Action
6 Navigate to Parameters tab, select Input scanner and uncheck Enable IO scanner) option.
Configure Input IO scanner table as shown in the following figure. Then, check the Enable IO
Scanner option.

7 Navigate to Parameters tab, select Output canner and uncheck Enable IO Scanner) option.
Configure Output IO scanner table as shown in the following figure. Then, check the Enable IO
Scanner option.

8 Close the Device configuration window.

542 EIO0000002092 04/2020

 Ethernet Technology

Adding Device DTM using Field Bus Discovery and Configuring IO Scanner Table (Online Mode)

Step Action
1 In the Master DTM configuration window, change the IP address to local system IP address in
the Source IP address. Set the Modbus network detection range to the device IP address range
and click OK.

2 Build and download the project to the controller.

3 Right-click master DTM and select Connect.

EIO0000002092 04/2020 543

Ethernet Technology

Step Action
4 Right-click on master DTM and select Field bus discovery.

5 Select Modbus over TCP and click OK.

544 EIO0000002092 04/2020

 Ethernet Technology

Step Action
6
In the Field bus directory window, select the ATV71 device and click symbol. Click OK.

EIO0000002092 04/2020 545

Ethernet Technology

Step Action
7 In DTM Browser window, right-click on the added ATV71 or ATV61 device and click Connect.

8 In the DTM Browser window, right click on ATV71 or ATV61 and click Load data from device.

546 EIO0000002092 04/2020

 Ethernet Technology

Step Action
9 In the Parameters tab, select Input Scanner and uncheck Enable IO Scanner option. Configure
Input IO Scanner table as shown in the following figure. Then, check the Enable IO Scanner
option.

EIO0000002092 04/2020 547

Ethernet Technology

Step Action
10 In the Parameters tab, select Output Scanner and uncheck Enable IO Scanner option.
Configure Output IO Scanner table as shown in the following figure. Then, check the Enable IO
Scanner) option.

11 Close the Device Configuration window.

548 EIO0000002092 04/2020

 Ethernet Technology

Selection of Profile/Parameter in Device DTM

Overview
This section describes the profile/parameter that needs to be selected in addition to common
configuration defined in the above section, for different device DTM while communicating with the
respective device control function.

ATV32 IO Scanner Parameter Configuration

To configure ATV32 IO scanner parameter:
1. Double-click on added ATV32 device DTM in Control Expert project.
2. Navigate to Parameters tab, select Modbus TCP Settings and clear Enable IO Scanner option.
3. Configure Input IO Scanner and Output IO Scanner table as shown in the following figure
4. After configuration, check Enable IO Scanner option.

Supported DTM version

 ATV32 v 2.0.1.6

EIO0000002092 04/2020 549

Ethernet Technology

ATV9xx IO Profile Configuration

To configure ATV9xx IO profile:
1. Double-click on added ATV9xx device DTM in Control Expert project.
2. Navigate to Parameter List tab and select the Protocol and Drive Profiles field.
3. Select ATV 9xx DFB as I/O profile under Modbus TCP section as shown in the following figure.
4. After configuration, click OK.

Supported DTM version

 ATV9xx v 1.2.0.0

550 EIO0000002092 04/2020

 Ethernet Technology

ATV6xx IO Profile Configuration

To configure ATV6xx IO profile:
1. Double-click on added ATV6xx device DTM in Control Expert project.
2. Navigate to Parameter List tab and select the Protocol and Drive Profiles field.
3. Select ATV 6xx DFB as I/O profile list under Modbus TCP section as shown in the following
figure.
4. After configuration, click OK.

Supported DTM version

 ATV6xx v 1.4.12.0

EIO0000002092 04/2020 551

Ethernet Technology

TeSysT/TeSysTFast IO Scanner Configuration

To configure TeSysT/TeSysTFast IO profile:
1. Double-click on added TeSysT/TeSysTFast device DTM in Control Expert project.
2. Navigate to Parameter List tab and select Process Data.
3. Select E_TeSysT Fast Access option in case of ETESYST control function and EIOS_TeSysT
option in case of EIOSTeSysT control function and click Apply.

Supported DTM version

 TeSysTDTMLibrary 2.10.0.0

552 EIO0000002092 04/2020

 Ethernet Technology

Section 22.6
Modbus TCPIP - Implicit with IOScanning

Modbus TCPIP - Implicit with IOScanning

Creating an Application using Modbus TCPIP Communication Technology (Implicit

with NOE/CPU).

Overview
In this section, ATV71 and Quantum controller are taken as reference for the user. This example
has to be used for creating an application with any other Modbus TCPIP devices or controller.

Prerequisite
Configure the device for Ethernet communication with appropriate settings. Verify that device is
ready and is communicating with controller and the PC used for configuration.

Supported Architecture

EIO0000002092 04/2020 553

Ethernet Technology

Configuration
Configure Ethernet communication networks for NOE and CPU with I/O scanning enabled as
shown in the following figures:

Step Action
1 Set the IP address, read write addresses (%MW) and length of data being exchanged as shown
in the following figure (Mandatory). The IP address and IO scanner configuration are show in
the following figures.

554 EIO0000002092 04/2020

 Ethernet Technology

Step Action
2 Key parameters to be set (same for IO scanning with NOE except for health block address)
 IP address - Define the IP address of the actual device.
 Unit ID - This associates the slave address of the device connected to Modbus/Ethernet
gateway to the IP address of the gateway. For this example, set the value to 255 (default
value).
 Health timeout (0-65535 ms) - Maximum time allowed for the device to respond to assert
healthiness. The device will be invalid if it exceeds the maximum health timeout value.
 Set the health timeout value to 1000ms (default value is equal to1500ms). Health timeout
should be greater than repetitive rate for NOE and should be greater than scan time for CPU.
 Repetitive rate (0 to 65535ms in multiples of repetitive step: 0 to 200ms) - Rate at which
data is scanned from the device. Set the value as 60ms (default value).
 RD master object - Destination address in the master controller/PLC where data has to
be stored (%MWxx).
 RD slave ref - Source address in the slave/remote device (slave syntax dependent which
is usually %MWxx).
 Read length - Number of words to be read (9 in case of ATV71)
 Last value - Value to be set in the event of a detected error related to access of the device.
 Set to 0 = Values fall back to 0.
 Hold = Holds the previous value.

 WR master object - Source address of the controller/PLC whose data is being written in
the remote device (%MWxx).
 WR slave ref - The address of the first word written in the remote device (%MWxx).
 WR length - Number of words to be written.
 Device control block - Defines the value 101 to 108 (default).

3 I/O Scanning of a device through NOE.

The key parameters to be defined for IO scanning with NOE in the following figure are similar
to the parameters defined for CPU except, for health block address. The following figure shows
the NOE IOScanning Configuration.

 Health block (%IW- available only for NOE) - This address sets the starting address of
the health word for devices. Each bit in the word indicates the health status of the device.
For example, %IW1.15 has the health status of device 1 (ATV71E). This has to be mapped
to IO scanner variable.
In the example, health block address id is set as %IW1.

EIO0000002092 04/2020 555

Ethernet Technology

Instantiation

Step Action
1 Instantiate ATV7161 DFB in FBD section and add variables as shown in the following figure:

2 Declare ATV71E_1_ATV_FailCode variable and link to the Failcode pin of the DFB
(Mandatory).
3 Declare variables ATV71E_1_ATV_IOSSts and link to pin IOScannerStatus (Mandatory)

556 EIO0000002092 04/2020

 Ethernet Technology

Step Action
4 Create DDT types ATV7161_IN_DDT, ATV7161_OUT_DDT (Mandatory).
NOTE: These DDTs are specific to ATV71E DFB.

For variable name to be created (see page 559).

5 Declare variable ATV71E_1_ATV_INData1 of type ATV7161_IN_DDT and link the
ATV71E_1_ATV_INData1.Data variable to Inputs pin.
Map variable ATV71E_1_ATV_INData1 to address %MW319. Value to be entered as per the
IO scanner RD master object address is +1. Defined for reading data in IO scanning.
6 Declare variable ATV71E_1_ATV_OUTData1 of type ATV7161_OUT_DDT and link the
ATV71E_1_ATV_OUTData1.Data variable to Outputs pin.
Map variable ATV71E_1_ATV_OUTData1 to address %MW312. Value to be entered as per the
IO scanner WR master object address is +1. Defined for writing data in IO scanning.

EIO0000002092 04/2020 557

Ethernet Technology

Step Action
7 Mapping addresses:
 Define the address for variable ATV71E_1_ATV_IOSSts as %IW1.15. This is the
IOScanner address that indicates the health of the device. In case of IO scanning with NOE
health word can be defined (%IW).
NOTE: Address format to be defined (see page 559).
 Input Variable Mapping
 Map variable ATV71E_1_ATV_INData1 to address %MW319. Address value to be
entered as per IO scanner is RD master object address +1 as defined for reading data in
IO scanning.
 Output Variable Mapping
 Map ATV71E_1_ATV_OUTData1 to address %MW312. Address Value to be entered as
per IO scanner is WR Master Object address +1 as defined for writing data in IO
scanning.

558 EIO0000002092 04/2020

 Ethernet Technology

Variable Name to be created Type Value (IO Scanning address + 1)

ATV71E_1_ATV_INData1 ATV7161_IN_DDT %MW319
ATV71E_1_ATV_OUTData1 ATV7161_OUT_DDT %MW312

Address format to be defined:

CPU Address(Fixed addresses for CPU type) NOE Address

Device1(ATV71_1 in the %SW160.0 %IW1.15
example) Value Value
 0 = Error  0 = Error
 1 = Healthy  1 = Healthy

Device2 %SW160.1 %IW1.14

. . .
Device128 %SW167.15 %IW8.0

Build and Transfer Project to Controller

Step Action
1 After configuring the device, build and transfer the program to controller.
2 With controller in Run mode, reset failures (RESETFAIL_USER), configure the variable values
for direction input (DIRECTION_USER) and set point (SETPOINT_USER).
3 Start the drive (RUN_USER) and check if it is working. Reset failures if any using
RESETFAIL_USER variable connected to Resetfailinput of the DFB.

EIO0000002092 04/2020 559

Ethernet Technology

Read/Write with device

Now read/write with the device.

560 EIO0000002092 04/2020

 Ethernet Technology

Practical use of the DFB with Motor

Connect ATV7161 DFB to DEVCTL to control the motor from drive with, speed feedback from drive
as shown in the following diagram:

EIO0000002092 04/2020 561

Ethernet Technology

Section 22.7
Modbus TCPIP - Implicit with Device DTM

Modbus TCPIP - Implicit with Device DTM

Modbus TCPIP - Implicit with Device DTM

Overview
This document explains the process of creating an application using Modbus TCPIP implicit
Communication Technology through NOC. ATV7161 is used as a reference. However, same
procedure can be used for creating an application with other devices.

Prerequisites
Download and install the supported DTM version from Schneider website.
The following DTM version is required while communicating with ATV61/71:
 ATV71 v 2.0.1.0
 ATV61 v 2.0.0.9

Supported Architecture

562 EIO0000002092 04/2020

 Ethernet Technology

Configuration
Reserve sufficient memory based on the length of data required for the device connected to NOC
through Ethernet.
User has to set, read write addresses (%MW - 9 read and 7 write for ATV7161) and length of data
being exchanged as shown in the following graphics.

EIO0000002092 04/2020 563

Ethernet Technology

Adding ATV6171 DTM

For each device, user has to select the respective device IO profile/parameter in DTM.

Step Action
1 Install the supported DTM version.
2 Navigate to Tools menu, select Hardware Catalog.

564 EIO0000002092 04/2020

 Ethernet Technology

Step Action
3 In the Hardware Catalog window, navigate to DTM Catalog tab. Check if the ATV71 or ATV61
DTM is visible. If yes, click Update.

EIO0000002092 04/2020 565

Ethernet Technology

Step Action
4 Navigate to TOOLS → DTM Browser.

5 Two ways to use device DTM are:

 Adding device DTM (Offline mode) (see page 568)
 Field bus discovery option (Online mode) (see page 571)

566 EIO0000002092 04/2020

 Ethernet Technology

Step Action
6 Navigate to Project Browser, double-click Variables & FB Instances to view ATV71 or ATV61
structure variables, which comprise of element configured in IO Scanner table.

EIO0000002092 04/2020 567

Ethernet Technology

Adding Device DTM (Offline Mode)

Step Action
1 In DTM Browser, Right-click Master DTM → Add.

2 Select ATV61 or ATV71 DTM and click Add DTM.

568 EIO0000002092 04/2020

 Ethernet Technology

Step Action
3 Select Protocol Required as Modbus over TCP in the Protocol information tab and click OK.

4 Double-click the added ATV71 or ATV61 device DTM.

5 Configure as per the actual specification of field device and click OK.
Example:

EIO0000002092 04/2020 569

Ethernet Technology

Step Action
6 Navigate to Parameters tab, select Input scanner and clear Enable IO scanner option.
Configure Input IO scanner table as shown in the following figure. Then, check the Enable IO
Scanner option.

7 Navigate to Parameters tab, select Output scanner and clear Enable IO Scanner option.
Configure Output IO scanner table as shown in the following figure. Then, check the Enable IO
Scanner option.

8 Close the Device configuration window.

570 EIO0000002092 04/2020

 Ethernet Technology

Adding Device DTM using Field Bus Discovery and Configuring IO Scanner Table (Online Mode)

Step Action
1 In the Master DTM configuration window, change the IP address to local system IP address in
the Source IP address. Set the Modbus network detection range to the device IP address range
and click OK.

2 Build and download the project to the controller.

3 In DTM browser, Right-click the Master DTM and select Connect.

EIO0000002092 04/2020 571

Ethernet Technology

Step Action
4 Right-click on Master DTM and select Field bus discovery.

5 Select Modbus over TCP and click OK.

572 EIO0000002092 04/2020

 Ethernet Technology

Step Action
6
In the Field bus directory window, select the ATV71 device and click symbol. Click OK.

EIO0000002092 04/2020 573

Ethernet Technology

Step Action
7 In DTM Browser window, right-click on the added ATV71 or ATV61 device and click Connect.

8 In the DTM Browser window, right click on ATV71 or ATV61 and click Load data from device.

574 EIO0000002092 04/2020

 Ethernet Technology

Step Action
9 In the Parameters tab, select Input Scanner and clear Enable IO Scanner option. Configure
Input IO Scanner table as shown in the following figure. Then, check the Enable IO Scanner
option.

EIO0000002092 04/2020 575

Ethernet Technology

Step Action
10 In the Parameters tab, select Output Scanner and clear Enable IO Scanner option. Configure
Output IO Scanner table as shown in the following figure. Then, check the Enable IO Scanner
option.

11 Close the Device Configuration window.

576 EIO0000002092 04/2020

 Ethernet Technology

Instantiation

Step Action
1 Instantiate ATV7161_0 DFB in FBD section and add variables as shown in the following figure:

2 Declare ATV71E_1_ATV_FailCd variable and link to the Failcode pin of the DFB (Mandatory).
3 Mapping variable:
 ATV71Inputs
Quantum DTMInputs (In this example, ATV71EXX.Inputs is created by DTM addition)
M580/M340 DTMInputs (In this example, ATV71EXX.Inputs is created by DTM addition)
 ATV71Outputs
Quantum DTMInputs (In this example, ATV71EXX.Outputs is created by DTM addition).
M580/M340 DTMInputs (In this example, ATV71EXX.Outputs is created by DTM addition)
 ATV71Freshness
Quantum NOC hardware healthiness - NOCVariable_IN_HEALTH_BITS_IN[0].n for nth
device. (In this example for 1st device, Q_NOC78000_IN.HEALTH_BITS_IN[0].0)
M580/M340 DTMInputs (In this example, ATV71EXX.Freshness is created by DTM addition)
4 Map variables ATV71.Freshness and link to pin IOScannerStatus (Mandatory)
5 Map variable ATV71.Inputs of type ATV7161XX_IN and link the variable to DTMInputs pin.
6 Map variable ATV71.Outputs of type ATV7161XX_OUT and link the variable to DTMOutputs pin.

EIO0000002092 04/2020 577

Ethernet Technology

Build and Transfer Project to Controller

Step Action
1 Once the device is configured as explained above, build and transfer the program to controller.
2 With controller in Run mode, reset failures (RESETFAIL_USER), configure the variable values
for direction input (DIRECTION_USER) and set point (SETPOINT_USER).
3 Start the drive (RUN_USER) and check if it is working. Reset failures if any using
RESETFAIL_USER variable connected to Resetfail input of the DFB.

578 EIO0000002092 04/2020

 Ethernet Technology

Read/Write Devices
Now you should be able to read/write devices.

EIO0000002092 04/2020 579

Ethernet Technology

Section 22.8
Modbus TCPIP - Explicit

Modbus TCPIP - Explicit

Creating an Application using Modbus TCPIP Communication Technology (Explicit).

Overview
In this section, ATV71 and Quantum controller is taken as reference for the user. This example has
to be used for creating an application with any other ModBus TCPIP devices or Controller.

Supported Architecture

580 EIO0000002092 04/2020

 Ethernet Technology

Instantiation

Step Action
1 Instantiate EMESATV7161, ModbusEthernetPortQ and SDDEVCTL DFBs (see page 582).
NOTE: Select respective Port DFB based on the controller family.
2 Declare Failcode variable and link to the Failcode pin of the DFB (Mandatory).
3 Declare Workmemory variable and verify the same variable is linked to the devices and port
DFB.
4 Declare LocatedArea variable, allocate the memory address (%MWx) and link to the Port
DFB.

Here we are communicating with agitator (EMESATV7161 DFB) using port DFB
(ModBusEthernetPortQ)

EIO0000002092 04/2020 581

Ethernet Technology

Controller DFB Name

Quantum ModbusEthernetPortQ
M340 / M580 ModbusEthernetPortM

NOTE: All device DFB communicating to port block should be executed before port DFB executes.
Example: Execution order of DFBs has to be DFB1...DFBn → Port DFB

Configuration

Step Action
1 Define device address pin of ModBus TCPIP device DFB (see page 581).
NOTE: Follow the syntax '{XXX.XXX.XXX.XXX}xx' ('{IP Address}UnitID')
2 Define the public variable PortAddress of port DFB as shown in the following figure.

NOTE: The syntax to be followed is shown in the following table.

Controller Port Addressing

Quantum CPU '254'
NOE / NOC 'Slot'
M340 / M580 CPU / NOE / NOC 'Rack.Slot.Channel'

In this example we are using Quantum CPU port for communication.

582 EIO0000002092 04/2020

 Ethernet Technology

Defining Workmemory variable array size

Step Action
1 Build and transfer project to PLC.
2 Check the value of WantedArraySize of Port DFB.
3 Change array size of Workmemory variable to the value equal to WantedArraySize and
transfer the changes to PLC.

Read/write devices
Now you should be able to read/write devices.

EIO0000002092 04/2020 583

Ethernet Technology

Section 22.9
Modbus TCPIP - Explicit with Gateway

Modbus TCPIP - Explicit with Gateway

Modbus Serial - Explicit

Description
This section describes the procedure to create an application using Modbus serial communication
technology (Explicit). In this example ATV71 and Quantum controller is used as reference.
However, same procedure can be followed for creating an application with any other Modbus serial
devices or controller.

Prerequisite
Verify that the device is configured for Ethernet communication with appropriate settings. Verify
that device is ready and is available for communicating with gateway.

584 EIO0000002092 04/2020

 Ethernet Technology

Supported Architecture

EIO0000002092 04/2020 585

Ethernet Technology

Instantiation

Step Action
1 Instantiate DFB MBATV7161, ModBusGateway and ModbusEthernetPortQ (see page 587).
2 Declare Failcode variable and link to the Failcode pin of the DFB (Mandatory).
3 Declare WorkmemoryMB variable, verify the same variable is linked to the devices WorkMemory
pin of MBATV7161 DFB and WorkMemoryRS485 pin of ModbusGateway DFB.
Declare variable WorkMemory and link it to pin WorkMemoryEthernet (ModbusGateway
DFB) and pin WorkMemory (ModbusEthernetPortQ DFB).
4 Declare LocatedArea variable, allocate the memory address (%MWx) and link to the port DFB.
NOTE: Applicable only for ModbusEthernetPortQ DFB.

NOTE: Execution order of DFBs has to be DFB 1...DFB n → Port DFB.

The execution order of device DFBs has to be as follows:
1. Device DFB MBATV7161
2. Gateway DFB EGtwMB_1
3. Port DFB ModBusEthernetPortQ
FBD section containing DFB for device, gateway and port are shown in the following figure:

586 EIO0000002092 04/2020

 Ethernet Technology

Syntax

Controller Port Addressing

Quantum CPU '254'
NOE / NOC 'Slot'
M340 / M580 CPU / NOE / NOC 'Rack.Slot.Channel'

NOTE: User can communicate using either CPU or NOE with address as per the above format. In
this example NOE at slot 6 has been used and hence value 6 has to be set to port address.

Configuration

Step Action
1 Define ModBusAddress pin of Modbus serial device DFB after instantiation as shown in the
above figure..
NOTE: Follow the syntax - XXX (Example 10).
2 Define GatewayAddress pin of ModBus gateway device DFB (see page 585).
NOTE: Follow the syntax - '{XXX.XXX.XXX.XXX}' (i.e '{IP Address}').
3 Define public variable PortAddress of port DFB.
NOTE: Syntax to be followed (see page 588).

EIO0000002092 04/2020 587

Ethernet Technology

Step Action
4 Defining variables and array size for WorkMemory and WorkMemoryRS485 pins for port DFB
and gateway DFB:
1. Build and transfer project to PLC.
2. Check the value of WantedArraySize of port DFB and gateway DFB.
3. Disconnect project from PLC and change array size to variable WorkMemoryMB connected
to WorkMemoryRS485 pin (ModbusGateway DFB) and WorkMemory pin (ATV7161MB
DFB), array size has to be equal to WantedArraySize (Calculated by ModbusGateway
DFB in first program scan). In this example wanted array size is 109 and hence the array
size of the variable WorkMemoryMB is ARRAY[1..109] OF INT.

4. Change array size to variable WorkMemory connected to WorkMemoryEthernet pin

(ModbusGateway DFB) and WorkMemory pin (ModbusEthernetPortQ DFB), array size
has to be equal to WantedArraySize (Calculated by ModbusEthernetPortQ DFB in first
program scan).
In this example wanted array size is 34 and hence the array size of the variable WorkMemory
is ARRAY[1..34] OF INT.

5. Build and transfer project to PLC.

588 EIO0000002092 04/2020

 Ethernet Technology

Controller Family

Controller Port DFB name Gateway DFB name

Quantum ModbusEthernetPortQ ModbusGateway
M340/M580 ModbusEthernetPortM

NOTE: Select respective port DFB based on your controller family.

Read/Write devices
Now you should be able to read/write devices.

EIO0000002092 04/2020 589

Ethernet Technology

590 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Modbus over ULP Technology
EIO0000002092 04/2020

Chapter 23
Modbus over ULP Technology

Modbus over ULP Technology

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Creating a Project with $MASTERPACTMTZMBU for IFM connected to Masterpact MTZ and 592
Modbus Serial RJ45 Ports
Creating a Project with $MasterpactMTZMBU for IFE or IFE stacked with IFM connected to 593
Masterpact MTZ and Modbus Ethernet RJ45 Ports

EIO0000002092 04/2020 591

Modbus over ULP Technology

Creating a Project with $MASTERPACTMTZMBU for IFM connected to Masterpact MTZ

and Modbus Serial RJ45 Ports

Step Action
1 Instantiate MBUMASTERPACTMTZ and ModbusPortM so that ModbusPortM DFB should have
higher execution order than MBUMASTERPACTMTZ DFB.
NOTE: The variable connected to WorkMemory should have size greater than or equal to wanted
array size.

592 EIO0000002092 04/2020

 Modbus over ULP Technology

Creating a Project with $MasterpactMTZMBU for IFE or IFE stacked with IFM
connected to Masterpact MTZ and Modbus Ethernet RJ45 Ports

Step Action
1 Instantiate MBUMASTERPACTMTZ, ModbusGateway and ModbusEthernetPortM so
that ModbusEthernetPortM DFB should have higher execution order than
ModbusGateway DFB and ModbusGateway DFB should have higher execution
order than MBUMASTERPACTMTZ DFB.
NOTE: The variable connected to WorkMemory should have size greater than or
equal to wanted array size.

EIO0000002092 04/2020 593

Modbus over ULP Technology

594 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Modbus Technology
EIO0000002092 04/2020

Chapter 24
Modbus Technology

Modbus Technology

Overview
This chapter describes the configuration and setup details of the devices connected through
Modbus on the Modicon M340 automation platform.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
24.1 General 596
24.2 Configuring the Devices 601
24.3 Modbus Serial - Explicit 615

EIO0000002092 04/2020 595

Modbus Technology

Section 24.1
General

General

Overview
This section describes the complete configuration and setup details of the devices connected
through Modbus on the Modicon M340 automation platform.

What Is in This Section?

This section contains the following topics:
Topic Page
Modbus Technology 597
Determining Timeout Times 598

596 EIO0000002092 04/2020

 Modbus Technology

Modbus Technology

Modbus Network Configuration

WARNING
UNINTENDED EQUIPMENT OPERATION
Adapt the below examples to configure device or communication network parameters before you
implement them.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Refer to the configuration manual for communication networks and Control devices.
This figure shows the complete configuration and setup details for the devices connected through
Modbus on the Modicon M340 automation platforms.

EIO0000002092 04/2020 597

Modbus Technology

Determining Timeout Times

Introduction
This section provides guidelines for correctly selecting Timeout and Refresh times based on the
known parameters by using an example with a Modbus connection close to 10 ATV 31 devices:

Hardware Timeout
The timeout setting is selected on the MB physical port (PCMCIA or module). During this time, the
PLC HW uses as the maximum permissible time that can elapse before indicating a detected
failure if it does not receive a response to any sent request.
With a Modbus TSX SCY21601 module, for example, the module Timeout is 3 seconds (1 second
x 3 retries). When connecting 10 ATV31 devices on Modbus, a good setting would be to set the
time to 200 ms and 1 retry (400 ms).

598 EIO0000002092 04/2020

 Modbus Technology

Software Timeout
The timeout setting is selected on the serializer (ModbusPort - component that manages the
Modbus port). During this time, the SW uses as the maximum permissible time that can elapse
before indicating a detected failure if it does not receive a response from any of the devices.
The following is the minimum time that needs to be selected:
With Hardware Timeout = tHW
Software Timeout > tHW x No. of simultaneous send operations (Modbus port Simultane-
ousSends public parameter).
The default number of simultaneous requests managed by the ModbusPort is 4. (The SGS on the
Modbus port function generates a value of 4 for simultaneous transmissions.)

Software Timeout > 400 ms x 4 sim.sends Software Timeout > 1600 ms

NOTE: Check the default value for the public variable of the ModbusPort function if you want to
modify the software Timeout.

Device Timeout
This timeout is selected on the speed driver. During this time, the device uses as the maximum
permissible time that can elapse before indicating a detected failure if it does not receive any
requests. It tends to be a large number, but as a guideline:
Device Timeout > tHW x No. of devices connected to the Modbus port
For instance , if the network has 10 ATV 31devices, check the timeout value that is configured in
the parameters of each communications menu of the ATV 31:
Device Timeout > 400msec x 10 devices → Device Timeout > 4 s
The guidelines are as follows:
 The value of this timeout depends on the conditions that you establish for the ATV 31 when
operating it. That is, a timeout of 4 seconds for each ATV 31 means that if the ATV 31 ceases
to communicate, it stops or indicate a detected failure after 4 seconds.
 If there is a communications interruption with an ATV 31, the master attempts to establish
communications with the device, and with that device only, during the time specified in the
Hardware Timeout.
In this example, the master attempts to establish communications with the ATV 31 that is having
a communication interruption of 400 ms.
As a result, if the device Timeout < Hardware Timeout (that is, lower than 400 ms in this
example), the remaining network devices begins to drop out (indicate a detected error)
consequently due to a timeout while the master is attempting to establish communications with
the first ATV 31.
NOTE: The device Timeout need to be higher than the Refresh time (Refresh).

EIO0000002092 04/2020 599

Modbus Technology

Refresh
Refresh is the data refresh time, that is, the time between the cyclic requests sent to each one of
the devices.
This time must be sufficient for the data to be refreshed quickly but not so short as to saturate the
bus with cyclic requests.
An estimated value between 200 and 1500 is necessary to refresh their data depending on the type
of devices and the number of requests.

600 EIO0000002092 04/2020

 Modbus Technology

Section 24.2
Configuring the Devices

Configuring the Devices

Overview
This section explains the configuration of the devices.

What Is in This Section?

This section contains the following topics:
Topic Page
ATV 31, ATV 312, and ATV 12 602
ATV 71 and ATV 61 603
Tesys U 604
Tesys T 609
ATS 22 and ATS 48 611
SEPAM 612
PM 613
Compact and Masterpact 614

EIO0000002092 04/2020 601

Modbus Technology

ATV 31, ATV 312, and ATV 12

Description
The speed drives are connected to Modbus networks through an RJ45 connector.
Configure each Altivar 31, Altivar 312, and Altivar 12 devices with the same baud rate and with a
different station number so that each device is uniquely identified on the Modbus bus.

From the actual ATV without a programming console, in the Con menu for ATV 31 units and the
Conf → FULL → Con menu for ATV 312 and ATV 12 units:
 PrO : Protocol (Modbus RTU)
 Adrc or Add: Modbus address
 Bdr or tpr: Baud rate (19.2 = 19200 bps)
 Tfo: Communications mode (normally 8E1)
 tto : Communications Timeout (10 s by default)

NOTE: Communication parameters are recognized after the device is energized, that is, when the
parameters are edited, the device has to be power cycled so that the parameters are applied.

602 EIO0000002092 04/2020

 Modbus Technology

ATV 71 and ATV 61

Description
The ATV 71/61 speed driver is also connected to the Modbus network through a RJ45 connector.
That is, you can use an infrastructure identical to that used for the ATV 31.
Configure each Altivar 71 device with the same baud rate and with a different station number so
that each device is uniquely identified on the Modbus bus.
From the actual ATV without a programming console, in the menu; or from the 1.9
COMMUNICATION menu if there is a parameter configuration console:
 Add : Modbus address
 Tbr : Baud rate (19.2 = 19200bps)
 Tfo : Format (8-N-1 by default)
 tto : Communications Timeout (10 s by default)

NOTE: Communication parameters are recognized after the device is energized.

EIO0000002092 04/2020 603

Modbus Technology

Tesys U

Description
The LULC033 is the communications module for Tesys U starters and controllers that is used for
communicating with the M340 platform directly on the Modbus.
The Tesys U communications module is connected to the Modbus network through an RJ45
connector.
The available protection and control information depends on the control unit with which the Modbus
communications module is associated.
The Tesys U communications module has 3 types of control unit:
 Standard (reference: LUCA)
 Advanced (references: LUCB/C/D, LUCBT/DT)
 Multifunction (references: LUCM/MT)

The following table shows the information and controls that can be accessed with each type of
control unit:

Information/Controls Control unit

Standard (LUCA) Advanced (LUCB/C/D, Multifunction (LUCM/MT)
LUCBT/DT)
Start and stop controls * X X X
Statuses (ready, running, X X X
detected failure) *
Alarm * – X X
Automatic resetting and – X X
remote resetting through
the bus *
Indication of motor load * – X X
Detected failure – X X
differentiation *
Parameter configuration – – X
and remote query for all
functions
Log function – – X
Monitoring function – – X
Meaning of symbols used:
X Applicable
– Not Applicable
* The control block implemented in the GPL enables to work with the information marked with an
asterisk. Refer to Tesys U profile for more information regarding control based on the device and
communications used.\

604 EIO0000002092 04/2020

 Modbus Technology

Modbus Module Address

The address of the Modbus communications module is defined by switches that are located on the
bottom of the module. To access these switches, module has to be turned around:

A) The module is delivered with address 1 (factory settings).

B) Configuration example for address 20.

EIO0000002092 04/2020 605

Modbus Technology

The range of accepted values goes from 1 to 31, and the address code is binary. The least
significant bit is on the right and is indicated with .
NOTE: Addressing is recognized after the communications module is energized.
The control block implemented in the SGU is programmed to work with the factory default
configuration.
The parameter configuration of the communications module enables you to define the following:
 The operating mode
 The reset mode for a reset due to a thermal overload event
 The correspondence between the communication module outputs and the LUTM controller
inputs
The parameter configuration registers (Modbus protocol) can be accessed in read/write mode or
with the Power Suite software.
The following table shows factory default values:

Item Register Factory Meaning

settings
Reset mode for a reset due to a 602.0 1 Manual mode
detected thermal overload fault
Return mode for the control 682 2 Forced Stop
outputs in case of a Power base: OA1 and OA3 to 0
communication interruption Controller base: 13 and 23 to 0
In power base, assignment for: LO1 is the image of control bit 700.0
 LO1 output 685 LSB 2 OA1 is the image of control bit 704.0
 OA1 output 685 MSB 12 OA3 is the image of control bit 704.1
 OA3 output 686 MSB 13 13 is the image of control bit 704.0
23 is the image of control bit 704.1
In control base, assignment for: 687 LSB 12
 Output 13 687 LSB 13
 Output 23

Recovery mode after stop 688 0 The outputs revert to the state before the
power supply interrupted.

606 EIO0000002092 04/2020

 Modbus Technology

Controller
If a controller is used, 7 inputs are used in a configuration by using a communications module.

Input Function Output Comment

I.1 In Local mode: Each input 13 The input image
controls the output relay.
I.2 23 The input image
I.1 In Remote through bus 13 The register image
I.2 mode: These inputs are 23 The register image
available for sending
external information through
the communication bus
(writing to a register).
NOTE: If the voltage is too low, the output opens. Detected external and control unit problems do not affect
the state of this relay.
I.3 or I.4 These inputs are dedicated – –
to the status return of the
contactor controlled by the
output relay.
I.5 RST This dedicated input allows – Through Reset button on the front
(Reset) you to reset the controller side of the box or panel.
manually after a inoperable
unit.
I.6 SF This dedicated input – Example: Reception of information
(System enables sending trip provided by the Trip NC contact: =>
detected fault information when a From a circuit breaker, from a relay
or inoperable protection mechanism that with a probe, from a voltage relay =>
system) complements the controller from a chain of these contacts.
is tripped.
I.10 In Local or Remote through bus mode. This input sends external information through the
communication bus (writing to a register).
In Local mode. Output = The input image
In Remote through bus Output = The register image
mode.
In combined mode: This input sends local or remote through the bus information and allows
the controller to manage the control priorities.
If I.10 = 1: Local mode. Output = The input image
If I.10 = 0: Remote through Output = The register image
bus mode:

EIO0000002092 04/2020 607

Modbus Technology

This table describes the dedicated input:

Input Function Comment

I.7 SR This dedicated input allows system availability to Example: Reception of information
(System be communicated through the bus. If the provided by the circuit breaker Ready
ready) correlation Ready bit is not used, I.7 is available for NO contact.
sending the rest of the information.
I.8 This input sends external information through the Example: Status of the Emergency Stop
communication bus (writing to a register). It has no button.
I.9 effect on the controller operation. Example: In case of a cabinet in test
position panel.

608 EIO0000002092 04/2020

 Modbus Technology

Tesys T

Description
To connect a Tesys T device on a Modbus network, the following communication parameters need
to be configured.

Parameter Value
Network Modbus (Device Settings menu)
Address From 1 to 247 (Network Port menu)
Baud rate From 1200 bps to 19200 bps (Network Port menu)
Parity Even or No Parity (Network Port menu)

Use PowerSuite program to configure the Tesys T.

Configuration with Expansion Module

This figure shows the connection of a Tesys T module with an expansion module.

1 PC with PowerSuite software

2 VW3 A8 106 cable
3 LMT R controller
4 Expansion module

EIO0000002092 04/2020 609

Modbus Technology

Configuration without Expansion Module

This figure shows the connection of a Tesys T module without an expansion module.

1 PC with PowerSuite software

2 VW3 A8 106 cable
3 LMT R controller

610 EIO0000002092 04/2020

 Modbus Technology

ATS 22 and ATS 48

Description
NOTE: A reference to the ATS 48 unit is also referred to the ATS 22 unit unless otherwise
specified.
The ATS 48 starter is connected to the Modbus network through an RJ45 connector.
Configure each ATS 48 device with the same baud rate and with a different station number so that
each device is uniquely identified on the Modbus bus.
Access the COP menu and configure the following:

Parameter Description
Add ATS 48 Modbus address within the Modbus network.
Address from 0 to 31 for ATS 48 units and from 0 to 247 for ATS 22 units.
tbr Network baud rate at 4800, 9600, or 19200 bps.
FOr Configure the amount of communication bits (8 bits), parity (even, odd, or no parity),
and 1 or 2 Stop bits.
TLP/TTO (TTO for ATS 22 units) Time out. You can configure with a value of 0.1 to 60.0 in 0.1 s
increments.
Ctrl Only for ATS 22 units. Enables you to configure whether control is Modbus-based or
screw terminal-based. Configure dbS for Modbus-based control.

The timeout configured on the ATS 48 device has to be longer than the time configured in the
Refresh variable of the generated component.
NOTE: Communication parameters are recognized after the device is energized.
To use PLC-based control, the following connection needs to be made.

EIO0000002092 04/2020 611

Modbus Technology

SEPAM

Description
Modbus communication allows connecting Sepam units to a monitor that is equipped with a master
Modbus communications path.
To connect this unit, an ACE949-2 (2-wire RS485 network connection interface) or ACE949 (4-wire
RS485 network connection interface) interface module with a 12 VCC or 24 VCC power supply is
required.
This figure shows the Sepam series 80 configuration:

To connect a Sepam device to a Modbus network, configure the following communication

parameters with the configuration software:

Parameter Value
Bus Modbus
Address From 1 to 247
Baud Rate From 1200 bps to 19200 bps
Parity Even, odd, or no parity

612 EIO0000002092 04/2020

 Modbus Technology

PM

Description
Configure each PM device with the same baud rate and with a different station number so that each
device is uniquely identified on the Modbus bus.
After accessing the internal menu of the signal analyzer, configure the following:

EIO0000002092 04/2020 613

Modbus Technology

Compact and Masterpact

Description
Both Compact and Masterpact units are configured the same way in the Modbus section. This
configuration is implemented with the TRV00210 device.
This device automatically detects the baud rate of the bus as long as it is working with 8 bits, even
parity, and 1 stop bit.

The rotary selectors on the front of the device are used to configure the Modbus node address
(address from 1 to 99). To control the device remotely, the last selector has to be pointing at the
open lock symbol.

614 EIO0000002092 04/2020

 Modbus Technology

Section 24.3
Modbus Serial - Explicit

Modbus Serial - Explicit

Overview
This section describes the procedure to create an application using Modbus communication
technology (Explicit).

What Is in This Section?

This section contains the following topics:
Topic Page
Creating an Application using Modbus Communication Technology Using M340/ M580 on 616
Local Rack.
Creating an Application using Modbus Communication Technology using Quantum Controller 620
on X80 drop
Creating an Application using Modbus Communication Technology using M580 Controller on 624
X80 drop

EIO0000002092 04/2020 615

Modbus Technology

Creating an Application using Modbus Communication Technology Using M340/ M580

on Local Rack.

Overview
In this example ATV71 and M580 controller is used as a reference. However, same procedure can
be followed for creating an application with any other Modbus devices or controller.

Architecture

616 EIO0000002092 04/2020

 Modbus Technology

Instantiation

Step Action
1 Instantiate MBATV7161, ModbusPortM and SDDEVCTL DFBs.
2 Declare Failcode variable and link to the Failcode pin of the DFB (Mandatory).
3 Declare Workmemory variable, verify the same variable is linked to the devices and port DFB.

Controller DFB Name

M340 / M580 ModBusPortM

NOTE: All device DFBs communicating to port block should be executed before port DFB
executes.
In this example we are communicating with ATV71 (MBATV6171) using port DFB (ModbusPortM).
Example: Execution order of DFBs has to be DFB1...DFBn → Port DFB

EIO0000002092 04/2020 617

Modbus Technology

Configuration

Step Action
1 Define Modbus address pin of Modbus device DFB. Refer to the above figure.
2 Define public variable PortAddress of Port DFB (see page 618).
NOTE: Follow the syntax - 'XX.XX.X' ('Rack.Slot.Channel')

Controller Port Addressing

M340 / M580 CPU / NOM 'Rack.Slot.Channel'

In this example we are using M580 family NOM for Modbus serial communication.

Defining Workmemory Variable Array Size

Step Action Element

Step Action
1 Build and transfer project to PLC.
2 Check the value of WantedArraySize of port DFB.
3 Change array size of Workmemory variable to the value equal to WantedArraySize and
transfer the changes to PLC.

618 EIO0000002092 04/2020

 Modbus Technology

Read/Write Devices
Now you should be able to read/write devices.

EIO0000002092 04/2020 619

Modbus Technology

Creating an Application using Modbus Communication Technology using Quantum

Controller on X80 drop

Overview
In this example ATV71 and Quantum controller with X80 Drop (BMECRA31210) and NOM is used
as a reference. However, same procedure can be followed for creating an application with any
other Modbus devices or Quantum Controller with other X80 Drops (BMXCRA31210).

Architecture

620 EIO0000002092 04/2020

 Modbus Technology

Instantiation

Step Action
1 Instantiate MBATV7161, ModbusPortQX80, CONDSUM, CONDSUM1 and Motor2 DFBs
2 Declare Failcode variable and link to the Failcode pin of the DFB (Mandatory).
3 Declare Workmemory variable, verify the same variable is linked to the devices and port DFB.

NOTE: All device DFBs communicating to port block should be executed before port DFB
executes.
In this example we are communicating with one ATV71 (MBATV6171) using port DFB
ModbusPortQX80.
Example:Execution order of DFBs has to be DFB1...DFBn → Port DFB

EIO0000002092 04/2020 621

Modbus Technology

Configuration

Step Action
1 Define Modbus address pin of Modbus device DFB. Refer to the above figure.
2 Define public variable EthPortAddress of Port DFB.
NOTE: Follow the syntax - '1.XX.1' ('1.Slot.1').
3 Define public variable CRAIPAddress of Port DFB.
NOTE: Follow the syntax - 'XXX.XXX.XXX.XXX'.
4 Define public variable MBPortAddress of Port DFB.
NOTE: Follow the syntax - 'XX.XX.X' ('Rack.Slot.Channel').

In this example we are using Quantum family with X80 Drop with NOM for Modbus serial
communication

Defining Workmemory Variable Array Size

Step Action
1 Build and transfer project to PLC.
2 Check the value of WantedArraySize of port DFB.
3 Change array size of Workmemory variable to the value equal to WantedArraySize and
transfer the changes to PLC.

622 EIO0000002092 04/2020

 Modbus Technology

Read/Write Devices
Now you should be able to read/write devices.

EIO0000002092 04/2020 623

Modbus Technology

Creating an Application using Modbus Communication Technology using M580

Controller on X80 drop

Overview
In this example ATV71 and M580 controller with X80 Drop (BMECRA31210) and NOM is used as
a reference. However, same procedure can be followed for creating an application with any other
Modbus devices or M580 Controller with other X80 Drops (BMXCRA31210).

Architecture

624 EIO0000002092 04/2020

 Modbus Technology

Instantiation

Step Action
1 Instantiate MBATV7161, ModBusPortM58X80, CONDSUM, CONDSUM1 and Motor2 DFBs
2 Declare Failcode variable and link to the Failcode pin of the DFB (Mandatory).
3 Declare Workmemory variable, verify the same variable is linked to the devices and port DFB.

NOTE: All device DFBs communicating to port block should be executed before port DFB
executes.
In this example we are communicating with one ATV71 (MBATV6171) using port DFB
ModBusPortM58X80.
Example:Execution order of DFBs has to be DFB1...DFBn → Port DFB

EIO0000002092 04/2020 625

Modbus Technology

Configuration

Step Action
1 Define Modbus address pin of Modbus device DFB. Refer to the above figure.
2 Define public variable EthPortAddress of Port DFB.
NOTE: Follow the syntax - 'XX.XX.X' ('Rack.Slot.Channel').
3 Define public variable CRAIPAddress of Port DFB.
NOTE: Follow the syntax - 'XXX.XXX.XXX.XXX'.
4 Define public variable MBPortAddress of Port DFB.
NOTE: Follow the syntax - 'XX.XX.X' ('Rack.Slot.Channel').

In this example we are using M580 family with X80 Drop with NOM for Modbus serial communication

Defining Workmemory Variable Array Size

Step Action
1 Build and transfer project to PLC.
2 Check the value of WantedArraySize of port DFB.
3 Change array size of Workmemory variable to the value equal to WantedArraySize and
transfer the changes to PLC.

626 EIO0000002092 04/2020

 Modbus Technology

Read/Write Devices
Now you should be able to read/write devices.

EIO0000002092 04/2020 627

Modbus Technology

628 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Profibus Technology
EIO0000002092 04/2020

Chapter 25
Profibus Technology

Profibus Technology

EIO0000002092 04/2020 629

Profibus Technology

Section 25.1
Profibus Communication Using PRM

Profibus Communication Using PRM

Profibus Communication Using PRM

Overview
This document guides in creating an application using Profibus communication technology.
TESYST and M580 Controller is used as a reference. However, same procedure can be followed
for creating an application with any other Profibus device or controller

Architecture

630 EIO0000002092 04/2020

 Profibus Technology

Procedure to Configure PRM Master/Gateway DTM

Step Action
1 Install the supported DTM version.
2 Navigate to Tools menu, select Hardware Catalog.

EIO0000002092 04/2020 631

Profibus Technology

Step Action
3 In the Hardware Catalog window, navigate to DTM Catalog tab and click Update.

632 EIO0000002092 04/2020

 Profibus Technology

Step Action
4 Navigate to TOOLS → DTM Browser.

5 Two ways to use PRM DTM are:

 Master DTM (see page 635)
 Gateway DTM (see page 641)

6 Instantiate PRMMgtX DFB (X is defined to be M:=M340, M580 controller; Q=Quantum).

EIO0000002092 04/2020 633

Profibus Technology

Step Action
7 Configure public parameters of instance of PRMMgtX.

IPAddress: IP address of PRM

For port address of module to which PRM communicates (see page 651).
8 Map the PRMStatus input pin of PRMMgtM DFB with generated variable DDT of type
T_PRM_IN.

9 Add a device under PRM (see page 646).

634 EIO0000002092 04/2020

 Profibus Technology

How to Configure PRM Master DTM and IO Scanner Table Using Quantum CPU/M340 CPU/NOE
Prerequisite: User needs to make sure IP address of Quantum CPU/M340 CPU/NOE module is
configured to PRM Master with which it communicates.

Step Action
1 Right-click Host PC of DTM Browser and click Add.

2 Select PRM Master DTM and click Add DTM.

EIO0000002092 04/2020 635

Profibus Technology

Step Action
3 Navigate to Protocol information tab, select Profibus DVP1 in the Protocol supported list and click
OK.

4 Double-click the added PRM Master DTM.

636 EIO0000002092 04/2020

 Profibus Technology

Step Action
5 Navigate to General Settings tab, configure IP and MAC Address table as shown in the following
figure. Then, click Apply.
Example:

6 Close the configuration window.

NOTE: The system IP has to be the same IP domain as the IP configured by user in PRM.
7 Create an IOScanning line of PRM_Master and click the dotted line against Device Name attribute.

EIO0000002092 04/2020 637

Profibus Technology

Step Action
8 Add PRM_Master DTM for the configured IOScanning line and click OK.

9 Click button next to PRM_Master to update as shown in device.

NOTE: Depending on number of slave devices added, the size of Read and Write varies. User
needs to make sure that sufficient memory is allocated.

638 EIO0000002092 04/2020

 Profibus Technology

Step Action
10 If update is successful, the Device DDT generate by Control Expert is shown in the image below.

EIO0000002092 04/2020 639

Profibus Technology

Step Action
11 Perform Store data to Device of PRM Master.

640 EIO0000002092 04/2020

 Profibus Technology

How to Configure PRM Gateway DTM under CPU/NOC Master DTM

Step Action
1 Right-click on Master under which the user wants to have PRM Gateway DTM and click Add.

EIO0000002092 04/2020 641

Profibus Technology

Step Action
2 Select PRM Gateway DTM and click Add DTM.

642 EIO0000002092 04/2020

 Profibus Technology

Step Action
3 Select the protocol as shown in the figure below.

EIO0000002092 04/2020 643

Profibus Technology

Step Action
4 Open the Master DTM to configure Source IP Address in Channel Properties tab.

5 Configure the IP of PRM gateway under the Address Setting tab.

NOTE: The system IP needs to be same IP domain as IP configured in PRM by user.

644 EIO0000002092 04/2020

 Profibus Technology

Step Action
6 Configure Gateway DTM according as per user requirements.

7 Perform Store data to Device of PRM Master.

EIO0000002092 04/2020 645

Profibus Technology

Adding a Device under PRM

Step Action
1 Add gsd file into library, as shown in following figure:

2 While PRM Gateway is online, perform FieldBusDiscovery and then add device.

646 EIO0000002092 04/2020

 Profibus Technology

Step Action
3 Open TesysT DTM to select the profile and click Add.

4 Check the address in the Address field as shown in following figure.

EIO0000002092 04/2020 647

Profibus Technology

Step Action
5 After update is successful, the generated Device DDT variables are as shown in figure below.

648 EIO0000002092 04/2020

 Profibus Technology

Step Action
6 After performing Store data to device as shown in step 7 (see page 641), Map pins of DFB with
device DTM variables:
 Inputs: LTMR_Tesys_T_Profibus.Inputs.MMC_R_IN_1
 Outputs: LTMR_Tesys_T_Profibus.Outputs.MMC_R_OUT_1

NOTE: If user is using gateway, IOScanner: GobalFreshness_1 of Gateway in case of M580

If user is using Master, IOScanner: GlobalFreshness_1 of Master
Refer to the table below for type of communication module.

EIO0000002092 04/2020 649

Profibus Technology

Step Action
7 Transfer the project to PLC and change the state of controller to RUN.

650 EIO0000002092 04/2020

 Profibus Technology

Type of Communication Controller IOScanner

Module
CPU Quantum %SW160 ….
M340 %IW…
M580 Freshness_1
NOE Quantum %IW
M340
NOC Quantum HealthBits
M340 HealthBits
M580 Freshness_1

Type of Module Port Address

Quantum CPU 254
M340/M580 CPU 0.0.3
NOE/NOC of Quantum Module Slot Number
NOE/NOC in M340/M580 Rack.module.channel

EIO0000002092 04/2020 651

Profibus Technology

652 EIO0000002092 04/2020

 Modicon Libraries General Purpose
CANOpen Technology
EIO0000002092 04/2020

Chapter 26
CANOpen Technology

CANOpen Technology

EIO0000002092 04/2020 653

CANOpen Technology

Section 26.1
Advantys Communication using IO Scanning

Advantys Communication using IO Scanning

Advantys Communication Using IO Scanning

Overview
This document explains the steps to be followed for configuring Advantys island in Control Expert
using IOScanning. ATV61 is used as a reference. However, same procedure can be used for
creating an application with other devices.

654 EIO0000002092 04/2020

 CANOpen Technology

Architecture

EIO0000002092 04/2020 655

CANOpen Technology

Steps to Configure Advantys Island using IO Scanning

Step Action
1 Open the created Ethernet network and enable IOScanning option in Communication
configuration.

2 Create an IOScanning line for the device to communicate. This example shows Advantys with
IP address 192.168.1.114. Read/write address and length has to be entered in the
IOScanning line. Read/Write length required would change depending on the module used in
the Advantys island. For more details refer Advantys user manual

3 Click the icon highlighted in the following figure to select the Adavantys island in Control Expert.

656 EIO0000002092 04/2020

 CANOpen Technology

Step Action
4 Select the Device type as STB from the drop-down list as shown in the following figure.

5 Enter the Device name and click the Launch Advantys Configuration Software option to enable
user operation and to open Advantys Island software.

NOTE: Install Advantys island software in the computer.

EIO0000002092 04/2020 657

CANOpen Technology

Step Action
6 The architecture shown in the following figure is configured with a Digital input module
and CANOpen extension module. Two ATV drives ATV31 and ATV61 are selected under
CANOpen extension manual.

658 EIO0000002092 04/2020

 CANOpen Technology

Step Action
7 Perform Build all and click Download into the island as shown in the following figure. On
completion of download the status Island is healthy will be displayed.

EIO0000002092 04/2020 659

CANOpen Technology

Step Action
8 Close the Advantys page in Control Expert, the popup shown in the following figure appears.
Select Yes, the modifications made will be reflected in Control Expert and Control Expert will
change to Not Build state.

9 Instantiate DFB ASATV7161 DEVCTL and create variable for Failcode pin of the DFB
(Mandatory).
10 The Inputs and Outputs variables highlighted in the following figure are used to transfer data
to the device. The CommunicationOK variable is used to know the communication status of
the device. Create pins as per the requirement.

NOTE: For address format to be used with the above pins (see page 662).
11 Inputs pin is used to provide the Status word of the device to be communicated.
For address format to be used with the above pins. (see page 662)

660 EIO0000002092 04/2020

 CANOpen Technology

Step Action
12 Outputs pin is used to provide the Control word of the device to be communicated.
For address format to be used with the above pins. (see page 662)
NOTE: Create a variable with the data type "array of int" of size 2.

13 Create the required variables and perform Build all. Download the project to control the motor
using DFB.

EIO0000002092 04/2020 661

CANOpen Technology

Address Format

CPU Address(Fixed addresses for CPU type) NOE Address

Device 1(Advantys in the above %SW160.0 %IW1.15
example) Value Value
 0 = Error  0 = Error
 1 = Healthy  1 = Healthy

Device 2 %SW160.1 %IW1.14

Value Value
 0 = Error  0 = Error
 1 = Healthy  1 = Healthy

. . .
. . .
Device 128 %SW167.15 %IW8.0
Value Value
 0 = Error  0 = Error
 1 = Healthy  1 = Healthy

Read address starts from %MW1 Inputs address

Device 1 - ATV31 %MW2

Device 2 - ATV61 %MW4

. .
. .
Device 12 %mw24

Read address starts from %MW200 Outputs address

Device 1 - ATV31 %MW200

Device 2 - ATV61 %MW202

. .
. .
Device 12 %MW224

662 EIO0000002092 04/2020

 Modicon Libraries General Purpose
Index
EIO0000002092 04/2020

Index

A 553
Profibus Communication Using PRM, 630
Advantys Communication using IO Scanning
Compact
Advantys Communication using IO Scan-
Modbus communication configuration,
ning, 654
601
Altistart
Configuration Procedure for Device DTM
Modbus communication configuration,
Configuration Procedure for Device DTM,
601
533
Altivar
configuring the devices
Modbus communication configuration,
ATV 31, ATV 312 and ATV 12, 602
601
Altivar 71/61
configuring Altivar71/61 Ethernet commu- D
nication, 508
devices
Advantys Communication using IO Scan-
C ning , 654
Configuration Procedure for Device DTM,
circuit breakers
533
MBCOMPACTNSX, 49
configuring Altivar71/61 Ethernet commu-
communication
nication, 508
Advantys Communication using IO Scan-
configuring device Ethernet communica-
ning, 654
tion, 505
Configuration Procedure for Device DTM,
configuring device Modbus communica-
533
tion, 595
configuring Altivar71/61 Ethernet commu-
configuring Ethernet communication with
nication, 508
Modbus devices, 525
configuring device Ethernet communica-
configuring TeSys T Ethernet communi-
tion, 505
cation, 519
configuring device Modbus communica-
Modbus Serial - Explicit, 615
tion, 595
Modbus TCPIP - Explicit, 580
configuring Ethernet communication with
Modbus TCPIP - Explicit with Gateway,
Modbus devices, 525
584
configuring TeSys T Ethernet communi-
Modbus TCPIP - Implicit with Device
cation, 519
DTM, 562
Modbus Serial - Explicit, 615
Modbus TCPIP - Implicit with IOScanning,
Modbus TCPIP - Explicit , 580
553
Modbus TCPIP - Explicit with Gateway,
Profibus Communication Using PRM ,
584
630
Modbus TCPIP - Implicit with Device
digital protective relays
DTM, 562
SEPAM Profile, 119
Modbus TCPIP - Implicit with IOScanning,

EIO0000002092 04/2020 663

Index

E M
Ethernet MASTERPACT, 73
Configuration Procedure for Device DTM, Masterpact
533 Modbus communication configuration,
configuring Altivar71/61 Ethernet commu- 601
nication, 508 Modbus
configuring device Ethernet communica- configuring device Ethernet communica-
tion, 505 tion, 595
configuring Ethernet communication with configuring Ethernet communication with
Modbus devices, 525 Modbus devices, 525
configuring TeSys T Ethernet communi- device configuration details, 601
cation, 519 Modbus Serial - Explicit, 615
Modbus TCPIP - Explicit, 580 Modbus Serial - Explicit
Modbus TCPIP - Explicit with Gateway, Modbus Serial - Explicit, 615
584 Modbus TCPIP - Explicit
Modbus TCPIP - Implicit with Device Modbus TCPIP - Explicit, 580
DTM, 562 Modbus TCPIP - Explicit with Gateway,
Modbus TCPIP- Implicit with IOScanning, 584
553 Modbus TCPIP - Implicit
Ethernet technology Modbus TCPIP - Implicit with Device
CommunicationOK Variable, 506 DTM, 562
Modbus TCPIP - Implicit with IOScanning
Modbus TCPIP - Implicit with IOScanning,
G 553
gateway Modbus technology
configuring Ethernet communication with general, 596
Modbus devices, 525 Motor controllers and starters
general TeSys T Profile, 155
device resources overview, 21 motor controllers and starters
general overview of device components, Tesys U Profile, 191
19
supervision services, 27
general concepts O
function block interface, 28 OperationLimit, 111
monitoring, 31
set-point management, 30
General Purpose library automation system P
introduction, 19 Power Meter
Modbus communication configuration,
601
H power monitoring devices
Hardwired Circuit Breaker, 101 PM profile, 219
ACCUSINE PCS Profile, 259
Smart UPS Profile, 243

664 EIO0000002092 04/2020

 Index

Profibus
Advantys Communication using IO Scan-
ning , 654
Profibus Communication Using PRM, 630
Profibus Communication Using PRM
Profibus Communication Using PRM ,
630
progressive starters
ATS Progressive Starter , 281
PSx General Purpose library for
Control Expert
list of function blocks, 21

S
safety module
XPSMC, 483
Sepam
Modbus communication configuration,
601

T
TeSys T
configuring TeSys T Ethernet communi-
cation, 519
Modbus communication configuration,
601
TeSys U
Modbus communication configuration,
601

V
variable speed drives
ATV Profile, 307
EMATVWarn - Extended Warnings of
Process Drives, 367
EMATVWarn1 - Extended Warnings of
Process Drives (Supports 12 Alarm regis-
ters), 405

EIO0000002092 04/2020 665

Index

666 EIO0000002092 04/2020