# BooleanStateConfigurationTrait

    struct BooleanStateConfigurationTrait

This trait provides an interface for configuring a boolean sensor, including optional state
change alarm features and configuration of the sensor's sensitivity level.
- `


  ### [supportedEventTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV014supportedEventC0Say0aB3SDK0J0_pXpGvpZ)


  ` List of the event types that are supported by `BooleanStateConfigurationTrait`.

  #### Declaration

  Swift

      static let supportedEventTypes: [any Event.Type]

- `


  ### [supportedCommandTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV016supportedCommandC0Say0aB3SDK0J0_pXpGvpZ)


  ` List of the commands that are supported by `BooleanStateConfigurationTrait`.

  #### Declaration

  Swift

      static let supportedCommandTypes: [any Command.Type]

- `


  ### [identifier](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV10identifierSSvpZ)


  ` The trait identifier.

  #### Declaration

  Swift

      static let identifier: String

- `


  ### [metadata](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV8metadata0aB3SDK0H8MetadataVvp)


  ` Metadata about this `Trait`.

  #### Declaration

  Swift

      let metadata: TraitMetadata

- `


  ### [attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV10attributesAE10AttributesVvp)


  ` List of attributes for the `BooleanStateConfigurationTrait`.

  #### Declaration

  Swift

      let attributes: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.BooleanStateConfigurationTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/Attributes.html

- `


  ### [init(decoder:interactionProxy:metadata:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV7decoder16interactionProxy8metadataAE0aB3SDK0H7DecoderV_AI011InteractionK0_pSgAI0H8MetadataVtKcfc)


  ` Creates a new Trait instance using data read from the given `TraitDecoder`.
  Throws
  `HomeError.parseError` when parsing fails.

  #### Declaration

  Swift

      init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

  #### Parameters

  |---|---|
  | ` decoder ` | The raw data representing this Trait. |
  | ` interactionProxy ` | Proxy to the Interaction Client. |
  | ` metadata ` | Metadata about this Trait. |

- `


  ### [encode(with:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV6encode4withy0aB3SDK0H7EncoderC_tKF)


  ` Writes this object to the given `TraitEncoder`.
  Throws `HomeError.encodingFailed` if the data could not be encoded.

  #### Declaration

  Swift

      func encode(with encoder: TraitEncoder) throws

- `


  ### [forceRead()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV9forceReadyyYaKF)


  ` This API provides the ability to invalidate state retrieved through subscriptions to the
  target device in the cases where state is not being reported correctly, either intentionally
  (e.g attributes in Matter traits with the "C" quality) or unintentionally due to poor
  implementations.

  When successful, this API will result in a forced read of the convening scope as specified by
  the sub-class and return the result through existing Trait subscriptions if present and
  active.

  This API is to be used sparingly as it can impact the performance and battery life of the
  target device. As such, this API may be throttled by the platform.
  Callers SHALL be prepared to deal with `HomeError`s thrown by this call.

  #### Declaration

  Swift

      func forceRead() async throws

