ArmDisarmTrait.ErrorCode

enum ArmDisarmTrait.ErrorCode : Enum, ClusterEnum


The error encountered when processing the ArmDisarm command.

Summary

Enum Values

DeviceMoved

The device has been moved.

DeviceTampered

There are indications that tampering of the device has occurred.

DeviceUnplugged

The device is unplugged.

DoorOpen

The device has detected an open door.

IsOpen

The device sensor detects that something is open, but it cannot detect whether it is a door or window that is open.

MotionDetected

The device has detected motion.

UnknownValue

The enum value is out of range.

Unspecified

An unspecified error has occurred.

WindowOpen

The device has detected an open window.

Public functions

ArmDisarmTrait.ErrorCode
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<ArmDisarmTrait.ErrorCode>

Returns an array containing the constants of this enum type, in the order they're declared.

Public properties

open String
open String
open ULong

Enum Values

DeviceMoved

val ArmDisarmTrait.ErrorCode.DeviceMovedArmDisarmTrait.ErrorCode

The device has been moved.

DeviceTampered

val ArmDisarmTrait.ErrorCode.DeviceTamperedArmDisarmTrait.ErrorCode

There are indications that tampering of the device has occurred.

DeviceUnplugged

val ArmDisarmTrait.ErrorCode.DeviceUnpluggedArmDisarmTrait.ErrorCode

The device is unplugged.

DoorOpen

val ArmDisarmTrait.ErrorCode.DoorOpenArmDisarmTrait.ErrorCode

The device has detected an open door.

IsOpen

val ArmDisarmTrait.ErrorCode.IsOpenArmDisarmTrait.ErrorCode

The device sensor detects that something is open, but it cannot detect whether it is a door or window that is open.

MotionDetected

val ArmDisarmTrait.ErrorCode.MotionDetectedArmDisarmTrait.ErrorCode

The device has detected motion.

UnknownValue

val ArmDisarmTrait.ErrorCode.UnknownValueArmDisarmTrait.ErrorCode

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.ErrorCode.UnspecifiedArmDisarmTrait.ErrorCode

An unspecified error has occurred.

WindowOpen

val ArmDisarmTrait.ErrorCode.WindowOpenArmDisarmTrait.ErrorCode

The device has detected an open window.

Public functions

valueOf

fun valueOf(value: String): ArmDisarmTrait.ErrorCode

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.ErrorCode>

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 traitIdString

typeName

open val typeNameString

value

open val valueULong