OccupancySensingTrait.OccupancySensorTypeBitmap

data class OccupancySensingTrait.OccupancySensorTypeBitmap

The current active occupancy sensor type.

Summary

Public constructors
OccupancySensorTypeBitmap(
    pir: Boolean,
    ultrasonic: Boolean,
    physicalContact: Boolean
)

Creates the OccupancySensorTypeBitmap data class.

Public functions
open ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties
String

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

Supports a physical contact sensor.
Boolean

Supports a passive infrared sensor.
String

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

Supports an ultrasonic sensor.

Public constructors

OccupancySensorTypeBitmap

OccupancySensorTypeBitmap(
    pir: Boolean = false,
    ultrasonic: Boolean = false,
    physicalContact: Boolean = false
)

Creates the OccupancySensorTypeBitmap data class.

Public functions

toRaw

open fun toRaw(): ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties

bitmapName

val bitmapName: String

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

physicalContact

val physicalContact: Boolean

Supports a physical contact sensor.

pir

val pir: Boolean

Supports a passive infrared sensor.

traitId

val traitId: String

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

ultrasonic

val ultrasonic: Boolean

Supports an ultrasonic sensor.