/**
 * @file	SFE_CC3000.h
 * @brief 	Library for the SparkFun CC3000 shield and breakout boards
 * @author	Shawn Hymel (SparkFun Electronics)
 * @author  Revisions by Jacob Rosenthal (https://github.com/jacobrosenthal)
 * 
 * @copyright	This code is public domain but you buy me a beer if you use
 * this and we meet someday (Beerware license).
 * 
 * This library interfaces the TI CC3000 to Arduino over SPI. The library relies
 * on the Arduino built-in SPI commands. To use the library, instantiate an
 * SFE_CC3000 object, call the init() function, and then call connect() with the
 * necessary connection details.
 */

#ifndef SFE_CC3000_H
#define SFE_CC3000_H

#include <Arduino.h>

#include "wlan.h"                       // Needed for CC3000 #defines
#include "netapp.h"                     // Needed for struct types
#include "Client.h"

/* Constants for AP scanning */
#define SCAN_MIN_DWELL_TIME     20              // Milliseconds
#define SCAN_MAX_DWELL_TIME     30              // Milliseconds
#define SCAN_NUM_PROBE_REQS     2
#define SCAN_CHANNEL_MASK       0x7FF
#define SCAN_RSSI_THRESHOLD     -80
#define SCAN_NSR_THRESHOLD      0
#define SCAN_DEFAULT_TX_POWER   205
#define SCAN_NUM_CHANNELS       16
#define SCAN_CHANNEL_TIMEOUT    2000            // Milliseconds
#define BSSID_LENGTH            6

/* Struct for storing results from AP scan */
typedef struct ScanResult {
    uint32_t num_networks;
    uint32_t scan_status;
    unsigned is_valid : 1;
    unsigned rssi : 7;
    unsigned security_mode : 2;
    unsigned ssid_length : 6;
    uint16_t entry_time;
    unsigned char ssid[32];
    unsigned char bssid[6];
} ScanResult;

/* Struct for returning results to the user from AP scan */
typedef struct AccessPointInfo {
    unsigned int rssi;
    unsigned int security_mode;
    char ssid[32];
    unsigned char bssid[6];
} AccessPointInfo;

/* Struct for returning connection information to the user */
typedef struct ConnectionInfo {
    unsigned char ip_address[4];
    unsigned char subnet_mask[4];
    unsigned char default_gateway[4];
    unsigned char dhcp_server[4];
    unsigned char dns_server[4];
    unsigned char mac_address[6];
    char ssid[32];
} ConnectionInfo;

/* Struct for returning ping reports to the user */
typedef struct PingReports
{
	unsigned long packets_sent;
	unsigned long packets_received;
	unsigned long min_round_time;
	unsigned long max_round_time;
	unsigned long avg_round_time;
} PingReport;

/* CC3000 class */
class SFE_CC3000 {
public:
    SFE_CC3000(uint8_t int_pin, uint8_t en_pin, uint8_t cs_pin);
    ~SFE_CC3000();
    bool init();
	bool getFirmwareVersion(unsigned char *fw_ver);
    bool getMacAddress(unsigned char *mac_addr);
    bool scanAccessPoints(unsigned int scan_time);
    bool getNextAccessPoint(AccessPointInfo &ap_info);  
    bool connect(   char *ssid,  
                    unsigned int security,
                    char *password = NULL,
                    unsigned int timeout = 0);
    bool startSmartConfig(unsigned int timeout = 3000);
    bool fastConnect(unsigned int timeout = 3000);
    bool disconnect();
    bool dnsLookup(char *hostname, IPAddress *ip_address);
    bool ping(  IPAddress ip_address, 
                PingReport &ping_report,
                unsigned int attempts = 1, 
                unsigned int size = 56, 
                unsigned int timeout = 1000);
    bool getDHCPStatus();
    bool getConnectionStatus();
    bool getInitStatus();
    bool getConnectionInfo(ConnectionInfo &info);
private:
    bool is_initialized_;
    uint32_t num_access_points_;
    uint32_t access_point_count_;
    ScanResult ap_scan_result_;
    tNetappIpconfigRetArgs connection_info_;
};

#endif