WiFi station class. More...

#include <Station.h>

Collaboration diagram for StationClass:
[legend]

Public Member Functions

virtual ~StationClass ()
 
virtual void enable (bool enabled, bool save=false)=0
 Enable / disable WiFi station. More...
 
virtual bool isEnabled () const =0
 Get WiFi station enable status. More...
 
virtual bool config (const String &ssid, const String &password, bool autoConnectOnStartup=true, bool save=true)=0
 Configure WiFi station. More...
 
virtual bool connect ()=0
 Connect WiFi station to network. More...
 
virtual bool disconnect ()=0
 Disconnect WiFi station from network. More...
 
bool isConnected () const
 Get WiFi station connectoin status. More...
 
bool isConnectionFailed () const
 Get WiFi station connection failure status. More...
 
virtual StationConnectionStatus getConnectionStatus () const =0
 Get WiFi station connection status. More...
 
String getConnectionStatusName () const
 Get WiFi station connection status name. More...
 
virtual bool isEnabledDHCP () const =0
 Get WiFi station DHCP enabled status. More...
 
virtual void enableDHCP (bool enable)=0
 Enable or disable WiFi station DHCP. More...
 
virtual void setHostname (const String &hostname)=0
 Set WiFi station DHCP hostname. More...
 
virtual String getHostname () const =0
 Set WiFi station DHCP hostname. More...
 
virtual IpAddress getIP () const =0
 Get WiFi station IP address. More...
 
virtual MacAddress getMacAddress () const =0
 Get WiFi station MAC address. More...
 
String getMAC (char sep='\0') const
 Get WiFi station MAC address. More...
 
virtual IpAddress getNetworkMask () const =0
 Get WiFi station network mask. More...
 
virtual IpAddress getNetworkGateway () const =0
 Get WiFi station default gateway. More...
 
virtual IpAddress getNetworkBroadcast () const =0
 GetWiFi station broadcast address. More...
 
bool setIP (IpAddress address)
 Set WiFi station IP address. More...
 
virtual bool setIP (IpAddress address, IpAddress netmask, IpAddress gateway)=0
 Set WiFi station IP parameters. More...
 
virtual String getSSID () const =0
 Get WiFi station SSID. More...
 
virtual String getPassword () const =0
 Get WiFi station password. More...
 
virtual int8_t getRssi () const =0
 Get WiFi signal strength. More...
 
virtual uint8_t getChannel () const =0
 Get active WiFi channel. More...
 
virtual bool startScan (ScanCompletedDelegate scanCompleted)=0
 Start WiFi station network scan. More...
 

Protected Attributes

ScanCompletedDelegate scanCompletedCallback = nullptr
 

Detailed Description

WiFi station class.

Constructor & Destructor Documentation

◆ ~StationClass()

virtual StationClass::~StationClass ( )
inlinevirtual

Member Function Documentation

◆ config()

virtual bool StationClass::config ( const String ssid,
const String password,
bool  autoConnectOnStartup = true,
bool  save = true 
)
pure virtual

Configure WiFi station.

Parameters
ssidWiFi SSID
passwordWiFi password
autoConnectOnStartupTrue to auto connect. False for manual. (Default: True)
saveTrue to save the SSID and password in Flash. False otherwise. (Default: True)

◆ connect()

virtual bool StationClass::connect ( )
pure virtual

Connect WiFi station to network.

◆ disconnect()

virtual bool StationClass::disconnect ( )
pure virtual

Disconnect WiFi station from network.

◆ enable()

virtual void StationClass::enable ( bool  enabled,
bool  save = false 
)
pure virtual

Enable / disable WiFi station.

Note
Disabling WiFi station will also disable and clear the handler set with waitConnection.
Parameters
enabledTrue to enable station. False to disable.
saveTrue to save operational mode to flash, False to set current operational mode only

◆ enableDHCP()

virtual void StationClass::enableDHCP ( bool  enable)
pure virtual

Enable or disable WiFi station DHCP.

Parameters
enableTrue to enable WiFi station DHCP

◆ getChannel()

