BooleanStateConfiguration

interface BooleanStateConfiguration : BooleanStateConfigurationTrait.Attributes, MatterTrait, Updatable, BooleanStateConfigurationCommands

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

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<BooleanStateConfiguration>

Inherited functions
From com.google.home.matter.standard.BooleanStateConfigurationCommands
suspend Unit

Enable or disable one or more alarm modes.
suspend Unit

Suppress one or more alarm modes.
From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend BooleanStateConfiguration
update(
    optimisticReturn: (BooleanStateConfiguration) -> Unit,
    init: BooleanStateConfigurationTrait.MutableAttributes.() -> Unit
)

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
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
BooleanStateConfigurationTrait.AlarmModeBitmap?

Indicates which specific alarm modes are currently active.
BooleanStateConfigurationTrait.AlarmModeBitmap?

The alarm modes that will be emitted if the sensor is triggered.
BooleanStateConfigurationTrait.AlarmModeBitmap?

The alarms supported by the sensor.
BooleanStateConfigurationTrait.AlarmModeBitmap?

Indicates which specific alarm modes are currently suppressed.
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
UShort

The revision of the server cluster specification supported by the cluster instance.
UByte?

The currently selected sensitivity level.
UByte?

The default sensitivity level selected by the manufacturer.
BooleanStateConfigurationTrait.Feature

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
BooleanStateConfigurationTrait.SensorFaultBitmap?

Indicates any faults registered by the device.
UByte?

Indicates the number of sensitivity levels supported by the device.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: BooleanStateConfiguration.Attribute): Boolean

supports

fun supports(command: BooleanStateConfiguration.Command): Boolean

Public properties

factory

open val factory: TraitFactory<BooleanStateConfiguration>