FDI Package File Name Convention 

To understand how the versioning of your FDI Package is affected by its contents, first, we need to show the naming conventions used for all FDI Packages. 


The Version appears in the file name, as per Field Device Integration (FDI) – Part 4: FDI Packages Annex A.


The FDI-IDE project settings need to be used to set the "Version" of the FDI Package. The following image illustrates how the settings correspond to the name of the package.



Since the FDI Package contains device support file(s) which inherit the Device Revision and DD Revision from the source code as their file name, the same method can be applied to the FDI Package.


Set Version = <Device Revision/major>.<DD Revision/minor>.<FDI Package Revision/revision>


Note: the values of <major>.<minor>.<revision> are limited to 00-99. Use the decimal equivalent to any hexadecimal values used for the Device Revision or DD Revision.


Using this numbering convention will keep FDI Packages uniquely named for the life of the product it represents.



FDI Package Versioning

Now that we know where the Version is visible to the user, we will show how changes to the contents of the FDI Device Package affects the Version numbers. 


 

ElementVersion LevelFDI Package Type
MajorMinorRevisionDevice /
Profile /
 Comm Server
UIP Package
Package Catalog
Modifying existing compatibility references.
xx

Change to ListOfSupportedUips. Only the addition of wildcards is allowed for modifications to existing VersonSupported.
xx


Editorialxx
EDDIncrement Device Revision (need new UUID/PackageId)

x
Private Label EDD (need new UUID/PackageId)

x

Increment DD_REVISION with existing DEVICE_REVISION
x
AttachmentsChanges to Protocol Support Files (i.e. CFF for new Device Revision)

x

Changes to Protocol Support Files (i.e. CFF update for a DD Revision)
x
UIPTechnology DrivenTechnology DrivenTechnology Drivenxx
Incompatible changes

xx

Functional enhancement
xx


Bug fixxx
UUID (PackageId)Must changeMust not changeMust not changexx


References:            

FCG TS62769-4 Ed. 1.2.0 Section 6. FDI Package Versioning           

FCG TS62769-1 Ed. 1.2.0 Section 8. Life-cycle Model             

FCG TS62769-1 Ed. 1.2.0 Annex G - FDI Package Life-cycle use cases            

        Note on G3 use case: the RRTE (version 1.4.x) does not support device replacement, it expects a 1:1 representation of the package and device.

        Note on G6 use case: the FDI-IDE (version 1.4.x) does not support multiple device types, device descriptions, or bus Protocols in a single FDI Device Package.


Important Note For FF and HART Devices

Every time a device revision is incremented and an FDI Device Package is created, the FDI Package Version and the UUID must be different. This includes creating a Private Label package.