Variable VisualOrAudibleComponentConst

Type declaration

• Readonlyattributes: {
      alarmsActive: Attribute<TypeFromPartialBitSchema<{
          audible: BitFlag;
          visual: BitFlag;
      }>, any>;
      alarmsEnabled: OptionalAttribute<TypeFromPartialBitSchema<{
          audible: BitFlag;
          visual: BitFlag;
      }>, any>;
      alarmsSupported: FixedAttribute<TypeFromPartialBitSchema<{
          audible: BitFlag;
          visual: BitFlag;
      }>, any>;
  }

  • ReadonlyalarmsActive: Attribute<TypeFromPartialBitSchema<{
        audible: BitFlag;
        visual: BitFlag;
    }>, any>

    Indicates which specific alarm modes on the server are currently active. When the sensor is no longer triggered, this attribute shall be set to the inactive state, by setting the bit to 0, for all supported alarm modes.

    If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall indicate whether the alarm mode inactive or not:

    • 0 = Inactive

    • 1 = Active

    See

    MatterSpecification.v13.Cluster § 1.8.6.4

  • ReadonlyalarmsEnabled: OptionalAttribute<TypeFromPartialBitSchema<{
        audible: BitFlag;
        visual: BitFlag;
    }>, any>

    Indicates the alarm modes that will be emitted if the sensor is triggered. If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0.

    A bit shall indicate whether the alarm mode is enabled or disabled:

    • 0 = Disabled

    • 1 = Enabled

    See

    MatterSpecification.v13.Cluster § 1.8.6.6

  • ReadonlyalarmsSupported: FixedAttribute<TypeFromPartialBitSchema<{
        audible: BitFlag;
        visual: BitFlag;
    }>, any>

    Indicates the alarms supported by the sensor. A bit shall indicate whether the alarm mode is supported:

    • 0 = Not supported

    • 1 = Supported

    See

    MatterSpecification.v13.Cluster § 1.8.6.7

• Readonlycommands: {
      enableDisableAlarm: Command<TypeFromFields<{
          alarmsToEnableDisable: FieldType<TypeFromPartialBitSchema<{
              audible: BitFlag;
              visual: BitFlag;
          }>>;
      }>, void, any>;
  }

  • ReadonlyenableDisableAlarm: Command<TypeFromFields<{
        alarmsToEnableDisable: FieldType<TypeFromPartialBitSchema<{
            audible: BitFlag;
            visual: BitFlag;
        }>>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.8.7.2

• Readonlyevents: {
      alarmsStateChanged: Event<TypeFromFields<{
          alarmsActive: FieldType<TypeFromPartialBitSchema<{
              audible: BitFlag;
              visual: BitFlag;
          }>>;
          alarmsSuppressed: OptionalFieldType<TypeFromPartialBitSchema<{
              audible: BitFlag;
              visual: BitFlag;
          }>>;
      }>, any>;
  }

  • ReadonlyalarmsStateChanged: Event<TypeFromFields<{
        alarmsActive: FieldType<TypeFromPartialBitSchema<{
            audible: BitFlag;
            visual: BitFlag;
        }>>;
        alarmsSuppressed: OptionalFieldType<TypeFromPartialBitSchema<{
            audible: BitFlag;
            visual: BitFlag;
        }>>;
    }>, any>

    This event shall be generated after any bits in the AlarmsActive and/or AlarmsSuppressed attributes change. This may occur in situations such as when internal processing by the server determines that an alarm mode becomes active or inactive, or when the SuppressAlarm or EnableDisableAlarm commands are processed in a way that some alarm modes becomes suppressed, active or inactive.

    If several alarm modes change state at the same time, a single event combining multiple changes may be emitted instead of multiple events each representing a single change.

    See

    MatterSpecification.v13.Cluster § 1.8.8.1