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

MeshNetwork

@Serializable

class MeshNetwork

MeshNetwork representing a Bluetooth mesh network.

Types

Companion

object Companion

Properties

applicationKeys

val applicationKeys: List<ApplicationKey>

List of app keys that includes information about app keys used in the mesh network.

groups

val groups: List<Group>

List of groups that includes information about groups configured in the mesh network.

ivIndex

var ivIndex: IvIndex

IV Index of the network received via the last Secure Network Beacon and its current state.

localProvisioner

val localProvisioner: Provisioner?

Main provisioner of the network which is the first provisioner in the list of provisioners.

name

var name: String

Human-readable name for the mesh network.

networkKeys

val networkKeys: List<NetworkKey>

List of network keys that includes information about network keys used in the mesh network.

nextAvailableApplicationKeyIndex

val nextAvailableApplicationKeyIndex: KeyIndex?

Returns the next available application key index that can be used when construction an application key.

nextAvailableNetworkKeyIndex

val nextAvailableNetworkKeyIndex: KeyIndex?

THe next available network key index, or null if the index 4095 is already in use.

nodes

val nodes: List<Node>

List of nodes that includes information about mesh nodes in the mesh network.

partial

var partial: Boolean

Indicates if this Mesh Configuration Database is part of a larger database.

primaryNetworkKey

val primaryNetworkKey: NetworkKey?

provisioners

val provisioners: List<Provisioner>

List of known Provisioners and ranges of addresses that have been allocated to these Provisioners.

scenes

val scenes: List<Scene>

List of scenes that includes information about scenes configured in the mesh network.

timestamp

var timestamp: Instant

Represents the last time the Mesh Object has been modified. The timestamp is based on Coordinated Universal Time.

uuid

@Serializable(with = UUIDSerializer::class)

val uuid: UUID

128-bit Universally Unique Identifier (Uuid), which allows differentiation among multiple mesh networks.

Functions

add

fun add(group: Group)

Adds a given Group to the list of groups in the mesh network.

fun add(node: Node)

Adds a given Node to the list of nodes in the mesh network.

fun add(provisioner: Provisioner)

Adds the given Provisioner to the list of provisioners in the network.

fun add(name: String, number: SceneNumber): Scene

Adds a given Scene with the given name and the scene number to the mesh network.

fun add(provisioner: Provisioner, address: UnicastAddress?)

Adds the given Provisioner with the given address to the list of provisioners in the network.

fun add(name: String, key: ByteArray = Crypto.generateRandomKey(), index: KeyIndex? = null): NetworkKey

Adds the given NetworkKey to the list of network keys in the network.

fun add(name: String, key: ByteArray = Crypto.generateRandomKey(), index: KeyIndex? = null, boundNetworkKey: NetworkKey): ApplicationKey

Adds the given ApplicationKey to the list of network keys in the network.

applicationKey

fun applicationKey(keyIndex: KeyIndex): ApplicationKey

Returns the application key with a given key index.

disableConfigurationCapabilities

fun disableConfigurationCapabilities(provisioner: Provisioner)

Disables the configuration capabilities by un-assigning provisioner's address. Un-assigning an address will delete the provisioner's node. This results in the provisioner not being able to send or receive mesh messages in the mesh network. However, the provisioner will still retain it's provisioning capabilities.

isAddressAvailable

fun isAddressAvailable(address: UnicastAddress, elementCount: Int): Boolean

Checks if the address is available to be assigned to a node with the given number of elements or false otherwise.

fun isAddressAvailable(address: UnicastAddress, node: Node): Boolean

Checks if the address is available to be assigned to a node with the given number of elements.

isAddressRangeAvailable

fun isAddressRangeAvailable(range: UnicastRange): Boolean

Checks if the address range is available for use.

matches

fun matches(networkId: ByteArray): Boolean

Checks if the given Network ID matches with any of the network keys in the network.

fun matches(networkId: NetworkIdentity): Boolean

Checks if the given Network Identity beacon matches with any of the network keys in the network.

fun matches(nodeIdentity: NodeIdentity): Boolean

This method may be used to match the Node Identity or Private Node Identity beacons.

move

fun move(provisioner: Provisioner, to: Int)

Moves the given provisioner to the specified index.

networkKey

fun networkKey(keyIndex: KeyIndex): NetworkKey

Returns the network key with a given key index.

nextAvailableGroup

fun nextAvailableGroup(provisioner: Provisioner): GroupAddress?

Returns the next available Group from the Provisioner's range that can be assigned to a new Group.

nextAvailableGroupAddressRange

fun nextAvailableGroupAddressRange(rangeSize: Int): GroupRange?

Next available unicast address range for a given range size.

nextAvailableScene

fun nextAvailableScene(provisioner: Provisioner = provisioners.first()): SceneNumber?

Returns the next available Scene number from the Provisioner's range that can be assigned to a new Scene.

nextAvailableSceneRange

fun nextAvailableSceneRange(rangeSize: Int): SceneRange?

Next available unicast address range for a given range size.

nextAvailableUnicastAddress

fun nextAvailableUnicastAddress(offset: UnicastAddress = UnicastAddress(minUnicastAddress), elementCount: Int, provisioner: Provisioner): UnicastAddress?

Returns the next available unicast address from the provisioner's range that can be assigned to a new node based on the given number of elements. The zeroth element is identified by the node's Unicast Address. Each following element is identified by a subsequent Unicast Address.

nextAvailableUnicastAddressRange