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

Provisioner

@Serializable

A Provisioner is capable of provisioning a device to a mesh network and is represented by a provisioner object in the Mesh Configuration Database. A provisioner is represented as a node in mesh network only if it is assigned a unicast address. Having a unicast address assigned allows configuring nodes in the mesh network. Otherwise, a provisioner can only provision nodes to a mesh network.

Constructors

Provisioner

constructor(uuid: UUID = UUID.randomUUID())

Creates a Provisioner with the given UUID.

constructor(uuid: UUID = UUID.randomUUID(), name: String)

Creates a Provisioner with the given UUID and name.

constructor(name: String)

Creates a Provisioner with the given name.

Properties

allocatedGroupRanges

val allocatedGroupRanges: List<GroupRange>

List of allocated group ranges for a given provisioner.

allocatedSceneRanges

val allocatedSceneRanges: List<SceneRange>

List of allocated scene ranges for a given provisioner.

allocatedUnicastRanges

val allocatedUnicastRanges: List<UnicastRange>

List of allocated unicast ranges for a given provisioner.

hasConfigurationCapabilities

val hasConfigurationCapabilities: Boolean

Returns true if the provisioner has configuration capabilities.

isLocal

val isLocal: Boolean

Returns true if the Provisioner is set as the local Provisioner.

name

var name: String

Provisioner name.

node

val node: Node?

Node of the provisioner.

primaryUnicastAddress

val primaryUnicastAddress: UnicastAddress?

Primary unicast address of the provisioner.

uuid

@Serializable(with = UUIDSerializer::class)

val uuid: UUID

UUID of the provisioner.

Functions

allocate

fun allocate(ranges: List<Range>)

Allocates a list of ranges to a given provisioner.

fun allocate(range: GroupRange)

Allocates the given group range to a provisioner.

fun allocate(range: Range)

Allocates the given range to a provisioner.

fun allocate(range: SceneRange)

Allocates the given scene range to a provisioner.

fun allocate(range: UnicastRange)

Allocates the given unicast range to a provisioner.

areRangesAvailableForAllocation

fun areRangesAvailableForAllocation(ranges: List<Range>): Boolean

Check if the given list of ranges are allocatable to a provisioner.

assign

fun assign(address: UnicastAddress)

Assigns the unicast address to the given Provisioner. If the provisioner did not have a unicast address assigned, the method will create a Node with the address. This will enable configuration capabilities for the provisioner. The provisioner must be in the mesh network.

disableConfigurationCapabilities

fun disableConfigurationCapabilities()

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.

hasAllocatedRange