OtaSoftwareUpdateRequestorTrait.UpdateStateEnum

enum OtaSoftwareUpdateRequestorTrait.UpdateStateEnum : Enum, ClusterEnum


The state of an OTA update.

Summary

Enum Values

Applying

The node is in the process of verifying and applying a software update.

DelayedOnApply

The node is waiting due to an AwaitNextAction response.

DelayedOnQuery

The node is waiting after a Busy response.

DelayedOnUserConsent

The node is waiting on user consent.

Downloading

The node is in the process of downloading a software update.

Idle

The node is not yet in the process of software update.

Querying

The node is in the process of querying an OTA provider.

RollingBack

The node is recovering to a previous version.

Unknown

The current state is unknown.

UnknownValue

The enum value is out of range.

Public functions

OtaSoftwareUpdateRequestorTrait.UpdateStateEnum
valueOf(value: String)

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

Array<OtaSoftwareUpdateRequestorTrait.UpdateStateEnum>

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

Applying

val OtaSoftwareUpdateRequestorTrait.UpdateStateEnum.ApplyingOtaSoftwareUpdateRequestorTrait.UpdateStateEnum

The node is in the process of verifying and applying a software update.

DelayedOnApply

val OtaSoftwareUpdateRequestorTrait.UpdateStateEnum.DelayedOnApplyOtaSoftwareUpdateRequestorTrait.UpdateStateEnum

The node is waiting due to an AwaitNextAction response.

Downloading

val OtaSoftwareUpdateRequestorTrait.UpdateStateEnum.DownloadingOtaSoftwareUpdateRequestorTrait.UpdateStateEnum

The node is in the process of downloading a software update.

Idle

val OtaSoftwareUpdateRequestorTrait.UpdateStateEnum.IdleOtaSoftwareUpdateRequestorTrait.UpdateStateEnum

The node is not yet in the process of software update.

Querying

val OtaSoftwareUpdateRequestorTrait.UpdateStateEnum.QueryingOtaSoftwareUpdateRequestorTrait.UpdateStateEnum

The node is in the process of querying an OTA provider.

UnknownValue

val OtaSoftwareUpdateRequestorTrait.UpdateStateEnum.UnknownValueOtaSoftwareUpdateRequestorTrait.UpdateStateEnum

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): OtaSoftwareUpdateRequestorTrait.UpdateStateEnum

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<OtaSoftwareUpdateRequestorTrait.UpdateStateEnum>

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