Matter Cluster 52 — Software Diagnostics Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 52 values in the device shadow use this format:

endpoint_id / 52 / attribute_id

Example:

{
  "0/52/0": []
}

Cluster 52 Features

The FeatureMap attribute (0/52/65532) is a bitmap. Each bit set means the device implements that feature and the attributes and commands that depend on it.

Example: FeatureMap = 0 means no optional feature is enabled; 1 means every feature listed above is enabled.

Data Types

ThreadMetricsStruct (struct)

Cluster 52 Attributes

Cluster 52 defines 4 attributes plus the global attributes. Conformance: M mandatory, O optional, a feature code means "mandatory when that feature is present", square brackets mean "optional when …".

Global attributes

Attribute Details

Attribute 0 / 0x0000 — ThreadMetrics

Path example:

0/52/0

This attribute is a list of ThreadMetricsStruct structs. Each active thread on the Node is represented by a single entry within the ThreadMetrics attribute.

Each entry is a ThreadMetricsStruct (see Data Types).

Example:

{
  "0/52/0": []
}

Attribute 1 / 0x0001 — CurrentHeapFree

Path example:

0/52/1

Indicates the current amount of heap memory, in bytes, that are free for allocation. The effective amount may be smaller due to heap fragmentation or other reasons.

Example:

{
  "0/52/1": 1
}

Attribute 2 / 0x0002 — CurrentHeapUsed

Path example:

0/52/2

Indicates the current amount of heap memory, in bytes, that is being used.

Example:

{
  "0/52/2": 1
}

Attribute 3 / 0x0003 — CurrentHeapHighWatermark

Path example:

0/52/3

Indicates the maximum amount of heap memory, in bytes, that has been used by the Node. This value only be reset upon a Node reboot or upon receiving of the ResetWatermarks command.

Example:

{
  "0/52/3": 1
}

Cluster 52 Commands

Cluster 52 has 1 client-to-server command and 0 responses.

AcceptedCommandList

The AcceptedCommandList attribute lists the command IDs the endpoint actually implements:

endpoint_id / 52 / 65529

{
  "0/52/65529": [
    0
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 52,
    "command_name": "ResetWatermarks",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

For Cluster 52, always use "cluster_id": 52. Payload keys are the command field names in lowerCamelCase. Octet-string fields are base64-encoded. timed_request_timeout_ms is required for timed commands and ignored otherwise.

Command: ResetWatermarks

Purpose

This command is used to reset the high watermarks for heap and stack memory. Receipt of this command must reset the following values which track high and lower watermarks: - The StackFreeMinimum field of the ThreadMetrics attribute - The CurrentHeapHighWatermark attribute

Command Identity

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 0,
    "cluster_id": 52,
    "command_name": "ResetWatermarks",
    "payload": {}
  }
}

Cluster 52 Events

Event 0 — SoftwareFault

This Event is generated when a software fault occurs on the Node.

SmartphoneKey Notes

• Cluster 52 is not currently exposed by SmartphoneKey devices. This page documents the Matter 1.6.1 specification so that future devices can be interpreted without changes to the backend.
• Shadow paths follow endpoint/52/attribute; attribute values that the device reports as unreadable are written as n/a.
• Attribute IDs, command IDs and enum values on this page come from the CSA Matter 1.6.1 data model; descriptions are condensed from the specification text.