Contents

StatusReport

Provides details about an error for an item in a status report.

Declaration

object StatusReport

Properties

NameTypeDescription
StatusItems RequiredStatusReport.StatusItems

A dictionary where the keys are the status item paths and values are the corresponding status item value.

Errors Required[StatusReport.Error]

An array of errors for this status report.

FullReportboolean

The system sets this to true to indicate that the status report contains the full set of current status, and is not an incremental report. A full status report includes the full set of items in any status array item, not just the changes. Servers use this to replace their entire status for the device, rather than do an incremental update to the existing status. The system sets this to true when sending a “safety sync” status report, which is typically sent every 24 hours or so.

Mentioned in

Discussion

The device sends a status report when a subscribed status item changes. The report contains just the status items that have changed. About once a day, the device also sends a full status report containing all the subscribed status items, and the FullReport key is set to true in the report. This allows servers to reset their status items in case they missed an incremental report.

Topics

Dictionaries

See Also

Status report