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

Package-level declarations

Types

InputOobAction

enum InputOobAction : Enum<InputOobAction>

Actions a provisioner can request for Input OOB.

MeshProvisioner

interface MeshProvisioner : AutoCloseable

Discovers and provisions unprovisioned BLE Mesh devices.

OobAuthentication

sealed interface OobAuthentication

Out-of-Band authentication methods for BLE Mesh provisioning.

OobInfo

data class OobInfo(val staticOobSupported: Boolean = false, val outputOobActions: Set<OutputOobAction> = emptySet(), val outputOobSize: Int = 0, val inputOobActions: Set<InputOobAction> = emptySet(), val inputOobSize: Int = 0)

Device OOB capabilities from provisioning beacon.

OutputOobAction

enum OutputOobAction : Enum<OutputOobAction>

Actions a device can perform for Output OOB.

ProvisioningBearer

interface ProvisioningBearer : AutoCloseable

Abstract provisioning bearer for communicating with unprovisioned devices.

ProvisioningBearerType

enum ProvisioningBearerType : Enum<ProvisioningBearerType>

Types of provisioning bearers.

ProvisioningCapabilities

data class ProvisioningCapabilities(val numberOfElements: Int, val algorithms: Int, val publicKeyType: Boolean, val staticOobType: Boolean, val outputOobActions: Int, val outputOobSize: Int, val inputOobActions: Int, val inputOobSize: Int)

Capabilities reported by an unprovisioned device during provisioning.

ProvisioningData

data class ProvisioningData(val networkKey: NetworkKey, val keyIndex: KeyIndex, val ivIndex: IvIndex, val unicastAddress: MeshAddress.UnicastAddress, val deviceKey: DeviceKey)

Data distributed to a device during provisioning phase 5.

ProvisioningException

class ProvisioningException(val phase: ProvisioningPhase, reason: String) : Exception

Exception thrown when provisioning fails at a specific phase.

ProvisioningResult

data class ProvisioningResult(val node: MeshNode, val data: ProvisioningData)

Result of a completed provisioning operation.

UnprovisionedDevice

data class UnprovisionedDevice(val uuid: Uuid, val bleIdentifier: Identifier, val rssi: Int, val bearerType: ProvisioningBearerType, val oobInfo: OobInfo = OobInfo())

An unprovisioned BLE Mesh device discovered during scanning.

Functions

MeshProvisioner

actual fun MeshProvisioner(): MeshProvisioner

Create a platform-specific MeshProvisioner.

expect fun MeshProvisioner(): MeshProvisioner

Create a platform-specific MeshProvisioner.

actual fun MeshProvisioner(): MeshProvisioner

Create a platform-specific MeshProvisioner.

actual fun MeshProvisioner(): MeshProvisioner

Create a platform-specific MeshProvisioner.