View Issue Details

IDProjectCategoryView StatusLast Update
0006978NodeSets, XSDs and Generated CodeApi Changepublic2021-11-17 18:50
ReporterJim Luth Assigned ToRandy Armstrong  
PrioritynormalSeverityminorReproducibilityhave not tried
Status closedResolutionfixed 
Product Version1.05.00 RC1 
Target Version1.05.00Fixed in Version1.05.01 RC1 
Summary0006978: Add capability to provide a semantic version for SoftwareRevision
Description

We discussed in the Asset Management Basics WG that it would be desirable to provide more semantic in the SoftwareRevision than just a string, where you - in a nutshell - just compare if it is the same version or not. In many cases, there is more information like, Major, Minor, Build Number, etc. This website (https://semver.org/) gives a BNF how this can be represented in a string. This allows you to identify, if it is a newer or older version.

As not all SoftwareRevisions will be provided in such a format and we do not want to introduce a breaking change we suggest to:
Create a subtype of String which requires the specific syntax (e.g. called SemVerString). Servers can use the subtype and thus expose to the client, that a specific format is used. Companion Specs can require this format by refining the Property to this data type. Clients can use the information so that they know a specific format is used.

Remark: (Not discussed in WG): Maybe it even make sense to put this data type into the base spec? Then Part 100 should still mention its possible usage as SoftwareRevision.

TagsNo tags attached.
Commit Version
Fix Due Date

Relationships

related to 0006949 closedJeff Harding 10000-005: Information Model Add capability to provide a semantic version for SoftwareRevision 
related to 0007274 closedJeff Harding 10000-005: Information Model Add capability to provide a semantic version for SoftwareRevision 

Activities

Wolfgang Mahnke

2021-06-01 16:05

reporter   ~0014450

Discussed in WG Meeting:
Define Type called SemanticVersionString as subtype of string.
Copy BNF into spec.
Add note in IVendorNamplateType and SoftwareVersionType that the datatype can be used instead of the "normal" string.

Clone item to Part 5 and potentially define DataType in Part 5.

Wolfgang Mahnke

2021-06-01 16:05

reporter   ~0014451

Proposal from FDI/PA-DIM-WGs (probably also Fx):
“Limit the version parts to 1..5 characters. Furthermore, the number expressed by each part of the version string shall fit into an 16 bit unsigned integer, i.e. <= 65.535.”

Paul Hunkar

2021-06-01 16:05

reporter   ~0014452

Many vendors already use SoftwareVersion with vendor specific strings and getting them to switch might not be practical, but FLC required a standard versioning that can be easily compared. FX has defined an structure with numeric version information in it for use (major, minor, buid, subbuild). No string processing is required and can be easily compared. We still allow the vendors to use the software and Hardware version information as they want, since it might be used for vendor proprietary information.

defining the string type might be useful in other specification, but I don't think it can be applied to all of the existing devices.

Jim Luth

2021-06-01 16:05

administrator   ~0014453

Agreed name of type should be "SemanticVersionString".
We agreed to put this in the 1.05.0 release Nodeset even though it will not be in the 1.05.0 Part 5.

Randy Armstrong

2021-07-03 08:28

administrator   ~0014622

Added to 1.05 nodeset.

Jim Luth

2021-11-17 18:50

administrator   ~0015360

Reviewed with Randy -- agreed to close.

Issue History

Date Modified Username Field Change
2021-06-01 16:05 Jim Luth New Issue
2021-06-01 16:05 Jim Luth Status new => assigned
2021-06-01 16:05 Jim Luth Assigned To => Randy Armstrong
2021-06-01 16:05 Jim Luth Issue generated from: 0006949
2021-06-01 16:05 Jim Luth Note Added: 0014450
2021-06-01 16:05 Jim Luth Note Added: 0014451
2021-06-01 16:05 Jim Luth Note Added: 0014452
2021-06-01 16:05 Jim Luth Note Added: 0014453
2021-06-01 16:05 Jim Luth Relationship added related to 0006949
2021-06-01 16:05 Jim Luth Project 10000-005: Information Model => NodeSets, XSDs and Generated Code
2021-06-01 16:05 Jim Luth Category Spec => Api Change
2021-07-03 08:28 Randy Armstrong Status assigned => resolved
2021-07-03 08:28 Randy Armstrong Resolution open => fixed
2021-07-03 08:28 Randy Armstrong Fixed in Version => 1.05
2021-07-03 08:28 Randy Armstrong Note Added: 0014622
2021-09-22 17:50 Jim Luth Relationship added related to 0007274
2021-11-17 18:50 Jim Luth Status resolved => closed
2021-11-17 18:50 Jim Luth Fixed in Version => 1.05.01 RC1
2021-11-17 18:50 Jim Luth Note Added: 0015360