8000 Soft-AP documentation update by aerlon · Pull Request #5088 · esp8266/Arduino · GitHub
[go: up one dir, main page]
Skip to content

Soft-AP documentation update #5088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 29, 2018
Merged

Soft-AP documentation update #5088

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
650e4cf
Add information about the max_connection constructor argument.
aerlon Aug 28, 2018
dc5a5db
Correct information about max soft-AP connections.
aerlon Aug 28, 2018
1ec5ace
Add information about what happens when max_connection is reached.
aerlon Aug 28, 2018
6d29939
Correct terminology
aerlon Aug 28, 2018
fa3aca9
Merge branch 'master' into ap_documentation_update
aerlon Aug 29, 2018
0f9337b
- Correct the valid range of max_connection to 1 - 8.
aerlon Aug 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add information about what happens when max_connection is reached.
  • Loading branch information
@aerlon
aerlon authored Aug 28, 2018
commit 1ec5ace7cb1d2bd8365fa57b1995f7ff9e9e2737
2 changes: 1 addition & 1 deletion doc/esp8266wifi/soft 8C09 -access-point-class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ 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 clients, from 1 to 4. Defaults to 4.
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 4. 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.

Expand Down
0