Skip to content

Commit c33ef89

Browse files
aerlondevyte
authored andcommitted
Fix formatting of bullet lists (#5098)
1 parent 3164af0 commit c33ef89

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

Diff for: doc/esp8266wifi/soft-access-point-class.rst

+16-6
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,20 @@ To set up password protected network, or to configure additional network paramet
4848
4949
The first parameter of this function is required, remaining four are optional.
5050

51-
Meaning of all parameters is as follows: - ``ssid`` - character string containing network SSID (max. 63 characters) \* ``password`` - optional character string with a password. For WPA2-PSK network it should be at least 8 character long. If not specified, the access point will be open for anybody to connect. \* ``channel`` - optional parameter to set Wi-Fi channel, from 1 to 13. Default channel = 1. \* ``hidden`` - optional parameter, if set to ``true`` will hide SSID. \* ``max_connection`` - optional parameter to set max simultaneous connected stations, `from 1 to 8 <https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832>`__. Defaults to 4. Once the max number has been reached, any other station that wants to connect will be forced to wait until an already connected station disconnects.
51+
Meaning of all parameters is as follows:
52+
53+
- ``ssid`` - character string containing network SSID (max. 63 characters)
54+
- ``password`` - optional character string with a password. For WPA2-PSK network it should be at least 8 character long. If not specified, the access point will be open for anybody to connect.
55+
- ``channel`` - optional parameter to set Wi-Fi channel, from 1 to 13. Default channel = 1.
56+
- ``hidden`` - optional parameter, if set to ``true`` will hide SSID.
57+
- ``max_connection`` - optional parameter to set max simultaneous connected stations, `from 1 to 8 <https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832>`__. Defaults to 4. Once the max number has been reached, any other station that wants to connect will be forced to wait until an already connected station disconnects.
5258

5359
Function will return ``true`` or ``false`` depending on result of setting the soft-AP.
5460

55-
Notes: \* The network established by softAP will have default IP address of 192.168.4.1. This address may be changed using ``softAPConfig`` (see below). \* Even though ESP8266 can operate in soft-AP + station mode, it actually has only one hardware channel. Therefore in soft-AP + station mode, the soft-AP channel will default to the number used by station. For more information how this may affect operation of stations connected to ESP8266's soft-AP, please check `this FAQ entry <http://bbs.espressif.com/viewtopic.php?f=10&t=324>`__ on Espressif forum.
61+
Notes:
62+
63+
- The network established by softAP will have default IP address of 192.168.4.1. This address may be changed using ``softAPConfig`` (see below).
64+
- Even though ESP8266 can operate in soft-AP + station mode, it actually has only one hardware channel. Therefore in soft-AP + station mode, the soft-AP channel will default to the number used by station. For more information how this may affect operation of stations connected to ESP8266's soft-AP, please check `this FAQ entry <http://bbs.espressif.com/viewtopic.php?f=10&t=324>`__ on Espressif forum.
5665

5766
softAPConfig
5867
^^^^^^^^^^^^
@@ -63,10 +72,11 @@ Configure the soft access point's network interface.
6372
6473
softAPConfig (local_ip, gateway, subnet)
6574
66-
| All parameters are the type of ``IPAddress`` and defined as follows:
67-
\* ``local_ip`` - IP address of the soft access point \* ``gateway`` -
68-
gateway IP address
69-
| \* ``subnet`` - subnet mask
75+
All parameters are the type of ``IPAddress`` and defined as follows:
76+
77+
- ``local_ip`` - IP address of the soft access point
78+
- ``gateway`` - gateway IP address
79+
- ``subnet`` - subnet mask
7080

7181
Function will return ``true`` or ``false`` depending on result of changing the configuration.
7282

0 commit comments

Comments
 (0)