core/no.nordicsemi.kotlin.mesh.core.messages/ConfigMessage

ConfigMessage

A base interface for all Configuration messages.

Configuration messages are used to configure Nodes. They are sent between Configuration Client model on the Configuration Manager and Configuration Server model on the device, which is being configured. All Config messages are encrypted using target Node's Device Key.

Inheritors

UnacknowledgedConfigMessage

AcknowledgedConfigMessage

ConfigVirtualLabelMessage

Types

ConfigMessageUtils

object ConfigMessageUtils

Properties

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.

isVendorMessage

open val isVendorMessage: Boolean

Whether the message is a Vendor Message, or not.

opCode

abstract val opCode: UInt

parameters

abstract val parameters: ByteArray?

Access layer payload, including the Op Code.

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.