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:
Sun Jul 21 23:05:51 2013 +0000
Revision:
21:97294686b4a1
Parent:
18:18ab3993d00d
Child:
23:6e77c65ced00
Add baud rate setting

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 */
samux 1:fb4494783863 26
samux 1:fb4494783863 27 #ifndef WIFLY_H
samux 1:fb4494783863 28 #define WIFLY_H
samux 1:fb4494783863 29
samux 1:fb4494783863 30 #include "mbed.h"
samux 1:fb4494783863 31 #include "CBuffer.h"
samux 1:fb4494783863 32
WiredHome 14:473d73cb48ee 33 #define DEFAULT_WAIT_RESP_TIMEOUT 1000
samux 1:fb4494783863 34
samux 1:fb4494783863 35 enum Security {
samux 1:fb4494783863 36 NONE = 0,
samux 1:fb4494783863 37 WEP_128 = 1,
samux 1:fb4494783863 38 WPA = 3
samux 1:fb4494783863 39 };
samux 1:fb4494783863 40
samux 1:fb4494783863 41 enum Protocol {
samux 1:fb4494783863 42 UDP = (1 << 0),
samux 1:fb4494783863 43 TCP = (1 << 1)
samux 1:fb4494783863 44 };
samux 1:fb4494783863 45
WiredHome 15:121f473dae3f 46 /** the Wifly object
WiredHome 15:121f473dae3f 47 *
WiredHome 15:121f473dae3f 48 * This object controls the Wifly module.
WiredHome 15:121f473dae3f 49 */
samux 1:fb4494783863 50 class Wifly
samux 1:fb4494783863 51 {
samux 1:fb4494783863 52
samux 1:fb4494783863 53 public:
WiredHome 15:121f473dae3f 54 /**
samux 1:fb4494783863 55 * Constructor
samux 1:fb4494783863 56 *
samux 1:fb4494783863 57 * @param tx mbed pin to use for tx line of Serial interface
samux 1:fb4494783863 58 * @param rx mbed pin to use for rx line of Serial interface
samux 1:fb4494783863 59 * @param reset reset pin of the wifi module ()
samux 1:fb4494783863 60 * @param tcp_status connection status pin of the wifi module (GPIO 6)
samux 1:fb4494783863 61 * @param ssid ssid of the network
samux 1:fb4494783863 62 * @param phrase WEP or WPA key
samux 1:fb4494783863 63 * @param sec Security type (NONE, WEP_128 or WPA)
samux 1:fb4494783863 64 */
samux 1:fb4494783863 65 Wifly( PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec);
samux 1:fb4494783863 66
WiredHome 15:121f473dae3f 67 /**
samux 1:fb4494783863 68 * Connect the wifi module to the ssid contained in the constructor.
samux 1:fb4494783863 69 *
samux 1:fb4494783863 70 * @return true if connected, false otherwise
samux 1:fb4494783863 71 */
samux 1:fb4494783863 72 bool join();
samux 1:fb4494783863 73
WiredHome 15:121f473dae3f 74 /**
samux 1:fb4494783863 75 * Disconnect the wifly module from the access point
samux 1:fb4494783863 76 *
samux 1:fb4494783863 77 * @ returns true if successful
samux 1:fb4494783863 78 */
samux 1:fb4494783863 79 bool disconnect();
samux 1:fb4494783863 80
WiredHome 15:121f473dae3f 81 /**
samux 1:fb4494783863 82 * Open a tcp connection with the specified host on the specified port
samux 1:fb4494783863 83 *
samux 1:fb4494783863 84 * @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 85 * @param port port
samux 1:fb4494783863 86 * @ returns true if successful
samux 1:fb4494783863 87 */
samux 1:fb4494783863 88 bool connect(const char * host, int port);
samux 1:fb4494783863 89
samux 1:fb4494783863 90
WiredHome 15:121f473dae3f 91 /**
samux 1:fb4494783863 92 * Set the protocol (UDP or TCP)
samux 1:fb4494783863 93 *
samux 1:fb4494783863 94 * @param p protocol
samux 1:fb4494783863 95 * @ returns true if successful
samux 1:fb4494783863 96 */
samux 1:fb4494783863 97 bool setProtocol(Protocol p);
samux 1:fb4494783863 98
WiredHome 15:121f473dae3f 99 /**
samux 1:fb4494783863 100 * Reset the wifi module
samux 1:fb4494783863 101 */
samux 1:fb4494783863 102 void reset();
samux 3:9aa05e19c62e 103
WiredHome 15:121f473dae3f 104 /**
samux 3:9aa05e19c62e 105 * Reboot the wifi module
samux 3:9aa05e19c62e 106 */
samux 3:9aa05e19c62e 107 bool reboot();
samux 1:fb4494783863 108
WiredHome 15:121f473dae3f 109 /**
samux 1:fb4494783863 110 * Check if characters are available
samux 1:fb4494783863 111 *
samux 1:fb4494783863 112 * @return number of available characters
samux 1:fb4494783863 113 */
samux 1:fb4494783863 114 int readable();
samux 1:fb4494783863 115
WiredHome 15:121f473dae3f 116 /**
samux 1:fb4494783863 117 * Check if characters are available
samux 1:fb4494783863 118 *
samux 1:fb4494783863 119 * @return number of available characters
samux 1:fb4494783863 120 */
samux 1:fb4494783863 121 int writeable();
samux 1:fb4494783863 122
WiredHome 15:121f473dae3f 123 /**
samux 1:fb4494783863 124 * Check if a tcp link is active
samux 1:fb4494783863 125 *
samux 1:fb4494783863 126 * @returns true if successful
samux 1:fb4494783863 127 */
samux 1:fb4494783863 128 bool is_connected();
samux 1:fb4494783863 129
WiredHome 15:121f473dae3f 130 /**
samux 1:fb4494783863 131 * Read a character
samux 1:fb4494783863 132 *
samux 1:fb4494783863 133 * @return the character read
samux 1:fb4494783863 134 */
samux 1:fb4494783863 135 char getc();
samux 1:fb4494783863 136
WiredHome 15:121f473dae3f 137 /**
samux 1:fb4494783863 138 * Flush the buffer
samux 1:fb4494783863 139 */
samux 1:fb4494783863 140 void flush();
samux 1:fb4494783863 141
WiredHome 15:121f473dae3f 142 /**
samux 1:fb4494783863 143 * Write a character
samux 1:fb4494783863 144 *
samux 1:fb4494783863 145 * @param the character which will be written
samux 1:fb4494783863 146 */
samux 1:fb4494783863 147 int putc(char c);
samux 1:fb4494783863 148
samux 1:fb4494783863 149
WiredHome 15:121f473dae3f 150 /**
samux 1:fb4494783863 151 * To enter in command mode (we can configure the module)
samux 1:fb4494783863 152 *
samux 1:fb4494783863 153 * @return true if successful, false otherwise
samux 1:fb4494783863 154 */
samux 1:fb4494783863 155 bool cmdMode();
samux 1:fb4494783863 156
WiredHome 15:121f473dae3f 157 /**
samux 1:fb4494783863 158 * To exit the command mode
samux 1:fb4494783863 159 *
samux 1:fb4494783863 160 * @return true if successful, false otherwise
samux 1:fb4494783863 161 */
samux 1:fb4494783863 162 bool exit();
samux 1:fb4494783863 163
WiredHome 15:121f473dae3f 164 /**
samux 1:fb4494783863 165 * Close a tcp connection
samux 1:fb4494783863 166 *
samux 1:fb4494783863 167 * @ returns true if successful
samux 1:fb4494783863 168 */
samux 1:fb4494783863 169 bool close();
samux 1:fb4494783863 170
WiredHome 15:121f473dae3f 171 /**
samux 1:fb4494783863 172 * 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 173 * Useful to send a command to the module and wait a response.
samux 1:fb4494783863 174 *
samux 1:fb4494783863 175 *
samux 1:fb4494783863 176 * @param str string to be sent
samux 1:fb4494783863 177 * @param len string length
samux 1:fb4494783863 178 * @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 179 * @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 15:121f473dae3f 180 * @param timeout is the time in msec to wait for the acknowledge
samux 1:fb4494783863 181 *
samux 1:fb4494783863 182 * @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 183 */
samux 1:fb4494783863 184 int send(const char * str, int len, const char * ACK = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 1:fb4494783863 185
WiredHome 15:121f473dae3f 186 /**
samux 1:fb4494783863 187 * Send a command to the wify module. Check if the module is in command mode. If not enter in command mode
samux 1:fb4494783863 188 *
samux 1:fb4494783863 189 * @param str string to be sent
samux 1:fb4494783863 190 * @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 191 * @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 15:121f473dae3f 192 * @param timeout is the time in msec to wait for the acknowledge
samux 1:fb4494783863 193 *
samux 1:fb4494783863 194 * @returns true if successful
samux 1:fb4494783863 195 */
samux 1:fb4494783863 196 bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 4:0bcec6272784 197
WiredHome 15:121f473dae3f 198 /**
samux 4:0bcec6272784 199 * Return true if the module is using dhcp
samux 4:0bcec6272784 200 *
samux 4:0bcec6272784 201 * @returns true if the module is using dhcp
samux 4:0bcec6272784 202 */
samux 4:0bcec6272784 203 bool isDHCP() {
samux 4:0bcec6272784 204 return state.dhcp;
samux 4:0bcec6272784 205 }
samux 1:fb4494783863 206
WiredHome 15:121f473dae3f 207 /**
WiredHome 15:121f473dae3f 208 * gets the host ip address
WiredHome 15:121f473dae3f 209 *
WiredHome 15:121f473dae3f 210 * @param host is a pointer to the host string to look up
WiredHome 15:121f473dae3f 211 * @param ip contains the host IP in a string after the lookup.
WiredHome 15:121f473dae3f 212 * @param sizeof_ip is the size of the buffer pointed to by ip
WiredHome 15:121f473dae3f 213 * @returns true if successful
WiredHome 15:121f473dae3f 214 */
samux 1:fb4494783863 215 bool gethostbyname(const char * host, char * ip);
samux 1:fb4494783863 216
WiredHome 21:97294686b4a1 217 /**
WiredHome 21:97294686b4a1 218 * Set the baud rate between the ARM and the WiFly.
WiredHome 21:97294686b4a1 219 *
WiredHome 21:97294686b4a1 220 * This will set the WiFly module baud rate first and then
WiredHome 21:97294686b4a1 221 * set the ARM interface to match it. If it cannot get the proper
WiredHome 21:97294686b4a1 222 * acknowledge response, it will go on a hunt through the range
WiredHome 21:97294686b4a1 223 * of standard baud rates.
WiredHome 21:97294686b4a1 224 *
WiredHome 21:97294686b4a1 225 * @note Baud rate must be one of 2400, 4800, 9600, 19200, 38400, 57600,
WiredHome 21:97294686b4a1 226 * 115200, 230400, 460800, or 921600. (See Wifly manual 2.3.64)
WiredHome 21:97294686b4a1 227 * @note Baud rate of 230400 has been seen to be marginal w/o flow control.
WiredHome 21:97294686b4a1 228 * @note Setting a baud rate to a 460800 or above may be unrecoverable
WiredHome 21:97294686b4a1 229 * without resetting the Wifly module.
WiredHome 21:97294686b4a1 230 *
WiredHome 21:97294686b4a1 231 * @param baudrate is the desired baudrate.
WiredHome 21:97294686b4a1 232 * @returns true if it succeeded, which means that communications can continue,
WiredHome 21:97294686b4a1 233 * @returns false if it failed to establish a communication link.
WiredHome 21:97294686b4a1 234 */
WiredHome 21:97294686b4a1 235 bool baud(int baudrate);
WiredHome 21:97294686b4a1 236
samux 1:fb4494783863 237 static Wifly * getInstance() {
samux 1:fb4494783863 238 return inst;
samux 1:fb4494783863 239 };
samux 1:fb4494783863 240
samux 1:fb4494783863 241 protected:
samux 1:fb4494783863 242 Serial wifi;
samux 1:fb4494783863 243 DigitalOut reset_pin;
samux 1:fb4494783863 244 DigitalIn tcp_status;
WiredHome 21:97294686b4a1 245 int baudrate;
samux 1:fb4494783863 246 char phrase[30];
samux 1:fb4494783863 247 char ssid[30];
samux 1:fb4494783863 248 const char * ip;
samux 1:fb4494783863 249 const char * netmask;
samux 1:fb4494783863 250 const char * gateway;
samux 1:fb4494783863 251 CircBuffer<char> buf_wifly;
samux 1:fb4494783863 252
samux 1:fb4494783863 253 static Wifly * inst;
samux 1:fb4494783863 254
samux 1:fb4494783863 255 void attach_rx(bool null);
samux 1:fb4494783863 256 void handler_rx(void);
WiredHome 18:18ab3993d00d 257 void flushIn(int timeout_ms = 0);
samux 1:fb4494783863 258
samux 1:fb4494783863 259 typedef struct STATE {
samux 1:fb4494783863 260 bool associated;
samux 1:fb4494783863 261 bool tcp;
samux 1:fb4494783863 262 bool dhcp;
samux 1:fb4494783863 263 Security sec;
samux 1:fb4494783863 264 Protocol proto;
samux 1:fb4494783863 265 bool cmd_mode;
samux 1:fb4494783863 266 } State;
samux 1:fb4494783863 267
samux 1:fb4494783863 268 State state;
samux 1:fb4494783863 269 char * getStringSecurity();
WiredHome 21:97294686b4a1 270
WiredHome 21:97294686b4a1 271 /**
WiredHome 21:97294686b4a1 272 * Estimates the time needed for the Wifly module to respond
WiredHome 21:97294686b4a1 273 * to some of the simple commands.
WiredHome 21:97294686b4a1 274 *
WiredHome 21:97294686b4a1 275 * @param stringLength is the number of characters in the command
WiredHome 21:97294686b4a1 276 * @returns number of milliseconds.
WiredHome 21:97294686b4a1 277 */
WiredHome 21:97294686b4a1 278 int timeToRespond(int stringLen);
samux 1:fb4494783863 279 };
samux 1:fb4494783863 280
samux 1:fb4494783863 281 #endif