Matter Cluster 55 — Ethernet Network Diagnostics Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 55 values in the device shadow use this format:

endpoint_id / 55 / attribute_id

Example:

{
  "0/55/0": 0
}

Cluster 55 Features

The FeatureMap attribute (0/55/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; 3 means every feature listed above is enabled.

Data Types

PHYRateEnum

Cluster 55 Attributes

Cluster 55 defines 9 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 — PHYRate

Path example:

0/55/0

No condensed specification text is available for PHYRate; use the type, conformance and constraint below together with the cluster description above.

Values (PHYRateEnum):

Example:

{
  "0/55/0": 0
}

Attribute 1 / 0x0001 — FullDuplex

Path example:

0/55/1

Indicates if the Node is currently utilizing the full-duplex operating mode. A value of null indicates that the interface is not currently configured or operational.

Example:

{
  "0/55/1": true
}

Attribute 2 / 0x0002 — PacketRxCount

Path example:

0/55/2

Indicates the number of packets that have been received on the ethernet network interface. The attribute is reset to 0 upon a reboot of the Node.

Example:

{
  "0/55/2": 1
}

Attribute 3 / 0x0003 — PacketTxCount

Path example:

0/55/3

Indicates the number of packets that have been successfully transferred on the ethernet network interface. The attribute is reset to 0 upon a reboot of the Node.

Example:

{
  "0/55/3": 1
}

Attribute 4 / 0x0004 — TxErrCount

Path example:

0/55/4

Indicates the number of failed packet transmissions that have occurred on the ethernet network interface. The attribute is reset to 0 upon a reboot of the Node.

Example:

{
  "0/55/4": 1
}

Attribute 5 / 0x0005 — CollisionCount

Path example:

0/55/5

Indicates the number of collisions that have occurred while attempting to transmit a packet on the ethernet network interface. The attribute is reset to 0 upon a reboot of the Node.

Example:

{
  "0/55/5": 1
}

Attribute 6 / 0x0006 — OverrunCount

Path example:

0/55/6

Indicates the number of packets dropped either at ingress or egress, due to lack of buffer memory to retain all packets on the ethernet network interface. The attribute is reset to 0 upon a reboot of the Node.

Example:

{
  "0/55/6": 1
}

Attribute 7 / 0x0007 — CarrierDetect

Path example:

0/55/7

Indicates the value of the Carrier Detect control signal present on the ethernet network interface. A value of null indicates that the interface is not currently configured or operational.

Example:

{
  "0/55/7": true
}

Attribute 8 / 0x0008 — TimeSinceReset

Path example:

0/55/8

Indicates the duration of time, in minutes, that it has been since the ethernet network interface has reset for any reason.

Example:

{
  "0/55/8": 0
}

Cluster 55 Commands

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

AcceptedCommandList

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

endpoint_id / 55 / 65529

{
  "0/55/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": 55,
    "command_name": "ResetCounts",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

For Cluster 55, always use "cluster_id": 55. 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: ResetCounts

Purpose

This command is used to reset the count attributes. Reception of this command must reset the following attributes to 0: - PacketRxCount - PacketTxCount - TxErrCount - CollisionCount - OverrunCount

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": 55,
    "command_name": "ResetCounts",
    "payload": {}
  }
}

Cluster 55 Events

Cluster 55 defines no events.

SmartphoneKey Notes

• Cluster 55 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/55/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.