mirror of
https://github.com/arduino/Arduino.git
synced 2024-12-11 22:24:13 +01:00
220 lines
6.4 KiB
C++
220 lines
6.4 KiB
C++
#ifndef WiFi_Drv_h
|
|
#define WiFi_Drv_h
|
|
|
|
#include <inttypes.h>
|
|
#include "wifi_spi.h"
|
|
#include "IPAddress.h"
|
|
|
|
// Key index length
|
|
#define KEY_IDX_LEN 1
|
|
// 5 secs of delay to have the connection established
|
|
#define WL_DELAY_START_CONNECTION 5000
|
|
// firmware version string length
|
|
#define WL_FW_VER_LENGTH 6
|
|
|
|
class WiFiDrv
|
|
{
|
|
private:
|
|
// settings of requested network
|
|
static char _networkSsid[WL_NETWORKS_LIST_MAXNUM][WL_SSID_MAX_LENGTH];
|
|
static int32_t _networkRssi[WL_NETWORKS_LIST_MAXNUM];
|
|
static uint8_t _networkEncr[WL_NETWORKS_LIST_MAXNUM];
|
|
|
|
// firmware version string in the format a.b.c
|
|
static char fwVersion[WL_FW_VER_LENGTH];
|
|
|
|
// settings of current selected network
|
|
static char _ssid[WL_SSID_MAX_LENGTH];
|
|
static uint8_t _bssid[WL_MAC_ADDR_LENGTH];
|
|
static uint8_t _mac[WL_MAC_ADDR_LENGTH];
|
|
static uint8_t _localIp[WL_IPV4_LENGTH];
|
|
static uint8_t _subnetMask[WL_IPV4_LENGTH];
|
|
static uint8_t _gatewayIp[WL_IPV4_LENGTH];
|
|
|
|
/*
|
|
* Get network Data information
|
|
*/
|
|
static void getNetworkData(uint8_t *ip, uint8_t *mask, uint8_t *gwip);
|
|
|
|
static uint8_t reqHostByName(const char* aHostname);
|
|
|
|
static int getHostByName(IPAddress& aResult);
|
|
|
|
public:
|
|
|
|
/*
|
|
* Driver initialization
|
|
*/
|
|
static void wifiDriverInit();
|
|
|
|
/*
|
|
* Set the desired network which the connection manager should try to
|
|
* connect to.
|
|
*
|
|
* The ssid of the desired network should be specified.
|
|
*
|
|
* param ssid: The ssid of the desired network.
|
|
* param ssid_len: Lenght of ssid string.
|
|
* return: WL_SUCCESS or WL_FAILURE
|
|
*/
|
|
static int8_t wifiSetNetwork(char* ssid, uint8_t ssid_len);
|
|
|
|
/* Start Wifi connection with passphrase
|
|
* the most secure supported mode will be automatically selected
|
|
*
|
|
* param ssid: Pointer to the SSID string.
|
|
* param ssid_len: Lenght of ssid string.
|
|
* param passphrase: Passphrase. Valid characters in a passphrase
|
|
* must be between ASCII 32-126 (decimal).
|
|
* param len: Lenght of passphrase string.
|
|
* return: WL_SUCCESS or WL_FAILURE
|
|
*/
|
|
static int8_t wifiSetPassphrase(char* ssid, uint8_t ssid_len, const char *passphrase, const uint8_t len);
|
|
|
|
/* Start Wifi connection with WEP encryption.
|
|
* Configure a key into the device. The key type (WEP-40, WEP-104)
|
|
* is determined by the size of the key (5 bytes for WEP-40, 13 bytes for WEP-104).
|
|
*
|
|
* param ssid: Pointer to the SSID string.
|
|
* param ssid_len: Lenght of ssid string.
|
|
* param key_idx: The key index to set. Valid values are 0-3.
|
|
* param key: Key input buffer.
|
|
* param len: Lenght of key string.
|
|
* return: WL_SUCCESS or WL_FAILURE
|
|
*/
|
|
static int8_t wifiSetKey(char* ssid, uint8_t ssid_len, uint8_t key_idx, const void *key, const uint8_t len);
|
|
|
|
/*
|
|
* Disconnect from the network
|
|
*
|
|
* return: WL_SUCCESS or WL_FAILURE
|
|
*/
|
|
static int8_t disconnect();
|
|
|
|
/*
|
|
* Disconnect from the network
|
|
*
|
|
* return: one value of wl_status_t enum
|
|
*/
|
|
static uint8_t getConnectionStatus();
|
|
|
|
/*
|
|
* Get the interface MAC address.
|
|
*
|
|
* return: pointer to uint8_t array with length WL_MAC_ADDR_LENGTH
|
|
*/
|
|
static uint8_t* getMacAddress();
|
|
|
|
/*
|
|
* Get the interface IP address.
|
|
*
|
|
* return: copy the ip address value in IPAddress object
|
|
*/
|
|
static void getIpAddress(IPAddress& ip);
|
|
|
|
/*
|
|
* Get the interface subnet mask address.
|
|
*
|
|
* return: copy the subnet mask address value in IPAddress object
|
|
*/
|
|
static void getSubnetMask(IPAddress& mask);
|
|
|
|
/*
|
|
* Get the gateway ip address.
|
|
*
|
|
* return: copy the gateway ip address value in IPAddress object
|
|
*/
|
|
static void getGatewayIP(IPAddress& ip);
|
|
|
|
/*
|
|
* Return the current SSID associated with the network
|
|
*
|
|
* return: ssid string
|
|
*/
|
|
static char* getCurrentSSID();
|
|
|
|
/*
|
|
* Return the current BSSID associated with the network.
|
|
* It is the MAC address of the Access Point
|
|
*
|
|
* return: pointer to uint8_t array with length WL_MAC_ADDR_LENGTH
|
|
*/
|
|
static uint8_t* getCurrentBSSID();
|
|
|
|
/*
|
|
* Return the current RSSI /Received Signal Strength in dBm)
|
|
* associated with the network
|
|
*
|
|
* return: signed value
|
|
*/
|
|
static int32_t getCurrentRSSI();
|
|
|
|
/*
|
|
* Return the Encryption Type associated with the network
|
|
*
|
|
* return: one value of wl_enc_type enum
|
|
*/
|
|
static uint8_t getCurrentEncryptionType();
|
|
|
|
/*
|
|
* Start scan WiFi networks available
|
|
*
|
|
* return: Number of discovered networks
|
|
*/
|
|
static int8_t startScanNetworks();
|
|
|
|
/*
|
|
* Get the networks available
|
|
*
|
|
* return: Number of discovered networks
|
|
*/
|
|
static uint8_t getScanNetworks();
|
|
|
|
/*
|
|
* Return the SSID discovered during the network scan.
|
|
*
|
|
* param networkItem: specify from which network item want to get the information
|
|
*
|
|
* return: ssid string of the specified item on the networks scanned list
|
|
*/
|
|
static char* getSSIDNetoworks(uint8_t networkItem);
|
|
|
|
/*
|
|
* Return the RSSI of the networks discovered during the scanNetworks
|
|
*
|
|
* param networkItem: specify from which network item want to get the information
|
|
*
|
|
* return: signed value of RSSI of the specified item on the networks scanned list
|
|
*/
|
|
static int32_t getRSSINetoworks(uint8_t networkItem);
|
|
|
|
/*
|
|
* Return the encryption type of the networks discovered during the scanNetworks
|
|
*
|
|
* param networkItem: specify from which network item want to get the information
|
|
*
|
|
* return: encryption type (enum wl_enc_type) of the specified item on the networks scanned list
|
|
*/
|
|
static uint8_t getEncTypeNetowrks(uint8_t networkItem);
|
|
|
|
/*
|
|
* Resolve the given hostname to an IP address.
|
|
* param aHostname: Name to be resolved
|
|
* param aResult: IPAddress structure to store the returned IP address
|
|
* result: 1 if aIPAddrString was successfully converted to an IP address,
|
|
* else error code
|
|
*/
|
|
static int getHostByName(const char* aHostname, IPAddress& aResult);
|
|
|
|
/*
|
|
* Get the firmware version
|
|
* result: version as string with this format a.b.c
|
|
*/
|
|
static char* getFwVersion();
|
|
|
|
};
|
|
|
|
extern WiFiDrv wiFiDrv;
|
|
|
|
#endif
|