—

V ER S I ON 6 . 1/ 2

Wrapper Objects
800xA – AC800M – Minerals Library

PREPARED STATUS SECURITY LEVEL

2021-10-13 N.Cavalho Approved Public

APPROVED DOCUMENT KIND

2021-11-23 G.Schuetz Manual

OWNING ORGANIZATION DOCUMENT ID. REV. LANG. PAGE

IAPI ABB Switzerland 3BHS259604-612 I en 1/13

© Copyright 2020 ABB. All rights reserved.
 WR APP ER OBJ ECTS

Contents
1. Overview ...................................................................................................................................... 3
Principles of Wrapping in 800xA ..............................................................................................3

2. Control ........................................................................................................................................ 4
Control Modules .......................................................................................................................... 4
Wrapper CM.................................................................................................................................. 4
2.2.1. Parameters ..................................................................................................................5
2.2.2. Data Type .................................................................................................................... 6
Interface CM ................................................................................................................................. 6
2.3.1. Communication Watchdog ..................................................................................... 6

3. Operation ..................................................................................................................................... 7
Extended Info Links in Faceplate Header ............................................................................... 7
Extended Info Viewer .................................................................................................................. 7
3.2.1. Configuration ............................................................................................................. 9
3.2.2. Examples .................................................................................................................... 11

4. Revision history ........................................................................................................................ 13

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 2/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

1. Overview
Contained herein is a description of the Tools and Solutions available to add additional func-
tionality to the Mineral Library in the Form of Composite Objects by using an “Object Wrap-
per”. A structure for such objects is proposed and some examples are shown. It is intended
to help engineers during the design and implementation of their own control solutions by re-
using the Minerals Library Standard Object Types.

Principles of Wrapping in 800xA

The object wrapping technology combines the following:

Advantage of additional information available when using intelligent devices connected to

any type of field bus
Proven core functionalities of the Minerals Library.
The Minerals Library includes functions that allow the user to access data and aspects stored
in the wrapper, from the standard Mineral Library faceplates of the wrapped objects.

<MyObject> (Control Module)

Profibus or other Field Bus

<MyWrapper>IntCtrl (Control Module)

DWORD Coding and Decoding of FieldBus Data
<MyObject>.Interface (Data Type)
Hardware

Input Code Output Code Event Code

Block Block Block
(Data Type)
(Data Type)

SerialLink
SerialLink

Minerals Library Consumer Object (e.g. MOT1)

Figure 1 - Basic Structure of a Composite Object

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 3/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

2. Control

Control Modules
The Wrapper Object includes all needed Objects from Minerals Library as well as an addi-
tional Control Module to process Interface Data. It does normally not have a Faceplate or
Graphical Elements itself.

Composite Object Type (Wrap- CBM Instantiated Composite Object Composite Object after Name
per) Upload

Figure 2 - Composite Object Example

Wrapper CM
Note that the Wrapper Control Module must be configured to be instantiated as Aspect Ob-
ject for the inner Objects to be accessible from Plant Explorer.

Figure 3 - Instantiate as Aspect Object

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 4/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

2.2.1. Parameters

All Parameters from included Consumer Objects, that are not defined by the Interface or
other constraints from the Wrapper Object, should be declared as Parameters of the Wrapper
Object so it stays adaptable.

No Name Data Type Initial Value Description

1 Name string[20] INIT: Tag name of the serial object (. : - ok, no blanks al-
lowed!)

2 Motor_Name string[20] INIT: Tag name of the motor (. : - ok, no blanks allowed!)

3 Description string[40] 'Descr' IN: Description text of the motor

4 IO MOT1Data IN/OUT: Interface to the MOT1Data Variable

5 Interface MyWrap- IN/OUT: Variable Connection to Serial Interface / IO

per Inter-
face

6 Stw STWData default IN/OUT: Connection to control module STW (startwarn-

ing)

7 Group Grp- default IN/OUT: Connection to control module GROUP (se-

DrvCon quencer)

8 GrpStartStep dint cBMI.DINT_ IN: Start step no 1..999, if set to 0 -> not part of group se-
0 quence

9 GrpStopStep dint cBMI.DINT_ IN: Stop step no 1001..1999, if set to 0 -> not part of
0 group sequence

10 GrpStartDelay time cBMI.Time0s IN: Start delay when started from group sequence

11 GrpStopDelay time cBMI.Time0s IN: Stop delay when stopped from group sequence

12 InterfaceType dint 0 INIT: Interface for the MOT1 MC 0: Current (default), 1:

Power

13 MCNominal real INIT: Nominal (rated) load (current or power) of the motor

