Interface RetrieveLogsResponse

This shall be generated as a response to the RetrieveLogsRequest. The data for this command is shown in the following.

See

MatterSpecification.v13.Core § 11.11.5.2

interface RetrieveLogsResponse {
    logContent: Uint8Array;
    status: DiagnosticLogs.Status;
    timeSinceBoot?: number | bigint;
    utcTimeStamp?: number | bigint;
}

Hierarchy (view full)

Properties

logContent status timeSinceBoot? utcTimeStamp?

Properties

logContent

logContent: Uint8Array

This field shall be included in the command if the Status field has a value of Success or Exhausted. A Node SHOULD utilize this field to transfer the newest diagnostic log entries. This field shall be empty if BDX is requested and the Status field has a value of Success.

See

MatterSpecification.v13.Core § 11.11.5.2.2

status

status: DiagnosticLogs.Status

This field shall indicate the result of an attempt to retrieve diagnostic logs.

See

MatterSpecification.v13.Core § 11.11.5.2.1

OptionaltimeSinceBoot

timeSinceBoot?: number | bigint

This field SHOULD be included in the command if the Status field has a value of Success. When included, the TimeSinceBoot field shall contain the time of the oldest log entry in the diagnostic logs that are being transferred represented by the number of microseconds since the last time the Node went through a reboot.

See

MatterSpecification.v13.Core § 11.11.5.2.4

OptionalutcTimeStamp

utcTimeStamp?: number | bigint

This field SHOULD be included in the command if the Status field has a value of Success and the Node maintains a wall clock. When included, the UTCTimeStamp field shall contain the value of the oldest log entry in the diagnostic logs that are being transferred.

See

MatterSpecification.v13.Core § 11.11.5.2.3

Settings

Member Visibility

On This Page

Properties