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 Dec 03 02:06:24 2018 +0000
Revision:
78:a03a5dade5b5
Parent:
74:d20120171e35
Renamed the WiflyInterface header and class name to EthernetInterface to be more readily swapped with the wired version. The TimeInterface then works directly.

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 "UDPSocket.h"
samux 1:fb4494783863 20
samux 1:fb4494783863 21 #include <string>
samux 1:fb4494783863 22 #include <algorithm>
samux 1:fb4494783863 23
WiredHome 74:d20120171e35 24 //#define DEBUG "UDPs" //Debug is disabled by default
WiredHome 74:d20120171e35 25
WiredHome 74:d20120171e35 26 // How to use this debug macro
WiredHome 74:d20120171e35 27 //
WiredHome 74:d20120171e35 28 // ...
WiredHome 74:d20120171e35 29 // INFO("Stuff to show %d", var); // new-line is automatically appended
WiredHome 74:d20120171e35 30 // [I myfile 23] Stuff to show 23\r\n
WiredHome 74:d20120171e35 31 //
WiredHome 74:d20120171e35 32 #if (defined(DEBUG) && !defined(TARGET_LPC11U24))
WiredHome 74:d20120171e35 33 #define INFO(x, ...) std::printf("[INF %s %3d] "x"\r\n", DEBUG, __LINE__, ##__VA_ARGS__);
WiredHome 74:d20120171e35 34 #define WARN(x, ...) std::printf("[WRN %s %3d] "x"\r\n", DEBUG, __LINE__, ##__VA_ARGS__);
WiredHome 74:d20120171e35 35 #define ERR(x, ...) std::printf("[ERR %s %3d] "x"\r\n", DEBUG, __LINE__, ##__VA_ARGS__);
WiredHome 74:d20120171e35 36 #else
WiredHome 74:d20120171e35 37 #define INFO(x, ...)
WiredHome 74:d20120171e35 38 #define WARN(x, ...)
WiredHome 74:d20120171e35 39 #define ERR(x, ...)
WiredHome 74:d20120171e35 40 #endif
WiredHome 74:d20120171e35 41
samux 1:fb4494783863 42 UDPSocket::UDPSocket()
samux 1:fb4494783863 43 {
samux 1:fb4494783863 44 endpoint_configured = false;
samux 1:fb4494783863 45 endpoint_read = false;
samux 1:fb4494783863 46 }
samux 1:fb4494783863 47
samux 1:fb4494783863 48 int UDPSocket::init(void)
samux 1:fb4494783863 49 {
samux 1:fb4494783863 50 wifi->setProtocol(UDP);
samux 1:fb4494783863 51 wifi->exit();
samux 1:fb4494783863 52 return 0;
samux 1:fb4494783863 53 }
samux 1:fb4494783863 54
samux 1:fb4494783863 55 // Server initialization
samux 1:fb4494783863 56 int UDPSocket::bind(int port)
samux 1:fb4494783863 57 {
samux 1:fb4494783863 58 char cmd[17];
samux 1:fb4494783863 59
samux 1:fb4494783863 60 // set local port
samux 1:fb4494783863 61 sprintf(cmd, "set i l %d\r", port);
samux 1:fb4494783863 62 if (!wifi->sendCommand(cmd, "AOK"))
samux 1:fb4494783863 63 return -1;
samux 4:0bcec6272784 64
samux 4:0bcec6272784 65 // save
WiredHome 59:8e15d2ca7bd5 66 if (!wifi->sendCommand("save\r", "Stor", NULL, 5000))
samux 4:0bcec6272784 67 return -1;
samux 4:0bcec6272784 68
samux 4:0bcec6272784 69 // reboot
samux 4:0bcec6272784 70 wifi->reboot();
samux 4:0bcec6272784 71
samux 4:0bcec6272784 72 // set udp protocol
samux 4:0bcec6272784 73 wifi->setProtocol(UDP);
samux 4:0bcec6272784 74
samux 4:0bcec6272784 75 // connect the network
samux 4:0bcec6272784 76 if (wifi->isDHCP()) {
samux 4:0bcec6272784 77 if (!wifi->sendCommand("join\r", "DHCP=ON", NULL, 10000))
samux 4:0bcec6272784 78 return -1;
samux 4:0bcec6272784 79 } else {
samux 4:0bcec6272784 80 if (!wifi->sendCommand("join\r", "Associated", NULL, 10000))
samux 4:0bcec6272784 81 return -1;
samux 4:0bcec6272784 82 }
samux 4:0bcec6272784 83
samux 4:0bcec6272784 84 // exit
samux 1:fb4494783863 85 wifi->exit();
samux 4:0bcec6272784 86 wifi->flush();
samux 1:fb4494783863 87 return 0;
samux 1:fb4494783863 88 }
samux 1:fb4494783863 89
WiredHome 72:9499f5c1e00b 90 int UDPSocket::join_multicast_group(const char* address) {
WiredHome 72:9499f5c1e00b 91 return -1; // unsupported function
WiredHome 72:9499f5c1e00b 92 }
WiredHome 72:9499f5c1e00b 93
WiredHome 72:9499f5c1e00b 94 int UDPSocket::set_broadcasting(bool broadcast) {
WiredHome 72:9499f5c1e00b 95 return -1; // unsupported function
WiredHome 72:9499f5c1e00b 96 }
WiredHome 72:9499f5c1e00b 97
samux 1:fb4494783863 98 // -1 if unsuccessful, else number of bytes written
samux 1:fb4494783863 99 int UDPSocket::sendTo(Endpoint &remote, char *packet, int length)
samux 1:fb4494783863 100 {
samux 1:fb4494783863 101 Timer tmr;
samux 1:fb4494783863 102 int idx = 0;
WiredHome 74:d20120171e35 103 INFO("sendTo(..,..,%d)", length);
samux 1:fb4494783863 104 confEndpoint(remote);
samux 1:fb4494783863 105
samux 1:fb4494783863 106 tmr.start();
WiredHome 74:d20120171e35 107 INFO("sendTo %d", tmr.read_ms());
WiredHome 74:d20120171e35 108
samux 1:fb4494783863 109 while ((tmr.read_ms() < _timeout) || _blocking) {
samux 1:fb4494783863 110
samux 1:fb4494783863 111 idx += wifi->send(packet, length);
WiredHome 74:d20120171e35 112 INFO(" idx: %d", idx);
samux 1:fb4494783863 113 if (idx == length)
samux 1:fb4494783863 114 return idx;
samux 1:fb4494783863 115 }
WiredHome 74:d20120171e35 116 INFO(" idx; %d @ %d", idx, tmr.read_ms());
samux 1:fb4494783863 117 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 118 }
samux 1:fb4494783863 119
samux 1:fb4494783863 120 // -1 if unsuccessful, else number of bytes received
samux 1:fb4494783863 121 int UDPSocket::receiveFrom(Endpoint &remote, char *buffer, int length)
samux 1:fb4494783863 122 {
samux 1:fb4494783863 123 Timer tmr;
samux 1:fb4494783863 124 int idx = 0;
samux 1:fb4494783863 125 int nb_available = 0;
samux 1:fb4494783863 126 int time = -1;
samux 1:fb4494783863 127
samux 1:fb4494783863 128 if (_blocking) {
samux 1:fb4494783863 129 while (1) {
samux 1:fb4494783863 130 nb_available = wifi->readable();
samux 1:fb4494783863 131 if (nb_available != 0) {
samux 1:fb4494783863 132 break;
samux 1:fb4494783863 133 }
samux 1:fb4494783863 134 }
samux 1:fb4494783863 135 }
samux 1:fb4494783863 136
samux 1:fb4494783863 137 tmr.start();
samux 1:fb4494783863 138
samux 1:fb4494783863 139 while (time < _timeout) {
samux 1:fb4494783863 140
samux 1:fb4494783863 141 nb_available = wifi->readable();
samux 1:fb4494783863 142 for (int i = 0; i < min(nb_available, length); i++) {
samux 1:fb4494783863 143 buffer[idx] = wifi->getc();
samux 1:fb4494783863 144 idx++;
samux 1:fb4494783863 145 }
samux 1:fb4494783863 146
samux 1:fb4494783863 147 if (idx == length) {
samux 1:fb4494783863 148 break;
samux 1:fb4494783863 149 }
samux 1:fb4494783863 150
samux 1:fb4494783863 151 time = tmr.read_ms();
samux 1:fb4494783863 152 }
samux 1:fb4494783863 153
samux 1:fb4494783863 154 readEndpoint(remote);
samux 1:fb4494783863 155 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 156 }
samux 1:fb4494783863 157
samux 1:fb4494783863 158 bool UDPSocket::confEndpoint(Endpoint & ep)
samux 1:fb4494783863 159 {
samux 1:fb4494783863 160 char * host;
samux 1:fb4494783863 161 char cmd[30];
WiredHome 74:d20120171e35 162
WiredHome 74:d20120171e35 163 WARN("Force endpoint not configured");
WiredHome 74:d20120171e35 164 endpoint_configured = false;
WiredHome 74:d20120171e35 165 INFO("confEndpoint config'd: %d", endpoint_configured);
samux 1:fb4494783863 166 if (!endpoint_configured) {
samux 1:fb4494783863 167 host = ep.get_address();
samux 1:fb4494783863 168 if (host[0] != '\0') {
samux 1:fb4494783863 169 // set host
samux 1:fb4494783863 170 sprintf(cmd, "set i h %s\r", host);
WiredHome 74:d20120171e35 171 if (!wifi->sendCommand(cmd, "AOK")) {
WiredHome 74:d20120171e35 172 INFO(" confEndPoint false.");
samux 1:fb4494783863 173 return false;
WiredHome 74:d20120171e35 174 }
samux 1:fb4494783863 175 // set remote port
samux 1:fb4494783863 176 sprintf(cmd, "set i r %d\r", ep.get_port());
WiredHome 74:d20120171e35 177 if (!wifi->sendCommand(cmd, "AOK")) {
WiredHome 74:d20120171e35 178 INFO(" confEndPoint false.");
samux 1:fb4494783863 179 return false;
WiredHome 74:d20120171e35 180 }
samux 1:fb4494783863 181 wifi->exit();
samux 1:fb4494783863 182 endpoint_configured = true;
WiredHome 74:d20120171e35 183 INFO(" confEndPoint.");
samux 1:fb4494783863 184 return true;
samux 1:fb4494783863 185 }
samux 1:fb4494783863 186 }
WiredHome 74:d20120171e35 187 INFO(" confEndPoint.");
samux 1:fb4494783863 188 return true;
samux 1:fb4494783863 189 }
samux 1:fb4494783863 190
samux 1:fb4494783863 191 bool UDPSocket::readEndpoint(Endpoint & ep)
samux 1:fb4494783863 192 {
samux 1:fb4494783863 193 char recv[256];
samux 1:fb4494783863 194 int begin = 0;
samux 1:fb4494783863 195 int end = 0;
samux 1:fb4494783863 196 string str;
samux 1:fb4494783863 197 string addr;
samux 1:fb4494783863 198 int port;
samux 1:fb4494783863 199 if (!endpoint_read) {
samux 1:fb4494783863 200 if (!wifi->sendCommand("get ip\r", NULL, recv))
samux 1:fb4494783863 201 return false;
samux 1:fb4494783863 202 wifi->exit();
samux 1:fb4494783863 203 str = recv;
samux 1:fb4494783863 204 begin = str.find("HOST=");
samux 1:fb4494783863 205 end = str.find("PROTO=");
samux 1:fb4494783863 206 if (begin != string::npos && end != string::npos) {
samux 1:fb4494783863 207 str = str.substr(begin + 5, end - begin - 5);
samux 1:fb4494783863 208 int pos = str.find(":");
samux 1:fb4494783863 209 if (pos != string::npos) {
samux 1:fb4494783863 210 addr = str.substr(0, pos);
samux 1:fb4494783863 211 port = atoi(str.substr(pos + 1).c_str());
samux 1:fb4494783863 212 ep.set_address(addr.c_str(), port);
samux 1:fb4494783863 213 endpoint_read = true;
samux 1:fb4494783863 214 wifi->flush();
samux 1:fb4494783863 215 return true;
samux 1:fb4494783863 216 }
samux 1:fb4494783863 217 }
samux 1:fb4494783863 218 wifi->flush();
samux 1:fb4494783863 219 }
samux 1:fb4494783863 220 return false;
samux 1:fb4494783863 221 }