Release Notes¶

This API version is independent of the Industrial Edge releases.

V1.3.0¶

dpDataTypeV1 : added dataType 'Raw'
update-request: request a connector to republish the latest values. Needed for values which seldomly change. See ie/c/j/.../updaterequest and especially isResponseToUpdateRequest in subDpValueSimaticV11TimeSeriesPayload and in subDpValueSimaticV1Payload.
providerAppInstanceId: added pattern to allow only a single optional colon to separate between device name and instanceId
dpConnectionNamePath and dpCollectionNamePath: fixed pattern to not allow '#' and '+' because those characters are not allowed in MQTT topic names and need to be escaped using URL encoding. This also means that '%' needs to be escaped to allow for URL encoding.
sampleRateType and sampleRateHz: new concept for high frequency data like audio, vibration or motion control to be transmitted with very small overhead.

Fixed typo: the 'statustopic"' property names (with double-quotes at the end) have been changed to 'statustopic'

Fixed the 'Time_Of_Day' and 'LTime_Of_Day' definition. They were mapped to 'LTime', but 'LTime' is a range data type and not a time of day data type. Also, the allowed maximum value is different. The scaling of the values do not change, it is still 100ns resolution which means the values do not change, only the allowed range is reduced to 24 hours. Future connectors shall avoid using 'Time' but using 'LTime' instead. The same applies for 'Time_Of_Day', use 'LTime_Of_Day' instead.
Refined the description of 'providerAppInstanceId'. When aggregating topics from multiple devices, the topic names need to be unique. That is why during that forwarding, a prefix will be added to the Instance Name part of the topic, separated by a colon. For example the Instance Name will be changed from "s7c1" to "device15:s7c1".

Added new 'Status' message type for connector and connection dignaostics
Added extended quality information 'qx' to values
Added 'applicationName' and 'statustopic' to metadata
Added MQTT bindings ('qos' and 'retain')
Added additional 'asyncapi_profinet_io_conn.yaml' API file for the PROFINET IO Connector specific messages to read and write PROFINET Records

Fixed the definition of 'Time', 'Time_Of_Day' and 'LTime_Of_Day' to match the definition of 'LTime'. Actually, only 'LTime' would have been needed and the other definitions are obsolete at the Databus level. On the PLC level, there are different data types but all are normalized to use the same type on the Databus. Future connectors shall avoid using 'Time', 'Time_Of_Day' and 'LTime_Of_Day' and should use 'LTime'.

Use new ie-databus Databus hostname (instead of ie_databus which can still be used but contains '_' which is not allowed in DNS names and might cause some problems with libraries)
Added 'timeseries' and 'binarytimeseries' payload formats (used by PROFINET IO Connector)
Added 'hashVersion' to metadata message
Added 'mdHashVer' to the value messages and 'metadataHashVersion' to the metadata message
Added 'accessMode', 'dataPointAddr', 'acquisitionCycleInMs', 'acquisitionMode' to datapoint metadata
Added 'valueRank' and 'arrayDimensions' for array support of values

This version contains a bug and has been replaced by V1.1.1.

First Version.