DoorLockTrait.OperatingModeEnum
enum DoorLockTrait.OperatingModeEnum : Enum, ClusterEnum
Operating modes.
Summary
Enum Values |
|
|---|---|
NoRemoteLockUnlock |
This mode only disables remote interaction with the lock. |
Normal |
The lock operates normally. |
Passage |
The lock is open or can be opened or closed at will without the use of a keypad or other means of user validation, for example, a lock for a business during work hours. |
Privacy |
This mode is only possible if the door is locked. |
UnknownValue |
The enum value is out of range. |
Vacation |
Only remote interaction is enabled. |
Public functions |
|
|---|---|
DoorLockTrait.OperatingModeEnum |
Returns the enum constant of this type with the specified name. |
Array<DoorLockTrait.OperatingModeEnum> |
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
NoRemoteLockUnlock
val DoorLockTrait.OperatingModeEnum.NoRemoteLockUnlock: DoorLockTrait.OperatingModeEnum
This mode only disables remote interaction with the lock. This does not apply to any remote proprietary means of communication. It specifically applies to the Lock, Unlock, Toggle, and Unlock with Timeout commands.
Normal
val DoorLockTrait.OperatingModeEnum.Normal: DoorLockTrait.OperatingModeEnum
The lock operates normally. All interfaces are enabled.
Passage
val DoorLockTrait.OperatingModeEnum.Passage: DoorLockTrait.OperatingModeEnum
The lock is open or can be opened or closed at will without the use of a keypad or other means of user validation, for example, a lock for a business during work hours.
Privacy
val DoorLockTrait.OperatingModeEnum.Privacy: DoorLockTrait.OperatingModeEnum
This mode is only possible if the door is locked. Manual unlocking changes the mode to Normal operating mode. All external interaction with the door lock is disabled. This mode is intended to be used so that users, presumably inside the property, will have control over the entrance.
UnknownValue
val DoorLockTrait.OperatingModeEnum.UnknownValue: DoorLockTrait.OperatingModeEnum
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.
Vacation
val DoorLockTrait.OperatingModeEnum.Vacation: DoorLockTrait.OperatingModeEnum
Only remote interaction is enabled.
Public functions
valueOf
fun valueOf(value: String): DoorLockTrait.OperatingModeEnum
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<DoorLockTrait.OperatingModeEnum>
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.