wifi_device.h

Overview

Related Modules:

Wifiservice

Description:

Provides capabilities to enable and disable the station mode, connect to and disconnect from a station, query the station status, and listen for events.

Since:

1.0

Version:

1.0

Summary

Functions

Function Name

Description

EnableWifi (void)

WifiErrorCode 

Enables the station mode.

DisableWifi (void)

WifiErrorCode 

Disables the station mode.

IsWifiActive (void)

int 

Checks whether the station mode is enabled.

Scan (void)

WifiErrorCode 

Starts a Wi-Fi scan.

GetScanInfoList (WifiScanInfo result, unsigned int size)

WifiErrorCode 

Obtains an array of hotspots detected in a Wi-Fi scan.

AddDeviceConfig (const WifiDeviceConfig config, int result)

WifiErrorCode 

Adds a specified hotspot configuration for connecting to a hotspot.

GetDeviceConfigs (WifiDeviceConfig result, unsigned int size)

WifiErrorCode 

Obtains all hotspot configurations.

RemoveDevice (int networkId)

WifiErrorCode 

Removes a hotspot configuration matching a specified networkId.

ConnectTo (int networkId)

WifiErrorCode 

Connects to a hotspot matching a specified networkId.

Disconnect (void)

WifiErrorCode 

Disconnects this Wi-Fi connection.

GetLinkedInfo (WifiLinkedInfo result)

WifiErrorCode 

Obtains information about the connected hotspot.

RegisterWifiEvent (WifiEvent event)

WifiErrorCode 

Registers a callback for a specified Wi-Fi event.

UnRegisterWifiEvent (const WifiEvent event)

WifiErrorCode 

Unregisters a callback previously registered for a specified Wi-Fi event.

GetDeviceMacAddress (unsigned char result)

WifiErrorCode 

Obtains the MAC address of this device.

AdvanceScan (WifiScanParams *params)

WifiErrorCode 

Starts a Wi-Fi scan based on a specified parameter.