You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/esp8266wifi/station-class.rst
+19-4
Original file line number
Diff line number
Diff line change
@@ -73,16 +73,24 @@ The simplest overload of ``begin`` is as follows:
73
73
74
74
Calling it will enable station mode and connect to the last used access point based on configuration saved in flash memory.
75
75
76
-
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>`__).
76
+
Notes:
77
+
78
+
- 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.
79
+
- 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>`__).
77
80
78
81
Below is the syntax of another overload of ``begin`` with the all possible parameters:
Meaning of parameters is as follows: \* ``ssid`` - a character string containing the SSID of Access Point we would like to connect to, may have up to 32 characters \* ``password`` to the access point, a character string that should be minimum 8 characters long and not longer than 64 characters \* ``channel`` of AP, if we like to operate using specific channel, otherwise this parameter may be omitted \* ``bssid`` -
85
-
mac address of AP, this parameter is also optional \* ``connect`` - a ``boolean`` parameter that if set to ``false``, will instruct module just to save the other parameters without actually establishing connection to the access point
87
+
Meaning of parameters is as follows:
88
+
89
+
- ``ssid`` - a character string containing the SSID of Access Point we would like to connect to, may have up to 32 characters
90
+
- ``password`` to the access point, a character string that should be minimum 8 characters long and not longer than 64 characters
91
+
- ``channel`` of AP, if we like to operate using specific channel, otherwise this parameter may be omitted
92
+
- ``bssid`` - mac address of AP, this parameter is also optional
93
+
- ``connect`` - a ``boolean`` parameter that if set to ``false``, will instruct module just to save the other parameters without actually establishing connection to the access point
86
94
87
95
config
88
96
^^^^^^
@@ -239,7 +247,13 @@ Wait until module connects to the access point. This function is intended for mo
239
247
240
248
WiFi.waitForConnectResult()
241
249
242
-
Function returns one of the following connection statuses: \* ``WL_CONNECTED`` after successful connection is established \* ``WL_NO_SSID_AVAIL``\ in case configured SSID cannot be reached \* ``WL_CONNECT_FAILED`` if password is incorrect \* ``WL_IDLE_STATUS`` when Wi-Fi is in process of changing between statuses \* ``WL_DISCONNECTED`` if module is not configured in station mode
250
+
Function returns one of the following connection statuses:
251
+
252
+
- ``WL_CONNECTED`` after successful connection is established
253
+
- ``WL_NO_SSID_AVAIL`` in case configured SSID cannot be reached
254
+
- ``WL_CONNECT_FAILED`` if password is incorrect
255
+
- ``WL_IDLE_STATUS`` when Wi-Fi is in process of changing between statuses
256
+
- ``WL_DISCONNECTED`` if module is not configured in station mode
243
257
244
258
Configuration
245
259
~~~~~~~~~~~~~
@@ -428,6 +442,7 @@ Return the status of Wi-Fi connection.
428
442
.. code:: cpp
429
443
430
444
WiFi.status()
445
+
::
431
446
432
447
Function returns one of the following connection statuses:
0 commit comments