Marco Hsu / WIFI_API_32kRAM

For DFCM-NNN40-DT1R,32K RAM,

WIFIDevice.h@0:4085cc9441f3, 2015-06-26 (annotated)

Committer:
Marcomissyou
Date:
Fri Jun 26 09:44:35 2015 +0000
Revision:
0:4085cc9441f3
Commit WIFI_API_32kRAM; This API works on DFCM-NNN40-DT1R(32K RAM).

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Marcomissyou 0:4085cc9441f3 1 #ifndef WIFIDEVICE_H_
Marcomissyou 0:4085cc9441f3 2 #define WIFIDEVICE_H_
Marcomissyou 0:4085cc9441f3 3
Marcomissyou 0:4085cc9441f3 4 #include "nmi_wlan_if.h"
Marcomissyou 0:4085cc9441f3 5 #include "nmi_wlan.h"
Marcomissyou 0:4085cc9441f3 6
Marcomissyou 0:4085cc9441f3 7 /** Interface using WI-FI to connect to Ethernet
Marcomissyou 0:4085cc9441f3 8 *
Marcomissyou 0:4085cc9441f3 9 */
Marcomissyou 0:4085cc9441f3 10 class WIFIDevice {
Marcomissyou 0:4085cc9441f3 11 public:
Marcomissyou 0:4085cc9441f3 12
Marcomissyou 0:4085cc9441f3 13 /** Set WIFI in sleep mode.
Marcomissyou 0:4085cc9441f3 14 * Disable WIFI and set into sleep mode to conserve energy (no WIFI function is available at this point).
Marcomissyou 0:4085cc9441f3 15 * \return 0 on success, a negative number on failure
Marcomissyou 0:4085cc9441f3 16 */
Marcomissyou 0:4085cc9441f3 17 int sleep(void);
Marcomissyou 0:4085cc9441f3 18
Marcomissyou 0:4085cc9441f3 19 /** Set the position of embedded RF switch.
Marcomissyou 0:4085cc9441f3 20 * Set the position of RF switch between WIFI and BLE.
Marcomissyou 0:4085cc9441f3 21 * \param position set 1 on WIFI to use, set 0 on BLE to use.
Marcomissyou 0:4085cc9441f3 22 * \return 0 on success, a negative number on failure
Marcomissyou 0:4085cc9441f3 23 */
Marcomissyou 0:4085cc9441f3 24 int setSwitch(int position);
Marcomissyou 0:4085cc9441f3 25
Marcomissyou 0:4085cc9441f3 26 /** Get the position of embedded RF switch.
Marcomissyou 0:4085cc9441f3 27 * Get the current position of RF switch
Marcomissyou 0:4085cc9441f3 28 * \return get 1 on WIFI to use, get 0 on BLE to use
Marcomissyou 0:4085cc9441f3 29 */
Marcomissyou 0:4085cc9441f3 30 int getSwitch(void);
Marcomissyou 0:4085cc9441f3 31
Marcomissyou 0:4085cc9441f3 32 // /** Perform one time WIFI scan.
Marcomissyou 0:4085cc9441f3 33 // * Scan for available access point on all channels.
Marcomissyou 0:4085cc9441f3 34 // * \return number of scanned WIFI access point
Marcomissyou 0:4085cc9441f3 35 // */
Marcomissyou 0:4085cc9441f3 36 // int oneTimeScan(void);
Marcomissyou 0:4085cc9441f3 37 //
Marcomissyou 0:4085cc9441f3 38 // /** Get the scanned access point information.
Marcomissyou 0:4085cc9441f3 39 // * Get the scanned associated access point information table on least oneTimeScan.
Marcomissyou 0:4085cc9441f3 40 // * \param index query the information of result table in index number [0~19]
Marcomissyou 0:4085cc9441f3 41 // * \param SSID access point SSID name on query index
Marcomissyou 0:4085cc9441f3 42 // * \param RSSI access point RSSI (Received Signal Strength Indicator) on query index
Marcomissyou 0:4085cc9441f3 43 // * \param security access point security type on query index, get 0 on no security, 1 on WEP, 2 on WPA, 3 on WPA2
Marcomissyou 0:4085cc9441f3 44 // * \return 0 on success, a negative number on failure when empty
Marcomissyou 0:4085cc9441f3 45 // */
Marcomissyou 0:4085cc9441f3 46 // int getScanResult(uint8_t index, uint8_t* SSID, int* RSSI, uint8_t security);
Marcomissyou 0:4085cc9441f3 47
Marcomissyou 0:4085cc9441f3 48 /** Set network connection in priority.
Marcomissyou 0:4085cc9441f3 49 * Set SSID, password and priority to connect.
Marcomissyou 0:4085cc9441f3 50 * \param SSID name of access point to connect
Marcomissyou 0:4085cc9441f3 51 * \param PW password of the given SSID
Marcomissyou 0:4085cc9441f3 52 * \param priority range from 0 to 2, set 0 for the highest priority
Marcomissyou 0:4085cc9441f3 53 */
Marcomissyou 0:4085cc9441f3 54 void setNetwork(char* SSID, char* PW, uint8_t priority);
Marcomissyou 0:4085cc9441f3 55
Marcomissyou 0:4085cc9441f3 56 // /** Get the status of embedded WIFI chipset.
Marcomissyou 0:4085cc9441f3 57 // * Get the current status of embedded WIFI chipset
Marcomissyou 0:4085cc9441f3 58 // * \return get 1 on WIFI to use, get 0 on BLE to use
Marcomissyou 0:4085cc9441f3 59 // */
Marcomissyou 0:4085cc9441f3 60 // int getStatus(void);
Marcomissyou 0:4085cc9441f3 61
Marcomissyou 0:4085cc9441f3 62 // /** Set WIFI output power.
Marcomissyou 0:4085cc9441f3 63 // * Set WIFI output power level
Marcomissyou 0:4085cc9441f3 64 // * \param output power level
Marcomissyou 0:4085cc9441f3 65 // * \return 0 on success, a negative number on failure
Marcomissyou 0:4085cc9441f3 66 // */
Marcomissyou 0:4085cc9441f3 67 // int setTxPower(uint8_t powerIndex);
Marcomissyou 0:4085cc9441f3 68
Marcomissyou 0:4085cc9441f3 69 };
Marcomissyou 0:4085cc9441f3 70
Marcomissyou 0:4085cc9441f3 71 //#include "EthernetInterface.h"
Marcomissyou 0:4085cc9441f3 72
Marcomissyou 0:4085cc9441f3 73 #endif /* WIFIDEVICE_H_ */