Schneider Electric EcoStruxure Process Expert 2021 Foundation Library User Guide
Reklama
Reklama
EcoStruxure
™
Process Expert
Foundation Application Templates
User Guide
EIO0000002403.10
02/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.
As part of a group of responsible, inclusive companies, we are updating our communications that contain non-inclusive terminology. Until we complete this process, however, our content may still contain standardized industry terms that may be deemed inappropriate by our customers.
Foundation Application Templates
Table of Contents
EIO0000002403.10
Safety Information
.......................................................................................5
Operation and Adjustments .........................................................................7
About the Book
............................................................................................8
Overview
Foundation Application Templates ............................................................. 11
List of Foundation Application Templates....................................................12
Signal Conditioning and Processing
......................................................14
Signal Conditioning - Hardware Abstraction Layer.......................................15
$AISignal_UL - Analog Input Signal Conditioning...............................16
$AOSignal_UL - Analog Output Signal Conditioning ............................18
$CounterSignal_UL - Counter Signal Conditioning ...........................20
$DISignal_UL - Digital Input Signal Conditioning ................................22
$DOSignal_UL - Digital Output Signal Conditioning .............................24
$AHISignal_UL - HART Device Signal Mapping .................................27
$AISignalHART_UL - HART Input Signal Conditioning (M580).............28
$TSBool - Time Stamped Information of Elementary Variables ..............30
$TSEBool - Time Stamped Information of Field Signals ........................32
$TSDInput - Time Stamped Information of Field Signals ......................34
$TSDOutput - Time Stamped Information of Field Signals ....................36
Peer to Peer Communication.....................................................................38
Owner/Consumer Templates ...............................................................39
Data In/Data Out Templates.................................................................45
STAHL Control Module Templates .............................................................48
$STAHLAI8 for STAHL 8-channel Analog Input Modules .......................49
$STAHLAO8 for STAHL 8-Channel Analog Output Modules ....................51
$STAHLDI16 for STAHL 16-Channel Digital Input Modules....................53
$STAHLDO8 for STAHL 8-Channel Digital Output Modules .....................55
$STAHLAI8HART for STAHL 8-channel Analog Input Modules with
HART Signals.....................................................................................57
Using STAHL Control Module Templates ....................................................59
Use Case Architecture ........................................................................60
Instantiation and Application Links .......................................................61
Configuring Instances .........................................................................62
Finalizing the System .........................................................................66
The Logical Control Participant Project .................................................67
STAHL Remote I/O System Configuration.............................................69
Special Cards
............................................................................................73
Special Card Application Templates Approach ............................................74
$QEHC10500 - Quantum High Speed 5-Channel Counter Module ................75
$QEHC20200 - Quantum High Speed 2-Channel Counter Module ................76
$QERT85410 - Quantum Expert Time Stamp Module ..................................77
$QERT85420 - Quantum Expert Time Stamp Module ..................................79
3
Foundation Application Templates
$TUnsignCptBmx - M340 High Speed Counter Module UnSign .................81
$TSignCptBmx - M340 High Speed Counter Module Sign .........................82
$TCptFlmIn2 - M340 Turbo Machinery Frequency Module
$EPITesysUAS - Advantys Special Module for Handling TeSys U
$BMXEHC - M580 and X80 High Speed Counter Module ..............................86
$BMXETM - M580 and X80 Turbo Machinery Frequency Module
$BMXERT1604 - M580 and X80 16-Channel Digital Input Time Stamp
Variable Templates
...................................................................................90
Elementary Variable Templates..................................................................91
Reference Data Type Variable Templates ...................................................95
Using HART Analog I/O Signals
.............................................................96
Configuration Stage (Topology Explorer) ....................................................98
Index
4 EIO0000002403.10
Safety Information
Foundation Application Templates
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.
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.
EIO0000002403.10
5
6
Foundation Application Templates
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-ofoperation protection must be coordinated with the related automation equipment and software programming.
NOTE: Coordination of safeties and mechanical/electrical interlocks for pointof-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 are 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.
EIO0000002403.10
Foundation Application Templates
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.
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.
EIO0000002403.10
7
8
Foundation Application Templates
About the Book
Document Scope
This document describes the application templates of the EcoStruxure Process
Expert Foundation library.
This document is for users with knowledge of EcoStruxure Process Expert, and its
Control and Supervision Participants.
Validity Note
This document is valid for EcoStruxure Process Expert 2021 or later. It supersedes any previous version.
Related Documents
Title of documentation
EcoStruxure ™ Process Expert Foundation Control Services User Guide
EcoStruxure ™ Process Expert User Guide
EcoStruxure ™ Process Expert Global Templates Reference Manual
Reference number
EIO0000002404 (eng)
EIO0000001114 (eng)
EIO0000001986 (eng)
You can download these technical publications at https://www.se.com/ myschneider , Document Downloads section.
Registration required.
mySchneider Support Portal
Visit https://www.se.com/myschneider for support, software updates, and latest information on EcoStruxure Process Expert.
Registration required.
EIO0000002403.10
Product Related Information
Foundation Application Templates
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.
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.
NOTE: Templates shown in examples throughout this manual may differ from the actual templates contained in the supplied Schneider Electric libraries.
EIO0000002403.10
9
Foundation Application Templates
Overview
10 EIO0000002403.10
Foundation Application Templates
Description
Foundation Application Templates
The Foundation library provides resources that have been pre-configured and tested by Schneider Electric. Foundation application templates provide standardized elementary resources that are used in control module templates of the General Purpose library. It also provides additional services that are required to manage data transmission within a system.
The resources provided by Foundation application templates are encapsulated in facet or composite templates. You can customize the services provided by these templates at the instance level.
You can link Foundation application templates to compatible process and device templates.
For details on the naming convention (see EcoStruxure ™ Process Expert, User
Guide), refer to the topic describing the Global Templates Explorer .
Foundation Application Template Services
Foundation application templates provide Control services.
These include core services plus additional, optional services, which you can activate if needed. Function blocks and variables are the resources that are encapsulated in these templates to provide such services.
Exposed Interfaces
Foundation application templates expose interfaces that allow you to make the following types of connections:
• To topological instances (mapping interfaces)
• To other application instances (application interfaces)
Exposed interface can have the following roles:
Role
Ref
Def
CO
DO
HO
SO
Description
Role receiving data from the linked object. This role is represented graphically as plug.
Role providing data to the linked object. This role is represented graphically as socket.
Is used from the application templates representing communications objects (CO) that receive the data provided from the system configuration. This role is represented graphically as plug.
Is used from the application templates representing device objects (DO) that receive the data provided from the system configuration. This role is represented graphically as plug.
Is used from the topological template (also called hardware objects (HO)) to expose the information provided by the hardware (for example, topological addresses, slave number, and so on) to the project facets. This role is represented graphically as socket.
Is used from the application templates representing the signal objects (SO) or I/O module objects that receive the data provided from the system configuration. This role is represented graphically as plug.
EIO0000002403.10
11
Foundation Application Templates
List of Foundation Application Templates
List of Families
The templates described in this document are grouped by family.
The table lists the templates of each family.
Family name
Signal Conditioning -
Hardware
Abstraction Layer
(HAL)
Time Stamping
Unity Peer to Peer
STAHL
Unity Special In Rack
Cards - Quantum
Templates
$CounterSignal_UL
$TSBool8
$TSBool16
$TSBool32
$TSEBool8
$TSEBool16
$TSEBool32
$TSDInput8
$TSDInput16
$TSDInput32
$TSDOutput8
$TSDOutput16
$TSDOutput32
Description
Analog input signal conditioning
Analog output signal conditioning
Digital input signal conditioning
Digital output signal conditioning
HART device signal mapping
HART input signal conditioning (M580)
Counter signal conditioning
Time stamped information of elementary variables
Time stamped information of field signals
Data In/Out templates
Owner/Consumer templates
For STAHL 8-channel analog input modules
For STAHL 8-channel analog output modules
For STAHL 16-channel digital input modules
For STAHL 8-channel digital output modules
For STAHL 8-channel analog input modules with 4 or 8 HART signals.
Quantum high speed 5-channel counter module
Quantum high speed 2-channel counter module
Quantum expert time stamp module
Quantum expert time stamp module
12 EIO0000002403.10
Foundation Application Templates
Family name
Unity Special In Rack
Cards - M340
Unity Special In Rack
Cards - Advantys
Unity Special In Rack
Cards - M580
Variable Templates
Templates
Unity Elementary variables, page 91
Unity REF_TO Variables, page 95
Description
M340 high speed counter module UnSign
M340 high speed counter module Sign
M340 turbo machinery frequency module
Advantys special module to manage
TeSys_U information
M580 and X80 high speed counter module
M580 and X80 turbo machinery frequency module
M580 and X80 16-channel digital input time stamp module
Elementary variable templates
Array variable templates
Reference data type variable templates
Location of Templates
Foundation application templates are part of the Global Templates library.
To locate a template, enter its name in the search field of the Global Templates
Explorer , right-click the template in the result list, and select Navigate . You can also double-click the template.
EIO0000002403.10
13
Foundation Application Templates
Signal Conditioning and Processing
Signal Conditioning and Processing
Overview
This chapter describes the functionality of Foundation application templates for signal conditioning and processing, and their composition.
These templates 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.
14 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
Signal Conditioning - Hardware Abstraction Layer
Overview
This section explains the basic functionality of the hardware abstraction layer
(HAL) templates (signal objects) and their composition.
Hardware abstraction layer is a mechanism that emulates access to hardware resources to maintain an application device-independent. These HAL templates generate elementary digital or analog Control Participant variables, which represent the value and/or quality of hard-wired signals.
You can use these variables in the program and map them to the hardware that is configured in the topology. The mapping generates the corresponding topological addresses automatically.
EIO0000002403.10
15
Foundation Application Templates
Signal Conditioning and Processing
$AISignal_UL
- Analog Input Signal Conditioning
Description
The $AISignal_UL hardware abstraction layer facet template creates variables and elementary function blocks (EFBs) to model the value and, optionally, the quality of analog input signals.
Alternatively, the template can process an external variable of Int or Real data type in which case it acts as a pass-through without generating encapsulated constituents.
Parameters
The table describes the parameters of the $AISignal_UL facet template that you can configure.
Name
Configuration
Type
Type
Boolean
Default value Description
False (check box cleared)
AISignalName
ChannelDataType
String
Enum
Blank
Int
Select this parameter to process signal quality in addition to signal value.
NOTE: The parameter is selected by default when ChannelDataType is
Real.
Enter a name to be used for the generated
EFB and variables.
The name needs to be unique within the application of the system.
Select the data type of the signal to be acquired:
• Int
• Real
The table describes the logic generated by the facet template depending on its parameter configuration.
Generated logic Value of the
Type parameter
False (check box cleared)
Value of the
ChannelData-
Type parameter
Int
True (check box selected)
AISignalCond1 EFB is generated along with a variable.
False (check box cleared)
True (check box selected)
Real
AISignalCond1 EFB is generated along with variables
( SIGNALVALUE , ERROR , COMSTATUS , MODULESTATUS , and NOTMODULESTATUS ) to provide signal quality information.
AISignalCondReal1 EFB is generated along with variables ( SIGNALVALUE , ERROR , COMSTATUS ,
MODULESTATUS , and NOTMODULESTATUS ) to provide signal quality information.
NOTE: During the build, the number of variables created varies depending on the hardware to which the facet template is mapped.
16 EIO0000002403.10
Signal Conditioning and Processing
Signal type
Int
Real
Foundation Application Templates
Analog Signal Acquisition and Transmission
The table describes the interfaces exposed by the facet template to acquire an analog input signal depending on the signal type that is configured and the signal source.
Signal from an I/O channel
AIChannel : Mapping interface to be used in the Hardware Mapping
Editor .
Acquires signal with or without signal quality.
AIChannelReal : Mapping interface to be used in the Hardware Mapping
Editor .
Acquires signal with or without signal quality.
Variable from another instance
• IntVar : Application interface to be used in the Asset Workspace
Editor / Links Editor . Acquires signal value only.
Type/role: $Int / Ref
When the interface is connected, the template serves only as a passthrough and no logic is generated from it.
• AINPUTSignalExt : Application interface to be used in the Asset
Workspace Editor / Links Editor . Acquires signal value with signal quality.
Type/role: $AINPUTSignal / HO
To enable the interface, select to acquire also signal quality by setting the Type parameter to true.
RealVar : Application interface to be used in the Asset Workspace Editor /
Links Editor . Acquires signal value with or without signal quality.
Type/role: $Real / Ref
When the interface is connected, the template serves only as a passthrough and no logic is generated from it.
NOTE: Connecting an application interface disables the other application interfaces as well as the corresponding mapping interface. For example, if the signal type is Int and the Type parameter true, connecting the IntVar interface disables the AINPUTSignalExt interface and the AIChannel mapping interface.
The table describes the interfaces exposed by the facet template to transmit an analog input signal depending on the interface that receives the signal and the type of the signal.
Type/role Description Signal transmission interface
AISignal / Def
AINPUTSignal
AISignalReal
AINSPUTSignalReal
/ DO
/ Def
/ DO
Transmits the name of the variable holding the signal value when the signal is acquired by using the IntVar interface.
Transmits the names of the variables holding the signal value and signal quality when the signal is acquired by using the
AINPUTSignalExt or AIChannel (mapping) interfaces.
Transmits the name of the variable holding the signal value when the signal is acquired by using the RealVar interface.
Transmits the names of the variables holding the signal value and signal quality when the signal is acquired by using the
RealVar or AIChannelReal (mapping) interfaces.
Composition
The template encapsulates the AISignalCond1 and AISignalCondReal1 EFBs, which provide the core Control services.
Control Resource Description
Refer to the AISignalCond1 and AISignalCondReal1 Analog Input Signal
Conditioning (see EcoStruxure ™ Process Expert, Foundation Control Services
User Guide) for more details.
EIO0000002403.10
17
Foundation Application Templates
Signal Conditioning and Processing
$AOSignal_UL
- Analog Output Signal Conditioning
General Description
The $AOSignal_UL hardware abstraction layer facet template creates variables to model the value and, optionally, the quality of analog output signals.
Alternatively, the template can process an external variable of Int data type in which case it acts as a pass-through.
Applying the Analog Signal
The table describes the options offered by the facet template to apply an analog output signal:
Signal applied to
I/O Channel
Signal quality no yes
Hardware mapping
AOChannel/SO mapping interface
Links
Variable no yes
–
IntVar PO interface: Signal value only
IntVar PO interface: Signal value only
AOUTPUTSignalExt PO interface: Signal quality
IntVar and AOSignal interfaces. Signal value only.
IntVar and AOSignal interfaces: Signal value only.
AOUTPUTSignalExt and
AOUTPUTSignal interfaces: Signal quality
NOTE: Using a PO interface disables the mapping interface.
18 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
Parameters
The table describes the parameters of the $AOSignal_UL facet template that you can configure:
Name
Configuration
Type
Type
Boolean
Default value Description
0
AOSignalName
ChannelDataType
String
Enum empty
Int
Select this parameter to process signal quality in addition to signal value.
Enter a name to be used for the generated
DFB and variables.
The name needs to be unique within the application of the system.
Select the data type of the signal to be acquired:
• Int
• Real
The table describes the logic generated by the facet template depending on the
Include Signal Quality and Conditioning parameter configuration:
Type value
False
(check box cleared)
True
(check box selected)
Generated logic
A variable and AOSIGNALMOVE DFB are generated.
AOSIGNALCOND DFB is generated along with variables ( SIGNALVALUE , ERROR ,
COMSTATUS , MODULESTATUS , and NOTMODULESTATUS ) to provide signal quality information.
NOTE: During the build, the number of variables created varies depending on the hardware to which the facet template is mapped.
Composition
The HAL template encapsulates the AOSIGNALCOND and AOSIGNALMOVE DFBs, which provide the core Control services.
Control Resource Description
Refer to the AOSIGNALCOND Analog Output Signal Conditioning (see
EcoStruxure ™ Process Expert, Foundation Control Services User Guide) for more details.
EIO0000002403.10
19
Foundation Application Templates
Signal Conditioning and Processing
$CounterSignal_UL
- Counter Signal Conditioning
General Description
The $CounterSignal_UL hardware abstraction layer facet template creates variables to model the value and, optionally, the quality of counter signals.
Counter Signal Acquisition
Signal acquired from
Variable
Counter Channel ( BMXEHC0200/
BMXEHC0800/BMXERT1604T/
140QEHC10500/140QEHC20200 )
Counter Channel ( 140QEHC10500/
140QEHC20200 )
The table describes the options offered by the $CounterSignal_UL facet template to acquire a counter signal depending on the channel data type as shown below:
Channel Data Type
UDINT
UINT
UDINT
Hardware mapping
-
-
CounterChannelUDINT/SO mapping interface
Links
CounterSignalUDINT and
CounterSignal interfaces:
Signal value only.
CounterSignalUDINTExt and
CounterSignal interfaces:
Signal quality
CounterSignalUINT and
CounterSignal interfaces:
Signal value only.
CounterSignalUINTExt and
CounterSignal interfaces:
Signal quality
-
UINT CounterChannelUINT/SO mapping interface
-
Parameters
The table describes the parameters of the $CounterSignal_UL facet template that you can configure:
Name
Configuration
CounterSignal-
Name
Type
String
Default value Description
Empty
ChannelDataType Enum UDINT
Enter a name to be used for the generated
EFB and variables.
The name needs to be unique within the application of the system.
Selects the channel data type of the signal to be acquired
• UDINT
• UINT
NOTE: During the build, the number of variables created varies depending on the hardware to which the facet template is mapped.
Composition
The HAL template encapsulates the CounterSignalCondUDInt and
CounterSignalCondUInt EFBs, which provide the core Control services.
20 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
Control Resource Description
Refer to the CounterSignalCondUDInt and CounterSignalCondUInt -
Counter Signal Conditioning (see EcoStruxure ™ Process Expert, Foundation
Control Services User Guide) for more details.
EIO0000002403.10
21
Foundation Application Templates
Signal Conditioning and Processing
$DISignal_UL
- Digital Input Signal Conditioning
General Description
The $DISignal_UL hardware abstraction layer facet template creates variables to model the value and, optionally, the quality of digital input signals.
Alternatively, the template can process an external variable in which case it acts as a pass-through without generating encapsulated constituents.
Digital Signal Acquisition
The table describes the options offered by the facet template to acquire a digital input signal depending on the signal source:
Signal acquired from
I/O Channel
Signal quality no yes
Hardware mapping
DIChannel/SO mapping interface
Links
Variable no yes
–
BoolVar PO interface: Signal value only
BoolVar PO interface: Signal value only
DINPUTSignalExt PO interface: Signal quality
BoolVar and DISignal interfaces. Signal value only.
BoolVar and DISignal interfaces: Signal value only.
DINPUTSignalExt and DINPUTSignal interfaces: Signal quality
NOTE: Using a PO interface disables the mapping interface.
22 EIO0000002403.10
Signal Conditioning and Processing
Type
Foundation Application Templates
Parameters
The table describes the parameters of the $DISignal_UL facet template that you can configure:
Default value Description Name
Configuration
Negate
Type
DISignalName
Boolean
Boolean
String
TimeStamping
PLCHMIVar
Enum
Boolean
False
0
Empty
None
False
True = Negates the input or output signal.
Select this parameter to process signal quality in addition to signal value.
Enter a name to be used for the generated EFB and variables.
The name needs to be unique within the application of the system.
Sets the Time stamping attributes of the generated variable providing the signal value.
Possible values:
• Both edges .
• Rising edges .
• Falling edges .
• None .
NOTE: By default, EcoStruxure Process Expert uses the System time stamping mode, which supports only the both Edges setting.
The other values are supported by the Applicative time stamping mode.
Refer to the topic describing Control Expert settings (see EcoStruxure ™
Process Expert, Control Participant Services, User Guide).
Sets the HMI variable attribute of the generated variable providing the signal value.
NOTE: Set this parameter to True if you change the default value for
TimeStamping ; otherwise, the Time stamping attribute of the generated variable is set to None independently of your selection.
The table describes the logic generated by the facet template depending on the
Include Also Quality Signal parameter configuration:
Generated logic Type value
False
(check box cleared)
True
(check box selected)
Negate value
0 or 1
0 or 1
A variable and DISignalCond1 EFB are generated.
DISignalCond1 EFB is generated along with variables ( SIGNALVALUE ,
ERROR , COMSTATUS , MODULESTATUS , and NOTMODULESTATUS ) to provide signal quality information.
NOTE: During the build, the number of variables created varies depending on the hardware to which the facet template is mapped.
Composition
The HAL template encapsulates the DISignalCond1 EFB, which provides the core Control services.
Control Resource Description
Refer to the DISignalCond1 Digital Input Signal Conditioning (see
EcoStruxure ™ Process Expert, Foundation Control Services User Guide) for more details.
EIO0000002403.10
23
Foundation Application Templates
Signal Conditioning and Processing
$DOSignal_UL
- Digital Output Signal Conditioning
General Description
The $DOSignal_UL hardware abstraction layer facet template creates variables to model the value and, optionally, the quality of analog output signals.
Alternatively, the template can process an external variable in which case it acts as a pass-through.
Applying the Digital Signal
The table describes the options offered by the facet template to apply a digital output signal:
Signal applied to
I/O Channel
Signal quality no yes
Hardware mapping
DOChannel/SO mapping interface
Links
Variable no yes
–
BoolVar PO interface: Signal value only
BoolVar PO interface: Signal value only
DOUTPUTSignalExt PO interface: Signal quality
BoolVar and DOSignal interfaces. Signal value only.
BoolVar and DOSignal interfaces: Signal value only.
DOUTPUTSignalExt and
DOUTPUTSignal interfaces: Signal quality
NOTE: Using a PO interface disables the mapping interface.
24 EIO0000002403.10
Signal Conditioning and Processing
Type
Foundation Application Templates
Parameters
The table describes the parameters of the $DOSignal_UL facet template that you can configure:
Default value Description Name
Configuration
Negate
Type
DOSignalName
Boolean
Boolean
String
TimeStamping
PLCHMIVar
Enum
Boolean
False
0
Empty
None
False
True = Negates the input or output signal.
Select this parameter to process signal quality in addition to signal value.
Enter a name to be used for the generated DFB and variables.
The name needs to be unique within the application of the system.
Sets the Time stamping attributes of the generated variable providing the signal value.
Possible values:
• Both Edges
• Rising Edge
• Falling Edge
• None
NOTE: By default, EcoStruxure Process Expert uses the System time stamping mode, which supports only the Both Edges setting.
The other values are supported by the Applicative time stamping mode.
Refer to the topic describing Control Expert settings (see EcoStruxure ™
Process Expert, Control Participant Services, User Guide).
Sets the HMI variable attribute of the generated variable providing the signal value.
NOTE: Set this parameter to True if you change the default value for
TimeStamping ; otherwise, the Time stamping attribute of the generated variable is set to None independently of your selection.
The table describes the logic generated by the facet template depending on the
Include Also Quality Signal parameter configuration:
Type value
False (check box cleared)
True (check box selected)
Generated logic
A variable and DOSIGNALMOVE DFB are generated.
DOSIGNALCOND DFB is generated along with variables ( SIGNALVALUE , ERROR ,
COMSTATUS , MODULESTATUS , and NOTMODULESTATUS ) to provide signal quality information.
NOTE: During the build, the number of variables created varies depending on the hardware to which the facet template is mapped.
Composition
The HAL template encapsulates the $DOSIGNALCOND and DOSIGNALMOVE
DFBs, which provide the core Control services.
Control Resource Description
Refer to the DOSIGNALCOND Digital Output Signal Conditioning (see
EcoStruxure ™ Process Expert, Foundation Control Services User Guide) for more details.
EIO0000002403.10
25
Foundation Application Templates
HART
Overview
Signal Conditioning and Processing
This section describes the functionality of HART templates and their composition.
26 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
$AHISignal_UL
- HART Device Signal Mapping
Description
The $AHISignal_UL facet template models the value and/or quality of signals of
HART devices that are part of the Krohne instrumentation library. It allows mapping these signals to the four channels of an STBAHI8321 HART interface module, using one mapping interface.
You can also use this template together with the $AnalogInput or $AnalogInput1 templates to map signals of custom Krohne-like templates.
For more information, refer to the description of the various use cases (see
EcoStruxure ™ Process Expert , Process Templates User Guide).
NOTE: This facet template is referenced by templates of the Krohne instrumentation library.
Composition
The $AHISignal_UL template encapsulates the AHISIGNAL DFB (see
EcoStruxure ™ Process Expert, Foundation Control Services User Guide), which provides core Control services.
Interfaces
The template exposes the following interfaces:
Interface identifier
HARTChData
Type/role Description
Channel data from AHISIGNAL to HART DFB.
PAISignalReal
$HARTChData/Def
$Real/Def Provides the name of the primary variable.
PAINPUTSignalReal $AinputSignalReal/DO Provides the name of the primary variable with signal quality.
SAISignalReal $Real/Def
$Real/Def
Provides the name of the secondary variable.
SAINPUTSignalReal $AinputSignalReal/DO Provides the name of the secondary variable with signal quality.
TAISignalReal Provides the name of the tertiary variable.
TAINPUTSignalReal $AinputSignalReal/DO Provides the name of the tertiary variable with signal quality.
QAISignalReal $Real/Def Provides the name of the quaternary variable.
QAINPUTSignalReal $AinputSignalReal/DO Provides the name of the quaternary variable with signal quality.
EIO0000002403.10
27
Foundation Application Templates
Signal Conditioning and Processing
$AISignalHART_UL
- HART Input Signal Conditioning (M580)
Description
The Hardware Mapping Editor allows you to map only one signal per channel of a supported HART analog I/O module, which is configured in the topology. The
HART module is acting as a regular I/O module and the signal corresponds to the
Primary Variable (PV). The other HART signals, for example, Secondary Variable
(SV), Tertiary Variable (TV), and/or Quarternary Variable (QV) are not available.
The $AISignalHART_UL facet template allows you to use all HART signals
(including PV) coming from supported HART analog input and output modules by allocating manually state RAM addresses to variables representing these HART signals.
Parameters
The table describes the parameters of the $AISignalHART_UL facet template that you can configure:
Name
AISignalVar_Add
AISignalError_Add String
AISignalModStatus_Add
AISignalName
Type
Type
String
String
String
Boolean
Default value Description
0
0
HART AI signal value address excluding %
MW
HART Detected error in AI signal address excluding %MW
0
0
0
HART AI signal mod status address excluding %MW
Enter a name to be used for the generated
EFB and variables.
The name needs to be unique within the application of the system.
Select this parameter to process signal quality in addition to signal value.
Composition
The template encapsulates the following constituents, which provide the Control services:
• AISignalHart1
• AISignalErrorBOOL
• AISignalModStBOOL
• AISignalVar
28 EIO0000002403.10
Signal Conditioning and Processing
Time Stamping
Overview
Foundation Application Templates
This section describes the functionality of time stamping templates and their composition.
EIO0000002403.10
29
Foundation Application Templates
Signal Conditioning and Processing
$TSBool
- Time Stamped Information of Elementary Variables
General Description
The $TSBool control module template receives time stamped information from a single elementary variable and passes this information on to alarm pages of the
Supervision runtime.
In addition, the following control module templates exist, which can receive time stamped information from multiple elementary time stamping variables.
Template identifier
$TSBool8
$TSBool16
$TSBool32
Number of boolean time stamping variables
8
16
32
The configuration of these templates is similar to the single-variable time stamping template.
Element Name
Control
Name
Address
InitValue
TimeStamping
Parameters
Configuration
The table describes the Configuration parameters that you can configure:
Type
String
Boolean
Enum
Default value
Blank
False (check box cleared)
Both Edges
Description
Memory address of the variable.
Initial value of the variable.
Check box selected = true (1)
Sets the Time stamping attributes of the generated variable providing the signal value.
Possible values:
• Both Edges
• Rising Edge
• Falling Edge
• None
NOTE: By default, EcoStruxure Process Expert uses the System time stamping mode, which supports only the Both Edges setting.
The other values are supported by the Applicative time stamping mode. Refer to the topic describing
Control Expert settings (see EcoStruxure ™
Process Expert, Control Participant Services,
User Guide).
NOTE: One set of parameters exists for every channel.
Composition
The $TSBool template references composite and facet templates, which provide the following services:
Control
Supervision
Includes core services input signal.
These services complement the Control services. Supervision Services are optional.
The table describes the services that are available from the $TSBool template and the corresponding facet, which implements the service:
30 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
Control Services
Control
Facet template Associated Supervision services
Supervision
Corresponding facet template
$TSBool_CD
The table describes the services that are available from the multi-variable
$TSBool8 , $TSBool16 , $TSBool32 templates and the corresponding facets, which implement the service:
Control Services
( $TSBoolx_UC )
Control/ TSBool_1 to
TSBool_x
Facet template Associated Supervision services ($TSBoolx_
CS)
TSBool_CD1 to TSBool_
CDx
Where x represents the number of variables (8, 16, or 32)
Corresponding facet template
$TSBool_CD
Interfaces
The templates do not expose application interfaces that you can link.
EIO0000002403.10
31
Foundation Application Templates
Signal Conditioning and Processing
$TSEBool
- Time Stamped Information of Field Signals
General Description
The $TSEBool control module template receives time stamped information of field signals from a single elementary variable and passes this information on to alarm pages of the Supervision runtime.
In addition, the following control module templates exist, which can receive time stamped information from multiple elementary time stamping variables.
Template identifier
$TSEBool8
$TSEBool16
$TSEBool32
Number of extended boolean time stamping variables
8
16
32
The configuration of these templates is similar to the single-variable time stamping template.
Element Name
Control
Name
Address
InitValue
TimeStamping
Parameters
Configuration
The table describes the Configuration parameters that you can configure:
Type
String
Boolean
Enum
Default value
Blank
False (check box cleared)
Both Edges
Description
Memory address of the variable.
Initial value of the variable.
Check box selected = true (1)
Sets the Time stamping attributes of the generated variable providing the signal value.
Possible values:
• Both Edges
• Rising Edge
• Falling Edge
• None
NOTE: By default, EcoStruxure Process Expert uses the System time stamping mode, which supports only the Both Edges setting.
The other values are supported by the Applicative time stamping mode. Refer to the topic describing
Control Expert settings (see EcoStruxure ™
Process Expert, Control Participant Services,
User Guide).
NOTE: One set of parameters exists for every channel.
Composition
The $TSEBool template references composite and facet templates, which provide the following services:
Control
Supervision
Includes core services input signal.
These services complement the Control services. Supervision Services are optional.
The table describes the services that are available from the $TSEBool template and the corresponding facet, which implements the service:
32 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
Control Services Facet template Associated Supervision services
Supervision
Corresponding facet template
$TSEBool_CD Control
The table describes the services that are available from the multi-variable
$TSEBool8 , $TSEBool16 , $TSEBool32 templates and the corresponding facets, which implement the service:
Corresponding facet template
Control Services
( $TSEBoolx_UC )
Control/ TSEBool_1 to
TSEBool_x
Facet template Associated Supervision services ($TSEBoolx_
CS)
TSEBool_CD1 to
TSEBool_CDx
Where x represents the number of variables (8, 16, or 32)
$TSEBool_CD
Interfaces
The templates do not expose application interfaces that you can link.
EIO0000002403.10
33
Foundation Application Templates
Signal Conditioning and Processing
$TSDInput
- Time Stamped Information of Field Signals
General Description
The $TSDInput control module template receives time stamped information of field signals from a single channel and passes this information on to alarm pages of the Supervision runtime.
In addition, the following control module templates exist, which can receive time stamped information from multi-channel time stamping modules.
Template identifier
$TSDInput8
$TSDInput16
$TSDInput32
Type of time stamping module
8-channel modules
16-channel modules
32-channel modules
The configuration of these templates is similar to the single-channel time stamping template.
Element Name
Control
Name
Negate
Type
DISignalName
TimeStamping
Parameters
Configuration
The table describes the Configuration parameters that you can configure:
Type
Boolean
Boolean
String
Enum
Default value
False
False
Blank
Both Edges
Description
True = Negates the input or output signal.
Refer to
Enter a name to be used for the generated EFB and variables.
The name needs to be unique within the application of the system.
Sets the Time stamping attributes of the generated variable providing the signal value.
Possible values:
• Both Edges
• Rising Edge
• Falling Edge
• None
NOTE: By default, EcoStruxure Process Expert uses the System time stamping mode, which supports only the Both Edges setting.
The other values are supported by the Applicative time stamping mode. Refer to the topic describing
Control Expert settings (see EcoStruxure ™
Process Expert, Control Participant Services,
User Guide).
NOTE: One set of parameters exists for every channel.
34 EIO0000002403.10
Signal Conditioning and Processing
Control Services
Control
Foundation Application Templates
Composition
The $TSDInput template references composite and facet templates, which provide the following services:
Control
Supervision
Includes core services input signal.
These services complement the Control services. Supervision Services are optional.
The table describes the services that are available from the $TSDInput template and the corresponding facet, which implements the service:
Facet template
Control service description
Refer to DISignalCond1
(see EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide)
Associated Supervision services
Supervision
Corresponding facet template
$TSDISignal_CD
The table describes the services that are available from the multi-channel
$TSDInput8 , $TSDInput16 , $TSDInput32 templates and the corresponding facets, which implement the service:
Control Services
( $TSDISignalx_UC )
Facet template Control service description
Control/ TSDISignal_1
TSDISignal_x to
Refer to
DISignalCond1 (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide)
Where x represents the number of channels (8, 16, or 32)
Associated Supervision services ($TSDISignalx_
CS)
TSDISignal_CD1 to
TSDISignal_CDx
Corresponding facet template
$TSDISignal_CD
Interfaces
The time stamping templates expose the following application interfaces:
Interface identifier
DISignal
Type/role
$Bool/Def
Description
DINPUTSignal $DINPUTSignal/Def
Provides the name of the parameter, which holds the digital input signal value.
Provides the name of the parameters, which hold the digital input signal value and signal quality.
NOTE: There are as many pairs of interfaces as there are channels.
EIO0000002403.10
35
Foundation Application Templates
Signal Conditioning and Processing
$TSDOutput
- Time Stamped Information of Field Signals
General Description
The $TSDOutput control module template receives time stamped information of field signals from a single channel and passes this information on to alarm pages of the Supervision runtime.
In addition, the following control module templates exist, which can receive time stamped information from multi-channel time stamping modules.
Template identifier
$TSDOutput8
$TSDOutput16
$TSDOutput32
Type of time stamping module
8-channel modules
16-channel modules
32-channel modules
The configuration of these templates is similar to the single-channel time stamping template.
Element Name
Control
Name
Negate
Type
DOSignalName
TimeStamping
Parameters
Configuration
The table describes the Configuration parameters that you can configure:
Type
Boolean
Boolean
String
Enum
Default value
False
False
Blank
Both Edges
Description
True = Negates the input or output signal.
Refer to
Enter a name to be used for the generated EFB and variables.
The name needs to be unique within the application of the system.
Sets the Time stamping attributes of the generated variable providing the signal value.
Possible values:
• Both Edges
• Rising Edge
• Falling Edge
• None
NOTE: By default, EcoStruxure Process Expert uses the System time stamping mode, which supports only the Both Edges setting.
The other values are supported by the Applicative time stamping mode. Refer to the topic describing
Control Expert settings (see EcoStruxure ™
Process Expert, Control Participant Services,
User Guide).
NOTE: One set of parameters exists for every channel.
36 EIO0000002403.10
Signal Conditioning and Processing
Control Services
Control
Foundation Application Templates
Composition
The $TSDOutput template references composite and facet templates, which provide the following services:
Control
Supervision
Includes core services input signal.
These services complement the Control services. Supervision Services are optional.
The table describes the services that are available from the $TSDOutput template and the corresponding facet, which implements the service:
Facet template
Control service description
Refer to DOSignalCond
(see EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide)
Associated Supervision services
Supervision
Corresponding facet template
$TSDOSignal_CD
The table describes the services that are available from the multi-channel
$TSDOutput8 , $TSDOutput16 , $TSDOutput32 templates and the corresponding facets, which implement the service:
Corresponding facet template
Control Services
( $TSDOSignalx_UC )
Facet template Control service description
Control/ TSDOSignal_1
TSDOSignal_x to
Refer to
DOSignalCond (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User
Guide)
Where x represents the number of channels (8, 16, or 32)
Associated Supervision services ($TSDOSignalx_
CS)
TSDOSignal_CD1 to
TSDOSignal_CDx
$TSDOSignal_CD
Interfaces
The time stamping templates expose the following application interfaces:
Interface identifier
DOSignal
Type/role
$Bool/Ref
Description
DOUTPUTSignal
BoolVar
DOUTPUTSignalExt
$DOUTPUTSignal/Ref
$Bool/Def
$DOUTPUTSignal/Def
Receives the name of the parameter, which holds the digital output signal value.
Receives the name of the parameter, which holds the digital output signal value and signal quality.
Provides the name of the parameter, which holds the digital input signal value.
Provides the name of the parameters, which hold the digital output signal value and signal quality.
NOTE: There are as many pairs of interfaces as there are channels.
EIO0000002403.10
37
Foundation Application Templates
Peer to Peer Communication
Overview
Signal Conditioning and Processing
This section describes the functionality of peer to peer communication templates and their composition.
38 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
Owner/Consumer Templates
Description
Owner-consumer templates allow you to exchange, using peer to peer communication, sets of data between two Control projects, one being the owner, the other the consumer (see EcoStruxure ™ Process Expert, User Guide), and the consumer template to the consumer project. Several templates exist to communicate different data types.
The owner template is assigned to the owner project, which provides the data:
Either physical I/O signals or external variables (logical signals).
The owner template gets data through the following ways:
• Hardware mapping for physical I/O signals
• Interface links with other instances ( Asset Workspace Editor / Links Editor ) or refinement for logical signals
You can use only 1 type of link at once for each channel.
Both data value and detected failure value are transported between the owner and the consumer. In addition to the detected failure value provided by the owner, you can configure it to also include the quality of the signal.
1 pair of owner/consumer templates exists for each of the following use cases:
• Digital signals:
◦ Exchange of up to 16 boolean input signals
◦ Exchange of up to 16 boolean output signals
• Analog signals:
◦ Exchange of up to 8 integer input signals
◦ Exchange of up to 8 integer output signals
NOTE: A typical use case for these templates is to implement distributed I/Os with the Modicon M340 PRA module. In such use case, the Control project deployed to the PRA acts as owner, and the Control project executing the logic acts as the consumer.
Template Naming Convention
The templates follow a naming convention:
$<data type><amount of data><signal type>_<role>
Where:
• <data type> is Bool or Int
• <amount of data> is 8 or 16
• <Signal type> is IN for inputs (from owner to consumer) or OUT for outputs
(from consumer to owner)
• <role> is O for the owner side and C for the consumer side
Configuring the Communication Timeout
An internal mechanism is present in the templates to verify if the peer to peer communication is working correctly. A continuously increasing internal counter keeps sending the count value to the counterpart controller, which monitors this count value and detects whether the count value is stalled within a time-out value.
You can configure the Communication Time Out parameter in the instance of the consumer template, using the Properties window. Enter a value in seconds, depending on the architecture that is used.
EIO0000002403.10
39
Foundation Application Templates
Signal Conditioning and Processing
List of Templates
The following owner/consumer templates are available:
Identifier
$Bool16INO
$Bool16INC
$Bool16OUTO
$Bool16OUTC
$Int8INO
$Int8INC
$Int8OUTO
$Int8OUTC
Description
Packs and exposes up to 16 boolean input signals from the owner project and exposes them to the consumer.
Unpacks and consumes up to 16 boolean input signals that are received from the owner project.
Packs and exposes up to 16 boolean output signals from the owner project and exposes them to the consumer.
Unpacks and consumes up to 16 boolean output signals that are received from the owner project.
Packs and exposes up to 8 integer input signals from the owner project and exposes them to the consumer.
Unpacks and consumes up to 8 integer input signals that are received from the owner project.
Packs and exposes up to 8 integer output signals from the owner project and exposes them to the consumer.
Unpacks and consumes up to 8 integer output signals that are received from the owner project.
$Bool16INO
The template exposes the following interfaces:
Name
Bool16InO
Type/role
$Bool16InData/Def
DISignalxx
DINPUTSignalxx
$Bool/Ref
$DINPUTSignal/Ref
Description
Application interface to link to the related consumer template.
Application interface for digital signal value. This interface only provides the name of the variable holding the digital signal value.
Linking this interface disables the
DINPUTSignalxx interface for the channel.
Application interface for external signal and detected failure value.
Linking this interface disables the
DISignalxx interface for the channel.
NOTE: xx represents the channel number in the template, from 01 to 16.
$Bool16INC
The template exposes the following interfaces:
Name
Bool16InC
Type/role
$Bool16InData/Ref
$DISignalxx
$DINPUTSignalxx
$Bool/Def
$DInputSignal/Def
Description
Application interface to link to the related owner template.
Application interface for digital signal value.
Application interface for signal and detected failure value.
NOTE: xx represents the channel number in the template, from 01 to 16.
40 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
$Bool16OUTO
The template exposes the following interfaces:
Name
Bool16OutData
Type/role
$Bool16OutData/Def
BoolVarxx
DOUPUTSignalxx
$Bool/Def
$DOUTPUTSignal/PO
Description
Application interface to link to the related consumer template.
Application interface for digital signal value.
Application interface for external signal and detected failure value.
NOTE: xx represents the channel number in the template, from 01 to 16.
$Bool16OUTC
The template exposes the following interfaces:
Name
Bool16OutData
BoolVarxx
Type/role
$Bool16OutData/Ref
$Bool/Ref
DOUTPUTSignalxx $DOUTPUTSignal/DO
Description
Application interface to link to the related owner template.
Application interface for digital signal value.
Application interface for signal and detected failure value.
NOTE: xx represents the channel number in the template, from 01 to 16.
$Int8INO
The template exposes the following interfaces:
Name
Int8InO
AISignalxx
AINPUTSignalxx
Type/role
$Int8InData/Def
$Int/Ref
$AINPUTSignal/HO
Description
Application interface to link to the related consumer template.
Application interface for analog signal value.
Linking this interface disables the
AINPUTSignalxx interface for the channel.
Application interface for external signal and detected failure value.
Linking this interface disables the
AISignalxx interface for the channel.
NOTE: xx represents the channel number in the template, from 01 to 08.
$Int8INC
The template exposes the following interfaces:
Name
Int8InC
Type/role
$Int8InData/Ref
$AISignalxx $Int/Def
$AINPUTSignalxx $AINPUTSignal/DO
Description
Application interface to link to the related owner template.
Application interface for analog signal value.
Application Interface for signal and detected failure value.
EIO0000002403.10
41
Foundation Application Templates
Signal Conditioning and Processing
NOTE: xx represents the channel number in the template, from 01 to 08.
$Int8OUTO
The template exposes the following interfaces:
Name
Int8OutData
IntVarxx
Type/role
$Int8OutData/Def
$Int/Def
AOUTPUTSignalxx $AOUTPUTSignal/PO
Description
Application interface to link to the related consumer template.
Application interface for analog signal value.
Application interface for external signal and detected failure value.
NOTE: xx represents the channel number in the template, from 01 to 08.
$Int8OUTC
The template exposes the following interfaces:
Name
Int8OutData
IntVarxx
Type/role
$Int8OutData/Ref
$Int/Ref
AOUTPUTSignalxx $AOUTPUTSignal/DO
Description
Application interface to link to the related owner template.
Application interface for analog signal value.
Application interface for signal and detected failure value.
NOTE: xx represents the channel number in the template, from 01 to 08.
Reference Documents
Refer to Owner/Consumer (see EcoStruxure ™ Process Expert, Foundation
Control Services User Guide) for more information.
Using the Digital Input Owner/Consumer Templates
The following example explains how to use the digital input owner/consumer templates ( $Bool16INO / $Bool16INC ):
Step
1
2
3
4
5
Action
Instantiate $Bool16INO and $Bool16INC in the Application Explorer .
In the Asset Workspace Editor , link the Bool16INO interface from the owner to the consumer.
Link BoolVar interface of $Bool16INO to a boolean variable in the Asset Workspace
Editor if required or else you can perform hardware mapping to actual digital input card in the Projects Explorer .
NOTE: You can link the channel only once. If you link the channel to a variable, the channel is not available anymore during hardware mapping.
Refer to the following figure.
You can link the consumer output interfaces DISignal to variables and
DInputSignal to DigitalInput instances by using the Asset Workspace Editor .
To link a DigitalInput instance to a DInputSignal interface, set the Include also Quality Signal parameter to 1.
Refer to the figures below.
Refer to the Peer to Peer Communication Through Modbus TCP (see EcoStruxure ™
Process Expert, User Guide) for information on the other steps that you need to complete to implement peer to peer communication.
42 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
The following figure shows how to link to the DISignal01Var interface of an instance of Bool16INO interface of $Bool16INO to the MotorOP interface of an instance of $Motor and how to link the $Bool16INO interface to the Bool16INC interface of an instance of $Bool16INC .
EIO0000002403.10
The following figure shows how to link the consumer output interface
DINPUTDSignal01 to the DINPUTSignalExt interface of an instance of
$DigitalInput .
43
Foundation Application Templates
Signal Conditioning and Processing
The following figure shows how to include also signal quality by setting the Type parameter of the DISignal element to true in the Instance Editor window of the
Application Explorer .
44 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
Data In/Data Out Templates
Description
The Data In/Data Out facet templates allow you to exchange, by using peer to peer communication, scattered data between two or more Control projects, one being the owner, the others the consumer (see EcoStruxure ™ Process Expert,
User Guide). The Data Out template is assigned to the owner project and the Data
In template to the consumer project. Several templates exist to communicate data of different data types between projects.
There are 2 different types of templates:
• Data Out templates create a variable in the owner that can be accessed from
1 consumer. Instantiate as many Data Out templates as there are consumers that need to access the shared data.
• Data In templates create a network variable (see EcoStruxure ™ Process
Expert, User Guide) in the consumer to receive data from the owner.
Number of templates:
• There are 11 Data Out templates and 11 corresponding Data In templates.
• The 11 templates correspond to 11 different data types, which are Bool , Int ,
Dint , Word , Real , Array[1..8] of Int , Array[1..100] of Int , Array
[1..125
of Int , Array[1..8] of Real , Array[1..50] of Real , and
Array[1..62] of Real .
NOTE: You can use a Data Out template only to link directly to the functional variable input pin of any instance assigned to the consumer project. In such case, you need to create the network variable in the consumer, using the
Manage Network Variables dialog box (see EcoStruxure ™ Process Expert,
User Guide).
List of Templates
The following Data In/Data Out templates are available:
Identifier
$DINBool_UL
$DOUTBool_UL
$DINInt_UL
$DOUTInt_UL
$DINDInt_UL
$DOUTDInt_UL
$DINReal_UL
$DOUTReal_UL
$DINWord_UL
$DOUTWord_UL
$DIN8Int_UL
$DOUT8Int_UL
$DIN99Int_UL
$DOUT99Int_UL
$DIN124Int_UL
$DOUT124Int_UL
$DIN8Real_UL
$DOUT8Real_UL
$DIN49Real_UL
Description
Data In template for Bool data type.
Data Out template for Bool data type.
Data In template for Int data type.
Data Out template for Int data type.
Data In template for DInt data type.
Data Out template for DInt data type.
Data In template for Real data type.
Data Out template for Real data type.
Data In template for Word data type.
Data Out template for Word data type.
Data In template for Array[1..8] of Int data type.
Data Out template for Array[1..8] of Int data type.
Data In template for Array[1..100] of Int data type.
Data Out template for Array[1..100] of Int data type.
Data In template for Array[1..125] of Int data type.
Data Out template for Array[1..125] of Int data type.
Data In template for Array[1..8] of Real data type.
Data Out template for Array[1..8] of Real data type.
Data In template for Array[1..50] of Real data type.
EIO0000002403.10
45
Foundation Application Templates
Identifier
$DOUT49Real_UL
$DIN62Real_UL
$DOUT62Real_UL
Signal Conditioning and Processing
Description
Data Out template for Array[1..50] of Real data type.
Data In template for Array[1..62] of Real data type.
Data Out template for Array[1..62] of Real data type.
Data Out Interfaces
The $DOUTBool_UL template exposes the following interfaces:
Name
IN
OUT
Type/role
$Bool/Ref
$Bool/Def
Description
Application Interface to link to any variable in the owner that is to be exchanged through the network, including pins of
DFBs.
Application interface to link to the related DataIn instance, which will consume the variable or to the functional variable input pin of any other instance.
NOTE: Identical interfaces are present in the other 10 templates with the type changing according to their respective data types, which are Int , Dint ,
Word , Real , Array[1..8] of Int , Array[1..100] of Int , Array
[1..125] of Int , Array[1..8] of Real , Array[1..50] of Real , Array
[1..62] of Real .
Data In Interfaces
The $DINBool_UL template exposes the following interfaces:
Name
IN
OutToVar
Out
Type/role
$Bool/Ref
$Bool/Ref
$Bool/Def
Description
Application interface to link to the variable from the owner. It receives the name of the network variable that is created in the owner project.
This interface is used to provide the name of a variable of same type to which the value coming from the owner project needs to be passed on.
Otherwise, link the Out interface to one or more instances assigned to the consumer project.
Application interface to link to 1 or more input pins of a DFB in the consumer. The interface provides the name of the variable.
NOTE: Identical interfaces are present for the remaining 10 templates with the role identifiers changing according to their respective data types, which are
Int , DInt , Word , Real , Array[1..8] of Int , Array[1..100] of Int ,
Array[1..125] of Int , Array[1..8] of Real , Array[1..50] of Real , and Array[1..62] of Real .
Reference Document
Refer to Move_<type> DFBs (see EcoStruxure ™ Process Expert, Foundation
Control Services User Guide) for more information.
Using Data In/Out Templates
The following example explains how to use the Data In/Out templates
( $DINBool_UL\$DOUTBool_UL ) to exchange a boolean variable (represented by the $Bool_UL template):
46 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
3
4
5
Step
1
2
Action
In the Application Explorer , instantiate $DINBool_UL , $DOUTBool_UL , Motor , and
$Bool_UL .
In the Asset Workspace Editor , link the OUT interface of $DOUTBool_UL to the IN interface of $DINBool_UL .
Refer to the figure below.
Link the IN interface of $DOUTBool_UL to the MotorOP interface of $Motor .
Link the OutToVar interface of $DINBool_UL to $Bool_UL .
Refer to the Peer to Peer Communication Through Modbus TCP (see EcoStruxure ™
Process Expert, User Guide) for information on the other steps that you need to complete to implement peer to peer communication.
The following figure shows how to link the OUT interface of $DOUTBool_UL to the
IN interface of $DINBool_UL .
EIO0000002403.10
47
Foundation Application Templates
STAHL Control Module Templates
Overview.
Signal Conditioning and Processing
This section describes the basic functionality of the STAHL templates and their composition.
48 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
$STAHLAI8
for STAHL 8-channel Analog Input Modules
General Description
The $STAHLAI8 control module template allows reading the analog input signal value and signal quality data from 8 input channels of a STAHL analog input module.
Element
Name
Control
Parameters
Each instance of this template allows you to configure the offset between a range of values for the function block that it generates. If you configure offset parameter values incorrectly, a mismatch can occur between the field device and the generated function block, which leads to the exchange of incorrect information.
WARNING
LOSS OF CONTROL
• Allow only qualified personnel to configure offset parameter values.
• Conduct a safety analysis for the application and equipment installed.
• Verify that the offset parameter values match the STAHL configuration values.
• Verify the offset parameter values for each input pin of the function block that is generated by an instance of the template.
• Validate offset parameter values under simulated conditions before deployment in the field.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
The table describes the Configuration parameters, which you can configure.
Type Default value Description Name
InputModuleDataOffset
InputModuleStatusOffset
SHORT
SHORT
0
0
Offset of input data in context of STAHL IS1 Remote I/O system.
Offset of status data in context of STAHL IS1 Remote I/O system.
Control services
Core services
– –
Composite template
Composition
The $STAHLAI8 template references composite and facet templates that provide the following Control services: Core services.
The table describes the services that are available from the $STAHLAI8 control module and the corresponding facet, which implements the service:
Corresponding facet template
Control service description
Associated
Supervision services
Corresponding facet template
Supervision service description
– $STAHLAI8_UL Refer to the STAHLAI8CH
DFB (see EcoStruxure ™
Process Expert, Foundation
Control Services User
Guide).
– –
The control module template exposes the following interfaces.
EIO0000002403.10
49
Foundation Application Templates
Interface identifier Type/role
VarName
AISignal01 ...
AISignal08
AINPUTSignal01 ...
AINPUTSignal08
VarName/B
$Int/Def
$AINPUTSignal/DO
Signal Conditioning and Processing
Description
Receives the variable name.
Provides the analog input signal value of channels 0 to 7.
Provides the analog input signal value and diagnostic information of channels 0 to 7.
50 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
$STAHLAO8
for STAHL 8-Channel Analog Output Modules
General Description
The $STAHLAO8 control module template allows writing the analog output signal value to 8 output channels of a STAHL analog output module. It also reads the signal quality data from each channel.
Element
Name
Control
Parameters
Each instance of this template allows you to configure the offset between a range of values for the function block that it generates. If you configure offset parameter values incorrectly, a mismatch can occur between the field device and the generated function block, which leads to the exchange of incorrect information.
WARNING
LOSS OF CONTROL
• Allow only qualified personnel to configure offset parameter values.
• Conduct a safety analysis for the application and equipment installed.
• Verify that the offset parameter values match the STAHL configuration values.
• Verify the offset parameter values for each input pin of the function block that is generated by an instance of the template.
• Validate offset parameter values under simulated conditions before deployment in the field.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
Configuration
The table describes the Configuration parameters, which you can configure.
Type Default value Description Name
OutputModuleDataOffset
OutputModuleStatusOffset
SHORT
SHORT
0
0
Offset of output data in context of STAHL IS1 Remote I/O system.
Offset of output status data in context of STAHL IS1
Remote I/O system.
Control services
Core services
– –
Composite template
Composition
The $STAHLAO8 template references composite and facet templates that provide the following Control services: Core services.
The table describes the services that are available from the $STAHLAO8 control module and the corresponding facet, which implements the service:
Corresponding facet template
Control service description
Associated
Supervision services
Corresponding facet template
Supervision service description
– $STAHLAO8_UL Refer to the STAHLAO8CH
DFB (see EcoStruxure ™
Process Expert, Foundation
Control Services User
Guide).
– –
The control module template exposes the following interfaces:
EIO0000002403.10
51
Foundation Application Templates
Interface identifier
VarName
AOSignal01 ...
AOSignal08
AOUTPUTSignal01 ...
AOUTPUTSignal08
Type/role
VarName/B
$Int/Ref
$AOUTPUTSignal/DO
Signal Conditioning and Processing
Description
Variable name.
Provides the analog output signal value of channels 0 to 7.
Provides the analog output signal value and diagnostic information of channels 0 to 7.
52 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
$STAHLDI16
for STAHL 16-Channel Digital Input Modules
General Description
The $STAHLDI16 control module template allows reading the digital input signal value and signal quality data from 16 input channels of a STAHL digital input module.
Element
Name
Control
Parameters
Each instance of this template allows you to configure the offset between a range of values for the function block that it generates. If you configure offset parameter values incorrectly, a mismatch can occur between the field device and the generated function block, which leads to the exchange of incorrect information.
WARNING
LOSS OF CONTROL
• Allow only qualified personnel to configure offset parameter values.
• Conduct a safety analysis for the application and equipment installed.
• Verify that the offset parameter values match the STAHL configuration values.
• Verify the offset parameter values for each input pin of the function block that is generated by an instance of the template.
• Validate offset parameter values under simulated conditions before deployment in the field.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
Configuration
The table describes the Configuration parameters, which you can configure.
Type Default value Description Name
InputModuleDataOffset
InputModuleStatusOffset
SHORT
SHORT
0
0
Offset of input data in context of STAHL IS1 Remote I/O system.
Offset of status data in context of STAHL IS1 Remote I/O system.
Control services
Core services
– –
Composite template
Composition
The $STAHLDI16 template references composite and facet templates that provide the following Control services: Core services.
The table describes the services that are available from the $STAHLDI16 control module and the corresponding facet, which implements the service:
Corresponding facet template
Control service description
Associated
Supervision services
Corresponding facet template
Supervision service description
– $STAHLDI16_UL Refer to the STAHLDI16CH
DFB (see EcoStruxure ™
Process Expert, Foundation
Control Services User
Guide).
– –
The control module template exposes the following interfaces:
EIO0000002403.10
53
Foundation Application Templates
Interface identifier
VarName
DISignal01 ...
DISignal16
DINPUTSignal01 ...
DINPUTSignal16
Type/role
VarName/B
$Bool/Def
$DINPUTSignal/Def
Signal Conditioning and Processing
Description
Received the variable name.
Provides the digital input signal value of channels 0 to 15.
Provides the digital input signal value and diagnostic information of channels 0 to 15.
54 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
$STAHLDO8
for STAHL 8-Channel Digital Output Modules
General Description
The $STAHLDO8 control module template allows writing the digital output signal value to 8 output channels of a STAHL digital output module. It also reads the signal quality data from each channel.
Element
Name
Control
Parameters
Each instance of this template allows you to configure the offset between a range of values for the function block that it generates. If you configure offset parameter values incorrectly, a mismatch can occur between the field device and the generated function block, which leads to the exchange of incorrect information.
WARNING
LOSS OF CONTROL
• Allow only qualified personnel to configure offset parameter values.
• Conduct a safety analysis for the application and equipment installed.
• Verify that the offset parameter values match the STAHL configuration values.
• Verify the offset parameter values for each input pin of the function block that is generated by an instance of the template.
• Validate offset parameter values under simulated conditions before deployment in the field.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
Configuration
The table describes the Configuration parameters, which you can configure.
Type Default value Description Name
OutputModuleDataOffset
OutputModuleStatusOffset
SHORT
SHORT
0
0
Offset of output data in context of STAHL IS1 Remote I/O system.
Offset of output status data in context of STAHL IS1
Remote I/O system.
Control services
Core services
– –
Composite template
Composition
The $STAHLDO8 template references composite and facet templates that provide the following Control services: Core services.
The table describes the services that are available from the $STAHLDO8 control module and the corresponding facet, which implements the service:
Corresponding facet template
Control service description
Associated
Supervision services
Corresponding facet template
Supervision service description
– $STAHLDO8_UL Refer to the STAHLDO8CH
DFB (see EcoStruxure ™
Process Expert, Foundation
Control Services User
Guide).
– –
The control module template exposes the following interfaces:
EIO0000002403.10
55
Foundation Application Templates
Interface identifier
VarName
DOSignal01 ...
DOSignal08
DOUTPUTSignal01 ...
DOUTPUTSignal08
Type/role
VarName/B
$Bool/Ref
$DOUTPUTSignal/DO
Signal Conditioning and Processing
Description
Variable name.
Provides the digital output signal value of channels 0 to 7.
Provides the digital output signal value and diagnostic information of channels 0 to 7.
56 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
$STAHLAI8HART
for STAHL 8-channel Analog Input Modules with HART Signals
General Description
The $STAHLAI8HART control module template allows reading the analog input signal value and signal quality data from 8 input channels of a STAHL analog input module HART. It also processes four or eight HART signals.
Element
Name
Control.
STAHLAI8
Control.
STAHLAI8
Control.
STAHLHV4
Control.
STAHLHV8
Control
Parameters
Each instance of this template allows you to configure the offset between a range of values for the function block that it generates. If you configure offset parameter values incorrectly, a mismatch can occur between the field device and the generated function block, which leads to the exchange of incorrect information.
WARNING
LOSS OF CONTROL
• Allow only qualified personnel to configure offset parameter values.
• Conduct a safety analysis for the application and equipment installed.
• Verify that the offset parameter values match the STAHL configuration values.
• Verify the offset parameter values for each input pin of the function block that is generated by an instance of the template.
• Validate offset parameter values under simulated conditions before deployment in the field.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
Configuration
The table describes the Configuration parameters, which you can configure.
Type Default value Description Name
InputModuleDataOffset SHORT 0
InputModuleStatusOffset
SHORT
InputModuleDataOffset SHORT
InputModuleDataOffset SHORT
InputModuleStatusOffset
SHORT
0
0
0
1
Offset of input data in context of STAHL IS1 Remote I/
O system.
Offset of status data in context of STAHL IS1 Remote
I/O system.
Offset of input data in context of STAHL IS1 Remote I/
O system.
Offset of input data in context of STAHL IS1 Remote I/
O system.
Offset of status data in context of STAHL IS1 Remote
I/O system.
NOTE: You can only select either of the two elements.
Composition
The $STAHLAI8HART template references composite and facet templates that provide the following Control services: Core services plus additional, optional services, which you can activate if needed.
The table describes the services that are available from the $STAHLHV4 control module and the corresponding facet, which implements the service:
EIO0000002403.10
57
Foundation Application Templates
Signal Conditioning and Processing
Control services
Composite template
Corresponding facet template
Control service description
Associated
Supervision services
Corresponding facet template
Supervision service description
Core services
Control $STAHLAI8-
HART_UC
$STAHLAI8_UL Refer to the
STAHLAI8CH DFB (see
EcoStruxure ™ Process
Expert, Foundation
Control Services User
Guide).
– – –
Optional services
Control $STAHLAI8-
HART_UC
$STAHLHV4_UL
$STAHLHV8_UL
Refer to the
STAHLHARTVal4 DFB
(see EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide).
Refer to the
STAHLHARTVal8 DFB
(see EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide).
–
–
–
–
–
–
The control module template exposes the following interfaces.
Interface identifier Type/role
VarName
AISignal01 ...
AISignal08
VarName/B
$Int/Def
AINPUTSignal01 ...
AINPUTSignal08
$AINPUTSignal/DO
Description
Receives the variable name.
Provides the analog input signal value of channels 0 to 7.
Provides the analog input signal value and diagnostic information of channels 0 to 7.
In addition, the control module template exposes the following interfaces, depending on the element selection.
When you select the STAHLHV4 element:
Interface identifier
HARTSignal01 ...
HARTSignal04
Type/role
$Real/Def
Description
Provides the HART signal value of channels 0 to 3.
When you select the STAHLHV8 element:
Interface identifier
HARTSignal01 ...
HARTSignal08
Type/role
$Real/Def
Description
Provides the HART signal value of channels 0 to 7.
58 EIO0000002403.10
Signal Conditioning and Processing
Using STAHL Control Module Templates
Example Use Case
Foundation Application Templates
Using an example, this section describes the steps to configure a IS1 Remote I/O system, which communicates with a Quantum controller by using I/O scanning.
The implementation of this system requires both EcoStruxure Process Expert and
EcoStruxure Control Expert.
NOTE: This use case focuses on the configuration of the controller and the
IS1 Remote I/O system, and on the communication between the two. It does not describe the entire system engineering life cycle.
EIO0000002403.10
59
Foundation Application Templates
Signal Conditioning and Processing
Use Case Architecture
Module/Hardware
Quantum CPU 651 50
STAHL IS1 remote I/O system CPU
DIM16
DOM8
8AIH
8AIH
8AIH
EcoStruxure Process Expert system server/engineering station
Physical Architecture Description
The architecture that is modeled in this use case consists of the following components:
Particular configuration
I/O scanner
–
IP address
192.168.10.68
192.168.10.30
Templates
–
–
–
Automatic selection through bottom-up process.
$GenericDevice (Application template)
$EGenericDeviceHW (Topological template)
$STAHLDI16
$STAHLDO8
$STAHLAI8
–
–
Configured as 8channel analog input module.
Configured as 8channel analog output module.
Configured as 8channel analog input module with 4 HART values.
Control Expert is also installed
–
–
–
$STAHLAO8
$STAHLAI8HART
–
NOTE: The Quantum controller, STAHL IS1 Remote I/O system, and the
EcoStruxure Process Expert workstation are connected to the Ethernet control network.
Architecture Representation
60 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
Instantiation and Application Links
Instantiating Templates
Instantiate the necessary STAHL templates and the $GenericDevice application template in the Application Explorer .
NOTE: The $GenericDevice application template is used to pass the input/ output data variable name to the STAHL templates through the VarName interface.
The following figure shows instances of the necessary templates in the
Application Explorer :
Linking Instances
In the Asset Workspace Editor , connect the VarName interface of the
$GenericDevice template instance to the VarName interface of each STAHL template instance. After this process, the Link status of each STAHL template then becomes Valid .
EIO0000002403.10
61
Foundation Application Templates
Configuring Instances
Signal Conditioning and Processing
Overview
Each instance of a STAHL control module template allows you to configure the offset between a range of values for the function block that it generates. If you configure offset parameter values incorrectly, a mismatch can occur between the field device and the generated function block, which leads to the exchange of incorrect information.
WARNING
LOSS OF CONTROL
• Allow only qualified personnel to configure offset parameter values.
• Conduct a safety analysis for the application and equipment installed.
• Verify that the offset parameter values match the STAHL configuration values.
• Verify the offset parameter values for each input pin of the function block that is generated by an instance of the template.
• Validate offset parameter values under simulated conditions before deployment in the field.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
To be able to configure the STAHL template instances in the Properties window of the Application Explorer , you need to calculate the value of the following parameters:
• InputModuleDataOffset
• InputModuleStatusOffset
• OutputModuleDataOffset
• OutputModuleStatusOffset
In addition, for the $STAHLAI8HART template instance, you need to calculate the value of the InputModuleDataOffset parameter for HART data.
To be able to configure the $GenericDevice template instance in the
Properties window of the Application Explorer , you need to calculate the value of the following parameters:
• Input Data Length
• Output Data Length
Calculating STAHL Parameter Values
Two tables are used to calculate parameter values to configure the STAHL instances in the context of STAHL IS1 Remote I/O system:
• Input/output module status offset : This table shows how to calculate the values to set the module status offset parameters.
• Input/output module data offset : This table shows how to calculate the values to set the module data offset parameters.
62 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
This example shows the parameters of the STAHLDI16_1 instance that you need to configure:
EIO0000002403.10
Slot
Slot 1 - DIM 16
Slot 2 - DOM 8
Slot 3 - AI 8
Slot 4 - AO 8
Slot 5 - AI 8 + 4
HART
Slot 6 - Empty
Slot 7 - Empty
Slot 8 - Empty
Slot 9 - Empty
Slot 10 - Empty
Slot 11 - Empty
Slot 12 - Empty
Slot 13 - Empty
Slot 14 - Empty
Slot 15 - Empty
Slot 16 - Empty
CPU status register
Modbus address
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029–1031
Slot
Slot 1 - DIM 16
Modbus address
1032
1033
Data
Data (DI31–DI0)
Status (S15–S0)
Data
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
Status (S15–S0)
CPU status
Input module data offset
19
20
5
8
9
6
7
10
11
12
13
14
15
16–18
3
4
1
2
Input/output module status offset
0
Output module data offset
–
–
Slot 2 - DOM 8 32
1034
Data (DO31–DO0)
Status (S15–S0)
–
21
1
–
Slot 3 - AI 8 1035–1042
1043
Data (AI7–AI0)
Status (S7–S0)
22–29
30
–
–
63
Foundation Application Templates
Slot
Slot 4 - AO8
Modbus address
33–40
1044
Data
Data AO7–AO0)
Status (S7–S0)
Slot 5 - AI 8 + 4
HART
1045–1052
1053
1054–1060
Data (AI7–AI0)
Status (S7–S0)
HART data
Signal Conditioning and Processing
Input module data offset
–
31
Output module data offset
2–8
–
32–39
40
41–48
–
–
–
Calculating STAHL HART Parameter Values
The following figure shows the STAHLAI8HART_1 instance and the two parameters of the STHALAI8 element, which you calculate in the same way as for the STHALAI8_1 instance:
The following figure shows the InputModuleDataOffset parameter of the
STHALHV4 element, which you calculate using the module data offset table:
64
Calculating the GenericDevice Instance Parameter Values
Calculate the value of the parameters of the $GenericDevice application instance as follows:
• Input Data Length : Total number of read/input registers in the context of
STAHL IS1 remote I/O system.
• Output Data Length : Total number of write/output registers in the context of
STAHL IS1 remote I/O system.
NOTE: You have to enter the length of the input/output data variable greater than or equal to 2, to avoid detected errors in project build.
EIO0000002403.10
Signal Conditioning and Processing
Configuration
Foundation Application Templates
Overview
The Quantum controller and the STAHL IS1 Remote I/O system communication through Modbus TCP Ethernet implicit message by using the I/O scanner service of the controller. A generic Modbus TCP I/O device entity (which is the counterpart of the generic device instance create in the Application) allows you to perform the communication mapping with the controller.
Configuring the Topology
Step
1
2
3
Action
In the Topological Explorer , create a Quantum controller entity and configure it with the I/O scanner enabled.
Configure the client memory properties with suitable values.
NOTE: The configuration of the STAHL IS1 Remote I/O system is performed outside of EcoStruxure Process Expert.
Create a Modbus TCP I/O device entity by using the $EGenericDeviceHW template and configure its properties.
The following figure shows the properties of the generic Modbus TCP I/O device entity after configuring its parameters:
EIO0000002403.10
The parameters are calculated as follows in the context of the STAHL IS1 Remote
I/O system:
• ReadLength = Total number of read/input registers. The actual number is 49 but it is rounded off to 50.
• WriteLength = Total no of write/output registers. The actual number is 8 but it is rounded off to 10.
For detailed information on ReadAddress and WriteAddress parameters, refer to the Operating_instructions_IS1_ModTCP manual .
Connecting to the Control Network
Create an Ethernet network and make a physical connection with the controller and the generic device entities.
65
Foundation Application Templates
Finalizing the System
Signal Conditioning and Processing
Procedure
To complete the system engineering life cycle, complete the following steps:
Step Action
1 Create a Control project.
2
3
4
Assign facets of the $GenericDevice
Generate the project.
and STAHL instances to the Control project
5
Create an executable and proceed with:
• Service mapping.
• Communication mapping: To configure data exchange between the controller and the STAHL IS1 Remote I/O system system by I/O scanning.
• Hardware mapping: To map the application facet of the $GenericDevice instance to the topological facet of the generic Modbus TCP I/O device entity.
Build the project.
The following figure shows the communication mapping:
The following figure shows the hardware mapping:
66 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
The Logical Control Participant Project
The following figures show as an example FBD section to which a facet of two
STAHL instances was assigned after generating it. It contains the DFB, which is encapsulated in each facet and logical references to the generic device data variables:
This figure shows the STAHLDI16CH DFB, which is encapsulated in the facet of the STAHLDI16_1 instance (digital input template):
EIO0000002403.10
67
Foundation Application Templates
Signal Conditioning and Processing
This figure shows the STAHLDO8CH DFB, which is encapsulated in the facet of
STAHLDO8_1 instance (digital output template):
68 EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
STAHL Remote I/O System Configuration
Overview
You need to do the STAHL IS1 Remote I/O system configuration on a local Control
Expert application with the help of a DTM.
This topic describes the configuration of the STAHL IS1 Remote I/O system, which contains one Modbus TCP interface and the five I/O modules.
Two configuration scenarios can be considered:
• Scenario 1: The STAHL IS1 Remote I/O system is connected to the network, the digital and analog modules are plugged on to the BusRail and an IP address is assigned to the STAHL IS1 Remote I/O system CPU. In this case, the Control Expert DTM Browser field bus discovery feature is used, allowing the appropriate modules to be automatically selected.
• Scenario 2: The STAHL IS1 Remote I/O system is not reachable. In this case, the digital and analog I/O modules are manually selected by using the Control
Expert DTM Catalog .
Installing the STAHL IS1 Remote I/O System DTM
In any case, you need to install the STAHL IS1 Remote I/O system DTM on the
PC on which you are running Control Expert first. A DTM installs like traditional software.
You can download the STAHL IS1 Remote I/O system DTM from the STAHL http:// www.rstahl.com
Updating the Control Expert DTM Catalog
After the DTM is installed, you have to update the Control Expert DTM catalog .
Refer to Updating the Control Expert Hardware Catalog in the Control Expert online help.
Configuring the STAHL IS1 Remote I/O System - Common
Steps
The table describes the steps of the configuration that are common to both scenarios.
Step
1
2
Action
In the DTM Browser , right click the Host PC folder , and select Add to open the DTM catalog .
Select the 9441/1x-00-00 CPM Z1 24V Eth Modbus TCP/IP DTM, which corresponds to the selected CPU, and click Add DTM .
EIO0000002403.10
69
Foundation Application Templates
Step Action
Signal Conditioning and Processing
3 You can change the Alias name. In this guide IS1 is used as alias.
4
5
Double-click the IS1 instance to open the DTM.
Enter the selected IP address of the module in the Address field.
70
6 Click OK to apply the modifications and close the DTM.
EIO0000002403.10
Signal Conditioning and Processing
Foundation Application Templates
Configuring the STAHL IS1 Remote I/O System - Scenario 1
For scenario 1, you have to be able to reach the IS1 module by using a ping command from the computer on which Control Expert is running.
The table describes the steps of the configuration that are specific to scenario 1.
Step
1
Action
In the DTM Browser , right click and select Connect .
2
NOTE: The field bus discovery service is available only when the DTM is connected to the corresponding physical device. For details refer to DTM Browser in the Control Expert online help.
Once connected, right click IS1 again and select Field bus discovery :
EIO0000002403.10
3 Select the slot number to discover. Start with the first slot, which corresponds to the first
I/O module inserted in the BusRail. In this case, the D9470_3x_16_xx_DIM_16 DIM 16
STAHL module is inserted in Slot01 .
71
Foundation Application Templates
Step Action
Signal Conditioning and Processing
72
4
5
6
7
Click OK to launch the discovery. The Field bus discovery dialog box is displayed. It lists the scanned and matched devices.
From the Matched Devices pane, select the module and click the + button to add it to the selected devices pane.
Click OK to insert the module into the Control Expert DTM Browser .
Repeat steps 2 to 6 for the remaining DTM/slot pairs.
Configuring the STAHL IS1 Remote I/O System - Scenario 2
For scenario 2, the field bus discovery feature cannot be used and you need to select the modules manually.
The table describes the steps of the configuration that are specific to scenario 2:
Step
1
2
3
4
5
Action
In the DTM Browser , right click IS1 and click Add… to open the DTM catalog .
Select the appropriate DTM and click Add DTM to validate. A window opens to select the slot number on the BusRail where the selected DTM is physically inserted.
Click OK to confirm the slot number. The Properties window opens. In this window, you can change the alias name.
Click OK to complete the DTM instantiation .
Repeat steps 1 to 5 for the remaining DTM slot pairs.
EIO0000002403.10
Special Cards
Overview
Foundation Application Templates
This chapter explains the basic functionality of the special card templates and their composition.
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.
NOTE:
• User has to verify that Counter module has been mounted properly and standard connections are done per the manual.
• In case of any detected error and if required, user to implement suitable diagnostic message to provide information.
EIO0000002403.10
73
Foundation Application Templates
Special Card Application Templates Approach
Naming Convention
The following naming convention is applied for interface and template identifiers of special cards, taking the example of the high speed counter with 5 channels:
• Topological template: '$Q<model>'. For instance, $Q140EHC10500 .
• Mapping interface definition name: '$Q<model>Mapping'. For instance,
$Q140EHC10500Mapping .
Role names: 'HO' for the topological role and 'SO' for the project facet.
• DDT Type name: 'Q<model>_DDT'. For instance, Q140EHC10500_DDT .
• DFB Type name: 'Q<model>_DFB'. For instance, Q140EHC10500_DFB .
• Application facet template: '$Q<model>_UL'. For instance,
$Q140EHC10500_UL .
• Application interface definition: '$Q<model>_DDT'. For instance,
$Q140EHC10500_DDT .
74 EIO0000002403.10
Foundation Application Templates
$QEHC10500
- Quantum High Speed 5-Channel Counter Module
General Description
The $QEHC10500 special card template allows you to manage the high speed counter with 5 channels that utilizes 5 equivalent, independently usable counters.
The mapping value is 12 %IW-3X and 12 %MW-4X.
Parameters
The $QEHC10500 template features no configurable parameters other than the general $System parameters ($Name, $Description, and $Area).
Composition
Control
Services
Logic
Composite
Template
$QEHC10500_
UC
The special card template $QEHC10500 is composed of composite and facet templates, which provide the core Control services.
The following table describes the services that are available from the
$QEHC10500 control module and the corresponding facet, which implements the service:
Corresponding Facet
Template
Control Service
Description
$QEHC10500 _UL Refer to the
Q140EHC10500_
DFB DFB (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User
Guide).
Associated
Supervision
Services
–
Corresponding
Facet Template
–
Supervision
Service
Description
–
EIO0000002403.10
75
Foundation Application Templates
$QEHC20200
- Quantum High Speed 2-Channel Counter Module
General Description
The $QEHC20200 special card template allows you to manage the high speed counter with 2 channels.
This template 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.
Parameters
The $QEHC20200 template features no configurable parameters other than the general $System parameters ($Name, $Description, and $Area).
Composition
Control Services
Logic
The special card template $QEHC20200 is composed of composite and facet templates, which provide the core Control services.
The following table describes the services that are available from the
$QEHC20200 control module and the corresponding facet, which implements the service:
Composite
Template
$QEHC2020_
UC
Corresponding Facet
Template
$QEH-
C20200_UL
Control Service
Description
Refer to the
Q140EHC20200_
DFB DFB (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User
Guide).
Associated
Supervision
Services
–
Corresponding Facet
Template
–
Supervision
Service
Description
–
76 EIO0000002403.10
Foundation Application Templates
$QERT85410
- Quantum Expert Time Stamp Module
General Description
The $QERT85410 special card template allows you to manage and configure the
140ERT85410 module as a counter and discrete application. Time stamp application has to be independently managed by the user.
This template is for the intelligent 32 point input module and Counter module of
Quantum controllers that allow configuration of inputs and evaluates the input signal status every 1 ms.
For every Q140ERT85410 module being used in the configuration, one instance of the $QERT85410 application template has to be used.
Parameters
Element Name
Logic
Configuration
The table describes the Configuration parameters of the template that you can configure:
Name
ModulexFunction (where x=
1, 2, 3, 4)
Type
Enum
ModulexType (where x= 1, 2,
3, 4)
Boolean
Default value
Discrete
False
Description
Below configuration can be set for these parameters:
• Discrete
• Counter
NOTE: When configuring this module as a 1, 2 or 8 point with
Time tag in topology, select he
Enum value as Discrete.
• False = Without quality DISignal , the interfaces are generated.
• True = With quality DISignal , the interfaces are generated.
NOTE: Values of boolean parameters are set by using check boxes:
• Selected = True
• Cleared = False
Composition
Control
Services
Logic
Composite
Template
–
The special card template $QERT85410 is composed of composite and facet templates, which provide the core Control services.
The following table describes the services that are available from the
$QERT85410 control module and the corresponding facet, which implements the service:
Corresponding Facet
Template
$QERT85410_
UL
Control Service
Description
Refer to the
Q140ERT85410_DFB
DFB (see
EcoStruxure ™ Process
Expert, Foundation
Control Services User
Guide).
Associated
Supervision
Services
–
Corresponding
Facet Template
–
Supervision
Service
Description
–
The control module template exposes the following interfaces:
EIO0000002403.10
77
Foundation Application Templates
Interface Identifier
QERT85410Mapping
CRPMapping
Interface Model/Role Identifier
$Q140ERT85410Mapping
$CRPMapping
Description
Mapping interface to pass the
QERT85410 module information from topology
Application interface to map to the
$CRPPortAddress if the
Q140ERT85410 module is connected on a RIO/ERIO drop
DISignalChannelx
(where x = 1 to 32)
$Bool Application interface is exposed when the module is configured as a digital input
DInputChannelx x = 1 to 32)
(where
ERTCNTChannelx
(where x = 1 to 32)
$DInputSignal
$Q140ERT85410_CNTData
Application interface is exposed when the module is configured as a digital input with quality signal enabled
Application interface is exposed when the module is configured as a counter.
For a device, role identifiers other than DO, Ref, and Def link to a communication object.
A DO role identifier links to a process object.
78 EIO0000002403.10
Foundation Application Templates
$QERT85420
- Quantum Expert Time Stamp Module
General Description
The $QERT85420 special card template allows you to manage and configure the
140ERT85420 module as a counter and discrete application. Time stamp application has to be independently managed by the user.
This template is for the intelligent 32 point input module and Counter module of
Quantum controllers that allow configuration of inputs and evaluates the input signal status every 1 ms.
For every Q140ERT85420 module being used in the configuration, one instance of the $QERT85420 application template has to be used.
Parameters
Element Name
Logic
Configuration
The table describes the Configuration parameters of the template that you can configure:
Name
ModulexFunction (where x=
1, 2, 3, 4)
Type
Enum
ModulexType (where x= 1, 2,
3, 4)
Boolean
Default value
Discrete
False
Description
Below configuration can be set for these parameters:
• Discrete
• Counter
NOTE: When configuring this module as a 1, 2 or 8 point with
Time tag in topology, select the
Enum value as Discrete.
• False = Without quality DISignal , the interfaces are generated.
• True = With quality DISignal , the interfaces are generated.
NOTE: Values of boolean parameters are set by using check boxes:
• Selected = True
• Cleared = False
Composition
Control
Services
Logic
Composite
Template
–
The special card template $QERT85420 is composed of composite and facet templates, which provide the core Control services.
The following table describes the services that are available from the
$QERT85420 control module and the corresponding facet, which implements the service:
Corresponding Facet
Template
$QERT85420_
UL
Control Service
Description
Refer to the
Q140ERT85420_DFB
DFB (see
EcoStruxure ™ Process
Expert, Foundation
Control Services User
Guide).
Associated
Supervision
Services
–
Corresponding
Facet Template
–
Supervision
Service
Description
–
The control module template exposes the following interfaces:
EIO0000002403.10
79
Foundation Application Templates
Interface Identifier
QERT85420Mapping
CRPMapping
Interface Model/Role Identifier
$Q140ERT85420Mapping
$CRPMapping
Description
Mapping interface to pass the
QERT85420 module information from topology
Application interface to map to the
$CRPPortAddress if the
Q140ERT85420 module is connected on a RIO/ERIO drop
DISignalChannelx
(where x = 1 to 32)
$Bool Application interface is exposed when the module is configured as a digital input
DInputChannelx x = 1 to 32)
(where
ERTCNTChannelx
(where x = 1 to 32)
$DInputSignal
$Q140ERT85420_CNTData
Application interface is exposed when the module is configured as a digital input with quality signal enabled
Application interface is exposed when the module is configured as a counter.
For a device, role identifiers other than DO, Ref, and Def link to a communication object.
A DO role identifier links to a process object.
80 EIO0000002403.10
Foundation Application Templates
$TUnsignCptBmx
- M340 High Speed Counter Module UnSign
General Description
This template helps you to manage the data of the special cards:
• A specific topological template per special card model is defined to provide the base addresses and the mapping model, based on the retrieved data from the configuration in the topology of the system.
• Each channel has an equal number of mapping interfaces. 2 sets of mapping interfaces are available for 2 channels and 8 sets of mapping interfaces are available for 8 channels in the topological template.
• For each type of channel configuration, you can generate a specific DFB
(signed or un signed) for data reading (from Hardware Module) and packaging.
• Use this template for the T_UNSIGN_CPT_BMX IODDT depending on the mode that is configured for the counter channel. Refer to Overview tab of the counter module in the Control Participant for details.
NOTE: You can configure 1 channel per instance of the template. To configure
2 channels, create 2 instances.
Parameters
The $TUnsignCptBmx template features no configurable parameters other than the general $System parameters ($Name, $Description, and $Area).
Composition
Control
Services
Composite
Template
$TUnsignCptBmx
–
Interface Identifier
UNSIGN_CPT_BMX_MAP
UNSIGN_CPT_BMX_DDT
The following table describes the services that are available from the
$TUnsignCptBmx template and the corresponding facet, which implements the service.
Corresponding
Facet Template
$TUnsignCptBmx_
UL
Control Service
Description
Refer to T_UNSIGN_
CPT_BMX_DFB (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide)
Associated
Supervision
Services
–
Corresponding
Facet Template
–
Supervision
Service
Description
–
The control module template $T_UNSIGN_CPT_BMX_DFB exposes the following interfaces.
Role Identifier
$T_UNSIGN_CPT_BMXMapping / SO
$T_UNSIGN_CPT_BMX_DDT / Def
Description
Mapping interface to map to the topological template
Application interface, which contains DDT information for the user
EIO0000002403.10
81
Foundation Application Templates
$TSignCptBmx
- M340 High Speed Counter Module Sign
General Description
This template helps you to manage the data of the special cards:
• A specific topological template per special card model is defined to provide the base addresses and the mapping model, based on the retrieved data from the configuration in the topology of the system.
• Each channel has an equal number of mapping interfaces. 2 sets of mapping interfaces are available for 2 channels and 8 sets of mapping interfaces are available for 8 channels in the topological template.
• For each type of channel configuration, you can generate a specific DFB
(signed or unsigned) for data reading (from Hardware Module) and packaging.
• Use this template for the T_SIGN_CPT_BMX IODDT depending on the mode that is configured for the counter channel. Refer to Overview tab of the counter module in the Control Participant for details.
NOTE: You can configure 1 channel per instance of the template. To configure
2 channels, create 2 instances.
Parameters
The $TSignCptBmx template features no configurable parameters other than the general $System parameters ($Name, $Description, and $Area).
Composition
Control
Services
Composite
Template
$TSign-
CptBmx
–
Interface Identifier
SIGN_CPT_BMX_MAP
SIGN_CPT_BMX_DDT
The following table describes the services that are available from the
$TSignCptBmx template and the corresponding facet, which implements the service.
Corresponding
Facet Template
Control Service
Description
$TSignCptBmx_UL Refer to T_SIGN_
CPT_BMX_DFB (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide)
Associated
Supervision
Services
–
Corresponding
Facet Template
–
Supervision
Service
Description
–
The control module template $TSignCptBmx exposes the following interfaces.
Role Identifier
$T_SIGN_CPT_BMXMapping / SO
$T_SIGN_CPT_BMX_DDT / Def
Description
Mapping interface to map to the topological template
Application interface, which contains DDT information for the user
82 EIO0000002403.10
Foundation Application Templates
$TCptFlmIn2
- M340 Turbo Machinery Frequency Module
Template
General Description
This template helps you manage the data of the BMXETM0200 module:
• A specific topological template is defined to provide the base addresses and the mapping model, based on the data retrieved from the configuration in the topology of the system.
• Each channel has an equal number of mapping interfaces. 2 sets of mapping interfaces for 2 channels are available in the topological template.
NOTE: You can configure 1 channel per instance of the template. To configure
2 channels, create 2 instances.
Parameters
The $TCptFlmIn2 template features no configurable parameters other than the general $System parameters ($Name, $Description, and $Area).
Composition
Control
Services
Composite
Template
$TCptFlmIn2
–
Interface Identifier
T_CPT_FLMMapping
T_CPT_FLM_DDDT
The following table describes the services that are available from the
$TCptFlmIn2 template and the corresponding facet, which implements the service.
Corresponding
Facet Template
$TCptFlmIn2_UL
Control Service
Description
Refer to T_CPT_
FLM_IN2 DFB (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide)
Associated
Supervision
Services
–
Corresponding
Facet Template
–
Supervision
Service
Description
–
The $TCptFlmIn2 control module template exposes the following interfaces.
Role Identifier
$T_CPT_FLMMapping /SO
$T_CPT_FLM_CH_DDDT / Def
Description
Mapping interface to map to the topological template.
Application interface, which contains DDT information for the user.
EIO0000002403.10
83
Foundation Application Templates
$EPITesysUAS
- Advantys Special Module for Handling TeSys U
Information
General Description
The $EPITesysUAS template is the device template to manage the TeSys U with
EPI2145 module on an Advantys STB I/O island.
Parameters
Element name
Logic
Name
ResetMode
Configuration
The table describes the Configuration parameters of the template that you can configure:
Type
Boolean
Default value
False
Description
• False = Manual reset.
• True = Automatic reset.
NOTE: Values of boolean parameters are set by using check boxes:
• Selected = True
• Cleared = False
Element name
Logic
Time
The table describes the Time parameters of the template that you can configure:
Name
MaxResetTime
CommandCtrlWindow
Type
Duration
Duration
Default value
00:01:00
00:00:05
Description
The maximum time between two automatic resets of the DFB.
Time the device takes to execute commands.
Composition
Control
Services
Composite template
The following table describes the services that are available from the
$EPITesysUAS control module and the corresponding facet, which implements the service:
Corresponding facet template
Control Service description
Associated
Supervision
Services
Corresponding facet template
Supervision
Service description
Core Services
Logic – $EPITesysUAS_UL Refer to
EPITESYSU DFB.
(see EcoStruxure ™
Process Expert,
Foundation Control
Services User
Guide)
– – –
Mapping Interface
$EPI2145Data/DO
The control module template $EPITesysUAS exposes the following interfaces:
Interface identifier
$DEV1S1D
Interface Model/Role identifier
$DEV1S1D/DO
$DEV1S2D $DEV1S2D/DO
For a device, role identifiers other than DO, Ref, and Def link to a communication object.
A DO role identifier links to a process object.
Description
Links to a process object
Links to a process object
84 EIO0000002403.10
Foundation Application Templates
EIO0000002403.10
85
Foundation Application Templates
$BMXEHC
- M580 and X80 High Speed Counter Module
General Description
This template helps you to manage the data of the special cards:
• A specific topological template per special card model is defined to provide the base addresses and the mapping model, based on the retrieved data from the control configuration (during the bottom-up process of the topological manager).
• Each channel has an equal number of mapping interfaces. 2 sets of mapping interfaces are available for 2 channels and 8 sets of mapping interfaces are available for 8 channels in the topological template.
• For each type of channel configuration, you can generate a specific DFB for data reading (from Hardware Module) and packaging.
NOTE: You can configure 1 channel per instance of the template. To configure
2 channels, create 2 instances.
Parameters
The $BMXEHC template features no configurable parameters other than the general $System parameters ($Name, $Description, and $Area).
Composition
Control
Services
Composite
Template
$BMXEHC $BMXEHC
Interface Identifier
CHANNEL_MAP
COUNTER_CHANNEL_DDDT
The following table describes the services that are available from the $BMXEHC template and the corresponding facet, which implements the service.
Corresponding
Facet Template
$BMXEHC_UL
Control Service
Description
Refer to BMXEHC
DFB (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide)
Associated
Supervision
Services
–
Corresponding
Facet Template
–
Supervision
Service
Description
–
The control module template of $BMXEHC exposes the following interfaces.
Role Identifier
$T_M_CPT_STD_CH_INMapping
$T_M_CPT_STD_CH_DDDT
Description
Mapping interface to map to the topological template.
Application interface, which contains DDT information for the user.
86 EIO0000002403.10
Foundation Application Templates
$BMXETM
- M580 and X80 Turbo Machinery Frequency Module
Template
General Description
This template helps you manage the data of the BMXETM0200 module:
• A specific topological template is defined to provide the base addresses and the mapping model, based on the data retrieved from the configuration in the topology of the system.
• Each channel has an equal number of mapping interfaces. 2 sets of mapping interfaces for 2 channels are available in the topological template.
• For each type of channel configuration, you can generate a specific DFB to read data (from the hardware module) and package it.
NOTE: You can configure 1 channel per instance of the template. To configure
2 channels, create 2 instances.
Parameters
The $BMXETM template features no configurable parameters other than the general $System parameters ($Name, $Description, and $Area).
Composition
Control
Services
Composite
Template
$BMXETM $BMXETM
Interface Identifier
ChannelMap
FREQUENCY_CHANNEL_DDDT
The following table describes the services that are available from the $BMXETM template and the corresponding facet, which implements the service.
Corresponding
Facet Template
$BMXETM_UL
Control Service
Description
Refer to BMXETM
DFB (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide)
Associated
Supervision
Services
–
Corresponding
Facet Template
–
Supervision
Service
Description
–
The $BMXETM control module template exposes the following interfaces.
Role Identifier
$T_M_CPT_FLM_CH_INMapping
$T_M_CPT_FLM_CH_DDDT
Description
Mapping interface to map to the topological template.
Application interface, which contains DDT information for the user.
EIO0000002403.10
87
Foundation Application Templates
$BMXERT1604
- M580 and X80 16-Channel Digital Input Time
Stamp Module
General Description
The $BMXERT1604 template allows you to manage and configure the
BMXERT1604T/H module. The time stamp application has to be managed independently.
This template lets you use the channels of the module as regular digital inputs, time stamping, and/or counter functions.
For every BMXERT1604T/H module being used in the configuration, one instance of the $BMXERT1604 application template has to be used.
Parameters
Element Name
Control
BMXERTChannelx
(where x = 1 to 16)
Negate
Type
DISignalName
Configuration
The table describes the Configuration parameters of the template that you can configure.
Name
FCTTypeSelectionx (where x
= 1, 2, or 3)
Type
Enum
Boolean
Boolean
String
Default value
Time Stamping
(2)
False
False
Blank
Description
Either of the following values can be set for each one:
• Discrete Input (0)
• Counter (1)
• Time Stamping (2)
NOTE: Channels 0 to 3 are used for time stamping only.
True negates the input signal.
Refer to
Enter a name to be used for the generated EFB and variables.
The name needs to be unique within the application of the system.
Composition
Control Services
( $BMXERT1604_UC )
BMXERTChannel1 to
BMXERTChannel16
The $BMXERT1604 template references composite and facet templates, which provide the following services:
Control
Supervision
Includes core services input signal.
These services complement the Control services. Supervision Services are optional.
The table describes the services that are available from the template and the corresponding facets, which implement the service.
Facet template Control service description
$BMXERTDISignal_
UL
Refer to
DISignalCond1 (see
EcoStruxure ™
Process Expert,
Foundation Control
Services User Guide)
Associated Supervision services ($BMXERT1604_
CS)
BMXERTData_1 to
BMXERTData_16
Corresponding facet template
$BMXERT1604_CD
88 EIO0000002403.10
Interfaces
Interface Identifier
BoolVar
DINPUTSignalExt
DISignal
DINPUTSignal
BMXERT1604Name
Foundation Application Templates
The control module template exposes the following interfaces.
Interface Model/Role Identifier
$Bool/Ref
$DINPUTSignal/Ref
$Bool/Def
$DINPUTSignal/Def
$BMXERT1604_IF/Def
Description
Receives the name of the parameter, which holds the digital input signal value.
Receives the name of the parameter, which holds the digital input signal value and signal quality.
Provides the name of the parameter, which holds the digital input signal value.
Provides the name of the parameters, which hold the digital input signal value and signal quality.
Provides the name of the instance.
NOTE: There are as many sets of interfaces as there are channels.
EIO0000002403.10
89
Foundation Application Templates
Variable Templates
90 EIO0000002403.10
Elementary Variable Templates
Overview
Foundation Application Templates
These templates generate an elementary variable of the corresponding data type of the Control Participant.
The name of the variable is the identifier of the instance.
Parameters
The table describes the Configuration parameters of elementary variable templates that you can configure.
Type (1)
String
Default Value
Blank
Description/comment
Memory address of the variable
Template
All templates except
$Bool_UL
Name
Address
InitValue
$Byte_UL
$Date_UL
Boolean
UnsignedByte
Data
$Time_UL
$DInt_UL
$DT_UL
$DWord_UL
$EBool_UL
$Int_UL
$Real_UL
$String_UL
$UDInt_UL
$UInt_UL
$Word_UL
$Range_UL
$Bool_UL
$EBool_UL
Low
High
EU
Format
TimeStamping
Duration
Integer
DateTime
UnsignedInt
Boolean
Short
Float
String
UnsignedInt
UnsignedShort
UnsignedShort
Float
Float
String
String
Enum
False (check box cleared)
0
1/1/1900
0
0
“”
0
0.0
0
False (check box cleared)
0
0.0
100.0
%
###.#EU
None
–
–
Format: dd/mm/yyyy
Valid range for year: 1990 to 2099
Format: dd.hh:mm:ss.mss
00:00:00
0
01/01/1900 00:00:00 Format: dd/mm/yyyy
Valid range for year: 1990 to 2099
–
Low end of the range measured in engineering units.
High end of the range measured in engineering units.
Engineering units.
Format that is used to display the process value.
Sets the Time stamping attributes of the generated variable providing the signal value.
Possible values:
• Both Edges
• Rising Edge
• Falling Edge
• None
NOTE: By default, EcoStruxure
Process Expert uses the System time stamping mode, which
EIO0000002403.10
91
Foundation Application Templates
Template Name Type (1) Default Value Description/comment supports only the Both Edges setting.
The other values are supported by the Applicative time stamping mode. Refer to the topic describing
Control Expert settings (see
EcoStruxure ™ Process Expert,
Control Participant Services, User
Guide).
$Bool_UL
$EBool_UL
PLCHMIVar Boolean True Sets the HMI variable attribute of the generated variable providing the signal value.
NOTE: Keep this parameter set to
True if you change the default value for TimeStamping ; otherwise, the Time stamping attribute of the generated variable is set to None independently of your selection.
(1) EcoStruxure Process Expert converts the data types automatically to Control Participant supported types (see EcoStruxure ™ Process
Expert, Control Participant Services, User Guide).
NOTE: $TOD_UL only has the Address parameter.
Interfaces
The elementary variable templates shows the following application interfaces:
Template Type/role Description
$Bool_UL
$Byte_UL
$Date_UL
$Time_UL
$DInt_UL
$DT_UL
$DWord_UL
$EBool_UL
$Int_UL
$Real_UL
$String_UL
$UDInt_UL
$UInt_UL
$Word_UL
$TOD_UL
$Range
Interface identifier
Bool
Byte
Date
Time
Dint
DT
DWord
EBool
Int
Real
String
UDInt
UInt
Word
TOD
AnalogRange
$Bool/Def
$Byte/Def
$Date/Def
$Time/Def
$DInt/Def
$DT/Def
$DWord/Def
$EBool/Def
$Int/Def
$Real/Def
$String/Def
$UDInt/Def
$UInt/Def
$Word/Def
$TOP/Def
$Range/Def
Provides the name of the variable, which is the instance identifier.
Provides the following data:
• Name of the variable, which is the instance identifier.
• The value of the
Configuration parameters:
◦ Low
◦ High
◦ EU
◦ Format
92 EIO0000002403.10
Template
$AryBool_UL
$AryByte_UL
$AryDint_UL
$AryDT_UL
$AryDWord_UL
$AryEBool_UL
$AryInt_UL
$AryItem_UC
$AryReal_UL
$AryString_UL
$AryTime_UL
$AryTOD_UL
$AryUDInt_UL
$AryUInt_UL
$AryWord_UL
Array Variable Templates
Overview
Foundation Application Templates
These templates generate a 1-dimensional array of the corresponding data type of the Control Participant.
The name of the variable is the identifier of the instance.
NOTE: The $AryItem_UC template allows writing/reading a data item in a 1dimensional array by providing a string which refers to a specific element of the array (for example, MyArray[2]).
Parameters
The table describes the Configuration parameters of array variable templates that you can configure.
Template
All templates
All templates except
$AryString_UL
Name
Address
FirstItem
LastItem
FirstItem
Type (1)
String
Integer
Integer
Integer
Default Value
Blank
1
10
1
Description/comment
Memory address of the variable
Starting index value of the array
Ending index value of the array
Starting index value of the array
$AryItem_UC
LastItem
Item_1
Integer
Integer
16
Blank
Ending index value of the array
Defines the index of the element in the array to be accessed.
For example, 2 defines the second element of
ARRAY[1...10] of BOOL.
(1) EcoStruxure Process Expert converts the data types automatically to Control Participant supported types (see EcoStruxure ™ Process
Expert, Control Participant Services, User Guide).
Interfaces
Interface identifier
ArrayBool
ArrayByte
ArrayDInt
ArrayDT
ArrayDWord
ArrayEBool
ArrayInt
ArrayItem
ArrayReal
ArrayString
ArrayTime
ArrayTOD
ArrayUDInt
ArrayUInt
ArrayWord
The array variable templates shows the following application interfaces:
Type/role
$Array_Bool/Def
$Array_Byte/Def
$Array_DInt/Def
$Array_DT/Def
$Array_DWord/Def
$Array_EBool/Def
$Array_Int/Def
$Array_Item/Def
$Array_Real/Def
$Array_String/Def
$Array_Time/Def
$Array_TOD/Def
$Array_UDInt/Def
$Array_UInt/Def
$Array_Word/Def
Description
Provides the name of the variable, which is the instance identifier.
EIO0000002403.10
93
Foundation Application Templates
Template
$AryItem_UC
Interface identifier
Array_DataType_1 where DataType corresponds to the type of existing array templates
For example, Array_Bool_1
Array_DataTypeValue_1 where DataType corresponds to the type of existing array templates
For example, Array_
BoolValue_1
Type/role
$Array_DataType/Ref where DataType corresponds to the type of existing array templates
For example, Array_Bool/Ref
$Array_DataType/Def where DataType corresponds to the type of existing array templates
For example, $Bool/Def
Description
Receives the name of the array from which a data item is to be read or written.
Linking an interface of type Ref enables the corresponding interface of type Def.
Provides the name of the array whose interface is connected to a Ref interface of the corresponding type concatenated with the element index configured in the instance.
For example, AryBool_UL_1[2 .
94 EIO0000002403.10
Reference Data Type Variable Templates
Overview
Foundation Application Templates
These templates generate an elementary variable of reference data type of the
Control Participant.
The name of the variable is the identifier of the instance.
Parameters
Template
All
Name
InitValue
The table describes the Configuration parameters ( Name ) of reference data type variable templates that you can configure.
Type
String
Default Value
Blank
Description/comment
Memory address of the variable (Value attribute of the variable in the Control Participant)
Example 1: For InitValue = %MW100, Value = REF(%MW100)
Example 2: For InitValue = MOD_DIS_16_2.DIS_CH_OUT[15].
VALUE, Value = REF(MOD_DIS_16_2.DIS_CH_OUT[15].VALUE) where MOD_DIS_16_2 is a device DDT variable.
Example 3: For InitValue = blank, Value = blank
Interfaces
The reference data type variable templates shows the following application interfaces:
Interface identifier
DATATYPE where DATATYPE corresponds to the type of existing reference data type variable templates
For example, WORD
Type/role
$DataType/Def where DataType corresponds to the type of existing reference data type variable templates
For example, $Word/Def
Description
Provides the name of the dereferenced variable by using the caret postfix (^).
For example, REF_TO_WORD_
UL_1^
EIO0000002403.10
95
Foundation Application Templates
Using HART Analog I/O Signals
96 EIO0000002403.10
Getting Started
Overview
Foundation Application Templates
The Hardware Mapping Editor allows you to map only one signal per channel of a supported HART analog I/O module, which is configured in the topology. The
HART module is acting as a regular I/O module and the signal corresponds to the
Primary Variable (PV). The other HART signals, for example, Secondary Variable
(SV), Tertiary Variable (TV), and/or Quarternary Variable (QV) are not available.
This chapter describes that additional steps that are required to be able to use all
HART signals (including PV) coming from supported HART analog I/O modules by using their device DDT variables. In such case, no more hardware mapping is required for HART input signals. Hardware mapping is still required to send the 4-
20 mA output signal to a HART module.
The manual configuration involves using the Application Explorer and the
Project Explorer of the engineering client.
NOTE: For instructions how to configure HART modules in the topology, refer to the topic describing how to complete the configuration stage (see
EcoStruxure ™ Process Expert, User Guide).
Prerequisites
• One or more HART analog I/O module exists in the Topology Explorer in a controller of the M580 or Quantum platform, which contains a NOC communication module.
• The corresponding HART I/O module device type manager (DTM) is added and configured (except for the configuration of process data, which is described in this procedure). Refer to the corresponding User Guide (see
EcoStruxure ™ Process Expert, Control Participant Services, User Guide).
• The necessary HART device DTMs are installed in EcoStruxure Process
Expert. This is required to be able to configure or monitor HART devices. If the devices are already configured, the installation of device DTMs is not necessary. (Contact vendor to obtain the device DTM if necessary).
Modifying an Existing System
If you are already using a HART analog I/O module in your system and are accessing PV by using an instance of $AnalogInput1 or $AISignal_UL through the hardware mapping, you can access the other HART signals by using the procedure described in this chapter. You do not need to modify the way you have implemented PV. Both methods can coexist in the same system.
EIO0000002403.10
97
Foundation Application Templates
Configuration Stage (Topology Explorer)
Configuring HART DTM Process Data
Step
1
2
Action
Right-click the controller entity containing the HART analog I/O module and select
Configure .
Open the DTM of the HART analog I/O module. In the Process Data section of the
DTM, select the variables (primary, secondary, tertiary, and so on) that you need to use for each channel that is enabled.
Allocating State RAM Addresses
Click the button in the toolbar of the Participant window. This builds the application and allocates state RAM addresses to the DDDT variables created through the HART module DTM based on the enabled channels and their process data configuration.
Transferring to FDR Server
Verify that the HART module is available and transfer of FDR is possible.
98 EIO0000002403.10
Application Explorer
Foundation Application Templates
Creating and Configuring $AnalogInput1 Application Template Instances
Step
1
2
Action
Create as many instances of the $AnalogInput1 template as you have enabled HART signals for each channel of a module.
Example:
If you have enabled PV and SV for channel 0 and PV, SV, and TV for channel 1, you need to create 5 instances of the template. Each instance creates one variable corresponding to one signal of a channel of a HART analog I/O module. Other variables and/or a DFB instance are created depending on the configuration of the instance.
Edit each instance by using the Instance Editor and clear the check box of the
AnalogInputSignal control service.
Creating $AnalogOutput Application Template Instances
To send the 4-20 mA signal to a HART analog output module, create an instance of the $AnalogOutput template.
NOTE: To read the HART signals, create and configure instances of the
$AnalogInput1 template as described in the previous topic.
EIO0000002403.10
99
Foundation Application Templates
Project Explorer
Assigning Facets and Generating the Control Project
Assign the instances of the $AnalogInput1 and/or $AnalogOutput template to the
Control project and generate it.
Refining the Control Project
Step
1
2
3
4
Action
Refine the Control project.
Create the device DDT variables (see EcoStruxure ™ Process Expert, User Guide) of the HART analog I/O modules in the Control project.
Link each variable of the device DDT that represents a signal to the EXTPV input of the
DFB that has been generated by the corresponding facet.
Set the EXTPVEN input of these DFBs to true.
The following figure shows an example of the device DDT variable representing
QV of channel 0 of a HART analog input module that is linked to the EXTPV input of the AINPUT1 DFB. This is the DFB that was generated by the facet of the instance of the $AnalogInput1 template that has been created for the QV signal of channel 0. (The figure shows the default value for EXTPVEN ( false ).)
Performing the Hardware Mapping
To send the 4-20 mA signal to a HART analog output module, map the AOChannel interface of the $AnalogOutput template instance to the output channel of the
HART module by using the Hardware Mapping Editor .
Building the Control Project
Build the Control project. If you had already built the Control project a first time, use the Build All command.
100 EIO0000002403.10
Topology Explorer
Foundation Application Templates
Deploying the Built Control Project
Step
1
2
Action
Deploy the built Control project to the controller.
Use the Refine Online command to verify the logic and values online.
EIO0000002403.10
101
Index
Foundation Application Templates
K
Krohne field instruments
mapping input signals to STB modules ................27
$AHISignal_UL
template description ...........................................27
$AISignal_UL
template description ...........................................16
$AOSignal_UL
template description ...........................................18
$BMXERT1604
template description ...........................................88
$CounterSignal_UL
template description ...........................................20
$DISignal_UL
template description ...........................................22
$DOSignal_UL
template description ...........................................24
$Q140ERT85410
template description ...........................................77
$Q140ERT85420
template description ...........................................79
$Q1EHC10500
template description ...........................................75
$QEHC20200
template description ...........................................76
$STAHLAI8
template description ...........................................49
$STAHLAI8HART
template description ...........................................57
$STAHLAO8
template description ...........................................51
$STAHLDI16
template description ...........................................53
$STAHLDO8
template description ...........................................55
$TSBool
template description ...........................................30
$TSDInput
template description ...........................................34
$TSDOutput
template description ...........................................36
$TSEBool
template description ...........................................32
S setpoint management
$TSBool ............................................................30
$TSDInput.........................................................34
$TSDOutput ......................................................36
$TSEBool..........................................................32
signals
$AISignal_UL template.......................................16
$AOSignal_UL template .....................................18
$CounterSignal_UL template ..............................20
$DISignal_UL template.......................................22
$DOSignal_UL template .....................................24
special cards
$BMXERT1604..................................................88
$Q140ERT85410...............................................77
$Q140ERT85420...............................................79
$QEHC10500 ....................................................75
$QEHC20200 ....................................................76
STAHL
$STAHLAI8 .......................................................49
$STAHLAI8HART with 4 or 8 HART signals..........57
$STAHLAO8......................................................51
$STAHLDI16 .....................................................53
$STAHLDO8 .....................................................55
example use case ..............................................59
T templates
list of foundation application templates.................12
time stamping
time stamping templates.....................................29
D device templates
special card application templates approach ........74
F foundation application templates
list of templates..................................................12
H hardware abstraction layer templates
$AHISignal_UL ..................................................27
$AISignal_UL ....................................................16
$AOSignal_UL...................................................18
$CounterSignal_UL............................................20
$DISignal_UL ....................................................22
DOSignal_UL ....................................................24
HART
mapping input signals to STB modules ................27
EIO0000002403.10
103
Schneider Electric
35 rue Joseph Monier
92500 Rueil Malmaison
France
+ 33 (0) 1 41 29 70 00 www.se.com
As standards, specifications, and design change from time to time, please ask for confirmation of the information given in this publication.
© 2022 Schneider Electric . All rights reserved.
EIO0000002403.10
Stiahnuť
Verejný odkaz bol aktualizovaný
Verejný odkaz na váš chat bol aktualizovaný. You may view and manage your chat links after registration here.
Verejný odkaz na dokument
Reklama