Figure4_

Figure5_

OPC UA Companion Specification

OPC 40223

 

OPC UA for Pumps and Vacuum Pumps

 

 

 

Release 1.0

2021-04-19

OPC 40223 (Release 1.0) is identical with VDMA 40223:2021-04  - Description: Figure3_

Figure1_


 

Contents

 

Page

Foreword. 12

Introduction. 12

1              Scope. 13

2              Normative references. 14

3              Terms, definitions and conventions. 16

3.1          Overview.. 16

3.2          OPC UA for Pumps and Vacuum Pumps terms. 16

3.3          Conventions used in this document 17

4              General information to Pumps and Vacuum Pumps and OPC UA. 21

4.1          Introduction to Pumps and Vacuum Pumps. 21

4.2          Introduction to OPC Unified Architecture. 21

5              Use cases. 27

5.1          Device Identification. 27

5.2          Configuration. 27

5.3          Maintenance Management 27

5.4          Operation. 27

6              OPC UA for Pumps and Vacuum Pumps information model overview.. 28

6.1          Modelling Concepts. 28

6.2          Model Overview.. 29

6.3          Extending FunctionalGroups. 31

7              OPC UA ObjectTypes. 32

7.1          PumpType ObjectType Definition. 32

7.2          IPumpVendorNameplateType ObjectType Definition. 33

7.3          MarkingsType ObjectType Definition. 34

7.4          PumpIdentificationType ObjectType Definition. 35

7.5          DocumentationType ObjectType Definition. 36

7.6          MaintenanceGroupType ObjectType Definition. 38

7.7          GeneralMaintenanceType ObjectType Definition. 39

7.8          ConditionBasedMaintenanceType ObjectType Definition. 42

7.9          PreventiveMaintenanceType ObjectType Definition. 43

7.10        BreakdownMaintenanceType ObjectType Definition. 44

7.11        SupervisionType ObjectType Definition. 45

7.12        SupervisionMechanicsType ObjectType Definition. 46

7.13        SupervisionHardwareType ObjectType Definition. 47

7.14        SupervisionSoftwareType ObjectType Definition. 48

7.15        SupervisionProcessFluidType ObjectType Definition. 49

7.16        SupervisionPumpOperationType ObjectType Definition. 50

7.17        SupervisionAuxiliaryDeviceType ObjectType Definition. 51

7.18        SupervisionElectronicsType ObjectType Definition. 53

7.19        ConfigurationGroupType ObjectType Definition. 54

7.20        DesignType ObjectType Definition. 55

7.21        SystemRequirementsType ObjectType Definition. 64

7.22        ImplementationType ObjectType Definition. 68

7.23        OperationalGroupType ObjectType Definition. 73

7.24        ControlType ObjectType Definition. 74

7.25        ActuationType ObjectType Definition. 75

7.26        PumpActuationType ObjectType Definition. 76

7.27        DiscreteObjectType ObjectType Definition. 78

7.28        DiscreteInputObjectType ObjectType Definition. 79

7.29        DiscreteOutputObjectType ObjectType Definition. 79

7.30        PumpKickObjectType ObjectType Definition. 80

7.31        SignalsType ObjectType Definition. 80

7.32        MeasurementsType ObjectType Definition. 82

7.33        VibrationMeasurementType ObjectType Definition. 92

7.34        MultiPumpType ObjectType Definition. 97

7.35        PortsGroupType ObjectType Definition. 98

7.36        PortType ObjectType Definition. 99

7.37        DrivePortType ObjectType Definition. 100

7.38        InletConnectionPortType ObjectType Definition. 100

7.39        OutletConnectionPortType ObjectType Definition. 101

7.40        ConnectionDesignType ObjectType Definition. 101

7.41        InletConnectionDesignType ObjectType Definition. 102

7.42        OutletConnectionDesignType ObjectType Definition. 103

7.43        DriveDesignType ObjectType Definition. 105

7.44        InletConnectionSystemRequirementsType ObjectType Definition. 106

7.45        OutletConnectionSystemRequirementsType ObjectType Definition. 107

7.46        ConnectionImplementationType ObjectType Definition. 107

7.47        InletConnectionImplementationType ObjectType Definition. 108

7.48        OutletConnectionImplementationType ObjectType Definition. 109

7.49        DriveMeasurementsType ObjectType Definition. 110

7.50        InletConnectionMeasurementsType ObjectType Definition. 113

7.51        OutletConnectionMeasurementsType ObjectType Definition. 113

8              OPC UA DataTypes. 115

8.1          PhysicalAddressDataType. 115

8.2          DeclarationOfConformityOptionSet 115

8.3          ExplosionProtectionOptionSet 116

8.4          ExplosionZoneOptionSet 117

8.5          OfferedControlModesOptionSet 117

8.6          OfferedFieldbusesOptionSet 118

8.7          ControlModeEnum.. 119

8.8          PumpClassEnum.. 119

8.9          DistributionTypeEnum.. 120

8.10        ExchangeModeEnum.. 120

8.11        FieldbusEnum.. 121

8.12        MaintenanceLevelEnum.. 122

8.13        MultiPumpOperationModeEnum.. 122

8.14        OperatingModeEnum.. 123

8.15        OperationModeEnum.. 123

8.16        PortDirectionEnum.. 124

8.17        PumpKickModeEnum.. 124

8.18        PumpRoleEnum.. 124

8.19        StateOfTheItemEnum.. 125

9              Profiles and ConformanceUnits. 126

9.1          Conformance Units. 126

9.2          Profiles. 126

10           Namespaces. 128

10.1        Namespace Metadata. 128

10.2        Handling of OPC UA Namespaces. 128

Annex A (normative)       OPC UA for Pumps and Vacuum Pumps Namespace and mappings. 130

Annex B (informative) Example. 131

Annex C (informative) Bibliography. 132

 


 

Figures

 

Figure 1 – The Scope of OPC UA within an Enterprise. 22

Figure 2 – A Basic Object in an OPC UA Address Space. 23

Figure 3 – The Relationship between Type Definitions and Instances. 24

Figure 4 – Examples of References between Objects. 25

Figure 5 – The OPC UA Information Model Notation. 26

Figure 6 – Structure of an Asset Administration Shell 28

Figure 7 – Pumps & Vacuum Pumps Information Model (General - Structure) 29

Figure 8 – Pumps & Vacuum Pumps Information Model (Ports - Structure) 30

Figure 9 – Illustration of PumpType. 32

Figure 10 – Illustration of PumpIdentificationType. 35

Figure 11 – Illustration of MaintenanceGroupType. 38

Figure 12 – Illustration of SupervisionType. 45

Figure 13 – Illustration of SupervisionMechanicsType. 46

Figure 14 – Illustration of OperationalGroupType. 73

Figure 15 – Illustration of ActuationType. 75

Figure 16 – Illustration of PumpActuationType. 76

Figure 17 – Illustration of DiscreteObjectType. 78

Figure 18 – Illustration of MeasurementsType. 82

Figure 19 – Illustration of PortType. 99

Figure 20 – Illustration of ConnectionDesignType. 101

Figure 21 – Illustration of ConnectionImplementationType. 107

Figure 22 - Example of an instantiated PumpType. 131

 


 

Tables

 

Table 1 – Examples of DataTypes. 17

Table 2 – Type Definition Table. 18

Table 3 – Examples of Other Characteristics. 18

Table 4 – Common Node Attributes. 19

Table 5 – Common Object Attributes. 19

Table 6 – Common Variable Attributes. 19

Table 7 – Common VariableType Attributes. 20

Table 8 – Common Method Attributes. 20

Table 9 – PumpType Definition. 32

Table 10 – PumpType Attribute values for child Nodes. 33

Table 11 – IPumpVendorNameplateType Definition. 33

Table 12 – IPumpVendorNameplateType Attribute values for child Nodes. 34

Table 13 – MarkingsType Definition. 34

Table 14 – MarkingsType Attribute values for child Nodes. 34

Table 15 – PumpIdentificationType Definition. 35

Table 16 – PumpIdentificationType Attribute values for child Nodes. 36

Table 17 – DocumentationType Definition. 36

Table 18 – DocumentationType Attribute values for child Nodes. 37

Table 19 – MaintenanceGroupType Definition. 38

Table 20 – MaintenanceGroupType Attribute values for child Nodes. 39

Table 21 – GeneralMaintenanceType Definition. 39

Table 22 – GeneralMaintenanceType Attribute values for child Nodes. 39

Table 23 – ConditionBasedMaintenanceType Definition. 42

Table 24 – ConditionBasedMaintenanceType Attribute values for child Nodes. 42

Table 25 – PreventiveMaintenanceType Definition. 43

Table 26 – PreventiveMaintenanceType Attribute values for child Nodes. 44

Table 27 – BreakdownMaintenanceType Definition. 44

Table 28 – BreakdownMaintenanceType Attribute values for child Nodes. 45

Table 29 – SupervisionType Definition. 45

Table 30 – SupervisionType Attribute values for child Nodes. 46

Table 31 – SupervisionMechanicsType Definition. 46

Table 32 – SupervisionMechanicsType Attribute values for child Nodes. 47

Table 33 – SupervisionHardwareType Definition. 47

Table 34 – SupervisionHardwareType Attribute values for child Nodes. 48

Table 35 – SupervisionSoftwareType Definition. 48

Table 36 – SupervisionSoftwareType Attribute values for child Nodes. 48

Table 37 – SupervisionProcessFluidType Definition. 49

Table 38 – SupervisionProcessFluidType Attribute values for child Nodes. 49

Table 39 – SupervisionPumpOperationType Definition. 50

Table 40 – SupervisionPumpOperationType Attribute values for child Nodes. 51

Table 41 – SupervisionAuxiliaryDeviceType Definition. 51

Table 42 – SupervisionAuxiliaryDeviceType Attribute values for child Nodes. 52

Table 43 – SupervisionElectronicsType Definition. 53

Table 44 – SupervisionElectronicsType Attribute values for child Nodes. 54

Table 45 – ConfigurationGroupType Definition. 54

Table 46 – ConfigurationGroupType Attribute values for child Nodes. 54

Table 47 – DesignType Definition. 55

Table 48 – DesignType Attribute values for child Nodes. 56

Table 49 – SystemRequirementsType Definition. 64

Table 50 – SystemRequirementsType Attribute values for child Nodes. 65

Table 51 – ImplementationType Definition. 68

Table 52 – ImplementationType Attribute values for child Nodes. 69

Table 53 – OperationalGroupType Definition. 73

Table 54 – OperationalGroupType Attribute values for child Nodes. 74

Table 55 – ControlType Definition. 74

Table 56 – ControlType Attribute values for child Nodes. 74

Table 57 – ActuationType Definition. 75

Table 58 – ActuationType Attribute values for child Nodes. 76

Table 59 – PumpActuationType Definition. 77

Table 60 – PumpActuationType Attribute values for child Nodes. 77

Table 61 – DiscreteObjectType Definition. 78

Table 62 – DiscreteObjectType Attribute values for child Nodes. 78

Table 63 – DiscreteInputObjectType Definition. 79

Table 64 – DiscreteInputObjectType Attribute values for child Nodes. 79

Table 65 – DiscreteOutputObjectType Definition. 79

Table 66 – DiscreteOutputObjectType Attribute values for child Nodes. 79

Table 67 – PumpKickObjectType Definition. 80

Table 68 – PumpKickObjectType Attribute values for child Nodes. 80

Table 69 – SignalsType Definition. 80

Table 70 – SignalsType Attribute values for child Nodes. 81

Table 71 – MeasurementsType Definition. 82

Table 72 – MeasurementsType Additional Subcomponents. 83

Table 73 – MeasurementsType Attribute values for child Nodes. 84

Table 74 – VibrationMeasurementType Definition. 92

Table 75 – VibrationMeasurementType Attribute values for child Nodes. 93

Table 76 – MultiPumpType Definition. 97

Table 77 – MultiPumpType Attribute values for child Nodes. 97

Table 78 – PortsGroupType Definition. 98

Table 79 – PortsGroupType Attribute values for child Nodes. 98

Table 80 – PortType Definition. 99

Table 81 – PortType Attribute values for child Nodes. 99

Table 82 – DrivePortType Definition. 100

Table 83 – DrivePortType Attribute values for child Nodes. 100

Table 84 – InletConnectionPortType Definition. 100

Table 85 – InletConnectionPortType Attribute values for child Nodes. 100

Table 86 – OutletConnectionPortType Definition. 101

Table 87 – OutletConnectionPortType Attribute values for child Nodes. 101

Table 88 – ConnectionDesignType Definition. 102

Table 89 – ConnectionDesignType Attribute values for child Nodes. 102

Table 90 – InletConnectionDesignType Definition. 102

Table 91 – InletConnectionDesignType Attribute values for child Nodes. 102

Table 92 – OutletConnectionDesignType Definition. 103

Table 93 – OutletConnectionDesignType Attribute values for child Nodes. 104

Table 94 – DriveDesignType Definition. 105

Table 95 – DriveDesignType Attribute values for child Nodes. 105

Table 96 – InletConnectionSystemRequirementsType Definition. 106

