Skip to content

Commit

Permalink
Update wifi event monitor documentation
Browse files Browse the repository at this point in the history
Added a note to `wifi.eventmon.register()` and `wifi.sta.eventmonreg()`
  • Loading branch information
dnc40085 committed Mar 29, 2017
1 parent fc887e9 commit 62206e5
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/en/modules/wifi.md
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.

#### 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

0 comments on commit 62206e5

Please sign in to comment.