ClosureControlTrait.ClosureErrorEnum
enum ClosureControlTrait.ClosureErrorEnum : Enum, ClusterEnum
Error states that can be reported by the closure. The value range of 0x00 to 0x7F is for general errors, and the range of 0x80 to 0xBF is for vendor-specific errors.
Summary
Enum Values |
|
|---|---|
BlockedBySensor |
The closure is unsafe to move, as determined by a sensor, such as a photoelectric sensor. |
InternalInterference |
An internal element is prohibiting motion. |
MaintenanceRequired |
Applies when malfunctions that are not easily recoverable are detected, or when urgent servicing is needed. |
PhysicallyBlocked |
An obstacle is blocking the closure movement. |
TemperatureLimited |
A warning raised by the closure that indicates an over-temperature, possibly caused by an excessive drive or a stall current. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
String |
|
ClosureControlTrait.ClosureErrorEnum |
Returns the enum constant of this type with the specified name. |
Array<ClosureControlTrait.ClosureErrorEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<ClosureControlTrait.ClosureErrorEnum> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
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
BlockedBySensor
val ClosureControlTrait.ClosureErrorEnum.BlockedBySensor: ClosureControlTrait.ClosureErrorEnum
The closure is unsafe to move, as determined by a sensor, such as a photoelectric sensor.
InternalInterference
val ClosureControlTrait.ClosureErrorEnum.InternalInterference: ClosureControlTrait.ClosureErrorEnum
An internal element is prohibiting motion. For example this could be an integrated door that is open within a larger garage door so that the garage door is prevented from moving.
MaintenanceRequired
val ClosureControlTrait.ClosureErrorEnum.MaintenanceRequired: ClosureControlTrait.ClosureErrorEnum
Applies when malfunctions that are not easily recoverable are detected, or when urgent servicing is needed.
PhysicallyBlocked
val ClosureControlTrait.ClosureErrorEnum.PhysicallyBlocked: ClosureControlTrait.ClosureErrorEnum
An obstacle is blocking the closure movement.
TemperatureLimited
val ClosureControlTrait.ClosureErrorEnum.TemperatureLimited: ClosureControlTrait.ClosureErrorEnum
A warning raised by the closure that indicates an over-temperature, possibly caused by an excessive drive or a stall current.
UnknownValue
val ClosureControlTrait.ClosureErrorEnum.UnknownValue: ClosureControlTrait.ClosureErrorEnum
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.
Public functions
valueOf
fun valueOf(value: String): ClosureControlTrait.ClosureErrorEnum
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<ClosureControlTrait.ClosureErrorEnum>
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
entries
val entries: EnumEntries<ClosureControlTrait.ClosureErrorEnum>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.
traitId
open val traitId: String
Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.