ESP8266
Public Member Functions | List of all members
ESP8266WiFiAPClass Class Reference
Inheritance diagram for ESP8266WiFiAPClass:
ESP8266WiFiClass

Public Member Functions

bool softAP (const char *ssid, const char *passphrase=NULL, int channel=1, int ssid_hidden=0)
 
bool softAPConfig (IPAddress local_ip, IPAddress gateway, IPAddress subnet)
 
bool softAPdisconnect (bool wifioff=false)
 
uint8_t softAPgetStationNum ()
 
IPAddress softAPIP ()
 
uint8_t * softAPmacAddress (uint8_t *mac)
 
String softAPmacAddress (void)
 

Member Function Documentation

bool ESP8266WiFiAPClass::softAP ( const char *  ssid,
const char *  passphrase = NULL,
int  channel = 1,
int  ssid_hidden = 0 
)

Set up an access point

Parameters
ssidPointer to the SSID (max 63 char).
passphrase(for WPA2 min 8 char, for open use NULL)
channelWiFi channel number, 1 - 13.
ssid_hiddenNetwork cloaking (0 = broadcast SSID, 1 = hide SSID)
bool ESP8266WiFiAPClass::softAPConfig ( IPAddress  local_ip,
IPAddress  gateway,
IPAddress  subnet 
)

Configure access point

Parameters
local_ipaccess point IP
gatewaygateway IP
subnetsubnet mask
bool ESP8266WiFiAPClass::softAPdisconnect ( bool  wifioff = false)

Disconnect from the network (close AP)

Parameters
wifioffdisable mode?
Returns
one value of wl_status_t enum
uint8_t ESP8266WiFiAPClass::softAPgetStationNum ( )

Get the count of the Station / client that are connected to the softAP interface

Returns
Stations count
IPAddress ESP8266WiFiAPClass::softAPIP ( )

Get the softAP interface IP address.

Returns
IPAddress softAP IP
uint8_t * ESP8266WiFiAPClass::softAPmacAddress ( uint8_t *  mac)

Get the softAP interface MAC address.

Parameters
macpointer to uint8_t array with length WL_MAC_ADDR_LENGTH
Returns
pointer to uint8_t*
String ESP8266WiFiAPClass::softAPmacAddress ( void  )

Get the softAP interface MAC address.

Returns
String mac