Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      activeNetworkFaultsList: Attribute<ThreadNetworkDiagnostics.NetworkFault[], any>;
      activeTimestamp: OptionalAttribute<number | bigint | null, any>;
      channel: Attribute<number | null, any>;
      channelPage0Mask: Attribute<Uint8Array | null, any>;
      dataVersion: Attribute<number | null, any>;
      delay: OptionalAttribute<number | null, any>;
      extendedPanId: Attribute<number | bigint | null, any>;
      leaderRouterId: Attribute<number | null, any>;
      meshLocalPrefix: Attribute<Uint8Array | null, any>;
      neighborTable: Attribute<TypeFromFields[], any>;
      networkName: Attribute<string | null, any>;
      operationalDatasetComponents: Attribute<TypeFromFields | null, any>;
      panId: Attribute<number | null, any>;
      partitionId: Attribute<number | null, any>;
      pendingTimestamp: OptionalAttribute<number | bigint | null, any>;
      routeTable: Attribute<TypeFromFields[], any>;
      routingRole: Attribute<ThreadNetworkDiagnostics.RoutingRole | null, any>;
      securityPolicy: Attribute<TypeFromFields | null, any>;
      stableDataVersion: Attribute<number | null, any>;
      weighting: Attribute<number | null, any>;
  }

  • ReadonlyactiveNetworkFaultsList: Attribute<ThreadNetworkDiagnostics.NetworkFault[], any>

    See

    MatterSpecification.v13.Core § 11.14.6

  • ReadonlyactiveTimestamp: OptionalAttribute<number | bigint | null, any>

    Null when there is no dataset configured.

    See

    MatterSpecification.v13.Core § 11.14.6.57

  • Readonlychannel: Attribute<number | null, any>

    The Channel attribute shall indicate the 802.15.4 channel number configured on the Node’s Thread interface (that is, the Active Operational Dataset’s current Channel value). A value of null shall indicate that the Thread interface is not currently configured or operational.

    See

    MatterSpecification.v13.Core § 11.14.6.1

  • ReadonlychannelPage0Mask: Attribute<Uint8Array | null, any>

    The ChannelPage0Mask attribute indicates the channels within channel page 0, in the 2.4GHz ISM band. The channels are represented in most significant bit order, with bit value 1 meaning selected, bit value 0 meaning unselected. For example, the most significant bit of the left-most byte indicates channel 0. If channel 0 and channel 10 are selected, the mask would be: 80 20 00 00. Null when there is no dataset configured.

    See

    MatterSpecification.v13.Core § 11.14.6.61

  • ReadonlydataVersion: Attribute<number | null, any>

    The DataVersion attribute shall indicate the full Network Data Version the Node currently uses. Null if not attached to a Thread network.

    See

    MatterSpecification.v13.Core § 11.14.6.12

  • Readonlydelay: OptionalAttribute<number | null, any>

    Null when there is no dataset configured.

    See

    MatterSpecification.v13.Core § 11.14.6.59

  • ReadonlyextendedPanId: Attribute<number | bigint | null, any>

    The ExtendedPanId attribute shall indicate the unique 64-bit identifier of the Node on the Thread network. A value of null shall indicate that the Thread interface is not currently configured or operational.

    See

    MatterSpecification.v13.Core § 11.14.6.5

  • ReadonlyleaderRouterId: Attribute<number | null, any>

    The LeaderRouterId attribute shall indicate the 8-bit LeaderRouterId the Node shall attempt to utilize upon becoming a router or leader on the Thread network. Null if not attached to a Thread network.

    See

    MatterSpecification.v13.Core § 11.14.6.14

  • ReadonlymeshLocalPrefix: Attribute<Uint8Array | null, any>

    The MeshLocalPrefix attribute shall indicate the mesh-local IPv6 prefix for the Thread network that the Node has been configured to join to. A value of null shall indicate that the Thread interface is not currently configured or operational.

    See

    MatterSpecification.v13.Core § 11.14.6.6

  • ReadonlyneighborTable: Attribute<TypeFromFields[], any>

    The NeighborTable attribute shall indicate the current list of Nodes that comprise the neighbor table on the Node.

    See

    MatterSpecification.v13.Core § 11.14.6.8

  • ReadonlynetworkName: Attribute<string | null, any>

    The NetworkName attribute shall indicate a human-readable (displayable) name for the Thread network that the Node has been configured to join to. A value of null shall indicate that the Thread interface is not currently configured or operational.

    See

    MatterSpecification.v13.Core § 11.14.6.3

  • ReadonlyoperationalDatasetComponents: Attribute<TypeFromFields | null, any>

    The OperationalDatasetComponents attribute is a collection of flags to indicate the presence of various operationally acquired values.

    See

    MatterSpecification.v13.Core § 11.14.6.62

  • ReadonlypanId: Attribute<number | null, any>

    The PanId attribute shall indicate the 16-bit identifier of the Node on the Thread network. A value of null shall indicate that the Thread interface is not currently configured or operational.

    See

    MatterSpecification.v13.Core § 11.14.6.4

  • ReadonlypartitionId: Attribute<number | null, any>

    The PartitionId attribute shall indicate the Thread Leader Partition Id for the Thread network to which the Node is joined. Null if not attached to a Thread network.

    See

    MatterSpecification.v13.Core § 11.14.6.10

  • ReadonlypendingTimestamp: OptionalAttribute<number | bigint | null, any>

    Null when there is no dataset configured.

    See

    MatterSpecification.v13.Core § 11.14.6.58

  • ReadonlyrouteTable: Attribute<TypeFromFields[], any>

    The RouteTable attribute shall indicate the current list of router capable Nodes for which routes have been established.

    See

    MatterSpecification.v13.Core § 11.14.6.9

  • ReadonlyroutingRole: Attribute<ThreadNetworkDiagnostics.RoutingRole | null, any>

    The RoutingRole attribute shall indicate the role that this Node has within the routing of messages through the Thread network, as defined by RoutingRoleEnum. The potential roles are defined in the following table. A value of null shall indicate that the Thread interface is not currently configured or operational.

    See

    MatterSpecification.v13.Core § 11.14.6.2

  • ReadonlysecurityPolicy: Attribute<TypeFromFields | null, any>

    The SecurityPolicy attribute indicates the current security policies for the Thread partition to which a Node is connected. Null when there is no dataset configured.

    See

    MatterSpecification.v13.Core § 11.14.6.60

  • ReadonlystableDataVersion: Attribute<number | null, any>

    The StableDataVersion attribute shall indicate the Network Data Version for the stable subset of

    data the Node currently uses. Null if not attached to a Thread network.

    See

    MatterSpecification.v13.Core § 11.14.6.13

  • Readonlyweighting: Attribute<number | null, any>

    The Weighting attribute shall indicate the Thread Leader Weight used when operating in the Leader role. Null if not attached to a Thread network.

    See

    MatterSpecification.v13.Core § 11.14.6.11

