Field Device Integration (FDI) – Part 4: FDI Packages FCG TS62769-4 Edition 1.2.0 21 Jun 2019 RELEASED S P E C I F I C A T I O N Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 1 of 79 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 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 2 of 79 Revision Log Version Date Change Note / History / Reason 1.0.0.0 31 July 2014 First Release 1.1.0.1 31 May 2016 New document template, issues 1859 solved 1.1.0.2 21 June 2016 New Copyright section, remove FDI Cooperation Page 1.1.0.3 05 July 2016 Issue 1866 solved 1.1.0.4 19 Dec 2016 New document template 1.1.0.5 24 Feb 2017 New cover page and trademark information 1.1.0.6 19 June 2017 Updated subclause 7.2 and 7.3 (KAVI comment 313, Bugzilla issue 2245) 1.2.0.5 17 Oct 2018 Modified regular expression in VersionSupportedT Editorial Changes 1.2.0.6 05 Dec 2018 Added WorkstationAndMobile to Table E.20 (Bugzilla issue 2718) Added documentation on restriction to supported RuntimeIds to attribute Runtimeid of UipVariantT. (Bugzilla issue 2718) 1.2.0.7 26 Feb. 2019 Added Figure 10, correction of regular expression for versioning, editorial changes (Balloting Comments 871, 876, 906, 910, 939-942, 944, 945, 952, 953) 1.2.0.8 21 June 2019 Editorial changes Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 3 of 79 TABLE OF CONTENTS 1 Scope ........................................................................................................................................................... 9 2 Normative references .................................................................................................................................. 9 3 Terms, definitions, abbreviated terms and acronyms ................................................................................. 10 3.1 Terms and definitions .................................................................................................................. 10 3.2 Abbreviated terms and acronyms ................................................................................................ 11 4 FDI Package Model ..................................................................................................................................... 12 4.1 Overview ..................................................................................................................................... 12 4.2 FDI Package Elements .................................................................................................................. 13 Package Catalog ....................................................................................................... 13 Electronic Device Description ................................................................................... 13 User Interface Plug-in ............................................................................................... 13 Attachment .............................................................................................................. 15 4.3 FDI Package Types ....................................................................................................................... 15 FDI Device Package ................................................................................................... 15 FDI Communication Package ..................................................................................... 16 FDI UIP Package ........................................................................................................ 17 FDI Profile Package ................................................................................................... 17 5 FDI Package implementation ...................................................................................................................... 19 5.1 Packaging technology .................................................................................................................. 19 5.2 Use of Open Packaging Conventions ............................................................................................ 19 Unknown Parts ......................................................................................................... 19 Invalid Parts ............................................................................................................. 19 Unknown Relationships ............................................................................................ 19 Interleaving .............................................................................................................. 19 Core Properties ........................................................................................................ 19 Thumbnails ............................................................................................................... 19 Digital Signatures ..................................................................................................... 19 5.3 FDI Package Parts ........................................................................................................................ 19 Package Catalog ....................................................................................................... 19 5.3.1.1 Format ................................................................................................................. 19 5.3.1.2 Content ................................................................................................................ 20 Electronic Device Description ................................................................................... 20 5.3.2.1 Format ................................................................................................................. 20 5.3.2.2 Content ................................................................................................................ 21 User Interface Plug-in ............................................................................................... 21 5.3.3.1 Format ................................................................................................................. 21 5.3.3.2 Content ................................................................................................................ 22 5.3.3.2.1 Use of Open Packaging Convention .................................................... 22 5.3.3.2.2 User Interface Plug-in Parts ............................................................... 22 Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 4 of 79 Attachments ............................................................................................................. 23 5.3.4.1 Image ................................................................................................................... 23 5.3.4.2 Documentation ..................................................................................................... 24 5.3.4.3 Protocol Support File ............................................................................................ 24 5.3.4.4 FDI Registration Certificate ................................................................................... 24 5.3.4.4.1 Format ............................................................................................... 24 5.3.4.4.2 Content ............................................................................................. 25 6 FDI Package Versioning .............................................................................................................................. 26 6.1 Version Scheme ........................................................................................................................... 26 6.2 Versioned Elements..................................................................................................................... 26 6.3 Version Hierarchy ........................................................................................................................ 26 6.4 UIP Compatibility ........................................................................................................................ 28 7 Digital Signatures and Registration Certificates .......................................................................................... 30 7.1 Signed Elements and Certification documents ............................................................................. 30 7.2 Signing mechanism ...................................................................................................................... 30 7.3 FDI Package Originator, FDI Registration Authority ...................................................................... 31 7.4 FDI Host behavior ........................................................................................................................ 31 Annex A (normative) File name conventions...................................................................................................... 32 A.1 Identification .............................................................................................................................. 32 A.2 FDI Package filename convention ................................................................................................ 32 Annex B (informative) FDI Package Creation ...................................................................................................... 33 B.1 General ....................................................................................................................................... 33 B.2 Tools and Components ................................................................................................................ 33 B.2.1 Overview .................................................................................................................. 33 B.2.2 FDI Reference Implementation/Common EDD Engine ............................................... 33 B.2.3 FDI Package IDE ........................................................................................................ 33 B.2.4 FDI Device Package Conformance Test Tool .............................................................. 33 B.3 Development............................................................................................................................... 33 B.3.1 FDI Package core development ................................................................................. 33 B.3.2 User Interface Plug-in development .......................................................................... 34 B.3.3 FDI Package Attachment development ...................................................................... 34 B.3.4 FDI Package binding and packaging ........................................................................... 34 B.3.5 Conformance Test .................................................................................................... 35 Annex C (informative) FDI Package deployment ................................................................................................ 36 C.1 General ....................................................................................................................................... 36 C.2 Scenarios .................................................................................................................................... 36 C.2.1 FDI Package deployment to PC based client/server systems ...................................... 36 C.2.1.1 FDI Device Packages/FDI Profile Packages/FDI Communication Packages .............. 36 C.2.1.2 FDI UIP Packages .................................................................................................. 36 C.2.2 FDI Package deployment to an FDI standalone system .............................................. 37 C.2.2.1 FDI Device Packages/FDI Profile Packages/FDI Communication Packages .............. 37 C.2.2.2 FDI UIP Packages .................................................................................................. 37 Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 5 of 79 Annex D (informative) Example ......................................................................................................................... 39 D.1 General ....................................................................................................................................... 39 D.2 Open Packaging Conventions ....................................................................................................... 39 D.2.1 Overview .................................................................................................................. 39 D.2.2 Parts ......................................................................................................................... 39 D.2.3 Relationships ............................................................................................................ 40 D.2.4 OPC Core Features .................................................................................................... 40 D.2.4.1 Overview .............................................................................................................. 40 D.2.4.2 Content Types ...................................................................................................... 40 D.2.4.3 Package Relationships .......................................................................................... 41 D.2.4.4 Part Relationships................................................................................................. 41 D.2.5 OPC Additional features ........................................................................................... 41 D.2.5.1 Core Properties .................................................................................................... 41 D.2.5.2 Thumbnails ........................................................................................................... 41 D.2.5.3 Digital Signatures ................................................................................................. 42 D.3 Creation and Handling of FDI Packages ........................................................................................ 42 D.4 FDI Device Package Example ........................................................................................................ 42 D.4.1 Overview .................................................................................................................. 42 D.4.2 User Interface Plug-in ............................................................................................... 46 D.4.3 EDD reference to UIP ................................................................................................ 48 D.4.4 FDI Registration Certificate ....................................................................................... 48 Annex E (normative) Schema ............................................................................................................................. 50 E.1 Target Namespace ....................................................................................................................... 50 E.2 Catalog ........................................................................................................................................ 50 E.3 ClassificationIdT .......................................................................................................................... 50 E.4 CommunicationProfileT ............................................................................................................... 50 E.5 CommunicationRoleT .................................................................................................................. 50 E.6 CommunicationServerT ............................................................................................................... 51 E.7 DeviceTypeT ................................................................................................................................ 51 E.8 FdiRegistrationCert ..................................................................................................................... 52 E.9 FdiRegistrationCertT ................................................................................................................... 52 E.10 InterfaceT ................................................................................................................................... 53 E.11 ListOfCommunicationProfilesT .................................................................................................... 54 E.12 ListOfDeviceImagesT ................................................................................................................... 54 E.13 ListOfDeviceTypesT ..................................................................................................................... 54 E.14 ListOfDocumentsT ....................................................................................................................... 55 E.15 ListOfInterfacesT ......................................................................................................................... 55 E.16 ListOfLocalizedStringsT ................................................................................................................ 56 E.17 ListOfProtocolSupportFilesT ........................................................................................................ 56 E.18 ListOfRegDeviceTypesT ................................................................................................................ 56 E.19 ListOfRegistrationsT .................................................................................................................... 57 E.20 ListOfSupportedDeviceRevisionsT ................................................................................................ 57 Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 6 of 79 E.21 ListOfSupportedUipsT.................................................................................................................. 58 E.22 ListOfUipVariantsT ...................................................................................................................... 58 E.23 LocalizedStringT .......................................................................................................................... 58 E.24 PackageT ..................................................................................................................................... 59 E.25 PackageTypeT ............................................................................................................................. 60 E.26 PlatformT .................................................................................................................................... 60 E.27 RegDeviceTypeT .......................................................................................................................... 61 E.28 RegistrationT ............................................................................................................................... 61 E.29 RelationshipIdT ........................................................................................................................... 62 E.30 String256T ................................................................................................................................... 62 E.31 SupportedUipT ............................................................................................................................ 62 E.32 UipCatalog .................................................................................................................................. 63 E.33 UipStyleT .................................................................................................................................... 63 E.34 UipT ............................................................................................................................................ 63 E.35 UipVariantT ................................................................................................................................. 64 E.36 UuidT .......................................................................................................................................... 65 E.37 VersionSupportedT ...................................................................................................................... 65 E.38 VersionT ...................................................................................................................................... 65 Annex F (normative) Communication protocol specific profiles ......................................................................... 66 Annex G (informative) FDI Package life-cycle use cases ..................................................................................... 67 G.1 New Device Type ......................................................................................................................... 67 G.2 Replacement of Device ................................................................................................................ 67 G.3 Firmware enhancements ............................................................................................................. 67 G.4 FDI Package life-cycle polices ...................................................................................................... 68 G.5 FDI Package update ..................................................................................................................... 68 G.6 FDI Package upgrade ................................................................................................................... 68 G.7 FDI Package replacement/exchange ............................................................................................ 68 G.8 FDI Package uninstallation........................................................................................................... 68 Annex H (normative) Health Status Method ...................................................................................................... 70 H.1 Background ................................................................................................................................. 70 H.2 Device Health Status Model......................................................................................................... 70 H.3 Standard EDD Method signature ................................................................................................. 70 H.4 Performance considerations ........................................................................................................ 71 Annex I (normative) Modular devices ................................................................................................................ 72 I.1 Concept ...................................................................................................................................... 72 I.2 EDDL usage profile ...................................................................................................................... 72 I.3 Processing recommendations ...................................................................................................... 73 I.3.1 Monolithic device with device variants ................................................................................. 73 I.3.2 Remote IOs .......................................................................................................................... 73 I.3.3 How to identify the top level topology element .................................................................... 73 I.3.4 Packaging details example .................................................................................................... 73 Annex J (normative) FDI Communication Packages for FDI Communication Server ............................................. 75 Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4 , Ed. 1.2.0, 21 Jun 2019 Page 7 of 79 J.1 General ....................................................................................................................................... 75 J.2 Protocol Support File ................................................................................................................... 75 J.3 CommunicationProfile definition ................................................................................................. 75 J.4 Profile Device .............................................................................................................................. 75 J.5 Protocol version information ....................................................................................................... 75 J.6 Associating a Package with an FDI Communication Server ........................................................... 75 J.7 Handling of Catalog elements ...................................................................................................... 75 J.8 Example ...................................................................................................................................... 76 Annex K (normative) FDI Profile for EDDs .......................................................................................................... 77 K.1 Overview ..................................................................................................................................... 77 K.2 Entry Point to Online handling..................................................................................................... 77 K.3 Entry Point to Offline handling .................................................................................................... 77 K.4 Upload and Download ................................................................................................................. 77 K.5 Initial Data Set ............................................................................................................................ 77 K.6 Method GetHealthStatus ............................................................................................................. 77 K.7 Actions ........................................................................................................................................ 77 K.7.1 Pre- and Post-Read Actions ....................................................................................... 77 K.7.2 Pre- and Post-Write Actions ...................................................................................... 77 K.7.3 Refresh Actions on Variables .................................................................................... 78 K.7.4 Actions on BIT_ENUMERATION ................................................................................. 78 K.8 Shared files ................................................................................................................................. 78 Bibliography ...................................................................................................................................................... 79 Figure 1 – FDI architecture diagram ..................................................................................................................... 9 Figure 2 – FDI Package Model ............................................................................................................................ 12 Figure 3 – Architectural mapping ....................................................................................................................... 12 Figure 4 – User Interface Plug-in Reference Model ............................................................................................. 14 Figure 5 – Multiple FDI Packages referencing a common UIP .............................................................................. 15 Figure 6 – FDI Device Package ............................................................................................................................ 16 Figure 7 – FDI Communication Package .............................................................................................................. 17 Figure 8 – FDI UIP Package ................................................................................................................................. 17 Figure 9 – FDI Profile Package ............................................................................................................................ 18 Figure 10 – Device Function and Parameter sets (type and profile specific) ........................................................ 18 Figure 11 – Catalog Element............................................................................................................................... 20 Figure 12 – User Interface Plug-in ...................................................................................................................... 21 Figure 13 – UIP Catalog ...................................................................................................................................... 22 Figure 14 – FDI Registration Certificate .............................................................................................................. 25 Figure 15 – Version Hierarchy ............................................................................................................................ 27 Figure 16 – UIP Version Support concept ........................................................................................................... 29 Field Device Integration (FDI) – Part 4: FDI Packages RELEASED FCG TS62769-4, Ed. 1.2.0, 21 Jun 2019 Page 8 of 79 Figure 17 – FDI Package signing.......................................................................................................................... 30 Table 1 – UIP Platform Capabilities .................................................................................................................... 14 Table 2 – Package Catalog Part........................................................................................................................... 20 Table 3 – EDD part ............................................................................................................................................. 21 Table 4 – User Interface Plug-in part .................................................................................................................. 22 Table 5 – UIP Catalog Part .................................................................................................................................. 23 Table 6 – UIP Variant Part .................................................................................................................................. 23 Table 7 – Image Part .......................................................................................................................................... 23 Table 8 – Documentation Part ............................................................................................................................ 24 Table 9 – Protocol Support File Part ................................................................................................................... 24 Table 10 – FDI Registration Certificate Part ........................................................................................................ 24 Table 11 – Versioned Elements .......................................................................................................................... 26 Table 12 – Influence on FDI Package Version ...................................................................................................... 27 Table E.1 – Elements of CommunicationServerT ................................................................................................. 51 Table G.2– Device Replacement Guidelines ........................................................................................................ 67 Table G.3 – Firmware enhancement guidelines .................................................................................................. 68 Table J.1 – Catalog Mapping ............................................................................................................................... 75 Table J.2 – Handling of Catalog elements ........................................................................................................... 75 Next >