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:
Mon Jul 01 04:37:55 2013 +0000
Revision:
12:6270ced02019
Parent:
8:79415e982c32
Quite a bit of refactoring of the wifly interface. Most of the changes are in the Wifly.cpp file.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WiredHome 8:79415e982c32 1 /* Copyright (C) 2012 mbed.org, MIT License
WiredHome 8:79415e982c32 2 *
WiredHome 8:79415e982c32 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
WiredHome 8:79415e982c32 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
WiredHome 8:79415e982c32 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
WiredHome 8:79415e982c32 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
WiredHome 8:79415e982c32 7 * furnished to do so, subject to the following conditions:
WiredHome 8:79415e982c32 8 *
WiredHome 8:79415e982c32 9 * The above copyright notice and this permission notice shall be included in all copies or
WiredHome 8:79415e982c32 10 * substantial portions of the Software.
WiredHome 8:79415e982c32 11 *
WiredHome 8:79415e982c32 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
WiredHome 8:79415e982c32 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
WiredHome 8:79415e982c32 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
WiredHome 8:79415e982c32 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
WiredHome 8:79415e982c32 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
WiredHome 8:79415e982c32 17 */
WiredHome 8:79415e982c32 18
WiredHome 8:79415e982c32 19 #include "TCPSocketServer.h"
WiredHome 8:79415e982c32 20 #include <string>
WiredHome 8:79415e982c32 21
WiredHome 8:79415e982c32 22 TCPSocketServer::TCPSocketServer() {
WiredHome 7:b3d740f89f27 23 }
WiredHome 8:79415e982c32 24
WiredHome 8:79415e982c32 25 // Server initialization
WiredHome 12:6270ced02019 26 int TCPSocketServer::bind(int port)
WiredHome 12:6270ced02019 27 {
WiredHome 8:79415e982c32 28 char cmd[20];
WiredHome 8:79415e982c32 29
WiredHome 8:79415e982c32 30 // set TCP protocol
WiredHome 8:79415e982c32 31 wifi->setProtocol(TCP);
WiredHome 8:79415e982c32 32
WiredHome 8:79415e982c32 33 // set local port
WiredHome 8:79415e982c32 34 sprintf(cmd, "set i l %d\r", port);
WiredHome 8:79415e982c32 35 if (!wifi->sendCommand(cmd, "AOK"))
WiredHome 8:79415e982c32 36 return -1;
WiredHome 8:79415e982c32 37
WiredHome 8:79415e982c32 38 // save
WiredHome 12:6270ced02019 39 //if (!wifi->sendCommand("save\r", "Stor"))
WiredHome 12:6270ced02019 40 // return -1;
WiredHome 8:79415e982c32 41
WiredHome 8:79415e982c32 42 // reboot
WiredHome 12:6270ced02019 43 //wifi->reboot();
WiredHome 8:79415e982c32 44
WiredHome 8:79415e982c32 45 // connect the network
WiredHome 8:79415e982c32 46 if (wifi->isDHCP()) {
WiredHome 8:79415e982c32 47 if (!wifi->sendCommand("join\r", "DHCP=ON", NULL, 0, 10000))
WiredHome 8:79415e982c32 48 return -1;
WiredHome 8:79415e982c32 49 } else {
WiredHome 8:79415e982c32 50 if (!wifi->sendCommand("join\r", "Associated", NULL, 0, 10000))
WiredHome 8:79415e982c32 51 return -1;
WiredHome 8:79415e982c32 52 }
WiredHome 8:79415e982c32 53
WiredHome 8:79415e982c32 54 // exit
WiredHome 8:79415e982c32 55 wifi->exit();
WiredHome 8:79415e982c32 56 wifi->flush();
WiredHome 8:79415e982c32 57 return 0;
WiredHome 8:79415e982c32 58 }
WiredHome 8:79415e982c32 59
WiredHome 8:79415e982c32 60 int TCPSocketServer::listen(int backlog) {
WiredHome 8:79415e982c32 61 if (backlog != 1)
WiredHome 8:79415e982c32 62 return -1;
WiredHome 8:79415e982c32 63 return 0;
WiredHome 8:79415e982c32 64 }
WiredHome 8:79415e982c32 65
WiredHome 8:79415e982c32 66
WiredHome 8:79415e982c32 67 int TCPSocketServer::accept(TCPSocketConnection& connection) {
WiredHome 8:79415e982c32 68 int nb_available = 0, pos = 0;
WiredHome 8:79415e982c32 69 char c;
WiredHome 8:79415e982c32 70 string str;
WiredHome 8:79415e982c32 71 bool o_find = false;
WiredHome 8:79415e982c32 72
WiredHome 8:79415e982c32 73 while (1) {
WiredHome 8:79415e982c32 74 nb_available = wifi->readable();
WiredHome 12:6270ced02019 75 if (nb_available == 0 && !_blocking)
WiredHome 12:6270ced02019 76 return -1;
WiredHome 8:79415e982c32 77 for (int i = 0; i < nb_available; i++) {
WiredHome 8:79415e982c32 78 c = wifi->getc();
WiredHome 8:79415e982c32 79 if (c == '*') {
WiredHome 8:79415e982c32 80 o_find = true;
WiredHome 8:79415e982c32 81 }
WiredHome 8:79415e982c32 82 if (o_find && c != '\r' && c != '\n') {
WiredHome 8:79415e982c32 83 str += c;
WiredHome 8:79415e982c32 84 pos = str.find("*OPEN*");
WiredHome 8:79415e982c32 85 if (pos != string::npos) {
WiredHome 8:79415e982c32 86 wifi->setConnectionState(true);
WiredHome 8:79415e982c32 87 //printf("accept *OPEN*\r\n");
WiredHome 8:79415e982c32 88 return 0;
WiredHome 8:79415e982c32 89 }
WiredHome 12:6270ced02019 90 } else {
WiredHome 12:6270ced02019 91 //std::putchar(c); // diagnostics
WiredHome 8:79415e982c32 92 }
WiredHome 8:79415e982c32 93 }
WiredHome 8:79415e982c32 94 }
WiredHome 8:79415e982c32 95 }