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 Jun 24 19:52:51 2013 +0000
Revision:
7:b3d740f89f27
Parent:
1:fb4494783863
Child:
10:a594fe035b36
Permit TCPSocketConnection to be non-blocking.
; Permit Wifly to generation documentation.
; Other cosmetic changes.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WiredHome 7:b3d740f89f27 1 /* Copyright (C) 2012 mbed.org, MIT License
WiredHome 7:b3d740f89f27 2 *
WiredHome 7:b3d740f89f27 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
WiredHome 7:b3d740f89f27 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
WiredHome 7:b3d740f89f27 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
WiredHome 7:b3d740f89f27 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
WiredHome 7:b3d740f89f27 7 * furnished to do so, subject to the following conditions:
WiredHome 7:b3d740f89f27 8 *
WiredHome 7:b3d740f89f27 9 * The above copyright notice and this permission notice shall be included in all copies or
WiredHome 7:b3d740f89f27 10 * substantial portions of the Software.
WiredHome 7:b3d740f89f27 11 *
WiredHome 7:b3d740f89f27 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
WiredHome 7:b3d740f89f27 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
WiredHome 7:b3d740f89f27 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
WiredHome 7:b3d740f89f27 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
WiredHome 7:b3d740f89f27 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
WiredHome 7:b3d740f89f27 17 */
WiredHome 7:b3d740f89f27 18
WiredHome 7:b3d740f89f27 19 #include "TCPSocketConnection.h"
WiredHome 7:b3d740f89f27 20 #include <algorithm>
WiredHome 7:b3d740f89f27 21
WiredHome 7:b3d740f89f27 22 TCPSocketConnection::TCPSocketConnection() {
WiredHome 7:b3d740f89f27 23 }
WiredHome 7:b3d740f89f27 24
WiredHome 7:b3d740f89f27 25 int TCPSocketConnection::connect(const char* host, const int port)
WiredHome 7:b3d740f89f27 26 {
WiredHome 7:b3d740f89f27 27 if (!wifi->connect(host, port))
WiredHome 7:b3d740f89f27 28 return -1;
WiredHome 7:b3d740f89f27 29 wifi->flush();
WiredHome 7:b3d740f89f27 30 return 0;
WiredHome 7:b3d740f89f27 31 }
WiredHome 7:b3d740f89f27 32
WiredHome 7:b3d740f89f27 33 bool TCPSocketConnection::is_connected(void)
WiredHome 7:b3d740f89f27 34 {
WiredHome 7:b3d740f89f27 35 return wifi->is_connected();
WiredHome 7:b3d740f89f27 36 }
WiredHome 7:b3d740f89f27 37
WiredHome 7:b3d740f89f27 38 int TCPSocketConnection::send(char* data, int length)
WiredHome 7:b3d740f89f27 39 {
WiredHome 7:b3d740f89f27 40 Timer tmr;
WiredHome 7:b3d740f89f27 41
WiredHome 7:b3d740f89f27 42 if (!_blocking) {
WiredHome 7:b3d740f89f27 43 tmr.start();
WiredHome 7:b3d740f89f27 44 while (tmr.read_ms() < _timeout) {
WiredHome 7:b3d740f89f27 45 if (wifi->writeable())
WiredHome 7:b3d740f89f27 46 break;
WiredHome 7:b3d740f89f27 47 }
WiredHome 7:b3d740f89f27 48 if (tmr.read_ms() >= _timeout) {
WiredHome 7:b3d740f89f27 49 return -1;
WiredHome 7:b3d740f89f27 50 }
WiredHome 7:b3d740f89f27 51 }
WiredHome 7:b3d740f89f27 52 return wifi->send(data, length);
WiredHome 7:b3d740f89f27 53 }
WiredHome 7:b3d740f89f27 54
WiredHome 7:b3d740f89f27 55 // -1 if unsuccessful, else number of bytes written
WiredHome 7:b3d740f89f27 56 int TCPSocketConnection::send_all(char* data, int length)
WiredHome 7:b3d740f89f27 57 {
WiredHome 7:b3d740f89f27 58 Timer tmr;
WiredHome 7:b3d740f89f27 59 int idx = 0;
WiredHome 7:b3d740f89f27 60 tmr.start();
WiredHome 7:b3d740f89f27 61
WiredHome 7:b3d740f89f27 62 while ((tmr.read_ms() < _timeout) || _blocking) {
WiredHome 7:b3d740f89f27 63
WiredHome 7:b3d740f89f27 64 idx += wifi->send(data, length);
WiredHome 7:b3d740f89f27 65
WiredHome 7:b3d740f89f27 66 if (idx == length)
WiredHome 7:b3d740f89f27 67 return idx;
WiredHome 7:b3d740f89f27 68 }
WiredHome 7:b3d740f89f27 69 return (idx == 0) ? -1 : idx;
WiredHome 7:b3d740f89f27 70 }
WiredHome 7:b3d740f89f27 71
WiredHome 7:b3d740f89f27 72 // -1 if unsuccessful, else number of bytes received
WiredHome 7:b3d740f89f27 73 int TCPSocketConnection::receive(char* data, int length)
WiredHome 7:b3d740f89f27 74 {
WiredHome 7:b3d740f89f27 75 Timer tmr;
WiredHome 7:b3d740f89f27 76 int time = -1;
WiredHome 7:b3d740f89f27 77
WiredHome 7:b3d740f89f27 78 if (!_blocking) {
WiredHome 7:b3d740f89f27 79 tmr.start();
WiredHome 7:b3d740f89f27 80 while (time < _timeout) {
WiredHome 7:b3d740f89f27 81 if (wifi->readable()) {
WiredHome 7:b3d740f89f27 82 break;
WiredHome 7:b3d740f89f27 83 }
WiredHome 7:b3d740f89f27 84 time = tmr.read_ms();
WiredHome 7:b3d740f89f27 85 }
WiredHome 7:b3d740f89f27 86 if (time >= _timeout) {
WiredHome 7:b3d740f89f27 87 return -1;
WiredHome 7:b3d740f89f27 88 }
WiredHome 7:b3d740f89f27 89 }
WiredHome 7:b3d740f89f27 90
WiredHome 7:b3d740f89f27 91 while(!wifi->readable())
WiredHome 7:b3d740f89f27 92 ;
WiredHome 7:b3d740f89f27 93 int nb_available = wifi->readable();
WiredHome 7:b3d740f89f27 94 for (int i = 0; i < min(nb_available, length); i++) {
WiredHome 7:b3d740f89f27 95 data[i] = wifi->getc();
WiredHome 7:b3d740f89f27 96 }
WiredHome 7:b3d740f89f27 97
WiredHome 7:b3d740f89f27 98 return min(nb_available, length);
WiredHome 7:b3d740f89f27 99 }
WiredHome 7:b3d740f89f27 100
WiredHome 7:b3d740f89f27 101
WiredHome 7:b3d740f89f27 102 // -1 if unsuccessful, else number of bytes received
WiredHome 7:b3d740f89f27 103 int TCPSocketConnection::receive_all(char* data, int length)
WiredHome 7:b3d740f89f27 104 {
WiredHome 7:b3d740f89f27 105 Timer tmr;
WiredHome 7:b3d740f89f27 106 int idx = 0;
WiredHome 7:b3d740f89f27 107 int time = -1;
WiredHome 7:b3d740f89f27 108
WiredHome 7:b3d740f89f27 109 tmr.start();
WiredHome 7:b3d740f89f27 110 while (time < _timeout || _blocking) {
WiredHome 7:b3d740f89f27 111
WiredHome 7:b3d740f89f27 112 int nb_available = wifi->readable();
WiredHome 7:b3d740f89f27 113 for (int i = 0; i < min(nb_available, length); i++) {
WiredHome 7:b3d740f89f27 114 data[idx++] = wifi->getc();
WiredHome 7:b3d740f89f27 115 }
WiredHome 7:b3d740f89f27 116 if (idx == length)
WiredHome 7:b3d740f89f27 117 break;
WiredHome 7:b3d740f89f27 118 time = tmr.read_ms();
WiredHome 7:b3d740f89f27 119 }
WiredHome 7:b3d740f89f27 120 return (idx == 0) ? -1 : idx;
WiredHome 7:b3d740f89f27 121 }
WiredHome 7:b3d740f89f27 122