Methods and properties described in this section are specific to ESP8266. They are not covered in Arduino WiFi library documentation. Before they are fully documented please refer to information below.
void onEvent (WiFiEventCb cb, WiFiEvent_t event=WIFI_EVENT_ANY) __attribute__((deprecated))
WiFiEventHandler onStationModeConnected (std::function< void(const WiFiEventStationModeConnected &)>) WiFiEventHandler onStationModeDisconnected (std::function< void(const WiFiEventStationModeDisconnected &)>) WiFiEventHandler onStationModeAuthModeChanged (std::function< void(const WiFiEventStationModeAuthModeChanged &)>) WiFiEventHandler onStationModeGotIP (std::function< void(const WiFiEventStationModeGotIP &)>) WiFiEventHandler onStationModeDHCPTimeout (std::function< void(void)>) WiFiEventHandler onSoftAPModeStationConnected (std::function< void(const WiFiEventSoftAPModeStationConnected &)>) WiFiEventHandler onSoftAPModeStationDisconnected (std::function< void(const WiFiEventSoftAPModeStationDisconnected &)>)
It should be noted that when an WiFi interface goes down, all WiFiClients are stopped, and all WiFiServers stop serving. When the interface comes up, it is up to the user to reconnect the relevant WiFiClients and bring the WiFiServers back up. For the WiFi station interface, it is suggested to set a callback for onStationModeDisconnected() that shuts down the user app’s WiFiClients and WiFiServers (resource cleanup), and another callback for onStationModeGotIP() that brings them back up. For the SoftAP interface, when the interface is brought up, any servers should be brought up as well.
A detailed explanation of
WiFiEventHandler can be found in the section with examples :arrow_right: dedicated specifically to the Generic Class..
Alternatively, check the example sketch WiFiEvents.ino available in the examples folder of the ESP8266WiFi library.
ESP8266 is able to reconnect to the last used WiFi network or establishes the same Access Point upon power up or reset.
By default, these settings are written to specific sectors of flash memory every time they are changed in
WiFi.begin(ssid, passphrase) or
WiFi.softAP(ssid, passphrase, channel), and when
WiFi.softAPdisconnect is invoked.
Frequently calling these functions could cause wear on the flash memory (see issue #1054).
WiFi.persistent(false) is called,
WiFi.softAPdisconnect only changes the current in-memory WiFi settings, and does not affect the WiFi settings stored in flash memory.
Regular WiFi modes¶
bool mode(WiFiMode_t m)
Switches to one of the regular WiFi modes, where
m is one of:
bool mode(WiFiMode_t m, WiFiState* state)
Used with the following pseudo-modes, where
m is one of:
WIFI_SHUTDOWN: Fills in the provided
WiFiStatestructure, switches to
WIFI_OFFmode and puts WiFi into forced sleep, preserving energy.
WIFI_RESUME: Turns WiFi on and tries to re-establish the WiFi connection stored in the
These modes are used in low-power scenarios, e.g. where ESP.deepSleep is used between actions to preserve battery power.
It is the user’s responsibility to preserve the WiFiState between
WIFI_RESUME, e.g. by storing it
in RTC user data and/or flash memory.
There is an example sketch WiFiShutdown.ino available in the examples folder of the ESP8266WiFi library.
Gets the current WiFi mode (one out of four regular modes above).
WiFi power management, DTIM¶
bool setSleepMode (WiFiSleepType_t type, int listenInterval=0)
Sleep mode type is
listenInterval appeared in esp8266-arduino core v2.5.0 using the last
V2 revision of nonos-sdk before V3)
Quoting nonos-sdk datasheet:
NONE: disable power saving
MODEM: TCP timer rate raised from 250ms to 3s
listenInterval is set to 1..10, in
station wakes up every (DTIM-interval *
listenInterval). This saves
power but station interface may miss broadcast data.
Otherwise (default value 0), station wakes up at every DTIM-interval (configured in the access-point).
A Delivery Traffic Indication Map (DTIM) is a kind of Traffic Indication Map (TIM) which informs the clients about the presence of buffered multicast/broadcast data on the access point. It is generated within the periodic beacon at a frequency specified by the DTIM Interval. Beacons are packets sent by an access point to synchronize a wireless network.
void WiFi.setOutputPower(float dBm)
Sets the max transmit power, in dBm. Values range from 0 to 20.5 [dBm] inclusive, and should be multiples of 0.25. This is essentially a thin wrapper around the SDK’s system_phy_set_max_tpw() api call.
If wifi connection issues are encountered due to signal noise, one thing to try is to reduce the Tx power. This has been found effective in cases where STA mode is in use with 802.11n phy (default). Reducing to e.g.: 17.5dBm or slightly lower can reduce noise and improve connectivity, although max range will also be reduced.
bool setPhyMode (WiFiPhyMode_t mode)
Sets the WiFi radio phy mode. Argument is an enum of type WiFiPhyMode_t, valid values are:
WIFI_PHY_MODE_11B: 802.11b mode
WIFI_PHY_MODE_11G: 802.11g mode
WIFI_PHY_MODE_11N: 802.11n mode
Per the NONOS SDK API Reference document, the AP mode only supports b/g, see notes in section on wifi_set_phy_mode() api. Returns true success, false otherwise.
Some experiments have shown that 802.11b mode has longest LOS range, while 802.11n mode has longest indoor range.
It has been observed that some wifi routers may degrade from 802.11n to g/b if an ESP8266 in g/b phy mode connects to them. That means that the entire wifi connectivity of all devices are impacted.
WiFiPhyMode_t getPhyMode (WiFiPhyMode_t mode)
Gets the WiFi radio phy mode that is currently set.
Other Function Calls¶
int32_t channel (void) WiFiSleepType_t getSleepMode () bool enableSTA (bool enable) bool enableAP (bool enable) bool forceSleepBegin (uint32 sleepUs=0) bool forceSleepWake () int hostByName (const char *aHostname, IPAddress &aResult) appeared with SDK pre-V3: uint8_t getListenInterval (); bool isSleepLevelMax ();
Documentation for the above functions is not yet prepared.
For code samples please refer to separate section with examples dedicated specifically to the Generic Class.