OtaSoftwareUpdateRequestor

@Generated(value = ["GoogleHomePlatformCodegen"])
interface OtaSoftwareUpdateRequestor : OtaSoftwareUpdateRequestorTrait.Attributes, MatterTrait, Updatable, OtaSoftwareUpdateRequestorCommands

API for the OtaSoftwareUpdateRequestor trait. This trait provides an interface to a device that is capable of receiving an OTA software update.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<OtaSoftwareUpdateRequestor>

Inherited functions
suspend Unit
announceOtaProvider(
    providerNodeId: ULong,
    vendorId: UShort,
    announcementReason: OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum,
    endpoint: UShort,
    optionalArgs: OtaSoftwareUpdateRequestorTrait.AnnounceOtaProviderCommand.OptionalArgs.() -> Unit
)

Announce the presence of a particular OTA provider.
BatchableCommand<Unit>
announceOtaProviderBatchable(
    providerNodeId: ULong,
    vendorId: UShort,
    announcementReason: OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum,
    endpoint: UShort,
    optionalArgs: OtaSoftwareUpdateRequestorTrait.AnnounceOtaProviderCommand.OptionalArgs.() -> Unit
)

The batchable version of announceOtaProvider command.
suspend Unit
suspend OtaSoftwareUpdateRequestor

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

Inherited properties
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
UShort

The revision of the server cluster specification supported by the cluster instance.
List<OtaSoftwareUpdateRequestorTrait.ProviderLocation>?

A list of available OTA providers.
UInt

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
Boolean?

true indicates that the OTA requestor can be updated.
OtaSoftwareUpdateRequestorTrait.UpdateStateEnum?

The current state of the OTA requestor with regard to obtaining software updates.
UByte?

The progress of the update as a percentage.
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: OtaSoftwareUpdateRequestor.Attribute): Boolean

supports

fun supports(command: OtaSoftwareUpdateRequestor.Command): Boolean

Public properties

factory

open val factory: TraitFactory<OtaSoftwareUpdateRequestor>