Skip to content

Commit 5506892

Browse files
richabpnordicjm
authored andcommitted
doc improvement: Fixed some doc issues
Fixed miscellaneous doc issues. Signed-off-by: Richa Pandey <[email protected]>
1 parent 2df4adc commit 5506892

File tree

3 files changed

+119
-109
lines changed

3 files changed

+119
-109
lines changed

applications/nrf5340_audio/doc/feature_support.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ nRF5340 Audio DNs and QDIDs
2525

2626
The following DNs (Design Numbers) and QDIDs (Qualified Design IDs) are related to the nRF5340 LE Audio applications:
2727

28-
nRF5340 DK Bluetooth DNs/QDIDs
28+
nRF5340 Bluetooth DNs/QDIDs
2929
See `nRF5340 Bluetooth DNs and QDIDs Compatibility Matrix`_ for the DNs/QDIDs for nRF5340 LE Audio applications.
3030

3131
A full Audio product DN will typically require DNs/QDIDs for Controller component, Host component, Profiles and Services component and LC3 codec component.

samples/wifi/provisioning/internal/README.rst

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
.. _wifi_provisioning_internal_sample:
22

3-
Wi-Fi Provisioning Internal Sample
4-
##################################
3+
Wi-Fi: Provisioning Internal
4+
############################
55

66
.. contents::
77
:local:
88
:depth: 2
99

10-
This sample demonstrates the internal Wi-Fi® provisioning functionality using the decoupled Wi-Fi provisioning library.
10+
The Provisioning Internal sample demonstrates the internal Wi-Fi® provisioning functionality using the decoupled Wi-Fi provisioning library.
1111
The sample demonstrates proper integration of the Wi-Fi provisioning library with comprehensive testing capabilities and human-readable protocol decoding.
1212
It provides shell commands to test all supported Wi-Fi provisioning operations.
1313

@@ -21,19 +21,19 @@ The sample supports the following development kits:
2121
Overview
2222
********
2323

24-
The sample uses the core Wi-Fi provisioning library (``wifi_prov_core``) with a transport stub implementation that decodes and logs protobuf messages.
24+
The sample uses the :ref:`lib_wifi_prov_core` library with a transport stub implementation that decodes and logs protobuf messages.
2525
This allows testing of the provisioning protocol without requiring a Bluetooth® transport layer.
2626

2727
Features
2828
********
2929

3030
This sample demonstrates the following features:
3131

32-
* Transport Decoupling - Uses the core Wi-Fi provisioning library without Bluetooth® dependencies.
33-
* Protobuf Decoding - Automatically decodes and logs all requests and responses.
34-
* Comprehensive Testing - Shell commands for all supported operations.
35-
* Raw Data Support - Ability to send custom binary data for testing.
36-
* Configurable Generation - Wi-Fi configuration generated from Kconfig options.
32+
* Transport decoupling - Uses the Wi-Fi Provisioning Core library without Bluetooth dependencies.
33+
* Protobuf decoding - Automatically decodes and logs all requests and responses.
34+
* Comprehensive testing - Shell commands for all supported operations.
35+
* Raw data support - Ability to send custom binary data for testing.
36+
* Configurable generation - Wi-Fi configuration generated from Kconfig options.
3737

3838
Architecture
3939
************
@@ -208,9 +208,9 @@ The sample provides the following shell commands for testing Wi-Fi provisioning
208208
* - ``wifi_prov``
209209
- Send pregenerated Wi-Fi configuration data to the provisioning service.
210210
* - ``wifi_prov raw <base64_data>``
211-
- Send raw protobuf-encoded data (Base64 format) to the provisioning service.
211+
- Send raw protobuf-encoded data (in Base64 format) to the provisioning service.
212212
* - ``wifi_prov dump_scan <base64_data>``
213-
- Decode and display scan results in human-readable format from Base64 encoded protobuf data.
213+
- Decode and display scan results in a human-readable format from Base64 encoded protobuf data.
214214
* - ``wifi_prov get_status``
215215
- Send a ``GET_STATUS`` request to the provisioning service.
216216
* - ``wifi_prov start_scan``
@@ -231,6 +231,8 @@ Building and running
231231

232232
.. include:: /includes/build_and_run.txt
233233

234+
To build and run the sample, complete the following steps:
235+
234236
1. Configure the sample (optional) by running the following command:
235237

236238
.. code-block:: bash
@@ -342,6 +344,8 @@ The sample automatically decodes and logs all protobuf messages:
342344
Directory structure
343345
*******************
344346

