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
}

Revisions of Socket/TCPSocketServer.cpp

Revision Date Message Actions
59:8e15d2ca7bd5 2014-03-06 Revised the send() method for improved reliability. File  Diff  Annotate
58:f49aab8072ec 2014-03-01 Update to support long SSIDs.; Add Wifly module software update API.; Increase time-out to 2500 ms to accommodate Wifly module behavior.; Update documentation.; Clean up dead code.; Revise the debug interface. File  Diff  Annotate
57:5259cf47106a 2014-01-04 Documentation improvement. File  Diff  Annotate
37:84084567c4b9 2013-09-11 Remove dead code in the accept method. File  Diff  Annotate
36:8d868fea6fe6 2013-09-10 Minor modification to the accept() check for *OPEN*, as well as to the wifly send() method to check for the ACK string. This prevents it from potentially getting out of sync. File  Diff  Annotate
34:52e4eec8b790 2013-09-05 Major change is in how to checks for expected response. Prior code used the C++ string method of concatenation, which could continue to allocate memory to exhaustion, even if it was only interested in a few character response. File  Diff  Annotate
33:25958bf80481 2013-09-01 Revise the non-blocking - may override the desired timeout to a minimum of 10 msec because some parts of the socket are not well behaved with zero. File  Diff  Annotate
32:4543e91ab4bf 2013-09-01 Implement the non-blocking option. The API was there to set it, but it was otherwise unused. File  Diff  Annotate
28:b7c1182aed28 2013-07-27 Add a delay on close. While delays are to be avoided, if there is data in the Wifly module still being sent, it appears that closing too soon can interrupt that transmission. Have not identified any synchronous way to determine the transmit is done. File  Diff  Annotate
12:6270ced02019 2013-07-01 Quite a bit of refactoring of the wifly interface. Most of the changes are in the Wifly.cpp file. File  Diff  Annotate
8:79415e982c32 2013-06-25 When a pointer to a buffer is passed in to the APIs that can modify that buffer, good practices will also pass the size of that buffer to avoid buffer overrun. File  Diff  Annotate
7:b3d740f89f27 2013-06-24 Permit TCPSocketConnection to be non-blocking. File  Diff  Annotate
5:cc0506dc3565 2013-05-31 Numerous changes, mostly to Wifly.cpp to fix performance and capabilities. File  Diff  Annotate
4:0bcec6272784 2012-12-20 proper join after reboot - increase size flush File  Diff  Annotate
3:9aa05e19c62e 2012-12-20 add reboot method - reboot module for accept (tcp server) File  Diff  Annotate
1:fb4494783863 2012-08-24 first commit File  Diff  Annotate