< PreviousField Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100 , Ed. 1.2.0, 23 Jul 2019 Page 29 of 36 Annex B (normative) Transfer service parameters B.1 General Direct Access Services specified in IEC 62769-2 enable the User Interface Plug-in (UIP) to directly exchange data with the device. Direct data exchange means that data exchanged between a device and a UIP may not be reflected in the Information Model. The IEC 62769-5 defined interface IDirectAccess corresponds to the IEC 62769-2 specified Direct Access Services. Interface IDirectAccess defined functions BeginTransfer and EndTransfer need to convey protocol specific information. The protocol specifics shall be captured in an XML document. B.2 sendData The element described in the following contains data to be submitted through the IDirectAccess function BeginTransfer defined argument sendData. The XML schema for a sendData element is: <xs:element name="sendData" type="GP:TransferSendDataT"/> B.3 receiveData The element described in the following contains data that is returned through the IDirectAccess function EndTransfer defined return value. The XML schema for a receiveData element is: <xs:element name="receiveData" type="GP:TransferResultDataT"/> B.4 TransferSendDataT A complex type that defines the service parameter data format that shall be applied to Transfer defined argument sendData. The XML schema for a TransferSendDataT type is: <xs:complexType name="TransferSendDataT"> <xs:sequence> <xs:element name="RequestDataTypes" type="GP:EddDataTypeInfoListT"/> <xs:element name="ResponseDataTypes" type="GP:EddDataTypeInfoListT"/> </xs:sequence> <xs:attribute name="Header" type="xs:string" use="required"/> <xs:attribute name="RequestData" type="xs:hexBinary" use="required"/> </xs:complexType> The attributes of a TransferSendDataT type are described in Table B.1. Table B.1 – Attributes of TransferSendDataT Attribute Description Header The attribute corresponds to the Transfer method argument Header. RequestData The attribute corresponds to the Transfer method argument RequestData. Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100, Ed. 1.2.0, 23 Jul 2019 Page 30 of 36 The elements of a TransferSendDataT type are described in Table B.2. Table B.2 – Elements of TransferSendDataT Element Description RequestDataTypes The element corresponds to the Transfer method argument RequestDataTypes ResponseDataTypes The element corresponds to the Transfer method argument ResponseDataTypes B.5 EddDataTypeInfoListT List of EDD data type information. The XML schema for a EddDataTypeInfoListT type is: <xs:complexType name="EddDataTypeInfoListT"> <xs:sequence> <xs:element name="EddDataTypeInfo" type="GP:EddDataTypeInfoT" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> The elements of a EddDataTypeInfoListT type are described in Table B.3. Table B.3 – Elements of EddDataTypeInfoListT Element Description EddDataTypeInfo Describes an individual EDD data type and its size. B.6 EddDataTypeInfoT Describes an individual EDD data type and its size. The XML schema for a EddDataTypeInfoT type is: <xs:complexType name="EddDataTypeInfoT"> <xs:attribute name="EddDataType" type="GP:EddDataTypeT" use="required"/> <xs:attribute name="Size" type="xs:nonNegativeInteger" use="required"/> </xs:complexType> The attributes of a EddDataTypeInfoT type are described in Table B.4. Table B.4 – Attributes of EddDataTypeInfoT Attribute Description EddDataType The EddDataType used. Size The size of the eddDataType. It shall always be provided, even if not explicitly specified by the EDD. In that case the default value for that data type shall be provided. For data types where no size can be defined (e.g. BOOLEAN) the value shall be set to 0. Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100 , Ed. 1.2.0, 23 Jul 2019 Page 31 of 36 B.7 EddDataTypeT A simple type that defines the possible EDD data types. The XML schema for a EddDataTypeT enumeration type is: <xs:simpleType name="EddDataTypeT"> <xs:restriction base="xs:string"> <xs:enumeration value="BOOLEAN"/> <xs:enumeration value="DOUBLE"/> <xs:enumeration value="FLOAT"/> <xs:enumeration value="INTEGER"/> <xs:enumeration value="UNSIGNED_INTEGER"/> <xs:enumeration value="DATE"/> <xs:enumeration value="DATE_AND_TIME"/> <xs:enumeration value="DURATION"/> <xs:enumeration value="TIME"/> <xs:enumeration value="TIME_VALUE"/> <xs:enumeration value="BIT_ENUMERATED"/> <xs:enumeration value="ENUMERATED"/> <xs:enumeration value="ASCII"/> <xs:enumeration value="BITSTRING"/> <xs:enumeration value="EUC"/> <xs:enumeration value="OCTET"/> <xs:enumeration value="PACKED_ASCII"/> <xs:enumeration value="PASSWORD"/> <xs:enumeration value="VISIBLE"/> </xs:restriction> </xs:simpleType> The enumeration values of a EddDataTypeT enumeration type are described in Table B.5. Table B.5 – Enumerations of EddDataTypeT Enumeration Description BOOLEAN Data type as defined in IEC 61804-3. DOUBLE Data type as defined in IEC 61804-3. FLOAT Data type as defined in IEC 61804-3. INTEGER Data type as defined in IEC 61804-3. UNSIGNED_INTEGER Data type as defined in IEC 61804-3. DATE Data type as defined in IEC 61804-3. DATE_AND_TIME Data type as defined in IEC 61804-3. DURATION Data type as defined in IEC 61804-3. TIME Data type as defined in IEC 61804-3. TIME_VALUE Data type as defined in IEC 61804-3. BIT_ENUMERATED Data type as defined in IEC 61804-3. ENUMERATED Data type as defined in IEC 61804-3. ASCII Data type as defined in IEC 61804-3. BITSTRING Data type as defined in IEC 61804-3. EUC Data type as defined in IEC 61804-3. Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100, Ed. 1.2.0, 23 Jul 2019 Page 32 of 36 OCTET Data type as defined in IEC 61804-3. PACKED_ASCII Data type as defined in IEC 61804-3. PASSWORD Data type as defined in IEC 61804-3. VISIBLE Data type as defined in IEC 61804-3. B.8 TransferResultDataT A complex type that defines the service parameter data format that shall be applied to Transfer defined receivedData return value. <xs:complexType name="TransferResultDataT"> <xs:attribute name="ResponseData" type="xs:hexBinary" use="required"/> <xs:attribute name="RESPONSE_CODES" type="xs:hexBinary" use="required"/> </xs:complexType> The attributes of a TransferResultDataT type are described in Table B.6. Table B.6– Attributes of TransferResultDataT Attribute Description ResponseData The attribute corresponds to the Transfer method argument ResponseData. RESPONSE_CODES The attribute corresponds to the Transfer method argument RESPONSE_CODES. Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100 , Ed. 1.2.0, 23 Jul 2019 Page 33 of 36 Annex C (normative) Protocol Specific Definitions C.1 General This annex defines what the PSDs need to define per protocol. C.2 Header The HEADER attribute is used in an EDD to define the addressing of a COMMAND. When using this annex each EDD needs to comply with the profile for generic protocol extensions defined in IEC 61804-3 and define COMMANDs in the EDD using the HEADER as addressing in order to access the corresponding VARIABLEs in the device. The HEADER consists of a string. Per protocol it needs to be defined how the protocol-specific addressing is mapped to the HEADER attribute. Examples of protocol-specific addressing is the COMMAND number in HART or SLOT and INDEX in Profibus. The first communication service treating this string shall validate the string according to its format defined in the PSD. C.3 ProtocolIdentifier The ProtocolIdentifier is used in the Package Catalog defined in IEC 62769-4 (called CommunicationProfile) as well as in the EDD for Gateways defined in IEC 61804-3 (called PROTOCOL) to identify the protocol. It is represented as a string in the EDD and in the Package Catalog. In order to have a unique identifier per protocol the ProtocolIdentifier needs to be defined once per protocol and a URI syntax should be used in order to guarantee the uniqueness of the string. C.4 Address The address uniquely identifies a device in a network segment and is provided in the scan result as well as connect and set address methods of an FDI Communication Server or a Gateway. This profile uses an OPC UA String, XML string or an EDD EUC or DD_STRING in EDD Methods as data structure in order to allow high flexibility on the actual used protocol-specific address as well as an easy way to edit an address by the user. For each protocol the size of the EUC need to be defined, the details on how to structure the data in the data type as well as what corresponding protocol-specific addressing is used and whether the set address method can be supported. If set address is not supported Gateways and Communication Server shall not provide this method at all. C.5 Manufacturer The Manufacturer identifies the manufacturer of a device and is provided in the scan result and in the OPC UA information model and in the Package Catalog. This profile uses an XML string, an EDD EUC, or an OPC UA String data type as data structure. For each protocol the mapping to a protocol-specific representation needs to be defined as well as how to get the information when scanning a network. The Manufacturer is used to identify corresponding FDI Device Packages which also contain the Manufacturer information. An EDD also contains manufacturer information, in MANUFACTURER. Unless defined differently in the PSD, MANUFACTURER shall be set to all bits in the integer value to one, and the MANUFACTURER_EXT shall contain the manufacturer string as defined in the PSD. Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100, Ed. 1.2.0, 23 Jul 2019 Page 34 of 36 C.6 DeviceModel The DeviceModel identifies the type of device and is provided in the scan result and in the OPC UA information model and in the Package Catalog. This profile uses an XML string, an EDD EUC, or an OPC UA String data type as data structure. For each protocol the mapping to a protocol-specific representation needs to be defined as well as how to get the information when scanning a network. The DeviceModel is used to identify corresponding FDI Device Packages which also contain the DeviceModel information. An EDD also contains information about the type of device, in DEVICE_TYPE. Unless defined differently in the PSD, the DEVICE_TYPE shall be set to all bits in the integer value to one. C.7 DeviceRevision The DeviceRevision allows to determine the compatibility between an FDI Device Package and a Device and is optionally provided in the scan result and in the OPC UA information model. This profile uses an XML unsignedShort, an EDD UNSIGNED_INTEGER (2), or an OPC UA UInt16 data type as data structure. For each protocol it needs to be specified whether the DeviceRevision is supported and if it is supported the mapping to a protocol-specific representation needs to be defined as well as how to get the information when scanning a network. C.8 SerialNumber The SerialNumber uniquely identifies a device. It is optionally provided in the scan result and in the OPC UA information model. This profile uses an XML String, an EDD EUC or an OPC UA String data type as data structure. For each protocol it needs to be specified whether the SerialNumber is supported and if it is supported the mapping to a protocol-specific representation needs to be defined as well as how to get the information when scanning a network and the size of the EUC. The SerialNumber can be used by Host applications to identify a device even if it has been moved in the network or is accessible via different network paths. C.9 Tag The Tag provides a unique name for a device and is optionally provided in the scan result and in the OPC UA information model. This profile uses an XML String, an EDD EUC, or an OPC UA String data type as data structure. For each protocol it needs to be specified whether the Tag is supported and if it is supported the mapping to a protocol-specific representation needs to be defined as well as how to get the information when scanning a network and the size of the EUC. C.10 ProfileId The ProfileId identifies the supported profile of a device. It is optionally provided in the scan result and in the OPC UA information model. This profile uses an XML String, an EDD EUC, or an OPC UA String data type as data structure. For each protocol it needs to be specified whether the ProfileId is supported and if it is supported the mapping to a protocol-specific representation needs to be defined as well as how to get the information when scanning a network and the size of the EUC. C.11 Version The protocol version is used in the FDI Package Catalog to define which version of a protocol is supported by the FDI Package. It contains a major, minor and revision number. The mapping of protocol versions to this schema needs to be defined per protocol. Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100 , Ed. 1.2.0, 23 Jul 2019 Page 35 of 36 C.12 ProtocolSupportFile The ProtocolSupportFiles can be provided by an FDI Package. Whether such files are required need to be defined per protocol, including what type of files need to be supported. Field Device Integration (FDI) – Part 100: Profiles – Generic Protocols RELEASED FCG TS62769-100, Ed. 1.2.0, 23 Jul 2019 Page 36 of 36 Bibliography REC-xml-20081126, Extensible Markup Language (XML) 1.0 (Fifth Edition) – W3C Recommendation 26 November 2008, available at http://www.w3.org/TR/xml/ ___________ Next >