Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols FCG TS62769-100 Edition 1.2.0 23 Jul 2019 RELEASED S P E C I F I C A T I O N Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100 , Ed. 1.2.0, 23 Jul 2019 Page 1 of 36 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 (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 per-mission 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 100: Profiles – Generic Protocols RELEASED FCG TS62769-100, Ed. 1.2.0, 23 Jul 2019 Page 2 of 36 Revision Log Version Date Change Note / History / Reason 0.0.0 26 Aug 2015 Initial Version 0.1.0 07 Dec 2015 Changed Manufacturer and DeviceModel to String data type 0.2.0 26 Feb 2016 Changed to FCG format and minor changes, e.g. removed unnecessary references, added clarifications 0.3.0 15 Mar 2016 Added corrected version number to document. Small format changes and typo fixing. 0.3.1 06 May 2016 Made identification of scan result optional since not all protocol might support device identification. 1.1.0.1 11 May 2016 Switched to new version number, remove not needed descriptions in ServiceError of Metods (issue 1854) 1.1.0.2 26 July 2016 Added field ProfileId to scan result in order to handle profile packages. Changed data type of address from ByteString to String. 1.1.0.3 19 Dec 2016 New document template 1.1.0.4 24 Feb 2017 New cover page and trademark information 1.1.0.5 23 May 2017 Update of table 11 according to review comment ID 00332 1.2.0.1 17 Oct 2018 Editorial Changes 1.2.0.1 23 July 2019 Editorial Changes Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100 , Ed. 1.2.0, 23 Jul 2019 Page 3 of 36 TABLE OF CONTENTS 1 Scope ........................................................................................................................................................... 6 2 Normative References .................................................................................................................................. 6 3 Terms, definitions, abbreviated terms and Acronyms ................................................................................... 6 3.1 Terms and definitions .................................................................................................................... 6 3.2 Abbreviations ................................................................................................................................ 6 4 Conventions ................................................................................................................................................. 7 4.1 EDDL syntax .................................................................................................................................. 7 4.2 XML syntax .................................................................................................................................... 7 4.3 Capitalizations .............................................................................................................................. 7 5 Profile for Generic Protocols ........................................................................................................................ 7 5.1 General ......................................................................................................................................... 7 5.2 Catalog profile .............................................................................................................................. 7 5.2.1 Protocol support file ................................................................................................... 7 5.2.1.1 FDI Device Package ................................................................................................. 7 5.2.1.2 FDI Communication Packages ................................................................................. 8 5.2.2 CommunicationProfile definition ................................................................................ 8 5.2.3 Profile device ............................................................................................................. 8 5.2.4 Protocol version information ...................................................................................... 8 5.3 Associating a Package with a device .............................................................................................. 8 5.3.1 Device type identification mapping ............................................................................. 8 5.3.2 Device type revision mapping ................................................................................... 10 5.4 Information Model mapping ........................................................................................................ 10 5.4.1 ProtocolType definition ............................................................................................ 10 5.4.2 DeviceType mapping ................................................................................................. 10 5.4.3 FunctionalGroup identification definition ................................................................. 11 5.5 Topology elements ...................................................................................................................... 11 5.5.1 ConnectionPoint definition ....................................................................................... 11 5.5.2 Communication Device definition ............................................................................. 12 5.5.3 Communication service provider definition .............................................................. 13 5.5.4 Network definition ................................................................................................... 14 5.6 Methods ..................................................................................................................................... 14 5.6.1 Methods for FDI Communication Servers .................................................................. 14 5.6.1.1 General ................................................................................................................ 14 5.6.1.2 Connect ................................................................................................................ 14 5.6.1.3 Disconnect ........................................................................................................... 15 5.6.1.4 Transfer ................................................................................................................ 15 5.6.1.5 GetPublishedData ................................................................................................. 17 5.6.1.6 SetAddress ........................................................................................................... 17 5.6.1.7 Scan ..................................................................................................................... 18 5.6.1.8 ResetScan ............................................................................................................. 18 Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100, Ed. 1.2.0, 23 Jul 2019 Page 4 of 36 5.6.2 Methods for Gateways ............................................................................................. 18 5.6.2.1 General ................................................................................................................ 18 5.6.2.2 Connect ................................................................................................................ 18 5.6.2.3 Disconnect ........................................................................................................... 19 5.6.2.4 Transfer ................................................................................................................ 20 5.6.2.5 GetPublishedData ................................................................................................. 22 5.6.2.6 SetAddress ........................................................................................................... 23 5.6.2.7 Scan ..................................................................................................................... 24 5.6.2.8 ScanNext .............................................................................................................. 25 Annex A (normative) Topology Scan result schema ............................................................................................ 26 A.1 General ....................................................................................................................................... 26 A.2 Network ...................................................................................................................................... 26 A.3 GenericNetworkT ........................................................................................................................ 26 A.4 GenericConnectionPointT ............................................................................................................ 26 A.5 GenericIdentificationT ................................................................................................................. 27 A.6 GenericAddressT ......................................................................................................................... 28 Annex B (normative) Transfer service parameters ............................................................................................. 29 B.1 General ....................................................................................................................................... 29 B.2 sendData ..................................................................................................................................... 29 B.3 receiveData ................................................................................................................................. 29 B.4 TransferSendDataT ...................................................................................................................... 29 B.5 EddDataTypeInfoListT.................................................................................................................. 30 B.6 EddDataTypeInfoT ....................................................................................................................... 30 B.7 EddDataTypeT ............................................................................................................................. 31 B.8 TransferResultDataT .................................................................................................................... 32 Annex C (normative) Protocol Specific Definitions ............................................................................................. 33 C.1 General ....................................................................................................................................... 33 C.2 Header ........................................................................................................................................ 33 C.3 ProtocolIdentifier ........................................................................................................................ 33 C.4 Address ....................................................................................................................................... 33 C.5 Manufacturer .............................................................................................................................. 33 C.6 DeviceModel ............................................................................................................................... 34 C.7 DeviceRevision ............................................................................................................................ 34 C.8 SerialNumber .............................................................................................................................. 34 C.9 Tag .............................................................................................................................................. 34 C.10 ProfileId ...................................................................................................................................... 34 C.11 Version ....................................................................................................................................... 34 C.12 ProtocolSupportFile .................................................................................................................... 35 Bibliography ...................................................................................................................................................... 36 Table 1 – ProtocolSupportFile for FDI Device Packages ......................................................................................... 8 Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100 , Ed. 1.2.0, 23 Jul 2019 Page 5 of 36 Table 2 – Catalog values for profile devices .......................................................................................................... 8 Table 3 – Device identification information mapping............................................................................................ 9 Table 4 – Device revision information mapping .................................................................................................. 10 Table 5 – Protocol type GenericProtocol ............................................................................................................ 10 Table 6 – Inherited DeviceType property mapping ............................................................................................. 10 Table 7 – Generic Protocol Device Types identification attributes ...................................................................... 11 Table 8 – ConnectionPoint type for Generic Protocols ........................................................................................ 11 Table 9 – Method Connect arguments ................................................................................................................ 15 Table 10 – Method Disconnect arguments.......................................................................................................... 15 Table 11 – Method Transfer arguments .............................................................................................................. 15 Table 12 – EddDataTypeInfo DataType Structure ................................................................................................ 16 Table 13 – EddDataTypeEnum Values ................................................................................................................. 17 Table 14 – Method SetAddress arguments ......................................................................................................... 18 Table 15 – Connect service arguments ............................................................................................................... 19 Table 16 – Method Transfer arguments .............................................................................................................. 21 Table 17 – Method SetAddress arguments ......................................................................................................... 23 Table A.1 – Elements of GenericNetworkT.......................................................................................................... 26 Table A.2 – Attributes of GenericConnectionPointT ............................................................................................ 27 Table A.3 – Elements of GenericConnectionPointT ............................................................................................. 27 Table A.4 – Attributes of GenericIdentificationT................................................................................................. 27 Table B.1 – Attributes of TransferSendDataT ...................................................................................................... 29 Table B.2 – Elements of TransferSendDataT ....................................................................................................... 30 Table B.3 – Elements of EddDataTypeInfoListT ................................................................................................... 30 Table B.4 – Attributes of EddDataTypeInfoT ....................................................................................................... 30 Table B.5 – Enumerations of EddDataTypeT ....................................................................................................... 31 Table B.6– Attributes of TransferResultDataT ..................................................................................................... 32 Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100, Ed. 1.2.0, 23 Jul 2019 Page 6 of 36 1 Scope This part of IEC 62769 specifies an FDI profile of IEC 62769 for Generic Protocols. That means that all interfaces are defined and a host can add support for more protocols without changing its implementation. Nevertheless, there are some protocol-specific definitions (PSD) that need to be specified per protocol using this profile. Annex C specifies what PSD need to be defined per protocol so that FDI Device Packages, FDI Communication Packages for Gateways and FDI Communication Servers, FDI Communication Server, Gateways and Devices supporting such a protocol can work together in a host not aware about this specific protocol. NOTE: A host not using FDI communication server but a proprietary mechanism for communication needs to define its own means to deal with this profile to support several protocols without changing its implementation. This is specific to the proprietary way how the communication driver is bound to the host. 2 Normative References The following documents, in whole or in part, are normatively referenced in this document and are indispensable for its application. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies. IEC 61804 (all parts), Function blocks (FB) for process control and Electronic Device Description Language (EDDL) IEC 61804-3 1 , Function blocks (FB) for process control and Electronic Device Description Language (EDDL) – Part 3: EDDL syntax and semantics IEC 62541-100: OPC Unified Architecture – Part 100: OPC UA for Devices IEC 62769-2, Field Device Integration (FDI) – Part 2: FDI Client IEC 62769-4, Field Device Integration (FDI) – Part 4: FDI Packages IEC 62769-5, Field Device Integration (FDI) – Part 5: FDI Information Model IEC 62769-7, Field Device Integration (FDI) – Part 7: FDI Communication Devices 3 Terms, definitions, abbreviated terms and Acronyms 3.1 Terms and definitions For the purposes of this document, the terms and definitions given in IEC 61804 series, IEC 62541-100, IEC 62769-2, IEC 62769-4, IEC 62769-5, and IEC 62769-7 apply. 3.2 Abbreviations For the purposes of this specification, the following abbreviations apply. EDD Electronic Device Description EDDL Electronic Device Description Language (see IEC 61804) FDI Field Device Integration FCG FieldComm Group XML Extensible markup language (see REC-xml-20081126) 1 To be published. Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100 , Ed. 1.2.0, 23 Jul 2019 Page 7 of 36 4 Conventions 4.1 EDDL syntax This part of IEC 62769 specifies content for the EDD component that is part of FDI Communication Packages. The specification content using EDDL syntax uses the font Courier New . The EDDL syntax is used for method signature, variable, data structure and component declarations. 4.2 XML syntax XML syntax examples use font Courier New . The XML syntax is used to describe XML document schema. Example: <xs:simpleType name="ExampleType"> 4.3 Capitalizations The IEC 62769 series use capitalized terms to emphasize that these terms have a FDI specific meaning. Some of these terms using an acronym as a prefix for example • FDI Client, or • FDI Server. Some of these terms are compound terms such as: • Communication Servers, or • Profile Package. Parameter names or attributes are concatenated to a single term, where the original terms start in this term with a capital letter such as: • ProtocolSupportFile or • ProtocolType. Parameter names or attributes can also be constructed by using an underscore character to concatenate two or more terms such as: • DEVICE_REV or • DEVICE_MODEL 5 Profile for Generic Protocols 5.1 General This profile document to the FDI specification in IEC 62769 specifies the protocol specifics needed for FDI Packages describing Communication Servers, Gateways and Devices. For Communication Servers this document defines also protocol specifics as these need to be considered in the Communication Servers hosted Information Model. 5.2 Catalog profile 5.2.1 Protocol support file 5.2.1.1 FDI Device Package Protocol specific attachments are mentioned in the Package Catalog as defined in IEC 62769-5. As this annex defines a profile generically suitable for many protocols it does not define requirements for any protocol specific attachments. However, it does also not prevent the usage of protocol Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100, Ed. 1.2.0, 23 Jul 2019 Page 8 of 36 specific attachments. The PSD (see Annex C) define the requirements on the need of ProtocolSupportFiles for a specific protocol. However, the configuration of a device using an FDI Device Package shall not require the usage of a protocol specific attachment. Table 1 specifies the parameters of the ProtocolSupportFile in the FDI Device Package in case one or many are provided. Table 1 – ProtocolSupportFile for FDI Device Packages Parameter Description Content Type text/plain Root Namespace empty Source Relationship http://fdi-cooperation.com/2010/relationship/attachment-protocol Filename Not defined 5.2.1.2 FDI Communication Packages The same rules as for FDI Device Packages applies. 5.2.2 CommunicationProfile definition IEC 62769-4 defines a CommunicationProfileT string for the Catalog XML schema. The string is protocol specific and defined as ProfileIdentifier in the PSD (see Annex C). 5.2.3 Profile device A Profile Package shall provide the catalog values for profile devices, enabling the FDI Server to leverage a generic device description, if a specific one is not available. The definitions in Table 2 focus on catalog content that is vendor independent. Table 2 – Catalog values for profile devices Element Attribute Content PackageType — Profile Manufacturer — Empty DeviceModel — The format of the DeviceModel is protocol specific and details on the format are defined in the PSD (see Annex C). In order to assign a scan result with a profile package the ProfileId of the scan result shall be mapped to the DeviceModel of the profile package. 5.2.4 Protocol version information IEC 62769-4 defines an element type named InterfaceT for the Catalog XML schema. The element type InterfaceT contains an element named Version which is supposed to provide version information about the applied communication protocol profile. The value has to follow the IEC 62769-4 defined version information schema defined in the element type VersionT. The PSD (see Annex C) define the mapping of versions of a specific protocol to this field. 5.3 Associating a Package with a device 5.3.1 Device type identification mapping The purpose of device type identification mapping is to enable FDI host systems to compare the scan result against the topology representation in the Information Model. FDI host systems shall also be enabled to determine the FDI Device Package that fits for a device entry contained in the scan result. This will enable the user of an FDI host system to synchronize the Information Model with the actual installation. Next >