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

MeshNetwork

interface MeshNetwork : AutoCloseable

A BLE Mesh network.

MeshNetwork is the central entry point for BLE Mesh operations. It manages the network state (keys, nodes, IV Index), provides connectivity via GATT Proxy, and enables sending and receiving mesh messages.

Lifecycle

Created via MeshNetwork factory function with a builder DSL.
connectProxy establishes mesh connectivity through a proxy node.
send transmits mesh messages to any address on the network.
close disconnects the proxy and releases all resources.

Usage

val network = MeshNetwork {
    networkKey(myNetKey)
    applicationKey(myAppKey)
    element(MeshElement(0, UnicastAddress(0x0001u), ElementLocation.MAIN,
        listOf(MeshModelId.GenericOnOffClient)))
}

network.connectProxy(proxyPeripheral)
network.send(destination, MeshModelId.GenericOnOffServer,
    MeshOpcode(0x8202u), byteArrayOf(0x01), myAppKey)
network.close()

Inheritors

FakeMeshNetwork

Properties

applicationKeys

abstract val applicationKeys: List<ApplicationKey>

Application keys registered in this network.

configurationClient

abstract val configurationClient: ConfigurationClient

Client for configuring nodes post-provisioning.

incomingMessages

abstract val incomingMessages: Flow<MeshMessage>

Flow of incoming mesh messages addressed to our models.

isProxyConnected

abstract val isProxyConnected: StateFlow<Boolean>

Whether we are currently connected to a proxy node.

abstract val ivIndex: StateFlow<IvIndex>

Current IV Index of the network.

abstract val networkKeys: List<NetworkKey>

Network keys registered in this network.

abstract val nodes: StateFlow<List<MeshNode>>

All provisioned nodes in this network.

ownUnicastAddress

abstract val ownUnicastAddress: MeshAddress.UnicastAddress

Our unicast address on this mesh network.

Functions

addApplicationKey

abstract suspend fun addApplicationKey(key: ApplicationKey)

Add an application key to this network.

abstract suspend fun addNetworkKey(key: NetworkKey)

Add a network key to this network.

abstract suspend fun addNode(node: MeshNode)

Add a provisioned node to this network.

abstract override fun close()

Close the network and release all resources.

abstract suspend fun connectProxy(peripheral: Peripheral): ProxyConnection

Connect to the mesh network via a GATT Proxy node.

disconnectProxy

abstract suspend fun disconnectProxy()

Disconnect from the current proxy node.

abstract fun findNode(address: MeshAddress.UnicastAddress): MeshNode?

Find a node by its primary unicast address.

abstract suspend fun removeNode(address: MeshAddress.UnicastAddress)

Remove a node from this network.

abstract suspend fun send(destination: MeshAddress, modelId: MeshModelId, opcode: MeshOpcode, payload: ByteArray, appKey: ApplicationKey, acknowledged: Boolean = true, ttl: UByte): MeshMessageResponse?

Send a mesh message to a destination address.

abstract suspend fun sendConfig(destination: MeshAddress, opcode: MeshOpcode, payload: ByteArray, deviceKey: DeviceKey, acknowledged: Boolean = true, ttl: UByte): MeshMessageResponse?

Send a configuration message encrypted with the node's DeviceKey.