nbWifiApi.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/

 
#ifndef __NBWIFIAPI_H
#define __NBWIFIAPI_H
 
#include <buffers.h>
#include <nettypes.h>
#include <wifi/nbWifiConstants.h>
 
// Scanning and connecting uses the SAME exact AP deifition.
struct APDefinition
{
    char SSID[SSID_MAX_LEN + 1];
    char PassPhrase[PASS_MAX_LEN + 1];       // Should be "" empty string for open networks.
    MACADR BSSID;                            // All Zeros ignored on connect.
    bool bAdhoc;                             // True if its an or to create an Adhoc network.
    char Security[SEC_HUMAN_MAX_LEN + 1];    // On scan empty string for  open on connect empty string for don't care OPEN for forcing open.
    char Cipher[CIPHER_HUMAN_MAX_LEN + 1];   // On Scan indicates the Cipher used with the security, ignored on connect.
    NB::Constants::RadioBand band;
    uint16_t Channel;
    int rssi;   // Ignored on connect calls....
};
 
#define WIFI_Result_Success (1)
#define WIFI_Result_BadPass (-1)
#define WIFI_Result_NoAPFound (-2)
#define WIFI_Result_BSSID_NotFound (-3)
#define WIFI_Result_TimedOut (-4)
 
typedef void (*ReceiveScanResultFunc)(const APDefinition &ap);
 
class WifiInterface
{
   public:
    // Connection functions
    // If all three SSID, BSSID and PassPhrase are empty, connects to strongest open network
    int Connect();   // Use the SSID and PassPhrase stored in the config record.
    int Connect(const char *SSID, const char *Pass, bool bAdHoc = false);
    int Connect(APDefinition &ap);
    int Connect(APDefinition *pAps);   // Connect to the AP deifitions on the list in order of preference.
 
    void Disconnect();
 
    // Scan Functions:
 
    // Syncronous Scan...
    APDefinition *Scan(const char *ssid = nullptr);   // nullptr SSID means scan for all
    APDefinition *ScanWithSettings(const char *ssid = nullptr,
                                   uint8_t channelCount = 0,
                                   const uint16_t *channelList = nullptr,
                                   uint8_t band = 0,
                                   uint8_t infrastructureType = 0);
    // Returns a pointer to a list of APDefinitions
    // SSID, nullptr on the last one in the list.
    // This function is not reentrant and the result is only valid until the Next call to Scan
 
    // Asyncronous Scan....
 
    // If the underlying WIFI driver has an internally timed scan then the
    // call back funciton will receive an AP with SSID =nullptr as the last indicator...
    // Otherwise you shoudl probably call StopAsyncScan
    int StartAsyncScan(ReceiveScanResultFunc *pCallBackFunc, const char *ssid = nullptr);
    int StartAsyncScanWithSettings(ReceiveScanResultFunc *pCallBackFunc,
                                   const char *ssid = nullptr,
                                   uint8_t channelCount = 0,
                                   const uint16_t *channelList = nullptr,
                                   uint8_t band = 0,
                                   uint8_t infrastructureType = 0);
    // In some implmentaions this may be an empty function....
    int StopAsyncScan();
 
    // Status functions:
    int GetCurSSID(char *buf, int maxlen);
    MACADR GetCurBSSID();
    int GetCurrentAP(APDefinition &ap);
    bool Connected();
    int GetSignalStrength();
};
 
#endif /* ----- #ifndef __NBWIFIAPI_H  ----- */