MODIFIED from mbed official WiflyInterface (interface for Roving Networks Wifly modules). Numerous performance and reliability improvements (see the detailed documentation). Also, tracking changes in mbed official version to retain functional parity.

Dependents:   Smart-WiFly-WebServer PUB_WiflyInterface_Demo

Fork of WiflyInterface by mbed official

Resources

Derivative from mbed Official

  • Documentation update, improved consistency, documented parameters that were inadvertently omitted.
  • Avoid c++ string handling, which causes dynamic allocation and free, side effect, fewer CPU cycles spent for same purpose.
  • Fixed socket APIs to support non-blocking mode.
  • Increase communication baud-rate to Wifly module
  • sendCommand - added retries for improved robustness.
  • setConnectionState - method to force the connection state (used by TCPSocketServer)
  • gethostbyname - added a length parameter to the size of the buffer being written
  • flushIn - a private method to flush the input buffer
  • Changed the timeout from 500 to 2500 msec for commands - measured some at 700 to 850 msec.
  • Performance improvements - reduced some unnecessary delays.
  • Added additional security options for the wi-fi connection (that are supported by the WiFly module).
  • Added setSecurity API which permits revising the security when connecting to, or selecting from, one of several access points.
  • Improved DEBUG interface (slightly more consistent printout).
  • gathers information from the Wifly module on reboot (SW version info), which permits customizing behavior based on Wifly capabilities (like the improved security).
  • Avoid potential for recursive crash (if exit fails, it calls sendcommand, which calls exit...)
  • Update to support permissible SSID and PassCode lengths.

Robustness testing

I've had some mixed behavior with the Wifly module, some of which seems to be traceable to the module itself, and some in my derivative code. The result, after running for minutes, hours, sometimes days, it hangs and I have to reset the module.

To test, I created a fairly simple test program -

  • check for Watchdog induced reset and count it.
  • initialize the Watchdog for 60 sec timeout.
  • Init the Wifly interface and connect to my network.
  • Wait 10 seconds and force mbed_reset().

If the Watchdog induces the restart, then it is pretty clear that either:

  • The communications hung with the Wifly module causing the failure.
  • The Wifly module decided to go unresponsive.

If it gets to the end, it typically takes about 4 to 6 seconds for the boot and connect, then the 10 second delay.

But I can't really pin down the root cause easily. My strongest theory is that the Wifly module has rebooted, and since I don't store the high baud rate I configure it for, it resets back to 9600.

Also, one of the objectives for my revised send( ) is to avoid the c++ string, as that can fragment memory, and it wasn't very well bounded in behavior.

Latest tests:

Warm BootsWatchdog EventsNotes
100's30An early version of my derivative WiflyInterface, including my derivative of "send( )" API. Let's call this version 0.1.
26684My derivative WiflyInterface, but with the mbed official "send( )" API. Much improved. This was over the course of about 12 hours.
24003Most recent derivative - incremental change to "send( )", but this relative number does not rule out the Wifly module itself.

I think with these numbers, +/- 1 means that the changes have had no measurable effect. Which is good, since this incremental change eliminates the c++ string handling.

Test Software

This is pieces of a test program, clipped and copied to here. What I have compiled and run for hours and hours is almost exactly what you see. This uses this simple Watchdog library.

#include "mbed.h"
#include "WiflyInterface.h"
#include "Watchdog.h"

Serial pc(USBTX, USBRX);

Watchdog wd;
extern "C" void mbed_reset();

// Pinout for SmartBoard
WiflyInterface wifly(p9, p10, p30, p29, "ssid", "pass", WPA);

int main() {
    pc.baud(460800);                         // I like a snappy terminal
    
    wd.Configure(60.0);                     // Set time limit for the test to 1 minute
    LPC_RTC->GPREG0++;                      // Count boots here
    if (wd.WatchdogCausedReset()) {
        LPC_RTC->GPREG1++;                  // Count Watchdog events here
        pc.printf("\r\n\r\nWatchdog event.\r\n");
    }
    pc.printf("\r\nWifly Test: %d boots, %d watchdogs. %s %s\r\n", LPC_RTC->GPREG0, LPC_RTC->GPREG1, __DATE__, __TIME__);
    
    wifly.init(); // use DHCP
    pc.printf("Connect...  ");
    while (!wifly.connect());               // join the network
    pc.printf("Address is %s.  ", wifly.getIPAddress());
    pc.printf("Disconnect...  ");
    wifly.disconnect();
    pc.printf("OK. Reset in 10 sec...\r\n");
    wait(10);
    if (pc.readable()) {
        if (pc.getc() == 'r') {             // secret 'r'eset of the counters
            LPC_RTC->GPREG0 = 0;
            LPC_RTC->GPREG1 = 0;
            pc.printf("counters reset\r\n");
        }
    }
    mbed_reset();                           // reset here indicates successful communication
}

