W60X_Arduino: WiFiScanClass Class Reference

Arduino W60X

W60X_Arduino

Inherited by WiFiClass.

Public Member Functions

int8_t scanNetworks (bool async=false, bool show_hidden=false, uint8_t channel=0, uint8_t *ssid=NULL)
 This function is used to begin scan the WiFi network. More...
 
int8_t scanComplete ()
 This function is used to get the scan status. More...
 
void scanDelete ()
 This function is used to free the buffer of last scan result. More...
 
bool getNetworkInfo (uint8_t networkItem, char *&ssid, uint8_t &encryptionType, int32_t &RSSI, uint8_t *&BSSID, int32_t &channel, bool &isHidden)
 This function is used to get the network info via last scan. More...
 
char * SSID (uint8_t networkItem)
 This function is used to get ssid. More...
 
uint32_t encryptionType (uint8_t networkItem)
 This function is used to get encryption type. More...
 
int32_t RSSI (uint8_t networkItem)
 This function is used to get RSSI. More...
 
uint8_t * BSSID (uint8_t networkItem)
 This function is used to get the bssid. More...
 
char * BSSIDstr (uint8_t networkItem)
 This function is used to get the bssid. More...
 
int32_t channel (uint8_t networkItem)
 This function is used to get the bssid. More...
 
bool isHidden (uint8_t networkItem)
 This function is used to get the hidden flag. More...
 

Static Protected Member Functions

static void _scanDone ()
 
static void * _getScanInfoByIndex (int i)
 

Member Function Documentation

◆ BSSID()

uint8_t * WiFiScanClass::BSSID ( uint8_t  networkItem)

This function is used to get the bssid.

Parameters
[in]networkItemSpecify the index of scan result.
Returns
The bssid
Note
Parameters
[in]networkItemSpecify the index of scan result.
Returns
The bssid.
Note

◆ BSSIDstr()

char * WiFiScanClass::BSSIDstr ( uint8_t  networkItem)

This function is used to get the bssid.

Parameters
[in]networkItemSpecify the index of scan result.
Returns
The string of the bssid.
Note

◆ channel()

int32_t WiFiScanClass::channel ( uint8_t  networkItem)

This function is used to get the bssid.

Parameters
[in]networkItemSpecify the index of scan result.
Returns
The channel of the target.
Note

◆ encryptionType()

uint32_t WiFiScanClass::encryptionType ( uint8_t  networkItem)

This function is used to get encryption type.

Parameters
[in]networkItemSpecify the index of scan result.
Returns
The encryptionType of the target
Note

◆ getNetworkInfo()

bool WiFiScanClass::getNetworkInfo ( uint8_t  networkItem,
char *&  ssid,
uint8_t &  encryptionType,
int32_t &  RSSI,
uint8_t *&  BSSID,
int32_t &  channel,
bool &  isHidden 
)

This function is used to get the network info via last scan.

Parameters
[in]networkItemSpecify the index of scan result.
[out]ssidThe ssid in the scan result, indexed by networkItem.
[out]encryptionTypeThe encryptionType in the scan result, indexed by networkItem.
[out]RSSIThe RSSI in the scan result, indexed by networkItem.
[out]BSSIDThe BSSID in the scan result, indexed by networkItem.
[out]channelThe channel in the scan result, indexed by networkItem.
[out]isHiddenThe isHidden flag in the scan result, indexed by networkItem.
Returns
None
Note

◆ isHidden()

bool WiFiScanClass::isHidden ( uint8_t  networkItem)

This function is used to get the hidden flag.

Parameters
[in]networkItemSpecify the index of scan result.
Returns
false
Note

◆ RSSI()

int32_t WiFiScanClass::RSSI ( uint8_t  networkItem)

This function is used to get RSSI.

Parameters
[in]networkItemSpecify the index of scan result.
Returns
The RSSI of the target
Note

◆ scanComplete()

int8_t WiFiScanClass::scanComplete ( )

This function is used to get the scan status.

Parameters
[in]None
Returns
If during scanning, WM_WIFI_SCANNING_BUSY is returned. If finish scanning, the number of network is returned, otherwise, -1 is returned.
Note

◆ scanDelete()

void WiFiScanClass::scanDelete ( )

This function is used to free the buffer of last scan result.

Parameters
[in]None
Returns
None
Note

◆ scanNetworks()

int8_t WiFiScanClass::scanNetworks ( bool  async = false,
bool  show_hidden = false,
uint8_t  channel = 0,
uint8_t *  ssid = NULL 
)

This function is used to begin scan the WiFi network.

Parameters
[in]asyncSpecify the async.
[in]show_hiddenSpecify the show_hidden.
[in]channelSpecify the channel.
[in]ssidSpecify the ssid.
Returns
If not SUCCESS, user needs to call this function again to trigger scan
Note

◆ SSID()

char * WiFiScanClass::SSID ( uint8_t  networkItem)

This function is used to get ssid.

Parameters
[in]networkItemSpecify the index of scan result.
Returns
The SSID of the target
Note
Generated by   doxygen 1.8.14