Table 97 – InletConnectionSystemRequirementsType Attribute values for child Nodes. 107

Table 98 – OutletConnectionSystemRequirementsType Definition. 107

Table 99 – OutletConnectionSystemRequirementsType Attribute values for child Nodes. 107

Table 100 – ConnectionImplementationType Definition. 108

Table 101 – ConnectionImplementationType Attribute values for child Nodes. 108

Table 102 – InletConnectionImplementationType Definition. 108

Table 103 – InletConnectionImplementationType Attribute values for child Nodes. 108

Table 104 – OutletConnectionImplementationType Definition. 109

Table 105 – OutletConnectionImplementationType Attribute values for child Nodes. 109

Table 106 – DriveMeasurementsType Definition. 110

Table 107 – DriveMeasurementsType Additional Subcomponents. 110

Table 108 – DriveMeasurementsType Attribute values for child Nodes. 110

Table 109 – InletConnectionMeasurementsType Definition. 113

Table 110 – InletConnectionMeasurementsType Additional Subcomponents. 113

Table 111 – InletConnectionMeasurementsType Attribute values for child Nodes. 113

Table 112 – OutletConnectionMeasurementsType Definition. 114

Table 113 – OutletConnectionMeasurementsType Additional Subcomponents. 114

Table 114 – OutletConnectionMeasurementsType Attribute values for child Nodes. 114

Table 115 – PhysicalAddressDataType Structure. 115

Table 116 – DeclarationOfConformityOptionSet Values. 115

Table 117 – DeclarationOfConformityOptionSet Definition. 115

Table 118 – ExplosionProtectionOptionSet Values. 116

Table 119 – ExplosionProtectionOptionSet Definition. 116

Table 120 – ExplosionZoneOptionSet Values. 117

Table 121 – ExplosionZoneOptionSet Definition. 117

Table 122 – OfferedControlModesOptionSet Values. 117

Table 123 – OfferedControlModesOptionSet Definition. 117

Table 124 – OfferedFieldbusesOptionSet Values. 118

Table 125 – OfferedFieldbusesOptionSet Definition. 119

Table 126 – ControlModeEnum Items. 119

Table 127 – ControlModeEnum Definition. 119

Table 128 – PumpClassEnum Items. 119

Table 129 – PumpClassEnum Definition. 120

Table 130 – DistributionTypeEnum Items. 120

Table 131 – DistributionTypeEnum Definition. 120

Table 132 – ExchangeModeEnum Items. 120

Table 133 – ExchangeModeEnum Definition. 120

Table 134 – FieldbusEnum Items. 121

Table 135 – FieldbusEnum Definition. 122

Table 136 – MaintenanceLevelEnum Items. 122

Table 137 – MaintenanceLevelEnum Definition. 122

Table 138 – MultiPumpOperationModeEnum Items. 122

Table 139 – MultiPumpOperationModeEnum Definition. 122

Table 140 – OperatingModeEnum Items. 123

Table 141 – OperatingModeEnum Definition. 123

Table 142 – OperationModeEnum Items. 123

Table 143 – OperationModeEnum Definition. 123

Table 144 – PortDirectionEnum Items. 124

Table 145 – PortDirectionEnum Definition. 124

Table 146 – PumpKickModeEnum Items. 124

Table 147 – PumpKickModeEnum Definition. 124

Table 148 – PumpRoleEnum Items. 124

Table 149 – PumpRoleEnum Definition. 125

Table 150 – StateOfTheItemEnum Items. 125

Table 151 – StateOfTheItemEnum Definition. 125

Table 152 – Conformance Units for OPC UA for Pumps and Vacuum Pumps. 126

Table 153 – Profile URIs for OPC UA for Pumps and Vacuum Pumps. 126

Table 154 – Pump Base Server Profile. 127

Table 155 – Pump Advanced Server Profile. 127

Table 156 – NamespaceMetadata Object for this Document 128

Table 157 – Namespaces used in an OPC UA for Pumps and Vacuum Pumps Server 129

Table 158 – Namespaces used in this document 129

 

 


 

OPC Foundation / VDMA

____________

AGREEMENT OF USE

COPYRIGHT RESTRICTIONS

·          This document is provided "as is" by the OPC Foundation and VDMA.

·          Right of use for this specification is restricted to this specification and does not grant rights of use for referred documents.

·          Right of use for this specification will be granted without cost.

·          This document may be distributed through computer systems, printed or copied as long as the content remains unchanged and the document is not modified.

·          OPC Foundation and VDMA do not guarantee usability for any purpose and shall not be made liable for any case using the content of this document.

