TizenRT Public API  v2.0 M2
Wi-Fi_Manager

Provides APIs for Wi-Fi Manager. More...

Files

file  wifi_manager.h
 Provides APIs for Wi-Fi Manager.
 

Data Structures

struct  wifi_manager_scan_info_s
 Keep information of nearby access points as scan results. More...
 
struct  wifi_manager_cb_s
 Include callback functions which are asynchronously called after Wi-Fi Manager APIs are called. More...
 
struct  wifi_manager_info_s
 Keep Wi-Fi Manager information including ip/mac address, ssid, rssi, etc. More...
 
struct  wifi_manager_softap_config_s
 Specify information of soft access point (softAP) such as ssid and channel number. More...
 
struct  wifi_manager_reconnect_config_s
 Specify the policy of reconnect when the device is disconnected. More...
 
struct  wifi_manager_ap_config_s
 Specify which access point (AP) a client connects to. More...
 
struct  wifi_manager_stats_s
 Specify Wi-Fi Manager internal stats information. More...
 

Enumerations

Functions

wifi_manager_result_e wifi_manager_init (wifi_manager_cb_s *wmcb)
 Initialize Wi-Fi Manager including starting Wi-Fi interface. More...
 
wifi_manager_result_e wifi_manager_deinit (void)
 Deinitialize Wi-Fi Manager including stoping Wi-Fi interface. More...
 
wifi_manager_result_e wifi_manager_set_mode (wifi_manager_mode_e mode, wifi_manager_softap_config_s *config)
 Change the Wi-Fi mode to station or AP. More...
 
wifi_manager_result_e wifi_manager_get_info (wifi_manager_info_s *info)
 Retrieve current status of Wi-Fi interface including mode, connection status, ssid, received signal strengh indication, and ip address. More...
 
wifi_manager_result_e wifi_manager_connect_ap_config (wifi_manager_ap_config_s *config, wifi_manager_reconnect_config_s *reconn_config)
 Connect to an access point. More...
 
wifi_manager_result_e wifi_manager_connect_ap (wifi_manager_ap_config_s *config)
 Connect to an access point. More...
 
wifi_manager_result_e wifi_manager_disconnect_ap (void)
 Disconnect from the connected access point. More...
 
wifi_manager_result_e wifi_manager_scan_ap (void)
 Scan nearby access points. More...
 
wifi_manager_result_e wifi_manager_save_config (wifi_manager_ap_config_s *config)
 Save the AP configuration at persistent storage. More...
 
wifi_manager_result_e wifi_manager_get_config (wifi_manager_ap_config_s *config)
 Get the AP configuration which was saved. More...
 
wifi_manager_result_e wifi_manager_remove_config (void)
 Remove the AP configuration which was saved. More...
 
wifi_manager_result_e wifi_manager_get_connected_config (wifi_manager_ap_config_s *config)
 Get the most recently connected AP configuration which was saved by Wi-Fi Manager. More...
 
wifi_manager_result_e wifi_manager_get_stats (wifi_manager_stats_s *stats)
 Obtain WiFi Manager state stats. More...
 

Detailed Description

Provides APIs for Wi-Fi Manager.

Enumeration Type Documentation

Status of Wi-Fi interface such as connected or disconnected.

Definition at line 46 of file wifi_manager.h.

Wi-Fi authentication type such as WPA, WPA2, or WPS.

Enumerator
WIFI_MANAGER_AUTH_OPEN 

open mode

WIFI_MANAGER_AUTH_WEP_SHARED 

use shared key (wep key)

WIFI_MANAGER_AUTH_WPA_PSK 

WPA_PSK mode

WIFI_MANAGER_AUTH_WPA2_PSK 

WPA2_PSK mode

WIFI_MANAGER_AUTH_WPA_AND_WPA2_PSK 

WPA_PSK and WPA_PSK mixed mode

WIFI_MANAGER_AUTH_UNKNOWN 

unknown type

Definition at line 114 of file wifi_manager.h.

Wi-Fi encryption type such as WEP, AES, or TKIP.

Enumerator
WIFI_MANAGER_CRYPTO_NONE 

none encryption

WIFI_MANAGER_CRYPTO_WEP_64 

WEP encryption wep-40

WIFI_MANAGER_CRYPTO_WEP_128 

