W60X_Arduino: WiFi_class

Arduino W60X

W60X_Arduino

Functions

int WiFiSTAClass::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 WiFiSTAClass::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 WiFiSTAClass::begin ()
 This function is used to start the wifi module as station mode. More...
 
bool WiFiSTAClass::reconnect ()
 This function is used to reconect the AP. More...
 
bool WiFiSTAClass::disconnect (bool wifioff=false)
 This function is used to disconnect the wifi. More...
 
bool WiFiSTAClass::isConnected ()
 This function is used to get the wifi mode connect status. More...
 
bool WiFiSTAClass::setAutoConnect (bool autoConnect)
 This function is used to set auto connect flag. More...
 
bool WiFiSTAClass::getAutoConnect ()
 This function is used to get auto connect flag. More...
 
bool WiFiSTAClass::setAutoReconnect (bool autoReconnect)
 This function is used to set auto reconnect flag. More...
 
bool WiFiSTAClass::getAutoReconnect ()
 This function is used to get auto reconnect flag. More...
 
uint8_t WiFiSTAClass::waitForConnectResult ()
 This function is used to suspend until the WiFi is connected. More...
 
IPAddress WiFiSTAClass::localIP ()
 This function is used to get the local ip address. More...
 
char * WiFiSTAClass::macAddress ()
 This function is used to get local MAC address used by the module. More...
 
char * WiFiSTAClass::macAddressStr ()
 This function is used to get local MAC address used by the module. More...
 
IPAddress WiFiSTAClass::subnetMask ()
 This function is used to get subnet mask. More...
 
IPAddress WiFiSTAClass::getwayIP ()
 This function is used to get gateway IP address. More...
 
IPAddress WiFiSTAClass::dnsIP (uint8_t dns_no=0)
 This function is used to get DNS IP address. More...
 
char * WiFiSTAClass::hostname ()
 
bool WiFiSTAClass::hostname (char *aHostname)
 
bool WiFiSTAClass::hostname (const char *aHostname)
 
wl_status_t WiFiSTAClass::status ()
 This function is used to get the status during Station mode. More...
 
char * WiFiSTAClass::statusStr ()
 This function is used to get the status during Station mode. More...
 
char * WiFiSTAClass::SSID () const
 This function is used to get the SSID used by the module. More...
 
char * WiFiSTAClass::psk () const
 This function is used to get the psk used by the module. More...
 
uint8_t * WiFiSTAClass::BSSID ()
 This function is used to get the BSSID which is connected by the module. More...
 
char * WiFiSTAClass::BSSIDstr ()
 This function is used to get the BSSID which is connected by the module. More...
 
int32_t WiFiSTAClass::RSSI ()
 This function is used to get the RSSI. More...
 

Detailed Description

Function Documentation

◆ begin() [1/3]

int WiFiSTAClass::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.

Parameters
[in]ssidSpecify the SSID.
[in]passphraseSpecify the passphrase.
[in]channelSpecify the channel.
[in]bssidSpecify the BSSID.
[in]connectSpecify the connect.
Returns
If the paraments is invalid, negative is returned. Otherwise, wifi status is returned.
Note

◆ begin() [2/3]

int WiFiSTAClass::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.

Parameters
[in]ssidSpecify the SSID.
[in]passphraseSpecify the passphrase.
[in]channelSpecify the channel.
[in]bssidSpecify the BSSID.
[in]connectSpecify the connect.
Returns
If the paraments is invalid, negative is returned. Otherwise, wifi status is returned.
Note

◆ begin() [3/3]

int WiFiSTAClass::begin ( void  )

This function is used to start the wifi module as station mode.

Parameters
[in]None.
Returns
If the paraments is invalid, negative is returned. Otherwise, wifi status is returned.
Note

◆ BSSID()

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

◆ BSSIDstr()

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

◆ disconnect()

bool WiFiSTAClass::disconnect ( bool  wifioff = false)

