ArmDisarmTrait.ArmState
enum ArmDisarmTrait.ArmState : Enum, ClusterEnum
The current arm state of the device.
Summary
Enum Values |
|
|---|---|
Alarm |
The device is in the alarm state. |
Armed |
The device is in the armed state. |
Disarmed |
This device is in the disarmed state. |
ExitCountdown |
Number of seconds before the device enters the specified arm level. |
PreAlarm |
The device is in the pre-alarm state. |
UnknownValue |
The enum value is out of range. |
Unspecified |
The arm state is unspecified. |
Public functions |
|
|---|---|
ArmDisarmTrait.ArmState |
Returns the enum constant of this type with the specified name. |
Array<ArmDisarmTrait.ArmState> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
open String |
Trait identifier of the Matter Cluster that defines the enum Data Type. |
open String |
Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
open ULong |
Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |
Enum Values
Disarmed
val ArmDisarmTrait.ArmState.Disarmed: ArmDisarmTrait.ArmState
This device is in the disarmed state.
ExitCountdown
val ArmDisarmTrait.ArmState.ExitCountdown: ArmDisarmTrait.ArmState
Number of seconds before the device enters the specified arm level.
PreAlarm
val ArmDisarmTrait.ArmState.PreAlarm: ArmDisarmTrait.ArmState
The device is in the pre-alarm state.
UnknownValue
val ArmDisarmTrait.ArmState.UnknownValue: ArmDisarmTrait.ArmState
The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.
Unspecified
val ArmDisarmTrait.ArmState.Unspecified: ArmDisarmTrait.ArmState
The arm state is unspecified.
Public functions
valueOf
fun valueOf(value: String): ArmDisarmTrait.ArmState
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<ArmDisarmTrait.ArmState>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Public properties
traitId
open val traitId: String
Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.