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

Node

@Serializable

data class Node

The node represents a configured state of a mesh node.

Constructors

constructor(uuid: UUID, deviceKey: ByteArray, unicastAddress: UnicastAddress, elementCount: Int, assignedNetworkKey: NetworkKey, security: Security)

Convenience constructor to initialize a node from an unprovisioned device.

Properties

addresses

val addresses: List<UnicastAddress>

List of addresses used by this node.

appKeys

val appKeys: List<NodeKey>

Array of NodeKey that includes information about the ApplicationKeys known to this node.

applicationKeys

val applicationKeys: List<ApplicationKey>

List of application keys known to this node.

companyIdentifier

@Serializable(with = UShortAsStringSerializer::class)

var companyIdentifier: UShort?

16-bit Company Identifier (CID) assigned by the Bluetooth SIG. The value of this property is obtained from node composition data.

configComplete

var configComplete: Boolean

True if the Mesh Manager determines that this node’s configuration process is completed; otherwise, the property’s value is set to false.

defaultTTL

var defaultTTL: UByte?

0 to 127 that represents the default Time to Live (TTL) value used when sending messages.

deviceKey

@Serializable(with = KeySerializer::class)

val deviceKey: ByteArray?

128-bit device key. When importing a partially exported network configuration, the device key might not be present in the Mesh Network Configuration Database.

elements

val elements: List<Element>

Array of elements contained in the Node.

elementsCount

val elementsCount: Int

Number of elements belonging to this node.

excluded

var excluded: Boolean

True if the node is in the process of being deleted and is excluded from the new network key distribution during the Key Refresh procedure; otherwise, it is set to “false”.

features

var features: Features

Features supported by the node.

heartbeatPublication

var heartbeatPublication: HeartbeatPublication?

heartbeatSubscription

var heartbeatSubscription: HeartbeatSubscription?

lastUnicastAddress

val lastUnicastAddress: UnicastAddress

Address of the last element in the node.

name

var name: String

Human-readable name that can identify this node within the mesh network.

netKeys

val netKeys: List<NodeKey>

Array of NodeKey that includes information about the network keys known to this node.

networkKeys

val networkKeys: List<NetworkKey>

List of network keys known to this node.

networkTransmit

var networkTransmit: NetworkTransmit?

NetworkTransmit represents the parameters of the transmissions of network layer messages originating from a mesh node.

primaryElement

val primaryElement: Element?

primaryUnicastAddress

val primaryUnicastAddress: UnicastAddress

Address of the primary element in the node.

productIdentifier

@Serializable(with = UShortAsStringSerializer::class)

var productIdentifier: UShort?

16-bit, vendor-assigned Product Identifier (PID). The value of this property is obtained from node composition data.

relayRetransmit

var relayRetransmit: RelayRetransmit?

RelayRetransmit represents the parameters of the retransmissions of network layer messages relayed by a mesh node.

replayProtectionCount

@Serializable(with = UShortAsStringSerializer::class)

var replayProtectionCount: UShort?

16-bit value indicating the minimum number of Replay Protection List (RPL) entries for this node. The value of this property is obtained from node composition data. RPL implementation handles a multi-segment message transaction which is under a replay attack. The sequence number of the last segment that has been received for this message is stored for that peer node in the replay protection list.

secureNetworkBeacon

var secureNetworkBeacon: Boolean?

Represents whether the node is configured to send Secure Network beacons.

security

var security: Security

Represents the level of Security for the subnet on which the node has been originally provisioned.

unicastRange

val unicastRange: UnicastRange

Address range used by this node.

uuid

@Serializable(with = UUIDSerializer::class)

val uuid: UUID