Skip to content

Commit eca1367

Browse files
committed
fix doc
1 parent 9d7eb2e commit eca1367

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

doc/esp8266wifi/generic-class.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,18 @@ and WiFi does not anymore automatically fires up at boot**.
4949
(see PR `#7902 <https://github.com/esp8266/Arduino/pull/7902>`__).
5050

5151
Previously, SDK was automatically starting WiFi at boot. This was probably
52-
intended for the Espressif AT FW which is interactive and preserves state
53-
accross reboots. This behavior is generally irrelevant with the Arduino
54-
API because sketches start with WiFi.begin() or softAP...
55-
56-
This change is harmless with standard sketches: Calls to
57-
WiFi.mode()+WiFi.begin/WiFi.softAP(...) do enable radio as usual. It also
58-
smooths current spikes at boot and also decrease DHCP stress.
59-
60-
Legacy behavior can be restored by calling `enableWiFiAtBoot()` anywhere in
61-
the code (this is a weak void function intended to play with the linker).
52+
intended for the Espressif AT FW which is interactive and preserves WiFi
53+
state accross reboots. This behavior is generally irrelevant with the
54+
Arduino API because sketches start with ``WiFi.begin()`` or
55+
``WiFi.softAP()``.
56+
57+
This change is harmless with standard sketches: Calls to ``WiFi.mode()`` do
58+
enable radio as usual. It also smooths current spikes at boot and also
59+
decreases DHCP stress.
60+
61+
Legacy behavior can be restored by calling ``enableWiFiAtBoot()`` from
62+
anywhere in the code (it is a weak void function intended to play with the
63+
linker).
6264

6365
.. code:: cpp
6466
void setup () {

doc/faq/readme.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,5 +181,8 @@ Ref. `#3072 <https://github.com/esp8266/Arduino/issues/3072>`__
181181
My WiFi was previously automatically connected wight after booting
182182
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
183183

184-
This was WiFi persistence. WiFi is now indeed off at boot and is powered on
185-
only when using the regular API. Read more at :ref:`wifiOffAtBoot`.
184+
This was WiFi persistence. Starting from version 3 of this core, WiFi is
185+
indeed off at boot and is powered on only when starting to be used with the
186+
regular API.
187+
188+
Read more at :ref:`wifiOffAtBoot <../esp8266wifi/generic-class>`.

0 commit comments

Comments
 (0)