OtaSoftwareUpdateRequestorCommands

interface OtaSoftwareUpdateRequestorCommands

Known direct subclasses
OtaSoftwareUpdateRequestor

API for the OtaSoftwareUpdateRequestor trait.


Summary

Public 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.

Public functions

announceOtaProvider

suspend fun announceOtaProvider(
    providerNodeId: ULong,
    vendorId: UShort,
    announcementReason: OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum,
    endpoint: UShort,
    optionalArgs: OtaSoftwareUpdateRequestorTrait.AnnounceOtaProviderCommand.OptionalArgs.() -> Unit = {}
): Unit

Announce the presence of a particular OTA provider.

Parameters
announcementReason: OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum

The reason for the announcement.

endpoint: UShort

The endpoint ID of the node that implements the OTA Provider cluster.

optionalArgs: OtaSoftwareUpdateRequestorTrait.AnnounceOtaProviderCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command