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:
Sat Jan 04 20:56:56 2014 +0000
Revision:
57:5259cf47106a
Parent:
37:84084567c4b9
Child:
58:f49aab8072ec
Documentation improvement.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:fb4494783863 1 /* Copyright (C) 2012 mbed.org, MIT License
samux 1:fb4494783863 2 *
samux 1:fb4494783863 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:fb4494783863 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
samux 1:fb4494783863 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
samux 1:fb4494783863 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
samux 1:fb4494783863 7 * furnished to do so, subject to the following conditions:
samux 1:fb4494783863 8 *
samux 1:fb4494783863 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:fb4494783863 10 * substantial portions of the Software.
samux 1:fb4494783863 11 *
samux 1:fb4494783863 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:fb4494783863 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:fb4494783863 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:fb4494783863 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:fb4494783863 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:fb4494783863 17 */
samux 1:fb4494783863 18
samux 1:fb4494783863 19 #include "TCPSocketServer.h"
samux 1:fb4494783863 20 #include <string>
samux 1:fb4494783863 21
WiredHome 34:52e4eec8b790 22 TCPSocketServer::TCPSocketServer()
WiredHome 34:52e4eec8b790 23 {
WiredHome 34:52e4eec8b790 24 acceptIndex = 0;
WiredHome 34:52e4eec8b790 25 }
samux 1:fb4494783863 26
samux 1:fb4494783863 27 // Server initialization
WiredHome 34:52e4eec8b790 28 int TCPSocketServer::bind(int port)
WiredHome 34:52e4eec8b790 29 {
samux 1:fb4494783863 30 char cmd[20];
WiredHome 34:52e4eec8b790 31
WiredHome 57:5259cf47106a 32 wifi->setProtocol(TCP); // set TCP protocol
WiredHome 57:5259cf47106a 33 sprintf(cmd, "set i l %d\r", port); // set ip localport #
samux 1:fb4494783863 34 if (!wifi->sendCommand(cmd, "AOK"))
samux 1:fb4494783863 35 return -1;
samux 3:9aa05e19c62e 36 if (!wifi->sendCommand("save\r", "Stor"))
samux 3:9aa05e19c62e 37 return -1;
WiredHome 57:5259cf47106a 38 wifi->reboot(); // port setting only takes effect after reboot
WiredHome 34:52e4eec8b790 39
WiredHome 57:5259cf47106a 40 // connect to the network
samux 4:0bcec6272784 41 if (wifi->isDHCP()) {
samux 4:0bcec6272784 42 if (!wifi->sendCommand("join\r", "DHCP=ON", NULL, 10000))
samux 4:0bcec6272784 43 return -1;
samux 4:0bcec6272784 44 } else {
samux 4:0bcec6272784 45 if (!wifi->sendCommand("join\r", "Associated", NULL, 10000))
samux 4:0bcec6272784 46 return -1;
samux 4:0bcec6272784 47 }
samux 1:fb4494783863 48 wifi->exit();
samux 3:9aa05e19c62e 49 wait(0.2);
samux 3:9aa05e19c62e 50 wifi->flush();
samux 1:fb4494783863 51 return 0;
samux 1:fb4494783863 52 }
samux 1:fb4494783863 53
WiredHome 34:52e4eec8b790 54 int TCPSocketServer::listen(int backlog)
WiredHome 34:52e4eec8b790 55 {
samux 1:fb4494783863 56 if (backlog != 1)
samux 1:fb4494783863 57 return -1;
samux 1:fb4494783863 58 return 0;
samux 1:fb4494783863 59 }
samux 1:fb4494783863 60
WiredHome 37:84084567c4b9 61 // sometimes simply "*OPEN*" comes in, and sometimes
WiredHome 37:84084567c4b9 62 // a prior connection closes too, so we get "*CLOS**OPEN*".
WiredHome 37:84084567c4b9 63 // When accepting a connection from a browser, it can be
WiredHome 34:52e4eec8b790 64 // *CLOS**OPEN*GET / HTTP/1.1
WiredHome 34:52e4eec8b790 65 // The point here is to remove everything to the left
WiredHome 37:84084567c4b9 66 // of, and including, "*OPEN*" in order to accept this
WiredHome 37:84084567c4b9 67 // connection, and the "GET / HTTP/1.1" is available
WiredHome 37:84084567c4b9 68 // for consumption.
WiredHome 34:52e4eec8b790 69 //
WiredHome 34:52e4eec8b790 70 int TCPSocketServer::accept(TCPSocketConnection& connection)
WiredHome 34:52e4eec8b790 71 {
WiredHome 34:52e4eec8b790 72 int nb_available = 0;
samux 1:fb4494783863 73 char c;
WiredHome 34:52e4eec8b790 74 const char OPEN[] = "*OPEN*"; // seeking this to accept
WiredHome 34:52e4eec8b790 75
WiredHome 32:4543e91ab4bf 76 acceptTimerStart();
samux 1:fb4494783863 77 while (1) {
samux 1:fb4494783863 78 nb_available = wifi->readable();
WiredHome 32:4543e91ab4bf 79 if (nb_available == 0 && !_blocking && acceptTimeout())
WiredHome 32:4543e91ab4bf 80 return -1;
samux 1:fb4494783863 81 for (int i = 0; i < nb_available; i++) {
samux 1:fb4494783863 82 c = wifi->getc();
WiredHome 36:8d868fea6fe6 83 if (c != OPEN[acceptIndex])
WiredHome 36:8d868fea6fe6 84 acceptIndex = 0;
WiredHome 34:52e4eec8b790 85 if (c == OPEN[acceptIndex]) {
WiredHome 34:52e4eec8b790 86 acceptIndex++;
WiredHome 34:52e4eec8b790 87 if (acceptIndex == strlen(OPEN)) {
WiredHome 34:52e4eec8b790 88 wifi->setConnectionState(true);
WiredHome 34:52e4eec8b790 89 acceptIndex = 0; // for next pass
WiredHome 34:52e4eec8b790 90 return 0;
WiredHome 34:52e4eec8b790 91 }
WiredHome 34:52e4eec8b790 92 }
samux 1:fb4494783863 93 }
samux 1:fb4494783863 94 }
WiredHome 32:4543e91ab4bf 95 }
WiredHome 32:4543e91ab4bf 96
WiredHome 32:4543e91ab4bf 97 void TCPSocketServer::acceptTimerStart()
WiredHome 32:4543e91ab4bf 98 {
WiredHome 32:4543e91ab4bf 99 acceptTimer.start();
WiredHome 32:4543e91ab4bf 100 }
WiredHome 32:4543e91ab4bf 101
WiredHome 32:4543e91ab4bf 102 bool TCPSocketServer::acceptTimeout()
WiredHome 32:4543e91ab4bf 103 {
WiredHome 33:25958bf80481 104 if ((_timeout == 0) || (acceptTimer.read_ms() >= _timeout))
WiredHome 32:4543e91ab4bf 105 return true;
WiredHome 32:4543e91ab4bf 106 else
WiredHome 32:4543e91ab4bf 107 return false;
samux 1:fb4494783863 108 }