Skip to content
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

Update wifi event monitor documentation #1889

Merged
merged 4 commits into from
Mar 31, 2017
Merged

Update wifi event monitor documentation #1889

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62206e5
Update wifi event monitor documentation
dnc40085 Mar 29, 2017
1b81f09
Fix admonition syntax
marcelstoer Mar 29, 2017
7730165
correct typo
dnc40085 Mar 30, 2017
2e2ff0f
Add deprecation note to `wifi.sta.eventMonReg()`
dnc40085 Mar 30, 2017
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
7 changes: 7 additions & 0 deletions docs/en/modules/wifi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,9 @@ none

Registers callbacks for WiFi station status events.

!!! note
Please update your program to use the [`wifi.eventmon`](#wifieventmon-module) API, as the `wifi.sta.eventmon___()` API is to be depreciated.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is to be depreciated

  1. That should be "deprecated" I guess?
  2. "to be" confuses me a little here, is it deprecated or not?

Copy link
Contributor Author

@dnc40085 dnc40085 Mar 30, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That should be "deprecated" I guess?
"to be" confuses me a little here, is it deprecated or not?

You're right, I found this Wikipedia page about deprecation, and it is indeed "deprecated".


#### Syntax
- `wifi.sta.eventMonReg(wifi_status[, function([previous_state])])`

Expand Down Expand Up @@ -1371,6 +1374,10 @@ Note: The functions `wifi.sta.eventMon___()` and `wifi.eventmon.___()` are compl
## wifi.eventmon.register()

Register/unregister callbacks for WiFi event monitor.
- After a callback is registered, this function may be called to update a callback's function at any time

!!! note
To ensure all WiFi events are caught, the Wifi event monitor callbacks should be registered as early as possible in `init.lua`. Any events that occur before callbacks are registered will be discarded!

#### Syntax
wifi.eventmon.register(Event[, function(T)])
Expand Down