TizenRT Public API
v2.0 M2
|
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 |
Provides APIs for Wi-Fi Manager.
enum connect_status_e |
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.
Definition at line 114 of file wifi_manager.h.
Wi-Fi encryption type such as WEP, AES, or TKIP.
Definition at line 126 of file wifi_manager.h.
Wi-Fi disconnect event reason.
Definition at line 76 of file wifi_manager.h.
enum wifi_manager_mode_e |
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.
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>
[in] | config | ssid, passphrase, authentication type, and cryto type of the access point which the wi-fi interface connect to. |
[in] | conn_config | reconnect type, interval, minimum or maximun intervalis set |
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>
[in] | config | ssid, passphrase, authentication type, and cryto type of the access point which the wi-fi interface connect to. |
[in] | reconn_config | reconnect type, interval, minimum or maximun intervalis set |
wifi_manager_result_e wifi_manager_deinit | ( | void | ) |
Deinitialize Wi-Fi Manager including stoping Wi-Fi interface.
#include <wifi_manager/wifi_manager.h>
[in] | none |
wifi_manager_result_e wifi_manager_disconnect_ap | ( | void | ) |
Disconnect from the connected access point.
#include <wifi_manager/wifi_manager.h>
[in] | none |
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>
[in] | config | The pointer of AP configuration information which will be filled |
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>
[in] | config | The pointer of AP configuration infomation which will be filled |
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>
[out] | retrieved | information including mode, connection status, ssid, received signal strengh indication, and ip address. |
wifi_manager_result_e wifi_manager_get_stats | ( | wifi_manager_stats_s * | stats | ) |
Obtain WiFi Manager state stats.
#include <wifi_manager/wifi_manager.h>
[in] | The | pointer of WiFi Manager stats information which will be filled |
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>
[in] | wmcb | callback functions called when wi-fi events happen |
wifi_manager_result_e wifi_manager_remove_config | ( | void | ) |
Remove the AP configuration which was saved.
#include <wifi_manager/wifi_manager.h>
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>
[in] | config | AP configuration information should be given including ssid, channel, and passphrase. |
wifi_manager_result_e wifi_manager_scan_ap | ( | void | ) |
Scan nearby access points.
#include <wifi_manager/wifi_manager.h>
[in] | none |
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>
[in] | mode | Wi-Fi mode (station or AP) |
[in] | config | In case of AP mode, AP configuration information should be given including ssid, channel, and passphrase. |