 |
W60X_Arduino
|
WiFiClass Class Reference
Inherits WiFiGenericClass, WiFiSTAClass, WiFiScanClass, WiFiAPClass, and WiFiOneshotClass.
Public Member Functions | |
| char * | SSID () const |
| This function is used to get the SSID used by the module. More... | |
| uint8_t * | BSSID () |
| This function is used to get the BSSID which is connected by the module. More... | |
| char * | BSSIDstr () |
| This function is used to get the BSSID which is connected by the module. More... | |
| int32_t | RSSI () |
| This function is used to get the RSSI. More... | |
| char * | SSID (uint8_t networkItem) |
| This function is used to get ssid. 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 | RSSI (uint8_t networkItem) |
| This function is used to get RSSI. More... | |
| int32_t | channel (uint8_t networkItem) |
| This function is used to get the bssid. More... | |
 Public Member Functions inherited from WiFiGenericClass | |
| WiFiMode_t | getMode () |
| This function is used to Get the WiFi's work mode.. More... | |
| int | hostByName (const char *aHostname, IPAddress &aResult) |
| This function is used to resolve hostname . More... | |
| int | hostByName (const char *aHostname, IPAddress &aResult, uint32_t timeout_ms) |
| This function is used to resolve hostname . More... | |
| Public Member Functions inherited from WiFiSTAClass | |
| int | begin (const char *ssid, const char *passphrase=NULL, unsigned int channel=0, const unsigned char bssid[6]=NULL, bool connect=true) |
| This function is used to start the wifi module as station mode. More... | |
| int | begin (char *ssid, char *passphrase=NULL, int channel=0, unsigned char bssid[6]=NULL, bool connect=true) |
| This function is used to start the wifi module as station mode. More... | |
| int | begin () |
| This function is used to start the wifi module as station mode. More... | |
| bool | reconnect () |
| This function is used to reconect the AP. More... | |
| bool | disconnect (bool wifioff=false) |
| This function is used to disconnect the wifi. More... | |
| bool | isConnected () |
| This function is used to get the wifi mode connect status. More... | |
| bool | setAutoConnect (bool autoConnect) |
| This function is used to set auto connect flag. More... | |
| bool | getAutoConnect () |
| This function is used to get auto connect flag. More... | |
| bool | setAutoReconnect (bool autoReconnect) |
| This function is used to set auto reconnect flag. More... | |
| bool | getAutoReconnect () |
| This function is used to get auto reconnect flag. More... | |
| uint8_t | waitForConnectResult () |
| This function is used to suspend until the WiFi is connected. More... | |
| IPAddress | localIP () |
| This function is used to get the local ip address. More... | |
| char * | macAddress () |
| This function is used to get local MAC address used by the module. More... | |
| char * | macAddressStr () |
| This function is used to get local MAC address used by the module. More... | |
| IPAddress | subnetMask () |
| This function is used to get subnet mask. More... | |
| IPAddress | getwayIP () |
| This function is used to get gateway IP address. More... | |
| IPAddress | dnsIP (uint8_t dns_no=0) |
| This function is used to get DNS IP address. More... | |
| char * | hostname () |
| bool | hostname (char *aHostname) |
| bool | hostname (const char *aHostname) |
| wl_status_t | status () |
| This function is used to get the status during Station mode. More... | |
| char * | statusStr () |
| This function is used to get the status during Station mode. More... | |
| char * | SSID () const |
| This function is used to get the SSID used by the module. More... | |
| char * | psk () const |
| This function is used to get the psk used by the module. More... | |
| uint8_t * | BSSID () |
| This function is used to get the BSSID which is connected by the module. More... | |
| char * | BSSIDstr () |
| This function is used to get the BSSID which is connected by the module. More... | |
| int32_t | RSSI () |
| This function is used to get the RSSI. More... | |
| Public Member Functions inherited from WiFiScanClass | |
| 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... | |
| Public Member Functions inherited from WiFiAPClass | |
| bool | softAP (const char *ssid, const char *passphrase=NULL, int channel=1, int ssid_hidden=0, int max_connection=4) |
| This function is used to start wifi module as AP mode. More... | |
| bool | softAPConfig (uint32_t local_ip, uint32_t gateway, uint32_t subnet) |
| This function is used to config soft AP parameters. More... | |
| bool | softAPConfig (const char *local_ip, const char *gateway, const char *subnet) |
| This function is used to config soft AP parameters. More... | |
| bool | softAPdisconnect (bool wifioff=false) |
| This function is used to disconnect the ap function. More... | |
| bool | softAPdestroy () |
| This function is used to destrory the AP function. More... | |
| uint8_t | softAPgetStationNum () |
| This function is used to get the number of station. More... | |
| char * | softAPIP () |
| This function is used to get AP's IP. More... | |
| uint8_t * | softAPmacAddress (uint8_t *mac) |
| This function is used to get AP's MAC address. More... | |
| char * | softAPmacAddress (void) |
| This function is used to get the AP's MAC address. More... | |
| char * | softAPSSID () const |
| This function is used to get AP's SSID. More... | |
| char * | softAPPSK () const |
| This function is used to get AP's PSK. More... | |
| Public Member Functions inherited from WiFiOneshotClass | |
| int | oneshotStart () |
| This function is used to start oneshot configuration network. More... | |
| int | oneshotStop () |
| This function is used to stop oneshot configuration network. More... | |
| int | oneshotGetState () |
| This function is used to get oneshot state. More... | |
| int | oneshotSetMode (ONESHOT_MODE mode) |
| This function is used to get oneshot state. More... | |
| int | oneshotGetMode () |
| This function is used to get oneshot mode. More... | |
Additional Inherited Members | |
| Static Protected Member Functions inherited from WiFiScanClass | |
| static void | _scanDone () |
| static void * | _getScanInfoByIndex (int i) |
Member Function Documentation
◆ BSSID() [1/2]
| uint8_t * WiFiSTAClass::BSSID |
This function is used to get the BSSID which is connected by the module.
- Parameters
-
[in] None
- Returns
- The BSSID of the AP.
- Note
- Parameters
-
[in] none
- Returns
- The BSSID of the AP.
- Note
◆ BSSID() [2/2]
| uint8_t * WiFiScanClass::BSSID |
This function is used to get the bssid.
- Parameters
-
[in] networkItem Specify the index of scan result.
- Returns
- The bssid
- Note
- Parameters
-
[in] networkItem Specify the index of scan result.
- Returns
- The bssid.
- Note
◆ BSSIDstr() [1/2]
| char * WiFiSTAClass::BSSIDstr |
This function is used to get the BSSID which is connected by the module.
- Parameters
-
[in] None
- Returns
- The string of the BSSID of the AP.
- Note
◆ BSSIDstr() [2/2]
| char * WiFiScanClass::BSSIDstr |
This function is used to get the bssid.
- Parameters
-
[in] networkItem Specify the index of scan result.
- Returns
- The string of the bssid.
- Note
◆ channel()
| int32_t WiFiScanClass::channel |
This function is used to get the bssid.
- Parameters
-
[in] networkItem Specify the index of scan result.
- Returns
- The channel of the target.
- Note
◆ RSSI() [1/2]
| int32_t WiFiSTAClass::RSSI |
This function is used to get the RSSI.
- Parameters
-
[in] None
- Returns
- the value of rssi in this connect.
- Note
◆ RSSI() [2/2]
| int32_t WiFiScanClass::RSSI |
This function is used to get RSSI.
- Parameters
-
[in] networkItem Specify the index of scan result.
- Returns
- The RSSI of the target
- Note
◆ SSID() [1/2]
| char * WiFiSTAClass::SSID |
This function is used to get the SSID used by the module.
- Parameters
-
[in] none
- Returns
- The string of the SSID.
- Note
- Parameters
-
[in] None
- Returns
- The string of the SSID.
- Note
◆ SSID() [2/2]
| char * WiFiScanClass::SSID |
This function is used to get ssid.
- Parameters
-
[in] networkItem Specify the index of scan result.
- Returns
- The SSID of the target
- Note
Generated by
1.8.14