14 CurrentRange real 50 INIT: Max Current used for Trend

15 PowerRange real 100 INIT: Max Power used for Trend

16 ExtendedInfo dint cBMI.MNSiS IN: Mux 1 = ConsumerExt, 2 = Alarm List, 4 = Event List, 8 =
_MBTCP.Ext DetailGraphic, 16 = Status, 32 = Trend, 64 = Faceplate
endedInfo
Table 1 - Wrapper Object Parameters

The InterfaceType Parameter is also used for the Extended Info Aspect and should therefore
be created in all Wrapper Objects.

As all Objects with Faceplates need to have unique Names, all Name Parameters of included
Control Modules need to be declared as Parameters of the Wrapper Object.

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 5/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

2.2.2. Data Type

For Serial Interfaces, a structured Datatype should be defined containing all Input and Output
Data Variables that are to be connected on the Hardware Unit in CBM.

No Name Data Type Description

1 In MySerialInputData IN: Raw data from SerialInterface

2 Out MySerialOutputData OUT: Raw data to Serial Interface

3 UnitStatus HwStatus IN: HwUnit Status Information

Table 2 - Interface Datatype

Interface CM
The Interface Control Module is used to convert Data coming from the serial Interface into the
Data needed for the Minerals Library Control Modules. In case the LCB Signals (LcbStart /
LcbStop) are generated in this Control Module, it needs to run in FastTask.

2.3.1. Communication Watchdog

For Serial Interfaces, in general a Watchdog should be implemented in the User Application
on both sides to trigger the execution of Failsafe logic in case of Communication Error.

Code similar to the following can be used, one Boolean is inverted in the Application on Mas-
ter side:

TOn_Watchdog(Interface.Out.Watchdog xor Interface.In.Watchdog);

Interface.Out.Watchdog := not Interface.In.Watchdog;

Where in the User Application in the field side the same Boolean is just copied back from Out

to In.

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 6/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

3. Operation

Extended Info Links in Faceplate Header

Figure 4 - Extended Info Links in Faceplate Header

The Faceplate for all Consumer Objects includes Links to different Aspects that are used to
give the operator access to additional Information from the Wrapper Object.

Name Links to Aspect Description

Extended Info Extended Info Table with additional Properties of the Wrapper Object, mainly
Viewer used for Diagnostic / Detailed Warnings

Extended Status ../Status The “Status” Aspect of the Wrapper Object, particularly the Miner-
alsLib WebView Aspect configured in the Wrapper Object

Overlap Display Overlap_<Name> Any Overlap Display in Functional Structure, where the Aspect
Graphic Display Name is equal to the Object Name with the Prefix and Suffix as de-
fined in the “BMI Overlap Link” General Properties Aspect

Faceplate ../Faceplate The Faceplate of the Wrapper Object

Extended Trend ../Trend A Trend configured in the Wrapper Object (named “Trend”)

Extended Alarm List ../Alarm List The Alarm List of the Wrapper Object

Extended Event List ../Event List The Event List of the Wrapper Object
Table 3 - Extended Info Aspect Links

It is possible for special cases to configure the reference to the Object (Search Path) in the
“BMI Overlap Link” General Properties Aspect.

Extended Info Viewer

The Extended Info Viewer element can be used to show additional information coming from
the Wrapper Objects OPC Data in form of a List of Values.

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 7/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

Figure 5 - Extended Info Viewer Overview

Detailed Warning and Failure Data, which is not needed for normal operation, can be shown
on this Aspect as a List of Text Strings. It can use all Data that is available in the Wrapper Ob-
jects OPC Property List.

Figure 6 - Control Module OPC Properties

Normally, all boolean Values that are equal to their configured normal value are not shown.
This can be changed with the “Show normal position values” Checkbox.

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 8/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

Figure 7 - Extended Info Viewer showing all Information

3.2.1. Configuration

The Configuration of the Extended Info Viewer is stored in an Aspect of Category “Minerals
Library Extended Info Configuration Entry” on the Wrapper Object.

To configure the Extended Info Viewer, create a new “Minerals Library Extended Info Configu-
ration Entry” Aspect in the Object Type Structure and configure it to be inherited in every in-
stance.

The Configuration Aspect contains a Table specifying the Properties and Descriptions to be
shown in the Viewer.

The “Search Options” are not applicable for the Extended Info Viewer.

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 9/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

Figure 8 - Extended Info Configuration Screenshot

Column Description

EntryName Grouping of multiple Configuration Entries into one List Entry. This Column is only used for
the InterfaceFilter Option and shall be left empty otherwise.

Property The Name of the OPC Property of this Entry

