Skip to content

Release Notes

This API version is independent of the Industrial Edge releases.

V1.4.0

  • writing of Datapoints
  • added Datapoint values write response json topic 'ie/d/j/{msgStructureScheme}/{msgStructureSchemeMajorVersion}/{providerAppInstanceId}/dp/wr/resp{dpConnectionNamePath}{dpCollectionNamePath}' and subDpValueResponseSimaticV1Msg
  • pubDpValueSimaticV1Payload: added properties requestId and mdHashVer to allow response and error handling for write requests.
  • single read of Datapoints (they don't need to be part of any cyclic topic)
  • added Datapoint values single read request json 'ie/d/j/{msgStructureScheme}/{msgStructureSchemeMajorVersion}/{providerAppInstanceId}/dp/sr/req/{dpConnectionNamePath}{dpCollectionNamePath}' and pubSingleReadRequestDpValueSimaticV1Msg
  • added Datapoint values single read response json 'ie/d/j/{msgStructureScheme}/{msgStructureSchemeMajorVersion}/{providerAppInstanceId}/dp/sr/resp/{dpConnectionNamePath}{dpCollectionNamePath}' and subSingleReadResponseDpValueSimaticV1Msg
  • reading and writing datapoints which are not cyclically published (e.g. recipe data or setpoints)
  • nonCyclicDataPoints has been added to the metadata in dpMetaConnectionV1 which contains the list of datapoints which are configured in a connector but are not part of any cyclic data topic
  • You can use the datapoint ids and topic names defined there with single-read and write operations.
  • updated Databus url to include the name of the docker network : mqtt://ie-databus.proxy-redirect:1883. Is is best practice to always use the fully qualified DNS name, otherwise you might run into issues with no_proxy settings which are based on DNS network names. It might also happen that the DNS resolver might contact an external DNS server when the unqualified name is not found within the docker environment, e.g. because an App is currently not running.
  • fixed naming of messages/updateRequestMsg to messages/pubUpdateRequestMsg. This should't affect the interface itself, but is is necessary to fix the schema validation script.
  • allow dpMetadataSimaticV1 and diagConnectorStatusMsg to be null for shutdown scenarios

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.

V1.2.2

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

V1.2.1

  • 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".

V1.2.0

  • 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

V1.1.1

  • 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'.

V1.1.0

  • 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.

V1.0.0

First Version.