core/no.nordicsemi.kotlin.mesh.core.model/ApplicationKey

ApplicationKey

@Serializable

Application Keys are used to secure communications at the upper transport layer. The application key (AppKey) shall be generated using a random number generator compatible with the requirements in Volume 2, Part H, Section 2 of the Core Specification 1.

Parameters

_key

128-bit application key.

Properties

boundNetKeyIndex

var boundNetKeyIndex: KeyIndex

The boundNetKey property contains a corresponding Network Key index of the network key in the mesh network.

boundNetworkKey

val boundNetworkKey: NetworkKey?

Network key to which this application key is bound to.

index

val index: KeyIndex

The index property contains an integer from 0 to 4095 that represents the NetKey index for this network key.

isInUse

val isInUse: Boolean

key

var key: ByteArray

128-bit application key.

name

var name: String

Human-readable name for the application functionality associated with this application key.

oldKey

@Serializable(with = KeySerializer::class)

var oldKey: ByteArray?

OldKey property contains the previous application key.

Functions

bind

fun bind(networkKey: NetworkKey)

Binds the application key to a given network key. The application key must not be in use. If any of the network Nodes already knows this key, this method throws an error

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

isBoundTo

fun isBoundTo(networkKeys: List<NetworkKey>): Boolean

Checks if the application key is bound to any of the given list of network keys.

fun isBoundTo(networkKey: NetworkKey): Boolean

Checks if the application key is bound to a given network key.

setKey

fun setKey(key: ByteArray)

Updates the existing key with the given key, if it is not in use.