wifi_client_hal.h File Reference

#include <wifi_common_hal.h>

Include dependency graph for wifi_client_hal.h:

Go to the source code of this file.

Data Structures
struct	_wifi_pairedSSIDInfo
struct	_wifi_roamingCtrl_t
	Structure for roaming control information. More...
struct	_wifi_telemetry_ops_t
	Structure for telemetry callback functions. More...

Typedefs
typedef struct _wifi_pairedSSIDInfo	wifi_pairedSSIDInfo_t
typedef struct _wifi_roamingCtrl_t	wifi_roamingCtrl_t
typedef INT(*	wifi_disconnectEndpoint_callback) (INT ssidIndex, CHAR *AP_SSID, wifiStatusCode_t *error)
	Receives status updates from HAL in case of a disconnection event.
typedef INT(*	wifi_connectEndpoint_callback) (INT ssidIndex, CHAR *AP_SSID, wifiStatusCode_t *error)
	Receives status updates from HAL in case of a connection event.
typedef struct _wifi_telemetry_ops_t	wifi_telemetry_ops_t

Functions
INT	wifi_getCliWpsEnable (INT ssidIndex, BOOL *output_bool)
	This API checks WPS(Wi-Fi Protected Setup) functionality is enabled for this access point.
INT	wifi_setCliWpsEnable (INT ssidIndex, BOOL enableValue)
	This API enables or disables WPS functionality for this access point.
INT	wifi_getCliWpsDevicePIN (INT ssidIndex, ULONG *output_ulong)
	This API is used to read the device PIN required for making a WPS connection.
INT	wifi_setCliWpsDevicePIN (INT ssidIndex, ULONG pin)
	This API sets the WPS Device pin to the Wi-Fi hal.
INT	wifi_getCliWpsConfigMethodsSupported (INT ssidIndex, CHAR *methods)
	Gets WPS configuration methods supported by the device.
INT	wifi_getCliWpsConfigMethodsEnabled (INT ssidIndex, CHAR *output_string)
	Gets WPS configuration methods enabled on the device.
INT	wifi_setCliWpsConfigMethodsEnabled (INT ssidIndex, CHAR *methodString)
	Sets the active WPS methods.
INT	wifi_getCliWpsConfigurationState (INT ssidIndex, CHAR *output_string)
	This API is used to get the WPS config status, whether "configured" or "not configured".
INT	wifi_setCliWpsEnrolleePin (INT ssidIndex, CHAR *EnrolleePin)
	Sets the WPS PIN and uses it to pair with access point.
INT	wifi_setCliWpsButtonPush (INT ssidIndex)
	Starts the WPS Push button pairing with access point.
INT	wifi_cancelCliWPS (INT ssidIndex)
	Stop the WPS process.
INT	wifi_connectEndpoint (INT ssidIndex, CHAR *AP_SSID, wifiSecurityMode_t AP_security_mode, CHAR *AP_security_WEPKey, CHAR *AP_security_PreSharedKey, CHAR *AP_security_KeyPassphrase, int saveSSID, CHAR *eapIdentity, CHAR *carootcert, CHAR *clientcert, CHAR *privatekey)
	Starts the process of connection between the client and an access point.
INT	wifi_disconnectEndpoint (INT ssidIndex, CHAR *AP_SSID)
	Starts the process of disconnection between the client and an access point.
INT	wifi_clearSSIDInfo (INT ssidIndex)
	Clears the SSID information.
void	wifi_disconnectEndpoint_callback_register (wifi_disconnectEndpoint_callback callback_proc)
	Registers for disconnect callback.
void	wifi_connectEndpoint_callback_register (wifi_connectEndpoint_callback callback_proc)
	Registers for connect callback.
void	wifi_telemetry_callback_register (wifi_telemetry_ops_t *telemetry_ops)
	Registers for Telemetry callback.
INT	wifi_lastConnected_Endpoint (wifi_pairedSSIDInfo_t *pairedSSIDInfo)
	Provides the last connected SSID information.
int	wifi_setRoamingControl (int ssidIndex, wifi_roamingCtrl_t *pRoamingCtrl_data)
	Sets the roaming control parameters.
int	wifi_getRoamingControl (int ssidIndex, wifi_roamingCtrl_t *pRoamingCtrl_data)
	Gets the roaming control parameters.
WiFiHalStatus_t	getwifiStatusCode ()
	this call gets the current wifi status
INT	wifi_cancelWpsPairing ()
	Cancels any in-progress WPS operation.