Skip to content

Commit

Permalink
Fix WiFi status formatting issue (bullet list) (esp8266#4671)
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelstoer authored and devyte committed Apr 25, 2018
1 parent a0d1c64 commit 41a6470
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion doc/esp8266wifi/station-class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,13 @@ Return the status of Wi-Fi connection.
WiFi.status()
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

Returned value is type of ``wl_status_t`` defined in `wl\_definitions.h <https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/src/include/wl_definitions.h>`__

Expand Down

0 comments on commit 41a6470

Please sign in to comment.