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:
Sun Jul 21 23:05:51 2013 +0000
Parent:
19:b0c2488222a3
Child:
22:62267088e95a
Commit message:
Add baud rate setting

Changed in this revision

Wifly/Wifly.cpp Show annotated file Show diff for this revision Revisions of this file
Wifly/Wifly.h Show annotated file Show diff for this revision Revisions of this file
--- a/Wifly/Wifly.cpp	Sun Jul 21 21:14:57 2013 +0000
+++ b/Wifly/Wifly.cpp	Sun Jul 21 23:05:51 2013 +0000
@@ -43,7 +43,7 @@
 Wifly * Wifly::inst;
 
 Wifly::Wifly(   PinName tx, PinName rx, PinName _reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec):
-    wifi(tx, rx), reset_pin(_reset), tcp_status(tcp_status), buf_wifly(256)
+    wifi(tx, rx), reset_pin(_reset), tcp_status(tcp_status), baudrate(9600), buf_wifly(256)
 {
     memset(&state, 0, sizeof(state));
     state.sec = sec;
@@ -545,3 +545,55 @@
     DBG("Wifly::flushIn(%d) {%s}", timeout_ms, chatter);
 #endif
 }
+
+
+// The ARM uart and the Wifly uart have to be in sync or we get
+// no meaningful response, so then have to try the possibilities.
+//
+// First try is at the currently configured ARM uart baud, if
+// that fails then it shifts the ARM uart baud through the probable
+// speeds, trying to establish contact with the Wifly module.
+// Once contact is demonstrated (response to the 'ver' command),
+// then it sets the Wifly module and then the ARM uart.
+bool Wifly::baud(int _targetBaud)
+{
+    // in testing, 460800 and 921600 may change the Wifly module where you can't
+    // change it back w/o a reset. So, we won't even permit those speeds.
+    const int baudrates[] = {2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400};    //, 460800, 921600};
+#define BRCOUNT (sizeof(baudrates)/sizeof(baudrates[0]))
+    char cmd[20];       // sized for "set u i 460800\r" [15+1], plus margin [4]
+    int tryIndex = 0;
+    bool res = false;
+    int userIndex;
+
+    sprintf(cmd, "set u i %d\r", _targetBaud);
+    // set u i # should cause it to exit command mode (manual 2.3.64),
+    // but testing indicates that it does not.
+    for (userIndex=0; userIndex < BRCOUNT; userIndex++) {
+        if (_targetBaud == baudrates[userIndex]) {
+            while (tryIndex <= BRCOUNT) {
+                DBG("baud(%d) try: %d", _targetBaud, tryIndex);
+                sendCommand(cmd); // shift Wifly to desired speed [it may not respond (see 2.3.64)]
+                // state.cmd_mode = false;  // see note above why this is disabled
+                wifi.baud(_targetBaud);     // shift the ARM uart to match
+                if (sendCommand("ver\r", "wifly", NULL, timeToRespond(4))) {  // use this to verify communications
+                    baudrate = _targetBaud;
+                    res = true;
+                    break;              // success
+                }
+                // keep trying baudrates between ARM and WiFly
+                if (tryIndex < BRCOUNT) {
+                    wifi.baud(baudrates[tryIndex]);
+                }
+                tryIndex++;
+            }
+            break;  // if they selected a legitimate baud, try no others
+        }
+    }
+    return res;
+}
+
+int Wifly::timeToRespond(int stringLen) 
+{
+    return 150 + (1 | 10000/baudrate) * stringLen;
+}
--- a/Wifly/Wifly.h	Sun Jul 21 21:14:57 2013 +0000
+++ b/Wifly/Wifly.h	Sun Jul 21 23:05:51 2013 +0000
@@ -214,6 +214,26 @@
     */
     bool gethostbyname(const char * host, char * ip);
 
+    /**
+    * Set the baud rate between the ARM and the WiFly.
+    *
+    * This will set the WiFly module baud rate first and then
+    * set the ARM interface to match it. If it cannot get the proper 
+    * acknowledge response, it will go on a hunt through the range 
+    * of standard baud rates.
+    *
+    * @note Baud rate must be one of 2400, 4800, 9600, 19200, 38400, 57600,
+    *       115200, 230400, 460800, or 921600. (See Wifly manual 2.3.64)
+    * @note Baud rate of 230400 has been seen to be marginal w/o flow control.
+    * @note Setting a baud rate to a 460800 or above may be unrecoverable
+    *       without resetting the Wifly module.
+    *
+    * @param baudrate is the desired baudrate.
+    * @returns true if it succeeded, which means that communications can continue, 
+    * @returns false if it failed to establish a communication link.
+    */
+    bool baud(int baudrate);
+
     static Wifly * getInstance() {
         return inst;
     };
@@ -222,6 +242,7 @@
     Serial wifi;
     DigitalOut reset_pin;
     DigitalIn tcp_status;
+    int baudrate;
     char phrase[30];
     char ssid[30];
     const char * ip;
@@ -246,6 +267,15 @@
 
     State state;
     char * getStringSecurity();
+    
+    /**
+    * Estimates the time needed for the Wifly module to respond
+    * to some of the simple commands.
+    *
+    * @param stringLength is the number of characters in the command
+    * @returns number of milliseconds.
+    */
+    int timeToRespond(int stringLen);
 };
 
 #endif
\ No newline at end of file