BooleanStateConfigurationTrait.Feature

data class BooleanStateConfigurationTrait.Feature

BooleanStateConfiguration Trait FeatureMap.

Summary

Public constructors
Feature(
    visual: Boolean,
    audible: Boolean,
    alarmSuppress: Boolean,
    sensitivityLevel: Boolean
)

Creates the Feature data class.

Public functions
open ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties
Boolean

The device is able to suppress the supported alarm modes once the user acknowledges the alarm.
Boolean

Supports audible alarms.
String

Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.
Boolean

Supports ability to set sensor sensitivity.
String

Trait identifier of the Matter Cluster that defines the bitmap Data Type.
Boolean

Supports visible alarms.

Public constructors

Feature

Feature(
    visual: Boolean = false,
    audible: Boolean = false,
    alarmSuppress: Boolean = false,
    sensitivityLevel: Boolean = false
)

Creates the Feature data class.

Public functions

toRaw

open fun toRaw(): ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties

alarmSuppress

val alarmSuppress: Boolean

The device is able to suppress the supported alarm modes once the user acknowledges the alarm. This is intended for situations where the user is aware that the sensor is triggered, but doesn't want the alarm to emit anymore, such as when:

  • The triggering cause is resolved by the user, but the sensor still detects the triggering cause.
  • The user can't address the triggering cause, but is aware of the alarm and wants the alarm to stop emitting.

audible

val audible: Boolean

Supports audible alarms.

bitmapName

val bitmapName: String

Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.

sensitivityLevel

val sensitivityLevel: Boolean

Supports ability to set sensor sensitivity.

traitId

val traitId: String

Trait identifier of the Matter Cluster that defines the bitmap Data Type. Refer to ClusterId.traitId for the format.

visual

val visual: Boolean

Supports visible alarms.