This function is used to disconnect the wifi.

Parameters
[in]wifioffSpecify the parameter.
Returns
true is returned.
Note

◆ dnsIP()

IPAddress WiFiSTAClass::dnsIP ( uint8_t  dns_no = 0)

This function is used to get DNS IP address.

Parameters
[in]dns_noThe index of the dns.
Returns
The DNS's IPv4 address.
Note
Parameters
[in]dns_noThe index of the dns.
Returns
The DNS's IPv4 address
Note

◆ getAutoConnect()

bool WiFiSTAClass::getAutoConnect ( )

This function is used to get auto connect flag.

Parameters
[in]None
Returns
true - set the auto-connect flag, otherwise, return false.
Note

◆ getAutoReconnect()

bool WiFiSTAClass::getAutoReconnect ( )

This function is used to get auto reconnect flag.

Parameters
[in]None
Returns
true - set the auto-reconnect flag, otherwise, return false.
Note

◆ getwayIP()

IPAddress WiFiSTAClass::getwayIP ( )

This function is used to get gateway IP address.

Parameters
[in]None
Returns
The gateway's IPv4 address.
Note

◆ isConnected()

bool WiFiSTAClass::isConnected ( )

This function is used to get the wifi mode connect status.

Parameters
[in]None
Returns
true - WiFi status is connected, otherwise, false.
Note

◆ localIP()

IPAddress WiFiSTAClass::localIP ( )

This function is used to get the local ip address.

Parameters
[in]None
Returns
The local IPv4 address configure on the Module.
Note

◆ macAddress()

char * WiFiSTAClass::macAddress ( )

This function is used to get local MAC address used by the module.

Parameters
[in]None
Returns
The MAC address.
Note

◆ macAddressStr()

char * WiFiSTAClass::macAddressStr ( )

This function is used to get local MAC address used by the module.

Parameters
[in]None
Returns
The string of the MAC address.
Note

◆ psk()

char * WiFiSTAClass::psk ( ) const

This function is used to get the psk used by the module.

Parameters
[in]None
Returns
The string of the PSK.
Note

◆ reconnect()

bool WiFiSTAClass::reconnect ( )

This function is used to reconect the AP.

Parameters
[in]None
Returns
If reconnect successfully, return true, otherwise, return false.
Note

◆ RSSI()

int32_t WiFiSTAClass::RSSI ( )

This function is used to get the RSSI.

Parameters
[in]None
Returns
the value of rssi in this connect.
Note

◆ setAutoConnect()

bool WiFiSTAClass::setAutoConnect ( bool  autoConnect)

This function is used to set auto connect flag.

Parameters
[in]autoReconnectSpecify the auto-connect flag.
Returns
true - set successfully.
Note

◆ setAutoReconnect()

bool WiFiSTAClass::setAutoReconnect ( bool  autoReconnect)

This function is used to set auto reconnect flag.

Parameters
[in]autoReconnectSpecify the auto-reconnect flag.
Returns
true - set successfully.
Note

◆ SSID()

char * WiFiSTAClass::SSID ( ) const

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

◆ status()

wl_status_t WiFiSTAClass::status ( )

This function is used to get the status during Station mode.

Parameters
[in]None
Returns
The status of WiFi Mode
Note

◆ statusStr()

char * WiFiSTAClass::statusStr ( )

This function is used to get the status during Station mode.

Parameters
[in]None
Returns
The string of the status of WiFi Mode.
Note

◆ subnetMask()

IPAddress WiFiSTAClass::subnetMask ( )

This function is used to get subnet mask.

Parameters
[in]None
Returns
The sub-net mask.
Note

◆ waitForConnectResult()

uint8_t WiFiSTAClass::waitForConnectResult ( )

This function is used to suspend until the WiFi is connected.

Parameters
[in]None
Returns
WiFi status.
Note
Generated by   doxygen 1.8.14