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
}
Committer:
WiredHome
Date:
Thu Nov 28 18:17:00 2013 +0000
Revision:
51:a4831b1cb9a4
Parent:
45:21b7bbaad62b
Child:
63:fee0b25f1bf5
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)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WiredHome 51:a4831b1cb9a4 1 #include "WiflyInterface.h"
WiredHome 51:a4831b1cb9a4 2
WiredHome 51:a4831b1cb9a4 3 WiflyInterface::WiflyInterface( PinName tx, PinName rx, PinName reset, PinName tcp_status,
WiredHome 51:a4831b1cb9a4 4 const char * ssid, const char * phrase, Security sec) :
WiredHome 51:a4831b1cb9a4 5 Wifly(tx, rx, reset, tcp_status, ssid, phrase, sec)
WiredHome 51:a4831b1cb9a4 6 {
WiredHome 51:a4831b1cb9a4 7 ip_set = false;
WiredHome 51:a4831b1cb9a4 8 }
WiredHome 51:a4831b1cb9a4 9
WiredHome 51:a4831b1cb9a4 10 int WiflyInterface::init()
WiredHome 51:a4831b1cb9a4 11 {
WiredHome 51:a4831b1cb9a4 12 state.dhcp = true;
WiredHome 51:a4831b1cb9a4 13 reset();
WiredHome 51:a4831b1cb9a4 14 return 0;
WiredHome 51:a4831b1cb9a4 15 }
WiredHome 51:a4831b1cb9a4 16
WiredHome 51:a4831b1cb9a4 17 int WiflyInterface::init(const char* ip, const char* mask, const char* gateway)
WiredHome 51:a4831b1cb9a4 18 {
WiredHome 51:a4831b1cb9a4 19 state.dhcp = false;
WiredHome 51:a4831b1cb9a4 20 this->ip = ip;
WiredHome 51:a4831b1cb9a4 21 strcpy(ip_string, ip);
WiredHome 51:a4831b1cb9a4 22 ip_set = true;
WiredHome 51:a4831b1cb9a4 23 this->netmask = mask;
WiredHome 51:a4831b1cb9a4 24 this->gateway = gateway;
WiredHome 51:a4831b1cb9a4 25 reset();
WiredHome 51:a4831b1cb9a4 26
WiredHome 51:a4831b1cb9a4 27 return 0;
WiredHome 51:a4831b1cb9a4 28 }
WiredHome 51:a4831b1cb9a4 29
WiredHome 51:a4831b1cb9a4 30 void WiflyInterface::setSecurity(const char * ssid, const char * phrase, Security sec)
WiredHome 51:a4831b1cb9a4 31 {
WiredHome 51:a4831b1cb9a4 32 Wifly::SetSecurity(ssid, phrase, sec);
WiredHome 45:21b7bbaad62b 33 }
WiredHome 51:a4831b1cb9a4 34
WiredHome 51:a4831b1cb9a4 35 int WiflyInterface::connect()
WiredHome 51:a4831b1cb9a4 36 {
WiredHome 51:a4831b1cb9a4 37 return join();
WiredHome 51:a4831b1cb9a4 38 }
WiredHome 51:a4831b1cb9a4 39
WiredHome 51:a4831b1cb9a4 40 int WiflyInterface::disconnect()
WiredHome 51:a4831b1cb9a4 41 {
WiredHome 51:a4831b1cb9a4 42 return Wifly::disconnect();
WiredHome 51:a4831b1cb9a4 43 }
WiredHome 51:a4831b1cb9a4 44
WiredHome 51:a4831b1cb9a4 45 // typical response might be
WiredHome 51:a4831b1cb9a4 46 // \r192.168.43.107\r
WiredHome 51:a4831b1cb9a4 47 // <4.40>
WiredHome 51:a4831b1cb9a4 48 char * WiflyInterface::getIPAddress()
WiredHome 51:a4831b1cb9a4 49 {
WiredHome 51:a4831b1cb9a4 50 char * match = ip_string;
WiredHome 51:a4831b1cb9a4 51 if (!ip_set) {
WiredHome 51:a4831b1cb9a4 52 if (!sendCommand("get ip a\r", NULL, ip_string))
WiredHome 51:a4831b1cb9a4 53 return NULL;
WiredHome 51:a4831b1cb9a4 54 exit();
WiredHome 51:a4831b1cb9a4 55 flush();
WiredHome 51:a4831b1cb9a4 56 // revised to find the IP string, following a small
WiredHome 51:a4831b1cb9a4 57 // change where \r are permitted in the captured
WiredHome 51:a4831b1cb9a4 58 // reply to a command.
WiredHome 51:a4831b1cb9a4 59 while (*match && (*match < '0' || *match > '9'))
WiredHome 51:a4831b1cb9a4 60 match++;
WiredHome 51:a4831b1cb9a4 61 if (*match)
WiredHome 51:a4831b1cb9a4 62 memcpy(ip_string, match, strlen(match));
WiredHome 51:a4831b1cb9a4 63 match = ip_string;
WiredHome 51:a4831b1cb9a4 64 while (strchr("0123456789.", *match))
WiredHome 51:a4831b1cb9a4 65 match++;
WiredHome 51:a4831b1cb9a4 66 *match = '\0';
WiredHome 51:a4831b1cb9a4 67 ip_set = true;
WiredHome 51:a4831b1cb9a4 68 }
WiredHome 51:a4831b1cb9a4 69 return ip_string;
WiredHome 51:a4831b1cb9a4 70 }