NordicWiFiProvisioner is a library that allows to communicate with nRF 7 devices.
You can use it to connect to a device, read the information from it, and set the Wi-Fi configuration.
The library can be installed via Swift Package Manager or CocoaPods.
The library can also be included as SPM package. Simply add it in Xcode: File -> Swift Packages -> Add package dependency, type https://github.com/NordicSemiconductor/IOS-nRF-Wi-Fi-Provisioner.git and set required version, branch or commit.
If you have Swift.package file, include the following dependency:
dependencies: [
// [...]
.package(name: "NordicWiFiProvisioner",
url: "https://github.com/NordicSemiconductor/IOS-nRF-Wi-Fi-Provisioner.git",
.upToNextMajor(from: "x.y")) // Replace x.y with your required version
]You can install the library using CocoaPods. Add the following line to your Podfile:
pod 'NordicWiFiProvisioner'and run pod install in the directory containing your Podfile.
Check out the DOCUMENTATION for more details.
The library provides Scanner that allows to scan for nRF-7 Devices. If filters discovered devices by service UUID and returns only devices that have the wifi service, so you can use it to scan for devices that support Wi-Fi provisioning and don't warry about filtering them.
self.scanner = Scanner()
self.scanner.delegate = scannerDelegate
class ScannerDelegate {
func scannerDidUpdateState(_ state: Scanner.State) {
// Handle state change
}
func scannerStartedScanning() {
// Handle start scanning
}
func scannerStoppedScanning() {
// Handle stop scanning
}
}To connect to a device, you need to create a DeviceManager and call connect method.
deviceManager = DeviceManager(scanResult: scanResult)
deviceManager.connectionDelegate = connectionDelegate
deviceManager.connect()
class MyConnectionDelegate: ConnectionDelegate {
func deviceManagerConnectedDevice(_ deviceManager: DeviceManager) {
// Handle connected device
}
func deviceManagerDidFailToConnect(_ deviceManager: DeviceManager, error: Error) {
// Handle failed to connect
}
func deviceManagerDisconnectedDevice(_ deviceManager: DeviceManager, error: Error?) {
// Handle disconnected device
}
func deviceManager(_ deviceManager: DeviceManager, changedConnectionState newState: DeviceManager.ConnectionState) {
// Handle connection state change
}
}To read device information, you need to call readVersion and readDeviceStatus methods.
// Set delegate
deviceManager.infoDelegate = infoDelegate
// Read device information
try deviceManager.readVersion()
try deviceManager.readDeviceStatus()
class MyInfoDelegate: InfoDelegate {
func versionReceived(_ version: Result<Int, NordicWiFiProvisioner.ProvisionerInfoError>) {
// Handle version
}
func deviceStatusReceived(_ status: Result<NordicWiFiProvisioner.DeviceStatus, NordicWiFiProvisioner.ProvisionerError>) {
// Handle device status
}
}You can ask the device to scan for nearby Wi-Fi networks. The device will scan for networks and return the list of them.
// Set delegate
deviceManager.wiFiScanerDelegate = wifiScanDelegate
// Start / Stop scanning
try deviceManager.startScan()
try deviceManager.stopScan()
class MyWiFiScannerDelegate: WiFiScanerDelegate {
func deviceManager(_ deviceManager: DeviceManager, discoveredAccessPoint wifi: WifiInfo, rssi: Int?) {
// Handle new Wi-Fi network
}
func deviceManagerDidStartScan(_ deviceManager: DeviceManager, error: Error?) {
// Handle start scanning
}
func deviceManagerDidStopScan(_ deviceManager: DeviceManager, error: Error?) {
// Handle stop scanning
}
}To set Wi-Fi configuration, you need to call setWiFiConfiguration method.
// Set delegate
deviceManager.provisionerDelegate = provisionerDelegate
// Set configuration
try deviceManager.setConfig(wifi: wifi, passphrase: "WiFiPassword", volatileMemory: false)
// Forget configuration
try deviceManager.forgetConfig()
class MyProvisionDelegate: ProvisionDelegate {
func deviceManagerDidSetConfig(_ deviceManager: DeviceManager, error: Error?) {
// New configuration was set
}
func deviceManager(_ deviceManager: NordicWiFiProvisioner.DeviceManager, didChangeState state: NordicWiFiProvisioner.ConnectionState) {
// Connection Status changed
}
func deviceManagerDidForgetConfig(_ deviceManager: NordicWiFiProvisioner.DeviceManager, error: Error?) {
// Configuration was removed
}
}Application depends on one service which should be implemented by an IoT device:
14387800-130c-49e7-b877-2881c89cb258
The service contains 3 characteristics.
14387801-130c-49e7-b877-2881c89cb258- Unprotected version characteristic which return version number. It is reserved for checking supporting version before actual start of work.14387802-130c-49e7-b877-2881c89cb258- Protected with pairing control-point characteristic. It is used by the phone to send commands. In indication the command result status is obtained in asynchronous manner.14387803-130c-49e7-b877-2881c89cb258- Protected with pairing data-out characteristic. In notification the IoT device sends available Wi-Fi items and connectivity status updates.
The communication with the IoT device is handled with the usage of Proto files.
 |
 |
 |
 |
|---|---|---|---|
| 1 | 2 | 3 | 4 |
The application allows to communicate with a nRF 7 series device. The main job of the phone is to get status from the device and initiate provisioning or unprovisioning process.
- The phone connects to the selected IoT device and initialise pairing.
- After successful pairing it downloads current version and status.
- Based on status - provisioning or unprovisioning process can be initiated.
- The phone send START_SCAN command to the IoT device and waits for the result.
- The phone displays the list with result. An user can select Wi-Fi. If Wi-Fi item provides such an option, then there is a possibility to select a specific channel to connect.
- After selecting interesting Wi-Fi the phone should send STOP_SCAN command.
- The user needs to provide a password if the selected Wi-Fi is protected.
- The user selects if the Wi-Fi should be stored in persistent memory which means that Wi-Fi credentials should survive restarting process.
- Then the user clicks "Set Configuration" button which sends credential to the IoT device and receive connectivity changes from it.
- When the IoT device is provisioned then the process is finished and a next device can be provisioned.
- The phone sends FORGET_CONFIG command and receive success/error result.