Overview

Caution

This system is still under development. Information on this page may change at any time.

The Diagnostics system allows users of Spoke Zone to gather detailed diagnostics information from devices in the field.

Note

These features are only available for devices that properly implement the diagnostics integration. This integration can be added to devices already in the field. Developers can implement the integration and deploy it to devices through an OTA release.

Device Diagnostics Page

The device diagnostics page includes tools for inspecting diagnostics information and configuring diagnostics behavior for a specific device.

The Status section shows diagnostics data from each of the modules for the selected device’s model. It also includes an Echo feature to measure round-trip time to the device.

For more information, see:

• Runtime Tracking
• Live Debug Logs
• Connection Log
• Recent Data
• MQTT Traffic

Diagnostics Data Files

The following data file types are considered to be Diagnostics Data Files

• debug
• dmesg
• journal

Diagnostics Configuration

The device diagnostics page includes a Configuration section for setting a device’s diagnostics behavior.

There are three diagnostics settings that are sent to the device, plus a duration that controls how long the settings stay active.

Changes are configured specific to each device. The duration presets in the UI are 1 hour, 1 day, 1 week, and 2 weeks. After the changes have expired, the diagnostics level will revert to normal, the broadcast interval will revert to being disabled, and the debug level will revert to info.

Level

The type of diagnostics information that should be uploaded by a device can be configured using the level setting.

• normal
  • The device should not upload any diagnostics data files.
  • This is the default diagnostics level.
• debug
  • The device should record and upload diagnostics data files.

Broadcast Interval

Devices with support for the diagnostics system will periodically broadcast diagnostics information. By default, this broadcast is disabled to save data.

The broadcast interval setting is used to configure the interval of time between these broadcasts. For example, a value of 5 indicates that the device should broadcast every five seconds, and a value of 3600 indicates that the device should broadcast once an hour.

Debug Level

The amount of debug information included in debug data files can be configured using the Debug Level setting.

The default debug level is info.

The following values are supported:

• debug
• info
• warn
• error
• fatal

The debug level acts as a filter of debug information. For example, if the debug level is set to warn, only warn, error, and fatal debug messages should be included in the debug data file.

Here are the equivalent debug levels in other systems:

Spoke Zone Level	Qt Equivalent	JS Equivalent
debug	qDebug	console.debug (and console.log)
info	qInfo	console.info
warn	qWarning	console.warn
error	qCritical	console.error
fatal	qFatal	N/A

Duration

The duration setting controls how long the diagnostics configuration remains active before it reverts to the default behavior.