Wi-Fi: Scan
The Scan sample demonstrates how to use Nordic Semiconductor Wi-Fi devices to scan for access points without using the WPA supplicant.
Requirements
The sample supports the following development kits:
Hardware platforms |
PCA |
Board name |
Shields |
|
|---|---|---|---|---|
PCA20065 |
|
|||
PCA20053 |
|
|
||
PCA10153 |
|
|
||
PCA10090 |
|
|
||
PCA10171 |
|
|
||
PCA10217 |
|
|||
PCA10143 |
|
|||
PCA10184 |
|
|
||
PCA10156 |
|
|
||
PCA10175 |
|
|
||
PCA10095 |
|
|
||
PCA10056 |
|
|
Note
For boards listed with a shield, you must specify the shield on the build command line. See Building and running for the generic build command.
Overview
The sample demonstrates Wi-Fi scan operations in the 2.4 GHz and 5 GHz bands. The sample allows you to perform scan based on below profiles.
Default scan
Active scan
Passive scan
2.4 GHz Active scan
2.4 GHz Passive scan
5 GHz Active scan
5 GHz Passive scan
Scan only non-overlapping channels in the 2.4 GHz band
Scan only non-DFS channels in the 5 GHz band
Scan only non-overlapping channels in the 2.4 GHz and non-DFS channels in the 5 GHz band
Using this sample, the development kit can scan for available access points in STA mode.
Power management
On the nrf7120dk/nrf7120/cpuapp board target, the sample enables the nRF71 idle power library and suspends the console between scans to reduce the nRF71 Series application core’s System ON idle current.
Configuration
See Configuring and building for information about how to permanently or temporarily change the configuration.
Configuration options
The following sample-specific Kconfig options are used in this sample (located in samples/wifi/scan/Kconfig) :
- CONFIG_WIFI_SCAN_INTERVAL_S
(int) Scan interval (seconds)
Specifies the scan interval in seconds.
- CONFIG_WIFI_SCAN_BANDS_LIST
(string) Frequency bands to scan
Specifies the frequency bands to scan, as follows: 2 - 2.4 GHz, 5 - 5 GHz, 6 - 6 GHz, “” - All bands allowed by the regulatory domain. Multiple bands can be specified as comma separated band values. Only regulatory domain permitted values are allowed.
- CONFIG_WIFI_SCAN_CHAN_LIST
(string) Channel list for scan
Specifies the list of channels used to perform scan.
- CONFIG_WIFI_SCAN_DWELL_TIME_ACTIVE
(int) Active scan dwell time
Active scan dwell time (in ms) per channel.
- CONFIG_WIFI_SCAN_DWELL_TIME_PASSIVE
(int) Passive scan dwell time
Passive scan dwell time (in ms) per channel.
- CONFIG_WIFI_SCAN_TYPE_ACTIVE
(bool)
- CONFIG_WIFI_SCAN_TYPE_PASSIVE
(bool)
- CONFIG_WIFI_SCAN_PROFILE_DEFAULT
(bool) Scan in all bands and channels
Enable this profile to do Wi-Fi scan in all supported bands and channels.
- CONFIG_WIFI_SCAN_PROFILE_ACTIVE
(bool) Active scan
Enable this profile to do active scan where allowed.
- CONFIG_WIFI_SCAN_PROFILE_PASSIVE
(bool) Passive scan
Enable this profile to do passive scan on all channels.
- CONFIG_WIFI_SCAN_PROFILE_2_4GHz_ACTIVE
(bool) Scan in the 2.4 GHz band using active scan
Enable this profile to scan in the 2.4 GHz band using active scanning where allowed.
- CONFIG_WIFI_SCAN_PROFILE_2_4GHz_PASSIVE
(bool) Scan in the 2.4 GHz band using passive scan
Enable this profile to scan in the 2.4 GHz band using passive scanning on all channels.
- CONFIG_WIFI_SCAN_PROFILE_5GHz_ACTIVE
(bool) Scan in the 5 GHz band using active scan
Enable this profile to scan in the 5 GHz band using active scanning where allowed.
- CONFIG_WIFI_SCAN_PROFILE_5GHz_PASSIVE
(bool) Scan in the 5 GHz band using passive scan
Enable this profile to scan in the 5 GHz band using passive scanning on all channels.
- CONFIG_WIFI_SCAN_PROFILE_2_4GHz_NON_OVERLAP_CHAN
(bool) Scan only non-overlapping channels
Enable this profile to scan only non-overlapping channels (1, 6, 11) in the 2.4 GHz band.
- CONFIG_WIFI_SCAN_PROFILE_5GHz_NON_DFS_CHAN
(bool) Scan only non-DFS channels
Enable this profile to scan only non-DFS channels (36, 40, 44, 48, 149, 153, 157, 161, 165) in the 5 GHz band.
- CONFIG_WIFI_SCAN_PROFILE_2_4GHz_NON_OVERLAP_AND_5GHz_NON_DFS_CHAN
(bool) Scan only non-overlapping and non-DFS channels
Enable this profile to scan only non-overlapping channels (1, 6, 11) in the 2.4 GHz band and non-DFS channels (36, 40, 44, 48, 149, 153, 157, 161, 165) in the 5 GHz band.
Building and running
This sample can be found under samples/wifi/scan in the nRF Connect SDK folder structure.
For more security, it is recommended to use the */ns variant of the board target (see the Requirements section above.)
When built for this variant, the sample is configured to compile and run as a non-secure application using security by separation.
Therefore, it automatically includes Trusted Firmware-M that prepares the required peripherals and secure services to be available for the application.
To build the sample, follow the instructions in Building an application for your preferred building environment. See also Programming an application for programming steps and Testing and optimization for general information about testing and debugging in the nRF Connect SDK.
Note
When building repository applications in the SDK repositories, building with sysbuild is enabled by default.
If you work with out-of-tree freestanding applications, you need to manually pass the --sysbuild parameter to every build command or configure west to always use it.
See the Requirements section for the board targets and shields supported by this sample.
For information about providing the SHIELD CMake option, see Providing CMake options.
By default, the sample fetches only Device scan results. To build the sample with support for Raw scan results as well, add one of the following CMake options to the build command:
To fetch only Raw scan results, add the following option when building:
-DCONFIG_WIFI_MGMT_RAW_SCAN_RESULTS=y -DCONFIG_WIFI_MGMT_RAW_SCAN_RESULTS_ONLY=yTo fetch both Raw and Device scan results, add the following option when building:
-DCONFIG_WIFI_MGMT_RAW_SCAN_RESULTS=y
Refer to the sample.yaml file for a complete list of supported boards and their corresponding build command options.
Testing
After programming the sample to your development kit, complete the following steps to test it:
Connect the kit to the computer using a USB cable. The kit is assigned a serial port. Serial ports are referred to as COM ports on Windows, /dev/ttyACM devices on Linux, and /dev/tty devices on macOS. To list Nordic Semiconductor devices connected to your computer together with their serial ports, open a terminal and run the
nrfutil device listcommand. Alternatively, check your operating system’s device manager or its equivalent.Connect to the kit with a terminal emulator (for example, the Serial Terminal app). See Testing and optimization for the required settings and steps.
The sample shows the following output:
Device scan only results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa 2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx 3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy Scan request done
Raw scan only results:
Scan requested Num | len | Frequency | RSSI | RAW_DATA(32 bytes) 1 | 299 | 2412 | -44 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F E1 F5 33 D4 BD 4F E1 F5 33 A0 7F 0B 05 75 7F D8 00 00 00 2 | 430 | 2412 | -37 | 50 00 3A 01 F4 CE 36 00 10 CE 3C 7C 3F DA DF 38 3C 7C 3F DA DF 38 90 11 69 36 EC 8A 02 00 00 00 3 | 284 | 2412 | -45 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F 21 F5 38 D4 BD 4F 21 F5 38 20 CF 7B 20 75 7F D8 00 00 00 4 | 299 | 2412 | -43 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F E1 F5 33 D4 BD 4F E1 F5 33 B0 7F EC 2B 75 7F D8 00 00 00 5 | 409 | 2412 | -38 | 50 00 3A 01 F4 CE 36 00 10 CE A0 36 BC 56 41 E0 A0 36 BC 56 41 E0 60 E2 C7 A5 0F 90 0D 00 00 00 Scan request done
Raw scan and Device scan results:
Scan requested Num | len | Frequency | RSSI | RAW_DATA(32 bytes) 1 | 299 | 2412 | -44 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F E1 F5 33 D4 BD 4F E1 F5 33 A0 7F 0B 05 75 7F D8 00 00 00 2 | 430 | 2412 | -37 | 50 00 3A 01 F4 CE 36 00 10 CE 3C 7C 3F DA DF 38 3C 7C 3F DA DF 38 90 11 69 36 EC 8A 02 00 00 00 3 | 284 | 2412 | -45 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F 21 F5 38 D4 BD 4F 21 F5 38 20 CF 7B 20 75 7F D8 00 00 00 4 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa 5 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx 6 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy Scan request done
Default scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | 0 | 11 | -39 | Open | C2:A5:11:A2:B1:E2 2 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 3 | hijklmno 8 | 48 | -43 | Open | 00:22:CF:E6:AE:99 Scan request done
Active scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | 0 | 11 | -39 | Open | C2:A5:11:A2:B1:E2 2 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 3 | hijklmno 8 | 48 | -43 | Open | 00:22:CF:E6:AE:99 Scan request done
Passive scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | 0 | 11 | -39 | Open | C2:A5:11:A2:B1:E2 2 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 3 | hijklmno 8 | 48 | -43 | Open | 00:22:CF:E6:AE:99 Scan request done
2.4 GHz Active scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 Scan request done
2.4 GHz Passive scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 Scan request done
5 GHz Active scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | pqrst 5 | 48 | -43 | Open | 00:22:CF:E6:AE:99 Scan request done
5 GHz Passive scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | pqrst 5 | 48 | -43 | Open | 00:22:CF:E6:AE:99 Scan request done
2.4 GHz non-overlapping channels based scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 2 | mnopq 5 | 6 | -75 | Open | F0:1D:2D:73:C4:C1 3 | pqrst 5 | 1 | -77 | Open | DC:33:3D:AB:D1:A8 Scan request done
5 GHz non-DFS channels based scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | ABCDEFG 7 | 36 | -70 | Open | 48:5D:35:9C:4A:0B 2 | PQRST 5 | 161 | -78 | Open | 50:EB:F6:08:E1:6C 3 | abcd 4 | 165 | -78 | WPA/WPA2 | 08:86:3B:8B:52:9E 4 | KLMNO 5 | 40 | -90 | Open | E8:94:F6:C7:D8:8E Scan request done
2.4 GHz non-overlapping and 5 GHz non-DFS channels based scan results:
Scan requested Num | SSID (len) | Chan | RSSI | Security | BSSID 1 | pqrst 5 | 48 | -43 | Open | 00:22:CF:E6:AE:99 2 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 3 | ABCDE 5 | 40 | -90 | Open | E8:94:F6:C7:D8:8E Scan request done