WiFi Station Interface

Control and monitoring of WiFi station interface. More...

Collaboration diagram for WiFi Station Interface:

Classes

struct  SmartConfigEventInfo
 Smart Config callback information. More...
 
class  StationClass
 WiFi station class. More...
 

Macros

#define WPS_STATUS_MAP(XX)
 
#define XX(name)   name,
 
#define XX(name)   constexpr WpsStatus eWPS_##name{WpsStatus::name};
 

Typedefs

using ScanCompletedDelegate = Delegate< void(bool success, BssList &list)>
 Scan complete handler function. More...
 
using SmartConfigDelegate = Delegate< bool(SmartConfigEvent event, const SmartConfigEventInfo &info)>
 Smart configuration handler function. More...
 
using WPSConfigDelegate = Delegate< bool(WpsStatus status)>
 WPS configuration callback function. More...
 

Enumerations

enum  StationConnectionStatus {
  eSCS_Idle, eSCS_Connecting, eSCS_WrongPassword, eSCS_AccessPointNotFound,
  eSCS_ConnectionFailed, eSCS_GotIP
}
 WiFi station connection states. More...
 
enum  SmartConfigType { SCT_None = -1, SCT_EspTouch, SCT_AirKiss, SCT_EspTouch_AirKiss }
 Smart configuration type. More...
 
enum  SmartConfigEvent {
  SCE_Wait, SCE_FindChannel, SCE_GettingSsid, SCE_Link,
  SCE_LinkOver
}
 Smart configuration event. More...
 
enum  WpsStatus { WpsStatus::XX }
 WiFi WPS callback status. More...
 

Functions

String toString (WpsStatus status)
 

Variables

StationClassWifiStation
 Global instance of WiFi station object. More...
 

Detailed Description

Control and monitoring of WiFi station interface.

Note
The WiFi station interface provides client access to a WiFi network. Control of WiFi connection including WiFi SSID and password and IP address, DHCP, etc.
See also
WiFi Access Point
WiFi Events Interface

Macro Definition Documentation

◆ WPS_STATUS_MAP

#define WPS_STATUS_MAP (   XX)
Value:
XX(Success) \
XX(Failed) \
XX(Timeout) \
XX(WEP)
#define XX(name)
Definition: Station.h:79

◆ XX [1/2]

#define XX (   name)    name,

◆ XX [2/2]

#define XX (   name)    constexpr WpsStatus eWPS_##name{WpsStatus::name};

Typedef Documentation

◆ ScanCompletedDelegate

using ScanCompletedDelegate = Delegate<void(bool success, BssList& list)>

Scan complete handler function.

◆ SmartConfigDelegate

Smart configuration handler function.

Parameters
event
info
Return values
boolreturn true to perform default configuration

◆ WPSConfigDelegate

WPS configuration callback function.

Parameters
status
Return values
boolreturn true to perform default configuration

Enumeration Type Documentation

◆ SmartConfigEvent

Smart configuration event.

Enumerator
SCE_Wait 

Wait.

SCE_FindChannel 

Find channel.

SCE_GettingSsid 

Getting SSID & password.

SCE_Link 

Link established.

SCE_LinkOver 

Link-over.

◆ SmartConfigType

Smart configuration type.

Enumerator
SCT_None 
SCT_EspTouch 

ESP Touch.

SCT_AirKiss 

Air Kiss.

SCT_EspTouch_AirKiss 

ESP Touch and Air Kiss.

◆ StationConnectionStatus

WiFi station connection states.

Enumerator
eSCS_Idle 

Connection idle.

eSCS_Connecting 

Connecting.

eSCS_WrongPassword 

Wrong password.

eSCS_AccessPointNotFound 

AP not found.

eSCS_ConnectionFailed 

Connection failed.

eSCS_GotIP 

Got IP address.

◆ WpsStatus

enum WpsStatus
strong

WiFi WPS callback status.

Enumerator
XX 

Function Documentation

◆ toString()

String toString ( WpsStatus  status)

Variable Documentation

◆ WifiStation

StationClass& WifiStation

Global instance of WiFi station object.

Note
Use WifiStation.function to access WiFi station functions
Example:
if(WifiStation.config("My_WiFi", "My_Password"))