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

NetworkKey

@Serializable

AThe network key object represents the state of the mesh network key that is used for securing communication at the network layer.

Types

Companion

object Companion

Properties

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

Returns whether the network key is added to any nodes in the network. A key that is in use cannot be removed until it has been removed from all the nodes and is no longer bound to any application keys.

isPrimary

val isPrimary: Boolean

Returns true if the network key is the primary network key.

key

var key: ByteArray

128-bit key.

name

var name: String

Human-readable name for the the mesh subnet associated with this network key.

networkId

lateinit var networkId: ByteArray

Network ID is derived from a network key and is used to identify the network

oldKey

@Serializable(with = KeySerializer::class)

var oldKey: ByteArray?

The oldKey property contains a 32-character hexadecimal string that represents the 128-bit network key, and shall be present when the phase property has a non-zero value, such as when the Key Refresh procedure is in progress. The value of the oldKey property contains the previous network key.

oldNetworkId

var oldNetworkId: ByteArray?

Old Network ID is derived from the old network key.

phase

var phase: KeyRefreshPhase

The phase property represents the KeyRefreshPhase for the subnet associated with this network key.

security

var security: Security

Security property contains a string with a value of either “insecure” or “secure”, which describes a minimum security level for a subnet associated with this network key. If all the nodes on the subnet associated with this network key have been provisioned using the Secure Provisioning procedure, then the value of minSecurity property for the subnet is set to “secure”; otherwise, the value of the minSecurity is set to “insecure”.

timestamp

var timestamp: Instant

The timestamp property contains a string that represents the last time the value of the phase property has been updated.

Functions

equals

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

hashCode

open override fun hashCode(): Int

lowerSecurity

fun lowerSecurity()

Sets the security level to secure.

setKey

fun setKey(key: ByteArray)

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