Interface Complete

This cluster supports all ModeSelect 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>;
        currentMode: Attribute<number, any>;
        description: FixedAttribute<string, any>;
        featureMap: Attribute<TypeFromPartialBitSchema<{
            onOff: BitFlag;
        }>, never>;
        generatedCommandList: Attribute<CommandId[], never>;
        onMode: WritableAttribute<null | number, any> & {
            isConditional: true;
            mandatoryIf: [] | [{
                onOff: boolean;
            }];
            optional: true;
            optionalIf: [] | ConditionalFeatureList<BitSchema>;
        };
        standardNamespace: FixedAttribute<null | number, any>;
        startUpMode: OptionalWritableAttribute<null | number, any>;
        supportedModes: FixedAttribute<TypeFromFields<{
            label: FieldType<string>;
            mode: FieldType<number>;
            semanticTags: FieldType<TypeFromFields<{
                mfgCode: FieldType<(...)>;
                value: FieldType<(...)>;
            }>[]>;
        }>[], any>;
    }, GlobalAttributes<{
        onOff: BitFlag;
    }>>;
    base: undefined;
    commands: {
        changeToMode: Command<TypeFromFields<{
            newMode: FieldType<number>;
        }>, void, any>;
    };
    events: {};
    extensions: undefined;
    features: {
        onOff: BitFlag;
    };
    id: Branded<Branded<80, "ClusterId">, "ClusterId">;
    name: "ModeSelect";
    revision: 2;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            acceptedCommandList: Attribute<CommandId[], never>;
            attributeList: Attribute<AttributeId[], never>;
            clusterRevision: Attribute<number, never>;
            currentMode: Attribute<number, any>;
            description: FixedAttribute<string, any>;
            featureMap: Attribute<TypeFromPartialBitSchema<{
                onOff: BitFlag;
            }>, never>;
            generatedCommandList: Attribute<CommandId[], never>;
            onMode: WritableAttribute<null | number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    onOff: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            standardNamespace: FixedAttribute<null | number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                semanticTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        features: {
            onOff: BitFlag;
        };
        id: Branded<80, "ClusterId">;
        name: "ModeSelect";
        revision: 2;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            acceptedCommandList: Attribute<CommandId[], never>;
            attributeList: Attribute<AttributeId[], never>;
            clusterRevision: Attribute<number, never>;
            currentMode: Attribute<number, any>;
            description: FixedAttribute<string, any>;
            featureMap: Attribute<TypeFromPartialBitSchema<{
                onOff: BitFlag;
            }>, never>;
            generatedCommandList: Attribute<CommandId[], never>;
            onMode: WritableAttribute<null | number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    onOff: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            standardNamespace: FixedAttribute<null | number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                semanticTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        features: {
            onOff: BitFlag;
        };
        id: Branded<80, "ClusterId">;
        name: "ModeSelect";
        revision: 2;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            acceptedCommandList: Attribute<CommandId[], never>;
            attributeList: Attribute<AttributeId[], never>;
            clusterRevision: Attribute<number, never>;
            currentMode: Attribute<number, any>;
            description: FixedAttribute<string, any>;
            featureMap: Attribute<TypeFromPartialBitSchema<{
                onOff: BitFlag;
            }>, never>;
            generatedCommandList: Attribute<CommandId[], never>;
            onMode: WritableAttribute<null | number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    onOff: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            standardNamespace: FixedAttribute<null | number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                semanticTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        features: {
            onOff: BitFlag;
        };
        id: Branded<80, "ClusterId">;
        name: "ModeSelect";
        revision: 2;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            acceptedCommandList: Attribute<CommandId[], never>;
            attributeList: Attribute<AttributeId[], never>;
            clusterRevision: Attribute<number, never>;
            currentMode: Attribute<number, any>;
            description: FixedAttribute<string, any>;
            featureMap: Attribute<TypeFromPartialBitSchema<{
                onOff: BitFlag;
            }>, never>;
            generatedCommandList: Attribute<CommandId[], never>;
            onMode: WritableAttribute<null | number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    onOff: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            standardNamespace: FixedAttribute<null | number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                semanticTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        features: {
            onOff: BitFlag;
        };
        id: Branded<80, "ClusterId">;
        name: "ModeSelect";
        revision: 2;
    }>, 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>;
    currentMode: Attribute<number, any>;
    description: FixedAttribute<string, any>;
    featureMap: Attribute<TypeFromPartialBitSchema<{
        onOff: BitFlag;
    }>, never>;
    generatedCommandList: Attribute<CommandId[], never>;
    onMode: WritableAttribute<null | number, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            onOff: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    };
    standardNamespace: FixedAttribute<null | number, any>;
    startUpMode: OptionalWritableAttribute<null | number, any>;
    supportedModes: FixedAttribute<TypeFromFields<{
        label: FieldType<string>;
        mode: FieldType<number>;
        semanticTags: FieldType<TypeFromFields<{
            mfgCode: FieldType<(...)>;
            value: FieldType<(...)>;
        }>[]>;
    }>[], any>;
}, GlobalAttributes<{
    onOff: BitFlag;
}>>

