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 Wifly/Wifly.cpp

Revision Date Message Actions
73:59d0bbc4f905 2015-12-19 Updated to align with EthernetInterface - added setName and get_connection_speed.; Updated the SWUpdate for the Wifly module, then tested to ensure it is working. File  Diff  Annotate
71:59936f711b80 2014-09-25 Changes to more closely match the EthernetInterface APIs for improve interchangeability.; Increased the timeout in the FlushIn call after sending a command - this helps it clean up the response from a slow command. File  Diff  Annotate
70:83e420b0d3e1 2015-12-14 Minor refactoring to eliminate wasted operations, and adapt to firmware v4.75 File  Diff  Annotate
69:a4064f7e3529 2014-05-02 Revised the ssid and passcode to be simple char arrays, simplifying the storage and management, but also meeting the required size. File  Diff  Annotate
67:557ea7ad15c1 2014-04-19 Revise the Wifly interface so that recovery from a lost connection is possible. See the "in_connected()" method for an example. File  Diff  Annotate
66:e52bd50e6d9f 2014-04-18 remove a debug printf. File  Diff  Annotate
64:6202428f37ec 2014-04-18 Updated the is_connected method to query the Wifly module. Actually returning "is associated" instead of "is connected". File  Diff  Annotate
62:f1484c792c0e 2014-04-18 SetSecurity() api needs to first reset the state object. File  Diff  Annotate
61:288691545d03 2014-03-09 Turn off debug as the default. File  Diff  Annotate
60:03f1a99663e2 2014-03-08 Corrected build failure when debug was enabled - it was still referencing the removed c++ string. File  Diff  Annotate
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
56:eba4aabaad3e 2014-01-03 Minor comment change related to INCREASE_SECURITY SW version required.; Added a small guard on the Wifly module logonText extraction - have not seen a need for this however it is good safeguarding. File  Diff  Annotate
55:0729959263b7 2014-01-03 Updated documentation.; Remove unnecessary delay.; Minor code refactoring to improve maintenance. File  Diff  Annotate
53:3dd2e7f9edc0 2013-12-30 Added a small guard on cmdMode in sendCommand. File  Diff  Annotate
52:ffc0b655a23c 2013-12-30 Cleanup for compiler warning reduction. File  Diff  Annotate
51:a4831b1cb9a4 2013-11-28 Documentation updates - put all files into a more similar format for the doxygen tags.; Reduce some of the verbose debugging information.; Small amount of code size reduction (reduced some redundancy) File  Diff  Annotate
50:cc173c24a316 2013-10-12 Diagnostic changes only while trying to optimize performance. File  Diff  Annotate
48:b9e1152f39e3 2013-10-11 Small change to the debug print to better line up with other files. File  Diff  Annotate
47:97303e1970c1 2013-10-10 Fixed a defect in FixPhrase that was freeing memory that wasn't allocated. File  Diff  Annotate
46:4722f7d72aab 2013-10-10 Security enhancements File  Diff  Annotate
45:21b7bbaad62b 2013-10-10 Diagnostic improvements File  Diff  Annotate
43:df984bf61580 2013-10-10 Dead code removal File  Diff  Annotate
42:2a6fa071aecc 2013-10-10 Enhanced debugging, but fails in SendResponse(...) File  Diff  Annotate
41:698be43f9233 2013-10-10 Starting to add file upload capability. File  Diff  Annotate
38:30e142b93ce4 2013-10-09 Minor documentation changes 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
35:2dc12224cbd6 2013-09-06 Modified a version extraction to handle both v2.36 and v4.00 (it was looking for a case sensitive match of wifly before it parsed Ver X.YY).; WiFly Ver 2.36, 09-27-2012 on RN-171; wifly-EZX Ver 4.00.1, Apr 19 2013 11:47:16 on RN-171 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
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
31:e4422f192d25 2013-08-12 Added other security options back in. File  Diff  Annotate
30:f500260463b7 2013-08-05 Add extra access point security methods supported by the Wifly module File  Diff  Annotate
29:49876a8c445b 2013-08-04 Changes focused on connection reliability. A number of small changes to debug macros, while discovering that something kicks wifly out of command mode. So, the cmdMode() API forces a check. This seems to be a huge improvement. 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
27:8509ec4a0a0a 2013-07-22 Change the flush size to 1420 and minor documentation tweaks nearby. File  Diff  Annotate
26:78a1a09afdc9 2013-07-22 Modify the reboot method so it gets back in sync more easily. File  Diff  Annotate
25:a740eb74a86a 2013-07-22 Improve security, and small formatting changes for more consistency. File  Diff  Annotate
24:5012a535b1d5 2013-07-21 Refactored the ssid and passphrase handler to eliminate redundant code. File  Diff  Annotate
23:6e77c65ced00 2013-07-21 Minor refactor on send() to share the timeout for both purposes.; Minor refactor on sendCommand to retry on failure. File  Diff  Annotate
22:62267088e95a 2013-07-21 Improved the DEBUG behavior - printouts, extra \r\n, etc. File  Diff  Annotate
21:97294686b4a1 2013-07-21 Add baud rate setting File  Diff  Annotate
20:906b0f951bc3 2013-07-21 Add baud rate setting File  Diff  Annotate
19:b0c2488222a3 2013-07-21 Efficiency - send() had 3 timers, a passed in timer which worked only when no ACK was expected, and two hard-coded timers for when the caller wanted the return ACK. Eliminated the hard-coded timers. File  Diff  Annotate
18:18ab3993d00d 2013-07-21 Efficiency - add flushIn() and eliminate several inline equivalent changes.; Efficiency - largest effect was on the send() method. File  Diff  Annotate
17:213844a1864f 2013-07-21 Fixed serious error - if sendCommand() failed, it would then try to exit(), which called sendCommand() - high probability of recursion to exhaustion. File  Diff  Annotate
13:7197313973a4 2013-07-04 Remove idle timeout.; Remove unnecessary code.; Minor comment changes. 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
11:44563217d2b9 2013-06-30 Rearranged functions to compare more easily File  Diff  Annotate
10:a594fe035b36 2013-06-27 Refactoring a number of things, constructor, reset, acquisition of version information. File  Diff  Annotate
9:86105ba18d96 2013-06-25 Reduction in memory allocated requirement 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
6:9b25f2bc3b03 2013-06-02 Removed some unnecessary delays 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
2:8e54830d0df7 2012-11-24 set dns server name (now able to use "open host port") File  Diff  Annotate
1:fb4494783863 2012-08-24 first commit File  Diff  Annotate