ArmDisarmTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ArmDisarmTrait.Attributes
ArmDisarm |
API for the ArmDisarm trait. |
Attributes for the ArmDisarm cluster.
Summary
Public properties |
|
|---|---|
List<UInt> |
A list of client-generated commands which are supported by this cluster server instance. |
ArmDisarmTrait.ArmState? |
Current arm state of the device. |
List<UInt> |
A list of the attribute IDs of the attributes supported by the cluster instance. |
ArmDisarmTrait.AvailableArmLevels? |
The supported security levels of the device. |
UShort |
The revision of the server cluster specification supported by the cluster instance. |
String? |
The current security level. |
Long? |
The Epoch Unix timestamp of when an active entry allowance expires, before which the user must enter a pin to prevent the alarm from sounding. |
Long? |
The Epoch Unix timestamp of when an active exit allowance expires, before which the user must leave the house if the device is arming. |
UInt? |
Number of seconds before the |
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. |
Boolean? |
Indicates if the device is currently armed. |
String? |
The level from |
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.
availableArmLevels
val availableArmLevels: ArmDisarmTrait.AvailableArmLevels?
The supported security levels of the device.
Access type: Read
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
entryAllowanceEndTimeSeconds
val entryAllowanceEndTimeSeconds: Long?
The Epoch Unix timestamp of when an active entry allowance expires, before which the user must enter a pin to prevent the alarm from sounding. The timestamp is a long integer, such as 1710825433. Once the exact time represented by the timestamp has been reached, the alarm sounds. In the meantime, the device provides a time countdown to the user.
Access type: Read
exitAllowanceEndTimeSeconds
val exitAllowanceEndTimeSeconds: Long?
The Epoch Unix timestamp of when an active exit allowance expires, before which the user must leave the house if the device is arming. The timestamp is a long integer, such as 1710825433. Once the exact time represented by the timestamp has been reached, the alarm sounds. The user may cancel arming or disarming while this countdown is active.
Access type: Read
exitAllowanceSeconds
val exitAllowanceSeconds: UInt?
Number of seconds before the currentArmLevel takes effect.
Access type: Read
featureMap
val featureMap: UInt
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.
targetArmLevel
val targetArmLevel: String?
The level from availableArmLevels that the device will enter after an exit countdown completes.
Access type: Read