core/no.nordicsemi.kotlin.mesh.core.layers/NetworkParameters

NetworkParameters

data class NetworkParameters(_defaultTtl: UByte, _sarDiscardTimeout: UByte, _sarAcknowledgementDelayIncrement: UByte, _sarReceiverSegmentIntervalStep: UByte, _sarSegmentsThreshold: UByte, _sarAcknowledgementRetransmissionCount: UByte, _sarSegmentIntervalStep: UByte, _sarUnicastRetransmissionsCount: UByte, _sarUnicastRetransmissionsWithoutProgressCount: UByte, _sarUnicastRetransmissionsIntervalStep: UByte, _sarUnicastRetransmissionsIntervalIncrement: UByte, _sarMulticastRetransmissionsCount: UByte, _sarMulticastRetransmissionsIntervalStep: UByte, _acknowledgementMessageTimeout: Duration = 30.seconds, _acknowledgementMessageInterval: Duration = 2.seconds)

A set of network parameters that can be applied to the `MeshNetworkManager`.

Network parameters configure the transmission and retransmission intervals, acknowledge message timeout, the default Time To Live (TTL) and others.

Constructors

NetworkParameters

constructor(_defaultTtl: UByte, _sarDiscardTimeout: UByte, _sarAcknowledgementDelayIncrement: UByte, _sarReceiverSegmentIntervalStep: UByte, _sarSegmentsThreshold: UByte, _sarAcknowledgementRetransmissionCount: UByte, _sarSegmentIntervalStep: UByte, _sarUnicastRetransmissionsCount: UByte, _sarUnicastRetransmissionsWithoutProgressCount: UByte, _sarUnicastRetransmissionsIntervalStep: UByte, _sarUnicastRetransmissionsIntervalIncrement: UByte, _sarMulticastRetransmissionsCount: UByte, _sarMulticastRetransmissionsIntervalStep: UByte, _acknowledgementMessageTimeout: Duration = 30.seconds, _acknowledgementMessageInterval: Duration = 2.seconds)

Constructs a NetworkParameters object.

Properties

acknowledgementDelayIncrement

var acknowledgementDelayIncrement: Double

acknowledgementMessageTimeInterval

var acknowledgementMessageTimeInterval: Duration

The base time after which the acknowledged message will be repeated.

acknowledgementMessageTimeout

var acknowledgementMessageTimeout: Duration

If the Element does not receive a response within a period of time known as the acknowledged message timeout, then the Element may consider the message has not been delivered, without sending any additional messages.

allowIvIndexRecoveryOver42

var allowIvIndexRecoveryOver42: Boolean

According to Bluetooth Mesh Profile 1.0.1, section 3.10.5, if the IV Index of the mesh network increased by more than 42 since the last connection (which can take at least 48 weeks), the Node should be re-provisioned. However, as this library can be used to provision other Nodes, it should not be blocked from sending messages to the network only because the phone wasn't connected to the network for that time. This flag can disable this check, effectively allowing such connection.

defaultTtl

var defaultTtl: UByte

Default Time To Live (TTL) will be used for sending messages. If the value has not been set in the Provisioner's Node. By default it is set to 5, which is a reasonable value. The TTL shall be in range 2...127.

discardTimeout

var discardTimeout: Duration

ivUpdateTestMode

var ivUpdateTestMode: Boolean

IV Update Test Mode enables efficient testing of the IV Update procedure. The IV Update test mode removes the 96-hour limit; all other behavior of the device are unchanged.

multicastRetransmissionsInterval

var multicastRetransmissionsInterval: Duration

sarAcknowledgementDelayIncrement

var sarAcknowledgementDelayIncrement: UByte

sarAcknowledgementRetransmissionCount

var sarAcknowledgementRetransmissionCount: UByte

sarDiscardTimeout

var sarDiscardTimeout: UByte

sarMulticastRetransmissionsCount

var sarMulticastRetransmissionsCount: UByte

sarMulticastRetransmissionsIntervalStep

var sarMulticastRetransmissionsIntervalStep: UByte