Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      currentHeapFree: OptionalAttribute<number | bigint, any>;
      currentHeapUsed: OptionalAttribute<number | bigint, any>;
      threadMetrics: OptionalAttribute<TypeFromFields<{
          id: FieldType<number | bigint>;
          name: OptionalFieldType<string>;
          stackFreeCurrent: OptionalFieldType<number>;
          stackFreeMinimum: OptionalFieldType<number>;
          stackSize: OptionalFieldType<number>;
      }>[], any>;
  }

  • ReadonlycurrentHeapFree: OptionalAttribute<number | bigint, any>

    The CurrentHeapFree attribute shall indicate 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.

    See

    MatterSpecification.v13.Core § 11.13.6.2

  • ReadonlycurrentHeapUsed: OptionalAttribute<number | bigint, any>

    The CurrentHeapUsed attribute shall indicate the current amount of heap memory, in bytes, that is being used.

    See

    MatterSpecification.v13.Core § 11.13.6.3

  • ReadonlythreadMetrics: OptionalAttribute<TypeFromFields<{
        id: FieldType<number | bigint>;
        name: OptionalFieldType<string>;
        stackFreeCurrent: OptionalFieldType<number>;
        stackFreeMinimum: OptionalFieldType<number>;
        stackSize: OptionalFieldType<number>;
    }>[], any>

    The ThreadMetrics attribute shall be a list of ThreadMetricsStruct structs. Each active thread on the Node shall be represented by a single entry within the ThreadMetrics attribute.

    See

    MatterSpecification.v13.Core § 11.13.6.1

• Readonlyevents: {
      softwareFault: OptionalEvent<TypeFromFields<{
          faultRecording: OptionalFieldType<Uint8Array>;
          id: FieldType<number | bigint>;
          name: OptionalFieldType<string>;
      }>, any>;
  }

  • ReadonlysoftwareFault: OptionalEvent<TypeFromFields<{
        faultRecording: OptionalFieldType<Uint8Array>;
        id: FieldType<number | bigint>;
        name: OptionalFieldType<string>;
    }>, any>

    The SoftwareFault Event shall be generated when a software fault takes place on the Node.

    See

    MatterSpecification.v13.Core § 11.13.8.1

• Readonlyextensions: readonly [{
      component: {
          attributes: {
              currentHeapHighWatermark: Attribute<number | bigint, any>;
          };
          commands: {
              resetWatermarks: Command<void, void, any>;
          };
      };
      flags: {
          watermarks: true;
      };
  }]

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

• Readonlyfeatures: {
      watermarks: BitFlag;
  }

  • Readonlywatermarks: BitFlag

    Watermarks

    Node makes available the metrics for high watermark related to memory consumption.

• Readonlyid: 52

• Readonlyname: "SoftwareDiagnostics"

• Readonlyrevision: 1