Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
philips77 authored Jul 2, 2024
1 parent f1249fa commit e58ebc6
Showing 1 changed file with 29 additions and 22 deletions.
51 changes: 29 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

<a href='https://play.google.com/store/apps/details?id=no.nordicsemi.android.wifi.provisioning'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width='250'/></a>

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:<version>'
}
implementation 'no.nordicsemi.android.wifi:provisioning-ble:<version>'
```

```gradle
dependencies {
implementation 'no.nordicsemi.android.wifi:provisioning-softap:<version>'
}
implementation 'no.nordicsemi.android.wifi:provisioning-softap:<version>'
```

```gradle
dependencies {
implementation 'no.nordicsemi.android.wifi:provisioning-nfc:<version>'
}
implementation 'no.nordicsemi.android.wifi:provisioning-nfc:<version>'
```

#### 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.
Artifacts can be found on [Maven Central reopsitory](https://central.sonatype.com/search?q=no.nordicsemi.android.wifi&namespace=no.nordicsemi.android.wifi).

0 comments on commit e58ebc6

Please sign in to comment.