 |
W60X_Arduino
|
WiFiAPClass Class Reference
Inherited by WiFiClass.
Public Member Functions | |
| 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... | |
Member Function Documentation
◆ softAP()
| bool WiFiAPClass::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.
- Parameters
-
[in] ssid Specify the SSID. [in] passphrase Specify the passphrase. [in] channel Specify the channel. [in] ssid_hidden Specify the ssid_hidden flag. [in] max_connection Specify the max_connection.
- Returns
- true - operate successfully, false - operate failure.
- Note
◆ softAPConfig() [1/2]
| bool WiFiAPClass::softAPConfig | ( | uint32_t | local_ip, |
| uint32_t | gateway, | ||
| uint32_t | subnet | ||
| ) |
This function is used to config soft AP parameters.
- Parameters
-
[in] local_ip Specify the local_ip. [in] gateway Specify the gateway. [in] subnet Specify the subnet.
- Returns
- true - operate successfully, false - operate failure.
- Note
◆ softAPConfig() [2/2]
| bool WiFiAPClass::softAPConfig | ( | const char * | local_ip, |
| const char * | gateway, | ||
| const char * | subnet | ||
| ) |
This function is used to config soft AP parameters.
- Parameters
-
[in] local_ip Specify the local_ip. [in] gateway Specify the gateway. [in] subnet Specify the subnet.
- Returns
- true - operate successfully, false - operate failure.
- Note
◆ softAPdestroy()
| bool WiFiAPClass::softAPdestroy | ( | ) |
This function is used to destrory the AP function.
- Parameters
-
[in] None
- Returns
- true - operate successfully, false - operate failure.
- Note
◆ softAPdisconnect()
| bool WiFiAPClass::softAPdisconnect | ( | bool | wifioff = false | ) |
This function is used to disconnect the ap function.
- Parameters
-
[in] wifioff Specify the wifioff.
- Returns
- true - operate successfully, false - operate failure.
- Note
◆ softAPgetStationNum()
| uint8_t WiFiAPClass::softAPgetStationNum | ( | ) |
This function is used to get the number of station.
- Parameters
-
[in] None
- Returns
- The number of station.
- Note
◆ softAPIP()
| char * WiFiAPClass::softAPIP | ( | ) |
This function is used to get AP's IP.
- Parameters
-
[in] None
- Returns
- The local AP's IPv4 address.
- Note
◆ softAPmacAddress() [1/2]
| uint8_t * WiFiAPClass::softAPmacAddress | ( | uint8_t * | mac | ) |
This function is used to get AP's MAC address.
- Parameters
-
[in] mac Specify the mac buffer.
- Returns
- The AP's MAC address.
- Note
◆ softAPmacAddress() [2/2]
| char * WiFiAPClass::softAPmacAddress | ( | void | ) |
This function is used to get the AP's MAC address.
- Parameters
-
[in] None
- Returns
- The string of the AP's MAC address.
- Note
◆ softAPPSK()
| char * WiFiAPClass::softAPPSK | ( | ) | const |
This function is used to get AP's PSK.
- Parameters
-
[in] None
- Returns
- The AP's PSK is returned.
- Note
◆ softAPSSID()
| char * WiFiAPClass::softAPSSID | ( | ) | const |
This function is used to get AP's SSID.
- Parameters
-
[in] None
- Returns
- The AP's SSID is returned.
- Note
Generated by
1.8.14