kmp-ble-mesh/com.atruedev.kmpble.mesh.provisioning/MeshProvisioner

MeshProvisioner

interface MeshProvisioner : AutoCloseable

Discovers and provisions unprovisioned BLE Mesh devices.

MeshProvisioner handles the complete provisioning lifecycle:

Scan for unprovisioned devices via PB-ADV or PB-GATT
Run the provisioning protocol (ECDH + OOB authentication + data distribution)
Return a provisioned MeshNode ready for configuration

Usage

val provisioner = MeshProvisioner()
provisioner.scanEvents.collect { device ->
    val result = provisioner.provision(
        device = device,
        networkKey = myNetKey,
        unicastAddress = allocateAddress(),
        oobAuth = OobAuthentication.None,
    )
    network.addNode(result.node)
}
provisioner.close()

Inheritors

FakeProvisioner

Properties

scanEvents

abstract val scanEvents: Flow<UnprovisionedDevice>

Flow of discovered unprovisioned devices. Emits when a new device beacon is seen.

Functions

abstract override fun close()

provision

abstract suspend fun provision(device: UnprovisionedDevice, networkKey: NetworkKey, unicastAddress: MeshAddress.UnicastAddress, oobAuth: OobAuthentication = OobAuthentication.None): ProvisioningResult

Provision a discovered unprovisioned device.