Description The Description as shown in the List, for int and real Types this text is parsed for the unit
String enclosed in parentheses

DataType Datatype of the Property, one of real, uint, int, dint, bool, bits

Format Additional Options depending on the Datatype

Real: Dec = x; where x is the number of fractional digits
withparams; special Option for loading Unit and Fraction from the RealIO Parameter Variables
Bool: NormPos = x; where x is 0 for false or 1 for true
Bits: NormPos = x, AndMask = &hxxx; where xxx is the Bitmask in Hex

Default not used, shall be left emtpy

Grouping To sort the List into Groups, this column shall contain the Group Header that is shown to the
User

InterfaceFilter Value of the InterfaceType Parameter for which this Entry is shown, or “-1” to show it inde-
pendent of the configured InterfaceType.
In addition to this, there must be an Entry in the Configuration with EntryName and Descrip-
tion set to “InterfaceFilter” that refers to a Property of Datatype “int” that is used to filter the
Properties shown depending on the Interface Type configured on the Control Module.
Table 4 - Extended Info Configuration Keywords

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 10/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

DataType Option Description

Real Dec = n n is the number of fractional digits that will be shown

Real withparams load Unit and Fraction information from OPC, only possible for Variables of
Type RealIO

Bool NormPos = x the Normal Position of the Value (x = 0 for false or 1 for true), in case the Ac-
tual Value is equal to Normal Position, the Row will be hidden in the Con-
sumerExt01

Bits NormPos = x, NormPos is same as for Bool, while yyy is the Bitmask in Hex that will be ap-
AndMask = &hyyy plied to the Value. If the Value is not equal to 0 after applying the Mask, the
Value is True, else False

int Base = 16 show the Value as Hex, correct negative Values by adding 2^16, assuming 16
Bit signed Integer Data
(without this option, the Decimal Value will be shown)

unit Base = 16 show the Value as Hex

(without this option, the Decimal Value will be shown)

dint Base = 16 show the Value as Hex, correct negative Values by adding 2^32, assuming 32
Bit signed Integer Data
(without this option, the Decimal Value will be shown)
string Format=x exectutes string.format with {0} as the OPC Value and x as the format string.
NormPos=y string y defines the normal position (hides the value)
Table 5 - Extended Info Configuration Format Options

3.2.2. Examples

EntryName Property Description DataType Options Grouping InterfaceFilter

Control Module: No Motor bool NormPos Data 1

IO.Interface.Fault2.B1 Data (bool) =0

Control Module: Torque (%) real Dec = 2 Data 1

IO.Torque.Signal.Value

Control Module: No Motor bits NormPos Data 1

IO.Interface.DWFault1 Data (bit) = 0,
AndMask
= &h2

Control Module: Fault Word 2 int Base=16 Data 1

IO.Interface.DWFault1

Control Module: Power real with- Data 1

IO.Interface.Power.Value params

InterfaceFil- Control Module: Inter- InterfaceFil- int

ter faceType ter
Table 6 - Extended Info Configuration Examples

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 11/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

Figure 9 - Extended Info Viewer Example Screenshot

An error indication is shown in the lower right edge if there are some issues, either Data Qual-
ity Bad (any configured Data could not be read with good quality) or Configuration Error
(wrong or missing data in configuration aspect).

Figure 10 - Error Indication in Extended Info Viewer

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 12/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt
 WR APP ER OBJ ECTS

4. Revision history
Rev. Page (P) Description Date Dept./Init.
Chapt. (C)

0 Original document 04.09.08 ATBPA/LK

added “withparams” Parameter 08.04.09 ATBPA/LK

A “Instantiate as Aspect Object” hint added 27.10.09 ATBPA/LK

B Update for Datatypes, ConsumerExt Format Options Table 27.03.13 ATBPA/LK

C Added Section Communication Watchdog 02.07.13 ATBPA/LK

D Update Screenshots to PG2 Faceplates 23.05.14 ATBPA/LK

E Replace old VB Aspect with new Extended Info Viewer 03.02.15 ATBPA/LK

F Formal changes for Release 6.0 12.09.16 ATBPA/GS

G Update for Release 6.0/3 24.10.18 IAPIOE7/LK

H New formatting for MinLib Version 6.1/0 09.10.2019/AT

I Update for VCO MinLib 6.1/2 11.11.2020/JM

STATUS SECURITY LEVEL DOCUMENT ID. REV. LANG. PAGE

Approved Public 3BHS259604-612 I en 13/13

We reserve all rights in this document and the information contained therein. Reproduction, use or disclosure to third parties without express authority is strictly forbidden.
© Copyright 2020 ABB Switzerland Lt