OtaSoftwareUpdateRequestorTrait.AnnounceOtaProviderCommand.Request

class OtaSoftwareUpdateRequestorTrait.AnnounceOtaProviderCommand.Request


The request payload for the AnnounceOtaProvider command.

Summary

Public constructors

Request(
    providerNodeId: ULong,
    vendorId: UShort,
    announcementReason: OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum,
    metadataForNode: OptionalValue<ByteArray>,
    endpoint: UShort
)

Creates a request payload for the AnnounceOtaProvider command.

Public properties

OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum

The reason for the announcement.

UShort

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

OptionalValue<ByteArray>

A top-level anonymous list, where each list element contains a profile-specific tag encoded in fully-qualified form, and a manufacturer-specific payload.

ULong

The ID of a node implementing the OTA Provider cluster.

UShort

The assigned Vendor ID of the node invoking this command.

Public constructors

Request

Request(
    providerNodeId: ULong,
    vendorId: UShort,
    announcementReason: OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum = AnnouncementReasonEnum.SimpleAnnouncement,
    metadataForNode: OptionalValue<ByteArray> = OptionalValue.absent(),
    endpoint: UShort
)

Creates a request payload for the AnnounceOtaProvider command.

Public properties

announcementReason

val announcementReasonOtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum

The reason for the announcement.

endpoint

val endpointUShort

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

metadataForNode

val metadataForNodeOptionalValue<ByteArray>

A top-level anonymous list, where each list element contains a profile-specific tag encoded in fully-qualified form, and a manufacturer-specific payload.

providerNodeId

val providerNodeIdULong

The ID of a node implementing the OTA Provider cluster.

vendorId

val vendorIdUShort

The assigned Vendor ID of the node invoking this command.