PowerSourceTrait.PowerSourceStatusEnum
enum PowerSourceTrait.PowerSourceStatusEnum : Enum, ClusterEnum
The participation of the power source in providing power to the device.
Summary
Enum Values |
|
|---|---|
Active |
The power source is available and is currently providing power to the device. |
Standby |
The power source is not currently providing power to the device, but is prepared to do so. |
Unavailable |
The power source is not currently available to supply power to the device. |
UnknownValue |
The enum value is out of range. |
Unspecified |
The status of the power source is not specified. |
Public functions |
|
|---|---|
String |
|
PowerSourceTrait.PowerSourceStatusEnum |
Returns the enum constant of this type with the specified name. |
Array<PowerSourceTrait.PowerSourceStatusEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<PowerSourceTrait.PowerSourceStatusEnum> |
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
Active
val PowerSourceTrait.PowerSourceStatusEnum.Active: PowerSourceTrait.PowerSourceStatusEnum
The power source is available and is currently providing power to the device.
Standby
val PowerSourceTrait.PowerSourceStatusEnum.Standby: PowerSourceTrait.PowerSourceStatusEnum
The power source is not currently providing power to the device, but is prepared to do so.
Unavailable
val PowerSourceTrait.PowerSourceStatusEnum.Unavailable: PowerSourceTrait.PowerSourceStatusEnum
The power source is not currently available to supply power to the device.
UnknownValue
val PowerSourceTrait.PowerSourceStatusEnum.UnknownValue: PowerSourceTrait.PowerSourceStatusEnum
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 PowerSourceTrait.PowerSourceStatusEnum.Unspecified: PowerSourceTrait.PowerSourceStatusEnum
The status of the power source is not specified.
Public functions
valueOf
fun valueOf(value: String): PowerSourceTrait.PowerSourceStatusEnum
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<PowerSourceTrait.PowerSourceStatusEnum>
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<PowerSourceTrait.PowerSourceStatusEnum>
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.