core/no.nordicsemi.kotlin.mesh.core.messages.foundation.configuration/ConfigModelPublicationStatus

ConfigModelPublicationStatus

data class ConfigModelPublicationStatus(val publish: Publish, val elementAddress: UnicastAddress, val modelIdentifier: UShort, val companyIdentifier: UShort?, val status: ConfigMessageStatus = ConfigMessageStatus.SUCCESS) : ConfigResponse, ConfigStatusMessage, ConfigAnyModelMessage

This message is used to set the publication state of a model.

Constructors

constructor(publish: Publish, elementAddress: UnicastAddress, modelIdentifier: UShort, companyIdentifier: UShort?, status: ConfigMessageStatus = ConfigMessageStatus.SUCCESS)

Types

Initializer

object Initializer : ConfigMessageInitializer

Properties

companyIdentifier

open override val companyIdentifier: UShort?

Company identifier, as defined in Assigned Numbers, or nil, if the Model is defined in Bluetooth Mesh Model Specification.

elementAddress

open override val elementAddress: UnicastAddress

Unicast Address of the Model's parent Element.

isAcknowledged

open val isAcknowledged: Boolean

Defines if the message should be sent as an acknowledged message.

isSegmented

open val isSegmented: Boolean

Defines if the message should be sent or was sent as Segmented Access Message. By default, this returns false. To force segmentation for shorter messages return true despite payload length. If payload size is longer than 11 bytes this field is not checked as the message must be segmented.

isSuccess

open override val isSuccess: Boolean

True if the message was successful or false otherwise.

isVendorMessage

open val isVendorMessage: Boolean

Whether the message is a Vendor Message, or not.

message

open override val message: String

Status message of the operation.

modelId

open override val modelId: ModelId

32-bit Model identifier.

modelIdentifier

open override val modelIdentifier: UShort

16-bit Model identifier.

opCode

open override val opCode: UInt

parameters

open override val parameters: ByteArray

Access layer payload, including the Op Code.

publish

val publish: Publish

Contains the publication state.

security

open val security: MeshMessageSecurity

Defines if the message should be sent or has been sent using 32-bit or 64-bit TransMIC value. By default MeshMessageSecurity.Low is used. Only Segmented Access Messages can use 64-bit MIC. If the payload is shorter than 11 bytes, make sure you return true from MeshMessage.isSegmented, otherwise this field will be ignored.

status

open override val status: ConfigMessageStatus

Status of the Config operation.