Angel David Yaguana Hernandez / WiflyInterface

ACTUALIZED LIBRARY 0 Open (Default) 1 WEP-128 2 WPA1 3 Mixed WPA1 & WPA2-PSK 4 WPA2-PSK 5 Not Used 6 Adhoc, Join any Adhoc network

Dependents:   mbed_Arduino_sensor

Fork of WiflyInterface by Samuel Mokrani

Files at this revision

API Documentation at this revision

Revision 8:9a3cd07ed7e8, committed 2012-08-23

Comitter:
samux
Date:
Thu Aug 23 14:08:08 2012 +0000
Parent:
7:a92dbed32890
Child:
9:aeddb7353e6e
Child:
11:002225507f44
Commit message:
add documentation

Changed in this revision

Wifly/Wifly.h Show annotated file Show diff for this revision Revisions of this file
WiflyInterface.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Wifly/Wifly.h	Thu Aug 23 12:59:19 2012 +0000
+++ b/Wifly/Wifly.h	Thu Aug 23 14:08:08 2012 +0000
@@ -42,7 +42,7 @@
 
 public:
     /*
-    * Constructor for joining open, wep or wpa secured networks
+    * Constructor
     *
     * @param tx mbed pin to use for tx line of Serial interface
     * @param rx mbed pin to use for rx line of Serial interface
@@ -50,7 +50,7 @@
     * @param tcp_status connection status pin of the wifi module (GPIO 6)
     * @param ssid ssid of the network
     * @param phrase WEP or WPA key
-    * @param wpa true if wpa security false otherwise
+    * @param sec Security type (NONE, WEP_128 or WPA)
     */
     Wifly(  PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec);
 

--- a/WiflyInterface.h	Thu Aug 23 12:59:19 2012 +0000
+++ b/WiflyInterface.h	Thu Aug 23 14:08:08 2012 +0000
@@ -28,6 +28,17 @@
 class WiflyInterface: public Wifly {
 public:
 
+    /**
+    * Constructor
+    *
+    * \param tx mbed pin to use for tx line of Serial interface
+    * \param rx mbed pin to use for rx line of Serial interface
+    * \param reset reset pin of the wifi module ()
+    * \param tcp_status connection status pin of the wifi module (GPIO 6)
+    * \param ssid ssid of the network
+    * \param phrase WEP or WPA key
+    * \param sec Security type (NONE, WEP_128 or WPA)
+    */
   WiflyInterface(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec = NONE);
 
   /** Initialize the interface with DHCP.