Interface Complete

This cluster supports all SoftwareDiagnostics features. It may support illegal feature combinations.

If you use this cluster you must manually specify which features are active and ensure the set of active features is legal per the Matter specification.

interface Complete {
    attributes: Merge<{
        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>;
    }, GlobalAttributes<{
        watermarks: BitFlag;
    }>>;
    base: undefined;
    commands: {
        resetWatermarks: Command<void, void, any> & {
            isConditional: true;
            mandatoryIf: [] | [{
                watermarks: boolean;
            }];
            optional: true;
            optionalIf: [] | ConditionalFeatureList<BitSchema>;
        };
    };
    events: {
        softwareFault: OptionalEvent<TypeFromFields<{
            faultRecording: OptionalFieldType<Uint8Array>;
            id: FieldType<number | bigint>;
            name: OptionalFieldType<string>;
        }>, any>;
    };
    extensions: undefined;
    features: {
        watermarks: BitFlag;
    };
    id: Branded<Branded<52, "ClusterId">, "ClusterId">;
    name: "SoftwareDiagnostics";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    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>;
}, GlobalAttributes<{
    watermarks: BitFlag;
}>>

Type declaration

  • 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

base

base: undefined

commands

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

events

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

Type declaration

extensions

extensions: undefined

features

features: {
    watermarks: BitFlag;
}

Type declaration

  • Readonlywatermarks: BitFlag

    Watermarks

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

id

id: Branded<Branded<52, "ClusterId">, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

  • alter<const AlterationsT>(alterations): WithAlterations<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, AlterationsT>

  • Modify elements using ElementModifier.alter.

    Type Parameters

    • const AlterationsT extends Alterations<Of<{
          attributes: {
              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>;
          };
          commands: {
              resetWatermarks: Command<void, void, any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      watermarks: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
          };
          events: {
              softwareFault: OptionalEvent<TypeFromFields<{
                  faultRecording: OptionalFieldType<Uint8Array>;
                  id: FieldType<number | bigint>;
                  name: OptionalFieldType<string>;
              }>, any>;
          };
          features: {
              watermarks: BitFlag;
          };
          id: Branded<52, "ClusterId">;
          name: "SoftwareDiagnostics";
          revision: 1;
      }>>

    Parameters

    Returns WithAlterations<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, AlterationsT>

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              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>;
          };
          commands: {
              resetWatermarks: Command<void, void, any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      watermarks: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
          };
          events: {
              softwareFault: OptionalEvent<TypeFromFields<{
                  faultRecording: OptionalFieldType<Uint8Array>;
                  id: FieldType<number | bigint>;
                  name: OptionalFieldType<string>;
              }>, any>;
          };
          features: {
              watermarks: BitFlag;
          };
          id: Branded<52, "ClusterId">;
          name: "SoftwareDiagnostics";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          currentHeapFree?: number | bigint;
          currentHeapHighWatermark?: number | bigint;
          currentHeapUsed?: number | bigint;
          threadMetrics?: {
              id: number | bigint;
              name?: string;
              stackFreeCurrent?: number;
              stackFreeMinimum?: number;
              stackSize?: number;
          }[];
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              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>;
          };
          commands: {
              resetWatermarks: Command<void, void, any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      watermarks: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
          };
          events: {
              softwareFault: OptionalEvent<TypeFromFields<{
                  faultRecording: OptionalFieldType<Uint8Array>;
                  id: FieldType<number | bigint>;
                  name: OptionalFieldType<string>;
              }>, any>;
          };
          features: {
              watermarks: BitFlag;
          };
          id: Branded<52, "ClusterId">;
          name: "SoftwareDiagnostics";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            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>;
        };
        commands: {
            resetWatermarks: Command<void, void, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    watermarks: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        events: {
            softwareFault: OptionalEvent<TypeFromFields<{
                faultRecording: OptionalFieldType<Uint8Array>;
                id: FieldType<number | bigint>;
                name: OptionalFieldType<string>;
            }>, any>;
        };
        features: {
            watermarks: BitFlag;
        };
        id: Branded<52, "ClusterId">;
        name: "SoftwareDiagnostics";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods