• dnc40085's avatar
    Update to the wifi module (#1497) · 73773fd8
    dnc40085 authored
    * 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
    73773fd8
wifi.md 39.5 KB