document side-effects for wifi-off-at-boot (#8614)

* adding wifi-off-at-boot side-effects mention in documentation
esp8266 · Jun 25, 2022 · 5656035 · 5656035
1 parent 5d4ae86
commit 5656035
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/esp8266wifi/generic-class.rst b/doc/esp8266wifi/generic-class.rst
@@ -55,6 +55,10 @@ 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.
 
+Known side-effects:
+
+-  ``WiFi.mode()`` must be called before changing mac addresses with ``wifi_set_macaddr({SOFTAP,STATION}_IF, ...)``.
+
 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).