AccessPointClass Class Referenceabstract

Access point class. More...

#include <AccessPoint.h>

Public Member Functions

virtual ~AccessPointClass ()
 
virtual void enable (bool enabled, bool save=false)=0
 Enable or disable WiFi AP. More...
 
virtual bool isEnabled () const =0
 Get WiFi AP enable status. More...
 
virtual bool config (const String &ssid, String password, WifiAuthMode mode, bool hidden=false, int channel=7, int beaconInterval=200)=0
 Configure WiFi AP. More...
 
virtual IpAddress getIP () const =0
 Get WiFi AP IP address. More...
 
virtual bool setIP (IpAddress address)=0
 Set WiFi AP IP address. More...
 
virtual MacAddress getMacAddress () const =0
 Get WiFi AP MAC address. More...
 
String getMAC (char sep='\0') const
 Get WiFi AP MAC address. More...
 
virtual bool setMacAddress (const MacAddress &addr) const =0
 Set Access Point MAC address. More...
 
virtual IpAddress getNetworkMask () const =0
 Get WiFi AP network mask. More...
 
virtual IpAddress getNetworkGateway () const =0
 Get WiFi AP default gateway. More...
 
virtual IpAddress getNetworkBroadcast () const =0
 Get WiFi AP broadcast address. More...
 
bool isLocal (IpAddress address)
 Determine if the given address is on the same subnet. More...
 
virtual String getSSID () const =0
 Get WiFi access point SSID. More...
 
virtual String getPassword () const =0
 Get WiFi access point password. More...
 
virtual std::unique_ptr< StationListgetStations () const =0
 Gets a list of stations connected to the access point. More...
 

Detailed Description

Access point class.

Constructor & Destructor Documentation

◆ ~AccessPointClass()

virtual AccessPointClass::~AccessPointClass ( )
inlinevirtual

Member Function Documentation

◆ config()

virtual bool AccessPointClass::config ( const String ssid,
String  password,
WifiAuthMode  mode,
bool  hidden = false,
int  channel = 7,
int  beaconInterval = 200 
)
pure virtual

Configure WiFi AP.

Parameters
ssidWiFi AP SSID
passwordWiFi AP password
modeWiFi AP mode
hiddenTrue to hide WiFi AP (Default: Visible)
channelWiFi AP channel (Default: 7)
beaconIntervalWiFi AP beacon interval in milliseconds (Default: 200ms)
Return values
boolTrue on success

◆ enable()

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

Enable or disable WiFi AP.

Parameters
enabledTrue to enable AP. False to disable.
saveTrue to save operational mode to flash, False to set current operational mode only

◆ getIP()

virtual IpAddress AccessPointClass::getIP ( ) const
pure virtual

Get WiFi AP IP address.

Return values
IpAddressWiFi AP IP address

◆ getMAC()

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

Get WiFi AP MAC address.

Parameters
sepseparator between bytes (e.g. ':')
Return values
StringWiFi AP MAC address

◆ getMacAddress()

virtual MacAddress AccessPointClass::getMacAddress ( ) const
pure virtual

Get WiFi AP MAC address.

Return values
MacAddress

◆ getNetworkBroadcast()

virtual IpAddress AccessPointClass::getNetworkBroadcast ( ) const
pure virtual

Get WiFi AP broadcast address.

Return values
IpAddressWiFi AP broadcast address

◆ getNetworkGateway()

virtual IpAddress AccessPointClass::getNetworkGateway ( ) const
pure virtual

Get WiFi AP default gateway.

Return values
IpAddressWiFi AP default gateway

◆ getNetworkMask()

virtual IpAddress AccessPointClass::getNetworkMask ( ) const
pure virtual

Get WiFi AP network mask.

Return values
IpAddressWiFi AP network mask

◆ getPassword()

virtual String AccessPointClass::getPassword ( ) const
pure virtual

Get WiFi access point password.

Return values
StringWiFi access point password

◆ getSSID()

virtual String AccessPointClass::getSSID ( ) const
pure virtual

Get WiFi access point SSID.

Return values
StringWiFi access point SSID

◆ getStations()

virtual std::unique_ptr<StationList> AccessPointClass::getStations ( ) const
pure virtual

Gets a list of stations connected to the access point.

Return values
StationList

◆ isEnabled()

virtual bool AccessPointClass::isEnabled ( ) const
pure virtual

Get WiFi AP enable status.

Return values
boolTrue if WiFi AP enabled.

◆ isLocal()

bool AccessPointClass::isLocal ( IpAddress  address)
inline

Determine if the given address is on the same subnet.

Parameters
address
Return values
booltrue if address is local
Note
Use to prevent external access to services

◆ setIP()

virtual bool AccessPointClass::setIP ( IpAddress  address)
pure virtual

Set WiFi AP IP address.

Parameters
addressNew IP address for WiFi AP
Return values
boolTrue on success

◆ setMacAddress()

virtual bool AccessPointClass::setMacAddress ( const MacAddress addr) const
pure virtual

Set Access Point MAC address.

Parameters
addrThe new MAC address
Return values
booltrue on success

Must be called from init() before activating Access Point. Espressif place certain limitations on MAC addresses:

Bit 0 of the first byte of the MAC address can not be 1. For example:

OK: "1a:XX:XX:XX:XX:XX" NOT OK: "15:XX:XX:XX:XX:XX"


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