Skip to content

Commit 964df23

Browse files
committed
doc: wifi: Update documentation page about running Zephyr samples
Update the sample list and build method for the upstream networking samples. Signed-off-by: Robert Lubos <[email protected]>
1 parent 5a73c9a commit 964df23

File tree

1 file changed

+4
-23
lines changed

1 file changed

+4
-23
lines changed

doc/nrf/samples/wifi_zephyr.rst

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,12 @@ Wi-Fi: Zephyr networking samples
1010
In addition to |NCS| samples, it is possible to run selected networking samples with Wi-Fi®, provided and maintained as part of the upstream Zephyr project.
1111
The following list specifies samples that are currently supported with the Wi-Fi driver:
1212

13-
* :zephyr:code-sample:`dhcpv4-client`
1413
* :zephyr:code-sample:`dns-resolve`
1514
* :zephyr:code-sample:`ipv4-autoconf`
1615
* :zephyr:code-sample:`mdns-responder`
1716
* :zephyr:code-sample:`mqtt-publisher`
1817
* :zephyr:code-sample:`mqtt-sn-publisher`
19-
* :zephyr:code-sample:`coap-client`
2018
* :zephyr:code-sample:`coap-server`
21-
* :zephyr:code-sample:`sockets-echo`
2219
* :zephyr:code-sample:`async-sockets-echo`
2320
* :zephyr:code-sample:`sockets-echo-client`
2421
* :zephyr:code-sample:`sockets-echo-server`
@@ -27,42 +24,26 @@ The following list specifies samples that are currently supported with the Wi-Fi
2724
* :zephyr:code-sample:`syslog-net`
2825
* :zephyr:code-sample:`telnet-console`
2926

30-
Configuration
31-
*************
32-
33-
|config|
34-
35-
Before you build a sample, you must configure the following Wi-Fi credentials in the :file:`overlay-nrf700x.conf` file:
36-
37-
* :kconfig:option:`CONFIG_WIFI_CREDENTIALS_STATIC_SSID` - Network name (SSID)
38-
* :kconfig:option:`CONFIG_WIFI_CREDENTIALS_STATIC_PASSWORD` - Password
39-
* :kconfig:option:`CONFIG_WIFI_CREDENTIALS_STATIC_TYPE` - Security type (Optional)
40-
41-
.. note::
42-
You can also use ``menuconfig`` to configure Wi-Fi credentials.
43-
44-
See :ref:`zephyr:menuconfig` in the Zephyr documentation for instructions on how to run ``menuconfig``.
45-
4627
Building and running
4728
********************
4829

4930
To build the sample with |VSC|, follow the steps listed on the `How to build an application`_ page in the |nRFVSC| documentation.
5031
See :ref:`building` for other building scenarios, :ref:`programming` for programming steps, and :ref:`testing` for general information about testing and debugging in the |NCS|.
5132

52-
An overlay file, ``overlay-nrf700x.conf`` is provided to all Zephyr samples, which configures the sample to run with the Wi-Fi driver.
33+
A :ref:`Wi-Fi snippet <zephyr:snippet-wifi-ipv4>` configuration is provided to all Zephyr samples, which configures the sample to run with the Wi-Fi driver.
5334

5435
To build Zephyr samples for the nRF7002 DK, use the ``nrf7002dk/nrf5340/cpuapp`` board target.
5536
The following is an example of the CLI command:
5637

5738
.. code-block:: console
5839
59-
west build -b nrf7002dk/nrf5340/cpuapp -- -DEXTRA_CONF_FILE=overlay-nrf700x.conf
40+
west build -b nrf7002dk/nrf5340/cpuapp -S wifi-ipv4
6041
6142
To build for the nRF7002 EK with nRF5340 DK, use the ``nrf5340dk/nrf5340/cpuapp`` board target with the ``SHIELD`` CMake option set to ``nrf7002ek``.
6243
The following is an example of the CLI command:
6344

6445
.. code-block:: console
6546
66-
west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek -DEXTRA_CONF_FILE=overlay-nrf700x.conf
47+
west build -b nrf5340dk/nrf5340/cpuapp -S wifi-ipv4 -- -DSHIELD=nrf7002ek -DSB_CONFIG_WIFI_NRF70=y
6748
68-
For additional details about running a sample, refer to the respective sample in Zephyr’s Samples and Demos documentation.
49+
For additional details about running a sample, refer to the respective sample in Zephyr’s :ref:`Samples and Demos documentation <zephyr:samples-and-demos>`.

0 commit comments

Comments
 (0)