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 Sep 25 03:01:07 2014 +0000
Revision:
71:59936f711b80
Parent:
68:d9a3920cc407
Changes to more closely match the EthernetInterface APIs for improve interchangeability.; Increased the timeout in the FlushIn call after sending a command - this helps it clean up the response from a slow command.

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.
WiredHome 68:d9a3920cc407 17 *
WiredHome 68:d9a3920cc407 18 * Changes relative to mbed official version and others as identified
WiredHome 68:d9a3920cc407 19 * in the thread http://mbed.org/forum/team-165-components-community/topic/4844/?page=1#comment-24108
WiredHome 68:d9a3920cc407 20 * UDPSocket:
WiredHome 68:d9a3920cc407 21 * @li improve documentation
WiredHome 68:d9a3920cc407 22 * @li revise timeout on store command from default to 5000 msec
WiredHome 68:d9a3920cc407 23 * @li derived from 4:0bcec6272784
samux 1:fb4494783863 24 */
samux 1:fb4494783863 25
samux 1:fb4494783863 26 #ifndef UDPSOCKET_H
samux 1:fb4494783863 27 #define UDPSOCKET_H
samux 1:fb4494783863 28
samux 1:fb4494783863 29 #include "Endpoint.h"
samux 1:fb4494783863 30 #include "Socket.h"
samux 1:fb4494783863 31
samux 1:fb4494783863 32 #include <cstdint>
samux 1:fb4494783863 33
samux 1:fb4494783863 34 /**
samux 1:fb4494783863 35 UDP Socket
samux 1:fb4494783863 36 */
samux 1:fb4494783863 37 class UDPSocket: public Socket {
samux 1:fb4494783863 38
samux 1:fb4494783863 39 public:
samux 1:fb4494783863 40 /** Instantiate an UDP Socket.
samux 1:fb4494783863 41 */
samux 1:fb4494783863 42 UDPSocket();
samux 1:fb4494783863 43
samux 1:fb4494783863 44 /** Init the UDP Client Socket without binding it to any specific port
WiredHome 51:a4831b1cb9a4 45 @return 0 on success, -1 on failure.
samux 1:fb4494783863 46 */
samux 1:fb4494783863 47 int init(void);
samux 1:fb4494783863 48
samux 1:fb4494783863 49 /** Bind a UDP Server Socket to a specific port
WiredHome 51:a4831b1cb9a4 50 @param port The port to listen for incoming connections on
WiredHome 51:a4831b1cb9a4 51 @return 0 on success, -1 on failure.
samux 1:fb4494783863 52 */
samux 1:fb4494783863 53 int bind(int port = -1);
WiredHome 71:59936f711b80 54
WiredHome 71:59936f711b80 55 /** Join the multicast group at the given address
WiredHome 71:59936f711b80 56 @caution This API is introduced to the WiflyInterface for
WiredHome 71:59936f711b80 57 API compatibility with the wired interface. As such
WiredHome 71:59936f711b80 58 it may not function properly (at least while this caution
WiredHome 71:59936f711b80 59 remains).
WiredHome 71:59936f711b80 60 @param address The address of the multicast group
WiredHome 71:59936f711b80 61 (e.g. "224.0.0.0")
WiredHome 71:59936f711b80 62 @return 0 on success, -1 on failure.
WiredHome 71:59936f711b80 63 */
WiredHome 71:59936f711b80 64 int join_multicast_group(const char* address);
samux 1:fb4494783863 65
WiredHome 71:59936f711b80 66 /** Set the socket in broadcasting mode.
WiredHome 71:59936f711b80 67 @caution This API is introduced to the WiflyInterface for
WiredHome 71:59936f711b80 68 API compatibility with the wired interface. As such
WiredHome 71:59936f711b80 69 it may not function properly (at least while this caution
WiredHome 71:59936f711b80 70 remains).
WiredHome 71:59936f711b80 71 @param [in] broadcast is an optional parameter to sets
WiredHome 71:59936f711b80 72 broadcast mode (true/false). If not provided it
WiredHome 71:59936f711b80 73 sets it to true.
WiredHome 71:59936f711b80 74 @return 0 on success, -1 on failure.
WiredHome 71:59936f711b80 75 */
WiredHome 71:59936f711b80 76 int set_broadcasting(bool broadcast=true);
WiredHome 71:59936f711b80 77
samux 1:fb4494783863 78 /** Send a packet to a remote endpoint
WiredHome 51:a4831b1cb9a4 79 @param remote The remote endpoint
WiredHome 51:a4831b1cb9a4 80 @param packet The packet to be sent
WiredHome 51:a4831b1cb9a4 81 @param length The length of the packet to be sent
WiredHome 51:a4831b1cb9a4 82 @return the number of written bytes on success (>=0) or -1 on failure
samux 1:fb4494783863 83 */
samux 1:fb4494783863 84 int sendTo(Endpoint &remote, char *packet, int length);
samux 1:fb4494783863 85
samux 1:fb4494783863 86 /** Receive a packet from a remote endpoint
WiredHome 51:a4831b1cb9a4 87 @param remote The remote endpoint
WiredHome 51:a4831b1cb9a4 88 @param buffer The buffer for storing the incoming packet data. If a packet
samux 1:fb4494783863 89 is too long to fit in the supplied buffer, excess bytes are discarded
WiredHome 51:a4831b1cb9a4 90 @param length The length of the buffer
WiredHome 51:a4831b1cb9a4 91 @return the number of received bytes on success (>=0) or -1 on failure
samux 1:fb4494783863 92 */
samux 1:fb4494783863 93 int receiveFrom(Endpoint &remote, char *buffer, int length);
samux 1:fb4494783863 94
samux 1:fb4494783863 95 private:
samux 1:fb4494783863 96 bool confEndpoint(Endpoint & ep);
samux 1:fb4494783863 97 bool readEndpoint(Endpoint & ep);
samux 1:fb4494783863 98 bool endpoint_configured;
samux 1:fb4494783863 99 bool endpoint_read;
samux 1:fb4494783863 100
samux 1:fb4494783863 101 };
samux 1:fb4494783863 102
samux 1:fb4494783863 103 #include "def.h"
samux 1:fb4494783863 104
samux 1:fb4494783863 105 #endif