IdentifyTrait.EffectIdentifierEnum
enum IdentifyTrait.EffectIdentifierEnum : Enum, ClusterEnum
The effect to use for an identification state or triggered effect.
Summary
Enum Values |
|
|---|---|
Blink |
A blinking effect, such as a light turned on and off once. |
Breathe |
A breathing effect, such as slowly turning a light on and off over 1 second, repeated multiple times. |
ChannelChange |
An effect that indicates a channel changes, such as a light turning orange for 8 seconds. |
FinishEffect |
The current effect sequence is completed before terminating. |
Okay |
An effect that indicates an okay state, such as a light turning green for a second. |
StopEffect |
The effect is terminated as soon as possible. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
IdentifyTrait.EffectIdentifierEnum |
Returns the enum constant of this type with the specified name. |
Array<IdentifyTrait.EffectIdentifierEnum> |
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
Blink
val IdentifyTrait.EffectIdentifierEnum.Blink: IdentifyTrait.EffectIdentifierEnum
A blinking effect, such as a light turned on and off once.
Breathe
val IdentifyTrait.EffectIdentifierEnum.Breathe: IdentifyTrait.EffectIdentifierEnum
A breathing effect, such as slowly turning a light on and off over 1 second, repeated multiple times.
ChannelChange
val IdentifyTrait.EffectIdentifierEnum.ChannelChange: IdentifyTrait.EffectIdentifierEnum
An effect that indicates a channel changes, such as a light turning orange for 8 seconds.
FinishEffect
val IdentifyTrait.EffectIdentifierEnum.FinishEffect: IdentifyTrait.EffectIdentifierEnum
The current effect sequence is completed before terminating. A sequence is a single repetition of the effect, such as a single blink or breathe.
Okay
val IdentifyTrait.EffectIdentifierEnum.Okay: IdentifyTrait.EffectIdentifierEnum
An effect that indicates an okay state, such as a light turning green for a second.
StopEffect
val IdentifyTrait.EffectIdentifierEnum.StopEffect: IdentifyTrait.EffectIdentifierEnum
The effect is terminated as soon as possible.
UnknownValue
val IdentifyTrait.EffectIdentifierEnum.UnknownValue: IdentifyTrait.EffectIdentifierEnum
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): IdentifyTrait.EffectIdentifierEnum
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<IdentifyTrait.EffectIdentifierEnum>
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.