virtual uint8_t StationClass::getChannel ( ) const
pure virtual

Get active WiFi channel.

Return values
uint8_tchannel number

◆ getConnectionStatus()

virtual StationConnectionStatus StationClass::getConnectionStatus ( ) const
pure virtual

Get WiFi station connection status.

Return values
StationConnectionStatusConnection status structure

◆ getConnectionStatusName()

String StationClass::getConnectionStatusName ( ) const

Get WiFi station connection status name.

Return values
StringString representing connection status

◆ getHostname()

virtual String StationClass::getHostname ( ) const
pure virtual

Set WiFi station DHCP hostname.

Return values
WiFistation DHCP hostname

◆ getIP()

virtual IpAddress StationClass::getIP ( ) const
pure virtual

Get WiFi station IP address.

Return values
IpAddressIP address of WiFi station

◆ getMAC()

String StationClass::getMAC ( char  sep = '\0') const

Get WiFi station MAC address.

Parameters
sepOptional separator between bytes (e.g. ':')
Return values
StringWiFi station MAC address

◆ getMacAddress()

virtual MacAddress StationClass::getMacAddress ( ) const
pure virtual

Get WiFi station MAC address.

Return values
MacAddress

◆ getNetworkBroadcast()

virtual IpAddress StationClass::getNetworkBroadcast ( ) const
pure virtual

GetWiFi station broadcast address.

Return values
IpAddressWiFi station broadcast address

◆ getNetworkGateway()

virtual IpAddress StationClass::getNetworkGateway ( ) const
pure virtual

Get WiFi station default gateway.

Return values
IpAddressWiFi station default gateway

◆ getNetworkMask()

virtual IpAddress StationClass::getNetworkMask ( ) const
pure virtual

Get WiFi station network mask.

Return values
IpAddressWiFi station network mask

◆ getPassword()

virtual String StationClass::getPassword ( ) const
pure virtual

Get WiFi station password.

Return values
StringWiFi station password

◆ getRssi()

virtual int8_t StationClass::getRssi ( ) const
pure virtual

Get WiFi signal strength.

Return values
int8_tValue in dBm

◆ getSSID()

virtual String StationClass::getSSID ( ) const
pure virtual

Get WiFi station SSID.

Return values
StringWiFi station SSID

◆ isConnected()

bool StationClass::isConnected ( ) const

Get WiFi station connectoin status.

Return values
boolTrue if connected.

◆ isConnectionFailed()

bool StationClass::isConnectionFailed ( ) const

Get WiFi station connection failure status.

Return values
boolTrue if connection failed

◆ isEnabled()

virtual bool StationClass::isEnabled ( ) const
pure virtual

Get WiFi station enable status.

Return values
boolTrue if WiFi station enabled

◆ isEnabledDHCP()

virtual bool StationClass::isEnabledDHCP ( ) const
pure virtual

Get WiFi station DHCP enabled status.

Return values
boolTrue if DHCP enabled

◆ setHostname()

virtual void StationClass::setHostname ( const String hostname)
pure virtual

Set WiFi station DHCP hostname.

Parameters
hostname- WiFi station DHCP hostname

◆ setIP() [1/2]

bool StationClass::setIP ( IpAddress  address)

Set WiFi station IP address.

Parameters
addressIP address
Return values
boolTrue on success

◆ setIP() [2/2]

virtual bool StationClass::setIP ( IpAddress  address,
IpAddress  netmask,
IpAddress  gateway 
)
pure virtual

Set WiFi station IP parameters.

Parameters
addressIP address
netmaskNetwork mask
gatewayDefault gatway
Return values
boolTrue on success

◆ startScan()

virtual bool StationClass::startScan ( ScanCompletedDelegate  scanCompleted)
pure virtual

Start WiFi station network scan.

Parameters
scanCompletedFunction to call when scan completes
Return values
boolTrue on success

Member Data Documentation

◆ scanCompletedCallback

ScanCompletedDelegate StationClass::scanCompletedCallback = nullptr
protected

The documentation for this class was generated from the following file: