arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-07-27 18:02:17 +03:00
Code Activity

Soft-AP documentation update (#5088)

Browse Source 
* Add information about the max_connection constructor argument.

* Correct information about max soft-AP connections.

* Add information about what happens when max_connection is reached.

* Correct terminology

* - Correct the valid range of max_connection to 1 - 8.
- Include reference.
This commit is contained in:
aerlon
2018-08-29 17:17:44 +02:00
committed by Develo
parent 1ed7bee15e
commit 1d841953ab
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -44,11 +44,11 @@ To set up password protected network, or to configure additional network paramet
.. code:: cpp
WiFi.softAP(ssid, password, channel, hidden)
WiFi.softAP(ssid, password, channel, hidden, max_connection)
The first parameter of this function is required, remaining three are optional.
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
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.
@ -131,7 +131,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 five.
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.
softAPdisconnect
^^^^^^^^^^^^^^^^