Variable CompleteInstanceConst

Type declaration

• Readonlyattributes: {
      acceptedCommandList: Attribute<CommandId[], never>;
      attributeList: Attribute<AttributeId[], never>;
      clusterRevision: Attribute<number, never>;
      currentHeapFree: OptionalAttribute<number | bigint, any>;
      currentHeapHighWatermark: Attribute<number | bigint, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              watermarks: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      currentHeapUsed: OptionalAttribute<number | bigint, any>;
      featureMap: Attribute<TypeFromPartialBitSchema<{
          watermarks: BitFlag;
      }>, never>;
      generatedCommandList: Attribute<CommandId[], never>;
      threadMetrics: OptionalAttribute<TypeFromFields<{
          id: FieldType<number | bigint>;
          name: OptionalFieldType<string>;
          stackFreeCurrent: OptionalFieldType<number>;
          stackFreeMinimum: OptionalFieldType<number>;
          stackSize: OptionalFieldType<number>;
      }>[], any>;
  }

  • ReadonlyacceptedCommandList: Attribute<CommandId[], never>

    List of client generated commands which are supported by this cluster server instance.

  • ReadonlyattributeList: Attribute<AttributeId[], never>

    List of the attribute IDs of the attributes supported by the cluster instance.

  • ReadonlyclusterRevision: Attribute<number, never>

    Indicates the revision of the server cluster specification supported by the cluster instance.

  • 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

  • ReadonlycurrentHeapHighWatermark: Attribute<number | bigint, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            watermarks: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • 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

  • ReadonlyfeatureMap: Attribute<TypeFromPartialBitSchema<{
        watermarks: BitFlag;
    }>, never>

    Indicates whether the server supports zero or more optional cluster features.

  • ReadonlygeneratedCommandList: Attribute<CommandId[], never>

    List of server generated commands (server to client commands).

  • 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

• Readonlycommands: {
      resetWatermarks: Command<void, void, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              watermarks: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
  }

  • ReadonlyresetWatermarks: Command<void, void, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            watermarks: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

• 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

• Readonlyfeatures: {
      watermarks: BitFlag;
  }

  • Readonlywatermarks: BitFlag

    Watermarks

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

• Readonlyid: Branded<52, "ClusterId">

• Readonlyname: "SoftwareDiagnostics"

• Readonlyrevision: 1