Field Device Integration (FDI) – Part 5: Information Model FCG TS62769-5 Edition 1.2.0 22 Jul 2019 RELEASED S P E C I F I C A T I O N Field Device Integration (FDI) – Part 5: Information Model RELEASED FCG TS62769-5 , Ed. 1.2.0, 22 Jul 2019 Page 1 of 67 Document Distribution / Maintenance Control / Document Approval To obtain information concerning document distribution control, maintenance control, and document approval please contact FieldComm Group at the address shown below. Copyright © 2019 (2014, 2017) FieldComm Group, PROFIBUS Nutzerorganisation e. V., OPC Foundation, FDT Group FieldComm Group, PROFIBUS Nutzerorganisation e.V, OPC Foundation, and FDT Group are the joint publishers of this document. The information in this document is subject to change without notice and should not be construed as a commitment by the publishers. The publishers assume no responsibility for any errors that may appear in this document. In no event shall the publishers be liable for direct, indirect, special, incidental or consequential damages of any nature or kind arising from the use of this document. This document and parts thereof must not be reproduced or copied without written permission from the publishers, and the contents thereof must not be imparted to a third party nor used for any unauthorized purpose. All rights to copyrights, registered trademarks or applications, utility models and registered patents or applications reside with their respective owners. Trademark Information FieldComm Group ™ , F OUNDATION ™ Fieldbus and HART-IP ™ are trademarks, and HART ® , WirelessHART ® , ROM ® and SIF ® are registered trademarks of FieldComm Group, Austin, Texas, USA Any use of these terms hereafter in this document, or in any document referenced by this document, implies the trademark/registered trademark. All other trademarks used in this or referenced documents are trademarks of their respective companies. For more information, contact: FDT Group 5 Industrieweg 3001 Heverlee Belgium Phone: +32 (0)10 22 22 51 fdtgroup.org FieldComm Group 9430 Research Boulevard Suite 1-120 Austin, TX 78759, USA Phone: (512) 792-2300 Fax: (512) 792-2310 fieldcommgroup.org OPC Foundation Presidential Office 8455 Infirmary Rd., Ravenna, OH 44266 P.O. Box 808 (mailing address) Mantua, Ohio 44255 Phone: (330) 839-8718 opcfoundation.org PROFIBUS Nutzerorganisation e. V. (PNO) PROFIBUS & PROFINET International (PI) Haid-und-Neu-Str. 7 76131 Karlsruhe Germany Phone: +49 721 96 58 590 Fax: +49 721 96 58 589 profibus.com profinet.com Intellectual Property Rights The FieldComm Group (the Group) does not knowingly use or incorporate any information or data into the HART, F OUNDATION Fieldbus and FDI protocol standards, which the Group does not own or have lawful rights to use. Should the Group receive any notification regarding the existence of any conflicting private IPR, the Group will review the disclosure and either (A) determine there is no conflict; (B) resolve the conflict with the IPR owner; or (C) modify the standard to remove the conflicting requirement. In no case does the Group encourage implementers to infringe on any individual's or organization's IPR. Field Device Integration (FDI) – Part 5: Information Model RELEASED FCG TS62769-5, Ed. 1.2.0, 22 Jul 2019 Page 2 of 67 Revision Log Version Date Change Note / History / Reason 1.0.0.0 31 July 2014 First Release 1.0.4.0 27 Jan 2016 New status codes for dominant and dependent variables in EditCache 1.0.4.0 27 Jan 2016 Fixed description of ValueRank and ArrayDimensions. 1.1.0.0 12 April 2016 Upgrade to FCG template. 1.1.0.2 06 June 2016 Issue #5795: The NodeSets will always be released in a ZIP together with all documents. Therefore no more reference in the document to a separate schema file is needed. 1.1.0.5 19 Dec 2016 Issue # 5872: Illustrate that DeviceHealth is mandatory. Issue # 5870: Specify the mapping of EDD method GetHealthStatus. New document template 1.1.0.6 24 Feb 2017 New cover page and trademark information 1.1.0.7 30 Jun 2017 DeviceHealth Diagnostics: Additional information for NE107 specified in 7.3.2.(KAVI 319) 1.1.0.8 31 Jul 2017 The mapping of ENUMERATED variables (section 15.6.5) has been inconsistent with the DataType mapping in Table 47. It has to make use of the MulitStateValueDiscreteType VariableType (Bugzilla 2166) 1.1.0.9 15 Aug 2017 Corrected DeviceHealth Diagnostics in section 7.3.2 (KAVI 319) and typo in section 15.6.5. 1.1.0.10 15 Aug 2017 Editorial Changes 1.2.0.5 06 Oct. 2018 The following sections have been added - 5.6 Semantic Information - 15.6.12 EDDL CLASS Attributes on Parameters - 15.12 Semantic Identifiers Editorial Changes 1.2.0.6 05 Dec. 2018 Editorial Changes in 7.4.2 1.2.0.7 22 Feb. 2019 The following sections have been added (contents moved from FCG TS62769-2 to this part) - 11.1 Structure of the StatusCode - 11.2 FDI specific operation level result codes Addition of missing status codes (Bugzilla 1693, 2206, 2311, 2415) 1.2.0.8 21 June 2019 Editorial changes (Balloting comment 898) 1.2.0.9 09 July 2019 Corrected browse name of MultiStateSemanticDiscreteType, Editorial changes (Balloting comment 896) 1.2.0.10 22 July 2019 Synchronized specification of MultiStateSemanticDiscreteType between PA-DIM and FDI (Balloting comment 896) Field Device Integration (FDI) – Part 5: Information Model RELEASED FCG TS62769-5 , Ed. 1.2.0, 22 Jul 2019 Page 3 of 67 TABLE OF CONTENTS 1 Scope ........................................................................................................................................................... 9 2 Normative references .................................................................................................................................. 9 3 Terms, definitions, abbreviated terms, acronyms and conventions ............................................................. 10 3.1 Terms and definitions .................................................................................................................. 10 3.2 Abbreviated terms and acronyms ................................................................................................ 10 3.3 Conventions for graphical notation ............................................................................................. 10 4 Overview of OPC Unified Architecture ........................................................................................................ 12 4.1 General ....................................................................................................................................... 12 4.2 Overview of OPC UA Devices ....................................................................................................... 13 5 Concepts .................................................................................................................................................... 15 5.1 General ....................................................................................................................................... 15 5.2 Device topology .......................................................................................................................... 15 5.3 Online/offline ............................................................................................................................. 17 5.4 Catalogue (Type Definitions) ....................................................................................................... 18 5.5 Communication ........................................................................................................................... 18 5.6 Semantic Information .................................................................................................................. 18 6 AddressSpace organization ........................................................................................................................ 21 7 Device Model for FDI ................................................................................................................................. 21 7.1 General ....................................................................................................................................... 21 7.2 Online/offline ............................................................................................................................. 21 7.3 Device health .............................................................................................................................. 22 DeviceHealth Mapping ................................................................................................................ 22 DeviceHealth Diagnostics ............................................................................................................ 23 7.4 User interface elements .............................................................................................................. 24 General .................................................................................................................... 24 UI Description Type .................................................................................................. 24 UI Plug-in Type ......................................................................................................... 25 7.5 Type-specific support information ............................................................................................... 26 7.6 Actions ........................................................................................................................................ 27 Overview .................................................................................................................. 27 Action Type .............................................................................................................. 27 ActionService Type ................................................................................................... 28 ActionService Object ................................................................................................ 28 InvokeAction Method ............................................................................................... 29 RespondAction Method ............................................................................................ 30 AbortAction Method ................................................................................................. 31 8 Network and connectivity .......................................................................................................................... 31 9 Utility functions ......................................................................................................................................... 32 9.1 Overview ..................................................................................................................................... 32 9.2 Locking ........................................................................................................................................ 32 Field Device Integration (FDI) – Part 5: Information Model RELEASED FCG TS62769-5, Ed. 1.2.0, 22 Jul 2019 Page 4 of 67 9.3 EditContext ................................................................................................................................. 32 Overview .................................................................................................................. 32 EditContext Type ...................................................................................................... 33 EditContext Object ................................................................................................... 33 GetEditContext Method ............................................................................................ 33 RegisterNodes Method ............................................................................................. 34 Apply Method ........................................................................................................... 35 Reset Method ........................................................................................................... 36 Discard Method ........................................................................................................ 37 9.4 Direct Device Access ................................................................................................................... 37 General .................................................................................................................... 37 DirectDeviceAccess Type .......................................................................................... 38 DirectDeviceAccess Object ........................................................................................ 39 InitDirectAccess Method ........................................................................................... 39 EndDirectAccess Method .......................................................................................... 40 Transfer Method ...................................................................................................... 40 10 Parameter Types ........................................................................................................................................ 41 10.1 General ....................................................................................................................................... 41 10.2 ScalingFactor Property ................................................................................................................ 42 10.3 Min_Max_Values Property .......................................................................................................... 42 11 FDI StatusCodes ......................................................................................................................................... 43 11.1 Structure of the StatusCode ........................................................................................................ 43 11.2 FDI specific operation level result codes ...................................................................................... 44 12 Specialized topology elements ................................................................................................................... 47 13 Auditing ..................................................................................................................................................... 47 13.1 General ....................................................................................................................................... 47 13.2 FDI Client-provided context information ..................................................................................... 47 13.3 LogAuditTrailMessage Method .................................................................................................... 47 14 FDI Server Version ..................................................................................................................................... 48 15 Mapping FDI Package information to the FDI Information Model................................................................ 48 15.1 General ....................................................................................................................................... 48 15.2 Localization ................................................................................................................................. 49 Localized text ........................................................................................................... 49 Engineering units ...................................................................................................... 49 15.3 Device ......................................................................................................................................... 49 General .................................................................................................................... 49 Mapping to Attributes to a specific DeviceType Node ............................................... 49 Mapping to Properties .............................................................................................. 49 Mapping to ParameterSet ......................................................................................... 50 Mapping to Functional Groups .................................................................................. 50 Mapping to DeviceTypeImage ................................................................................... 50 Mapping to Documentation ...................................................................................... 50 Field Device Integration (FDI) – Part 5: Information Model RELEASED FCG TS62769-5 , Ed. 1.2.0, 22 Jul 2019 Page 5 of 67 Mapping to ProtocolSupport..................................................................................... 50 Mapping to ImageSet................................................................................................ 50 Mapping to ActionSet ............................................................................................... 51 Mapping to MethodSet ............................................................................................. 51 15.4 Modular Device ........................................................................................................................... 51 15.5 Block ........................................................................................................................................... 51 General .................................................................................................................... 51 Mapping to Attributes .............................................................................................. 51 Mapping to ParameterSet ......................................................................................... 51 Mapping to Functional Groups .................................................................................. 52 Mapping to ActionSet ............................................................................................... 52 Mapping to MethodSet ............................................................................................. 52 Instantiation rules .................................................................................................... 52 15.6 Parameter ................................................................................................................................... 52 General .................................................................................................................... 52 Private Parameters ................................................................................................... 55 MIN_Value and MAX_Value ...................................................................................... 56 Engineering units ...................................................................................................... 56 Enumerated Parameters ........................................................................................... 56 Bit-enumerated Parameters...................................................................................... 56 Representation of records ........................................................................................ 57 Representation of arrays, and lists of Parameters with simple data types ................. 57 Representation of values arrays, and lists of RECORD Parameters ............................. 58 Representation of COLLECTION and REFERENCE ARRAY ............................................ 58 SCALING_FACTOR ..................................................................................................... 59 EDDL CLASS Attributes on Parameters ...................................................................... 59 15.7 Functional Groups ....................................................................................................................... 61 15.8 AXIS elements in UIDs ................................................................................................................. 61 15.9 Actions ........................................................................................................................................ 61 15.10 UIPs ............................................................................................................................................ 62 15.11 Protocols, Networks and Connection Points ................................................................................ 62 15.12 Semantic Identifies ...................................................................................................................... 62 DictionaryIds Property ................................................................................................................ 62 MultiStateDictionaryEntryDiscreteType ....................................................................................... 63 GetNodeIdsByDictionaryEntryId .................................................................................................. 63 16 Profiles ...................................................................................................................................................... 64 Annex A (normative) Namespace and Mappings ................................................................................................ 66 Bibliography ...................................................................................................................................................... 67 Figure 1 – FDI architecture diagram ..................................................................................................................... 9 Figure 2 – OPC UA Graphical Notation for NodeClasses ...................................................................................... 11 Field Device Integration (FDI) – Part 5: Information Model RELEASED FCG TS62769-5, Ed. 1.2.0, 22 Jul 2019 Page 6 of 67 Figure 3 – OPC UA Graphical Notation for References ........................................................................................ 11 Figure 4 – OPC UA Graphical Notation Example .................................................................................................. 12 Figure 5 – Optimized Type Reference ................................................................................................................. 12 Figure 6 – OPC UA Devices Example: Functional Groups ..................................................................................... 14 Figure 7 – OPC UA Devices example: Configurable components.......................................................................... 15 Figure 8 – Example of an automation system ..................................................................................................... 16 Figure 9 – Example of a Device topology ............................................................................................................ 17 Figure 10 – Example Device Types representing a catalogue .............................................................................. 18 Figure 11 - Example of concrete DictionaryEntryType and Object ....................................................................... 19 Figure 12 - Example of DictionaryEntries ............................................................................................................ 20 Figure 13 – Online component for access to device data .................................................................................... 22 Figure 14 – Hierarchy of user interface Types..................................................................................................... 24 Figure 15 – Integration of Actions within a TopologyElement ............................................................................. 27 Figure 16 – Action Service .................................................................................................................................. 29 Figure 17 – EditContext type and instance ......................................................................................................... 33 Figure 18 – DirectDeviceAccessType................................................................................................................... 38 Figure 19 – DirectDeviceAccess instance ............................................................................................................ 39 Figure 20 – OPC UA VariableTypes including OPC UA DataAccess ....................................................................... 42 Figure 21 – Example: Complex variable representing a RECORD ......................................................................... 57 Figure 22 – Complex variable representing a VALUE_ARRAY of RECORDs ............................................................ 58 Figure 23 – Example of EDDL CLASS Attributes in the FDI OPC UA Information Model ...................................... 60 Table 1 – DeviceHealth Mapping ........................................................................................................................ 22 Table 2 – DeviceType definition (excerpt applicable for this clause) ................................................................... 23 Table 3 – DeviceType definition with DeviceHealth and DeviceHealthDiagnostics ............................................... 23 Table 4 – UIDescriptionType Definition .............................................................................................................. 24 Table 5 – UIPlugInType Definition ...................................................................................................................... 25 Table 6 – ActionType Definition ......................................................................................................................... 28 Table 7 – ActionServiceType Definition .............................................................................................................. 28 Table 8 – InvokeAction Method Arguments ........................................................................................................ 30 Table 9 – InvokeAction Method AddressSpace Definition ................................................................................... 30 Table 10 – RespondAction Method Arguments ................................................................................................... 30 Table 11 – RespondAction Method AddressSpace Definition .............................................................................. 31 Table 12 – AbortAction Method Arguments ....................................................................................................... 31 Table 13 – AbortAction Method AddressSpace Definition ................................................................................... 31 Table 14 – EditContextType Definition ............................................................................................................... 33 Table 15 – GetEditContext Method Arguments ................................................................................................... 34 Field Device Integration (FDI) – Part 5: Information Model RELEASED FCG TS62769-5 , Ed. 1.2.0, 22 Jul 2019 Page 7 of 67 Table 16 – GetEditContext Method AddressSpace Definition .............................................................................. 34 Table 17 – RegisterNodes Method Arguments .................................................................................................... 34 Table 18 – RegisterNodes Method AddressSpace Definition ............................................................................... 35 Table 19 – RegistrationParameters DataType Structure ...................................................................................... 35 Table 20 – RegisterNodesResult DataType Structure .......................................................................................... 35 Table 21 – Apply Method Arguments ................................................................................................................. 36 Table 22 – Apply Method AddressSpace Definition ............................................................................................. 36 Table 23 – ApplyResult DataType Structure ........................................................................................................ 36 Table 24 – Reset Method Arguments .................................................................................................................. 37 Table 25 – Reset Method AddressSpace Definition ............................................................................................. 37 Table 26 – Discard Method Arguments ............................................................................................................... 37 Table 27 – Discard Method AddressSpace Definition .......................................................................................... 37 Table 28 – DirectDeviceAccessType Definition ................................................................................................... 38 Table 29 – DirectDeviceAccess Instance Definition ............................................................................................. 39 Table 30 – InitDirectAccess Method Arguments ................................................................................................. 40 Table 31 – InitDirectAccess Method AddressSpace Definition ............................................................................. 40 Table 32 – EndDirectAccess Method Arguments ................................................................................................. 40 Table 33 – EndDirectAccess Method AddressSpace Definition ............................................................................ 40 Table 34 – Transfer Method Arguments ............................................................................................................. 41 Table 35 – Transfer Method AddressSpace Definition......................................................................................... 41 Table 36 – ScalingFactor Property Definition ...................................................................................................... 42 Table 37 – Min_Max_Values Property Definition ................................................................................................ 43 Table 38 – Variant_Range DataType Structure .................................................................................................... 43 Table 39 – Variant_Range Definition .................................................................................................................. 43 Table 40 – StatusCode Bit Assignments .............................................................................................................. 44 Table 41 – DataValue InfoBits ............................................................................................................................ 44 Table 42 – Good operation level result codes ..................................................................................................... 44 Table 43 – Uncertain operation level result codes .............................................................................................. 45 Table 44 – Bad operation level result codes ....................................................................................................... 46 Table 45 – LogAuditTrailMessage Method Arguments ........................................................................................ 48 Table 46 – LogAuditTrailMessage Method AddressSpace Definition ................................................................... 48 Table 47 – FDIServerVersion Property Definition ................................................................................................ 48 Table 48 – DeviceType Property Mapping .......................................................................................................... 50 Table 49 – Setting OPC UA Variable Attributes from EDDL variable attributes .................................................... 53 Table 50 – Correspondence between EDDL and OPC UA standard data types ..................................................... 53 Table 51 – Definition of EddlDictionaryType ....................................................................................................... 59 Table 52 – Definition of EddlDictionary Object ................................................................................................... 59 Field Device Integration (FDI) – Part 5: Information Model RELEASED FCG TS62769-5, Ed. 1.2.0, 22 Jul 2019 Page 8 of 67 Table 53 – Definition of Parameter Class Attributes ........................................................................................... 59 Table 54 - DictionaryIds Definition ..................................................................................................................... 63 Table 55 - MultiStateDictionaryEntryDiscreteType definition ............................................................................. 63 Table 56 - GetNodeIdsByDictionaryEntryId ......................................................................................................... 64 Table 57 – FDI Server Facet Definition ................................................................................................................ 64 Table 58 –FDI Client Facet Definition.................................................................................................................. 64 Next >