Open Edge Device Kit – Configuration Updates¶

This section describes configuration messages published by the Open Edge Device Kit. They provide configuration updates, which have been made in Insights Hub using Device Configuration Service. The Open Edge Device Kit obtains these updates using the Deployment Workflow Service. Modules running on devices must subscribe to the topics listed in this section.

Info

If the connection with Insights Hub is interrupted, the Open Edge Device Kit receives and publishes configuration updates after the connection is re-established.

Device Configuration Update¶

Topic	`cloud/monitoring/update/configuration`
Description	Specifies the new device configuration downloaded by the Open Edge Device Kit.
Quality of Service	1
Retained	`TRUE`

Sample Body:

{
  "jobid": "000-111-222",
  "device" : {
        ...
  }
}

After applying the new configuration, the Open Edge Device Kit expects a status message to be published via boxmanager/monitoring/opresult/configupdate with the provided ID and a status.

Application Configuration Update¶

Topic	`cloud/monitoring/update/configuration/{app_id}`
Description	Contains the new configuration for the specified Edge application. This message is published by the Open Edge Device Kit after the configuration has been changed in the Insights Hub backend and published to the device. Every Edge application must subscribe to this channel, appended with its associated identifier.
Quality of Service	1
Retained	`TRUE`

Sample Body:

{
  "job": { The Configuration Job },
  "fileContent" : "..."
}

After applying the new configuration, the Open Edge Device Kit expects a status message to be published via boxmanager/monitoring/opresult/configupdate with the provided ID and a status.

Data Source Configuration Update¶

Topic	`cloud/monitoring/update/configuration/{protocol}`
Description	Contains a new data source configuration. Modules reading data must subscribe to the topic using the protocol they are supposed to support.
Quality of Service	2
Retained	`FALSE`

Sample Body:

{
  "name": "GAIA",
  "description": "",
  "protocol": "MODBUS",
  "readCycleInSeconds": "1",
  "protocolData": {
    "ipAddress": "192.168.0.211"
  },
  "dataPoints": [
    {
      "dataPointId": "1526635470331",
      "name": "byte_variable",
      "description": "",
      "unit": "PERCENT",
      "dataType": "INT",
      "dataPointData": {
        "address": "DB1.DBB150",
        "onDataChanged": false}
    },
    {
      "dataPointId": "1526635496767",
      "name": "float_variable",
      "description": "",
      "unit": "PERCENT",
      "dataType": "DOUBLE",
      "dataPointData": {
        "address": "DB1.DBREAL1800",
        "onDataChanged": false}
    },
    {
      "dataPointId": "1526635524797",
      "name": "int_variable",
      "description": "",
      "unit": "PERCENT",
      "dataType": "INT",
      "dataPointData": {
        "address": "DB1.DBW2830",
        "onDataChanged": false}
    }
  ]
}

All Data Sources Configuration¶

Topic	`cloud/monitoring/datasources`
Description	Contains all data sources configuration.
Quality of Service	2
Retained	`TRUE`

Sample Body:

{
  "name": "GAIA",
  "description": "",
  "protocol": "MODBUS",
  "dataSourceId" "32D434ADS3"
  "readCycleInSeconds": "1",
  "protocolData": {
    "ipAddress": "192.168.0.211"
  },
  "dataPoints": [
    {
      "dataPointId": "1526635470331",
      "name": "byte_variable",
      "description": "",
      "unit": "PERCENT",
      "dataType": "INT",
      "dataPointData": {
        "address": "DB1.DBB150",
        "onDataChanged": false}
    },
    {
      "dataPointId": "1526635496767",
      "name": "float_variable",
      "description": "",
      "unit": "PERCENT",
      "dataType": "DOUBLE",
      "dataPointData": {
        "address": "DB1.DBREAL1800",
        "onDataChanged": false}
    },
    {
      "dataPointId": "1526635524797",
      "name": "int_variable",
      "description": "",
      "unit": "PERCENT",
      "dataType": "INT",
      "dataPointData": {
        "address": "DB1.DBW2830",
        "onDataChanged": false}
    }
  ]
}

Last update: February 23, 2024

Except where otherwise noted, content on this site is licensed under the Development License Agreement.