Add event callbacks to wifi.sta.config() and wifi.ap.config() and more #1903
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added option to register event callbacks during configuration of both station and AP. Added option to register event callbacks to `wifi.sta.connect()` and `wifi.sta.disconnect()`
Other minor changes to wifi documentation are also included
TerryE
reviewed
Apr 8, 2017
docs/en/modules/wifi.md
Outdated
| @@ -1143,7 +1144,8 @@ Sets SSID and password in AP mode. Be sure to make the password at least 8 chara | |||
| - `save` save configuration to flash. | |||
| - `true` configuration **will** be retained through power cycle. (Default) | |||
| - `false` configuration **will not** be retained through power cycle. | |||
| - Event callbacks will only be available if `WIFI_SDK_EVENT_MONITOR_ENABLE` is enabled in `user_config.h` | |||
| - Event callbacks will only be available if `WIFI_SDK_EVENT_MONITOR_ENABLE` is uncommented in `user_config.h` | |||
| - Please note: To ensure all SoftAP events are handled at boot time, all relevant callbacks must be registered as early as possible in `init.lua` with either `wifi.ap.config()` or `wifi.eventmon.register()`. | |||
There was a problem hiding this comment.
One comment about this. The way this reads, the cb's are optional, which they are technically, but I feel that we should add a caveat to the effect that:
Application developers should not assume that the WiFi is connected at any time during initialization start-up. This should be validated either by using a wifi event callback or by polling the status on a timer.
Or words to that effect.
eiselekd
pushed a commit
to eiselekd/nodemcu-firmware
that referenced
this pull request
Jan 7, 2018
nodemcu#1903) * Add event callbacks to wifi.sta.config() and wifi.ap.config() and more Added option to register event callbacks during configuration of both station and AP. Added option to register event callbacks to `wifi.sta.connect()` and `wifi.sta.disconnect()` * Add note about event registration to wifi module documentation Other minor changes to wifi documentation are also included * Add more detail to documentation for wifi.sta.config()
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add feature requested in issue #1131.
devbranch rather than formaster.docs/en/*.This PR adds the functionality requested in issue #1131, add optional callbacks to
wifi.sta.connect()andwifi.sta.disconnect(). The option to register event callbacks as part of the Station/SoftAP configuration process has also been implemented.