lib_wifi.h File Reference

WiFi library header file. More...

Go to the source code of this file.

Data Structures
struct	wifiCred_st
	WiFi credentials. More...

Enumerations
enum	wifiStates_et {   STATE_WIFI_IDLE , STATE_WIFI_SCAN , STATE_WIFI_START , STATE_WIFI_DISCONNECTED ,   STATE_WIFI_CONNECTED , STATE_WIFI_MAX }

Functions
bool	WIFI_isConnected ()
	Check if WiFi is connected. More...
char *	WIFI_getIpAddress ()
	Get the IP address. More...
uint8_t	WIFI_getSignalStrength ()
	Get WiFi signal strength. More...
int8_t	WIFI_getRssi ()
	Get WiFi RSSI. More...
void	WIFI_printStatus ()
	Print the WiFi status. More...
const char *	WIFI_getStateString ()
	Get WiFi state as string. More...
uint16_t	WIFI_getApList (char *pBuffer)
	Get list of avaialable Access Points (AP) More...

Detailed Description

WiFi library header file.

Enumeration Type Documentation

wifiStates_et

enum wifiStates_et

An enum to represnet WiFi states

Enumerator
STATE_WIFI_IDLE	Idle state
STATE_WIFI_SCAN	Scanning for SSIDs
STATE_WIFI_START	Start WiFi
STATE_WIFI_DISCONNECTED	WiFi disconnected
STATE_WIFI_CONNECTED	WiFi connected
STATE_WIFI_MAX	Total number of states

Function Documentation

WIFI_getApList()

uint16_t WIFI_getApList

(

char *

pBuffer

)

Get list of avaialable Access Points (AP)

Parameters

[out]

pBuffer

outputs list of APs

Returns

Total number of available APs

WIFI_getIpAddress()

char * WIFI_getIpAddress

(

)

Get the IP address.

Parameters

none

Returns

IP address as string

WIFI_getRssi()

int8_t WIFI_getRssi

(

)

Get WiFi RSSI.

Parameters

none

Returns

RSSI value

WIFI_getSignalStrength()

uint8_t WIFI_getSignalStrength

(

)

Get WiFi signal strength.

Parameters

none

Returns

WiFi signal strength

WIFI_getStateString()

const char * WIFI_getStateString

(

)

Get WiFi state as string.

Parameters

none

Returns

WiFi state as string.

Return values

IDLE	- for STATE_WIFI_IDLE
SCAN	- for STAT_WIFI_SCAN
START	- for STATE_WIFI_START
DISCONNECTED	- for STATE_WIFI_DISCONNECTED
CONNECTED	- for STATE_WIFI_CONNECTED

WIFI_isConnected()

bool WIFI_isConnected

(

)

Check if WiFi is connected.

Parameters

none

Returns

WiFi connection status

Return values

true	if connected
false	if not connected

WIFI_printStatus()

void WIFI_printStatus

(

)

Print the WiFi status.

Parameters

none

Returns

none