Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BREAKING] Disable WiFi at boot by default #7902

Merged
merged 29 commits into from
Apr 9, 2021
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
ab16b8c
Disable WiFi at boot by default
d-a-v Mar 2, 2021
6310da8
+define WIFI_IS_OFF_AT_BOOT
d-a-v Mar 2, 2021
330b229
remove now useless example
d-a-v Mar 3, 2021
68d338e
Merge branch 'master' into WiFiOffAtBoot
d-a-v Mar 3, 2021
253bbc5
Merge branch 'master' into WiFiOffAtBoot
d-a-v Mar 3, 2021
5ead6a2
Merge branch 'WiFiOffAtBoot' of github.com:d-a-v/Arduino into WiFiOff…
d-a-v Mar 3, 2021
b2a53b7
mv enableWiFiAtBootTime() to core_esp8266_features.h
d-a-v Mar 3, 2021
7756427
Merge branch 'master' into WiFiOffAtBoot
d-a-v Mar 15, 2021
64ff4b0
Merge branch 'WiFiOffAtBoot' of github.com:d-a-v/Arduino into WiFiOff…
d-a-v Mar 15, 2021
2d4ca1d
sync with master
d-a-v Mar 15, 2021
8510670
Merge branch 'master' into WiFiOffAtBoot
earlephilhower Mar 15, 2021
1059beb
Merge branch 'master' into WiFiOffAtBoot
earlephilhower Mar 16, 2021
7fd4116
per @earlephilhower review: a file was missing
d-a-v Mar 16, 2021
c15cb5d
doc
d-a-v Mar 16, 2021
9d7eb2e
WiFi persistence is now false by default
d-a-v Mar 16, 2021
227e557
Merge branch 'master' into WiFiOffAtBoot
d-a-v Mar 16, 2021
eca1367
fix doc
d-a-v Mar 16, 2021
8b0d641
Merge branch 'WiFiOffAtBoot' of github.com:d-a-v/Arduino into WiFiOff…
d-a-v Mar 16, 2021
6d9ec26
ditto
d-a-v Mar 16, 2021
8ecc7f0
doc: remove sphinx warnings (fix links and formatting)
d-a-v Mar 16, 2021
8332c42
fix link name
d-a-v Mar 16, 2021
df8f8a7
fix doc
d-a-v Mar 18, 2021
20020c0
legacy: restore persistence
d-a-v Mar 18, 2021
4e5abc6
Merge branch 'master' into WiFiOffAtBoot
d-a-v Mar 31, 2021
2eb8bb1
undeprecate preinit()
d-a-v Mar 31, 2021
da5966b
move force modem up to when mode has changed (per @mcspr review)
d-a-v Mar 31, 2021
f0f1f55
do not wake up from sleep when mode if OFF
d-a-v Mar 31, 2021
77087f0
Merge branch 'master' into WiFiOffAtBoot
d-a-v Apr 9, 2021
5d12aa2
fix doc per review
d-a-v Apr 9, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cores/esp8266/core_esp8266_main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ extern "C" void user_init(void) {
#if defined(MMU_IRAM_HEAP)
umm_init_iram();
#endif
preinit(); // deprecated
preinit(); // Prior to C++ Dynamic Init (not related to above init() ). Meant to be user redefinable.
__disableWiFiAtBootTime(); // default weak function disables WiFi

ets_task(loop_task,
Expand Down
27 changes: 27 additions & 0 deletions doc/esp8266wifi/generic-class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,33 @@ persistent

WiFi.persistent(persistent)

Starting from version 3 of this core, **persistence is disabled by default
and WiFi does not anymore automatically fires up at boot** (see PR `#7902 <https://github.com/esp8266/Arduino/pull/7902>`__).
d-a-v marked this conversation as resolved.
Show resolved Hide resolved

Previously, SDK was automatically starting WiFi at boot. This was probably
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest highlighting here that the prior to v3 persistent was defaulted to true, and so the wifi creds were always stored to flash when the WiFi was configured, which could lead to a reduced life of the wifi config flash sector, and hence the entire ESP. Starting with v3, persistent defaults to false, so creds aren't stored by the SDK in the flash sector and hence don't survive across reboots.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@devyte I think this is not precisely correct. Settings that were once persisted, remain that way, so thereafter, WiFi.begin(), with no WiFi.persistent(true) in the sketch, as long as enableWiFiAtBootTime() is somewhere in the sketch, will suffice to auto-connect to the AP.

intended for the Espressif AT FW which is interactive and preserves WiFi
state accross reboots. This behavior is generally irrelevant with the
Arduino API because sketches start with ``WiFi.begin()`` or
``WiFi.softAP()``.

This change is harmless with standard sketches: Calls to ``WiFi.mode()`` do
enable radio as usual. It also smooths current spikes at boot and decreases
DHCP stress.

Legacy behavior can be restored by calling ``enableWiFiAtBootTime()`` from
anywhere in the code (it is a weak void function intended to play with the
linker).

.. code:: cpp

void setup () {
#ifdef WIFI_IS_OFF_AT_BOOT
enableWiFiAtBootTime(); // can be called from anywhere with the same effect
#endif
....
}

When legacy behavior is restored thanks to this call,
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.disconnect`` or ``WiFi.softAPdisconnect`` is invoked.
Frequently calling these functions could cause wear on the flash memory (see issue `#1054 <https://github.com/esp8266/Arduino/issues/1054>`__).
Expand Down
1 change: 1 addition & 0 deletions doc/esp8266wifi/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ WiFi Multi
Example:

.. code:: cpp

#include <ESP8266WiFiMulti.h>

ESP8266WiFiMulti wifiMulti;
Expand Down
5 changes: 2 additions & 3 deletions doc/faq/a01-espcomm_sync-failed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,8 @@ following three things right: 1. Module is provided with enough power,
2. GPIO0, GPIO15 and CH\_PD are connected using pull up / pull down
resistors, 3. Module is put into boot loader mode.

For specific details please refer to section on `Generic ESP8266
modules <../boards.rst#generic-esp8266-modules>`__. Example modules
without USB to serial converter on board are shown below.
For specific details please refer to section on `Generic ESP8266 module <../boards.rst#generic-esp8266-module>`__.
Example modules without USB to serial converter on board are shown below.

.. figure:: pictures/a01-example-boards-without-usb.png
:alt: Example ESP8266 modules without USB to serial converter
Expand Down
2 changes: 1 addition & 1 deletion doc/faq/a04-board-generic-is-unknown.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ follows:
Error compiling for board Generic ESP8266 Module.

Below is an example messages for
`WeMos <../boards.rst#wemos-d1-r2-mini>`__:
`WeMos <../boards.rst#lolin-wemos-d1-r2-mini>`__:

::

Expand Down
9 changes: 9 additions & 0 deletions doc/faq/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,3 +177,12 @@ will need to implement an additional (short) deep sleep using
``WAKE_RF_DEFAULT``.

Ref. `#3072 <https://github.com/esp8266/Arduino/issues/3072>`__

My WiFi was previously automatically connected right after booting
d-a-v marked this conversation as resolved.
Show resolved Hide resolved
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This was WiFi persistence. Starting from version 3 of this core, WiFi is
indeed off at boot and is powered on only when starting to be used with the
regular API.

Read more at `former WiFi persistent mode <../esp8266wifi/generic-class.rst#persistent>`__.
16 changes: 8 additions & 8 deletions doc/filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -474,8 +474,8 @@ Performs the same operation as ``info`` but allows for reporting greater than
4GB for filesystem size/used/etc. Should be used with the SD and SDFS
filesystems since most SD cards today are greater than 4GB in size.

setTimeCallback(time_t (*cb)(void))
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
setTimeCallback(time_t (\*cb)(void))
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: cpp

Expand Down Expand Up @@ -574,8 +574,8 @@ rewind

Resets the internal pointer to the start of the directory.

setTimeCallback(time_t (*cb)(void))
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
setTimeCallback(time_t (\*cb)(void))
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sets the time callback for any files accessed from this Dir object via openNextFile.
Note that the SD and SDFS filesystems only support a filesystem-wide callback and
Expand Down Expand Up @@ -693,7 +693,7 @@ Close the file. No other operations should be performed on *File* object
after ``close`` function was called.

openNextFile (compatibiity method, not recommended for new code)
~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: cpp

Expand All @@ -705,7 +705,7 @@ Opens the next file in the directory pointed to by the File. Only valid
when ``File.isDirectory() == true``.

rewindDirectory (compatibiity method, not recommended for new code)
~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: cpp

Expand All @@ -718,8 +718,8 @@ rewindDirectory (compatibiity method, not recommended for new code)
Resets the ``openNextFile`` pointer to the top of the directory. Only
valid when ``File.isDirectory() == true``.

setTimeCallback(time_t (*cb)(void))
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
setTimeCallback(time_t (\*cb)(void))
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sets the time callback for this specific file. Note that the SD and
SDFS filesystems only support a filesystem-wide callback and calls to
Expand Down
2 changes: 1 addition & 1 deletion doc/libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Some ESP-specific APIs related to deep sleep, RTC and flash memories are availab

``ESP.getHeapFragmentation()`` returns the fragmentation metric (0% is clean, more than ~50% is not harmless)

``ESP.getMaxFreeBlockSize()`` returns the largest contiguous free RAM block in the heap, useful for checking heap fragmentation. **NOTE:** Maximum ``malloc()``able block will be smaller due to memory manager overheads.
``ESP.getMaxFreeBlockSize()`` returns the largest contiguous free RAM block in the heap, useful for checking heap fragmentation. **NOTE:** Maximum ``malloc()`` -able block will be smaller due to memory manager overheads.

``ESP.getChipId()`` returns the ESP8266 chip ID as a 32-bit integer.

Expand Down
2 changes: 0 additions & 2 deletions doc/mmu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,5 +233,3 @@ address range of IRAM or DRAM.
uint8_t mmu_set_uint8(void *p8, const uint8_t val);
uint16_t mmu_set_uint16(uint16_t *p16, const uint16_t val);
int16_t mmu_set_int16(int16_t *p16, const int16_t val);

::
2 changes: 1 addition & 1 deletion doc/ota_updates/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ If signing is desired, sign the gzip compressed file *after* compression.
Updating apps in the field to support compression
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have applications deployed in the field and wish to update them to support compressed OTA uploads, you will need to first recompile the application, then _upload the uncompressed `.bin` file once_. Attempting to upload a `gzip` compressed binary to a legacy app will result in the Updater rejecting the upload as it does not understand the `gzip` format. After this initial upload, which will include the new bootloader and `Updater` class with compression support, compressed updates can then be used.
If you have applications deployed in the field and wish to update them to support compressed OTA uploads, you will need to first recompile the application, then _upload the uncompressed `.bin` file once. Attempting to upload a `gzip` compressed binary to a legacy app will result in the Updater rejecting the upload as it does not understand the `gzip` format. After this initial upload, which will include the new bootloader and `Updater` class with compression support, compressed updates can then be used.


Safety
Expand Down
14 changes: 7 additions & 7 deletions libraries/ESP8266WiFi/src/ESP8266WiFiGeneric.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ struct WiFiEventHandlerOpaque

static std::list<WiFiEventHandler> sCbEventList;

bool ESP8266WiFiGenericClass::_persistent = true;
bool ESP8266WiFiGenericClass::_persistent = false;
WiFiMode_t ESP8266WiFiGenericClass::_forceSleepLastMode = WIFI_OFF;

ESP8266WiFiGenericClass::ESP8266WiFiGenericClass()
Expand Down Expand Up @@ -418,12 +418,6 @@ bool ESP8266WiFiGenericClass::mode(WiFiMode_t m, WiFiState* state) {
DEBUG_WIFI("core: state is useless without SHUTDOWN or RESUME\n");
}

if (wifi_fpm_get_sleep_type() != NONE_SLEEP_T) {
// wifi starts asleep by default
wifi_fpm_do_wakeup();
wifi_fpm_close();
}

if(_persistent){
if(wifi_get_opmode() == (uint8) m && wifi_get_opmode_default() == (uint8) m){
return true;
Expand All @@ -432,6 +426,12 @@ bool ESP8266WiFiGenericClass::mode(WiFiMode_t m, WiFiState* state) {
return true;
}

if (m != WIFI_OFF && wifi_fpm_get_sleep_type() != NONE_SLEEP_T) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small side note / question, will test some time later today
wifi_fpm_get_sleep_type() is MODEM_SLEEP_T by default (in the previous version, or when wifi-off preinit is disabled by user currently) since this is a setting, not the actual mode that is active. is it ok do wakeup & close without fpm active?

// wifi starts asleep by default
wifi_fpm_do_wakeup();
wifi_fpm_close();
}

bool ret = false;
ETS_UART_INTR_DISABLE();
if(_persistent) {
Expand Down
2 changes: 1 addition & 1 deletion libraries/ESP8266WiFi/src/ESP8266WiFiGeneric.h
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ class ESP8266WiFiGenericClass {

void setOutputPower(float dBm);

void persistent(bool persistent);
static void persistent(bool persistent);

bool mode(WiFiMode_t, WiFiState* state = nullptr);
WiFiMode_t getMode();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

#include "coredecls.h"

#include <ESP8266WiFi.h>

extern "C" void enableWiFiAtBootTime()
{
/*
Expand All @@ -16,5 +18,11 @@ extern "C" void enableWiFiAtBootTime()
extern "C" void __disableWiFiAtBootTime()
{
// overrides the default __disableWiFiAtBootTime:
// Does nothing: WiFi is enabled by default in nonos-sdk
// Does (almost) nothing: WiFi is enabled by default in nonos-sdk

// ... but restores legacy WiFi credentials persistence to true at boot time
// (can be still overriden by user before setting up WiFi, like before)

// (note: c++ ctors not called yet at this point)
ESP8266WiFiClass::persistent(true);
}