• Readonlyevents: {
      connectionStatus: OptionalEvent<TypeFromFields, any>;
      networkFaultChange: OptionalEvent<TypeFromFields, any>;
  }

  • ReadonlyconnectionStatus: OptionalEvent<TypeFromFields, any>

    The ConnectionStatus Event shall indicate that a Node’s connection status to a Thread network has changed.

    See

    MatterSpecification.v13.Core § 11.14.8.2

  • ReadonlynetworkFaultChange: OptionalEvent<TypeFromFields, any>

    The NetworkFaultChange Event shall indicate a change in the set of network faults currently detected by the Node.

    See

    MatterSpecification.v13.Core § 11.14.8.1

• Readonlyextensions: readonly [{
      component: {
          attributes: {
              overrunCount: Attribute<number | bigint, any>;
          };
          commands: {
              resetCounts: Command<void, void, any>;
          };
      };
      flags: {
          errorCounts: true;
      };
  }, {
      component: {
          attributes: {
              attachAttemptCount: OptionalAttribute<number, any>;
              betterPartitionAttachAttemptCount: OptionalAttribute<number, any>;
              childRoleCount: OptionalAttribute<number, any>;
              detachedRoleCount: OptionalAttribute<number, any>;
              leaderRoleCount: OptionalAttribute<number, any>;
              parentChangeCount: OptionalAttribute<number, any>;
              partitionIdChangeCount: OptionalAttribute<number, any>;
              routerRoleCount: OptionalAttribute<number, any>;
          };
      };
      flags: {
          mleCounts: true;
      };
  }, {
      component: {
          attributes: {
              rxAddressFilteredCount: OptionalAttribute<number, any>;
              rxBeaconCount: OptionalAttribute<number, any>;
              rxBeaconRequestCount: OptionalAttribute<number, any>;
              rxBroadcastCount: OptionalAttribute<number, any>;
              rxDataCount: OptionalAttribute<number, any>;
              rxDataPollCount: OptionalAttribute<number, any>;
              rxDestAddrFilteredCount: OptionalAttribute<number, any>;
              rxDuplicatedCount: OptionalAttribute<number, any>;
              rxErrFcsCount: OptionalAttribute<number, any>;
              rxErrInvalidSrcAddrCount: OptionalAttribute<number, any>;
              rxErrNoFrameCount: OptionalAttribute<number, any>;
              rxErrOtherCount: OptionalAttribute<number, any>;
              rxErrSecCount: OptionalAttribute<number, any>;
              rxErrUnknownNeighborCount: OptionalAttribute<number, any>;
              rxOtherCount: OptionalAttribute<number, any>;
              rxTotalCount: OptionalAttribute<number, any>;
              rxUnicastCount: OptionalAttribute<number, any>;
              txAckedCount: OptionalAttribute<number, any>;
              txAckRequestedCount: OptionalAttribute<number, any>;
              txBeaconCount: OptionalAttribute<number, any>;
              txBeaconRequestCount: OptionalAttribute<number, any>;
              txBroadcastCount: OptionalAttribute<number, any>;
              txDataCount: OptionalAttribute<number, any>;
              txDataPollCount: OptionalAttribute<number, any>;
              txDirectMaxRetryExpiryCount: OptionalAttribute<number, any>;
              txErrAbortCount: OptionalAttribute<number, any>;
              txErrBusyChannelCount: OptionalAttribute<number, any>;
              txErrCcaCount: OptionalAttribute<number, any>;
              txIndirectMaxRetryExpiryCount: OptionalAttribute<number, any>;
              txNoAckRequestedCount: OptionalAttribute<number, any>;
              txOtherCount: OptionalAttribute<number, any>;
              txRetryCount: OptionalAttribute<number, any>;
              txTotalCount: OptionalAttribute<number, any>;
              txUnicastCount: OptionalAttribute<number, any>;
          };
      };
      flags: {
          macCounts: true;
      };
  }]

  This metadata controls which ThreadNetworkDiagnosticsCluster elements matter.js activates for specific feature combinations.

• Readonlyfeatures: {
      errorCounts: BitFlag;
      macCounts: BitFlag;
      mleCounts: BitFlag;
      packetCounts: BitFlag;
  }

  • ReadonlyerrorCounts: BitFlag

    ErrorCounts

    Server supports the counts for the number of errors that have occurred during the reception and transmission of packets on the Thread interface.

  • ReadonlymacCounts: BitFlag

    MacCounts

    Server supports the counts for various MAC layer happenings.

  • ReadonlymleCounts: BitFlag

    MleCounts

    Server supports the counts for various MLE layer happenings.

  • ReadonlypacketCounts: BitFlag

    PacketCounts

    Server supports the counts for the number of received and transmitted packets on the Thread interface.

• Readonlyid: 53

• Readonlyname: "ThreadNetworkDiagnostics"

• Readonlyrevision: 2