mirror of
https://github.com/esp8266/Arduino.git
synced 2025-04-21 10:26:06 +03:00
Make softAP documentation state the correct min value (0) for the max_connection argument. (#5165)
This commit is contained in:
parent
d547c47667
commit
24a1d22730
@ -125,7 +125,7 @@ Soft Access Point
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
An `access point (AP) <https://en.wikipedia.org/wiki/Wireless_access_point>`__ is a device that provides access to Wi-Fi network to other devices (stations)
|
||||
and connects them further to a wired network. ESP8266 can provide similar functionality except it does not have interface to a wired network. Such mode of operation is called soft access point (soft-AP). The maximum number of stations that can simultaneously be connected to the soft-AP can be set `from 1 to 8 <https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832>`__, but defaults to 4.
|
||||
and connects them further to a wired network. ESP8266 can provide similar functionality except it does not have interface to a wired network. Such mode of operation is called soft access point (soft-AP). The maximum number of stations that can simultaneously be connected to the soft-AP can be set `from 0 to 8 <https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832>`__, but defaults to 4.
|
||||
|
||||
.. figure:: pictures/esp8266-soft-access-point.png
|
||||
:alt: ESP8266 operating in the Soft Access Point mode
|
||||
|
@ -54,7 +54,7 @@ Meaning of all parameters is as follows:
|
||||
- ``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.
|
||||
- ``max_connection`` - optional parameter to set max simultaneous connected stations, `from 0 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.
|
||||
|
||||
@ -141,7 +141,7 @@ Get the count of the stations that are connected to the soft-AP interface.
|
||||
|
||||
Stations connected to soft-AP = 2
|
||||
|
||||
Note: the maximum number of stations that may be connected to ESP8266 soft-AP is 4 by default. This can be changed from 1 to 8 via the ``max_connection`` argument of the softAP method.
|
||||
Note: the maximum number of stations that may be connected to ESP8266 soft-AP is 4 by default. This can be changed from 0 to 8 via the ``max_connection`` argument of the softAP method.
|
||||
|
||||
softAPdisconnect
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
@ -89,7 +89,7 @@ static bool softap_config_equal(const softap_config& lhs, const softap_config& r
|
||||
* @param passphrase (for WPA2 min 8 char, for open use NULL)
|
||||
* @param channel WiFi channel number, 1 - 13.
|
||||
* @param ssid_hidden Network cloaking (0 = broadcast SSID, 1 = hide SSID)
|
||||
* @param max_connection Max simultaneous connected clients, 1 - 8. https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832
|
||||
* @param max_connection Max simultaneous connected clients, 0 - 8. https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832
|
||||
*/
|
||||
bool ESP8266WiFiAPClass::softAP(const char* ssid, const char* passphrase, int channel, int ssid_hidden, int max_connection) {
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user