Skip to content

Commit

Permalink
Fix formatting of bullet lists (#5098)
Browse files Browse the repository at this point in the history
  • Loading branch information
aerlon authored and devyte committed Aug 31, 2018
1 parent 3164af0 commit c33ef89
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions doc/esp8266wifi/soft-access-point-class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,20 @@ To set up password protected network, or to configure additional network paramet
The first parameter of this function is required, remaining four are optional.

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.
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.

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

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.
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.

softAPConfig
^^^^^^^^^^^^
Expand All @@ -63,10 +72,11 @@ Configure the soft access point's network interface.
softAPConfig (local_ip, gateway, subnet)
| All parameters are the type of ``IPAddress`` and defined as follows:
\* ``local_ip`` - IP address of the soft access point \* ``gateway`` -
gateway IP address
| \* ``subnet`` - subnet mask
All parameters are the type of ``IPAddress`` and defined as follows:

- ``local_ip`` - IP address of the soft access point
- ``gateway`` - gateway IP address
- ``subnet`` - subnet mask

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

Expand Down

0 comments on commit c33ef89

Please sign in to comment.