arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-25 20:02:37 +03:00
Code

Adding Notes in WiFi.begin docs (closes #4949) (#4958)

Browse Source 
* Also fixing formatting of unrelated link in station class docs.
This commit is contained in:
Joseph Spencer 2018-07-28 17:52:54 -07:00 committed by Develo
parent 799193888a
commit 2ee744ecdd
1 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/esp8266wifi/station-class.rst
View File

@ -62,7 +62,7 @@ By default, ESP will attempt to reconnect to Wi-Fi network whenever it is discon
begin
^^^^^
There are several versions (called *`function overloads <https://en.wikipedia.org/wiki/Function_overloading>`__* in C++) of ``begin`` function. One was presented just above:
There are several versions (called `function overloads <https://en.wikipedia.org/wiki/Function_overloading>`__ in C++) of ``begin`` function. One was presented just above:
``WiFi.begin(ssid, password)``. Overloads provide flexibility in number or type of accepted parameters.
The simplest overload of ``begin`` is as follows:
@ -71,7 +71,9 @@ The simplest overload of ``begin`` is as follows:
WiFi.begin()
Calling it will instruct module to switch to the station mode and connect to the last used access point basing on configuration saved in flash memory.
Calling it will enable station mode and connect to the last used access point based on configuration saved in flash memory.
Notes: \* It is possible that calling ``begin`` will result in the module being in STA + softAP mode if the module was previously placed into AP mode. \* If you notice strange behavior with DNS or other network functionality, check which mode your module is in (see ``WiFi.mode()`` in the `Generic Class Documentation <generic-class.rst#mode>`__).
Below is the syntax of another overload of ``begin`` with the all possible parameters: