NetIF_WiFi_Scan

Scan available wireless access point.

Files

net_if_wifi.h/net_if_wifi.c

Prototype

          void NetIF_WiFi_Scan (NET_IF_NBR           if_nbr,
                                NET_IF_WIFI_AP      *p_buf_scan,
                                CPU_INT16U           buf_scan_len_max,
                          const NET_IF_WIFI_SSID    *p_ssid,
                                NET_IF_WIFI_CH       ch,
                                NET_ERR             *p_err);

Arguments

if_nbr

Interface number to scan wireless access point.

p_buf_scan

Pointer to a buffer that will receive wireless access point found.

buf_scan_len_max

Maximum number of access point that can be stored in the scan buffer.

p_ssid

Pointer to a:

a. string that contains the hidden SSID to scan for

b. null pointer, if the scan is for all SSID broadcasted.

ch

Wireless channel number to scan:

NET_IF_WIFI_CH_ALL
NET_IF_WIFI_CH_1
NET_IF_WIFI_CH_2
NET_IF_WIFI_CH_3
NET_IF_WIFI_CH_4
NET_IF_WIFI_CH_5
NET_IF_WIFI_CH_6
NET_IF_WIFI_CH_7
NET_IF_WIFI_CH_8
NET_IF_WIFI_CH_9
NET_IF_WIFI_CH_10
NET_IF_WIFI_CH_11
NET_IF_WIFI_CH_12
NET_IF_WIFI_CH_13
NET_IF_WIFI_CH_14

p_err

Pointer to variable that will receive the return error code from this function:

NET_IF_WIFI_ERR_NONE
NET_IF_WIFI_ERR_CH_INVALID
NET_IF_WIFI_ERR_SCAN
NET_IF_ERR_NULL_PTR

Returned Value

Number of wireless access point found and set in the scan buffer.

Required Configuration

None.

Notes / Warnings

None.