From e58ebc685da7f4b62c0b101bd14f0a1a52c85fa4 Mon Sep 17 00:00:00 2001 From: Aleksander Nowakowski Date: Tue, 2 Jul 2024 22:13:52 +0200 Subject: [PATCH] Update README.md --- README.md | 51 +++++++++++++++++++++++++++++---------------------- 1 file changed, 29 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 3cbb73d3..e2940c33 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,63 @@ # nRF Wi-Fi Provisioner for Android -An Android library and a sample app for provisioning [nRF 7002 devices](https://www.nordicsemi.com/Products/nRF7002) to a Wi-Fi network. The library and sample application supports 3 different modes of provisioning. +An Android library and a sample app for provisioning [nRF 7002 devices](https://www.nordicsemi.com/Products/nRF7002) to a Wi-Fi network. + +The library and sample application supports 3 different modes of provisioning: * Bluetooth LE * SoftAp -* NFC (Note NFC is not a part of the current nRF Connect SDK release 2.7.0) +* NFC + +> [!Note] +> Provisioning over NFC is not a part of the current nRF Connect SDK release 2.7.0. ## Application Get it on Google Play -The application requires nRF700x Wi-Fi device with a nRF5x companion chip with firmware allowing provisioning over Bluetooth LE as a transport. +The application requires nRF700x Wi-Fi device with a nRF5x companion chip with firmware allowing provisioning over one of supported transport methods. + ### Features + * Provisioning over Bluetooth LE - - Obtaining device status + - Obtaining available Wi-Fi networks from the device - Provisioning to Wi-Fi network + - Obtaining device status - Unprovisioning -* Provisioning over SoftAP - - List nearby Wi-Fi networks +* Provisioning over Wi-Fi (SoftAP) + - Obtaining available Wi-Fi networks from the device - Provisioning to Wi-Fi network - - Verifying provisioning status - Note that Verification is an experimental feature + - Verifying provisioning status * Provisioning over NFC - Scan Wi-Fi network using the App - Manually Add a Wi-Fi Network - Provisioning to Wi-Fi network +### Known Issues + +* Provisioning over Wi-Fi (SoftAP) + - Verification may fail if the device was provisioned to a different network then the phone is connected to, even though the provisioned was successful. + - During a successful verification, the `DnsResolver` on certain Android versions/devices may cache the IP address of the SoftAP Provisioning service. + This can cause selecting a Wi-Fi network while provisioning/re-provisioning a device to fail. + However, turning Off and Nn the Wi-Fi adapter on the Android device before re-provisioning should fix this issue. + ## Libraries +![Maven Central Version](https://img.shields.io/maven-central/v/no.nordicsemi.android.wifi/provisioning-ble) + Include the library in your project by adding the following to your `build.gradle` file. ```gradle -dependencies { - implementation 'no.nordicsemi.android.wifi:provisioning-ble:' -} +implementation 'no.nordicsemi.android.wifi:provisioning-ble:' ``` ```gradle -dependencies { - implementation 'no.nordicsemi.android.wifi:provisioning-softap:' -} +implementation 'no.nordicsemi.android.wifi:provisioning-softap:' ``` ```gradle -dependencies { - implementation 'no.nordicsemi.android.wifi:provisioning-nfc:' -} +implementation 'no.nordicsemi.android.wifi:provisioning-nfc:' ``` -#### Known Issues -* Provisioning over SoftAP - - Verification may fail at times and even though the device could be successfully provisioned to the network. - - During a successful verification, the DnsResolver on certain Android versions/devices may cache the IP address of the SoftAP Provisioning service. - This can cause, selecting a Wi-Fi network while provisioning/re-provisioning a device to fail. - However, turning off and on the wifi on the Android device before re-provisioning should fix this issue. \ No newline at end of file +Artifacts can be found on [Maven Central reopsitory](https://central.sonatype.com/search?q=no.nordicsemi.android.wifi&namespace=no.nordicsemi.android.wifi).