OccupancySensingTrait.Attributes

@Generated(value = ["GoogleHomePlatformCodegen"])
interface OccupancySensingTrait.Attributes : ClusterStruct

Known direct subclasses

OccupancySensing

OccupancySensing

API for the OccupancySensing trait.

Attributes for the OccupancySensing cluster.

Summary

Public functions
`open StructDescriptor`	`@HomeExperimentalGenericApi getDescriptor()` Returns the descriptor for the struct.
`open Any?`	`@HomeExperimentalGenericApi getFieldValueById(tagId: UInt)` Returns the value of the field for the given tag ID.

Public properties
`List<UInt>`	`acceptedCommandList` A list of client-generated commands which are supported by this cluster server instance.
`List<UInt>`	`attributeList` A list of the attribute IDs of the attributes supported by the cluster instance.
`UShort`	`clusterRevision` The revision of the server cluster specification supported by the cluster instance.
`OccupancySensingTrait.Feature`	`featureMap` Whether the server supports zero or more optional cluster features.
`List<UInt>`	`generatedCommandList` A list of server-generated commands (server to client) which are supported by this cluster server instance.
`UShort?`	`holdTime` The time delay, in seconds, before the sensor changes to its unoccupied state after the last detection of occupancy.
`OccupancySensingTrait.HoldTimeLimitsStruct?`	`holdTimeLimits` The server's limits and default value for the holdTime attribute.
`OccupancySensingTrait.OccupancyBitmap?`	`occupancy` The sensed (processed) status of occupancy.
`OccupancySensingTrait.OccupancySensorTypeEnum?`	`occupancySensorType` The type of occupancy sensor.
`OccupancySensingTrait.OccupancySensorTypeBitmap?`	`occupancySensorTypeBitmap` The active occupancy sensor type.
`UShort?`	`physicalContactOccupiedToUnoccupiedDelay` The time delay in seconds before the physical contact occupancy sensor switches to its unoccupied state after detecting an unoccupied event.
`UShort?`	`physicalContactUnoccupiedToOccupiedDelay` The time delay in seconds before the physical contact occupancy sensor switches to its occupied state after detecting an occupied event.
`UByte?`	`physicalContactUnoccupiedToOccupiedThreshold` The number of movement detection events required during the `physicalContactUnoccupiedToOccupiedDelay` period before the PIR sensor transitions to its occupied state.
`UShort?`	`pirOccupiedToUnoccupiedDelay` The time delay in seconds before the PIR sensor changes to its unoccupied state after detecting movement in the sensed area.
`UShort?`	`pirUnoccupiedToOccupiedDelay` The time delay in seconds before the PIR sensor changes to its occupied state after detecting movement in the sensed area.
`UByte?`	`pirUnoccupiedToOccupiedThreshold` The number of movement detection events that must occur within the PirUnoccupiedToOccupiedDelay period before the PIR sensor transitions to its occupied state.
`UShort?`	`ultrasonicOccupiedToUnoccupiedDelay` The time delay in seconds before the ultrasonic sensor changes to its unoccupied state after detecting movement in the sensed area.
`UShort?`	`ultrasonicUnoccupiedToOccupiedDelay` The time delay in seconds before the Ultrasonic sensor changes to its occupied state after detecting movement in the sensed area.
`UByte?`	`ultrasonicUnoccupiedToOccupiedThreshold` The number of movement detection events required during the `ultrasonicUnoccupiedToOccupiedDelay` period before the ultrasonic sensor transitions to its occupied state.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

acceptedCommandList

val acceptedCommandList: List<UInt>

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

attributeList

val attributeList: List<UInt>

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

clusterRevision

val clusterRevision: UShort

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

featureMap

val featureMap: OccupancySensingTrait.Feature

Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).

generatedCommandList

val generatedCommandList: List<UInt>

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

holdTime

val holdTime: UShort?

The time delay, in seconds, before the sensor changes to its unoccupied state after the last detection of occupancy.

Access type: Write

holdTimeLimits

val holdTimeLimits: OccupancySensingTrait.HoldTimeLimitsStruct?

The server's limits and default value for the holdTime attribute.

Access type: Read

occupancy

val occupancy: OccupancySensingTrait.OccupancyBitmap?

The sensed (processed) status of occupancy.

Access type: Read

occupancySensorType

val occupancySensorType: OccupancySensingTrait.OccupancySensorTypeEnum?

The type of occupancy sensor. Valid values are defined in OccupancySensorTypeEnum

Access type: Read

occupancySensorTypeBitmap

val occupancySensorTypeBitmap: OccupancySensingTrait.OccupancySensorTypeBitmap?

The active occupancy sensor type. Valid modes are defined in OccupancySensorTypeBitmap

Access type: Read

physicalContactOccupiedToUnoccupiedDelay

val physicalContactOccupiedToUnoccupiedDelay: UShort?

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

Access type: Write

physicalContactUnoccupiedToOccupiedDelay

val physicalContactUnoccupiedToOccupiedDelay: UShort?

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

Access type: Write

physicalContactUnoccupiedToOccupiedThreshold

val physicalContactUnoccupiedToOccupiedThreshold: UByte?

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

Access type: Write

pirOccupiedToUnoccupiedDelay

val pirOccupiedToUnoccupiedDelay: UShort?

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

Access type: Write

pirUnoccupiedToOccupiedDelay

val pirUnoccupiedToOccupiedDelay: UShort?

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

Access type: Write

pirUnoccupiedToOccupiedThreshold

val pirUnoccupiedToOccupiedThreshold: UByte?

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

Access type: Write

ultrasonicOccupiedToUnoccupiedDelay

val ultrasonicOccupiedToUnoccupiedDelay: UShort?

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

Access type: Write

ultrasonicUnoccupiedToOccupiedDelay

val ultrasonicUnoccupiedToOccupiedDelay: UShort?

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

Access type: Write

ultrasonicUnoccupiedToOccupiedThreshold

val ultrasonicUnoccupiedToOccupiedThreshold: UByte?

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

Access type: Write