< PreviousField Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1 , Ed. 1.2.0, 09 Jul 2019 Page 9 of 31 Table 3 – Device type catalog mapping Catalog Element CP Mapping Manufacturer element of InterfaceT (IEC 62769-4) MANUFAC_ID String format “0xdddd” where dddd is the MANUFAC_ID number in hexadecimal format. DeviceModel element of InterfaceT (IEC 62769-4) DEVICE_TYPE String format “0xdddd” where dddd is the DEVICE_TYPE number in hexadecimal format. DeviceRevision element ListOfSupportedDeviceRevisionsT (IEC 62769-4) DEV_REV String format “x.0.0” where x is the DEV_REV in decimal format (no leading zeros). Device type revision mapping Each device type is identified according to 5.3.1. A device may also include a parameter COMPATIBILITY_REV from the Resource Block. This parameter specifies the lowest device version (DEV_REV) that a new device can replace while maintaining compatibility with a prior FDI Device Package. 5.4 Information Model mapping ProtocolType definition Table 4 defines the ProtocolType used to identify CP 1/1 network communications. Table 4 – ProtocolType Foundation_H1 definition Attribute Value BrowseName Foundation_H1 IsAbstract False References NodeClass BrowseName DataType TypeDefinition ModellingRule Inherits the properties of ProtocolType defined in IEC 62541-100. DeviceType mapping Each device type inherits the properties of the DeviceType. The mapping of the inherited properties from the DeviceType is defined in Table 5. Table 5 – Inherited DeviceType Property mapping Property CP Mapping SerialNumber DEV_ID (System Management Information Base) RevisionCounter -1 (not defined) Manufacturer String obtained from FDI package catalog (ManufacturerName from PackageT) Model String obtained from FDI package catalog (Name of DeviceTypeT, which is a localized name) DeviceManual entry text string (not supported) a DeviceRevision DEV_REV (Resource Block) SoftwareRevision SOFTWARE_REV (if available, otherwise empty string) HardwareRevision HARDWARE_REV (if available, otherwise empty string) a Device manuals are exposed as attachments of the FDI Device Package. Field Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1, Ed. 1.2.0, 09 Jul 2019 Page 10 of 31 FunctionalGroup Identification definition As defined in IEC 62541-100, each device representation in the FDI Server hosted Information Model shall contain a protocol specific FunctionalGroup called Identification. This FunctionalGroup organizes variables found in the Resource Block of the device type instance. The FunctionalGroup Identification for CP 1/1 is defined in Table 6. Table 6 – Identification Parameters BrowseName DataType Optional/Mandatory MANUFAC_ID UInt32 Mandatory DEV_TYPE UInt16 Mandatory DEV_REV UInt8 Mandatory HARDWARE_REV String Optional SOFTWARE_REV String Optional COMPATIBILITY_REV UInt8 Optional CAPABILITY_LEV UInt8 Optional ITK_VER UInt16 Mandatory SIF_ITK_VER UInt16 Optional FD_VER UInt16 Optional BlockType property mapping CP 1/1 device types are block-oriented according to IEC 62541-100. IEC 62769-5 specifies the mapping of EDDL BLOCK_A elements to block types and instances The BLOCK_A maps as a subtype of the topology element BlockType and inherits the properties per IEC 62541-100. The mapping of the inherited properties of the BlockType is specified in Table 7. Table 7 – Inherited BlockType property mapping Property CP Mapping (Block ParameterSet) RevisionCounter ST_REV ActualMode MODE_BLK.ACTUAL PermittedMode MODE_BLK.PERMITTED NormalMode MODE_BLK.NORMAL TargetMode MODE_BLK.TARGET Mapping to Block ParameterSet The ParameterSet is relative to each Block. The ParameterSet includes the CHARACTERISTICS records of the block and all the parameters found in the PARAMETERS, LOCAL_PARAMETERS and LIST_ITEMS. The browse name of the parameters found in the PARAMETERS and LOCAL_PARAMETERS is the member name in the respective lists. For example, ST_REV is the browse name of the Static Revision parameter. LIST_ITEMS do not have member names; therefore the browse name of each LIST in the LIST_ITEMS is the item name of the list. 5.5 Topology elements ConnectionPoint definition The ConnectionPoint type ConnectionPoint_Foundation_H1 shall be used to identify CP 1/1 network communication and is defined in Table 8. The ConnectionPoint_Foundation_H1 type is a sub type of the abstract type ConnectionPointType defined in IEC 62541-100. The Address property shall be the H1 node address. Field Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1 , Ed. 1.2.0, 09 Jul 2019 Page 11 of 31 The OrdinalNumber property reflects the position of the VFD within the SMIB VFD list. For devices exposing multiple FB VFDs, the OrdinalNumber property is mandatory to address the FB VFD. For devices with a single FB VFD, the OrdinalNumber property can be omitted. Devices exposed as instances of type DeviceType define their connection points as components. Hence Devices with multiple FB VFDs shall contain multiple Connection Points, one per FB VFD. The SIFConnection property denotes whether a safety instrumented function (SIF) connection is necessary or not according to the functional safety profile (IEC 61784-3:2010, Clause 6). CP 1/1 devices that implement the functional safety profile shall have a connection point as a component that has set this property to true. Devices supporting standard connections and SIF connections shall expose two Connections Points as components. Table 8 – ConnectionPointType ConnectionPoint_Foundation_H1 definition Attribute Value BrowseName ConnnectionPoint_Foundation_H1 IsAbstract False References NodeClass BrowseName DataType TypeDefinition ModellingRule Inherits the properties of ConnectionPointType defined in IEC 62541-100. HasProperty Variable Address Byte PropertyType Mandatory HasProperty Variable OrdinalNumber Int32 PropertyType Optional HasProperty Variable SIFConnection Boolean PropertyType Optional The ConnectionPoint type ConnectionPoint_Foundation_H1 shall be described by an EDD element contained in a Communication Device related FDI Package that can drive a CP 1/1 network. Actual ConnectionPoint_Foundation_H1 properties are declared by VARIABLE constructs grouped together in a COLLECTION named Foundation_H1_ConnectionPoint_Properties. COMPONENT ConnectionPoint_Foundation_H1 { LABEL "Foundation H1 Connection point"; CLASSIFICATION NETWORK_CONNECTION_POINT; CAN_DELETE FALSE; PROTOCOL Foundation_H1; CONNECTION_POINT Foundation_H1_ConnectionPoint_Properties; } VARIABLE Address { LABEL "H1 Node address"; HELP "Address of the H1 Node"; CLASS DEVICE; TYPE UNSIGNED_INTEGER (1) { MIN_VALUE 16; MAX_VALUE 255; } HANDLING READ & WRITE; } VARIABLE OrdinalNumber { LABEL "OrdinalNumber address property"; HELP "OrdinalNumber property to address the Function Block Application”; CLASS DEVICE; Field Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1, Ed. 1.2.0, 09 Jul 2019 Page 12 of 31 TYPE UNSIGNED_INTEGER (4); HANDLING READ & WRITE; } VARIABLE SIFConnection { LABEL "SIFConnection address property"; HELP "Connection point supports SIF Connections"; CLASS DEVICE; TYPE ENUMERATED (1) { {0,”NO_SIFCONNECTION”} , {1,”SIFCONNECTION”} } HANDLING READ & WRITE; } COLLECTION Foundation_H1_ConnectionPoint_Properties { LABEL "FF H1 Connection Point data"; MEMBERS { CONNECTION_POINT_ADDRESS, Address; CONNECTION_POINT_ORDINALNUMBER, OrdinalNumber; CONNECTION_POINT_SIFCONNECTION , SIFConnection; } } Communication Device definition According to IEC 62769-7 each FDI Communication Package shall contain an EDD element describing the device. The following EDDL source code is an example describing an FDI Communication Server. COMPONENT Foundation_H1_Communication_Server { LABEL "Foundation H1 communication server", PRODUCT_URI "urn:Fieldbus Foundation:Foundation H1 Communication Server"; CAN_DELETE TRUE; CLASSIFICATION NETWORK_COMPONENT; COMPONENT_RELATIONS { Foundation_H1_Communication_Device_Setup } } COMPONENT_RELATION Foundation_H1_Communication_Device_Setup { LABEL "Relation between Device and communication device"; RELATION_TYPE CHILD_COMPONENT; ADDRESSING { LinkId } COMPONENTS { Foundation_H1_Communication_Device{AUTO_CREATE 1;} } MINIMUM_NUMBER 1; MAXIMUM_NUMBER 4; } Field Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1 , Ed. 1.2.0, 09 Jul 2019 Page 13 of 31 VARIABLE LinkId { LABEL "Link Id address parameter of the Communication device"; HELP "Link Id address parameter of the Communication device"; CLASS DEVICE; TYPE UNSIGNED_INTEGER (2) { MIN_VALUE 4096; MAX_VALUE 65535; } HANDLING READ & WRITE; } Semantics of the EDDL constructs shown with the EDDL source code above are described in IEC 62769-7. The EDDL COMPONENT will be utilized by the FDI server and FDI Communication Server to create an instance of type CommunicationServerType as described in IEC 62769-7. The LinkId VARIABLE holds the address value for a Communication device instance. In the Information model the LinkId will be represented as an instance of BaseDataVariableType and as a component of the ParameterSet of the communication device. According to IEC 62769-7 each FDI Communication Package shall contain at least one EDD element describing at least one Communication Device component. The following EDDL source code is an example for a communication device. COMPONENT Foundation_H1_Communication_Device { LABEL "Foundation H1 communication device"; CAN_DELETE TRUE; CLASSIFICATION NETWORK_COMPONENT; COMPONENT_RELATIONS { Foundation_H1_Service_Provider_Relation } } COMPONENT_RELATION Foundation_H1_Service_Provider_Relation { LABEL "Foundation H1 communication service provider”; RELATION_TYPE CHILD_COMPONENT; COMPONENTS { Foundation_H1_Service_Provider{AUTO_CREATE 1;} } MINIMUM_NUMBER 1; MAXIMUM_NUMBER 16; } Semantics of the EDDL constructs shown with the EDDL source code above are described in IEC 62769-7. The EDDL COMPONENT will be utilized by the FDI server and FDI Communication Server to create an instance of type ServerCommunicationDeviceType as described in IEC 62769-7. An instance of ServerCommunicationDeviceType shall contain the following parameter(s) with its ParameterSet. Table 9 shows the definition of Communication device ParameterSet. Field Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1, Ed. 1.2.0, 09 Jul 2019 Page 14 of 31 Table 9 – Communication device ParameterSet definition Attribute Value BrowseName ParameterSet References NodeClass BrowseName DataType TypeDefinition ModellingRule See IEC 62541-100:–, 5.2. HasTypeDefinition ObjectType BaseObjectType HasComponent Variable LinkId UInt16 BaseDataVariableType Mandatory HasComponent Variable <ParameterIdentifier> BaseDataVariableType Mandatory- Placeholder The LinkId parameter is an addressing parameter distinguishing multiple H1 Links. If an FDI Communication Server supports multiple physical H1 Links these are mapped within the Information Model to multiple communication device instances. If the FDI Communication Server supports only one H1 Link it shall define only one communication device within the Information Model. The value of the variable can be set to 0 in this case. The EDD declaration of the variable LinkId is with the ADDRESSING attribute of the COMPONENT_RELATION of the FDI Communication Server definition (see 5.5.2) Communication service provider definition According to IEC 62769-7 each FDI Communication Package shall contain at least one EDD element describing at least one communication service provider component. The following EDDL source code is an example for a CP 1/1 communication service provider component. The component reference ConnectionPoint_Foundation_H1 corresponds to the related Connection Point definition in 5.5.1. COMPONENT Foundation_H1_Service_Provider { LABEL "Foundation H1 communication service provider"; CAN_DELETE FALSE; CLASSIFICATION NETWORK_COMMUNICATION_SERVICE_PROVIDER; COMPONENT_RELATIONS { Foundation_H1_Connection_Point_Relation } BYTE_ORDER BIG_ENDIAN; } COMPONENT_RELATION Foundation_H1_Service_Provider_Connection_Point_Relation { LABEL "Relation between communication service provider and connection point"; RELATION_TYPE CHILD_COMPONENT; ADDRESSING {Address} COMPONENTS { ConnectionPoint_Foundation_H1{ AUTO_CREATE 1;} } MINIMUM_NUMBER 1; MAXIMUM_NUMBER 1; } Semantics of the EDDL constructs shown with the EDDL source code above are described in IEC 62769-7. The EDDL COMPONENT will be utilized by the FDI server and FDI Communication Server to create an instance of type ServerCommunicationServiceType as described in IEC 62769-7. Field Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1 , Ed. 1.2.0, 09 Jul 2019 Page 15 of 31 Network definition According to IEC 62769-7 each FDI Communication Package shall contain at least one EDD element describing one Network for each of the protocols that are supported by the Communication Device. The definition supports the network topology engineering. COMPONENT Network_Foundation_H1 { LABEL "Foundation H1 Network"; CAN_DELETE TRUE; CLASSIFICATION NETWORK; PROTOCOL Foundation_H1 COMPONENT_RELATIONS { Foundation_H1_Network_Connection_Point_Relation } COMPONENT_RELATION Foundation_H1_Network_Connection_Point_Relation { LABEL "Relation between network and connection point"; RELATION_TYPE CHILD_COMPONENT; ADDRESSING {Address} COMPONENTS { ConnectionPoint_Foundation_H1 } MINIMUM_NUMBER 1; MAXIMUM_NUMBER 32; } Semantics of the EDDL constructs shown with the EDDL source code above are described in IEC 62769-7. The EDDL COMPONENT will be utilized by the FDI server and FDI Communication Server to create an instance of type NetworkType as described in IEC 62541-100. 5.6 Methods Methods for FDI Communication Servers General The FDI Communication Server shall implement the services according to the method signatures described in 5.6.1 and according to the Information Model. Field Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1, Ed. 1.2.0, 09 Jul 2019 Page 16 of 31 Connect Table 10 shows the Method Connect arguments. The connect transaction may need a significant amout of time since configuration of communication endpoints is involved. Ensure the OPC UA timeout is configured appropriately (e.g. 30 seconds). Signature: Connect( [in] ByteString CommunicationRelationId, [in] UInt16 LinkId [in] byte Address, [in] Int32 OrdinalNumber [in] Boolean SIFConnection [out] Int32 ServiceError); Table 10 – Method Connect arguments Argument Description CommunicationRelationId The argument value contains the nodeId of the Device ConnectionPoint representing the connection between a device and a physical network which is directly connected to the FDI Communication Server hardware. The nodeId allows finding the direct parent-child relation. LinkId The argument name shall match with the corresponding BrowseName of the Variable defined as a component of an instance of type ServerCommunicationDeviceType (refer to 5.5.2). The argument value is passed by the parent instance of a ServerCommunicationDeviceType. The value may be obtained by the Scan Method or may be directly configured. Address The argument name shall match with the corresponding attribute name defined for the ConnectionPoint which is described by a corresponding EDD element. The argument value holds the device’s node address. OrdinalNumber The argument name shall match with the corresponding attribute name defined for the ConnectionPoint which is described by a corresponding EDD element specified in 5.5.1. The argument value holds the OrdinalNumber. The OrdinalNumber is the position of the VFD within the SMIB VFD list. If a value 0 is passed with this argument the first FB VFD is selected. SIFConnection The argument name shall match with the corresponding attribute name defined for the ConnectionPoint which is described by a corresponding EDD element specified in 5.5.1. The argument value denotes whether a SIF Connection is necessary or not. ServiceError 0: OK / execution finished, connection established successfully -1: Connect Failed / canceled by caller -2: Call Failed / unknown service ID -3: Connect Failed / device not found -4: Connect Failed / invalid device node address -5: Connect Failed / invalid device identification -6: Connect Failed / invalid LinkId argument -7: Connect Failed / invalid OrdinalNumber argument NOTE IEC 62769-7 defines the argument AddressData of the Connect Method as an array of Variant. The address arguments defined with the table are represented as entries of the Variant array in the order they are specified above. IEC 62769-7 defines the argument DeviceInformation as a protocol specific argument list in which the Connect Method stores the resulting data. The DeviceInformation argument is defined as an array of Variant. The DeviceInformation argument is not used. Field Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1 , Ed. 1.2.0, 09 Jul 2019 Page 17 of 31 Disconnect Table 11 shows the Method Disconnect arguments. Signature: Disconnect( [in] ByteString CommunicationRelationId, [out] UInt32 ServiceError) Table 11 – Method Disconnect arguments Argument Description CommunicationRelationId The argument value contains the nodeId of the Device ConnectionPoint representing the connection between a device and a physical network which is directly connected to the FDI Communication Server hardware. The nodeId allows finding the direct parent-child relation. ServiceError 0: OK / disconnect finished successfully -1: Disconnect Failed / no existing communication relation -2: Disconnect Failed / invalid communication relation identifier Transfer Table 12 shows the Method Transfer arguments. Signature Transfer( [in] ByteString CommunicationRelationId, [in] String OPERATION, [in] String BlockTag, [in] UInt32 INDEX, [in] UInt32 SUB_INDEX, [in] Byte[] WriteData, [in] UInt32 ServiceId, [out] Byte[] ReadData, [out] Int32 ServiceError); Field Device Integration (FDI) – Part 101-1: Profiles – Foundation Fieldbus H1 RELEASED FCG TS62769-101-1, Ed. 1.2.0, 09 Jul 2019 Page 18 of 31 Table 12 – Method Transfer 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. OPERATION The argument value indicates the data transfer operation. The allowed values are “READ”, “WRITE” and “VIEW_READ”. BlockTag The argument denotes the Block tag of the block instance being addressed. The value can be obtained by the Method Scan. INDEX OPERATION indicates “READ” or “WRITE”: The argument denotes the relative index of the block parameter being addressed. The relative index can be calculated by iterating the parameters of a block within the FDI Information Model. A value of 0 addresses the block header record (described by the CHARACTERISTICS attribute within the EDD). The first parameter is addressed with the INDEX 1. OPERATION indicates “VIEW_READ”: The argument denotes the view identifier in a range from 1 to 4. For instance a value of 1 requests that View_1 shall be read. Multiple View_3 or View_4 objects are identified by the INDEX and the SUB_INDEX argument. SUB_INDEX OPERATION indicates “READ” or “WRITE”: The argument denotes the subindex of a member of the block parameter being addressed if the block parameter is of type RECORD or ARRAY. To address a simple parameter a value of 0 shall be passed with this argument. To address a specific member of a parameter of type RECORD or ARRAY a 1 relative value shall be passed with this argument. To address the parameter of type RECORD or ARRAY as a whole a value of 0 shall be passed with this argument. OPERATION indicates “VIEW_READ”: The argument addresses a View_3 or View_4 if multiple views of that type exist. The argument shall be 0 if there are no multiple views of the type addressed with the INDEX argument. Values of 1 up to the number of views of that type address the specific view. WriteData Write data encoded as byte array. Encoding of integers shall follow the rules defined in IEC 62541-6. The argument shall be ignored if OPERATION indicates a read transfer or a view read transfer. ServiceId The service transaction code establishes the relation between the service request and the corresponding response. ReadData With this argument the read data byte stream is returned as byte array. Encoding of integers shall follow the rules defined in IEC 62541-6. The argument shall be ignored if OPERATION indicates a write transfer. ServiceError 0: OK / execution finished -1: Transfer Failed / canceled by caller -2: Call Failed / unknown service ID -3: Transfer Failed / no existing communication relation. -4: Transfer Failed / invalid communication relation identifier -5: Transfer Failed / invalid sendData content -6: Transfer Failed / invalid receiveData format -7: Transfer Failed / parameter Check a -8: Transfer Failed / exceeds Parameter Limits a -9: Transfer Failed / wrong Mode for Request a -10: Transfer Failed / write is prohibited by write lock switch or write lock Function Block for SIS devices a Next >