Field Device Integration (FDI) – Part 109-1: Profiles - HART® and WirelessHART® FCG TS62769-109-1 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 109-1: Profiles - HART® and WirelessHART® RELEASED FCG TS62769-109-1 , Ed. 1.2.0, 23 Jul 2019 Page 1 of 43 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 109-1: Profiles - HART® and WirelessHART® RELEASED FCG TS62769-109-1, Ed. 1.2.0, 23 Jul 2019 Page 2 of 43 Revision Log Version Date Change Note / History / Reason 0.9.0 5 Nov 2013 Initial Public Version 1.0 31 July 2014 First Release 1.0.3 26 Feb 2015 Incorporate Comments from IEC 1.0.4 22 Dec 2015 Update Table 6 to specify human readable string names to be used for Manufacturer and Model properties. 1.0.5 15 Mar 2016 Reformat to FCG template Change description of communicationProfileT from enum to string 1.1.0 25 Aug 2016 New document template 1.1.0.1 16 Oct 2016 Move protocol specific command information from table 6 to A.1 Changed max hardware revision in IdentificationT Schema from 32 to 31. 1.1.0.2 28 Oct 2016 Tables 13, 14, 18, and 19 editorial update to service error 0 description. No need to specify where the result is returned in these tables. 1.1.0.3 19 Dec 2016 New document template 1.1.0.4 24 Feb 2017 New cover page and trademark information 1.2.0.3 25 Sept 2018 Added Device Information Files as mandatory protocol support file. Added normative reference to FCG AG21073, HART DeviceInfo Editorial Changes 1.2.0.4 23 July 2019 Editorial Changes (Balloting Comments 908, 998) Field Device Integration (FDI) – Part 109-1: Profiles - HART® and WirelessHART® RELEASED FCG TS62769-109-1 , Ed. 1.2.0, 23 Jul 2019 Page 3 of 43 TABLE OF CONTENTS 1 Scope ........................................................................................................................................................... 6 2 Normative references .................................................................................................................................. 6 3 Terms, definitions, abbreviated terms and acronyms ................................................................................... 6 Terms and definitions .................................................................................................................... 6 Abbreviated terms and acronyms .................................................................................................. 6 4 Conventions ................................................................................................................................................. 7 EDDL syntax .................................................................................................................................. 7 XML syntax .................................................................................................................................... 7 Capitalizations .............................................................................................................................. 7 5 Profile for CP 9/1 (HART ® ) or CP 9/2 (WirelessHART ® ) ................................................................................... 7 General ......................................................................................................................................... 7 Catalog profile .............................................................................................................................. 7 Protocol support file ................................................................................................... 7 CommunicationProfile definition ................................................................................ 8 Profile device ............................................................................................................. 8 Protocol version information ...................................................................................... 9 Associating a Package with a CP 9/1 device ................................................................................... 9 Device type identification mapping ............................................................................. 9 Device type revision mapping ..................................................................................... 9 Information Model mapping .......................................................................................................... 9 ProtocolType definition .............................................................................................. 9 DeviceType mapping ................................................................................................. 10 FunctionalGroup Identification definition ................................................................. 10 Topology elements ...................................................................................................................... 11 ConnectionPoint definition ....................................................................................... 11 5.5.1.1 General ................................................................................................................ 11 5.5.1.2 HART_TP5, HART_TP6, HART_TP7 ......................................................................... 11 5.5.1.3 HART_IP ............................................................................................................... 13 5.5.1.4 HART_TDMA ......................................................................................................... 15 Communication Device definition ............................................................................. 17 Communication service provider definition .............................................................. 18 Network definition ................................................................................................... 19 Methods ..................................................................................................................................... 20 Methods for FDI Communication Servers .................................................................. 20 5.6.1.1 General ................................................................................................................ 20 5.6.1.2 Connect ................................................................................................................ 20 5.6.1.3 Disconnect ........................................................................................................... 21 5.6.1.4 Transfer ................................................................................................................ 21 5.6.1.5 GetPublishedData ................................................................................................. 23 5.6.1.6 SetAddress ........................................................................................................... 24 Field Device Integration (FDI) – Part 109-1: Profiles - HART® and WirelessHART® RELEASED FCG TS62769-109-1, Ed. 1.2.0, 23 Jul 2019 Page 4 of 43 5.6.1.7 Scan ..................................................................................................................... 25 5.6.1.8 ResetScan ............................................................................................................. 25 Methods for Gateways ............................................................................................. 25 5.6.2.1 General ................................................................................................................ 25 5.6.2.2 Connect ................................................................................................................ 25 5.6.2.3 Disconnect ........................................................................................................... 26 5.6.2.4 Transfer ................................................................................................................ 26 5.6.2.5 GetPublishedData ................................................................................................. 28 5.6.2.6 SetAddress ........................................................................................................... 29 5.6.2.7 Scan ..................................................................................................................... 30 5.6.2.8 ScanNext .............................................................................................................. 32 Annex A (normative) Topology scan schema ...................................................................................................... 33 A.1 General ....................................................................................................................................... 33 A.2 IdentificationType ....................................................................................................................... 33 A.3 AddressTypeTP ............................................................................................................................ 35 A.4 AddressTypeIP ............................................................................................................................. 37 A.5 AddressTypeTDMA ...................................................................................................................... 37 A.6 AddressType ............................................................................................................................... 38 A.7 ConnectionPointType .................................................................................................................. 39 A.8 NetworkType ............................................................................................................................... 39 A.9 Network ...................................................................................................................................... 40 Annex B (normative) Transfer service parameters ............................................................................................. 41 B.1 General ....................................................................................................................................... 41 B.2 receiveData ................................................................................................................................. 41 B.3 sendData ..................................................................................................................................... 41 B.4 TransferResultDataT .................................................................................................................... 41 B.5 TransferSendDataT ...................................................................................................................... 42 Bibliography ...................................................................................................................................................... 43 Table 1 – Device Information Files ....................................................................................................................... 8 Table 2 – CommunicationProfile definition .......................................................................................................... 8 Table 3 – Catalog values for profile devices .......................................................................................................... 8 Table 4 – Protocol Version Information ................................................................................................................ 9 Table 5 – Device type catalog mapping ................................................................................................................ 9 Table 6 – ProtocolType HART definition ............................................................................................................. 10 Table 7 – Inherited DeviceType Property mapping ............................................................................................. 10 Table 8 – Identification parameters ................................................................................................................... 10 Table 9 – ConnectionPointType HART_TP definition ........................................................................................... 12 Table 10 – ConnectionPointType HART_IP Definition .......................................................................................... 14 Table 11 – ConnectionPointType HART_TDMA Definition ................................................................................... 16 Field Device Integration (FDI) – Part 109-1: Profiles - HART® and WirelessHART® RELEASED FCG TS62769-109-1 , Ed. 1.2.0, 23 Jul 2019 Page 5 of 43 Table 12 – Method Connect arguments .............................................................................................................. 20 Table 13 – Method Disconnect arguments.......................................................................................................... 21 Table 14 – Method Transfer arguments .............................................................................................................. 23 Table 15 – Method GetPublishedData arguments ............................................................................................... 23 Table 16 – Method SetAddress arguments ......................................................................................................... 24 Table 17 – Method Connect arguments .............................................................................................................. 25 Table 18 – Method Disconnect arguments.......................................................................................................... 26 Table 19 – Method Transfer arguments .............................................................................................................. 27 Table 20 – Method GetPublishedData arguments ............................................................................................... 29 Table 21 – Method SetAddress arguments ......................................................................................................... 30 Table A.1 – Attributes of IdentificationT ............................................................................................................ 35 Table A.2 – Elements of AddressTypeTP ............................................................................................................. 36 Table A.3 – Elements of AddressTypeIP .............................................................................................................. 37 Table A.4 – Elements of AddressTypeTDMA ....................................................................................................... 38 Table A.5 – Elements of AddressT ...................................................................................................................... 38 Table A.6 – Elements of ConnectionPointT ......................................................................................................... 39 Table A.7 – Elements of NetworkT ..................................................................................................................... 39 Table B.1 – Attributes of TransferResultDataT .................................................................................................... 41 Table B.2 – Attributes of TransferSendDataT ...................................................................................................... 42 Field Device Integration (FDI) – Part 109-1: Profiles - HART® and WirelessHART® RELEASED FCG TS62769-109-1, Ed. 1.2.0, 23 Jul 2019 Page 6 of 43 1 Scope This part of FCG TS62769 specifies an FDI profile of IEC 62769 for IEC 61784-1_CP 9/1 (HART ® ) 1 and IEC 61784-1_CP 9/2 (WirelessHART ® ). 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 62541-100, OPC Unified Architecture Specification – Part 100: OPC Device Interface FCG AG21073, HART DeviceInfo – Technical Overview; to be released FCG TS62769-4, Field device integration (FDI) – Part 4: FDI Packages FCG TS62769-5, Field device integration (FDI) – Part 5: FDI Information Model FCG TS62769-7, Field device integration (FDI) – Part 7: Communication Devices 3 Terms, definitions, abbreviated terms and acronyms Terms and definitions For the purposes of this document, the terms and definitions given in IEC 62541-100, IEC 62769-4, IEC 62769-5 and IEC 62769-7 apply. Abbreviated terms and acronyms For the purposes of this document, the following abbreviations apply: CP Communication profile (see IEC 61784-1 or IEC 61784-2) CPF Communication profile family (see IEC 61784-1 or IEC 61784-2) EDD Electronic device description (see IEC 61804) EDDL Electronic device description language (see IEC 61804) FDI Field device integration FSK Frequency-Shift-Keying HCF HART Communication Foundation ID Identification IM Information Model IP Internet protocol PDU Protocol data unit PSK Phase-Shift-Keying TCP Transmission Control Protocol (see IETF RFC 793) UDP User Datagram Protocol (see IETF RFC 768) XML Extended markup language Field Device Integration (FDI) – Part 109-1: Profiles - HART® and WirelessHART® RELEASED FCG TS62769-109-1 , Ed. 1.2.0, 23 Jul 2019 Page 7 of 43 4 Conventions EDDL syntax This document specifies content for the EDD component that is part of FDI Communication Packages. EDDL syntax uses the font Courier New . EDDL syntax is used for method signature, variable, data structure and component declarations. XML syntax XML syntax examples use font Courier New . The XML syntax is used to describe XML document schema. Example: <xs:simpleType name="ExampleT"> Capitalizations The FCG TS62769 series uses capitalized terms to emphasize that these terms have an 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: • FDI 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 like: • PROFILE_ID or • HART_Network 5 Profile for CP 9/1 (HART ® ) or CP 9/2 (WirelessHART ® ) General This profile document to the FDI specification in FCG TS62769 selects the protocol specifics needed for FDI Packages describing FDI Communication Servers, gateways and devices. Catalog profile Protocol support file Device information files provide metadata for the dynamic runtime data that is supplied by the device. This metadata is a subset of information that is contained in the EDD. The device information files may be extracted from the package by light-weight gateway or server implementations to exchange runtime device information with minimal implementation overhead. Device information files do not replace the need for the EDD part because device information files only contain a subset of the information from the EDD, and do not provide any user-interface elements. Field Device Integration (FDI) – Part 109-1: Profiles - HART® and WirelessHART® RELEASED FCG TS62769-109-1, Ed. 1.2.0, 23 Jul 2019 Page 8 of 43 The formats of the Device Information Files are described in Table 1. Table 1 – Device Information Files Part Content Content Type Not specified here Root Namespace Not specified here Source Relationship http://fdi-cooperation.com/2010/relationships/attachment-protocol Filename Not specified here The Device Information Files are specified in FCG AG21073. CommunicationProfile definition FCG TS62769-4 defines a CommunicationProfileT string type for the Catalog XML schema. Table 2 defines the CP 9/1 specific values for this enumeration. Table 2 – CommunicationProfile definition CommunicationProfile Description hart_fsk CP 9/1 device type that supports an FSK physical layer (Frequency-Shift-Keying on a pair of wires) hart_psk CP 9/1 device type that supports a PSK physical layer (Phase-Shift-Keying on a pair of wires). Devices supporting PSK are required to also inherently support FSK, and therefore PSK will always be used only in combination with at least FSK. hart_wirelesshart CP 9/2 device type that supports a wireless physical layer (communication between device and gateway). hart_ip CP 9/1 device type that supports Internet Protocol (these devices support both TCP and UDP). hart_rs485 CP 9/1 device type that supports EIA-485 digital communication. hart_ir CP 9/1 device type that supports an Infrared physical layer (designed to be transparent to FSK masters – included only as information to indicate that the device supports IR connection). NOTE It is possible for a single CP 9/1 device to support more than one CP. 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 3 focus on catalog content that is vendor independent. Table 3 – Catalog values for profile devices Element Attribute Content PackageType — Profile DeviceModel — Empty Manufacturer — Empty Next >