Skip to content

Commit c005997

Browse files
jukkarmmahadevan108
authored andcommitted
samples: net: wifi: Update the AP-STA mode sample
Update the AP/STA mode README file to make it more generic. Signed-off-by: Jukka Rissanen <[email protected]>
1 parent d75b210 commit c005997

File tree

6 files changed

+16
-10
lines changed

6 files changed

+16
-10
lines changed

boards/ti/cc3220sf_launchxl/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Usage:
215215

216216
Set :kconfig:option:`CONFIG_WIFI_SIMPLELINK` and :kconfig:option:`CONFIG_WIFI` to ``y``
217217
to enable Wi-Fi.
218-
See :zephyr_file:`samples/net/wifi/boards/cc3220sf_launchxl.conf`.
218+
See :zephyr_file:`samples/net/wifi/shell/boards/cc3220sf_launchxl.conf`.
219219

220220
Provisioning:
221221
=============

boards/ti/cc3235sf_launchxl/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Usage:
215215

216216
Set :kconfig:option:`CONFIG_WIFI_SIMPLELINK` and :kconfig:option:`CONFIG_WIFI` to ``y``
217217
to enable Wi-Fi.
218-
See :zephyr_file:`samples/net/wifi/boards/cc3235sf_launchxl.conf`.
218+
See :zephyr_file:`samples/net/wifi/shell/boards/cc3235sf_launchxl.conf`.
219219

220220
Provisioning:
221221
=============

doc/_scripts/redirects.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,9 @@
231231
('samples/boards/esp32/flash_memory_mapped/README', 'samples/boards/espressif/flash_memory_mapped/README'),
232232
('samples/boards/esp32/light_sleep/README', 'samples/boards/espressif/light_sleep/README'),
233233
('samples/boards/esp32/spiram_test/README', 'samples/boards/espressif/spiram_test/README'),
234-
('samples/boards/esp32/wifi_apsta_mode/README', 'samples/boards/espressif/wifi_apsta_mode/README'),
234+
('samples/boards/esp32/wifi_apsta_mode/README', 'samples/net/wifi/apsta_mode/README'),
235235
('samples/boards/esp32/xt_wdt/README', 'samples/boards/espressif/xt_wdt/README'),
236+
('samples/boards/espressif/wifi_apsta_mode/README', 'samples/net/wifi/apsta_mode/README'),
236237
('samples/boards/google_twinkie_v2_pda/README', 'samples/boards/google/twinkie_v2/pda/README'),
237238
('samples/boards/intel_adsp/code_relocation/README', 'samples/boards/intel/adsp/code_relocation/README'),
238239
('samples/boards/litex/i2s/README', 'samples/boards/enjoydigital/litex/i2s/README'),

samples/net/wifi/README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. zephyr:code-sample-category:: wifi
2+
:name: Wi-Fi
3+
:show-listing:
4+
5+
These samples demonstrate various Wi-Fi use cases for boards that support it.

samples/net/wifi/apsta_mode/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
.. zephyr:code-sample:: esp32-wifi-ap-sta-mode
1+
.. zephyr:code-sample:: wifi-ap-sta-mode
22
:name: Wi-Fi AP-STA mode
33
:relevant-api: wifi_mgmt dhcpv4_server
44

5-
Setup ESP32 to function as both an Access Point (AP) and a Station (STA) simultaneously.
5+
Configure a Wi-Fi board to operate as both an Access Point (AP) and a Station (STA).
66

77
Overview
88
********
99

10-
The Wi-Fi AP-STA mode of the ESP32 allows it to function as both
10+
The Wi-Fi AP-STA mode of a Wi-Fi board allows it to function as both
1111
an Access Point (AP) and a Station (STA) simultaneously.
1212
This sample demonstrates how to configure and utilize AP-STA mode.
1313

@@ -21,7 +21,7 @@ In this demo, AP-STA mode is enabled using :kconfig:option:`CONFIG_ESP32_WIFI_AP
2121
An additional Wi-Fi node is added in the ``.overlay`` file. The ``net_if``.
2222
In the sample code, initially, the AP mode is enabled, followed by enabling the STA mode.
2323
The driver checks if AP mode was previously enabled. If so, it transitions
24-
the ESP32 into AP-STA mode to support both modes and attempts to connect to the
24+
the board into AP-STA mode to support both modes and attempts to connect to the
2525
AP specified by the provided SSID and PSK.
2626

2727
Requirements

samples/net/wifi/shell/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Building and Running
1717

1818
Verify the board and chip you are targeting provide Wi-Fi support.
1919

20-
For instance you can use TI's CC3220 by selecting the cc3220sf_launchxl board.
20+
For instance you can use Nordic's nrf7002dk by selecting the nrf7002dk/nrf5340/cpuapp board.
2121

2222
.. zephyr-app-commands::
23-
:zephyr-app: samples/net/wifi
24-
:board: cc3220sf_launchxl
23+
:zephyr-app: samples/net/wifi/shell
24+
:board: nrf7002dk/nrf5340/cpuapp
2525
:goals: build
2626
:compact:
2727

0 commit comments

Comments
 (0)