OccupancySensing

interface OccupancySensing : OccupancySensingTrait.Attributes, MatterTrait, Updatable


API for the OccupancySensing trait. This trait provides an interface to occupancy sensing functionality.

Summary

Nested types

Descriptor enum for this trait's attributes.

Public functions

Boolean

Public properties

open TraitFactory<OccupancySensing>

Inherited functions

From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend OccupancySensing

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.OccupancySensingTrait.Attributes
List<UInt>

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

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.

UInt

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.

OccupancySensingTrait.OccupancyBitmap?

The sensed (processed) status of occupancy.

OccupancySensingTrait.OccupancySensorTypeEnum?

The type of occupancy sensor.

OccupancySensingTrait.OccupancySensorTypeBitmap?

The active occupancy sensor type.

UShort?

The time delay in seconds before the physical contact occupancy sensor switches to its unoccupied state after detecting an unoccupied event.

UShort?

The time delay in seconds before the physical contact occupancy sensor switches to its occupied state after detecting an occupied event.

UByte?

The number of movement detection events required during the physicalContactUnoccupiedToOccupiedDelay period before the PIR sensor transitions to its occupied state.

UShort?

The time delay in seconds before the PIR sensor changes to its unoccupied state after detecting movement in the sensed area.

UShort?

The time delay in seconds before the PIR sensor changes to its occupied state after detecting movement in the sensed area.

UByte?

The number of movement detection events that must occur within the PirUnoccupiedToOccupiedDelay period before the PIR sensor transitions to its occupied state.

UShort?

The time delay in seconds before the ultrasonic sensor changes to its unoccupied state after detecting movement in the sensed area.

UShort?

The time delay in seconds before the Ultrasonic sensor changes to its occupied state after detecting movement in the sensed area.

UByte?

The number of movement detection events required during the ultrasonicUnoccupiedToOccupiedDelay period before the ultrasonic sensor transitions to its occupied state.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: OccupancySensing.Attribute): Boolean

Public properties

factory

open val factoryTraitFactory<OccupancySensing>