Go to the documentation of this file.
67 #define WPS_STATUS_MAP(XX) \
75 #define XX(name) name,
80 #define XX(name) constexpr WpsStatus eWPS_##name{WpsStatus::name};
131 virtual void enable(
bool enabled,
bool save =
false) = 0;
152 bool config(
const String& ssid,
const String& password,
bool autoConnectOnStartup =
true,
bool save =
true)
156 .password = password,
157 .autoConnectOnStartup = autoConnectOnStartup,
298 virtual int8_t
getRssi()
const = 0;
311 #ifdef ENABLE_SMART_CONFIG
322 virtual void smartConfigStop() = 0;
333 virtual void wpsConfigStop() = 0;
338 #ifdef ENABLE_SMART_CONFIG
@ SCE_FindChannel
Find channel.
Definition: Station.h:52
String ssid
AP SSID.
Definition: Station.h:61
String getConnectionStatusName() const
Get WiFi station connection status name.
virtual bool disconnect()=0
Disconnect WiFi station from network.
@ eSCS_ConnectionFailed
Connection failed.
Definition: Station.h:36
@ success
Definition: Libraries/IOControl/include/IO/Error.h:71
#define XX(name)
Definition: Station.h:80
virtual int8_t getRssi() const =0
Get WiFi signal strength.
String getMAC(char sep='\0') const
Get WiFi station MAC address.
WiFi station class.
Definition: Station.h:108
bool isConnectionFailed() const
Get WiFi station connection failure status.
bool isLocal(IpAddress address)
Determine if the given address is on the same subnet.
Definition: Station.h:261
virtual bool connect()=0
Connect WiFi station to network.
ScanCompletedDelegate scanCompletedCallback
Definition: Station.h:337
virtual String getPassword() const =0
Get WiFi station password.
virtual IpAddress getIP() const =0
Get WiFi station IP address.
The String class.
Definition: WString.h:136
bool setIP(IpAddress address)
Set WiFi station IP address.
virtual bool setMacAddress(const MacAddress &addr) const =0
Set WiFi station MAC address.
virtual void enable(bool enabled, bool save=false)=0
Enable / disable WiFi station.
@ SCT_EspTouch_AirKiss
ESP Touch and Air Kiss.
Definition: Station.h:45
virtual IpAddress getNetworkGateway() const =0
Get WiFi station default gateway.
Station configuration passed to config method.
Definition: Station.h:114
String ssid
Service Set to connect to (may be advertised by multiple access points)
Definition: Station.h:115
@ SCT_None
Definition: Station.h:42
@ eSCS_GotIP
Got IP address.
Definition: Station.h:37
String toString(WpsStatus status)
Smart Config callback information.
Definition: Station.h:59
SmartConfigType type
Type of configuration underway.
Definition: Station.h:60
@ SCE_Wait
Wait.
Definition: Station.h:51
bool save
Store new settings in NV memory.
Definition: Station.h:119
virtual bool isEnabled() const =0
Get WiFi station enable status.
virtual void setHostname(const String &hostname)=0
Set WiFi station DHCP hostname.
WpsStatus
WiFi WPS callback status.
Definition: Station.h:74
#define WPS_STATUS_MAP(XX)
Definition: Station.h:67
@ eSCS_Idle
Connection idle.
Definition: Station.h:32
virtual ~StationClass()
Definition: Station.h:122
MacAddress bssid
Set this to connect to a specific access point.
Definition: Station.h:117
@ SCT_EspTouch
ESP Touch.
Definition: Station.h:43
String password
Password (if required)
Definition: Station.h:116
bool isConnected() const
Get WiFi station connectoin status.
MacAddress bssid
AP BSSID.
Definition: Station.h:64
@ SCT_EspTouch_V2
ESP Touch version 2.
Definition: Station.h:46
bool config(const String &ssid, const String &password, bool autoConnectOnStartup=true, bool save=true)
Configure WiFi station.
Definition: Station.h:152
bool bssidSet
true if connection should match both SSID and BSSID
Definition: Station.h:63
bool compare(const IpAddress &addr, const IpAddress &mask) const
Definition: IpAddress.h:151
virtual bool config(const Config &config)=0
Configure WiFi station.
virtual IpAddress getNetworkMask() const =0
Get WiFi station network mask.
virtual StationConnectionStatus getConnectionStatus() const =0
Get WiFi station connection status.
virtual void enableDHCP(bool enable)=0
Enable or disable WiFi station DHCP.
virtual IpAddress getNetworkBroadcast() const =0
GetWiFi station broadcast address.
@ SCE_LinkOver
Link-over.
Definition: Station.h:55
@ SCE_Link
Link established.
Definition: Station.h:54
virtual bool isEnabledDHCP() const =0
Get WiFi station DHCP enabled status.
virtual MacAddress getMacAddress() const =0
Get WiFi station MAC address.
bool autoConnectOnStartup
Auto connect to this AP on system restart.
Definition: Station.h:118
A class to make it easier to handle and pass around IP addresses.
Definition: IpAddress.h:44
virtual MacAddress getBSSID() const =0
Get BSSID (Basic Service Set Identifier) for connected AP.
StationClass & WifiStation
Global instance of WiFi station object.
virtual bool startScan(ScanCompletedDelegate scanCompleted)=0
Start WiFi station network scan.
@ eSCS_WrongPassword
Wrong password.
Definition: Station.h:34
@ SCT_AirKiss
Air Kiss.
Definition: Station.h:44
@ eSCS_Connecting
Connecting.
Definition: Station.h:33
A network hardware (MAC) address.
Definition: MacAddress.h:38
virtual uint8_t getChannel() const =0
Get active WiFi channel.
@ eSCS_AccessPointNotFound
AP not found.
Definition: Station.h:35
SmartConfigType
Smart configuration type.
Definition: Station.h:41
Vector class template.
Definition: WVector.h:31
String password
AP Password.
Definition: Station.h:62
StationConnectionStatus
WiFi station connection states.
Definition: Station.h:31
virtual String getSSID() const =0
Get WiFi station SSID (Service Set Identifier)
virtual String getHostname() const =0
Set WiFi station DHCP hostname.
SmartConfigEvent
Smart configuration event.
Definition: Station.h:50
@ SCE_GettingSsid
Getting SSID & password.
Definition: Station.h:53