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 Jun 24 19:52:51 2013 +0000
Revision:
7:b3d740f89f27
Parent:
5:cc0506dc3565
Child:
8:79415e982c32
Permit TCPSocketConnection to be non-blocking.
; Permit Wifly to generation documentation.
; Other cosmetic changes.

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 * @section DESCRIPTION
samux 1:fb4494783863 19 *
samux 1:fb4494783863 20 * Wifly RN131-C, wifi module
samux 1:fb4494783863 21 *
samux 1:fb4494783863 22 * Datasheet:
samux 1:fb4494783863 23 *
samux 1:fb4494783863 24 * http://dlnmh9ip6v2uc.cloudfront.net/datasheets/Wireless/WiFi/WiFly-RN-UM.pdf
samux 1:fb4494783863 25 */
WiredHome 5:cc0506dc3565 26 /* Modifications by David Smart
WiredHome 5:cc0506dc3565 27 * baud - added method to crank up the baud rate.
WiredHome 5:cc0506dc3565 28 * isCmdMode - added a method to find out if it is in command mode
WiredHome 5:cc0506dc3565 29 * send - documented the timeout parameter
WiredHome 5:cc0506dc3565 30 * sendCommand - documented the timeout parameter
WiredHome 5:cc0506dc3565 31 * setConnectionState - added method to force the connection state (used by TCPSocketServer when it accepts a connection)
WiredHome 5:cc0506dc3565 32 * gethostbyname - added a length parameter to the size of the buffer being written
WiredHome 5:cc0506dc3565 33 * flushIn - added a private method to flush the input buffer
WiredHome 5:cc0506dc3565 34 */
samux 1:fb4494783863 35 #ifndef WIFLY_H
samux 1:fb4494783863 36 #define WIFLY_H
samux 1:fb4494783863 37
samux 1:fb4494783863 38 #include "mbed.h"
samux 1:fb4494783863 39 #include "CBuffer.h"
samux 1:fb4494783863 40
WiredHome 5:cc0506dc3565 41 #define DEFAULT_WAIT_RESP_TIMEOUT 1000
samux 1:fb4494783863 42
samux 1:fb4494783863 43 enum Security {
samux 1:fb4494783863 44 NONE = 0,
samux 1:fb4494783863 45 WEP_128 = 1,
samux 1:fb4494783863 46 WPA = 3
samux 1:fb4494783863 47 };
samux 1:fb4494783863 48
samux 1:fb4494783863 49 enum Protocol {
samux 1:fb4494783863 50 UDP = (1 << 0),
samux 1:fb4494783863 51 TCP = (1 << 1)
samux 1:fb4494783863 52 };
samux 1:fb4494783863 53
WiredHome 7:b3d740f89f27 54 /** the Wifly object
WiredHome 7:b3d740f89f27 55 *
WiredHome 7:b3d740f89f27 56 */
samux 1:fb4494783863 57 class Wifly
samux 1:fb4494783863 58 {
samux 1:fb4494783863 59
samux 1:fb4494783863 60 public:
WiredHome 7:b3d740f89f27 61 /**
samux 1:fb4494783863 62 * Constructor
samux 1:fb4494783863 63 *
samux 1:fb4494783863 64 * @param tx mbed pin to use for tx line of Serial interface
samux 1:fb4494783863 65 * @param rx mbed pin to use for rx line of Serial interface
samux 1:fb4494783863 66 * @param reset reset pin of the wifi module ()
samux 1:fb4494783863 67 * @param tcp_status connection status pin of the wifi module (GPIO 6)
samux 1:fb4494783863 68 * @param ssid ssid of the network
samux 1:fb4494783863 69 * @param phrase WEP or WPA key
samux 1:fb4494783863 70 * @param sec Security type (NONE, WEP_128 or WPA)
samux 1:fb4494783863 71 */
WiredHome 5:cc0506dc3565 72 Wifly(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec);
WiredHome 5:cc0506dc3565 73
WiredHome 7:b3d740f89f27 74 /**
WiredHome 5:cc0506dc3565 75 * Set the baud rate between the ARM and the WiFly module by first
WiredHome 5:cc0506dc3565 76 * setting the WiFly module and then shifting the ARM to that speed.
WiredHome 5:cc0506dc3565 77 *
WiredHome 5:cc0506dc3565 78 * @note Baud rate of 230400 has been tested without using flow
WiredHome 5:cc0506dc3565 79 * control.
WiredHome 5:cc0506dc3565 80 *
WiredHome 5:cc0506dc3565 81 * @param baudrate is the desired baudrate.
WiredHome 5:cc0506dc3565 82 */
WiredHome 5:cc0506dc3565 83 void baud(int baudrate);
samux 1:fb4494783863 84
WiredHome 7:b3d740f89f27 85 /**
samux 1:fb4494783863 86 * Connect the wifi module to the ssid contained in the constructor.
samux 1:fb4494783863 87 *
samux 1:fb4494783863 88 * @return true if connected, false otherwise
samux 1:fb4494783863 89 */
samux 1:fb4494783863 90 bool join();
samux 1:fb4494783863 91
WiredHome 7:b3d740f89f27 92 /**
samux 1:fb4494783863 93 * Disconnect the wifly module from the access point
samux 1:fb4494783863 94 *
samux 1:fb4494783863 95 * @ returns true if successful
samux 1:fb4494783863 96 */
samux 1:fb4494783863 97 bool disconnect();
samux 1:fb4494783863 98
WiredHome 7:b3d740f89f27 99 /**
samux 1:fb4494783863 100 * Open a tcp connection with the specified host on the specified port
samux 1:fb4494783863 101 *
samux 1:fb4494783863 102 * @param host host (can be either an ip address or a name. If a name is provided, a dns request will be established)
samux 1:fb4494783863 103 * @param port port
samux 1:fb4494783863 104 * @ returns true if successful
samux 1:fb4494783863 105 */
samux 1:fb4494783863 106 bool connect(const char * host, int port);
samux 1:fb4494783863 107
samux 1:fb4494783863 108
WiredHome 7:b3d740f89f27 109 /**
samux 1:fb4494783863 110 * Set the protocol (UDP or TCP)
samux 1:fb4494783863 111 *
samux 1:fb4494783863 112 * @param p protocol
samux 1:fb4494783863 113 * @ returns true if successful
samux 1:fb4494783863 114 */
samux 1:fb4494783863 115 bool setProtocol(Protocol p);
samux 1:fb4494783863 116
WiredHome 7:b3d740f89f27 117 /**
samux 1:fb4494783863 118 * Reset the wifi module
samux 1:fb4494783863 119 */
samux 1:fb4494783863 120 void reset();
samux 3:9aa05e19c62e 121
WiredHome 7:b3d740f89f27 122 /**
samux 3:9aa05e19c62e 123 * Reboot the wifi module
samux 3:9aa05e19c62e 124 */
samux 3:9aa05e19c62e 125 bool reboot();
samux 1:fb4494783863 126
WiredHome 7:b3d740f89f27 127 /**
samux 1:fb4494783863 128 * Check if characters are available
samux 1:fb4494783863 129 *
samux 1:fb4494783863 130 * @return number of available characters
samux 1:fb4494783863 131 */
samux 1:fb4494783863 132 int readable();
samux 1:fb4494783863 133
WiredHome 7:b3d740f89f27 134 /**
samux 1:fb4494783863 135 * Check if characters are available
samux 1:fb4494783863 136 *
samux 1:fb4494783863 137 * @return number of available characters
samux 1:fb4494783863 138 */
samux 1:fb4494783863 139 int writeable();
samux 1:fb4494783863 140
WiredHome 7:b3d740f89f27 141 /**
samux 1:fb4494783863 142 * Check if a tcp link is active
samux 1:fb4494783863 143 *
samux 1:fb4494783863 144 * @returns true if successful
samux 1:fb4494783863 145 */
samux 1:fb4494783863 146 bool is_connected();
samux 1:fb4494783863 147
WiredHome 7:b3d740f89f27 148 /**
samux 1:fb4494783863 149 * Read a character
samux 1:fb4494783863 150 *
samux 1:fb4494783863 151 * @return the character read
samux 1:fb4494783863 152 */
samux 1:fb4494783863 153 char getc();
samux 1:fb4494783863 154
WiredHome 7:b3d740f89f27 155 /**
samux 1:fb4494783863 156 * Flush the buffer
samux 1:fb4494783863 157 */
samux 1:fb4494783863 158 void flush();
samux 1:fb4494783863 159
WiredHome 7:b3d740f89f27 160 /**
samux 1:fb4494783863 161 * Write a character
samux 1:fb4494783863 162 *
samux 1:fb4494783863 163 * @param the character which will be written
samux 1:fb4494783863 164 */
samux 1:fb4494783863 165 int putc(char c);
samux 1:fb4494783863 166
samux 1:fb4494783863 167
WiredHome 7:b3d740f89f27 168 /**
samux 1:fb4494783863 169 * To enter in command mode (we can configure the module)
samux 1:fb4494783863 170 *
samux 1:fb4494783863 171 * @return true if successful, false otherwise
samux 1:fb4494783863 172 */
samux 1:fb4494783863 173 bool cmdMode();
samux 1:fb4494783863 174
WiredHome 7:b3d740f89f27 175 /**
WiredHome 5:cc0506dc3565 176 * determine if the module is in command mode
WiredHome 5:cc0506dc3565 177 *
WiredHome 5:cc0506dc3565 178 * @return true if in command mode, false otherwise
WiredHome 5:cc0506dc3565 179 */
WiredHome 5:cc0506dc3565 180 bool isCmdMode() {
WiredHome 5:cc0506dc3565 181 return state.cmd_mode;
WiredHome 5:cc0506dc3565 182 }
WiredHome 5:cc0506dc3565 183
WiredHome 7:b3d740f89f27 184 /**
samux 1:fb4494783863 185 * To exit the command mode
samux 1:fb4494783863 186 *
samux 1:fb4494783863 187 * @return true if successful, false otherwise
samux 1:fb4494783863 188 */
samux 1:fb4494783863 189 bool exit();
samux 1:fb4494783863 190
WiredHome 7:b3d740f89f27 191 /**
samux 1:fb4494783863 192 * Close a tcp connection
samux 1:fb4494783863 193 *
samux 1:fb4494783863 194 * @ returns true if successful
samux 1:fb4494783863 195 */
samux 1:fb4494783863 196 bool close();
samux 1:fb4494783863 197
WiredHome 7:b3d740f89f27 198 /**
samux 1:fb4494783863 199 * Send a string to the wifi module by serial port. This function desactivates the user interrupt handler when a character is received to analyze the response from the wifi module.
samux 1:fb4494783863 200 * Useful to send a command to the module and wait a response.
samux 1:fb4494783863 201 *
samux 1:fb4494783863 202 *
samux 1:fb4494783863 203 * @param str string to be sent
samux 1:fb4494783863 204 * @param len string length
samux 1:fb4494783863 205 * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
samux 1:fb4494783863 206 * @param res this field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
WiredHome 5:cc0506dc3565 207 * @param timeout is the time in msec to wait for the acknowledge
samux 1:fb4494783863 208 *
samux 1:fb4494783863 209 * @return true if ACK has been found in the response from the wifi module. False otherwise or if there is no response in 5s.
samux 1:fb4494783863 210 */
samux 1:fb4494783863 211 int send(const char * str, int len, const char * ACK = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 1:fb4494783863 212
WiredHome 7:b3d740f89f27 213 /**
samux 1:fb4494783863 214 * Send a command to the wify module. Check if the module is in command mode. If not enter in command mode
samux 1:fb4494783863 215 *
samux 1:fb4494783863 216 * @param str string to be sent
samux 1:fb4494783863 217 * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
samux 1:fb4494783863 218 * @param res this field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
WiredHome 5:cc0506dc3565 219 * @param timeout is the time in msec to wait for the acknowledge
samux 1:fb4494783863 220 *
samux 1:fb4494783863 221 * @returns true if successful
samux 1:fb4494783863 222 */
samux 1:fb4494783863 223 bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 4:0bcec6272784 224
WiredHome 7:b3d740f89f27 225 /**
samux 4:0bcec6272784 226 * Return true if the module is using dhcp
samux 4:0bcec6272784 227 *
samux 4:0bcec6272784 228 * @returns true if the module is using dhcp
samux 4:0bcec6272784 229 */
samux 4:0bcec6272784 230 bool isDHCP() {
samux 4:0bcec6272784 231 return state.dhcp;
samux 4:0bcec6272784 232 }
samux 1:fb4494783863 233
WiredHome 7:b3d740f89f27 234 /**
WiredHome 5:cc0506dc3565 235 * gets the host ip address
WiredHome 5:cc0506dc3565 236 *
WiredHome 5:cc0506dc3565 237 * @param host is a pointer to the host string to look up
WiredHome 5:cc0506dc3565 238 * @param ip contains the host IP in a string after the lookup.
WiredHome 5:cc0506dc3565 239 * @param sizeof_ip is the size of the buffer pointed to by ip
WiredHome 5:cc0506dc3565 240 * @returns true if successful
WiredHome 5:cc0506dc3565 241 */
WiredHome 5:cc0506dc3565 242 bool gethostbyname(const char * host, char * ip, int sizeof_ip);
WiredHome 5:cc0506dc3565 243
WiredHome 7:b3d740f89f27 244 /**
WiredHome 5:cc0506dc3565 245 * Sets the connection state. Typically used by external apps that detect
WiredHome 5:cc0506dc3565 246 * an incoming connection.
WiredHome 5:cc0506dc3565 247 *
WiredHome 5:cc0506dc3565 248 * @param state sets the connection state to true or false
WiredHome 5:cc0506dc3565 249 */
WiredHome 5:cc0506dc3565 250 void setConnectionState(bool state);
samux 1:fb4494783863 251
samux 1:fb4494783863 252 static Wifly * getInstance() {
samux 1:fb4494783863 253 return inst;
samux 1:fb4494783863 254 };
samux 1:fb4494783863 255
samux 1:fb4494783863 256 protected:
samux 1:fb4494783863 257 Serial wifi;
samux 1:fb4494783863 258 DigitalOut reset_pin;
samux 1:fb4494783863 259 DigitalIn tcp_status;
WiredHome 5:cc0506dc3565 260 int baudrate; //DS for "instantaneous" shifts in baudrate
samux 1:fb4494783863 261 char phrase[30];
samux 1:fb4494783863 262 char ssid[30];
samux 1:fb4494783863 263 const char * ip;
samux 1:fb4494783863 264 const char * netmask;
samux 1:fb4494783863 265 const char * gateway;
samux 1:fb4494783863 266 int channel;
samux 1:fb4494783863 267 CircBuffer<char> buf_wifly;
samux 1:fb4494783863 268
samux 1:fb4494783863 269 static Wifly * inst;
samux 1:fb4494783863 270
samux 1:fb4494783863 271 void attach_rx(bool null);
samux 1:fb4494783863 272 void handler_rx(void);
WiredHome 5:cc0506dc3565 273 void flushIn(int timeout_ms = 0);
samux 1:fb4494783863 274
samux 1:fb4494783863 275 typedef struct STATE {
samux 1:fb4494783863 276 bool associated;
samux 1:fb4494783863 277 bool tcp;
samux 1:fb4494783863 278 bool dhcp;
samux 1:fb4494783863 279 Security sec;
samux 1:fb4494783863 280 Protocol proto;
samux 1:fb4494783863 281 bool cmd_mode;
samux 1:fb4494783863 282 } State;
samux 1:fb4494783863 283
samux 1:fb4494783863 284 State state;
samux 1:fb4494783863 285 char * getStringSecurity();
samux 1:fb4494783863 286 };
samux 1:fb4494783863 287
samux 1:fb4494783863 288 #endif