arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-21 10:26:06 +03:00
Code

Format lists for readability (#5082)

Browse Source 
Changed in-line style to bulleted lists for improved readability
This commit is contained in:
jlpuder 2018-08-27 09:58:25 -04:00 committed by Develo
parent 0713a01db8
commit 9634f79f45
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -73,7 +73,10 @@ The simplest overload of ``begin`` is as follows:
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>`__).
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:
@ -81,8 +84,13 @@ Below is the syntax of another overload of ``begin`` with the all possible param
WiFi.begin(ssid, password, channel, bssid, connect)
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`` -
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
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`` - 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
config
^^^^^^
@ -239,7 +247,13 @@ Wait until module connects to the access point. This function is intended for mo
WiFi.waitForConnectResult()
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
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
Configuration
~~~~~~~~~~~~~
@ -428,6 +442,7 @@ Return the status of Wi-Fi connection.
.. code:: cpp
WiFi.status()
::
Function returns one of the following connection statuses: