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:
Wed Oct 09 20:47:09 2013 +0000
Revision:
38:30e142b93ce4
Parent:
1:fb4494783863
Child:
39:29e72dada2f5
Minor documentation changes

Who changed what in which revision?

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