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 12:6270ced02019 1 /* Copyright (C) 2012 mbed.org, MIT License
WiredHome 12:6270ced02019 2 *
WiredHome 12:6270ced02019 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
WiredHome 12:6270ced02019 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
WiredHome 12:6270ced02019 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
WiredHome 12:6270ced02019 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
WiredHome 12:6270ced02019 7 * furnished to do so, subject to the following conditions:
WiredHome 12:6270ced02019 8 *
WiredHome 12:6270ced02019 9 * The above copyright notice and this permission notice shall be included in all copies or
WiredHome 12:6270ced02019 10 * substantial portions of the Software.
WiredHome 12:6270ced02019 11 *
WiredHome 12:6270ced02019 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
WiredHome 12:6270ced02019 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
WiredHome 12:6270ced02019 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
WiredHome 12:6270ced02019 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
WiredHome 12:6270ced02019 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
WiredHome 12:6270ced02019 17 */
WiredHome 12:6270ced02019 18
WiredHome 12:6270ced02019 19 #include "UDPSocket.h"
WiredHome 12:6270ced02019 20
WiredHome 12:6270ced02019 21 #include <string>
WiredHome 12:6270ced02019 22 #include <algorithm>
WiredHome 12:6270ced02019 23
WiredHome 12:6270ced02019 24 UDPSocket::UDPSocket()
WiredHome 12:6270ced02019 25 {
WiredHome 12:6270ced02019 26 endpoint_configured = false;
WiredHome 12:6270ced02019 27 endpoint_read = false;
WiredHome 12:6270ced02019 28 }
WiredHome 12:6270ced02019 29
WiredHome 12:6270ced02019 30 int UDPSocket::init(void)
WiredHome 12:6270ced02019 31 {
WiredHome 12:6270ced02019 32 wifi->setProtocol(UDP);
WiredHome 12:6270ced02019 33 wifi->exit();
WiredHome 12:6270ced02019 34 return 0;
WiredHome 12:6270ced02019 35 }
WiredHome 12:6270ced02019 36
WiredHome 12:6270ced02019 37 // Server initialization
WiredHome 12:6270ced02019 38 int UDPSocket::bind(int port)
WiredHome 12:6270ced02019 39 {
WiredHome 12:6270ced02019 40 char cmd[17];
WiredHome 12:6270ced02019 41
WiredHome 12:6270ced02019 42 // set udp protocol
WiredHome 12:6270ced02019 43 wifi->setProtocol(UDP);
WiredHome 12:6270ced02019 44
WiredHome 12:6270ced02019 45 // set local port
WiredHome 12:6270ced02019 46 sprintf(cmd, "set i l %d\r", port);
WiredHome 12:6270ced02019 47 if (!wifi->sendCommand(cmd, "AOK"))
WiredHome 12:6270ced02019 48 return -1;
WiredHome 12:6270ced02019 49
WiredHome 12:6270ced02019 50 // save
WiredHome 12:6270ced02019 51 //if (!wifi->sendCommand("save\r", "Stor"))
WiredHome 12:6270ced02019 52 // return -1;
WiredHome 12:6270ced02019 53
WiredHome 12:6270ced02019 54 // reboot
WiredHome 12:6270ced02019 55 //wifi->reboot();
WiredHome 12:6270ced02019 56
WiredHome 12:6270ced02019 57 // connect the network
WiredHome 12:6270ced02019 58 if (wifi->isDHCP()) {
WiredHome 12:6270ced02019 59 if (!wifi->sendCommand("join\r", "DHCP=ON", NULL, 0, 10000))
WiredHome 12:6270ced02019 60 return -1;
WiredHome 12:6270ced02019 61 } else {
WiredHome 12:6270ced02019 62 if (!wifi->sendCommand("join\r", "Associated", NULL, 0, 10000))
WiredHome 12:6270ced02019 63 return -1;
WiredHome 12:6270ced02019 64 }
WiredHome 12:6270ced02019 65
WiredHome 12:6270ced02019 66 // exit
WiredHome 12:6270ced02019 67 wifi->exit();
WiredHome 12:6270ced02019 68 wifi->flush();
WiredHome 12:6270ced02019 69 return 0;
WiredHome 12:6270ced02019 70 }
WiredHome 12:6270ced02019 71
WiredHome 12:6270ced02019 72 // -1 if unsuccessful, else number of bytes written
WiredHome 12:6270ced02019 73 int UDPSocket::sendTo(Endpoint &remote, char *packet, int length)
WiredHome 12:6270ced02019 74 {
WiredHome 12:6270ced02019 75 Timer tmr;
WiredHome 12:6270ced02019 76 int idx = 0;
WiredHome 12:6270ced02019 77
WiredHome 12:6270ced02019 78 confEndpoint(remote);
WiredHome 12:6270ced02019 79
WiredHome 12:6270ced02019 80 tmr.start();
WiredHome 12:6270ced02019 81
WiredHome 12:6270ced02019 82 while ((tmr.read_ms() < _timeout) || _blocking) {
WiredHome 12:6270ced02019 83
WiredHome 12:6270ced02019 84 idx += wifi->send(packet, length);
WiredHome 12:6270ced02019 85
WiredHome 12:6270ced02019 86 if (idx == length)
WiredHome 12:6270ced02019 87 return idx;
WiredHome 12:6270ced02019 88 }
WiredHome 12:6270ced02019 89 return (idx == 0) ? -1 : idx;
WiredHome 12:6270ced02019 90 }
WiredHome 8:79415e982c32 91
WiredHome 12:6270ced02019 92 // -1 if unsuccessful, else number of bytes received
WiredHome 12:6270ced02019 93 int UDPSocket::receiveFrom(Endpoint &remote, char *buffer, int length)
WiredHome 12:6270ced02019 94 {
WiredHome 12:6270ced02019 95 Timer tmr;
WiredHome 12:6270ced02019 96 int idx = 0;
WiredHome 12:6270ced02019 97 int nb_available = 0;
WiredHome 12:6270ced02019 98 int time = -1;
WiredHome 12:6270ced02019 99
WiredHome 12:6270ced02019 100 if (_blocking) {
WiredHome 12:6270ced02019 101 while (1) {
WiredHome 12:6270ced02019 102 nb_available = wifi->readable();
WiredHome 12:6270ced02019 103 if (nb_available != 0) {
WiredHome 12:6270ced02019 104 break;
WiredHome 12:6270ced02019 105 }
WiredHome 12:6270ced02019 106 }
WiredHome 12:6270ced02019 107 }
WiredHome 12:6270ced02019 108
WiredHome 12:6270ced02019 109 tmr.start();
WiredHome 12:6270ced02019 110
WiredHome 12:6270ced02019 111 while (time < _timeout) {
WiredHome 12:6270ced02019 112
WiredHome 12:6270ced02019 113 nb_available = wifi->readable();
WiredHome 12:6270ced02019 114 for (int i = 0; i < min(nb_available, length); i++) {
WiredHome 12:6270ced02019 115 buffer[idx] = wifi->getc();
WiredHome 12:6270ced02019 116 idx++;
WiredHome 12:6270ced02019 117 }
WiredHome 12:6270ced02019 118
WiredHome 12:6270ced02019 119 if (idx == length) {
WiredHome 12:6270ced02019 120 break;
WiredHome 12:6270ced02019 121 }
WiredHome 12:6270ced02019 122 time = tmr.read_ms();
WiredHome 12:6270ced02019 123 }
WiredHome 12:6270ced02019 124
WiredHome 12:6270ced02019 125 readEndpoint(remote);
WiredHome 12:6270ced02019 126 return (idx == 0) ? -1 : idx;
WiredHome 12:6270ced02019 127 }
WiredHome 12:6270ced02019 128
WiredHome 12:6270ced02019 129 bool UDPSocket::confEndpoint(Endpoint & ep)
WiredHome 12:6270ced02019 130 {
WiredHome 12:6270ced02019 131 char * host;
WiredHome 12:6270ced02019 132 char cmd[30];
WiredHome 12:6270ced02019 133 if (!endpoint_configured) {
WiredHome 12:6270ced02019 134 host = ep.get_address();
WiredHome 12:6270ced02019 135 if (host[0] != '\0') {
WiredHome 12:6270ced02019 136 // set host
WiredHome 12:6270ced02019 137 sprintf(cmd, "set i h %s\r", host);
WiredHome 12:6270ced02019 138 if (!wifi->sendCommand(cmd, "AOK"))
WiredHome 12:6270ced02019 139 return false;
WiredHome 12:6270ced02019 140
WiredHome 12:6270ced02019 141 // set remote port
WiredHome 12:6270ced02019 142 sprintf(cmd, "set i r %d\r", ep.get_port());
WiredHome 12:6270ced02019 143 if (!wifi->sendCommand(cmd, "AOK"))
WiredHome 12:6270ced02019 144 return false;
WiredHome 12:6270ced02019 145
WiredHome 12:6270ced02019 146 wifi->exit();
WiredHome 12:6270ced02019 147 endpoint_configured = true;
WiredHome 12:6270ced02019 148 return true;
WiredHome 12:6270ced02019 149 }
WiredHome 12:6270ced02019 150 }
WiredHome 12:6270ced02019 151 return true;
WiredHome 12:6270ced02019 152 }
WiredHome 12:6270ced02019 153
WiredHome 12:6270ced02019 154 bool UDPSocket::readEndpoint(Endpoint & ep)
WiredHome 12:6270ced02019 155 {
WiredHome 12:6270ced02019 156 char recv[256];
WiredHome 12:6270ced02019 157 int begin = 0;
WiredHome 12:6270ced02019 158 int end = 0;
WiredHome 12:6270ced02019 159 string str;
WiredHome 12:6270ced02019 160 string addr;
WiredHome 12:6270ced02019 161 int port;
WiredHome 12:6270ced02019 162 if (!endpoint_read) {
WiredHome 12:6270ced02019 163 if (!wifi->sendCommand("get ip\r", NULL, recv, sizeof(recv)))
WiredHome 12:6270ced02019 164 return false;
WiredHome 12:6270ced02019 165 wifi->exit();
WiredHome 12:6270ced02019 166 str = recv;
WiredHome 12:6270ced02019 167 begin = str.find("HOST=");
WiredHome 12:6270ced02019 168 end = str.find("PROTO=");
WiredHome 12:6270ced02019 169 if (begin != string::npos && end != string::npos) {
WiredHome 12:6270ced02019 170 str = str.substr(begin + 5, end - begin - 5);
WiredHome 12:6270ced02019 171 int pos = str.find(":");
WiredHome 12:6270ced02019 172 if (pos != string::npos) {
WiredHome 12:6270ced02019 173 addr = str.substr(0, pos);
WiredHome 12:6270ced02019 174 port = atoi(str.substr(pos + 1).c_str());
WiredHome 12:6270ced02019 175 ep.set_address(addr.c_str(), port);
WiredHome 12:6270ced02019 176 endpoint_read = true;
WiredHome 12:6270ced02019 177 wifi->flush();
WiredHome 12:6270ced02019 178 return true;
WiredHome 12:6270ced02019 179 }
WiredHome 12:6270ced02019 180 }
WiredHome 12:6270ced02019 181 wifi->flush();
WiredHome 12:6270ced02019 182 }
WiredHome 12:6270ced02019 183 return false;
WiredHome 12:6270ced02019 184 }