ble/no.nordicsemi.android.wifi.provisioner.ble/ProvisionerRepository

ProvisionerRepository

interface ProvisionerRepository

A class responsible for establishing connection and maintaining communication with a nRF 7 device.

It has several methods which allows for sending Wi-Fi credentials to an IoT device. The typical flow contains:

start - Connecting to the device.
readVersion&getStatus - Obtaining the device's version and status.
startScan - Send START_SCAN command to the device and obtain Wi-Fi list.
stopScan - After getting desired result the scanning should be stopped.
setConfig - After selecting Wi-Fi and providing password, a provisioning data should be send to the DK.
Observe connection status and eventually repeat step 4 if the password was wrong.

The device can be unprovisioned, if Status returns Wi-Fi info, by calling forgetConfig.

The connection should be closed after the job is done by calling release.

Inheritors

ProvisionerRepositoryImpl

Types

object Companion

Functions

abstract suspend fun forgetConfig()

Unprovision the DK - forget slected SSID, password, etc.

abstract suspend fun getStatus(): DeviceStatusDomain

Read device status.

abstract suspend fun readVersion(): VersionDomain

Read the current version.

abstract fun release()

Closes connection with the DK.

abstract fun setConfig(config: WifiConfigDomain): Flow<WifiConnectionStateDomain>

Provision the connected DK with data obtained from startScan + password.

abstract suspend fun start(device: BluetoothDevice): Flow<ConnectionStatus>

Connects and initialise bonding with a selected device.

abstract fun startScan(): Flow<ScanRecordDomain>

Start scanning and obtains available Wi-Fi list.

abstract suspend fun stopScan()

Stop scanning for available Wi-Fi's. Should be called after startScan.