347+
The directory structure of the sample is as follows:
348+
345349
.. code-block:: text
346350
347351
samples/wifi/provisioning/internal/
@@ -359,6 +363,6 @@ Generated files
359363

360364
During the build process, the following files are generated:
361365

362-
* :file:`wifi_config.h` - Header with Wi-Fi configuration data declarations
363-
* :file:`wifi_config.c` - C file with Wi-Fi configuration data definitions
366+
* :file:`wifi_config.h` - Header file with Wi-Fi configuration data declarations.
367+
* :file:`wifi_config.c` - Source file with Wi-Fi configuration data definitions.
364368
* Protobuf Python files - Generated from the :file:`*.proto` files for configuration.

samples/wifi/shutdown/README.rst

Lines changed: 101 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Wi-Fi: Shutdown
1010
The Shutdown sample demonstrates how to put the Nordic Semiconductor's Wi-Fi® chipset in the Shutdown state, where the device is completely powered off.
1111
For more information, see the `nRF70 Series power states`_ page.
1212

13-
This also demonstrates how to achieve the lowest possible power consumption in the Host SoC (nRF53, nRF52 or nRF91 Series) when Wi-Fi is enabled but not being used.
13+
This also demonstrates how to achieve the lowest possible power consumption in the host SoC (nRF53, nRF52 or nRF91 Series) when Wi-Fi is enabled but not being used.
1414

1515
The sample supports the following three modes of operation:
1616

@@ -28,15 +28,15 @@ The sample supports the following development kits:
2828
Overview
2929
********
3030

31-
The sample can demonstrate Wi-Fi shutdown and achieve the lowest possible power consumption in the Host SoC.
31+
The sample can demonstrate Wi-Fi shutdown and achieve the lowest possible power consumption in the host SoC.
3232
It operates in one of the following three modes, based on the selected configuration:
3333

34-
* In Continuous mode(default), the sample performs the following steps:
34+
* In Continuous mode (default), the sample performs the following steps:
3535

3636
1. Initializes the Wi-Fi driver and powers up the nRF70 device.
3737
#. Scans for available Wi-Fi networks to verify that the Wi-Fi driver is operational.
3838
#. Brings down the Wi-Fi network interface, which automatically directs the Wi-Fi driver to power down the nRF70 device.
39-
#. Puts the Host SoC in the lowest possible power consumption mode.
39+
#. Puts the host SoC in the lowest possible power consumption mode.
4040
#. Waits for the configured timeout period (``SHUTDOWN_TIMEOUT_S``).
4141
#. Repeats the cycle from step 1.
4242

@@ -49,29 +49,59 @@ User Interface
4949

5050
The user interface depends on the selected mode of operation:
5151

52-
Buttons mode only:
52+
Buttons mode
53+
============
5354

5455
Button 1:
55-
Wakes up the Host SoC, brings up the Wi-Fi network interface, which automatically directs the Wi-Fi driver to power on the nRF70 device.
56+
Wakes up the host SoC, brings up the Wi-Fi network interface, which automatically directs the Wi-Fi driver to power on the nRF70 device.
5657
The sample then scans for available Wi-Fi networks to verify that the Wi-Fi driver is operational.
5758

5859
Button 2:
5960
Brings down the Wi-Fi network interface, which automatically directs the Wi-Fi driver to power down the nRF70 device.
60-
The Host SoC is put into the lowest possible power consumption mode.
61+
The host SoC is put into the lowest possible power consumption mode.
6162

62-
Continuous and One-shot modes:
63+
Continuous and One-shot modes
64+
=============================
6365

64-
User interaction required.
66+
User interaction is required.
6567
The sample operates automatically according to the selected mode.
6668

69+
Configuration
70+
*************
71+
72+
|config|
73+
74+
Configuration options
75+
=====================
76+
77+
Disable auto-start of the Wi-Fi driver
78+
--------------------------------------
79+
80+
The Wi-Fi network interface is automatically brought up when the Wi-Fi driver is initialized by default.
81+
You can disable it by setting the :kconfig:option:`CONFIG_NRF_WIFI_IF_AUTO_START` Kconfig option to ``n``.
82+
This is automatically set for One-shot mode.
83+
84+
.. code-block:: console
85+
86+
west build -p -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_NRF_WIFI_IF_AUTO_START=n
87+
88+
Adjust shutdown timeout
89+
-----------------------
90+
91+
In Continuous mode, you can configure the timeout period between shutdown and restart cycles using the :kconfig:option:`CONFIG_SHUTDOWN_TIMEOUT_S` option (in seconds):
92+
93+
.. code-block:: console
94+
95+
west build -p -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_SHUTDOWN_TIMEOUT_S=10
96+
6797
Building and running
6898
********************
6999