base

base: undefined

commands

commands: {
    changeToMode: Command<TypeFromFields<{
        newMode: FieldType<number>;
    }>, void, any>;
}

Type declaration

  • ReadonlychangeToMode: Command<TypeFromFields<{
        newMode: FieldType<number>;
    }>, void, any>

    On receipt of this command, if the NewMode field indicates a valid mode transition within the supported list, the server shall set the CurrentMode attribute to the NewMode value, otherwise, the server shall respond with an INVALID_COMMAND status response.

    See

    MatterSpecification.v13.Cluster § 1.9.7.1

events

events: {}

extensions

extensions: undefined

features

features: {
    onOff: BitFlag;
}

Type declaration

  • ReadonlyonOff: BitFlag

    OnOff

    This feature creates a dependency between an OnOff cluster instance and this cluster instance on the same endpoint. See OnMode for more information.

    See

    MatterSpecification.v13.Cluster § 1.9.4.1

id

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

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            acceptedCommandList: Attribute<CommandId[], never>;
            attributeList: Attribute<AttributeId[], never>;
            clusterRevision: Attribute<number, never>;
            currentMode: Attribute<number, any>;
            description: FixedAttribute<string, any>;
            featureMap: Attribute<TypeFromPartialBitSchema<{
                onOff: BitFlag;
            }>, never>;
            generatedCommandList: Attribute<CommandId[], never>;
            onMode: WritableAttribute<null | number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    onOff: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            standardNamespace: FixedAttribute<null | number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                semanticTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        features: {
            onOff: BitFlag;
        };
        id: Branded<80, "ClusterId">;
        name: "ModeSelect";
        revision: 2;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          currentMode: number;
          description: string;
          onMode?: null | number;
          standardNamespace: null | number;
          startUpMode?: null | number;
          supportedModes: {
              label: string;
              mode: number;
              semanticTags: {
                  mfgCode: number;
                  value: number;
              }[];
          }[];
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            acceptedCommandList: Attribute<CommandId[], never>;
            attributeList: Attribute<AttributeId[], never>;
            clusterRevision: Attribute<number, never>;
            currentMode: Attribute<number, any>;
            description: FixedAttribute<string, any>;
            featureMap: Attribute<TypeFromPartialBitSchema<{
                onOff: BitFlag;
            }>, never>;
            generatedCommandList: Attribute<CommandId[], never>;
            onMode: WritableAttribute<null | number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    onOff: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            standardNamespace: FixedAttribute<null | number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                semanticTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        features: {
            onOff: BitFlag;
        };
        id: Branded<80, "ClusterId">;
        name: "ModeSelect";
        revision: 2;
    }>, ValuesT>

with

Settings

Member Visibility

On This Page

Properties
Methods