Interface Complete

This cluster supports all AlarmBase 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: {
        latch: FixedAttribute<number, any> & {
            isConditional: true;
            mandatoryIf: [] | [{
                reset: boolean;
            }];
            optional: true;
            optionalIf: [] | ConditionalFeatureList<BitSchema>;
        };
        mask: Attribute<number, any>;
        state: Attribute<number, any>;
        supported: FixedAttribute<number, any>;
    };
    commands: {
        modifyEnabledAlarms: OptionalCommand<TypeFromFields<{
            mask: FieldType<number>;
        }>, void, any>;
        reset: Command<TypeFromFields<{
            alarms: FieldType<number>;
        }>, void, any> & {
            isConditional: true;
            mandatoryIf: [] | [{
                reset: boolean;
            }];
            optional: true;
            optionalIf: [] | ConditionalFeatureList<BitSchema>;
        };
    };
    events: {
        notify: Event<TypeFromFields<{
            active: FieldType<number>;
            inactive: FieldType<number>;
            mask: FieldType<number>;
            state: FieldType<number>;
        }>, any>;
    };
    features: {
        reset: BitFlag;
    };
    name: "AlarmBase";
    revision: 1;
}

Hierarchy (view full)

Properties

attributes commands events features name revision

Properties

Readonlyattributes

attributes: {
    latch: FixedAttribute<number, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            reset: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    };
    mask: Attribute<number, any>;
    state: Attribute<number, any>;
    supported: FixedAttribute<number, any>;
}

Type declaration

  • Readonlylatch: FixedAttribute<number, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            reset: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }
  • Readonlymask: Attribute<number, any>

    Indicates a bitmap where each bit set in the Mask attribute corresponds to an alarm that shall be enabled.

    See

    MatterSpecification.v13.Cluster § 1.15.6.1

  • Readonlystate: Attribute<number, any>

    Indicates a bitmap where each bit shall represent the state of an alarm. The value of true means the alarm is active, otherwise the alarm is inactive.

    See

    MatterSpecification.v13.Cluster § 1.15.6.3

  • Readonlysupported: FixedAttribute<number, any>

    Indicates a bitmap where each bit shall represent whether or not an alarm is supported. The value of true means the alarm is supported, otherwise the alarm is not supported.

    If an alarm is not supported, the corresponding bit in Mask, Latch, and State shall be false.

    See

    MatterSpecification.v13.Cluster § 1.15.6.4

Readonlycommands

commands: {
    modifyEnabledAlarms: OptionalCommand<TypeFromFields<{
        mask: FieldType<number>;
    }>, void, any>;
    reset: Command<TypeFromFields<{
        alarms: FieldType<number>;
    }>, void, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            reset: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    };
}

Type declaration

  • ReadonlymodifyEnabledAlarms: OptionalCommand<TypeFromFields<{
        mask: FieldType<number>;
    }>, void, any>

    This command allows a client to request that an alarm be enabled or suppressed at the server.

    See

    MatterSpecification.v13.Cluster § 1.15.7.2

  • Readonlyreset: Command<TypeFromFields<{
        alarms: FieldType<number>;
    }>, void, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            reset: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

Readonlyevents

events: {
    notify: Event<TypeFromFields<{
        active: FieldType<number>;
        inactive: FieldType<number>;
        mask: FieldType<number>;
        state: FieldType<number>;
    }>, any>;
}

Type declaration

  • Readonlynotify: Event<TypeFromFields<{
        active: FieldType<number>;
        inactive: FieldType<number>;
        mask: FieldType<number>;
        state: FieldType<number>;
    }>, any>

    This event shall be generated when one or more alarms change state, and shall have these fields:

    See

    MatterSpecification.v13.Cluster § 1.15.8.1

Readonlyfeatures

features: {
    reset: BitFlag;
}

Type declaration

  • Readonlyreset: BitFlag

    Reset

    This feature indicates that alarms can be reset via the Reset command.

    See

    MatterSpecification.v13.Cluster § 1.15.4.1

Readonlyname

name

Readonlyrevision

revision

Settings

Member Visibility

On This Page

Properties