GainSpan Wi-Fi library

Diff: GSwifiInterface.h

Revision:

8:64184a968e3b

Parent:

5:78943b3945b5

Child:

21:6431364fc667

--- a/GSwifiInterface.h	Wed Jan 30 05:52:14 2013 +0000
+++ b/GSwifiInterface.h	Thu Oct 31 06:41:45 2013 +0000
@@ -1,4 +1,5 @@
 /* GSwifiInterface.h */
+/* EthernetInterface.h */
 /* Copyright (C) 2012 mbed.org, MIT License
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
@@ -20,8 +21,8 @@
  *  port to the GainSpan Wi-FI module GS1011
  */
  
-#ifndef GSwifiINTERFACE_H_
-#define GSwifiINTERFACE_H_
+#ifndef GSWIFIINTERFACE_H_
+#define GSWIFIINTERFACE_H_
 
 #include "GSwifi.h"
 
@@ -38,18 +39,17 @@
     * \param rx mbed pin to use for rx line of Serial interface
     * \param cts mbed pin to use for cts line of Serial interface
     * \param rts mbed pin to use for rts line of Serial interface
-    * \param reset reset pin of the wifi module ()
-    * \param ssid ssid of the network
-    * \param phrase WEP or WPA key
-    * \param sec Security type (NONE, WEP_128 or WPA)
+    * \param reset reset pin of the wifi module
+    * \param alarm alarm pin of the wifi module (default: NC)
+    * \param baud baud rate of Serial interface (default: 9600)
     */
-  GSwifiInterface(PinName tx, PinName rx, PinName cts, PinName rts, PinName reset, const char * ssid, const char * phrase, Security sec = SEC_NONE);
+  GSwifiInterface(PinName tx, PinName rx, PinName cts, PinName rts, PinName reset, PinName alarm = NC, int baud = 9600);
 
   /** Initialize the interface with DHCP.
   * Initialize the interface and configure it to use DHCP (no connection at this point).
   * \return 0 on success, a negative number on failure
   */
-  int init(); //With DHCP
+  int init(const char* name = NULL); //With DHCP
 
   /** Initialize the interface with a static IP address.
   * Initialize the interface and configure it with the following static configuration (no connection at this point).
@@ -58,13 +58,17 @@
   * \param gateway the gateway to use
   * \return 0 on success, a negative number on failure
   */
-  int init(const char* ip, const char* mask, const char* gateway);
+  int init(const char* ip, const char* mask, const char* gateway, const char* name = NULL);
 
   /** Connect
   * Bring the interface up, start DHCP if needed.
+  * \param sec the Wi-Fi security type
+  * \param ssid the Wi-Fi SSID
+  * \param phrase the Wi-Fi passphrase or security key
+  * \param mode the Wi-Fi mode
   * \return 0 on success, a negative number on failure
   */
-  int connect();
+  int connect(Security sec, const char* ssid, const char* phrase, WiFiMode mode = WM_INFRASTRUCTURE);
   
   /** Disconnect
   * Bring the interface down
@@ -72,19 +76,32 @@
   */
   int disconnect();
   
-  /** Get IP address
-  *
-  * @ returns ip address
-  */
+  /** Get the MAC address of your Ethernet interface
+   * \return a pointer to a string containing the MAC address
+   */
+  char* getMACAddress();
+  
+  /** Get the IP address of your Ethernet interface
+   * \return a pointer to a string containing the IP address
+   */
   char* getIPAddress();
-  
-private:
-    char _ip_string[20];
-    bool _ip_set;
+
+  /** Get the Gateway address of your Ethernet interface
+   * \return a pointer to a string containing the Gateway address
+   */
+  char* getGateway();
+ 
+  /** Get the Network mask of your Ethernet interface
+   * \return a pointer to a string containing the Network mask
+   */
+  char* getNetworkMask();
+
 };
 
 #include "TCPSocketConnection.h"
 #include "TCPSocketServer.h"
+
+#include "Endpoint.h"
 #include "UDPSocket.h"
 
-#endif /* WIFLYINTERFACE_H_ */
+#endif /* GSWIFIINTERFACE_H_ */