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, SCT_EspTouch_V2 } |
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 | |
StationClass & | WifiStation |
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.
Macro Definition Documentation
◆ WPS_STATUS_MAP
#define WPS_STATUS_MAP | ( | XX | ) |
Value:
◆ 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
using SmartConfigDelegate = Delegate<bool(SmartConfigEvent event, const SmartConfigEventInfo& info)> |
Smart configuration handler function.
- Parameters
-
event info
- Return values
-
bool return true to perform default configuration
◆ WPSConfigDelegate
using WPSConfigDelegate = Delegate<bool(WpsStatus status)> |
WPS configuration callback function.
- Parameters
-
status
- Return values
-
bool return true to perform default configuration
Enumeration Type Documentation
◆ SmartConfigEvent
enum SmartConfigEvent |
◆ SmartConfigType
enum SmartConfigType |
◆ StationConnectionStatus
◆ WpsStatus
|
strong |
Function Documentation
◆ toString()
Variable Documentation
◆ WifiStation
StationClass& WifiStation |
Global instance of WiFi station object.
- Note
- Use WifiStation.function to access WiFi station functions
-
Example:
virtual void enable(bool enabled, bool save=false)=0
Enable / disable WiFi station.