70100
.. |sample path| replace:: :file:`samples/wifi/shutdown`
71101

72102
.. include:: /includes/build_and_run_ns.txt
73103

74-
Modes of Operation
104+
Modes of operation
75105
==================
76106

77107
To build for the nRF7002 DK and nRF7000 EK with nRF5340 DK in different modes of operation, see the following examples:
@@ -121,120 +151,96 @@ Buttons mode
121151
122152
west build -p -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek_nrf7000 -DCONFIG_OPERATION_MODE_BUTTONS=y
123153
124-
Configuration options
125-
=====================
126-
127-
Disable auto-start of the Wi-Fi driver
128-
--------------------------------------
129-
130-
The Wi-Fi network interface is automatically brought up when the Wi-Fi driver is initialized by default.
131-
You can disable it by setting the :kconfig:option:`CONFIG_NRF_WIFI_IF_AUTO_START` Kconfig option to ``n``.
132-
This is automatically set for One-shot mode.
133-
134-
.. code-block:: console
135-
136-
west build -p -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_NRF_WIFI_IF_AUTO_START=n
137-
138-
Adjust shutdown timeout
139-
-----------------------
140-
141-
In Continuous mode, you can configure the timeout period between shutdown and restart cycles using the ``SHUTDOWN_TIMEOUT_S`` option (in seconds):
142-
143-
.. code-block:: console
144-
145-
west build -p -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_SHUTDOWN_TIMEOUT_S=10
146-
147154
Testing
148155
=======
149156

150157
|test_sample|
151158

152-
#. |connect_kit|
153-
#. |connect_terminal|
154-
155-
Testing in Continuous mode
156-
--------------------------
157-
158-
The sample shows the following output in Continuous mode:
159+
.. tabs::
159160

160-
.. code-block:: console
161+
.. group-tab:: Testing in Continuous mode
161162

162-
*** Booting nRF Connect SDK v3.0.99-7c4f8113c3e4 ***
163-
*** Using Zephyr OS v4.1.99-eb12c854d528 ***
164-
[00:00:00.428,253] <inf> shutdown: Starting nrf7002dk with CPU frequency: 64 MHz
163+
1. |connect_kit|
164+
#. |connect_terminal|
165+
#. The sample shows the following output in Continuous mode:
165166

166-
[00:00:00.431,640] <inf> shutdown: Scan requested
167+
.. code-block:: console
167168
168-
Num | SSID (len) | Chan | RSSI | Security | BSSID
169-
1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa
170-
2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx
171-
3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy
172-
[00:00:05.116,943] <inf> shutdown: Scan request done
169+
*** Booting nRF Connect SDK v3.0.99-7c4f8113c3e4 ***
170+
*** Using Zephyr OS v4.1.99-eb12c854d528 ***
171+
[00:00:00.428,253] <inf> shutdown: Starting nrf7002dk with CPU frequency: 64 MHz
173172
174-
[00:00:05.130,706] <inf> shutdown: Interface down
175-
[00:00:05.297,180] <inf> shutdown: Interface up
176-
[00:00:05.299,194] <inf> shutdown: Scan requested
173+
[00:00:00.431,640] <inf> shutdown: Scan requested
177174
178-
Num | SSID (len) | Chan | RSSI | Security | BSSID
179-
1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa
180-
2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx
181-
3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy
182-
[00:00:10.009,399] <inf> shutdown: Scan request done
175+
Num | SSID (len) | Chan | RSSI | Security | BSSID
176+
1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa
177+
2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx
178+
3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy
179+
[00:00:05.116,943] <inf> shutdown: Scan request done
183180
184-
[00:00:10.022,735] <inf> shutdown: Interface down
185-
[00:00:15.189,270] <inf> shutdown: Interface up
186-
[00:00:15.191,284] <inf> shutdown: Scan requested
181+
[00:00:05.130,706] <inf> shutdown: Interface down
182+
[00:00:05.297,180] <inf> shutdown: Interface up
183+
[00:00:05.299,194] <inf> shutdown: Scan requested
187184
188-
Testing in One-shot mode
189-
------------------------
185+
Num | SSID (len) | Chan | RSSI | Security | BSSID
186+
1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa
187+
2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx
188+
3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy
189+
[00:00:10.009,399] <inf> shutdown: Scan request done
190190
191-
The sample shows the following output in One-shot mode:
191+
[00:00:10.022,735] <inf> shutdown: Interface down
192+
[00:00:15.189,270] <inf> shutdown: Interface up
193+
[00:00:15.191,284] <inf> shutdown: Scan requested
192194
193-
.. code-block:: console
195+
.. group-tab:: Testing in One-shot mode
194196

