arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-19 23:22:16 +03:00
Code

Fix formatting of bullet lists (#5098)

Browse Source
This commit is contained in:
aerlon 2018-08-31 19:03:37 +02:00 committed by Develo
parent 3164af0f35
commit c33ef89f60
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/esp8266wifi/soft-access-point-class.rst
View File

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