WiFi Access Point

Control and monitoring of WiFi access point interface. More...

Functions
void	AccessPointClass::enable (bool enabled, bool save=false)
	Enable or disable WiFi AP. More...
bool	AccessPointClass::isEnabled ()
	Get WiFi AP enable status. More...
bool	AccessPointClass::config (const String &ssid, String password, AUTH_MODE mode, bool hidden=false, int channel=7, int beaconInterval=200)
	Configure WiFi AP. More...
IPAddress	AccessPointClass::getIP ()
	Get WiFi AP IP address. More...
bool	AccessPointClass::setIP (IPAddress address)
	Set WiFi AP IP addres. More...
String	AccessPointClass::getMAC (char sep= '\0')
	Get WiFi AP MAC address. More...
IPAddress	AccessPointClass::getNetworkMask ()
	Get WiFi AP network mask. More...
IPAddress	AccessPointClass::getNetworkGateway ()
	Get WiFi AP default gateway. More...
IPAddress	AccessPointClass::getNetworkBroadcast ()
	Get WiFi AP broadcast address. More...
String	AccessPointClass::getSSID ()
	Get WiFi access point SSID. More...
String	AccessPointClass::getPassword ()
	Get WiFi access point password. More...

Variables
AccessPointClass	WifiAccessPoint
	Global instance of WiFi access point object. More...

Detailed Description

Control and monitoring of WiFi access point interface.

Access point class.

Note

The WiFi access point interface provides a WiFi network access point. Control of WiFi AP including WiFi SSID and password and IP address.

See also

WiFi Station Interface

Todo:

How is wifi access point dhcp controlled?

Function Documentation

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

Configure WiFi AP.

Parameters

ssid	WiFi AP SSID
password	WiFi AP password
mode	WiFi AP mode
hidden	True to hide WiFi AP (Default: Visible)
channel	WiFi AP channel (Default: 7)
beaconInterval	WiFi AP beacon interval in milliseconds (Default: 200ms)

Return values

bool	True on success

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

Enable or disable WiFi AP.

Parameters

enabled	True to enable AP. False to disable.
save	True to save operational mode to flash, False to set current operational mode only

IPAddress AccessPointClass::getIP

(

)

Get WiFi AP IP address.

Return values

IPAddress

WiFi AP IP address

String AccessPointClass::getMAC

(

char

sep = '\0'

)

Get WiFi AP MAC address.

Parameters

optional

separator between bytes (e.g. ':')

Return values

String

WiFi AP MAC address

IPAddress AccessPointClass::getNetworkBroadcast

(

)

Get WiFi AP broadcast address.

Return values

IPAddress

WiFi AP broadcast address

IPAddress AccessPointClass::getNetworkGateway

(

)

Get WiFi AP default gateway.

Return values

IPAddress

WiFi AP default gateway

IPAddress AccessPointClass::getNetworkMask

(

)

Get WiFi AP network mask.

Return values

IPAddress

WiFi AP network mask

String AccessPointClass::getPassword

(

)

Get WiFi access point password.

Return values

String

WiFi access point password

String AccessPointClass::getSSID

(

)

Get WiFi access point SSID.

Return values

String

WiFi access point SSID

bool AccessPointClass::isEnabled

(

)

Get WiFi AP enable status.

Return values

bool	True if WiFi AP enabled.

bool AccessPointClass::setIP

(

IPAddress

address

)

Set WiFi AP IP addres.

Parameters

address

New IP address for WiFi AP

Return values

bool	True on success

Variable Documentation

AccessPointClass WifiAccessPoint

Global instance of WiFi access point object.

Note

Use WiFiAccessPoint.function to access WiFi access point functions

Example:

if(WiFiAccessPoint.config("ESP_AP", AUTH_OPEN))
           WiFiAccessPoint.enable(true);