Files at this revision

API Documentation at this revision

Comitter:
WiredHome
Date:
Mon Dec 03 02:06:24 2018 +0000
Parent:
77:41f9c7987e0a
Commit message:
Renamed the WiflyInterface header and class name to EthernetInterface to be more readily swapped with the wired version. The TimeInterface then works directly.

Changed in this revision

EthernetInterface.cpp Show annotated file Show diff for this revision Revisions of this file
EthernetInterface.h Show annotated file Show diff for this revision Revisions of this file
WiflyInterface.cpp Show diff for this revision Revisions of this file
WiflyInterface.h Show diff for this revision Revisions of this file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/EthernetInterface.cpp	Mon Dec 03 02:06:24 2018 +0000
@@ -0,0 +1,188 @@
+#include "EthernetInterface.h"
+
+
+//#define DEBUG "WFLY"      //Debug is disabled by default
+
+// How to use this debug macro
+//
+// ...
+// INFO("Stuff to show %d", var); // new-line is automatically appended
+// [I myfile  23] Stuff to show 23\r\n
+//
+#if (defined(DEBUG) && !defined(TARGET_LPC11U24))
+#define INFO(x, ...) std::printf("[INF %s %3d] "x"\r\n", DEBUG, __LINE__, ##__VA_ARGS__);
+#define WARN(x, ...) std::printf("[WRN %s %3d] "x"\r\n", DEBUG, __LINE__, ##__VA_ARGS__);
+#define ERR(x, ...)  std::printf("[ERR %s %3d] "x"\r\n", DEBUG, __LINE__, ##__VA_ARGS__);
+#else
+#define INFO(x, ...)
+#define WARN(x, ...)
+#define ERR(x, ...)
+#endif
+
+static char myName[33];    // name cannot exceed 32 chars
+
+EthernetInterface::EthernetInterface( PinName tx, PinName rx, PinName reset, PinName tcp_status,
+                                const char * ssid, const char * phrase, Security sec) :
+    Wifly(tx, rx, reset, tcp_status, ssid, phrase, sec)
+{
+    ip_set = false;
+    mac_set = false;
+    myName[0] = '\0';
+}
+
+int EthernetInterface::init()
+{
+    state.dhcp = true;
+    ip_set = false;
+    reset();
+    configure();
+    return 0;
+}
+
+int EthernetInterface::init(const char* ip, const char* mask, const char* gateway)
+{
+    state.dhcp = false;
+    this->ip = ip;
+    strcpy(ip_string, ip);
+    ip_set = true;
+    this->netmask = mask;
+    this->gateway = gateway;
+    reset();
+    configure();
+    return 0;
+}
+
+void EthernetInterface::setSecurity(const char * ssid, const char * phrase, Security sec)
+{
+    Wifly::SetSecurity(ssid, phrase, sec);
+}
+
+int EthernetInterface::connect()
+{
+    return (join()) ? 0 : -1;
+}
+
+int EthernetInterface::disconnect()
+{
+    ip_set = false;
+    return Wifly::disconnect();
+}
+
+// command   "get mac\r"
+// response  "MAC Addr=##:##:##:##:##:##\n<4.40> "
+char * EthernetInterface::getMACAddress()
+{
+    char buffer[50];
+    char * match = buffer;
+    char * p;
+    if (!mac_set) {
+        mac_string[0] = '\0';
+        if (!sendCommand("get mac\r", NULL, buffer))
+            return NULL;
+        exit();
+        flush();
+        INFO("buffer is '%s'", buffer);
+        // revised to find the mac address string, following a small
+        // change where \r are permitted in the captured
+        // reply to a command.
+        while (*match && (*match != '='))
+            match++;
+        if (*match) {
+            match++;    // Advance past '='
+            p = match;
+            while (strchr("0123456789abcdefABCDEF:", *p))
+                p++;
+            *p = '\0';
+            if (strlen(match) <= 17) {  // 192.168.101.202
+                strcpy(mac_string, match);
+                mac_set = true;
+            }
+        }
+    }
+    return mac_string;
+}
+
+// typical response might be
+// \r192.168.43.107\r
+// <4.40>
+char * EthernetInterface::getIPAddress()
+{
+    char buffer[50];
+    char * match = buffer;
+    char * p;
+    if (!ip_set) {
+        if (!sendCommand("get ip a\r", NULL, buffer))
+            return NULL;
+        exit();
+        flush();
+        // revised to find the IP string, following a small
+        // change where \r are permitted in the captured
+        // reply to a command.
+        while (*match && (*match < '0' || *match > '9'))
+            match++;
+        p = match;
+        while (strchr("0123456789.", *p))
+            p++;
+        *p = '\0';
+        if (strlen(match) <= 15) {  // 192.168.101.202
+            strcpy(ip_string, match);
+            ip_set = true;
+        }
+    }
+    return ip_string;
+}
+
+static bool inRange(char testChar, char minChar, char maxChar)
+{
+    if (testChar >= minChar && testChar <= maxChar) 
+        return true;
+    else
+        return false;
+}
+
+int EthernetInterface::setName(const char * myname)
+{
+    char buffer[60];    // hold the whole command
+    int i;
+    
+    strncpy(myName, myname, 32);
+    myName[32] = '\0';  // be sure it is NULL terminated.
+    // make the name 'safe'
+    for (i=0; i<32 && myName[i]; i++) {
+        if (!inRange(myName[i], '0', '9')
+        &&  !inRange(myName[i], 'A', 'Z')
+        &&  !inRange(myName[i], 'a', 'z'))
+            myName[i] = '-';
+    }
+    sprintf(buffer, "set opt deviceid %s\r", myname);
+    if (!sendCommand(buffer, "OK"))
+        return -1;  // fail
+    return 0;       // indicate success...
+}
+
+const char * EthernetInterface::getName(void)
+{
+    return myName;
+}
+
+int EthernetInterface::get_connection_speed(void)
+{
+    char bigbuf[200];   // big enough?
+    int res = 0;
+    
+    if (sendCommand("get wlan\r", NULL, bigbuf)) {
+        // "Rate=15, 54 Mb\r"
+        char * p = strstr(bigbuf, "Rate=");
+        
+        if (p) {
+            p += 5; // strlen("Rate=");
+            while (*p && *p != ' ')
+                p++;
+            while (*p && *p == ' ')
+                p++;
+            res = atoi(p);
+            
+        }
+    }
+    return res;
+}
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/EthernetInterface.h	Mon Dec 03 02:06:24 2018 +0000
@@ -0,0 +1,172 @@
+/* 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
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * Changes relative to mbed official version and others as identified
+ * in the thread http://mbed.org/forum/team-165-components-community/topic/4844/?page=1#comment-24108
+ * EthernetInterface:
+ * @li Improve documentation
+ * @li add setSecurity() api
+ * @li correct connect() api return value (it was inverted)
+ * @li derived from 4:0bcec6272784
+ */
+
+#ifndef EthernetInterface_H_
+#define EthernetInterface_H_
+
+#include "Wifly.h"
+
+/** Interface using Wifly to connect to an IP-based network
+*
+*/
+class EthernetInterface: public Wifly
+{
+public:
+
+    /**
+    * Construct the WiFlyInterface.
+    *
+    * API Precedence:
+    * @verbatim
+    * EthernetInterface() -->
+    *            +------------------+              +---------------------------+
+    *            v                  ^              v                           ^
+    * -> init() -+----------------->+-> connect() -+-------------------------->+-> disconnect() --|
+    *            |                  ^              +-> getName() --------------+
+    *            +-> setName() -----+              +-> getIPAddress() ---------+
+    *            |                  |              +-> getMACAddress() --------+
+    *            +-> setSecurity() -+              +-> Wifly APIs -------------+
+    *                                              +-> get_connection_speed() -+
+    * @endverbatim
+    *
+    * @note The optional ssid, phrase, and sec parameters may be deferred, or
+    *       overridden prior to the connect().
+    *
+    * @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 optional parameter which is the ssid of the network
+    * @param phrase optional parameter which is the WEP or WPA key/phrase
+    * @param sec optional security type (NONE[default], WEP_128 or WPA)
+    */
+    EthernetInterface(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid = NULL, const char * phrase = NULL, Security sec = NONE);
+
+    /** 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
+
+    /** Initialize the interface with a static IP address.
+    *
+    * Initialize the interface and configure it with the following static
+    * configuration (no connection at this point).
+    *
+    * @param ip the IP address to use
+    * @param mask the IP address mask
+    * @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);
+
+    /** Set security parameters for the interface.
+    *
+    * Prior to connect, this interface permits changing the security parameters. This
+    * can be most useful when the Wifly module may be used where there are multiple access
+    * points to be connected to. With this, the interface can be brought online far
+    * enough to scan for available access points.
+    *
+    * @param ssid optional parameter which is the ssid of the network
+    * @param phrase optional parameter which is the WEP or WPA key/phrase
+    * @param sec optional security type (NONE[default], WEP_128 or WPA)
+    */
+    void setSecurity(const char * ssid = NULL, const char * phrase = NULL, Security sec = NONE);
+
+    /** Connect
+    * Bring the interface up, start DHCP if needed.
+    * @return 0 on success, a negative number on failure
+    */
+    int connect();
+
+    /** Disconnect
+    * Bring the interface down
+    * @return 0 on success, a negative number on failure
+    */
+    int disconnect();
+
+    /** Get the MAC address of your Ethernet interface.
+    *
+    * @return a pointer to a string containing the MAC address
+    */
+    char * getMACAddress();
+  
+    /** Get IP address
+    *
+    * @return a pointer to a string containing the IP address
+    */
+    char * getIPAddress();
+
+    /** setName 
+    *
+    * Set the network name for this device. Apply this before
+    * calling 'connect'.
+    *
+    * @example
+    * EthernetInterface eth;
+    * ...
+    *     if (0 == eth.init()) {
+    *         eth.setName("Sensor 3");
+    *         if (0 == eth.connect()) {
+    *             ...
+    *
+    * @param myname is the name to assign for this node. 
+    *        Only the first 32 characters will be used if the 
+    *        name is longer.
+    *        Only '0'-'9', 'A'-'Z', 'a'-'z' are accepted,
+    *        any others are converted to '-'.
+    * @return 0 on success, a negative number on failure.
+    */
+    int setName(const char * myname);
+    
+    /** getName
+    *
+    * Get the network name for this device.
+    *
+    * @return pointer to the name (or null)
+    */
+    const char * getName(void);
+
+    /** get the speed of the connection.
+    *
+    * @return the connection speed, which can range from 1 to 54 (Mb/s)
+    * @return 0 if the information could not be acquired.
+    */
+    int get_connection_speed(void);
+
+private:
+    char ip_string[16];     // "129.168.100.123\0"
+    bool ip_set;            // true when we have captured the IP address
+    char mac_string[18];    // "11:22:33:44:55:66\0"
+    bool mac_set;           // true when we have captured the MAC address
+};
+
+#include "TCPSocketConnection.h"
+#include "TCPSocketServer.h"
+#include "UDPSocket.h"
+
+#endif /* EthernetInterface_H_ */
--- a/WiflyInterface.cpp	Wed Apr 11 00:21:02 2018 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,188 +0,0 @@
-#include "WiflyInterface.h"
-
-
-//#define DEBUG "WFLY"      //Debug is disabled by default
-
-// How to use this debug macro
-//
-// ...
-// INFO("Stuff to show %d", var); // new-line is automatically appended
-// [I myfile  23] Stuff to show 23\r\n
-//
-#if (defined(DEBUG) && !defined(TARGET_LPC11U24))
-#define INFO(x, ...) std::printf("[INF %s %3d] "x"\r\n", DEBUG, __LINE__, ##__VA_ARGS__);
-#define WARN(x, ...) std::printf("[WRN %s %3d] "x"\r\n", DEBUG, __LINE__, ##__VA_ARGS__);
-#define ERR(x, ...)  std::printf("[ERR %s %3d] "x"\r\n", DEBUG, __LINE__, ##__VA_ARGS__);
-#else
-#define INFO(x, ...)
-#define WARN(x, ...)
-#define ERR(x, ...)
-#endif
-
-static char myName[33];    // name cannot exceed 32 chars
-
-WiflyInterface::WiflyInterface( PinName tx, PinName rx, PinName reset, PinName tcp_status,
-                                const char * ssid, const char * phrase, Security sec) :
-    Wifly(tx, rx, reset, tcp_status, ssid, phrase, sec)
-{
-    ip_set = false;
-    mac_set = false;
-    myName[0] = '\0';
-}
-
-int WiflyInterface::init()
-{
-    state.dhcp = true;
-    ip_set = false;
-    reset();
-    configure();
-    return 0;
-}
-
-int WiflyInterface::init(const char* ip, const char* mask, const char* gateway)
-{
-    state.dhcp = false;
-    this->ip = ip;
-    strcpy(ip_string, ip);
-    ip_set = true;
-    this->netmask = mask;
-    this->gateway = gateway;
-    reset();
-    configure();
-    return 0;
-}
-
-void WiflyInterface::setSecurity(const char * ssid, const char * phrase, Security sec)
-{
-    Wifly::SetSecurity(ssid, phrase, sec);
-}
-
-int WiflyInterface::connect()
-{
-    return (join()) ? 0 : -1;
-}
-
-int WiflyInterface::disconnect()
-{
-    ip_set = false;
-    return Wifly::disconnect();
-}
-
-// command   "get mac\r"
-// response  "MAC Addr=##:##:##:##:##:##\n<4.40> "
-char * WiflyInterface::getMACAddress()
-{
-    char buffer[50];
-    char * match = buffer;
-    char * p;
-    if (!mac_set) {
-        mac_string[0] = '\0';
-        if (!sendCommand("get mac\r", NULL, buffer))
-            return NULL;
-        exit();
-        flush();
-        INFO("buffer is '%s'", buffer);
-        // revised to find the mac address string, following a small
-        // change where \r are permitted in the captured
-        // reply to a command.
-        while (*match && (*match != '='))
-            match++;
-        if (*match) {
-            match++;    // Advance past '='
-            p = match;
-            while (strchr("0123456789abcdefABCDEF:", *p))
-                p++;
-            *p = '\0';
-            if (strlen(match) <= 17) {  // 192.168.101.202
-                strcpy(mac_string, match);
-                mac_set = true;
-            }
-        }
-    }
-    return mac_string;
-}
-
-// typical response might be
-// \r192.168.43.107\r
-// <4.40>
-char * WiflyInterface::getIPAddress()
-{
-    char buffer[50];
-    char * match = buffer;
-    char * p;
-    if (!ip_set) {
-        if (!sendCommand("get ip a\r", NULL, buffer))
-            return NULL;
-        exit();
-        flush();
-        // revised to find the IP string, following a small
-        // change where \r are permitted in the captured
-        // reply to a command.
-        while (*match && (*match < '0' || *match > '9'))
-            match++;
-        p = match;
-        while (strchr("0123456789.", *p))
-            p++;
-        *p = '\0';
-        if (strlen(match) <= 15) {  // 192.168.101.202
-            strcpy(ip_string, match);
-            ip_set = true;
-        }
-    }
-    return ip_string;
-}
-
-static bool inRange(char testChar, char minChar, char maxChar)
-{
-    if (testChar >= minChar && testChar <= maxChar) 
-        return true;
-    else
-        return false;
-}
-
-int WiflyInterface::setName(const char * myname)
-{
-    char buffer[60];    // hold the whole command
-    int i;
-    
-    strncpy(myName, myname, 32);
-    myName[32] = '\0';  // be sure it is NULL terminated.
-    // make the name 'safe'
-    for (i=0; i<32 && myName[i]; i++) {
-        if (!inRange(myName[i], '0', '9')
-        &&  !inRange(myName[i], 'A', 'Z')
-        &&  !inRange(myName[i], 'a', 'z'))
-            myName[i] = '-';
-    }
-    sprintf(buffer, "set opt deviceid %s\r", myname);
-    if (!sendCommand(buffer, "OK"))
-        return -1;  // fail
-    return 0;       // indicate success...
-}
-
-const char * WiflyInterface::getName(void)
-{
-    return myName;
-}
-
-int WiflyInterface::get_connection_speed(void)
-{
-    char bigbuf[200];   // big enough?
-    int res = 0;
-    
-    if (sendCommand("get wlan\r", NULL, bigbuf)) {
-        // "Rate=15, 54 Mb\r"
-        char * p = strstr(bigbuf, "Rate=");
-        
-        if (p) {
-            p += 5; // strlen("Rate=");
-            while (*p && *p != ' ')
-                p++;
-            while (*p && *p == ' ')
-                p++;
-            res = atoi(p);
-            
-        }
-    }
-    return res;
-}
\ No newline at end of file
--- a/WiflyInterface.h	Wed Apr 11 00:21:02 2018 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,172 +0,0 @@
-/* WiflyInterface.h */
-/* Copyright (C) 2012 mbed.org, MIT License
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
- * and associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute,
- * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or
- * substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
- * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
- * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * Changes relative to mbed official version and others as identified
- * in the thread http://mbed.org/forum/team-165-components-community/topic/4844/?page=1#comment-24108
- * WiflyInterface:
- * @li Improve documentation
- * @li add setSecurity() api
- * @li correct connect() api return value (it was inverted)
- * @li derived from 4:0bcec6272784
- */
-
-#ifndef WIFLYINTERFACE_H_
-#define WIFLYINTERFACE_H_
-
-#include "Wifly.h"
-
-/** Interface using Wifly to connect to an IP-based network
-*
-*/
-class WiflyInterface: public Wifly
-{
-public:
-
-    /**
-    * Construct the WiFlyInterface.
-    *
-    * API Precedence:
-    * @verbatim
-    * WiflyInterface() -->
-    *            +------------------+              +---------------------------+
-    *            v                  ^              v                           ^
-    * -> init() -+----------------->+-> connect() -+-------------------------->+-> disconnect() --|
-    *            |                  ^              +-> getName() --------------+
-    *            +-> setName() -----+              +-> getIPAddress() ---------+
-    *            |                  |              +-> getMACAddress() --------+
-    *            +-> setSecurity() -+              +-> Wifly APIs -------------+
-    *                                              +-> get_connection_speed() -+
-    * @endverbatim
-    *
-    * @note The optional ssid, phrase, and sec parameters may be deferred, or
-    *       overridden prior to the connect().
-    *
-    * @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 optional parameter which is the ssid of the network
-    * @param phrase optional parameter which is the WEP or WPA key/phrase
-    * @param sec optional security type (NONE[default], WEP_128 or WPA)
-    */
-    WiflyInterface(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid = NULL, const char * phrase = NULL, Security sec = NONE);
-
-    /** 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
-
-    /** Initialize the interface with a static IP address.
-    *
-    * Initialize the interface and configure it with the following static
-    * configuration (no connection at this point).
-    *
-    * @param ip the IP address to use
-    * @param mask the IP address mask
-    * @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);
-
-    /** Set security parameters for the interface.
-    *
-    * Prior to connect, this interface permits changing the security parameters. This
-    * can be most useful when the Wifly module may be used where there are multiple access
-    * points to be connected to. With this, the interface can be brought online far
-    * enough to scan for available access points.
-    *
-    * @param ssid optional parameter which is the ssid of the network
-    * @param phrase optional parameter which is the WEP or WPA key/phrase
-    * @param sec optional security type (NONE[default], WEP_128 or WPA)
-    */
-    void setSecurity(const char * ssid = NULL, const char * phrase = NULL, Security sec = NONE);
-
-    /** Connect
-    * Bring the interface up, start DHCP if needed.
-    * @return 0 on success, a negative number on failure
-    */
-    int connect();
-
-    /** Disconnect
-    * Bring the interface down
-    * @return 0 on success, a negative number on failure
-    */
-    int disconnect();
-
-    /** Get the MAC address of your Ethernet interface.
-    *
-    * @return a pointer to a string containing the MAC address
-    */
-    char * getMACAddress();
-  
-    /** Get IP address
-    *
-    * @return a pointer to a string containing the IP address
-    */
-    char * getIPAddress();
-
-    /** setName 
-    *
-    * Set the network name for this device. Apply this before
-    * calling 'connect'.
-    *
-    * @example
-    * EthernetInterface eth;
-    * ...
-    *     if (0 == eth.init()) {
-    *         eth.setName("Sensor 3");
-    *         if (0 == eth.connect()) {
-    *             ...
-    *
-    * @param myname is the name to assign for this node. 
-    *        Only the first 32 characters will be used if the 
-    *        name is longer.
-    *        Only '0'-'9', 'A'-'Z', 'a'-'z' are accepted,
-    *        any others are converted to '-'.
-    * @return 0 on success, a negative number on failure.
-    */
-    int setName(const char * myname);
-    
-    /** getName
-    *
-    * Get the network name for this device.
-    *
-    * @return pointer to the name (or null)
-    */
-    const char * getName(void);
-
-    /** get the speed of the connection.
-    *
-    * @return the connection speed, which can range from 1 to 54 (Mb/s)
-    * @return 0 if the information could not be acquired.
-    */
-    int get_connection_speed(void);
-
-private:
-    char ip_string[16];     // "129.168.100.123\0"
-    bool ip_set;            // true when we have captured the IP address
-    char mac_string[18];    // "11:22:33:44:55:66\0"
-    bool mac_set;           // true when we have captured the MAC address
-};
-
-#include "TCPSocketConnection.h"
-#include "TCPSocketServer.h"
-#include "UDPSocket.h"
-
-#endif /* WIFLYINTERFACE_H_ */