WEP encryption wep-104

WIFI_MANAGER_CRYPTO_AES 

AES encryption

WIFI_MANAGER_CRYPTO_TKIP 

TKIP encryption

WIFI_MANAGER_CRYPTO_TKIP_AND_AES 

TKIP and AES mixed encryption

WIFI_MANAGER_CRYPTO_UNKNOWN 

unknown encryption

Definition at line 126 of file wifi_manager.h.

Wi-Fi disconnect event reason.

Definition at line 76 of file wifi_manager.h.

Mode of Wi-Fi interface such as station mode or ap mode.

Definition at line 84 of file wifi_manager.h.

Reconnection mode of Wi-Fi interface.

Definition at line 97 of file wifi_manager.h.

Result types of Wi-Fi Manager APIs such as FAIL, SUCCESS, or INVALID ARGS.

Definition at line 62 of file wifi_manager.h.

Result types of nearby access point scanning.

Definition at line 106 of file wifi_manager.h.

Function Documentation

wifi_manager_result_e wifi_manager_connect_ap ( wifi_manager_ap_config_s config)

Connect to an access point.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]configssid, passphrase, authentication type, and cryto type of the access point which the wi-fi interface connect to.
[in]conn_configreconnect type, interval, minimum or maximun intervalis set
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v1.1
wifi_manager_result_e wifi_manager_connect_ap_config ( wifi_manager_ap_config_s config,
wifi_manager_reconnect_config_s reconn_config 
)

Connect to an access point.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]configssid, passphrase, authentication type, and cryto type of the access point which the wi-fi interface connect to.
[in]reconn_configreconnect type, interval, minimum or maximun intervalis set
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v1.1
wifi_manager_result_e wifi_manager_deinit ( void  )

Deinitialize Wi-Fi Manager including stoping Wi-Fi interface.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]none
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v1.1
wifi_manager_result_e wifi_manager_disconnect_ap ( void  )

Disconnect from the connected access point.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]none
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v1.1
wifi_manager_result_e wifi_manager_get_config ( wifi_manager_ap_config_s config)

Get the AP configuration which was saved.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]configThe pointer of AP configuration information which will be filled
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v2.0
wifi_manager_result_e wifi_manager_get_connected_config ( wifi_manager_ap_config_s config)

Get the most recently connected AP configuration which was saved by Wi-Fi Manager.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]configThe pointer of AP configuration infomation which will be filled
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v2.0
wifi_manager_result_e wifi_manager_get_info ( wifi_manager_info_s info)

Retrieve current status of Wi-Fi interface including mode, connection status, ssid, received signal strengh indication, and ip address.

#include <wifi_manager/wifi_manager.h>

Parameters
[out]retrievedinformation including mode, connection status, ssid, received signal strengh indication, and ip address.
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v1.1
wifi_manager_result_e wifi_manager_get_stats ( wifi_manager_stats_s stats)

Obtain WiFi Manager state stats.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]Thepointer of WiFi Manager stats information which will be filled
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v2.0
wifi_manager_result_e wifi_manager_init ( wifi_manager_cb_s wmcb)

Initialize Wi-Fi Manager including starting Wi-Fi interface.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]wmcbcallback functions called when wi-fi events happen
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v1.1
wifi_manager_result_e wifi_manager_remove_config ( void  )

Remove the AP configuration which was saved.

#include <wifi_manager/wifi_manager.h>

Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v2.0
wifi_manager_result_e wifi_manager_save_config ( wifi_manager_ap_config_s config)

Save the AP configuration at persistent storage.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]configAP configuration information should be given including ssid, channel, and passphrase.
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v2.0
wifi_manager_result_e wifi_manager_scan_ap ( void  )

Scan nearby access points.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]none
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v1.1
wifi_manager_result_e wifi_manager_set_mode ( wifi_manager_mode_e  mode,
wifi_manager_softap_config_s config 
)

Change the Wi-Fi mode to station or AP.

#include <wifi_manager/wifi_manager.h>

Parameters
[in]modeWi-Fi mode (station or AP)
[in]configIn case of AP mode, AP configuration information should be given including ssid, channel, and passphrase.
Returns
On success, WIFI_MANAGER_SUCCESS (i.e., 0) is returned. On failure, non-zero value is returned.
Since
TizenRT v1.1