Commit Graph

26 Commits

Author SHA1 Message Date
Luís Fonseca fcc91967f9 Improve wifi documentation - prefer constants to hardcoded values (#1837) 2017-03-07 07:04:39 +01:00
Jason Follas 2ab28df92a Support clearing WiFi config (#1761)
* Add wifi.sta.clearconfig(). Adjust password validation to match 2.0.0 SDK rules (no min length enforced, i.e. for WEP)
* Updat comments about WEP key not having a minimum
* Documentation: add note about node.restore() to wifi.sta.clearconfig() docs, and add SDK verbiage to describe what node.restore() impacts.
* Normaliz if statements
* Convert leading tabs to leading spaces for consistency
2017-02-08 21:42:29 +01:00
Marcel Stör 9dfedaf55c Fix admonitions in WiFi docs 2017-01-01 17:32:29 +01:00
Marcel Stör 007f870cb6 Fix list indentation 2016-12-29 09:23:06 +01:00
Marcel Stör 1452fbfd13 Fix list formatting 2016-12-23 13:43:52 +01:00
Marcel Stör 680d349039 Fix list formatting 2016-12-23 12:59:46 +01:00
dnc40085 73773fd8a5 Update to the wifi module (#1497)
* Removed inline documentation for several functions and update comments
Since documentation is now part of the repository, the inline
documentation just adds to the already huge wifi.c

* Wifi module: add new functionality, update documentation

Functions Added:
wifi.getdefaultmode(): returns default wifi opmode
wifi.sta.apchange(): select alternate cached AP
wifi.sta.apinfo(): get cached AP list 
wifi.sta.aplimit(): set cached AP limit
wifi.sta.getapindex(): get index of currently configured AP
wifi.sta.getdefaultconfig(): get default station configuration
wifi.ap.getdefaultconfig(): get default AP configuration

functions modified:
wifi.setmode: saving mode to flash is now optional
wifi.sta.config: now accepts table as an argument and save config to
flash is now optional
wifi.sta.getconfig: added option to return table
wifi.ap.config: save config to flash is now optional
wifi.ap.getconfig: added option to return table

Documentation changes:
- Modified documentation to reflect above changes
- Removed unnecessary inline documentation from `wifi.c` 
- Updated documentation for `wifi.sta.disconnect`to address issue #1480 
- Fixed inaccurate documentation for function `wifi.sleeptype`
- Added more details to `wifi.nullmodesleep()`

* Move function `wifi.sleeptype()` to `wifi.sta.sleeptype()`

* Fixed problem where wifi.x.getconfig() returned invalid strings when
ssid or password were set to maximum length.

* fix error in documentation for `wifi.sta.getapindex`

* Renamed some wifi functions
wifi.sta.apinfo -> getapinfo
wifi.sta.aplimit -> setaplimit 
wifi.sta.apchange -> changeap

also organized the wifi_station_map array
2016-11-06 20:51:01 +01:00
dnc40085 3328c66f2c Add function `wifi.nullmodesleep()` (#1475)
Enable auto sleep in NULL_MODE by default.
2016-08-27 11:46:24 +02:00
snosrap 8cd5e02634 Fixed `STA_DISCONNECT` typo (#1430) 2016-07-31 23:09:16 +02:00
Marcel Stör 0bbce6f845 Set admonition types correctly (subjective) 2016-07-14 22:52:30 +02:00
Marcel Stör 3a7f01bb66 Fix documented MAC address format of wifi.sta.getmac() 2016-06-29 22:46:34 +02:00
Marcel Stör ed679a7263 Correct WiFi auth constants in docs, fixes #1360 2016-06-21 22:13:26 +02:00
Konrad Beckmann 65e83fd2f4 Fixed typo in wifi doc (#1337)
Changed wifi.getpymode() into wifi.getphymode()
2016-06-04 15:33:58 +02:00
dnc40085 1b4234e2d3 Add details to WiFi module documentation (#1294)
Update descriptions of `wifi.setmode`, `wifi.sta.config` and `wifi.ap.config` to inform user of configuration persistence.
2016-05-14 23:04:20 +02:00
dnc40085 526f5457a2 Fixed some errors in wifi documentation (#1279)
Changed Parameters in `wifi.sta.status()` to match constants in source.

Fixed typo in example for `wifi.eventmon.register()`.
2016-05-02 13:57:18 +02:00
Marcel Stör 8dbbe40fb8 Improve docs wrt to auto-connect vs connect, addresses #1273 2016-04-29 19:21:25 +02:00
dnc40085 5e9ab01523 Modified wifi module
Implement SDK event monitor
Move wifi status event monitor code into seperate file
(app/modules/wifi_eventmon.c)
Modify wifi lua callback registration code.
Add Functions wifi.ap.deauth and wifi.sta.getrssi
Rework wifi event monitor to use tasking interface
fix for Lua coroutine compatibility issue
Made changes Suggested by TerryE

Also, moved code that sets the default host name out of
luaopen_wifi_init and into a separate function and added a post_task_low
entry in it's place.

Replaced some if test then return error lines with
luaL_argcheck
Add check for malloc null return in wifi.eventmon 
to catch out of memory errors
2016-03-31 19:01:41 -07:00
dnc40085 7def6ec7cf fix for #1065
Also changed wifi.sta.eventMonStop("unreg all") to
wifi.sta.eventMonStop(1) and wifi.sta.eventMonReg(wifi.status, "unreg")
to wifi.sta.eventMonReg(wifi.status)
2016-03-13 09:51:48 -07:00
Marcel Stör 202cc1a12a Add meta-info block to every module doc page 2016-03-06 08:56:28 +01:00
Marcel Stör f087908d62 Disable SmartConfig by default 2016-03-01 21:32:24 +01:00
San 598b098184 Fix example code in WiFi Module Doc 2016-01-20 09:34:45 +08:00
Marcel Stör 96a05dcd41 Fix syntax for optional parameters for a few modules 2016-01-17 14:14:34 +01:00
Marcel Stör b03a669683 Add documentation for new wifi functions 2016-01-15 23:06:09 +01:00
Marcel Stör e1733f8d3a Remove extra comma in wifi docs 2016-01-15 00:00:49 +01:00
Marcel Stör 6480ba7282 Complete wifi docs transition 2016-01-14 23:27:38 +01:00
Johny Mattsson 5fc553c7ce Transferred top-level WiFi module docs.
Note that this does not include wifi.sta, wifi.ap or wifi.ap.dhcp docs.
2016-01-13 21:55:18 +11:00