EthernetNetworkDiagnostics Cluster

Cluster ID: 0x0037  |  Endpoint: Endpoint 0 (Root Node)

EthernetNetworkDiagnostics provides Ethernet interface operational status and statistics — link rate, duplex mode, TX/RX packet counts, error counts, etc. This cluster has only 1 command and 9 attributes, with a simple structure primarily for network health monitoring and troubleshooting.

Feature Bitmap

EthernetNetworkDiagnostics Declares which diagnostic capabilities the device supports through FeatureMap (0xFFFC):

Attribute Overview

Click an attribute ID to jump to detailed description. Attributes marked with a Feature only exist when the device supports the corresponding feature.

PHYRate (Physical Layer Rate)

Read-only attribute indicating the physical layer link rate negotiated by the current Ethernet interface. null indicates unknown rate or interface not connected.

PHYRateEnum Enum Values

↑ Back to Attributes

FullDuplex (Full Duplex Mode)

Read-only attribute indicating whether the current Ethernet link operates in full-duplex mode. true for full-duplex, false for half-duplex, null means unable to determine. Modern Ethernet devices are almost always full-duplex; half-duplex usually indicates a negotiation anomaly.

↑ Back to Attributes

PacketRxCount (Received Packet Count)

Read-only attribute, total packets received since last reset. Requires device PKTCNT feature support. This counter resets to zero upon calling the ResetCounts command or device reboot.

↑ Back to Attributes

PacketTxCount (Transmitted Packet Count)

Read-only attribute, total packets transmitted since last reset. Requires device PKTCNT feature support.

↑ Back to Attributes

TxErrCount (Transmission Error Count)

Read-only attribute, number of transmission failures since last reset. Requires device ERRCNT feature support. Continuous growth usually indicates poor cable quality or switch port issues.

↑ Back to Attributes

CollisionCount (Collision Count)

Read-only attribute, collision count since last reset. Requires device ERRCNT feature support. On a full-duplex link, this value should always be 0; if it continues to grow, the link may have degraded to half-duplex.

↑ Back to Attributes

OverrunCount (Overrun Count)

Read-only attribute, number of receive buffer overruns since last reset. Requires device ERRCNT feature support. Overruns mean the device cannot process received data in time, possibly due to high device load or excessive network traffic.

↑ Back to Attributes

CarrierDetect (Carrier Detect)

Read-only attribute indicating whether the Ethernet interface detects a carrier signal. true means the cable is connected and the remote device is working, false means the cable is disconnected or the remote end is unresponsive, null means unable to determine. This is the most direct indicator of physical connection status.

↑ Back to Attributes

TimeSinceReset (Time Since Counter Reset)

Read-only attribute, seconds elapsed since the last counter reset (ResetCounts command or device reboot). Combined with packet counts and error counts, you can calculate average per-second TX/RX rates and error rates.

↑ Back to Attributes

Commands

EthernetNetworkDiagnostics has only one command. It is only meaningful when the device supports PKTCNT or ERRCNT features.

ResetCounts — Reset Counters (0x00)

Resets PacketRxCount, PacketTxCount, TxErrCount, CollisionCount, and OverrunCount all to zero, while TimeSinceReset also resets to 0 and restarts counting. No parameters needed, just send directly.

Request example:

{
  "invokeRequests": [{
    "commandPath": {
      "endpointId": 0,
      "clusterId": "0x0037",
      "commandId": "0x00"       // ResetCounts
    },
    "commandFields": {}
  }]
}

↑ Back to Commands

Example Data

Reading an Ethernet Hub device's EthernetNetworkDiagnostics Cluster attributes:

{
  // --- Attributes ---
  "0x0": 2,           // PHYRate = Rate1G (Gigabit Ethernet)
  "0x1": true,        // FullDuplex = true (full-duplex)
  "0x2": 1048576,     // PacketRxCount = 1048576 (approximately 1 million packets received)
  "0x3": 524288,      // PacketTxCount = 524288 (approximately 500K packets transmitted)
  "0x4": 3,           // TxErrCount = 3 (3 transmission errors)
  "0x5": 0,           // CollisionCount = 0 (no collisions)
  "0x6": 0,           // OverrunCount = 0 (no overruns)
  "0x7": true,        // CarrierDetect = true (carrier detect normal)
  "0x8": 86400        // TimeSinceReset = 86400 (24 hours since last reset)
}

Common Scenarios