195-
*** Booting nRF Connect SDK v3.0.99-7c4f8113c3e4 ***
196-
*** Using Zephyr OS v4.1.99-eb12c854d528 ***
197-
[00:00:00.261,718] <inf> shutdown: Starting nrf7002dk with CPU frequency: 64 MHz
197+
1. |connect_kit|
198+
#. |connect_terminal|
199+
#. The sample shows the following output in One-shot mode:
198200

199-
[00:00:00.428,802] <inf> shutdown: OTP not programmed, proceeding with local MAC: F6:CE:36:00:00:01
200-
[00:00:00.430,877] <inf> shutdown: Scan requested
201+
.. code-block:: console
201202
202-
Num | SSID (len) | Chan | RSSI | Security | BSSID
203-
1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa
204-
2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx
205-
3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy
206-
[00:00:05.144,104] <inf> shutdown: Scan request done
203+
*** Booting nRF Connect SDK v3.0.99-7c4f8113c3e4 ***
204+
*** Using Zephyr OS v4.1.99-eb12c854d528 ***
205+
[00:00:00.261,718] <inf> shutdown: Starting nrf7002dk with CPU frequency: 64 MHz
207206
208-
[00:00:05.157,714] <inf> shutdown: Interface down
207+
[00:00:00.428,802] <inf> shutdown: OTP not programmed, proceeding with local MAC: F6:CE:36:00:00:01
208+
[00:00:00.430,877] <inf> shutdown: Scan requested
209209
210-
Testing in Buttons mode
211-
-----------------------
210+
Num | SSID (len) | Chan | RSSI | Security | BSSID
211+
1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa
212+
2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx
213+
3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy
214+
[00:00:05.144,104] <inf> shutdown: Scan request done
212215
213-
Complete the following steps to test the sample in Buttons mode (nRF5340 host boards only):
216+
[00:00:05.157,714] <inf> shutdown: Interface down
214217
215-
#. The sample starts with Wi-Fi initialization and shutdown.
218+
.. group-tab:: Testing in Buttons mode (nRF5340 host boards only)
216219

217-
#. Press **Button 1** to wake up the nRF5340 SoC, initialize the Wi-Fi chipset, and scan for available Wi-Fi networks:
220+
1. |connect_kit|
221+
#. |connect_terminal|
222+
#. The sample starts with Wi-Fi initialization and shutdown.
223+
#. Press **Button 1** to wake up the nRF5340 SoC, initialize the Wi-Fi chipset, and scan for available Wi-Fi networks:
218224

219-
The sample shows the following output:
225+
The sample shows the following output:
220226

221-
.. code-block:: console
227+
.. code-block:: console
222228
223-
[00:00:29.141,357] <inf> shutdown: Firmware (v1.2.8.1) booted successfully
229+
[00:00:29.141,357] <inf> shutdown: Firmware (v1.2.8.1) booted successfully
224230
225-
[00:00:29.269,165] <inf> shutdown: Interface up
226-
[00:00:29.272,521] <inf> shutdown: Scan requested
231+
[00:00:29.269,165] <inf> shutdown: Interface up
232+
[00:00:29.272,521] <inf> shutdown: Scan requested
227233
228-
Num | SSID (len) | Chan | RSSI | Security | BSSID
229-
1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa
230-
2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx
231-
3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy
232-
[00:00:34.092,285] <inf> shutdown: Scan request done
234+
Num | SSID (len) | Chan | RSSI | Security | BSSID
235+
1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa
236+
2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx
237+
3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy
238+
[00:00:34.092,285] <inf> shutdown: Scan request done
233239
234-
#. Press **Button 2** to shut down the Wi-Fi driver and put the nRF5340 SoC in lowest possible power consumption mode:
240+
#. Press **Button 2** to shut down the Wi-Fi driver and put the nRF5340 SoC in lowest possible power consumption mode:
235241

236-
The sample shows the following output:
242+
The sample shows the following output:
237243

238-
.. code-block:: console
244+
.. code-block:: console
239245
240-
[00:00:48.313,354] <inf> shutdown : Interface down
246+
[00:00:48.313,354] <inf> shutdown : Interface down

0 commit comments

Comments
 (0)