·          The user of the document agrees to indemnify OPC Foundation and VDMA and their officers, directors and agents harmless from all demands, claims, actions, losses, damages (including damages from personal injuries), costs and expenses (including attorneys' fees) which are in any way related to activities associated with its use of content from this specification.

·          The document shall not be used in conjunction with company advertising, shall not be sold or licensed to any party.

·          The intellectual property and copyright is solely owned by the OPC Foundation and VDMA.

 

PATENTS

The attention of adopters is directed to the possibility that compliance with or adoption of OPC or VDMA specifications may require use of an invention covered by patent rights. OPC Foundation or VDMA shall not be responsible for identifying patents for which a license may be required by any OPC or VDMA specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. OPC or VDMA specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents.

WARRANTY AND LIABILITY DISCLAIMERS

WHILE THIS PUBLICATION IS BELIEVED TO BE ACCURATE, IT IS PROVIDED "AS IS" AND MAY CONTAIN ERRORS OR MISPRINTS. THE OPC FOUDATION NOR VDMA MAKES NO WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, WITH REGARD TO THIS PUBLICATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF TITLE OR OWNERSHIP, IMPLIED WARRANTY OF MERCHANTABILITY OR WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE. IN NO EVENT SHALL THE OPC FOUNDATION NOR VDMA BE LIABLE FOR ERRORS CONTAINED HEREIN OR FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, RELIANCE OR COVER DAMAGES, INCLUDING LOSS OF PROFITS, REVENUE, DATA OR USE, INCURRED BY ANY USER OR ANY THIRD PARTY IN CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS MATERIAL, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

The entire risk as to the quality and performance of software developed using this specification is borne by you.

RESTRICTED RIGHTS LEGEND

This Specification is provided with Restricted Rights. Use, duplication or disclosure by the U.S. government is subject to restrictions as set forth in (a) this Agreement pursuant to DFARs 227.7202-3(a); (b) subparagraph (c)(1)(i) of the Rights in Technical Data and Computer Software clause at DFARs 252.227-7013; or (c) the Commercial Computer Software Restricted Rights clause at FAR 52.227-19 subdivision (c)(1) and (2), as applicable. Contractor / manufacturer are the OPC Foundation, 16101 N. 82nd Street, Suite 3B, Scottsdale, AZ, 85260-1830

COMPLIANCE

The combination of VDMA and OPC Foundation shall at all times be the sole entities that may authorize developers, suppliers and sellers of hardware and software to use certification marks, trademarks or other special designations to indicate compliance with these materials as specified within this document. Products developed using this specification may claim compliance or conformance with this specification if and only if the software satisfactorily meets the certification requirements set by VDMA or the OPC Foundation. Products that do not meet these requirements may claim only that the product was based on this specification and must not claim compliance or conformance with this specification.

TRADEMARKS

Most computer and software brand names have trademarks or registered trademarks. The individual trademarks have not been listed here.

GENERAL PROVISIONS

Should any provision of this Agreement be held to be void, invalid, unenforceable or illegal by a court, the validity and enforceability of the other provisions shall not be affected thereby.

This Agreement shall be governed by and construed under the laws of Germany.

This Agreement embodies the entire understanding between the parties with respect to, and supersedes any prior understanding or agreement (oral or written) relating to, this specification.

 

Foreword

Introduction

The OPC 40223 specification is developed by members of VDMA and/or the OPC Foundation. OPC UA is a machine to machine communication technology to transmit characteristics of products (e.g. manufacturer name, device type or components) and process data (e.g. temperatures, pressures or feed rates). To enable vendor independent interoperability the description of product characteristics and process data has to be standardized utilizing technical specifications, the OPC UA companion specifications.

Associations

VDMA Pumps + Systems / Compressors, Compressed Air- and Vacuum Technology

The VDMA represents around 3300 German and European companies in the mechanical engineering industry. The industry represents innovation, export orientation, medium-sized companies and employs around four million people in Europe, more than one million of them in Germany.

Under the roof of VDMA the professional associations Pumps + Systems and Compressors, Compressed Air and Vacuum technology offer its members a management platform for informal meetings also on an international level. Beyond that a continuous, significant support of international regulations (standards, guidelines, recommendations) and its constant adaptation to changing requirements is administered. As unique feature of the professional associations the Research Funds Pumps and Vacuum technology, active in precompetitive manor offering the members to obtain fundamental knowledge-based methods.

OPC Foundation

OPC is the interoperability standard for the secure and reliable exchange of data and information in the industrial automation space and in other industries. It is platform independent and ensures the seamless flow of information among devices from multiple vendors. The OPC Foundation is responsible for the development and maintenance of this standard.

OPC UA is a platform independent service-oriented architecture that integrates all the functionality of the individual OPC Classic specifications into one extensible framework. This multi-layered approach accomplishes the original design specification goals of:

      Platform independence: from an embedded microcontroller to cloud-based infrastructure

      Secure: encryption, authentication, authorization and auditing

      Extensible: ability to add new features including transports without affecting existing applications

      Comprehensive information modelling capabilities: for defining any model from simple to complex


 

1       Scope

In their basic function of conveying fluids or gases, pumps and vacuum pumps perform elementary tasks in numerous technical processes in the process industry, building technology, the semiconductor and manufacturing industries, the food industry and water management. Additional functionalities, such as self-monitoring, the generation of status and diagnostic information, offer great potential for optimizing operating processes. Information for the identification of pumps is essential for device management, measured values for energy consumption are an important source for energy management applications, etc. Highly functional pumps are also multivariable devices (e.g. pressure, volume flow, temperature, etc.) because they require information about the process during operation. Their versatile use and special significance make pumps and vacuum pumps an important asset in the current developments around Industry 4.0 (I4.0).

I4.0 stands for the intelligent digital networking of products and processes to optimize the value chains of manufacturers and users. The central object of current developments is the I4.0-component, a composition of Administration Shell and asset. The Administration Shell represents the asset - e.g. a pump or vacuum pump - in the digital I4.0-world. Among other things, it consists of submodels that describe different aspects or functions of the asset in the form of standardized properties. They form the basis for a common language of pumps.

In 2019 pump manufacturers of the VDMA trade associations Pumps + Systems and Compressors, Compressed Air and Vacuum Technology have specified a manufacturer-independent Administration Shell for pumps and vacuum pumps for applications in the process industry, building technology, the semiconductor and manufacturing industries, the food industry and water management. The work focused on three main I4.0 application scenarios for the digital integration of pumps and vacuum pumps into the I4.0 information world: the support of continuous and dynamic engineering over the life cycle, optimized operation through transparency and adaptability of delivered products, and the provision of value-based services.

Based on acknowledged and applied National, European and International Standards the descriptions and definitions were used to develop submodels for pumps in the Administration Shell project. The developments are based on fundamental work in the I4.0 environment, which describes the general structure of the administration shell. On this basis, pump-specific submodels are developed. These are based on different standards which describe aspects and requirements of pumps. In this OPC UA Companion Specification the contents of the individual sumodels of the Asset Administration Shell were transferred to the information model of OPC UA.

Alongside the development of this OPC UA Companion Specification, the submodels and properties of the Asset Administration Shell for pumps and vacuum pumps were integrated into the product classification system ECLASS. Following the ECLASS Release 12.0 this OPC UA Companion Specification can be extended by the ECLASS references.

 


 

2       Normative references

 

OPC 10000-1, OPC Unified Architecture - Part 1: Overview and Concepts

http://www.opcfoundation.org/UA/Part1/

OPC 10000-2, OPC Unified Architecture - Part 2: Security Model

http://www.opcfoundation.org/UA/Part2/

OPC 10000-3, OPC Unified Architecture - Part 3: Address Space Model

http://www.opcfoundation.org/UA/Part3/

OPC 10000-4, OPC Unified Architecture - Part 4: Services

http://www.opcfoundation.org/UA/Part4/

OPC 10000-5, OPC Unified Architecture - Part 5: Information Model

http://www.opcfoundation.org/UA/Part5/

OPC 10000-6, OPC Unified Architecture - Part 6: Mappings

http://www.opcfoundation.org/UA/Part6/

OPC 10000-7, OPC Unified Architecture - Part 7: Profiles

http://www.opcfoundation.org/UA/Part7/

OPC 10000-8, OPC Unified Architecture - Part 8: Data Access

http://www.opcfoundation.org/UA/Part8/

OPC 10000-100, OPC Unified Architecture - Part 100: Devices

http://www.opcfoundation.org/UA/Part100/

OPC 40001-1, OPC UA for Machinery - Part 1: Basic Building Blocks

http://www.opcfoundation.org/UA/Machinery/

ISO 3529-2 - Vacuum technology – Vocabulary – Part 2: Vacuum pumps and related terms. ISO, 2018

ISO 6708 - Pipework components — Definition and selection of DN (nominal size). ISO, 1995

ISO 13372 - Condition monitoring and diagnostics of machines — Vocabulary. ISO, 2012

ISO 21360-2 - Vacuum technology — Standard methods for measuring vacuum-pump performance - Part 2: Positive displacement vacuum pumps. ISO, 2012

ISO/TR 25417 - Acoustics – Definitions of basic quantities and terms. ISO, 2007

IEC 62683-1 - Low-voltage switchgear and controlgear - Product data and properties for information exchange - Part 1: Catalogue data. VDE, 2017

DIN EN 61360-4 - Genormte Datenelementtypen mit Klassifikationsschema für elektrische Bauteile- Teil 4. Beuth Verlag, 2005

IEC 61987-1 - Industrial-process measurement and control - Data structures and elements in process equipment catalogues - Part 1: Measuring equipment with analogue and digital output. VDE, 2006

DIN EN 1333 - Flanges and their joints – Pipework components – Definition and selection of PN. Beuth-Verlag, 2006

DIN EN 13306 - Maintenance – Maintenance terminology. Beuth-Verlag, 2018

DIN EN 13460 - Maintenance – Documentation for maintenance; Beuth-Verlag, 2009

DIN EN ISO 17769 -1 - Liquid pumps and installation – General terms, definitions, quantities, letter symbols and units – Part 1: Liquid pumps. Beuth-Verlag, 2012

DIN EN ISO 17769 -2 - Liquid pumps and installation – General terms, definitions, quantities, letter symbols and units – Part 2: Pumping System. Beuth-Verlag, 2013

DIN 28400-2 - Vacuum technology; terms and definitions; vacuum pumps. Beuth-Verlag, 1980

DIN 28426-1 - Vacuum technology; acceptance specifications for rotary plunger vacuum pumps. Beuth-Verlag, 1983

IEC 60050-351 - International electrotechnical vocabulary –Part 351: Control technology. IEC, 2013

DIN EN ISO 80000-8 - Quantities and units – Part 8: Acoustics. Beuth-Verlag, 2020

VDMA 24223 - Device Profile for Liquid and Vacuum Pumps- Part I: Device Information Model, Universal Profile Elements Generic Pumps.” 2006

VDMA 24223 - Device Profile for Liquid and Vacuum Pumps- Part IIA: Vacuum Pumps.” 2006

VDI 3805-4 - Product data exchange in the building services (TGA) - Pumps. Beuth-Verlag, 1999

 


 

3       Terms, definitions and conventions

3.1         Overview

It is assumed that basic concepts of OPC UA information modelling, OPC Unified Architecture - Part 100, and OPC UA for Machinery - Part 1 are understood in this specification. This specification will use these concepts to describe the OPC UA for Pumps and Vacuum Pumps Information Model. For the purposes of this document, the terms and definitions given in OPC 10000-1, OPC 10000-3, OPC 10000-4, OPC 10000-5, OPC 10000-7, OPC 10000-100, OPC 40001-1, and VDMA 24223.

Note that OPC UA terms and terms defined in this specification are italicized in the specification.

3.2          OPC UA for Pumps and Vacuum Pumps terms

3.2.1          PumpClass

Specific type of a Pump and value of the PumpClass Variable of an instance of the FunctionalGroup Design of a Pump.

EXAMPLE 1         The pump P1 is of the PumpClass positive displacement pump.

EXAMPLE 2         The pump P2 is of the PumpClass turbo vacuum pump.

3.2.2          FunctionalGroup

Instance of the 2:FunctionalGroupType or one of its subtypes.

Note 1 to entry: In this specification, FunctionalGroup usually refers to an instance of a Pump specific ObjectType like OperationalGroupType, ActuationType, or DesignType.

EXAMPLE 1         The pump P1 has the FunctionalGroups Identification, Design, and Operational.

3.2.3          KindOfQuantity

aspect common to mutually comparable quantities

Note 1 to entry: The division of the concept of quantity into several kinds of quantity is to some extent arbitrary. Examples:

       The quantities diameter, circumference, and wavelength, are generally considered to be quantities of the same kind, namely of the kind of quantity called length.

       The quantities heat, kinetic energy, and potential energy, are generally considered to be quantities of the same kind, namely of the kind of quantity called energy.

Note 2 to entry: Quantities of the same kind within a given system of quantities have the same dimension of a quantity. However, quantities of the same dimension are not necessarily of the same kind.

Examples: The quantities moment of force and energy are not of the same kind, although they have the same dimension. Similarly for heat capacity and entropy, as well as for relative permeability and mass fraction.

Note 3 to entry: The term "kind" is mainly used in expressions such as "quantities of the same kind." Two quantities of the same kind are mutually comparable, so that they can be placed in order of magnitude. Length and mass are quantities of different kinds because they are not mutually comparable.

[SOURCE: ISO/IEC Guide 99:2007, 1.2, modified – Note 3 has been modified.]

3.2.4          Port

Connection point to a Pump used for fluids or auxiliary devices.

Note 1 to entry: Ports are described in chapter 6.2.

EXAMPLE 1         The pump P1 has its process fluid inlet connected at the Port InletConnectionPort.

EXAMPLE 2         The pump P1 has its drive connected at the Port DrivePort.

3.2.5          Pump

Asset of the DeviceClass Pump and representation of a pump or vacuum pump.

Note 1 to entry: This term includes all described pump types defined in this specification.

EXAMPLE 1         The pump P1 has the FunctionalGroups Identification, Design, and Operational.

3.3         Conventions used in this document

3.3.1          Conventions for Node descriptions

Node definitions are specified using tables (see Table 2 ).

Attributes are defined by providing the Attribute name and a value, or a description of the value.

References are defined by providing the ReferenceType name, the BrowseName of the TargetNode and its NodeClass.

      If the TargetNode is a component of the Node being defined in the table the Attributes of the composed Node are defined in the same row of the table.

      The DataType is only specified for Variables; “[<number>]” indicates a single-dimensional array, for multi-dimensional arrays the expression is repeated for each dimension (e.g. [2][3] for a two-dimensional array). For all arrays the ArrayDimensions is set as identified by <number> values. If no <number> is set, the corresponding dimension is set to 0, indicating an unknown size. If no number is provided at all the ArrayDimensions can be omitted. If no brackets are provided, it identifies a scalar DataType and the ValueRank is set to the corresponding value (see OPC 10000-3). In addition, ArrayDimensions is set to null or is omitted. If it can be Any or ScalarOrOneDimension, the value is put into “{<value>}”, so either “{Any}” or “{ScalarOrOneDimension}” and the ValueRank is set to the corresponding value (see OPC 10000-3) and the ArrayDimensions is set to null or is omitted. Examples are given in Table 1 .

Table 1 – Examples of DataTypes

Notation

Data­Type

Value­Rank

Array­Dimensions

Description

0:Int32

0:Int32

-1

omitted or null

A scalar Int32.

0:Int32[]

0:Int32

1

omitted or {0}

Single-dimensional array of Int32 with an unknown size.

0:Int32[][]

0:Int32

2

omitted or {0,0}

Two-dimensional array of Int32 with unknown sizes for both dimensions.

0:Int32[3][]

0:Int32

2

{3,0}

Two-dimensional array of Int32 with a size of 3 for the first dimension and an unknown size for the second dimension.

0:Int32[5][3]

0:Int32

2

{5,3}

Two-dimensional array of Int32 with a size of 5 for the first dimension and a size of 3 for the second dimension.

0:Int32{Any}

0:Int32

-2

omitted or null

An Int32 where it is unknown if it is scalar or array with any number of dimensions.

0:Int32{ScalarOrOneDimension}

0:Int32

-3

omitted or null

An Int32 where it is either a single-dimensional array or a scalar.

 

      The TypeDefinition is specified for Objects and Variables.

      The TypeDefinition column specifies a symbolic name for a NodeId, i.e. the specified Node points with a HasTypeDefinition Reference to the corresponding Node.

      The ModellingRule of the referenced component is provided by specifying the symbolic name of the rule in the ModellingRule column. In the AddressSpace, the Node shall use a HasModellingRule Reference to point to the corresponding ModellingRule Object.

If the NodeId of a DataType is provided, the symbolic name of the Node representing the DataType shall be used.

Note that if a symbolic name of a different namespace is used, it is prefixed by the NamespaceIndex (see 3.3.2.2).

Nodes of all other NodeClasses cannot be defined in the same table; therefore only the used ReferenceType, their NodeClass and their BrowseName are specified. A reference to another part of this document points to their definition.

Table 2 illustrates the table. If no components are provided, the DataType, TypeDefinition and ModellingRule columns may be omitted and only a Comment column is introduced to point to the Node definition.

Table 2 – Type Definition Table

Attribute

Value

Attribute name

Attribute value. If it is an optional Attribute that is not set “--“ will be used.

 

 

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

ReferenceType name

NodeClass of the TargetNode.

BrowseName of the target Node. If the Reference is to be instantiated by the server, then the value of the target Node’s BrowseName is “--“.

DataType of the referenced Node, only applicable for Variables.

TypeDefinition of the referenced Node, only applicable for Variables and Objects.

Additional characteristics of the TargetNode such as the ModellingRule or AccessLevel.

NOTE Notes referencing footnotes of the table content.

 

Components of Nodes can be complex that is containing components by themselves. The TypeDefinition, NodeClass and DataType can be derived from the type definitions, and the symbolic name can be created as defined in 3.3.3.1. Therefore, those containing components are not explicitly specified; they are implicitly specified by the type definitions.

The Other column defines additional characteristics of the Node. Examples of characteristics that can appear in this column are show in Table 3.

Table 3 – Examples of Other Characteristics

Name

Short Name

Description

0:Mandatory

M

The Node has the Mandatory ModellingRule.

0:Optional

O

The Node has the Optional ModellingRule.

0:MandatoryPlaceholder

MP

The Node has the MandatoryPlaceholder ModellingRule.

0:OptionalPlaceholder

OP

The Node has the OptionalPlaceholder ModellingRule.

ReadOnly

RO

The Node AccessLevel has the CurrentRead bit set but not the CurrentWrite bit.

ReadWrite

RW

The Node AccessLevel has the CurrentRead and CurrentWrite bits set.

WriteOnly

WO

The Node AccessLevel has the CurrentWrite bit set but not the CurrentRead bit.

 

If multiple characteristics are defined they are separated by commas. The name or the short name may be used.

3.3.2          NodeIds and BrowseNames

3.3.2.1            NodeIds

The NodeIds of all Nodes described in this standard are only symbolic names. Annex A defines the actual NodeIds.

The symbolic name of each Node defined in this document is its BrowseName, or, when it is part of another Node, the BrowseName of the other Node, a “.”, and the BrowseName of itself. In this case “part of” means that the whole has a HasProperty or HasComponent Reference to its part. Since all Nodes not being part of another Node have a unique name in this document, the symbolic name is unique.

The NamespaceUri for all NodeIds defined in this document is defined in Annex A. The NamespaceIndex for this NamespaceUri is vendor-specific and depends on the position of the NamespaceUri in the server namespace table.

Note that this document not only defines concrete Nodes, but also requires that some Nodes shall be generated, for example one for each Session running on the Server. The NodeIds of those Nodes are Server-specific, including the namespace. But the NamespaceIndex of those Nodes cannot be the NamespaceIndex used for the Nodes defined in this document, because they are not defined by this document but generated by the Server.

3.3.2.2            BrowseNames

The text part of the BrowseNames for all Nodes defined in this document is specified in the tables defining the Nodes. The NamespaceUri for all BrowseNames defined in this document is defined in Annex A.

If the BrowseName is not defined by this document, a namespace index prefix like ‘0:EngineeringUnits’ or ‘2:DeviceRevision’ is added to the BrowseName. This is typically necessary if a Property of another specification is overwritten or used in the OPC UA types defined in this document. Table 158 provides a list of namespaces and their indexes as used in this document.

3.3.3          Common Attributes

3.3.3.1            General

The Attributes of Nodes, their DataTypes and descriptions are defined in OPC 10000-3. Attributes not marked as optional are mandatory and shall be provided by a Server. The following tables define if the Attribute value is defined by this specification or if it is server-specific.

For all Nodes specified in this specification, the Attributes named in Table 4 shall be set as specified in the table.

Table 4 – Common Node Attributes

Attribute

Value

DisplayName

The DisplayName is a LocalizedText. Each server shall provide the DisplayName identical to the BrowseName of the Node for the LocaleId “en”. Whether the server provides translated names for other LocaleIds is server-specific.

Description

Optionally a server-specific description is provided.

NodeClass

Shall reflect the NodeClass of the Node.

NodeId

The NodeId is described by BrowseNames as defined in 3.3.2.1.

WriteMask

Optionally the WriteMask Attribute can be provided. If the WriteMask Attribute is provided, it shall set all non-server-specific Attributes to not writable. For example, the Description Attribute may be set to writable since a Server may provide a server-specific description for the Node. The NodeId shall not be writable, because it is defined for each Node in this specification.

UserWriteMask

Optionally the UserWriteMask Attribute can be provided. The same rules as for the WriteMask Attribute apply.

RolePermissions

Optionally server-specific role permissions can be provided.

UserRolePermissions

Optionally the role permissions of the current Session can be provided. The value is server-specific and depend on the RolePermissions Attribute (if provided) and the current Session.

AccessRestrictions

Optionally server-specific access restrictions can be provided.

 

3.3.3.2            Objects

For all Objects specified in this specification, the Attributes named in Table 5 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

Table 5 – Common Object Attributes

Attribute

Value

EventNotifier

Whether the Node can be used to subscribe to Events or not is server-specific.

 

3.3.3.3            Variables

For all Variables specified in this specification, the Attributes named in Table 6 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

Table 6 – Common Variable Attributes

Attribute

Value

MinimumSamplingInterval

Optionally, a server-specific minimum sampling interval is provided.

AccessLevel

The access level for Variables used for type definitions is server-specific, for all other Variables defined in this specification, the access level shall allow reading; other settings are server-specific.

UserAccessLevel

The value for the UserAccessLevel Attribute is server-specific. It is assumed that all Variables can be accessed by at least one user.

Value

For Variables used as InstanceDeclarations, the value is server-specific; otherwise it shall represent the value described in the text.

ArrayDimensions

If the ValueRank does not identify an array of a specific dimension (i.e. ValueRank <= 0) the ArrayDimensions can either be set to null or the Attribute is missing. This behavior is server-specific.

If the ValueRank specifies an array of a specific dimension (i.e. ValueRank > 0) then the ArrayDimensions Attribute shall be specified in the table defining the Variable.

Historizing

The value for the Historizing Attribute is server-specific.

AccessLevelEx

If the AccessLevelEx Attribute is provided, it shall have the bits 8, 9, and 10 set to 0, meaning that read and write operations on an individual Variable are atomic, and arrays can be partly written.

 

3.3.3.4            VariableTypes

For all VariableTypes specified in this specification, the Attributes named in Table 7 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

Table 7 – Common VariableType Attributes

Attributes

Value

Value

Optionally a server-specific default value can be provided.

ArrayDimensions

If the ValueRank does not identify an array of a specific dimension (i.e. ValueRank <= 0) the ArrayDimensions can either be set to null or the Attribute is missing. This behavior is server-specific.

If the ValueRank specifies an array of a specific dimension (i.e. ValueRank > 0) then the ArrayDimensions Attribute shall be specified in the table defining the VariableType.

3.3.3.5            Methods

For all Methods specified in this specification, the Attributes named in Table 8 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

Table 8 – Common Method Attributes

Attributes

Value

Executable

All Methods defined in this specification shall be executable (Executable Attribute set to “True”), unless it is defined differently in the Method definition.

UserExecutable

The value of the UserExecutable Attribute is server-specific. It is assumed that all Methods can be executed by at least one user.

 


 

4       General information to Pumps and Vacuum Pumps and OPC UA

4.1         Introduction to Pumps and Vacuum Pumps

Pumps are important industrial plant components in e.g. process industry, manufacturing industry and building engineering services. Due to a large installed basis, they allocate considerable capital and resources in numerous plants. An elementary task of pumps in operational process control engineering is to fulfill their basic function of conveying liquids or evacuating gases. Apart from the basic function, additional functionalities, e.g. self-monitoring, the generation of condition information and innovative diagnostics, open up a large potential for the optimization of the maintenance. To avoid breakdowns and to minimize downtimes of a production plant, self-monitoring and diagnostic functionalities are requested by plant operators. Information about the identification of pumps is essential for the audit trail and device management, the energy consumption is important for energy management applications etc. High-functional pumps are multivariable devices since they need information about the process. Such pumps are also a window to the process, an important source for additional information about the current process state [1].

Therefore, the integration of the informational bookkeeping of pumps into process control engineering is not only important for operational process control. Particularly its integration into a comprehensive plant asset management (e.g. foresighted maintenance) and plant energy management activates the full potential of pumps [1].

 

4.2         Introduction to OPC Unified Architecture

4.2.1          What is OPC UA?

OPC UA is an open and royalty free set of standards designed as a universal communication protocol. While there are numerous communication solutions available, OPC UA has key advantages:

      A state of art security model (see OPC 10000-2).

      A fault tolerant communication protocol.

      An information modelling framework that allows application developers to represent their data in a way that makes sense to them.

OPC UA has a broad scope which delivers for economies of scale for application developers. This means that a larger number of high-quality applications at a reasonable cost are available. When combined with semantic models such as OPC UA for Pumps and Vacuum Pumps, OPC UA makes it easier for end users to access data via generic commercial applications.

The OPC UA model is scalable from small devices to ERP systems. OPC UA Servers process information locally and then provide that data in a consistent format to any application requesting data - ERP, MES, PMS, Maintenance Systems, HMI, Smartphone or a standard Browser, for examples. For a more complete overview see OPC 10000-1.

4.2.2          Basics of OPC UA

As an open standard, OPC UA is based on standard internet technologies, like TCP/IP, HTTP, Web Sockets.

As an extensible standard, OPC UA provides a set of Services (see OPC 10000-4) and a basic information model framework. This framework provides an easy manner for creating and exposing vendor defined information in a standard way. More importantly all OPC UA Clients are expected to be able to discover and use vendor-defined information. This means OPC UA users can benefit from the economies of scale that come with generic visualization and historian applications. This specification is an example of an OPC UA Information Model designed to meet the needs of developers and users.

OPC UA Clients can be any consumer of data from another device on the network to browser based thin clients and ERP systems. The full scope of OPC UA applications is shown in Figure 1.

Figure6_

Figure 1 – The Scope of OPC UA within an Enterprise

OPC UA provides a robust and reliable communication infrastructure having mechanisms for handling lost messages, failover, heartbeat, etc. With its binary encoded data, it offers a high-performing data exchange solution. Security is built into OPC UA as security requirements become more and more important especially since environments are connected to the office network or the internet and attackers are starting to focus on automation systems.

4.2.3          Information modelling in OPC UA

4.2.3.1            Concepts

OPC UA provides a framework that can be used to represent complex information as Objects in an AddressSpace which can be accessed with standard services. These Objects consist of Nodes connected by References. Different classes of Nodes convey different semantics. For example, a Variable Node represents a value that can be read or written. The Variable Node has an associated DataType that can define the actual value, such as a string, float, structure etc. It can also describe the Variable value as a variant. A Method Node represents a function that can be called. Every Node has a number of Attributes including a unique identifier called a NodeId and non-localized name called as BrowseName. An Object representing a ‘Reservation’ is shown in Figure 2.

Figure7_

Figure 2 – A Basic Object in an OPC UA Address Space

Object and Variable Nodes represent instances and they always reference a TypeDefinition (ObjectType or VariableType) Node which describes their semantics and structure. illustrates the relationship between an instance and its TypeDefinition.

The type Nodes are templates that define all of the children that can be present in an instance of the type. In the example in Figure 3 the PersonType ObjectType defines two children: First Name and Last Name. All instances of PersonType are expected to have the same children with the same BrowseNames. Within a type the BrowseNames uniquely identify the children. This means Client applications can be designed to search for children based on the BrowseNames from the type instead of NodeIds. This eliminates the need for manual reconfiguration of systems if a Client uses types that multiple Servers implement.

OPC UA also supports the concept of sub-typing. This allows a modeler to take an existing type and extend it. There are rules regarding sub-typing defined in OPC 10000-3, but in general they allow the extension of a given type or the restriction of a DataType. For example, the modeler may decide that the existing ObjectType in some cases needs an additional Variable. The modeler can create a subtype of the ObjectType and add the Variable. A Client that is expecting the parent type can treat the new type as if it was of the parent type. Regarding DataTypes, subtypes can only restrict. If a Variable is defined to have a numeric value, a sub type could restrict it to a float.

Figure8_

Figure 3 – The Relationship between Type Definitions and Instances

References allow Nodes to be connected in ways that describe their relationships. All References have a ReferenceType that specifies the semantics of the relationship. References can be hierarchical or non-hierarchical. Hierarchical references are used to create the structure of Objects and Variables. Non-hierarchical are used to create arbitrary associations. Applications can define their own ReferenceType by creating subtypes of an existing ReferenceType. Subtypes inherit the semantics of the parent but may add additional restrictions.


 

Figure 4 depicts several References, connecting different Objects.

Figure9_

 

Figure 4 – Examples of References between Objects

The figures above use a notation that was developed for the OPC UA specification. The notation is summarized in Figure 5 – The OPC UA Information Model Notation. UML representations can also be used; however, the OPC UA notation is less ambiguous because there is a direct mapping from the elements in the figures to Nodes in the AddressSpace of an OPC UA Server.

Figure10_

Figure 5 – The OPC UA Information Model Notation

A complete description of the different types of Nodes and References can be found in OPC 10000-3 and the base structure is described in OPC 10000-5.

OPC UA specification defines a very wide range of functionality in its basic information model. It is not required that all Clients or Servers support all functionality in the OPC UA specifications. OPC UA includes the concept of Profiles, which segment the functionality into testable certifiable units. This allows the definition of functional subsets (that are expected to be implemented) within a companion specification. The Profiles do not restrict functionality, but generate requirements for a minimum set of functionality (see OPC 10000-7)

4.2.3.2            Namespaces

OPC UA allows information from many different sources to be combined into a single coherent AddressSpace. Namespaces are used to make this possible by eliminating naming and id conflicts between information from different sources. Each namespace in OPC UA has a globally unique string called a NamespaceUri which identifies a naming authority and a locally unique integer called a NamespaceIndex, which is an index into the Server's table of NamespaceUris. The NamespaceIndex is unique only within the context of a Session between an OPC UA Client and an OPC UA Server- the NamespaceIndex can change between Sessions and still identify the same item even though the NamespaceUri's location in the table has changed. The Services defined for OPC UA use the NamespaceIndex to specify the Namespace for qualified values.

There are two types of structured values in OPC UA that are qualified with NamespaceIndexes: NodeIds and QualifiedNames. NodeIds are locally unique (and sometimes globally unique) identifiers for Nodes. The same globally unique NodeId can be used as the identifier in a node in many Servers – the node's instance data may vary but its semantic meaning is the same regardless of the Server it appears in. This means Clients can have built-in knowledge of what the data means in these Nodes. OPC UA Information Models generally define globally unique NodeIds for the TypeDefinitions defined by the Information Model.

QualifiedNames are non-localized names qualified with a Namespace. They are used for the BrowseNames of Nodes and allow the same names to be used by different information models without conflict. TypeDefinitions are not allowed to have children with duplicate BrowseNames; however, instances do not have that restriction.

4.2.3.3            Companion Specifications

An OPC UA companion specification for an industry specific vertical market describes an Information Model by defining ObjectTypes, VariableTypes, DataTypes and ReferenceTypes that represent the concepts used in the vertical market, and potentially also well-defined Objects as entry points into the AddressSpace.

5       Use cases

5.1         Device Identification

The use case Device Identification forms the basis for the operation of a Pump and the operators plant asset management, e.g. Documentation Management, Energy Management and Maintenance Management. For this purpose, the Pump shall provide properties for asset identification.

In addition to nameplate information of the Pump, the operator / integrator requires properties to describe its functional role and installation place.

5.2         Configuration

This use case describes the pre-configuration and commissioning of Pump based on standardized manufacturer and operator information. For this purpose, general characteristics about the pump type shall be provided by the manufacturer. Properties that describe operational requirements for Pumps during operation shall be specified by the operator. Additionally, manufacturer and operator information of a Pump shall be compared.

5.3         Maintenance Management

For the integration of Pump in an operator's maintenance management application, the Pump should provide properties for general maintenance and the three strategies breakdown maintenance, preventive maintenance, and condition based maintenance.

To support asset monitoring, the Pump collects and analyzes operational and historical data (e.g. current values, deviations, performance, wear). Since plant operators require a generalized health status of plant assets, the Pump shall provide a generalized health status, based on the NAMUR NE107 categories.

Additionally, the Pump shall provide maintenance documentation, e.g. for ordering maintenance and wear parts.

5.4         Operation

This use case specifies all properties that characterize the operation of a Pump (e.g. current measurement and control values). It is based on measurements, events, and further information from the Pump operation. These can be collected and analyzed by the manufacturer or operator. Based on this analysis, Pumps can be reconfigured or updated during operation. In addition, new services can be loaded into the Pump to optimize pump operation.

6       OPC UA for Pumps and Vacuum Pumps information model overview

6.1         Modelling Concepts

The content of this OPC UA Companion Specification is based on the asset administration shell for pumps and vacuum pumps. The asset administration shell and its submodels were modeled to describe the whole life cycle of a Pump.

The organization Plattform Industrie 4.0 published the specification Details [2] of the Asset Administration Shell to define the concept and metamodel for asset administration shells. The specification describes every aspect of asset administration shells in detail and should be used for reference purposes.

Figure 6 shows an abstract example on the composition of an I4.0 component and the content of an asset administration shell.

Figure11_

Figure 6 – Structure of an Asset Administration Shell

An asset administration shell is defined by the Plattform Industrie 4.0 organization as a “standardized digital representation of the asset, corner stone of the interoperability between the applications managing the manufacturing systems. It identifies the Administration Shell and the assets represented by it, holds digital models of various aspects (submodels) and describes technical functionality exposed by the Administration Shell or respective assets. ” [2]

The content of an asset administration shells consists of submodels and properties. “Each submodel refers to a well-defined domain or subject matter. Submodels can become standardized and thus become submodels templates.” [2]

This OPC UA Companion Specification transfers the contents of the asset administration shell for pumps and vacuum pumps into an OPC UA model by defining generic and specific ObjectTypes, VariableTypes and DataTypes. In general, submodels are modeled as subtypes of the 2:FunctionalGroupType of OPC 10000-100. The pump, i.e. the asset administration shell, is modeled as a subtype of the 2:TopologyElementType of OPC 10000-100.

For more information about the asset administration shell metamodel, it is recommended to consult the Details of the Asset Administration Shell specification [2].

 


 

6.2         Model Overview

In this OPC UA Companion Specification there are several subtypes of the 2:FunctionalGroupType and the 2:TopologyElementType defined. Figure 7 shows the general relationships between the PumpType and the FunctionalGroups.

Figure12_

Figure 7 – Pumps & Vacuum Pumps Information Model (General - Structure)


 

6.2.1          Ports

A Pump has several Ports. While most Pumps have inlet and outlet Ports, the number of other Ports may vary. For this reason, the concept of Ports is introduced. Ports can be used to connect other components or systems to the Pump. In this specification, the input and output Ports, as well as the drive Port for the connection of the pump drive are defined. A port is not part of a submodel and therefore a port is modeled as a separate BaseObject and not, like submodels, as a FunctionalGroup. Figure 8 shows how the Port concept was integrated into this OPC UA Companion Specification.

Figure13_

Figure 8 – Pumps & Vacuum Pumps Information Model (Ports - Structure)

 

6.2.2          Variables

In most cases Variables have the TypeDefinition 0:DataItemType or one of its subtypes. The optional Property Definition can be added to a Variable that uses such a TypeDefinition. This allows manufacturers to store a specific definitions for each Variable.

Variables defined in this specification that have the TypeDefinition 0:BaseAnalogType or one of its subtypes, usually have a predefined unit for the 0:EngineeringUnits Property. If no value is specified, the 0:EngineeringUnits Property should not be instantiated, or the Value Attribute shall be Null. To comply with this Companion Specification, the default values specified should be used for the 0:EngineeringUnits Property. The 0:EngineeringUnits should be sensible to the use of the application.

Variables that use the DataType Boolean are modelled with the TypeDefinition 0:TwoStateDiscreteType. Such Variables have the TrueState and FalseState Properties which shall be used for defining the actual states.

Variables that are children of the SupvervisionType or one of its subtypes represent supervision states. Such a supervision state is active if the Boolean value is True (see example 1).

Variables that are not children of SupvervisionType or one of its subtypes provide defined True and False states in their description (see Example 2).

EXAMPLE 1    
If the Value Attribute of the Variable RotorBlocked (see section 7.12) is True, this means that the rotor of a pump is blocked. If the Value Attribute of this Variable is False, it means that the rotor is not blocked.

EXAMPLE 2    
The Variable ClockwiseRotation (see section 7.20) provides in the Description Attribute the Value Attributes for the mandatory Properties TrueState and FalseState.     
Description Attribute: Direction of rotation in which the shaft is seen to be turning in a clockwise direction when viewing the drive end of the shaft. A "True" status means that the rotation of pump is clockwise and a "False" status means that the rotation of pump is anticlockwise.

6.2.3          FunctionalGroups

Where it made sense, the BrowseName of a FunctionalGroup was taken from the recommendation in OPC 10000-100.

A FunctionalGroup that would have no Variables, Objects, or Methods if instantiated shall not be instantiated.

6.3         Extending FunctionalGroups

The manufacturer or system integrator of a Pump may wish to add Variables, Objects, or Methods which are not yet defined by this specification. In such a case the additional Variables, Objects, or Methods shall be added to an appropriate FunctionalGroup of the component. It is important, that the Variables, Objects, or Methods which are added match the description of the FunctionalGroup they are added to. If there is no FunctionalGroup available the Variables, Objects, and Methods fit in, the manufacturer or system integrator shall create a new Object of the 2:FunctionalGroupType.

It is also possible to define a subtype of the 2:FunctionalGroupType or one of its subtypes to define a new collection of Variables, Objects, or Methods. When subtyping, the manufacturer or system integrator should keep in mind, that all Variables, Objects, and Methods of the supertype are also available to the new subtype.

In general, no new Variables, Objects, or Methods shall be created that are already available in this specification. If the manufacturer or system integrator wants to add already existing Variables, Objects, or Methods to another FunctionalGroup, the Organizes ReferenceType shall be used.

When creating new Variables that are not specified by this specification and are representing measurements the 0:BaseAnalogType should be used as TypeDefinition. If such a Variable can be matched to a physical quantity, this Variable should have the additional subcomponent KindOfQuantity that stores the physical quantity information (see chapter 7.32). If the new Variable has a predefined unit, for example hours or meters, the optional Property 0:EngineeringUnits should be used. The Property 0:Definition shall also be used to further clarify the intended purpose of the Variable.

 


 

7       OPC UA ObjectTypes

7.1         PumpType ObjectType Definition

The PumpType is the representation of a Pump and organizes its properties in FunctionalGroups. It is illustrated in Figure 9 and formally defined in Table 9.

Figure14_

Figure 9 – Illustration of PumpType

Table 9 – PumpType Definition

Attribute

Value

BrowseName

PumpType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:TopologyElementType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Object

2:Configuration

 

ConfigurationGroupType

O

0:HasComponent

Object

Documentation

 

DocumentationType

O

0:HasComponent

Object

Events

 

SupervisionType

O

0:HasComponent

Object

2:Identification

 

PumpIdentificationType

M

0:HasComponent

Object

2:Maintenance

 

MaintenanceGroupType

O

0:HasComponent

Object

2:Operational

 

OperationalGroupType

O

0:HasComponent

Object

Ports

 

PortsGroupType

O

 

The PumpType ObjectType is a concrete type and shall be used directly.

To comply with the Finding all Machines in a Server use case of OPC UA for Machinery, all Pumps shall be added to the 3:Machines Object defined in (OPC 40001-1).

The optional FunctionalGroup 2:Configuration provides collections of Nodes for manufacturer data about the Pump and user data about the Pump’s process environment, such as maximum operating temperature and minimum flow rate.

The optional FunctionalGroup Documentation provides Nodes that are used to store Pump documentation, such as an operating manual and an overview drawing.

The optional FunctionalGroup Events provides collections of Nodes that are used for Pump monitoring, such as failure states, alarms, and conditions.

The mandatory FunctionalGroup 2:Identification provides Nodes for Pump identification, such as the manufacturer, serial number, and article number.

The optional FunctionalGroup 2:Maintenance provides collections of Nodes used for Pump maintenance, such as mean time between failures and installation date.

The optional FunctionalGroup 2:Operational provides collections of Nodes for process data that is used during normal Pump operation, such as measurements, signals, and actuation.

The optional FunctionalGroup Ports provides Nodes for the representation of Pump Ports, such as the inlet, outlet, and drive port.

The InstanceDeclarations of the PumpType have additional Attributes defined in Table 10.

Table 10 – PumpType Attribute values for child Nodes

BrowsePath

Description Attribute

2:Configuration

Static design, system requirements, and implementation data of the pump.

Documentation

Static documentation files of a pump.

Events

States, alarms, and conditions of a pump.

2:Identification

Identification information of a pump.

2:Maintenance

Maintenance data of a pump.

2:Operational

Process data for control, actuation, signals, and measurements of the pump.

Ports

Connection points of the pump.

 

7.2         IPumpVendorNameplateType ObjectType Definition

The IPumpVendorNameplateType provides the capabilities to globally uniquely identify a Pump. It is a subtype of the 3:IMachineVendorNameplateType and extends it by Pump specific Objects and Variables.

The IPumpVendorNameplateType is formally defined in Table 11.

Table 11 – IPumpVendorNameplateType Definition

Attribute

Value

BrowseName

IPumpVendorNameplateType

IsAbstract

True

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 3:IMachineVendorNameplateType defined in OPC 40001-1, i.e. inheriting the InstanceDeclarations of that Node.

0:HasProperty

Variable

ArticleNumber

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

CountryOfOrigin

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

DayOfConstruction

0:Int32

0:PropertyType

O, RO

0:HasProperty

Variable

FabricationNumber

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

GTINCode

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

NationalStockNumber

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

OrderProductCode

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

PhysicalAddress 

PhysicalAddressDataType

0:PropertyType

O, RO

0:HasProperty

Variable

Supplier

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

TypeOfProduct

0:String

0:PropertyType

O, RO

 

The InstanceDeclarations of the IPumpVendorNameplateType have additional Attributes defined in Table 12. The Variables and the associated Descriptions are based on the IEC Common Data Dictionary (CDD). The basis for this are the IEC 61360-4, 61987 and 62683 standards.

Table 12 – IPumpVendorNameplateType Attribute values for child Nodes

BrowsePath

Description Attribute

ArticleNumber

Alphanumeric character sequence identifying a manufactured, non-configurable product.

CountryOfOrigin

Country in which the product is manufactured.

DayOfConstruction

The optional DayOfConstrucition provides the day of the month in which the manufacturing process of the machine has been completed. It shall be a number and never change during the life-cycle of a machine.

FabricationNumber

Alphanumeric character sequence assigned to a fabricated product, which allows the date, time and circumstances of fabrication to be traced.

GTINCode

Bar code number that identifies the device based on the Global Trade Item Number system.

NationalStockNumber

13-digit numeric code, identifying all 'standardized material items of supply' as recognized by the United States Department of Defense.

OrderProductCode

Unique combination of numbers and letters used to order the device.

PhysicalAddress

Physical address of the manufacturer.

Supplier

Name of the supplier or vendor of a device.

TypeOfProduct

Characterization of the device based on its usage, operation principle, and its fabricated form.

 

7.3         MarkingsType ObjectType Definition

The MarkingsType provides a placeholder Object for safety instructions for the safe use of an asset, such as CE marking, temperature and pressure resistance, electrostatic charge, high voltage, radioactivity or explosive protection.

Table 13 – MarkingsType Definition

Attribute

Value

BrowseName

MarkingsType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 0:FolderType defined in OPC 10000-5, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Object

<Marking>

 

0:FileType

OP

 

The InstanceDeclarations of the MarkingsType have additional Attributes defined in Table 14.

Table 14 – MarkingsType Attribute values for child Nodes

BrowsePath

Description Attribute

<Marking>

Placeholder for saving markings.


 

7.4         PumpIdentificationType ObjectType Definition

The PumpIdentificationType provides Nodes for a globally unique identification, vendor defined information, and user-specific information of a Pump. It is illustrated in Figure 10 and formally defined in Table 15.

Figure15_

Figure 10 – Illustration of PumpIdentificationType

Table 15 – PumpIdentificationType Definition

Attribute

Value

BrowseName

PumpIdentificationType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 3:MachineIdentificationType defined in OPC 40001-1, i.e. inheriting the InstanceDeclarations of that Node.

0:HasInterface

ObjectType

IPumpVendorNameplateType

 

 

 

0:HasComponent

Object

Markings

 

MarkingsType

O

 

 

 

 

 

 

Applied from IPumpVendorNameplateType

0:HasProperty

Variable

ArticleNumber

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

CountryOfOrigin

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

DayOfConstruction

0:Int32

0:PropertyType

O, RO

0:HasProperty

Variable

FabricationNumber

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

GTINCode

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

NationalStockNumber

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

OrderProductCode

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

PhysicalAddress 

PhysicalAddressDataType

0:PropertyType

O, RO

0:HasProperty

Variable

Supplier

0:String

0:PropertyType

O, RO

0:HasProperty

Variable

TypeOfProduct

0:String

0:PropertyType

O, RO

 

 

 

 

 

 

The following nodes override nodes added by the 3:MachineIdentificationType

0:HasProperty

Variable

2:DeviceClass

0:String

0:PropertyType

M, RO

 

The optional Property 2:DeviceClass of the 3:MachineIdentificationType is overridden. The ModellingRule is changed to Mandatory and the Value Attribute is set to “Pump”.

The InstanceDeclarations of the PumpIdentificationType have additional Attributes defined in Table 16.

Table 16 – PumpIdentificationType Attribute values for child Nodes

BrowsePath

Value

Description Attribute

Markings

 

Safety instructions for safe use, e.g. temperature and pressure resistance, electrostatic charge, high voltage, radioactivity, explosive protection.

2:DeviceClass

“Pump”

Domain or for what purpose this item is used.

 

7.5         DocumentationType ObjectType Definition

The DocumentationType provides various FileType Objects for documents and Variables for links to documents that are used for maintenance operations. It is formally defined in Table 17.

Table 17 – DocumentationType Definition

Attribute

Value

BrowseName

DocumentationType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Object

Arrangements

-

0:FileType

O

0:HasComponent

Variable

ArrangementsLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

Certificates

-

0:FileType

O

0:HasComponent

Variable

CertificatesLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

CircuitDiagram

-

0:FileType

O

0:HasComponent

Variable

CircuitDiagramLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

ComponentsList

-

0:FileType

O

0:HasComponent

Variable

ComponentsListLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

Detail

-

0:FileType

O

0:HasComponent

Variable

DetailLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

DuringMaintenanceServicesRendered

-

0:FileType

O

0:HasComponent

Variable

DuringMaintenanceServicesRenderedLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

ImplementationDescription

-

0:FileType

O

0:HasComponent

Variable

ImplementationDescriptionLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

Layout

-

0:FileType

O

0:HasComponent

Variable

LayoutLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

Location

-

0:FileType

O

0:HasComponent

Variable

LocationLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

LogicDiagram

-

0:FileType

O

0:HasComponent

Variable

LogicDiagramLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

LubricationMap

-

0:FileType

O

0:HasComponent

Variable

LubricationMapLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

MaintenanceManual

-

0:FileType

O

0:HasComponent

Variable

MaintenanceManualLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

OperationManual

-

0:FileType

O

0:HasComponent

Variable

OperationManualLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

PersonnelRecording

-

0:FileType

O

0:HasComponent

Variable

PersonnelRecordingLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

PipeAndInstrumentDiagram

-

0:FileType

O

0:HasComponent

Variable

PipeAndInstrumentDiagramLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

ScopeOfWork

-

0:FileType

O

0:HasComponent

Variable

ScopeOfWorkLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

SingleLineDiagram

-

0:FileType

O

0:HasComponent

Variable

SingleLineDiagramLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

SparePartReference

-

0:FileType

O

0:HasComponent

Variable

SparePartReferenceLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

Staff

-

0:FileType

O

0:HasComponent

Variable

StaffLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

TechnicalData

-

0:FileType

O

0:HasComponent

Variable

TechnicalDataLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

TestProgramReport

-

0:FileType

O

0:HasComponent

Variable

TestProgramReportLink

0:String

0:DataItemType

O, RO

0:HasComponent

Object

UnitMaintenanceReport

-

0:FileType

O

0:HasComponent

Variable

UnitMaintenanceReportLink

0:String

0:DataItemType

O, RO

 

The InstanceDeclarations of the DocumentationType have additional Attributes defined in Table 18. The Variables and the associated Descriptions are based on the standard DIN EN 13460.

Table 18 – DocumentationType Attribute values for child Nodes

BrowsePath

Description Attribute

Arrangements

Drawing showing replacement components layout for an item.

ArrangementsLink

Drawing showing replacement components layout for an item.

Certificates

Specific safety and statutory regulations certificates for items (lifting equipment, steam boilers, pressure vessels,...).

CertificatesLink

Specific safety and statutory regulations certificates for items (lifting equipment, steam boilers, pressure vessels,...).

CircuitDiagram

Overall feeder and control circuits diagram.

CircuitDiagramLink

Overall feeder and control circuits diagram.

ComponentsList

Comprehensive list of items which constitute part of another one.

ComponentsListLink

Comprehensive list of items which constitute part of another one.

Detail

Drawing with part list to ensure dismantling, repair and assembly of items.

DetailLink

Drawing with part list to ensure dismantling, repair and assembly of items.

DuringMaintenanceServicesRendered

Final and/or interim report on services provided

DuringMaintenanceServicesRenderedLink

Final and/or interim report on services provided

ImplementationDescription

Explanation of the work carried out

ImplementationDescriptionLink

Explanation of the work carried out

Layout

Drawing showing all areas of a particular plant.

LayoutLink

Drawing showing all areas of a particular plant.

Location

Drawing showing the position of all field items within the considered area.

LocationLink

Drawing showing the position of all field items within the considered area.

LogicDiagram

System control diagram to clarify the overall system logic.

LogicDiagramLink

System control diagram to clarify the overall system logic.

LubricationMap

Drawing showing position of each item lubrication point, with lubrication data and specifications.

LubricationMapLink

Drawing showing position of each item lubrication point, with lubrication data and specifications.

MaintenanceManual

Technical instructions intended to preserve an item in, or restore it to, a state in which it can perform a required function.

MaintenanceManualLink

Technical instructions intended to preserve an item in, or restore it to, a state in which it can perform a required function.

OperationManual

Technical instructions to reach a proper item function performance according to its technical specifications and safety conditions.

OperationManualLink

Technical instructions to reach a proper item function performance according to its technical specifications and safety conditions.

PersonnelRecording

List of all activities (work order) performed by a technician. This list includes a predefined time period

PersonnelRecordingLink

List of all activities (work order) performed by a technician. This list includes a predefined time period

PipeAndInstrumentDiagram

Overall fluid conduction (air, steam, oil, fuel ...), and control diagram.

PipeAndInstrumentDiagramLink

Overall fluid conduction (air, steam, oil, fuel ...), and control diagram.

ScopeOfWork

The hours worked in the execution of the work order. The type of hours worked should be indicated: normal, in shifts, at night, overtime, etc.

ScopeOfWorkLink

The hours worked in the execution of the work order. The type of hours worked should be indicated: normal, in shifts, at night, overtime, etc.

SingleLineDiagram

Overall power distribution diagram (electrical, pneumatic, hydraulic). This kind of diagram includes switchboard circuits.

SingleLineDiagramLink

Overall power distribution diagram (electrical, pneumatic, hydraulic). This kind of diagram includes switchboard circuits.

SparePartReference

List of all spare parts used within the scope of the work order

SparePartReferenceLink

List of all spare parts used within the scope of the work order

Staff

List of all maintenance workers involved in the execution of the work order

StaffLink

List of all maintenance workers involved in the execution of the work order

TechnicalData

Manufacturer`s specification of the item.

TechnicalDataLink

Manufacturer`s specification of the item.

TestProgramReport

Commissioning report which demonstrates that an item is in compliance with specifications.

TestProgramReportLink

Commissioning report which demonstrates that an item is in compliance with specifications.

UnitMaintenanceReport

List of work orders for a particular unit. The list is created for a specified period of time

UnitMaintenanceReportLink

List of work orders for a particular unit. The list is created for a specified period of time

 

7.6         MaintenanceGroupType ObjectType Definition

The MaintenanceGroupType provides FunctionalGroups for general maintenance and specific maintenance strategies, such as condition based maintenance, preventive maintenance, and breakdown maintenance. It is illustrated in Figure 11 and formally defined in Table 19.

Figure16_

Figure 11 – Illustration of MaintenanceGroupType

Table 19 – MaintenanceGroupType Definition

Attribute

Value

BrowseName

MaintenanceGroupType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Object

BreakdownMaintenance

 

BreakdownMaintenanceType

O

0:HasComponent

Object

ConditionBasedMaintenance

 

ConditionBasedMaintenanceType

O

0:HasComponent

Object

GeneralMaintenance

 

GeneralMaintenanceType

O

0:HasComponent

Object

PreventiveMaintenance

 

PreventiveMaintenanceType

O

 

The InstanceDeclarations of the MaintenanceGroupType have additional Attributes defined in Table 20.

Table 20 – MaintenanceGroupType Attribute values for child Nodes

BrowsePath

Description Attribute

BreakdownMaintenance

Properties for breakdown maintenance.

ConditionBasedMaintenance

Properties for condition based maintenance.

GeneralMaintenance

General maintenance properties.

PreventiveMaintenance

Properties for preventive maintenance.

 

7.7         GeneralMaintenanceType ObjectType Definition

The GeneralMaintenanceType provides Variables that are used for general maintenance applications and is formally defined in Table 21.

Table 21 – GeneralMaintenanceType Definition

Attribute

Value

BrowseName

GeneralMaintenanceType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

ActiveMaintenanceTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

DownTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

ExternalDisabledTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

FailureRate

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

IdleTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

MaintenanceLevel

MaintenanceLevelEnum

0:DataItemType

O, RO

0:HasComponent

Variable

MaintenanceTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

MeanOperatingTimeBetweenFailures

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

MeanRepairTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

MeanTimeToRestauration

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

Obsolescence

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

OperatingTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

OperatingTimeBetweenFailures

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

OperatingTimeToFailure

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

RepairTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

StandbyTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

StateOfTheItem

StateOfTheItemEnum

0:DataItemType

O, RO

0:HasComponent

Variable

TimeBetweenFailures

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

TimeToRestoration

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

UpTime

0:Double

0:BaseAnalogType

O, RO

 

The InstanceDeclarations of the GeneralMaintenanceType have additional Attributes defined in Table 22. The Variables and the associated Descriptions are based on the standards ISO 13372 and DIN EN 13306.

Table 22 – GeneralMaintenanceType Attribute values for child Nodes

BrowsePath

Value Attribute

Description Attribute

ActiveMaintenanceTime

 

Part of the maintenance time when active maintenance is carried out on an item.

ActiveMaintenanceTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

DownTime

 

Measured time interval throughout which an item is in a down state

DownTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

ExternalDisabledTime

 

Measured time interval throughout which an item is in an external disabled state

ExternalDisabledTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

FailureRate

 

Number of failures within a population divided by the number of life units used by that population

FailureRate

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

IdleTime

 

Measured time interval throughout which an item is in an idle state

IdleTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

MaintenanceLevel

 

Maintenance task categorization by complexity

MaintenanceTime

 

Time interval when maintenance is carried out on an item including technical, logistic and internal administrative delays

MaintenanceTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

MeanOperatingTimeBetweenFailures

 

Average of the operating times between failures

MeanOperatingTimeBetweenFailures

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

MeanRepairTime

 

Average of the repair times

MeanRepairTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

MeanTimeToRestauration

 

Average of the time to restauration

MeanTimeToRestauration

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

Obsolescence

 

Inability of an item to be maintained due to the unavailability on the market of the necessary resources at acceptable technical and/or economic conditions. A "True" status means that the pump is obsolete and a "False" status means that the pump is not obsolete.

OperatingTimeBetweenFailures

 

Operating time between consecutive failures

OperatingTimeBetweenFailures

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

OperatingTime

 

Measured time interval throughout which an item is in operating state

OperatingTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

OperatingTimeToFailure

 

Operating time accumulated from the first use, or from restoration, until failure

OperatingTimeToFailure

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

RepairTime

 

Part of corrective maintenance time when repair is carried out on an item.

RepairTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

StandbyTime

 

Measured time interval throughout which an item is in a standby state

StandbyTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

StateOfTheItem

 

Current state of the item

TimeBetweenFailures

 

Duration between consecutive failures

TimeBetweenFailures

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

TimeToRestoration

 

Time interval, from the instant of failure, until restoration

TimeToRestoration

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

UpTime

 

Measured time interval throughout which an item is in an up state

UpTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 


 

7.8         ConditionBasedMaintenanceType ObjectType Definition

The ConditionBasedMaintenanceType provides Variables that are used for condition based maintenance and is formally defined in Table 23.

Table 23 – ConditionBasedMaintenanceType Definition

Attribute

Value

BrowseName

ConditionBasedMaintenanceType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

Availability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

Durability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

ExpectedReliability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

InstantaneousAvailability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

IntrinsicMaintainability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

IntrinsicReliability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

Maintainability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

OperationalReliability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

ProductionBasedAvailability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

Reliability

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

TimeBasedAvailability

0:Double

0:BaseAnalogType

O, RO

 

The InstanceDeclarations of the ConditionBasedMaintenanceType have additional Attributes defined in Table 24. The Variables and the associated Descriptions are based on the standards ISO 13372 and DIN EN 13306.

Table 24 – ConditionBasedMaintenanceType Attribute values for child Nodes

BrowsePath

Value Attribute

Description Attribute

Availability

 

Probability that a machine will, when used under specified conditions, operate satisfactorily and effectively

Availability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

Durability

 

Actual reliability of an item considering operating modes, operating conditions and possible preventive maintenance actions carried out

Durability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

ExpectedReliability

 

Reliability of an item determined by design and manufacture under expected conditions of operation and maintenance

ExpectedReliability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

InstantaneousAvailability

 

Probability that an item is in a state to perform as required at a given instant, under given conditions, assuming that the necessary external resources are provided

InstantaneousAvailability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

IntrinsicMaintainability

 

Maintainability of an item determined by the design under expected conditions of maintenance and logistic support

IntrinsicMaintainability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

IntrinsicReliability

 

Reliability of an item determined by design and manufacture under expected conditions of operation assuming that no preventive maintenance task is carried out, excepting routine maintenance

IntrinsicReliability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

Maintainability

 

Ability of a machine or part of a system to be retained in, or restored to, a state in which it can perform the required function(s)

Maintainability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

OperationalReliability

 

Actual reliability of an item considering operating modes, operating conditions and possible preventive maintenance actions carried out

OperationalReliability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

ProductionBasedAvailability

 

Ratio of actual production to required production, or any other reference level, over a specified period of time

ProductionBasedAvailability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

Reliability

 

Probability that a machine will perform its required functions without failure for a specified time period when used under specified conditions

Reliability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

TimeBasedAvailability

 

During a given period of time, percentage of the time during which an item was able to perform when required

TimeBasedAvailability

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 20529

DisplayName: %

Description: percent

 

 

7.9         PreventiveMaintenanceType ObjectType Definition

The PreventiveMaintenanceType provides Variables that are used for preventive maintenance and is formally defined in Table 25.

Table 25 – PreventiveMaintenanceType Definition

Attribute

Value

BrowseName

PreventiveMaintenanceType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

ActivePreventiveMaintenanceTime

0:Double

0:BaseAnalogType

O, RW

0:HasComponent

Variable

InstallationDate

0:DateTime

0:DataItemType

O, RW

0:HasComponent

Variable

LastInspectionDate

0:DateTime

0:DataItemType

O, RW

0:HasComponent

Variable

LastServicingDate

0:DateTime

0:DataItemType

O, RW

0:HasComponent

Variable

NextInspectionDate

0:DateTime

0:DataItemType

O, RW

0:HasComponent

Variable

NextServicingDate

0:DateTime

0:DataItemType

O, RW

0:HasComponent

Variable

PreventiveMaintenanceTime

0:Double

0:BaseAnalogType

O, RW

 

The InstanceDeclarations of the PreventiveMaintenanceType have additional Attributes defined in Table 26. The Variables and the associated Descriptions are based on the standards DIN EN 13306 and VDMA 24223-1.

Table 26 – PreventiveMaintenanceType Attribute values for child Nodes

BrowsePath

Value Attribute

Description Attribute

ActivePreventiveMaintenanceTime

 

This attribute indicates the date of installation or commissioning of the device.

ActivePreventiveMaintenanceTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

InstallationDate

 

This attribute identifies the date when the device was last inspected.

LastInspectionDate

 

This attribute identifies the date when the device is scheduled for the next inspection.

LastServicingDate

 

This attribute identifies the date when the device is scheduled for the next servicing.

NextInspectionDate

 

This attribute identifies the date when the device was last serviced.

NextServicingDate

 

Part of maintenance time when preventive maintenance is carried out on an item, including technical, logistic and internal administrative delays

PreventiveMaintenanceTime

 

Part of the active maintenance time taken to perform a preventive maintenance

PreventiveMaintenanceTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

 

7.10      BreakdownMaintenanceType ObjectType Definition

The BreakdownMaintenanceType provides Variables that are used for breakdown maintenance and is formally defined in Table 27.

Table 27 – BreakdownMaintenanceType Definition

Attribute

Value

BrowseName

BreakdownMaintenanceType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

CorrectiveMaintenanceTime

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

Criticality

0:Double

0:BaseAnalogType

O, RO

0:HasComponent

Variable

Failure

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

NumberOfFailures

0:Int32

0:BaseAnalogType

O, RO

0:HasComponent

Variable

Severity

0:String

0:DataItemType

O, RO

 

The InstanceDeclarations of the PreventiveMaintenanceType have additional Attributes defined in Table 28. The Variables and the associated Descriptions are based on the standards ISO 13372 and DIN EN 13306.

Table 28 – BreakdownMaintenanceType Attribute values for child Nodes

BrowsePath

Value Attribute

Description Attribute

CorrectiveMaintenanceTime

 

Part of the maintenance time when active corrective maintenance is carried out on an item, including technical, logistic and internal administrative delays

CorrectiveMaintenanceTime

0:EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4740434

DisplayName: h

Description: hour

 

Criticality

 

Index of the severity of an effect combined with the probability of expected frequency of its occurrence

Failure

 

Termination of the ability of an item to perform a required function. A "True" status means that the pump has a failure and a "False" status means that the pump has no failure.

NumberOfFailures

 

Number of failures of an object

Severity

 

Extent of loss, damage or harm caused by a fault or failure

 

7.11      SupervisionType ObjectType Definition

The SupervisionType provides collections of Variables used for Pump monitoring. It is illustrated in Figure 12 and formally defined in Table 29.

Figure17_

Figure 12 – Illustration of SupervisionType

Table 29 – SupervisionType Definition

Attribute

Value

BrowseName

SupervisionType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Object

SupervisionAuxiliaryDevice

 

SupervisionAuxiliaryDeviceType

O

0:HasComponent

Object

SupervisionElectronics

 

SupervisionElectronicsType

O

0:HasComponent

Object

SupervisionHardware

 

SupervisionHardwareType

O

0:HasComponent

Object

SupervisionMechanics

 

SupervisionMechanicsType

O

0:HasComponent

Object

SupervisionProcessFluid

 

SupervisionProcessFluidType

O

0:HasComponent

Object

SupervisionPumpOperation

 

SupervisionPumpOperationType

O

0:HasComponent

Object

SupervisionSoftware

 

SupervisionSoftwareType

O

 

The InstanceDeclarations of the SupervisionType have additional Attributes defined in Table 30.

Table 30 – SupervisionType Attribute values for child Nodes

BrowsePath

Description Attribute

SupervisionAuxiliaryDevice

Supervision auxiliary device specifies information for monitoring an additional device.

SupervisionElectronics

Supervision Electrics specifies information for monitoring the electronics.

SupervisionHardware

Supervision hardware specifies supervising information related to device hardware.

SupervisionMechanics

Supervision mechanics specifies supervising information related to device mechanics.

SupervisionProcessFluid

Supervision process fluid specifies information for monitoring the fluid of a pump.

SupervisionPumpOperation

Supervision pump operation specifies information for monitoring the pump operation.

SupervisionSoftware

Supervision software specifies supervising information related to device software.

 

7.12      SupervisionMechanicsType ObjectType Definition

The SupervisionMechanicsType provides Variables used for monitoring the Pump mechanics. It is illustrated in Figure 13 and formally defined in Table 31. For the generation of events, the SupervisionMechanicsType has references to the four Namur NE 107 statuses defined in OPC 10000-100. The InputNode Property of the Alarm shall contain the NodeId of the Component.

Figure18_

Figure 13 – Illustration of SupervisionMechanicsType

Table 31 – SupervisionMechanicsType Definition

Attribute

Value

BrowseName

SupervisionMechanicsType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

AxialBearingAbrasion

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AxialBearingFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AxialBearingOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

BearingFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

BrakeChopper

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

BrakeOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ExcessVibration

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

GapWear

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MechanicalFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Misalignment

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

RadialBearingAbrasion

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

RadialBearingFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

RadialBearingOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

RotorBlocked

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

RotorStationRubbing

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Unbalance

0:Boolean

0:TwoStateDiscreteType

O, RO

0:GeneratesEvent

ObjectType

2:CheckFunctionAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:FailureAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:MaintenanceRequiredAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:OffSpecAlarmType

Defined in OPC 10000-100

 

The InstanceDeclarations of the SupervisionMechanicsType have additional Attributes defined in Table 32. The Variables and the associated Descriptions are based on the standard VDMA 24223-1.

Table 32 – SupervisionMechanicsType Attribute values for child Nodes

BrowsePath

Description Attribute

AxialBearingAbrasion

This attribute indicates an unacceptable abrasion of the axial bearing.

AxialBearingFault

This attribute indicates a failure of the axial bearing.

AxialBearingOverheat

This attribute indicates an overheating of the axial bearing.

BearingFault

This attribute indicates a generic bearing failure.

BrakeChopper

This attribute indicates a problem of the brake chopper.

BrakeOverheat

This attribute indicates an overheating of a brake.

ExcessVibration

This attribute indicates unacceptable high mechanical vibration.

GapWear

This attribute indicates a mechanical wear at gap.

MechanicalFault

This attribute indicates a generic mechanical fault.

Misalignment

This attribute indicates a misalignment.

RadialBearingAbrasion

This attribute indicates an unacceptable abrasion of the radial bearing.

RadialBearingFault

This attribute indicates a failure of the radial bearing.

RadialBearingOverheat

This attribute indicates an overheating of the radial bearing.

RotorBlocked

This attribute indicates a blocked rotor.

RotorStationRubbing

This attribute indicates the rubbing of stator and rotor.

Unbalance

This attribute indicates an unbalance.

 

7.13      SupervisionHardwareType ObjectType Definition

The SupervisionHardwareType provides Variables used for monitoring the Pump hardware. It is formally defined in Table 33. For the generation of events, the SupervisionHardwareType has references to the four Namur NE 107 statuses defined in OPC 10000-100. The InputNode Property of the Alarm shall contain the NodeId of the Component.

Table 33 – SupervisionHardwareType Definition

Attribute

Value

BrowseName

SupervisionHardwareType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

Communication

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ComputingCircuit

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ControlCircuit

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

DCLinkSupply

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Eprom

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

HardwareFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

IONA

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MeasureCircuit

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MicroProcessor

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

NetworkNA

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

PowerSupply

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Ram

0:Boolean

0:TwoStateDiscreteType

O, RO

0:GeneratesEvent

ObjectType

2:CheckFunctionAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:FailureAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:MaintenanceRequiredAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:OffSpecAlarmType

Defined in OPC 10000-100

 

The InstanceDeclarations of the SupervisionHardwareType have additional Attributes defined in Table 34. The Variables and the associated Descriptions are based on the standard VDMA 24223-1.

Table 34 – SupervisionHardwareType Attribute values for child Nodes

BrowsePath

Description Attribute

Communication

This attribute indicates a communication failure.

ComputingCircuit

This attribute indicates a failure in the computing elements of device hardware.

ControlCircuit

This attribute indicates a failure in the control elements of device hardware.

DCLinkSupply

This attribute indicates a failure in the dc power supply of device hardware.

Eprom

This attribute indicates a failure of an eprom.

HardwareFault

This attribute indicates a failure of device hardware.

IONA

This attribute indicates a disconnection between processing unit and device.

MeasureCircuit

This attribute indicates a failure in the measurement elements of device hardware.

MicroProcessor

This attribute indicates a failure of the micro processor.

NetworkNA

This attribute indicates a disconnection of the device.

PowerSupply

This attribute indicates a failure in the power supply of device hardware.

Ram

This attribute indicates a ram failure.

 

7.14      SupervisionSoftwareType ObjectType Definition

The SupervisionSoftwareType provides Variables used for monitoring the Pump software. It is formally defined in Table 35. For the generation of events, the SupervisionSoftwareType has references to the four Namur NE 107 statuses defined in OPC 10000-100. The InputNode Property of the Alarm shall contain the NodeId of the Component.

Table 35 – SupervisionSoftwareType Definition

Attribute

Value

BrowseName

SupervisionSoftwareType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

Application

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Communication

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Control

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Memory

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

OS

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Parameter

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SoftwareFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SoftwareReset

0:Boolean

0:TwoStateDiscreteType

O, RO

0:GeneratesEvent

ObjectType

2:CheckFunctionAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:FailureAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:MaintenanceRequiredAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:OffSpecAlarmType

Defined in OPC 10000-100

 

The InstanceDeclarations of the SupervisionSoftwareType have additional Attributes defined in Table 36. The Variables and the associated Descriptions are based on the standard VDMA 24223-1.

Table 36 – SupervisionSoftwareType Attribute values for child Nodes

BrowsePath

Description Attribute

Application

This attribute indicates a failure in application software.

Communication

This attribute indicates a failure in communication software.

Control

This attribute indicates a failure in control software.

Memory

This attribute indicates a memory resource problem.

OS

This attribute indicates a failure of operation system software.

Parameter

This attribute indicates a parameter problem.

SoftwareFault

This attribute indicates a failure of device software.

SoftwareReset

This attribute indicates a software reset.

 

7.15      SupervisionProcessFluidType ObjectType Definition

The SupervisionProcessFluidType provides Variables used for monitoring the Pump process fluid. It is formally defined in Table 37. For the generation of events, the SupervisionProcessFluidType has references to the four Namur NE 107 statuses defined in OPC 10000-100. The InputNode Property of the Alarm shall contain the NodeId of the Component.

Table 37 – SupervisionProcessFluidType Definition

Attribute

Value

BrowseName

SupervisionProcessFluidType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

Blockage

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Cavitation

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Condensation

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Dry

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Flow

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Gas

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Liquid

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Pressure

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ProcessFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Solid

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Stall

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Temperature

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Viscosity

0:Boolean

0:TwoStateDiscreteType

O, RO

0:GeneratesEvent

ObjectType

2:CheckFunctionAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:FailureAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:MaintenanceRequiredAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:OffSpecAlarmType

Defined in OPC 10000-100

 

The InstanceDeclarations of the SupervisionProcessFluidType have additional Attributes defined in Table 38. The Variables and the associated Descriptions are based on the standard VDMA 24223-1.

Table 38 – SupervisionProcessFluidType Attribute values for child Nodes

BrowsePath

Description Attribute

Blockage

This attribute indicates a closed valve operation.

Cavitation

This attribute indicates cavitation of the pump liquid.

Condensation

This attribute indicates abnormal condensation in flow medium.

Dry

This attribute indicates a dry running.

Flow

This attribute indicates an abnormal flow of the pump fluid.

Gas

This attribute indicates a significant amount of gas in the pump liquid.

Liquid

This attribute indicates a significant amount of liquid in the flow medium.

Pressure

This attribute indicates an abnormal pressure of the pump fluid.

ProcessFault

This attribute indicates a generic process problem.

Solid

This attribute indicates an significant amount of solid in the pump fluid.

Stall

This attribute indicates a stall of the pump liquid.

Temperature

This attribute indicates an abnormal temperature of the pump fluid.

Viscosity

This attribute indicates an abnormal viscosity of the pump liquid.

 


 

7.16      SupervisionPumpOperationType ObjectType Definition

The SupervisionPumpOperationType provides Variables used for monitoring the Pump operation. It is formally defined in Table 39. For the generation of events, the SupervisionPumpOperationType has references to the four Namur NE 107 statuses defined in OPC 10000-100. The InputNode Property of the Alarm shall contain the NodeId of the Component.

Table 39 – SupervisionPumpOperationType Definition

Attribute

Value

BrowseName

SupervisionPumpOperationType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

AccessoryLiquidFlow

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AccessoryLiquidHigh

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AccessoryLiquidLow

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AccessoryLiquidOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AccessoryLiquidPressure

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AmbientTemperature

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

CaseOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ControllerOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ConverterOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

CoolantFlow

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

CoolantHigh

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

CoolantLow

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

CoolantOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Deceleration

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

DirtyImpeller

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

DriveOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

GeneratorOperation

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Leakage

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Lubricant

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MaximumNumberStarts

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MaximumOperationTime

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MaximumStartsAtTime

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MotorHumidity

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MotorOverheat

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

OperationFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

OverLoad

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

OverSpeed

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

PartialLoad

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Synchronisation

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

TemperatureFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

TimeOut

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

TMSFailure

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

TorqueLimit

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

TurbineOperation

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

UnderSpeed

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

VelocityLimit

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

WearReserveExhausted

0:Boolean

0:TwoStateDiscreteType

O, RO

0:GeneratesEvent

ObjectType

2:CheckFunctionAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:FailureAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:MaintenanceRequiredAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:OffSpecAlarmType

Defined in OPC 10000-100

 

The InstanceDeclarations of the SupervisionPumpOperationType have additional Attributes defined in Table 40. The Variables and the associated Descriptions are based on the standard VDMA 24223-1.


 

Table 40 – SupervisionPumpOperationType Attribute values for child Nodes

BrowsePath

Description Attribute

AccessoryLiquidFlow

This attribute indicates a problem with the accessory liquid flow, e.g. the buffer fluid flow or operating fluid flow.

AccessoryLiquidHigh

This attribute indicates a high limited accessory liquid, e.g. the buffer fluid or operating fluid.

AccessoryLiquidLow

This attribute indicates a low limited accessory liquid, e.g. the buffer fluid or operating fluid.

AccessoryLiquidOverheat

This attribute indicates an overheating of the accessory liquid, e.g. the buffer fluid or operating fluid.

AccessoryLiquidPressure

This attribute indicates an abnormal pressure of the accessory liquid, e.g. the buffer fluid pressure or operating fluid pressure.

AmbientTemperature

This attribute indicates an abnormal ambient temperature.

CaseOverheat

This attribute indicates an overheating of the case.

ControllerOverheat

This attribute indicates an overheating of a controller.

ConverterOverheat

This property indicates an overheating of a converter.

CoolantFlow

This attribute indicates a problem with the coolant flow.

CoolantHigh

This attribute indicates that the coolant is high limited.

CoolantLow

This attribute indicates that the coolant is low limited.

CoolantOverheat

This attribute indicates an overheating of the coolant liquid.

Deceleration

This attribute indicates a deceleration of a pump.

DirtyImpeller

This attribute indicates a dirty impeller.

DriveOverheat

This attribute indicates an overheating of a drive.

GeneratorOperation

This attribute indicates that the pump is working as a generator (in flow).

Leakage

This attribute indicates a leakage problem, e.g. leakage of the mechanical seal.

Lubricant

This attribute indicates a problem with the lubricant.

MaximumNumberStarts

This attribute indicates that the maximum number of pump start cycles is exceeded.

MaximumOperationTime

This attribute indicates that the maximum time of pump operation is exceeded.

MaximumStartsAtTime

This attribute indicates that the maximum number of pump start cycles per timespan is exceeded.

MotorHumidity

This attribute indicates unacceptable humidity in the motor.

MotorOverheat

This attribute indicates an overheating of a motor.

OperationFault

This attribute indicates a generic operation problem of a pump.

OverLoad

This attribute indicates an over load.

OverSpeed

This attribute indicates that the pump operates over normal speed.

PartialLoad

This attribute indicates a partial load.

Synchronisation

This attribute indicates a synchronization problem of a pump.

TemperatureFault

This attribute indicates a generic temperature problem of a pump.

TimeOut

This attribute indicates a start up time out.

TMSFailure

This attribute indicates a failure of the temperature management system.

TorqueLimit

This attribute indicates a limitation problem of a pump.

TurbineOperation

This attribute indicates that the pump is working as a turbine (reverse flow).

UnderSpeed

This attribute indicates that the pump operates under normal speed.

VelocityLimit

This attribute indicates a limitation problem of a pump.

WearReserveExhausted

This attribute indicates that the wear reserve of the pump is exhausted.

 

7.17      SupervisionAuxiliaryDeviceType ObjectType Definition

The SupervisionAuxiliaryDeviceType provides Variables used for monitoring the Pump auxiliary devices. It is formally defined in Table 41. For the generation of events, the SupervisionAuxiliaryDeviceType has references to the four Namur NE 107 statuses defined in OPC 10000-100. The InputNode Property of the Alarm shall contain the NodeId of the Component.

Table 41 – SupervisionAuxiliaryDeviceType Definition

Attribute

Value

BrowseName

SupervisionAuxiliaryDeviceType

IsAbstract

false

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

ActuatorElement

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AmbientTemperature

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AuxiliaryDeviceFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AuxiliaryMediumAbsence

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AuxiliaryMediumInsufficiency

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AuxiliaryPowerPole

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

AuxiliaryPowerRange

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

CommunicationError

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Corrosion

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Deviation

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ElectromagneticInterference

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ElectronicFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

EnergySupply

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

EvaluationElectronics

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ExciterError

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Fouling

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

HumidityElectronics

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Installation

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Interruption

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

LineLength

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MaterialElectronics

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MeasuredMaterialElectronics

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

MechanicalDamage

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

OperatingConditions

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Other

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Overloading

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ParameterSetting

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Peripheral

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ProcessInfluence

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SensorElement

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

StartUp

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

TemperatureShock

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

Vibration

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

WearReserveOperation

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

WearReserveWear

0:Boolean

0:TwoStateDiscreteType

O, RO

0:GeneratesEvent

ObjectType

2:CheckFunctionAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:FailureAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:MaintenanceRequiredAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:OffSpecAlarmType

Defined in OPC 10000-100

 

The InstanceDeclarations of the SupervisionAuxiliaryDeviceType have additional Attributes defined in Table 42. The Variables and the associated Descriptions are based on the standard VDMA 24223-1.

Table 42 – SupervisionAuxiliaryDeviceType Attribute values for child Nodes

BrowsePath

Description Attribute

ActuatorElement

This property indicates a fault in an actuator element.

AmbientTemperature

This property indicates an abnormal ambient temperature.

AuxiliaryDeviceFault

This property indicates a generic failure of an auxiliary device.

AuxiliaryMediumAbsence

This property indicates an absence of or wrong auxiliary medium.

AuxiliaryMediumInsufficiency

This property indicates an insufficiency of auxiliary medium.

AuxiliaryPowerPole

This property indicates an auxiliary power supply wrongly poled.

AuxiliaryPowerRange

This property indicates an off-spec of the auxiliary power range.

CommunicationError

This property indicates a communication error.

Corrosion

This property indicates corrosion/abrasion in parts in contact with medium.

Deviation

This property indicates an inadmissible deviation from measurement.

ElectromagneticInterference

This property indicates an abnormal electromagnetic interference.

ElectronicFault

This property indicates a fault in the device electronics.

EnergySupply

This property indicates an error in internal energy supply.

EvaluationElectronics

This property indicates an error in evaluation electronics.

ExciterError

This property indicates an error in the exciter of the sensor element.

Fouling

This property indicates a fouling on sensor element.

HumidityElectronics

This property indicates an abnormal amount of humidity in electronics area.

Installation

This property indicates an installation fault.

Interruption

This property indicates an interruption of signal path or short circuit.

LineLength

This property indicates that the maximum line length is exceeded.

MaterialElectronics

This property indicates a foreign material in electronics area.

MeasuredMaterialElectronics

This property indicates measured material in electronics area.

MechanicalDamage

This property indicates a mechanical damage.

OperatingConditions

This property indicates a fault due to non-compliance with specified operating conditions.

Other

This property indicates other faults.

Overloading

This property indicates an overloading.

ParameterSetting

This property indicates a parameter setting error.

Peripheral

This property indicates an error in peripherals.

ProcessInfluence

This property indicates a fault due to process influence.

SensorElement

This property indicates a fault in a sensor element.

StartUp

This property indicate an installation fault or fault during start-up.

TemperatureShock

This property indicates an excessive temperature shock.

Vibration

This property indicates an excessive vibration or impact load.

WearReserveOperation

This property indicates that the wear reserve is used up by operation.

WearReserveWear

This property indicates that the wear reserve is used up by wear.

 

7.18      SupervisionElectronicsType ObjectType Definition

The SupervisionElectronicsType provides Variables used for monitoring the Pump electronics. It is formally defined in Table 43. For the generation of events, the SupervisionElectronicsType has references to the four Namur NE 107 statuses defined in OPC 10000-100. The InputNode Property of the Alarm shall contain the NodeId of the Component.

Table 43 – SupervisionElectronicsType Definition

Attribute

Value

BrowseName

SupervisionElectronicsType

IsAbstract

false

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Variable

ArmatureCircuit

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

CurrentInsideDevice

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ElectricalFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

FieldCircuit

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

InstallationFault

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

InsulationResistance

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

PhaseFailure

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ShortCircuit

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

ShortToEarth

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SupplyCurrent

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SupplyCurrentHigh

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SupplyCurrentLow

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SupplyFrequency

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SupplyFrequencyHigh

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SupplyFrequencyLow

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SupplyVoltage

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SupplyVoltageHigh

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

SupplyVoltageLow

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

VoltageInsideDevice

0:Boolean

0:TwoStateDiscreteType

O, RO

0:HasComponent

Variable

WindingTemperature

0:Boolean

0:TwoStateDiscreteType

O, RO

0:GeneratesEvent

ObjectType

2:CheckFunctionAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:FailureAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:MaintenanceRequiredAlarmType

Defined in OPC 10000-100

0:GeneratesEvent

ObjectType

2:OffSpecAlarmType

Defined in OPC 10000-100

 

The InstanceDeclarations of the SupervisionElectronicsType have additional Attributes defined in Table 44. The Variables and the associated Descriptions are based on the standard VDMA 24223-1.


 

Table 44 – SupervisionElectronicsType Attribute values for child Nodes

BrowsePath

Description Attribute

ArmatureCircuit

This property indicates a failure in armature circuit.

CurrentInsideDevice

This property indicates unacceptable current inside the device.

ElectricalFault

This property indicates a generic electrical fault.

FieldCircuit

This property indicates a failure in field circuit.

InstallationFault

This property indicates an unacceptable electrical installation, e.g. mixed up phases.

InsulationResistance

This property indicates an unacceptable low winding resistance.

PhaseFailure

This property indicates a phase failure.

ShortCircuit

This property indicates a short circuit.

ShortToEarth

This property indicates a short to earth.

SupplyCurrent

This property indicates a failure of supply current.

SupplyCurrentHigh

This property indicates too high supply current.

SupplyCurrentLow

This property indicates too low supply current.

SupplyFrequency

This property indicates unacceptable supply frequency.

SupplyFrequencyHigh

This property indicates too high supply frequency.

SupplyFrequencyLow

This property indicates too low supply frequency.

SupplyVoltage

This property indicates a failure of supply voltage.

SupplyVoltageHigh

This property indicates too high supply voltage.

SupplyVoltageLow

This property indicates too low supply voltage.

VoltageInsideDevice

This property indicates unacceptable voltage inside the device.

WindingTemperature

This property indicates an unacceptable winding temperature.

 

7.19      ConfigurationGroupType ObjectType Definition

The ConfigurationGroupType provides FunctionalGroups for static manufacturer data about the Pump and user data about the Pump’s process environment. General information on this use case can be found in chapter 5.2. It is formally defined in Table 45.

Table 45 – ConfigurationGroupType Definition

Attribute

Value

BrowseName

ConfigurationGroupType

IsAbstract

False

References

Node Class

BrowseName

DataType

TypeDefinition

Other

Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.

0:HasComponent

Object

Design

 

DesignType

O

0:HasComponent

Object

Implementation

 

ImplementationType

O

0:HasComponent

Object

SystemRequirements

 

SystemRequirementsType

O