Skip to content

Open Edge Device Kit – Device Status Messages

This section describes the monitoring topics that modules running on the devices are required to publish. The Open Edge Device Kit subscribes to these topics.

Configuration Update Status

Topic boxmanager/monitoring/opresult/configupdate
Description States the configuration update status for Box Manager. Possible values for the status are limited to 0 to 2, which are associated with the status "Configuration Update Successful", "Configuration Decrypt Failed", "Configuration Failed".
Quality of Service 1
Retained TRUE

Sample Body:

{
  "jobid": "000-111-222",
  "value": 0,
  "status": "Configuration Update Successful"
}

The jobid is provided by the Open Edge Device Kit with the configuration message via cloud/monitoring/update/configuration.

Offboarding Success

Topic boxmanager/monitoring/opresult/offboard
Description States that the offboarding operation was successful on device side.
Quality of Service 1
Retained TRUE

Sample Body:

{
  "value": 0,
  "status": "Offboarding Completed"
}

Software Version Information

Topic boxmanager/monitoring/softwareinformation/version
Description States the version of the firmware running on the device.
Quality of Service 1
Retained TRUE

Sample Body:

{
    "installedAt": "2017-11-15T10:43:39.264Z",
    "type": "string",
    "softwareId": "string",
    "version": "string",
  "description": "string"
}

Last update: May 20, 2019

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