OtaSoftwareUpdateRequestorTrait.AnnounceOtaProviderCommand.Request
class OtaSoftwareUpdateRequestorTrait.AnnounceOtaProviderCommand.Request : ClusterStruct
The request payload for the AnnounceOtaProvider command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the AnnounceOtaProvider command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
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 functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
announcementReason
val announcementReason: OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum
The reason for the announcement.
metadataForNode
val metadataForNode: 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.