NetIF_WiFi_Join

Join an wireless access point.

Files

net_if_wifi.h/net_if_wifi.c

Prototype

          void NetIF_WiFi_Join (NET_IF_NBR                 if_nbr,
                                NET_IF_WIFI_NET_TYPE       net_type,
                                NET_IF_WIFI_DATA_RATE      data_rate,
                                NET_IF_WIFI_SECURITY_TYPE  security_type,
                                NET_IF_WIFI_PWR_LEVEL      pwr_level,
                                NET_IF_WIFI_SSID           ssid,
                                NET_IF_WIFI_PSK            psk,
                                NET_ERR                   *p_err);

Arguments

if_nbr

Interface number to join wireless access point.

net_type

Wireless network type of the access point:

NET_IF_WIFI_NET_TYPE_INFRASTRUCTURE
NET_IF_WIFI_NET_TYPE_ADHOC

data_rate

Wireless data rate to configure:

NET_IF_WIFI_DATA_RATE_AUTO
NET_IF_WIFI_DATA_RATE_1_MBPS
NET_IF_WIFI_DATA_RATE_2_MBPS
NET_IF_WIFI_DATA_RATE_5_5_MBPS
NET_IF_WIFI_DATA_RATE_6_MBPS
NET_IF_WIFI_DATA_RATE_9_MBPS
NET_IF_WIFI_DATA_RATE_11_MBPS
NET_IF_WIFI_DATA_RATE_12_MBPS
NET_IF_WIFI_DATA_RATE_18_MBPS
NET_IF_WIFI_DATA_RATE_24_MBPS
NET_IF_WIFI_DATA_RATE_36_MBPS
NET_IF_WIFI_DATA_RATE_48_MBPS
NET_IF_WIFI_DATA_RATE_54_MBPS
NET_IF_WIFI_DATA_RATE_MCS0
NET_IF_WIFI_DATA_RATE_MCS1
NET_IF_WIFI_DATA_RATE_MCS2
NET_IF_WIFI_DATA_RATE_MCS3
NET_IF_WIFI_DATA_RATE_MCS4
NET_IF_WIFI_DATA_RATE_MCS5
NET_IF_WIFI_DATA_RATE_MCS6
NET_IF_WIFI_DATA_RATE_MCS7
NET_IF_WIFI_DATA_RATE_MCS8
NET_IF_WIFI_DATA_RATE_MCS9
NET_IF_WIFI_DATA_RATE_MCS10
NET_IF_WIFI_DATA_RATE_MCS11
NET_IF_WIFI_DATA_RATE_MCS12
NET_IF_WIFI_DATA_RATE_MCS13
NET_IF_WIFI_DATA_RATE_MCS14
NET_IF_WIFI_DATA_RATE_MCS15

security_type

Wireless security type:

NET_IF_WIFI_SECURITY_OPEN
NET_IF_WIFI_SECURITY_WEP
NET_IF_WIFI_SECURITY_WPA
NET_IF_WIFI_SECURITY_WPA2

pwr_level

Wireless radio power to configure:

NET_IF_WIFI_PWR_LEVEL_LO
NET_IF_WIFI_PWR_LEVEL_MED
NET_IF_WIFI_PWR_LEVEL_HI

ssid

SSID of the access point to join.

psk

Pre shared key of the access point to join.

p_err

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

NET_IF_WIFI_ERR_NONE
NET_IF_WIFI_ERR_JOIN
NET_IF_WIFI_ERR_INVALID_NET_TYPE
NET_IF_WIFI_ERR_INVALID_DATA_RATE
NET_IF_WIFI_ERR_INVALID_SECURITY
NET_IF_WIFI_ERR_INVALID_PWR_LEVEL

Returned Value

None.

Required Configuration

None.

Notes / Warnings

Prior joining an access point a scan should be performed to find the access point.