Modicon Libraries V2 Diagnostics User Guide
Modicon Libraries V2 Diagnostics User Guide
Control Expert
Diagnostics User Guide
EIO0000004365.01
04/2022
www.se.com
Legal Information
The Schneider Electric brand and any trademarks of Schneider Electric SE and its
subsidiaries referred to in this guide are the property of Schneider Electric SE or its
subsidiaries. All other brands may be trademarks of their respective owners.
This guide and its content are protected under applicable copyright laws and
furnished for informational use only. No part of this guide may be reproduced or
transmitted in any form or by any means (electronic, mechanical, photocopying,
recording, or otherwise), for any purpose, without the prior written permission of
Schneider Electric.
Schneider Electric does not grant any right or license for commercial use of the guide
or its content, except for a non-exclusive and personal license to consult it on an "as
is" basis. Schneider Electric products and equipment should be installed, operated,
serviced, and maintained only by qualified personnel.
As standards, specifications, and designs change from time to time, information
contained in this guide may be subject to change without notice.
To the extent permitted by applicable law, no responsibility or liability is assumed by
Schneider Electric and its subsidiaries for any errors or omissions in the informational
content of this material or consequences arising out of or resulting from the use of the
information contained herein.
Table of Contents
Safety Information ......................................................................................5
Before You Begin ..................................................................................5
Start-up and Test ..................................................................................6
Operation and Adjustments ...................................................................7
About the Book...........................................................................................8
Overview .................................................................................................... 11
Glossary of Acronyms ...............................................................................12
Acronym ............................................................................................12
Control.....................................................................................................13
Diagnostic Control Composite and Facet Templates ..............................13
List of Function Blocks.........................................................................14
CPU Diagnostics .......................................................................................15
Control.....................................................................................................16
GENSTS - General Status ...................................................................16
Description ...................................................................................16
DFB Representation......................................................................16
Inputs...........................................................................................17
Inputs/Outputs ..............................................................................17
OSINFO - Operating System Information ..............................................17
Description ...................................................................................18
DFB Representation......................................................................18
Inputs/Outputs ..............................................................................18
MASTINFO - Mast Task Information .....................................................18
Description ...................................................................................19
DFB Representation......................................................................19
Inputs/Outputs ..............................................................................19
LASTSTOP - Last Stop Information ......................................................19
Description ...................................................................................20
DFB Representation......................................................................20
Inputs/Outputs ..............................................................................20
COMM - Communication Diagnostics ...................................................21
Description ...................................................................................21
DFB Representation......................................................................21
Inputs/Outputs ..............................................................................21
RTC - Real Time Clock ........................................................................22
Description ...................................................................................22
DFB Representation......................................................................22
Inputs/Outputs ..............................................................................23
BATT - Battery Diagnostics ..................................................................24
Description ...................................................................................24
DFB Representation......................................................................24
Inputs/Outputs ..............................................................................24
FASTINFO - FAST Task Diagnostics ....................................................25
Description ...................................................................................25
DFB Representation......................................................................25
Inputs/Outputs ..............................................................................26
AUX0INFO – AUX0 Task Diagnostics ...................................................26
Description ...................................................................................26
EIO0000004365.01 3
DFB Representation......................................................................27
Inputs/Outputs ..............................................................................27
AUX1INFO – AUX1 Task Diagnostics ...................................................27
Description ...................................................................................28
DFB Representation......................................................................28
Inputs/Outputs ..............................................................................28
AUX2INFO – AUX2 Task Diagnostics ...................................................29
Description ...................................................................................29
DFB Representation......................................................................29
Inputs/Outputs ..............................................................................29
AUX3INFO - AUX3 Task Diagnostics....................................................30
Description ...................................................................................30
DFB Representation......................................................................30
Inputs/Outputs ..............................................................................30
Index ...........................................................................................................31
4 EIO0000004365.01
Safety Information
Safety Information
Important Information
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.
The addition of this symbol to a “Danger” or “Warning” safety label indicates that an
electrical hazard exists which will result in personal injury if the instructions are not
followed.
This is the safety alert symbol. It is used to alert you to potential personal injury
hazards. Obey all safety messages that follow this symbol to avoid possible injury or
death.
! DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in death or serious
injury.
! WARNING
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.
! CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result in minor or
moderate injury.
NOTICE
NOTICE is used to address practices not related to physical injury.
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.
EIO0000004365.01 5
Safety Information
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.
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.
6 EIO0000004365.01
Safety Information
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.
EIO0000004365.01 7
About the Book
Validity Note
This document is valid for EcoStruxure™ Control Expert V15 or later.
Related Documents
Title of Documentation Reference Number
Modicon Libraries – General Purpose V2 for EIO0000004359
Control Expert Process Control User Guide
You can download these technical publications and other technical information
from our website at www.se.com/ww/en/download/ .
Technical Support
Visit https://app.schneider-electric.com/ecostruxure-hybrid-dcs for support,
software updates, and latest information.
Registration required.
8 EIO0000004365.01
About the Book
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.
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.
EIO0000004365.01 9
Overview
What’s in This Part
Glossary of Acronyms.....................................................................................12
Control ..........................................................................................................13
Overview
This part gives an overview of Modicon Libraries – General Purpose for Control
Expert diagnostics library and describes the concept that are implemented for
controlling and monitoring diagnostics.
EIO0000004365.01 11
Glossary of Acronyms
Glossary of Acronyms
What’s in This Chapter
Acronym .......................................................................................................12
Acronym
Acronyms and Definitions
The following table lists the acronyms used in this manual:
Acronym Definition
12 EIO0000004365.01
Control
Control
What’s in This Chapter
Diagnostic Control Composite and Facet Templates.........................................13
List of Function Blocks ...................................................................................14
Overview
This chapter describes how the Control services of the Diagnostic library are
made available to you through Modicon Libraries and the embedded Control
Participant.
EIO0000004365.01 13
Control
14 EIO0000004365.01
CPU Diagnostics
What’s in This Part
Control ..........................................................................................................16
Overview
This part provides the functionality of the templates and a detailed description of
the control (pins,pin layout, and variables of the function blocks) functions of CPU
diagnostics.
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.
EIO0000004365.01 15
Control
Control
What’s in This Chapter
GENSTS - General Status .............................................................................16
OSINFO - Operating System Information ........................................................17
MASTINFO - Mast Task Information................................................................18
LASTSTOP - Last Stop Information ................................................................19
COMM - Communication Diagnostics .............................................................21
RTC - Real Time Clock ..................................................................................22
BATT - Battery Diagnostics.............................................................................24
FASTINFO - FAST Task Diagnostics ...............................................................25
AUX0INFO – AUX0 Task Diagnostics .............................................................26
AUX1INFO – AUX1 Task Diagnostics .............................................................27
AUX2INFO – AUX2 Task Diagnostics .............................................................29
AUX3INFO - AUX3 Task Diagnostics ..............................................................30
Overview
The chapter provides the detailed description of the functional block for hardware
diagnostics.
Description
General
This chapter describes the Control Expert components provided by the GENSTS
DFB.
DFB Representation
Representation
The following figure represents GENSTS DFB:
16 EIO0000004365.01
Control
Inputs
Input Parameter Description
Parameter Type Description
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
GENSTS_ST_DDT Type
SYSBITW Word
Bit Description
0 Indicates a cold CPU boot. The Control Expert %S1 system bit is
mapped directly. Has no effect on monitoring.
1 Indicates a warm CPU boot. The Control Expert %S1 system bit is
mapped directly. Has no effect on monitoring.
The Control Expert %S1 system bit is mapped directly. Has no effect
on monitoring.
EIO0000004365.01 17
Control
Description
Functional Description
The OSINFO DFB provides the information regarding the operating system.
DFB Representation
Representation
The following figure represents OSINFO DFB:
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
OSINFO_ST_DDT Type
18 EIO0000004365.01
Control
Description
Functional Description
This chapter describes the Control Expert components provided by the MASTIFO
DFB.
DFB Representation
Representation
The following figure represents MASTINFO DFB:
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
MASTINFO_ST_DDT Type
EIO0000004365.01 19
Control
Description
Functional Description
The LASTSTOP DFB is included in the CPUDIAG component.This is an optional
DFB and you can delete it from the generated code.
This DFB maps the time in which the last stop occurred.
DFB Representation
Representation
The following figure represents LASTSTOP DFB:
Inputs/Outputs
Input/Output Parameter Representation
Parameter Type Description
LASTSTOP_ST_DDT Type
STOPMD Int Indicates the month and date of the last stop.
STOPDAY Int Indicates the day of the week (high byte) of the last
stop and its causes (low byte).
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
20 EIO0000004365.01
Control
6 Saturday
7 Sunday
Description
Functional Description
The COMM DFB is included in the CPUDIAG component. This is an optional DFB
and you can delete it from the generated code.
DFB Representation
Representation
The following figure represents COMM DFB:
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
EIO0000004365.01 21
Control
COMM_ST_DDT Type
Description
Functional Description
The RTC DFB is included in the CPUDIAG component. This is an optional DFB
and you can delete it from the generated code. This DFB is used to set the real
date and time in the controller.
NOTICE
ERRONEOUS DATA LOGGING
Confirm the input date and time before setting the date and time in the
controller.
Failure to follow these instructions can result in data loss.
DFB Representation
Representation
The following figure represents RTC DFB:
22 EIO0000004365.01
Control
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
RTC_ST_DDT Type
1: Monday
2: Tuesday, and so on
RTC_CFG_DDT Type
EIO0000004365.01 23
Control
NEWMONTH Word Provides the number of the month for the date
that is adjusted from the monitoring system.
NEWYEAR Word Provides the number of the year for the date
that is adjusted from the monitoring system.
Description
Functional Description
The BATT DFB is included in the CPUDIAG component. This is an optional DFB
and you can delete it from the generated code.
This DFB retrieves the information of the battery status.
DFB Representation
Representation
The following figure represents BATT DFB:
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
BATT_ST_DDT Type
24 EIO0000004365.01
Control
SYSBITW Word
Bit Description
NOTE: Data is available for the Quantum automation platform. The M340
platform does not use a battery, hence this data is not applicable for M340
platform.
Description
Functional Description
This DFB corresponds to the FASTINFO component. It needs to be executed in
the FAST task of the controller.
DFB Representation
Representation
The following figure represents the FASTINFO DFB:
EIO0000004365.01 25
Control
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
FASTINFO_ST_DDT Type
Description
Functional Description
The AUX0INFO DFB needs to be executed in the AUX0 task of the controller.
26 EIO0000004365.01
Control
DFB Representation
Representation
The following figure represents the AUX0INFO DFB:
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
AUX0INFO_ST_DDT Type
EIO0000004365.01 27
Control
Description
Functional Description
The AUX1INFO DFB needs to be executed in the AUX1 task of the controller.
DFB Representation
Representation
The following figure represents the AUX1INFO DFB:
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
AUX1INFO_ST_DDT Type
28 EIO0000004365.01
Control
Description
Functional Description
The AUX2INFO DFB needs to be executed in the AUX2 task of the controller.
DFB Representation
Representation
The following figure represents AUX2INFO DFB:
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
AUX2INFO_ST_DDT Type
EIO0000004365.01 29
Control
Description
Functional Description
The AUX3INFO DFB needs to be executed in the AUX3 task of the controller.
DFB Representation
Representation
The following figure represents AUX3INFO DFB:
Inputs/Outputs
Input/Output Parameter Description
Parameter Type Description
AUX3INFO_ST_DDT Type
30 EIO0000004365.01
Index
A
AUX0INFO
AUX0 Task Diagnostics ......................................26
AUX1INFO
AUX1 Task Diagnostics ......................................27
AUX2INFO
AUX2 Task Diagnostics ......................................29
AUX3INFO
AUX3 Task Diagnostics ......................................30
B
BATT
Battery Diagnostics ............................................24
C
COMM
Communication Diagnostics ...............................21
F
FASTINFO
FAST Task Diagnostics.......................................25
function blocks for diagnostics ................................14
G
GENSTS
general status ....................................................16
L
LASTSTOP
Last Stop Information .........................................19
M
MASTINFO
Mast Task Information ........................................18
O
OSINFO
Operating System Information.............................17
R
RTC
Real Time Clock.................................................22
EIO0000004365.01 31
Schneider Electric
35 rue Joseph Monier
92500 Rueil Malmaison
France
+ 33 (0) 1 41 29 70 00
www.se.com