Skip to content

Commit

Permalink
doc improvement: Wi-Fi Provisioning
Browse files Browse the repository at this point in the history
Small style update and source code links added.

Signed-off-by: Katherine Depa <katherine.depa@nordicsemi.no>
  • Loading branch information
Katherine Depa authored and carlescufi committed Jun 22, 2023
1 parent 64922e8 commit 7424788
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 15 deletions.
29 changes: 16 additions & 13 deletions doc/nrf/libraries/bluetooth_services/services/wifi_prov.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,14 @@ Wi-Fi Provisioning Service
:local:
:depth: 2

This module implements a Bluetooth® GATT service for Wi-Fi® provisioning.
This library is to be used with the :ref:`wifi_provisioning` sample.
The Wi-Fi Provisioning Service forms a complete reference solution, together with the mobile application.
You can find details in the documentation of the :ref:`wifi_provisioning` sample.

Overview
********

This module implements a Bluetooth® GATT service for Wi-Fi® provisioning.

The service is divided into three parts:

* GATT service interface: Defines GATT service and provides an interface for the configurator to exchange messages.
Expand Down Expand Up @@ -74,9 +77,9 @@ The characteristic requirements of the Wi-Fi Provisioning Service are shown in t

The purpose of each characteristic is as follows:

* ``Information``: for client to get ``Info`` message from server.
* ``Operation Control Point``: for client to send ``Request`` message to server, and server to send ``Response`` message to client.
* ``Data Out``: for server to send ``Result`` message to the client.
* ``Information``: For client to get ``Info`` message from server.
* ``Operation Control Point``: For client to send ``Request`` message to server, and server to send ``Response`` message to client.
* ``Data Out``: For server to send ``Result`` message to the client.

Task and event handling
***********************
Expand Down Expand Up @@ -124,17 +127,17 @@ The service uses four message types:

The ``Response`` message contains one of following response codes:

* ``SUCCESS``: the operation is dispatched successfully.
* ``INVALID_ARGUMENT``: the argument is invalid.
* ``INVALID_PROTO``: the message cannot be encoded or decoded.
* ``INTERNAL_ERROR``: the operation cannot be dispatched properly.
* ``SUCCESS``: The operation is dispatched successfully.
* ``INVALID_ARGUMENT``: The argument is invalid.
* ``INVALID_PROTO``: The message cannot be encoded or decoded.
* ``INTERNAL_ERROR``: The operation cannot be dispatched properly.

If the command is ``GET_STATUS``, the response includes some or all of the following fields:

* ``state``: describes the Wi-Fi connection state according to values defined in the :file:`common.proto` file.
* ``provisioning_info``: includes Wi-Fi provisioning information stored in the non-volatile memory (NVM) of the device.
* ``connection_info``: includes Wi-Fi connection details.
* ``scan_info``: includes the parameters used for the AP scan.
* ``state``: Describes the Wi-Fi connection state according to values defined in the :file:`common.proto` file.
* ``provisioning_info``: Includes Wi-Fi provisioning information stored in the non-volatile memory (NVM) of the device.
* ``connection_info``: Includes Wi-Fi connection details.
* ``scan_info``: Includes the parameters used for the AP scan.

* ``Result``: Carries asynchronous data about the operation status.

Expand Down
3 changes: 3 additions & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@

.. _`nRF Blinky`: https://github.com/NordicSemiconductor/Android-nRF-Blinky

.. _`Source code for nRF Wi-Fi Provisioner mobile app for Android`: https://github.com/NordicSemiconductor/Android-nRF-Wi-Fi-Provisioner
.. _`Source code for nRF Wi-Fi Provisioner mobile app for iOS`: https://github.com/NordicSemiconductor/IOS-nRF-Wi-Fi-Provisioner

.. _`Ethernet over RTT for Linux`: https://github.com/doki-nordic/experimental-eth-rtt-link/

.. _`Memfault firmware SDK`: https://github.com/memfault/memfault-firmware-sdk
Expand Down
9 changes: 7 additions & 2 deletions samples/wifi/provisioning/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,13 @@ The sample supports the following development kits:
The sample requires a smartphone (configurator) with Nordic Semiconductor's nRF Wi-Fi Provisioner app installed in one of the following versions:

* `nRF Wi-Fi Provisioner mobile app for Android`_

* `Source code for nRF Wi-Fi Provisioner mobile app for Android`_

* `nRF Wi-Fi Provisioner mobile app for iOS`_

* `Source code for nRF Wi-Fi Provisioner mobile app for iOS`_

Overview
********

Expand Down Expand Up @@ -78,9 +83,9 @@ It contains the UUID of the Wi-Fi Provisioning Service and four bytes of service

* Flag: 16-bit little endian field. Byte 2 (first byte on air) is LSB, and Byte 3 (second byte on air) is MSB.

* Bit 0: provisioning status. The value is ``1`` if the device is provisioned, otherwise it is ``0``.
* Bit 0: Provisioning status. The value is ``1`` if the device is provisioned, otherwise it is ``0``.

* Bit 1: connection status. The value is ``1`` if Wi-Fi is connected, otherwise it is ``0``.
* Bit 1: Connection status. The value is ``1`` if Wi-Fi is connected, otherwise it is ``0``.

* Bit 2 - 15: RFU

Expand Down

0 comments on commit 7424788

Please sign in to comment.