- `


  ### [Attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/Attributes.html)


  ` Attributes for the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait.html`.

  #### Declaration

  Swift

      struct Attributes

- `


  ### [==(_:_:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV2eeoiySbAE_AEtFZ)


  ` Returns a Boolean value indicating whether two values are equal.

  Equality is the inverse of inequality. For any values `a` and `b`,
  `a == b` implies that `a != b` is `false`.

  #### Declaration

  Swift

      static func == (lhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.BooleanStateConfigurationTrait, rhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.BooleanStateConfigurationTrait) -> Bool

  #### Parameters

  |---|---|
  | ` lhs ` | A value to compare. |
  | ` rhs ` | Another value to compare. |

- `


  ### [hash(into:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV4hash4intoys6HasherVz_tF)


  ` Hashes the essential components of this value by feeding them into the
  given hasher.

  Implement this method to conform to the `Hashable` protocol. The
  components used for hashing must be the same as the components compared
  in your type's `==` operator implementation. Call `hasher.combine(_:)`
  with each of these components.
  Important

  In your implementation of `hash(into:)`,
  don't call `finalize()` on the `hasher` instance provided,
  or replace it with a different instance.
  Doing so may become a compile-time error in the future.

  #### Declaration

  Swift

      func hash(into hasher: inout Hasher)

- `


  ### [AlarmsStateChangedEvent](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/AlarmsStateChangedEvent.html)


  ` Generated after any bits in the `alarmsActive` or `alarmsSuppressed` attributes change.

  #### Declaration

  Swift

      struct AlarmsStateChangedEvent

- `


  ### [SensorFaultEvent](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/SensorFaultEvent.html)


  ` The device registered or cleared a fault.

  #### Declaration

  Swift

      struct SensorFaultEvent

- `


  ### [supportsSuppressAlarmCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV28supportsSuppressAlarmCommandSbvp)


  ` Whether the device supports the `suppressAlarm` command for this trait.

  #### Declaration

  Swift

      var supportsSuppressAlarmCommand: Bool { get }

- `


  ### [suppressAlarm(alarmsToSuppress:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV13suppressAlarm16alarmsToSuppressyAE0J10ModeBitmapV_tYaKF)


  ` Suppress one or more alarm modes.

  #### Declaration

  Swift

      func suppressAlarm(alarmsToSuppress: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.BooleanStateConfigurationTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/AlarmModeBitmap.html) async throws

  #### Parameters

  |---|---|
  | ` alarmsToSuppress ` | The alarm modes to suppress. |

- `


  ### [suppressAlarmBatchable(alarmsToSuppress:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV22suppressAlarmBatchable16alarmsToSuppress0aB3SDK0K7CommandVyytGAE0J10ModeBitmapV_tKF)


  ` The batchable version of suppressAlarm command above.
  See also
  suppressAlarm

  #### Declaration

  Swift

      func suppressAlarmBatchable(alarmsToSuppress: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.BooleanStateConfigurationTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/AlarmModeBitmap.html) throws -> BatchableCommand<Void>

- `


  ### [supportsEnableDisableAlarmCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV33supportsEnableDisableAlarmCommandSbvp)


  ` Whether the device supports the `enableDisableAlarm` command for this trait.

  #### Declaration

  Swift

      var supportsEnableDisableAlarmCommand: Bool { get }

- `


  ### [enableDisableAlarm(alarmsToEnableDisable:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV18enableDisableAlarm014alarmsToEnableJ0yAE0K10ModeBitmapV_tYaKF)


  ` Enable or disable one or more alarm modes.

  #### Declaration

  Swift

      func enableDisableAlarm(alarmsToEnableDisable: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.BooleanStateConfigurationTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/AlarmModeBitmap.html) async throws

  #### Parameters

  |---|---|
  | ` alarmsToEnableDisable ` | The alarm modes to enable or disable. |

- `


  ### [enableDisableAlarmBatchable(alarmsToEnableDisable:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait#/s:15GoogleHomeTypes6MatterO30BooleanStateConfigurationTraitV27enableDisableAlarmBatchable014alarmsToEnableJ00aB3SDK0L7CommandVyytGAE0K10ModeBitmapV_tKF)


  ` The batchable version of enableDisableAlarm command above.
  See also
  enableDisableAlarm

  #### Declaration

  Swift

      func enableDisableAlarmBatchable(alarmsToEnableDisable: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.BooleanStateConfigurationTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/AlarmModeBitmap.html) throws -> BatchableCommand<Void>

- `


  ### [AlarmModeBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/AlarmModeBitmap.html)


  ` The modes supported by the alarm.

  #### Declaration

  Swift

      struct AlarmModeBitmap

- `


  ### [Feature](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/Feature.html)


  ` BooleanStateConfiguration Trait FeatureMap.

  #### Declaration

  Swift

      struct Feature

- `


  ### [SensorFaultBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/BooleanStateConfigurationTrait/SensorFaultBitmap.html)


  ` Type of sensor fault.

  #### Declaration

  Swift

      struct SensorFaultBitmap