NetBurner 3.1
wifi.h
Go to the documentation of this file.
1 /*NB_REVISION*/
2 
3 /*NB_COPYRIGHT*/
4 
15 #ifndef __NBWIFI_H
16 #define __NBWIFI_H
17 
18 #include <wifi/wifiDriver.h>
20 #include <wifi/nbwifi/nbWifiSpi.h>
22 
23 
24 /*****************************************************************************
25  *
26  * Default WiFi Initialization Structure
27  *
28  * Uncomment one macro to use the default pin/irq settings for that WiFi
29  * module. The default pin/irq settings are defined in the NBWIFI Getting
30  * Started Guide. To customize the pin/irq settings, include the WiFiInit
31  * structure with customized settings in your application.
32  *
33  *****************************************************************************/
34 #define ENABLE_NBWIFIIN_SPI
35 // #define ENABLE_NBWIFIIN_SERIAL
36 // #define ENABLE_NBWIFIWILC
37 
38 
39 extern const int NBWIFI_PLAT_DEFAULT_IRQNUM;
40 extern const int NBWIFI_PLAT_DEFAULT_SPINUM;
41 extern const int NBWIFI_PLAT_DEFAULT_CSNUM;
42 extern const int NBWIFI_PLAT_DEFAULT_CONNUM;
43 extern const int NBWIFI_PLAT_DEFAULT_PINNUM;
44 extern const int NBWIFI_PLAT_DEFAULT_RESETPIN;
45 extern const int NBWIFI_PLAT_DEFAULT_UART;
46 extern const int NBWIFI_PLAT_DEFAULT_CHIPEN;
47 
48 #define NBWIFI_DEFAULT_WIFICHANNEL 6
49 
50 
79 nbWifiScanResult * WifiInitScan_SPI(
80  int irqNum = -1,
81  int moduleNum = -1,
82  int csNum = -1,
83  int connectorNum = -1,
84  int gpioPinNum = -1,
85  int resetPinNum = -1
86  );
87 
109  int irqNum = -1,
110  int moduleNum = -1,
111  int csNum = -1,
112  int connectorNum = -1,
113  int gpioPinNum = -1,
114  int resetPinNum = -1
115  );
116 
141 int InitWifi_SPI(
142  const char * SSID = "",
143  const char * password = "",
144  int irqNum = -1,
145  int moduleNum = -1,
146  int csNum = -1,
147  int connectorNum = -1,
148  int gpioPinNum = -1,
149  int resetPinNum = -1
150  );
151 
178 int InitAP_SPI(
179  const char * SSID = "",
180  const char * password = "",
181  uint8_t channel = NBWIFI_DEFAULT_WIFICHANNEL,
182  int irqNum = -1,
183  int moduleNum = -1,
184  int csNum = -1,
185  int connectorNum = -1,
186  int gpioPinNum = -1,
187  int resetPinNum = -1
188  );
189 
209 nbWifiScanResult * WifiInitScan_Serial(
210  int portNum = -1,
211  int resetPinNum =-1,
212  int connectorNum =-1
213  );
214 
232  int portNum = -1,
233  int resetPinNum =-1,
234  int connectorNum = -1
235  );
236 
257 int InitWifi_Serial(
258  const char * SSID = "",
259  const char * password = "",
260  int portNum = -1,
261  int resetPinNum = -1,
262  int connectorNum = -1
263  );
264 
276 void SetWifiSPISpeed( int busSpeed );
277 
286 void ScanAndShowNetworks();
287 
297 nbWifiScanResult * ScanForNetworks();
298 
299 #endif /* ----- #ifndef __NBWIFI_H ----- */
int InitAP_SPI(const char *SSID="", const char *password="", uint8_t channel=NBWIFI_DEFAULT_WIFICHANNEL, int irqNum=-1, int moduleNum=-1, int csNum=-1, int connectorNum=-1, int gpioPinNum=-1, int resetPinNum=-1)
Initializes the WiFi hardware, initializes the driver using the SPI bus, and attempts to establish th...
int InitWifi_Serial(const char *SSID="", const char *password="", int portNum=-1, int resetPinNum=-1, int connectorNum=-1)
Initializes the WiFi hardware, initializes the driver using the UART interface, and attempts to estab...
int WifiInitScanAndShow_Serial(int portNum=-1, int resetPinNum=-1, int connectorNum=-1)
Initializes the WiFi hardware, initializes the driver using the UART interface, performs an AP scan...
nbWifiScanResult * WifiInitScan_SPI(int irqNum=-1, int moduleNum=-1, int csNum=-1, int connectorNum=-1, int gpioPinNum=-1, int resetPinNum=-1)
Initializes the WiFi hardware, initializes the driver over the SPI bus, and performs an AP scan...
NetBurner Wifi API.
int InitWifi_SPI(const char *SSID="", const char *password="", int irqNum=-1, int moduleNum=-1, int csNum=-1, int connectorNum=-1, int gpioPinNum=-1, int resetPinNum=-1)
Initializes the WiFi hardware, initializes the driver using the SPI bus, and attempts to establish th...
nbWifiScanResult * WifiInitScan_Serial(int portNum=-1, int resetPinNum=-1, int connectorNum=-1)
Initializes the WiFi hardware, initializes the driver using the UART interface, performs an AP scan...
void ScanAndShowNetworks()
Scan for surrounding access points and print the results via iprintf.
nbWifiScanResult * ScanForNetworks()
Scan for surrounding access points.
int WifiInitScanAndShow_SPI(int irqNum=-1, int moduleNum=-1, int csNum=-1, int connectorNum=-1, int gpioPinNum=-1, int resetPinNum=-1)
Initializes the WiFi hardware, initializes the driver using the SPI bus, performs an AP scan...
void SetWifiSPISpeed(int busSpeed)
Set SPI bus speed.