< PreviousField Device Integration (FDI) – Part 150-1: Profiles – ISA100 WIRELESS RELEASED FCG TS62769-150-1 , Ed. 1.2.0, 23 Jul 2019 Page 19 of 26 5.6.1.5 GetPublishedData ISA100 Wireless alerts represent unsolicited messages as defined in FCG TS62769-7. Table 13 shows the Method GetPublishedData arguments. NOTE ISA100 Wireless uses the term alerts to refer to alarms and event messages. These are asynchronous, unsolicited messages that deliver state change notifications such as diagnostic conditions. These messages are mapped to the GetPublishData service. ISA100 Wireless also uses the term publish to refer to synchronous, network scheduled communication for process values. These published messages are not mapped to the GetPublishedData service. Signature: GetPublishedData ( [in] ByteString CommunicationRelationId, [out] UInt16 AppID, [out] UInt16 ObjectID, [out] Byte[] AlarmEventData, [out] UInt16 AlarmEventType, [out] DateTime TimeStamp, [out] Int32 ServiceError); Table 13 – Method GetPublishedData arguments Argument Description CommunicationRelationId The argument value contains the nodeId of the ConnectionPoint representing the connection between a device and a physical network within the Information Model. AppID The output argument denotes the ID of the application in ISA100 WIRELESS device being addressed. ObjectID The output argument denotes the ID of the Object in the application being addressed. AlarmEventData With this argument the alarm/event data byte stream is returned as a byte array. Encoding of integers shall follow the rules defined in IEC 62541-6. AlarmEventType The two bytes of this UInt16 denotes below information AlertClass – Byte 1 Bit 0 AlarmDirection – Byte 1 Bit 1 AlertCategory – Byte 1 Bit 2 to Bit 3 AlertPriority – Byte 1 Bit 4 to Bit 7 AlertType – Byte 2 Bit 0 to Bit 7 Refer to IEC 62734/Ed1 for further details TimeStamp Denotes the time the alarm or event was detected by the device. ServiceError 0: OK / execution finished -1: GetPublishedData Failed / canceled by caller -2: Call Failed / unknown service ID -3: GetPublishedData Failed / not supported -4: GetPublishedData Failed / no existing communication relation. -5: GetPublishedData Failed / invalid communication relation identifier -8: GetPublishedData Failed / no alarm/event data published. -9: GetPublishedData Failed / invalid AlarmEventType The FDI Server maintains an Information Model defined in IEC 62541-100. Hence topology elements representing an IS100ObjectType are separated from actual object instances. An instance called Objects of a ConfigurableObjectType is used to implement instantiation rules. Instantiation of objects is further detailed with FCG TS62769-5. According to the rules defined in FCG TS62769-5, the FDI Server needs to gather information from the UAPMO. ObjectIDandType in order to be able to create object instances. This information shall be provided by the Scan Method defined in 5.6.1.7. NOTE 1 FCG TS62769-7, defines the argument SendData of the Transfer Method as an array of Variant. The argument RequestID defined in the table is represented as entries of the Variant array in the order specified above. NOTE 2 FCG TS62769-7, defines the argument ReceiveData of the GetPublishedData Method as an array of Variant. The Field Device Integration (FDI) – Part 150-1: Profiles – ISA100 WIRELESS RELEASED FCG TS62769-150-1, Ed. 1.2.0, 23 Jul 2019 Page 20 of 26 arguments AppID, ObjectID, AlarmEventData and AlarmEventType defined in the table are represented as entries of the Variant array in the order they are specified above. 5.6.1.6 SetAddress This service is not supported in ISA100 Wireless. 5.6.1.7 Scan The Method signature specified in FCG TS62769-7 applies. The corresponding topologyScanResult schema is specified in A.2. 5.6.1.8 ResetScan The Method signature specified in FCG TS62769-7 applies. Methods for Gateways Not supported in this standard. Field Device Integration (FDI) – Part 150-1: Profiles – ISA100 WIRELESS RELEASED FCG TS62769-150-1 , Ed. 1.2.0, 23 Jul 2019 Page 21 of 26 Annex A (normative) Topology Scan result schema A.1 General The topology scan result schema specified in Annex A describes the ISA100 WIRELESS specific format Method Scan argument topologyScanResult . The XML document content and structure shall correspond to the Information Model designed concept to describe a topology in order to enable generic matching between physical devices connected to the network and the FDI Server hosted Information Model. A.2 Network The root element that is used to return the scan result of an ISA100 WIRELESS network. The XML schema for a Network element is: <xs:element name="Network" type="isa100:ISA100_WirelessNetworkT"/> A.3 ISA100_WirelessNetworkT A complex type that defines the network for ISA100 WIRELESS. The XML schema for ISA100_WirelessNetworkT element is: <xs:complexType name="ISA100_WirelessNetworkT"> <xs:sequence> <xs:element name="ConnectionPoint" type="isa100:ISA100_WirelessConnectionPointT" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> The elements of an ISA100_WirelessNetworkT type are described in Table A.1. Table A.1 – Elements of ISA100_WirelessNetworkT Element Description ConnectionPoint ISA100 WIRELESS connection point A.4 ISA100_WirelessConnectionPointT A complex type that defines the connection point for ISA100 WIRELESS. The XML schema for a ISA100_WirelessConnectionPointT type is: Field Device Integration (FDI) – Part 150-1: Profiles – ISA100 WIRELESS RELEASED FCG TS62769-150-1, Ed. 1.2.0, 23 Jul 2019 Page 22 of 26 <xs:complexType name="ISA100_WirelessConnectionPointT"> <xs:sequence> <xs:element name="Identification" type="isa100:ISA100_WirelessIdentificationT"> </xs:element> <xs:element name="Address" type="isa100:ISA100_WirelessAddressT"> </xs:element> </xs:sequence> </xs:complexType> The elements of a ISA100_WirelessConnectionPointT type are described in Table A.2. Table A.2 – Elements of ISA100_WirelessConnectionPointT Element Description Identification The element data holds the device type identification data. Compared to the Information Model (IEC 62769-5) the ConnectionPoint does not contain or refer to the device type identification data. But in order to support the FDI host system in finding the package that matches the connected device this schema associates the device type identification with the ConnectionPoint. Address The address element holds the specific information used to uniquely address the device in the network. A.5 ISA100_WirelessIdentificationT The element content corresponds to the "FunctionalGroup Identification". The XML schema for an ISA100_WirelessIdentificationT type is: <xs:complexType name=" ISA100_WirelessIdentificationT"> <xs:sequence> <xs:element minOccurs="1" maxOccurs="unbounded" name = "ObjIdentification" type="isa100:ISA100_WirelessObjIdentificationT" /> </xs:sequence> <xs:attribute name="DEV_TAG" type="xs:string" use="required"> </xs:attribute> <xs:attribute name="MANUFAC_ID" type="xs:unsignedInt" use="required"> </xs:attribute> <xs:attribute name="DEV_TYPE" type="xs:unsignedShort" use="required"> </xs:attribute> <xs:attribute name="DEV_REV" type="xs:unsignedShort" use="required"> </xs:attribute> <xs:attribute name="ITS_VERSION" type="xs:unsignedShort" use="required"> </xs:attribute></xs:complexType> The attributes of an ISA100_WirelessIdentificationT type are described in Table A.3. Table A.3 – Attributes of ISA100_WirelessIdentificationT Attribute Description ObjectIdentification List of ISA100 Object information that is currently activated in the device. DEV_TAG Tag of the device Field Device Integration (FDI) – Part 150-1: Profiles – ISA100 WIRELESS RELEASED FCG TS62769-150-1 , Ed. 1.2.0, 23 Jul 2019 Page 23 of 26 MANUFAC_ID See Table 7 DEV_TYPE See Table 7 DEV_REV See Table 7 ITS_VERSION See Table 7 A.6 ISA100_WirelessAddressT A complex type that defines the address structure for ISA100 WIRELESS. The XML schema for a ISA100_WirelessAddressT type is: <xs:complexType name="ISA100_WirelessAddressT "> <xs:sequence> <xs:element name="IPv6Address"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:pattern value="(([A-Fa-f0-9]{1,4}:){7}[A-Fa-f0- 9]{1,4})"/> </xs:restriction> </xs:simpleType> </xs:element> </xs:sequence> </xs:complexType> A.7 ISA_WirelessObjIdentificationT A complex type that defines the object instance identification for an ISA100 WIRELESS device. The XML schema for a ISA100_WirelessObjIdentificationT type is: <xs:complexType name="ISA100_WirelessObjIdentificationT"> <xs:attribute name="OBJ_ID" type="xs:unsignedShort" use="required"> </xs:attribute> <xs:attribute name="OBJ_TYPE" type="xs:unsignedShort" use="required"> </xs:attribute> <xs:attribute name="OBJ_SUBTYPE" type="xs:unsignedShort" use="required"> </xs:attribute> <xs:attribute name=”OBJ_VENDOR_SUBTYPE” type=”xs:unsignedShort” use=”required”/> </xs:complexType> Table A.4 – Attributes of ISA100_WirelessObjIdentificationT Attribute Description OBJ_ID Unique identifier of the Object in UAP. OBJ_TYPE Type of the Object in UAP. OBJ_SUBTYPE Profile Sub type of the Object. OBJ_VENDOR_SUBTYPE Vendor Sub type of the Object. Field Device Integration (FDI) – Part 150-1: Profiles – ISA100 WIRELESS RELEASED FCG TS62769-150-1, Ed. 1.2.0, 23 Jul 2019 Page 24 of 26 Annex B (normative) Transfer service parameters B.1 General Direct Access Services specified in FCG TS62769-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 FCG TS62769-6 defined interface IDirectAccess corresponds to the FCG TS62769-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="isa100: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="isa100: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:attribute name="OPERATION" type="isa100:OperationT" use="required"/> <xs:attribute name="OBJ_ID" type="xs:unsignedShort" use="required"/> <xs:attribute name="ATTR_ID" type="xs:unsignedShort " use="required"/> <xs:attribute name="ATTR_INDEX" type="xs:unsignedShort " use="optional"/> <xs:attribute name="DATA" type="xs:hexBinary" use="optional"/> </xs:complexType> The attributes of a TransferSendDataT type are described in Table B.1. Table B.1 – Attributes of TransferSendDataT Attribute Description OPERATION Data transfer operation OBJ_ID Unique identifier of the Object in UAP. Field Device Integration (FDI) – Part 150-1: Profiles – ISA100 WIRELESS RELEASED FCG TS62769-150-1 , Ed. 1.2.0, 23 Jul 2019 Page 25 of 26 ATTR_ID Unique identifier of the Attribute in the Object. ATTR_INDEX Sub index of the Attribute in case of aggregate data type attribute DATA Mandatory attribute for data to be transferred in the service WRITE operation. This attribute is not used for the READ. This attribute may or may not be used for EXCUTE service operation. B.5 OperationT A simple type that defines service operations. The XML schema for an OperationT enumeration type is: <xs:simpleType name="OperationT"> <xs:restriction base="xs:string"> <xs:enumeration value="READ"/> <xs:enumeration value="WRITE"/> <xs:enumeration value="EXECUTE"/> </xs:restriction> </xs:simpleType> The enumeration values of a OperationT enumeration type are described in Table B.2. Table B.2 – Enumerations of OperationT Enumeration Description READ Read Service according to IEC 62734 as defined in 12.22.2.6 WRITE Write Service according to IEC 62734 as defined in 12.22.2.7 EXECUTE Execute Service according to IEC 62734 as defined in 12.22.2.8 B.6 TransferResultDataT A complex type that defines the service parameter data format that shall be applied to Transfer defined recievedData return value. The XML schema for a TransferResultDataT type is: <xs:complexType name="TransferResultDataT"> <xs:attribute name="DATA" type="xs:hexBinary" use="optional"/> </xs:complexType> The attributes of a TransferResultDataT type are described in Table B.3. Table B.3 – Attributes of TransferResultDataT Attribute Description DATA Data received after the service operation. This attribute is required for the READ and EXECUTE service operations. Bibliography IEC 62734/Ed1: Industrial networks - Wireless communication network and communication profiles - ISA 100.11a Field Device Integration (FDI) – Part 150-1: Profiles – ISA100 WIRELESS RELEASED FCG TS62769-150-1, Ed. 1.2.0, 23 Jul 2019 Page 26 of 26 IEC 61804 (all parts), Function blocks (FB) for process control and Electronic Device Description Language (EDDL) IEC 62541-100:–, OPC Unified Architecture – Part 100: OPC UA for Devices FCG TS62769-2, Field Device Integration (FDI) – Part 2: FDI Client 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-6, Field Device Integration (FDI) – Part 6: FDI Technology Mapping FCG TS62769-7, Field Device Integration (FDI) – Part 7: FDI Communication Devices 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 >