# BooleanStateConfiguration

# BooleanStateConfiguration


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface BooleanStateConfiguration : BooleanStateConfigurationTrait.Attributes, MatterTrait, Updatable, BooleanStateConfigurationCommands
```

<br />

*** ** * ** ***

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

## Summary

| ### Nested types |
|---|
| `class https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration.AlarmsStateChangedEvent : https://developers.home.google.com/reference/kotlin/com/google/home/Event, https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.AlarmsStateChanged` |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration.AlarmsStateChangedEvent.EventFields : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this event's fields. |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration.Attribute : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this trait's attributes. |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration.Command : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html` Descriptor enum for this trait's commands. |
| `class https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration.SensorFaultEvent : https://developers.home.google.com/reference/kotlin/com/google/home/Event, https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.SensorFault` |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration.SensorFaultEvent.EventFields : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this event's fields. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration#supports(com.google.home.matter.standard.BooleanStateConfiguration.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration.Attribute)` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration#supports(com.google.home.matter.standard.BooleanStateConfiguration.Command)(command: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration.Command)` |

| ### Public properties |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/TraitFactory<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration#factory()` |

| ### Inherited functions |
|---|
| From [com.google.home.matter.standard.BooleanStateConfigurationCommands](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationCommands) |---|---| | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationCommands#enableDisableAlarm(com.google.home.matter.standard.BooleanStateConfigurationTrait.AlarmModeBitmap)( alarmsToEnableDisable: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.AlarmModeBitmap )` Enable or disable one or more alarm modes. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationCommands#enableDisableAlarmBatchable(com.google.home.matter.standard.BooleanStateConfigurationTrait.AlarmModeBitmap)( alarmsToEnableDisable: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.AlarmModeBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationCommands#enableDisableAlarm(com.google.home.matter.standard.BooleanStateConfigurationTrait.AlarmModeBitmap)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationCommands#suppressAlarm(com.google.home.matter.standard.BooleanStateConfigurationTrait.AlarmModeBitmap)( alarmsToSuppress: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.AlarmModeBitmap )` Suppress one or more alarm modes. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationCommands#suppressAlarmBatchable(com.google.home.matter.standard.BooleanStateConfigurationTrait.AlarmModeBitmap)( alarmsToSuppress: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.AlarmModeBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationCommands#suppressAlarm(com.google.home.matter.standard.BooleanStateConfigurationTrait.AlarmModeBitmap)` command. | |
| From [com.google.home.matter.standard.BooleanStateConfigurationTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes) |---|---| | `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#getDescriptor()()` Returns the descriptor for the struct. | | `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` Returns the value of the field for the given tag ID. | |
| From [com.google.home.TraitStateInvalidation](https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation) |---|---| | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation#forceRead()()` | |
| From [com.google.home.Updatable](https://developers.home.google.com/reference/kotlin/com/google/home/Updatable) |---|---| | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration` | `https://developers.home.google.com/reference/kotlin/com/google/home/Updatable#update(kotlin.Function1,kotlin.Function1)( optimisticReturn: (https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfiguration) -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html, init: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.MutableAttributes.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state. | |

| ### Inherited properties |
|---|
| From [com.google.home.matter.standard.BooleanStateConfigurationTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes) |---|---| | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#acceptedCommandList()` A list of client-generated commands which are supported by this cluster server instance. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.AlarmModeBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#alarmsActive()` Indicates which specific alarm modes are currently active. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.AlarmModeBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#alarmsEnabled()` The alarm modes that will be emitted if the sensor is triggered. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.AlarmModeBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#alarmsSupported()` The alarms supported by the sensor. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.AlarmModeBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#alarmsSuppressed()` Indicates which specific alarm modes are currently suppressed. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#attributeList()` A list of the attribute IDs of the attributes supported by the cluster instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#clusterRevision()` The revision of the server cluster specification supported by the cluster instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#currentSensitivityLevel()` The currently selected sensitivity level. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#defaultSensitivityLevel()` The default sensitivity level selected by the manufacturer. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Feature` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#featureMap()` Whether the server supports zero or more optional cluster features. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#generatedCommandList()` A list of server-generated commands (server to client) which are supported by this cluster server instance. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.SensorFaultBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#sensorFault()` Indicates any faults registered by the device. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/BooleanStateConfigurationTrait.Attributes#supportedSensitivityLevels()` Indicates the number of sensitivity levels supported by the device. | |
| From [com.google.home.Trait](https://developers.home.google.com/reference/kotlin/com/google/home/Trait) |---|---| | `https://developers.home.google.com/reference/kotlin/com/google/home/Trait.TraitMetadata` | `https://developers.home.google.com/reference/kotlin/com/google/home/Trait#metadata()` | |

## Public functions

### supports

```
fun supports(attribute: BooleanStateConfiguration.Attribute): Boolean
```

### supports

```
fun supports(command: BooleanStateConfiguration.Command): Boolean
```

## Public properties

### factory

```
open val factory: TraitFactory<BooleanStateConfiguration>
```