Variable BaseConst

Base: {
    attributes: {
        mask: Attribute<number, any>;
        state: Attribute<number, any>;
        supported: FixedAttribute<number, any>;
    };
    commands: {
        modifyEnabledAlarms: OptionalCommand<TypeFromFields, void, any>;
    };
    events: {
        notify: Event<TypeFromFields, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                latch: FixedAttribute<number, any>;
            };
            commands: {
                reset: Command<TypeFromFields, void, any>;
            };
        };
        flags: {
            reset: true;
        };
    }];
    features: {
        reset: BitFlag;
    };
    name: "AlarmBase";
    revision: 1;
}

AlarmBase is a derived cluster, not to be used directly. These elements are present in all clusters derived from AlarmBase.

Type declaration

  • Readonlyattributes: {
        mask: Attribute<number, any>;
        state: Attribute<number, any>;
        supported: FixedAttribute<number, any>;
    }
    • 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: {
        modifyEnabledAlarms: OptionalCommand<TypeFromFields, void, any>;
    }
    • ReadonlymodifyEnabledAlarms: OptionalCommand<TypeFromFields, 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

  • Readonlyevents: {
        notify: Event<TypeFromFields, any>;
    }
    • Readonlynotify: Event<TypeFromFields, 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

  • Readonlyextensions: readonly [{
        component: {
            attributes: {
                latch: FixedAttribute<number, any>;
            };
            commands: {
                reset: Command<TypeFromFields, void, any>;
            };
        };
        flags: {
            reset: true;
        };
    }]

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

  • Readonlyfeatures: {
        reset: BitFlag;
    }
    • Readonlyreset: BitFlag

      Reset

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

      See

      MatterSpecification.v13.Cluster § 1.15.4.1

  • Readonlyname: "AlarmBase"
  • Readonlyrevision: 1

Settings

Member Visibility