Skip to content

Commit 24a1d22

Browse files
aerlondevyte
authored andcommitted
Make softAP documentation state the correct min value (0) for the max_connection argument. (#5165)
1 parent d547c47 commit 24a1d22

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

doc/esp8266wifi/readme.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Soft Access Point
125125
~~~~~~~~~~~~~~~~~
126126

127127
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)
128-
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.
128+
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.
129129

130130
.. figure:: pictures/esp8266-soft-access-point.png
131131
:alt: ESP8266 operating in the Soft Access Point mode

doc/esp8266wifi/soft-access-point-class.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Meaning of all parameters is as follows:
5454
- ``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.
5555
- ``channel`` - optional parameter to set Wi-Fi channel, from 1 to 13. Default channel = 1.
5656
- ``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.
57+
- ``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.
5858

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

@@ -141,7 +141,7 @@ Get the count of the stations that are connected to the soft-AP interface.
141141

142142
Stations connected to soft-AP = 2
143143

144-
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.
144+
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.
145145

146146
softAPdisconnect
147147
^^^^^^^^^^^^^^^^

libraries/ESP8266WiFi/src/ESP8266WiFiAP.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ static bool softap_config_equal(const softap_config& lhs, const softap_config& r
8989
* @param passphrase (for WPA2 min 8 char, for open use NULL)
9090
* @param channel WiFi channel number, 1 - 13.
9191
* @param ssid_hidden Network cloaking (0 = broadcast SSID, 1 = hide SSID)
92-
* @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
92+
* @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
9393
*/
9494
bool ESP8266WiFiAPClass::softAP(const char* ssid, const char* passphrase, int channel, int ssid_hidden, int max_connection) {
9595

0 commit comments

Comments
 (0)