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:
Thu Oct 10 20:37:47 2013 +0000
Revision:
45:21b7bbaad62b
Parent:
44:dc8ef27bd311
Child:
51:a4831b1cb9a4
Diagnostic improvements

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 */
WiredHome 44:dc8ef27bd311 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
WiredHome 44:dc8ef27bd311 25 /** Interface using Wifly to connect to an IP-based network
WiredHome 44:dc8ef27bd311 26 *
WiredHome 44:dc8ef27bd311 27 */
WiredHome 44:dc8ef27bd311 28 class WiflyInterface: public Wifly
WiredHome 44:dc8ef27bd311 29 {
samux 1:fb4494783863 30 public:
samux 1:fb4494783863 31
samux 1:fb4494783863 32 /**
WiredHome 44:dc8ef27bd311 33 * Construct the WiFlyInterface.
WiredHome 44:dc8ef27bd311 34 *
WiredHome 44:dc8ef27bd311 35 * API Precedence:
WiredHome 44:dc8ef27bd311 36 * @verbatim
WiredHome 44:dc8ef27bd311 37 * WiflyInterface() -->
WiredHome 44:dc8ef27bd311 38 * +-------------------+
WiredHome 44:dc8ef27bd311 39 * v ^
WiredHome 44:dc8ef27bd311 40 * --> init() -+----------------->+-> connect() -+------------------>+-> disconnect() --|
WiredHome 44:dc8ef27bd311 41 * | ^ | ^
WiredHome 44:dc8ef27bd311 42 * +-> setSecurity() -+ +-> getIPAddress() -+
WiredHome 44:dc8ef27bd311 43 * | ^
WiredHome 44:dc8ef27bd311 44 * +-> Wifly APIs -----+
WiredHome 44:dc8ef27bd311 45 *
WiredHome 44:dc8ef27bd311 46 * @endverbatim
samux 1:fb4494783863 47 *
WiredHome 45:21b7bbaad62b 48 * @note The optional ssid, phrase, and sec parameters may be deferred, or
WiredHome 45:21b7bbaad62b 49 * overridden prior to the connect().
WiredHome 45:21b7bbaad62b 50 *
samux 1:fb4494783863 51 * \param tx mbed pin to use for tx line of Serial interface
samux 1:fb4494783863 52 * \param rx mbed pin to use for rx line of Serial interface
samux 1:fb4494783863 53 * \param reset reset pin of the wifi module ()
samux 1:fb4494783863 54 * \param tcp_status connection status pin of the wifi module (GPIO 6)
WiredHome 45:21b7bbaad62b 55 * \param ssid optional parameter which is the ssid of the network
WiredHome 45:21b7bbaad62b 56 * \param phrase optional parameter which is the WEP or WPA key/phrase
WiredHome 45:21b7bbaad62b 57 * \param sec optional security type (NONE[default], WEP_128 or WPA)
samux 1:fb4494783863 58 */
WiredHome 45:21b7bbaad62b 59 WiflyInterface(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid = NULL, const char * phrase = NULL, Security sec = NONE);
samux 1:fb4494783863 60
WiredHome 44:dc8ef27bd311 61 /** Initialize the interface with DHCP.
WiredHome 44:dc8ef27bd311 62 * Initialize the interface and configure it to use DHCP (no connection at this point).
WiredHome 44:dc8ef27bd311 63 * \return 0 on success, a negative number on failure
WiredHome 44:dc8ef27bd311 64 */
WiredHome 44:dc8ef27bd311 65 int init(); //With DHCP
samux 1:fb4494783863 66
WiredHome 44:dc8ef27bd311 67 /** Initialize the interface with a static IP address.
WiredHome 45:21b7bbaad62b 68 *
WiredHome 45:21b7bbaad62b 69 * Initialize the interface and configure it with the following static
WiredHome 45:21b7bbaad62b 70 * configuration (no connection at this point).
WiredHome 45:21b7bbaad62b 71 *
WiredHome 44:dc8ef27bd311 72 * \param ip the IP address to use
WiredHome 44:dc8ef27bd311 73 * \param mask the IP address mask
WiredHome 44:dc8ef27bd311 74 * \param gateway the gateway to use
WiredHome 44:dc8ef27bd311 75 * \return 0 on success, a negative number on failure
WiredHome 44:dc8ef27bd311 76 */
WiredHome 44:dc8ef27bd311 77 int init(const char* ip, const char* mask, const char* gateway);
samux 1:fb4494783863 78
WiredHome 45:21b7bbaad62b 79 /** Set security parameters for the interface.
WiredHome 45:21b7bbaad62b 80 *
WiredHome 45:21b7bbaad62b 81 * Prior to connect, this interface permits changing the security parameters. This
WiredHome 45:21b7bbaad62b 82 * can be most useful when the Wifly module may be used where there are multiple access
WiredHome 45:21b7bbaad62b 83 * points to be connected to. With this, the interface can be brought online far
WiredHome 45:21b7bbaad62b 84 * enough to scan for available access points.
WiredHome 45:21b7bbaad62b 85 *
WiredHome 45:21b7bbaad62b 86 * \param ssid optional parameter which is the ssid of the network
WiredHome 45:21b7bbaad62b 87 * \param phrase optional parameter which is the WEP or WPA key/phrase
WiredHome 45:21b7bbaad62b 88 * \param sec optional security type (NONE[default], WEP_128 or WPA)
WiredHome 45:21b7bbaad62b 89 */
WiredHome 45:21b7bbaad62b 90 void setSecurity(const char * ssid = NULL, const char * phrase = NULL, Security sec = NONE);
WiredHome 45:21b7bbaad62b 91
WiredHome 44:dc8ef27bd311 92 /** Connect
WiredHome 44:dc8ef27bd311 93 * Bring the interface up, start DHCP if needed.
WiredHome 44:dc8ef27bd311 94 * \return 0 on success, a negative number on failure
WiredHome 44:dc8ef27bd311 95 */
WiredHome 44:dc8ef27bd311 96 int connect();
WiredHome 44:dc8ef27bd311 97
WiredHome 44:dc8ef27bd311 98 /** Disconnect
WiredHome 44:dc8ef27bd311 99 * Bring the interface down
WiredHome 44:dc8ef27bd311 100 * \return 0 on success, a negative number on failure
WiredHome 44:dc8ef27bd311 101 */
WiredHome 44:dc8ef27bd311 102 int disconnect();
WiredHome 44:dc8ef27bd311 103
WiredHome 44:dc8ef27bd311 104 /** Get IP address
WiredHome 44:dc8ef27bd311 105 *
WiredHome 44:dc8ef27bd311 106 * @ returns ip address
WiredHome 44:dc8ef27bd311 107 */
WiredHome 44:dc8ef27bd311 108 char* getIPAddress();
WiredHome 44:dc8ef27bd311 109
samux 1:fb4494783863 110 private:
samux 1:fb4494783863 111 char ip_string[20];
samux 1:fb4494783863 112 bool ip_set;
samux 1:fb4494783863 113 };
samux 1:fb4494783863 114
samux 1:fb4494783863 115 #include "TCPSocketConnection.h"
samux 1:fb4494783863 116 #include "TCPSocketServer.h"
samux 1:fb4494783863 117 #include "UDPSocket.h"
samux 1:fb4494783863 118
samux 1:fb4494783863 119 #endif /* WIFLYINTERFACE_H_ */