NetBurner 3.5.6
PDF Version
wifi.h
Go to the documentation of this file.
1/*NB_REVISION*/
2
3/*NB_COPYRIGHT*/
4
20#ifndef __NBWIFI_H
21#define __NBWIFI_H
22
23#include <wifi/wifiDriver.h>
24#include <wifi/wilc/nbWifiWilcSpi.h>
25#include <wifi/nbwifi/nbWifiSpi.h>
26#include <wifi/nbwifi/nbWifiSerial.h>
27
28/*****************************************************************************
29 *
30 * Default WiFi Initialization Structure
31 *
32 * Uncomment one macro to use the default pin/irq settings for that WiFi
33 * module. The default pin/irq settings are defined in the NBWIFI Getting
34 * Started Guide. To customize the pin/irq settings, include the WiFiInit
35 * structure with customized settings in your application.
36 *
37 *****************************************************************************/
38#define ENABLE_NBWIFIIN_SPI
39// #define ENABLE_NBWIFIIN_SERIAL
40// #define ENABLE_NBWIFIWILC
41
42extern const int NBWIFI_PLAT_DEFAULT_IRQNUM ;
43extern const int NBWIFI_PLAT_DEFAULT_IRQPIN;
44extern const int NBWIFI_PLAT_DEFAULT_SPINUM;
45extern const int NBWIFI_PLAT_DEFAULT_CSNUM;
46extern const int NBWIFI_PLAT_DEFAULT_CONNUM;
47extern const int NBWIFI_PLAT_DEFAULT_PINNUM;
48extern const int NBWIFI_PLAT_DEFAULT_RESETPIN;
49extern const int NBWIFI_PLAT_DEFAULT_UART;
50extern const int NBWIFI_PLAT_DEFAULT_CHIPEN;
51
52#define NBWIFI_DEFAULT_WIFICHANNEL 6
53
82nbWifiScanResult *WifiInitScan_SPI(int irqNum = -1,
83 int moduleNum = -1,
84 int csNum = -1,
85 int connectorNum = -1,
86 int gpioPinNum = -1,
87 int resetPinNum = -1);
88
110int WifiInitScanAndShow_SPI(int irqNum = -1,
111 int moduleNum = -1,
112 int csNum = -1,
113 int connectorNum = -1,
114 int gpioPinNum = -1,
115 int resetPinNum = -1);
116
142int InitWifi_SPI(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
186int InitAP_SPI(const char *SSID = "",
187 const char *password = "",
188 uint8_t channel = NBWIFI_DEFAULT_WIFICHANNEL,
189 int irqNum = -1,
190 int moduleNum = -1,
191 int csNum = -1,
192 int connectorNum = -1,
193 int gpioPinNum = -1,
194 int resetPinNum = -1);
195
215nbWifiScanResult *WifiInitScan_Serial(int portNum = -1, int resetPinNum = -1, int connectorNum = -1);
216
233int WifiInitScanAndShow_Serial(int portNum = -1, int resetPinNum = -1, int connectorNum = -1);
234
255int InitWifi_Serial(const char *SSID = "", const char *password = "", int portNum = -1, int resetPinNum = -1, int connectorNum = -1);
256
263void SetWifiSPISpeed(int busSpeed);
264
271void ScanAndShowNetworks();
272
282nbWifiScanResult *ScanForNetworks();
283
284#endif /* ----- #ifndef __NBWIFI_H ----- */
285
WifiInitScanAndShow_Serial
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,...
InitWifi_SPI
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...
SetWifiSPISpeed
void SetWifiSPISpeed(int busSpeed)
Set SPI bus speed.
WifiInitScan_SPI
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.
InitAP_SPI
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...
WifiInitScanAndShow_SPI
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,...
WifiInitScan_Serial
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,...
ScanAndShowNetworks
void ScanAndShowNetworks()
Scan for surrounding access points and print the results via iprintf.
ScanForNetworks
nbWifiScanResult * ScanForNetworks()
Scan for surrounding access points.
InitWifi_Serial
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...
wifiDriver.h
NetBurner Wifi API.