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:
Fri May 31 03:22:59 2013 +0000
Revision:
5:cc0506dc3565
Parent:
1:fb4494783863
Child:
12:6270ced02019
Numerous changes, mostly to Wifly.cpp to fix performance and capabilities.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WiredHome 5:cc0506dc3565 1 /* WiflyInterface.h */
WiredHome 5:cc0506dc3565 2 /* Copyright (C) 2012 mbed.org, MIT License
WiredHome 5:cc0506dc3565 3 *
WiredHome 5:cc0506dc3565 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
WiredHome 5:cc0506dc3565 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
WiredHome 5:cc0506dc3565 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
WiredHome 5:cc0506dc3565 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
WiredHome 5:cc0506dc3565 8 * furnished to do so, subject to the following conditions:
WiredHome 5:cc0506dc3565 9 *
WiredHome 5:cc0506dc3565 10 * The above copyright notice and this permission notice shall be included in all copies or
WiredHome 5:cc0506dc3565 11 * substantial portions of the Software.
WiredHome 5:cc0506dc3565 12 *
WiredHome 5:cc0506dc3565 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
WiredHome 5:cc0506dc3565 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
WiredHome 5:cc0506dc3565 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
WiredHome 5:cc0506dc3565 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
WiredHome 5:cc0506dc3565 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
WiredHome 5:cc0506dc3565 18 */
WiredHome 5:cc0506dc3565 19
WiredHome 5:cc0506dc3565 20 /*
WiredHome 5:cc0506dc3565 21 * Modifications by David Smart
WiredHome 5:cc0506dc3565 22 * match doxygen format with other files
WiredHome 5:cc0506dc3565 23 * minor documentation improvements
WiredHome 5:cc0506dc3565 24 */
WiredHome 5:cc0506dc3565 25
WiredHome 5:cc0506dc3565 26 #ifndef WIFLYINTERFACE_H_
WiredHome 5:cc0506dc3565 27 #define WIFLYINTERFACE_H_
WiredHome 5:cc0506dc3565 28
WiredHome 5:cc0506dc3565 29 #include "Wifly.h"
WiredHome 5:cc0506dc3565 30
WiredHome 5:cc0506dc3565 31 /** Interface using Wifly to connect to an IP-based network
WiredHome 5:cc0506dc3565 32 *
WiredHome 5:cc0506dc3565 33 */
WiredHome 5:cc0506dc3565 34 class WiflyInterface: public Wifly {
WiredHome 5:cc0506dc3565 35 public:
WiredHome 5:cc0506dc3565 36
WiredHome 5:cc0506dc3565 37 /**
WiredHome 5:cc0506dc3565 38 * Constructor
WiredHome 5:cc0506dc3565 39 *
WiredHome 5:cc0506dc3565 40 * @param tx mbed pin to use for tx line of Serial interface
WiredHome 5:cc0506dc3565 41 * @param rx mbed pin to use for rx line of Serial interface
WiredHome 5:cc0506dc3565 42 * @param reset reset pin of the wifi module ()
WiredHome 5:cc0506dc3565 43 * @param tcp_status connection status pin of the wifi module (GPIO 6)
WiredHome 5:cc0506dc3565 44 * @param ssid ssid of the network
WiredHome 5:cc0506dc3565 45 * @param phrase WEP or WPA key
WiredHome 5:cc0506dc3565 46 * @param sec Security type (NONE, WEP_128 or WPA)
WiredHome 5:cc0506dc3565 47 */
WiredHome 5:cc0506dc3565 48 WiflyInterface(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec = NONE);
WiredHome 5:cc0506dc3565 49
WiredHome 5:cc0506dc3565 50 /** Initialize the interface with DHCP.
WiredHome 5:cc0506dc3565 51 * Initialize the interface and configure it to use DHCP (no connection at this point).
WiredHome 5:cc0506dc3565 52 *
WiredHome 5:cc0506dc3565 53 * @return 0 on success, a negative number on failure
WiredHome 5:cc0506dc3565 54 */
WiredHome 5:cc0506dc3565 55 int init(); //With DHCP
WiredHome 5:cc0506dc3565 56
WiredHome 5:cc0506dc3565 57 /** Initialize the interface with a static IP address.
WiredHome 5:cc0506dc3565 58 * Initialize the interface and configure it with the following static configuration (no connection at this point).
WiredHome 5:cc0506dc3565 59 *
WiredHome 5:cc0506dc3565 60 * @param ip the IP address to use
WiredHome 5:cc0506dc3565 61 * @param mask the IP address mask
WiredHome 5:cc0506dc3565 62 * @param gateway the gateway to use
WiredHome 5:cc0506dc3565 63 * @return 0 on success, a negative number on failure
WiredHome 5:cc0506dc3565 64 */
WiredHome 5:cc0506dc3565 65 int init(const char* ip, const char* mask, const char* gateway);
WiredHome 5:cc0506dc3565 66
WiredHome 5:cc0506dc3565 67 /** Connect
WiredHome 5:cc0506dc3565 68 * Bring the interface up, start DHCP if needed.
WiredHome 5:cc0506dc3565 69 *
WiredHome 5:cc0506dc3565 70 * @return 0 on success, a negative number on failure
WiredHome 5:cc0506dc3565 71 */
WiredHome 5:cc0506dc3565 72 int connect();
WiredHome 5:cc0506dc3565 73
WiredHome 5:cc0506dc3565 74 /** Disconnect
WiredHome 5:cc0506dc3565 75 * Bring the interface down
WiredHome 5:cc0506dc3565 76 *
WiredHome 5:cc0506dc3565 77 * @return 0 on success, a negative number on failure
WiredHome 5:cc0506dc3565 78 */
WiredHome 5:cc0506dc3565 79 int disconnect();
WiredHome 5:cc0506dc3565 80
WiredHome 5:cc0506dc3565 81 /** Get IP address of this node when connected to a network
WiredHome 5:cc0506dc3565 82 *
WiredHome 5:cc0506dc3565 83 * @note this command switches to/from command mode which is time intensive.
WiredHome 5:cc0506dc3565 84 *
WiredHome 5:cc0506dc3565 85 * @returns ip address
WiredHome 5:cc0506dc3565 86 */
WiredHome 5:cc0506dc3565 87 char* getIPAddress();
WiredHome 5:cc0506dc3565 88
WiredHome 5:cc0506dc3565 89 private:
WiredHome 5:cc0506dc3565 90 char ip_string[20];
WiredHome 5:cc0506dc3565 91 bool ip_set;
WiredHome 5:cc0506dc3565 92 };
WiredHome 5:cc0506dc3565 93
WiredHome 5:cc0506dc3565 94 #include "TCPSocketConnection.h"
WiredHome 5:cc0506dc3565 95 #include "TCPSocketServer.h"
WiredHome 5:cc0506dc3565 96 #include "UDPSocket.h"
WiredHome 5:cc0506dc3565 97
WiredHome 5:cc0506dc3565 98 #endif /* WIFLYINTERFACE_H_ */
WiredHome 5:cc0506dc3565 99