Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      sensorFault: OptionalAttribute<TypeFromPartialBitSchema<{
          generalFault: BitFlag;
      }>, any>;
  }

  • ReadonlysensorFault: OptionalAttribute<TypeFromPartialBitSchema<{
        generalFault: BitFlag;
    }>, any>

    Indicates any faults registered by the device.

    See

    MatterSpecification.v13.Cluster § 1.8.6.8

• Readonlyevents: {
      sensorFault: OptionalEvent<TypeFromFields<{
          sensorFault: FieldType<TypeFromPartialBitSchema<{
              generalFault: BitFlag;
          }>>;
      }>, any>;
  }

  • ReadonlysensorFault: OptionalEvent<TypeFromFields<{
        sensorFault: FieldType<TypeFromPartialBitSchema<{
            generalFault: BitFlag;
        }>>;
    }>, any>

    This event shall be generated when the device registers or clears a fault.

    See

    MatterSpecification.v13.Cluster § 1.8.8.2

• Readonlyextensions: readonly [{
      component: {
          attributes: {
              currentSensitivityLevel: WritableAttribute<number, any>;
              defaultSensitivityLevel: OptionalFixedAttribute<number, any>;
              supportedSensitivityLevels: FixedAttribute<number, any>;
          };
      };
      flags: {
          sensitivityLevel: true;
      };
  }, {
      component: {
          attributes: {
              alarmsActive: Attribute<TypeFromPartialBitSchema<{
                  audible: BitFlag;
                  visual: BitFlag;
              }>, any>;
              alarmsEnabled: OptionalAttribute<TypeFromPartialBitSchema<{
                  audible: BitFlag;
                  visual: BitFlag;
              }>, any>;
              alarmsSupported: FixedAttribute<TypeFromPartialBitSchema<{
                  audible: BitFlag;
                  visual: BitFlag;
              }>, any>;
          };
          commands: {
              enableDisableAlarm: Command<TypeFromFields<{
                  alarmsToEnableDisable: FieldType<TypeFromPartialBitSchema<(...)>>;
              }>, void, any>;
          };
          events: {
              alarmsStateChanged: Event<TypeFromFields<{
                  alarmsActive: FieldType<TypeFromPartialBitSchema<(...)>>;
                  alarmsSuppressed: OptionalFieldType<TypeFromPartialBitSchema<(...)>>;
              }>, any>;
          };
      };
      flags: {
          visual: true;
      };
  }, {
      component: {
          attributes: {
              alarmsActive: Attribute<TypeFromPartialBitSchema<{
                  audible: BitFlag;
                  visual: BitFlag;
              }>, any>;
              alarmsEnabled: OptionalAttribute<TypeFromPartialBitSchema<{
                  audible: BitFlag;
                  visual: BitFlag;
              }>, any>;
              alarmsSupported: FixedAttribute<TypeFromPartialBitSchema<{
                  audible: BitFlag;
                  visual: BitFlag;
              }>, any>;
          };
          commands: {
              enableDisableAlarm: Command<TypeFromFields<{
                  alarmsToEnableDisable: FieldType<TypeFromPartialBitSchema<(...)>>;
              }>, void, any>;
          };
          events: {
              alarmsStateChanged: Event<TypeFromFields<{
                  alarmsActive: FieldType<TypeFromPartialBitSchema<(...)>>;
                  alarmsSuppressed: OptionalFieldType<TypeFromPartialBitSchema<(...)>>;
              }>, any>;
          };
      };
      flags: {
          audible: true;
      };
  }, {
      component: {
          attributes: {
              alarmsSuppressed: Attribute<TypeFromPartialBitSchema<{
                  audible: BitFlag;
                  visual: BitFlag;
              }>, any>;
          };
          commands: {
              suppressAlarm: Command<TypeFromFields<{
                  alarmsToSuppress: FieldType<TypeFromPartialBitSchema<(...)>>;
              }>, void, any>;
          };
      };
      flags: {
          alarmSuppress: true;
      };
  }, {
      component: false;
      flags: {
          alarmSuppress: true;
          audible: true;
          visual: true;
      };
  }]

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

• Readonlyfeatures: {
      alarmSuppress: BitFlag;
      audible: BitFlag;
      sensitivityLevel: BitFlag;
      visual: BitFlag;
  }

  • ReadonlyalarmSuppress: BitFlag

    AlarmSuppress

    This feature shall indicate that the device is able to suppress the supported alarm modes, when the user acknowledges the alarm. This is intended to stop visual and/or audible alarms, when the user has become aware that the sensor is triggered, but it is no longer desired to have the alarm modes active on the device, e.g.:

    • The triggering cause have been resolved by the user, but the sensor has not yet stopped detecting the triggering cause.

    • The user is not able to address the triggering cause, but is aware of the alarm and suppress/acknowledge it be addressed at a later point.

    Acknowledge of alarms will for the remainder of this cluster be referred to as suppress.

    A suppressed alarm is still considered active and will remain so unless it is actively disabled or the triggering condition is not longer present. The action of suppressing an alarm mode is only applicable to and is intended to stop the physical alarming, e.g. emitting a sound or blinking a light; it does not impact alarm reporting in AlarmsActive.

    See

    MatterSpecification.v13.Cluster § 1.8.4.1

  • Readonlyaudible: BitFlag

    Audible

    Supports audible alarms

  • ReadonlysensitivityLevel: BitFlag

    SensitivityLevel

    Supports ability to set sensor sensitivity

  • Readonlyvisual: BitFlag

    Visual

    Supports visual alarms

• Readonlyid: 128

• Readonlyname: "BooleanStateConfiguration"

• Readonlyrevision: 1